move the new public get_decoder_client_data function to public header.
[flac.git] / src / libFLAC / stream_decoder.c
blob5b96086c114434daa37a76505843d4155eef5f1d
1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000-2009 Josh Coalson
3 * Copyright (C) 2011-2016 Xiph.Org Foundation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * - Neither the name of the Xiph.org Foundation nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifdef HAVE_CONFIG_H
34 # include <config.h>
35 #endif
37 #include <stdio.h>
38 #include <stdlib.h> /* for malloc() */
39 #include <string.h> /* for memset/memcpy() */
40 #include <sys/stat.h> /* for stat() */
41 #include <sys/types.h> /* for off_t */
42 #include "share/compat.h"
43 #include "FLAC/assert.h"
44 #include "share/alloc.h"
45 #include "protected/stream_decoder.h"
46 #include "private/bitreader.h"
47 #include "private/bitmath.h"
48 #include "private/cpu.h"
49 #include "private/crc.h"
50 #include "private/fixed.h"
51 #include "private/format.h"
52 #include "private/lpc.h"
53 #include "private/md5.h"
54 #include "private/memory.h"
55 #include "private/macros.h"
58 /* technically this should be in an "export.c" but this is convenient enough */
59 FLAC_API int FLAC_API_SUPPORTS_OGG_FLAC = FLAC__HAS_OGG;
62 /***********************************************************************
64 * Private static data
66 ***********************************************************************/
68 static const FLAC__byte ID3V2_TAG_[3] = { 'I', 'D', '3' };
70 /***********************************************************************
72 * Private class method prototypes
74 ***********************************************************************/
76 static void set_defaults_(FLAC__StreamDecoder *decoder);
77 static FILE *get_binary_stdin_(void);
78 static FLAC__bool allocate_output_(FLAC__StreamDecoder *decoder, uint32_t size, uint32_t channels);
79 static FLAC__bool has_id_filtered_(FLAC__StreamDecoder *decoder, FLAC__byte *id);
80 static FLAC__bool find_metadata_(FLAC__StreamDecoder *decoder);
81 static FLAC__bool read_metadata_(FLAC__StreamDecoder *decoder);
82 static FLAC__bool read_metadata_streaminfo_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, uint32_t length);
83 static FLAC__bool read_metadata_seektable_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, uint32_t length);
84 static FLAC__bool read_metadata_vorbiscomment_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_VorbisComment *obj, uint32_t length);
85 static FLAC__bool read_metadata_cuesheet_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_CueSheet *obj);
86 static FLAC__bool read_metadata_picture_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_Picture *obj);
87 static FLAC__bool skip_id3v2_tag_(FLAC__StreamDecoder *decoder);
88 static FLAC__bool frame_sync_(FLAC__StreamDecoder *decoder);
89 static FLAC__bool read_frame_(FLAC__StreamDecoder *decoder, FLAC__bool *got_a_frame, FLAC__bool do_full_decode);
90 static FLAC__bool read_frame_header_(FLAC__StreamDecoder *decoder);
91 static FLAC__bool read_subframe_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode);
92 static FLAC__bool read_subframe_constant_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode);
93 static FLAC__bool read_subframe_fixed_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, const uint32_t order, FLAC__bool do_full_decode);
94 static FLAC__bool read_subframe_lpc_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, const uint32_t order, FLAC__bool do_full_decode);
95 static FLAC__bool read_subframe_verbatim_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode);
96 static FLAC__bool read_residual_partitioned_rice_(FLAC__StreamDecoder *decoder, uint32_t predictor_order, uint32_t partition_order, FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents, FLAC__int32 *residual, FLAC__bool is_extended);
97 static FLAC__bool read_zero_padding_(FLAC__StreamDecoder *decoder);
98 static FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data);
99 #if FLAC__HAS_OGG
100 static FLAC__StreamDecoderReadStatus read_callback_ogg_aspect_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes);
101 static FLAC__OggDecoderAspectReadStatus read_callback_proxy_(const void *void_decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
102 #endif
103 static FLAC__StreamDecoderWriteStatus write_audio_frame_to_client_(FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[]);
104 static void send_error_to_client_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status);
105 static FLAC__bool seek_to_absolute_sample_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample);
106 #if FLAC__HAS_OGG
107 static FLAC__bool seek_to_absolute_sample_ogg_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample);
108 #endif
109 static FLAC__StreamDecoderReadStatus file_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
110 static FLAC__StreamDecoderSeekStatus file_seek_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
111 static FLAC__StreamDecoderTellStatus file_tell_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
112 static FLAC__StreamDecoderLengthStatus file_length_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
113 static FLAC__bool file_eof_callback_(const FLAC__StreamDecoder *decoder, void *client_data);
115 /***********************************************************************
117 * Private class data
119 ***********************************************************************/
121 typedef struct FLAC__StreamDecoderPrivate {
122 FLAC__bool is_ogg;
123 FLAC__StreamDecoderReadCallback read_callback;
124 FLAC__StreamDecoderSeekCallback seek_callback;
125 FLAC__StreamDecoderTellCallback tell_callback;
126 FLAC__StreamDecoderLengthCallback length_callback;
127 FLAC__StreamDecoderEofCallback eof_callback;
128 FLAC__StreamDecoderWriteCallback write_callback;
129 FLAC__StreamDecoderMetadataCallback metadata_callback;
130 FLAC__StreamDecoderErrorCallback error_callback;
131 /* generic 32-bit datapath: */
132 void (*local_lpc_restore_signal)(const FLAC__int32 residual[], uint32_t data_len, const FLAC__int32 qlp_coeff[], uint32_t order, int lp_quantization, FLAC__int32 data[]);
133 /* generic 64-bit datapath: */
134 void (*local_lpc_restore_signal_64bit)(const FLAC__int32 residual[], uint32_t data_len, const FLAC__int32 qlp_coeff[], uint32_t order, int lp_quantization, FLAC__int32 data[]);
135 /* for use when the signal is <= 16 bits-per-sample, or <= 15 bits-per-sample on a side channel (which requires 1 extra bit): */
136 void (*local_lpc_restore_signal_16bit)(const FLAC__int32 residual[], uint32_t data_len, const FLAC__int32 qlp_coeff[], uint32_t order, int lp_quantization, FLAC__int32 data[]);
137 void *client_data;
138 FILE *file; /* only used if FLAC__stream_decoder_init_file()/FLAC__stream_decoder_init_file() called, else NULL */
139 FLAC__BitReader *input;
140 FLAC__int32 *output[FLAC__MAX_CHANNELS];
141 FLAC__int32 *residual[FLAC__MAX_CHANNELS]; /* WATCHOUT: these are the aligned pointers; the real pointers that should be free()'d are residual_unaligned[] below */
142 FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents[FLAC__MAX_CHANNELS];
143 uint32_t output_capacity, output_channels;
144 FLAC__uint32 fixed_block_size, next_fixed_block_size;
145 FLAC__uint64 samples_decoded;
146 FLAC__bool has_stream_info, has_seek_table;
147 FLAC__StreamMetadata stream_info;
148 FLAC__StreamMetadata seek_table;
149 FLAC__bool metadata_filter[128]; /* MAGIC number 128 == total number of metadata block types == 1 << 7 */
150 FLAC__byte *metadata_filter_ids;
151 size_t metadata_filter_ids_count, metadata_filter_ids_capacity; /* units for both are IDs, not bytes */
152 FLAC__Frame frame;
153 FLAC__bool cached; /* true if there is a byte in lookahead */
154 FLAC__CPUInfo cpuinfo;
155 FLAC__byte header_warmup[2]; /* contains the sync code and reserved bits */
156 FLAC__byte lookahead; /* temp storage when we need to look ahead one byte in the stream */
157 /* unaligned (original) pointers to allocated data */
158 FLAC__int32 *residual_unaligned[FLAC__MAX_CHANNELS];
159 FLAC__bool do_md5_checking; /* initially gets protected_->md5_checking but is turned off after a seek or if the metadata has a zero MD5 */
160 FLAC__bool internal_reset_hack; /* used only during init() so we can call reset to set up the decoder without rewinding the input */
161 FLAC__bool is_seeking;
162 FLAC__MD5Context md5context;
163 FLAC__byte computed_md5sum[16]; /* this is the sum we computed from the decoded data */
164 /* (the rest of these are only used for seeking) */
165 FLAC__Frame last_frame; /* holds the info of the last frame we seeked to */
166 FLAC__uint64 first_frame_offset; /* hint to the seek routine of where in the stream the first audio frame starts */
167 FLAC__uint64 target_sample;
168 uint32_t unparseable_frame_count; /* used to tell whether we're decoding a future version of FLAC or just got a bad sync */
169 FLAC__bool got_a_frame; /* hack needed in Ogg FLAC seek routine to check when process_single() actually writes a frame */
170 } FLAC__StreamDecoderPrivate;
172 /***********************************************************************
174 * Public static class data
176 ***********************************************************************/
178 FLAC_API const char * const FLAC__StreamDecoderStateString[] = {
179 "FLAC__STREAM_DECODER_SEARCH_FOR_METADATA",
180 "FLAC__STREAM_DECODER_READ_METADATA",
181 "FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC",
182 "FLAC__STREAM_DECODER_READ_FRAME",
183 "FLAC__STREAM_DECODER_END_OF_STREAM",
184 "FLAC__STREAM_DECODER_OGG_ERROR",
185 "FLAC__STREAM_DECODER_SEEK_ERROR",
186 "FLAC__STREAM_DECODER_ABORTED",
187 "FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
188 "FLAC__STREAM_DECODER_UNINITIALIZED"
191 FLAC_API const char * const FLAC__StreamDecoderInitStatusString[] = {
192 "FLAC__STREAM_DECODER_INIT_STATUS_OK",
193 "FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER",
194 "FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS",
195 "FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR",
196 "FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE",
197 "FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED"
200 FLAC_API const char * const FLAC__StreamDecoderReadStatusString[] = {
201 "FLAC__STREAM_DECODER_READ_STATUS_CONTINUE",
202 "FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM",
203 "FLAC__STREAM_DECODER_READ_STATUS_ABORT"
206 FLAC_API const char * const FLAC__StreamDecoderSeekStatusString[] = {
207 "FLAC__STREAM_DECODER_SEEK_STATUS_OK",
208 "FLAC__STREAM_DECODER_SEEK_STATUS_ERROR",
209 "FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED"
212 FLAC_API const char * const FLAC__StreamDecoderTellStatusString[] = {
213 "FLAC__STREAM_DECODER_TELL_STATUS_OK",
214 "FLAC__STREAM_DECODER_TELL_STATUS_ERROR",
215 "FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED"
218 FLAC_API const char * const FLAC__StreamDecoderLengthStatusString[] = {
219 "FLAC__STREAM_DECODER_LENGTH_STATUS_OK",
220 "FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR",
221 "FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED"
224 FLAC_API const char * const FLAC__StreamDecoderWriteStatusString[] = {
225 "FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE",
226 "FLAC__STREAM_DECODER_WRITE_STATUS_ABORT"
229 FLAC_API const char * const FLAC__StreamDecoderErrorStatusString[] = {
230 "FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC",
231 "FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER",
232 "FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH",
233 "FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM"
236 /***********************************************************************
238 * Class constructor/destructor
240 ***********************************************************************/
241 FLAC_API FLAC__StreamDecoder *FLAC__stream_decoder_new(void)
243 FLAC__StreamDecoder *decoder;
244 uint32_t i;
246 FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
248 decoder = calloc(1, sizeof(FLAC__StreamDecoder));
249 if(decoder == 0) {
250 return 0;
253 decoder->protected_ = calloc(1, sizeof(FLAC__StreamDecoderProtected));
254 if(decoder->protected_ == 0) {
255 free(decoder);
256 return 0;
259 decoder->private_ = calloc(1, sizeof(FLAC__StreamDecoderPrivate));
260 if(decoder->private_ == 0) {
261 free(decoder->protected_);
262 free(decoder);
263 return 0;
266 decoder->private_->input = FLAC__bitreader_new();
267 if(decoder->private_->input == 0) {
268 free(decoder->private_);
269 free(decoder->protected_);
270 free(decoder);
271 return 0;
274 decoder->private_->metadata_filter_ids_capacity = 16;
275 if(0 == (decoder->private_->metadata_filter_ids = malloc((FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) * decoder->private_->metadata_filter_ids_capacity))) {
276 FLAC__bitreader_delete(decoder->private_->input);
277 free(decoder->private_);
278 free(decoder->protected_);
279 free(decoder);
280 return 0;
283 for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
284 decoder->private_->output[i] = 0;
285 decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
288 decoder->private_->output_capacity = 0;
289 decoder->private_->output_channels = 0;
290 decoder->private_->has_seek_table = false;
292 for(i = 0; i < FLAC__MAX_CHANNELS; i++)
293 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&decoder->private_->partitioned_rice_contents[i]);
295 decoder->private_->file = 0;
297 set_defaults_(decoder);
299 decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
301 return decoder;
304 FLAC_API void FLAC__stream_decoder_delete(FLAC__StreamDecoder *decoder)
306 uint32_t i;
308 if (decoder == NULL)
309 return ;
311 FLAC__ASSERT(0 != decoder->protected_);
312 FLAC__ASSERT(0 != decoder->private_);
313 FLAC__ASSERT(0 != decoder->private_->input);
315 (void)FLAC__stream_decoder_finish(decoder);
317 if(0 != decoder->private_->metadata_filter_ids)
318 free(decoder->private_->metadata_filter_ids);
320 FLAC__bitreader_delete(decoder->private_->input);
322 for(i = 0; i < FLAC__MAX_CHANNELS; i++)
323 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&decoder->private_->partitioned_rice_contents[i]);
325 free(decoder->private_);
326 free(decoder->protected_);
327 free(decoder);
330 /***********************************************************************
332 * Public class methods
334 ***********************************************************************/
336 static FLAC__StreamDecoderInitStatus init_stream_internal_(
337 FLAC__StreamDecoder *decoder,
338 FLAC__StreamDecoderReadCallback read_callback,
339 FLAC__StreamDecoderSeekCallback seek_callback,
340 FLAC__StreamDecoderTellCallback tell_callback,
341 FLAC__StreamDecoderLengthCallback length_callback,
342 FLAC__StreamDecoderEofCallback eof_callback,
343 FLAC__StreamDecoderWriteCallback write_callback,
344 FLAC__StreamDecoderMetadataCallback metadata_callback,
345 FLAC__StreamDecoderErrorCallback error_callback,
346 void *client_data,
347 FLAC__bool is_ogg
350 FLAC__ASSERT(0 != decoder);
352 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
353 return FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
355 if(FLAC__HAS_OGG == 0 && is_ogg)
356 return FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER;
359 0 == read_callback ||
360 0 == write_callback ||
361 0 == error_callback ||
362 (seek_callback && (0 == tell_callback || 0 == length_callback || 0 == eof_callback))
364 return FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
366 #if FLAC__HAS_OGG
367 decoder->private_->is_ogg = is_ogg;
368 if(is_ogg && !FLAC__ogg_decoder_aspect_init(&decoder->protected_->ogg_decoder_aspect))
369 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE;
370 #endif
373 * get the CPU info and set the function pointers
375 FLAC__cpu_info(&decoder->private_->cpuinfo);
376 /* first default to the non-asm routines */
377 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal;
378 decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide;
379 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal;
380 /* now override with asm where appropriate */
381 #ifndef FLAC__NO_ASM
382 if(decoder->private_->cpuinfo.use_asm) {
383 #ifdef FLAC__CPU_IA32
384 FLAC__ASSERT(decoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_IA32);
385 #ifdef FLAC__HAS_NASM
386 decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide_asm_ia32; /* OPT_IA32: was really necessary for GCC < 4.9 */
387 if (decoder->private_->cpuinfo.x86.mmx) {
388 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
389 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32_mmx;
391 else {
392 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
393 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32;
395 #endif
396 #if FLAC__HAS_X86INTRIN && ! defined FLAC__INTEGER_ONLY_LIBRARY
397 # if defined FLAC__SSE4_1_SUPPORTED
398 if (decoder->private_->cpuinfo.x86.sse41) {
399 # if !defined FLAC__HAS_NASM /* these are not undoubtedly faster than their MMX ASM counterparts */
400 decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_intrin_sse41;
401 decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_16_intrin_sse41;
402 # endif
403 decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide_intrin_sse41;
405 # endif
406 #endif
407 #elif defined FLAC__CPU_X86_64
408 FLAC__ASSERT(decoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_X86_64);
409 /* No useful SSE optimizations yet */
410 #endif
412 #endif
414 /* from here on, errors are fatal */
416 if(!FLAC__bitreader_init(decoder->private_->input, read_callback_, decoder)) {
417 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
418 return FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR;
421 decoder->private_->read_callback = read_callback;
422 decoder->private_->seek_callback = seek_callback;
423 decoder->private_->tell_callback = tell_callback;
424 decoder->private_->length_callback = length_callback;
425 decoder->private_->eof_callback = eof_callback;
426 decoder->private_->write_callback = write_callback;
427 decoder->private_->metadata_callback = metadata_callback;
428 decoder->private_->error_callback = error_callback;
429 decoder->private_->client_data = client_data;
430 decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size = 0;
431 decoder->private_->samples_decoded = 0;
432 decoder->private_->has_stream_info = false;
433 decoder->private_->cached = false;
435 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
436 decoder->private_->is_seeking = false;
438 decoder->private_->internal_reset_hack = true; /* so the following reset does not try to rewind the input */
439 if(!FLAC__stream_decoder_reset(decoder)) {
440 /* above call sets the state for us */
441 return FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR;
444 return FLAC__STREAM_DECODER_INIT_STATUS_OK;
447 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_stream(
448 FLAC__StreamDecoder *decoder,
449 FLAC__StreamDecoderReadCallback read_callback,
450 FLAC__StreamDecoderSeekCallback seek_callback,
451 FLAC__StreamDecoderTellCallback tell_callback,
452 FLAC__StreamDecoderLengthCallback length_callback,
453 FLAC__StreamDecoderEofCallback eof_callback,
454 FLAC__StreamDecoderWriteCallback write_callback,
455 FLAC__StreamDecoderMetadataCallback metadata_callback,
456 FLAC__StreamDecoderErrorCallback error_callback,
457 void *client_data
460 return init_stream_internal_(
461 decoder,
462 read_callback,
463 seek_callback,
464 tell_callback,
465 length_callback,
466 eof_callback,
467 write_callback,
468 metadata_callback,
469 error_callback,
470 client_data,
471 /*is_ogg=*/false
475 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_stream(
476 FLAC__StreamDecoder *decoder,
477 FLAC__StreamDecoderReadCallback read_callback,
478 FLAC__StreamDecoderSeekCallback seek_callback,
479 FLAC__StreamDecoderTellCallback tell_callback,
480 FLAC__StreamDecoderLengthCallback length_callback,
481 FLAC__StreamDecoderEofCallback eof_callback,
482 FLAC__StreamDecoderWriteCallback write_callback,
483 FLAC__StreamDecoderMetadataCallback metadata_callback,
484 FLAC__StreamDecoderErrorCallback error_callback,
485 void *client_data
488 return init_stream_internal_(
489 decoder,
490 read_callback,
491 seek_callback,
492 tell_callback,
493 length_callback,
494 eof_callback,
495 write_callback,
496 metadata_callback,
497 error_callback,
498 client_data,
499 /*is_ogg=*/true
503 static FLAC__StreamDecoderInitStatus init_FILE_internal_(
504 FLAC__StreamDecoder *decoder,
505 FILE *file,
506 FLAC__StreamDecoderWriteCallback write_callback,
507 FLAC__StreamDecoderMetadataCallback metadata_callback,
508 FLAC__StreamDecoderErrorCallback error_callback,
509 void *client_data,
510 FLAC__bool is_ogg
513 FLAC__ASSERT(0 != decoder);
514 FLAC__ASSERT(0 != file);
516 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
517 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
519 if(0 == write_callback || 0 == error_callback)
520 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
523 * To make sure that our file does not go unclosed after an error, we
524 * must assign the FILE pointer before any further error can occur in
525 * this routine.
527 if(file == stdin)
528 file = get_binary_stdin_(); /* just to be safe */
530 decoder->private_->file = file;
532 return init_stream_internal_(
533 decoder,
534 file_read_callback_,
535 decoder->private_->file == stdin? 0: file_seek_callback_,
536 decoder->private_->file == stdin? 0: file_tell_callback_,
537 decoder->private_->file == stdin? 0: file_length_callback_,
538 file_eof_callback_,
539 write_callback,
540 metadata_callback,
541 error_callback,
542 client_data,
543 is_ogg
547 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_FILE(
548 FLAC__StreamDecoder *decoder,
549 FILE *file,
550 FLAC__StreamDecoderWriteCallback write_callback,
551 FLAC__StreamDecoderMetadataCallback metadata_callback,
552 FLAC__StreamDecoderErrorCallback error_callback,
553 void *client_data
556 return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/false);
559 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_FILE(
560 FLAC__StreamDecoder *decoder,
561 FILE *file,
562 FLAC__StreamDecoderWriteCallback write_callback,
563 FLAC__StreamDecoderMetadataCallback metadata_callback,
564 FLAC__StreamDecoderErrorCallback error_callback,
565 void *client_data
568 return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/true);
571 static FLAC__StreamDecoderInitStatus init_file_internal_(
572 FLAC__StreamDecoder *decoder,
573 const char *filename,
574 FLAC__StreamDecoderWriteCallback write_callback,
575 FLAC__StreamDecoderMetadataCallback metadata_callback,
576 FLAC__StreamDecoderErrorCallback error_callback,
577 void *client_data,
578 FLAC__bool is_ogg
581 FILE *file;
583 FLAC__ASSERT(0 != decoder);
586 * To make sure that our file does not go unclosed after an error, we
587 * have to do the same entrance checks here that are later performed
588 * in FLAC__stream_decoder_init_FILE() before the FILE* is assigned.
590 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
591 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
593 if(0 == write_callback || 0 == error_callback)
594 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
596 file = filename? flac_fopen(filename, "rb") : stdin;
598 if(0 == file)
599 return FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE;
601 return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, is_ogg);
604 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_file(
605 FLAC__StreamDecoder *decoder,
606 const char *filename,
607 FLAC__StreamDecoderWriteCallback write_callback,
608 FLAC__StreamDecoderMetadataCallback metadata_callback,
609 FLAC__StreamDecoderErrorCallback error_callback,
610 void *client_data
613 return init_file_internal_(decoder, filename, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/false);
616 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_file(
617 FLAC__StreamDecoder *decoder,
618 const char *filename,
619 FLAC__StreamDecoderWriteCallback write_callback,
620 FLAC__StreamDecoderMetadataCallback metadata_callback,
621 FLAC__StreamDecoderErrorCallback error_callback,
622 void *client_data
625 return init_file_internal_(decoder, filename, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/true);
628 FLAC_API FLAC__bool FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder)
630 FLAC__bool md5_failed = false;
631 uint32_t i;
633 FLAC__ASSERT(0 != decoder);
634 FLAC__ASSERT(0 != decoder->private_);
635 FLAC__ASSERT(0 != decoder->protected_);
637 if(decoder->protected_->state == FLAC__STREAM_DECODER_UNINITIALIZED)
638 return true;
640 /* see the comment in FLAC__stream_decoder_reset() as to why we
641 * always call FLAC__MD5Final()
643 FLAC__MD5Final(decoder->private_->computed_md5sum, &decoder->private_->md5context);
645 free(decoder->private_->seek_table.data.seek_table.points);
646 decoder->private_->seek_table.data.seek_table.points = 0;
647 decoder->private_->has_seek_table = false;
649 FLAC__bitreader_free(decoder->private_->input);
650 for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
651 /* WATCHOUT:
652 * FLAC__lpc_restore_signal_asm_ia32_mmx() and ..._intrin_sseN()
653 * require that the output arrays have a buffer of up to 3 zeroes
654 * in front (at negative indices) for alignment purposes;
655 * we use 4 to keep the data well-aligned.
657 if(0 != decoder->private_->output[i]) {
658 free(decoder->private_->output[i]-4);
659 decoder->private_->output[i] = 0;
661 if(0 != decoder->private_->residual_unaligned[i]) {
662 free(decoder->private_->residual_unaligned[i]);
663 decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
666 decoder->private_->output_capacity = 0;
667 decoder->private_->output_channels = 0;
669 #if FLAC__HAS_OGG
670 if(decoder->private_->is_ogg)
671 FLAC__ogg_decoder_aspect_finish(&decoder->protected_->ogg_decoder_aspect);
672 #endif
674 if(0 != decoder->private_->file) {
675 if(decoder->private_->file != stdin)
676 fclose(decoder->private_->file);
677 decoder->private_->file = 0;
680 if(decoder->private_->do_md5_checking) {
681 if(memcmp(decoder->private_->stream_info.data.stream_info.md5sum, decoder->private_->computed_md5sum, 16))
682 md5_failed = true;
684 decoder->private_->is_seeking = false;
686 set_defaults_(decoder);
688 decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
690 return !md5_failed;
693 FLAC_API FLAC__bool FLAC__stream_decoder_set_ogg_serial_number(FLAC__StreamDecoder *decoder, long value)
695 FLAC__ASSERT(0 != decoder);
696 FLAC__ASSERT(0 != decoder->private_);
697 FLAC__ASSERT(0 != decoder->protected_);
698 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
699 return false;
700 #if FLAC__HAS_OGG
701 /* can't check decoder->private_->is_ogg since that's not set until init time */
702 FLAC__ogg_decoder_aspect_set_serial_number(&decoder->protected_->ogg_decoder_aspect, value);
703 return true;
704 #else
705 (void)value;
706 return false;
707 #endif
710 FLAC_API FLAC__bool FLAC__stream_decoder_set_md5_checking(FLAC__StreamDecoder *decoder, FLAC__bool value)
712 FLAC__ASSERT(0 != decoder);
713 FLAC__ASSERT(0 != decoder->protected_);
714 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
715 return false;
716 decoder->protected_->md5_checking = value;
717 return true;
720 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
722 FLAC__ASSERT(0 != decoder);
723 FLAC__ASSERT(0 != decoder->private_);
724 FLAC__ASSERT(0 != decoder->protected_);
725 FLAC__ASSERT((uint32_t)type <= FLAC__MAX_METADATA_TYPE_CODE);
726 /* double protection */
727 if((uint32_t)type > FLAC__MAX_METADATA_TYPE_CODE)
728 return false;
729 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
730 return false;
731 decoder->private_->metadata_filter[type] = true;
732 if(type == FLAC__METADATA_TYPE_APPLICATION)
733 decoder->private_->metadata_filter_ids_count = 0;
734 return true;
737 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
739 FLAC__ASSERT(0 != decoder);
740 FLAC__ASSERT(0 != decoder->private_);
741 FLAC__ASSERT(0 != decoder->protected_);
742 FLAC__ASSERT(0 != id);
743 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
744 return false;
746 if(decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
747 return true;
749 FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
751 if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
752 if(0 == (decoder->private_->metadata_filter_ids = safe_realloc_mul_2op_(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity, /*times*/2))) {
753 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
754 return false;
756 decoder->private_->metadata_filter_ids_capacity *= 2;
759 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));
760 decoder->private_->metadata_filter_ids_count++;
762 return true;
765 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_all(FLAC__StreamDecoder *decoder)
767 uint32_t i;
768 FLAC__ASSERT(0 != decoder);
769 FLAC__ASSERT(0 != decoder->private_);
770 FLAC__ASSERT(0 != decoder->protected_);
771 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
772 return false;
773 for(i = 0; i < sizeof(decoder->private_->metadata_filter) / sizeof(decoder->private_->metadata_filter[0]); i++)
774 decoder->private_->metadata_filter[i] = true;
775 decoder->private_->metadata_filter_ids_count = 0;
776 return true;
779 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
781 FLAC__ASSERT(0 != decoder);
782 FLAC__ASSERT(0 != decoder->private_);
783 FLAC__ASSERT(0 != decoder->protected_);
784 FLAC__ASSERT((uint32_t)type <= FLAC__MAX_METADATA_TYPE_CODE);
785 /* double protection */
786 if((uint32_t)type > FLAC__MAX_METADATA_TYPE_CODE)
787 return false;
788 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
789 return false;
790 decoder->private_->metadata_filter[type] = false;
791 if(type == FLAC__METADATA_TYPE_APPLICATION)
792 decoder->private_->metadata_filter_ids_count = 0;
793 return true;
796 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
798 FLAC__ASSERT(0 != decoder);
799 FLAC__ASSERT(0 != decoder->private_);
800 FLAC__ASSERT(0 != decoder->protected_);
801 FLAC__ASSERT(0 != id);
802 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
803 return false;
805 if(!decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
806 return true;
808 FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
810 if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
811 if(0 == (decoder->private_->metadata_filter_ids = safe_realloc_mul_2op_(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity, /*times*/2))) {
812 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
813 return false;
815 decoder->private_->metadata_filter_ids_capacity *= 2;
818 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));
819 decoder->private_->metadata_filter_ids_count++;
821 return true;
824 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all(FLAC__StreamDecoder *decoder)
826 FLAC__ASSERT(0 != decoder);
827 FLAC__ASSERT(0 != decoder->private_);
828 FLAC__ASSERT(0 != decoder->protected_);
829 if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
830 return false;
831 memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
832 decoder->private_->metadata_filter_ids_count = 0;
833 return true;
836 FLAC_API FLAC__StreamDecoderState FLAC__stream_decoder_get_state(const FLAC__StreamDecoder *decoder)
838 FLAC__ASSERT(0 != decoder);
839 FLAC__ASSERT(0 != decoder->protected_);
840 return decoder->protected_->state;
843 FLAC_API const char *FLAC__stream_decoder_get_resolved_state_string(const FLAC__StreamDecoder *decoder)
845 return FLAC__StreamDecoderStateString[decoder->protected_->state];
848 FLAC_API FLAC__bool FLAC__stream_decoder_get_md5_checking(const FLAC__StreamDecoder *decoder)
850 FLAC__ASSERT(0 != decoder);
851 FLAC__ASSERT(0 != decoder->protected_);
852 return decoder->protected_->md5_checking;
855 FLAC_API FLAC__uint64 FLAC__stream_decoder_get_total_samples(const FLAC__StreamDecoder *decoder)
857 FLAC__ASSERT(0 != decoder);
858 FLAC__ASSERT(0 != decoder->protected_);
859 return decoder->private_->has_stream_info? decoder->private_->stream_info.data.stream_info.total_samples : 0;
862 FLAC_API uint32_t FLAC__stream_decoder_get_channels(const FLAC__StreamDecoder *decoder)
864 FLAC__ASSERT(0 != decoder);
865 FLAC__ASSERT(0 != decoder->protected_);
866 return decoder->protected_->channels;
869 FLAC_API FLAC__ChannelAssignment FLAC__stream_decoder_get_channel_assignment(const FLAC__StreamDecoder *decoder)
871 FLAC__ASSERT(0 != decoder);
872 FLAC__ASSERT(0 != decoder->protected_);
873 return decoder->protected_->channel_assignment;
876 FLAC_API uint32_t FLAC__stream_decoder_get_bits_per_sample(const FLAC__StreamDecoder *decoder)
878 FLAC__ASSERT(0 != decoder);
879 FLAC__ASSERT(0 != decoder->protected_);
880 return decoder->protected_->bits_per_sample;
883 FLAC_API uint32_t FLAC__stream_decoder_get_sample_rate(const FLAC__StreamDecoder *decoder)
885 FLAC__ASSERT(0 != decoder);
886 FLAC__ASSERT(0 != decoder->protected_);
887 return decoder->protected_->sample_rate;
890 FLAC_API uint32_t FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *decoder)
892 FLAC__ASSERT(0 != decoder);
893 FLAC__ASSERT(0 != decoder->protected_);
894 return decoder->protected_->blocksize;
897 FLAC_API FLAC__bool FLAC__stream_decoder_get_decode_position(const FLAC__StreamDecoder *decoder, FLAC__uint64 *position)
899 FLAC__ASSERT(0 != decoder);
900 FLAC__ASSERT(0 != decoder->private_);
901 FLAC__ASSERT(0 != position);
903 if(FLAC__HAS_OGG && decoder->private_->is_ogg)
904 return false;
906 if(0 == decoder->private_->tell_callback)
907 return false;
908 if(decoder->private_->tell_callback(decoder, position, decoder->private_->client_data) != FLAC__STREAM_DECODER_TELL_STATUS_OK)
909 return false;
910 /* should never happen since all FLAC frames and metadata blocks are byte aligned, but check just in case */
911 if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input))
912 return false;
913 FLAC__ASSERT(*position >= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder));
914 *position -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder);
915 return true;
918 FLAC_API FLAC__bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder)
920 FLAC__ASSERT(0 != decoder);
921 FLAC__ASSERT(0 != decoder->private_);
922 FLAC__ASSERT(0 != decoder->protected_);
924 if(!decoder->private_->internal_reset_hack && decoder->protected_->state == FLAC__STREAM_DECODER_UNINITIALIZED)
925 return false;
927 decoder->private_->samples_decoded = 0;
928 decoder->private_->do_md5_checking = false;
930 #if FLAC__HAS_OGG
931 if(decoder->private_->is_ogg)
932 FLAC__ogg_decoder_aspect_flush(&decoder->protected_->ogg_decoder_aspect);
933 #endif
935 if(!FLAC__bitreader_clear(decoder->private_->input)) {
936 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
937 return false;
939 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
941 return true;
944 FLAC_API FLAC__bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder)
946 FLAC__ASSERT(0 != decoder);
947 FLAC__ASSERT(0 != decoder->private_);
948 FLAC__ASSERT(0 != decoder->protected_);
950 if(!FLAC__stream_decoder_flush(decoder)) {
951 /* above call sets the state for us */
952 return false;
955 #if FLAC__HAS_OGG
956 /*@@@ could go in !internal_reset_hack block below */
957 if(decoder->private_->is_ogg)
958 FLAC__ogg_decoder_aspect_reset(&decoder->protected_->ogg_decoder_aspect);
959 #endif
961 /* Rewind if necessary. If FLAC__stream_decoder_init() is calling us,
962 * (internal_reset_hack) don't try to rewind since we are already at
963 * the beginning of the stream and don't want to fail if the input is
964 * not seekable.
966 if(!decoder->private_->internal_reset_hack) {
967 if(decoder->private_->file == stdin)
968 return false; /* can't rewind stdin, reset fails */
969 if(decoder->private_->seek_callback && decoder->private_->seek_callback(decoder, 0, decoder->private_->client_data) == FLAC__STREAM_DECODER_SEEK_STATUS_ERROR)
970 return false; /* seekable and seek fails, reset fails */
972 else
973 decoder->private_->internal_reset_hack = false;
975 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_METADATA;
977 decoder->private_->has_stream_info = false;
979 free(decoder->private_->seek_table.data.seek_table.points);
980 decoder->private_->seek_table.data.seek_table.points = 0;
981 decoder->private_->has_seek_table = false;
983 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
985 * This goes in reset() and not flush() because according to the spec, a
986 * fixed-blocksize stream must stay that way through the whole stream.
988 decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size = 0;
990 /* We initialize the FLAC__MD5Context even though we may never use it. This
991 * is because md5 checking may be turned on to start and then turned off if
992 * a seek occurs. So we init the context here and finalize it in
993 * FLAC__stream_decoder_finish() to make sure things are always cleaned up
994 * properly.
996 FLAC__MD5Init(&decoder->private_->md5context);
998 decoder->private_->first_frame_offset = 0;
999 decoder->private_->unparseable_frame_count = 0;
1001 return true;
1004 FLAC_API FLAC__bool FLAC__stream_decoder_process_single(FLAC__StreamDecoder *decoder)
1006 FLAC__bool got_a_frame;
1007 FLAC__ASSERT(0 != decoder);
1008 FLAC__ASSERT(0 != decoder->protected_);
1010 while(1) {
1011 switch(decoder->protected_->state) {
1012 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1013 if(!find_metadata_(decoder))
1014 return false; /* above function sets the status for us */
1015 break;
1016 case FLAC__STREAM_DECODER_READ_METADATA:
1017 if(!read_metadata_(decoder))
1018 return false; /* above function sets the status for us */
1019 else
1020 return true;
1021 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1022 if(!frame_sync_(decoder))
1023 return true; /* above function sets the status for us */
1024 break;
1025 case FLAC__STREAM_DECODER_READ_FRAME:
1026 if(!read_frame_(decoder, &got_a_frame, /*do_full_decode=*/true))
1027 return false; /* above function sets the status for us */
1028 if(got_a_frame)
1029 return true; /* above function sets the status for us */
1030 break;
1031 case FLAC__STREAM_DECODER_END_OF_STREAM:
1032 case FLAC__STREAM_DECODER_ABORTED:
1033 return true;
1034 default:
1035 FLAC__ASSERT(0);
1036 return false;
1041 FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_metadata(FLAC__StreamDecoder *decoder)
1043 FLAC__ASSERT(0 != decoder);
1044 FLAC__ASSERT(0 != decoder->protected_);
1046 while(1) {
1047 switch(decoder->protected_->state) {
1048 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1049 if(!find_metadata_(decoder))
1050 return false; /* above function sets the status for us */
1051 break;
1052 case FLAC__STREAM_DECODER_READ_METADATA:
1053 if(!read_metadata_(decoder))
1054 return false; /* above function sets the status for us */
1055 break;
1056 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1057 case FLAC__STREAM_DECODER_READ_FRAME:
1058 case FLAC__STREAM_DECODER_END_OF_STREAM:
1059 case FLAC__STREAM_DECODER_ABORTED:
1060 return true;
1061 default:
1062 FLAC__ASSERT(0);
1063 return false;
1068 FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_stream(FLAC__StreamDecoder *decoder)
1070 FLAC__bool dummy;
1071 FLAC__ASSERT(0 != decoder);
1072 FLAC__ASSERT(0 != decoder->protected_);
1074 while(1) {
1075 switch(decoder->protected_->state) {
1076 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1077 if(!find_metadata_(decoder))
1078 return false; /* above function sets the status for us */
1079 break;
1080 case FLAC__STREAM_DECODER_READ_METADATA:
1081 if(!read_metadata_(decoder))
1082 return false; /* above function sets the status for us */
1083 break;
1084 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1085 if(!frame_sync_(decoder))
1086 return true; /* above function sets the status for us */
1087 break;
1088 case FLAC__STREAM_DECODER_READ_FRAME:
1089 if(!read_frame_(decoder, &dummy, /*do_full_decode=*/true))
1090 return false; /* above function sets the status for us */
1091 break;
1092 case FLAC__STREAM_DECODER_END_OF_STREAM:
1093 case FLAC__STREAM_DECODER_ABORTED:
1094 return true;
1095 default:
1096 FLAC__ASSERT(0);
1097 return false;
1102 FLAC_API FLAC__bool FLAC__stream_decoder_skip_single_frame(FLAC__StreamDecoder *decoder)
1104 FLAC__bool got_a_frame;
1105 FLAC__ASSERT(0 != decoder);
1106 FLAC__ASSERT(0 != decoder->protected_);
1108 while(1) {
1109 switch(decoder->protected_->state) {
1110 case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1111 case FLAC__STREAM_DECODER_READ_METADATA:
1112 return false; /* above function sets the status for us */
1113 case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1114 if(!frame_sync_(decoder))
1115 return true; /* above function sets the status for us */
1116 break;
1117 case FLAC__STREAM_DECODER_READ_FRAME:
1118 if(!read_frame_(decoder, &got_a_frame, /*do_full_decode=*/false))
1119 return false; /* above function sets the status for us */
1120 if(got_a_frame)
1121 return true; /* above function sets the status for us */
1122 break;
1123 case FLAC__STREAM_DECODER_END_OF_STREAM:
1124 case FLAC__STREAM_DECODER_ABORTED:
1125 return true;
1126 default:
1127 FLAC__ASSERT(0);
1128 return false;
1133 FLAC_API FLAC__bool FLAC__stream_decoder_seek_absolute(FLAC__StreamDecoder *decoder, FLAC__uint64 sample)
1135 FLAC__uint64 length;
1137 FLAC__ASSERT(0 != decoder);
1140 decoder->protected_->state != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA &&
1141 decoder->protected_->state != FLAC__STREAM_DECODER_READ_METADATA &&
1142 decoder->protected_->state != FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC &&
1143 decoder->protected_->state != FLAC__STREAM_DECODER_READ_FRAME &&
1144 decoder->protected_->state != FLAC__STREAM_DECODER_END_OF_STREAM
1146 return false;
1148 if(0 == decoder->private_->seek_callback)
1149 return false;
1151 FLAC__ASSERT(decoder->private_->seek_callback);
1152 FLAC__ASSERT(decoder->private_->tell_callback);
1153 FLAC__ASSERT(decoder->private_->length_callback);
1154 FLAC__ASSERT(decoder->private_->eof_callback);
1156 if(FLAC__stream_decoder_get_total_samples(decoder) > 0 && sample >= FLAC__stream_decoder_get_total_samples(decoder))
1157 return false;
1159 decoder->private_->is_seeking = true;
1161 /* turn off md5 checking if a seek is attempted */
1162 decoder->private_->do_md5_checking = false;
1164 /* get the file length (currently our algorithm needs to know the length so it's also an error to get FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED) */
1165 if(decoder->private_->length_callback(decoder, &length, decoder->private_->client_data) != FLAC__STREAM_DECODER_LENGTH_STATUS_OK) {
1166 decoder->private_->is_seeking = false;
1167 return false;
1170 /* if we haven't finished processing the metadata yet, do that so we have the STREAMINFO, SEEK_TABLE, and first_frame_offset */
1172 decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_METADATA ||
1173 decoder->protected_->state == FLAC__STREAM_DECODER_READ_METADATA
1175 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder)) {
1176 /* above call sets the state for us */
1177 decoder->private_->is_seeking = false;
1178 return false;
1180 /* check this again in case we didn't know total_samples the first time */
1181 if(FLAC__stream_decoder_get_total_samples(decoder) > 0 && sample >= FLAC__stream_decoder_get_total_samples(decoder)) {
1182 decoder->private_->is_seeking = false;
1183 return false;
1188 const FLAC__bool ok =
1189 #if FLAC__HAS_OGG
1190 decoder->private_->is_ogg?
1191 seek_to_absolute_sample_ogg_(decoder, length, sample) :
1192 #endif
1193 seek_to_absolute_sample_(decoder, length, sample)
1195 decoder->private_->is_seeking = false;
1196 return ok;
1200 /***********************************************************************
1202 * Protected class methods
1204 ***********************************************************************/
1206 uint32_t FLAC__stream_decoder_get_input_bytes_unconsumed(const FLAC__StreamDecoder *decoder)
1208 FLAC__ASSERT(0 != decoder);
1209 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1210 FLAC__ASSERT(!(FLAC__bitreader_get_input_bits_unconsumed(decoder->private_->input) & 7));
1211 return FLAC__bitreader_get_input_bits_unconsumed(decoder->private_->input) / 8;
1214 /***********************************************************************
1216 * Private class methods
1218 ***********************************************************************/
1220 void set_defaults_(FLAC__StreamDecoder *decoder)
1222 decoder->private_->is_ogg = false;
1223 decoder->private_->read_callback = 0;
1224 decoder->private_->seek_callback = 0;
1225 decoder->private_->tell_callback = 0;
1226 decoder->private_->length_callback = 0;
1227 decoder->private_->eof_callback = 0;
1228 decoder->private_->write_callback = 0;
1229 decoder->private_->metadata_callback = 0;
1230 decoder->private_->error_callback = 0;
1231 decoder->private_->client_data = 0;
1233 memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
1234 decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] = true;
1235 decoder->private_->metadata_filter_ids_count = 0;
1237 decoder->protected_->md5_checking = false;
1239 #if FLAC__HAS_OGG
1240 FLAC__ogg_decoder_aspect_set_defaults(&decoder->protected_->ogg_decoder_aspect);
1241 #endif
1245 * This will forcibly set stdin to binary mode (for OSes that require it)
1247 FILE *get_binary_stdin_(void)
1249 /* if something breaks here it is probably due to the presence or
1250 * absence of an underscore before the identifiers 'setmode',
1251 * 'fileno', and/or 'O_BINARY'; check your system header files.
1253 #if defined _MSC_VER || defined __MINGW32__
1254 _setmode(_fileno(stdin), _O_BINARY);
1255 #elif defined __EMX__
1256 setmode(fileno(stdin), O_BINARY);
1257 #endif
1259 return stdin;
1262 FLAC__bool allocate_output_(FLAC__StreamDecoder *decoder, uint32_t size, uint32_t channels)
1264 uint32_t i;
1265 FLAC__int32 *tmp;
1267 if(size <= decoder->private_->output_capacity && channels <= decoder->private_->output_channels)
1268 return true;
1270 /* simply using realloc() is not practical because the number of channels may change mid-stream */
1272 for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
1273 if(0 != decoder->private_->output[i]) {
1274 free(decoder->private_->output[i]-4);
1275 decoder->private_->output[i] = 0;
1277 if(0 != decoder->private_->residual_unaligned[i]) {
1278 free(decoder->private_->residual_unaligned[i]);
1279 decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
1283 for(i = 0; i < channels; i++) {
1284 /* WATCHOUT:
1285 * FLAC__lpc_restore_signal_asm_ia32_mmx() and ..._intrin_sseN()
1286 * require that the output arrays have a buffer of up to 3 zeroes
1287 * in front (at negative indices) for alignment purposes;
1288 * we use 4 to keep the data well-aligned.
1290 tmp = safe_malloc_muladd2_(sizeof(FLAC__int32), /*times (*/size, /*+*/4/*)*/);
1291 if(tmp == 0) {
1292 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1293 return false;
1295 memset(tmp, 0, sizeof(FLAC__int32)*4);
1296 decoder->private_->output[i] = tmp + 4;
1298 if(!FLAC__memory_alloc_aligned_int32_array(size, &decoder->private_->residual_unaligned[i], &decoder->private_->residual[i])) {
1299 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1300 return false;
1304 decoder->private_->output_capacity = size;
1305 decoder->private_->output_channels = channels;
1307 return true;
1310 FLAC__bool has_id_filtered_(FLAC__StreamDecoder *decoder, FLAC__byte *id)
1312 size_t i;
1314 FLAC__ASSERT(0 != decoder);
1315 FLAC__ASSERT(0 != decoder->private_);
1317 for(i = 0; i < decoder->private_->metadata_filter_ids_count; i++)
1318 if(0 == memcmp(decoder->private_->metadata_filter_ids + i * (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8), id, (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8)))
1319 return true;
1321 return false;
1324 FLAC__bool find_metadata_(FLAC__StreamDecoder *decoder)
1326 FLAC__uint32 x;
1327 uint32_t i, id;
1328 FLAC__bool first = true;
1330 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1332 for(i = id = 0; i < 4; ) {
1333 if(decoder->private_->cached) {
1334 x = (FLAC__uint32)decoder->private_->lookahead;
1335 decoder->private_->cached = false;
1337 else {
1338 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1339 return false; /* read_callback_ sets the state for us */
1341 if(x == FLAC__STREAM_SYNC_STRING[i]) {
1342 first = true;
1343 i++;
1344 id = 0;
1345 continue;
1348 if(id >= 3)
1349 return false;
1351 if(x == ID3V2_TAG_[id]) {
1352 id++;
1353 i = 0;
1354 if(id == 3) {
1355 if(!skip_id3v2_tag_(decoder))
1356 return false; /* skip_id3v2_tag_ sets the state for us */
1358 continue;
1360 id = 0;
1361 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1362 decoder->private_->header_warmup[0] = (FLAC__byte)x;
1363 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1364 return false; /* read_callback_ sets the state for us */
1366 /* we have to check if we just read two 0xff's in a row; the second may actually be the beginning of the sync code */
1367 /* else we have to check if the second byte is the end of a sync code */
1368 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1369 decoder->private_->lookahead = (FLAC__byte)x;
1370 decoder->private_->cached = true;
1372 else if(x >> 1 == 0x7c) { /* MAGIC NUMBER for the last 6 sync bits and reserved 7th bit */
1373 decoder->private_->header_warmup[1] = (FLAC__byte)x;
1374 decoder->protected_->state = FLAC__STREAM_DECODER_READ_FRAME;
1375 return true;
1378 i = 0;
1379 if(first) {
1380 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
1381 first = false;
1385 decoder->protected_->state = FLAC__STREAM_DECODER_READ_METADATA;
1386 return true;
1389 FLAC__bool read_metadata_(FLAC__StreamDecoder *decoder)
1391 FLAC__bool is_last;
1392 FLAC__uint32 i, x, type, length;
1394 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1396 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_IS_LAST_LEN))
1397 return false; /* read_callback_ sets the state for us */
1398 is_last = x? true : false;
1400 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &type, FLAC__STREAM_METADATA_TYPE_LEN))
1401 return false; /* read_callback_ sets the state for us */
1403 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &length, FLAC__STREAM_METADATA_LENGTH_LEN))
1404 return false; /* read_callback_ sets the state for us */
1406 if(type == FLAC__METADATA_TYPE_STREAMINFO) {
1407 if(!read_metadata_streaminfo_(decoder, is_last, length))
1408 return false;
1410 decoder->private_->has_stream_info = true;
1411 if(0 == memcmp(decoder->private_->stream_info.data.stream_info.md5sum, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", 16))
1412 decoder->private_->do_md5_checking = false;
1413 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] && decoder->private_->metadata_callback)
1414 decoder->private_->metadata_callback(decoder, &decoder->private_->stream_info, decoder->private_->client_data);
1416 else if(type == FLAC__METADATA_TYPE_SEEKTABLE) {
1417 /* just in case we already have a seek table, and reading the next one fails: */
1418 decoder->private_->has_seek_table = false;
1420 if(!read_metadata_seektable_(decoder, is_last, length))
1421 return false;
1423 decoder->private_->has_seek_table = true;
1424 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_SEEKTABLE] && decoder->private_->metadata_callback)
1425 decoder->private_->metadata_callback(decoder, &decoder->private_->seek_table, decoder->private_->client_data);
1427 else {
1428 FLAC__bool skip_it = !decoder->private_->metadata_filter[type];
1429 uint32_t real_length = length;
1430 FLAC__StreamMetadata block;
1432 memset(&block, 0, sizeof(block));
1433 block.is_last = is_last;
1434 block.type = (FLAC__MetadataType)type;
1435 block.length = length;
1437 if(type == FLAC__METADATA_TYPE_APPLICATION) {
1438 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8))
1439 return false; /* read_callback_ sets the state for us */
1441 if(real_length < FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) { /* underflow check */
1442 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;/*@@@@@@ maybe wrong error? need to resync?*/
1443 return false;
1446 real_length -= FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8;
1448 if(decoder->private_->metadata_filter_ids_count > 0 && has_id_filtered_(decoder, block.data.application.id))
1449 skip_it = !skip_it;
1452 if(skip_it) {
1453 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1454 return false; /* read_callback_ sets the state for us */
1456 else {
1457 FLAC__bool ok = true;
1458 switch(type) {
1459 case FLAC__METADATA_TYPE_PADDING:
1460 /* skip the padding bytes */
1461 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1462 ok = false; /* read_callback_ sets the state for us */
1463 break;
1464 case FLAC__METADATA_TYPE_APPLICATION:
1465 /* remember, we read the ID already */
1466 if(real_length > 0) {
1467 if(0 == (block.data.application.data = malloc(real_length))) {
1468 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1469 ok = false;
1471 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.data, real_length))
1472 ok = false; /* read_callback_ sets the state for us */
1474 else
1475 block.data.application.data = 0;
1476 break;
1477 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1478 if(!read_metadata_vorbiscomment_(decoder, &block.data.vorbis_comment, real_length))
1479 ok = false;
1480 break;
1481 case FLAC__METADATA_TYPE_CUESHEET:
1482 if(!read_metadata_cuesheet_(decoder, &block.data.cue_sheet))
1483 ok = false;
1484 break;
1485 case FLAC__METADATA_TYPE_PICTURE:
1486 if(!read_metadata_picture_(decoder, &block.data.picture))
1487 ok = false;
1488 break;
1489 case FLAC__METADATA_TYPE_STREAMINFO:
1490 case FLAC__METADATA_TYPE_SEEKTABLE:
1491 FLAC__ASSERT(0);
1492 break;
1493 default:
1494 if(real_length > 0) {
1495 if(0 == (block.data.unknown.data = malloc(real_length))) {
1496 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1497 ok = false;
1499 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.unknown.data, real_length))
1500 ok = false; /* read_callback_ sets the state for us */
1502 else
1503 block.data.unknown.data = 0;
1504 break;
1506 if(ok && !decoder->private_->is_seeking && decoder->private_->metadata_callback)
1507 decoder->private_->metadata_callback(decoder, &block, decoder->private_->client_data);
1509 /* now we have to free any malloc()ed data in the block */
1510 switch(type) {
1511 case FLAC__METADATA_TYPE_PADDING:
1512 break;
1513 case FLAC__METADATA_TYPE_APPLICATION:
1514 if(0 != block.data.application.data)
1515 free(block.data.application.data);
1516 break;
1517 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1518 if(0 != block.data.vorbis_comment.vendor_string.entry)
1519 free(block.data.vorbis_comment.vendor_string.entry);
1520 if(block.data.vorbis_comment.num_comments > 0)
1521 for(i = 0; i < block.data.vorbis_comment.num_comments; i++)
1522 if(0 != block.data.vorbis_comment.comments[i].entry)
1523 free(block.data.vorbis_comment.comments[i].entry);
1524 if(0 != block.data.vorbis_comment.comments)
1525 free(block.data.vorbis_comment.comments);
1526 break;
1527 case FLAC__METADATA_TYPE_CUESHEET:
1528 if(block.data.cue_sheet.num_tracks > 0)
1529 for(i = 0; i < block.data.cue_sheet.num_tracks; i++)
1530 if(0 != block.data.cue_sheet.tracks[i].indices)
1531 free(block.data.cue_sheet.tracks[i].indices);
1532 if(0 != block.data.cue_sheet.tracks)
1533 free(block.data.cue_sheet.tracks);
1534 break;
1535 case FLAC__METADATA_TYPE_PICTURE:
1536 if(0 != block.data.picture.mime_type)
1537 free(block.data.picture.mime_type);
1538 if(0 != block.data.picture.description)
1539 free(block.data.picture.description);
1540 if(0 != block.data.picture.data)
1541 free(block.data.picture.data);
1542 break;
1543 case FLAC__METADATA_TYPE_STREAMINFO:
1544 case FLAC__METADATA_TYPE_SEEKTABLE:
1545 FLAC__ASSERT(0);
1546 default:
1547 if(0 != block.data.unknown.data)
1548 free(block.data.unknown.data);
1549 break;
1552 if(!ok) /* anything that unsets "ok" should also make sure decoder->protected_->state is updated */
1553 return false;
1557 if(is_last) {
1558 /* if this fails, it's OK, it's just a hint for the seek routine */
1559 if(!FLAC__stream_decoder_get_decode_position(decoder, &decoder->private_->first_frame_offset))
1560 decoder->private_->first_frame_offset = 0;
1561 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
1564 return true;
1567 FLAC__bool read_metadata_streaminfo_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, uint32_t length)
1569 FLAC__uint32 x;
1570 uint32_t bits, used_bits = 0;
1572 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1574 decoder->private_->stream_info.type = FLAC__METADATA_TYPE_STREAMINFO;
1575 decoder->private_->stream_info.is_last = is_last;
1576 decoder->private_->stream_info.length = length;
1578 bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN;
1579 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, bits))
1580 return false; /* read_callback_ sets the state for us */
1581 decoder->private_->stream_info.data.stream_info.min_blocksize = x;
1582 used_bits += bits;
1584 bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN;
1585 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
1586 return false; /* read_callback_ sets the state for us */
1587 decoder->private_->stream_info.data.stream_info.max_blocksize = x;
1588 used_bits += bits;
1590 bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN;
1591 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
1592 return false; /* read_callback_ sets the state for us */
1593 decoder->private_->stream_info.data.stream_info.min_framesize = x;
1594 used_bits += bits;
1596 bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN;
1597 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
1598 return false; /* read_callback_ sets the state for us */
1599 decoder->private_->stream_info.data.stream_info.max_framesize = x;
1600 used_bits += bits;
1602 bits = FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN;
1603 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
1604 return false; /* read_callback_ sets the state for us */
1605 decoder->private_->stream_info.data.stream_info.sample_rate = x;
1606 used_bits += bits;
1608 bits = FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN;
1609 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
1610 return false; /* read_callback_ sets the state for us */
1611 decoder->private_->stream_info.data.stream_info.channels = x+1;
1612 used_bits += bits;
1614 bits = FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN;
1615 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
1616 return false; /* read_callback_ sets the state for us */
1617 decoder->private_->stream_info.data.stream_info.bits_per_sample = x+1;
1618 used_bits += bits;
1620 bits = FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN;
1621 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &decoder->private_->stream_info.data.stream_info.total_samples, FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN))
1622 return false; /* read_callback_ sets the state for us */
1623 used_bits += bits;
1625 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, decoder->private_->stream_info.data.stream_info.md5sum, 16))
1626 return false; /* read_callback_ sets the state for us */
1627 used_bits += 16*8;
1629 /* skip the rest of the block */
1630 FLAC__ASSERT(used_bits % 8 == 0);
1631 length -= (used_bits / 8);
1632 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1633 return false; /* read_callback_ sets the state for us */
1635 return true;
1638 FLAC__bool read_metadata_seektable_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, uint32_t length)
1640 FLAC__uint32 i, x;
1641 FLAC__uint64 xx;
1643 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1645 decoder->private_->seek_table.type = FLAC__METADATA_TYPE_SEEKTABLE;
1646 decoder->private_->seek_table.is_last = is_last;
1647 decoder->private_->seek_table.length = length;
1649 decoder->private_->seek_table.data.seek_table.num_points = length / FLAC__STREAM_METADATA_SEEKPOINT_LENGTH;
1651 /* use realloc since we may pass through here several times (e.g. after seeking) */
1652 if(0 == (decoder->private_->seek_table.data.seek_table.points = safe_realloc_mul_2op_(decoder->private_->seek_table.data.seek_table.points, decoder->private_->seek_table.data.seek_table.num_points, /*times*/sizeof(FLAC__StreamMetadata_SeekPoint)))) {
1653 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1654 return false;
1656 for(i = 0; i < decoder->private_->seek_table.data.seek_table.num_points; i++) {
1657 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
1658 return false; /* read_callback_ sets the state for us */
1659 decoder->private_->seek_table.data.seek_table.points[i].sample_number = xx;
1661 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
1662 return false; /* read_callback_ sets the state for us */
1663 decoder->private_->seek_table.data.seek_table.points[i].stream_offset = xx;
1665 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
1666 return false; /* read_callback_ sets the state for us */
1667 decoder->private_->seek_table.data.seek_table.points[i].frame_samples = x;
1669 length -= (decoder->private_->seek_table.data.seek_table.num_points * FLAC__STREAM_METADATA_SEEKPOINT_LENGTH);
1670 /* if there is a partial point left, skip over it */
1671 if(length > 0) {
1672 /*@@@ do a send_error_to_client_() here? there's an argument for either way */
1673 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1674 return false; /* read_callback_ sets the state for us */
1677 return true;
1680 FLAC__bool read_metadata_vorbiscomment_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_VorbisComment *obj, uint32_t length)
1682 FLAC__uint32 i;
1684 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1686 /* read vendor string */
1687 if (length >= 8) {
1688 length -= 8; /* vendor string length + num comments entries alone take 8 bytes */
1689 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1690 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->vendor_string.length))
1691 return false; /* read_callback_ sets the state for us */
1692 if (obj->vendor_string.length > 0) {
1693 if (length < obj->vendor_string.length) {
1694 obj->vendor_string.length = 0;
1695 obj->vendor_string.entry = 0;
1696 goto skip;
1698 else
1699 length -= obj->vendor_string.length;
1700 if (0 == (obj->vendor_string.entry = safe_malloc_add_2op_(obj->vendor_string.length, /*+*/1))) {
1701 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1702 return false;
1704 if (!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->vendor_string.entry, obj->vendor_string.length))
1705 return false; /* read_callback_ sets the state for us */
1706 obj->vendor_string.entry[obj->vendor_string.length] = '\0';
1708 else
1709 obj->vendor_string.entry = 0;
1711 /* read num comments */
1712 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN == 32);
1713 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->num_comments))
1714 return false; /* read_callback_ sets the state for us */
1716 /* read comments */
1717 if (obj->num_comments > 100000) {
1718 /* Possibly malicious file. */
1719 obj->num_comments = 0;
1720 return false;
1722 if (obj->num_comments > 0) {
1723 if (0 == (obj->comments = safe_malloc_mul_2op_p(obj->num_comments, /*times*/sizeof(FLAC__StreamMetadata_VorbisComment_Entry)))) {
1724 obj->num_comments = 0;
1725 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1726 return false;
1728 for (i = 0; i < obj->num_comments; i++) {
1729 /* Initialize here just to make sure. */
1730 obj->comments[i].length = 0;
1731 obj->comments[i].entry = 0;
1733 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1734 if (length < 4) {
1735 obj->num_comments = i;
1736 goto skip;
1738 else
1739 length -= 4;
1740 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->comments[i].length)) {
1741 obj->num_comments = i;
1742 return false; /* read_callback_ sets the state for us */
1744 if (obj->comments[i].length > 0) {
1745 if (length < obj->comments[i].length) {
1746 obj->num_comments = i;
1747 goto skip;
1749 else
1750 length -= obj->comments[i].length;
1751 if (0 == (obj->comments[i].entry = safe_malloc_add_2op_(obj->comments[i].length, /*+*/1))) {
1752 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1753 obj->num_comments = i;
1754 return false;
1756 memset (obj->comments[i].entry, 0, obj->comments[i].length) ;
1757 if (!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->comments[i].entry, obj->comments[i].length)) {
1758 /* Current i-th entry is bad, so we delete it. */
1759 free (obj->comments[i].entry) ;
1760 obj->comments[i].entry = NULL ;
1761 obj->num_comments = i;
1762 goto skip;
1764 obj->comments[i].entry[obj->comments[i].length] = '\0';
1766 else
1767 obj->comments[i].entry = 0;
1772 skip:
1773 if (length > 0) {
1774 /* length > 0 can only happen on files with invalid data in comments */
1775 if(obj->num_comments < 1) {
1776 free(obj->comments);
1777 obj->comments = NULL;
1779 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1780 return false; /* read_callback_ sets the state for us */
1783 return true;
1786 FLAC__bool read_metadata_cuesheet_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_CueSheet *obj)
1788 FLAC__uint32 i, j, x;
1790 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1792 memset(obj, 0, sizeof(FLAC__StreamMetadata_CueSheet));
1794 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN % 8 == 0);
1795 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, (FLAC__byte*)obj->media_catalog_number, FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN/8))
1796 return false; /* read_callback_ sets the state for us */
1798 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &obj->lead_in, FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN))
1799 return false; /* read_callback_ sets the state for us */
1801 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN))
1802 return false; /* read_callback_ sets the state for us */
1803 obj->is_cd = x? true : false;
1805 if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN))
1806 return false; /* read_callback_ sets the state for us */
1808 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN))
1809 return false; /* read_callback_ sets the state for us */
1810 obj->num_tracks = x;
1812 if(obj->num_tracks > 0) {
1813 if(0 == (obj->tracks = safe_calloc_(obj->num_tracks, sizeof(FLAC__StreamMetadata_CueSheet_Track)))) {
1814 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1815 return false;
1817 for(i = 0; i < obj->num_tracks; i++) {
1818 FLAC__StreamMetadata_CueSheet_Track *track = &obj->tracks[i];
1819 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &track->offset, FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN))
1820 return false; /* read_callback_ sets the state for us */
1822 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN))
1823 return false; /* read_callback_ sets the state for us */
1824 track->number = (FLAC__byte)x;
1826 FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN % 8 == 0);
1827 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, (FLAC__byte*)track->isrc, FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN/8))
1828 return false; /* read_callback_ sets the state for us */
1830 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN))
1831 return false; /* read_callback_ sets the state for us */
1832 track->type = x;
1834 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN))
1835 return false; /* read_callback_ sets the state for us */
1836 track->pre_emphasis = x;
1838 if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN))
1839 return false; /* read_callback_ sets the state for us */
1841 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN))
1842 return false; /* read_callback_ sets the state for us */
1843 track->num_indices = (FLAC__byte)x;
1845 if(track->num_indices > 0) {
1846 if(0 == (track->indices = safe_calloc_(track->num_indices, sizeof(FLAC__StreamMetadata_CueSheet_Index)))) {
1847 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1848 return false;
1850 for(j = 0; j < track->num_indices; j++) {
1851 FLAC__StreamMetadata_CueSheet_Index *indx = &track->indices[j];
1852 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &indx->offset, FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN))
1853 return false; /* read_callback_ sets the state for us */
1855 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN))
1856 return false; /* read_callback_ sets the state for us */
1857 indx->number = (FLAC__byte)x;
1859 if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN))
1860 return false; /* read_callback_ sets the state for us */
1866 return true;
1869 FLAC__bool read_metadata_picture_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_Picture *obj)
1871 FLAC__uint32 x;
1873 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1875 /* read type */
1876 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_TYPE_LEN))
1877 return false; /* read_callback_ sets the state for us */
1878 obj->type = x;
1880 /* read MIME type */
1881 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN))
1882 return false; /* read_callback_ sets the state for us */
1883 if(0 == (obj->mime_type = safe_malloc_add_2op_(x, /*+*/1))) {
1884 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1885 return false;
1887 if(x > 0) {
1888 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, (FLAC__byte*)obj->mime_type, x))
1889 return false; /* read_callback_ sets the state for us */
1891 obj->mime_type[x] = '\0';
1893 /* read description */
1894 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN))
1895 return false; /* read_callback_ sets the state for us */
1896 if(0 == (obj->description = safe_malloc_add_2op_(x, /*+*/1))) {
1897 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1898 return false;
1900 if(x > 0) {
1901 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->description, x))
1902 return false; /* read_callback_ sets the state for us */
1904 obj->description[x] = '\0';
1906 /* read width */
1907 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->width, FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN))
1908 return false; /* read_callback_ sets the state for us */
1910 /* read height */
1911 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->height, FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN))
1912 return false; /* read_callback_ sets the state for us */
1914 /* read depth */
1915 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->depth, FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN))
1916 return false; /* read_callback_ sets the state for us */
1918 /* read colors */
1919 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->colors, FLAC__STREAM_METADATA_PICTURE_COLORS_LEN))
1920 return false; /* read_callback_ sets the state for us */
1922 /* read data */
1923 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &(obj->data_length), FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN))
1924 return false; /* read_callback_ sets the state for us */
1925 if(0 == (obj->data = safe_malloc_(obj->data_length))) {
1926 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1927 return false;
1929 if(obj->data_length > 0) {
1930 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->data, obj->data_length))
1931 return false; /* read_callback_ sets the state for us */
1934 return true;
1937 FLAC__bool skip_id3v2_tag_(FLAC__StreamDecoder *decoder)
1939 FLAC__uint32 x;
1940 uint32_t i, skip;
1942 /* skip the version and flags bytes */
1943 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 24))
1944 return false; /* read_callback_ sets the state for us */
1945 /* get the size (in bytes) to skip */
1946 skip = 0;
1947 for(i = 0; i < 4; i++) {
1948 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1949 return false; /* read_callback_ sets the state for us */
1950 skip <<= 7;
1951 skip |= (x & 0x7f);
1953 /* skip the rest of the tag */
1954 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, skip))
1955 return false; /* read_callback_ sets the state for us */
1956 return true;
1959 FLAC__bool frame_sync_(FLAC__StreamDecoder *decoder)
1961 FLAC__uint32 x;
1962 FLAC__bool first = true;
1964 /* If we know the total number of samples in the stream, stop if we've read that many. */
1965 /* This will stop us, for example, from wasting time trying to sync on an ID3V1 tag. */
1966 if(FLAC__stream_decoder_get_total_samples(decoder) > 0) {
1967 if(decoder->private_->samples_decoded >= FLAC__stream_decoder_get_total_samples(decoder)) {
1968 decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
1969 return true;
1973 /* make sure we're byte aligned */
1974 if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input)) {
1975 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__bitreader_bits_left_for_byte_alignment(decoder->private_->input)))
1976 return false; /* read_callback_ sets the state for us */
1979 while(1) {
1980 if(decoder->private_->cached) {
1981 x = (FLAC__uint32)decoder->private_->lookahead;
1982 decoder->private_->cached = false;
1984 else {
1985 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1986 return false; /* read_callback_ sets the state for us */
1988 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1989 decoder->private_->header_warmup[0] = (FLAC__byte)x;
1990 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1991 return false; /* read_callback_ sets the state for us */
1993 /* we have to check if we just read two 0xff's in a row; the second may actually be the beginning of the sync code */
1994 /* else we have to check if the second byte is the end of a sync code */
1995 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1996 decoder->private_->lookahead = (FLAC__byte)x;
1997 decoder->private_->cached = true;
1999 else if(x >> 1 == 0x7c) { /* MAGIC NUMBER for the last 6 sync bits and reserved 7th bit */
2000 decoder->private_->header_warmup[1] = (FLAC__byte)x;
2001 decoder->protected_->state = FLAC__STREAM_DECODER_READ_FRAME;
2002 return true;
2005 if(first) {
2006 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2007 first = false;
2011 return true;
2014 FLAC__bool read_frame_(FLAC__StreamDecoder *decoder, FLAC__bool *got_a_frame, FLAC__bool do_full_decode)
2016 uint32_t channel;
2017 uint32_t i;
2018 FLAC__int32 mid, side;
2019 uint32_t frame_crc; /* the one we calculate from the input stream */
2020 FLAC__uint32 x;
2022 *got_a_frame = false;
2024 /* init the CRC */
2025 frame_crc = 0;
2026 frame_crc = FLAC__CRC16_UPDATE(decoder->private_->header_warmup[0], frame_crc);
2027 frame_crc = FLAC__CRC16_UPDATE(decoder->private_->header_warmup[1], frame_crc);
2028 FLAC__bitreader_reset_read_crc16(decoder->private_->input, (FLAC__uint16)frame_crc);
2030 if(!read_frame_header_(decoder))
2031 return false;
2032 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means we didn't sync on a valid header */
2033 return true;
2034 if(!allocate_output_(decoder, decoder->private_->frame.header.blocksize, decoder->private_->frame.header.channels))
2035 return false;
2036 for(channel = 0; channel < decoder->private_->frame.header.channels; channel++) {
2038 * first figure the correct bits-per-sample of the subframe
2040 uint32_t bps = decoder->private_->frame.header.bits_per_sample;
2041 switch(decoder->private_->frame.header.channel_assignment) {
2042 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
2043 /* no adjustment needed */
2044 break;
2045 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
2046 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2047 if(channel == 1)
2048 bps++;
2049 break;
2050 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
2051 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2052 if(channel == 0)
2053 bps++;
2054 break;
2055 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
2056 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2057 if(channel == 1)
2058 bps++;
2059 break;
2060 default:
2061 FLAC__ASSERT(0);
2064 * now read it
2066 if(!read_subframe_(decoder, channel, bps, do_full_decode))
2067 return false;
2068 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2069 return true;
2071 if(!read_zero_padding_(decoder))
2072 return false;
2073 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption (i.e. "zero bits" were not all zeroes) */
2074 return true;
2077 * Read the frame CRC-16 from the footer and check
2079 frame_crc = FLAC__bitreader_get_read_crc16(decoder->private_->input);
2080 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__FRAME_FOOTER_CRC_LEN))
2081 return false; /* read_callback_ sets the state for us */
2082 if(frame_crc == x) {
2083 if(do_full_decode) {
2084 /* Undo any special channel coding */
2085 switch(decoder->private_->frame.header.channel_assignment) {
2086 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
2087 /* do nothing */
2088 break;
2089 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
2090 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2091 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2092 decoder->private_->output[1][i] = decoder->private_->output[0][i] - decoder->private_->output[1][i];
2093 break;
2094 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
2095 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2096 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2097 decoder->private_->output[0][i] += decoder->private_->output[1][i];
2098 break;
2099 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
2100 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2101 for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2102 #if 1
2103 mid = decoder->private_->output[0][i];
2104 side = decoder->private_->output[1][i];
2105 mid = ((uint32_t) mid) << 1;
2106 mid |= (side & 1); /* i.e. if 'side' is odd... */
2107 decoder->private_->output[0][i] = (mid + side) >> 1;
2108 decoder->private_->output[1][i] = (mid - side) >> 1;
2109 #else
2110 /* OPT: without 'side' temp variable */
2111 mid = (decoder->private_->output[0][i] << 1) | (decoder->private_->output[1][i] & 1); /* i.e. if 'side' is odd... */
2112 decoder->private_->output[0][i] = (mid + decoder->private_->output[1][i]) >> 1;
2113 decoder->private_->output[1][i] = (mid - decoder->private_->output[1][i]) >> 1;
2114 #endif
2116 break;
2117 default:
2118 FLAC__ASSERT(0);
2119 break;
2123 else {
2124 /* Bad frame, emit error and zero the output signal */
2125 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH);
2126 if(do_full_decode) {
2127 for(channel = 0; channel < decoder->private_->frame.header.channels; channel++) {
2128 memset(decoder->private_->output[channel], 0, sizeof(FLAC__int32) * decoder->private_->frame.header.blocksize);
2133 *got_a_frame = true;
2135 /* we wait to update fixed_block_size until here, when we're sure we've got a proper frame and hence a correct blocksize */
2136 if(decoder->private_->next_fixed_block_size)
2137 decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size;
2139 /* put the latest values into the public section of the decoder instance */
2140 decoder->protected_->channels = decoder->private_->frame.header.channels;
2141 decoder->protected_->channel_assignment = decoder->private_->frame.header.channel_assignment;
2142 decoder->protected_->bits_per_sample = decoder->private_->frame.header.bits_per_sample;
2143 decoder->protected_->sample_rate = decoder->private_->frame.header.sample_rate;
2144 decoder->protected_->blocksize = decoder->private_->frame.header.blocksize;
2146 FLAC__ASSERT(decoder->private_->frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
2147 decoder->private_->samples_decoded = decoder->private_->frame.header.number.sample_number + decoder->private_->frame.header.blocksize;
2149 /* write it */
2150 if(do_full_decode) {
2151 if(write_audio_frame_to_client_(decoder, &decoder->private_->frame, (const FLAC__int32 * const *)decoder->private_->output) != FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE) {
2152 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2153 return false;
2157 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2158 return true;
2161 FLAC__bool read_frame_header_(FLAC__StreamDecoder *decoder)
2163 FLAC__uint32 x;
2164 FLAC__uint64 xx;
2165 uint32_t i, blocksize_hint = 0, sample_rate_hint = 0;
2166 FLAC__byte crc8, raw_header[16]; /* MAGIC NUMBER based on the maximum frame header size, including CRC */
2167 uint32_t raw_header_len;
2168 FLAC__bool is_unparseable = false;
2170 FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
2172 /* init the raw header with the saved bits from synchronization */
2173 raw_header[0] = decoder->private_->header_warmup[0];
2174 raw_header[1] = decoder->private_->header_warmup[1];
2175 raw_header_len = 2;
2177 /* check to make sure that reserved bit is 0 */
2178 if(raw_header[1] & 0x02) /* MAGIC NUMBER */
2179 is_unparseable = true;
2182 * Note that along the way as we read the header, we look for a sync
2183 * code inside. If we find one it would indicate that our original
2184 * sync was bad since there cannot be a sync code in a valid header.
2186 * Three kinds of things can go wrong when reading the frame header:
2187 * 1) We may have sync'ed incorrectly and not landed on a frame header.
2188 * If we don't find a sync code, it can end up looking like we read
2189 * a valid but unparseable header, until getting to the frame header
2190 * CRC. Even then we could get a false positive on the CRC.
2191 * 2) We may have sync'ed correctly but on an unparseable frame (from a
2192 * future encoder).
2193 * 3) We may be on a damaged frame which appears valid but unparseable.
2195 * For all these reasons, we try and read a complete frame header as
2196 * long as it seems valid, even if unparseable, up until the frame
2197 * header CRC.
2201 * read in the raw header as bytes so we can CRC it, and parse it on the way
2203 for(i = 0; i < 2; i++) {
2204 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2205 return false; /* read_callback_ sets the state for us */
2206 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
2207 /* if we get here it means our original sync was erroneous since the sync code cannot appear in the header */
2208 decoder->private_->lookahead = (FLAC__byte)x;
2209 decoder->private_->cached = true;
2210 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2211 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2212 return true;
2214 raw_header[raw_header_len++] = (FLAC__byte)x;
2217 switch(x = raw_header[2] >> 4) {
2218 case 0:
2219 is_unparseable = true;
2220 break;
2221 case 1:
2222 decoder->private_->frame.header.blocksize = 192;
2223 break;
2224 case 2:
2225 case 3:
2226 case 4:
2227 case 5:
2228 decoder->private_->frame.header.blocksize = 576 << (x-2);
2229 break;
2230 case 6:
2231 case 7:
2232 blocksize_hint = x;
2233 break;
2234 case 8:
2235 case 9:
2236 case 10:
2237 case 11:
2238 case 12:
2239 case 13:
2240 case 14:
2241 case 15:
2242 decoder->private_->frame.header.blocksize = 256 << (x-8);
2243 break;
2244 default:
2245 FLAC__ASSERT(0);
2246 break;
2249 switch(x = raw_header[2] & 0x0f) {
2250 case 0:
2251 if(decoder->private_->has_stream_info)
2252 decoder->private_->frame.header.sample_rate = decoder->private_->stream_info.data.stream_info.sample_rate;
2253 else
2254 is_unparseable = true;
2255 break;
2256 case 1:
2257 decoder->private_->frame.header.sample_rate = 88200;
2258 break;
2259 case 2:
2260 decoder->private_->frame.header.sample_rate = 176400;
2261 break;
2262 case 3:
2263 decoder->private_->frame.header.sample_rate = 192000;
2264 break;
2265 case 4:
2266 decoder->private_->frame.header.sample_rate = 8000;
2267 break;
2268 case 5:
2269 decoder->private_->frame.header.sample_rate = 16000;
2270 break;
2271 case 6:
2272 decoder->private_->frame.header.sample_rate = 22050;
2273 break;
2274 case 7:
2275 decoder->private_->frame.header.sample_rate = 24000;
2276 break;
2277 case 8:
2278 decoder->private_->frame.header.sample_rate = 32000;
2279 break;
2280 case 9:
2281 decoder->private_->frame.header.sample_rate = 44100;
2282 break;
2283 case 10:
2284 decoder->private_->frame.header.sample_rate = 48000;
2285 break;
2286 case 11:
2287 decoder->private_->frame.header.sample_rate = 96000;
2288 break;
2289 case 12:
2290 case 13:
2291 case 14:
2292 sample_rate_hint = x;
2293 break;
2294 case 15:
2295 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2296 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2297 return true;
2298 default:
2299 FLAC__ASSERT(0);
2302 x = (uint32_t)(raw_header[3] >> 4);
2303 if(x & 8) {
2304 decoder->private_->frame.header.channels = 2;
2305 switch(x & 7) {
2306 case 0:
2307 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE;
2308 break;
2309 case 1:
2310 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE;
2311 break;
2312 case 2:
2313 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_MID_SIDE;
2314 break;
2315 default:
2316 is_unparseable = true;
2317 break;
2320 else {
2321 decoder->private_->frame.header.channels = (uint32_t)x + 1;
2322 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT;
2325 switch(x = (uint32_t)(raw_header[3] & 0x0e) >> 1) {
2326 case 0:
2327 if(decoder->private_->has_stream_info)
2328 decoder->private_->frame.header.bits_per_sample = decoder->private_->stream_info.data.stream_info.bits_per_sample;
2329 else
2330 is_unparseable = true;
2331 break;
2332 case 1:
2333 decoder->private_->frame.header.bits_per_sample = 8;
2334 break;
2335 case 2:
2336 decoder->private_->frame.header.bits_per_sample = 12;
2337 break;
2338 case 4:
2339 decoder->private_->frame.header.bits_per_sample = 16;
2340 break;
2341 case 5:
2342 decoder->private_->frame.header.bits_per_sample = 20;
2343 break;
2344 case 6:
2345 decoder->private_->frame.header.bits_per_sample = 24;
2346 break;
2347 case 3:
2348 case 7:
2349 is_unparseable = true;
2350 break;
2351 default:
2352 FLAC__ASSERT(0);
2353 break;
2356 /* check to make sure that reserved bit is 0 */
2357 if(raw_header[3] & 0x01) /* MAGIC NUMBER */
2358 is_unparseable = true;
2360 /* read the frame's starting sample number (or frame number as the case may be) */
2362 raw_header[1] & 0x01 ||
2363 /*@@@ this clause is a concession to the old way of doing variable blocksize; the only known implementation is flake and can probably be removed without inconveniencing anyone */
2364 (decoder->private_->has_stream_info && decoder->private_->stream_info.data.stream_info.min_blocksize != decoder->private_->stream_info.data.stream_info.max_blocksize)
2365 ) { /* variable blocksize */
2366 if(!FLAC__bitreader_read_utf8_uint64(decoder->private_->input, &xx, raw_header, &raw_header_len))
2367 return false; /* read_callback_ sets the state for us */
2368 if(xx == FLAC__U64L(0xffffffffffffffff)) { /* i.e. non-UTF8 code... */
2369 decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2370 decoder->private_->cached = true;
2371 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2372 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2373 return true;
2375 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2376 decoder->private_->frame.header.number.sample_number = xx;
2378 else { /* fixed blocksize */
2379 if(!FLAC__bitreader_read_utf8_uint32(decoder->private_->input, &x, raw_header, &raw_header_len))
2380 return false; /* read_callback_ sets the state for us */
2381 if(x == 0xffffffff) { /* i.e. non-UTF8 code... */
2382 decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2383 decoder->private_->cached = true;
2384 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2385 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2386 return true;
2388 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER;
2389 decoder->private_->frame.header.number.frame_number = x;
2392 if(blocksize_hint) {
2393 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2394 return false; /* read_callback_ sets the state for us */
2395 raw_header[raw_header_len++] = (FLAC__byte)x;
2396 if(blocksize_hint == 7) {
2397 FLAC__uint32 _x;
2398 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2399 return false; /* read_callback_ sets the state for us */
2400 raw_header[raw_header_len++] = (FLAC__byte)_x;
2401 x = (x << 8) | _x;
2403 decoder->private_->frame.header.blocksize = x+1;
2406 if(sample_rate_hint) {
2407 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2408 return false; /* read_callback_ sets the state for us */
2409 raw_header[raw_header_len++] = (FLAC__byte)x;
2410 if(sample_rate_hint != 12) {
2411 FLAC__uint32 _x;
2412 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2413 return false; /* read_callback_ sets the state for us */
2414 raw_header[raw_header_len++] = (FLAC__byte)_x;
2415 x = (x << 8) | _x;
2417 if(sample_rate_hint == 12)
2418 decoder->private_->frame.header.sample_rate = x*1000;
2419 else if(sample_rate_hint == 13)
2420 decoder->private_->frame.header.sample_rate = x;
2421 else
2422 decoder->private_->frame.header.sample_rate = x*10;
2425 /* read the CRC-8 byte */
2426 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2427 return false; /* read_callback_ sets the state for us */
2428 crc8 = (FLAC__byte)x;
2430 if(FLAC__crc8(raw_header, raw_header_len) != crc8) {
2431 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2432 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2433 return true;
2436 /* calculate the sample number from the frame number if needed */
2437 decoder->private_->next_fixed_block_size = 0;
2438 if(decoder->private_->frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER) {
2439 x = decoder->private_->frame.header.number.frame_number;
2440 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2441 if(decoder->private_->fixed_block_size)
2442 decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->fixed_block_size * (FLAC__uint64)x;
2443 else if(decoder->private_->has_stream_info) {
2444 if(decoder->private_->stream_info.data.stream_info.min_blocksize == decoder->private_->stream_info.data.stream_info.max_blocksize) {
2445 decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->stream_info.data.stream_info.min_blocksize * (FLAC__uint64)x;
2446 decoder->private_->next_fixed_block_size = decoder->private_->stream_info.data.stream_info.max_blocksize;
2448 else
2449 is_unparseable = true;
2451 else if(x == 0) {
2452 decoder->private_->frame.header.number.sample_number = 0;
2453 decoder->private_->next_fixed_block_size = decoder->private_->frame.header.blocksize;
2455 else {
2456 /* can only get here if the stream has invalid frame numbering and no STREAMINFO, so assume it's not the last (possibly short) frame */
2457 decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->frame.header.blocksize * (FLAC__uint64)x;
2461 if(is_unparseable) {
2462 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2463 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2464 return true;
2467 return true;
2470 FLAC__bool read_subframe_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode)
2472 FLAC__uint32 x;
2473 FLAC__bool wasted_bits;
2474 uint32_t i;
2476 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8)) /* MAGIC NUMBER */
2477 return false; /* read_callback_ sets the state for us */
2479 wasted_bits = (x & 1);
2480 x &= 0xfe;
2482 if(wasted_bits) {
2483 uint32_t u;
2484 if(!FLAC__bitreader_read_unary_unsigned(decoder->private_->input, &u))
2485 return false; /* read_callback_ sets the state for us */
2486 decoder->private_->frame.subframes[channel].wasted_bits = u+1;
2487 if (decoder->private_->frame.subframes[channel].wasted_bits >= bps)
2488 return false;
2489 bps -= decoder->private_->frame.subframes[channel].wasted_bits;
2491 else
2492 decoder->private_->frame.subframes[channel].wasted_bits = 0;
2495 * Lots of magic numbers here
2497 if(x & 0x80) {
2498 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2499 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2500 return true;
2502 else if(x == 0) {
2503 if(!read_subframe_constant_(decoder, channel, bps, do_full_decode))
2504 return false;
2506 else if(x == 2) {
2507 if(!read_subframe_verbatim_(decoder, channel, bps, do_full_decode))
2508 return false;
2510 else if(x < 16) {
2511 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2512 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2513 return true;
2515 else if(x <= 24) {
2516 if(!read_subframe_fixed_(decoder, channel, bps, (x>>1)&7, do_full_decode))
2517 return false;
2518 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2519 return true;
2521 else if(x < 64) {
2522 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2523 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2524 return true;
2526 else {
2527 if(!read_subframe_lpc_(decoder, channel, bps, ((x>>1)&31)+1, do_full_decode))
2528 return false;
2529 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2530 return true;
2533 if(wasted_bits && do_full_decode) {
2534 x = decoder->private_->frame.subframes[channel].wasted_bits;
2535 for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2536 uint32_t val = decoder->private_->output[channel][i];
2537 decoder->private_->output[channel][i] = (val << x);
2541 return true;
2544 FLAC__bool read_subframe_constant_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode)
2546 FLAC__Subframe_Constant *subframe = &decoder->private_->frame.subframes[channel].data.constant;
2547 FLAC__int32 x;
2548 uint32_t i;
2549 FLAC__int32 *output = decoder->private_->output[channel];
2551 decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_CONSTANT;
2553 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2554 return false; /* read_callback_ sets the state for us */
2556 subframe->value = x;
2558 /* decode the subframe */
2559 if(do_full_decode) {
2560 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2561 output[i] = x;
2564 return true;
2567 FLAC__bool read_subframe_fixed_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, const uint32_t order, FLAC__bool do_full_decode)
2569 FLAC__Subframe_Fixed *subframe = &decoder->private_->frame.subframes[channel].data.fixed;
2570 FLAC__int32 i32;
2571 FLAC__uint32 u32;
2572 uint32_t u;
2574 decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_FIXED;
2576 subframe->residual = decoder->private_->residual[channel];
2577 subframe->order = order;
2579 /* read warm-up samples */
2580 for(u = 0; u < order; u++) {
2581 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2582 return false; /* read_callback_ sets the state for us */
2583 subframe->warmup[u] = i32;
2586 /* read entropy coding method info */
2587 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2588 return false; /* read_callback_ sets the state for us */
2589 subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2590 switch(subframe->entropy_coding_method.type) {
2591 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2592 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2593 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2594 return false; /* read_callback_ sets the state for us */
2595 if(decoder->private_->frame.header.blocksize >> u32 < order) {
2596 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2597 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2598 return true;
2600 subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2601 subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2602 break;
2603 default:
2604 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2605 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2606 return true;
2609 /* read residual */
2610 switch(subframe->entropy_coding_method.type) {
2611 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2612 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2613 if(!read_residual_partitioned_rice_(decoder, order, subframe->entropy_coding_method.data.partitioned_rice.order, &decoder->private_->partitioned_rice_contents[channel], decoder->private_->residual[channel], /*is_extended=*/subframe->entropy_coding_method.type == FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2))
2614 return false;
2615 break;
2616 default:
2617 FLAC__ASSERT(0);
2620 /* decode the subframe */
2621 if(do_full_decode) {
2622 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2623 FLAC__fixed_restore_signal(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, order, decoder->private_->output[channel]+order);
2626 return true;
2629 FLAC__bool read_subframe_lpc_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, const uint32_t order, FLAC__bool do_full_decode)
2631 FLAC__Subframe_LPC *subframe = &decoder->private_->frame.subframes[channel].data.lpc;
2632 FLAC__int32 i32;
2633 FLAC__uint32 u32;
2634 uint32_t u;
2636 decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_LPC;
2638 subframe->residual = decoder->private_->residual[channel];
2639 subframe->order = order;
2641 /* read warm-up samples */
2642 for(u = 0; u < order; u++) {
2643 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2644 return false; /* read_callback_ sets the state for us */
2645 subframe->warmup[u] = i32;
2648 /* read qlp coeff precision */
2649 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
2650 return false; /* read_callback_ sets the state for us */
2651 if(u32 == (1u << FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN) - 1) {
2652 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2653 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2654 return true;
2656 subframe->qlp_coeff_precision = u32+1;
2658 /* read qlp shift */
2659 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
2660 return false; /* read_callback_ sets the state for us */
2661 if(i32 < 0) {
2662 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2663 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2664 return true;
2666 subframe->quantization_level = i32;
2668 /* read quantized lp coefficiencts */
2669 for(u = 0; u < order; u++) {
2670 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, subframe->qlp_coeff_precision))
2671 return false; /* read_callback_ sets the state for us */
2672 subframe->qlp_coeff[u] = i32;
2675 /* read entropy coding method info */
2676 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2677 return false; /* read_callback_ sets the state for us */
2678 subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2679 switch(subframe->entropy_coding_method.type) {
2680 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2681 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2682 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2683 return false; /* read_callback_ sets the state for us */
2684 if(decoder->private_->frame.header.blocksize >> u32 < order) {
2685 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2686 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2687 return true;
2689 subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2690 subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2691 break;
2692 default:
2693 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2694 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2695 return true;
2698 /* read residual */
2699 switch(subframe->entropy_coding_method.type) {
2700 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2701 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2702 if(!read_residual_partitioned_rice_(decoder, order, subframe->entropy_coding_method.data.partitioned_rice.order, &decoder->private_->partitioned_rice_contents[channel], decoder->private_->residual[channel], /*is_extended=*/subframe->entropy_coding_method.type == FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2))
2703 return false;
2704 break;
2705 default:
2706 FLAC__ASSERT(0);
2709 /* decode the subframe */
2710 if(do_full_decode) {
2711 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2712 if(bps + subframe->qlp_coeff_precision + FLAC__bitmath_ilog2(order) <= 32)
2713 if(bps <= 16 && subframe->qlp_coeff_precision <= 16)
2714 decoder->private_->local_lpc_restore_signal_16bit(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, subframe->qlp_coeff, order, subframe->quantization_level, decoder->private_->output[channel]+order);
2715 else
2716 decoder->private_->local_lpc_restore_signal(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, subframe->qlp_coeff, order, subframe->quantization_level, decoder->private_->output[channel]+order);
2717 else
2718 decoder->private_->local_lpc_restore_signal_64bit(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, subframe->qlp_coeff, order, subframe->quantization_level, decoder->private_->output[channel]+order);
2721 return true;
2724 FLAC__bool read_subframe_verbatim_(FLAC__StreamDecoder *decoder, uint32_t channel, uint32_t bps, FLAC__bool do_full_decode)
2726 FLAC__Subframe_Verbatim *subframe = &decoder->private_->frame.subframes[channel].data.verbatim;
2727 FLAC__int32 x, *residual = decoder->private_->residual[channel];
2728 uint32_t i;
2730 decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_VERBATIM;
2732 subframe->data = residual;
2734 for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2735 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2736 return false; /* read_callback_ sets the state for us */
2737 residual[i] = x;
2740 /* decode the subframe */
2741 if(do_full_decode)
2742 memcpy(decoder->private_->output[channel], subframe->data, sizeof(FLAC__int32) * decoder->private_->frame.header.blocksize);
2744 return true;
2747 FLAC__bool read_residual_partitioned_rice_(FLAC__StreamDecoder *decoder, uint32_t predictor_order, uint32_t partition_order, FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents, FLAC__int32 *residual, FLAC__bool is_extended)
2749 FLAC__uint32 rice_parameter;
2750 int i;
2751 uint32_t partition, sample, u;
2752 const uint32_t partitions = 1u << partition_order;
2753 const uint32_t partition_samples = partition_order > 0? decoder->private_->frame.header.blocksize >> partition_order : decoder->private_->frame.header.blocksize - predictor_order;
2754 const uint32_t plen = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_PARAMETER_LEN : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN;
2755 const uint32_t pesc = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_ESCAPE_PARAMETER : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
2757 /* invalid predictor and partition orders mush be handled in the callers */
2758 FLAC__ASSERT(partition_order > 0? partition_samples >= predictor_order : decoder->private_->frame.header.blocksize >= predictor_order);
2760 if(!FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(partitioned_rice_contents, flac_max(6u, partition_order))) {
2761 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
2762 return false;
2765 sample = 0;
2766 for(partition = 0; partition < partitions; partition++) {
2767 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, plen))
2768 return false; /* read_callback_ sets the state for us */
2769 partitioned_rice_contents->parameters[partition] = rice_parameter;
2770 if(rice_parameter < pesc) {
2771 partitioned_rice_contents->raw_bits[partition] = 0;
2772 u = (partition_order == 0 || partition > 0)? partition_samples : partition_samples - predictor_order;
2773 if(!FLAC__bitreader_read_rice_signed_block(decoder->private_->input, residual + sample, u, rice_parameter))
2774 return false; /* read_callback_ sets the state for us */
2775 sample += u;
2777 else {
2778 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
2779 return false; /* read_callback_ sets the state for us */
2780 partitioned_rice_contents->raw_bits[partition] = rice_parameter;
2781 for(u = (partition_order == 0 || partition > 0)? 0 : predictor_order; u < partition_samples; u++, sample++) {
2782 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i, rice_parameter))
2783 return false; /* read_callback_ sets the state for us */
2784 residual[sample] = i;
2789 return true;
2792 FLAC__bool read_zero_padding_(FLAC__StreamDecoder *decoder)
2794 if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input)) {
2795 FLAC__uint32 zero = 0;
2796 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &zero, FLAC__bitreader_bits_left_for_byte_alignment(decoder->private_->input)))
2797 return false; /* read_callback_ sets the state for us */
2798 if(zero != 0) {
2799 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2800 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2803 return true;
2806 FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data)
2808 FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder *)client_data;
2811 #if FLAC__HAS_OGG
2812 /* see [1] HACK NOTE below for why we don't call the eof_callback when decoding Ogg FLAC */
2813 !decoder->private_->is_ogg &&
2814 #endif
2815 decoder->private_->eof_callback && decoder->private_->eof_callback(decoder, decoder->private_->client_data)
2817 *bytes = 0;
2818 decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2819 return false;
2821 else if(*bytes > 0) {
2822 /* While seeking, it is possible for our seek to land in the
2823 * middle of audio data that looks exactly like a frame header
2824 * from a future version of an encoder. When that happens, our
2825 * error callback will get an
2826 * FLAC__STREAM_DECODER_UNPARSEABLE_STREAM and increment its
2827 * unparseable_frame_count. But there is a remote possibility
2828 * that it is properly synced at such a "future-codec frame",
2829 * so to make sure, we wait to see many "unparseable" errors in
2830 * a row before bailing out.
2832 if(decoder->private_->is_seeking && decoder->private_->unparseable_frame_count > 20) {
2833 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2834 return false;
2836 else {
2837 const FLAC__StreamDecoderReadStatus status =
2838 #if FLAC__HAS_OGG
2839 decoder->private_->is_ogg?
2840 read_callback_ogg_aspect_(decoder, buffer, bytes) :
2841 #endif
2842 decoder->private_->read_callback(decoder, buffer, bytes, decoder->private_->client_data)
2844 if(status == FLAC__STREAM_DECODER_READ_STATUS_ABORT) {
2845 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2846 return false;
2848 else if(*bytes == 0) {
2850 status == FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM ||
2852 #if FLAC__HAS_OGG
2853 /* see [1] HACK NOTE below for why we don't call the eof_callback when decoding Ogg FLAC */
2854 !decoder->private_->is_ogg &&
2855 #endif
2856 decoder->private_->eof_callback && decoder->private_->eof_callback(decoder, decoder->private_->client_data)
2859 decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2860 return false;
2862 else
2863 return true;
2865 else
2866 return true;
2869 else {
2870 /* abort to avoid a deadlock */
2871 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2872 return false;
2874 /* [1] @@@ HACK NOTE: The end-of-stream checking has to be hacked around
2875 * for Ogg FLAC. This is because the ogg decoder aspect can lose sync
2876 * and at the same time hit the end of the stream (for example, seeking
2877 * to a point that is after the beginning of the last Ogg page). There
2878 * is no way to report an Ogg sync loss through the callbacks (see note
2879 * in read_callback_ogg_aspect_()) so it returns CONTINUE with *bytes==0.
2880 * So to keep the decoder from stopping at this point we gate the call
2881 * to the eof_callback and let the Ogg decoder aspect set the
2882 * end-of-stream state when it is needed.
2886 #if FLAC__HAS_OGG
2887 FLAC__StreamDecoderReadStatus read_callback_ogg_aspect_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes)
2889 switch(FLAC__ogg_decoder_aspect_read_callback_wrapper(&decoder->protected_->ogg_decoder_aspect, buffer, bytes, read_callback_proxy_, decoder, decoder->private_->client_data)) {
2890 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK:
2891 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2892 /* we don't really have a way to handle lost sync via read
2893 * callback so we'll let it pass and let the underlying
2894 * FLAC decoder catch the error
2896 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_LOST_SYNC:
2897 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2898 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM:
2899 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
2900 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_NOT_FLAC:
2901 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_UNSUPPORTED_MAPPING_VERSION:
2902 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT:
2903 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ERROR:
2904 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_MEMORY_ALLOCATION_ERROR:
2905 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2906 default:
2907 FLAC__ASSERT(0);
2908 /* double protection */
2909 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2913 FLAC__OggDecoderAspectReadStatus read_callback_proxy_(const void *void_decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
2915 FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder*)void_decoder;
2917 switch(decoder->private_->read_callback(decoder, buffer, bytes, client_data)) {
2918 case FLAC__STREAM_DECODER_READ_STATUS_CONTINUE:
2919 return FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK;
2920 case FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM:
2921 return FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM;
2922 case FLAC__STREAM_DECODER_READ_STATUS_ABORT:
2923 return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2924 default:
2925 /* double protection: */
2926 FLAC__ASSERT(0);
2927 return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2930 #endif
2932 FLAC__StreamDecoderWriteStatus write_audio_frame_to_client_(FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[])
2934 if(decoder->private_->is_seeking) {
2935 FLAC__uint64 this_frame_sample = frame->header.number.sample_number;
2936 FLAC__uint64 next_frame_sample = this_frame_sample + (FLAC__uint64)frame->header.blocksize;
2937 FLAC__uint64 target_sample = decoder->private_->target_sample;
2939 FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
2941 #if FLAC__HAS_OGG
2942 decoder->private_->got_a_frame = true;
2943 #endif
2944 decoder->private_->last_frame = *frame; /* save the frame */
2945 if(this_frame_sample <= target_sample && target_sample < next_frame_sample) { /* we hit our target frame */
2946 uint32_t delta = (uint32_t)(target_sample - this_frame_sample);
2947 /* kick out of seek mode */
2948 decoder->private_->is_seeking = false;
2949 /* shift out the samples before target_sample */
2950 if(delta > 0) {
2951 uint32_t channel;
2952 const FLAC__int32 *newbuffer[FLAC__MAX_CHANNELS];
2953 for(channel = 0; channel < frame->header.channels; channel++)
2954 newbuffer[channel] = buffer[channel] + delta;
2955 decoder->private_->last_frame.header.blocksize -= delta;
2956 decoder->private_->last_frame.header.number.sample_number += (FLAC__uint64)delta;
2957 /* write the relevant samples */
2958 return decoder->private_->write_callback(decoder, &decoder->private_->last_frame, newbuffer, decoder->private_->client_data);
2960 else {
2961 /* write the relevant samples */
2962 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2965 else {
2966 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
2969 else {
2971 * If we never got STREAMINFO, turn off MD5 checking to save
2972 * cycles since we don't have a sum to compare to anyway
2974 if(!decoder->private_->has_stream_info)
2975 decoder->private_->do_md5_checking = false;
2976 if(decoder->private_->do_md5_checking) {
2977 if(!FLAC__MD5Accumulate(&decoder->private_->md5context, buffer, frame->header.channels, frame->header.blocksize, (frame->header.bits_per_sample+7) / 8))
2978 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
2980 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2984 void send_error_to_client_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status)
2986 if(!decoder->private_->is_seeking)
2987 decoder->private_->error_callback(decoder, status, decoder->private_->client_data);
2988 else if(status == FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM)
2989 decoder->private_->unparseable_frame_count++;
2992 FLAC__bool seek_to_absolute_sample_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
2994 FLAC__uint64 first_frame_offset = decoder->private_->first_frame_offset, lower_bound, upper_bound, lower_bound_sample, upper_bound_sample, this_frame_sample;
2995 FLAC__int64 pos = -1;
2996 int i;
2997 uint32_t approx_bytes_per_frame;
2998 FLAC__bool first_seek = true;
2999 const FLAC__uint64 total_samples = FLAC__stream_decoder_get_total_samples(decoder);
3000 const uint32_t min_blocksize = decoder->private_->stream_info.data.stream_info.min_blocksize;
3001 const uint32_t max_blocksize = decoder->private_->stream_info.data.stream_info.max_blocksize;
3002 const uint32_t max_framesize = decoder->private_->stream_info.data.stream_info.max_framesize;
3003 const uint32_t min_framesize = decoder->private_->stream_info.data.stream_info.min_framesize;
3004 /* take these from the current frame in case they've changed mid-stream */
3005 uint32_t channels = FLAC__stream_decoder_get_channels(decoder);
3006 uint32_t bps = FLAC__stream_decoder_get_bits_per_sample(decoder);
3007 const FLAC__StreamMetadata_SeekTable *seek_table = decoder->private_->has_seek_table? &decoder->private_->seek_table.data.seek_table : 0;
3009 /* use values from stream info if we didn't decode a frame */
3010 if(channels == 0)
3011 channels = decoder->private_->stream_info.data.stream_info.channels;
3012 if(bps == 0)
3013 bps = decoder->private_->stream_info.data.stream_info.bits_per_sample;
3015 /* we are just guessing here */
3016 if(max_framesize > 0)
3017 approx_bytes_per_frame = (max_framesize + min_framesize) / 2 + 1;
3019 * Check if it's a known fixed-blocksize stream. Note that though
3020 * the spec doesn't allow zeroes in the STREAMINFO block, we may
3021 * never get a STREAMINFO block when decoding so the value of
3022 * min_blocksize might be zero.
3024 else if(min_blocksize == max_blocksize && min_blocksize > 0) {
3025 /* note there are no () around 'bps/8' to keep precision up since it's an integer calculation */
3026 approx_bytes_per_frame = min_blocksize * channels * bps/8 + 64;
3028 else
3029 approx_bytes_per_frame = 4096 * channels * bps/8 + 64;
3032 * First, we set an upper and lower bound on where in the
3033 * stream we will search. For now we assume the worst case
3034 * scenario, which is our best guess at the beginning of
3035 * the first frame and end of the stream.
3037 lower_bound = first_frame_offset;
3038 lower_bound_sample = 0;
3039 upper_bound = stream_length;
3040 upper_bound_sample = total_samples > 0 ? total_samples : target_sample /*estimate it*/;
3043 * Now we refine the bounds if we have a seektable with
3044 * suitable points. Note that according to the spec they
3045 * must be ordered by ascending sample number.
3047 * Note: to protect against invalid seek tables we will ignore points
3048 * that have frame_samples==0 or sample_number>=total_samples
3050 if(seek_table) {
3051 FLAC__uint64 new_lower_bound = lower_bound;
3052 FLAC__uint64 new_upper_bound = upper_bound;
3053 FLAC__uint64 new_lower_bound_sample = lower_bound_sample;
3054 FLAC__uint64 new_upper_bound_sample = upper_bound_sample;
3056 /* find the closest seek point <= target_sample, if it exists */
3057 for(i = (int)seek_table->num_points - 1; i >= 0; i--) {
3059 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3060 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3061 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */
3062 seek_table->points[i].sample_number <= target_sample
3064 break;
3066 if(i >= 0) { /* i.e. we found a suitable seek point... */
3067 new_lower_bound = first_frame_offset + seek_table->points[i].stream_offset;
3068 new_lower_bound_sample = seek_table->points[i].sample_number;
3071 /* find the closest seek point > target_sample, if it exists */
3072 for(i = 0; i < (int)seek_table->num_points; i++) {
3074 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3075 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3076 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */
3077 seek_table->points[i].sample_number > target_sample
3079 break;
3081 if(i < (int)seek_table->num_points) { /* i.e. we found a suitable seek point... */
3082 new_upper_bound = first_frame_offset + seek_table->points[i].stream_offset;
3083 new_upper_bound_sample = seek_table->points[i].sample_number;
3085 /* final protection against unsorted seek tables; keep original values if bogus */
3086 if(new_upper_bound >= new_lower_bound) {
3087 lower_bound = new_lower_bound;
3088 upper_bound = new_upper_bound;
3089 lower_bound_sample = new_lower_bound_sample;
3090 upper_bound_sample = new_upper_bound_sample;
3094 FLAC__ASSERT(upper_bound_sample >= lower_bound_sample);
3095 /* there are 2 insidious ways that the following equality occurs, which
3096 * we need to fix:
3097 * 1) total_samples is 0 (unknown) and target_sample is 0
3098 * 2) total_samples is 0 (unknown) and target_sample happens to be
3099 * exactly equal to the last seek point in the seek table; this
3100 * means there is no seek point above it, and upper_bound_samples
3101 * remains equal to the estimate (of target_samples) we made above
3102 * in either case it does not hurt to move upper_bound_sample up by 1
3104 if(upper_bound_sample == lower_bound_sample)
3105 upper_bound_sample++;
3107 decoder->private_->target_sample = target_sample;
3108 while(1) {
3109 /* check if the bounds are still ok */
3110 if (lower_bound_sample >= upper_bound_sample || lower_bound > upper_bound) {
3111 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3112 return false;
3114 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3115 pos = (FLAC__int64)lower_bound + (FLAC__int64)((double)(target_sample - lower_bound_sample) / (double)(upper_bound_sample - lower_bound_sample) * (double)(upper_bound - lower_bound)) - approx_bytes_per_frame;
3116 #else
3117 /* a little less accurate: */
3118 if(upper_bound - lower_bound < 0xffffffff)
3119 pos = (FLAC__int64)lower_bound + (FLAC__int64)(((target_sample - lower_bound_sample) * (upper_bound - lower_bound)) / (upper_bound_sample - lower_bound_sample)) - approx_bytes_per_frame;
3120 else /* @@@ WATCHOUT, ~2TB limit */
3121 pos = (FLAC__int64)lower_bound + (FLAC__int64)((((target_sample - lower_bound_sample)>>8) * ((upper_bound - lower_bound)>>8)) / ((upper_bound_sample - lower_bound_sample)>>16)) - approx_bytes_per_frame;
3122 #endif
3123 if(pos >= (FLAC__int64)upper_bound)
3124 pos = (FLAC__int64)upper_bound - 1;
3125 if(pos < (FLAC__int64)lower_bound)
3126 pos = (FLAC__int64)lower_bound;
3127 if(decoder->private_->seek_callback(decoder, (FLAC__uint64)pos, decoder->private_->client_data) != FLAC__STREAM_DECODER_SEEK_STATUS_OK) {
3128 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3129 return false;
3131 if(!FLAC__stream_decoder_flush(decoder)) {
3132 /* above call sets the state for us */
3133 return false;
3135 /* Now we need to get a frame. First we need to reset our
3136 * unparseable_frame_count; if we get too many unparseable
3137 * frames in a row, the read callback will return
3138 * FLAC__STREAM_DECODER_READ_STATUS_ABORT, causing
3139 * FLAC__stream_decoder_process_single() to return false.
3141 decoder->private_->unparseable_frame_count = 0;
3142 if(!FLAC__stream_decoder_process_single(decoder) ||
3143 decoder->protected_->state == FLAC__STREAM_DECODER_ABORTED) {
3144 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3145 return false;
3147 /* our write callback will change the state when it gets to the target frame */
3148 /* actually, we could have got_a_frame if our decoder is at FLAC__STREAM_DECODER_END_OF_STREAM so we need to check for that also */
3149 #if 0
3150 /*@@@@@@ used to be the following; not clear if the check for end of stream is needed anymore */
3151 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING && decoder->protected_->state != FLAC__STREAM_DECODER_END_OF_STREAM)
3152 break;
3153 #endif
3154 if(!decoder->private_->is_seeking)
3155 break;
3157 FLAC__ASSERT(decoder->private_->last_frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
3158 this_frame_sample = decoder->private_->last_frame.header.number.sample_number;
3160 if (0 == decoder->private_->samples_decoded || (this_frame_sample + decoder->private_->last_frame.header.blocksize >= upper_bound_sample && !first_seek)) {
3161 if (pos == (FLAC__int64)lower_bound) {
3162 /* can't move back any more than the first frame, something is fatally wrong */
3163 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3164 return false;
3166 /* our last move backwards wasn't big enough, try again */
3167 approx_bytes_per_frame = approx_bytes_per_frame? approx_bytes_per_frame * 2 : 16;
3168 continue;
3170 /* allow one seek over upper bound, so we can get a correct upper_bound_sample for streams with unknown total_samples */
3171 first_seek = false;
3173 /* make sure we are not seeking in corrupted stream */
3174 if (this_frame_sample < lower_bound_sample) {
3175 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3176 return false;
3179 /* we need to narrow the search */
3180 if(target_sample < this_frame_sample) {
3181 upper_bound_sample = this_frame_sample + decoder->private_->last_frame.header.blocksize;
3182 /*@@@@@@ what will decode position be if at end of stream? */
3183 if(!FLAC__stream_decoder_get_decode_position(decoder, &upper_bound)) {
3184 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3185 return false;
3187 approx_bytes_per_frame = (uint32_t)(2 * (upper_bound - pos) / 3 + 16);
3189 else { /* target_sample >= this_frame_sample + this frame's blocksize */
3190 lower_bound_sample = this_frame_sample + decoder->private_->last_frame.header.blocksize;
3191 if(!FLAC__stream_decoder_get_decode_position(decoder, &lower_bound)) {
3192 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3193 return false;
3195 approx_bytes_per_frame = (uint32_t)(2 * (lower_bound - pos) / 3 + 16);
3199 return true;
3202 #if FLAC__HAS_OGG
3203 FLAC__bool seek_to_absolute_sample_ogg_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
3205 FLAC__uint64 left_pos = 0, right_pos = stream_length;
3206 FLAC__uint64 left_sample = 0, right_sample = FLAC__stream_decoder_get_total_samples(decoder);
3207 FLAC__uint64 this_frame_sample = (FLAC__uint64)0 - 1;
3208 FLAC__uint64 pos = 0; /* only initialized to avoid compiler warning */
3209 FLAC__bool did_a_seek;
3210 uint32_t iteration = 0;
3212 /* In the first iterations, we will calculate the target byte position
3213 * by the distance from the target sample to left_sample and
3214 * right_sample (let's call it "proportional search"). After that, we
3215 * will switch to binary search.
3217 uint32_t BINARY_SEARCH_AFTER_ITERATION = 2;
3219 /* We will switch to a linear search once our current sample is less
3220 * than this number of samples ahead of the target sample
3222 static const FLAC__uint64 LINEAR_SEARCH_WITHIN_SAMPLES = FLAC__MAX_BLOCK_SIZE * 2;
3224 /* If the total number of samples is unknown, use a large value, and
3225 * force binary search immediately.
3227 if(right_sample == 0) {
3228 right_sample = (FLAC__uint64)(-1);
3229 BINARY_SEARCH_AFTER_ITERATION = 0;
3232 decoder->private_->target_sample = target_sample;
3233 for( ; ; iteration++) {
3234 if (iteration == 0 || this_frame_sample > target_sample || target_sample - this_frame_sample > LINEAR_SEARCH_WITHIN_SAMPLES) {
3235 if (iteration >= BINARY_SEARCH_AFTER_ITERATION) {
3236 pos = (right_pos + left_pos) / 2;
3238 else {
3239 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3240 pos = (FLAC__uint64)((double)(target_sample - left_sample) / (double)(right_sample - left_sample) * (double)(right_pos - left_pos));
3241 #else
3242 /* a little less accurate: */
3243 if ((target_sample-left_sample <= 0xffffffff) && (right_pos-left_pos <= 0xffffffff))
3244 pos = (FLAC__int64)(((target_sample-left_sample) * (right_pos-left_pos)) / (right_sample-left_sample));
3245 else /* @@@ WATCHOUT, ~2TB limit */
3246 pos = (FLAC__int64)((((target_sample-left_sample)>>8) * ((right_pos-left_pos)>>8)) / ((right_sample-left_sample)>>16));
3247 #endif
3248 /* @@@ TODO: might want to limit pos to some distance
3249 * before EOF, to make sure we land before the last frame,
3250 * thereby getting a this_frame_sample and so having a better
3251 * estimate.
3255 /* physical seek */
3256 if(decoder->private_->seek_callback((FLAC__StreamDecoder*)decoder, (FLAC__uint64)pos, decoder->private_->client_data) != FLAC__STREAM_DECODER_SEEK_STATUS_OK) {
3257 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3258 return false;
3260 if(!FLAC__stream_decoder_flush(decoder)) {
3261 /* above call sets the state for us */
3262 return false;
3264 did_a_seek = true;
3266 else
3267 did_a_seek = false;
3269 decoder->private_->got_a_frame = false;
3270 if(!FLAC__stream_decoder_process_single(decoder) ||
3271 decoder->protected_->state == FLAC__STREAM_DECODER_ABORTED) {
3272 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3273 return false;
3275 if(!decoder->private_->got_a_frame) {
3276 if(did_a_seek) {
3277 /* this can happen if we seek to a point after the last frame; we drop
3278 * to binary search right away in this case to avoid any wasted
3279 * iterations of proportional search.
3281 right_pos = pos;
3282 BINARY_SEARCH_AFTER_ITERATION = 0;
3284 else {
3285 /* this can probably only happen if total_samples is unknown and the
3286 * target_sample is past the end of the stream
3288 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3289 return false;
3292 /* our write callback will change the state when it gets to the target frame */
3293 else if(!decoder->private_->is_seeking) {
3294 break;
3296 else {
3297 this_frame_sample = decoder->private_->last_frame.header.number.sample_number;
3298 FLAC__ASSERT(decoder->private_->last_frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
3300 if (did_a_seek) {
3301 if (this_frame_sample <= target_sample) {
3302 /* The 'equal' case should not happen, since
3303 * FLAC__stream_decoder_process_single()
3304 * should recognize that it has hit the
3305 * target sample and we would exit through
3306 * the 'break' above.
3308 FLAC__ASSERT(this_frame_sample != target_sample);
3310 left_sample = this_frame_sample;
3311 /* sanity check to avoid infinite loop */
3312 if (left_pos == pos) {
3313 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3314 return false;
3316 left_pos = pos;
3318 else if(this_frame_sample > target_sample) {
3319 right_sample = this_frame_sample;
3320 /* sanity check to avoid infinite loop */
3321 if (right_pos == pos) {
3322 decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3323 return false;
3325 right_pos = pos;
3331 return true;
3333 #endif
3335 FLAC__StreamDecoderReadStatus file_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
3337 (void)client_data;
3339 if(*bytes > 0) {
3340 *bytes = fread(buffer, sizeof(FLAC__byte), *bytes, decoder->private_->file);
3341 if(ferror(decoder->private_->file))
3342 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
3343 else if(*bytes == 0)
3344 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
3345 else
3346 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
3348 else
3349 return FLAC__STREAM_DECODER_READ_STATUS_ABORT; /* abort to avoid a deadlock */
3352 FLAC__StreamDecoderSeekStatus file_seek_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)
3354 (void)client_data;
3356 if(decoder->private_->file == stdin)
3357 return FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED;
3358 else if(fseeko(decoder->private_->file, (FLAC__off_t)absolute_byte_offset, SEEK_SET) < 0)
3359 return FLAC__STREAM_DECODER_SEEK_STATUS_ERROR;
3360 else
3361 return FLAC__STREAM_DECODER_SEEK_STATUS_OK;
3364 FLAC__StreamDecoderTellStatus file_tell_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
3366 FLAC__off_t pos;
3367 (void)client_data;
3369 if(decoder->private_->file == stdin)
3370 return FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED;
3371 else if((pos = ftello(decoder->private_->file)) < 0)
3372 return FLAC__STREAM_DECODER_TELL_STATUS_ERROR;
3373 else {
3374 *absolute_byte_offset = (FLAC__uint64)pos;
3375 return FLAC__STREAM_DECODER_TELL_STATUS_OK;
3379 FLAC__StreamDecoderLengthStatus file_length_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data)
3381 struct flac_stat_s filestats;
3382 (void)client_data;
3384 if(decoder->private_->file == stdin)
3385 return FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED;
3386 else if(flac_fstat(fileno(decoder->private_->file), &filestats) != 0)
3387 return FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR;
3388 else {
3389 *stream_length = (FLAC__uint64)filestats.st_size;
3390 return FLAC__STREAM_DECODER_LENGTH_STATUS_OK;
3394 FLAC__bool file_eof_callback_(const FLAC__StreamDecoder *decoder, void *client_data)
3396 (void)client_data;
3398 return feof(decoder->private_->file)? true : false;
3401 FLAC_API const void *FLAC__get_decoder_client_data(FLAC__StreamDecoder *decoder)
3403 return decoder->private_->client_data;