more doxygen docs
[flac.git] / include / FLAC / seekable_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__SEEKABLE_STREAM_DECODER_H
21 #define FLAC__SEEKABLE_STREAM_DECODER_H
22
23 #include "stream_decoder.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /** \file include/FLAC/seekable_stream_decoder.h
31  *
32  *  \brief
33  *  This module contains the functions which implement the seekable stream
34  *  decoder.
35  *
36  *  See the detailed documentation in the
37  *  \link flac_seekable_stream_decoder seekable stream decoder \endlink module.
38  */
39
40 /** \defgroup flac_seekable_stream_decoder FLAC/seekable_stream_decoder.h: seekable stream decoder interface
41  *  \ingroup flac_decoder
42  *
43  *  \brief
44  *  This module contains the functions which implement the seekable stream
45  *  decoder.
46  *
47  * The basic usage of this decoder is as follows:
48  * - The program creates an instance of a decoder using
49  *   FLAC__seekable_stream_decoder_new().
50  * - The program overrides the default settings and sets callbacks for
51  *   reading, writing, seeking, error reporting, and metadata reporting
52  *   using FLAC__seekable_stream_decoder_set_*() functions.
53  * - The program initializes the instance to validate the settings and
54  *   prepare for decoding using FLAC__seekable_stream_decoder_init().
55  * - The program calls the FLAC__seekable_stream_decoder_process_*()
56  *   functions to decode data, which subsequently calls the callbacks.
57  * - The program finishes the decoding with
58  *   FLAC__seekable_stream_decoder_finish(), which flushes the input and
59  *   output and resets the decoder to the uninitialized state.
60  * - The instance may be used again or deleted with
61  *   FLAC__seekable_stream_decoder_delete().
62  *
63  * The seekable stream decoder is a wrapper around the
64  * \link flac_stream_decoder stream decoder \endlink which also provides
65  * seeking capability.  In addition to the Read/Write/Metadata/Error
66  * callbacks of the stream decoder, the user must also provide the following:
67  *
68  * - Seek callback - This function will be called when the decoder wants to
69  *   seek to an absolute position in the stream.
70  * - Tell callback - This function will be called when the decoder wants to
71  *   know the current absolute position of the stream.
72  * - Length callback - This function will be called when the decoder wants
73  *   to know length of the stream.  The seeking algorithm currently requires
74  *   that the overall stream length be known.
75  * - EOF callback - This function will be called when the decoder wants to
76  *   know if it is at the end of the stream.  This could be synthesized from
77  *   the tell and length callbacks but it may be more expensive that way, so
78  *   there is a separate callback for it.
79  *
80  * Seeking is exposed through the
81  * FLAC__seekable_stream_decoder_seek_absolute() method.  At any point after
82  * the seekable stream decoder has been initialized, the user can call this
83  * function to seek to an exact sample within the stream.  Subsequently, the
84  * first time the write callback is called it will be passed a (possibly
85  * partial) block starting at that sample.
86  *
87  * The seekable stream decoder also provides MD5 signature checking.  If
88  * this is turned on before initialization,
89  * FLAC__seekable_stream_decoder_finish() will report when the decoded MD5
90  * signature does not match the one stored in the STREAMINFO block.  MD5
91  * checking is automatically turned off (until the next
92  * FLAC__seekable_stream_decoder_reset()) if there is no signature in the
93  * STREAMINFO block or when a seek is attempted.
94  *
95  * Make sure to read the detailed description of the
96  * \link flac_stream_decoder stream decoder module \endlink since the
97  * seekable stream decoder inherits much of its behavior.
98  *
99  * \note
100  * The "set" functions may only be called when the decoder is in the
101  * state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after
102  * FLAC__seekable_stream_decoder_new() or
103  * FLAC__seekable_stream_decoder_finish(), but before
104  * FLAC__seekable_stream_decoder_init().  If this is the case they will
105  * return \c true, otherwise \c false.
106  *
107  * \note
108  * FLAC__stream_decoder_finish() resets all settings to the constructor
109  * defaults, including the callbacks.
110  *
111  * \{
112  */
113
114
115 /** State values for a FLAC__SeekableStreamDecoder
116  *
117  *  The decoder's state can be obtained by calling FLAC__seekable_stream_decoder_get_state().
118  */
119 typedef enum {
120
121     FLAC__SEEKABLE_STREAM_DECODER_OK = 0,
122         /**< The decoder is in the normal OK state. */
123
124         FLAC__SEEKABLE_STREAM_DECODER_SEEKING,
125         /**< The decoder is in the process of seeking. */
126
127         FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM,
128         /**< The decoder has reached the end of the stream. */
129
130         FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
131         /**< An error occurred allocating memory. */
132
133         FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR,
134         /**< An error occurred in the underlying stream decoder. */
135
136         FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR,
137         /**< The read callback returned an error. */
138
139         FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR,
140         /**< An error occurred while seeking or the seek or tell
141          * callback returned an error.
142          */
143
144     FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED,
145         /**< FLAC__seekable_stream_decoder_init() was called when the
146          * decoder was already initialized, usually because
147          * FLAC__seekable_stream_decoder_finish() was not called.
148          */
149
150     FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK,
151         /**< FLAC__seekable_stream_decoder_init() was called without all
152          * callbacks being set.
153          */
154
155     FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED
156         /**< The decoder is in the uninitialized state. */
157
158 } FLAC__SeekableStreamDecoderState;
159
160 /** Maps a FLAC__SeekableStreamDecoderState to a C string.
161  *
162  *  Using a FLAC__SeekableStreamDecoderState as the index to this array
163  *  will give the string equivalent.  The contents should not be modified.
164  */
165 extern const char * const FLAC__SeekableStreamDecoderStateString[];
166
167
168 /** Return values for the FLAC__SeekableStreamDecoder read callback.
169  */
170 typedef enum {
171
172         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK,
173         /**< The read was OK and decoding can continue. */
174
175         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR
176         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
177
178 } FLAC__SeekableStreamDecoderReadStatus;
179
180 /** Maps a FLAC__SeekableStreamDecoderReadStatus to a C string.
181  *
182  *  Using a FLAC__SeekableStreamDecoderReadStatus as the index to this array
183  *  will give the string equivalent.  The contents should not be modified.
184  */
185 extern const char * const FLAC__SeekableStreamDecoderReadStatusString[];
186
187
188 /** Return values for the FLAC__SeekableStreamDecoder seek callback.
189  */
190 typedef enum {
191
192         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK,
193         /**< The seek was OK and decoding can continue. */
194
195         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR
196         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
197
198 } FLAC__SeekableStreamDecoderSeekStatus;
199
200 /** Maps a FLAC__SeekableStreamDecoderSeekStatus to a C string.
201  *
202  *  Using a FLAC__SeekableStreamDecoderSeekStatus as the index to this array
203  *  will give the string equivalent.  The contents should not be modified.
204  */
205 extern const char * const FLAC__SeekableStreamDecoderSeekStatusString[];
206
207
208 /** Return values for the FLAC__SeekableStreamDecoder tell callback.
209  */
210 typedef enum {
211
212         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK,
213         /**< The tell was OK and decoding can continue. */
214
215         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR
216         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
217
218 } FLAC__SeekableStreamDecoderTellStatus;
219
220 /** Maps a FLAC__SeekableStreamDecoderTellStatus to a C string.
221  *
222  *  Using a FLAC__SeekableStreamDecoderTellStatus as the index to this array
223  *  will give the string equivalent.  The contents should not be modified.
224  */
225 extern const char * const FLAC__SeekableStreamDecoderTellStatusString[];
226
227
228 /** Return values for the FLAC__SeekableStreamDecoder length callback.
229  */
230 typedef enum {
231
232         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK,
233         /**< The length call was OK and decoding can continue. */
234
235         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR
236         /**< An unrecoverable error occurred.  The decoder will return from the process call. */
237
238 } FLAC__SeekableStreamDecoderLengthStatus;
239
240 /** Maps a FLAC__SeekableStreamDecoderLengthStatus to a C string.
241  *
242  *  Using a FLAC__SeekableStreamDecoderLengthStatus as the index to this array
243  *  will give the string equivalent.  The contents should not be modified.
244  */
245 extern const char * const FLAC__SeekableStreamDecoderLengthStatusString[];
246
247
248 /***********************************************************************
249  *
250  * class FLAC__SeekableStreamDecoder : public FLAC__StreamDecoder
251  *
252  ***********************************************************************/
253
254 struct FLAC__SeekableStreamDecoderProtected;
255 struct FLAC__SeekableStreamDecoderPrivate;
256 /** The opaque structure definition for the seekable stream decoder type.
257  *  See the
258  *  \link flac_seekable_stream_decoder seekable stream decoder module \endlink
259  *  for a detailed description.
260  */
261 typedef struct {
262         struct FLAC__SeekableStreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
263         struct FLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
264 } FLAC__SeekableStreamDecoder;
265
266
267 /***********************************************************************
268  *
269  * Class constructor/destructor
270  *
271  ***********************************************************************/
272
273 /** Create a new seekable stream decoder instance.  The instance is created
274  *  with default settings; see the individual
275  *  FLAC__seekable_stream_decoder_set_*() functions for each setting's
276  *  default.
277  *
278  * \retval FLAC__SeekableStreamDecoder*
279  *    \c NULL if there was an error allocating memory, else the new instance.
280  */
281 FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new();
282
283 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
284  *
285  * \param decoder  A pointer to an existing decoder.
286  * \assert
287  *    \code decoder != NULL \endcode
288  */
289 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *decoder);
290
291
292 /***********************************************************************
293  *
294  * Public class method prototypes
295  *
296  ***********************************************************************/
297
298 /** Set the "MD5 signature checking" flag.  If \c true, the decoder will
299  *  compute the MD5 signature of the unencoded audio data while decoding
300  *  and compare it to the signature from the STREAMINFO block, if it
301  *  exists, during FLAC__seekable_stream_decoder_finish().
302  *
303  *  MD5 signature checking will be turned off (until the next
304  *  FLAC__seekable_stream_decoder_reset()) if there is no signature in
305  *  the STREAMINFO block or when a seek is attempted.
306  *
307  * \default \c false
308  * \param  decoder  A decoder instance to set.
309  * \param  value    Flag value (see above).
310  * \assert
311  *    \code decoder != NULL \endcode
312  * \retval FLAC__bool
313  *    \c false if the decoder is already initialized, else \c true.
314  */
315 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
316
317 /** Set the read callback.
318  *  This is inherited from FLAC__StreamDecoder; see
319  *  FLAC__stream_decoder_set_read_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 FLAC__bool FLAC__seekable_stream_decoder_set_read_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderReadStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data));
334
335 /** Set the seek callback.
336  *  The supplied function will be called when the decoder needs to seek
337  *  the input stream.  The decoder will pass the absolute byte offset
338  *  to seek to, 0 meaning the beginning of the stream.
339  *
340  * \note
341  * The callback is mandatory and must be set before initialization.
342  *
343  * \default \c NULL
344  * \param  decoder  An decoder instance to set.
345  * \param  value    See above.
346  * \assert
347  *    \code decoder != NULL \endcode
348  *    \code value != NULL \endcode
349  * \retval FLAC__bool
350  *    \c false if the decoder is already initialized, else \c true.
351  */
352 FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderSeekStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data));
353
354 /** Set the tell callback.
355  *  The supplied function will be called when the decoder wants to know
356  *  the current position of the stream.  The callback should return the
357  *  byte offset from the beginning of the stream.
358  *
359  * \note
360  * The callback is mandatory and must be set before initialization.
361  *
362  * \default \c NULL
363  * \param  decoder  An decoder instance to set.
364  * \param  value    See above.
365  * \assert
366  *    \code decoder != NULL \endcode
367  *    \code value != NULL \endcode
368  * \retval FLAC__bool
369  *    \c false if the decoder is already initialized, else \c true.
370  */
371 FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderTellStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data));
372
373 /** Set the length callback.
374  *  The supplied function will be called when the decoder wants to know
375  *  the total length of the stream in bytes.
376  *
377  * \note
378  * The callback is mandatory and must be set before initialization.
379  *
380  * \default \c NULL
381  * \param  decoder  An decoder instance to set.
382  * \param  value    See above.
383  * \assert
384  *    \code decoder != NULL \endcode
385  *    \code value != NULL \endcode
386  * \retval FLAC__bool
387  *    \c false if the decoder is already initialized, else \c true.
388  */
389 FLAC__bool FLAC__seekable_stream_decoder_set_length_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderLengthStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data));
390
391 /** Set the eof callback.
392  *  The supplied function will be called when the decoder needs to know
393  *  if the end of the stream has been reached.
394  *
395  * \note
396  * The callback is mandatory and must be set before initialization.
397  *
398  * \default \c NULL
399  * \param  decoder  An decoder instance to set.
400  * \param  value    See above.
401  * \assert
402  *    \code decoder != NULL \endcode
403  *    \code value != NULL \endcode
404  * \retval FLAC__bool
405  *    \c false if the decoder is already initialized, else \c true.
406  */
407 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__bool (*value)(const FLAC__SeekableStreamDecoder *decoder, void *client_data));
408
409 /** Set the write callback.
410  *  This is inherited from FLAC__StreamDecoder; see
411  *  FLAC__stream_decoder_set_write_callback().
412  *
413  * \note
414  * The callback is mandatory and must be set before initialization.
415  *
416  * \default \c NULL
417  * \param  decoder  A decoder instance to set.
418  * \param  value    See above.
419  * \assert
420  *    \code decoder != NULL \endcode
421  *    \code value != NULL \endcode
422  * \retval FLAC__bool
423  *    \c false if the decoder is already initialized, else \c true.
424  */
425 FLAC__bool FLAC__seekable_stream_decoder_set_write_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderWriteStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data));
426
427 /** Set the metadata callback.
428  *  This is inherited from FLAC__StreamDecoder; see
429  *  FLAC__stream_decoder_set_metadata_callback().
430  *
431  * \note
432  * The callback is mandatory and must be set before initialization.
433  *
434  * \default \c NULL
435  * \param  decoder  A decoder instance to set.
436  * \param  value    See above.
437  * \assert
438  *    \code decoder != NULL \endcode
439  *    \code value != NULL \endcode
440  * \retval FLAC__bool
441  *    \c false if the decoder is already initialized, else \c true.
442  */
443 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback(FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data));
444
445 /** Set the error callback.
446  *  This is inherited from FLAC__StreamDecoder; see
447  *  FLAC__stream_decoder_set_error_callback().
448  *
449  * \note
450  * The callback is mandatory and must be set before initialization.
451  *
452  * \default \c NULL
453  * \param  decoder  A decoder instance to set.
454  * \param  value    See above.
455  * \assert
456  *    \code decoder != NULL \endcode
457  *    \code value != NULL \endcode
458  * \retval FLAC__bool
459  *    \c false if the decoder is already initialized, else \c true.
460  */
461 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
462
463 /** Set the client data to be passed back to callbacks.
464  *  This value will be supplied to callbacks in their \a client_data
465  *  argument.
466  *
467  * \default \c NULL
468  * \param  decoder  An decoder instance to set.
469  * \param  value    See above.
470  * \assert
471  *    \code decoder != NULL \endcode
472  * \retval FLAC__bool
473  *    \c false if the decoder is already initialized, else \c true.
474  */
475 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value);
476
477 /** This is inherited from FLAC__StreamDecoder; see
478  *  FLAC__stream_decoder_set_metadata_respond().
479  *
480  * \default By default, only the \c STREAMINFO block is returned via the
481  *          metadata callback.
482  * \param  decoder  A decoder instance to set.
483  * \param  type     See above.
484  * \assert
485  *    \code decoder != NULL \endcode
486  *    \a type is valid
487  * \retval FLAC__bool
488  *    \c false if the decoder is already initialized, else \c true.
489  */
490 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
491
492 /** This is inherited from FLAC__StreamDecoder; see
493  *  FLAC__stream_decoder_set_metadata_respond_application().
494  *
495  * \default By default, only the \c STREAMINFO block is returned via the
496  *          metadata callback.
497  * \param  decoder  A decoder instance to set.
498  * \param  id       See above.
499  * \assert
500  *    \code decoder != NULL \endcode
501  *    \code id != NULL \endcode
502  * \retval FLAC__bool
503  *    \c false if the decoder is already initialized, else \c true.
504  */
505 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
506
507 /** This is inherited from FLAC__StreamDecoder; see
508  *  FLAC__stream_decoder_set_metadata_respond_all().
509  *
510  * \default By default, only the \c STREAMINFO block is returned via the
511  *          metadata callback.
512  * \param  decoder  A decoder instance to set.
513  * \assert
514  *    \code decoder != NULL \endcode
515  * \retval FLAC__bool
516  *    \c false if the decoder is already initialized, else \c true.
517  */
518 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder);
519
520 /** This is inherited from FLAC__StreamDecoder; see
521  *  FLAC__stream_decoder_set_metadata_ignore().
522  *
523  * \default By default, only the \c STREAMINFO block is returned via the
524  *          metadata callback.
525  * \param  decoder  A decoder instance to set.
526  * \param  type     See above.
527  * \assert
528  *    \code decoder != NULL \endcode
529  *    \a type is valid
530  * \retval FLAC__bool
531  *    \c false if the decoder is already initialized, else \c true.
532  */
533 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
534
535 /** This is inherited from FLAC__StreamDecoder; see
536  *  FLAC__stream_decoder_set_metadata_ignore_application().
537  *
538  * \default By default, only the \c STREAMINFO block is returned via the
539  *          metadata callback.
540  * \param  decoder  A decoder instance to set.
541  * \param  id       See above.
542  * \assert
543  *    \code decoder != NULL \endcode
544  *    \code id != NULL \endcode
545  * \retval FLAC__bool
546  *    \c false if the decoder is already initialized, else \c true.
547  */
548 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
549
550 /** This is inherited from FLAC__StreamDecoder; see
551  *  FLAC__stream_decoder_set_metadata_ignore_all().
552  *
553  * \default By default, only the \c STREAMINFO block is returned via the
554  *          metadata callback.
555  * \param  decoder  A decoder instance to set.
556  * \assert
557  *    \code decoder != NULL \endcode
558  * \retval FLAC__bool
559  *    \c false if the decoder is already initialized, else \c true.
560  */
561 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder);
562
563 /** Get the current decoder state.
564  *
565  * \param  decoder  A decoder instance to query.
566  * \assert
567  *    \code decoder != NULL \endcode
568  * \retval FLAC__SeekableStreamDecoderState
569  *    The current decoder state.
570  */
571 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder);
572
573 /** Get the "MD5 signature checking" flag.
574  *  This is the value of the setting, not whether or not the decoder is
575  *  currently checking the MD5 (remember, it can be turned off automatically
576  *  by a seek).  When the decoder is reset the flag will be restored to the
577  *  value returned by this function.
578  *
579  * \param  decoder  A decoder instance to query.
580  * \assert
581  *    \code decoder != NULL \endcode
582  * \retval FLAC__bool
583  *    See above.
584  */
585 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder);
586
587 /** This is inherited from FLAC__StreamDecoder; see
588  *  FLAC__stream_decoder_get_channels().
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__seekable_stream_decoder_get_channels(const FLAC__SeekableStreamDecoder *decoder);
597
598 /** This is inherited from FLAC__StreamDecoder; see
599  *  FLAC__stream_decoder_get_channel_assignment().
600  *
601  * \param  decoder  A decoder instance to query.
602  * \assert
603  *    \code decoder != NULL \endcode
604  * \retval FLAC__ChannelAssignment
605  *    See above.
606  */
607 FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder);
608
609 /** This is inherited from FLAC__StreamDecoder; see
610  *  FLAC__stream_decoder_get_bits_per_sample().
611  *
612  * \param  decoder  A decoder instance to query.
613  * \assert
614  *    \code decoder != NULL \endcode
615  * \retval unsigned
616  *    See above.
617  */
618 unsigned FLAC__seekable_stream_decoder_get_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder);
619
620 /** This is inherited from FLAC__StreamDecoder; see
621  *  FLAC__stream_decoder_get_sample_rate().
622  *
623  * \param  decoder  A decoder instance to query.
624  * \assert
625  *    \code decoder != NULL \endcode
626  * \retval unsigned
627  *    See above.
628  */
629 unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder);
630
631 /** This is inherited from FLAC__StreamDecoder; see
632  *  FLAC__stream_decoder_get_blocksize().
633  *
634  * \param  decoder  A decoder instance to query.
635  * \assert
636  *    \code decoder != NULL \endcode
637  * \retval unsigned
638  *    See above.
639  */
640 unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder);
641
642 /** Initialize the decoder instance.
643  *  Should be called after FLAC__seekable_stream_decoder_new() and
644  *  FLAC__seekable_stream_decoder_set_*() but before any of the
645  *  FLAC__seekable_stream_decoder_process_*() functions.  Will set and return
646  *  the decoder state, which will be FLAC__SEEKABLE_STREAM_DECODER_OK
647  *  if initialization succeeded.
648  *
649  * \param  decoder  An uninitialized decoder instance.
650  * \assert
651  *    \code decoder != NULL \endcode
652  * \retval FLAC__SeekableStreamDecoderState
653  *    \c FLAC__SEEKABLE_STREAM_DECODER_OK if initialization was
654  *    successful; see FLAC__SeekableStreamDecoderState for the meanings
655  *    of other return values.
656  */
657 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder);
658
659 /** Finish the decoding process.
660  *  Flushes the decoding buffer, releases resources, resets the decoder
661  *  settings to their defaults, and returns the decoder state to
662  *  FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.
663  *
664  *  In the event of a prematurely-terminated decode, it is not strictly
665  *  necessary to call this immediately before
666  *  FLAC__seekable_stream_decoder_delete() but it is good practice to match
667  *  every FLAC__seekable_stream_decoder_init() with a
668  *  FLAC__seekable_stream_decoder_finish().
669  *
670  * \param  decoder  An uninitialized decoder instance.
671  * \assert
672  *    \code decoder != NULL \endcode
673  * \retval FLAC__bool
674  *    \c false if MD5 checking is on AND a STREAMINFO block was available
675  *    AND the MD5 signature in the STREAMINFO block was non-zero AND the
676  *    signature does not match the one computed by the decoder; else
677  *    \c true.
678  */
679 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder);
680
681 /** Flush the stream input.
682  *  The decoder's input buffer will be cleared and the state set to
683  *  \c FLAC__SEEKABLE_STREAM_DECODER_OK.  This will also turn off MD5
684  *  checking.
685  *
686  * \param  decoder  A decoder instance.
687  * \assert
688  *    \code decoder != NULL \endcode
689  * \retval FLAC__bool
690  *    \c true if successful, else \c false if a memory allocation
691  *    or stream decoder error occurs.
692  */
693 FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder);
694
695 /** Reset the decoding process.
696  *  The decoder's input buffer will be cleared and the state set to
697  *  \c FLAC__SEEKABLE_STREAM_DECODER_OK.  This is similar to
698  *  FLAC__seekable_stream_decoder_finish() except that the settings are
699  *  preserved; there is no need to call FLAC__seekable_stream_decoder_init()
700  *  before decoding again.  MD5 checking will be restored to its original
701  *  setting.
702  *
703  * \param  decoder  A decoder instance.
704  * \assert
705  *    \code decoder != NULL \endcode
706  * \retval FLAC__bool
707  *    \c true if successful, else \c false if a memory allocation
708  *    or stream decoder error occurs.
709  */
710 FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder);
711
712 /** This is inherited from FLAC__StreamDecoder; see
713  *  FLAC__stream_decoder_process_whole_stream().
714  *
715  * \param  decoder  A decoder instance.
716  * \assert
717  *    \code decoder != NULL \endcode
718  * \retval FLAC__bool
719  *    See above.
720  */
721 FLAC__bool FLAC__seekable_stream_decoder_process_whole_stream(FLAC__SeekableStreamDecoder *decoder);
722
723 /** This is inherited from FLAC__StreamDecoder; see
724  *  FLAC__stream_decoder_process_metadata().
725  *
726  * \param  decoder  A decoder instance.
727  * \assert
728  *    \code decoder != NULL \endcode
729  * \retval FLAC__bool
730  *    See above.
731  */
732 FLAC__bool FLAC__seekable_stream_decoder_process_metadata(FLAC__SeekableStreamDecoder *decoder);
733
734 /** This is inherited from FLAC__StreamDecoder; see
735  *  FLAC__stream_decoder_process_one_frame().
736  *
737  * \param  decoder  A decoder instance.
738  * \assert
739  *    \code decoder != NULL \endcode
740  * \retval FLAC__bool
741  *    See above.
742  */
743 FLAC__bool FLAC__seekable_stream_decoder_process_one_frame(FLAC__SeekableStreamDecoder *decoder);
744
745 /** This is inherited from FLAC__StreamDecoder; see
746  *  FLAC__stream_decoder_process_remaining_frames().
747  *
748  * \param  decoder  A decoder instance.
749  * \assert
750  *    \code decoder != NULL \endcode
751  * \retval FLAC__bool
752  *    See above.
753  */
754 FLAC__bool FLAC__seekable_stream_decoder_process_remaining_frames(FLAC__SeekableStreamDecoder *decoder);
755
756 /** Flush the input and seek to an absolute sample.
757  *  Decoding will resume at the given sample.  Note that because of
758  *  this, the next write callback may contain a partial block.
759  *
760  * \param  decoder  A decoder instance.
761  * \param  sample   The target sample number to seek to.
762  * \assert
763  *    \code decoder != NULL \endcode
764  * \retval FLAC__bool
765  *    \c true if successful, else \c false.
766  */
767 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
768
769 /* \} */
770
771 #ifdef __cplusplus
772 }
773 #endif
774
775 #endif