1 /* libOggFLAC - Free Lossless Audio Codec + Ogg library
2 * Copyright (C) 2002,2003 Josh Coalson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * - Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * - Neither the name of the Xiph.org Foundation nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #include <stdlib.h> /* for calloc() */
33 #include <string.h> /* for memset() */
35 #include "FLAC/assert.h"
36 #include "protected/stream_decoder.h"
41 #define min(x,y) ((x)<(y)?(x):(y))
43 /***********************************************************************
45 * Private class method prototypes
47 ***********************************************************************/
49 static void set_defaults_(OggFLAC__StreamDecoder *decoder);
50 static FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
51 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
52 static void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
53 static void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
56 /***********************************************************************
60 ***********************************************************************/
62 typedef struct OggFLAC__StreamDecoderPrivate {
63 OggFLAC__StreamDecoderReadCallback read_callback;
64 OggFLAC__StreamDecoderWriteCallback write_callback;
65 OggFLAC__StreamDecoderMetadataCallback metadata_callback;
66 OggFLAC__StreamDecoderErrorCallback error_callback;
68 FLAC__StreamDecoder *FLAC_stream_decoder;
70 ogg_stream_state stream_state;
71 ogg_sync_state sync_state;
72 FLAC__bool need_serial_number;
74 } OggFLAC__StreamDecoderPrivate;
76 /***********************************************************************
78 * Public static class data
80 ***********************************************************************/
82 const OggFLAC_API char * const OggFLAC__StreamDecoderStateString[] = {
83 "OggFLAC__STREAM_DECODER_OK",
84 "OggFLAC__STREAM_DECODER_OGG_ERROR",
85 "OggFLAC__STREAM_DECODER_READ_ERROR",
86 "OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR",
87 "OggFLAC__STREAM_DECODER_INVALID_CALLBACK",
88 "OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
89 "OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED",
90 "OggFLAC__STREAM_DECODER_UNINITIALIZED"
94 /***********************************************************************
96 * Class constructor/destructor
98 ***********************************************************************/
99 OggFLAC_API OggFLAC__StreamDecoder *OggFLAC__stream_decoder_new()
101 OggFLAC__StreamDecoder *decoder;
103 decoder = (OggFLAC__StreamDecoder*)calloc(1, sizeof(OggFLAC__StreamDecoder));
108 decoder->protected_ = (OggFLAC__StreamDecoderProtected*)calloc(1, sizeof(OggFLAC__StreamDecoderProtected));
109 if(decoder->protected_ == 0) {
114 decoder->private_ = (OggFLAC__StreamDecoderPrivate*)calloc(1, sizeof(OggFLAC__StreamDecoderPrivate));
115 if(decoder->private_ == 0) {
116 free(decoder->protected_);
121 decoder->private_->FLAC_stream_decoder = FLAC__stream_decoder_new();
122 if(0 == decoder->private_->FLAC_stream_decoder) {
123 free(decoder->private_);
124 free(decoder->protected_);
129 set_defaults_(decoder);
131 decoder->protected_->state = OggFLAC__STREAM_DECODER_UNINITIALIZED;
136 OggFLAC_API void OggFLAC__stream_decoder_delete(OggFLAC__StreamDecoder *decoder)
138 FLAC__ASSERT(0 != decoder);
139 FLAC__ASSERT(0 != decoder->protected_);
140 FLAC__ASSERT(0 != decoder->private_);
141 FLAC__ASSERT(0 != decoder->private_->FLAC_stream_decoder);
143 OggFLAC__stream_decoder_finish(decoder);
145 FLAC__stream_decoder_delete(decoder->private_->FLAC_stream_decoder);
147 free(decoder->private_);
148 free(decoder->protected_);
152 /***********************************************************************
154 * Public class methods
156 ***********************************************************************/
158 OggFLAC_API OggFLAC__StreamDecoderState OggFLAC__stream_decoder_init(OggFLAC__StreamDecoder *decoder)
160 FLAC__ASSERT(0 != decoder);
162 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
163 return decoder->protected_->state = OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED;
165 if(0 == decoder->private_->read_callback || 0 == decoder->private_->write_callback || 0 == decoder->private_->metadata_callback || 0 == decoder->private_->error_callback)
166 return decoder->protected_->state = OggFLAC__STREAM_DECODER_INVALID_CALLBACK;
168 decoder->private_->ogg.need_serial_number = decoder->protected_->use_first_serial_number;
169 /* we will determine the serial number later if necessary */
170 if(ogg_stream_init(&decoder->private_->ogg.stream_state, decoder->protected_->serial_number) != 0)
171 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OGG_ERROR;
173 if(ogg_sync_init(&decoder->private_->ogg.sync_state) != 0)
174 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OGG_ERROR;
176 FLAC__stream_decoder_set_read_callback(decoder->private_->FLAC_stream_decoder, read_callback_);
177 FLAC__stream_decoder_set_write_callback(decoder->private_->FLAC_stream_decoder, write_callback_);
178 FLAC__stream_decoder_set_metadata_callback(decoder->private_->FLAC_stream_decoder, metadata_callback_);
179 FLAC__stream_decoder_set_error_callback(decoder->private_->FLAC_stream_decoder, error_callback_);
180 FLAC__stream_decoder_set_client_data(decoder->private_->FLAC_stream_decoder, decoder);
182 if(FLAC__stream_decoder_init(decoder->private_->FLAC_stream_decoder) != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA)
183 return decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
185 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
188 OggFLAC_API void OggFLAC__stream_decoder_finish(OggFLAC__StreamDecoder *decoder)
190 FLAC__ASSERT(0 != decoder);
191 FLAC__ASSERT(0 != decoder->private_);
192 FLAC__ASSERT(0 != decoder->protected_);
194 if(decoder->protected_->state == OggFLAC__STREAM_DECODER_UNINITIALIZED)
197 FLAC__ASSERT(0 != decoder->private_->FLAC_stream_decoder);
199 FLAC__stream_decoder_finish(decoder->private_->FLAC_stream_decoder);
201 (void)ogg_sync_clear(&decoder->private_->ogg.sync_state);
202 (void)ogg_stream_clear(&decoder->private_->ogg.stream_state);
204 set_defaults_(decoder);
206 decoder->protected_->state = OggFLAC__STREAM_DECODER_UNINITIALIZED;
209 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_read_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderReadCallback value)
211 FLAC__ASSERT(0 != decoder);
212 FLAC__ASSERT(0 != decoder->private_);
213 FLAC__ASSERT(0 != decoder->protected_);
214 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
216 decoder->private_->read_callback = value;
220 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_write_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderWriteCallback value)
222 FLAC__ASSERT(0 != decoder);
223 FLAC__ASSERT(0 != decoder->private_);
224 FLAC__ASSERT(0 != decoder->protected_);
225 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
227 decoder->private_->write_callback = value;
231 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderMetadataCallback value)
233 FLAC__ASSERT(0 != decoder);
234 FLAC__ASSERT(0 != decoder->private_);
235 FLAC__ASSERT(0 != decoder->protected_);
236 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
238 decoder->private_->metadata_callback = value;
242 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_error_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderErrorCallback value)
244 FLAC__ASSERT(0 != decoder);
245 FLAC__ASSERT(0 != decoder->private_);
246 FLAC__ASSERT(0 != decoder->protected_);
247 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
249 decoder->private_->error_callback = value;
253 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_client_data(OggFLAC__StreamDecoder *decoder, void *value)
255 FLAC__ASSERT(0 != decoder);
256 FLAC__ASSERT(0 != decoder->private_);
257 FLAC__ASSERT(0 != decoder->protected_);
258 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
260 decoder->private_->client_data = value;
264 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_serial_number(OggFLAC__StreamDecoder *decoder, long value)
266 FLAC__ASSERT(0 != decoder);
267 FLAC__ASSERT(0 != decoder->private_);
268 FLAC__ASSERT(0 != decoder->protected_);
269 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
271 decoder->protected_->use_first_serial_number = false;
272 decoder->protected_->serial_number = value;
276 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond(OggFLAC__StreamDecoder *decoder, FLAC__MetadataType type)
278 FLAC__ASSERT(0 != decoder);
279 FLAC__ASSERT(0 != decoder->private_);
280 FLAC__ASSERT(0 != decoder->protected_);
281 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
283 return FLAC__stream_decoder_set_metadata_respond(decoder->private_->FLAC_stream_decoder, type);
286 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4])
288 FLAC__ASSERT(0 != decoder);
289 FLAC__ASSERT(0 != decoder->private_);
290 FLAC__ASSERT(0 != decoder->protected_);
291 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
293 return FLAC__stream_decoder_set_metadata_respond_application(decoder->private_->FLAC_stream_decoder, id);
296 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_all(OggFLAC__StreamDecoder *decoder)
298 FLAC__ASSERT(0 != decoder);
299 FLAC__ASSERT(0 != decoder->private_);
300 FLAC__ASSERT(0 != decoder->protected_);
301 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
303 return FLAC__stream_decoder_set_metadata_respond_all(decoder->private_->FLAC_stream_decoder);
306 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore(OggFLAC__StreamDecoder *decoder, FLAC__MetadataType type)
308 FLAC__ASSERT(0 != decoder);
309 FLAC__ASSERT(0 != decoder->private_);
310 FLAC__ASSERT(0 != decoder->protected_);
311 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
313 return FLAC__stream_decoder_set_metadata_ignore(decoder->private_->FLAC_stream_decoder, type);
316 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4])
318 FLAC__ASSERT(0 != decoder);
319 FLAC__ASSERT(0 != decoder->private_);
320 FLAC__ASSERT(0 != decoder->protected_);
321 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
323 return FLAC__stream_decoder_set_metadata_ignore_application(decoder->private_->FLAC_stream_decoder, id);
326 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_all(OggFLAC__StreamDecoder *decoder)
328 FLAC__ASSERT(0 != decoder);
329 FLAC__ASSERT(0 != decoder->private_);
330 FLAC__ASSERT(0 != decoder->protected_);
331 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
333 return FLAC__stream_decoder_set_metadata_ignore_all(decoder->private_->FLAC_stream_decoder);
336 OggFLAC_API OggFLAC__StreamDecoderState OggFLAC__stream_decoder_get_state(const OggFLAC__StreamDecoder *decoder)
338 FLAC__ASSERT(0 != decoder);
339 FLAC__ASSERT(0 != decoder->protected_);
340 return decoder->protected_->state;
343 OggFLAC_API FLAC__StreamDecoderState OggFLAC__stream_decoder_get_FLAC_stream_decoder_state(const OggFLAC__StreamDecoder *decoder)
345 FLAC__ASSERT(0 != decoder);
346 FLAC__ASSERT(0 != decoder->private_);
347 return FLAC__stream_decoder_get_state(decoder->private_->FLAC_stream_decoder);
350 OggFLAC_API unsigned OggFLAC__stream_decoder_get_channels(const OggFLAC__StreamDecoder *decoder)
352 FLAC__ASSERT(0 != decoder);
353 FLAC__ASSERT(0 != decoder->private_);
354 return FLAC__stream_decoder_get_channels(decoder->private_->FLAC_stream_decoder);
357 OggFLAC_API FLAC__ChannelAssignment OggFLAC__stream_decoder_get_channel_assignment(const OggFLAC__StreamDecoder *decoder)
359 FLAC__ASSERT(0 != decoder);
360 FLAC__ASSERT(0 != decoder->private_);
361 return FLAC__stream_decoder_get_channel_assignment(decoder->private_->FLAC_stream_decoder);
364 OggFLAC_API unsigned OggFLAC__stream_decoder_get_bits_per_sample(const OggFLAC__StreamDecoder *decoder)
366 FLAC__ASSERT(0 != decoder);
367 FLAC__ASSERT(0 != decoder->private_);
368 return FLAC__stream_decoder_get_bits_per_sample(decoder->private_->FLAC_stream_decoder);
371 OggFLAC_API unsigned OggFLAC__stream_decoder_get_sample_rate(const OggFLAC__StreamDecoder *decoder)
373 FLAC__ASSERT(0 != decoder);
374 FLAC__ASSERT(0 != decoder->private_);
375 return FLAC__stream_decoder_get_sample_rate(decoder->private_->FLAC_stream_decoder);
378 OggFLAC_API unsigned OggFLAC__stream_decoder_get_blocksize(const OggFLAC__StreamDecoder *decoder)
380 FLAC__ASSERT(0 != decoder);
381 FLAC__ASSERT(0 != decoder->private_);
382 return FLAC__stream_decoder_get_blocksize(decoder->private_->FLAC_stream_decoder);
385 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_flush(OggFLAC__StreamDecoder *decoder)
387 FLAC__ASSERT(0 != decoder);
388 FLAC__ASSERT(0 != decoder->private_);
389 FLAC__ASSERT(0 != decoder->protected_);
391 (void)ogg_sync_clear(&decoder->private_->ogg.sync_state);
393 if(!FLAC__stream_decoder_flush(decoder->private_->FLAC_stream_decoder)) {
394 decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
398 decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
403 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *decoder)
405 FLAC__ASSERT(0 != decoder);
406 FLAC__ASSERT(0 != decoder->private_);
407 FLAC__ASSERT(0 != decoder->protected_);
409 if(!OggFLAC__stream_decoder_flush(decoder)) {
410 decoder->protected_->state = OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
414 if(!FLAC__stream_decoder_reset(decoder->private_->FLAC_stream_decoder)) {
415 decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
419 decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
424 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder)
426 FLAC__ASSERT(0 != decoder);
427 FLAC__ASSERT(0 != decoder->private_);
428 return FLAC__stream_decoder_process_single(decoder->private_->FLAC_stream_decoder);
431 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder)
433 FLAC__ASSERT(0 != decoder);
434 FLAC__ASSERT(0 != decoder->private_);
435 return FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->FLAC_stream_decoder);
438 OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder)
440 FLAC__ASSERT(0 != decoder);
441 FLAC__ASSERT(0 != decoder->private_);
442 return FLAC__stream_decoder_process_until_end_of_stream(decoder->private_->FLAC_stream_decoder);
446 /***********************************************************************
448 * Private class methods
450 ***********************************************************************/
452 void set_defaults_(OggFLAC__StreamDecoder *decoder)
454 decoder->private_->read_callback = 0;
455 decoder->private_->write_callback = 0;
456 decoder->private_->metadata_callback = 0;
457 decoder->private_->error_callback = 0;
458 decoder->private_->client_data = 0;
459 decoder->protected_->use_first_serial_number = true;
462 FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *unused, FLAC__byte buffer[], unsigned *bytes, void *client_data)
464 static const unsigned OGG_BYTES_CHUNK = 8192;
465 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
466 unsigned ogg_bytes_to_read, ogg_bytes_read;
473 * We have to be careful not to read in more than the
474 * FLAC__StreamDecoder says it has room for. We know
475 * that the size of the decoded data must be no more
476 * than the encoded data we will read.
478 ogg_bytes_to_read = min(*bytes, OGG_BYTES_CHUNK);
479 oggbuf = ogg_sync_buffer(&decoder->private_->ogg.sync_state, ogg_bytes_to_read);
481 if(decoder->private_->read_callback(decoder, (FLAC__byte*)oggbuf, &ogg_bytes_to_read, decoder->private_->client_data) != FLAC__STREAM_DECODER_READ_STATUS_CONTINUE) {
482 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
483 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
485 ogg_bytes_read = ogg_bytes_to_read;
487 if(ogg_sync_wrote(&decoder->private_->ogg.sync_state, ogg_bytes_read) < 0) {
488 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
489 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
493 while(ogg_sync_pageout(&decoder->private_->ogg.sync_state, &page) == 1) {
494 /* grab the serial number if necessary */
495 if(decoder->private_->ogg.need_serial_number) {
496 decoder->private_->ogg.stream_state.serialno = decoder->protected_->serial_number = ogg_page_serialno(&page);
497 decoder->private_->ogg.need_serial_number = false;
499 if(ogg_stream_pagein(&decoder->private_->ogg.stream_state, &page) == 0) {
502 while(ogg_stream_packetout(&decoder->private_->ogg.stream_state, &packet) == 1) {
503 memcpy(buffer, packet.packet, packet.bytes);
504 *bytes += packet.bytes;
505 buffer += packet.bytes;
508 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
509 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
513 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
516 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *unused, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
518 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
520 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
523 void metadata_callback_(const FLAC__StreamDecoder *unused, const FLAC__StreamMetadata *metadata, void *client_data)
525 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
527 decoder->private_->metadata_callback(decoder, metadata, decoder->private_->client_data);
530 void error_callback_(const FLAC__StreamDecoder *unused, FLAC__StreamDecoderErrorStatus status, void *client_data)
532 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
534 decoder->private_->error_callback(decoder, status, decoder->private_->client_data);