add FLAC__stream_encoder_set_compression_level()
[flac.git] / include / FLAC / stream_encoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef FLAC__STREAM_ENCODER_H
33 #define FLAC__STREAM_ENCODER_H
34
35 #include <stdio.h> /* for FILE */
36 #include "export.h"
37 #include "format.h"
38 #include "stream_decoder.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44
45 /** \file include/FLAC/stream_encoder.h
46  *
47  *  \brief
48  *  This module contains the functions which implement the stream
49  *  encoder.
50  *
51  *  See the detailed documentation in the
52  *  \link flac_stream_encoder stream encoder \endlink module.
53  */
54
55 /** \defgroup flac_encoder FLAC/ *_encoder.h: encoder interfaces
56  *  \ingroup flac
57  *
58  *  \brief
59  *  This module describes the encoder layers provided by libFLAC.
60  *
61  * The stream encoder can be used to encode complete streams either to the
62  * client via callbacks, or directly to a file, depending on how it is
63  * initialized.  When encoding via callbacks, the client provides a write
64  * callback which will be called whenever FLAC data is ready to be written.
65  * If the client also supplies a seek callback, the encoder will also
66  * automatically handle the writing back of metadata discovered while
67  * encoding, like stream info, seek points offsets, etc.  When encoding to
68  * a file, the client needs only supply a filename or open \c FILE* and an
69  * optional progress callback for periodic notification of progress; the
70  * write and seek callbacks are supplied internally.  For more info see the
71  * \link flac_stream_encoder stream encoder \endlink module.
72  */
73
74 /** \defgroup flac_stream_encoder FLAC/stream_encoder.h: stream encoder interface
75  *  \ingroup flac_encoder
76  *
77  *  \brief
78  *  This module contains the functions which implement the stream
79  *  encoder.
80  *
81  * The stream encoder can encode to native FLAC, and optionally Ogg FLAC
82  * (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files.
83  *
84  * The basic usage of this encoder is as follows:
85  * - The program creates an instance of an encoder using
86  *   FLAC__stream_encoder_new().
87  * - The program overrides the default settings using
88  *   FLAC__stream_encoder_set_*() functions.  At a minimum, the following
89  *   functions should be called:
90  *   - FLAC__stream_encoder_set_channels()
91  *   - FLAC__stream_encoder_set_bits_per_sample()
92  *   - FLAC__stream_encoder_set_sample_rate()
93  *   - FLAC__stream_encoder_set_ogg_serial_number() (if encoding to Ogg FLAC)
94  *   - FLAC__stream_encoder_set_total_samples_estimate() (if known)
95  * - If the application wants to control the compression level or set its own
96  *   metadata, then the following should also be called:
97  *   - FLAC__stream_encoder_set_compression_level()
98  *   - FLAC__stream_encoder_set_verify()
99  *   - FLAC__stream_encoder_set_metadata()
100  * - The rest of the set functions should only be called if the client needs
101  *   exact control over how the audio is compressed; thorough understanding
102  *   of the FLAC format is necessary to achieve good results.
103  * - The program initializes the instance to validate the settings and
104  *   prepare for encoding using
105  *   - FLAC__stream_encoder_init_stream() or FLAC__stream_encoder_init_FILE()
106  *     or FLAC__stream_encoder_init_file() for native FLAC
107  *   - FLAC__stream_encoder_init_ogg_stream() or FLAC__stream_encoder_init_ogg_FILE()
108  *     or FLAC__stream_encoder_init_ogg_file() for Ogg FLAC
109  * - The program calls FLAC__stream_encoder_process() or
110  *   FLAC__stream_encoder_process_interleaved() to encode data, which
111  *   subsequently calls the callbacks when there is encoder data ready
112  *   to be written.
113  * - The program finishes the encoding with FLAC__stream_encoder_finish(),
114  *   which causes the encoder to encode any data still in its input pipe,
115  *   update the metadata with the final encoding statistics if output
116  *   seeking is possible, and finally reset the encoder to the
117  *   uninitialized state.
118  * - The instance may be used again or deleted with
119  *   FLAC__stream_encoder_delete().
120  *
121  * In more detail, the stream encoder functions similarly to the
122  * \link flac_stream_decoder stream decoder \endlink, but has fewer
123  * callbacks and more options.  Typically the client will create a new
124  * instance by calling FLAC__stream_encoder_new(), then set the necessary
125  * parameters with FLAC__stream_encoder_set_*(), and initialize it by
126  * calling one of the FLAC__stream_encoder_init_*() functions.
127  *
128  * Unlike the decoders, the stream encoder has many options that can
129  * affect the speed and compression ratio.  When setting these parameters
130  * you should have some basic knowledge of the format (see the
131  * <A HREF="../documentation.html#format">user-level documentation</A>
132  * or the <A HREF="../format.html">formal description</A>).  The
133  * FLAC__stream_encoder_set_*() functions themselves do not validate the
134  * values as many are interdependent.  The FLAC__stream_encoder_init_*()
135  * functions will do this, so make sure to pay attention to the state
136  * returned by FLAC__stream_encoder_init_*() to make sure that it is
137  * FLAC__STREAM_ENCODER_INIT_STATUS_OK.  Any parameters that are not set
138  * before FLAC__stream_encoder_init_*() will take on the defaults from
139  * the constructor.
140  *
141  * There are three initialization functions for native FLAC, one for
142  * setting up the encoder to encode FLAC data to the client via
143  * callbacks, and two for encoding directly to a file.
144  *
145  * For encoding via callbacks, use FLAC__stream_encoder_init_stream().
146  * You must also supply a write callback which will be called anytime
147  * there is raw encoded data to write.  If the client can seek the output
148  * it is best to also supply seek and tell callbacks, as this allows the
149  * encoder to go back after encoding is finished to write back
150  * information that was collected while encoding, like seek point offsets,
151  * frame sizes, etc.
152  *
153  * For encoding directly to a file, use FLAC__stream_encoder_init_FILE()
154  * or FLAC__stream_encoder_init_file().  Then you must only supply a
155  * filename or open \c FILE*; the encoder will handle all the callbacks
156  * internally.  You may also supply a progress callback for periodic
157  * notification of the encoding progress.
158  *
159  * There are three similarly-named init functions for encoding to Ogg
160  * FLAC streams.  Check \c FLAC_API_SUPPORTS_OGG_FLAC to find out if the
161  * library has been built with Ogg support.
162  *
163  * The call to FLAC__stream_encoder_init_*() currently will also immediately
164  * call the write callback several times, once with the \c fLaC signature,
165  * and once for each encoded metadata block.  Note that for Ogg FLAC
166  * encoding you will usually get twice the number of callbacks than with
167  * native FLAC, one for the Ogg page header and one for the page body.
168  *
169  * After initializing the instance, the client may feed audio data to the
170  * encoder in one of two ways:
171  *
172  * - Channel separate, through FLAC__stream_encoder_process() - The client
173  *   will pass an array of pointers to buffers, one for each channel, to
174  *   the encoder, each of the same length.  The samples need not be
175  *   block-aligned.
176  * - Channel interleaved, through
177  *   FLAC__stream_encoder_process_interleaved() - The client will pass a single
178  *   pointer to data that is channel-interleaved (i.e. channel0_sample0,
179  *   channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
180  *   Again, the samples need not be block-aligned but they must be
181  *   sample-aligned, i.e. the first value should be channel0_sample0 and
182  *   the last value channelN_sampleM.
183  *
184  * When the client is finished encoding data, it calls
185  * FLAC__stream_encoder_finish(), which causes the encoder to encode any
186  * data still in its input pipe, and call the metadata callback with the
187  * final encoding statistics.  Then the instance may be deleted with
188  * FLAC__stream_encoder_delete() or initialized again to encode another
189  * stream.
190  *
191  * For programs that write their own metadata, but that do not know the
192  * actual metadata until after encoding, it is advantageous to instruct
193  * the encoder to write a PADDING block of the correct size, so that
194  * instead of rewriting the whole stream after encoding, the program can
195  * just overwrite the PADDING block.  If only the maximum size of the
196  * metadata is known, the program can write a slightly larger padding
197  * block, then split it after encoding.
198  *
199  * Make sure you understand how lengths are calculated.  All FLAC metadata
200  * blocks have a 4 byte header which contains the type and length.  This
201  * length does not include the 4 bytes of the header.  See the format page
202  * for the specification of metadata blocks and their lengths.
203  *
204  * \note
205  * If you are writing the FLAC data to a file via callbacks, make sure it
206  * is open for update (e.g. mode "w+" for stdio streams).  This is because
207  * after the first encoding pass, the encoder will try to seek back to the
208  * beginning of the stream, to the STREAMINFO block, to write some data
209  * there.  (If using FLAC__stream_encoder_init*_file() or
210  * FLAC__stream_encoder_init*_FILE(), the file is managed internally.)
211  *
212  * \note
213  * The "set" functions may only be called when the encoder is in the
214  * state FLAC__STREAM_ENCODER_UNINITIALIZED, i.e. after
215  * FLAC__stream_encoder_new() or FLAC__stream_encoder_finish(), but
216  * before FLAC__stream_encoder_init_*().  If this is the case they will
217  * return \c true, otherwise \c false.
218  *
219  * \note
220  * FLAC__stream_encoder_finish() resets all settings to the constructor
221  * defaults.
222  *
223  * \{
224  */
225
226
227 /** State values for a FLAC__StreamEncoder.
228  *
229  * The encoder's state can be obtained by calling FLAC__stream_encoder_get_state().
230  *
231  * If the encoder gets into any other state besides \c FLAC__STREAM_ENCODER_OK
232  * or \c FLAC__STREAM_ENCODER_UNINITIALIZED, it becomes invalid for encoding and
233  * must be deleted with FLAC__stream_encoder_delete().
234  */
235 typedef enum {
236
237         FLAC__STREAM_ENCODER_OK = 0,
238         /**< The encoder is in the normal OK state and samples can be processed. */
239
240         FLAC__STREAM_ENCODER_UNINITIALIZED,
241         /**< The encoder is in the uninitialized state; one of the
242          * FLAC__stream_encoder_init_*() functions must be called before samples
243          * can be processed.
244          */
245
246         FLAC__STREAM_ENCODER_OGG_ERROR,
247         /**< An error occurred in the underlying Ogg layer.  */
248
249         FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR,
250         /**< An error occurred in the underlying verify stream decoder;
251          * check FLAC__stream_encoder_get_verify_decoder_state().
252          */
253
254         FLAC__STREAM_ENCODER_VERIFY_MISMATCH_IN_AUDIO_DATA,
255         /**< The verify decoder detected a mismatch between the original
256          * audio signal and the decoded audio signal.
257          */
258
259         FLAC__STREAM_ENCODER_CLIENT_ERROR,
260         /**< One of the callbacks returned a fatal error. */
261
262         FLAC__STREAM_ENCODER_IO_ERROR,
263         /**< An I/O error occurred while opening/reading/writing a file.
264          * Check \c errno.
265          */
266
267         FLAC__STREAM_ENCODER_FRAMING_ERROR,
268         /**< An error occurred while writing the stream; usually, the
269          * write_callback returned an error.
270          */
271
272         FLAC__STREAM_ENCODER_MEMORY_ALLOCATION_ERROR
273         /**< Memory allocation failed. */
274
275 } FLAC__StreamEncoderState;
276
277 /** Maps a FLAC__StreamEncoderState to a C string.
278  *
279  *  Using a FLAC__StreamEncoderState as the index to this array
280  *  will give the string equivalent.  The contents should not be modified.
281  */
282 extern FLAC_API const char * const FLAC__StreamEncoderStateString[];
283
284
285 /** Possible return values for the FLAC__stream_encoder_init_*() functions.
286  */
287 typedef enum {
288
289         FLAC__STREAM_ENCODER_INIT_STATUS_OK = 0,
290         /**< Initialization was successful. */
291
292         FLAC__STREAM_ENCODER_INIT_STATUS_ENCODER_ERROR,
293         /**< General failure to set up encoder; call FLAC__stream_encoder_get_state() for cause. */
294
295         FLAC__STREAM_ENCODER_INIT_STATUS_UNSUPPORTED_CONTAINER,
296         /**< The library was not compiled with support for the given container
297          * format.
298          */
299
300         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_CALLBACKS,
301         /**< A required callback was not supplied. */
302
303         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_NUMBER_OF_CHANNELS,
304         /**< The encoder has an invalid setting for number of channels. */
305
306         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BITS_PER_SAMPLE,
307         /**< The encoder has an invalid setting for bits-per-sample.
308          * FLAC supports 4-32 bps but the reference encoder currently supports
309          * only up to 24 bps.
310          */
311
312         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_SAMPLE_RATE,
313         /**< The encoder has an invalid setting for the input sample rate. */
314
315         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_BLOCK_SIZE,
316         /**< The encoder has an invalid setting for the block size. */
317
318         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_MAX_LPC_ORDER,
319         /**< The encoder has an invalid setting for the maximum LPC order. */
320
321         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_QLP_COEFF_PRECISION,
322         /**< The encoder has an invalid setting for the precision of the quantized linear predictor coefficients. */
323
324         FLAC__STREAM_ENCODER_INIT_STATUS_BLOCK_SIZE_TOO_SMALL_FOR_LPC_ORDER,
325         /**< The specified block size is less than the maximum LPC order. */
326
327         FLAC__STREAM_ENCODER_INIT_STATUS_NOT_STREAMABLE,
328         /**< The encoder is bound to the <A HREF="../format.html#subset">Subset</A> but other settings violate it. */
329
330         FLAC__STREAM_ENCODER_INIT_STATUS_INVALID_METADATA,
331         /**< The metadata input to the encoder is invalid, in one of the following ways:
332          * - FLAC__stream_encoder_set_metadata() was called with a null pointer but a block count > 0
333          * - One of the metadata blocks contains an undefined type
334          * - It contains an illegal CUESHEET as checked by FLAC__format_cuesheet_is_legal()
335          * - It contains an illegal SEEKTABLE as checked by FLAC__format_seektable_is_legal()
336          * - It contains more than one SEEKTABLE block or more than one VORBIS_COMMENT block
337          */
338
339         FLAC__STREAM_ENCODER_INIT_STATUS_ALREADY_INITIALIZED
340         /**< FLAC__stream_encoder_init_*() was called when the encoder was
341          * already initialized, usually because
342          * FLAC__stream_encoder_finish() was not called.
343          */
344
345 } FLAC__StreamEncoderInitStatus;
346
347 /** Maps a FLAC__StreamEncoderInitStatus to a C string.
348  *
349  *  Using a FLAC__StreamEncoderInitStatus as the index to this array
350  *  will give the string equivalent.  The contents should not be modified.
351  */
352 extern FLAC_API const char * const FLAC__StreamEncoderInitStatusString[];
353
354
355 /** Return values for the FLAC__StreamEncoder read callback.
356  */
357 typedef enum {
358
359         FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE,
360         /**< The read was OK and decoding can continue. */
361
362         FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM,
363         /**< The read was attempted at the end of the stream. */
364
365         FLAC__STREAM_ENCODER_READ_STATUS_ABORT,
366         /**< An unrecoverable error occurred. */
367
368         FLAC__STREAM_ENCODER_READ_STATUS_UNSUPPORTED
369         /**< Client does not support reading back from the output. */
370
371 } FLAC__StreamEncoderReadStatus;
372
373 /** Maps a FLAC__StreamEncoderReadStatus to a C string.
374  *
375  *  Using a FLAC__StreamEncoderReadStatus as the index to this array
376  *  will give the string equivalent.  The contents should not be modified.
377  */
378 extern FLAC_API const char * const FLAC__StreamEncoderReadStatusString[];
379
380
381 /** Return values for the FLAC__StreamEncoder write callback.
382  */
383 typedef enum {
384
385         FLAC__STREAM_ENCODER_WRITE_STATUS_OK = 0,
386         /**< The write was OK and encoding can continue. */
387
388         FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR
389         /**< An unrecoverable error occurred.  The encoder will return from the process call. */
390
391 } FLAC__StreamEncoderWriteStatus;
392
393 /** Maps a FLAC__StreamEncoderWriteStatus to a C string.
394  *
395  *  Using a FLAC__StreamEncoderWriteStatus as the index to this array
396  *  will give the string equivalent.  The contents should not be modified.
397  */
398 extern FLAC_API const char * const FLAC__StreamEncoderWriteStatusString[];
399
400
401 /** Return values for the FLAC__StreamEncoder seek callback.
402  */
403 typedef enum {
404
405         FLAC__STREAM_ENCODER_SEEK_STATUS_OK,
406         /**< The seek was OK and encoding can continue. */
407
408         FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR,
409         /**< An unrecoverable error occurred. */
410
411         FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED
412         /**< Client does not support seeking. */
413
414 } FLAC__StreamEncoderSeekStatus;
415
416 /** Maps a FLAC__StreamEncoderSeekStatus to a C string.
417  *
418  *  Using a FLAC__StreamEncoderSeekStatus as the index to this array
419  *  will give the string equivalent.  The contents should not be modified.
420  */
421 extern FLAC_API const char * const FLAC__StreamEncoderSeekStatusString[];
422
423
424 /** Return values for the FLAC__StreamEncoder tell callback.
425  */
426 typedef enum {
427
428         FLAC__STREAM_ENCODER_TELL_STATUS_OK,
429         /**< The tell was OK and encoding can continue. */
430
431         FLAC__STREAM_ENCODER_TELL_STATUS_ERROR,
432         /**< An unrecoverable error occurred. */
433
434         FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED
435         /**< Client does not support seeking. */
436
437 } FLAC__StreamEncoderTellStatus;
438
439 /** Maps a FLAC__StreamEncoderTellStatus to a C string.
440  *
441  *  Using a FLAC__StreamEncoderTellStatus as the index to this array
442  *  will give the string equivalent.  The contents should not be modified.
443  */
444 extern FLAC_API const char * const FLAC__StreamEncoderTellStatusString[];
445
446
447 /***********************************************************************
448  *
449  * class FLAC__StreamEncoder
450  *
451  ***********************************************************************/
452
453 struct FLAC__StreamEncoderProtected;
454 struct FLAC__StreamEncoderPrivate;
455 /** The opaque structure definition for the stream encoder type.
456  *  See the \link flac_stream_encoder stream encoder module \endlink
457  *  for a detailed description.
458  */
459 typedef struct {
460         struct FLAC__StreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
461         struct FLAC__StreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
462 } FLAC__StreamEncoder;
463
464 /** Signature for the read callback.
465  *
466  *  A function pointer matching this signature must be passed to
467  *  FLAC__stream_encoder_init_ogg_stream() if seeking is supported.
468  *  The supplied function will be called when the encoder needs to read back
469  *  encoded data.  This happens during the metadata callback, when the encoder
470  *  has to read, modify, and rewrite the metadata (e.g. seekpoints) gathered
471  *  while encoding.  The address of the buffer to be filled is supplied, along
472  *  with the number of bytes the buffer can hold.  The callback may choose to
473  *  supply less data and modify the byte count but must be careful not to
474  *  overflow the buffer.  The callback then returns a status code chosen from
475  *  FLAC__StreamEncoderReadStatus.
476  *
477  * \note In general, FLAC__StreamEncoder functions which change the
478  * state should not be called on the \a encoder while in the callback.
479  *
480  * \param  encoder  The encoder instance calling the callback.
481  * \param  buffer   A pointer to a location for the callee to store
482  *                  data to be encoded.
483  * \param  bytes    A pointer to the size of the buffer.  On entry
484  *                  to the callback, it contains the maximum number
485  *                  of bytes that may be stored in \a buffer.  The
486  *                  callee must set it to the actual number of bytes
487  *                  stored (0 in case of error or end-of-stream) before
488  *                  returning.
489  * \param  client_data  The callee's client data set through
490  *                      FLAC__stream_encoder_set_client_data().
491  * \retval FLAC__StreamEncoderReadStatus
492  *    The callee's return status.
493  */
494 typedef FLAC__StreamEncoderReadStatus (*FLAC__StreamEncoderReadCallback)(const FLAC__StreamEncoder *encoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
495
496 /** Signature for the write callback.
497  *
498  *  A function pointer matching this signature must be passed to
499  *  FLAC__stream_encoder_init*_stream().  The supplied function will be called
500  *  by the encoder anytime there is raw encoded data ready to write.  It may
501  *  include metadata mixed with encoded audio frames and the data is not
502  *  guaranteed to be aligned on frame or metadata block boundaries.
503  *
504  *  The only duty of the callback is to write out the \a bytes worth of data
505  *  in \a buffer to the current position in the output stream.  The arguments
506  *  \a samples and \a current_frame are purely informational.  If \a samples
507  *  is greater than \c 0, then \a current_frame will hold the current frame
508  *  number that is being written; otherwise it indicates that the write
509  *  callback is being called to write metadata.
510  *
511  * \note
512  * Unlike when writing to native FLAC, when writing to Ogg FLAC the
513  * write callback will be called twice when writing each audio
514  * frame; once for the page header, and once for the page body.
515  * When writing the page header, the \a samples argument to the
516  * write callback will be \c 0.
517  *
518  * \note In general, FLAC__StreamEncoder functions which change the
519  * state should not be called on the \a encoder while in the callback.
520  *
521  * \param  encoder  The encoder instance calling the callback.
522  * \param  buffer   An array of encoded data of length \a bytes.
523  * \param  bytes    The byte length of \a buffer.
524  * \param  samples  The number of samples encoded by \a buffer.
525  *                  \c 0 has a special meaning; see above.
526  * \param  current_frame  The number of the current frame being encoded.
527  * \param  client_data  The callee's client data set through
528  *                      FLAC__stream_encoder_init_*().
529  * \retval FLAC__StreamEncoderWriteStatus
530  *    The callee's return status.
531  */
532 typedef FLAC__StreamEncoderWriteStatus (*FLAC__StreamEncoderWriteCallback)(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, unsigned samples, unsigned current_frame, void *client_data);
533
534 /** Signature for the seek callback.
535  *
536  *  A function pointer matching this signature may be passed to
537  *  FLAC__stream_encoder_init*_stream().  The supplied function will be called
538  *  when the encoder needs to seek the output stream.  The encoder will pass
539  *  the absolute byte offset to seek to, 0 meaning the beginning of the stream.
540  *
541  * \note In general, FLAC__StreamEncoder functions which change the
542  * state should not be called on the \a encoder while in the callback.
543  *
544  * \param  encoder  The encoder instance calling the callback.
545  * \param  absolute_byte_offset  The offset from the beginning of the stream
546  *                               to seek to.
547  * \param  client_data  The callee's client data set through
548  *                      FLAC__stream_encoder_init_*().
549  * \retval FLAC__StreamEncoderSeekStatus
550  *    The callee's return status.
551  */
552 typedef FLAC__StreamEncoderSeekStatus (*FLAC__StreamEncoderSeekCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
553
554 /** Signature for the tell callback.
555  *
556  *  A function pointer matching this signature may be passed to
557  *  FLAC__stream_encoder_init*_stream().  The supplied function will be called
558  *  when the encoder needs to know the current position of the output stream.
559  *
560  * \warning
561  * The callback must return the true current byte offset of the output to
562  * which the encoder is writing.  If you are buffering the output, make
563  * sure and take this into account.  If you are writing directly to a
564  * FILE* from your write callback, ftell() is sufficient.  If you are
565  * writing directly to a file descriptor from your write callback, you
566  * can use lseek(fd, SEEK_CUR, 0).  The encoder may later seek back to
567  * these points to rewrite metadata after encoding.
568  *
569  * \note In general, FLAC__StreamEncoder functions which change the
570  * state should not be called on the \a encoder while in the callback.
571  *
572  * \param  encoder  The encoder instance calling the callback.
573  * \param  absolute_byte_offset  The address at which to store the current
574  *                               position of the output.
575  * \param  client_data  The callee's client data set through
576  *                      FLAC__stream_encoder_init_*().
577  * \retval FLAC__StreamEncoderTellStatus
578  *    The callee's return status.
579  */
580 typedef FLAC__StreamEncoderTellStatus (*FLAC__StreamEncoderTellCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
581
582 /** Signature for the metadata callback.
583  *
584  *  A function pointer matching this signature may be passed to
585  *  FLAC__stream_encoder_init*_stream().  The supplied function will be called
586  *  once at the end of encoding with the populated STREAMINFO structure.  This
587  *  is so the client can seek back to the beginning of the file and write the
588  *  STREAMINFO block with the correct statistics after encoding (like
589  *  minimum/maximum frame size and total samples).
590  *
591  * \note In general, FLAC__StreamEncoder functions which change the
592  * state should not be called on the \a encoder while in the callback.
593  *
594  * \param  encoder      The encoder instance calling the callback.
595  * \param  metadata     The final populated STREAMINFO block.
596  * \param  client_data  The callee's client data set through
597  *                      FLAC__stream_encoder_init_*().
598  */
599 typedef void (*FLAC__StreamEncoderMetadataCallback)(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data);
600
601 /** Signature for the progress callback.
602  *
603  *  A function pointer matching this signature may be passed to
604  *  FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE().
605  *  The supplied function will be called when the encoder has finished
606  *  writing a frame.  The \c total_frames_estimate argument to the
607  *  callback will be based on the value from
608  *  FLAC__stream_encoder_set_total_samples_estimate().
609  *
610  * \note In general, FLAC__StreamEncoder functions which change the
611  * state should not be called on the \a encoder while in the callback.
612  *
613  * \param  encoder          The encoder instance calling the callback.
614  * \param  bytes_written    Bytes written so far.
615  * \param  samples_written  Samples written so far.
616  * \param  frames_written   Frames written so far.
617  * \param  total_frames_estimate  The estimate of the total number of
618  *                                frames to be written.
619  * \param  client_data      The callee's client data set through
620  *                          FLAC__stream_encoder_init_*().
621  */
622 typedef void (*FLAC__StreamEncoderProgressCallback)(const FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data);
623
624
625 /***********************************************************************
626  *
627  * Class constructor/destructor
628  *
629  ***********************************************************************/
630
631 /** Create a new stream encoder instance.  The instance is created with
632  *  default settings; see the individual FLAC__stream_encoder_set_*()
633  *  functions for each setting's default.
634  *
635  * \retval FLAC__StreamEncoder*
636  *    \c NULL if there was an error allocating memory, else the new instance.
637  */
638 FLAC_API FLAC__StreamEncoder *FLAC__stream_encoder_new();
639
640 /** Free an encoder instance.  Deletes the object pointed to by \a encoder.
641  *
642  * \param encoder  A pointer to an existing encoder.
643  * \assert
644  *    \code encoder != NULL \endcode
645  */
646 FLAC_API void FLAC__stream_encoder_delete(FLAC__StreamEncoder *encoder);
647
648
649 /***********************************************************************
650  *
651  * Public class method prototypes
652  *
653  ***********************************************************************/
654
655 /** Set the serial number for the FLAC stream to use in the Ogg container.
656  *
657  * \note
658  * This does not need to be set for native FLAC encoding.
659  *
660  * \note
661  * It is recommended to set a serial number explicitly as the default of '0'
662  * may collide with other streams.
663  *
664  * \default \c 0
665  * \param  encoder        An encoder instance to set.
666  * \param  serial_number  See above.
667  * \assert
668  *    \code encoder != NULL \endcode
669  * \retval FLAC__bool
670  *    \c false if the encoder is already initialized, else \c true.
671  */
672 FLAC_API FLAC__bool FLAC__stream_encoder_set_ogg_serial_number(FLAC__StreamEncoder *encoder, long serial_number);
673
674 /** Set the "verify" flag.  If \c true, the encoder will verify it's own
675  *  encoded output by feeding it through an internal decoder and comparing
676  *  the original signal against the decoded signal.  If a mismatch occurs,
677  *  the process call will return \c false.  Note that this will slow the
678  *  encoding process by the extra time required for decoding and comparison.
679  *
680  * \default \c false
681  * \param  encoder  An encoder instance to set.
682  * \param  value    Flag value (see above).
683  * \assert
684  *    \code encoder != NULL \endcode
685  * \retval FLAC__bool
686  *    \c false if the encoder is already initialized, else \c true.
687  */
688 FLAC_API FLAC__bool FLAC__stream_encoder_set_verify(FLAC__StreamEncoder *encoder, FLAC__bool value);
689
690 /** Set the <A HREF="../format.html#subset">Subset</A> flag.  If \c true,
691  *  the encoder will comply with the Subset and will check the
692  *  settings during FLAC__stream_encoder_init_*() to see if all settings
693  *  comply.  If \c false, the settings may take advantage of the full
694  *  range that the format allows.
695  *
696  *  Make sure you know what it entails before setting this to \c false.
697  *
698  * \default \c true
699  * \param  encoder  An encoder instance to set.
700  * \param  value    Flag value (see above).
701  * \assert
702  *    \code encoder != NULL \endcode
703  * \retval FLAC__bool
704  *    \c false if the encoder is already initialized, else \c true.
705  */
706 FLAC_API FLAC__bool FLAC__stream_encoder_set_streamable_subset(FLAC__StreamEncoder *encoder, FLAC__bool value);
707
708 /** Set the number of channels to be encoded.
709  *
710  * \default \c 2
711  * \param  encoder  An encoder instance to set.
712  * \param  value    See above.
713  * \assert
714  *    \code encoder != NULL \endcode
715  * \retval FLAC__bool
716  *    \c false if the encoder is already initialized, else \c true.
717  */
718 FLAC_API FLAC__bool FLAC__stream_encoder_set_channels(FLAC__StreamEncoder *encoder, unsigned value);
719
720 /** Set the sample resolution of the input to be encoded.
721  *
722  * \warning
723  * Do not feed the encoder data that is wider than the value you
724  * set here or you will generate an invalid stream.
725  *
726  * \default \c 16
727  * \param  encoder  An encoder instance to set.
728  * \param  value    See above.
729  * \assert
730  *    \code encoder != NULL \endcode
731  * \retval FLAC__bool
732  *    \c false if the encoder is already initialized, else \c true.
733  */
734 FLAC_API FLAC__bool FLAC__stream_encoder_set_bits_per_sample(FLAC__StreamEncoder *encoder, unsigned value);
735
736 /** Set the sample rate (in Hz) of the input to be encoded.
737  *
738  * \default \c 44100
739  * \param  encoder  An encoder instance to set.
740  * \param  value    See above.
741  * \assert
742  *    \code encoder != NULL \endcode
743  * \retval FLAC__bool
744  *    \c false if the encoder is already initialized, else \c true.
745  */
746 FLAC_API FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *encoder, unsigned value);
747
748 /** Set the compression level
749  *
750  * The compression level is roughly proportional to the amount of effort
751  * the encoder expends to compress the file.  A higher level usually
752  * means more computation but higher compression.  The default level is
753  * suitable for most applications.
754  *
755  * Currently the levels range from \c 0 (fastest, least compression) to
756  * \c 8 (slowest, most compression).  A value larger than \c 8 will be
757  * treated as \c 8.
758  *
759  * This function automatically calls the following other \c _set_
760  * functions with appropriate values, so the client does not need to
761  * unless it specifically wants to override them:
762  * - FLAC__stream_encoder_set_do_mid_side_stereo()
763  * - FLAC__stream_encoder_set_loose_mid_side_stereo()
764  * - FLAC__stream_encoder_set_apodization()
765  * - FLAC__stream_encoder_set_max_lpc_order()
766  * - FLAC__stream_encoder_set_qlp_coeff_precision()
767  * - FLAC__stream_encoder_set_do_qlp_coeff_prec_search()
768  * - FLAC__stream_encoder_set_do_escape_coding()
769  * - FLAC__stream_encoder_set_do_exhaustive_model_search()
770  * - FLAC__stream_encoder_set_min_residual_partition_order()
771  * - FLAC__stream_encoder_set_max_residual_partition_order()
772  * - FLAC__stream_encoder_set_rice_parameter_search_dist()
773  *
774  * The actual values set for each level are:
775  * <table>
776  * <tr>
777  *  <td><b>level</b><td>
778  *  <td>do mid-side stereo<td>
779  *  <td>loose mid-side stereo<td>
780  *  <td>apodization<td>
781  *  <td>max lpc order<td>
782  *  <td>qlp coeff precision<td>
783  *  <td>qlp coeff prec search<td>
784  *  <td>escape coding<td>
785  *  <td>exhaustive model search<td>
786  *  <td>min residual partition order<td>
787  *  <td>max residual partition order<td>
788  *  <td>rice parameter search dist<td>
789  * </tr>
790  * <tr>  <td><b>0</b><td>  <td>false<td>  <td>false<td>  <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>2<td>  <td>2<td>  <td>0<td>  </tr>
791  * <tr>  <td><b>1</b><td>  <td>true<td>   <td>true<td>   <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>2<td>  <td>2<td>  <td>0<td>  </tr>
792  * <tr>  <td><b>2</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>3<td>  <td>0<td>  </tr>
793  * <tr>  <td><b>3</b><td>  <td>false<td>  <td>false<td>  <td>tukey(0.5)<td>  <td>6<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>3<td>  <td>3<td>  <td>0<td>  </tr>
794  * <tr>  <td><b>4</b><td>  <td>true<td>   <td>true<td>   <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>3<td>  <td>3<td>  <td>0<td>  </tr>
795  * <tr>  <td><b>5</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>3<td>  <td>3<td>  <td>0<td>  </tr>
796  * <tr>  <td><b>6</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>4<td>  <td>0<td>  </tr>
797  * <tr>  <td><b>7</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>true<td>   <td>0<td>  <td>6<td>  <td>0<td>  </tr>
798  * <tr>  <td><b>8</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>12<td>  <td>0<td>  <td>false<td>  <td>false<td>  <td>true<td>   <td>0<td>  <td>6<td>  <td>0<td>  </tr>
799  * </table>
800  *
801  * \default \c 5
802  * \param  encoder  An encoder instance to set.
803  * \param  value    See above.
804  * \assert
805  *    \code encoder != NULL \endcode
806  * \retval FLAC__bool
807  *    \c false if the encoder is already initialized, else \c true.
808  */
809 FLAC_API FLAC__bool FLAC__stream_encoder_set_compression_level(FLAC__StreamEncoder *encoder, unsigned value);
810
811 /** Set the blocksize to use while encoding.
812  *
813  * The number of samples to use per frame.  Use \c 0 to let the encoder
814  * estimate a blocksize; this is usually best.
815  *
816  * \default \c 0
817  * \param  encoder  An encoder instance to set.
818  * \param  value    See above.
819  * \assert
820  *    \code encoder != NULL \endcode
821  * \retval FLAC__bool
822  *    \c false if the encoder is already initialized, else \c true.
823  */
824 FLAC_API FLAC__bool FLAC__stream_encoder_set_blocksize(FLAC__StreamEncoder *encoder, unsigned value);
825
826 /** Set to \c true to enable mid-side encoding on stereo input.  The
827  *  number of channels must be 2 for this to have any effect.  Set to
828  *  \c false to use only independent channel coding.
829  *
830  * \default \c false
831  * \param  encoder  An encoder instance to set.
832  * \param  value    Flag value (see above).
833  * \assert
834  *    \code encoder != NULL \endcode
835  * \retval FLAC__bool
836  *    \c false if the encoder is already initialized, else \c true.
837  */
838 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
839
840 /** Set to \c true to enable adaptive switching between mid-side and
841  *  left-right encoding on stereo input.  Set to \c false to use
842  *  exhaustive searching.  Setting this to \c true requires
843  *  FLAC__stream_encoder_set_do_mid_side_stereo() to also be set to
844  *  \c true in order to have any effect.
845  *
846  * \default \c false
847  * \param  encoder  An encoder instance to set.
848  * \param  value    Flag value (see above).
849  * \assert
850  *    \code encoder != NULL \endcode
851  * \retval FLAC__bool
852  *    \c false if the encoder is already initialized, else \c true.
853  */
854 FLAC_API FLAC__bool FLAC__stream_encoder_set_loose_mid_side_stereo(FLAC__StreamEncoder *encoder, FLAC__bool value);
855
856 /** Sets the apodization function(s) the encoder will use when windowing
857  *  audio data for LPC analysis.
858  *
859  * The \a specification is a plain ASCII string which specifies exactly
860  * which functions to use.  There may be more than one (up to 32),
861  * separated by \c ';' characters.  Some functions take one or more
862  * comma-separated arguments in parentheses.
863  *
864  * The available functions are \c bartlett, \c bartlett_hann,
865  * \c blackman, \c blackman_harris_4term_92db, \c connes, \c flattop,
866  * \c gauss(STDDEV), \c hamming, \c hann, \c kaiser_bessel, \c nuttall,
867  * \c rectangle, \c triangle, \c tukey(P), \c welch.
868  *
869  * For \c gauss(STDDEV), STDDEV specifies the standard deviation
870  * (0<STDDEV<=0.5).
871  *
872  * For \c tukey(P), P specifies the fraction of the window that is
873  * tapered (0<=P<=1).  P=0 corresponds to \c rectangle and P=1
874  * corresponds to \c hann.
875  *
876  * Example specifications are \c "blackman" or
877  * \c "hann;triangle;tukey(0.5);tukey(0.25);tukey(0.125)"
878  *
879  * Any function that is specified erroneously is silently dropped.  Up
880  * to 32 functions are kept, the rest are dropped.  If the specification
881  * is empty the encoder defaults to \c "tukey(0.5)".
882  *
883  * When more than one function is specified, then for every subframe the
884  * encoder will try each of them separately and choose the window that
885  * results in the smallest compressed subframe.
886  *
887  * Note that each function specified causes the encoder to occupy a
888  * floating point array in which to store the window.
889  *
890  * \default \c "tukey(0.5)"
891  * \param  encoder        An encoder instance to set.
892  * \param  specification  See above.
893  * \assert
894  *    \code encoder != NULL \endcode
895  *    \code specification != NULL \endcode
896  * \retval FLAC__bool
897  *    \c false if the encoder is already initialized, else \c true.
898  */
899 /* @@@@add to unit tests*/
900 FLAC_API FLAC__bool FLAC__stream_encoder_set_apodization(FLAC__StreamEncoder *encoder, const char *specification);
901
902 /** Set the maximum LPC order, or \c 0 to use only the fixed predictors.
903  *
904  * \default \c 0
905  * \param  encoder  An encoder instance to set.
906  * \param  value    See above.
907  * \assert
908  *    \code encoder != NULL \endcode
909  * \retval FLAC__bool
910  *    \c false if the encoder is already initialized, else \c true.
911  */
912 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_lpc_order(FLAC__StreamEncoder *encoder, unsigned value);
913
914 /** Set the precision, in bits, of the quantized linear predictor
915  *  coefficients, or \c 0 to let the encoder select it based on the
916  *  blocksize.
917  *
918  * \note
919  * In the current implementation, qlp_coeff_precision + bits_per_sample must
920  * be less than 32.
921  *
922  * \default \c 0
923  * \param  encoder  An encoder instance to set.
924  * \param  value    See above.
925  * \assert
926  *    \code encoder != NULL \endcode
927  * \retval FLAC__bool
928  *    \c false if the encoder is already initialized, else \c true.
929  */
930 FLAC_API FLAC__bool FLAC__stream_encoder_set_qlp_coeff_precision(FLAC__StreamEncoder *encoder, unsigned value);
931
932 /** Set to \c false to use only the specified quantized linear predictor
933  *  coefficient precision, or \c true to search neighboring precision
934  *  values and use the best one.
935  *
936  * \default \c false
937  * \param  encoder  An encoder instance to set.
938  * \param  value    See above.
939  * \assert
940  *    \code encoder != NULL \endcode
941  * \retval FLAC__bool
942  *    \c false if the encoder is already initialized, else \c true.
943  */
944 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_qlp_coeff_prec_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
945
946 /** Deprecated.  Setting this value has no effect.
947  *
948  * \default \c false
949  * \param  encoder  An encoder instance to set.
950  * \param  value    See above.
951  * \assert
952  *    \code encoder != NULL \endcode
953  * \retval FLAC__bool
954  *    \c false if the encoder is already initialized, else \c true.
955  */
956 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_escape_coding(FLAC__StreamEncoder *encoder, FLAC__bool value);
957
958 /** Set to \c false to let the encoder estimate the best model order
959  *  based on the residual signal energy, or \c true to force the
960  *  encoder to evaluate all order models and select the best.
961  *
962  * \default \c false
963  * \param  encoder  An encoder instance to set.
964  * \param  value    See above.
965  * \assert
966  *    \code encoder != NULL \endcode
967  * \retval FLAC__bool
968  *    \c false if the encoder is already initialized, else \c true.
969  */
970 FLAC_API FLAC__bool FLAC__stream_encoder_set_do_exhaustive_model_search(FLAC__StreamEncoder *encoder, FLAC__bool value);
971
972 /** Set the minimum partition order to search when coding the residual.
973  *  This is used in tandem with
974  *  FLAC__stream_encoder_set_max_residual_partition_order().
975  *
976  *  The partition order determines the context size in the residual.
977  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
978  *
979  *  Set both min and max values to \c 0 to force a single context,
980  *  whose Rice parameter is based on the residual signal variance.
981  *  Otherwise, set a min and max order, and the encoder will search
982  *  all orders, using the mean of each context for its Rice parameter,
983  *  and use the best.
984  *
985  * \default \c 0
986  * \param  encoder  An encoder instance to set.
987  * \param  value    See above.
988  * \assert
989  *    \code encoder != NULL \endcode
990  * \retval FLAC__bool
991  *    \c false if the encoder is already initialized, else \c true.
992  */
993 FLAC_API FLAC__bool FLAC__stream_encoder_set_min_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
994
995 /** Set the maximum partition order to search when coding the residual.
996  *  This is used in tandem with
997  *  FLAC__stream_encoder_set_min_residual_partition_order().
998  *
999  *  The partition order determines the context size in the residual.
1000  *  The context size will be approximately <tt>blocksize / (2 ^ order)</tt>.
1001  *
1002  *  Set both min and max values to \c 0 to force a single context,
1003  *  whose Rice parameter is based on the residual signal variance.
1004  *  Otherwise, set a min and max order, and the encoder will search
1005  *  all orders, using the mean of each context for its Rice parameter,
1006  *  and use the best.
1007  *
1008  * \default \c 0
1009  * \param  encoder  An encoder instance to set.
1010  * \param  value    See above.
1011  * \assert
1012  *    \code encoder != NULL \endcode
1013  * \retval FLAC__bool
1014  *    \c false if the encoder is already initialized, else \c true.
1015  */
1016 FLAC_API FLAC__bool FLAC__stream_encoder_set_max_residual_partition_order(FLAC__StreamEncoder *encoder, unsigned value);
1017
1018 /** Deprecated.  Setting this value has no effect.
1019  *
1020  * \default \c 0
1021  * \param  encoder  An encoder instance to set.
1022  * \param  value    See above.
1023  * \assert
1024  *    \code encoder != NULL \endcode
1025  * \retval FLAC__bool
1026  *    \c false if the encoder is already initialized, else \c true.
1027  */
1028 FLAC_API FLAC__bool FLAC__stream_encoder_set_rice_parameter_search_dist(FLAC__StreamEncoder *encoder, unsigned value);
1029
1030 /** Set an estimate of the total samples that will be encoded.
1031  *  This is merely an estimate and may be set to \c 0 if unknown.
1032  *  This value will be written to the STREAMINFO block before encoding,
1033  *  and can remove the need for the caller to rewrite the value later
1034  *  if the value is known before encoding.
1035  *
1036  * \default \c 0
1037  * \param  encoder  An encoder instance to set.
1038  * \param  value    See above.
1039  * \assert
1040  *    \code encoder != NULL \endcode
1041  * \retval FLAC__bool
1042  *    \c false if the encoder is already initialized, else \c true.
1043  */
1044 FLAC_API FLAC__bool FLAC__stream_encoder_set_total_samples_estimate(FLAC__StreamEncoder *encoder, FLAC__uint64 value);
1045
1046 /** Set the metadata blocks to be emitted to the stream before encoding.
1047  *  A value of \c NULL, \c 0 implies no metadata; otherwise, supply an
1048  *  array of pointers to metadata blocks.  The array is non-const since
1049  *  the encoder may need to change the \a is_last flag inside them, and
1050  *  in some cases update seek point offsets.  Otherwise, the encoder will
1051  *  not modify or free the blocks.  It is up to the caller to free the
1052  *  metadata blocks after encoding.
1053  *
1054  * \note
1055  * The encoder stores only the \a metadata pointer; the passed-in array
1056  * must survive at least until after FLAC__stream_encoder_init_*() returns.
1057  * Do not modify the array or free the blocks until then.
1058  *
1059  * \note
1060  * The STREAMINFO block is always written and no STREAMINFO block may
1061  * occur in the supplied array.
1062  *
1063  * \note
1064  * By default the encoder does not create a SEEKTABLE.  If one is supplied
1065  * in the \a metadata array, but the client has specified that it does not
1066  * support seeking, then the SEEKTABLE will be written verbatim.  However
1067  * by itself this is not very useful as the client will not know the stream
1068  * offsets for the seekpoints ahead of time.  In order to get a proper
1069  * seektable the client must support seeking.  See next note.
1070  *
1071  * \note
1072  * SEEKTABLE blocks are handled specially.  Since you will not know
1073  * the values for the seek point stream offsets, you should pass in
1074  * a SEEKTABLE 'template', that is, a SEEKTABLE object with the
1075  * required sample numbers (or placeholder points), with \c 0 for the
1076  * \a frame_samples and \a stream_offset fields for each point.  If the
1077  * client has specified that it supports seeking by providing a seek
1078  * callback to FLAC__stream_encoder_init_stream() or both seek AND read
1079  * callback to FLAC__stream_encoder_init_ogg_stream() (or by using
1080  * FLAC__stream_encoder_init*_file() or FLAC__stream_encoder_init*_FILE()),
1081  * then while it is encoding the encoder will fill the stream offsets in
1082  * for you and when encoding is finished, it will seek back and write the
1083  * real values into the SEEKTABLE block in the stream.  There are helper
1084  * routines for manipulating seektable template blocks; see metadata.h:
1085  * FLAC__metadata_object_seektable_template_*().  If the client does
1086  * not support seeking, the SEEKTABLE will have inaccurate offsets which
1087  * will slow down or remove the ability to seek in the FLAC stream.
1088  *
1089  * \note
1090  * The encoder instance \b will modify the first \c SEEKTABLE block
1091  * as it transforms the template to a valid seektable while encoding,
1092  * but it is still up to the caller to free all metadata blocks after
1093  * encoding.
1094  *
1095  * \note
1096  * A VORBIS_COMMENT block may be supplied.  The vendor string in it
1097  * will be ignored.  libFLAC will use it's own vendor string. libFLAC
1098  * will not modify the passed-in VORBIS_COMMENT's vendor string, it
1099  * will simply write it's own into the stream.  If no VORBIS_COMMENT
1100  * block is present in the \a metadata array, libFLAC will write an
1101  * empty one, containing only the vendor string.
1102  *
1103  * \note The Ogg FLAC mapping requires that the VORBIS_COMMENT block be
1104  * the second metadata block of the stream.  The encoder already supplies
1105  * the STREAMINFO block automatically.  If \a metadata does not contain a
1106  * VORBIS_COMMENT block, the encoder will supply that too.  Otherwise, if
1107  * \a metadata does contain a VORBIS_COMMENT block and it is not the
1108  * first, the init function will reorder \a metadata by moving the
1109  * VORBIS_COMMENT block to the front; the relative ordering of the other
1110  * blocks will remain as they were.
1111  *
1112  * \note The Ogg FLAC mapping limits the number of metadata blocks per
1113  * stream to \c 65535.  If \a num_blocks exceeds this the function will
1114  * return \c false.
1115  *
1116  * \default \c NULL, 0
1117  * \param  encoder     An encoder instance to set.
1118  * \param  metadata    See above.
1119  * \param  num_blocks  See above.
1120  * \assert
1121  *    \code encoder != NULL \endcode
1122  * \retval FLAC__bool
1123  *    \c false if the encoder is already initialized, else \c true.
1124  *    \c false if the encoder is already initialized, or if
1125  *    \a num_blocks > 65535 if encoding to Ogg FLAC, else \c true.
1126  */
1127 FLAC_API FLAC__bool FLAC__stream_encoder_set_metadata(FLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
1128
1129 /** Get the current encoder state.
1130  *
1131  * \param  encoder  An encoder instance to query.
1132  * \assert
1133  *    \code encoder != NULL \endcode
1134  * \retval FLAC__StreamEncoderState
1135  *    The current encoder state.
1136  */
1137 FLAC_API FLAC__StreamEncoderState FLAC__stream_encoder_get_state(const FLAC__StreamEncoder *encoder);
1138
1139 /** Get the state of the verify stream decoder.
1140  *  Useful when the stream encoder state is
1141  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.
1142  *
1143  * \param  encoder  An encoder instance to query.
1144  * \assert
1145  *    \code encoder != NULL \endcode
1146  * \retval FLAC__StreamDecoderState
1147  *    The verify stream decoder state.
1148  */
1149 FLAC_API FLAC__StreamDecoderState FLAC__stream_encoder_get_verify_decoder_state(const FLAC__StreamEncoder *encoder);
1150
1151 /** Get the current encoder state as a C string.
1152  *  This version automatically resolves
1153  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR by getting the
1154  *  verify decoder's state.
1155  *
1156  * \param  encoder  A encoder instance to query.
1157  * \assert
1158  *    \code encoder != NULL \endcode
1159  * \retval const char *
1160  *    The encoder state as a C string.  Do not modify the contents.
1161  */
1162 FLAC_API const char *FLAC__stream_encoder_get_resolved_state_string(const FLAC__StreamEncoder *encoder);
1163
1164 /** Get relevant values about the nature of a verify decoder error.
1165  *  Useful when the stream encoder state is
1166  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.  The arguments should
1167  *  be addresses in which the stats will be returned, or NULL if value
1168  *  is not desired.
1169  *
1170  * \param  encoder  An encoder instance to query.
1171  * \param  absolute_sample  The absolute sample number of the mismatch.
1172  * \param  frame_number  The number of the frame in which the mismatch occurred.
1173  * \param  channel       The channel in which the mismatch occurred.
1174  * \param  sample        The number of the sample (relative to the frame) in
1175  *                       which the mismatch occurred.
1176  * \param  expected      The expected value for the sample in question.
1177  * \param  got           The actual value returned by the decoder.
1178  * \assert
1179  *    \code encoder != NULL \endcode
1180  */
1181 FLAC_API void FLAC__stream_encoder_get_verify_decoder_error_stats(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got);
1182
1183 /** Get the "verify" flag.
1184  *
1185  * \param  encoder  An encoder instance to query.
1186  * \assert
1187  *    \code encoder != NULL \endcode
1188  * \retval FLAC__bool
1189  *    See FLAC__stream_encoder_set_verify().
1190  */
1191 FLAC_API FLAC__bool FLAC__stream_encoder_get_verify(const FLAC__StreamEncoder *encoder);
1192
1193 /** Get the <A HREF="../format.html#subset>Subset</A> flag.
1194  *
1195  * \param  encoder  An encoder instance to query.
1196  * \assert
1197  *    \code encoder != NULL \endcode
1198  * \retval FLAC__bool
1199  *    See FLAC__stream_encoder_set_streamable_subset().
1200  */
1201 FLAC_API FLAC__bool FLAC__stream_encoder_get_streamable_subset(const FLAC__StreamEncoder *encoder);
1202
1203 /** Get the number of input channels being processed.
1204  *
1205  * \param  encoder  An encoder instance to query.
1206  * \assert
1207  *    \code encoder != NULL \endcode
1208  * \retval unsigned
1209  *    See FLAC__stream_encoder_set_channels().
1210  */
1211 FLAC_API unsigned FLAC__stream_encoder_get_channels(const FLAC__StreamEncoder *encoder);
1212
1213 /** Get the input sample resolution setting.
1214  *
1215  * \param  encoder  An encoder instance to query.
1216  * \assert
1217  *    \code encoder != NULL \endcode
1218  * \retval unsigned
1219  *    See FLAC__stream_encoder_set_bits_per_sample().
1220  */
1221 FLAC_API unsigned FLAC__stream_encoder_get_bits_per_sample(const FLAC__StreamEncoder *encoder);
1222
1223 /** Get the input sample rate setting.
1224  *
1225  * \param  encoder  An encoder instance to query.
1226  * \assert
1227  *    \code encoder != NULL \endcode
1228  * \retval unsigned
1229  *    See FLAC__stream_encoder_set_sample_rate().
1230  */
1231 FLAC_API unsigned FLAC__stream_encoder_get_sample_rate(const FLAC__StreamEncoder *encoder);
1232
1233 /** Get the blocksize setting.
1234  *
1235  * \param  encoder  An encoder instance to query.
1236  * \assert
1237  *    \code encoder != NULL \endcode
1238  * \retval unsigned
1239  *    See FLAC__stream_encoder_set_blocksize().
1240  */
1241 FLAC_API unsigned FLAC__stream_encoder_get_blocksize(const FLAC__StreamEncoder *encoder);
1242
1243 /** Get the "mid/side stereo coding" flag.
1244  *
1245  * \param  encoder  An encoder instance to query.
1246  * \assert
1247  *    \code encoder != NULL \endcode
1248  * \retval FLAC__bool
1249  *    See FLAC__stream_encoder_get_do_mid_side_stereo().
1250  */
1251 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_mid_side_stereo(const FLAC__StreamEncoder *encoder);
1252
1253 /** Get the "adaptive mid/side switching" flag.
1254  *
1255  * \param  encoder  An encoder instance to query.
1256  * \assert
1257  *    \code encoder != NULL \endcode
1258  * \retval FLAC__bool
1259  *    See FLAC__stream_encoder_set_loose_mid_side_stereo().
1260  */
1261 FLAC_API FLAC__bool FLAC__stream_encoder_get_loose_mid_side_stereo(const FLAC__StreamEncoder *encoder);
1262
1263 /** Get the maximum LPC order setting.
1264  *
1265  * \param  encoder  An encoder instance to query.
1266  * \assert
1267  *    \code encoder != NULL \endcode
1268  * \retval unsigned
1269  *    See FLAC__stream_encoder_set_max_lpc_order().
1270  */
1271 FLAC_API unsigned FLAC__stream_encoder_get_max_lpc_order(const FLAC__StreamEncoder *encoder);
1272
1273 /** Get the quantized linear predictor coefficient precision setting.
1274  *
1275  * \param  encoder  An encoder instance to query.
1276  * \assert
1277  *    \code encoder != NULL \endcode
1278  * \retval unsigned
1279  *    See FLAC__stream_encoder_set_qlp_coeff_precision().
1280  */
1281 FLAC_API unsigned FLAC__stream_encoder_get_qlp_coeff_precision(const FLAC__StreamEncoder *encoder);
1282
1283 /** Get the qlp coefficient precision search flag.
1284  *
1285  * \param  encoder  An encoder instance to query.
1286  * \assert
1287  *    \code encoder != NULL \endcode
1288  * \retval FLAC__bool
1289  *    See FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
1290  */
1291 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__StreamEncoder *encoder);
1292
1293 /** Get the "escape coding" flag.
1294  *
1295  * \param  encoder  An encoder instance to query.
1296  * \assert
1297  *    \code encoder != NULL \endcode
1298  * \retval FLAC__bool
1299  *    See FLAC__stream_encoder_set_do_escape_coding().
1300  */
1301 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_escape_coding(const FLAC__StreamEncoder *encoder);
1302
1303 /** Get the exhaustive model search flag.
1304  *
1305  * \param  encoder  An encoder instance to query.
1306  * \assert
1307  *    \code encoder != NULL \endcode
1308  * \retval FLAC__bool
1309  *    See FLAC__stream_encoder_set_do_exhaustive_model_search().
1310  */
1311 FLAC_API FLAC__bool FLAC__stream_encoder_get_do_exhaustive_model_search(const FLAC__StreamEncoder *encoder);
1312
1313 /** Get the minimum residual partition order setting.
1314  *
1315  * \param  encoder  An encoder instance to query.
1316  * \assert
1317  *    \code encoder != NULL \endcode
1318  * \retval unsigned
1319  *    See FLAC__stream_encoder_set_min_residual_partition_order().
1320  */
1321 FLAC_API unsigned FLAC__stream_encoder_get_min_residual_partition_order(const FLAC__StreamEncoder *encoder);
1322
1323 /** Get maximum residual partition order setting.
1324  *
1325  * \param  encoder  An encoder instance to query.
1326  * \assert
1327  *    \code encoder != NULL \endcode
1328  * \retval unsigned
1329  *    See FLAC__stream_encoder_set_max_residual_partition_order().
1330  */
1331 FLAC_API unsigned FLAC__stream_encoder_get_max_residual_partition_order(const FLAC__StreamEncoder *encoder);
1332
1333 /** Get the Rice parameter search distance setting.
1334  *
1335  * \param  encoder  An encoder instance to query.
1336  * \assert
1337  *    \code encoder != NULL \endcode
1338  * \retval unsigned
1339  *    See FLAC__stream_encoder_set_rice_parameter_search_dist().
1340  */
1341 FLAC_API unsigned FLAC__stream_encoder_get_rice_parameter_search_dist(const FLAC__StreamEncoder *encoder);
1342
1343 /** Get the previously set estimate of the total samples to be encoded.
1344  *  The encoder merely mimics back the value given to
1345  *  FLAC__stream_encoder_set_total_samples_estimate() since it has no
1346  *  other way of knowing how many samples the client will encode.
1347  *
1348  * \param  encoder  An encoder instance to set.
1349  * \assert
1350  *    \code encoder != NULL \endcode
1351  * \retval FLAC__uint64
1352  *    See FLAC__stream_encoder_get_total_samples_estimate().
1353  */
1354 FLAC_API FLAC__uint64 FLAC__stream_encoder_get_total_samples_estimate(const FLAC__StreamEncoder *encoder);
1355
1356 /** Initialize the encoder instance to encode native FLAC streams.
1357  *
1358  *  This flavor of initialization sets up the encoder to encode to a
1359  *  native FLAC stream. I/O is performed via callbacks to the client.
1360  *  For encoding to a plain file via filename or open \c FILE*,
1361  *  FLAC__stream_encoder_init_file() and FLAC__stream_encoder_init_FILE()
1362  *  provide a simpler interface.
1363  *
1364  *  This function should be called after FLAC__stream_encoder_new() and
1365  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1366  *  or FLAC__stream_encoder_process_interleaved().
1367  *  initialization succeeded.
1368  *
1369  *  The call to FLAC__stream_encoder_init_stream() currently will also
1370  *  immediately call the write callback several times, once with the \c fLaC
1371  *  signature, and once for each encoded metadata block.
1372  *
1373  * \param  encoder            An uninitialized encoder instance.
1374  * \param  write_callback     See FLAC__StreamEncoderWriteCallback.  This
1375  *                            pointer must not be \c NULL.
1376  * \param  seek_callback      See FLAC__StreamEncoderSeekCallback.  This
1377  *                            pointer may be \c NULL if seeking is not
1378  *                            supported.  The encoder uses seeking to go back
1379  *                            and write some some stream statistics to the
1380  *                            STREAMINFO block; this is recommended but not
1381  *                            necessary to create a valid FLAC stream.  If
1382  *                            \a seek_callback is not \c NULL then a
1383  *                            \a tell_callback must also be supplied.
1384  *                            Alternatively, a dummy seek callback that just
1385  *                            returns \c FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED
1386  *                            may also be supplied, all though this is slightly
1387  *                            less efficient for the decoder.
1388  * \param  tell_callback      See FLAC__StreamEncoderTellCallback.  This
1389  *                            pointer may be \c NULL if seeking is not
1390  *                            supported.  If \a seek_callback is \c NULL then
1391  *                            this argument will be ignored.  If
1392  *                            \a seek_callback is not \c NULL then a
1393  *                            \a tell_callback must also be supplied.
1394  *                            Alternatively, a dummy tell callback that just
1395  *                            returns \c FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED
1396  *                            may also be supplied, all though this is slightly
1397  *                            less efficient for the decoder.
1398  * \param  metadata_callback  See FLAC__StreamEncoderMetadataCallback.  This
1399  *                            pointer may be \c NULL if the callback is not
1400  *                            desired.  If the client provides a seek callback,
1401  *                            this function is not necessary as the encoder
1402  *                            will automatically seek back and update the
1403  *                            STREAMINFO block.  It may also be \c NULL if the
1404  *                            client does not support seeking, since it will
1405  *                            have no way of going back to update the
1406  *                            STREAMINFO.  However the client can still supply
1407  *                            a callback if it would like to know the details
1408  *                            from the STREAMINFO.
1409  * \param  client_data        This value will be supplied to callbacks in their
1410  *                            \a client_data argument.
1411  * \assert
1412  *    \code encoder != NULL \endcode
1413  * \retval FLAC__StreamEncoderInitStatus
1414  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1415  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1416  */
1417 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_stream(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderWriteCallback write_callback, FLAC__StreamEncoderSeekCallback seek_callback, FLAC__StreamEncoderTellCallback tell_callback, FLAC__StreamEncoderMetadataCallback metadata_callback, void *client_data);
1418
1419 /** Initialize the encoder instance to encode Ogg FLAC streams.
1420  *
1421  *  This flavor of initialization sets up the encoder to encode to a FLAC
1422  *  stream in an Ogg container.  I/O is performed via callbacks to the
1423  *  client.  For encoding to a plain file via filename or open \c FILE*,
1424  *  FLAC__stream_encoder_init_ogg_file() and FLAC__stream_encoder_init_ogg_FILE()
1425  *  provide a simpler interface.
1426  *
1427  *  This function should be called after FLAC__stream_encoder_new() and
1428  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1429  *  or FLAC__stream_encoder_process_interleaved().
1430  *  initialization succeeded.
1431  *
1432  *  The call to FLAC__stream_encoder_init_ogg_stream() currently will also
1433  *  immediately call the write callback several times to write the metadata
1434  *  packets.
1435  *
1436  * \param  encoder            An uninitialized encoder instance.
1437  * \param  read_callback      See FLAC__StreamEncoderReadCallback.  This
1438  *                            pointer must not be \c NULL if \a seek_callback
1439  *                            is non-NULL since they are both needed to be
1440  *                            able to write data back to the Ogg FLAC stream
1441  *                            in the post-encode phase.
1442  * \param  write_callback     See FLAC__StreamEncoderWriteCallback.  This
1443  *                            pointer must not be \c NULL.
1444  * \param  seek_callback      See FLAC__StreamEncoderSeekCallback.  This
1445  *                            pointer may be \c NULL if seeking is not
1446  *                            supported.  The encoder uses seeking to go back
1447  *                            and write some some stream statistics to the
1448  *                            STREAMINFO block; this is recommended but not
1449  *                            necessary to create a valid FLAC stream.  If
1450  *                            \a seek_callback is not \c NULL then a
1451  *                            \a tell_callback must also be supplied.
1452  *                            Alternatively, a dummy seek callback that just
1453  *                            returns \c FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED
1454  *                            may also be supplied, all though this is slightly
1455  *                            less efficient for the decoder.
1456  * \param  tell_callback      See FLAC__StreamEncoderTellCallback.  This
1457  *                            pointer may be \c NULL if seeking is not
1458  *                            supported.  If \a seek_callback is \c NULL then
1459  *                            this argument will be ignored.  If
1460  *                            \a seek_callback is not \c NULL then a
1461  *                            \a tell_callback must also be supplied.
1462  *                            Alternatively, a dummy tell callback that just
1463  *                            returns \c FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED
1464  *                            may also be supplied, all though this is slightly
1465  *                            less efficient for the decoder.
1466  * \param  metadata_callback  See FLAC__StreamEncoderMetadataCallback.  This
1467  *                            pointer may be \c NULL if the callback is not
1468  *                            desired.  If the client provides a seek callback,
1469  *                            this function is not necessary as the encoder
1470  *                            will automatically seek back and update the
1471  *                            STREAMINFO block.  It may also be \c NULL if the
1472  *                            client does not support seeking, since it will
1473  *                            have no way of going back to update the
1474  *                            STREAMINFO.  However the client can still supply
1475  *                            a callback if it would like to know the details
1476  *                            from the STREAMINFO.
1477  * \param  client_data        This value will be supplied to callbacks in their
1478  *                            \a client_data argument.
1479  * \assert
1480  *    \code encoder != NULL \endcode
1481  * \retval FLAC__StreamEncoderInitStatus
1482  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1483  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1484  */
1485 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_stream(FLAC__StreamEncoder *encoder, FLAC__StreamEncoderReadCallback read_callback, FLAC__StreamEncoderWriteCallback write_callback, FLAC__StreamEncoderSeekCallback seek_callback, FLAC__StreamEncoderTellCallback tell_callback, FLAC__StreamEncoderMetadataCallback metadata_callback, void *client_data);
1486
1487 /** Initialize the encoder instance to encode native FLAC files.
1488  *
1489  *  This flavor of initialization sets up the encoder to encode to a
1490  *  plain native FLAC file.  For non-stdio streams, you must use
1491  *  FLAC__stream_encoder_init_stream() and provide callbacks for the I/O.
1492  *
1493  *  This function should be called after FLAC__stream_encoder_new() and
1494  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1495  *  or FLAC__stream_encoder_process_interleaved().
1496  *  initialization succeeded.
1497  *
1498  * \param  encoder            An uninitialized encoder instance.
1499  * \param  file               An open file.  The file should have been opened
1500  *                            with mode \c "w+b" and rewound.  The file
1501  *                            becomes owned by the encoder and should not be
1502  *                            manipulated by the client while encoding.
1503  *                            Unless \a file is \c stdout, it will be closed
1504  *                            when FLAC__stream_encoder_finish() is called.
1505  *                            Note however that a proper SEEKTABLE cannot be
1506  *                            created when encoding to \c stdout since it is
1507  *                            not seekable.
1508  * \param  progress_callback  See FLAC__StreamEncoderProgressCallback.  This
1509  *                            pointer may be \c NULL if the callback is not
1510  *                            desired.
1511  * \param  client_data        This value will be supplied to callbacks in their
1512  *                            \a client_data argument.
1513  * \assert
1514  *    \code encoder != NULL \endcode
1515  *    \code file != NULL \endcode
1516  * \retval FLAC__StreamEncoderInitStatus
1517  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1518  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1519  */
1520 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_FILE(FLAC__StreamEncoder *encoder, FILE *file, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1521
1522 /** Initialize the encoder instance to encode Ogg FLAC files.
1523  *
1524  *  This flavor of initialization sets up the encoder to encode to a
1525  *  plain Ogg FLAC file.  For non-stdio streams, you must use
1526  *  FLAC__stream_encoder_init_ogg_stream() and provide callbacks for the I/O.
1527  *
1528  *  This function should be called after FLAC__stream_encoder_new() and
1529  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1530  *  or FLAC__stream_encoder_process_interleaved().
1531  *  initialization succeeded.
1532  *
1533  * \param  encoder            An uninitialized encoder instance.
1534  * \param  file               An open file.  The file should have been opened
1535  *                            with mode \c "w+b" and rewound.  The file
1536  *                            becomes owned by the encoder and should not be
1537  *                            manipulated by the client while encoding.
1538  *                            Unless \a file is \c stdout, it will be closed
1539  *                            when FLAC__stream_encoder_finish() is called.
1540  *                            Note however that a proper SEEKTABLE cannot be
1541  *                            created when encoding to \c stdout since it is
1542  *                            not seekable.
1543  * \param  progress_callback  See FLAC__StreamEncoderProgressCallback.  This
1544  *                            pointer may be \c NULL if the callback is not
1545  *                            desired.
1546  * \param  client_data        This value will be supplied to callbacks in their
1547  *                            \a client_data argument.
1548  * \assert
1549  *    \code encoder != NULL \endcode
1550  *    \code file != NULL \endcode
1551  * \retval FLAC__StreamEncoderInitStatus
1552  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1553  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1554  */
1555 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_FILE(FLAC__StreamEncoder *encoder, FILE *file, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1556
1557 /** Initialize the encoder instance to encode native FLAC files.
1558  *
1559  *  This flavor of initialization sets up the encoder to encode to a plain
1560  *  FLAC file.  If POSIX fopen() semantics are not sufficient (for example,
1561  *  with Unicode filenames on Windows), you must use
1562  *  FLAC__stream_encoder_init_FILE(), or FLAC__stream_encoder_init_stream()
1563  *  and provide callbacks for the I/O.
1564  *
1565  *  This function should be called after FLAC__stream_encoder_new() and
1566  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1567  *  or FLAC__stream_encoder_process_interleaved().
1568  *  initialization succeeded.
1569  *
1570  * \param  encoder            An uninitialized encoder instance.
1571  * \param  filename           The name of the file to encode to.  The file will
1572  *                            be opened with fopen().  Use \c NULL to encode to
1573  *                            \c stdout.  Note however that a proper SEEKTABLE
1574  *                            cannot be created when encoding to \c stdout since
1575  *                            it is not seekable.
1576  * \param  progress_callback  See FLAC__StreamEncoderProgressCallback.  This
1577  *                            pointer may be \c NULL if the callback is not
1578  *                            desired.
1579  * \param  client_data        This value will be supplied to callbacks in their
1580  *                            \a client_data argument.
1581  * \assert
1582  *    \code encoder != NULL \endcode
1583  * \retval FLAC__StreamEncoderInitStatus
1584  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1585  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1586  */
1587 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1588
1589 /** Initialize the encoder instance to encode Ogg FLAC files.
1590  *
1591  *  This flavor of initialization sets up the encoder to encode to a plain
1592  *  Ogg FLAC file.  If POSIX fopen() semantics are not sufficient (for example,
1593  *  with Unicode filenames on Windows), you must use
1594  *  FLAC__stream_encoder_init_ogg_FILE(), or FLAC__stream_encoder_init_ogg_stream()
1595  *  and provide callbacks for the I/O.
1596  *
1597  *  This function should be called after FLAC__stream_encoder_new() and
1598  *  FLAC__stream_encoder_set_*() but before FLAC__stream_encoder_process()
1599  *  or FLAC__stream_encoder_process_interleaved().
1600  *  initialization succeeded.
1601  *
1602  * \param  encoder            An uninitialized encoder instance.
1603  * \param  filename           The name of the file to encode to.  The file will
1604  *                            be opened with fopen().  Use \c NULL to encode to
1605  *                            \c stdout.  Note however that a proper SEEKTABLE
1606  *                            cannot be created when encoding to \c stdout since
1607  *                            it is not seekable.
1608  * \param  progress_callback  See FLAC__StreamEncoderProgressCallback.  This
1609  *                            pointer may be \c NULL if the callback is not
1610  *                            desired.
1611  * \param  client_data        This value will be supplied to callbacks in their
1612  *                            \a client_data argument.
1613  * \assert
1614  *    \code encoder != NULL \endcode
1615  * \retval FLAC__StreamEncoderInitStatus
1616  *    \c FLAC__STREAM_ENCODER_INIT_STATUS_OK if initialization was successful;
1617  *    see FLAC__StreamEncoderInitStatus for the meanings of other return values.
1618  */
1619 FLAC_API FLAC__StreamEncoderInitStatus FLAC__stream_encoder_init_ogg_file(FLAC__StreamEncoder *encoder, const char *filename, FLAC__StreamEncoderProgressCallback progress_callback, void *client_data);
1620
1621 /** Finish the encoding process.
1622  *  Flushes the encoding buffer, releases resources, resets the encoder
1623  *  settings to their defaults, and returns the encoder state to
1624  *  FLAC__STREAM_ENCODER_UNINITIALIZED.  Note that this can generate
1625  *  one or more write callbacks before returning, and will generate
1626  *  a metadata callback.
1627  *
1628  *  In the event of a prematurely-terminated encode, it is not strictly
1629  *  necessary to call this immediately before FLAC__stream_encoder_delete()
1630  *  but it is good practice to match every FLAC__stream_encoder_init_*()
1631  *  with a FLAC__stream_encoder_finish().
1632  *
1633  * \param  encoder  An uninitialized encoder instance.
1634  * \assert
1635  *    \code encoder != NULL \endcode
1636  */
1637 FLAC_API void FLAC__stream_encoder_finish(FLAC__StreamEncoder *encoder);
1638
1639 /** Submit data for encoding.
1640  *  This version allows you to supply the input data via an array of
1641  *  pointers, each pointer pointing to an array of \a samples samples
1642  *  representing one channel.  The samples need not be block-aligned,
1643  *  but each channel should have the same number of samples.
1644  *
1645  *  For applications where channel order is important, channels must
1646  *  follow the order as described in the
1647  *  <A HREF="../format.html#frame_header">frame header</A>.
1648  *
1649  * \param  encoder  An initialized encoder instance in the OK state.
1650  * \param  buffer   An array of pointers to each channel's signal.
1651  * \param  samples  The number of samples in one channel.
1652  * \assert
1653  *    \code encoder != NULL \endcode
1654  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
1655  * \retval FLAC__bool
1656  *    \c true if successful, else \c false; in this case, check the
1657  *    encoder state with FLAC__stream_encoder_get_state() to see what
1658  *    went wrong.
1659  */
1660 FLAC_API FLAC__bool FLAC__stream_encoder_process(FLAC__StreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
1661
1662 /** Submit data for encoding.
1663  *  This version allows you to supply the input data where the channels
1664  *  are interleaved into a single array (i.e. channel0_sample0,
1665  *  channel1_sample0, ... , channelN_sample0, channel0_sample1, ...).
1666  *  The samples need not be block-aligned but they must be
1667  *  sample-aligned, i.e. the first value should be channel0_sample0
1668  *  and the last value channelN_sampleM.
1669  *
1670  *  For applications where channel order is important, channels must
1671  *  follow the order as described in the
1672  *  <A HREF="../format.html#frame_header">frame header</A>.
1673  *
1674  * \param  encoder  An initialized encoder instance in the OK state.
1675  * \param  buffer   An array of channel-interleaved data (see above).
1676  * \param  samples  The number of samples in one channel, the same as for
1677  *                  FLAC__stream_encoder_process().  For example, if
1678  *                  encoding two channels, \c 1000 \a samples corresponds
1679  *                  to a \a buffer of 2000 values.
1680  * \assert
1681  *    \code encoder != NULL \endcode
1682  *    \code FLAC__stream_encoder_get_state(encoder) == FLAC__STREAM_ENCODER_OK \endcode
1683  * \retval FLAC__bool
1684  *    \c true if successful, else \c false; in this case, check the
1685  *    encoder state with FLAC__stream_encoder_get_state() to see what
1686  *    went wrong.
1687  */
1688 FLAC_API FLAC__bool FLAC__stream_encoder_process_interleaved(FLAC__StreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);
1689
1690 /* \} */
1691
1692 #ifdef __cplusplus
1693 }
1694 #endif
1695
1696 #endif