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  * \note
96  * The "set" functions may only be called when the decoder is in the
97  * state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after
98  * FLAC__seekable_stream_decoder_new() or
99  * FLAC__seekable_stream_decoder_finish(), but before
100  * FLAC__seekable_stream_decoder_init().  If this is the case they will
101  * return \c true, otherwise \c false.
102  *
103  * \note
104  * FLAC__stream_decoder_finish() resets all settings to the constructor
105  * defaults, including the callbacks.
106  *
107  * \{
108  */
109
110
111 /** State values for a FLAC__SeekableStreamDecoder
112  *
113  *  The decoder's state can be obtained by calling FLAC__seekable_tream_decoder_get_state().
114  */
115 typedef enum {
116     FLAC__SEEKABLE_STREAM_DECODER_OK = 0,
117         FLAC__SEEKABLE_STREAM_DECODER_SEEKING,
118         FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM,
119         FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
120         FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR,
121         FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR,
122         FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR,
123     FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED,
124     FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK,
125     FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED
126 } FLAC__SeekableStreamDecoderState;
127 extern const char * const FLAC__SeekableStreamDecoderStateString[];
128
129 typedef enum {
130         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK,
131         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR
132 } FLAC__SeekableStreamDecoderReadStatus;
133 extern const char * const FLAC__SeekableStreamDecoderReadStatusString[];
134
135 typedef enum {
136         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK,
137         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR
138 } FLAC__SeekableStreamDecoderSeekStatus;
139 extern const char * const FLAC__SeekableStreamDecoderSeekStatusString[];
140
141 typedef enum {
142         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK,
143         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR
144 } FLAC__SeekableStreamDecoderTellStatus;
145 extern const char * const FLAC__SeekableStreamDecoderTellStatusString[];
146
147 typedef enum {
148         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK,
149         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR
150 } FLAC__SeekableStreamDecoderLengthStatus;
151 extern const char * const FLAC__SeekableStreamDecoderLengthStatusString[];
152
153 /***********************************************************************
154  *
155  * class FLAC__SeekableStreamDecoder : public FLAC__StreamDecoder
156  *
157  ***********************************************************************/
158
159 struct FLAC__SeekableStreamDecoderProtected;
160 struct FLAC__SeekableStreamDecoderPrivate;
161 typedef struct {
162         struct FLAC__SeekableStreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
163         struct FLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
164 } FLAC__SeekableStreamDecoder;
165
166 /***********************************************************************
167  *
168  * Class constructor/destructor
169  *
170  ***********************************************************************/
171
172 /*
173  * Any parameters that are not set before FLAC__seekable_stream_decoder_init()
174  * will take on the defaults from the constructor, shown below.
175  * For more on what the parameters mean, see the documentation.
176  *
177  * FLAC__bool  md5_checking                   (DEFAULT: false) MD5 checking will be turned off if a seek is requested
178  *           (*read_callback)()               (DEFAULT: NULL ) The callbacks are the only values that MUST be set before FLAC__seekable_stream_decoder_init()
179  *           (*seek_callback)()               (DEFAULT: NULL )
180  *           (*tell_callback)()               (DEFAULT: NULL )
181  *           (*length_callback)()             (DEFAULT: NULL )
182  *           (*eof_callback)()                (DEFAULT: NULL )
183  *           (*write_callback)()              (DEFAULT: NULL )
184  *           (*metadata_callback)()           (DEFAULT: NULL )
185  *           (*error_callback)()              (DEFAULT: NULL )
186  * void*       client_data                    (DEFAULT: NULL ) passed back through the callbacks
187  *          metadata_respond/ignore        By default, only the STREAMINFO block is returned via metadata_callback()
188  */
189 FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new();
190 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *);
191
192 /***********************************************************************
193  *
194  * Public class method prototypes
195  *
196  ***********************************************************************/
197
198 /*
199  * Various "set" methods.  These may only be called when the decoder
200  * is in the state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after
201  * FLAC__seekable_stream_decoder_new() or FLAC__seekable_stream_decoder_finish(),
202  * but before FLAC__seekable_stream_decoder_init().  If this is the case they
203  * will return true, otherwise false.
204  *
205  * NOTE that these functions do not validate the values as many are
206  * interdependent.  The FLAC__seekable_stream_decoder_init() function will
207  * do this, so make sure to pay attention to the state returned by
208  * FLAC__seekable_stream_decoder_init().
209  *
210  * Any parameters that are not set before FLAC__seekable_stream_decoder_init()
211  * will take on the defaults from the constructor.  NOTE that
212  * FLAC__seekable_stream_decoder_flush() or FLAC__seekable_stream_decoder_reset()
213  * do NOT reset the values to the constructor defaults.
214  */
215 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
216 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));
217 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));
218 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));
219 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));
220 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__bool (*value)(const FLAC__SeekableStreamDecoder *decoder, void *client_data));
221 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));
222 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));
223 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
224 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value);
225 /*
226  * See the comments for the equivalent functions in stream_decoder.h
227  */
228 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
229 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
230 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder);
231 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
232 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
233 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder);
234
235 /*
236  * Various "get" methods
237  */
238 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder);
239 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder);
240 /*
241  * Methods to return the current number of channels, channel assignment
242  * bits-per-sample, sample rate in Hz, and blocksize in samples.  These
243  * will only be valid after decoding has started.
244  */
245 unsigned FLAC__seekable_stream_decoder_get_channels(const FLAC__SeekableStreamDecoder *decoder);
246 FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder);
247 unsigned FLAC__seekable_stream_decoder_get_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder);
248 unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder);
249 unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder);
250
251 /*
252  * Initialize the instance; should be called after construction and
253  * 'set' calls but before any of the 'process' or 'seek' calls.  Will
254  * set and return the decoder state, which will be
255  *  FLAC__SEEKABLE_STREAM_DECODER_OK if initialization succeeded.
256  */
257 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder);
258
259 /*
260  * Flush the decoding buffer, release resources, and return the decoder
261  * state to FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.  Only returns false if
262  * md5_checking is set AND the stored MD5 sum is non-zero AND the stored
263  * MD5 sum and computed MD5 sum do not match.
264  */
265 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder);
266
267 /*
268  * state control methods
269  */
270 FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder);
271 FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder);
272
273 /*
274  * Methods for decoding the data
275  */
276 FLAC__bool FLAC__seekable_stream_decoder_process_whole_stream(FLAC__SeekableStreamDecoder *decoder);
277 FLAC__bool FLAC__seekable_stream_decoder_process_metadata(FLAC__SeekableStreamDecoder *decoder);
278 FLAC__bool FLAC__seekable_stream_decoder_process_one_frame(FLAC__SeekableStreamDecoder *decoder);
279 FLAC__bool FLAC__seekable_stream_decoder_process_remaining_frames(FLAC__SeekableStreamDecoder *decoder);
280
281 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
282
283 /* \} */
284
285 #ifdef __cplusplus
286 }
287 #endif
288
289 #endif