more doxygen docs
[flac.git] / include / FLAC / stream_decoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA  02111-1307, USA.
18  */
19
20 #ifndef FLAC__STREAM_DECODER_H
21 #define FLAC__STREAM_DECODER_H
22
23 #include "format.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /** \file include/FLAC/stream_decoder.h
31  *
32  *  \brief
33  *  This module contains the functions which implement the stream
34  *  decoder.
35  *
36  *  See the detailed documentation in the
37  *  \link flac_stream_decoder stream decoder \endlink module.
38  */
39
40 /** \defgroup flac_decoder FLAC/*_decoder.h: decoder interfaces
41  *  \ingroup flac
42  *
43  *  \brief
44  *  This module describes the three decoder layers provided by libFLAC.
45  *
46  * For decoding FLAC streams, libFLAC provides three layers of access.  The
47  * lowest layer is non-seekable stream-level decoding, the next is seekable
48  * stream-level decoding, and the highest layer is file-level decoding.  The
49  * interfaces are described in the \link flac_stream_decoder stream decoder
50  * \endlink, \link flac_seekable_stream_decoder seekable stream decoder
51  * \endlink, and \link flac_file_decoder file decoder \endlink modules
52  * respectively.  Typically you will choose the highest layer that your input
53  * source will support.
54  *
55  * The stream decoder relies on callbacks for all input and output and has no
56  * provisions for seeking.  The seekable stream decoder wraps the stream
57  * decoder and exposes functions for seeking.  However, you must provide
58  * extra callbacks for seek-related operations on your stream, like seek and
59  * tell.  The file decoder wraps the seekable stream decoder and supplies
60  * most of the callbacks internally, simplifying the processing of standard
61  * files.
62  */
63
64 /** \defgroup flac_stream_decoder FLAC/stream_decoder.h: stream decoder interface
65  *  \ingroup flac_decoder
66  *
67  *  \brief
68  *  This module contains the functions which implement the stream
69  *  decoder.
70  *
71  * The basic usage of this decoder is as follows:
72  * - The program creates an instance of a decoder using
73  *   FLAC__stream_decoder_new().
74  * - The program overrides the default settings and sets callbacks for
75  *   reading, writing, error reporting, and metadata reporting using
76  *   FLAC__stream_decoder_set_*() functions.
77  * - The program initializes the instance to validate the settings and
78  *   prepare for decoding using FLAC__stream_decoder_init().
79  * - The program calls the FLAC__stream_decoder_process_*() functions
80  *   to decode data, which subsequently calls the callbacks.
81  * - The program finishes the decoding with FLAC__stream_decoder_finish(),
82  *   which flushes the input and output and resets the decoder to the
83  *   uninitialized state.
84  * - The instance may be used again or deleted with
85  *   FLAC__stream_decoder_delete().
86  *
87  * In more detail, the program will create a new instance by calling
88  * FLAC__stream_decoder_new(), then call FLAC__stream_decoder_set_*()
89  * functions to set the callbacks and client data, and call
90  * FLAC__stream_decoder_init().  The required callbacks are:
91  *
92  * - Read callback - This function will be called when the decoder needs
93  *   more input data.  The address of the buffer to be filled is supplied,
94  *   along with the number of bytes the buffer can hold.  The callback may
95  *   choose to supply less data and modify the byte count but must be careful
96  *   not to overflow the buffer.  The callback then returns a status code
97  *   chosen from FLAC__StreamDecoderReadStatus.
98  * - Write callback - This function will be called when the decoder has
99  *   decoded a single frame of data.  The decoder will pass the frame
100  *   metadata as well as an array of pointers (one for each channel)
101  *   pointing to the decoded audio.
102  * - Metadata callback - This function will be called when the decoder has
103  *   decoded a metadata block.  There will always be one STREAMINFO block
104  *   per stream, followed by zero or more other metadata blocks.  These will
105  *   be supplied by the decoder in the same order as they appear in the
106  *   stream and always before the first audio frame (i.e. write callback).
107  *   The metadata block that is passed in must not be modified, and it
108  *   doesn't live beyond the callback, so you should make a copy of it with
109  *   FLAC__metadata_object_clone() if you will need it elsewhere.  Since
110  *   metadata blocks can potentially be large, by default the decoder only
111  *   calls the metadata callback for the STREAMINFO block; you can instruct
112  *   the decoder to pass or filter other blocks with
113  *   FLAC__stream_decoder_set_metadata_*() calls.
114  * - Error callback - This function will be called whenever an error occurs
115  *   during decoding.
116  *
117  * Once the decoder is initialized, your program will call one of several
118  * functions to start the decoding process:
119  *
120  * - FLAC__stream_decoder_process_whole_stream() - Tells the decoder to
121  *   start and continue processing the stream until the read callback
122  *   returns FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM or
123  *   FLAC__STREAM_DECODER_READ_STATUS_ABORT.
124  * - FLAC__stream_decoder_process_metadata() - Tells the decoder to start
125  *   processing the stream and stop upon reaching the first audio frame.
126  * - FLAC__stream_decoder_process_one_frame() - Tells the decoder to
127  *   process one audio frame and return.  The decoder must have processed
128  *   all metadata first before calling this function.
129  * - FLAC__stream_decoder_process_remaining_frames() - Tells the decoder to
130  *   process all remaining frames.  The decoder must have processed all
131  *   metadata first but may also have processed frames with
132  *   FLAC__stream_decoder_process_one_frame().
133  *
134  * When the decoder has finished decoding (normally or through an abort),
135  * the instance is finished by calling FLAC__stream_decoder_finish(), which
136  * ensures the decoder is in the correct state and frees memory.  Then the
137  * instance may be deleted with FLAC__stream_decoder_delete() or initialized
138  * again to decode another stream.
139  *
140  * Note that the stream decoder has no real concept of stream position, it
141  * just converts data.  To seek within a stream the callbacks have only to
142  * flush the decoder using FLAC__stream_decoder_flush() and start feeding
143  * data from the new position through the read callback.  The seekable
144  * stream decoder does just this.
145  *
146  * The FLAC__stream_decoder_set_metadata_*() functions deserve special
147  * attention.  By default, the decoder only calls the metadata_callback for
148  * the STREAMINFO block.  These functions allow you to tell the decoder
149  * explicitly which blocks to parse and return via the metadata_callback
150  * and/or which to skip.  Use a FLAC__stream_decoder_respond_all(),
151  * FLAC__stream_decoder_ignore() ... or FLAC__stream_decoder_ignore_all(),
152  * FLAC__stream_decoder_respond() ... sequence to exactly specify which
153  * blocks to return.  Remember that some metadata blocks can be big so
154  * filtering out the ones you don't use can reduce the memory requirements
155  * of the decoder.  Also note the special forms
156  * FLAC__stream_decoder_respond_application(id) and 
157  * FLAC__stream_decoder_ignore_application(id) for filtering APPLICATION
158  * blocks based on the application ID.
159  *
160  * STREAMINFO and SEEKTABLE blocks are always parsed and used internally, but
161  * they still can legally be filtered from the metadata_callback.
162  *
163  * \note
164  * The "set" functions may only be called when the decoder is in the
165  * state FLAC__STREAM_DECODER_UNINITIALIZED, i.e. after
166  * FLAC__stream_decoder_new() or FLAC__stream_decoder_finish(), but
167  * before FLAC__stream_decoder_init().  If this is the case they will
168  * return \c true, otherwise \c false.
169  *
170  * \note
171  * FLAC__stream_decoder_finish() resets all settings to the constructor
172  * defaults, including the callbacks.
173  *
174  * \{
175  */
176
177
178 /** State values for a FLAC__StreamDecoder
179  *
180  *  The decoder's state can be obtained by calling FLAC__stream_decoder_get_state().
181  */
182 typedef enum {
183
184         FLAC__STREAM_DECODER_SEARCH_FOR_METADATA = 0,
185         /**< The decoder is ready to search for metadata. */
186
187         FLAC__STREAM_DECODER_READ_METADATA,
188         /**< The decoder is ready to or is in the process of reading metadata. */
189
190         FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC,
191         /**< The decoder is ready to or is in the process of searching for the frame sync code. */
192
193         FLAC__STREAM_DECODER_READ_FRAME,
194         /**< The decoder is ready to or is in the process of reading a frame. */
195
196         FLAC__STREAM_DECODER_END_OF_STREAM,
197         /**< The decoder has reached the end of the stream. */
198
199         FLAC__STREAM_DECODER_ABORTED,
200         /**< The decoder was aborted by the read callback. */
201
202         FLAC__STREAM_DECODER_UNPARSEABLE_STREAM,
203         /**< The decoder encountered reserved fields in use in the stream. */
204
205         FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
206         /**< An error occurred allocating memory. */
207
208         FLAC__STREAM_DECODER_ALREADY_INITIALIZED,
209         /**< FLAC__stream_decoder_init() was called when the decoder was
210          * already initialized, usually because
211          * FLAC__stream_decoder_finish() was not called.
212          */
213
214         FLAC__STREAM_DECODER_INVALID_CALLBACK,
215         /**< FLAC__stream_decoder_init() was called without all callbacks being set. */
216
217         FLAC__STREAM_DECODER_UNINITIALIZED
218         /**< The decoder is in the uninitialized state. */
219
220 } FLAC__StreamDecoderState;
221
222 /** Maps a FLAC__StreamDecoderState to a C string.
223  *
224  *  Using a FLAC__StreamDecoderState as the index to this array
225  *  will give the string equivalent.  The contents should not be modified.
226  */
227 extern const char * const FLAC__StreamDecoderStateString[];
228
229
230 /** Return values for the FLAC__StreamDecoder read callback.
231  */
232 typedef enum {
233
234         FLAC__STREAM_DECODER_READ_STATUS_CONTINUE,
235         /**< The read was OK and decoding can continue. */
236
237         FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM,
238         /**< The read was attempted at the end of the stream. */
239
240         FLAC__STREAM_DECODER_READ_STATUS_ABORT
241         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
242
243 } FLAC__StreamDecoderReadStatus;
244
245 /** Maps a FLAC__StreamDecoderReadStatus to a C string.
246  *
247  *  Using a FLAC__StreamDecoderReadStatus as the index to this array
248  *  will give the string equivalent.  The contents should not be modified.
249  */
250 extern const char * const FLAC__StreamDecoderReadStatusString[];
251
252
253 /** Return values for the FLAC__StreamDecoder write callback.
254  */
255 typedef enum {
256
257         FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE,
258         /**< The write was OK and decoding can continue. */
259
260         FLAC__STREAM_DECODER_WRITE_STATUS_ABORT
261         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
262
263 } FLAC__StreamDecoderWriteStatus;
264
265 /** Maps a FLAC__StreamDecoderWriteStatus to a C string.
266  *
267  *  Using a FLAC__StreamDecoderWriteStatus as the index to this array
268  *  will give the string equivalent.  The contents should not be modified.
269  */
270 extern const char * const FLAC__StreamDecoderWriteStatusString[];
271
272
273 /** Possible values passed in to the FLAC__StreamDecoder error callback.
274  */
275 typedef enum {
276
277         FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC,
278         /**< An error in the stream caused the decoder to lose synchronization. */
279
280         FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER,
281         /**< The decoder encountered a corrupted frame header. */
282
283         FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH
284         /**< The frame's data did not match the CRC in the footer. */
285
286 } FLAC__StreamDecoderErrorStatus;
287
288 /** Maps a FLAC__StreamDecoderErrorStatus to a C string.
289  *
290  *  Using a FLAC__StreamDecoderErrorStatus as the index to this array
291  *  will give the string equivalent.  The contents should not be modified.
292  */
293 extern const char * const FLAC__StreamDecoderErrorStatusString[];
294
295
296 /***********************************************************************
297  *
298  * class FLAC__StreamDecoder
299  *
300  ***********************************************************************/
301
302 struct FLAC__StreamDecoderProtected;
303 struct FLAC__StreamDecoderPrivate;
304 /** The opaque structure definition for the stream decoder type.
305  *  See the \link flac_stream_decoder stream decoder module \endlink
306  *  for a detailed description.
307  */
308 typedef struct {
309         struct FLAC__StreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
310         struct FLAC__StreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
311 } FLAC__StreamDecoder;
312
313
314 /***********************************************************************
315  *
316  * Class constructor/destructor
317  *
318  ***********************************************************************/
319
320 /** Create a new stream decoder instance.  The instance is created with
321  *  default settings; see the individual FLAC__stream_decoder_set_*()
322  *  functions for each setting's default.
323  *
324  * \retval FLAC__StreamDecoder*
325  *    \c NULL if there was an error allocating memory, else the new instance.
326  */
327 FLAC__StreamDecoder *FLAC__stream_decoder_new();
328
329 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
330  *
331  * \param decoder  A pointer to an existing decoder.
332  * \assert
333  *    \code decoder != NULL \endcode
334  */
335 void FLAC__stream_decoder_delete(FLAC__StreamDecoder *decoder);
336
337
338 /***********************************************************************
339  *
340  * Public class method prototypes
341  *
342  ***********************************************************************/
343
344 /** Set the read callback.
345  *  The supplied function will be called when the decoder needs more input
346  *  data.  The address of the buffer to be filled is supplied, along with
347  *  the number of bytes the buffer can hold.  The callback may choose to
348  *  supply less data and modify the byte count but must be careful not to
349  *  overflow the buffer.  The callback then returns a status code chosen
350  *  from FLAC__StreamDecoderReadStatus.
351  *
352  * \note
353  * The callback is mandatory and must be set before initialization.
354  *
355  * \default \c NULL
356  * \param  decoder  An decoder instance to set.
357  * \param  value    See above.
358  * \assert
359  *    \code decoder != NULL \endcode
360  *    \code value != NULL \endcode
361  * \retval FLAC__bool
362  *    \c false if the decoder is already initialized, else \c true.
363  */
364 FLAC__bool FLAC__stream_decoder_set_read_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderReadStatus (*value)(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data));
365
366 /** Set the write callback.
367  *  The supplied function will be called when the decoder has decoded a
368  *  single frame of data.  The decoder will pass the frame metadata as
369  *  well as an array of pointers (one for each channel) pointing to the
370  *  decoded audio.
371  *
372  * \note
373  * The callback is mandatory and must be set before initialization.
374  *
375  * \default \c NULL
376  * \param  decoder  An decoder instance to set.
377  * \param  value    See above.
378  * \assert
379  *    \code decoder != NULL \endcode
380  *    \code value != NULL \endcode
381  * \retval FLAC__bool
382  *    \c false if the decoder is already initialized, else \c true.
383  */
384 FLAC__bool FLAC__stream_decoder_set_write_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderWriteStatus (*value)(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data));
385
386 /** Set the metadata callback.
387  *  The supplied function will be called when the decoder has decoded a
388  *  metadata block.  There will always be one STREAMINFO block per stream,
389  *  followed by zero or more other metadata blocks.  These will be supplied
390  *  by the decoder in the same order as they appear in the stream and always
391  *  before the first audio frame (i.e. write callback).  The metadata block
392  *  that is passed in must not be modified, and it doesn't live beyond the
393  *  callback, so you should make a copy of it with
394  *  FLAC__metadata_object_clone() if you will need it elsewhere.  Since
395  *  metadata blocks can potentially be large, by default the decoder only
396  *  calls the metadata callback for the STREAMINFO block; you can instruct
397  *  the decoder to pass or filter other blocks with
398  *  FLAC__stream_decoder_set_metadata_*() calls.
399  *
400  * \note
401  * The callback is mandatory and must be set before initialization.
402  *
403  * \default \c NULL
404  * \param  decoder  An decoder instance to set.
405  * \param  value    See above.
406  * \assert
407  *    \code decoder != NULL \endcode
408  *    \code value != NULL \endcode
409  * \retval FLAC__bool
410  *    \c false if the decoder is already initialized, else \c true.
411  */
412 FLAC__bool FLAC__stream_decoder_set_metadata_callback(FLAC__StreamDecoder *decoder, void (*value)(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data));
413
414 /** Set the error callback.
415  *  The supplied function will be called whenever an error occurs during
416  *  decoding.
417  *
418  * \note
419  * The callback is mandatory and must be set before initialization.
420  *
421  * \default \c NULL
422  * \param  decoder  An decoder instance to set.
423  * \param  value    See above.
424  * \assert
425  *    \code decoder != NULL \endcode
426  *    \code value != NULL \endcode
427  * \retval FLAC__bool
428  *    \c false if the decoder is already initialized, else \c true.
429  */
430 FLAC__bool FLAC__stream_decoder_set_error_callback(FLAC__StreamDecoder *decoder, void (*value)(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
431
432 /** Set the client data to be passed back to callbacks.
433  *  This value will be supplied to callbacks in their \a client_data
434  *  argument.
435  *
436  * \default \c NULL
437  * \param  decoder  An decoder instance to set.
438  * \param  value    See above.
439  * \assert
440  *    \code decoder != NULL \endcode
441  * \retval FLAC__bool
442  *    \c false if the decoder is already initialized, else \c true.
443  */
444 FLAC__bool FLAC__stream_decoder_set_client_data(FLAC__StreamDecoder *decoder, void *value);
445
446 /** Direct the decoder to pass on all metadata blocks of type \a type.
447  *
448  * \default By default, only the \c STREAMINFO block is returned via the
449  *          metadata callback.
450  * \param  decoder  A decoder instance to set.
451  * \param  type     See above.
452  * \assert
453  *    \code decoder != NULL \endcode
454  *    \a type is valid
455  * \retval FLAC__bool
456  *    \c false if the decoder is already initialized, else \c true.
457  */
458 FLAC__bool FLAC__stream_decoder_set_metadata_respond(FLAC__StreamDecoder *decoder, FLAC__MetadataType type);
459
460 /** Direct the decoder to pass on all APPLICATION metadata blocks of the
461  *  given \a id.
462  *
463  * \default By default, only the \c STREAMINFO block is returned via the
464  *          metadata callback.
465  * \param  decoder  A decoder instance to set.
466  * \param  id       See above.
467  * \assert
468  *    \code decoder != NULL \endcode
469  *    \code id != NULL \endcode
470  * \retval FLAC__bool
471  *    \c false if the decoder is already initialized, else \c true.
472  */
473 FLAC__bool FLAC__stream_decoder_set_metadata_respond_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4]);
474
475 /** Direct the decoder to pass on all metadata blocks of any type.
476  *
477  * \default By default, only the \c STREAMINFO block is returned via the
478  *          metadata callback.
479  * \param  decoder  A decoder instance to set.
480  * \assert
481  *    \code decoder != NULL \endcode
482  * \retval FLAC__bool
483  *    \c false if the decoder is already initialized, else \c true.
484  */
485 FLAC__bool FLAC__stream_decoder_set_metadata_respond_all(FLAC__StreamDecoder *decoder);
486
487 /** Direct the decoder to filter out all metadata blocks of type \a type.
488  *
489  * \default By default, only the \c STREAMINFO block is returned via the
490  *          metadata callback.
491  * \param  decoder  A decoder instance to set.
492  * \param  type     See above.
493  * \assert
494  *    \code decoder != NULL \endcode
495  *    \a type is valid
496  * \retval FLAC__bool
497  *    \c false if the decoder is already initialized, else \c true.
498  */
499 FLAC__bool FLAC__stream_decoder_set_metadata_ignore(FLAC__StreamDecoder *decoder, FLAC__MetadataType type);
500
501 /** Direct the decoder to filter out all APPLICATION metadata blocks of
502  *  the given \a id.
503  *
504  * \default By default, only the \c STREAMINFO block is returned via the
505  *          metadata callback.
506  * \param  decoder  A decoder instance to set.
507  * \param  id       See above.
508  * \assert
509  *    \code decoder != NULL \endcode
510  *    \code id != NULL \endcode
511  * \retval FLAC__bool
512  *    \c false if the decoder is already initialized, else \c true.
513  */
514 FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4]);
515
516 /** Direct the decoder to filter out all metadata blocks of any type.
517  *
518  * \default By default, only the \c STREAMINFO block is returned via the
519  *          metadata callback.
520  * \param  decoder  A decoder instance to set.
521  * \assert
522  *    \code decoder != NULL \endcode
523  * \retval FLAC__bool
524  *    \c false if the decoder is already initialized, else \c true.
525  */
526 FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all(FLAC__StreamDecoder *decoder);
527
528 /** Get the current decoder state.
529  *
530  * \param  decoder  A decoder instance to query.
531  * \assert
532  *    \code decoder != NULL \endcode
533  * \retval FLAC__StreamDecoderState
534  *    The current decoder state.
535  */
536 FLAC__StreamDecoderState FLAC__stream_decoder_get_state(const FLAC__StreamDecoder *decoder);
537
538 /** Get the current number of channels in the stream being decoded.
539  *  Will only be valid after decoding has started and will contain the
540  *  value from the most recently decoded frame header.
541  *
542  * \param  decoder  A decoder instance to query.
543  * \assert
544  *    \code decoder != NULL \endcode
545  * \retval unsigned
546  *    See above.
547  */
548 unsigned FLAC__stream_decoder_get_channels(const FLAC__StreamDecoder *decoder);
549
550 /** Get the current channel assignment in the stream being decoded.
551  *  Will only be valid after decoding has started and will contain the
552  *  value from the most recently decoded frame header.
553  *
554  * \param  decoder  A decoder instance to query.
555  * \assert
556  *    \code decoder != NULL \endcode
557  * \retval FLAC__ChannelAssignment
558  *    See above.
559  */
560 FLAC__ChannelAssignment FLAC__stream_decoder_get_channel_assignment(const FLAC__StreamDecoder *decoder);
561
562 /** Get the current sample resolution in the stream being decoded.
563  *  Will only be valid after decoding has started and will contain the
564  *  value from the most recently decoded frame header.
565  *
566  * \param  decoder  A decoder instance to query.
567  * \assert
568  *    \code decoder != NULL \endcode
569  * \retval unsigned
570  *    See above.
571  */
572 unsigned FLAC__stream_decoder_get_bits_per_sample(const FLAC__StreamDecoder *decoder);
573
574 /** Get the current sample rate in Hz of the stream being decoded.
575  *  Will only be valid after decoding has started and will contain the
576  *  value from the most recently decoded frame header.
577  *
578  * \param  decoder  A decoder instance to query.
579  * \assert
580  *    \code decoder != NULL \endcode
581  * \retval unsigned
582  *    See above.
583  */
584 unsigned FLAC__stream_decoder_get_sample_rate(const FLAC__StreamDecoder *decoder);
585
586 /** Get the current blocksize of the stream being decoded.
587  *  Will only be valid after decoding has started and will contain the
588  *  value from the most recently decoded frame header.
589  *
590  * \param  decoder  A decoder instance to query.
591  * \assert
592  *    \code decoder != NULL \endcode
593  * \retval unsigned
594  *    See above.
595  */
596 unsigned FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *decoder);
597
598 /** Initialize the decoder instance.
599  *  Should be called after FLAC__stream_decoder_new() and
600  *  FLAC__stream_decoder_set_*() but before any of the
601  *  FLAC__stream_decoder_process_*() functions.  Will set and return the
602  *  decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA
603  *  if initialization succeeded.
604  *
605  * \param  decoder  An uninitialized decoder instance.
606  * \assert
607  *    \code decoder != NULL \endcode
608  * \retval FLAC__StreamDecoderState
609  *    \c FLAC__STREAM_DECODER_SEARCH_FOR_MEATADATA if initialization was
610  *    successful; see FLAC__StreamDecoderState for the meanings of other
611  *    return values.
612  */
613 FLAC__StreamDecoderState FLAC__stream_decoder_init(FLAC__StreamDecoder *decoder);
614
615 /** Finish the decoding process.
616  *  Flushes the decoding buffer, releases resources, resets the decoder
617  *  settings to their defaults, and returns the decoder state to
618  *  FLAC__STREAM_DECODER_UNINITIALIZED.
619  *
620  *  In the event of a prematurely-terminated decode, it is not strictly
621  *  necessary to call this immediately before FLAC__stream_decoder_delete()
622  *  but it is good practice to match every FLAC__stream_decoder_init()
623  *  with a FLAC__stream_decoder_finish().
624  *
625  * \param  decoder  An uninitialized decoder instance.
626  * \assert
627  *    \code decoder != NULL \endcode
628  */
629 void FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder);
630
631 /** Flush the stream input.
632  *  The decoder's input buffer will be cleared and the state set to
633  *  \c FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC.
634  *
635  * \param  decoder  A decoder instance.
636  * \assert
637  *    \code decoder != NULL \endcode
638  * \retval FLAC__bool
639  *    \c true if successful, else \c false if a memory allocation
640  *    error occurs.
641  */
642 FLAC__bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder);
643
644 /** Reset the decoding process.
645  *  The decoder's input buffer will be cleared and the state set to
646  *  \c FLAC__STREAM_DECODER_SEARCH_FOR_METADATA.  This is similar to
647  *  FLAC__stream_decoder_finish() except that the settings are
648  *  preserved; there is no need to call FLAC__stream_decoder_init()
649  *  before decoding again.
650  *
651  * \param  decoder  A decoder instance.
652  * \assert
653  *    \code decoder != NULL \endcode
654  * \retval FLAC__bool
655  *    \c true if successful, else \c false if a memory allocation
656  *    error occurs.
657  */
658 FLAC__bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder);
659
660 /** Decode the entire stream.
661  *  This version instructs the decoder to start and continue decoding
662  *  the entire stream until the callbacks return a fatal error or the
663  *  read callback returns \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM.
664  *
665  *  As the decoder needs more input it will call the read callback.
666  *  As each metadata block and frame is decoded, the metadata or write
667  *  callback will be called with the decoded metadata or frame.
668  * 
669  * \param  decoder  An initialized decoder instance in the state
670  *                  \c FLAC__STREAM_DECODER_SEARCH_FOR_METADATA.
671  * \assert
672  *    \code decoder != NULL \endcode
673  *    \code FLAC__stream_decoder_get_state(decoder) == FLAC__STREAM_DECODER_SEARCH_FOR_METADATA \endcode
674  * \retval FLAC__bool
675  *    \c false if any read or write error occurred (except
676  *    \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
677  *    in any case, check the decoder state with
678  *    FLAC__stream_decoder_get_state() to see what went wrong or to
679  *    check for lost synchronization (a sign of stream corruption).
680  */
681 FLAC__bool FLAC__stream_decoder_process_whole_stream(FLAC__StreamDecoder *decoder);
682
683 /** Decode just the metadata.
684  *  This version instructs the decoder to start decoding and stop after
685  *  all the metadata has been read, or until the callbacks return a fatal
686  *  error or the read callback returns
687  *  \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM.
688  *
689  *  As the decoder needs more input it will call the read callback.
690  *  As each metadata block is decoded, the metadata callback will be called
691  *  with the decoded metadata.
692  * 
693  * \param  decoder  An initialized decoder instance in the state
694  *                  \c FLAC__STREAM_DECODER_SEARCH_FOR_METADATA.
695  * \assert
696  *    \code decoder != NULL \endcode
697  *    \code FLAC__stream_decoder_get_state(decoder) == FLAC__STREAM_DECODER_SEARCH_FOR_METADATA \endcode
698  * \retval FLAC__bool
699  *    \c false if any read or write error occurred (except
700  *    \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
701  *    in any case, check the decoder state with
702  *    FLAC__stream_decoder_get_state() to see what went wrong or to
703  *    check for lost synchronization (a sign of stream corruption).
704  */
705 FLAC__bool FLAC__stream_decoder_process_metadata(FLAC__StreamDecoder *decoder);
706
707 /** Decode one frame.
708  *  This version instructs the decoder to decode a single frame and stop,
709  *  or until the callbacks return a fatal error or the read callback returns
710  *  \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM.
711  *
712  *  As the decoder needs more input it will call the read callback.
713  *  The write callback will be called with the decoded frame.
714  * 
715  * \param  decoder  An initialized decoder instance in the state
716  *                  \c FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC.
717  * \assert
718  *    \code decoder != NULL \endcode
719  *    \code FLAC__stream_decoder_get_state(decoder) == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC \endcode
720  * \retval FLAC__bool
721  *    \c false if any read or write error occurred (except
722  *    \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
723  *    in any case, check the decoder state with
724  *    FLAC__stream_decoder_get_state() to see what went wrong or to
725  *    check for lost synchronization (a sign of stream corruption).
726  */
727 FLAC__bool FLAC__stream_decoder_process_one_frame(FLAC__StreamDecoder *decoder);
728
729 /** Decode the remaining frames until end of stream.
730  *  This version instructs the decoder to decode all remaining frames,
731  *  until the callbacks return a fatal error or the read callback returns
732  *  \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM.
733  *
734  *  As the decoder needs more input it will call the read callback.
735  *  As each frame is decoded, the write callback will be called with the
736  *  decoded frame.
737  * 
738  * \param  decoder  An initialized decoder instance in the state
739  *                  \c FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC.
740  * \assert
741  *    \code decoder != NULL \endcode
742  *    \code FLAC__stream_decoder_get_state(decoder) == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC \endcode
743  * \retval FLAC__bool
744  *    \c false if any read or write error occurred (except
745  *    \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
746  *    in any case, check the decoder state with
747  *    FLAC__stream_decoder_get_state() to see what went wrong or to
748  *    check for lost synchronization (a sign of stream corruption).
749  */
750 FLAC__bool FLAC__stream_decoder_process_remaining_frames(FLAC__StreamDecoder *decoder);
751
752 /* \} */
753
754 #ifdef __cplusplus
755 }
756 #endif
757
758 #endif