1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001,2002 Josh Coalson
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef FLAC__STREAM_ENCODER_H
21 #define FLAC__STREAM_ENCODER_H
30 /** \file include/FLAC/stream_encoder.h
33 * This module contains the functions which implement the stream
36 * See the detailed documentation in the
37 * \link flac_stream_encoder stream encoder \endlink module.
40 /** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
44 * This module describes the single encoder layer provided by libFLAC.
46 * Currently there is only one level of encoder implementation which is at
47 * the stream level. There is currently no file encoder because seeking
48 * within a file while encoding seemed like too obscure a feature.
51 /** \defgroup flac_encoder FLAC/*_encoder.h: encoder interfaces
56 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
57 * \ingroup flac_encoder
60 * This module contains the functions which implement the stream
63 * The basic usage of this encoder is as follows:
64 * - The program creates an instance of an encoder using
65 * FLAC__stream_encoder_new().
66 * - The program overrides the default settings and sets callbacks for
67 * writing and metadata reporting using
68 * FLAC__stream_encoder_set_*() functions.
69 * - The program initializes the instance to validate the settings and
70 * prepare for encoding using FLAC__stream_encoder_init().
71 * - The program calls FLAC__stream_encoder_process() or
72 * FLAC__stream_encoder_process_interleaved() to encode data, which
73 * subsequently calls the callbacks when there is encoder data ready
75 * - The program finishes the encoding with FLAC__stream_encoder_finish(),
76 * which causes the encoder to encode any data still in its input pipe,
77 * call the metadata callback with the final encoding statistics, and
78 * finally reset the encoder to the uninitialized state.
79 * - The instance may be used again or deleted with
80 * FLAC__stream_encoder_delete().
82 * In more detail, the stream encoder functions similarly to the
83 * \link flac_stream_decoder stream decoder \endlink, but has fewer
84 * callbacks and more options. Typically the user will create a new
85 * instance by calling FLAC__stream_encoder_new(), then set the necessary
86 * parameters and callbacks with FLAC__stream_encoder_set_*(), and
87 * initialize it by calling FLAC__stream_encoder_init().
89 * Unlike the decoders, the stream encoder has many options that can
90 * affect the speed and compression ratio. When setting these parameters
91 * you should have some basic knowledge of the format (see the
92 * <A HREF="../documentation.html#format">user-level documentation</A>
93 * or the <A HREF="../format.html">formal description</A>). The
94 * FLAC__stream_encoder_set_*() functions themselves do not validate the
95 * values as many are interdependent. The FLAC__stream_encoder_init()
96 * function will do this, so make sure to pay attention to the state
97 * returned by FLAC__stream_encoder_init() to make sure that it is
98 * FLAC__STREAM_ENCODER_OK. Any parameters that are not set before
99 * FLAC__stream_encoder_init() will take on the defaults from the
102 * The user must provide function pointers for the following callbacks:
104 * - Write callback - This function is called by the encoder anytime there
105 * is raw encoded data to write. It may include metadata mixed with
106 * encoded audio frames and the data is not guaranteed to be aligned on
107 * frame or metadata block boundaries.
108 * - Metadata callback - This function is called once at the end of
109 * encoding with the populated STREAMINFO structure. This is so file
110 * encoders can seek back to the beginning of the file and write the
111 * STREAMINFO block with the correct statistics after encoding (like
112 * minimum/maximum frame size).
114 * The call to FLAC__stream_encoder_init() currently will also immediately
115 * call the write callback with the \c fLaC signature and all the encoded
118 * After initializing the instance, the user may feed audio data to the
119 * encoder in one of two ways:
121 * - Channel separate, through FLAC__stream_encoder_process() - The user
122 * will pass an array of pointers to buffers, one for each channel, to
123 * the encoder, each of the same length. The samples need not be
125 * - Channel interleaved, through
126 * FLAC__stream_encoder_process_interleaved() - The user will pass a single
127 * pointer to data that is channel-interleaved (i.e. channel0_sample0,
128 * channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
129 * Again, the samples need not be block-aligned but they must be
130 * sample-aligned, i.e. the first value should be channel0_sample0 and
131 * the last value channelN_sampleM.
133 * When the user is finished encoding data, it calls
134 * FLAC__stream_encoder_finish(), which causes the encoder to encode any
135 * data still in its input pipe, and call the metadata callback with the
136 * final encoding statistics. Then the instance may be deleted with
137 * FLAC__stream_encoder_delete() or initialized again to encode another
140 * For programs that write their own metadata, but that do not know the
141 * actual metadata until after encoding, it is advantageous to instruct
142 * the encoder to write a PADDING block of the correct size, so that
143 * instead of rewriting the whole stream after encoding, the program can
144 * just overwrite the PADDING block. If only the maximum size of the
145 * metadata is known, the program can write a slightly larger padding
146 * block, then split it after encoding.
148 * Make sure you understand how lengths are calculated. All FLAC metadata
149 * blocks have a 4 byte header which contains the type and length. This
150 * length does not include the 4 bytes of the header. See the format page
151 * for the specification of metadata blocks and their lengths.
154 * The "set" functions may only be called when the encoder is in the
155 * state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after
156 * FLAC__stream_encoder_new() or FLAC__stream_encoder_finish(), but
157 * before FLAC__stream_encoder_init(). If this is the case they will
158 * return \c true, otherwise \c false.
161 * FLAC__stream_encoder_finish() resets all settings to the constructor
162 * defaults, including the callbacks.
168 /** State values for a FLAC__StreamEncoder
170 * The encoder's state can be obtained by calling FLAC__stream_encoder_get_state().
174 FLAC__STREAM_ENCODER_OK = 0,
175 /**< The encoder is in the normal OK state. */
177 FLAC__STREAM_ENCODER_INVALID_CALLBACK,
178 /**< The encoder was initialized before setting all the required callbacks. */
180 FLAC__STREAM_ENCODER_INVALID_NUMBER_OF_CHANNELS,
181 /**< The encoder has an invalid setting for number of channels. */
183 FLAC__STREAM_ENCODER_INVALID_BITS_PER_SAMPLE,
184 /**< The encoder has an invalid setting for bits-per-sample.
185 * FLAC supports 4-32 bps but the reference encoder currently supports
189 FLAC__STREAM_ENCODER_INVALID_SAMPLE_RATE,
190 /**< The encoder has an invalid setting for the input sample rate. */
192 FLAC__STREAM_ENCODER_INVALID_BLOCK_SIZE,
193 /**< The encoder has an invalid setting for the block size. */
195 FLAC__STREAM_ENCODER_INVALID_QLP_COEFF_PRECISION,
196 /**< The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. */
198 FLAC__STREAM_ENCODER_MID_SIDE_CHANNELS_MISMATCH,
199 /**< Mid/side coding was specified but the number of channels is not equal to 2. */
201 FLAC__STREAM_ENCODER_MID_SIDE_SAMPLE_SIZE_MISMATCH,
204 FLAC__STREAM_ENCODER_ILLEGAL_MID_SIDE_FORCE,
205 /**< Loose mid/side coding was specified but mid/side coding was not. */
207 FLAC__STREAM_ENCODER_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER,
208 /**< The specified block size is less than the maximum LPC order. */
210 FLAC__STREAM_ENCODER_NOT_STREAMABLE,
211 /**< The encoder is bound to the "streamable subset" but other settings violate it. */
213 FLAC__STREAM_ENCODER_FRAMING_ERROR,
214 /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
216 FLAC__STREAM_ENCODER_INVALID_METADATA,
217 /**< The metadata input to the encoder is invalid. */
219 FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_ENCODING,
220 /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
222 FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_WRITING,
223 /**< The write_callback returned an error. */
225 FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR,
226 /**< Memory allocation failed. */
228 FLAC__STREAM_ENCODER_ALREADY_INITIALIZED,
229 /**< FLAC__stream_encoder_init() was called when the encoder was
230 * already initialized, usually because
231 * FLAC__stream_encoder_finish() was not called.
234 FLAC__STREAM_ENCODER_UNINITIALIZED
235 /**< The encoder is in the uninitialized state. */
237 } FLAC__StreamEncoderState;
239 /** Maps a FLAC__StreamEncoderState to a C string.
241 * Using a FLAC__StreamEncoderState as the index to this array
242 * will give the string equivalent. The contents should not be modified.
244 extern const char * const FLAC__StreamEncoderStateString[];
246 /** Return values for the FLAC__StreamEncoder write callback.
250 FLAC__STREAM_ENCODER_WRITE_OK = 0,
251 /**< The write was OK and encoding can continue. */
253 FLAC__STREAM_ENCODER_WRITE_FATAL_ERROR
254 /**< An unrecoverable error occurred. The encoder will return from the process call. */
256 } FLAC__StreamEncoderWriteStatus;
258 /** Maps a FLAC__StreamEncoderWriteStatus to a C string.
260 * Using a FLAC__StreamEncoderWriteStatus as the index to this array
261 * will give the string equivalent. The contents should not be modified.
263 extern const char * const FLAC__StreamEncoderWriteStatusString[];
266 /***********************************************************************
268 * class FLAC__StreamEncoder
270 ***********************************************************************/
272 struct FLAC__StreamEncoderProtected;
273 struct FLAC__StreamEncoderPrivate;
274 /** The opaque structure definition for the stream encoder type.
275 * See the \link flac_stream_encoder stream encoder module \endlink
276 * for a detailed description.
279 struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
280 struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
281 } FLAC__StreamEncoder;
284 /***********************************************************************
286 * Class constructor/destructor
288 ***********************************************************************/
290 /** Create a new stream encoder instance. The instance is created with
291 * default settings; see the individual FLAC__stream_encoder_set_*()
292 * functions for each setting's default.
294 * \retval FLAC__StreamEncoder*
295 * \c NULL if there was an error allocating memory, else the new instance.
297 FLAC__StreamEncoder *FLAC__stream_encoder_new();
299 /** Free an encoder instance. Deletes the object pointed to by \a encoder.
301 * \param encoder A pointer to an existing encoder.
303 * \code encoder != NULL \endcode
305 void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder);
307 /***********************************************************************
309 * Public class method prototypes
311 ***********************************************************************/
313 /** Set the "streamable subset" flag. If \c true, the encoder will comply
314 * with the subset (see the format specification) and will check the
315 * settings during FLAC__stream_encoder_init() to see if all settings
316 * comply. If \c false, the settings may take advantage of the full
317 * range that the format allows.
319 * Make sure you know what it entails before setting this to \c false.
322 * \param encoder An encoder instance to set.
323 * \param value Flag value (see above).
325 * \code encoder != NULL \endcode
327 * \c false if the encoder is already initialized, else \c true.
329 FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
331 /** Set to \c true to enable mid-side encoding on stereo input. The
332 * number of channels must be 2. Set to \c false to use only
333 * independent channel coding.
336 * \param encoder An encoder instance to set.
337 * \param value Flag value (see above).
339 * \code encoder != NULL \endcode
341 * \c false if the encoder is already initialized, else \c true.
343 FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
345 /** Set to \c true to enable adaptive switching between mid-side and
346 * left-right encoding on stereo input. The number of channels must
347 * be 2. Set to \c false to use exhaustive searching. In either
348 * case, the mid/side stereo setting must be \c true.
351 * \param encoder An encoder instance to set.
352 * \param value Flag value (see above).
354 * \code encoder != NULL \endcode
356 * \c false if the encoder is already initialized, else \c true.
358 FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
360 /** Set the number of channels to be encoded.
363 * \param encoder An encoder instance to set.
364 * \param value See above.
366 * \code encoder != NULL \endcode
368 * \c false if the encoder is already initialized, else \c true.
370 FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value);
372 /** Set the sample resolution of the input to be encoded.
375 * Do not feed the encoder data that is wider than the value you
376 * set here or you will generate an invalid stream.
379 * \param encoder An encoder instance to set.
380 * \param value See above.
382 * \code encoder != NULL \endcode
384 * \c false if the encoder is already initialized, else \c true.
386 FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value);
388 /** Set the sample rate (in Hz) of the input to be encoded.
391 * \param encoder An encoder instance to set.
392 * \param value See above.
394 * \code encoder != NULL \endcode
396 * \c false if the encoder is already initialized, else \c true.
398 FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value);
400 /** Set the blocksize to use while encoding.
403 * \param encoder An encoder instance to set.
404 * \param value See above.
406 * \code encoder != NULL \endcode
408 * \c false if the encoder is already initialized, else \c true.
410 FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value);
412 /** Set the maximum LPC order, or \c 0 to use only the fixed predictors.
415 * \param encoder An encoder instance to set.
416 * \param value See above.
418 * \code encoder != NULL \endcode
420 * \c false if the encoder is already initialized, else \c true.
422 FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value);
424 /** Set the precision, in bits, of the quantized linear predictor
425 * coefficients, or \c 0 to let the encoder select it based on the
429 * In the current implementation, qlp_coeff_precision + bits_per_sample must
433 * \param encoder An encoder instance to set.
434 * \param value See above.
436 * \code encoder != NULL \endcode
438 * \c false if the encoder is already initialized, else \c true.
440 FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value);
442 /** Set to \c false to use only the specified quantized linear predictor
443 * coefficient precision, or \c true to search neighboring precision
444 * values and use the best one.
447 * \param encoder An encoder instance to set.
448 * \param value See above.
450 * \code encoder != NULL \endcode
452 * \c false if the encoder is already initialized, else \c true.
454 FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
456 /** Deprecated. Setting this value has no effect.
459 * \param encoder An encoder instance to set.
460 * \param value See above.
462 * \code encoder != NULL \endcode
464 * \c false if the encoder is already initialized, else \c true.
466 FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
468 /** Set to \c false to let the encoder estimate the best model order
469 * based on the residual signal energy, or \c true to force the
470 * encoder to evaluate all order models and select the best.
473 * \param encoder An encoder instance to set.
474 * \param value See above.
476 * \code encoder != NULL \endcode
478 * \c false if the encoder is already initialized, else \c true.
480 FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
482 /** Set the minimum partition order to search when coding the residual.
483 * This is used in tandem with
484 * FLAC__stream_encoder_set_max_residual_partition_order().
486 * The partition order determines the context size in the residual.
487 * The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
489 * Set both min and max values to \c 0 to force a single context,
490 * whose Rice parameter is based on the residual signal variance.
491 * Otherwise, set a min and max order, and the encoder will search
492 * all orders, using the mean of each context for its Rice parameter,
496 * \param encoder An encoder instance to set.
497 * \param value See above.
499 * \code encoder != NULL \endcode
501 * \c false if the encoder is already initialized, else \c true.
503 FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
505 /** Set the minimum partition order to search when coding the residual.
506 * This is used in tandem with
507 * FLAC__stream_encoder_set_min_residual_partition_order().
509 * The partition order determines the context size in the residual.
510 * The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
512 * Set both min and max values to \c 0 to force a single context,
513 * whose Rice parameter is based on the residual signal variance.
514 * Otherwise, set a min and max order, and the encoder will search
515 * all orders, using the mean of each context for its Rice parameter,
519 * \param encoder An encoder instance to set.
520 * \param value See above.
522 * \code encoder != NULL \endcode
524 * \c false if the encoder is already initialized, else \c true.
526 FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
528 /** Deprecated. Setting this value has no effect.
531 * \param encoder An encoder instance to set.
532 * \param value See above.
534 * \code encoder != NULL \endcode
536 * \c false if the encoder is already initialized, else \c true.
538 FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value);
540 /** Set an estimate of the total samples that will be encoded.
541 * This is merely an estimate and may be set to \c 0 if unknown.
542 * This value will be written to the STREAMINFO block before encoding,
543 * and can remove the need for the caller to rewrite the value later
544 * if the value is known before encoding.
547 * \param encoder An encoder instance to set.
548 * \param value See above.
550 * \code encoder != NULL \endcode
552 * \c false if the encoder is already initialized, else \c true.
554 FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
556 /** Set the metadata blocks to be emitted to the stream before encoding.
557 * A value of \c NULL, \c 0 implies no metadata; otherwise, supply an
558 * array of pointers to metadata blocks. The array is non-const since
559 * the encoder may need to change the \a is_last flag inside them.
560 * Otherwise, the encoder will not modify or free the blocks.
562 * The STREAMINFO block is always written and no STREAMINFO block may
563 * occur in the supplied array.
565 * \default \c NULL, 0
566 * \param encoder An encoder instance to set.
567 * \param value See above.
569 * \code encoder != NULL \endcode
571 * \c false if the encoder is already initialized, else \c true.
573 FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
575 /** Set the write callback.
576 * The supplied function will be called by the encoder anytime there is raw
577 * encoded data ready to write. It may include metadata mixed with encoded
578 * audio frames and the data is not guaranteed to be aligned on frame or
579 * metadata block boundaries.
582 * The callback is mandatory and must be set before initialization.
585 * \param encoder An encoder instance to set.
586 * \param value See above.
588 * \code encoder != NULL \endcode
589 * \code value != NULL \endcode
591 * \c false if the encoder is already initialized, else \c true.
593 FLAC__bool FLAC__stream_encoder_set_write_callback(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderWriteStatus (*value)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data));
595 /** Set the metadata callback.
596 * The supplied function will be called once at the end of encoding with
597 * the populated STREAMINFO structure. This is so file encoders can seek
598 * back to the beginning of the file and write the STREAMINFO block with
599 * the correct statistics after encoding (like minimum/maximum frame size
600 * and total samples).
603 * The callback is mandatory and must be set before initialization.
606 * \param encoder An encoder instance to set.
607 * \param value See above.
609 * \code encoder != NULL \endcode
610 * \code value != NULL \endcode
612 * \c false if the encoder is already initialized, else \c true.
614 FLAC__bool FLAC__stream_encoder_set_metadata_callback(FLAC__StreamEncoder *encoder, void (*value)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data));
616 /** Set the client data to be passed back to callbacks.
617 * This value will be supplied to callbacks in their \a client_data
621 * \param encoder An encoder instance to set.
622 * \param value See above.
624 * \code encoder != NULL \endcode
626 * \c false if the encoder is already initialized, else \c true.
628 FLAC__bool FLAC__stream_encoder_set_client_data(FLAC__StreamEncoder *encoder, void *value);
630 /** Get the current encoder state.
632 * \param encoder An encoder instance to query.
634 * \code encoder != NULL \endcode
635 * \retval FLAC__StreamEncoderState
636 * The current encoder state.
638 FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder);
640 /** Get the "streamable subset" flag.
642 * \param encoder An encoder instance to query.
644 * \code encoder != NULL \endcode
646 * See FLAC__stream_encoder_set_streamable_subset().
648 FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder);
650 /** Get the "mid/side stereo coding" flag.
652 * \param encoder An encoder instance to query.
654 * \code encoder != NULL \endcode
656 * See FLAC__stream_encoder_get_do_mid_side_stereo().
658 FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder);
660 /** Get the "adaptive mid/side switching" flag.
662 * \param encoder An encoder instance to query.
664 * \code encoder != NULL \endcode
666 * See FLAC__stream_encoder_set_loose_mid_side_stereo().
668 FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder);
670 /** Get the number of input channels being processed.
672 * \param encoder An encoder instance to query.
674 * \code encoder != NULL \endcode
676 * See FLAC__stream_encoder_set_channels().
678 unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder);
680 /** Get the input sample resolution setting.
682 * \param encoder An encoder instance to query.
684 * \code encoder != NULL \endcode
686 * See FLAC__stream_encoder_set_bits_per_sample().
688 unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder);
690 /** Get the input sample rate setting.
692 * \param encoder An encoder instance to query.
694 * \code encoder != NULL \endcode
696 * See FLAC__stream_encoder_set_sample_rate().
698 unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder);
700 /** Get the blocksize setting.
702 * \param encoder An encoder instance to query.
704 * \code encoder != NULL \endcode
706 * See FLAC__stream_encoder_set_blocksize().
708 unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder);
710 /** Get the maximum LPC order setting.
712 * \param encoder An encoder instance to query.
714 * \code encoder != NULL \endcode
716 * See FLAC__stream_encoder_set_max_lpc_order().
718 unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder);
720 /** Get the quantized linear predictor coefficient precision setting.
722 * \param encoder An encoder instance to query.
724 * \code encoder != NULL \endcode
726 * See FLAC__stream_encoder_set_qlp_coeff_precision().
728 unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder);
730 /** Get the qlp coefficient precision search flag.
732 * \param encoder An encoder instance to query.
734 * \code encoder != NULL \endcode
736 * See FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
738 FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder);
740 /** Get the "escape coding" flag.
742 * \param encoder An encoder instance to query.
744 * \code encoder != NULL \endcode
746 * See FLAC__stream_encoder_set_do_escape_coding().
748 FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder);
750 /** Get the exhaustive model search flag.
752 * \param encoder An encoder instance to query.
754 * \code encoder != NULL \endcode
756 * See FLAC__stream_encoder_set_do_exhaustive_model_search().
758 FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder);
760 /** Get the minimum residual partition order setting.
762 * \param encoder An encoder instance to query.
764 * \code encoder != NULL \endcode
766 * See FLAC__stream_encoder_set_min_residual_partition_order().
768 unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder);
770 /** Get maximum residual partition order setting.
772 * \param encoder An encoder instance to query.
774 * \code encoder != NULL \endcode
776 * See FLAC__stream_encoder_set_max_residual_partition_order().
778 unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder);
780 /** Get the Rice parameter search distance setting.
782 * \param encoder An encoder instance to query.
784 * \code encoder != NULL \endcode
786 * See FLAC__stream_encoder_set_rice_parameter_search_dist().
788 unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder);
790 /** Initialize the encoder instance.
791 * Should be called after FLAC__stream_encoder_new() and
792 * FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
793 * or FLAC__stream_encoder_process_interleaved(). Will set and return
794 * the encoder state, which will be FLAC__STREAM_ENCODER_OK if
795 * initialization succeeded.
797 * The call to FLAC__stream_encoder_init() currently will also immediately
798 * call the write callback with the \c fLaC signature and all the encoded
801 * \param encoder An uninitialized encoder instance.
803 * \code encoder != NULL \endcode
804 * \retval FLAC__StreamEncoderState
805 * \c FLAC__STREAM_ENCODER_OK if initialization was successful; see
806 * FLAC__StreamEncoderState for the meanings of other return values.
808 FLAC__StreamEncoderState FLAC__stream_encoder_init(FLAC__StreamEncoder *encoder);
810 /** Finish the encoding process.
811 * Flushes the encoding buffer, releases resources, and returns the encoder
812 * state to FLAC__STREAM_ENCODER_UNINITIALIZED. Note that this can
813 * generate one or more write callbacks before returning, and will
814 * generate a metadata callback.
816 * In the event of a prematurely-terminated encode, it is not strictly
817 * necessary to call this immediately before FLAC__stream_encoder_delete()
818 * but it is good practice to match every FLAC__stream_encoder_init()
819 * with a FLAC__stream_encoder_finish().
821 * \param encoder An uninitialized encoder instance.
823 * \code encoder != NULL \endcode
825 void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
827 /** Submit data for encoding.
828 * This version allows you to supply the input data via an array of
829 * pointers, each pointer pointing to an array of \a samples samples
830 * representing one channel. The samples need not be block-aligned,
831 * but each channel should have the same number of samples.
833 * \param encoder An initialized encoder instance in the OK state.
834 * \param buffer An array of pointers to each channel's signal.
835 * \param samples The number of samples in one channel.
837 * \code encoder != NULL \endcode
838 * \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
840 * \c true if successful, else \c false; in this case, check the
841 * encoder state with FLAC__stream_encoder_get_state() to see what
844 FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
846 /** Submit data for encoding.
847 * This version allows you to supply the input data where the channels
848 * are interleaved into a single array (i.e. channel0_sample0,
849 * channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
850 * The samples need not be block-aligned but they must be
851 * sample-aligned, i.e. the first value should be channel0_sample0
852 * and the last value channelN_sampleM.
855 * \param encoder An initialized encoder instance in the OK state.
856 * \param buffer An array of channel-interleaved data (see above).
857 * \param samples The number of samples in one channel, the same as for
858 * FLAC__stream_encoder_process(). For example, if
859 * encoding two channels, \c 1000 \a samples corresponds
860 * to a \a buffer of 2000 values.
862 * \code encoder != NULL \endcode
863 * \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
865 * \c true if successful, else \c false; in this case, check the
866 * encoder state with FLAC__stream_encoder_get_state() to see what
869 FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);