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 two encoder layers provided by libFLAC.
46 * For encoding FLAC streams, libFLAC provides two layers of access. The
47 * lowest layer is stream-level encoding, and the highest is file-level
48 * encoding. The interfaces are described in the \link flac_stream_encoder
49 * stream encoder \endlink and \link flac_file_encoder file encoder \endlink
50 * modules respectively. Typically you will choose the highest layer that
51 * your output source will support.
53 * The stream encoder relies on callbacks for writing the data and
54 * metadata. The file encoder provides these callbacks internally and you
55 * need only supply the filename.
58 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
59 * \ingroup flac_encoder
62 * This module contains the functions which implement the stream
65 * The basic usage of this encoder is as follows:
66 * - The program creates an instance of an encoder using
67 * FLAC__stream_encoder_new().
68 * - The program overrides the default settings and sets callbacks for
69 * writing and metadata reporting using
70 * FLAC__stream_encoder_set_*() functions.
71 * - The program initializes the instance to validate the settings and
72 * prepare for encoding using FLAC__stream_encoder_init().
73 * - The program calls FLAC__stream_encoder_process() or
74 * FLAC__stream_encoder_process_interleaved() to encode data, which
75 * subsequently calls the callbacks when there is encoder data ready
77 * - The program finishes the encoding with FLAC__stream_encoder_finish(),
78 * which causes the encoder to encode any data still in its input pipe,
79 * call the metadata callback with the final encoding statistics, and
80 * finally reset the encoder to the uninitialized state.
81 * - The instance may be used again or deleted with
82 * FLAC__stream_encoder_delete().
84 * In more detail, the stream encoder functions similarly to the
85 * \link flac_stream_decoder stream decoder \endlink, but has fewer
86 * callbacks and more options. Typically the user will create a new
87 * instance by calling FLAC__stream_encoder_new(), then set the necessary
88 * parameters and callbacks with FLAC__stream_encoder_set_*(), and
89 * initialize it by calling FLAC__stream_encoder_init().
91 * Unlike the decoders, the stream encoder has many options that can
92 * affect the speed and compression ratio. When setting these parameters
93 * you should have some basic knowledge of the format (see the
94 * <A HREF="../documentation.html#format">user-level documentation</A>
95 * or the <A HREF="../format.html">formal description</A>). The
96 * FLAC__stream_encoder_set_*() functions themselves do not validate the
97 * values as many are interdependent. The FLAC__stream_encoder_init()
98 * function will do this, so make sure to pay attention to the state
99 * returned by FLAC__stream_encoder_init() to make sure that it is
100 * FLAC__STREAM_ENCODER_OK. Any parameters that are not set before
101 * FLAC__stream_encoder_init() will take on the defaults from the
104 * The user must provide function pointers for the following callbacks:
106 * - Write callback - This function is called by the encoder anytime there
107 * is raw encoded data to write. It may include metadata mixed with
108 * encoded audio frames and the data is not guaranteed to be aligned on
109 * frame or metadata block boundaries.
110 * - Metadata callback - This function is called once at the end of
111 * encoding with the populated STREAMINFO structure. This is so file
112 * encoders can seek back to the beginning of the file and write the
113 * STREAMINFO block with the correct statistics after encoding (like
114 * minimum/maximum frame size).
116 * The call to FLAC__stream_encoder_init() currently will also immediately
117 * call the write callback several times, once with the \c fLaC signature,
118 * and once for each encoded metadata block.
120 * After initializing the instance, the user may feed audio data to the
121 * encoder in one of two ways:
123 * - Channel separate, through FLAC__stream_encoder_process() - The user
124 * will pass an array of pointers to buffers, one for each channel, to
125 * the encoder, each of the same length. The samples need not be
127 * - Channel interleaved, through
128 * FLAC__stream_encoder_process_interleaved() - The user will pass a single
129 * pointer to data that is channel-interleaved (i.e. channel0_sample0,
130 * channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
131 * Again, the samples need not be block-aligned but they must be
132 * sample-aligned, i.e. the first value should be channel0_sample0 and
133 * the last value channelN_sampleM.
135 * When the user is finished encoding data, it calls
136 * FLAC__stream_encoder_finish(), which causes the encoder to encode any
137 * data still in its input pipe, and call the metadata callback with the
138 * final encoding statistics. Then the instance may be deleted with
139 * FLAC__stream_encoder_delete() or initialized again to encode another
142 * For programs that write their own metadata, but that do not know the
143 * actual metadata until after encoding, it is advantageous to instruct
144 * the encoder to write a PADDING block of the correct size, so that
145 * instead of rewriting the whole stream after encoding, the program can
146 * just overwrite the PADDING block. If only the maximum size of the
147 * metadata is known, the program can write a slightly larger padding
148 * block, then split it after encoding.
150 * Make sure you understand how lengths are calculated. All FLAC metadata
151 * blocks have a 4 byte header which contains the type and length. This
152 * length does not include the 4 bytes of the header. See the format page
153 * for the specification of metadata blocks and their lengths.
156 * The "set" functions may only be called when the encoder is in the
157 * state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after
158 * FLAC__stream_encoder_new() or FLAC__stream_encoder_finish(), but
159 * before FLAC__stream_encoder_init(). If this is the case they will
160 * return \c true, otherwise \c false.
163 * FLAC__stream_encoder_finish() resets all settings to the constructor
164 * defaults, including the callbacks.
170 /** State values for a FLAC__StreamEncoder
172 * The encoder's state can be obtained by calling FLAC__stream_encoder_get_state().
176 FLAC__STREAM_ENCODER_OK = 0,
177 /**< The encoder is in the normal OK state. */
179 FLAC__STREAM_ENCODER_INVALID_CALLBACK,
180 /**< The encoder was initialized before setting all the required callbacks. */
182 FLAC__STREAM_ENCODER_INVALID_NUMBER_OF_CHANNELS,
183 /**< The encoder has an invalid setting for number of channels. */
185 FLAC__STREAM_ENCODER_INVALID_BITS_PER_SAMPLE,
186 /**< The encoder has an invalid setting for bits-per-sample.
187 * FLAC supports 4-32 bps but the reference encoder currently supports
191 FLAC__STREAM_ENCODER_INVALID_SAMPLE_RATE,
192 /**< The encoder has an invalid setting for the input sample rate. */
194 FLAC__STREAM_ENCODER_INVALID_BLOCK_SIZE,
195 /**< The encoder has an invalid setting for the block size. */
197 FLAC__STREAM_ENCODER_INVALID_QLP_COEFF_PRECISION,
198 /**< The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. */
200 FLAC__STREAM_ENCODER_MID_SIDE_CHANNELS_MISMATCH,
201 /**< Mid/side coding was specified but the number of channels is not equal to 2. */
203 FLAC__STREAM_ENCODER_MID_SIDE_SAMPLE_SIZE_MISMATCH,
206 FLAC__STREAM_ENCODER_ILLEGAL_MID_SIDE_FORCE,
207 /**< Loose mid/side coding was specified but mid/side coding was not. */
209 FLAC__STREAM_ENCODER_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER,
210 /**< The specified block size is less than the maximum LPC order. */
212 FLAC__STREAM_ENCODER_NOT_STREAMABLE,
213 /**< The encoder is bound to the "streamable subset" but other settings violate it. */
215 FLAC__STREAM_ENCODER_FRAMING_ERROR,
216 /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
218 FLAC__STREAM_ENCODER_INVALID_METADATA,
219 /**< The metadata input to the encoder is invalid. */
221 FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_ENCODING,
222 /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
224 FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_WRITING,
225 /**< The write_callback returned an error. */
227 FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR,
228 /**< Memory allocation failed. */
230 FLAC__STREAM_ENCODER_ALREADY_INITIALIZED,
231 /**< FLAC__stream_encoder_init() was called when the encoder was
232 * already initialized, usually because
233 * FLAC__stream_encoder_finish() was not called.
236 FLAC__STREAM_ENCODER_UNINITIALIZED
237 /**< The encoder is in the uninitialized state. */
239 } FLAC__StreamEncoderState;
241 /** Maps a FLAC__StreamEncoderState to a C string.
243 * Using a FLAC__StreamEncoderState as the index to this array
244 * will give the string equivalent. The contents should not be modified.
246 extern const char * const FLAC__StreamEncoderStateString[];
248 /** Return values for the FLAC__StreamEncoder write callback.
252 FLAC__STREAM_ENCODER_WRITE_STATUS_OK = 0,
253 /**< The write was OK and encoding can continue. */
255 FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR
256 /**< An unrecoverable error occurred. The encoder will return from the process call. */
258 } FLAC__StreamEncoderWriteStatus;
260 /** Maps a FLAC__StreamEncoderWriteStatus to a C string.
262 * Using a FLAC__StreamEncoderWriteStatus as the index to this array
263 * will give the string equivalent. The contents should not be modified.
265 extern const char * const FLAC__StreamEncoderWriteStatusString[];
268 /***********************************************************************
270 * class FLAC__StreamEncoder
272 ***********************************************************************/
274 struct FLAC__StreamEncoderProtected;
275 struct FLAC__StreamEncoderPrivate;
276 /** The opaque structure definition for the stream encoder type.
277 * See the \link flac_stream_encoder stream encoder module \endlink
278 * for a detailed description.
281 struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
282 struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
283 } FLAC__StreamEncoder;
286 typedef FLAC__StreamEncoderWriteStatus (*FLAC__StreamEncoderWriteCallback)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data);
287 typedef void (*FLAC__StreamEncoderMetadataCallback)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data);
290 /***********************************************************************
292 * Class constructor/destructor
294 ***********************************************************************/
296 /** Create a new stream encoder instance. The instance is created with
297 * default settings; see the individual FLAC__stream_encoder_set_*()
298 * functions for each setting's default.
300 * \retval FLAC__StreamEncoder*
301 * \c NULL if there was an error allocating memory, else the new instance.
303 FLAC__StreamEncoder *FLAC__stream_encoder_new();
305 /** Free an encoder instance. Deletes the object pointed to by \a encoder.
307 * \param encoder A pointer to an existing encoder.
309 * \code encoder != NULL \endcode
311 void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder);
313 /***********************************************************************
315 * Public class method prototypes
317 ***********************************************************************/
319 /** Set the "streamable subset" flag. If \c true, the encoder will comply
320 * with the subset (see the format specification) and will check the
321 * settings during FLAC__stream_encoder_init() to see if all settings
322 * comply. If \c false, the settings may take advantage of the full
323 * range that the format allows.
325 * Make sure you know what it entails before setting this to \c false.
328 * \param encoder An encoder instance to set.
329 * \param value Flag value (see above).
331 * \code encoder != NULL \endcode
333 * \c false if the encoder is already initialized, else \c true.
335 FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
337 /** Set to \c true to enable mid-side encoding on stereo input. The
338 * number of channels must be 2. Set to \c false to use only
339 * independent channel coding.
342 * \param encoder An encoder instance to set.
343 * \param value Flag value (see above).
345 * \code encoder != NULL \endcode
347 * \c false if the encoder is already initialized, else \c true.
349 FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
351 /** Set to \c true to enable adaptive switching between mid-side and
352 * left-right encoding on stereo input. The number of channels must
353 * be 2. Set to \c false to use exhaustive searching. In either
354 * case, the mid/side stereo setting must be \c true.
357 * \param encoder An encoder instance to set.
358 * \param value Flag value (see above).
360 * \code encoder != NULL \endcode
362 * \c false if the encoder is already initialized, else \c true.
364 FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
366 /** Set the number of channels to be encoded.
369 * \param encoder An encoder instance to set.
370 * \param value See above.
372 * \code encoder != NULL \endcode
374 * \c false if the encoder is already initialized, else \c true.
376 FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value);
378 /** Set the sample resolution of the input to be encoded.
381 * Do not feed the encoder data that is wider than the value you
382 * set here or you will generate an invalid stream.
385 * \param encoder An encoder instance to set.
386 * \param value See above.
388 * \code encoder != NULL \endcode
390 * \c false if the encoder is already initialized, else \c true.
392 FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value);
394 /** Set the sample rate (in Hz) of the input to be encoded.
397 * \param encoder An encoder instance to set.
398 * \param value See above.
400 * \code encoder != NULL \endcode
402 * \c false if the encoder is already initialized, else \c true.
404 FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value);
406 /** Set the blocksize to use while encoding.
409 * \param encoder An encoder instance to set.
410 * \param value See above.
412 * \code encoder != NULL \endcode
414 * \c false if the encoder is already initialized, else \c true.
416 FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value);
418 /** Set the maximum LPC order, or \c 0 to use only the fixed predictors.
421 * \param encoder An encoder instance to set.
422 * \param value See above.
424 * \code encoder != NULL \endcode
426 * \c false if the encoder is already initialized, else \c true.
428 FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value);
430 /** Set the precision, in bits, of the quantized linear predictor
431 * coefficients, or \c 0 to let the encoder select it based on the
435 * In the current implementation, qlp_coeff_precision + bits_per_sample must
439 * \param encoder An encoder instance to set.
440 * \param value See above.
442 * \code encoder != NULL \endcode
444 * \c false if the encoder is already initialized, else \c true.
446 FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value);
448 /** Set to \c false to use only the specified quantized linear predictor
449 * coefficient precision, or \c true to search neighboring precision
450 * values and use the best one.
453 * \param encoder An encoder instance to set.
454 * \param value See above.
456 * \code encoder != NULL \endcode
458 * \c false if the encoder is already initialized, else \c true.
460 FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
462 /** Deprecated. Setting this value has no effect.
465 * \param encoder An encoder instance to set.
466 * \param value See above.
468 * \code encoder != NULL \endcode
470 * \c false if the encoder is already initialized, else \c true.
472 FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
474 /** Set to \c false to let the encoder estimate the best model order
475 * based on the residual signal energy, or \c true to force the
476 * encoder to evaluate all order models and select the best.
479 * \param encoder An encoder instance to set.
480 * \param value See above.
482 * \code encoder != NULL \endcode
484 * \c false if the encoder is already initialized, else \c true.
486 FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
488 /** Set the minimum partition order to search when coding the residual.
489 * This is used in tandem with
490 * FLAC__stream_encoder_set_max_residual_partition_order().
492 * The partition order determines the context size in the residual.
493 * The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
495 * Set both min and max values to \c 0 to force a single context,
496 * whose Rice parameter is based on the residual signal variance.
497 * Otherwise, set a min and max order, and the encoder will search
498 * all orders, using the mean of each context for its Rice parameter,
502 * \param encoder An encoder instance to set.
503 * \param value See above.
505 * \code encoder != NULL \endcode
507 * \c false if the encoder is already initialized, else \c true.
509 FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
511 /** Set the minimum partition order to search when coding the residual.
512 * This is used in tandem with
513 * FLAC__stream_encoder_set_min_residual_partition_order().
515 * The partition order determines the context size in the residual.
516 * The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
518 * Set both min and max values to \c 0 to force a single context,
519 * whose Rice parameter is based on the residual signal variance.
520 * Otherwise, set a min and max order, and the encoder will search
521 * all orders, using the mean of each context for its Rice parameter,
525 * \param encoder An encoder instance to set.
526 * \param value See above.
528 * \code encoder != NULL \endcode
530 * \c false if the encoder is already initialized, else \c true.
532 FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
534 /** Deprecated. Setting this value has no effect.
537 * \param encoder An encoder instance to set.
538 * \param value See above.
540 * \code encoder != NULL \endcode
542 * \c false if the encoder is already initialized, else \c true.
544 FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value);
546 /** Set an estimate of the total samples that will be encoded.
547 * This is merely an estimate and may be set to \c 0 if unknown.
548 * This value will be written to the STREAMINFO block before encoding,
549 * and can remove the need for the caller to rewrite the value later
550 * if the value is known before encoding.
553 * \param encoder An encoder instance to set.
554 * \param value See above.
556 * \code encoder != NULL \endcode
558 * \c false if the encoder is already initialized, else \c true.
560 FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
562 /** Set the metadata blocks to be emitted to the stream before encoding.
563 * A value of \c NULL, \c 0 implies no metadata; otherwise, supply an
564 * array of pointers to metadata blocks. The array is non-const since
565 * the encoder may need to change the \a is_last flag inside them.
566 * Otherwise, the encoder will not modify or free the blocks. It is up
567 * to the caller to free the metadata blocks after encoding.
569 * The STREAMINFO block is always written and no STREAMINFO block may
570 * occur in the supplied array.
572 * \default \c NULL, 0
573 * \param encoder An encoder instance to set.
574 * \param metadata See above.
575 * \param num_blocks See above.
577 * \code encoder != NULL \endcode
579 * \c false if the encoder is already initialized, else \c true.
581 FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
583 /** Set the write callback.
584 * The supplied function will be called by the encoder anytime there is raw
585 * encoded data ready to write. It may include metadata mixed with encoded
586 * audio frames and the data is not guaranteed to be aligned on frame or
587 * metadata block boundaries.
589 * The only duty of the callback is to write out the \a bytes worth of data
590 * in \a buffer to the current position in the output stream. The arguments
591 * \a samples and \a current_frame are purely informational. If \a samples
592 * is greater than \c 0, then \a current_frame will hold the current frame
593 * number that is being written; otherwise, the write callback is being called
597 * The callback is mandatory and must be set before initialization.
600 * \param encoder An encoder instance to set.
601 * \param value See above.
603 * \code encoder != NULL \endcode
604 * \code value != NULL \endcode
606 * \c false if the encoder is already initialized, else \c true.
608 FLAC__bool FLAC__stream_encoder_set_write_callback(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderWriteCallback value);
610 /** Set the metadata callback.
611 * The supplied function will be called once at the end of encoding with
612 * the populated STREAMINFO structure. This is so file encoders can seek
613 * back to the beginning of the file and write the STREAMINFO block with
614 * the correct statistics after encoding (like minimum/maximum frame size
615 * and total samples).
618 * The callback is mandatory and must be set before initialization.
621 * \param encoder An encoder instance to set.
622 * \param value See above.
624 * \code encoder != NULL \endcode
625 * \code value != NULL \endcode
627 * \c false if the encoder is already initialized, else \c true.
629 FLAC__bool FLAC__stream_encoder_set_metadata_callback(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderMetadataCallback value);
631 /** Set the client data to be passed back to callbacks.
632 * This value will be supplied to callbacks in their \a client_data
636 * \param encoder An encoder instance to set.
637 * \param value See above.
639 * \code encoder != NULL \endcode
641 * \c false if the encoder is already initialized, else \c true.
643 FLAC__bool FLAC__stream_encoder_set_client_data(FLAC__StreamEncoder *encoder, void *value);
645 /** Get the current encoder state.
647 * \param encoder An encoder instance to query.
649 * \code encoder != NULL \endcode
650 * \retval FLAC__StreamEncoderState
651 * The current encoder state.
653 FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder);
655 /** Get the "streamable subset" flag.
657 * \param encoder An encoder instance to query.
659 * \code encoder != NULL \endcode
661 * See FLAC__stream_encoder_set_streamable_subset().
663 FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder);
665 /** Get the "mid/side stereo coding" flag.
667 * \param encoder An encoder instance to query.
669 * \code encoder != NULL \endcode
671 * See FLAC__stream_encoder_get_do_mid_side_stereo().
673 FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder);
675 /** Get the "adaptive mid/side switching" flag.
677 * \param encoder An encoder instance to query.
679 * \code encoder != NULL \endcode
681 * See FLAC__stream_encoder_set_loose_mid_side_stereo().
683 FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder);
685 /** Get the number of input channels being processed.
687 * \param encoder An encoder instance to query.
689 * \code encoder != NULL \endcode
691 * See FLAC__stream_encoder_set_channels().
693 unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder);
695 /** Get the input sample resolution setting.
697 * \param encoder An encoder instance to query.
699 * \code encoder != NULL \endcode
701 * See FLAC__stream_encoder_set_bits_per_sample().
703 unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder);
705 /** Get the input sample rate setting.
707 * \param encoder An encoder instance to query.
709 * \code encoder != NULL \endcode
711 * See FLAC__stream_encoder_set_sample_rate().
713 unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder);
715 /** Get the blocksize setting.
717 * \param encoder An encoder instance to query.
719 * \code encoder != NULL \endcode
721 * See FLAC__stream_encoder_set_blocksize().
723 unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder);
725 /** Get the maximum LPC order setting.
727 * \param encoder An encoder instance to query.
729 * \code encoder != NULL \endcode
731 * See FLAC__stream_encoder_set_max_lpc_order().
733 unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder);
735 /** Get the quantized linear predictor coefficient precision setting.
737 * \param encoder An encoder instance to query.
739 * \code encoder != NULL \endcode
741 * See FLAC__stream_encoder_set_qlp_coeff_precision().
743 unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder);
745 /** Get the qlp coefficient precision search flag.
747 * \param encoder An encoder instance to query.
749 * \code encoder != NULL \endcode
751 * See FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
753 FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder);
755 /** Get the "escape coding" flag.
757 * \param encoder An encoder instance to query.
759 * \code encoder != NULL \endcode
761 * See FLAC__stream_encoder_set_do_escape_coding().
763 FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder);
765 /** Get the exhaustive model search flag.
767 * \param encoder An encoder instance to query.
769 * \code encoder != NULL \endcode
771 * See FLAC__stream_encoder_set_do_exhaustive_model_search().
773 FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder);
775 /** Get the minimum residual partition order setting.
777 * \param encoder An encoder instance to query.
779 * \code encoder != NULL \endcode
781 * See FLAC__stream_encoder_set_min_residual_partition_order().
783 unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder);
785 /** Get maximum residual partition order setting.
787 * \param encoder An encoder instance to query.
789 * \code encoder != NULL \endcode
791 * See FLAC__stream_encoder_set_max_residual_partition_order().
793 unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder);
795 /** Get the Rice parameter search distance setting.
797 * \param encoder An encoder instance to query.
799 * \code encoder != NULL \endcode
801 * See FLAC__stream_encoder_set_rice_parameter_search_dist().
803 unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder);
805 /** Initialize the encoder instance.
806 * Should be called after FLAC__stream_encoder_new() and
807 * FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
808 * or FLAC__stream_encoder_process_interleaved(). Will set and return
809 * the encoder state, which will be FLAC__STREAM_ENCODER_OK if
810 * initialization succeeded.
812 * The call to FLAC__stream_encoder_init() currently will also immediately
813 * call the write callback several times, once with the \c fLaC signature,
814 * and once for each encoded metadata block.
816 * \param encoder An uninitialized encoder instance.
818 * \code encoder != NULL \endcode
819 * \retval FLAC__StreamEncoderState
820 * \c FLAC__STREAM_ENCODER_OK if initialization was successful; see
821 * FLAC__StreamEncoderState for the meanings of other return values.
823 FLAC__StreamEncoderState FLAC__stream_encoder_init(FLAC__StreamEncoder *encoder);
825 /** Finish the encoding process.
826 * Flushes the encoding buffer, releases resources, resets the encoder
827 * settings to their defaults, and returns the encoder state to
828 * FLAC__STREAM_ENCODER_UNINITIALIZED. Note that this can generate
829 * one or more write callbacks before returning, and will generate
830 * a metadata callback.
832 * In the event of a prematurely-terminated encode, it is not strictly
833 * necessary to call this immediately before FLAC__stream_encoder_delete()
834 * but it is good practice to match every FLAC__stream_encoder_init()
835 * with a FLAC__stream_encoder_finish().
837 * \param encoder An uninitialized encoder instance.
839 * \code encoder != NULL \endcode
841 void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
843 /** Submit data for encoding.
844 * This version allows you to supply the input data via an array of
845 * pointers, each pointer pointing to an array of \a samples samples
846 * representing one channel. The samples need not be block-aligned,
847 * but each channel should have the same number of samples.
849 * \param encoder An initialized encoder instance in the OK state.
850 * \param buffer An array of pointers to each channel's signal.
851 * \param samples The number of samples in one channel.
853 * \code encoder != NULL \endcode
854 * \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
856 * \c true if successful, else \c false; in this case, check the
857 * encoder state with FLAC__stream_encoder_get_state() to see what
860 FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
862 /** Submit data for encoding.
863 * This version allows you to supply the input data where the channels
864 * are interleaved into a single array (i.e. channel0_sample0,
865 * channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
866 * The samples need not be block-aligned but they must be
867 * sample-aligned, i.e. the first value should be channel0_sample0
868 * and the last value channelN_sampleM.
870 * \param encoder An initialized encoder instance in the OK state.
871 * \param buffer An array of channel-interleaved data (see above).
872 * \param samples The number of samples in one channel, the same as for
873 * FLAC__stream_encoder_process(). For example, if
874 * encoding two channels, \c 1000 \a samples corresponds
875 * to a \a buffer of 2000 values.
877 * \code encoder != NULL \endcode
878 * \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
880 * \c true if successful, else \c false; in this case, check the
881 * encoder state with FLAC__stream_encoder_get_state() to see what
884 FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);