1b6f17fe3e3c9fe304333cd020f95014fb2046df
[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 /*@@@ document */
267 typedef FLAC__SeekableStreamDecoderReadStatus (*FLAC__SeekableStreamDecoderReadCallback)(const FLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
268 typedef FLAC__SeekableStreamDecoderSeekStatus (*FLAC__SeekableStreamDecoderSeekCallback)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
269 typedef FLAC__SeekableStreamDecoderTellStatus (*FLAC__SeekableStreamDecoderTellCallback)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
270 typedef FLAC__SeekableStreamDecoderLengthStatus (*FLAC__SeekableStreamDecoderLengthCallback)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
271 typedef FLAC__bool (*FLAC__SeekableStreamDecoderEofCallback)(const FLAC__SeekableStreamDecoder *decoder, void *client_data);
272 typedef FLAC__StreamDecoderWriteStatus (*FLAC__SeekableStreamDecoderWriteCallback)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
273 typedef void (*FLAC__SeekableStreamDecoderMetadataCallback)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
274 typedef void (*FLAC__SeekableStreamDecoderErrorCallback)(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
275
276
277 /***********************************************************************
278  *
279  * Class constructor/destructor
280  *
281  ***********************************************************************/
282
283 /** Create a new seekable stream decoder instance.  The instance is created
284  *  with default settings; see the individual
285  *  FLAC__seekable_stream_decoder_set_*() functions for each setting's
286  *  default.
287  *
288  * \retval FLAC__SeekableStreamDecoder*
289  *    \c NULL if there was an error allocating memory, else the new instance.
290  */
291 FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new();
292
293 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
294  *
295  * \param decoder  A pointer to an existing decoder.
296  * \assert
297  *    \code decoder != NULL \endcode
298  */
299 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *decoder);
300
301
302 /***********************************************************************
303  *
304  * Public class method prototypes
305  *
306  ***********************************************************************/
307
308 /** Set the "MD5 signature checking" flag.  If \c true, the decoder will
309  *  compute the MD5 signature of the unencoded audio data while decoding
310  *  and compare it to the signature from the STREAMINFO block, if it
311  *  exists, during FLAC__seekable_stream_decoder_finish().
312  *
313  *  MD5 signature checking will be turned off (until the next
314  *  FLAC__seekable_stream_decoder_reset()) if there is no signature in
315  *  the STREAMINFO block or when a seek is attempted.
316  *
317  * \default \c false
318  * \param  decoder  A decoder instance to set.
319  * \param  value    Flag value (see above).
320  * \assert
321  *    \code decoder != NULL \endcode
322  * \retval FLAC__bool
323  *    \c false if the decoder is already initialized, else \c true.
324  */
325 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
326
327 /** Set the read callback.
328  *  This is inherited from FLAC__StreamDecoder; see
329  *  FLAC__stream_decoder_set_read_callback().
330  *
331  * \note
332  * The callback is mandatory and must be set before initialization.
333  *
334  * \default \c NULL
335  * \param  decoder  A decoder instance to set.
336  * \param  value    See above.
337  * \assert
338  *    \code decoder != NULL \endcode
339  *    \code value != NULL \endcode
340  * \retval FLAC__bool
341  *    \c false if the decoder is already initialized, else \c true.
342  */
343 FLAC__bool FLAC__seekable_stream_decoder_set_read_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderReadCallback value);
344
345 /** Set the seek callback.
346  *  The supplied function will be called when the decoder needs to seek
347  *  the input stream.  The decoder will pass the absolute byte offset
348  *  to seek to, 0 meaning the beginning of the stream.
349  *
350  * \note
351  * The callback is mandatory and must be set before initialization.
352  *
353  * \default \c NULL
354  * \param  decoder  An decoder instance to set.
355  * \param  value    See above.
356  * \assert
357  *    \code decoder != NULL \endcode
358  *    \code value != NULL \endcode
359  * \retval FLAC__bool
360  *    \c false if the decoder is already initialized, else \c true.
361  */
362 FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderSeekCallback value);
363
364 /** Set the tell callback.
365  *  The supplied function will be called when the decoder wants to know
366  *  the current position of the stream.  The callback should return the
367  *  byte offset from the beginning of the stream.
368  *
369  * \note
370  * The callback is mandatory and must be set before initialization.
371  *
372  * \default \c NULL
373  * \param  decoder  An decoder instance to set.
374  * \param  value    See above.
375  * \assert
376  *    \code decoder != NULL \endcode
377  *    \code value != NULL \endcode
378  * \retval FLAC__bool
379  *    \c false if the decoder is already initialized, else \c true.
380  */
381 FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderTellCallback value);
382
383 /** Set the length callback.
384  *  The supplied function will be called when the decoder wants to know
385  *  the total length of the stream in bytes.
386  *
387  * \note
388  * The callback is mandatory and must be set before initialization.
389  *
390  * \default \c NULL
391  * \param  decoder  An decoder instance to set.
392  * \param  value    See above.
393  * \assert
394  *    \code decoder != NULL \endcode
395  *    \code value != NULL \endcode
396  * \retval FLAC__bool
397  *    \c false if the decoder is already initialized, else \c true.
398  */
399 FLAC__bool FLAC__seekable_stream_decoder_set_length_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderLengthCallback value);
400
401 /** Set the eof callback.
402  *  The supplied function will be called when the decoder needs to know
403  *  if the end of the stream has been reached.
404  *
405  * \note
406  * The callback is mandatory and must be set before initialization.
407  *
408  * \default \c NULL
409  * \param  decoder  An decoder instance to set.
410  * \param  value    See above.
411  * \assert
412  *    \code decoder != NULL \endcode
413  *    \code value != NULL \endcode
414  * \retval FLAC__bool
415  *    \c false if the decoder is already initialized, else \c true.
416  */
417 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderEofCallback value);
418
419 /** Set the write callback.
420  *  This is inherited from FLAC__StreamDecoder; see
421  *  FLAC__stream_decoder_set_write_callback().
422  *
423  * \note
424  * The callback is mandatory and must be set before initialization.
425  *
426  * \default \c NULL
427  * \param  decoder  A decoder instance to set.
428  * \param  value    See above.
429  * \assert
430  *    \code decoder != NULL \endcode
431  *    \code value != NULL \endcode
432  * \retval FLAC__bool
433  *    \c false if the decoder is already initialized, else \c true.
434  */
435 FLAC__bool FLAC__seekable_stream_decoder_set_write_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderWriteCallback value);
436
437 /** Set the metadata callback.
438  *  This is inherited from FLAC__StreamDecoder; see
439  *  FLAC__stream_decoder_set_metadata_callback().
440  *
441  * \note
442  * The callback is mandatory and must be set before initialization.
443  *
444  * \default \c NULL
445  * \param  decoder  A decoder instance to set.
446  * \param  value    See above.
447  * \assert
448  *    \code decoder != NULL \endcode
449  *    \code value != NULL \endcode
450  * \retval FLAC__bool
451  *    \c false if the decoder is already initialized, else \c true.
452  */
453 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderMetadataCallback value);
454
455 /** Set the error callback.
456  *  This is inherited from FLAC__StreamDecoder; see
457  *  FLAC__stream_decoder_set_error_callback().
458  *
459  * \note
460  * The callback is mandatory and must be set before initialization.
461  *
462  * \default \c NULL
463  * \param  decoder  A decoder instance to set.
464  * \param  value    See above.
465  * \assert
466  *    \code decoder != NULL \endcode
467  *    \code value != NULL \endcode
468  * \retval FLAC__bool
469  *    \c false if the decoder is already initialized, else \c true.
470  */
471 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderErrorCallback value);
472
473 /** Set the client data to be passed back to callbacks.
474  *  This value will be supplied to callbacks in their \a client_data
475  *  argument.
476  *
477  * \default \c NULL
478  * \param  decoder  An decoder instance to set.
479  * \param  value    See above.
480  * \assert
481  *    \code decoder != NULL \endcode
482  * \retval FLAC__bool
483  *    \c false if the decoder is already initialized, else \c true.
484  */
485 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value);
486
487 /** This is inherited from FLAC__StreamDecoder; see
488  *  FLAC__stream_decoder_set_metadata_respond().
489  *
490  * \default By default, only the \c STREAMINFO block is returned via the
491  *          metadata callback.
492  * \param  decoder  A decoder instance to set.
493  * \param  type     See above.
494  * \assert
495  *    \code decoder != NULL \endcode
496  *    \a type is valid
497  * \retval FLAC__bool
498  *    \c false if the decoder is already initialized, else \c true.
499  */
500 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
501
502 /** This is inherited from FLAC__StreamDecoder; see
503  *  FLAC__stream_decoder_set_metadata_respond_application().
504  *
505  * \default By default, only the \c STREAMINFO block is returned via the
506  *          metadata callback.
507  * \param  decoder  A decoder instance to set.
508  * \param  id       See above.
509  * \assert
510  *    \code decoder != NULL \endcode
511  *    \code id != NULL \endcode
512  * \retval FLAC__bool
513  *    \c false if the decoder is already initialized, else \c true.
514  */
515 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
516
517 /** This is inherited from FLAC__StreamDecoder; see
518  *  FLAC__stream_decoder_set_metadata_respond_all().
519  *
520  * \default By default, only the \c STREAMINFO block is returned via the
521  *          metadata callback.
522  * \param  decoder  A decoder instance to set.
523  * \assert
524  *    \code decoder != NULL \endcode
525  * \retval FLAC__bool
526  *    \c false if the decoder is already initialized, else \c true.
527  */
528 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder);
529
530 /** This is inherited from FLAC__StreamDecoder; see
531  *  FLAC__stream_decoder_set_metadata_ignore().
532  *
533  * \default By default, only the \c STREAMINFO block is returned via the
534  *          metadata callback.
535  * \param  decoder  A decoder instance to set.
536  * \param  type     See above.
537  * \assert
538  *    \code decoder != NULL \endcode
539  *    \a type is valid
540  * \retval FLAC__bool
541  *    \c false if the decoder is already initialized, else \c true.
542  */
543 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
544
545 /** This is inherited from FLAC__StreamDecoder; see
546  *  FLAC__stream_decoder_set_metadata_ignore_application().
547  *
548  * \default By default, only the \c STREAMINFO block is returned via the
549  *          metadata callback.
550  * \param  decoder  A decoder instance to set.
551  * \param  id       See above.
552  * \assert
553  *    \code decoder != NULL \endcode
554  *    \code id != NULL \endcode
555  * \retval FLAC__bool
556  *    \c false if the decoder is already initialized, else \c true.
557  */
558 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
559
560 /** This is inherited from FLAC__StreamDecoder; see
561  *  FLAC__stream_decoder_set_metadata_ignore_all().
562  *
563  * \default By default, only the \c STREAMINFO block is returned via the
564  *          metadata callback.
565  * \param  decoder  A decoder instance to set.
566  * \assert
567  *    \code decoder != NULL \endcode
568  * \retval FLAC__bool
569  *    \c false if the decoder is already initialized, else \c true.
570  */
571 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder);
572
573 /** Get the current decoder state.
574  *
575  * \param  decoder  A decoder instance to query.
576  * \assert
577  *    \code decoder != NULL \endcode
578  * \retval FLAC__SeekableStreamDecoderState
579  *    The current decoder state.
580  */
581 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder);
582
583 /** Get the state of the underlying stream decoder.
584  *  Useful when the seekable stream decoder state is
585  *  \c FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR.
586  *
587  * \param  decoder  An decoder instance to query.
588  * \assert
589  *    \code decoder != NULL \endcode
590  * \retval FLAC__StreamDecoderState
591  *    The stream decoder state.
592  */
593 FLAC__StreamDecoderState FLAC__seekable_stream_decoder_get_stream_decoder_state(const FLAC__SeekableStreamDecoder *decoder);
594
595 /** Get the "MD5 signature checking" flag.
596  *  This is the value of the setting, not whether or not the decoder is
597  *  currently checking the MD5 (remember, it can be turned off automatically
598  *  by a seek).  When the decoder is reset the flag will be restored to the
599  *  value returned by this function.
600  *
601  * \param  decoder  A decoder instance to query.
602  * \assert
603  *    \code decoder != NULL \endcode
604  * \retval FLAC__bool
605  *    See above.
606  */
607 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder);
608
609 /** This is inherited from FLAC__StreamDecoder; see
610  *  FLAC__stream_decoder_get_channels().
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_channels(const FLAC__SeekableStreamDecoder *decoder);
619
620 /** This is inherited from FLAC__StreamDecoder; see
621  *  FLAC__stream_decoder_get_channel_assignment().
622  *
623  * \param  decoder  A decoder instance to query.
624  * \assert
625  *    \code decoder != NULL \endcode
626  * \retval FLAC__ChannelAssignment
627  *    See above.
628  */
629 FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder);
630
631 /** This is inherited from FLAC__StreamDecoder; see
632  *  FLAC__stream_decoder_get_bits_per_sample().
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_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder);
641
642 /** This is inherited from FLAC__StreamDecoder; see
643  *  FLAC__stream_decoder_get_sample_rate().
644  *
645  * \param  decoder  A decoder instance to query.
646  * \assert
647  *    \code decoder != NULL \endcode
648  * \retval unsigned
649  *    See above.
650  */
651 unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder);
652
653 /** This is inherited from FLAC__StreamDecoder; see
654  *  FLAC__stream_decoder_get_blocksize().
655  *
656  * \param  decoder  A decoder instance to query.
657  * \assert
658  *    \code decoder != NULL \endcode
659  * \retval unsigned
660  *    See above.
661  */
662 unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder);
663
664 /** Initialize the decoder instance.
665  *  Should be called after FLAC__seekable_stream_decoder_new() and
666  *  FLAC__seekable_stream_decoder_set_*() but before any of the
667  *  FLAC__seekable_stream_decoder_process_*() functions.  Will set and return
668  *  the decoder state, which will be FLAC__SEEKABLE_STREAM_DECODER_OK
669  *  if initialization succeeded.
670  *
671  * \param  decoder  An uninitialized decoder instance.
672  * \assert
673  *    \code decoder != NULL \endcode
674  * \retval FLAC__SeekableStreamDecoderState
675  *    \c FLAC__SEEKABLE_STREAM_DECODER_OK if initialization was
676  *    successful; see FLAC__SeekableStreamDecoderState for the meanings
677  *    of other return values.
678  */
679 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder);
680
681 /** Finish the decoding process.
682  *  Flushes the decoding buffer, releases resources, resets the decoder
683  *  settings to their defaults, and returns the decoder state to
684  *  FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.
685  *
686  *  In the event of a prematurely-terminated decode, it is not strictly
687  *  necessary to call this immediately before
688  *  FLAC__seekable_stream_decoder_delete() but it is good practice to match
689  *  every FLAC__seekable_stream_decoder_init() with a
690  *  FLAC__seekable_stream_decoder_finish().
691  *
692  * \param  decoder  An uninitialized decoder instance.
693  * \assert
694  *    \code decoder != NULL \endcode
695  * \retval FLAC__bool
696  *    \c false if MD5 checking is on AND a STREAMINFO block was available
697  *    AND the MD5 signature in the STREAMINFO block was non-zero AND the
698  *    signature does not match the one computed by the decoder; else
699  *    \c true.
700  */
701 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder);
702
703 /** Flush the stream input.
704  *  The decoder's input buffer will be cleared and the state set to
705  *  \c FLAC__SEEKABLE_STREAM_DECODER_OK.  This will also turn off MD5
706  *  checking.
707  *
708  * \param  decoder  A decoder instance.
709  * \assert
710  *    \code decoder != NULL \endcode
711  * \retval FLAC__bool
712  *    \c true if successful, else \c false if a memory allocation
713  *    or stream decoder error occurs.
714  */
715 FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder);
716
717 /** Reset the decoding process.
718  *  The decoder's input buffer will be cleared and the state set to
719  *  \c FLAC__SEEKABLE_STREAM_DECODER_OK.  This is similar to
720  *  FLAC__seekable_stream_decoder_finish() except that the settings are
721  *  preserved; there is no need to call FLAC__seekable_stream_decoder_init()
722  *  before decoding again.  MD5 checking will be restored to its original
723  *  setting.
724  *
725  * \param  decoder  A decoder instance.
726  * \assert
727  *    \code decoder != NULL \endcode
728  * \retval FLAC__bool
729  *    \c true if successful, else \c false if a memory allocation
730  *    or stream decoder error occurs.
731  */
732 FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder);
733
734 /** This is inherited from FLAC__StreamDecoder; see
735  *  FLAC__stream_decoder_process_single().
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_single(FLAC__SeekableStreamDecoder *decoder);
744
745 /** This is inherited from FLAC__StreamDecoder; see
746  *  FLAC__stream_decoder_process_until_end_of_metadata().
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_until_end_of_metadata(FLAC__SeekableStreamDecoder *decoder);
755
756 /** This is inherited from FLAC__StreamDecoder; see
757  *  FLAC__stream_decoder_process_until_end_of_stream().
758  *
759  * \param  decoder  A decoder instance.
760  * \assert
761  *    \code decoder != NULL \endcode
762  * \retval FLAC__bool
763  *    See above.
764  */
765 FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_stream(FLAC__SeekableStreamDecoder *decoder);
766
767 /** Flush the input and seek to an absolute sample.
768  *  Decoding will resume at the given sample.  Note that because of
769  *  this, the next write callback may contain a partial block.
770  *
771  * \param  decoder  A decoder instance.
772  * \param  sample   The target sample number to seek to.
773  * \assert
774  *    \code decoder != NULL \endcode
775  * \retval FLAC__bool
776  *    \c true if successful, else \c false.
777  */
778 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
779
780 /* \} */
781
782 #ifdef __cplusplus
783 }
784 #endif
785
786 #endif