FLAC 1.5.0 Free Lossless Audio Codec

encoder.h
Go to the documentation of this file.
1/* libFLAC++ - Free Lossless Audio Codec library
2 * Copyright (C) 2002-2009 Josh Coalson
3 * Copyright (C) 2011-2025 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
79 namespace FLAC {
80 namespace Encoder {
81
102 class FLACPP_API Stream {
103 public:
106 class FLACPP_API State {
107 public:
108 inline State(::FLAC__StreamEncoderState state): state_(state) { }
109 inline operator ::FLAC__StreamEncoderState() const { return state_; }
110 inline const char *as_cstring() const { return ::FLAC__StreamEncoderStateString[state_]; }
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
120
124 virtual bool is_valid() const;
125 inline operator bool() const { return is_valid(); }
127
128 virtual bool set_ogg_serial_number(long value);
129 virtual bool set_verify(bool value);
130 virtual bool set_streamable_subset(bool value);
131 virtual bool set_channels(uint32_t value);
132 virtual bool set_bits_per_sample(uint32_t value);
133 virtual bool set_sample_rate(uint32_t value);
134 virtual bool set_compression_level(uint32_t value);
135 virtual bool set_blocksize(uint32_t value);
136 virtual bool set_do_mid_side_stereo(bool value);
137 virtual bool set_loose_mid_side_stereo(bool value);
138 virtual bool set_apodization(const char *specification);
139 virtual bool set_max_lpc_order(uint32_t value);
140 virtual bool set_qlp_coeff_precision(uint32_t value);
141 virtual bool set_do_qlp_coeff_prec_search(bool value);
142 virtual bool set_do_escape_coding(bool value);
143 virtual bool set_do_exhaustive_model_search(bool value);
144 virtual bool set_min_residual_partition_order(uint32_t value);
145 virtual bool set_max_residual_partition_order(uint32_t value);
146 virtual bool set_rice_parameter_search_dist(uint32_t value);
147 virtual bool set_total_samples_estimate(FLAC__uint64 value);
148 virtual bool set_metadata(::FLAC__StreamMetadata **metadata, uint32_t num_blocks);
149 virtual bool set_metadata(FLAC::Metadata::Prototype **metadata, uint32_t num_blocks);
150 virtual bool set_limit_min_bitrate(bool value);
151 virtual uint32_t set_num_threads(uint32_t value);
152
153 /* get_state() is not virtual since we want subclasses to be able to return their own state */
154 State get_state() const;
155 virtual Decoder::Stream::State get_verify_decoder_state() const;
156 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);
157 virtual bool get_verify() const;
158 virtual bool get_streamable_subset() const;
159 virtual bool get_do_mid_side_stereo() const;
160 virtual bool get_loose_mid_side_stereo() const;
161 virtual uint32_t get_channels() const;
162 virtual uint32_t get_bits_per_sample() const;
163 virtual uint32_t get_sample_rate() const;
164 virtual uint32_t get_blocksize() const;
165 virtual uint32_t get_max_lpc_order() const;
166 virtual uint32_t get_qlp_coeff_precision() const;
167 virtual bool get_do_qlp_coeff_prec_search() const;
168 virtual bool get_do_escape_coding() const;
169 virtual bool get_do_exhaustive_model_search() const;
170 virtual uint32_t get_min_residual_partition_order() const;
171 virtual uint32_t get_max_residual_partition_order() const;
172 virtual uint32_t get_rice_parameter_search_dist() const;
173 virtual FLAC__uint64 get_total_samples_estimate() const;
174 virtual bool get_limit_min_bitrate() const;
175 virtual uint32_t get_num_threads() const;
176
177 virtual ::FLAC__StreamEncoderInitStatus init();
178 virtual ::FLAC__StreamEncoderInitStatus init_ogg();
179
180 virtual bool finish();
181
182 virtual bool process(const FLAC__int32 * const buffer[], uint32_t samples);
183 virtual bool process_interleaved(const FLAC__int32 buffer[], uint32_t samples);
184 protected:
186 virtual ::FLAC__StreamEncoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
187
189 virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame) = 0;
190
192 virtual ::FLAC__StreamEncoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
193
195 virtual ::FLAC__StreamEncoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
196
198 virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata);
199
200#if (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)
201 // lame hack: some compilers can't see a protected encoder_ from nested State::resolved_as_cstring()
202 friend State;
203#endif
204 ::FLAC__StreamEncoder *encoder_;
205
206 static ::FLAC__StreamEncoderReadStatus read_callback_(const ::FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
207 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);
208 static ::FLAC__StreamEncoderSeekStatus seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
209 static ::FLAC__StreamEncoderTellStatus tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
210 static void metadata_callback_(const ::FLAC__StreamEncoder *encoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
211 private:
212 // Private and undefined so you can't use them:
213 Stream(const Stream &);
214 void operator=(const Stream &);
215 };
216
237 class FLACPP_API File: public Stream {
238 public:
239 File();
240 virtual ~File();
241
242 using Stream::init;
243 virtual ::FLAC__StreamEncoderInitStatus init(FILE *file);
244 virtual ::FLAC__StreamEncoderInitStatus init(const char *filename);
245 virtual ::FLAC__StreamEncoderInitStatus init(const std::string &filename);
246 using Stream::init_ogg;
247 virtual ::FLAC__StreamEncoderInitStatus init_ogg(FILE *file);
248 virtual ::FLAC__StreamEncoderInitStatus init_ogg(const char *filename);
249 virtual ::FLAC__StreamEncoderInitStatus init_ogg(const std::string &filename);
250 protected:
252 virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate);
253
255 virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame);
256 private:
257 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);
258
259 // Private and undefined so you can't use them:
260 File(const Stream &);
261 void operator=(const Stream &);
262 };
263
264 }
265}
266
267#endif
export.h
This module contains #defines and symbols for exporting function calls, and providing version informa...
metadata.h
This module provides functions for creating and manipulating FLAC metadata blocks in memory,...
FLAC::Decoder::Stream::State
Definition: decoder.h:104
FLAC::Encoder::File
This class wraps the FLAC__StreamEncoder. If you are not encoding to a file, you may need to use FLAC...
Definition: encoder.h:237
FLAC::Encoder::File::init_ogg
virtual ::FLAC__StreamEncoderInitStatus init_ogg(const char *filename)
See FLAC__stream_encoder_init_ogg_file()
FLAC::Encoder::File::init_ogg
virtual ::FLAC__StreamEncoderInitStatus init_ogg(const std::string &filename)
See FLAC__stream_encoder_init_ogg_file()
FLAC::Encoder::File::init
virtual ::FLAC__StreamEncoderInitStatus init(const char *filename)
See FLAC__stream_encoder_init_file()
FLAC::Encoder::File::init
virtual ::FLAC__StreamEncoderInitStatus init(const std::string &filename)
See FLAC__stream_encoder_init_file()
FLAC::Encoder::File::init_ogg
virtual ::FLAC__StreamEncoderInitStatus init_ogg(FILE *file)
See FLAC__stream_encoder_init_ogg_FILE()
FLAC::Encoder::File::write_callback
virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame)
This is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied intern...
FLAC::Encoder::File::progress_callback
virtual void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate)
See FLAC__StreamEncoderProgressCallback.
FLAC::Encoder::File::init
virtual ::FLAC__StreamEncoderInitStatus init(FILE *file)
See FLAC__stream_encoder_init_FILE()
FLAC::Encoder::Stream::State
Definition: encoder.h:106
FLAC::Encoder::Stream
This class wraps the FLAC__StreamEncoder. If you are encoding to a file, FLAC::Encoder::File may be m...
Definition: encoder.h:102
FLAC::Encoder::Stream::get_do_mid_side_stereo
virtual bool get_do_mid_side_stereo() const
See FLAC__stream_encoder_get_do_mid_side_stereo()
FLAC::Encoder::Stream::set_do_mid_side_stereo
virtual bool set_do_mid_side_stereo(bool value)
See FLAC__stream_encoder_set_do_mid_side_stereo()
FLAC::Encoder::Stream::set_max_residual_partition_order
virtual bool set_max_residual_partition_order(uint32_t value)
See FLAC__stream_encoder_set_max_residual_partition_order()
FLAC::Encoder::Stream::get_do_exhaustive_model_search
virtual bool get_do_exhaustive_model_search() const
See FLAC__stream_encoder_get_do_exhaustive_model_search()
FLAC::Encoder::Stream::init
virtual ::FLAC__StreamEncoderInitStatus init()
See FLAC__stream_encoder_init_stream()
FLAC::Encoder::Stream::set_compression_level
virtual bool set_compression_level(uint32_t value)
See FLAC__stream_encoder_set_compression_level()
FLAC::Encoder::Stream::set_limit_min_bitrate
virtual bool set_limit_min_bitrate(bool value)
See FLAC__stream_encoder_set_limit_min_bitrate()
FLAC::Encoder::Stream::get_verify_decoder_error_stats
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()
FLAC::Encoder::Stream::set_do_exhaustive_model_search
virtual bool set_do_exhaustive_model_search(bool value)
See FLAC__stream_encoder_set_do_exhaustive_model_search()
FLAC::Encoder::Stream::get_num_threads
virtual uint32_t get_num_threads() const
See FLAC__stream_encoder_get_num_threads()
FLAC::Encoder::Stream::set_blocksize
virtual bool set_blocksize(uint32_t value)
See FLAC__stream_encoder_set_blocksize()
FLAC::Encoder::Stream::set_min_residual_partition_order
virtual bool set_min_residual_partition_order(uint32_t value)
See FLAC__stream_encoder_set_min_residual_partition_order()
FLAC::Encoder::Stream::read_callback
virtual ::FLAC__StreamEncoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes)
See FLAC__StreamEncoderReadCallback.
FLAC::Encoder::Stream::set_do_escape_coding
virtual bool set_do_escape_coding(bool value)
See FLAC__stream_encoder_set_do_escape_coding()
FLAC::Encoder::Stream::set_apodization
virtual bool set_apodization(const char *specification)
See FLAC__stream_encoder_set_apodization()
FLAC::Encoder::Stream::get_streamable_subset
virtual bool get_streamable_subset() const
See FLAC__stream_encoder_get_streamable_subset()
FLAC::Encoder::Stream::get_bits_per_sample
virtual uint32_t get_bits_per_sample() const
See FLAC__stream_encoder_get_bits_per_sample()
FLAC::Encoder::Stream::tell_callback
virtual ::FLAC__StreamEncoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset)
See FLAC__StreamEncoderTellCallback.
FLAC::Encoder::Stream::set_sample_rate
virtual bool set_sample_rate(uint32_t value)
See FLAC__stream_encoder_set_sample_rate()
FLAC::Encoder::Stream::set_total_samples_estimate
virtual bool set_total_samples_estimate(FLAC__uint64 value)
See FLAC__stream_encoder_set_total_samples_estimate()
FLAC::Encoder::Stream::set_metadata
virtual bool set_metadata(FLAC::Metadata::Prototype **metadata, uint32_t num_blocks)
See FLAC__stream_encoder_set_metadata()
FLAC::Encoder::Stream::set_qlp_coeff_precision
virtual bool set_qlp_coeff_precision(uint32_t value)
See FLAC__stream_encoder_set_qlp_coeff_precision()
FLAC::Encoder::Stream::set_channels
virtual bool set_channels(uint32_t value)
See FLAC__stream_encoder_set_channels()
FLAC::Encoder::Stream::init_ogg
virtual ::FLAC__StreamEncoderInitStatus init_ogg()
See FLAC__stream_encoder_init_ogg_stream()
FLAC::Encoder::Stream::set_bits_per_sample
virtual bool set_bits_per_sample(uint32_t value)
See FLAC__stream_encoder_set_bits_per_sample()
FLAC::Encoder::Stream::is_valid
virtual bool is_valid() const
FLAC::Encoder::Stream::get_loose_mid_side_stereo
virtual bool get_loose_mid_side_stereo() const
See FLAC__stream_encoder_get_loose_mid_side_stereo()
FLAC::Encoder::Stream::get_max_residual_partition_order
virtual uint32_t get_max_residual_partition_order() const
See FLAC__stream_encoder_get_max_residual_partition_order()
FLAC::Encoder::Stream::get_blocksize
virtual uint32_t get_blocksize() const
See FLAC__stream_encoder_get_blocksize()
FLAC::Encoder::Stream::get_do_qlp_coeff_prec_search
virtual bool get_do_qlp_coeff_prec_search() const
See FLAC__stream_encoder_get_do_qlp_coeff_prec_search()
FLAC::Encoder::Stream::seek_callback
virtual ::FLAC__StreamEncoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset)
See FLAC__StreamEncoderSeekCallback.
FLAC::Encoder::Stream::set_rice_parameter_search_dist
virtual bool set_rice_parameter_search_dist(uint32_t value)
See FLAC__stream_encoder_set_rice_parameter_search_dist()
FLAC::Encoder::Stream::get_qlp_coeff_precision
virtual uint32_t get_qlp_coeff_precision() const
See FLAC__stream_encoder_get_qlp_coeff_precision()
FLAC::Encoder::Stream::set_verify
virtual bool set_verify(bool value)
See FLAC__stream_encoder_set_verify()
FLAC::Encoder::Stream::set_streamable_subset
virtual bool set_streamable_subset(bool value)
See FLAC__stream_encoder_set_streamable_subset()
FLAC::Encoder::Stream::get_verify_decoder_state
virtual Decoder::Stream::State get_verify_decoder_state() const
See FLAC__stream_encoder_get_verify_decoder_state()
FLAC::Encoder::Stream::get_channels
virtual uint32_t get_channels() const
See FLAC__stream_encoder_get_channels()
FLAC::Encoder::Stream::set_do_qlp_coeff_prec_search
virtual bool set_do_qlp_coeff_prec_search(bool value)
See FLAC__stream_encoder_set_do_qlp_coeff_prec_search()
FLAC::Encoder::Stream::set_num_threads
virtual uint32_t set_num_threads(uint32_t value)
See FLAC__stream_encoder_set_num_threads()
FLAC::Encoder::Stream::get_state
State get_state() const
See FLAC__stream_encoder_get_state()
FLAC::Encoder::Stream::get_verify
virtual bool get_verify() const
See FLAC__stream_encoder_get_verify()
FLAC::Encoder::Stream::set_loose_mid_side_stereo
virtual bool set_loose_mid_side_stereo(bool value)
See FLAC__stream_encoder_set_loose_mid_side_stereo()
FLAC::Encoder::Stream::get_max_lpc_order
virtual uint32_t get_max_lpc_order() const
See FLAC__stream_encoder_get_max_lpc_order()
FLAC::Encoder::Stream::get_rice_parameter_search_dist
virtual uint32_t get_rice_parameter_search_dist() const
See FLAC__stream_encoder_get_rice_parameter_search_dist()
FLAC::Encoder::Stream::get_do_escape_coding
virtual bool get_do_escape_coding() const
See FLAC__stream_encoder_get_do_escape_coding()
FLAC::Encoder::Stream::get_min_residual_partition_order
virtual uint32_t get_min_residual_partition_order() const
See FLAC__stream_encoder_get_min_residual_partition_order()
FLAC::Encoder::Stream::set_metadata
virtual bool set_metadata(::FLAC__StreamMetadata **metadata, uint32_t num_blocks)
See FLAC__stream_encoder_set_metadata()
FLAC::Encoder::Stream::process
virtual bool process(const FLAC__int32 *const buffer[], uint32_t samples)
See FLAC__stream_encoder_process()
FLAC::Encoder::Stream::get_sample_rate
virtual uint32_t get_sample_rate() const
See FLAC__stream_encoder_get_sample_rate()
FLAC::Encoder::Stream::get_limit_min_bitrate
virtual bool get_limit_min_bitrate() const
See FLAC__stream_encoder_get_limit_min_bitrate()
FLAC::Encoder::Stream::process_interleaved
virtual bool process_interleaved(const FLAC__int32 buffer[], uint32_t samples)
See FLAC__stream_encoder_process_interleaved()
FLAC::Encoder::Stream::get_total_samples_estimate
virtual FLAC__uint64 get_total_samples_estimate() const
See FLAC__stream_encoder_get_total_samples_estimate()
FLAC::Encoder::Stream::write_callback
virtual ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame)=0
See FLAC__StreamEncoderWriteCallback.
FLAC::Encoder::Stream::finish
virtual bool finish()
See FLAC__stream_encoder_finish()
FLAC::Encoder::Stream::metadata_callback
virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata)
See FLAC__StreamEncoderMetadataCallback.
FLAC::Encoder::Stream::set_ogg_serial_number
virtual bool set_ogg_serial_number(long value)
See FLAC__stream_encoder_set_ogg_serial_number()
FLAC::Encoder::Stream::set_max_lpc_order
virtual bool set_max_lpc_order(uint32_t value)
See FLAC__stream_encoder_set_max_lpc_order()
FLAC::Metadata::Prototype
Definition: metadata.h:109
decoder.h
This module contains the classes which implement the various decoders.
FLAC__StreamEncoderState
FLAC__StreamEncoderState
Definition: stream_encoder.h:241
FLACPP_API
#define FLACPP_API
Definition: export.h:88
stream_encoder.h
This module contains the functions which implement the stream encoder.
FLAC__StreamEncoder
Definition: stream_encoder.h:469
FLAC__StreamMetadata
Definition: format.h:841

Copyright (c) 2000-2009 Josh Coalson Copyright (c) 2011-2025 Xiph.Org Foundation