new seekable stream encoder and file encoder layers, not fully implemented yet
[flac.git] / include / FLAC / stream_encoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002  Josh Coalson
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #ifndef FLAC__STREAM_ENCODER_H
21 #define FLAC__STREAM_ENCODER_H
22
23 #include "format.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /** \file include/FLAC/stream_encoder.h
31  *
32  *  \brief
33  *  This module contains the functions which implement the stream
34  *  encoder.
35  *
36  *  See the detailed documentation in the
37  *  \link flac_stream_encoder stream encoder \endlink module.
38  */
39
40 /** \defgroup flac_encoder FLAC/ *_encoder.h: encoder interfaces
41  *  \ingroup flac
42  *
43  *  \brief
44  *  This module describes the two encoder layers provided by libFLAC.
45  *
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.
52  *
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.
56  */
57
58 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
59  *  \ingroup flac_encoder
60  *
61  *  \brief
62  *  This module contains the functions which implement the stream
63  *  encoder.
64  *
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
76  *   to be written.
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().
83  *
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().
90  *
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
102  * constructor.
103  *
104  * The user must provide function pointers for the following callbacks:
105  *
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).
115  *
116  * The call to FLAC__stream_encoder_init() currently will also immediately
117  * call the write callback with the \c fLaC signature and all the encoded
118  * metadata.
119  *
120  * After initializing the instance, the user may feed audio data to the
121  * encoder in one of two ways:
122  *
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
126  *   block-aligned.
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.
134  *
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
140  * stream.
141  *
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.
149  *
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.
154  *
155  * \note
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.
161  *
162  * \note
163  * FLAC__stream_encoder_finish() resets all settings to the constructor
164  * defaults, including the callbacks.
165  *
166  * \{
167  */
168
169
170 /** State values for a FLAC__StreamEncoder
171  *
172  *  The encoder's state can be obtained by calling FLAC__stream_encoder_get_state().
173  */
174 typedef enum {
175
176         FLAC__STREAM_ENCODER_OK = 0,
177         /**< The encoder is in the normal OK state. */
178
179         FLAC__STREAM_ENCODER_INVALID_CALLBACK,
180         /**< The encoder was initialized before setting all the required callbacks. */
181
182         FLAC__STREAM_ENCODER_INVALID_NUMBER_OF_CHANNELS,
183         /**< The encoder has an invalid setting for number of channels. */
184
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
188          * only up to 24 bps.
189          */
190
191         FLAC__STREAM_ENCODER_INVALID_SAMPLE_RATE,
192         /**< The encoder has an invalid setting for the input sample rate. */
193
194         FLAC__STREAM_ENCODER_INVALID_BLOCK_SIZE,
195         /**< The encoder has an invalid setting for the block size. */
196
197         FLAC__STREAM_ENCODER_INVALID_QLP_COEFF_PRECISION,
198         /**< The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. */
199
200         FLAC__STREAM_ENCODER_MID_SIDE_CHANNELS_MISMATCH,
201         /**< Mid/side coding was specified but the number of channels is not equal to 2. */
202
203         FLAC__STREAM_ENCODER_MID_SIDE_SAMPLE_SIZE_MISMATCH,
204         /**< Deprecated. */
205
206         FLAC__STREAM_ENCODER_ILLEGAL_MID_SIDE_FORCE,
207         /**< Loose mid/side coding was specified but mid/side coding was not. */
208
209         FLAC__STREAM_ENCODER_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER,
210         /**< The specified block size is less than the maximum LPC order. */
211
212         FLAC__STREAM_ENCODER_NOT_STREAMABLE,
213         /**< The encoder is bound to the "streamable subset" but other settings violate it. */
214
215         FLAC__STREAM_ENCODER_FRAMING_ERROR,
216         /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
217
218         FLAC__STREAM_ENCODER_INVALID_METADATA,
219         /**< The metadata input to the encoder is invalid. */
220
221         FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_ENCODING,
222         /**< An error occurred while writing the stream; usually, the write_callback returned an error. */
223
224         FLAC__STREAM_ENCODER_FATAL_ERROR_WHILE_WRITING,
225         /**< The write_callback returned an error. */
226
227         FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR,
228         /**< Memory allocation failed. */
229
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.
234          */
235
236         FLAC__STREAM_ENCODER_UNINITIALIZED
237         /**< The encoder is in the uninitialized state. */
238
239 } FLAC__StreamEncoderState;
240
241 /** Maps a FLAC__StreamEncoderState to a C string.
242  *
243  *  Using a FLAC__StreamEncoderState as the index to this array
244  *  will give the string equivalent.  The contents should not be modified.
245  */
246 extern const char * const FLAC__StreamEncoderStateString[];
247
248 /** Return values for the FLAC__StreamEncoder write callback.
249  */
250 typedef enum {
251
252         FLAC__STREAM_ENCODER_WRITE_OK = 0,
253         /**< The write was OK and encoding can continue. */
254
255         FLAC__STREAM_ENCODER_WRITE_FATAL_ERROR
256         /**< An unrecoverable error occurred.  The encoder will return from the process call. */
257
258 } FLAC__StreamEncoderWriteStatus;
259
260 /** Maps a FLAC__StreamEncoderWriteStatus to a C string.
261  *
262  *  Using a FLAC__StreamEncoderWriteStatus as the index to this array
263  *  will give the string equivalent.  The contents should not be modified.
264  */
265 extern const char * const FLAC__StreamEncoderWriteStatusString[];
266
267
268 /***********************************************************************
269  *
270  * class FLAC__StreamEncoder
271  *
272  ***********************************************************************/
273
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.
279  */
280 typedef struct {
281         struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
282         struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
283 } FLAC__StreamEncoder;
284
285
286 /***********************************************************************
287  *
288  * Class constructor/destructor
289  *
290  ***********************************************************************/
291
292 /** Create a new stream encoder instance.  The instance is created with
293  *  default settings; see the individual FLAC__stream_encoder_set_*()
294  *  functions for each setting's default.
295  *
296  * \retval FLAC__StreamEncoder*
297  *    \c NULL if there was an error allocating memory, else the new instance.
298  */
299 FLAC__StreamEncoder *FLAC__stream_encoder_new();
300
301 /** Free an encoder instance.  Deletes the object pointed to by \a encoder.
302  *
303  * \param encoder  A pointer to an existing encoder.
304  * \assert
305  *    \code encoder != NULL \endcode
306  */
307 void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder);
308
309 /***********************************************************************
310  *
311  * Public class method prototypes
312  *
313  ***********************************************************************/
314
315 /** Set the "streamable subset" flag.  If \c true, the encoder will comply
316  *  with the subset (see the format specification) and will check the
317  *  settings during FLAC__stream_encoder_init() to see if all settings
318  *  comply.  If \c false, the settings may take advantage of the full
319  *  range that the format allows.
320  *
321  *  Make sure you know what it entails before setting this to \c false.
322  *
323  * \default \c true
324  * \param  encoder  An encoder instance to set.
325  * \param  value    Flag value (see above).
326  * \assert
327  *    \code encoder != NULL \endcode
328  * \retval FLAC__bool
329  *    \c false if the encoder is already initialized, else \c true.
330  */
331 FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
332
333 /** Set to \c true to enable mid-side encoding on stereo input.  The
334  *  number of channels must be 2.  Set to \c false to use only
335  *  independent channel coding.
336  *
337  * \default \c false
338  * \param  encoder  An encoder instance to set.
339  * \param  value    Flag value (see above).
340  * \assert
341  *    \code encoder != NULL \endcode
342  * \retval FLAC__bool
343  *    \c false if the encoder is already initialized, else \c true.
344  */
345 FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
346
347 /** Set to \c true to enable adaptive switching between mid-side and
348  *  left-right encoding on stereo input.  The number of channels must
349  *  be 2.  Set to \c false to use exhaustive searching.  In either
350  *  case, the mid/side stereo setting must be \c true.
351  *
352  * \default \c false
353  * \param  encoder  An encoder instance to set.
354  * \param  value    Flag value (see above).
355  * \assert
356  *    \code encoder != NULL \endcode
357  * \retval FLAC__bool
358  *    \c false if the encoder is already initialized, else \c true.
359  */
360 FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
361
362 /** Set the number of channels to be encoded.
363  *
364  * \default \c 2
365  * \param  encoder  An encoder instance to set.
366  * \param  value    See above.
367  * \assert
368  *    \code encoder != NULL \endcode
369  * \retval FLAC__bool
370  *    \c false if the encoder is already initialized, else \c true.
371  */
372 FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value);
373
374 /** Set the sample resolution of the input to be encoded.
375  *
376  * \warning
377  * Do not feed the encoder data that is wider than the value you
378  * set here or you will generate an invalid stream.
379  *
380  * \default \c 16
381  * \param  encoder  An encoder instance to set.
382  * \param  value    See above.
383  * \assert
384  *    \code encoder != NULL \endcode
385  * \retval FLAC__bool
386  *    \c false if the encoder is already initialized, else \c true.
387  */
388 FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value);
389
390 /** Set the sample rate (in Hz) of the input to be encoded.
391  *
392  * \default \c 44100
393  * \param  encoder  An encoder instance to set.
394  * \param  value    See above.
395  * \assert
396  *    \code encoder != NULL \endcode
397  * \retval FLAC__bool
398  *    \c false if the encoder is already initialized, else \c true.
399  */
400 FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value);
401
402 /** Set the blocksize to use while encoding.
403  *
404  * \default \c 1152
405  * \param  encoder  An encoder instance to set.
406  * \param  value    See above.
407  * \assert
408  *    \code encoder != NULL \endcode
409  * \retval FLAC__bool
410  *    \c false if the encoder is already initialized, else \c true.
411  */
412 FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value);
413
414 /** Set the maximum LPC order, or \c 0 to use only the fixed predictors.
415  *
416  * \default \c 0
417  * \param  encoder  An encoder instance to set.
418  * \param  value    See above.
419  * \assert
420  *    \code encoder != NULL \endcode
421  * \retval FLAC__bool
422  *    \c false if the encoder is already initialized, else \c true.
423  */
424 FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value);
425
426 /** Set the precision, in bits, of the quantized linear predictor
427  *  coefficients, or \c 0 to let the encoder select it based on the
428  *  blocksize.
429  *
430  * \note
431  * In the current implementation, qlp_coeff_precision + bits_per_sample must
432  * be less than 32.
433  *
434  * \default \c 0
435  * \param  encoder  An encoder instance to set.
436  * \param  value    See above.
437  * \assert
438  *    \code encoder != NULL \endcode
439  * \retval FLAC__bool
440  *    \c false if the encoder is already initialized, else \c true.
441  */
442 FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value);
443
444 /** Set to \c false to use only the specified quantized linear predictor
445  *  coefficient precision, or \c true to search neighboring precision
446  *  values and use the best one.
447  *
448  * \default \c false
449  * \param  encoder  An encoder instance to set.
450  * \param  value    See above.
451  * \assert
452  *    \code encoder != NULL \endcode
453  * \retval FLAC__bool
454  *    \c false if the encoder is already initialized, else \c true.
455  */
456 FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
457
458 /** Deprecated.  Setting this value has no effect.
459  *
460  * \default \c false
461  * \param  encoder  An encoder instance to set.
462  * \param  value    See above.
463  * \assert
464  *    \code encoder != NULL \endcode
465  * \retval FLAC__bool
466  *    \c false if the encoder is already initialized, else \c true.
467  */
468 FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
469
470 /** Set to \c false to let the encoder estimate the best model order
471  *  based on the residual signal energy, or \c true to force the
472  *  encoder to evaluate all order models and select the best.
473  *
474  * \default \c false
475  * \param  encoder  An encoder instance to set.
476  * \param  value    See above.
477  * \assert
478  *    \code encoder != NULL \endcode
479  * \retval FLAC__bool
480  *    \c false if the encoder is already initialized, else \c true.
481  */
482 FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
483
484 /** Set the minimum partition order to search when coding the residual.
485  *  This is used in tandem with
486  *  FLAC__stream_encoder_set_max_residual_partition_order().
487  *
488  *  The partition order determines the context size in the residual.
489  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
490  *
491  *  Set both min and max values to \c 0 to force a single context,
492  *  whose Rice parameter is based on the residual signal variance.
493  *  Otherwise, set a min and max order, and the encoder will search
494  *  all orders, using the mean of each context for its Rice parameter,
495  *  and use the best.
496  *
497  * \default \c 0
498  * \param  encoder  An encoder instance to set.
499  * \param  value    See above.
500  * \assert
501  *    \code encoder != NULL \endcode
502  * \retval FLAC__bool
503  *    \c false if the encoder is already initialized, else \c true.
504  */
505 FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
506
507 /** Set the minimum partition order to search when coding the residual.
508  *  This is used in tandem with
509  *  FLAC__stream_encoder_set_min_residual_partition_order().
510  *
511  *  The partition order determines the context size in the residual.
512  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
513  *
514  *  Set both min and max values to \c 0 to force a single context,
515  *  whose Rice parameter is based on the residual signal variance.
516  *  Otherwise, set a min and max order, and the encoder will search
517  *  all orders, using the mean of each context for its Rice parameter,
518  *  and use the best.
519  *
520  * \default \c 0
521  * \param  encoder  An encoder instance to set.
522  * \param  value    See above.
523  * \assert
524  *    \code encoder != NULL \endcode
525  * \retval FLAC__bool
526  *    \c false if the encoder is already initialized, else \c true.
527  */
528 FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
529
530 /** Deprecated.  Setting this value has no effect.
531  *
532  * \default \c 0
533  * \param  encoder  An encoder instance to set.
534  * \param  value    See above.
535  * \assert
536  *    \code encoder != NULL \endcode
537  * \retval FLAC__bool
538  *    \c false if the encoder is already initialized, else \c true.
539  */
540 FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value);
541
542 /** Set an estimate of the total samples that will be encoded.
543  *  This is merely an estimate and may be set to \c 0 if unknown.
544  *  This value will be written to the STREAMINFO block before encoding,
545  *  and can remove the need for the caller to rewrite the value later
546  *  if the value is known before encoding.
547  *
548  * \default \c 0
549  * \param  encoder  An encoder instance to set.
550  * \param  value    See above.
551  * \assert
552  *    \code encoder != NULL \endcode
553  * \retval FLAC__bool
554  *    \c false if the encoder is already initialized, else \c true.
555  */
556 FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
557
558 /** Set the metadata blocks to be emitted to the stream before encoding.
559  *  A value of \c NULL, \c 0 implies no metadata; otherwise, supply an
560  *  array of pointers to metadata blocks.  The array is non-const since
561  *  the encoder may need to change the \a is_last flag inside them.
562  *  Otherwise, the encoder will not modify or free the blocks.
563  *
564  *  The STREAMINFO block is always written and no STREAMINFO block may
565  *  occur in the supplied array.
566  *
567  * \default \c NULL, 0
568  * \param  encoder     An encoder instance to set.
569  * \param  metadata    See above.
570  * \param  num_blocks  See above.
571  * \assert
572  *    \code encoder != NULL \endcode
573  * \retval FLAC__bool
574  *    \c false if the encoder is already initialized, else \c true.
575  */
576 FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
577
578 /** Set the write callback.
579  *  The supplied function will be called by the encoder anytime there is raw
580  *  encoded data ready to write.  It may include metadata mixed with encoded
581  *  audio frames and the data is not guaranteed to be aligned on frame or
582  *  metadata block boundaries.
583  *
584  *  The only duty of the callback is to write out the \a bytes worth of data
585  *  in \a buffer to the current position in the output stream.  The arguments
586  *  \a samples and \a current_frame are purely informational.  If \a samples
587  *  is greater than \c 0, then \a current_frame will hold the current frame
588  *  number that is being written; otherwise, the write callback is being called
589  *  to write metadata.
590  *
591  * \note
592  * The callback is mandatory and must be set before initialization.
593  *
594  * \default \c NULL
595  * \param  encoder  An encoder instance to set.
596  * \param  value    See above.
597  * \assert
598  *    \code encoder != NULL \endcode
599  *    \code value != NULL \endcode
600  * \retval FLAC__bool
601  *    \c false if the encoder is already initialized, else \c true.
602  */
603 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));
604
605 /** Set the metadata callback.
606  *  The supplied function will be called once at the end of encoding with
607  *  the populated STREAMINFO structure.  This is so file encoders can seek
608  *  back to the beginning of the file and write the STREAMINFO block with
609  *  the correct statistics after encoding (like minimum/maximum frame size
610  *  and total samples).
611  *
612  * \note
613  * The callback is mandatory and must be set before initialization.
614  *
615  * \default \c NULL
616  * \param  encoder  An encoder instance to set.
617  * \param  value    See above.
618  * \assert
619  *    \code encoder != NULL \endcode
620  *    \code value != NULL \endcode
621  * \retval FLAC__bool
622  *    \c false if the encoder is already initialized, else \c true.
623  */
624 FLAC__bool FLAC__stream_encoder_set_metadata_callback(FLAC__StreamEncoder *encoder, void (*value)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data));
625
626 /** Set the client data to be passed back to callbacks.
627  *  This value will be supplied to callbacks in their \a client_data
628  *  argument.
629  *
630  * \default \c NULL
631  * \param  encoder  An encoder instance to set.
632  * \param  value    See above.
633  * \assert
634  *    \code encoder != NULL \endcode
635  * \retval FLAC__bool
636  *    \c false if the encoder is already initialized, else \c true.
637  */
638 FLAC__bool FLAC__stream_encoder_set_client_data(FLAC__StreamEncoder *encoder, void *value);
639
640 /** Get the current encoder state.
641  *
642  * \param  encoder  An encoder instance to query.
643  * \assert
644  *    \code encoder != NULL \endcode
645  * \retval FLAC__StreamEncoderState
646  *    The current encoder state.
647  */
648 FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder);
649
650 /** Get the "streamable subset" flag.
651  *
652  * \param  encoder  An encoder instance to query.
653  * \assert
654  *    \code encoder != NULL \endcode
655  * \retval FLAC__bool
656  *    See FLAC__stream_encoder_set_streamable_subset().
657  */
658 FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder);
659
660 /** Get the "mid/side stereo coding" flag.
661  *
662  * \param  encoder  An encoder instance to query.
663  * \assert
664  *    \code encoder != NULL \endcode
665  * \retval FLAC__bool
666  *    See FLAC__stream_encoder_get_do_mid_side_stereo().
667  */
668 FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder);
669
670 /** Get the "adaptive mid/side switching" flag.
671  *
672  * \param  encoder  An encoder instance to query.
673  * \assert
674  *    \code encoder != NULL \endcode
675  * \retval FLAC__bool
676  *    See FLAC__stream_encoder_set_loose_mid_side_stereo().
677  */
678 FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder);
679
680 /** Get the number of input channels being processed.
681  *
682  * \param  encoder  An encoder instance to query.
683  * \assert
684  *    \code encoder != NULL \endcode
685  * \retval FLAC__bool
686  *    See FLAC__stream_encoder_set_channels().
687  */
688 unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder);
689
690 /** Get the input sample resolution setting.
691  *
692  * \param  encoder  An encoder instance to query.
693  * \assert
694  *    \code encoder != NULL \endcode
695  * \retval FLAC__bool
696  *    See FLAC__stream_encoder_set_bits_per_sample().
697  */
698 unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder);
699
700 /** Get the input sample rate setting.
701  *
702  * \param  encoder  An encoder instance to query.
703  * \assert
704  *    \code encoder != NULL \endcode
705  * \retval FLAC__bool
706  *    See FLAC__stream_encoder_set_sample_rate().
707  */
708 unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder);
709
710 /** Get the blocksize setting.
711  *
712  * \param  encoder  An encoder instance to query.
713  * \assert
714  *    \code encoder != NULL \endcode
715  * \retval FLAC__bool
716  *    See FLAC__stream_encoder_set_blocksize().
717  */
718 unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder);
719
720 /** Get the maximum LPC order setting.
721  *
722  * \param  encoder  An encoder instance to query.
723  * \assert
724  *    \code encoder != NULL \endcode
725  * \retval FLAC__bool
726  *    See FLAC__stream_encoder_set_max_lpc_order().
727  */
728 unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder);
729
730 /** Get the quantized linear predictor coefficient precision setting.
731  *
732  * \param  encoder  An encoder instance to query.
733  * \assert
734  *    \code encoder != NULL \endcode
735  * \retval FLAC__bool
736  *    See FLAC__stream_encoder_set_qlp_coeff_precision().
737  */
738 unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder);
739
740 /** Get the qlp coefficient precision search flag.
741  *
742  * \param  encoder  An encoder instance to query.
743  * \assert
744  *    \code encoder != NULL \endcode
745  * \retval FLAC__bool
746  *    See FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
747  */
748 FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder);
749
750 /** Get the "escape coding" flag.
751  *
752  * \param  encoder  An encoder instance to query.
753  * \assert
754  *    \code encoder != NULL \endcode
755  * \retval FLAC__bool
756  *    See FLAC__stream_encoder_set_do_escape_coding().
757  */
758 FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder);
759
760 /** Get the exhaustive model search flag.
761  *
762  * \param  encoder  An encoder instance to query.
763  * \assert
764  *    \code encoder != NULL \endcode
765  * \retval FLAC__bool
766  *    See FLAC__stream_encoder_set_do_exhaustive_model_search().
767  */
768 FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder);
769
770 /** Get the minimum residual partition order setting.
771  *
772  * \param  encoder  An encoder instance to query.
773  * \assert
774  *    \code encoder != NULL \endcode
775  * \retval FLAC__bool
776  *    See FLAC__stream_encoder_set_min_residual_partition_order().
777  */
778 unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder);
779
780 /** Get maximum residual partition order setting.
781  *
782  * \param  encoder  An encoder instance to query.
783  * \assert
784  *    \code encoder != NULL \endcode
785  * \retval FLAC__bool
786  *    See FLAC__stream_encoder_set_max_residual_partition_order().
787  */
788 unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder);
789
790 /** Get the Rice parameter search distance setting.
791  *
792  * \param  encoder  An encoder instance to query.
793  * \assert
794  *    \code encoder != NULL \endcode
795  * \retval FLAC__bool
796  *    See FLAC__stream_encoder_set_rice_parameter_search_dist().
797  */
798 unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder);
799
800 /** Initialize the encoder instance.
801  *  Should be called after FLAC__stream_encoder_new() and
802  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
803  *  or FLAC__stream_encoder_process_interleaved().  Will set and return
804  *  the encoder state, which will be FLAC__STREAM_ENCODER_OK if
805  *  initialization succeeded.
806  *
807  *  The call to FLAC__stream_encoder_init() currently will also immediately
808  *  call the write callback with the \c fLaC signature and all the encoded
809  *  metadata.
810  *
811  * \param  encoder  An uninitialized encoder instance.
812  * \assert
813  *    \code encoder != NULL \endcode
814  * \retval FLAC__StreamEncoderState
815  *    \c FLAC__STREAM_ENCODER_OK if initialization was successful; see
816  *    FLAC__StreamEncoderState for the meanings of other return values.
817  */
818 FLAC__StreamEncoderState FLAC__stream_encoder_init(FLAC__StreamEncoder *encoder);
819
820 /** Finish the encoding process.
821  *  Flushes the encoding buffer, releases resources, resets the encoder
822  *  settings to their defaults, and returns the encoder state to
823  *  FLAC__STREAM_ENCODER_UNINITIALIZED.  Note that this can generate
824  *  one or more write callbacks before returning, and will generate
825  *  a metadata callback.
826  *
827  *  In the event of a prematurely-terminated encode, it is not strictly
828  *  necessary to call this immediately before FLAC__stream_encoder_delete()
829  *  but it is good practice to match every FLAC__stream_encoder_init()
830  *  with a FLAC__stream_encoder_finish().
831  *
832  * \param  encoder  An uninitialized encoder instance.
833  * \assert
834  *    \code encoder != NULL \endcode
835  */
836 void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
837
838 /** Submit data for encoding.
839  *  This version allows you to supply the input data via an array of
840  *  pointers, each pointer pointing to an array of \a samples samples
841  *  representing one channel.  The samples need not be block-aligned,
842  *  but each channel should have the same number of samples.
843  *
844  * \param  encoder  An initialized encoder instance in the OK state.
845  * \param  buffer   An array of pointers to each channel's signal.
846  * \param  samples  The number of samples in one channel.
847  * \assert
848  *    \code encoder != NULL \endcode
849  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
850  * \retval FLAC__bool
851  *    \c true if successful, else \c false; in this case, check the
852  *    encoder state with FLAC__stream_encoder_get_state() to see what
853  *    went wrong.
854  */
855 FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
856
857 /** Submit data for encoding.
858  *  This version allows you to supply the input data where the channels
859  *  are interleaved into a single array (i.e. channel0_sample0,
860  *  channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
861  *  The samples need not be block-aligned but they must be
862  *  sample-aligned, i.e. the first value should be channel0_sample0
863  *  and the last value channelN_sampleM.
864  *
865  * \param  encoder  An initialized encoder instance in the OK state.
866  * \param  buffer   An array of channel-interleaved data (see above).
867  * \param  samples  The number of samples in one channel, the same as for
868  *                  FLAC__stream_encoder_process().  For example, if
869  *                  encoding two channels, \c 1000 \a samples corresponds
870  *                  to a \a buffer of 2000 values.
871  * \assert
872  *    \code encoder != NULL \endcode
873  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
874  * \retval FLAC__bool
875  *    \c true if successful, else \c false; in this case, check the
876  *    encoder state with FLAC__stream_encoder_get_state() to see what
877  *    went wrong.
878  */
879 FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);
880
881 /* \} */
882
883 #ifdef __cplusplus
884 }
885 #endif
886
887 #endif