update with new semantics for padding
[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_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 *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 *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 *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 *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 *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  */
103 FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new();
104 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *);
105
106 /***********************************************************************
107  *
108  * Public class method prototypes
109  *
110  ***********************************************************************/
111
112 /*
113  * Various "set" methods.  These may only be called when the decoder
114  * is in the state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after
115  * FLAC__seekable_stream_decoder_new() or FLAC__seekable_stream_decoder_finish(),
116  * but before FLAC__seekable_stream_decoder_init().  If this is the case they
117  * will return true, otherwise false.
118  *
119  * NOTE that these functions do not validate the values as many are
120  * interdependent.  The FLAC__seekable_stream_decoder_init() function will
121  * do this, so make sure to pay attention to the state returned by
122  * FLAC__seekable_stream_decoder_init().
123  *
124  * Any parameters that are not set before FLAC__seekable_stream_decoder_init()
125  * will take on the defaults from the constructor.  NOTE that
126  * FLAC__seekable_stream_decoder_flush() or FLAC__seekable_stream_decoder_reset()
127  * do NOT reset the values to the constructor defaults.
128  */
129 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(const FLAC__SeekableStreamDecoder *decoder, FLAC__bool value);
130 FLAC__bool FLAC__seekable_stream_decoder_set_read_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderReadStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data));
131 FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderSeekStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data));
132 FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderTellStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data));
133 FLAC__bool FLAC__seekable_stream_decoder_set_length_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderLengthStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data));
134 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__bool (*value)(const FLAC__SeekableStreamDecoder *decoder, void *client_data));
135 FLAC__bool FLAC__seekable_stream_decoder_set_write_callback(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderWriteStatus (*value)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 *buffer[], void *client_data));
136 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback(const FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, const FLAC__StreamMetaData *metadata, void *client_data));
137 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(const FLAC__SeekableStreamDecoder *decoder, void (*value)(const FLAC__SeekableStreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data));
138 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(const FLAC__SeekableStreamDecoder *decoder, void *value);
139 /*
140  * See the comments for the equivalent functions in stream_decoder.h
141  */
142 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(const FLAC__SeekableStreamDecoder *decoder, FLAC__MetaDataType type);
143 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(const FLAC__SeekableStreamDecoder *decoder, FLAC__byte id[4]);
144 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(const FLAC__SeekableStreamDecoder *decoder);
145 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(const FLAC__SeekableStreamDecoder *decoder, FLAC__MetaDataType type);
146 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(const FLAC__SeekableStreamDecoder *decoder, FLAC__byte id[4]);
147 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(const FLAC__SeekableStreamDecoder *decoder);
148
149 /*
150  * Various "get" methods
151  */
152 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder);
153 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder);
154
155 /*
156  * Initialize the instance; should be called after construction and
157  * 'set' calls but before any of the 'process' or 'seek' calls.  Will
158  * set and return the decoder state, which will be FLAC__SEEKABLE_STREAM_DECODER_OK
159  * if initialization succeeded.
160  */
161 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder);
162
163 /*
164  * Flush the decoding buffer, release resources, and return the decoder
165  * state to FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.  Only returns false if
166  * md5_checking is set AND the stored MD5 sum is non-zero AND the stored
167  * MD5 sum and computed MD5 sum do not match.
168  */
169 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder);
170
171 /*
172  * Methods for decoding the data
173  */
174 FLAC__bool FLAC__seekable_stream_decoder_process_whole_stream(FLAC__SeekableStreamDecoder *decoder);
175 FLAC__bool FLAC__seekable_stream_decoder_process_metadata(FLAC__SeekableStreamDecoder *decoder);
176 FLAC__bool FLAC__seekable_stream_decoder_process_one_frame(FLAC__SeekableStreamDecoder *decoder);
177 FLAC__bool FLAC__seekable_stream_decoder_process_remaining_frames(FLAC__SeekableStreamDecoder *decoder);
178
179 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample);
180
181 #ifdef __cplusplus
182 }
183 #endif
184
185 #endif