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 typedef enum {
31     FLAC__SEEKABLE_STREAM_DECODER_OK = 0,
32         FLAC__SEEKABLE_STREAM_DECODER_SEEKING,
33         FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM,
34         FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR,
35         FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR,
36         FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR,
37         FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR,
38     FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED,
39     FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK,
40     FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED
41 } FLAC__SeekableStreamDecoderState;
42 extern const char * const FLAC__SeekableStreamDecoderStateString[];
43
44 typedef enum {
45         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK,
46         FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR
47 } FLAC__SeekableStreamDecoderReadStatus;
48 extern const char * const FLAC__SeekableStreamDecoderReadStatusString[];
49
50 typedef enum {
51         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK,
52         FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR
53 } FLAC__SeekableStreamDecoderSeekStatus;
54 extern const char * const FLAC__SeekableStreamDecoderSeekStatusString[];
55
56 typedef enum {
57         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK,
58         FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR
59 } FLAC__SeekableStreamDecoderTellStatus;
60 extern const char * const FLAC__SeekableStreamDecoderTellStatusString[];
61
62 typedef enum {
63         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK,
64         FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR
65 } FLAC__SeekableStreamDecoderLengthStatus;
66 extern const char * const FLAC__SeekableStreamDecoderLengthStatusString[];
67
68 /***********************************************************************
69  *
70  * class FLAC__SeekableStreamDecoder : public FLAC__StreamDecoder
71  *
72  ***********************************************************************/
73
74 struct FLAC__SeekableStreamDecoderProtected;
75 struct FLAC__SeekableStreamDecoderPrivate;
76 typedef struct {
77         struct FLAC__SeekableStreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
78         struct FLAC__SeekableStreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
79 } FLAC__SeekableStreamDecoder;
80
81 /***********************************************************************
82  *
83  * Class constructor/destructor
84  *
85  ***********************************************************************/
86
87 /*
88  * Any parameters that are not set before FLAC__seekable_stream_decoder_init()
89  * will take on the defaults from the constructor, shown below.
90  * For more on what the parameters mean, see the documentation.
91  *
92  * FLAC__bool  md5_checking                   (DEFAULT: false) MD5 checking will be turned off if a seek is requested
93  *           (*read_callback)()               (DEFAULT: NULL ) The callbacks are the only values that MUST be set before FLAC__seekable_stream_decoder_init()
94  *           (*seek_callback)()               (DEFAULT: NULL )
95  *           (*tell_callback)()               (DEFAULT: NULL )
96  *           (*length_callback)()             (DEFAULT: NULL )
97  *           (*eof_callback)()                (DEFAULT: NULL )
98  *           (*write_callback)()              (DEFAULT: NULL )
99  *           (*metadata_callback)()           (DEFAULT: NULL )
100  *           (*error_callback)()              (DEFAULT: NULL )
101  * void*       client_data                    (DEFAULT: NULL ) passed back through the callbacks
102  *          metadata_respond/ignore        By default, only the STREAMINFO block is returned via metadata_callback()
103  */
104 FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new();
105 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *);
106
107 /***********************************************************************
108  *
109  * Public class method prototypes
110  *
111  ***********************************************************************/
112
113 /*
114  * Various "set" methods.  These may only be called when the decoder
115  * is in the state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after
116  * FLAC__seekable_stream_decoder_new() or FLAC__seekable_stream_decoder_finish(),
117  * but before FLAC__seekable_stream_decoder_init().  If this is the case they
118  * will return true, otherwise false.
119  *
120  * NOTE that these functions do not validate the values as many are
121  * interdependent.  The FLAC__seekable_stream_decoder_init() function will
122  * do this, so make sure to pay attention to the state returned by
123  * FLAC__seekable_stream_decoder_init().
124  *
125  * Any parameters that are not set before FLAC__seekable_stream_decoder_init()
126  * will take on the defaults from the constructor.  NOTE that
127  * FLAC__seekable_stream_decoder_flush() or FLAC__seekable_stream_decoder_reset()
128  * do NOT reset the values to the constructor defaults.
129  */
130 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
131 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));
132 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));
133 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));
134 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));
135 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__bool (*value)(const FLAC__SeekableStreamDecoder *decoder, void *client_data));
136 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));
137 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));
138 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
139 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value);
140 /*
141  * See the comments for the equivalent functions in stream_decoder.h
142  */
143 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
144 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
145 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder);
146 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type);
147 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4]);
148 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder);
149
150 /*
151  * Various "get" methods
152  */
153 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder);
154 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder);
155 /*
156  * Methods to return the current number of channels, channel assignment
157  * bits-per-sample, sample rate in Hz, and blocksize in samples.  These
158  * will only be valid after decoding has started.
159  */
160 unsigned FLAC__seekable_stream_decoder_get_channels(const FLAC__SeekableStreamDecoder *decoder);
161 FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder);
162 unsigned FLAC__seekable_stream_decoder_get_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder);
163 unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder);
164 unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder);
165
166 /*
167  * Initialize the instance; should be called after construction and
168  * 'set' calls but before any of the 'process' or 'seek' calls.  Will
169  * set and return the decoder state, which will be
170  *  FLAC__SEEKABLE_STREAM_DECODER_OK if initialization succeeded.
171  */
172 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder);
173
174 /*
175  * Flush the decoding buffer, release resources, and return the decoder
176  * state to FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.  Only returns false if
177  * md5_checking is set AND the stored MD5 sum is non-zero AND the stored
178  * MD5 sum and computed MD5 sum do not match.
179  */
180 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder);
181
182 /*
183  * state control methods
184  */
185 FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder);
186 FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder);
187
188 /*
189  * Methods for decoding the data
190  */
191 FLAC__bool FLAC__seekable_stream_decoder_process_whole_stream(FLAC__SeekableStreamDecoder *decoder);
192 FLAC__bool FLAC__seekable_stream_decoder_process_metadata(FLAC__SeekableStreamDecoder *decoder);
193 FLAC__bool FLAC__seekable_stream_decoder_process_one_frame(FLAC__SeekableStreamDecoder *decoder);
194 FLAC__bool FLAC__seekable_stream_decoder_process_remaining_frames(FLAC__SeekableStreamDecoder *decoder);
195
196 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
197
198 #ifdef __cplusplus
199 }
200 #endif
201
202 #endif