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 "FLAC/assert.h"
22 #include "protected/stream_decoder.h"
24 /***********************************************************************
26 * Private class method prototypes
28 ***********************************************************************/
30 static void set_defaults_(FLAC__StreamDecoder *decoder);
33 /***********************************************************************
37 ***********************************************************************/
39 typedef struct FLAC__StreamDecoderPrivate {
40 FLAC__StreamDecoderReadCallback read_callback;
41 FLAC__StreamDecoderWriteCallback write_callback;
42 FLAC__StreamDecoderMetadataCallback metadata_callback;
43 FLAC__StreamDecoderErrorCallback error_callback;
45 } FLAC__StreamDecoderPrivate;
47 /***********************************************************************
49 * Public static class data
51 ***********************************************************************/
53 const char * const FLAC__StreamDecoderStateString[] = {
54 "OggFLAC__STREAM_DECODER_OK",
55 "OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR",
56 "OggFLAC__STREAM_DECODER_INVALID_CALLBACK",
57 "OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
58 "OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED",
59 "OggFLAC__STREAM_DECODER_UNINITIALIZED"
63 /***********************************************************************
65 * Class constructor/destructor
67 ***********************************************************************/
68 FLAC__StreamDecoder *FLAC__stream_decoder_new()
70 FLAC__StreamDecoder *decoder;
73 FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
75 decoder = (FLAC__StreamDecoder*)malloc(sizeof(FLAC__StreamDecoder));
79 memset(decoder, 0, sizeof(FLAC__StreamDecoder));
81 decoder->protected_ = (FLAC__StreamDecoderProtected*)malloc(sizeof(FLAC__StreamDecoderProtected));
82 if(decoder->protected_ == 0) {
86 memset(decoder->protected_, 0, sizeof(FLAC__StreamDecoderProtected));
88 decoder->private_ = (FLAC__StreamDecoderPrivate*)malloc(sizeof(FLAC__StreamDecoderPrivate));
89 if(decoder->private_ == 0) {
90 free(decoder->protected_);
94 memset(decoder->private_, 0, sizeof(FLAC__StreamDecoderPrivate));
96 decoder->private_->input = FLAC__bitbuffer_new();
97 if(decoder->private_->input == 0) {
98 free(decoder->private_);
99 free(decoder->protected_);
104 decoder->private_->metadata_filter_ids_capacity = 16;
105 if(0 == (decoder->private_->metadata_filter_ids = malloc((FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) * decoder->private_->metadata_filter_ids_capacity))) {
106 FLAC__bitbuffer_delete(decoder->private_->input);
107 free(decoder->private_);
108 free(decoder->protected_);
113 for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
114 decoder->private_->output[i] = 0;
115 decoder->private_->residual[i] = 0;
118 decoder->private_->output_capacity = 0;
119 decoder->private_->output_channels = 0;
120 decoder->private_->has_seek_table = false;
122 set_defaults_(decoder);
124 decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
129 void FLAC__stream_decoder_delete(FLAC__StreamDecoder *decoder)
131 FLAC__ASSERT(0 != decoder);
132 FLAC__ASSERT(0 != decoder->protected_);
133 FLAC__ASSERT(0 != decoder->private_);
134 FLAC__ASSERT(0 != decoder->private_->input);
136 FLAC__stream_decoder_finish(decoder);
138 if(0 != decoder->private_->metadata_filter_ids)
139 free(decoder->private_->metadata_filter_ids);
141 FLAC__bitbuffer_delete(decoder->private_->input);
142 free(decoder->private_);
143 free(decoder->protected_);
147 /***********************************************************************
149 * Public class methods
151 ***********************************************************************/
153 FLAC__StreamDecoderState FLAC__stream_decoder_init(FLAC__StreamDecoder *decoder)
155 FLAC__ASSERT(0 != decoder);
157 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
158 return decoder->protected_->state = FLAC__STREAM_DECODER_ALREADY_INITIALIZED;
160 if(0 == decoder->private_->read_callback || 0 == decoder->private_->write_callback || 0 == decoder->private_->metadata_callback || 0 == decoder->private_->error_callback)
161 return decoder->protected_->state = FLAC__STREAM_DECODER_INVALID_CALLBACK;
163 if(!FLAC__bitbuffer_init(decoder->private_->input))
164 return decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
166 decoder->private_->last_frame_number = 0;
167 decoder->private_->samples_decoded = 0;
168 decoder->private_->has_stream_info = false;
169 decoder->private_->cached = false;
172 * get the CPU info and set the function pointers
174 FLAC__cpu_info(&decoder->private_->cpuinfo);
175 /* first default to the non-asm routines */
176 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal;
177 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal;
178 /* now override with asm where appropriate */
180 if(decoder->private_->cpuinfo.use_asm) {
181 #ifdef FLAC__CPU_IA32
182 FLAC__ASSERT(decoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_IA32);
183 #ifdef FLAC__HAS_NASM
184 if(decoder->private_->cpuinfo.data.ia32.mmx) {
185 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
186 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32_mmx;
189 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
190 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32;
197 if(!FLAC__stream_decoder_reset(decoder))
198 return decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
200 return decoder->protected_->state;
203 void FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder)
206 FLAC__ASSERT(0 != decoder);
207 if(decoder->protected_->state == FLAC__STREAM_DECODER_UNINITIALIZED)
209 if(decoder->private_->has_seek_table) {
210 FLAC__ASSERT(0 != decoder->private_->seek_table.data.seek_table.points);
211 free(decoder->private_->seek_table.data.seek_table.points);
212 decoder->private_->seek_table.data.seek_table.points = 0;
213 decoder->private_->has_seek_table = false;
215 FLAC__bitbuffer_free(decoder->private_->input);
216 for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
217 /* WATCHOUT: FLAC__lpc_restore_signal_asm_ia32_mmx() requires that the output arrays have a buffer of up to 3 zeroes in front (at negative indices) for alignment purposes; we use 4 to keep the data well-aligned. */
218 if(0 != decoder->private_->output[i]) {
219 free(decoder->private_->output[i]-4);
220 decoder->private_->output[i] = 0;
222 if(0 != decoder->private_->residual[i]) {
223 free(decoder->private_->residual[i]);
224 decoder->private_->residual[i] = 0;
227 decoder->private_->output_capacity = 0;
228 decoder->private_->output_channels = 0;
230 set_defaults_(decoder);
232 decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
235 FLAC__bool FLAC__stream_decoder_set_read_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderReadCallback value)
237 FLAC__ASSERT(0 != decoder);
238 FLAC__ASSERT(0 != decoder->private_);
239 FLAC__ASSERT(0 != decoder->protected_);
240 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
242 decoder->private_->read_callback = value;
246 FLAC__bool FLAC__stream_decoder_set_write_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderWriteCallback value)
248 FLAC__ASSERT(0 != decoder);
249 FLAC__ASSERT(0 != decoder->private_);
250 FLAC__ASSERT(0 != decoder->protected_);
251 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
253 decoder->private_->write_callback = value;
257 FLAC__bool FLAC__stream_decoder_set_metadata_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderMetadataCallback value)
259 FLAC__ASSERT(0 != decoder);
260 FLAC__ASSERT(0 != decoder->private_);
261 FLAC__ASSERT(0 != decoder->protected_);
262 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
264 decoder->private_->metadata_callback = value;
268 FLAC__bool FLAC__stream_decoder_set_error_callback(FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorCallback value)
270 FLAC__ASSERT(0 != decoder);
271 FLAC__ASSERT(0 != decoder->private_);
272 FLAC__ASSERT(0 != decoder->protected_);
273 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
275 decoder->private_->error_callback = value;
279 FLAC__bool FLAC__stream_decoder_set_client_data(FLAC__StreamDecoder *decoder, void *value)
281 FLAC__ASSERT(0 != decoder);
282 FLAC__ASSERT(0 != decoder->private_);
283 FLAC__ASSERT(0 != decoder->protected_);
284 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
286 decoder->private_->client_data = value;
290 FLAC__bool FLAC__stream_decoder_set_metadata_respond(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
292 FLAC__ASSERT(0 != decoder);
293 FLAC__ASSERT(0 != decoder->private_);
294 FLAC__ASSERT(0 != decoder->protected_);
295 FLAC__ASSERT(type <= FLAC__METADATA_TYPE_VORBIS_COMMENT);
296 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
298 decoder->private_->metadata_filter[type] = true;
299 if(type == FLAC__METADATA_TYPE_APPLICATION)
300 decoder->private_->metadata_filter_ids_count = 0;
304 FLAC__bool FLAC__stream_decoder_set_metadata_respond_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
306 FLAC__ASSERT(0 != decoder);
307 FLAC__ASSERT(0 != decoder->private_);
308 FLAC__ASSERT(0 != decoder->protected_);
309 FLAC__ASSERT(0 != id);
310 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
313 if(decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
316 FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
318 if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
319 if(0 == (decoder->private_->metadata_filter_ids = realloc(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity * 2)))
320 return decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
321 decoder->private_->metadata_filter_ids_capacity *= 2;
324 memcpy(decoder->private_->metadata_filter_ids + decoder->private_->metadata_filter_ids_count * (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8), id, (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8));
325 decoder->private_->metadata_filter_ids_count++;
330 FLAC__bool FLAC__stream_decoder_set_metadata_respond_all(FLAC__StreamDecoder *decoder)
333 FLAC__ASSERT(0 != decoder);
334 FLAC__ASSERT(0 != decoder->private_);
335 FLAC__ASSERT(0 != decoder->protected_);
336 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
338 for(i = 0; i < sizeof(decoder->private_->metadata_filter) / sizeof(decoder->private_->metadata_filter[0]); i++)
339 decoder->private_->metadata_filter[i] = true;
340 decoder->private_->metadata_filter_ids_count = 0;
344 FLAC__bool FLAC__stream_decoder_set_metadata_ignore(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
346 FLAC__ASSERT(0 != decoder);
347 FLAC__ASSERT(0 != decoder->private_);
348 FLAC__ASSERT(0 != decoder->protected_);
349 FLAC__ASSERT(type <= FLAC__METADATA_TYPE_VORBIS_COMMENT);
350 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
352 decoder->private_->metadata_filter[type] = false;
353 if(type == FLAC__METADATA_TYPE_APPLICATION)
354 decoder->private_->metadata_filter_ids_count = 0;
358 FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
360 FLAC__ASSERT(0 != decoder);
361 FLAC__ASSERT(0 != decoder->private_);
362 FLAC__ASSERT(0 != decoder->protected_);
363 FLAC__ASSERT(0 != id);
364 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
367 if(!decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
370 FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
372 if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
373 if(0 == (decoder->private_->metadata_filter_ids = realloc(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity * 2)))
374 return decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
375 decoder->private_->metadata_filter_ids_capacity *= 2;
378 memcpy(decoder->private_->metadata_filter_ids + decoder->private_->metadata_filter_ids_count * (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8), id, (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8));
379 decoder->private_->metadata_filter_ids_count++;
384 FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all(FLAC__StreamDecoder *decoder)
386 FLAC__ASSERT(0 != decoder);
387 FLAC__ASSERT(0 != decoder->private_);
388 FLAC__ASSERT(0 != decoder->protected_);
389 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
391 memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
392 decoder->private_->metadata_filter_ids_count = 0;
396 FLAC__StreamDecoderState FLAC__stream_decoder_get_state(const FLAC__StreamDecoder *decoder)
398 FLAC__ASSERT(0 != decoder);
399 FLAC__ASSERT(0 != decoder->protected_);
400 return decoder->protected_->state;
403 unsigned FLAC__stream_decoder_get_channels(const FLAC__StreamDecoder *decoder)
405 FLAC__ASSERT(0 != decoder);
406 FLAC__ASSERT(0 != decoder->protected_);
407 return decoder->protected_->channels;
410 FLAC__ChannelAssignment FLAC__stream_decoder_get_channel_assignment(const FLAC__StreamDecoder *decoder)
412 FLAC__ASSERT(0 != decoder);
413 FLAC__ASSERT(0 != decoder->protected_);
414 return decoder->protected_->channel_assignment;
417 unsigned FLAC__stream_decoder_get_bits_per_sample(const FLAC__StreamDecoder *decoder)
419 FLAC__ASSERT(0 != decoder);
420 FLAC__ASSERT(0 != decoder->protected_);
421 return decoder->protected_->bits_per_sample;
424 unsigned FLAC__stream_decoder_get_sample_rate(const FLAC__StreamDecoder *decoder)
426 FLAC__ASSERT(0 != decoder);
427 FLAC__ASSERT(0 != decoder->protected_);
428 return decoder->protected_->sample_rate;
431 unsigned FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *decoder)
433 FLAC__ASSERT(0 != decoder);
434 FLAC__ASSERT(0 != decoder->protected_);
435 return decoder->protected_->blocksize;
438 FLAC__bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder)
440 FLAC__ASSERT(0 != decoder);
441 FLAC__ASSERT(0 != decoder->private_);
442 FLAC__ASSERT(0 != decoder->protected_);
444 if(!FLAC__bitbuffer_clear(decoder->private_->input)) {
445 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
448 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
453 FLAC__bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder)
455 FLAC__ASSERT(0 != decoder);
456 FLAC__ASSERT(0 != decoder->private_);
457 FLAC__ASSERT(0 != decoder->protected_);
459 if(!FLAC__stream_decoder_flush(decoder)) {
460 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
463 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_METADATA;
465 decoder->private_->samples_decoded = 0;
470 FLAC__bool FLAC__stream_decoder_process_single(FLAC__StreamDecoder *decoder)
472 FLAC__bool got_a_frame;
473 FLAC__ASSERT(0 != decoder);
474 FLAC__ASSERT(0 != decoder->protected_);
477 switch(decoder->protected_->state) {
478 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
479 if(!find_metadata_(decoder))
480 return false; /* above function sets the status for us */
482 case FLAC__STREAM_DECODER_READ_METADATA:
483 if(!read_metadata_(decoder))
484 return false; /* above function sets the status for us */
487 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
488 if(!frame_sync_(decoder))
489 return true; /* above function sets the status for us */
491 case FLAC__STREAM_DECODER_READ_FRAME:
492 if(!read_frame_(decoder, &got_a_frame))
493 return false; /* above function sets the status for us */
495 return true; /* above function sets the status for us */
497 case FLAC__STREAM_DECODER_END_OF_STREAM:
498 case FLAC__STREAM_DECODER_ABORTED:
507 FLAC__bool FLAC__stream_decoder_process_until_end_of_metadata(FLAC__StreamDecoder *decoder)
509 FLAC__ASSERT(0 != decoder);
510 FLAC__ASSERT(0 != decoder->protected_);
513 switch(decoder->protected_->state) {
514 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
515 if(!find_metadata_(decoder))
516 return false; /* above function sets the status for us */
518 case FLAC__STREAM_DECODER_READ_METADATA:
519 if(!read_metadata_(decoder))
520 return false; /* above function sets the status for us */
522 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
523 case FLAC__STREAM_DECODER_READ_FRAME:
524 case FLAC__STREAM_DECODER_END_OF_STREAM:
525 case FLAC__STREAM_DECODER_ABORTED:
534 FLAC__bool FLAC__stream_decoder_process_until_end_of_stream(FLAC__StreamDecoder *decoder)
537 FLAC__ASSERT(0 != decoder);
538 FLAC__ASSERT(0 != decoder->protected_);
541 switch(decoder->protected_->state) {
542 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
543 if(!find_metadata_(decoder))
544 return false; /* above function sets the status for us */
546 case FLAC__STREAM_DECODER_READ_METADATA:
547 if(!read_metadata_(decoder))
548 return false; /* above function sets the status for us */
550 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
551 if(!frame_sync_(decoder))
552 return true; /* above function sets the status for us */
554 case FLAC__STREAM_DECODER_READ_FRAME:
555 if(!read_frame_(decoder, &dummy))
556 return false; /* above function sets the status for us */
558 case FLAC__STREAM_DECODER_END_OF_STREAM:
559 case FLAC__STREAM_DECODER_ABORTED:
568 /***********************************************************************
570 * Protected class methods
572 ***********************************************************************/
574 unsigned FLAC__stream_decoder_get_input_bytes_unconsumed(const FLAC__StreamDecoder *decoder)
576 FLAC__ASSERT(0 != decoder);
577 return FLAC__bitbuffer_get_input_bytes_unconsumed(decoder->private_->input);
580 /***********************************************************************
582 * Private class methods
584 ***********************************************************************/
586 void set_defaults_(FLAC__StreamDecoder *decoder)
588 decoder->private_->read_callback = 0;
589 decoder->private_->write_callback = 0;
590 decoder->private_->metadata_callback = 0;
591 decoder->private_->error_callback = 0;
592 decoder->private_->client_data = 0;
594 memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
595 decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] = true;
596 decoder->private_->metadata_filter_ids_count = 0;