1 /* libFLAC++ - Free Lossless Audio Codec library
2  * Copyright (C) 2002-2009  Josh Coalson
3  * Copyright (C) 2011-2016  Xiph.Org Foundation
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * - Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * - Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * - Neither the name of the Xiph.org Foundation nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef FLACPP__ENCODER_H
34 #define FLACPP__ENCODER_H
35 
36 #include "export.h"
37 
38 #include "FLAC/stream_encoder.h"
39 #include "decoder.h"
40 #include "metadata.h"
41 
42 
43 /** \file include/FLAC++/encoder.h
44  *
45  *  \brief
46  *  This module contains the classes which implement the various
47  *  encoders.
48  *
49  *  See the detailed documentation in the
50  *  \link flacpp_encoder encoder \endlink module.
51  */
52 
53 /** \defgroup flacpp_encoder FLAC++/encoder.h: encoder classes
54  *  \ingroup flacpp
55  *
56  *  \brief
57  *  This module describes the encoder layers provided by libFLAC++.
58  *
59  * The libFLAC++ encoder classes are object wrappers around their
60  * counterparts in libFLAC.  All encoding layers available in
61  * libFLAC are also provided here.  The interface is very similar;
62  * make sure to read the \link flac_encoder libFLAC encoder module \endlink.
63  *
64  * There are only two significant differences here.  First, instead of
65  * passing in C function pointers for callbacks, you inherit from the
66  * encoder class and provide implementations for the callbacks in your
67  * derived class; because of this there is no need for a 'client_data'
68  * property.
69  *
70  * Second, there are two stream encoder classes.  FLAC::Encoder::Stream
71  * is used for the same cases that FLAC__stream_encoder_init_stream() /
72  * FLAC__stream_encoder_init_ogg_stream() are used, and FLAC::Encoder::File
73  * is used for the same cases that
74  * FLAC__stream_encoder_init_FILE() and FLAC__stream_encoder_init_file() /
75  * FLAC__stream_encoder_init_ogg_FILE() and FLAC__stream_encoder_init_ogg_file()
76  * are used.
77  */
78 
79 namespace FLAC {
80 	namespace Encoder {
81 
82 		/** \ingroup flacpp_encoder
83 		 *  \brief
84 		 *  This class wraps the ::FLAC__StreamEncoder.  If you are
85 		 *  encoding to a file, FLAC::Encoder::File may be more
86 		 *  convenient.
87 		 *
88 		 * The usage of this class is similar to FLAC__StreamEncoder,
89 		 * except instead of providing callbacks to
90 		 * FLAC__stream_encoder_init*_stream(), you will inherit from this
91 		 * class and override the virtual callback functions with your
92 		 * own implementations, then call init() or init_ogg().  The rest of
93 		 * the calls work the same as in the C layer.
94 		 *
95 		 * Only the write callback is mandatory.  The others are
96 		 * optional; this class provides default implementations that do
97 		 * nothing.  In order for some STREAMINFO and SEEKTABLE data to
98 		 * be written properly, you must override seek_callback() and
99 		 * tell_callback(); see FLAC__stream_encoder_init_stream() as to
100 		 * why.
101 		 */
102 		class FLACPP_API Stream {
103 		public:
104 			/** This class is a wrapper around FLAC__StreamEncoderState.
105 			 */
106 			class FLACPP_API State {
107 			public:
State(::FLAC__StreamEncoderState state)108 				inline State(::FLAC__StreamEncoderState state): state_(state) { }
FLAC__StreamEncoderState()109 				inline operator ::FLAC__StreamEncoderState() const { return state_; }
as_cstring()110 				inline const char *as_cstring() const { return ::FLAC__StreamEncoderStateString[state_]; }
resolved_as_cstring(const Stream & encoder)111 				inline const char *resolved_as_cstring(const Stream &encoder) const { return ::FLAC__stream_encoder_get_resolved_state_string(encoder.encoder_); }
112 			protected:
113 				::FLAC__StreamEncoderState state_;
114 			};
115 
116 			Stream();
117 			virtual ~Stream();
118 
119 			//@{
120 			/** Call after construction to check that the object was created
121 			 *  successfully.  If not, use get_state() to find out why not.
122 			 *
123 			 */
124 			virtual bool is_valid() const;
125 			inline operator bool() const { return is_valid(); } ///< See is_valid()
126 			//@}
127 
128 			virtual bool set_ogg_serial_number(long value);                 ///< See FLAC__stream_encoder_set_ogg_serial_number()
129 			virtual bool set_verify(bool value);                            ///< See FLAC__stream_encoder_set_verify()
130 			virtual bool set_streamable_subset(bool value);                 ///< See FLAC__stream_encoder_set_streamable_subset()
131 			virtual bool set_channels(uint32_t value);                      ///< See FLAC__stream_encoder_set_channels()
132 			virtual bool set_bits_per_sample(uint32_t value);               ///< See FLAC__stream_encoder_set_bits_per_sample()
133 			virtual bool set_sample_rate(uint32_t value);                   ///< See FLAC__stream_encoder_set_sample_rate()
134 			virtual bool set_compression_level(uint32_t value);             ///< See FLAC__stream_encoder_set_compression_level()
135 			virtual bool set_blocksize(uint32_t value);                     ///< See FLAC__stream_encoder_set_blocksize()
136 			virtual bool set_do_mid_side_stereo(bool value);                ///< See FLAC__stream_encoder_set_do_mid_side_stereo()
137 			virtual bool set_loose_mid_side_stereo(bool value);             ///< See FLAC__stream_encoder_set_loose_mid_side_stereo()
138 			virtual bool set_apodization(const char *specification);        ///< See FLAC__stream_encoder_set_apodization()
139 			virtual bool set_max_lpc_order(uint32_t value);                 ///< See FLAC__stream_encoder_set_max_lpc_order()
140 			virtual bool set_qlp_coeff_precision(uint32_t value);           ///< See FLAC__stream_encoder_set_qlp_coeff_precision()
141 			virtual bool set_do_qlp_coeff_prec_search(bool value);          ///< See FLAC__stream_encoder_set_do_qlp_coeff_prec_search()
142 			virtual bool set_do_escape_coding(bool value);                  ///< See FLAC__stream_encoder_set_do_escape_coding()
143 			virtual bool set_do_exhaustive_model_search(bool value);        ///< See FLAC__stream_encoder_set_do_exhaustive_model_search()
144 			virtual bool set_min_residual_partition_order(uint32_t value);  ///< See FLAC__stream_encoder_set_min_residual_partition_order()
145 			virtual bool set_max_residual_partition_order(uint32_t value);  ///< See FLAC__stream_encoder_set_max_residual_partition_order()
146 			virtual bool set_rice_parameter_search_dist(uint32_t value);    ///< See FLAC__stream_encoder_set_rice_parameter_search_dist()
147 			virtual bool set_total_samples_estimate(FLAC__uint64 value);    ///< See FLAC__stream_encoder_set_total_samples_estimate()
148 			virtual bool set_metadata(::FLAC__StreamMetadata **metadata, uint32_t num_blocks);    ///< See FLAC__stream_encoder_set_metadata()
149 			virtual bool set_metadata(FLAC::Metadata::Prototype **metadata, uint32_t num_blocks); ///< See FLAC__stream_encoder_set_metadata()
150 
151 			/* get_state() is not virtual since we want subclasses to be able to return their own state */
152 			State get_state() const;                                   ///< See FLAC__stream_encoder_get_state()
153 			virtual Decoder::Stream::State get_verify_decoder_state() const; ///< See FLAC__stream_encoder_get_verify_decoder_state()
154 			virtual void get_verify_decoder_error_stats(FLAC__uint64 *absolute_sample, uint32_t *frame_number, uint32_t *channel, uint32_t *sample, FLAC__int32 *expected, FLAC__int32 *got); ///< See FLAC__stream_encoder_get_verify_decoder_error_stats()
155 			virtual bool     get_verify() const;                       ///< See FLAC__stream_encoder_get_verify()
156 			virtual bool     get_streamable_subset() const;            ///< See FLAC__stream_encoder_get_streamable_subset()
157 			virtual bool     get_do_mid_side_stereo() const;           ///< See FLAC__stream_encoder_get_do_mid_side_stereo()
158 			virtual bool     get_loose_mid_side_stereo() const;        ///< See FLAC__stream_encoder_get_loose_mid_side_stereo()
159 			virtual uint32_t get_channels() const;                     ///< See FLAC__stream_encoder_get_channels()
160 			virtual uint32_t get_bits_per_sample() const;              ///< See FLAC__stream_encoder_get_bits_per_sample()
161 			virtual uint32_t get_sample_rate() const;                  ///< See FLAC__stream_encoder_get_sample_rate()
162 			virtual uint32_t get_blocksize() const;                    ///< See FLAC__stream_encoder_get_blocksize()
163 			virtual uint32_t get_max_lpc_order() const;                ///< See FLAC__stream_encoder_get_max_lpc_order()
164 			virtual uint32_t get_qlp_coeff_precision() const;          ///< See FLAC__stream_encoder_get_qlp_coeff_precision()
165 			virtual bool     get_do_qlp_coeff_prec_search() const;     ///< See FLAC__stream_encoder_get_do_qlp_coeff_prec_search()
166 			virtual bool     get_do_escape_coding() const;             ///< See FLAC__stream_encoder_get_do_escape_coding()
167 			virtual bool     get_do_exhaustive_model_search() const;   ///< See FLAC__stream_encoder_get_do_exhaustive_model_search()
168 			virtual uint32_t get_min_residual_partition_order() const; ///< See FLAC__stream_encoder_get_min_residual_partition_order()
169 			virtual uint32_t get_max_residual_partition_order() const; ///< See FLAC__stream_encoder_get_max_residual_partition_order()
170 			virtual uint32_t get_rice_parameter_search_dist() const;   ///< See FLAC__stream_encoder_get_rice_parameter_search_dist()
171 			virtual FLAC__uint64 get_total_samples_estimate() const;   ///< See FLAC__stream_encoder_get_total_samples_estimate()
172 
173 			virtual ::FLAC__StreamEncoderInitStatus init();            ///< See FLAC__stream_encoder_init_stream()
174 			virtual ::FLAC__StreamEncoderInitStatus init_ogg();        ///< See FLAC__stream_encoder_init_ogg_stream()
175 
176 			virtual bool finish(); ///< See FLAC__stream_encoder_finish()
177 
178 			virtual bool process(const FLAC__int32 * const buffer[], uint32_t samples);     ///< See FLAC__stream_encoder_process()
179 			virtual bool process_interleaved(const FLAC__int32 buffer[], uint32_t samples); ///< See FLAC__stream_encoder_process_interleaved()
180 		protected:
181 			/// See FLAC__StreamEncoderReadCallback
182 			virtual ::FLAC__StreamEncoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
183 
184 			/// See FLAC__StreamEncoderWriteCallback
185 			virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame) = 0;
186 
187 			/// See FLAC__StreamEncoderSeekCallback
188 			virtual ::FLAC__StreamEncoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
189 
190 			/// See FLAC__StreamEncoderTellCallback
191 			virtual ::FLAC__StreamEncoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
192 
193 			/// See FLAC__StreamEncoderMetadataCallback
194 			virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
195 
196 #if (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
197 			// lame hack: some compilers can't see a protected encoder_ from nested State::resolved_as_cstring()
198 			friend State;
199 #endif
200 			::FLAC__StreamEncoder *encoder_;
201 
202 			static ::FLAC__StreamEncoderReadStatus read_callback_(const ::FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
203 			static ::FLAC__StreamEncoderWriteStatus write_callback_(const ::FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data);
204 			static ::FLAC__StreamEncoderSeekStatus seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
205 			static ::FLAC__StreamEncoderTellStatus tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
206 			static void metadata_callback_(const ::FLAC__StreamEncoder *encoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
207 		private:
208 			// Private and undefined so you can't use them:
209 			Stream(const Stream &);
210 			void operator=(const Stream &);
211 		};
212 
213 		/** \ingroup flacpp_encoder
214 		 *  \brief
215 		 *  This class wraps the ::FLAC__StreamEncoder.  If you are
216 		 *  not encoding to a file, you may need to use
217 		 *  FLAC::Encoder::Stream.
218 		 *
219 		 * The usage of this class is similar to FLAC__StreamEncoder,
220 		 * except instead of providing callbacks to
221 		 * FLAC__stream_encoder_init*_FILE() or
222 		 * FLAC__stream_encoder_init*_file(), you will inherit from this
223 		 * class and override the virtual callback functions with your
224 		 * own implementations, then call init() or init_ogg().  The rest
225 		 * of the calls work the same as in the C layer.
226 		 *
227 		 * There are no mandatory callbacks; all the callbacks from
228 		 * FLAC::Encoder::Stream are implemented here fully and support
229 		 * full post-encode STREAMINFO and SEEKTABLE updating.  There is
230 		 * only an optional progress callback which you may override to
231 		 * get periodic reports on the progress of the encode.
232 		 */
233 		class FLACPP_API File: public Stream {
234 		public:
235 			File();
236 			virtual ~File();
237 
238 			using Stream::init;
239 			virtual ::FLAC__StreamEncoderInitStatus init(FILE *file);                      ///< See FLAC__stream_encoder_init_FILE()
240 			virtual ::FLAC__StreamEncoderInitStatus init(const char *filename);            ///< See FLAC__stream_encoder_init_file()
241 			virtual ::FLAC__StreamEncoderInitStatus init(const std::string &filename);     ///< See FLAC__stream_encoder_init_file()
242 			using Stream::init_ogg;
243 			virtual ::FLAC__StreamEncoderInitStatus init_ogg(FILE *file);                  ///< See FLAC__stream_encoder_init_ogg_FILE()
244 			virtual ::FLAC__StreamEncoderInitStatus init_ogg(const char *filename);        ///< See FLAC__stream_encoder_init_ogg_file()
245 			virtual ::FLAC__StreamEncoderInitStatus init_ogg(const std::string &filename); ///< See FLAC__stream_encoder_init_ogg_file()
246 		protected:
247 			/// See FLAC__StreamEncoderProgressCallback
248 			virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate);
249 
250 			/// This is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer
251 			virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame);
252 		private:
253 			static void progress_callback_(const ::FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate, void *client_data);
254 
255 			// Private and undefined so you can't use them:
256 			File(const Stream &);
257 			void operator=(const Stream &);
258 		};
259 
260 	}
261 }
262 
263 #endif
264