more work
[flac.git] / include / OggFLAC / stream_decoder.h
1 /* libOggFLAC - Free Lossless Audio Codec + Ogg library
2  * Copyright (C) 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 OggFLAC__STREAM_DECODER_H
21 #define OggFLAC__STREAM_DECODER_H
22
23 #include "FLAC/stream_decoder.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29
30 /** \file include/OggFLAC/stream_decoder.h
31  *
32  *  \brief
33  *  This module contains the functions which implement the stream
34  *  decoder.
35  *
36  *  See the detailed documentation in the
37  *  \link oggflac_stream_decoder stream decoder \endlink module.
38  */
39
40 /** \defgroup oggflac_decoder OggFLAC/ *_decoder.h: decoder interfaces
41  *  \ingroup oggflac
42  *
43  *  \brief
44  *  This module describes the three decoder layers provided by libOggFLAC.
45  *
46  * libOggFLAC provides the same three layers of access as libFLAC and the
47  * interface is identical.  See the \link flac_decoder FLAC decoder module
48  * \endlink for full documentation.
49  */
50
51 /** \defgroup oggflac_stream_decoder OggFLAC/stream_decoder.h: stream decoder interface
52  *  \ingroup oggflac_decoder
53  *
54  *  \brief
55  *  This module contains the functions which implement the stream
56  *  decoder.
57  *
58  * The interface here is identical to FLAC's stream decoder.  See the
59  * defaults, including the callbacks.  See the \link flac_stream_decoder
60  * FLAC stream decoder module \endlink for full documentation.
61  *
62  * \{
63  */
64
65
66 /** State values for an OggFLAC__StreamDecoder
67  *
68  *  The decoder's state can be obtained by calling OggFLAC__stream_decoder_get_state().
69  */
70 typedef enum {
71
72         OggFLAC__STREAM_DECODER_OK = 0,
73         /**< The decoder is in the normal OK state. */
74
75         OggFLAC__STREAM_ENCODER_OGG_ERROR,
76         /**< An error occurred in the underlying Ogg layer.  */
77
78         OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR,
79         /**< An error occurred in the underlying FLAC stream decoder;
80          * check OggFLAC__stream_decoder_get_FLAC_stream_decoder_state().
81          */
82
83         OggFLAC__STREAM_DECODER_INVALID_CALLBACK,
84         /**< The decoder was initialized before setting all the required callbacks. */
85
86         OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
87         /**< Memory allocation failed. */
88
89         OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED,
90         /**< OggFLAC__stream_decoder_init() was called when the decoder was
91          * already initialized, usually because
92          * OggFLAC__stream_decoder_finish() was not called.
93          */
94
95         OggFLAC__STREAM_DECODER_UNINITIALIZED
96         /**< The decoder is in the uninitialized state. */
97
98 } OggFLAC__StreamDecoderState;
99
100 /** Maps an OggFLAC__StreamDecoderState to a C string.
101  *
102  *  Using an OggFLAC__StreamDecoderState as the index to this array
103  *  will give the string equivalent.  The contents should not be modified.
104  */
105 extern const char * const OggFLAC__StreamDecoderStateString[];
106
107
108 /***********************************************************************
109  *
110  * class OggFLAC__StreamDecoder
111  *
112  ***********************************************************************/
113
114 struct OggFLAC__StreamDecoderProtected;
115 struct OggFLAC__StreamDecoderPrivate;
116 /** The opaque structure definition for the stream decoder type.
117  *  See the \link oggflac_stream_decoder stream decoder module \endlink
118  *  for a detailed description.
119  */
120 typedef struct {
121         struct OggFLAC__StreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
122         struct OggFLAC__StreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
123 } OggFLAC__StreamDecoder;
124
125 typedef FLAC__StreamDecoderReadStatus (*OggFLAC__StreamDecoderReadCallback)(const OggFLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
126 typedef FLAC__StreamDecoderWriteStatus (*OggFLAC__StreamDecoderWriteCallback)(const OggFLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
127 typedef void (*OggFLAC__StreamDecoderMetadataCallback)(const OggFLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
128 typedef void (*OggFLAC__StreamDecoderErrorCallback)(const OggFLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
129
130
131 /***********************************************************************
132  *
133  * Class constructor/destructor
134  *
135  ***********************************************************************/
136
137 /** Create a new stream decoder instance.  The instance is created with
138  *  default settings; see the individual OggFLAC__stream_decoder_set_*()
139  *  functions for each setting's default.
140  *
141  * \retval OggFLAC__StreamDecoder*
142  *    \c NULL if there was an error allocating memory, else the new instance.
143  */
144 OggFLAC__StreamDecoder *OggFLAC__stream_decoder_new();
145
146 /** Free a decoder instance.  Deletes the object pointed to by \a decoder.
147  *
148  * \param decoder  A pointer to an existing decoder.
149  * \assert
150  *    \code decoder != NULL \endcode
151  */
152 void OggFLAC__stream_decoder_delete(OggFLAC__StreamDecoder *decoder);
153
154
155 /***********************************************************************
156  *
157  * Public class method prototypes
158  *
159  ***********************************************************************/
160
161 /** Set the read callback.
162  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_read_callback()
163  *
164  * \note
165  * The callback is mandatory and must be set before initialization.
166  *
167  * \default \c NULL
168  * \param  decoder  An decoder instance to set.
169  * \param  value    See above.
170  * \assert
171  *    \code decoder != NULL \endcode
172  *    \code value != NULL \endcode
173  * \retval FLAC__bool
174  *    \c false if the decoder is already initialized, else \c true.
175  */
176 FLAC__bool OggFLAC__stream_decoder_set_read_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderReadCallback);
177
178 /** Set the write callback.
179  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_write_callback()
180  *
181  * \note
182  * The callback is mandatory and must be set before initialization.
183  *
184  * \default \c NULL
185  * \param  decoder  An decoder instance to set.
186  * \param  value    See above.
187  * \assert
188  *    \code decoder != NULL \endcode
189  *    \code value != NULL \endcode
190  * \retval FLAC__bool
191  *    \c false if the decoder is already initialized, else \c true.
192  */
193 FLAC__bool OggFLAC__stream_decoder_set_write_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderWriteCallback);
194
195 /** Set the metadata callback.
196  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_callback()
197  *
198  * \note
199  * The callback is mandatory and must be set before initialization.
200  *
201  * \default \c NULL
202  * \param  decoder  An decoder instance to set.
203  * \param  value    See above.
204  * \assert
205  *    \code decoder != NULL \endcode
206  *    \code value != NULL \endcode
207  * \retval FLAC__bool
208  *    \c false if the decoder is already initialized, else \c true.
209  */
210 FLAC__bool OggFLAC__stream_decoder_set_metadata_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderMetadataCallback);
211
212 /** Set the error callback.
213  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_error_callback()
214  *
215  * \note
216  * The callback is mandatory and must be set before initialization.
217  *
218  * \default \c NULL
219  * \param  decoder  An decoder instance to set.
220  * \param  value    See above.
221  * \assert
222  *    \code decoder != NULL \endcode
223  *    \code value != NULL \endcode
224  * \retval FLAC__bool
225  *    \c false if the decoder is already initialized, else \c true.
226  */
227 FLAC__bool OggFLAC__stream_decoder_set_error_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderErrorCallback);
228
229 /** Set the client data to be passed back to callbacks.
230  *  This value will be supplied to callbacks in their \a client_data
231  *  argument.
232  *
233  * \default \c NULL
234  * \param  decoder  An decoder instance to set.
235  * \param  value    See above.
236  * \assert
237  *    \code decoder != NULL \endcode
238  * \retval FLAC__bool
239  *    \c false if the decoder is already initialized, else \c true.
240  */
241 FLAC__bool OggFLAC__stream_decoder_set_client_data(OggFLAC__StreamDecoder *decoder, void *value);
242
243 /** Direct the decoder to pass on all metadata blocks of type \a type.
244  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond()
245  *
246  * \default By default, only the \c STREAMINFO block is returned via the
247  *          metadata callback.
248  * \param  decoder  A decoder instance to set.
249  * \param  type     See above.
250  * \assert
251  *    \code decoder != NULL \endcode
252  *    \a type is valid
253  * \retval FLAC__bool
254  *    \c false if the decoder is already initialized, else \c true.
255  */
256 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond(OggFLAC__StreamDecoder *decoder, OggFLAC__MetadataType type);
257
258 /** Direct the decoder to pass on all APPLICATION metadata blocks of the
259  *  given \a id.
260  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond_application()
261  *
262  * \default By default, only the \c STREAMINFO block is returned via the
263  *          metadata callback.
264  * \param  decoder  A decoder instance to set.
265  * \param  id       See above.
266  * \assert
267  *    \code decoder != NULL \endcode
268  *    \code id != NULL \endcode
269  * \retval FLAC__bool
270  *    \c false if the decoder is already initialized, else \c true.
271  */
272 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4]);
273
274 /** Direct the decoder to pass on all metadata blocks of any type.
275  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_respond_all()
276  *
277  * \default By default, only the \c STREAMINFO block is returned via the
278  *          metadata callback.
279  * \param  decoder  A decoder instance to set.
280  * \assert
281  *    \code decoder != NULL \endcode
282  * \retval FLAC__bool
283  *    \c false if the decoder is already initialized, else \c true.
284  */
285 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_all(OggFLAC__StreamDecoder *decoder);
286
287 /** Direct the decoder to filter out all metadata blocks of type \a type.
288  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore()
289  *
290  * \default By default, only the \c STREAMINFO block is returned via the
291  *          metadata callback.
292  * \param  decoder  A decoder instance to set.
293  * \param  type     See above.
294  * \assert
295  *    \code decoder != NULL \endcode
296  *    \a type is valid
297  * \retval FLAC__bool
298  *    \c false if the decoder is already initialized, else \c true.
299  */
300 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore(OggFLAC__StreamDecoder *decoder, OggFLAC__MetadataType type);
301
302 /** Direct the decoder to filter out all APPLICATION metadata blocks of
303  *  the given \a id.
304  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore_application()
305  *
306  * \default By default, only the \c STREAMINFO block is returned via the
307  *          metadata callback.
308  * \param  decoder  A decoder instance to set.
309  * \param  id       See above.
310  * \assert
311  *    \code decoder != NULL \endcode
312  *    \code id != NULL \endcode
313  * \retval FLAC__bool
314  *    \c false if the decoder is already initialized, else \c true.
315  */
316 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4]);
317
318 /** Direct the decoder to filter out all metadata blocks of any type.
319  * This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_set_metadata_ignore_all()
320  *
321  * \default By default, only the \c STREAMINFO block is returned via the
322  *          metadata callback.
323  * \param  decoder  A decoder instance to set.
324  * \assert
325  *    \code decoder != NULL \endcode
326  * \retval FLAC__bool
327  *    \c false if the decoder is already initialized, else \c true.
328  */
329 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_all(OggFLAC__StreamDecoder *decoder);
330
331 /** Get the current decoder state.
332  *
333  * \param  decoder  A decoder instance to query.
334  * \assert
335  *    \code decoder != NULL \endcode
336  * \retval OggFLAC__StreamDecoderState
337  *    The current decoder state.
338  */
339 OggFLAC__StreamDecoderState OggFLAC__stream_decoder_get_state(const OggFLAC__StreamDecoder *decoder);
340
341 /** Get the state of the underlying FLAC stream decoder.
342  *  Useful when the stream decoder state is
343  *  \c OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR.
344  *
345  * \param  decoder  An decoder instance to query.
346  * \assert
347  *    \code decoder != NULL \endcode
348  * \retval FLAC__StreamDecoderState
349  *    The FLAC stream decoder state.
350  */
351 FLAC__StreamDecoderState OggFLAC__stream_decoder_get_FLAC_stream_decoder_state(const OggFLAC__StreamDecoder *decoder);
352
353 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_channels()
354  *
355  * \param  decoder  A decoder instance to query.
356  * \assert
357  *    \code decoder != NULL \endcode
358  * \retval unsigned
359  *    See above.
360  */
361 unsigned OggFLAC__stream_decoder_get_channels(const OggFLAC__StreamDecoder *decoder);
362
363 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_channel_assignment()
364  *
365  * \param  decoder  A decoder instance to query.
366  * \assert
367  *    \code decoder != NULL \endcode
368  * \retval OggFLAC__ChannelAssignment
369  *    See above.
370  */
371 OggFLAC__ChannelAssignment OggFLAC__stream_decoder_get_channel_assignment(const OggFLAC__StreamDecoder *decoder);
372
373 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_bits_per_sample()
374  *
375  * \param  decoder  A decoder instance to query.
376  * \assert
377  *    \code decoder != NULL \endcode
378  * \retval unsigned
379  *    See above.
380  */
381 unsigned OggFLAC__stream_decoder_get_bits_per_sample(const OggFLAC__StreamDecoder *decoder);
382
383 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_sample_rate()
384  *
385  * \param  decoder  A decoder instance to query.
386  * \assert
387  *    \code decoder != NULL \endcode
388  * \retval unsigned
389  *    See above.
390  */
391 unsigned OggFLAC__stream_decoder_get_sample_rate(const OggFLAC__StreamDecoder *decoder);
392
393 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_get_blocksize()
394  *
395  * \param  decoder  A decoder instance to query.
396  * \assert
397  *    \code decoder != NULL \endcode
398  * \retval unsigned
399  *    See above.
400  */
401 unsigned OggFLAC__stream_decoder_get_blocksize(const OggFLAC__StreamDecoder *decoder);
402
403 /** Initialize the decoder instance.
404  *  Should be called after OggFLAC__stream_decoder_new() and
405  *  OggFLAC__stream_decoder_set_*() but before any of the
406  *  OggFLAC__stream_decoder_process_*() functions.  Will set and return the
407  *  decoder state, which will be OggFLAC__STREAM_DECODER_OK
408  *  if initialization succeeded.
409  *
410  * \param  decoder  An uninitialized decoder instance.
411  * \assert
412  *    \code decoder != NULL \endcode
413  * \retval OggFLAC__StreamDecoderState
414  *    \c OggFLAC__STREAM_DECODER_OK if initialization was
415  *    successful; see OggFLAC__StreamDecoderState for the meanings of other
416  *    return values.
417  */
418 OggFLAC__StreamDecoderState OggFLAC__stream_decoder_init(OggFLAC__StreamDecoder *decoder);
419
420 /** Finish the decoding process.
421  *  Flushes the decoding buffer, releases resources, resets the decoder
422  *  settings to their defaults, and returns the decoder state to
423  *  OggFLAC__STREAM_DECODER_UNINITIALIZED.
424  *
425  *  In the event of a prematurely-terminated decode, it is not strictly
426  *  necessary to call this immediately before OggFLAC__stream_decoder_delete()
427  *  but it is good practice to match every OggFLAC__stream_decoder_init()
428  *  with an OggFLAC__stream_decoder_finish().
429  *
430  * \param  decoder  An uninitialized decoder instance.
431  * \assert
432  *    \code decoder != NULL \endcode
433  */
434 void OggFLAC__stream_decoder_finish(OggFLAC__StreamDecoder *decoder);
435
436 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_flush()
437  *
438  * \param  decoder  A decoder instance.
439  * \assert
440  *    \code decoder != NULL \endcode
441  * \retval FLAC__bool
442  *    \c true if successful, else \c false if a memory allocation
443  *    error occurs.
444  */
445 FLAC__bool OggFLAC__stream_decoder_flush(OggFLAC__StreamDecoder *decoder);
446
447 /** This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_reset()
448  *
449  * \param  decoder  A decoder instance.
450  * \assert
451  *    \code decoder != NULL \endcode
452  * \retval FLAC__bool
453  *    \c true if successful, else \c false if a memory allocation
454  *    error occurs.
455  */
456 FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *decoder);
457
458 /** Decode one metadata block or audio frame.
459  *  This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_single()
460  * 
461  * \param  decoder  An initialized decoder instance in the state
462  *                  \c OggFLAC__STREAM_DECODER_OK.
463  * \assert
464  *    \code decoder != NULL \endcode
465  *    \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
466  * \retval FLAC__bool
467  *    \c false if any read or write error occurred (except
468  *    \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
469  *    in any case, check the decoder state with
470  *    OggFLAC__stream_decoder_get_state() to see what went wrong or to
471  *    check for lost synchronization (a sign of stream corruption).
472  */
473 FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder);
474
475 /** Decode until the end of the metadata.
476  *  This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_until_end_of_metadata()
477  * 
478  * \param  decoder  An initialized decoder instance in the state
479  *                  \c OggFLAC__STREAM_DECODER_OK.
480  * \assert
481  *    \code decoder != NULL \endcode
482  *    \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
483  * \retval FLAC__bool
484  *    \c false if any read or write error occurred (except
485  *    \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
486  *    in any case, check the decoder state with
487  *    OggFLAC__stream_decoder_get_state() to see what went wrong or to
488  *    check for lost synchronization (a sign of stream corruption).
489  */
490 FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder);
491
492 /** Decode until the end of the stream.
493  *  This is inherited from FLAC__StreamDecoder; see FLAC__stream_decoder_process_until_end_of_stream()
494  * 
495  * \param  decoder  An initialized decoder instance in the state
496  *                  \c OggFLAC__STREAM_DECODER_OK.
497  * \assert
498  *    \code decoder != NULL \endcode
499  *    \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
500  * \retval FLAC__bool
501  *    \c false if any read or write error occurred (except
502  *    \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c false;
503  *    in any case, check the decoder state with
504  *    OggFLAC__stream_decoder_get_state() to see what went wrong or to
505  *    check for lost synchronization (a sign of stream corruption).
506  */
507 FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder);
508
509 /* \} */
510
511 #ifdef __cplusplus
512 }
513 #endif
514
515 #endif