File: FlacEncoder.h

package info (click to toggle)
kwave 25.04.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 23,272 kB
  • sloc: cpp: 56,173; xml: 817; perl: 688; sh: 57; makefile: 11
file content (148 lines) | stat: -rw-r--r-- 4,846 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*************************************************************************
          FlacEncoder.h  -  encoder for FLAC data
                             -------------------
    begin                : Tue Feb 28 2004
    copyright            : (C) 2004 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef FLAC_ENCODER_H
#define FLAC_ENCODER_H

#include "config.h"

#include <QList>
#include <QVector>

#include <FLAC++/encoder.h>
#include <FLAC++/metadata.h>
#include <FLAC/format.h>

#include <vorbis/vorbisenc.h>

#include "libkwave/Encoder.h"
#include "libkwave/VorbisCommentMap.h"

class QIODevice;
class QWidget;

namespace Kwave
{

    class MultiTrackReader;

    class FlacEncoder: public Kwave::Encoder,
                       protected FLAC::Encoder::Stream
    {
    public:
        /** Constructor */
        FlacEncoder();

        /** Destructor */
        ~FlacEncoder() override;

        /** Returns a new instance of the encoder */
        Kwave::Encoder *instance() override;

        /**
         * Encodes a signal into a stream of bytes.
         * @param widget a widget that can be used for displaying
         *        message boxes or dialogs
         * @param src MultiTrackReader used as source of the audio data
         * @param dst file or other source to receive a stream of bytes
         * @param meta_data meta data of the file to save
         * @return true if succeeded, false on errors
         */
        virtual bool encode(QWidget *widget, Kwave::MultiTrackReader &src,
                            QIODevice &dst,
                            const Kwave::MetaDataList &meta_data)
            override;

        /** Returns a list of supported file properties */
        virtual QList<Kwave::FileProperty> supportedProperties()
            override;

    protected:

        /**
         * Callback for writing data to the FLAC layer
         *
         * @param buffer array with samples
         * @param bytes length of the buffer in bytes
         * @param samples the number of samples
         * @param current_frame index of the current frame
         * @return FLAC stream encoder write status
         */
        virtual ::FLAC__StreamEncoderWriteStatus write_callback(
            const FLAC__byte buffer[], size_t bytes,
            unsigned samples, unsigned current_frame) override;

        /**
         * Callback for encoding meta data
         *
         * @param metadata pointer to a FLAC metadata structure that will
         *        be filled
         */
        virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata)
            override;

        /**
         * Encode all Kwave file info into FLAC meta data
         *
         * @param info information about the file to be saved
         * @param flac_metadata QList with collects the FLAC metadata
         */
        virtual void encodeMetaData(const Kwave::FileInfo &info,
            QVector<FLAC__StreamMetadata *> &flac_metadata);

    protected:

        class VorbisCommentContainer
        {
        public:
            /** Constructor */
            VorbisCommentContainer();

            /** Destructor */
            virtual ~VorbisCommentContainer();

            /**
             * add a new comment
             *
             * @param tag name of the vorbis tag, as string
             * @param value the value of the tag, as string
             */
            void add(const QString &tag, const QString &value);

            /** Returns a pointer to the FLAC metadata */
            FLAC__StreamMetadata *data();

        private:
            /** list of metadata objects */
            FLAC__StreamMetadata *m_vc;
        };

    private:

        /** map for translating vorbis comments to FileInfo properties */
        Kwave::VorbisCommentMap m_vorbis_comment_map;

        /** pointer to the QIODevice for storing, used while encoding */
        QIODevice *m_dst;

    };
}

#endif /* FLAC_ENCODER_H */

//***************************************************************************
//***************************************************************************