minor comments
[flac.git] / include / OggFLAC / seekable_stream_decoder.h
1 /* libOggFLAC - Free Lossless Audio Codec + Ogg library
2  * Copyright (C) 2002,2003  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 OggFLAC__SEEKABLE_STREAM_DECODER_H
33 #define OggFLAC__SEEKABLE_STREAM_DECODER_H
34
35 #include "export.h"
36
37 #include "FLAC/seekable_stream_decoder.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43
44 /** \file include/OggFLAC/seekable_stream_decoder.h
45  *
46  *  \brief
47  *  This module contains the functions which implement the seekable stream
48  *  decoder.
49  *
50  *  See the detailed documentation in the
51  *  \link oggflac_seekable_stream_decoder seekable stream decoder \endlink module.
52  */
53
54 /** \defgroup oggflac_seekable_stream_decoder OggFLAC/seekable_stream_decoder.h: seekable stream decoder interface
55  *  \ingroup oggflac_decoder
56  *
57  *  \brief
58  *  This module contains the functions which implement the seekable stream
59  *  decoder.
60  *
61  * The interface here is nearly identical to FLAC's seekable stream decoder,
62  * including the callbacks, with the addition of
63  * OggFLAC__seekable_stream_decoder_set_serial_number().  See the
64  * \link flac_seekable_stream_decoder FLAC seekable stream decoder module \endlink
65  * for full documentation.
66  *
67  * \{
68  */
69
70
71 /** State values for an OggFLAC__SeekableStreamDecoder
72  *
73  *  The decoder's state can be obtained by calling OggFLAC__seekable_stream_decoder_get_state().
74  */
75 typedef enum {
76
77         OggFLAC__SEEKABLE_STREAM_DECODER_OK = 0,
78         /**< The decoder is in the normal OK state. */
79
80         OggFLAC__SEEKABLE_STREAM_DECODER_OGG_ERROR,
81         /**< An error occurred in the underlying Ogg layer.  */
82
83         OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR,
84         /**< An error occurred in the underlying FLAC seekable stream decoder;
85          * check OggFLAC__seekable_stream_decoder_get_FLAC_seekable_stream_decoder_state().
86          */
87
88         OggFLAC__SEEKABLE_STREAM_DECODER_READ_ERROR,
89         /**< The read callback returned an error. */
90
91         OggFLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK,
92         /**< The decoder was initialized before setting all the required callbacks. */
93
94         OggFLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
95         /**< Memory allocation failed. */
96
97         OggFLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED,
98         /**< OggFLAC__seekable_stream_decoder_init() was called when the decoder was
99          * already initialized, usually because
100          * OggFLAC__seekable_stream_decoder_finish() was not called.
101          */
102
103         OggFLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED
104         /**< The decoder is in the uninitialized state. */
105
106 } OggFLAC__SeekableStreamDecoderState;
107
108 /** Maps an OggFLAC__SeekableStreamDecoderState to a C string.
109  *
110  *  Using an OggFLAC__SeekableStreamDecoderState as the index to this array
111  *  will give the string equivalent.  The contents should not be modified.
112  */
113 extern OggFLAC_API const char * const OggFLAC__SeekableStreamDecoderStateString[];
114
115
116 /***********************************************************************
117  *
118  * class OggFLAC__SeekableStreamDecoder : public FLAC__StreamDecoder
119  *
120  ***********************************************************************/
121
122 struct OggFLAC__SeekableStreamDecoderProtected;
123 struct OggFLAC__SeekableStreamDecoderPrivate;
124 /** The opaque structure definition for the seekable stream decoder type.
125  *  See the
126  *  \link oggflac_seekable_stream_decoder seekable stream decoder module \endlink
127  *  for a detailed description.
128  */
129 typedef struct {
130         struct OggFLAC__SeekableStreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
131         struct OggFLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
132 } OggFLAC__SeekableStreamDecoder;
133
134 /** Signature for the read callback.
135  *  See OggFLAC__seekable_stream_decoder_set_read_callback()
136  *  and OggFLAC__StreamDecoderReadCallback for more info.
137  *
138  * \param  decoder  The decoder instance calling the callback.
139  * \param  buffer   A pointer to a location for the callee to store
140  *                  data to be decoded.
141  * \param  bytes    A pointer to the size of the buffer.
142  * \param  client_data  The callee's client data set through
143  *                      OggFLAC__seekable_stream_decoder_set_client_data().
144  * \retval FLAC__SeekableStreamDecoderReadStatus
145  *    The callee's return status.
146  */
147 typedef FLAC__SeekableStreamDecoderReadStatus (*OggFLAC__SeekableStreamDecoderReadCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
148
149 /** Signature for the seek callback.
150  *  See OggFLAC__seekable_stream_decoder_set_seek_callback() for more info.
151  *
152  * \param  decoder  The decoder instance calling the callback.
153  * \param  absolute_byte_offset  The offset from the beginning of the stream
154  *                               to seek to.
155  * \param  client_data  The callee's client data set through
156  *                      OggFLAC__seekable_stream_decoder_set_client_data().
157  * \retval FLAC__SeekableStreamDecoderSeekStatus
158  *    The callee's return status.
159  */
160 typedef FLAC__SeekableStreamDecoderSeekStatus (*OggFLAC__SeekableStreamDecoderSeekCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
161
162 /** Signature for the tell callback.
163  *  See OggFLAC__seekable_stream_decoder_set_tell_callback() for more info.
164  *
165  * \param  decoder  The decoder instance calling the callback.
166  * \param  absolute_byte_offset  A pointer to storage for the current offset
167  *                               from the beginning of the stream.
168  * \param  client_data  The callee's client data set through
169  *                      OggFLAC__seekable_stream_decoder_set_client_data().
170  * \retval FLAC__SeekableStreamDecoderTellStatus
171  *    The callee's return status.
172  */
173 typedef FLAC__SeekableStreamDecoderTellStatus (*OggFLAC__SeekableStreamDecoderTellCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
174
175 /** Signature for the length callback.
176  *  See OggFLAC__seekable_stream_decoder_set_length_callback() for more info.
177  *
178  * \param  decoder  The decoder instance calling the callback.
179  * \param  stream_length  A pointer to storage for the length of the stream
180  *                        in bytes.
181  * \param  client_data  The callee's client data set through
182  *                      OggFLAC__seekable_stream_decoder_set_client_data().
183  * \retval FLAC__SeekableStreamDecoderLengthStatus
184  *    The callee's return status.
185  */
186 typedef FLAC__SeekableStreamDecoderLengthStatus (*OggFLAC__SeekableStreamDecoderLengthCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
187
188 /** Signature for the EOF callback.
189  *  See OggFLAC__seekable_stream_decoder_set_eof_callback() for more info.
190  *
191  * \param  decoder  The decoder instance calling the callback.
192  * \param  client_data  The callee's client data set through
193  *                      OggFLAC__seekable_stream_decoder_set_client_data().
194  * \retval FLAC__bool
195  *    \c true if the currently at the end of the stream, else \c false.
196  */
197 typedef FLAC__bool (*OggFLAC__SeekableStreamDecoderEofCallback)(const OggFLAC__SeekableStreamDecoder *decoder, void *client_data);
198
199 /** Signature for the write callback.
200  *  See OggFLAC__seekable_stream_decoder_set_write_callback()
201  *  and OggFLAC__StreamDecoderWriteCallback for more info.
202  *
203  * \param  decoder  The decoder instance calling the callback.
204  * \param  frame    The description of the decoded frame.
205  * \param  buffer   An array of pointers to decoded channels of data.
206  * \param  client_data  The callee's client data set through
207  *                      OggFLAC__seekable_stream_decoder_set_client_data().
208  * \retval FLAC__StreamDecoderWriteStatus
209  *    The callee's return status.
210  */
211 typedef FLAC__StreamDecoderWriteStatus (*OggFLAC__SeekableStreamDecoderWriteCallback)(const OggFLAC__SeekableStreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
212
213 /** Signature for the metadata callback.
214  *  See OggFLAC__seekable_stream_decoder_set_metadata_callback()
215  *  and OggFLAC__StreamDecoderMetadataCallback for more info.
216  *
217  * \param  decoder  The decoder instance calling the callback.
218  * \param  metadata The decoded metadata block.
219  * \param  client_data  The callee's client data set through
220  *                      OggFLAC__seekable_stream_decoder_set_client_data().
221  */
222 typedef void (*OggFLAC__SeekableStreamDecoderMetadataCallback)(const OggFLAC__SeekableStreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
223
224 /** Signature for the error callback.
225  *  See OggFLAC__seekable_stream_decoder_set_error_callback()
226  *  and OggFLAC__StreamDecoderErrorCallback for more info.
227  *
228  * \param  decoder  The decoder instance calling the callback.
229  * \param  status   The error encountered by the decoder.
230  * \param  client_data  The callee's client data set through
231  *                      OggFLAC__seekable_stream_decoder_set_client_data().
232  */
233 typedef void (*OggFLAC__SeekableStreamDecoderErrorCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
234
235
236 /***********************************************************************
237  *
238  * Class constructor/destructor
239  *
240  ***********************************************************************/
241
242 /** Create a new seekable stream decoder instance.  The instance is created
243  *  with default settings; see the individual
244  *  OggFLAC__seekable_stream_decoder_set_*() functions for each setting's
245  *  default.
246  *
247  * \retval OggFLAC__SeekableStreamDecoder*
248  *    \c NULL if there was an error allocating memory, else the new instance.
249  */
250 OggFLAC_API OggFLAC__SeekableStreamDecoder *OggFLAC__seekable_stream_decoder_new();
251
252 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
253  *
254  * \param decoder  A pointer to an existing decoder.
255  * \assert
256  *    \code decoder != NULL \endcode
257  */
258 OggFLAC_API void OggFLAC__seekable_stream_decoder_delete(OggFLAC__SeekableStreamDecoder *decoder);
259
260
261 /***********************************************************************
262  *
263  * Public class method prototypes
264  *
265  ***********************************************************************/
266
267 /** Set the "MD5 signature checking" flag.
268  *  This is inherited from FLAC__SeekableStreamDecoder; see
269  *  FLAC__seekable_stream_decoder_set_md5_checking().
270  *
271  * \default \c false
272  * \param  decoder  A decoder instance to set.
273  * \param  value    Flag value (see above).
274  * \assert
275  *    \code decoder != NULL \endcode
276  * \retval FLAC__bool
277  *    \c false if the decoder is already initialized, else \c true.
278  */
279 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_md5_checking(OggFLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
280
281 /** Set the read callback.
282  *  This is inherited from FLAC__SeekableStreamDecoder; see
283  *  FLAC__seekable_stream_decoder_set_read_callback().
284  *
285  * \note
286  * The callback is mandatory and must be set before initialization.
287  *
288  * \default \c NULL
289  * \param  decoder  A decoder instance to set.
290  * \param  value    See above.
291  * \assert
292  *    \code decoder != NULL \endcode
293  *    \code value != NULL \endcode
294  * \retval FLAC__bool
295  *    \c false if the decoder is already initialized, else \c true.
296  */
297 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_read_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderReadCallback value);
298
299 /** Set the seek callback.
300  *  This is inherited from FLAC__SeekableStreamDecoder; see
301  *  FLAC__seekable_stream_decoder_set_seek_callback().
302  *
303  * \note
304  * The callback is mandatory and must be set before initialization.
305  *
306  * \default \c NULL
307  * \param  decoder  A decoder instance to set.
308  * \param  value    See above.
309  * \assert
310  *    \code decoder != NULL \endcode
311  *    \code value != NULL \endcode
312  * \retval FLAC__bool
313  *    \c false if the decoder is already initialized, else \c true.
314  */
315 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_seek_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderSeekCallback value);
316
317 /** Set the tell callback.
318  *  This is inherited from FLAC__SeekableStreamDecoder; see
319  *  FLAC__seekable_stream_decoder_set_tell_callback().
320  *
321  * \note
322  * The callback is mandatory and must be set before initialization.
323  *
324  * \default \c NULL
325  * \param  decoder  A decoder instance to set.
326  * \param  value    See above.
327  * \assert
328  *    \code decoder != NULL \endcode
329  *    \code value != NULL \endcode
330  * \retval FLAC__bool
331  *    \c false if the decoder is already initialized, else \c true.
332  */
333 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_tell_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderTellCallback value);
334
335 /** Set the length callback.
336  *  This is inherited from FLAC__SeekableStreamDecoder; see
337  *  FLAC__seekable_stream_decoder_set_length_callback().
338  *
339  * \note
340  * The callback is mandatory and must be set before initialization.
341  *
342  * \default \c NULL
343  * \param  decoder  A decoder instance to set.
344  * \param  value    See above.
345  * \assert
346  *    \code decoder != NULL \endcode
347  *    \code value != NULL \endcode
348  * \retval FLAC__bool
349  *    \c false if the decoder is already initialized, else \c true.
350  */
351 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_length_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderLengthCallback value);
352
353 /** Set the eof callback.
354  *  This is inherited from FLAC__SeekableStreamDecoder; see
355  *  FLAC__seekable_stream_decoder_set_eof_callback().
356  *
357  * \note
358  * The callback is mandatory and must be set before initialization.
359  *
360  * \default \c NULL
361  * \param  decoder  A decoder instance to set.
362  * \param  value    See above.
363  * \assert
364  *    \code decoder != NULL \endcode
365  *    \code value != NULL \endcode
366  * \retval FLAC__bool
367  *    \c false if the decoder is already initialized, else \c true.
368  */
369 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_eof_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderEofCallback value);
370
371 /** Set the write callback.
372  *  This is inherited from FLAC__SeekableStreamDecoder; see
373  *  FLAC__seekable_stream_decoder_set_write_callback().
374  *
375  * \note
376  * The callback is mandatory and must be set before initialization.
377  *
378  * \default \c NULL
379  * \param  decoder  A decoder instance to set.
380  * \param  value    See above.
381  * \assert
382  *    \code decoder != NULL \endcode
383  *    \code value != NULL \endcode
384  * \retval FLAC__bool
385  *    \c false if the decoder is already initialized, else \c true.
386  */
387 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_write_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderWriteCallback value);
388
389 /** Set the metadata callback.
390  *  This is inherited from FLAC__SeekableStreamDecoder; see
391  *  FLAC__seekable_stream_decoder_set_metadata_callback().
392  *
393  * \note
394  * The callback is mandatory and must be set before initialization.
395  *
396  * \default \c NULL
397  * \param  decoder  A decoder instance to set.
398  * \param  value    See above.
399  * \assert
400  *    \code decoder != NULL \endcode
401  *    \code value != NULL \endcode
402  * \retval FLAC__bool
403  *    \c false if the decoder is already initialized, else \c true.
404  */
405 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderMetadataCallback value);
406
407 /** Set the error callback.
408  *  This is inherited from FLAC__SeekableStreamDecoder; see
409  *  FLAC__seekable_stream_decoder_set_error_callback().
410  *
411  * \note
412  * The callback is mandatory and must be set before initialization.
413  *
414  * \default \c NULL
415  * \param  decoder  A decoder instance to set.
416  * \param  value    See above.
417  * \assert
418  *    \code decoder != NULL \endcode
419  *    \code value != NULL \endcode
420  * \retval FLAC__bool
421  *    \c false if the decoder is already initialized, else \c true.
422  */
423 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_error_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderErrorCallback value);
424
425 /** Set the client data to be passed back to callbacks.
426  *  This value will be supplied to callbacks in their \a client_data
427  *  argument.
428  *
429  * \default \c NULL
430  * \param  decoder  A decoder instance to set.
431  * \param  value    See above.
432  * \assert
433  *    \code decoder != NULL \endcode
434  * \retval FLAC__bool
435  *    \c false if the decoder is already initialized, else \c true.
436  */
437 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_client_data(OggFLAC__SeekableStreamDecoder *decoder, void *value);
438
439 /** Set the serial number for the Ogg stream.
440  * The default behavior is to use the serial number of the first Ogg
441  * page.  Setting a serial number here will explicitly specify which
442  * stream is to be decoded.
443  *
444  * \default \c use serial number of first page
445  * \param  decoder        A decoder instance to set.
446  * \param  serial_number  See above.
447  * \assert
448  *    \code decoder != NULL \endcode
449  * \retval FLAC__bool
450  *    \c false if the decoder is already initialized, else \c true.
451  */
452 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_serial_number(OggFLAC__SeekableStreamDecoder *decoder, long serial_number);
453
454 /** This is inherited from FLAC__SeekableStreamDecoder; see
455  *  FLAC__seekable_stream_decoder_set_metadata_respond().
456  *
457  * \default By default, only the \c STREAMINFO block is returned via the
458  *          metadata callback.
459  * \param  decoder  A decoder instance to set.
460  * \param  type     See above.
461  * \assert
462  *    \code decoder != NULL \endcode
463  *    \a type is valid
464  * \retval FLAC__bool
465  *    \c false if the decoder is already initialized, else \c true.
466  */
467 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond(OggFLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
468
469 /** This is inherited from FLAC__SeekableStreamDecoder; see
470  *  FLAC__seekable_stream_decoder_set_metadata_respond_application().
471  *
472  * \default By default, only the \c STREAMINFO block is returned via the
473  *          metadata callback.
474  * \param  decoder  A decoder instance to set.
475  * \param  id       See above.
476  * \assert
477  *    \code decoder != NULL \endcode
478  *    \code id != NULL \endcode
479  * \retval FLAC__bool
480  *    \c false if the decoder is already initialized, else \c true.
481  */
482 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond_application(OggFLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
483
484 /** This is inherited from FLAC__SeekableStreamDecoder; see
485  *  FLAC__seekable_stream_decoder_set_metadata_respond_all().
486  *
487  * \default By default, only the \c STREAMINFO block is returned via the
488  *          metadata callback.
489  * \param  decoder  A decoder instance to set.
490  * \assert
491  *    \code decoder != NULL \endcode
492  * \retval FLAC__bool
493  *    \c false if the decoder is already initialized, else \c true.
494  */
495 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond_all(OggFLAC__SeekableStreamDecoder *decoder);
496
497 /** This is inherited from FLAC__SeekableStreamDecoder; see
498  *  FLAC__seekable_stream_decoder_set_metadata_ignore().
499  *
500  * \default By default, only the \c STREAMINFO block is returned via the
501  *          metadata callback.
502  * \param  decoder  A decoder instance to set.
503  * \param  type     See above.
504  * \assert
505  *    \code decoder != NULL \endcode
506  *    \a type is valid
507  * \retval FLAC__bool
508  *    \c false if the decoder is already initialized, else \c true.
509  */
510 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore(OggFLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
511
512 /** This is inherited from FLAC__SeekableStreamDecoder; see
513  *  FLAC__seekable_stream_decoder_set_metadata_ignore_application().
514  *
515  * \default By default, only the \c STREAMINFO block is returned via the
516  *          metadata callback.
517  * \param  decoder  A decoder instance to set.
518  * \param  id       See above.
519  * \assert
520  *    \code decoder != NULL \endcode
521  *    \code id != NULL \endcode
522  * \retval FLAC__bool
523  *    \c false if the decoder is already initialized, else \c true.
524  */
525 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore_application(OggFLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
526
527 /** This is inherited from FLAC__SeekableStreamDecoder; see
528  *  FLAC__seekable_stream_decoder_set_metadata_ignore_all().
529  *
530  * \default By default, only the \c STREAMINFO block is returned via the
531  *          metadata callback.
532  * \param  decoder  A decoder instance to set.
533  * \assert
534  *    \code decoder != NULL \endcode
535  * \retval FLAC__bool
536  *    \c false if the decoder is already initialized, else \c true.
537  */
538 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore_all(OggFLAC__SeekableStreamDecoder *decoder);
539
540 /** Get the current decoder state.
541  *
542  * \param  decoder  A decoder instance to query.
543  * \assert
544  *    \code decoder != NULL \endcode
545  * \retval OggFLAC__SeekableStreamDecoderState
546  *    The current decoder state.
547  */
548 OggFLAC_API OggFLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_get_state(const OggFLAC__SeekableStreamDecoder *decoder);
549
550 /** Get the state of the underlying FLAC seekable stream decoder.
551  *  Useful when the seekable stream decoder state is
552  *  \c OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR.
553  *
554  * \param  decoder  A decoder instance to query.
555  * \assert
556  *    \code decoder != NULL \endcode
557  * \retval FLAC__SeekableStreamDecoderState
558  *    The FLAC seekable stream decoder state.
559  */
560 OggFLAC_API FLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_get_FLAC_seekable_stream_decoder_state(const OggFLAC__SeekableStreamDecoder *decoder);
561
562 /** Get the state of the underlying FLAC seekable stream decoder's stream decoder.
563  *  Useful when the seekable stream decoder state is
564  *  \c OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR and the
565  *  FLAC seekable stream decoder state is \c FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR
566  *
567  * \param  decoder  A decoder instance to query.
568  * \assert
569  *    \code decoder != NULL \endcode
570  * \retval FLAC__StreamDecoderState
571  *    The FLAC stream decoder state.
572  */
573 OggFLAC_API FLAC__StreamDecoderState OggFLAC__seekable_stream_decoder_get_FLAC_stream_decoder_state(const OggFLAC__SeekableStreamDecoder *decoder);
574
575 /** Get the current decoder state as a C string.
576  *  This version automatically resolves
577  *  \c OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR
578  *  by getting the FLAC seekable stream decoder's state.
579  *
580  * \param  decoder  A decoder instance to query.
581  * \assert
582  *    \code decoder != NULL \endcode
583  * \retval const char *
584  *    The decoder state as a C string.  Do not modify the contents.
585  */
586 OggFLAC_API const char *FLAC__seekable_stream_decoder_get_resolved_state_string(const FLAC__SeekableStreamDecoder *decoder);
587
588 /** This is inherited from FLAC__SeekableStreamDecoder; see
589  *  FLAC__seekable_stream_decoder_get_md5_checking().
590  *
591  * \param  decoder  A decoder instance to query.
592  * \assert
593  *    \code decoder != NULL \endcode
594  * \retval FLAC__bool
595  *    See above.
596  */
597 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_get_md5_checking(const OggFLAC__SeekableStreamDecoder *decoder);
598
599 /** This is inherited from FLAC__SeekableStreamDecoder; see
600  *  FLAC__seekable_stream_decoder_get_channels().
601  *
602  * \param  decoder  A decoder instance to query.
603  * \assert
604  *    \code decoder != NULL \endcode
605  * \retval unsigned
606  *    See above.
607  */
608 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_channels(const OggFLAC__SeekableStreamDecoder *decoder);
609
610 /** This is inherited from FLAC__SeekableStreamDecoder; see
611  *  FLAC__seekable_stream_decoder_get_channel_assignment().
612  *
613  * \param  decoder  A decoder instance to query.
614  * \assert
615  *    \code decoder != NULL \endcode
616  * \retval OggFLAC__ChannelAssignment
617  *    See above.
618  */
619 OggFLAC_API FLAC__ChannelAssignment OggFLAC__seekable_stream_decoder_get_channel_assignment(const OggFLAC__SeekableStreamDecoder *decoder);
620
621 /** This is inherited from FLAC__SeekableStreamDecoder; see
622  *  FLAC__seekable_stream_decoder_get_bits_per_sample().
623  *
624  * \param  decoder  A decoder instance to query.
625  * \assert
626  *    \code decoder != NULL \endcode
627  * \retval unsigned
628  *    See above.
629  */
630 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_bits_per_sample(const OggFLAC__SeekableStreamDecoder *decoder);
631
632 /** This is inherited from FLAC__SeekableStreamDecoder; see
633  *  FLAC__seekable_stream_decoder_get_sample_rate().
634  *
635  * \param  decoder  A decoder instance to query.
636  * \assert
637  *    \code decoder != NULL \endcode
638  * \retval unsigned
639  *    See above.
640  */
641 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_sample_rate(const OggFLAC__SeekableStreamDecoder *decoder);
642
643 /** This is inherited from FLAC__SeekableStreamDecoder; see
644  *  FLAC__seekable_stream_decoder_get_blocksize().
645  *
646  * \param  decoder  A decoder instance to query.
647  * \assert
648  *    \code decoder != NULL \endcode
649  * \retval unsigned
650  *    See above.
651  */
652 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_blocksize(const OggFLAC__SeekableStreamDecoder *decoder);
653
654 /** Returns the decoder's current read position within the stream.
655  *  This is inherited from FLAC__SeekableStreamDecoder; see
656  *  FLAC__seekable_stream_decoder_get_decode_position().
657  *
658  * \param  decoder   A decoder instance to query.
659  * \param  position  Address at which to return the desired position.
660  * \assert
661  *    \code decoder != NULL \endcode
662  *    \code position != NULL \endcode
663  * \retval FLAC__bool
664  *    \c true if successful, \c false if there was an error from
665  *    the 'tell' callback.
666  */
667 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_get_decode_position(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *position);
668
669 /** Initialize the decoder instance.
670  *  Should be called after OggFLAC__seekable_stream_decoder_new() and
671  *  OggFLAC__seekable_stream_decoder_set_*() but before any of the
672  *  OggFLAC__seekable_stream_decoder_process_*() functions.  Will set and return
673  *  the decoder state, which will be OggFLAC__SEEKABLE_STREAM_DECODER_OK
674  *  if initialization succeeded.
675  *
676  * \param  decoder  An uninitialized decoder instance.
677  * \assert
678  *    \code decoder != NULL \endcode
679  * \retval OggFLAC__SeekableStreamDecoderState
680  *    \c OggFLAC__SEEKABLE_STREAM_DECODER_OK if initialization was
681  *    successful; see OggFLAC__SeekableStreamDecoderState for the meanings
682  *    of other return values.
683  */
684 OggFLAC_API OggFLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_init(OggFLAC__SeekableStreamDecoder *decoder);
685
686 /** Finish the decoding process.
687  *  Flushes the decoding buffer, releases resources, resets the decoder
688  *  settings to their defaults, and returns the decoder state to
689  *  OggFLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.
690  *
691  *  In the event of a prematurely-terminated decode, it is not strictly
692  *  necessary to call this immediately before
693  *  OggFLAC__seekable_stream_decoder_delete() but it is good practice to match
694  *  every OggFLAC__seekable_stream_decoder_init() with a
695  *  OggFLAC__seekable_stream_decoder_finish().
696  *
697  * \param  decoder  An uninitialized decoder instance.
698  * \assert
699  *    \code decoder != NULL \endcode
700  * \retval FLAC__bool
701  *    \c false if MD5 checking is on AND a STREAMINFO block was available
702  *    AND the MD5 signature in the STREAMINFO block was non-zero AND the
703  *    signature does not match the one computed by the decoder; else
704  *    \c true.
705  */
706 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_finish(OggFLAC__SeekableStreamDecoder *decoder);
707
708 /** This is inherited from FLAC__SeekableStreamDecoder; see
709  *  FLAC__seekable_stream_decoder_flush().
710  *
711  * \param  decoder  A decoder instance.
712  * \assert
713  *    \code decoder != NULL \endcode
714  * \retval FLAC__bool
715  *    \c true if successful, else \c false if a memory allocation
716  *    or stream decoder error occurs.
717  */
718 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_flush(OggFLAC__SeekableStreamDecoder *decoder);
719
720 /** This is inherited from FLAC__SeekableStreamDecoder; see
721  *  FLAC__seekable_stream_decoder_reset().
722  *
723  * \param  decoder  A decoder instance.
724  * \assert
725  *    \code decoder != NULL \endcode
726  * \retval FLAC__bool
727  *    \c true if successful, else \c false if a memory allocation
728  *    or stream decoder error occurs.
729  */
730 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_reset(OggFLAC__SeekableStreamDecoder *decoder);
731
732 /** This is inherited from FLAC__SeekableStreamDecoder; see
733  *  FLAC__seekable_stream_decoder_process_single().
734  *
735  * \param  decoder  A decoder instance.
736  * \assert
737  *    \code decoder != NULL \endcode
738  * \retval FLAC__bool
739  *    See above.
740  */
741 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_single(OggFLAC__SeekableStreamDecoder *decoder);
742
743 /** This is inherited from FLAC__SeekableStreamDecoder; see
744  *  FLAC__seekable_stream_decoder_process_until_end_of_metadata().
745  *
746  * \param  decoder  A decoder instance.
747  * \assert
748  *    \code decoder != NULL \endcode
749  * \retval FLAC__bool
750  *    See above.
751  */
752 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_until_end_of_metadata(OggFLAC__SeekableStreamDecoder *decoder);
753
754 /** This is inherited from FLAC__SeekableStreamDecoder; see
755  *  FLAC__seekable_stream_decoder_process_until_end_of_stream().
756  *
757  * \param  decoder  A decoder instance.
758  * \assert
759  *    \code decoder != NULL \endcode
760  * \retval FLAC__bool
761  *    See above.
762  */
763 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_until_end_of_stream(OggFLAC__SeekableStreamDecoder *decoder);
764
765 /** This is inherited from FLAC__SeekableStreamDecoder; see
766  *  FLAC__seekable_stream_decoder_seek_absolute().
767  *
768  * \param  decoder  A decoder instance.
769  * \param  sample   The target sample number to seek to.
770  * \assert
771  *    \code decoder != NULL \endcode
772  * \retval FLAC__bool
773  *    \c true if successful, else \c false.
774  */
775 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_seek_absolute(OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
776
777 /* \} */
778
779 #ifdef __cplusplus
780 }
781 #endif
782
783 #endif