1 /* libOggFLAC - Free Lossless Audio Codec + Ogg library
2 * Copyright (C) 2002 Josh Coalson
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.
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.
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.
21 #include <string.h> /* for memset() */
23 #include "FLAC/assert.h"
24 #include "protected/stream_decoder.h"
29 #define min(x,y) ((x)<(y)?(x):(y))
31 /***********************************************************************
33 * Private class method prototypes
35 ***********************************************************************/
37 static void set_defaults_(OggFLAC__StreamDecoder *decoder);
38 static FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
39 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
40 static void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
41 static void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
44 /***********************************************************************
48 ***********************************************************************/
50 typedef struct OggFLAC__StreamDecoderPrivate {
51 OggFLAC__StreamDecoderReadCallback read_callback;
52 OggFLAC__StreamDecoderWriteCallback write_callback;
53 OggFLAC__StreamDecoderMetadataCallback metadata_callback;
54 OggFLAC__StreamDecoderErrorCallback error_callback;
56 FLAC__StreamDecoder *FLAC_stream_decoder;
58 ogg_stream_state stream_state;
59 ogg_sync_state sync_state;
61 } OggFLAC__StreamDecoderPrivate;
63 /***********************************************************************
65 * Public static class data
67 ***********************************************************************/
69 const char * const OggFLAC__StreamDecoderStateString[] = {
70 "OggFLAC__STREAM_DECODER_OK",
71 "OggFLAC__STREAM_DECODER_OGG_ERROR",
72 "OggFLAC__STREAM_DECODER_READ_ERROR",
73 "OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR",
74 "OggFLAC__STREAM_DECODER_INVALID_CALLBACK",
75 "OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
76 "OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED",
77 "OggFLAC__STREAM_DECODER_UNINITIALIZED"
81 /***********************************************************************
83 * Class constructor/destructor
85 ***********************************************************************/
86 OggFLAC__StreamDecoder *OggFLAC__stream_decoder_new()
88 OggFLAC__StreamDecoder *decoder;
90 decoder = (OggFLAC__StreamDecoder*)malloc(sizeof(OggFLAC__StreamDecoder));
94 memset(decoder, 0, sizeof(OggFLAC__StreamDecoder));
96 decoder->protected_ = (OggFLAC__StreamDecoderProtected*)malloc(sizeof(OggFLAC__StreamDecoderProtected));
97 if(decoder->protected_ == 0) {
101 memset(decoder->protected_, 0, sizeof(OggFLAC__StreamDecoderProtected));
103 decoder->private_ = (OggFLAC__StreamDecoderPrivate*)malloc(sizeof(OggFLAC__StreamDecoderPrivate));
104 if(decoder->private_ == 0) {
105 free(decoder->protected_);
109 memset(decoder->private_, 0, sizeof(OggFLAC__StreamDecoderPrivate));
111 decoder->private_->FLAC_stream_decoder = FLAC__stream_decoder_new();
112 if(0 == decoder->private_->FLAC_stream_decoder) {
113 free(decoder->private_);
114 free(decoder->protected_);
119 set_defaults_(decoder);
121 decoder->protected_->state = OggFLAC__STREAM_DECODER_UNINITIALIZED;
126 void OggFLAC__stream_decoder_delete(OggFLAC__StreamDecoder *decoder)
128 FLAC__ASSERT(0 != decoder);
129 FLAC__ASSERT(0 != decoder->protected_);
130 FLAC__ASSERT(0 != decoder->private_);
131 FLAC__ASSERT(0 != decoder->private_->FLAC_stream_decoder);
133 OggFLAC__stream_decoder_finish(decoder);
135 FLAC__stream_decoder_delete(decoder->private_->FLAC_stream_decoder);
137 free(decoder->private_);
138 free(decoder->protected_);
142 /***********************************************************************
144 * Public class methods
146 ***********************************************************************/
148 OggFLAC__StreamDecoderState OggFLAC__stream_decoder_init(OggFLAC__StreamDecoder *decoder)
150 FLAC__ASSERT(0 != decoder);
152 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
153 return decoder->protected_->state = OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED;
155 if(0 == decoder->private_->read_callback || 0 == decoder->private_->write_callback || 0 == decoder->private_->metadata_callback || 0 == decoder->private_->error_callback)
156 return decoder->protected_->state = OggFLAC__STREAM_DECODER_INVALID_CALLBACK;
158 if(ogg_stream_init(&decoder->private_->ogg.stream_state, 0) != 0)
159 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OGG_ERROR;
161 if(ogg_sync_init(&decoder->private_->ogg.sync_state) != 0)
162 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OGG_ERROR;
164 FLAC__stream_decoder_set_read_callback(decoder->private_->FLAC_stream_decoder, read_callback_);
165 FLAC__stream_decoder_set_write_callback(decoder->private_->FLAC_stream_decoder, write_callback_);
166 FLAC__stream_decoder_set_metadata_callback(decoder->private_->FLAC_stream_decoder, metadata_callback_);
167 FLAC__stream_decoder_set_error_callback(decoder->private_->FLAC_stream_decoder, error_callback_);
168 FLAC__stream_decoder_set_client_data(decoder->private_->FLAC_stream_decoder, decoder);
170 if(FLAC__stream_decoder_init(decoder->private_->FLAC_stream_decoder) != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA)
171 return decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
173 return decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
176 void OggFLAC__stream_decoder_finish(OggFLAC__StreamDecoder *decoder)
178 FLAC__ASSERT(0 != decoder);
179 FLAC__ASSERT(0 != decoder->private_);
180 FLAC__ASSERT(0 != decoder->protected_);
182 if(decoder->protected_->state == OggFLAC__STREAM_DECODER_UNINITIALIZED)
185 FLAC__ASSERT(0 != decoder->private_->FLAC_stream_decoder);
187 FLAC__stream_decoder_finish(decoder->private_->FLAC_stream_decoder);
189 (void)ogg_sync_clear(&decoder->private_->ogg.sync_state);
190 (void)ogg_stream_clear(&decoder->private_->ogg.stream_state);
192 set_defaults_(decoder);
194 decoder->protected_->state = OggFLAC__STREAM_DECODER_UNINITIALIZED;
197 FLAC__bool OggFLAC__stream_decoder_set_read_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderReadCallback value)
199 FLAC__ASSERT(0 != decoder);
200 FLAC__ASSERT(0 != decoder->private_);
201 FLAC__ASSERT(0 != decoder->protected_);
202 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
204 decoder->private_->read_callback = value;
208 FLAC__bool OggFLAC__stream_decoder_set_write_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderWriteCallback value)
210 FLAC__ASSERT(0 != decoder);
211 FLAC__ASSERT(0 != decoder->private_);
212 FLAC__ASSERT(0 != decoder->protected_);
213 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
215 decoder->private_->write_callback = value;
219 FLAC__bool OggFLAC__stream_decoder_set_metadata_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderMetadataCallback value)
221 FLAC__ASSERT(0 != decoder);
222 FLAC__ASSERT(0 != decoder->private_);
223 FLAC__ASSERT(0 != decoder->protected_);
224 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
226 decoder->private_->metadata_callback = value;
230 FLAC__bool OggFLAC__stream_decoder_set_error_callback(OggFLAC__StreamDecoder *decoder, OggFLAC__StreamDecoderErrorCallback value)
232 FLAC__ASSERT(0 != decoder);
233 FLAC__ASSERT(0 != decoder->private_);
234 FLAC__ASSERT(0 != decoder->protected_);
235 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
237 decoder->private_->error_callback = value;
241 FLAC__bool OggFLAC__stream_decoder_set_client_data(OggFLAC__StreamDecoder *decoder, void *value)
243 FLAC__ASSERT(0 != decoder);
244 FLAC__ASSERT(0 != decoder->private_);
245 FLAC__ASSERT(0 != decoder->protected_);
246 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
248 decoder->private_->client_data = value;
252 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond(OggFLAC__StreamDecoder *decoder, FLAC__MetadataType type)
254 FLAC__ASSERT(0 != decoder);
255 FLAC__ASSERT(0 != decoder->private_);
256 FLAC__ASSERT(0 != decoder->protected_);
257 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
259 return FLAC__stream_decoder_set_metadata_respond(decoder->private_->FLAC_stream_decoder, type);
262 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4])
264 FLAC__ASSERT(0 != decoder);
265 FLAC__ASSERT(0 != decoder->private_);
266 FLAC__ASSERT(0 != decoder->protected_);
267 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
269 return FLAC__stream_decoder_set_metadata_respond_application(decoder->private_->FLAC_stream_decoder, id);
272 FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_all(OggFLAC__StreamDecoder *decoder)
274 FLAC__ASSERT(0 != decoder);
275 FLAC__ASSERT(0 != decoder->private_);
276 FLAC__ASSERT(0 != decoder->protected_);
277 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
279 return FLAC__stream_decoder_set_metadata_respond_all(decoder->private_->FLAC_stream_decoder);
282 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore(OggFLAC__StreamDecoder *decoder, FLAC__MetadataType type)
284 FLAC__ASSERT(0 != decoder);
285 FLAC__ASSERT(0 != decoder->private_);
286 FLAC__ASSERT(0 != decoder->protected_);
287 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
289 return FLAC__stream_decoder_set_metadata_ignore(decoder->private_->FLAC_stream_decoder, type);
292 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_application(OggFLAC__StreamDecoder *decoder, const FLAC__byte id[4])
294 FLAC__ASSERT(0 != decoder);
295 FLAC__ASSERT(0 != decoder->private_);
296 FLAC__ASSERT(0 != decoder->protected_);
297 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
299 return FLAC__stream_decoder_set_metadata_ignore_application(decoder->private_->FLAC_stream_decoder, id);
302 FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_all(OggFLAC__StreamDecoder *decoder)
304 FLAC__ASSERT(0 != decoder);
305 FLAC__ASSERT(0 != decoder->private_);
306 FLAC__ASSERT(0 != decoder->protected_);
307 if(decoder->protected_->state != OggFLAC__STREAM_DECODER_UNINITIALIZED)
309 return FLAC__stream_decoder_set_metadata_ignore_all(decoder->private_->FLAC_stream_decoder);
312 OggFLAC__StreamDecoderState OggFLAC__stream_decoder_get_state(const OggFLAC__StreamDecoder *decoder)
314 FLAC__ASSERT(0 != decoder);
315 FLAC__ASSERT(0 != decoder->protected_);
316 return decoder->protected_->state;
319 FLAC__StreamDecoderState OggFLAC__stream_decoder_get_FLAC_stream_decoder_state(const OggFLAC__StreamDecoder *decoder)
321 FLAC__ASSERT(0 != decoder);
322 FLAC__ASSERT(0 != decoder->private_);
323 return FLAC__stream_decoder_get_state(decoder->private_->FLAC_stream_decoder);
326 unsigned OggFLAC__stream_decoder_get_channels(const OggFLAC__StreamDecoder *decoder)
328 FLAC__ASSERT(0 != decoder);
329 FLAC__ASSERT(0 != decoder->private_);
330 return FLAC__stream_decoder_get_channels(decoder->private_->FLAC_stream_decoder);
333 FLAC__ChannelAssignment OggFLAC__stream_decoder_get_channel_assignment(const OggFLAC__StreamDecoder *decoder)
335 FLAC__ASSERT(0 != decoder);
336 FLAC__ASSERT(0 != decoder->private_);
337 return FLAC__stream_decoder_get_channel_assignment(decoder->private_->FLAC_stream_decoder);
340 unsigned OggFLAC__stream_decoder_get_bits_per_sample(const OggFLAC__StreamDecoder *decoder)
342 FLAC__ASSERT(0 != decoder);
343 FLAC__ASSERT(0 != decoder->private_);
344 return FLAC__stream_decoder_get_bits_per_sample(decoder->private_->FLAC_stream_decoder);
347 unsigned OggFLAC__stream_decoder_get_sample_rate(const OggFLAC__StreamDecoder *decoder)
349 FLAC__ASSERT(0 != decoder);
350 FLAC__ASSERT(0 != decoder->private_);
351 return FLAC__stream_decoder_get_sample_rate(decoder->private_->FLAC_stream_decoder);
354 unsigned OggFLAC__stream_decoder_get_blocksize(const OggFLAC__StreamDecoder *decoder)
356 FLAC__ASSERT(0 != decoder);
357 FLAC__ASSERT(0 != decoder->private_);
358 return FLAC__stream_decoder_get_blocksize(decoder->private_->FLAC_stream_decoder);
361 FLAC__bool OggFLAC__stream_decoder_flush(OggFLAC__StreamDecoder *decoder)
363 FLAC__ASSERT(0 != decoder);
364 FLAC__ASSERT(0 != decoder->private_);
365 FLAC__ASSERT(0 != decoder->protected_);
367 (void)ogg_sync_clear(&decoder->private_->ogg.sync_state);
369 if(!FLAC__stream_decoder_flush(decoder->private_->FLAC_stream_decoder)) {
370 decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
374 decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
379 FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *decoder)
381 FLAC__ASSERT(0 != decoder);
382 FLAC__ASSERT(0 != decoder->private_);
383 FLAC__ASSERT(0 != decoder->protected_);
385 if(!OggFLAC__stream_decoder_flush(decoder)) {
386 decoder->protected_->state = OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
390 if(!FLAC__stream_decoder_reset(decoder->private_->FLAC_stream_decoder)) {
391 decoder->protected_->state = OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR;
395 decoder->protected_->state = OggFLAC__STREAM_DECODER_OK;
400 FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder)
402 FLAC__ASSERT(0 != decoder);
403 FLAC__ASSERT(0 != decoder->private_);
404 return FLAC__stream_decoder_process_single(decoder->private_->FLAC_stream_decoder);
407 FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder)
409 FLAC__ASSERT(0 != decoder);
410 FLAC__ASSERT(0 != decoder->private_);
411 return FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->FLAC_stream_decoder);
414 FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder)
416 FLAC__ASSERT(0 != decoder);
417 FLAC__ASSERT(0 != decoder->private_);
418 return FLAC__stream_decoder_process_until_end_of_stream(decoder->private_->FLAC_stream_decoder);
422 /***********************************************************************
424 * Private class methods
426 ***********************************************************************/
428 void set_defaults_(OggFLAC__StreamDecoder *decoder)
430 decoder->private_->read_callback = 0;
431 decoder->private_->write_callback = 0;
432 decoder->private_->metadata_callback = 0;
433 decoder->private_->error_callback = 0;
434 decoder->private_->client_data = 0;
437 FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *unused, FLAC__byte buffer[], unsigned *bytes, void *client_data)
439 static const unsigned OGG_BYTES_CHUNK = 8192;
440 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
441 unsigned ogg_bytes_to_read, ogg_bytes_read;
448 * We have to be careful not to read in more than the
449 * FLAC__StreamDecoder says it has room for. We know
450 * that the size of the decoded data must be no more
451 * than the encoded data we will read.
453 ogg_bytes_to_read = min(*bytes, OGG_BYTES_CHUNK);
454 oggbuf = ogg_sync_buffer(&decoder->private_->ogg.sync_state, ogg_bytes_to_read);
456 if(decoder->private_->read_callback(decoder, oggbuf, &ogg_bytes_to_read, decoder->private_->client_data) != FLAC__STREAM_DECODER_READ_STATUS_CONTINUE) {
457 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
458 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
460 ogg_bytes_read = ogg_bytes_to_read;
462 if(ogg_sync_wrote(&decoder->private_->ogg.sync_state, ogg_bytes_read) < 0) {
463 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
464 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
468 while(ogg_sync_pageout(&decoder->private_->ogg.sync_state, &page) == 1) {
469 if(ogg_stream_pagein(&decoder->private_->ogg.stream_state, &page) == 0) {
472 while(ogg_stream_packetout(&decoder->private_->ogg.stream_state, &packet) == 1) {
473 memcpy(buffer, packet.packet, packet.bytes);
474 *bytes += packet.bytes;
475 buffer += packet.bytes;
478 decoder->protected_->state = OggFLAC__STREAM_DECODER_READ_ERROR;
479 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
483 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
486 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *unused, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
488 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
490 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
493 void metadata_callback_(const FLAC__StreamDecoder *unused, const FLAC__StreamMetadata *metadata, void *client_data)
495 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
497 decoder->private_->metadata_callback(decoder, metadata, decoder->private_->client_data);
500 void error_callback_(const FLAC__StreamDecoder *unused, FLAC__StreamDecoderErrorStatus status, void *client_data)
502 OggFLAC__StreamDecoder *decoder = (OggFLAC__StreamDecoder*)client_data;
504 decoder->private_->error_callback(decoder, status, decoder->private_->client_data);