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 identical to FLAC's seekable stream decoder.  See the
62  * defaults, including the callbacks.  See the \link flac_seekable_stream_decoder
63  * FLAC seekable stream decoder module \endlink for full documentation.
64  *
65  * \{
66  */
67
68
69 /** State values for an OggFLAC__SeekableStreamDecoder
70  *
71  *  The decoder's state can be obtained by calling OggFLAC__seekable_stream_decoder_get_state().
72  */
73 typedef enum {
74
75         OggFLAC__SEEKABLE_STREAM_DECODER_OK = 0,
76         /**< The decoder is in the normal OK state. */
77
78         OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR,
79         /**< An error occurred in the underlying FLAC seekable stream decoder;
80          * check OggFLAC__seekable_stream_decoder_get_FLAC_seekable_stream_decoder_state().
81          */
82
83         OggFLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK,
84         /**< The decoder was initialized before setting all the required callbacks. */
85
86         OggFLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
87         /**< Memory allocation failed. */
88
89         OggFLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED,
90         /**< OggFLAC__seekable_stream_decoder_init() was called when the decoder was
91          * already initialized, usually because
92          * OggFLAC__seekable_stream_decoder_finish() was not called.
93          */
94
95         OggFLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED
96         /**< The decoder is in the uninitialized state. */
97
98 } OggFLAC__SeekableStreamDecoderState;
99
100 /** Maps an OggFLAC__SeekableStreamDecoderState to a C string.
101  *
102  *  Using an OggFLAC__SeekableStreamDecoderState as the index to this array
103  *  will give the string equivalent.  The contents should not be modified.
104  */
105 extern OggFLAC_API const char * const OggFLAC__SeekableStreamDecoderStateString[];
106
107
108 /***********************************************************************
109  *
110  * class OggFLAC__SeekableStreamDecoder : public FLAC__StreamDecoder
111  *
112  ***********************************************************************/
113
114 struct OggFLAC__SeekableStreamDecoderProtected;
115 struct OggFLAC__SeekableStreamDecoderPrivate;
116 /** The opaque structure definition for the seekable stream decoder type.
117  *  See the
118  *  \link oggflac_seekable_stream_decoder seekable stream decoder module \endlink
119  *  for a detailed description.
120  */
121 typedef struct {
122         struct OggFLAC__SeekableStreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
123         struct OggFLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
124 } OggFLAC__SeekableStreamDecoder;
125
126 /*@@@@ document */
127 typedef FLAC__SeekableStreamDecoderReadStatus (*OggFLAC__SeekableStreamDecoderReadCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
128 typedef FLAC__SeekableStreamDecoderSeekStatus (*OggFLAC__SeekableStreamDecoderSeekCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
129 typedef FLAC__SeekableStreamDecoderTellStatus (*OggFLAC__SeekableStreamDecoderTellCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
130 typedef FLAC__SeekableStreamDecoderLengthStatus (*OggFLAC__SeekableStreamDecoderLengthCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
131 typedef FLAC__bool (*OggFLAC__SeekableStreamDecoderEofCallback)(const OggFLAC__SeekableStreamDecoder *decoder, void *client_data);
132 typedef FLAC__StreamDecoderWriteStatus (*OggFLAC__SeekableStreamDecoderWriteCallback)(const OggFLAC__SeekableStreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
133 typedef void (*OggFLAC__SeekableStreamDecoderMetadataCallback)(const OggFLAC__SeekableStreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
134 typedef void (*OggFLAC__SeekableStreamDecoderErrorCallback)(const OggFLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
135
136
137 /***********************************************************************
138  *
139  * Class constructor/destructor
140  *
141  ***********************************************************************/
142
143 /** Create a new seekable stream decoder instance.  The instance is created
144  *  with default settings; see the individual
145  *  OggFLAC__seekable_stream_decoder_set_*() functions for each setting's
146  *  default.
147  *
148  * \retval OggFLAC__SeekableStreamDecoder*
149  *    \c NULL if there was an error allocating memory, else the new instance.
150  */
151 OggFLAC_API OggFLAC__SeekableStreamDecoder *OggFLAC__seekable_stream_decoder_new();
152
153 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
154  *
155  * \param decoder  A pointer to an existing decoder.
156  * \assert
157  *    \code decoder != NULL \endcode
158  */
159 OggFLAC_API void OggFLAC__seekable_stream_decoder_delete(OggFLAC__SeekableStreamDecoder *decoder);
160
161
162 /***********************************************************************
163  *
164  * Public class method prototypes
165  *
166  ***********************************************************************/
167
168 /*@@@@inherit set_serial_number*/
169
170 /** Set the "MD5 signature checking" flag.
171  *  This is inherited from FLAC__SeekableStreamDecoder; see
172  *  FLAC__seekable_stream_decoder_set_md5_checking().
173  *
174  * \default \c false
175  * \param  decoder  A decoder instance to set.
176  * \param  value    Flag value (see above).
177  * \assert
178  *    \code decoder != NULL \endcode
179  * \retval FLAC__bool
180  *    \c false if the decoder is already initialized, else \c true.
181  */
182 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_md5_checking(OggFLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
183
184 /** Set the read callback.
185  *  This is inherited from FLAC__SeekableStreamDecoder; see
186  *  FLAC__seekable_stream_decoder_set_read_callback().
187  *
188  * \note
189  * The callback is mandatory and must be set before initialization.
190  *
191  * \default \c NULL
192  * \param  decoder  A decoder instance to set.
193  * \param  value    See above.
194  * \assert
195  *    \code decoder != NULL \endcode
196  *    \code value != NULL \endcode
197  * \retval FLAC__bool
198  *    \c false if the decoder is already initialized, else \c true.
199  */
200 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_read_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderReadCallback value);
201
202 /** Set the seek callback.
203  *  This is inherited from FLAC__SeekableStreamDecoder; see
204  *  FLAC__seekable_stream_decoder_set_seek_callback().
205  *
206  * \note
207  * The callback is mandatory and must be set before initialization.
208  *
209  * \default \c NULL
210  * \param  decoder  A decoder instance to set.
211  * \param  value    See above.
212  * \assert
213  *    \code decoder != NULL \endcode
214  *    \code value != NULL \endcode
215  * \retval FLAC__bool
216  *    \c false if the decoder is already initialized, else \c true.
217  */
218 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_seek_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderSeekCallback value);
219
220 /** Set the tell callback.
221  *  This is inherited from FLAC__SeekableStreamDecoder; see
222  *  FLAC__seekable_stream_decoder_set_tell_callback().
223  *
224  * \note
225  * The callback is mandatory and must be set before initialization.
226  *
227  * \default \c NULL
228  * \param  decoder  A decoder instance to set.
229  * \param  value    See above.
230  * \assert
231  *    \code decoder != NULL \endcode
232  *    \code value != NULL \endcode
233  * \retval FLAC__bool
234  *    \c false if the decoder is already initialized, else \c true.
235  */
236 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_tell_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderTellCallback value);
237
238 /** Set the length callback.
239  *  This is inherited from FLAC__SeekableStreamDecoder; see
240  *  FLAC__seekable_stream_decoder_set_length_callback().
241  *
242  * \note
243  * The callback is mandatory and must be set before initialization.
244  *
245  * \default \c NULL
246  * \param  decoder  A decoder instance to set.
247  * \param  value    See above.
248  * \assert
249  *    \code decoder != NULL \endcode
250  *    \code value != NULL \endcode
251  * \retval FLAC__bool
252  *    \c false if the decoder is already initialized, else \c true.
253  */
254 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_length_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderLengthCallback value);
255
256 /** Set the eof callback.
257  *  This is inherited from FLAC__SeekableStreamDecoder; see
258  *  FLAC__seekable_stream_decoder_set_eof_callback().
259  *
260  * \note
261  * The callback is mandatory and must be set before initialization.
262  *
263  * \default \c NULL
264  * \param  decoder  A decoder instance to set.
265  * \param  value    See above.
266  * \assert
267  *    \code decoder != NULL \endcode
268  *    \code value != NULL \endcode
269  * \retval FLAC__bool
270  *    \c false if the decoder is already initialized, else \c true.
271  */
272 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_eof_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderEofCallback value);
273
274 /** Set the write callback.
275  *  This is inherited from FLAC__SeekableStreamDecoder; see
276  *  FLAC__seekable_stream_decoder_set_write_callback().
277  *
278  * \note
279  * The callback is mandatory and must be set before initialization.
280  *
281  * \default \c NULL
282  * \param  decoder  A decoder instance to set.
283  * \param  value    See above.
284  * \assert
285  *    \code decoder != NULL \endcode
286  *    \code value != NULL \endcode
287  * \retval FLAC__bool
288  *    \c false if the decoder is already initialized, else \c true.
289  */
290 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_write_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderWriteCallback value);
291
292 /** Set the metadata callback.
293  *  This is inherited from FLAC__SeekableStreamDecoder; see
294  *  FLAC__seekable_stream_decoder_set_metadata_callback().
295  *
296  * \note
297  * The callback is mandatory and must be set before initialization.
298  *
299  * \default \c NULL
300  * \param  decoder  A decoder instance to set.
301  * \param  value    See above.
302  * \assert
303  *    \code decoder != NULL \endcode
304  *    \code value != NULL \endcode
305  * \retval FLAC__bool
306  *    \c false if the decoder is already initialized, else \c true.
307  */
308 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderMetadataCallback value);
309
310 /** Set the error callback.
311  *  This is inherited from FLAC__SeekableStreamDecoder; see
312  *  FLAC__seekable_stream_decoder_set_error_callback().
313  *
314  * \note
315  * The callback is mandatory and must be set before initialization.
316  *
317  * \default \c NULL
318  * \param  decoder  A decoder instance to set.
319  * \param  value    See above.
320  * \assert
321  *    \code decoder != NULL \endcode
322  *    \code value != NULL \endcode
323  * \retval FLAC__bool
324  *    \c false if the decoder is already initialized, else \c true.
325  */
326 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_error_callback(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__SeekableStreamDecoderErrorCallback value);
327
328 /** Set the client data to be passed back to callbacks.
329  *  This value will be supplied to callbacks in their \a client_data
330  *  argument.
331  *
332  * \default \c NULL
333  * \param  decoder  A decoder instance to set.
334  * \param  value    See above.
335  * \assert
336  *    \code decoder != NULL \endcode
337  * \retval FLAC__bool
338  *    \c false if the decoder is already initialized, else \c true.
339  */
340 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_client_data(OggFLAC__SeekableStreamDecoder *decoder, void *value);
341
342 /** This is inherited from FLAC__SeekableStreamDecoder; see
343  *  FLAC__seekable_stream_decoder_set_metadata_respond().
344  *
345  * \default By default, only the \c STREAMINFO block is returned via the
346  *          metadata callback.
347  * \param  decoder  A decoder instance to set.
348  * \param  type     See above.
349  * \assert
350  *    \code decoder != NULL \endcode
351  *    \a type is valid
352  * \retval FLAC__bool
353  *    \c false if the decoder is already initialized, else \c true.
354  */
355 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__MetadataType type);
356
357 /** This is inherited from FLAC__SeekableStreamDecoder; see
358  *  FLAC__seekable_stream_decoder_set_metadata_respond_application().
359  *
360  * \default By default, only the \c STREAMINFO block is returned via the
361  *          metadata callback.
362  * \param  decoder  A decoder instance to set.
363  * \param  id       See above.
364  * \assert
365  *    \code decoder != NULL \endcode
366  *    \code id != NULL \endcode
367  * \retval FLAC__bool
368  *    \c false if the decoder is already initialized, else \c true.
369  */
370 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond_application(OggFLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
371
372 /** This is inherited from FLAC__SeekableStreamDecoder; see
373  *  FLAC__seekable_stream_decoder_set_metadata_respond_all().
374  *
375  * \default By default, only the \c STREAMINFO block is returned via the
376  *          metadata callback.
377  * \param  decoder  A decoder instance to set.
378  * \assert
379  *    \code decoder != NULL \endcode
380  * \retval FLAC__bool
381  *    \c false if the decoder is already initialized, else \c true.
382  */
383 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond_all(OggFLAC__SeekableStreamDecoder *decoder);
384
385 /** This is inherited from FLAC__SeekableStreamDecoder; see
386  *  FLAC__seekable_stream_decoder_set_metadata_ignore().
387  *
388  * \default By default, only the \c STREAMINFO block is returned via the
389  *          metadata callback.
390  * \param  decoder  A decoder instance to set.
391  * \param  type     See above.
392  * \assert
393  *    \code decoder != NULL \endcode
394  *    \a type is valid
395  * \retval FLAC__bool
396  *    \c false if the decoder is already initialized, else \c true.
397  */
398 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__MetadataType type);
399
400 /** This is inherited from FLAC__SeekableStreamDecoder; see
401  *  FLAC__seekable_stream_decoder_set_metadata_ignore_application().
402  *
403  * \default By default, only the \c STREAMINFO block is returned via the
404  *          metadata callback.
405  * \param  decoder  A decoder instance to set.
406  * \param  id       See above.
407  * \assert
408  *    \code decoder != NULL \endcode
409  *    \code id != NULL \endcode
410  * \retval FLAC__bool
411  *    \c false if the decoder is already initialized, else \c true.
412  */
413 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore_application(OggFLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
414
415 /** This is inherited from FLAC__SeekableStreamDecoder; see
416  *  FLAC__seekable_stream_decoder_set_metadata_ignore_all().
417  *
418  * \default By default, only the \c STREAMINFO block is returned via the
419  *          metadata callback.
420  * \param  decoder  A decoder instance to set.
421  * \assert
422  *    \code decoder != NULL \endcode
423  * \retval FLAC__bool
424  *    \c false if the decoder is already initialized, else \c true.
425  */
426 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore_all(OggFLAC__SeekableStreamDecoder *decoder);
427
428 /** Get the current decoder state.
429  *
430  * \param  decoder  A decoder instance to query.
431  * \assert
432  *    \code decoder != NULL \endcode
433  * \retval OggFLAC__SeekableStreamDecoderState
434  *    The current decoder state.
435  */
436 OggFLAC_API OggFLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_get_state(const OggFLAC__SeekableStreamDecoder *decoder);
437
438 /** Get the state of the underlying FLAC seekable stream decoder.
439  *  Useful when the seekable stream decoder state is
440  *  \c OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR.
441  *
442  * \param  decoder  A decoder instance to query.
443  * \assert
444  *    \code decoder != NULL \endcode
445  * \retval FLAC__SeekableStreamDecoderState
446  *    The FLAC seekable stream decoder state.
447  */
448 OggFLAC_API FLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_get_FLAC_seekable_stream_decoder_state(const OggFLAC__SeekableStreamDecoder *decoder);
449
450 /** Get the state of the underlying FLAC seekable stream decoder's stream decoder.
451  *  Useful when the seekable stream decoder state is
452  *  \c OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR and the
453  *  FLAC seekable stream decoder state is \c FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR
454  *
455  * \param  decoder  A decoder instance to query.
456  * \assert
457  *    \code decoder != NULL \endcode
458  * \retval FLAC__StreamDecoderState
459  *    The FLAC stream decoder state.
460  */
461 OggFLAC_API FLAC__StreamDecoderState OggFLAC__seekable_stream_decoder_get_FLAC_stream_decoder_state(const OggFLAC__SeekableStreamDecoder *decoder);
462
463 /** This is inherited from FLAC__SeekableStreamDecoder; see
464  *  FLAC__seekable_stream_decoder_get_md5_checking().
465  *
466  * \param  decoder  A decoder instance to query.
467  * \assert
468  *    \code decoder != NULL \endcode
469  * \retval FLAC__bool
470  *    See above.
471  */
472 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_get_md5_checking(const OggFLAC__SeekableStreamDecoder *decoder);
473
474 /** This is inherited from FLAC__SeekableStreamDecoder; see
475  *  FLAC__seekable_stream_decoder_get_channels().
476  *
477  * \param  decoder  A decoder instance to query.
478  * \assert
479  *    \code decoder != NULL \endcode
480  * \retval unsigned
481  *    See above.
482  */
483 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_channels(const OggFLAC__SeekableStreamDecoder *decoder);
484
485 /** This is inherited from FLAC__SeekableStreamDecoder; see
486  *  FLAC__seekable_stream_decoder_get_channel_assignment().
487  *
488  * \param  decoder  A decoder instance to query.
489  * \assert
490  *    \code decoder != NULL \endcode
491  * \retval OggFLAC__ChannelAssignment
492  *    See above.
493  */
494 OggFLAC_API OggFLAC__ChannelAssignment OggFLAC__seekable_stream_decoder_get_channel_assignment(const OggFLAC__SeekableStreamDecoder *decoder);
495
496 /** This is inherited from FLAC__SeekableStreamDecoder; see
497  *  FLAC__seekable_stream_decoder_get_bits_per_sample().
498  *
499  * \param  decoder  A decoder instance to query.
500  * \assert
501  *    \code decoder != NULL \endcode
502  * \retval unsigned
503  *    See above.
504  */
505 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_bits_per_sample(const OggFLAC__SeekableStreamDecoder *decoder);
506
507 /** This is inherited from FLAC__SeekableStreamDecoder; see
508  *  FLAC__seekable_stream_decoder_get_sample_rate().
509  *
510  * \param  decoder  A decoder instance to query.
511  * \assert
512  *    \code decoder != NULL \endcode
513  * \retval unsigned
514  *    See above.
515  */
516 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_sample_rate(const OggFLAC__SeekableStreamDecoder *decoder);
517
518 /** This is inherited from FLAC__SeekableStreamDecoder; see
519  *  FLAC__seekable_stream_decoder_get_blocksize().
520  *
521  * \param  decoder  A decoder instance to query.
522  * \assert
523  *    \code decoder != NULL \endcode
524  * \retval unsigned
525  *    See above.
526  */
527 OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_blocksize(const OggFLAC__SeekableStreamDecoder *decoder);
528
529 /** Initialize the decoder instance.
530  *  Should be called after OggFLAC__seekable_stream_decoder_new() and
531  *  OggFLAC__seekable_stream_decoder_set_*() but before any of the
532  *  OggFLAC__seekable_stream_decoder_process_*() functions.  Will set and return
533  *  the decoder state, which will be OggFLAC__SEEKABLE_STREAM_DECODER_OK
534  *  if initialization succeeded.
535  *
536  * \param  decoder  An uninitialized decoder instance.
537  * \assert
538  *    \code decoder != NULL \endcode
539  * \retval OggFLAC__SeekableStreamDecoderState
540  *    \c OggFLAC__SEEKABLE_STREAM_DECODER_OK if initialization was
541  *    successful; see OggFLAC__SeekableStreamDecoderState for the meanings
542  *    of other return values.
543  */
544 OggFLAC_API OggFLAC__SeekableStreamDecoderState OggFLAC__seekable_stream_decoder_init(OggFLAC__SeekableStreamDecoder *decoder);
545
546 /** Finish the decoding process.
547  *  Flushes the decoding buffer, releases resources, resets the decoder
548  *  settings to their defaults, and returns the decoder state to
549  *  OggFLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.
550  *
551  *  In the event of a prematurely-terminated decode, it is not strictly
552  *  necessary to call this immediately before
553  *  OggFLAC__seekable_stream_decoder_delete() but it is good practice to match
554  *  every OggFLAC__seekable_stream_decoder_init() with a
555  *  OggFLAC__seekable_stream_decoder_finish().
556  *
557  * \param  decoder  An uninitialized decoder instance.
558  * \assert
559  *    \code decoder != NULL \endcode
560  * \retval FLAC__bool
561  *    \c false if MD5 checking is on AND a STREAMINFO block was available
562  *    AND the MD5 signature in the STREAMINFO block was non-zero AND the
563  *    signature does not match the one computed by the decoder; else
564  *    \c true.
565  */
566 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_finish(OggFLAC__SeekableStreamDecoder *decoder);
567
568 /** This is inherited from FLAC__SeekableStreamDecoder; see
569  *  FLAC__seekable_stream_decoder_flush().
570  *
571  * \param  decoder  A decoder instance.
572  * \assert
573  *    \code decoder != NULL \endcode
574  * \retval FLAC__bool
575  *    \c true if successful, else \c false if a memory allocation
576  *    or stream decoder error occurs.
577  */
578 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_flush(OggFLAC__SeekableStreamDecoder *decoder);
579
580 /** This is inherited from FLAC__SeekableStreamDecoder; see
581  *  FLAC__seekable_stream_decoder_reset().
582  *
583  * \param  decoder  A decoder instance.
584  * \assert
585  *    \code decoder != NULL \endcode
586  * \retval FLAC__bool
587  *    \c true if successful, else \c false if a memory allocation
588  *    or stream decoder error occurs.
589  */
590 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_reset(OggFLAC__SeekableStreamDecoder *decoder);
591
592 /** This is inherited from FLAC__SeekableStreamDecoder; see
593  *  FLAC__seekable_stream_decoder_process_single().
594  *
595  * \param  decoder  A decoder instance.
596  * \assert
597  *    \code decoder != NULL \endcode
598  * \retval FLAC__bool
599  *    See above.
600  */
601 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_single(OggFLAC__SeekableStreamDecoder *decoder);
602
603 /** This is inherited from FLAC__SeekableStreamDecoder; see
604  *  FLAC__seekable_stream_decoder_process_until_end_of_metadata().
605  *
606  * \param  decoder  A decoder instance.
607  * \assert
608  *    \code decoder != NULL \endcode
609  * \retval FLAC__bool
610  *    See above.
611  */
612 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_until_end_of_metadata(OggFLAC__SeekableStreamDecoder *decoder);
613
614 /** This is inherited from FLAC__SeekableStreamDecoder; see
615  *  FLAC__seekable_stream_decoder_process_until_end_of_stream().
616  *
617  * \param  decoder  A decoder instance.
618  * \assert
619  *    \code decoder != NULL \endcode
620  * \retval FLAC__bool
621  *    See above.
622  */
623 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_process_until_end_of_stream(OggFLAC__SeekableStreamDecoder *decoder);
624
625 /** This is inherited from FLAC__SeekableStreamDecoder; see
626  *  FLAC__seekable_stream_decoder_seek_absolute().
627  *
628  * \param  decoder  A decoder instance.
629  * \param  sample   The target sample number to seek to.
630  * \assert
631  *    \code decoder != NULL \endcode
632  * \retval FLAC__bool
633  *    \c true if successful, else \c false.
634  */
635 OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_seek_absolute(OggFLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
636
637 /* \} */
638
639 #ifdef __cplusplus
640 }
641 #endif
642
643 #endif