more doxygen comments
[flac.git] / include / FLAC / seekable_stream_encoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 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__SEEKABLE_STREAM_ENCODER_H
21 #define FLAC__SEEKABLE_STREAM_ENCODER_H
22
23 #include "stream_encoder.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /** \file include/FLAC/seekable_stream_encoder.h
31  *
32  *  \brief
33  *  This module contains the functions which implement the seekable stream
34  *  encoder.
35  *
36  *  See the detailed documentation in the
37  *  \link flac_seekable_stream_encoder seekable stream encoder \endlink module.
38  */
39
40 /** \defgroup flac_seekable_stream_encoder FLAC/seekable_stream_encoder.h: seekable stream encoder interface
41  *  \ingroup flac_encoder
42  *
43  *  \brief
44  *  This module contains the functions which implement the seekable stream
45  *  encoder.
46  *
47  * XXX (import)
48  *
49  * The seekable stream encoder is a wrapper around the
50  * \link flac_stream_encoder stream encoder \endlink which (XXXimport)
51  *
52  * Make sure to read the detailed description of the
53  * \link flac_stream_encoder stream encoder module \endlink since the
54  * seekable stream encoder inherits much of its behavior.
55  *
56  * \note
57  * The "set" functions may only be called when the encoder is in the
58  * state FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED, i.e. after
59  * FLAC__seekable_stream_encoder_new() or FLAC__seekable_stream_encoder_finish(), but
60  * before FLAC__seekable_stream_encoder_init().  If this is the case they will
61  * return \c true, otherwise \c false.
62  *
63  * \note
64  * FLAC__seekable_stream_encoder_finish() resets all settings to the constructor
65  * defaults, including the callbacks.
66  *
67  * \{
68  */
69
70
71 /** State values for a FLAC__SeekableStreamEncoder
72  *
73  *  The encoder's state can be obtained by calling FLAC__seekable_stream_encoder_get_state().
74  */
75 typedef enum {
76
77         FLAC__SEEKABLE_STREAM_ENCODER_OK = 0,
78         /**< The encoder is in the normal OK state. */
79
80         FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR,
81         /**< An error occurred in the underlying stream encoder;
82          * check FLAC__seekable_stream_encoder_get_stream_encoder_state().
83          */
84
85         FLAC__SEEKABLE_STREAM_ENCODER_MEMORY_ALLOCATION_ERROR,
86         /**< Memory allocation failed. */
87
88         FLAC__SEEKABLE_STREAM_ENCODER_WRITE_ERROR,
89         /**< The write callback returned an error. */
90
91         FLAC__SEEKABLE_STREAM_ENCODER_READ_ERROR,
92         /**< The read callback returned an error. */
93
94         FLAC__SEEKABLE_STREAM_ENCODER_SEEK_ERROR,
95         /**< The seek callback returned an error. */
96
97         FLAC__SEEKABLE_STREAM_ENCODER_ALREADY_INITIALIZED,
98         /**< FLAC__seekable_stream_encoder_init() was called when the encoder was
99          * already initialized, usually because
100          * FLAC__seekable_stream_encoder_finish() was not called.
101          */
102
103     FLAC__SEEKABLE_STREAM_ENCODER_INVALID_CALLBACK,
104         /**< FLAC__seekable_stream_encoder_init() was called without all
105          * callbacks being set.
106          */
107
108     FLAC__SEEKABLE_STREAM_ENCODER_INVALID_SEEKTABLE,
109         /**< An invalid seek table was passed is the metadata to
110          * FLAC__seekable_stream_encoder_set_metadata().
111          */
112
113         FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED
114         /**< The encoder is in the uninitialized state. */
115
116 } FLAC__SeekableStreamEncoderState;
117
118 /** Maps a FLAC__SeekableStreamEncoderState to a C string.
119  *
120  *  Using a FLAC__SeekableStreamEncoderState as the index to this array
121  *  will give the string equivalent.  The contents should not be modified.
122  */
123 extern const char * const FLAC__SeekableStreamEncoderStateString[];
124
125
126 /** Return values for the FLAC__SeekableStreamEncoder seek callback.
127  */
128 typedef enum {
129
130         FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_OK,
131         /**< The seek was OK and encoding can continue. */
132
133         FLAC__SEEKABLE_STREAM_ENCODER_SEEK_STATUS_ERROR
134         /**< An unrecoverable error occurred.  The encoder will return from the process call. */
135
136 } FLAC__SeekableStreamEncoderSeekStatus;
137
138 /** Maps a FLAC__SeekableStreamEncoderSeekStatus to a C string.
139  *
140  *  Using a FLAC__SeekableStreamEncoderSeekStatus as the index to this array
141  *  will give the string equivalent.  The contents should not be modified.
142  */
143 extern const char * const FLAC__SeekableStreamEncoderSeekStatusString[];
144
145
146 /***********************************************************************
147  *
148  * class FLAC__SeekableStreamEncoder
149  *
150  ***********************************************************************/
151
152 struct FLAC__SeekableStreamEncoderProtected;
153 struct FLAC__SeekableStreamEncoderPrivate;
154 /** The opaque structure definition for the seekable stream encoder type.
155  *  See the \link flac_seekable_stream_encoder seekable stream encoder module \endlink
156  *  for a detailed description.
157  */
158 typedef struct {
159         struct FLAC__SeekableStreamEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */
160         struct FLAC__SeekableStreamEncoderPrivate *private_; /* avoid the C++ keyword 'private' */
161 } FLAC__SeekableStreamEncoder;
162
163 /** Signature for the seek callback.
164  *  See FLAC__seekable_stream_encoder_set_seek_callback() for more info.
165  *
166  * \param  encoder  The encoder instance calling the callback.
167  * \param  absolute_byte_offset  The offset from the beginning of the stream
168  *                               to seek to.
169  * \param  client_data  The callee's client data set through
170  *                      FLAC__seekable_stream_encoder_set_client_data().
171  * \retval FLAC__SeekableStreamEncoderSeekStatus
172  *    The callee's return status.
173  */
174 typedef FLAC__SeekableStreamEncoderSeekStatus (*FLAC__SeekableStreamEncoderSeekCallback)(const FLAC__SeekableStreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data);
175
176 /** Signature for the write callback.
177  *  See FLAC__seekable_stream_encoder_set_write_callback()
178  *  and FLAC__StreamEncoderWriteCallback for more info.
179  *
180  * \param  encoder  The encoder instance calling the callback.
181  * \param  buffer   An array of encoded data of length \a bytes.
182  * \param  bytes    The byte length of \a buffer.
183  * \param  samples  The number of samples encoded by \a buffer.
184  *                  \c 0 has a special meaning; see
185  *                  FLAC__stream_encoder_set_write_callback().
186  * \param  current_frame  The number of current frame being encoded.
187  * \param  client_data  The callee's client data set through
188  *                      FLAC__seekable_stream_encoder_set_client_data().
189  * \retval FLAC__StreamEncoderWriteStatus
190  *    The callee's return status.
191  */
192 typedef FLAC__StreamEncoderWriteStatus (*FLAC__SeekableStreamEncoderWriteCallback)(const FLAC__SeekableStreamEncoder *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data);
193
194
195 /***********************************************************************
196  *
197  * Class constructor/destructor
198  *
199  ***********************************************************************/
200
201 /** Create a new seekable stream encoder instance.  The instance is created with
202  *  default settings; see the individual FLAC__seekable_stream_encoder_set_*()
203  *  functions for each setting's default.
204  *
205  * \retval FLAC__SeekableStreamEncoder*
206  *    \c NULL if there was an error allocating memory, else the new instance.
207  */
208 FLAC__SeekableStreamEncoder *FLAC__seekable_stream_encoder_new();
209
210 /** Free an encoder instance.  Deletes the object pointed to by \a encoder.
211  *
212  * \param encoder  A pointer to an existing encoder.
213  * \assert
214  *    \code encoder != NULL \endcode
215  */
216 void FLAC__seekable_stream_encoder_delete(FLAC__SeekableStreamEncoder *encoder);
217
218 /***********************************************************************
219  *
220  * Public class method prototypes
221  *
222  ***********************************************************************/
223
224 /** This is inherited from FLAC__StreamEncoder; see
225  *  FLAC__stream_encoder_set_verify().
226  *
227  * \default \c true
228  * \param  encoder  An encoder instance to set.
229  * \param  value    See above.
230  * \assert
231  *    \code encoder != NULL \endcode
232  * \retval FLAC__bool
233  *    \c false if the encoder is already initialized, else \c true.
234  */
235 FLAC__bool FLAC__seekable_stream_encoder_set_verify(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
236
237 /** This is inherited from FLAC__StreamEncoder; see
238  *  FLAC__stream_encoder_set_streamable_subset().
239  *
240  * \default \c true
241  * \param  encoder  An encoder instance to set.
242  * \param  value    See above.
243  * \assert
244  *    \code encoder != NULL \endcode
245  * \retval FLAC__bool
246  *    \c false if the encoder is already initialized, else \c true.
247  */
248 FLAC__bool FLAC__seekable_stream_encoder_set_streamable_subset(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
249
250 /** This is inherited from FLAC__StreamEncoder; see
251  *  FLAC__stream_encoder_set_do_mid_side_stereo().
252  *
253  * \default \c false
254  * \param  encoder  An encoder instance to set.
255  * \param  value    See above.
256  * \assert
257  *    \code encoder != NULL \endcode
258  * \retval FLAC__bool
259  *    \c false if the encoder is already initialized, else \c true.
260  */
261 FLAC__bool FLAC__seekable_stream_encoder_set_do_mid_side_stereo(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
262
263 /** This is inherited from FLAC__StreamEncoder; see
264  *  FLAC__stream_encoder_set_loose_mid_side_stereo().
265  *
266  * \default \c false
267  * \param  encoder  An encoder instance to set.
268  * \param  value    See above.
269  * \assert
270  *    \code encoder != NULL \endcode
271  * \retval FLAC__bool
272  *    \c false if the encoder is already initialized, else \c true.
273  */
274 FLAC__bool FLAC__seekable_stream_encoder_set_loose_mid_side_stereo(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
275
276 /** This is inherited from FLAC__StreamEncoder; see
277  *  FLAC__stream_encoder_set_channels().
278  *
279  * \default \c 2
280  * \param  encoder  An encoder instance to set.
281  * \param  value    See above.
282  * \assert
283  *    \code encoder != NULL \endcode
284  * \retval FLAC__bool
285  *    \c false if the encoder is already initialized, else \c true.
286  */
287 FLAC__bool FLAC__seekable_stream_encoder_set_channels(FLAC__SeekableStreamEncoder *encoder, unsigned value);
288
289 /** This is inherited from FLAC__StreamEncoder; see
290  *  FLAC__stream_encoder_set_bits_per_sample().
291  *
292  * \warning
293  * Do not feed the encoder data that is wider than the value you
294  * set here or you will generate an invalid stream.
295  *
296  * \default \c 16
297  * \param  encoder  An encoder instance to set.
298  * \param  value    See above.
299  * \assert
300  *    \code encoder != NULL \endcode
301  * \retval FLAC__bool
302  *    \c false if the encoder is already initialized, else \c true.
303  */
304 FLAC__bool FLAC__seekable_stream_encoder_set_bits_per_sample(FLAC__SeekableStreamEncoder *encoder, unsigned value);
305
306 /** This is inherited from FLAC__StreamEncoder; see
307  *  FLAC__stream_encoder_set_sample_rate().
308  *
309  * \default \c 44100
310  * \param  encoder  An encoder instance to set.
311  * \param  value    See above.
312  * \assert
313  *    \code encoder != NULL \endcode
314  * \retval FLAC__bool
315  *    \c false if the encoder is already initialized, else \c true.
316  */
317 FLAC__bool FLAC__seekable_stream_encoder_set_sample_rate(FLAC__SeekableStreamEncoder *encoder, unsigned value);
318
319 /** This is inherited from FLAC__StreamEncoder; see
320  *  FLAC__stream_encoder_set_blocksize().
321  *
322  * \default \c 1152
323  * \param  encoder  An encoder instance to set.
324  * \param  value    See above.
325  * \assert
326  *    \code encoder != NULL \endcode
327  * \retval FLAC__bool
328  *    \c false if the encoder is already initialized, else \c true.
329  */
330 FLAC__bool FLAC__seekable_stream_encoder_set_blocksize(FLAC__SeekableStreamEncoder *encoder, unsigned value);
331
332 /** This is inherited from FLAC__StreamEncoder; see
333  *  FLAC__stream_encoder_set_max_lpc_order().
334  *
335  * \default \c 0
336  * \param  encoder  An encoder instance to set.
337  * \param  value    See above.
338  * \assert
339  *    \code encoder != NULL \endcode
340  * \retval FLAC__bool
341  *    \c false if the encoder is already initialized, else \c true.
342  */
343 FLAC__bool FLAC__seekable_stream_encoder_set_max_lpc_order(FLAC__SeekableStreamEncoder *encoder, unsigned value);
344
345 /** This is inherited from FLAC__StreamEncoder; see
346  *  FLAC__stream_encoder_set_qlp_coeff_precision().
347  *
348  * \note
349  * In the current implementation, qlp_coeff_precision + bits_per_sample must
350  * be less than 32.
351  *
352  * \default \c 0
353  * \param  encoder  An encoder instance to set.
354  * \param  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__seekable_stream_encoder_set_qlp_coeff_precision(FLAC__SeekableStreamEncoder *encoder, unsigned value);
361
362 /** This is inherited from FLAC__StreamEncoder; see
363  *  FLAC__stream_encoder_set_do_qlp_coeff_prec_search().
364  *
365  * \default \c false
366  * \param  encoder  An encoder instance to set.
367  * \param  value    See above.
368  * \assert
369  *    \code encoder != NULL \endcode
370  * \retval FLAC__bool
371  *    \c false if the encoder is already initialized, else \c true.
372  */
373 FLAC__bool FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
374
375 /** This is inherited from FLAC__StreamEncoder; see
376  *  FLAC__stream_encoder_set_do_escape_coding().
377  *
378  * \default \c false
379  * \param  encoder  An encoder instance to set.
380  * \param  value    See above.
381  * \assert
382  *    \code encoder != NULL \endcode
383  * \retval FLAC__bool
384  *    \c false if the encoder is already initialized, else \c true.
385  */
386 FLAC__bool FLAC__seekable_stream_encoder_set_do_escape_coding(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
387
388 /** This is inherited from FLAC__StreamEncoder; see
389  *  FLAC__stream_encoder_set_do_exhaustive_model_search().
390  *
391  * \default \c false
392  * \param  encoder  An encoder instance to set.
393  * \param  value    See above.
394  * \assert
395  *    \code encoder != NULL \endcode
396  * \retval FLAC__bool
397  *    \c false if the encoder is already initialized, else \c true.
398  */
399 FLAC__bool FLAC__seekable_stream_encoder_set_do_exhaustive_model_search(FLAC__SeekableStreamEncoder *encoder, FLAC__bool value);
400
401 /** This is inherited from FLAC__StreamEncoder; see
402  *  FLAC__stream_encoder_set_min_residual_partition_order().
403  *
404  * \default \c 0
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__seekable_stream_encoder_set_min_residual_partition_order(FLAC__SeekableStreamEncoder *encoder, unsigned value);
413
414 /** This is inherited from FLAC__StreamEncoder; see
415  *  FLAC__stream_encoder_set_max_residual_partition_order().
416  *
417  * \default \c 0
418  * \param  encoder  An encoder instance to set.
419  * \param  value    See above.
420  * \assert
421  *    \code encoder != NULL \endcode
422  * \retval FLAC__bool
423  *    \c false if the encoder is already initialized, else \c true.
424  */
425 FLAC__bool FLAC__seekable_stream_encoder_set_max_residual_partition_order(FLAC__SeekableStreamEncoder *encoder, unsigned value);
426
427 /** This is inherited from FLAC__StreamEncoder; see
428  *  FLAC__stream_encoder_set_rice_parameter_search_dist().
429  *
430  * \default \c 0
431  * \param  encoder  An encoder instance to set.
432  * \param  value    See above.
433  * \assert
434  *    \code encoder != NULL \endcode
435  * \retval FLAC__bool
436  *    \c false if the encoder is already initialized, else \c true.
437  */
438 FLAC__bool FLAC__seekable_stream_encoder_set_rice_parameter_search_dist(FLAC__SeekableStreamEncoder *encoder, unsigned value);
439
440 /** This is inherited from FLAC__StreamEncoder; see
441  *  FLAC__stream_encoder_set_total_samples_estimate().
442  *
443  * \default \c 0
444  * \param  encoder  An encoder instance to set.
445  * \param  value    See above.
446  * \assert
447  *    \code encoder != NULL \endcode
448  * \retval FLAC__bool
449  *    \c false if the encoder is already initialized, else \c true.
450  */
451 FLAC__bool FLAC__seekable_stream_encoder_set_total_samples_estimate(FLAC__SeekableStreamEncoder *encoder, FLAC__uint64 value);
452
453 /** This is inherited from FLAC__StreamEncoder; see
454  *  FLAC__stream_encoder_set_metadata().
455  *
456  * \note
457  * The decoder instance \b will modify the first \c SEEKTABLE block
458  * as it transforms the template to a valid seektable while encoding,
459  * but it is still up to the caller to free all metadata blocks after
460  * encoding.
461  *
462  * \default \c NULL, 0
463  * \param  encoder     An encoder instance to set.
464  * \param  metadata    See above.
465  * \param  num_blocks  See above.
466  * \assert
467  *    \code encoder != NULL \endcode
468  * \retval FLAC__bool
469  *    \c false if the encoder is already initialized, else \c true.
470  */
471 FLAC__bool FLAC__seekable_stream_encoder_set_metadata(FLAC__SeekableStreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
472
473 /** Set the seek callback.
474  *  The supplied function will be called when the encoder needs to seek
475  *  the output stream.  The encoder will pass the absolute byte offset
476  *  to seek to, 0 meaning the beginning of the stream.
477  *
478  * \note
479  * The callback is mandatory and must be set before initialization.
480  *
481  * \default \c NULL
482  * \param  encoder  An encoder instance to set.
483  * \param  value    See above.
484  * \assert
485  *    \code encoder != NULL \endcode
486  *    \code value != NULL \endcode
487  * \retval FLAC__bool
488  *    \c false if the encoder is already initialized, else \c true.
489  */
490 FLAC__bool FLAC__seekable_stream_encoder_set_seek_callback(FLAC__SeekableStreamEncoder *encoder, FLAC__SeekableStreamEncoderSeekCallback value);
491
492 /** Set the write callback.
493  *  This is inherited from FLAC__StreamEncoder; see
494  *  FLAC__stream_encoder_set_write_callback().
495  *
496  * \note
497  * The callback is mandatory and must be set before initialization.
498  *
499  * \default \c NULL
500  * \param  encoder  An encoder instance to set.
501  * \param  value    See above.
502  * \assert
503  *    \code encoder != NULL \endcode
504  *    \code value != NULL \endcode
505  * \retval FLAC__bool
506  *    \c false if the encoder is already initialized, else \c true.
507  */
508 FLAC__bool FLAC__seekable_stream_encoder_set_write_callback(FLAC__SeekableStreamEncoder *encoder, FLAC__SeekableStreamEncoderWriteCallback value);
509
510 /** Set the client data to be passed back to callbacks.
511  *  This value will be supplied to callbacks in their \a client_data
512  *  argument.
513  *
514  * \default \c NULL
515  * \param  encoder  An encoder instance to set.
516  * \param  value    See above.
517  * \assert
518  *    \code encoder != NULL \endcode
519  * \retval FLAC__bool
520  *    \c false if the encoder is already initialized, else \c true.
521  */
522 FLAC__bool FLAC__seekable_stream_encoder_set_client_data(FLAC__SeekableStreamEncoder *encoder, void *value);
523
524 /** Get the current encoder state.
525  *
526  * \param  encoder  An encoder instance to query.
527  * \assert
528  *    \code encoder != NULL \endcode
529  * \retval FLAC__SeekableStreamEncoderState
530  *    The current encoder state.
531  */
532 FLAC__SeekableStreamEncoderState FLAC__seekable_stream_encoder_get_state(const FLAC__SeekableStreamEncoder *encoder);
533
534 /** Get the state of the underlying stream encoder.
535  *  Useful when the seekable stream encoder state is
536  *  \c FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR.
537  *
538  * \param  encoder  An encoder instance to query.
539  * \assert
540  *    \code encoder != NULL \endcode
541  * \retval FLAC__StreamEncoderState
542  *    The stream encoder state.
543  */
544 FLAC__StreamEncoderState FLAC__seekable_stream_encoder_get_stream_encoder_state(const FLAC__SeekableStreamEncoder *encoder);
545
546 /** Get the state of the underlying stream encoder's verify decoder.
547  *  Useful when the seekable stream encoder state is
548  *  \c FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR and the
549  *  stream encoder state is \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.
550  *
551  * \param  encoder  An encoder instance to query.
552  * \assert
553  *    \code encoder != NULL \endcode
554  * \retval FLAC__StreamDecoderState
555  *    The stream encoder state.
556  */
557 FLAC__StreamDecoderState FLAC__seekable_stream_encoder_get_verify_decoder_state(const FLAC__SeekableStreamEncoder *encoder);
558
559 /** Get relevant values about the nature of a verify decoder error.
560  *  Inherited from FLAC__stream_encoder_get_verify_decoder_error_stats().
561  *  Useful when the seekable stream encoder state is
562  *  \c FLAC__SEEKABLE_STREAM_ENCODER_STREAM_ENCODER_ERROR and the
563  *  stream encoder state is
564  *  \c FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR.
565  *
566  * \param  encoder  An encoder instance to query.
567  * \param  absolute_sample  The absolute sample number of the mismatch.
568  * \param  frame_number  The number of the frame in which the mismatch occurred.
569  * \param  channel       The channel in which the mismatch occurred.
570  * \param  sample        The number of the sample (relative to the frame) in
571  *                       which the mismatch occurred.
572  * \param  expected      The expected value for the sample in question.
573  * \param  got           The actual value returned by the decoder.
574  * \assert
575  *    \code encoder != NULL \endcode
576  */
577 void FLAC__seekable_stream_encoder_get_verify_decoder_error_stats(const FLAC__SeekableStreamEncoder *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got);
578
579 /** Get the "verify" flag.
580  *  This is inherited from FLAC__StreamEncoder; see
581  *  FLAC__stream_encoder_get_verify().
582  *
583  * \param  encoder  An encoder instance to query.
584  * \assert
585  *    \code encoder != NULL \endcode
586  * \retval FLAC__bool
587  *    See FLAC__seekable_stream_encoder_set_verify().
588  */
589 FLAC__bool FLAC__seekable_stream_encoder_get_verify(const FLAC__SeekableStreamEncoder *encoder);
590
591 /** Get the "streamable subset" flag.
592  *  This is inherited from FLAC__StreamEncoder; see
593  *  FLAC__stream_encoder_get_streamable_subset().
594  *
595  * \param  encoder  An encoder instance to query.
596  * \assert
597  *    \code encoder != NULL \endcode
598  * \retval FLAC__bool
599  *    See FLAC__seekable_stream_encoder_set_streamable_subset().
600  */
601 FLAC__bool FLAC__seekable_stream_encoder_get_streamable_subset(const FLAC__SeekableStreamEncoder *encoder);
602
603 /** Get the "mid/side stereo coding" flag.
604  *  This is inherited from FLAC__StreamEncoder; see
605  *  FLAC__stream_encoder_get_do_mid_side_stereo().
606  *
607  * \param  encoder  An encoder instance to query.
608  * \assert
609  *    \code encoder != NULL \endcode
610  * \retval FLAC__bool
611  *    See FLAC__seekable_stream_encoder_get_do_mid_side_stereo().
612  */
613 FLAC__bool FLAC__seekable_stream_encoder_get_do_mid_side_stereo(const FLAC__SeekableStreamEncoder *encoder);
614
615 /** Get the "adaptive mid/side switching" flag.
616  *  This is inherited from FLAC__StreamEncoder; see
617  *  FLAC__stream_encoder_get_loose_mid_side_stereo().
618  *
619  * \param  encoder  An encoder instance to query.
620  * \assert
621  *    \code encoder != NULL \endcode
622  * \retval FLAC__bool
623  *    See FLAC__seekable_stream_encoder_set_loose_mid_side_stereo().
624  */
625 FLAC__bool FLAC__seekable_stream_encoder_get_loose_mid_side_stereo(const FLAC__SeekableStreamEncoder *encoder);
626
627 /** Get the number of input channels being processed.
628  *  This is inherited from FLAC__StreamEncoder; see
629  *  FLAC__stream_encoder_get_channels().
630  *
631  * \param  encoder  An encoder instance to query.
632  * \assert
633  *    \code encoder != NULL \endcode
634  * \retval unsigned
635  *    See FLAC__seekable_stream_encoder_set_channels().
636  */
637 unsigned FLAC__seekable_stream_encoder_get_channels(const FLAC__SeekableStreamEncoder *encoder);
638
639 /** Get the input sample resolution setting.
640  *  This is inherited from FLAC__StreamEncoder; see
641  *  FLAC__stream_encoder_get_bits_per_sample().
642  *
643  * \param  encoder  An encoder instance to query.
644  * \assert
645  *    \code encoder != NULL \endcode
646  * \retval unsigned
647  *    See FLAC__seekable_stream_encoder_set_bits_per_sample().
648  */
649 unsigned FLAC__seekable_stream_encoder_get_bits_per_sample(const FLAC__SeekableStreamEncoder *encoder);
650
651 /** Get the input sample rate setting.
652  *  This is inherited from FLAC__StreamEncoder; see
653  *  FLAC__stream_encoder_get_sample_rate().
654  *
655  * \param  encoder  An encoder instance to query.
656  * \assert
657  *    \code encoder != NULL \endcode
658  * \retval unsigned
659  *    See FLAC__seekable_stream_encoder_set_sample_rate().
660  */
661 unsigned FLAC__seekable_stream_encoder_get_sample_rate(const FLAC__SeekableStreamEncoder *encoder);
662
663 /** Get the blocksize setting.
664  *  This is inherited from FLAC__StreamEncoder; see
665  *  FLAC__stream_encoder_get_blocksize().
666  *
667  * \param  encoder  An encoder instance to query.
668  * \assert
669  *    \code encoder != NULL \endcode
670  * \retval unsigned
671  *    See FLAC__seekable_stream_encoder_set_blocksize().
672  */
673 unsigned FLAC__seekable_stream_encoder_get_blocksize(const FLAC__SeekableStreamEncoder *encoder);
674
675 /** Get the maximum LPC order setting.
676  *  This is inherited from FLAC__StreamEncoder; see
677  *  FLAC__stream_encoder_get_max_lpc_order().
678  *
679  * \param  encoder  An encoder instance to query.
680  * \assert
681  *    \code encoder != NULL \endcode
682  * \retval unsigned
683  *    See FLAC__seekable_stream_encoder_set_max_lpc_order().
684  */
685 unsigned FLAC__seekable_stream_encoder_get_max_lpc_order(const FLAC__SeekableStreamEncoder *encoder);
686
687 /** Get the quantized linear predictor coefficient precision setting.
688  *  This is inherited from FLAC__StreamEncoder; see
689  *  FLAC__stream_encoder_get_qlp_coeff_precision().
690  *
691  * \param  encoder  An encoder instance to query.
692  * \assert
693  *    \code encoder != NULL \endcode
694  * \retval unsigned
695  *    See FLAC__seekable_stream_encoder_set_qlp_coeff_precision().
696  */
697 unsigned FLAC__seekable_stream_encoder_get_qlp_coeff_precision(const FLAC__SeekableStreamEncoder *encoder);
698
699 /** Get the qlp coefficient precision search flag.
700  *  This is inherited from FLAC__StreamEncoder; see
701  *  FLAC__stream_encoder_get_do_qlp_coeff_prec_search().
702  *
703  * \param  encoder  An encoder instance to query.
704  * \assert
705  *    \code encoder != NULL \endcode
706  * \retval FLAC__bool
707  *    See FLAC__seekable_stream_encoder_set_do_qlp_coeff_prec_search().
708  */
709 FLAC__bool FLAC__seekable_stream_encoder_get_do_qlp_coeff_prec_search(const FLAC__SeekableStreamEncoder *encoder);
710
711 /** Get the "escape coding" flag.
712  *  This is inherited from FLAC__StreamEncoder; see
713  *  FLAC__stream_encoder_get_do_escape_coding().
714  *
715  * \param  encoder  An encoder instance to query.
716  * \assert
717  *    \code encoder != NULL \endcode
718  * \retval FLAC__bool
719  *    See FLAC__seekable_stream_encoder_set_do_escape_coding().
720  */
721 FLAC__bool FLAC__seekable_stream_encoder_get_do_escape_coding(const FLAC__SeekableStreamEncoder *encoder);
722
723 /** Get the exhaustive model search flag.
724  *  This is inherited from FLAC__StreamEncoder; see
725  *  FLAC__stream_encoder_get_do_exhaustive_model_search().
726  *
727  * \param  encoder  An encoder instance to query.
728  * \assert
729  *    \code encoder != NULL \endcode
730  * \retval FLAC__bool
731  *    See FLAC__seekable_stream_encoder_set_do_exhaustive_model_search().
732  */
733 FLAC__bool FLAC__seekable_stream_encoder_get_do_exhaustive_model_search(const FLAC__SeekableStreamEncoder *encoder);
734
735 /** Get the minimum residual partition order setting.
736  *  This is inherited from FLAC__StreamEncoder; see
737  *  FLAC__stream_encoder_get_min_residual_partition_order().
738  *
739  * \param  encoder  An encoder instance to query.
740  * \assert
741  *    \code encoder != NULL \endcode
742  * \retval unsigned
743  *    See FLAC__seekable_stream_encoder_set_min_residual_partition_order().
744  */
745 unsigned FLAC__seekable_stream_encoder_get_min_residual_partition_order(const FLAC__SeekableStreamEncoder *encoder);
746
747 /** Get maximum residual partition order setting.
748  *  This is inherited from FLAC__StreamEncoder; see
749  *  FLAC__stream_encoder_get_max_residual_partition_order().
750  *
751  * \param  encoder  An encoder instance to query.
752  * \assert
753  *    \code encoder != NULL \endcode
754  * \retval unsigned
755  *    See FLAC__seekable_stream_encoder_set_max_residual_partition_order().
756  */
757 unsigned FLAC__seekable_stream_encoder_get_max_residual_partition_order(const FLAC__SeekableStreamEncoder *encoder);
758
759 /** Get the Rice parameter search distance setting.
760  *  This is inherited from FLAC__StreamEncoder; see
761  *  FLAC__stream_encoder_get_rice_parameter_search_dist().
762  *
763  * \param  encoder  An encoder instance to query.
764  * \assert
765  *    \code encoder != NULL \endcode
766  * \retval unsigned
767  *    See FLAC__seekable_stream_encoder_set_rice_parameter_search_dist().
768  */
769 unsigned FLAC__seekable_stream_encoder_get_rice_parameter_search_dist(const FLAC__SeekableStreamEncoder *encoder);
770
771 /** Get the previously set estimate of the total samples to be encoded.
772  *  This is inherited from FLAC__StreamEncoder; see
773  *  FLAC__stream_encoder_get_total_samples_estimate().
774  *
775  * \param  encoder  An encoder instance to query.
776  * \assert
777  *    \code encoder != NULL \endcode
778  * \retval FLAC__uint64
779  *    See FLAC__seekable_stream_encoder_set_total_samples_estimate().
780  */
781 FLAC__uint64 FLAC__seekable_stream_encoder_get_total_samples_estimate(const FLAC__SeekableStreamEncoder *encoder);
782
783 /** Initialize the encoder instance.
784  *  Should be called after FLAC__seekable_stream_encoder_new() and
785  *  FLAC__seekable_stream_encoder_set_*() but before FLAC__seekable_stream_encoder_process()
786  *  or FLAC__seekable_stream_encoder_process_interleaved().  Will set and return
787  *  the encoder state, which will be FLAC__SEEKABLE_STREAM_ENCODER_OK if
788  *  initialization succeeded.
789  *
790  *  The call to FLAC__seekable_stream_encoder_init() currently will also immediately
791  *  call the write callback with the \c fLaC signature and all the encoded
792  *  metadata.
793  *
794  * \param  encoder  An uninitialized encoder instance.
795  * \assert
796  *    \code encoder != NULL \endcode
797  * \retval FLAC__SeekableStreamEncoderState
798  *    \c FLAC__SEEKABLE_STREAM_ENCODER_OK if initialization was successful; see
799  *    FLAC__SeekableStreamEncoderState for the meanings of other return values.
800  */
801 FLAC__SeekableStreamEncoderState FLAC__seekable_stream_encoder_init(FLAC__SeekableStreamEncoder *encoder);
802
803 /** Finish the encoding process.
804  *  Flushes the encoding buffer, releases resources, resets the encoder
805  *  settings to their defaults, and returns the encoder state to
806  *  FLAC__SEEKABLE_STREAM_ENCODER_UNINITIALIZED.
807  *
808  *  In the event of a prematurely-terminated encode, it is not strictly
809  *  necessary to call this immediately before FLAC__seekable_stream_encoder_delete()
810  *  but it is good practice to match every FLAC__seekable_stream_encoder_init()
811  *  with a FLAC__seekable_stream_encoder_finish().
812  *
813  * \param  encoder  An uninitialized encoder instance.
814  * \assert
815  *    \code encoder != NULL \endcode
816  */
817 void FLAC__seekable_stream_encoder_finish(FLAC__SeekableStreamEncoder *encoder);
818
819 /** Submit data for encoding.
820  *  This is inherited from FLAC__StreamEncoder; see
821  *  FLAC__stream_encoder_process().
822  *
823  * \param  encoder  An initialized encoder instance in the OK state.
824  * \param  buffer   An array of pointers to each channel's signal.
825  * \param  samples  The number of samples in one channel.
826  * \assert
827  *    \code encoder != NULL \endcode
828  *    \code FLAC__seekable_stream_encoder_get_state(encoder) == FLAC__SEEKABLE_STREAM_ENCODER_OK \endcode
829  * \retval FLAC__bool
830  *    \c true if successful, else \c false; in this case, check the
831  *    encoder state with FLAC__seekable_stream_encoder_get_state() to see what
832  *    went wrong.
833  */
834 FLAC__bool FLAC__seekable_stream_encoder_process(FLAC__SeekableStreamEncoder *encoder, const FLAC__int32 * const buffer[], unsigned samples);
835
836 /** Submit data for encoding.
837  *  This is inherited from FLAC__StreamEncoder; see
838  *  FLAC__stream_encoder_process_interleaved().
839  *
840  * \param  encoder  An initialized encoder instance in the OK state.
841  * \param  buffer   An array of channel-interleaved data (see above).
842  * \param  samples  The number of samples in one channel, the same as for
843  *                  FLAC__seekable_stream_encoder_process().  For example, if
844  *                  encoding two channels, \c 1000 \a samples corresponds
845  *                  to a \a buffer of 2000 values.
846  * \assert
847  *    \code encoder != NULL \endcode
848  *    \code FLAC__seekable_stream_encoder_get_state(encoder) == FLAC__SEEKABLE_STREAM_ENCODER_OK \endcode
849  * \retval FLAC__bool
850  *    \c true if successful, else \c false; in this case, check the
851  *    encoder state with FLAC__seekable_stream_encoder_get_state() to see what
852  *    went wrong.
853  */
854 FLAC__bool FLAC__seekable_stream_encoder_process_interleaved(FLAC__SeekableStreamEncoder *encoder, const FLAC__int32 buffer[], unsigned samples);
855
856 /* \} */
857
858 #ifdef __cplusplus
859 }
860 #endif
861
862 #endif