flac/vorbiscomment.c : Fix typo.
[flac.git] / src / libFLAC / stream_decoder.c
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000-2009  Josh Coalson
3  * Copyright (C) 2011-2014  Xiph.Org Foundation
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * - Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
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.
15  *
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.
19  *
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.
31  */
32
33 #ifdef HAVE_CONFIG_H
34 #  include <config.h>
35 #endif
36
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"
56
57
58 /* technically this should be in an "export.c" but this is convenient enough */
59 FLAC_API int FLAC_API_SUPPORTS_OGG_FLAC =
60 #if FLAC__HAS_OGG
61         1
62 #else
63         0
64 #endif
65 ;
66
67
68 /***********************************************************************
69  *
70  * Private static data
71  *
72  ***********************************************************************/
73
74 static const FLAC__byte ID3V2_TAG_[3] = { 'I', 'D', '3' };
75
76 /***********************************************************************
77  *
78  * Private class method prototypes
79  *
80  ***********************************************************************/
81
82 static void set_defaults_(FLAC__StreamDecoder *decoder);
83 static FILE *get_binary_stdin_(void);
84 static FLAC__bool allocate_output_(FLAC__StreamDecoder *decoder, unsigned size, unsigned channels);
85 static FLAC__bool has_id_filtered_(FLAC__StreamDecoder *decoder, FLAC__byte *id);
86 static FLAC__bool find_metadata_(FLAC__StreamDecoder *decoder);
87 static FLAC__bool read_metadata_(FLAC__StreamDecoder *decoder);
88 static FLAC__bool read_metadata_streaminfo_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length);
89 static FLAC__bool read_metadata_seektable_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length);
90 static FLAC__bool read_metadata_vorbiscomment_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_VorbisComment *obj, unsigned length);
91 static FLAC__bool read_metadata_cuesheet_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_CueSheet *obj);
92 static FLAC__bool read_metadata_picture_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_Picture *obj);
93 static FLAC__bool skip_id3v2_tag_(FLAC__StreamDecoder *decoder);
94 static FLAC__bool frame_sync_(FLAC__StreamDecoder *decoder);
95 static FLAC__bool read_frame_(FLAC__StreamDecoder *decoder, FLAC__bool *got_a_frame, FLAC__bool do_full_decode);
96 static FLAC__bool read_frame_header_(FLAC__StreamDecoder *decoder);
97 static FLAC__bool read_subframe_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode);
98 static FLAC__bool read_subframe_constant_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode);
99 static FLAC__bool read_subframe_fixed_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode);
100 static FLAC__bool read_subframe_lpc_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode);
101 static FLAC__bool read_subframe_verbatim_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode);
102 static FLAC__bool read_residual_partitioned_rice_(FLAC__StreamDecoder *decoder, unsigned predictor_order, unsigned partition_order, FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents, FLAC__int32 *residual, FLAC__bool is_extended);
103 static FLAC__bool read_zero_padding_(FLAC__StreamDecoder *decoder);
104 static FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data);
105 #if FLAC__HAS_OGG
106 static FLAC__StreamDecoderReadStatus read_callback_ogg_aspect_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes);
107 static FLAC__OggDecoderAspectReadStatus read_callback_proxy_(const void *void_decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
108 #endif
109 static FLAC__StreamDecoderWriteStatus write_audio_frame_to_client_(FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[]);
110 static void send_error_to_client_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status);
111 static FLAC__bool seek_to_absolute_sample_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample);
112 #if FLAC__HAS_OGG
113 static FLAC__bool seek_to_absolute_sample_ogg_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample);
114 #endif
115 static FLAC__StreamDecoderReadStatus file_read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
116 static FLAC__StreamDecoderSeekStatus file_seek_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data);
117 static FLAC__StreamDecoderTellStatus file_tell_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data);
118 static FLAC__StreamDecoderLengthStatus file_length_callback_(const FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data);
119 static FLAC__bool file_eof_callback_(const FLAC__StreamDecoder *decoder, void *client_data);
120
121 /***********************************************************************
122  *
123  * Private class data
124  *
125  ***********************************************************************/
126
127 typedef struct FLAC__StreamDecoderPrivate {
128 #if FLAC__HAS_OGG
129         FLAC__bool is_ogg;
130 #endif
131         FLAC__StreamDecoderReadCallback read_callback;
132         FLAC__StreamDecoderSeekCallback seek_callback;
133         FLAC__StreamDecoderTellCallback tell_callback;
134         FLAC__StreamDecoderLengthCallback length_callback;
135         FLAC__StreamDecoderEofCallback eof_callback;
136         FLAC__StreamDecoderWriteCallback write_callback;
137         FLAC__StreamDecoderMetadataCallback metadata_callback;
138         FLAC__StreamDecoderErrorCallback error_callback;
139         /* generic 32-bit datapath: */
140         void (*local_lpc_restore_signal)(const FLAC__int32 residual[], unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 data[]);
141         /* generic 64-bit datapath: */
142         void (*local_lpc_restore_signal_64bit)(const FLAC__int32 residual[], unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 data[]);
143         /* for use when the signal is <= 16 bits-per-sample, or <= 15 bits-per-sample on a side channel (which requires 1 extra bit): */
144         void (*local_lpc_restore_signal_16bit)(const FLAC__int32 residual[], unsigned data_len, const FLAC__int32 qlp_coeff[], unsigned order, int lp_quantization, FLAC__int32 data[]);
145         void *client_data;
146         FILE *file; /* only used if FLAC__stream_decoder_init_file()/FLAC__stream_decoder_init_file() called, else NULL */
147         FLAC__BitReader *input;
148         FLAC__int32 *output[FLAC__MAX_CHANNELS];
149         FLAC__int32 *residual[FLAC__MAX_CHANNELS]; /* WATCHOUT: these are the aligned pointers; the real pointers that should be free()'d are residual_unaligned[] below */
150         FLAC__EntropyCodingMethod_PartitionedRiceContents partitioned_rice_contents[FLAC__MAX_CHANNELS];
151         unsigned output_capacity, output_channels;
152         FLAC__uint32 fixed_block_size, next_fixed_block_size;
153         FLAC__uint64 samples_decoded;
154         FLAC__bool has_stream_info, has_seek_table;
155         FLAC__StreamMetadata stream_info;
156         FLAC__StreamMetadata seek_table;
157         FLAC__bool metadata_filter[128]; /* MAGIC number 128 == total number of metadata block types == 1 << 7 */
158         FLAC__byte *metadata_filter_ids;
159         size_t metadata_filter_ids_count, metadata_filter_ids_capacity; /* units for both are IDs, not bytes */
160         FLAC__Frame frame;
161         FLAC__bool cached; /* true if there is a byte in lookahead */
162         FLAC__CPUInfo cpuinfo;
163         FLAC__byte header_warmup[2]; /* contains the sync code and reserved bits */
164         FLAC__byte lookahead; /* temp storage when we need to look ahead one byte in the stream */
165         /* unaligned (original) pointers to allocated data */
166         FLAC__int32 *residual_unaligned[FLAC__MAX_CHANNELS];
167         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 */
168         FLAC__bool internal_reset_hack; /* used only during init() so we can call reset to set up the decoder without rewinding the input */
169         FLAC__bool is_seeking;
170         FLAC__MD5Context md5context;
171         FLAC__byte computed_md5sum[16]; /* this is the sum we computed from the decoded data */
172         /* (the rest of these are only used for seeking) */
173         FLAC__Frame last_frame; /* holds the info of the last frame we seeked to */
174         FLAC__uint64 first_frame_offset; /* hint to the seek routine of where in the stream the first audio frame starts */
175         FLAC__uint64 target_sample;
176         unsigned unparseable_frame_count; /* used to tell whether we're decoding a future version of FLAC or just got a bad sync */
177 #if FLAC__HAS_OGG
178         FLAC__bool got_a_frame; /* hack needed in Ogg FLAC seek routine to check when process_single() actually writes a frame */
179 #endif
180 } FLAC__StreamDecoderPrivate;
181
182 /***********************************************************************
183  *
184  * Public static class data
185  *
186  ***********************************************************************/
187
188 FLAC_API const char * const FLAC__StreamDecoderStateString[] = {
189         "FLAC__STREAM_DECODER_SEARCH_FOR_METADATA",
190         "FLAC__STREAM_DECODER_READ_METADATA",
191         "FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC",
192         "FLAC__STREAM_DECODER_READ_FRAME",
193         "FLAC__STREAM_DECODER_END_OF_STREAM",
194         "FLAC__STREAM_DECODER_OGG_ERROR",
195         "FLAC__STREAM_DECODER_SEEK_ERROR",
196         "FLAC__STREAM_DECODER_ABORTED",
197         "FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
198         "FLAC__STREAM_DECODER_UNINITIALIZED"
199 };
200
201 FLAC_API const char * const FLAC__StreamDecoderInitStatusString[] = {
202         "FLAC__STREAM_DECODER_INIT_STATUS_OK",
203         "FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER",
204         "FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS",
205         "FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR",
206         "FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE",
207         "FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED"
208 };
209
210 FLAC_API const char * const FLAC__StreamDecoderReadStatusString[] = {
211         "FLAC__STREAM_DECODER_READ_STATUS_CONTINUE",
212         "FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM",
213         "FLAC__STREAM_DECODER_READ_STATUS_ABORT"
214 };
215
216 FLAC_API const char * const FLAC__StreamDecoderSeekStatusString[] = {
217         "FLAC__STREAM_DECODER_SEEK_STATUS_OK",
218         "FLAC__STREAM_DECODER_SEEK_STATUS_ERROR",
219         "FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED"
220 };
221
222 FLAC_API const char * const FLAC__StreamDecoderTellStatusString[] = {
223         "FLAC__STREAM_DECODER_TELL_STATUS_OK",
224         "FLAC__STREAM_DECODER_TELL_STATUS_ERROR",
225         "FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED"
226 };
227
228 FLAC_API const char * const FLAC__StreamDecoderLengthStatusString[] = {
229         "FLAC__STREAM_DECODER_LENGTH_STATUS_OK",
230         "FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR",
231         "FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED"
232 };
233
234 FLAC_API const char * const FLAC__StreamDecoderWriteStatusString[] = {
235         "FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE",
236         "FLAC__STREAM_DECODER_WRITE_STATUS_ABORT"
237 };
238
239 FLAC_API const char * const FLAC__StreamDecoderErrorStatusString[] = {
240         "FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC",
241         "FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER",
242         "FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH",
243         "FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM"
244 };
245
246 /***********************************************************************
247  *
248  * Class constructor/destructor
249  *
250  ***********************************************************************/
251 FLAC_API FLAC__StreamDecoder *FLAC__stream_decoder_new(void)
252 {
253         FLAC__StreamDecoder *decoder;
254         unsigned i;
255
256         FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
257
258         decoder = calloc(1, sizeof(FLAC__StreamDecoder));
259         if(decoder == 0) {
260                 return 0;
261         }
262
263         decoder->protected_ = calloc(1, sizeof(FLAC__StreamDecoderProtected));
264         if(decoder->protected_ == 0) {
265                 free(decoder);
266                 return 0;
267         }
268
269         decoder->private_ = calloc(1, sizeof(FLAC__StreamDecoderPrivate));
270         if(decoder->private_ == 0) {
271                 free(decoder->protected_);
272                 free(decoder);
273                 return 0;
274         }
275
276         decoder->private_->input = FLAC__bitreader_new();
277         if(decoder->private_->input == 0) {
278                 free(decoder->private_);
279                 free(decoder->protected_);
280                 free(decoder);
281                 return 0;
282         }
283
284         decoder->private_->metadata_filter_ids_capacity = 16;
285         if(0 == (decoder->private_->metadata_filter_ids = malloc((FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) * decoder->private_->metadata_filter_ids_capacity))) {
286                 FLAC__bitreader_delete(decoder->private_->input);
287                 free(decoder->private_);
288                 free(decoder->protected_);
289                 free(decoder);
290                 return 0;
291         }
292
293         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
294                 decoder->private_->output[i] = 0;
295                 decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
296         }
297
298         decoder->private_->output_capacity = 0;
299         decoder->private_->output_channels = 0;
300         decoder->private_->has_seek_table = false;
301
302         for(i = 0; i < FLAC__MAX_CHANNELS; i++)
303                 FLAC__format_entropy_coding_method_partitioned_rice_contents_init(&decoder->private_->partitioned_rice_contents[i]);
304
305         decoder->private_->file = 0;
306
307         set_defaults_(decoder);
308
309         decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
310
311         return decoder;
312 }
313
314 FLAC_API void FLAC__stream_decoder_delete(FLAC__StreamDecoder *decoder)
315 {
316         unsigned i;
317
318         if (decoder == NULL)
319                 return ;
320
321         FLAC__ASSERT(0 != decoder->protected_);
322         FLAC__ASSERT(0 != decoder->private_);
323         FLAC__ASSERT(0 != decoder->private_->input);
324
325         (void)FLAC__stream_decoder_finish(decoder);
326
327         if(0 != decoder->private_->metadata_filter_ids)
328                 free(decoder->private_->metadata_filter_ids);
329
330         FLAC__bitreader_delete(decoder->private_->input);
331
332         for(i = 0; i < FLAC__MAX_CHANNELS; i++)
333                 FLAC__format_entropy_coding_method_partitioned_rice_contents_clear(&decoder->private_->partitioned_rice_contents[i]);
334
335         free(decoder->private_);
336         free(decoder->protected_);
337         free(decoder);
338 }
339
340 /***********************************************************************
341  *
342  * Public class methods
343  *
344  ***********************************************************************/
345
346 static FLAC__StreamDecoderInitStatus init_stream_internal_(
347         FLAC__StreamDecoder *decoder,
348         FLAC__StreamDecoderReadCallback read_callback,
349         FLAC__StreamDecoderSeekCallback seek_callback,
350         FLAC__StreamDecoderTellCallback tell_callback,
351         FLAC__StreamDecoderLengthCallback length_callback,
352         FLAC__StreamDecoderEofCallback eof_callback,
353         FLAC__StreamDecoderWriteCallback write_callback,
354         FLAC__StreamDecoderMetadataCallback metadata_callback,
355         FLAC__StreamDecoderErrorCallback error_callback,
356         void *client_data,
357         FLAC__bool is_ogg
358 )
359 {
360         FLAC__ASSERT(0 != decoder);
361
362         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
363                 return FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
364
365 #if !FLAC__HAS_OGG
366         if(is_ogg)
367                 return FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER;
368 #endif
369
370         if(
371                 0 == read_callback ||
372                 0 == write_callback ||
373                 0 == error_callback ||
374                 (seek_callback && (0 == tell_callback || 0 == length_callback || 0 == eof_callback))
375         )
376                 return FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
377
378 #if FLAC__HAS_OGG
379         decoder->private_->is_ogg = is_ogg;
380         if(is_ogg && !FLAC__ogg_decoder_aspect_init(&decoder->protected_->ogg_decoder_aspect))
381                 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE;
382 #endif
383
384         /*
385          * get the CPU info and set the function pointers
386          */
387         FLAC__cpu_info(&decoder->private_->cpuinfo);
388         /* first default to the non-asm routines */
389         decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal;
390         decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide;
391         decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal;
392         /* now override with asm where appropriate */
393 #ifndef FLAC__NO_ASM
394         if(decoder->private_->cpuinfo.use_asm) {
395 #ifdef FLAC__CPU_IA32
396                 FLAC__ASSERT(decoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_IA32);
397 #ifdef FLAC__HAS_NASM
398                 decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide_asm_ia32; /* OPT_IA32: was really necessary for GCC < 4.9 */
399                 if(decoder->private_->cpuinfo.ia32.mmx) {
400                         decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
401                         decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32_mmx;
402                 }
403                 else {
404                         decoder->private_->local_lpc_restore_signal = FLAC__lpc_restore_signal_asm_ia32;
405                         decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_asm_ia32;
406                 }
407 #endif
408 #ifdef FLAC__HAS_X86INTRIN
409 # if defined FLAC__SSE2_SUPPORTED && !defined FLAC__HAS_NASM /* OPT_SSE: not better than MMX asm */
410                 if(decoder->private_->cpuinfo.ia32.sse2) {
411                         decoder->private_->local_lpc_restore_signal_16bit = FLAC__lpc_restore_signal_16_intrin_sse2;
412                 }
413 # endif
414 # if defined FLAC__SSE4_1_SUPPORTED
415                 if(decoder->private_->cpuinfo.ia32.sse41) {
416                         decoder->private_->local_lpc_restore_signal_64bit = FLAC__lpc_restore_signal_wide_intrin_sse41;
417                 }
418 # endif
419 #endif
420 #elif defined FLAC__CPU_X86_64
421                 FLAC__ASSERT(decoder->private_->cpuinfo.type == FLAC__CPUINFO_TYPE_X86_64);
422                 /* No useful SSE optimizations yet */
423 #endif
424         }
425 #endif
426
427         /* from here on, errors are fatal */
428
429         if(!FLAC__bitreader_init(decoder->private_->input, read_callback_, decoder)) {
430                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
431                 return FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR;
432         }
433
434         decoder->private_->read_callback = read_callback;
435         decoder->private_->seek_callback = seek_callback;
436         decoder->private_->tell_callback = tell_callback;
437         decoder->private_->length_callback = length_callback;
438         decoder->private_->eof_callback = eof_callback;
439         decoder->private_->write_callback = write_callback;
440         decoder->private_->metadata_callback = metadata_callback;
441         decoder->private_->error_callback = error_callback;
442         decoder->private_->client_data = client_data;
443         decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size = 0;
444         decoder->private_->samples_decoded = 0;
445         decoder->private_->has_stream_info = false;
446         decoder->private_->cached = false;
447
448         decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
449         decoder->private_->is_seeking = false;
450
451         decoder->private_->internal_reset_hack = true; /* so the following reset does not try to rewind the input */
452         if(!FLAC__stream_decoder_reset(decoder)) {
453                 /* above call sets the state for us */
454                 return FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR;
455         }
456
457         return FLAC__STREAM_DECODER_INIT_STATUS_OK;
458 }
459
460 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_stream(
461         FLAC__StreamDecoder *decoder,
462         FLAC__StreamDecoderReadCallback read_callback,
463         FLAC__StreamDecoderSeekCallback seek_callback,
464         FLAC__StreamDecoderTellCallback tell_callback,
465         FLAC__StreamDecoderLengthCallback length_callback,
466         FLAC__StreamDecoderEofCallback eof_callback,
467         FLAC__StreamDecoderWriteCallback write_callback,
468         FLAC__StreamDecoderMetadataCallback metadata_callback,
469         FLAC__StreamDecoderErrorCallback error_callback,
470         void *client_data
471 )
472 {
473         return init_stream_internal_(
474                 decoder,
475                 read_callback,
476                 seek_callback,
477                 tell_callback,
478                 length_callback,
479                 eof_callback,
480                 write_callback,
481                 metadata_callback,
482                 error_callback,
483                 client_data,
484                 /*is_ogg=*/false
485         );
486 }
487
488 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_stream(
489         FLAC__StreamDecoder *decoder,
490         FLAC__StreamDecoderReadCallback read_callback,
491         FLAC__StreamDecoderSeekCallback seek_callback,
492         FLAC__StreamDecoderTellCallback tell_callback,
493         FLAC__StreamDecoderLengthCallback length_callback,
494         FLAC__StreamDecoderEofCallback eof_callback,
495         FLAC__StreamDecoderWriteCallback write_callback,
496         FLAC__StreamDecoderMetadataCallback metadata_callback,
497         FLAC__StreamDecoderErrorCallback error_callback,
498         void *client_data
499 )
500 {
501         return init_stream_internal_(
502                 decoder,
503                 read_callback,
504                 seek_callback,
505                 tell_callback,
506                 length_callback,
507                 eof_callback,
508                 write_callback,
509                 metadata_callback,
510                 error_callback,
511                 client_data,
512                 /*is_ogg=*/true
513         );
514 }
515
516 static FLAC__StreamDecoderInitStatus init_FILE_internal_(
517         FLAC__StreamDecoder *decoder,
518         FILE *file,
519         FLAC__StreamDecoderWriteCallback write_callback,
520         FLAC__StreamDecoderMetadataCallback metadata_callback,
521         FLAC__StreamDecoderErrorCallback error_callback,
522         void *client_data,
523         FLAC__bool is_ogg
524 )
525 {
526         FLAC__ASSERT(0 != decoder);
527         FLAC__ASSERT(0 != file);
528
529         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
530                 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
531
532         if(0 == write_callback || 0 == error_callback)
533                 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
534
535         /*
536          * To make sure that our file does not go unclosed after an error, we
537          * must assign the FILE pointer before any further error can occur in
538          * this routine.
539          */
540         if(file == stdin)
541                 file = get_binary_stdin_(); /* just to be safe */
542
543         decoder->private_->file = file;
544
545         return init_stream_internal_(
546                 decoder,
547                 file_read_callback_,
548                 decoder->private_->file == stdin? 0: file_seek_callback_,
549                 decoder->private_->file == stdin? 0: file_tell_callback_,
550                 decoder->private_->file == stdin? 0: file_length_callback_,
551                 file_eof_callback_,
552                 write_callback,
553                 metadata_callback,
554                 error_callback,
555                 client_data,
556                 is_ogg
557         );
558 }
559
560 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_FILE(
561         FLAC__StreamDecoder *decoder,
562         FILE *file,
563         FLAC__StreamDecoderWriteCallback write_callback,
564         FLAC__StreamDecoderMetadataCallback metadata_callback,
565         FLAC__StreamDecoderErrorCallback error_callback,
566         void *client_data
567 )
568 {
569         return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/false);
570 }
571
572 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_FILE(
573         FLAC__StreamDecoder *decoder,
574         FILE *file,
575         FLAC__StreamDecoderWriteCallback write_callback,
576         FLAC__StreamDecoderMetadataCallback metadata_callback,
577         FLAC__StreamDecoderErrorCallback error_callback,
578         void *client_data
579 )
580 {
581         return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/true);
582 }
583
584 static FLAC__StreamDecoderInitStatus init_file_internal_(
585         FLAC__StreamDecoder *decoder,
586         const char *filename,
587         FLAC__StreamDecoderWriteCallback write_callback,
588         FLAC__StreamDecoderMetadataCallback metadata_callback,
589         FLAC__StreamDecoderErrorCallback error_callback,
590         void *client_data,
591         FLAC__bool is_ogg
592 )
593 {
594         FILE *file;
595
596         FLAC__ASSERT(0 != decoder);
597
598         /*
599          * To make sure that our file does not go unclosed after an error, we
600          * have to do the same entrance checks here that are later performed
601          * in FLAC__stream_decoder_init_FILE() before the FILE* is assigned.
602          */
603         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
604                 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED;
605
606         if(0 == write_callback || 0 == error_callback)
607                 return decoder->protected_->initstate = FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS;
608
609         file = filename? flac_fopen(filename, "rb") : stdin;
610
611         if(0 == file)
612                 return FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE;
613
614         return init_FILE_internal_(decoder, file, write_callback, metadata_callback, error_callback, client_data, is_ogg);
615 }
616
617 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_file(
618         FLAC__StreamDecoder *decoder,
619         const char *filename,
620         FLAC__StreamDecoderWriteCallback write_callback,
621         FLAC__StreamDecoderMetadataCallback metadata_callback,
622         FLAC__StreamDecoderErrorCallback error_callback,
623         void *client_data
624 )
625 {
626         return init_file_internal_(decoder, filename, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/false);
627 }
628
629 FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_file(
630         FLAC__StreamDecoder *decoder,
631         const char *filename,
632         FLAC__StreamDecoderWriteCallback write_callback,
633         FLAC__StreamDecoderMetadataCallback metadata_callback,
634         FLAC__StreamDecoderErrorCallback error_callback,
635         void *client_data
636 )
637 {
638         return init_file_internal_(decoder, filename, write_callback, metadata_callback, error_callback, client_data, /*is_ogg=*/true);
639 }
640
641 FLAC_API FLAC__bool FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder)
642 {
643         FLAC__bool md5_failed = false;
644         unsigned i;
645
646         FLAC__ASSERT(0 != decoder);
647         FLAC__ASSERT(0 != decoder->private_);
648         FLAC__ASSERT(0 != decoder->protected_);
649
650         if(decoder->protected_->state == FLAC__STREAM_DECODER_UNINITIALIZED)
651                 return true;
652
653         /* see the comment in FLAC__stream_decoder_reset() as to why we
654          * always call FLAC__MD5Final()
655          */
656         FLAC__MD5Final(decoder->private_->computed_md5sum, &decoder->private_->md5context);
657
658         if(decoder->private_->has_seek_table && 0 != decoder->private_->seek_table.data.seek_table.points) {
659                 free(decoder->private_->seek_table.data.seek_table.points);
660                 decoder->private_->seek_table.data.seek_table.points = 0;
661                 decoder->private_->has_seek_table = false;
662         }
663         FLAC__bitreader_free(decoder->private_->input);
664         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
665                 /* WATCHOUT:
666                  * FLAC__lpc_restore_signal_asm_ia32_mmx() requires that the
667                  * output arrays have a buffer of up to 3 zeroes in front
668                  * (at negative indices) for alignment purposes; we use 4
669                  * to keep the data well-aligned.
670                  */
671                 if(0 != decoder->private_->output[i]) {
672                         free(decoder->private_->output[i]-4);
673                         decoder->private_->output[i] = 0;
674                 }
675                 if(0 != decoder->private_->residual_unaligned[i]) {
676                         free(decoder->private_->residual_unaligned[i]);
677                         decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
678                 }
679         }
680         decoder->private_->output_capacity = 0;
681         decoder->private_->output_channels = 0;
682
683 #if FLAC__HAS_OGG
684         if(decoder->private_->is_ogg)
685                 FLAC__ogg_decoder_aspect_finish(&decoder->protected_->ogg_decoder_aspect);
686 #endif
687
688         if(0 != decoder->private_->file) {
689                 if(decoder->private_->file != stdin)
690                         fclose(decoder->private_->file);
691                 decoder->private_->file = 0;
692         }
693
694         if(decoder->private_->do_md5_checking) {
695                 if(memcmp(decoder->private_->stream_info.data.stream_info.md5sum, decoder->private_->computed_md5sum, 16))
696                         md5_failed = true;
697         }
698         decoder->private_->is_seeking = false;
699
700         set_defaults_(decoder);
701
702         decoder->protected_->state = FLAC__STREAM_DECODER_UNINITIALIZED;
703
704         return !md5_failed;
705 }
706
707 FLAC_API FLAC__bool FLAC__stream_decoder_set_ogg_serial_number(FLAC__StreamDecoder *decoder, long value)
708 {
709         FLAC__ASSERT(0 != decoder);
710         FLAC__ASSERT(0 != decoder->private_);
711         FLAC__ASSERT(0 != decoder->protected_);
712         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
713                 return false;
714 #if FLAC__HAS_OGG
715         /* can't check decoder->private_->is_ogg since that's not set until init time */
716         FLAC__ogg_decoder_aspect_set_serial_number(&decoder->protected_->ogg_decoder_aspect, value);
717         return true;
718 #else
719         (void)value;
720         return false;
721 #endif
722 }
723
724 FLAC_API FLAC__bool FLAC__stream_decoder_set_md5_checking(FLAC__StreamDecoder *decoder, FLAC__bool value)
725 {
726         FLAC__ASSERT(0 != decoder);
727         FLAC__ASSERT(0 != decoder->protected_);
728         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
729                 return false;
730         decoder->protected_->md5_checking = value;
731         return true;
732 }
733
734 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
735 {
736         FLAC__ASSERT(0 != decoder);
737         FLAC__ASSERT(0 != decoder->private_);
738         FLAC__ASSERT(0 != decoder->protected_);
739         FLAC__ASSERT((unsigned)type <= FLAC__MAX_METADATA_TYPE_CODE);
740         /* double protection */
741         if((unsigned)type > FLAC__MAX_METADATA_TYPE_CODE)
742                 return false;
743         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
744                 return false;
745         decoder->private_->metadata_filter[type] = true;
746         if(type == FLAC__METADATA_TYPE_APPLICATION)
747                 decoder->private_->metadata_filter_ids_count = 0;
748         return true;
749 }
750
751 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
752 {
753         FLAC__ASSERT(0 != decoder);
754         FLAC__ASSERT(0 != decoder->private_);
755         FLAC__ASSERT(0 != decoder->protected_);
756         FLAC__ASSERT(0 != id);
757         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
758                 return false;
759
760         if(decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
761                 return true;
762
763         FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
764
765         if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
766                 if(0 == (decoder->private_->metadata_filter_ids = safe_realloc_mul_2op_(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity, /*times*/2))) {
767                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
768                         return false;
769                 }
770                 decoder->private_->metadata_filter_ids_capacity *= 2;
771         }
772
773         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));
774         decoder->private_->metadata_filter_ids_count++;
775
776         return true;
777 }
778
779 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_all(FLAC__StreamDecoder *decoder)
780 {
781         unsigned i;
782         FLAC__ASSERT(0 != decoder);
783         FLAC__ASSERT(0 != decoder->private_);
784         FLAC__ASSERT(0 != decoder->protected_);
785         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
786                 return false;
787         for(i = 0; i < sizeof(decoder->private_->metadata_filter) / sizeof(decoder->private_->metadata_filter[0]); i++)
788                 decoder->private_->metadata_filter[i] = true;
789         decoder->private_->metadata_filter_ids_count = 0;
790         return true;
791 }
792
793 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore(FLAC__StreamDecoder *decoder, FLAC__MetadataType type)
794 {
795         FLAC__ASSERT(0 != decoder);
796         FLAC__ASSERT(0 != decoder->private_);
797         FLAC__ASSERT(0 != decoder->protected_);
798         FLAC__ASSERT((unsigned)type <= FLAC__MAX_METADATA_TYPE_CODE);
799         /* double protection */
800         if((unsigned)type > FLAC__MAX_METADATA_TYPE_CODE)
801                 return false;
802         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
803                 return false;
804         decoder->private_->metadata_filter[type] = false;
805         if(type == FLAC__METADATA_TYPE_APPLICATION)
806                 decoder->private_->metadata_filter_ids_count = 0;
807         return true;
808 }
809
810 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4])
811 {
812         FLAC__ASSERT(0 != decoder);
813         FLAC__ASSERT(0 != decoder->private_);
814         FLAC__ASSERT(0 != decoder->protected_);
815         FLAC__ASSERT(0 != id);
816         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
817                 return false;
818
819         if(!decoder->private_->metadata_filter[FLAC__METADATA_TYPE_APPLICATION])
820                 return true;
821
822         FLAC__ASSERT(0 != decoder->private_->metadata_filter_ids);
823
824         if(decoder->private_->metadata_filter_ids_count == decoder->private_->metadata_filter_ids_capacity) {
825                 if(0 == (decoder->private_->metadata_filter_ids = safe_realloc_mul_2op_(decoder->private_->metadata_filter_ids, decoder->private_->metadata_filter_ids_capacity, /*times*/2))) {
826                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
827                         return false;
828                 }
829                 decoder->private_->metadata_filter_ids_capacity *= 2;
830         }
831
832         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));
833         decoder->private_->metadata_filter_ids_count++;
834
835         return true;
836 }
837
838 FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all(FLAC__StreamDecoder *decoder)
839 {
840         FLAC__ASSERT(0 != decoder);
841         FLAC__ASSERT(0 != decoder->private_);
842         FLAC__ASSERT(0 != decoder->protected_);
843         if(decoder->protected_->state != FLAC__STREAM_DECODER_UNINITIALIZED)
844                 return false;
845         memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
846         decoder->private_->metadata_filter_ids_count = 0;
847         return true;
848 }
849
850 FLAC_API FLAC__StreamDecoderState FLAC__stream_decoder_get_state(const FLAC__StreamDecoder *decoder)
851 {
852         FLAC__ASSERT(0 != decoder);
853         FLAC__ASSERT(0 != decoder->protected_);
854         return decoder->protected_->state;
855 }
856
857 FLAC_API const char *FLAC__stream_decoder_get_resolved_state_string(const FLAC__StreamDecoder *decoder)
858 {
859         return FLAC__StreamDecoderStateString[decoder->protected_->state];
860 }
861
862 FLAC_API FLAC__bool FLAC__stream_decoder_get_md5_checking(const FLAC__StreamDecoder *decoder)
863 {
864         FLAC__ASSERT(0 != decoder);
865         FLAC__ASSERT(0 != decoder->protected_);
866         return decoder->protected_->md5_checking;
867 }
868
869 FLAC_API FLAC__uint64 FLAC__stream_decoder_get_total_samples(const FLAC__StreamDecoder *decoder)
870 {
871         FLAC__ASSERT(0 != decoder);
872         FLAC__ASSERT(0 != decoder->protected_);
873         return decoder->private_->has_stream_info? decoder->private_->stream_info.data.stream_info.total_samples : 0;
874 }
875
876 FLAC_API unsigned FLAC__stream_decoder_get_channels(const FLAC__StreamDecoder *decoder)
877 {
878         FLAC__ASSERT(0 != decoder);
879         FLAC__ASSERT(0 != decoder->protected_);
880         return decoder->protected_->channels;
881 }
882
883 FLAC_API FLAC__ChannelAssignment FLAC__stream_decoder_get_channel_assignment(const FLAC__StreamDecoder *decoder)
884 {
885         FLAC__ASSERT(0 != decoder);
886         FLAC__ASSERT(0 != decoder->protected_);
887         return decoder->protected_->channel_assignment;
888 }
889
890 FLAC_API unsigned FLAC__stream_decoder_get_bits_per_sample(const FLAC__StreamDecoder *decoder)
891 {
892         FLAC__ASSERT(0 != decoder);
893         FLAC__ASSERT(0 != decoder->protected_);
894         return decoder->protected_->bits_per_sample;
895 }
896
897 FLAC_API unsigned FLAC__stream_decoder_get_sample_rate(const FLAC__StreamDecoder *decoder)
898 {
899         FLAC__ASSERT(0 != decoder);
900         FLAC__ASSERT(0 != decoder->protected_);
901         return decoder->protected_->sample_rate;
902 }
903
904 FLAC_API unsigned FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *decoder)
905 {
906         FLAC__ASSERT(0 != decoder);
907         FLAC__ASSERT(0 != decoder->protected_);
908         return decoder->protected_->blocksize;
909 }
910
911 FLAC_API FLAC__bool FLAC__stream_decoder_get_decode_position(const FLAC__StreamDecoder *decoder, FLAC__uint64 *position)
912 {
913         FLAC__ASSERT(0 != decoder);
914         FLAC__ASSERT(0 != decoder->private_);
915         FLAC__ASSERT(0 != position);
916
917 #if FLAC__HAS_OGG
918         if(decoder->private_->is_ogg)
919                 return false;
920 #endif
921         if(0 == decoder->private_->tell_callback)
922                 return false;
923         if(decoder->private_->tell_callback(decoder, position, decoder->private_->client_data) != FLAC__STREAM_DECODER_TELL_STATUS_OK)
924                 return false;
925         /* should never happen since all FLAC frames and metadata blocks are byte aligned, but check just in case */
926         if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input))
927                 return false;
928         FLAC__ASSERT(*position >= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder));
929         *position -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder);
930         return true;
931 }
932
933 FLAC_API FLAC__bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder)
934 {
935         FLAC__ASSERT(0 != decoder);
936         FLAC__ASSERT(0 != decoder->private_);
937         FLAC__ASSERT(0 != decoder->protected_);
938
939         decoder->private_->samples_decoded = 0;
940         decoder->private_->do_md5_checking = false;
941
942 #if FLAC__HAS_OGG
943         if(decoder->private_->is_ogg)
944                 FLAC__ogg_decoder_aspect_flush(&decoder->protected_->ogg_decoder_aspect);
945 #endif
946
947         if(!FLAC__bitreader_clear(decoder->private_->input)) {
948                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
949                 return false;
950         }
951         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
952
953         return true;
954 }
955
956 FLAC_API FLAC__bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder)
957 {
958         FLAC__ASSERT(0 != decoder);
959         FLAC__ASSERT(0 != decoder->private_);
960         FLAC__ASSERT(0 != decoder->protected_);
961
962         if(!FLAC__stream_decoder_flush(decoder)) {
963                 /* above call sets the state for us */
964                 return false;
965         }
966
967 #if FLAC__HAS_OGG
968         /*@@@ could go in !internal_reset_hack block below */
969         if(decoder->private_->is_ogg)
970                 FLAC__ogg_decoder_aspect_reset(&decoder->protected_->ogg_decoder_aspect);
971 #endif
972
973         /* Rewind if necessary.  If FLAC__stream_decoder_init() is calling us,
974          * (internal_reset_hack) don't try to rewind since we are already at
975          * the beginning of the stream and don't want to fail if the input is
976          * not seekable.
977          */
978         if(!decoder->private_->internal_reset_hack) {
979                 if(decoder->private_->file == stdin)
980                         return false; /* can't rewind stdin, reset fails */
981                 if(decoder->private_->seek_callback && decoder->private_->seek_callback(decoder, 0, decoder->private_->client_data) == FLAC__STREAM_DECODER_SEEK_STATUS_ERROR)
982                         return false; /* seekable and seek fails, reset fails */
983         }
984         else
985                 decoder->private_->internal_reset_hack = false;
986
987         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_METADATA;
988
989         decoder->private_->has_stream_info = false;
990         if(decoder->private_->has_seek_table && 0 != decoder->private_->seek_table.data.seek_table.points) {
991                 free(decoder->private_->seek_table.data.seek_table.points);
992                 decoder->private_->seek_table.data.seek_table.points = 0;
993                 decoder->private_->has_seek_table = false;
994         }
995         decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
996         /*
997          * This goes in reset() and not flush() because according to the spec, a
998          * fixed-blocksize stream must stay that way through the whole stream.
999          */
1000         decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size = 0;
1001
1002         /* We initialize the FLAC__MD5Context even though we may never use it.  This
1003          * is because md5 checking may be turned on to start and then turned off if
1004          * a seek occurs.  So we init the context here and finalize it in
1005          * FLAC__stream_decoder_finish() to make sure things are always cleaned up
1006          * properly.
1007          */
1008         FLAC__MD5Init(&decoder->private_->md5context);
1009
1010         decoder->private_->first_frame_offset = 0;
1011         decoder->private_->unparseable_frame_count = 0;
1012
1013         return true;
1014 }
1015
1016 FLAC_API FLAC__bool FLAC__stream_decoder_process_single(FLAC__StreamDecoder *decoder)
1017 {
1018         FLAC__bool got_a_frame;
1019         FLAC__ASSERT(0 != decoder);
1020         FLAC__ASSERT(0 != decoder->protected_);
1021
1022         while(1) {
1023                 switch(decoder->protected_->state) {
1024                         case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1025                                 if(!find_metadata_(decoder))
1026                                         return false; /* above function sets the status for us */
1027                                 break;
1028                         case FLAC__STREAM_DECODER_READ_METADATA:
1029                                 if(!read_metadata_(decoder))
1030                                         return false; /* above function sets the status for us */
1031                                 else
1032                                         return true;
1033                         case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1034                                 if(!frame_sync_(decoder))
1035                                         return true; /* above function sets the status for us */
1036                                 break;
1037                         case FLAC__STREAM_DECODER_READ_FRAME:
1038                                 if(!read_frame_(decoder, &got_a_frame, /*do_full_decode=*/true))
1039                                         return false; /* above function sets the status for us */
1040                                 if(got_a_frame)
1041                                         return true; /* above function sets the status for us */
1042                                 break;
1043                         case FLAC__STREAM_DECODER_END_OF_STREAM:
1044                         case FLAC__STREAM_DECODER_ABORTED:
1045                                 return true;
1046                         default:
1047                                 FLAC__ASSERT(0);
1048                                 return false;
1049                 }
1050         }
1051 }
1052
1053 FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_metadata(FLAC__StreamDecoder *decoder)
1054 {
1055         FLAC__ASSERT(0 != decoder);
1056         FLAC__ASSERT(0 != decoder->protected_);
1057
1058         while(1) {
1059                 switch(decoder->protected_->state) {
1060                         case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1061                                 if(!find_metadata_(decoder))
1062                                         return false; /* above function sets the status for us */
1063                                 break;
1064                         case FLAC__STREAM_DECODER_READ_METADATA:
1065                                 if(!read_metadata_(decoder))
1066                                         return false; /* above function sets the status for us */
1067                                 break;
1068                         case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1069                         case FLAC__STREAM_DECODER_READ_FRAME:
1070                         case FLAC__STREAM_DECODER_END_OF_STREAM:
1071                         case FLAC__STREAM_DECODER_ABORTED:
1072                                 return true;
1073                         default:
1074                                 FLAC__ASSERT(0);
1075                                 return false;
1076                 }
1077         }
1078 }
1079
1080 FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_stream(FLAC__StreamDecoder *decoder)
1081 {
1082         FLAC__bool dummy;
1083         FLAC__ASSERT(0 != decoder);
1084         FLAC__ASSERT(0 != decoder->protected_);
1085
1086         while(1) {
1087                 switch(decoder->protected_->state) {
1088                         case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1089                                 if(!find_metadata_(decoder))
1090                                         return false; /* above function sets the status for us */
1091                                 break;
1092                         case FLAC__STREAM_DECODER_READ_METADATA:
1093                                 if(!read_metadata_(decoder))
1094                                         return false; /* above function sets the status for us */
1095                                 break;
1096                         case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1097                                 if(!frame_sync_(decoder))
1098                                         return true; /* above function sets the status for us */
1099                                 break;
1100                         case FLAC__STREAM_DECODER_READ_FRAME:
1101                                 if(!read_frame_(decoder, &dummy, /*do_full_decode=*/true))
1102                                         return false; /* above function sets the status for us */
1103                                 break;
1104                         case FLAC__STREAM_DECODER_END_OF_STREAM:
1105                         case FLAC__STREAM_DECODER_ABORTED:
1106                                 return true;
1107                         default:
1108                                 FLAC__ASSERT(0);
1109                                 return false;
1110                 }
1111         }
1112 }
1113
1114 FLAC_API FLAC__bool FLAC__stream_decoder_skip_single_frame(FLAC__StreamDecoder *decoder)
1115 {
1116         FLAC__bool got_a_frame;
1117         FLAC__ASSERT(0 != decoder);
1118         FLAC__ASSERT(0 != decoder->protected_);
1119
1120         while(1) {
1121                 switch(decoder->protected_->state) {
1122                         case FLAC__STREAM_DECODER_SEARCH_FOR_METADATA:
1123                         case FLAC__STREAM_DECODER_READ_METADATA:
1124                                 return false; /* above function sets the status for us */
1125                         case FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC:
1126                                 if(!frame_sync_(decoder))
1127                                         return true; /* above function sets the status for us */
1128                                 break;
1129                         case FLAC__STREAM_DECODER_READ_FRAME:
1130                                 if(!read_frame_(decoder, &got_a_frame, /*do_full_decode=*/false))
1131                                         return false; /* above function sets the status for us */
1132                                 if(got_a_frame)
1133                                         return true; /* above function sets the status for us */
1134                                 break;
1135                         case FLAC__STREAM_DECODER_END_OF_STREAM:
1136                         case FLAC__STREAM_DECODER_ABORTED:
1137                                 return true;
1138                         default:
1139                                 FLAC__ASSERT(0);
1140                                 return false;
1141                 }
1142         }
1143 }
1144
1145 FLAC_API FLAC__bool FLAC__stream_decoder_seek_absolute(FLAC__StreamDecoder *decoder, FLAC__uint64 sample)
1146 {
1147         FLAC__uint64 length;
1148
1149         FLAC__ASSERT(0 != decoder);
1150
1151         if(
1152                 decoder->protected_->state != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA &&
1153                 decoder->protected_->state != FLAC__STREAM_DECODER_READ_METADATA &&
1154                 decoder->protected_->state != FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC &&
1155                 decoder->protected_->state != FLAC__STREAM_DECODER_READ_FRAME &&
1156                 decoder->protected_->state != FLAC__STREAM_DECODER_END_OF_STREAM
1157         )
1158                 return false;
1159
1160         if(0 == decoder->private_->seek_callback)
1161                 return false;
1162
1163         FLAC__ASSERT(decoder->private_->seek_callback);
1164         FLAC__ASSERT(decoder->private_->tell_callback);
1165         FLAC__ASSERT(decoder->private_->length_callback);
1166         FLAC__ASSERT(decoder->private_->eof_callback);
1167
1168         if(FLAC__stream_decoder_get_total_samples(decoder) > 0 && sample >= FLAC__stream_decoder_get_total_samples(decoder))
1169                 return false;
1170
1171         decoder->private_->is_seeking = true;
1172
1173         /* turn off md5 checking if a seek is attempted */
1174         decoder->private_->do_md5_checking = false;
1175
1176         /* 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) */
1177         if(decoder->private_->length_callback(decoder, &length, decoder->private_->client_data) != FLAC__STREAM_DECODER_LENGTH_STATUS_OK) {
1178                 decoder->private_->is_seeking = false;
1179                 return false;
1180         }
1181
1182         /* if we haven't finished processing the metadata yet, do that so we have the STREAMINFO, SEEK_TABLE, and first_frame_offset */
1183         if(
1184                 decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_METADATA ||
1185                 decoder->protected_->state == FLAC__STREAM_DECODER_READ_METADATA
1186         ) {
1187                 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder)) {
1188                         /* above call sets the state for us */
1189                         decoder->private_->is_seeking = false;
1190                         return false;
1191                 }
1192                 /* check this again in case we didn't know total_samples the first time */
1193                 if(FLAC__stream_decoder_get_total_samples(decoder) > 0 && sample >= FLAC__stream_decoder_get_total_samples(decoder)) {
1194                         decoder->private_->is_seeking = false;
1195                         return false;
1196                 }
1197         }
1198
1199         {
1200                 const FLAC__bool ok =
1201 #if FLAC__HAS_OGG
1202                         decoder->private_->is_ogg?
1203                         seek_to_absolute_sample_ogg_(decoder, length, sample) :
1204 #endif
1205                         seek_to_absolute_sample_(decoder, length, sample)
1206                 ;
1207                 decoder->private_->is_seeking = false;
1208                 return ok;
1209         }
1210 }
1211
1212 /***********************************************************************
1213  *
1214  * Protected class methods
1215  *
1216  ***********************************************************************/
1217
1218 unsigned FLAC__stream_decoder_get_input_bytes_unconsumed(const FLAC__StreamDecoder *decoder)
1219 {
1220         FLAC__ASSERT(0 != decoder);
1221         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1222         FLAC__ASSERT(!(FLAC__bitreader_get_input_bits_unconsumed(decoder->private_->input) & 7));
1223         return FLAC__bitreader_get_input_bits_unconsumed(decoder->private_->input) / 8;
1224 }
1225
1226 /***********************************************************************
1227  *
1228  * Private class methods
1229  *
1230  ***********************************************************************/
1231
1232 void set_defaults_(FLAC__StreamDecoder *decoder)
1233 {
1234 #if FLAC__HAS_OGG
1235         decoder->private_->is_ogg = false;
1236 #endif
1237         decoder->private_->read_callback = 0;
1238         decoder->private_->seek_callback = 0;
1239         decoder->private_->tell_callback = 0;
1240         decoder->private_->length_callback = 0;
1241         decoder->private_->eof_callback = 0;
1242         decoder->private_->write_callback = 0;
1243         decoder->private_->metadata_callback = 0;
1244         decoder->private_->error_callback = 0;
1245         decoder->private_->client_data = 0;
1246
1247         memset(decoder->private_->metadata_filter, 0, sizeof(decoder->private_->metadata_filter));
1248         decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] = true;
1249         decoder->private_->metadata_filter_ids_count = 0;
1250
1251         decoder->protected_->md5_checking = false;
1252
1253 #if FLAC__HAS_OGG
1254         FLAC__ogg_decoder_aspect_set_defaults(&decoder->protected_->ogg_decoder_aspect);
1255 #endif
1256 }
1257
1258 /*
1259  * This will forcibly set stdin to binary mode (for OSes that require it)
1260  */
1261 FILE *get_binary_stdin_(void)
1262 {
1263         /* if something breaks here it is probably due to the presence or
1264          * absence of an underscore before the identifiers 'setmode',
1265          * 'fileno', and/or 'O_BINARY'; check your system header files.
1266          */
1267 #if defined _MSC_VER || defined __MINGW32__
1268         _setmode(_fileno(stdin), _O_BINARY);
1269 #elif defined __CYGWIN__
1270         /* almost certainly not needed for any modern Cygwin, but let's be safe... */
1271         setmode(_fileno(stdin), _O_BINARY);
1272 #elif defined __EMX__
1273         setmode(fileno(stdin), O_BINARY);
1274 #endif
1275
1276         return stdin;
1277 }
1278
1279 FLAC__bool allocate_output_(FLAC__StreamDecoder *decoder, unsigned size, unsigned channels)
1280 {
1281         unsigned i;
1282         FLAC__int32 *tmp;
1283
1284         if(size <= decoder->private_->output_capacity && channels <= decoder->private_->output_channels)
1285                 return true;
1286
1287         /* simply using realloc() is not practical because the number of channels may change mid-stream */
1288
1289         for(i = 0; i < FLAC__MAX_CHANNELS; i++) {
1290                 if(0 != decoder->private_->output[i]) {
1291                         free(decoder->private_->output[i]-4);
1292                         decoder->private_->output[i] = 0;
1293                 }
1294                 if(0 != decoder->private_->residual_unaligned[i]) {
1295                         free(decoder->private_->residual_unaligned[i]);
1296                         decoder->private_->residual_unaligned[i] = decoder->private_->residual[i] = 0;
1297                 }
1298         }
1299
1300         for(i = 0; i < channels; i++) {
1301                 /* WATCHOUT:
1302                  * FLAC__lpc_restore_signal_asm_ia32_mmx() requires that the
1303                  * output arrays have a buffer of up to 3 zeroes in front
1304                  * (at negative indices) for alignment purposes; we use 4
1305                  * to keep the data well-aligned.
1306                  */
1307                 tmp = safe_malloc_muladd2_(sizeof(FLAC__int32), /*times (*/size, /*+*/4/*)*/);
1308                 if(tmp == 0) {
1309                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1310                         return false;
1311                 }
1312                 memset(tmp, 0, sizeof(FLAC__int32)*4);
1313                 decoder->private_->output[i] = tmp + 4;
1314
1315                 if(!FLAC__memory_alloc_aligned_int32_array(size, &decoder->private_->residual_unaligned[i], &decoder->private_->residual[i])) {
1316                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1317                         return false;
1318                 }
1319         }
1320
1321         decoder->private_->output_capacity = size;
1322         decoder->private_->output_channels = channels;
1323
1324         return true;
1325 }
1326
1327 FLAC__bool has_id_filtered_(FLAC__StreamDecoder *decoder, FLAC__byte *id)
1328 {
1329         size_t i;
1330
1331         FLAC__ASSERT(0 != decoder);
1332         FLAC__ASSERT(0 != decoder->private_);
1333
1334         for(i = 0; i < decoder->private_->metadata_filter_ids_count; i++)
1335                 if(0 == memcmp(decoder->private_->metadata_filter_ids + i * (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8), id, (FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8)))
1336                         return true;
1337
1338         return false;
1339 }
1340
1341 FLAC__bool find_metadata_(FLAC__StreamDecoder *decoder)
1342 {
1343         FLAC__uint32 x;
1344         unsigned i, id;
1345         FLAC__bool first = true;
1346
1347         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1348
1349         for(i = id = 0; i < 4; ) {
1350                 if(decoder->private_->cached) {
1351                         x = (FLAC__uint32)decoder->private_->lookahead;
1352                         decoder->private_->cached = false;
1353                 }
1354                 else {
1355                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1356                                 return false; /* read_callback_ sets the state for us */
1357                 }
1358                 if(x == FLAC__STREAM_SYNC_STRING[i]) {
1359                         first = true;
1360                         i++;
1361                         id = 0;
1362                         continue;
1363                 }
1364
1365                 if(id >= 3)
1366                         return false;
1367
1368                 if(x == ID3V2_TAG_[id]) {
1369                         id++;
1370                         i = 0;
1371                         if(id == 3) {
1372                                 if(!skip_id3v2_tag_(decoder))
1373                                         return false; /* skip_id3v2_tag_ sets the state for us */
1374                         }
1375                         continue;
1376                 }
1377                 id = 0;
1378                 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1379                         decoder->private_->header_warmup[0] = (FLAC__byte)x;
1380                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1381                                 return false; /* read_callback_ sets the state for us */
1382
1383                         /* 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 */
1384                         /* else we have to check if the second byte is the end of a sync code */
1385                         if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1386                                 decoder->private_->lookahead = (FLAC__byte)x;
1387                                 decoder->private_->cached = true;
1388                         }
1389                         else if(x >> 1 == 0x7c) { /* MAGIC NUMBER for the last 6 sync bits and reserved 7th bit */
1390                                 decoder->private_->header_warmup[1] = (FLAC__byte)x;
1391                                 decoder->protected_->state = FLAC__STREAM_DECODER_READ_FRAME;
1392                                 return true;
1393                         }
1394                 }
1395                 i = 0;
1396                 if(first) {
1397                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
1398                         first = false;
1399                 }
1400         }
1401
1402         decoder->protected_->state = FLAC__STREAM_DECODER_READ_METADATA;
1403         return true;
1404 }
1405
1406 FLAC__bool read_metadata_(FLAC__StreamDecoder *decoder)
1407 {
1408         FLAC__bool is_last;
1409         FLAC__uint32 i, x, type, length;
1410
1411         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1412
1413         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_IS_LAST_LEN))
1414                 return false; /* read_callback_ sets the state for us */
1415         is_last = x? true : false;
1416
1417         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &type, FLAC__STREAM_METADATA_TYPE_LEN))
1418                 return false; /* read_callback_ sets the state for us */
1419
1420         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &length, FLAC__STREAM_METADATA_LENGTH_LEN))
1421                 return false; /* read_callback_ sets the state for us */
1422
1423         if(type == FLAC__METADATA_TYPE_STREAMINFO) {
1424                 if(!read_metadata_streaminfo_(decoder, is_last, length))
1425                         return false;
1426
1427                 decoder->private_->has_stream_info = true;
1428                 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))
1429                         decoder->private_->do_md5_checking = false;
1430                 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] && decoder->private_->metadata_callback)
1431                         decoder->private_->metadata_callback(decoder, &decoder->private_->stream_info, decoder->private_->client_data);
1432         }
1433         else if(type == FLAC__METADATA_TYPE_SEEKTABLE) {
1434                 if(!read_metadata_seektable_(decoder, is_last, length))
1435                         return false;
1436
1437                 decoder->private_->has_seek_table = true;
1438                 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_SEEKTABLE] && decoder->private_->metadata_callback)
1439                         decoder->private_->metadata_callback(decoder, &decoder->private_->seek_table, decoder->private_->client_data);
1440         }
1441         else {
1442                 FLAC__bool skip_it = !decoder->private_->metadata_filter[type];
1443                 unsigned real_length = length;
1444                 FLAC__StreamMetadata block;
1445
1446                 memset(&block, 0, sizeof(block));
1447                 block.is_last = is_last;
1448                 block.type = (FLAC__MetadataType)type;
1449                 block.length = length;
1450
1451                 if(type == FLAC__METADATA_TYPE_APPLICATION) {
1452                         if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8))
1453                                 return false; /* read_callback_ sets the state for us */
1454
1455                         if(real_length < FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) { /* underflow check */
1456                                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;/*@@@@@@ maybe wrong error? need to resync?*/
1457                                 return false;
1458                         }
1459
1460                         real_length -= FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8;
1461
1462                         if(decoder->private_->metadata_filter_ids_count > 0 && has_id_filtered_(decoder, block.data.application.id))
1463                                 skip_it = !skip_it;
1464                 }
1465
1466                 if(skip_it) {
1467                         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1468                                 return false; /* read_callback_ sets the state for us */
1469                 }
1470                 else {
1471                         FLAC__bool ok = true;
1472                         switch(type) {
1473                                 case FLAC__METADATA_TYPE_PADDING:
1474                                         /* skip the padding bytes */
1475                                         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1476                                                 ok = false; /* read_callback_ sets the state for us */
1477                                         break;
1478                                 case FLAC__METADATA_TYPE_APPLICATION:
1479                                         /* remember, we read the ID already */
1480                                         if(real_length > 0) {
1481                                                 if(0 == (block.data.application.data = malloc(real_length))) {
1482                                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1483                                                         ok = false;
1484                                                 }
1485                                                 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.data, real_length))
1486                                                         ok = false; /* read_callback_ sets the state for us */
1487                                         }
1488                                         else
1489                                                 block.data.application.data = 0;
1490                                         break;
1491                                 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1492                                         if(!read_metadata_vorbiscomment_(decoder, &block.data.vorbis_comment, real_length))
1493                                                 ok = false;
1494                                         break;
1495                                 case FLAC__METADATA_TYPE_CUESHEET:
1496                                         if(!read_metadata_cuesheet_(decoder, &block.data.cue_sheet))
1497                                                 ok = false;
1498                                         break;
1499                                 case FLAC__METADATA_TYPE_PICTURE:
1500                                         if(!read_metadata_picture_(decoder, &block.data.picture))
1501                                                 ok = false;
1502                                         break;
1503                                 case FLAC__METADATA_TYPE_STREAMINFO:
1504                                 case FLAC__METADATA_TYPE_SEEKTABLE:
1505                                         FLAC__ASSERT(0);
1506                                         break;
1507                                 default:
1508                                         if(real_length > 0) {
1509                                                 if(0 == (block.data.unknown.data = malloc(real_length))) {
1510                                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1511                                                         ok = false;
1512                                                 }
1513                                                 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.unknown.data, real_length))
1514                                                         ok = false; /* read_callback_ sets the state for us */
1515                                         }
1516                                         else
1517                                                 block.data.unknown.data = 0;
1518                                         break;
1519                         }
1520                         if(ok && !decoder->private_->is_seeking && decoder->private_->metadata_callback)
1521                                 decoder->private_->metadata_callback(decoder, &block, decoder->private_->client_data);
1522
1523                         /* now we have to free any malloc()ed data in the block */
1524                         switch(type) {
1525                                 case FLAC__METADATA_TYPE_PADDING:
1526                                         break;
1527                                 case FLAC__METADATA_TYPE_APPLICATION:
1528                                         if(0 != block.data.application.data)
1529                                                 free(block.data.application.data);
1530                                         break;
1531                                 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1532                                         if(0 != block.data.vorbis_comment.vendor_string.entry)
1533                                                 free(block.data.vorbis_comment.vendor_string.entry);
1534                                         if(block.data.vorbis_comment.num_comments > 0)
1535                                                 for(i = 0; i < block.data.vorbis_comment.num_comments; i++)
1536                                                         if(0 != block.data.vorbis_comment.comments[i].entry)
1537                                                                 free(block.data.vorbis_comment.comments[i].entry);
1538                                         if(0 != block.data.vorbis_comment.comments)
1539                                                 free(block.data.vorbis_comment.comments);
1540                                         break;
1541                                 case FLAC__METADATA_TYPE_CUESHEET:
1542                                         if(block.data.cue_sheet.num_tracks > 0)
1543                                                 for(i = 0; i < block.data.cue_sheet.num_tracks; i++)
1544                                                         if(0 != block.data.cue_sheet.tracks[i].indices)
1545                                                                 free(block.data.cue_sheet.tracks[i].indices);
1546                                         if(0 != block.data.cue_sheet.tracks)
1547                                                 free(block.data.cue_sheet.tracks);
1548                                         break;
1549                                 case FLAC__METADATA_TYPE_PICTURE:
1550                                         if(0 != block.data.picture.mime_type)
1551                                                 free(block.data.picture.mime_type);
1552                                         if(0 != block.data.picture.description)
1553                                                 free(block.data.picture.description);
1554                                         if(0 != block.data.picture.data)
1555                                                 free(block.data.picture.data);
1556                                         break;
1557                                 case FLAC__METADATA_TYPE_STREAMINFO:
1558                                 case FLAC__METADATA_TYPE_SEEKTABLE:
1559                                         FLAC__ASSERT(0);
1560                                 default:
1561                                         if(0 != block.data.unknown.data)
1562                                                 free(block.data.unknown.data);
1563                                         break;
1564                         }
1565
1566                         if(!ok) /* anything that unsets "ok" should also make sure decoder->protected_->state is updated */
1567                                 return false;
1568                 }
1569         }
1570
1571         if(is_last) {
1572                 /* if this fails, it's OK, it's just a hint for the seek routine */
1573                 if(!FLAC__stream_decoder_get_decode_position(decoder, &decoder->private_->first_frame_offset))
1574                         decoder->private_->first_frame_offset = 0;
1575                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
1576         }
1577
1578         return true;
1579 }
1580
1581 FLAC__bool read_metadata_streaminfo_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length)
1582 {
1583         FLAC__uint32 x;
1584         unsigned bits, used_bits = 0;
1585
1586         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1587
1588         decoder->private_->stream_info.type = FLAC__METADATA_TYPE_STREAMINFO;
1589         decoder->private_->stream_info.is_last = is_last;
1590         decoder->private_->stream_info.length = length;
1591
1592         bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN;
1593         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, bits))
1594                 return false; /* read_callback_ sets the state for us */
1595         decoder->private_->stream_info.data.stream_info.min_blocksize = x;
1596         used_bits += bits;
1597
1598         bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN;
1599         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
1600                 return false; /* read_callback_ sets the state for us */
1601         decoder->private_->stream_info.data.stream_info.max_blocksize = x;
1602         used_bits += bits;
1603
1604         bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN;
1605         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
1606                 return false; /* read_callback_ sets the state for us */
1607         decoder->private_->stream_info.data.stream_info.min_framesize = x;
1608         used_bits += bits;
1609
1610         bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN;
1611         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
1612                 return false; /* read_callback_ sets the state for us */
1613         decoder->private_->stream_info.data.stream_info.max_framesize = x;
1614         used_bits += bits;
1615
1616         bits = FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN;
1617         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
1618                 return false; /* read_callback_ sets the state for us */
1619         decoder->private_->stream_info.data.stream_info.sample_rate = x;
1620         used_bits += bits;
1621
1622         bits = FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN;
1623         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
1624                 return false; /* read_callback_ sets the state for us */
1625         decoder->private_->stream_info.data.stream_info.channels = x+1;
1626         used_bits += bits;
1627
1628         bits = FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN;
1629         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
1630                 return false; /* read_callback_ sets the state for us */
1631         decoder->private_->stream_info.data.stream_info.bits_per_sample = x+1;
1632         used_bits += bits;
1633
1634         bits = FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN;
1635         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))
1636                 return false; /* read_callback_ sets the state for us */
1637         used_bits += bits;
1638
1639         if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, decoder->private_->stream_info.data.stream_info.md5sum, 16))
1640                 return false; /* read_callback_ sets the state for us */
1641         used_bits += 16*8;
1642
1643         /* skip the rest of the block */
1644         FLAC__ASSERT(used_bits % 8 == 0);
1645         length -= (used_bits / 8);
1646         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1647                 return false; /* read_callback_ sets the state for us */
1648
1649         return true;
1650 }
1651
1652 FLAC__bool read_metadata_seektable_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length)
1653 {
1654         FLAC__uint32 i, x;
1655         FLAC__uint64 xx;
1656
1657         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1658
1659         decoder->private_->seek_table.type = FLAC__METADATA_TYPE_SEEKTABLE;
1660         decoder->private_->seek_table.is_last = is_last;
1661         decoder->private_->seek_table.length = length;
1662
1663         decoder->private_->seek_table.data.seek_table.num_points = length / FLAC__STREAM_METADATA_SEEKPOINT_LENGTH;
1664
1665         /* use realloc since we may pass through here several times (e.g. after seeking) */
1666         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)))) {
1667                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1668                 return false;
1669         }
1670         for(i = 0; i < decoder->private_->seek_table.data.seek_table.num_points; i++) {
1671                 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
1672                         return false; /* read_callback_ sets the state for us */
1673                 decoder->private_->seek_table.data.seek_table.points[i].sample_number = xx;
1674
1675                 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
1676                         return false; /* read_callback_ sets the state for us */
1677                 decoder->private_->seek_table.data.seek_table.points[i].stream_offset = xx;
1678
1679                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
1680                         return false; /* read_callback_ sets the state for us */
1681                 decoder->private_->seek_table.data.seek_table.points[i].frame_samples = x;
1682         }
1683         length -= (decoder->private_->seek_table.data.seek_table.num_points * FLAC__STREAM_METADATA_SEEKPOINT_LENGTH);
1684         /* if there is a partial point left, skip over it */
1685         if(length > 0) {
1686                 /*@@@ do a send_error_to_client_() here?  there's an argument for either way */
1687                 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1688                         return false; /* read_callback_ sets the state for us */
1689         }
1690
1691         return true;
1692 }
1693
1694 FLAC__bool read_metadata_vorbiscomment_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_VorbisComment *obj, unsigned length)
1695 {
1696         FLAC__uint32 i;
1697
1698         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1699
1700         /* read vendor string */
1701         if (length >= 8) {
1702                 length -= 8; /* vendor string length + num comments entries alone take 8 bytes */
1703                 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1704                 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->vendor_string.length))
1705                         return false; /* read_callback_ sets the state for us */
1706                 if (obj->vendor_string.length > 0) {
1707                         if (length < obj->vendor_string.length) {
1708                                 obj->vendor_string.length = 0;
1709                                 obj->vendor_string.entry = 0;
1710                                 goto skip;
1711                         }
1712                         else
1713                                 length -= obj->vendor_string.length;
1714                         if (0 == (obj->vendor_string.entry = safe_malloc_add_2op_(obj->vendor_string.length, /*+*/1))) {
1715                                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1716                                 return false;
1717                         }
1718                         if (!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->vendor_string.entry, obj->vendor_string.length))
1719                                 return false; /* read_callback_ sets the state for us */
1720                         obj->vendor_string.entry[obj->vendor_string.length] = '\0';
1721                 }
1722                 else
1723                         obj->vendor_string.entry = 0;
1724
1725                 /* read num comments */
1726                 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN == 32);
1727                 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->num_comments))
1728                         return false; /* read_callback_ sets the state for us */
1729
1730                 /* read comments */
1731                 if (obj->num_comments > 100000) {
1732                         /* Possibly malicious file. */
1733                         obj->num_comments = 0;
1734                         return false;
1735                 }
1736                 if (obj->num_comments > 0) {
1737                         if (0 == (obj->comments = safe_malloc_mul_2op_p(obj->num_comments, /*times*/sizeof(FLAC__StreamMetadata_VorbisComment_Entry)))) {
1738                                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1739                                 return false;
1740                         }
1741                         for (i = 0; i < obj->num_comments; i++) {
1742                                 FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1743                                 if (length < 4) {
1744                                         obj->num_comments = i;
1745                                         goto skip;
1746                                 }
1747                                 else
1748                                         length -= 4;
1749                                 if (!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->comments[i].length))
1750                                         return false; /* read_callback_ sets the state for us */
1751                                 if (obj->comments[i].length > 0) {
1752                                         if (length < obj->comments[i].length) {
1753                                                 obj->comments[i].length = 0;
1754                                                 obj->comments[i].entry = 0;
1755                                                 obj->num_comments = i;
1756                                                 goto skip;
1757                                         }
1758                                         else
1759                                                 length -= obj->comments[i].length;
1760                                         if (0 == (obj->comments[i].entry = safe_malloc_add_2op_(obj->comments[i].length, /*+*/1))) {
1761                                                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1762                                                 return false;
1763                                         }
1764                                         if (!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->comments[i].entry, obj->comments[i].length))
1765                                                 return false; /* read_callback_ sets the state for us */
1766                                         obj->comments[i].entry[obj->comments[i].length] = '\0';
1767                                 }
1768                                 else
1769                                         obj->comments[i].entry = 0;
1770                         }
1771                 }
1772                 else
1773                         obj->comments = 0;
1774         }
1775
1776   skip:
1777         if (length > 0) {
1778                 /* This will only happen on files with invalid data in comments */
1779                 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1780                         return false; /* read_callback_ sets the state for us */
1781         }
1782
1783         return true;
1784 }
1785
1786 FLAC__bool read_metadata_cuesheet_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_CueSheet *obj)
1787 {
1788         FLAC__uint32 i, j, x;
1789
1790         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1791
1792         memset(obj, 0, sizeof(FLAC__StreamMetadata_CueSheet));
1793
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 */
1797
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 */
1800
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;
1804
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 */
1807
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;
1811
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;
1816                 }
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 */
1821
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;
1825
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 */
1829
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;
1833
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;
1837
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 */
1840
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;
1844
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;
1849                                 }
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 */
1854
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;
1858
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 */
1861                                 }
1862                         }
1863                 }
1864         }
1865
1866         return true;
1867 }
1868
1869 FLAC__bool read_metadata_picture_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_Picture *obj)
1870 {
1871         FLAC__uint32 x;
1872
1873         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1874
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;
1879
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;
1886         }
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 */
1890         }
1891         obj->mime_type[x] = '\0';
1892
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;
1899         }
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 */
1903         }
1904         obj->description[x] = '\0';
1905
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 */
1909
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 */
1913
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 */
1917
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 */
1921
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;
1928         }
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 */
1932         }
1933
1934         return true;
1935 }
1936
1937 FLAC__bool skip_id3v2_tag_(FLAC__StreamDecoder *decoder)
1938 {
1939         FLAC__uint32 x;
1940         unsigned i, skip;
1941
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);
1952         }
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;
1957 }
1958
1959 FLAC__bool frame_sync_(FLAC__StreamDecoder *decoder)
1960 {
1961         FLAC__uint32 x;
1962         FLAC__bool first = true;
1963
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;
1970                 }
1971         }
1972
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 */
1977         }
1978
1979         while(1) {
1980                 if(decoder->private_->cached) {
1981                         x = (FLAC__uint32)decoder->private_->lookahead;
1982                         decoder->private_->cached = false;
1983                 }
1984                 else {
1985                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1986                                 return false; /* read_callback_ sets the state for us */
1987                 }
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 */
1992
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;
1998                         }
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;
2003                         }
2004                 }
2005                 if(first) {
2006                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2007                         first = false;
2008                 }
2009         }
2010
2011         return true;
2012 }
2013
2014 FLAC__bool read_frame_(FLAC__StreamDecoder *decoder, FLAC__bool *got_a_frame, FLAC__bool do_full_decode)
2015 {
2016         unsigned channel;
2017         unsigned i;
2018         FLAC__int32 mid, side;
2019         unsigned frame_crc; /* the one we calculate from the input stream */
2020         FLAC__uint32 x;
2021
2022         *got_a_frame = false;
2023
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);
2029
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++) {
2037                 /*
2038                  * first figure the correct bits-per-sample of the subframe
2039                  */
2040                 unsigned 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);
2062                 }
2063                 /*
2064                  * now read it
2065                  */
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;
2070         }
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;
2075
2076         /*
2077          * Read the frame CRC-16 from the footer and check
2078          */
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 <<= 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
2115                                         }
2116                                         break;
2117                                 default:
2118                                         FLAC__ASSERT(0);
2119                                         break;
2120                         }
2121                 }
2122         }
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);
2129                         }
2130                 }
2131         }
2132
2133         *got_a_frame = true;
2134
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;
2138
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;
2145
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;
2148
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                         return false;
2153         }
2154
2155         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2156         return true;
2157 }
2158
2159 FLAC__bool read_frame_header_(FLAC__StreamDecoder *decoder)
2160 {
2161         FLAC__uint32 x;
2162         FLAC__uint64 xx;
2163         unsigned i, blocksize_hint = 0, sample_rate_hint = 0;
2164         FLAC__byte crc8, raw_header[16]; /* MAGIC NUMBER based on the maximum frame header size, including CRC */
2165         unsigned raw_header_len;
2166         FLAC__bool is_unparseable = false;
2167
2168         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
2169
2170         /* init the raw header with the saved bits from synchronization */
2171         raw_header[0] = decoder->private_->header_warmup[0];
2172         raw_header[1] = decoder->private_->header_warmup[1];
2173         raw_header_len = 2;
2174
2175         /* check to make sure that reserved bit is 0 */
2176         if(raw_header[1] & 0x02) /* MAGIC NUMBER */
2177                 is_unparseable = true;
2178
2179         /*
2180          * Note that along the way as we read the header, we look for a sync
2181          * code inside.  If we find one it would indicate that our original
2182          * sync was bad since there cannot be a sync code in a valid header.
2183          *
2184          * Three kinds of things can go wrong when reading the frame header:
2185          *  1) We may have sync'ed incorrectly and not landed on a frame header.
2186          *     If we don't find a sync code, it can end up looking like we read
2187          *     a valid but unparseable header, until getting to the frame header
2188          *     CRC.  Even then we could get a false positive on the CRC.
2189          *  2) We may have sync'ed correctly but on an unparseable frame (from a
2190          *     future encoder).
2191          *  3) We may be on a damaged frame which appears valid but unparseable.
2192          *
2193          * For all these reasons, we try and read a complete frame header as
2194          * long as it seems valid, even if unparseable, up until the frame
2195          * header CRC.
2196          */
2197
2198         /*
2199          * read in the raw header as bytes so we can CRC it, and parse it on the way
2200          */
2201         for(i = 0; i < 2; i++) {
2202                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2203                         return false; /* read_callback_ sets the state for us */
2204                 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
2205                         /* if we get here it means our original sync was erroneous since the sync code cannot appear in the header */
2206                         decoder->private_->lookahead = (FLAC__byte)x;
2207                         decoder->private_->cached = true;
2208                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2209                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2210                         return true;
2211                 }
2212                 raw_header[raw_header_len++] = (FLAC__byte)x;
2213         }
2214
2215         switch(x = raw_header[2] >> 4) {
2216                 case 0:
2217                         is_unparseable = true;
2218                         break;
2219                 case 1:
2220                         decoder->private_->frame.header.blocksize = 192;
2221                         break;
2222                 case 2:
2223                 case 3:
2224                 case 4:
2225                 case 5:
2226                         decoder->private_->frame.header.blocksize = 576 << (x-2);
2227                         break;
2228                 case 6:
2229                 case 7:
2230                         blocksize_hint = x;
2231                         break;
2232                 case 8:
2233                 case 9:
2234                 case 10:
2235                 case 11:
2236                 case 12:
2237                 case 13:
2238                 case 14:
2239                 case 15:
2240                         decoder->private_->frame.header.blocksize = 256 << (x-8);
2241                         break;
2242                 default:
2243                         FLAC__ASSERT(0);
2244                         break;
2245         }
2246
2247         switch(x = raw_header[2] & 0x0f) {
2248                 case 0:
2249                         if(decoder->private_->has_stream_info)
2250                                 decoder->private_->frame.header.sample_rate = decoder->private_->stream_info.data.stream_info.sample_rate;
2251                         else
2252                                 is_unparseable = true;
2253                         break;
2254                 case 1:
2255                         decoder->private_->frame.header.sample_rate = 88200;
2256                         break;
2257                 case 2:
2258                         decoder->private_->frame.header.sample_rate = 176400;
2259                         break;
2260                 case 3:
2261                         decoder->private_->frame.header.sample_rate = 192000;
2262                         break;
2263                 case 4:
2264                         decoder->private_->frame.header.sample_rate = 8000;
2265                         break;
2266                 case 5:
2267                         decoder->private_->frame.header.sample_rate = 16000;
2268                         break;
2269                 case 6:
2270                         decoder->private_->frame.header.sample_rate = 22050;
2271                         break;
2272                 case 7:
2273                         decoder->private_->frame.header.sample_rate = 24000;
2274                         break;
2275                 case 8:
2276                         decoder->private_->frame.header.sample_rate = 32000;
2277                         break;
2278                 case 9:
2279                         decoder->private_->frame.header.sample_rate = 44100;
2280                         break;
2281                 case 10:
2282                         decoder->private_->frame.header.sample_rate = 48000;
2283                         break;
2284                 case 11:
2285                         decoder->private_->frame.header.sample_rate = 96000;
2286                         break;
2287                 case 12:
2288                 case 13:
2289                 case 14:
2290                         sample_rate_hint = x;
2291                         break;
2292                 case 15:
2293                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2294                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2295                         return true;
2296                 default:
2297                         FLAC__ASSERT(0);
2298         }
2299
2300         x = (unsigned)(raw_header[3] >> 4);
2301         if(x & 8) {
2302                 decoder->private_->frame.header.channels = 2;
2303                 switch(x & 7) {
2304                         case 0:
2305                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE;
2306                                 break;
2307                         case 1:
2308                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE;
2309                                 break;
2310                         case 2:
2311                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_MID_SIDE;
2312                                 break;
2313                         default:
2314                                 is_unparseable = true;
2315                                 break;
2316                 }
2317         }
2318         else {
2319                 decoder->private_->frame.header.channels = (unsigned)x + 1;
2320                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT;
2321         }
2322
2323         switch(x = (unsigned)(raw_header[3] & 0x0e) >> 1) {
2324                 case 0:
2325                         if(decoder->private_->has_stream_info)
2326                                 decoder->private_->frame.header.bits_per_sample = decoder->private_->stream_info.data.stream_info.bits_per_sample;
2327                         else
2328                                 is_unparseable = true;
2329                         break;
2330                 case 1:
2331                         decoder->private_->frame.header.bits_per_sample = 8;
2332                         break;
2333                 case 2:
2334                         decoder->private_->frame.header.bits_per_sample = 12;
2335                         break;
2336                 case 4:
2337                         decoder->private_->frame.header.bits_per_sample = 16;
2338                         break;
2339                 case 5:
2340                         decoder->private_->frame.header.bits_per_sample = 20;
2341                         break;
2342                 case 6:
2343                         decoder->private_->frame.header.bits_per_sample = 24;
2344                         break;
2345                 case 3:
2346                 case 7:
2347                         is_unparseable = true;
2348                         break;
2349                 default:
2350                         FLAC__ASSERT(0);
2351                         break;
2352         }
2353
2354         /* check to make sure that reserved bit is 0 */
2355         if(raw_header[3] & 0x01) /* MAGIC NUMBER */
2356                 is_unparseable = true;
2357
2358         /* read the frame's starting sample number (or frame number as the case may be) */
2359         if(
2360                 raw_header[1] & 0x01 ||
2361                 /*@@@ 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 */
2362                 (decoder->private_->has_stream_info && decoder->private_->stream_info.data.stream_info.min_blocksize != decoder->private_->stream_info.data.stream_info.max_blocksize)
2363         ) { /* variable blocksize */
2364                 if(!FLAC__bitreader_read_utf8_uint64(decoder->private_->input, &xx, raw_header, &raw_header_len))
2365                         return false; /* read_callback_ sets the state for us */
2366                 if(xx == FLAC__U64L(0xffffffffffffffff)) { /* i.e. non-UTF8 code... */
2367                         decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2368                         decoder->private_->cached = true;
2369                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2370                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2371                         return true;
2372                 }
2373                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2374                 decoder->private_->frame.header.number.sample_number = xx;
2375         }
2376         else { /* fixed blocksize */
2377                 if(!FLAC__bitreader_read_utf8_uint32(decoder->private_->input, &x, raw_header, &raw_header_len))
2378                         return false; /* read_callback_ sets the state for us */
2379                 if(x == 0xffffffff) { /* i.e. non-UTF8 code... */
2380                         decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2381                         decoder->private_->cached = true;
2382                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2383                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2384                         return true;
2385                 }
2386                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER;
2387                 decoder->private_->frame.header.number.frame_number = x;
2388         }
2389
2390         if(blocksize_hint) {
2391                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2392                         return false; /* read_callback_ sets the state for us */
2393                 raw_header[raw_header_len++] = (FLAC__byte)x;
2394                 if(blocksize_hint == 7) {
2395                         FLAC__uint32 _x;
2396                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2397                                 return false; /* read_callback_ sets the state for us */
2398                         raw_header[raw_header_len++] = (FLAC__byte)_x;
2399                         x = (x << 8) | _x;
2400                 }
2401                 decoder->private_->frame.header.blocksize = x+1;
2402         }
2403
2404         if(sample_rate_hint) {
2405                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2406                         return false; /* read_callback_ sets the state for us */
2407                 raw_header[raw_header_len++] = (FLAC__byte)x;
2408                 if(sample_rate_hint != 12) {
2409                         FLAC__uint32 _x;
2410                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2411                                 return false; /* read_callback_ sets the state for us */
2412                         raw_header[raw_header_len++] = (FLAC__byte)_x;
2413                         x = (x << 8) | _x;
2414                 }
2415                 if(sample_rate_hint == 12)
2416                         decoder->private_->frame.header.sample_rate = x*1000;
2417                 else if(sample_rate_hint == 13)
2418                         decoder->private_->frame.header.sample_rate = x;
2419                 else
2420                         decoder->private_->frame.header.sample_rate = x*10;
2421         }
2422
2423         /* read the CRC-8 byte */
2424         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2425                 return false; /* read_callback_ sets the state for us */
2426         crc8 = (FLAC__byte)x;
2427
2428         if(FLAC__crc8(raw_header, raw_header_len) != crc8) {
2429                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2430                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2431                 return true;
2432         }
2433
2434         /* calculate the sample number from the frame number if needed */
2435         decoder->private_->next_fixed_block_size = 0;
2436         if(decoder->private_->frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER) {
2437                 x = decoder->private_->frame.header.number.frame_number;
2438                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2439                 if(decoder->private_->fixed_block_size)
2440                         decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->fixed_block_size * (FLAC__uint64)x;
2441                 else if(decoder->private_->has_stream_info) {
2442                         if(decoder->private_->stream_info.data.stream_info.min_blocksize == decoder->private_->stream_info.data.stream_info.max_blocksize) {
2443                                 decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->stream_info.data.stream_info.min_blocksize * (FLAC__uint64)x;
2444                                 decoder->private_->next_fixed_block_size = decoder->private_->stream_info.data.stream_info.max_blocksize;
2445                         }
2446                         else
2447                                 is_unparseable = true;
2448                 }
2449                 else if(x == 0) {
2450                         decoder->private_->frame.header.number.sample_number = 0;
2451                         decoder->private_->next_fixed_block_size = decoder->private_->frame.header.blocksize;
2452                 }
2453                 else {
2454                         /* can only get here if the stream has invalid frame numbering and no STREAMINFO, so assume it's not the last (possibly short) frame */
2455                         decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->frame.header.blocksize * (FLAC__uint64)x;
2456                 }
2457         }
2458
2459         if(is_unparseable) {
2460                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2461                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2462                 return true;
2463         }
2464
2465         return true;
2466 }
2467
2468 FLAC__bool read_subframe_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2469 {
2470         FLAC__uint32 x;
2471         FLAC__bool wasted_bits;
2472         unsigned i;
2473
2474         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8)) /* MAGIC NUMBER */
2475                 return false; /* read_callback_ sets the state for us */
2476
2477         wasted_bits = (x & 1);
2478         x &= 0xfe;
2479
2480         if(wasted_bits) {
2481                 unsigned u;
2482                 if(!FLAC__bitreader_read_unary_unsigned(decoder->private_->input, &u))
2483                         return false; /* read_callback_ sets the state for us */
2484                 decoder->private_->frame.subframes[channel].wasted_bits = u+1;
2485                 bps -= decoder->private_->frame.subframes[channel].wasted_bits;
2486         }
2487         else
2488                 decoder->private_->frame.subframes[channel].wasted_bits = 0;
2489
2490         /*
2491          * Lots of magic numbers here
2492          */
2493         if(x & 0x80) {
2494                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2495                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2496                 return true;
2497         }
2498         else if(x == 0) {
2499                 if(!read_subframe_constant_(decoder, channel, bps, do_full_decode))
2500                         return false;
2501         }
2502         else if(x == 2) {
2503                 if(!read_subframe_verbatim_(decoder, channel, bps, do_full_decode))
2504                         return false;
2505         }
2506         else if(x < 16) {
2507                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2508                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2509                 return true;
2510         }
2511         else if(x <= 24) {
2512                 if(!read_subframe_fixed_(decoder, channel, bps, (x>>1)&7, do_full_decode))
2513                         return false;
2514                 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2515                         return true;
2516         }
2517         else if(x < 64) {
2518                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2519                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2520                 return true;
2521         }
2522         else {
2523                 if(!read_subframe_lpc_(decoder, channel, bps, ((x>>1)&31)+1, do_full_decode))
2524                         return false;
2525                 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2526                         return true;
2527         }
2528
2529         if(wasted_bits && do_full_decode) {
2530                 x = decoder->private_->frame.subframes[channel].wasted_bits;
2531                 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2532                         decoder->private_->output[channel][i] <<= x;
2533         }
2534
2535         return true;
2536 }
2537
2538 FLAC__bool read_subframe_constant_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2539 {
2540         FLAC__Subframe_Constant *subframe = &decoder->private_->frame.subframes[channel].data.constant;
2541         FLAC__int32 x;
2542         unsigned i;
2543         FLAC__int32 *output = decoder->private_->output[channel];
2544
2545         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_CONSTANT;
2546
2547         if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2548                 return false; /* read_callback_ sets the state for us */
2549
2550         subframe->value = x;
2551
2552         /* decode the subframe */
2553         if(do_full_decode) {
2554                 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2555                         output[i] = x;
2556         }
2557
2558         return true;
2559 }
2560
2561 FLAC__bool read_subframe_fixed_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode)
2562 {
2563         FLAC__Subframe_Fixed *subframe = &decoder->private_->frame.subframes[channel].data.fixed;
2564         FLAC__int32 i32;
2565         FLAC__uint32 u32;
2566         unsigned u;
2567
2568         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_FIXED;
2569
2570         subframe->residual = decoder->private_->residual[channel];
2571         subframe->order = order;
2572
2573         /* read warm-up samples */
2574         for(u = 0; u < order; u++) {
2575                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2576                         return false; /* read_callback_ sets the state for us */
2577                 subframe->warmup[u] = i32;
2578         }
2579
2580         /* read entropy coding method info */
2581         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2582                 return false; /* read_callback_ sets the state for us */
2583         subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2584         switch(subframe->entropy_coding_method.type) {
2585                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2586                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2587                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2588                                 return false; /* read_callback_ sets the state for us */
2589                         subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2590                         subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2591                         break;
2592                 default:
2593                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2594                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2595                         return true;
2596         }
2597
2598         /* read residual */
2599         switch(subframe->entropy_coding_method.type) {
2600                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2601                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2602                         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))
2603                                 return false;
2604                         break;
2605                 default:
2606                         FLAC__ASSERT(0);
2607         }
2608
2609         /* decode the subframe */
2610         if(do_full_decode) {
2611                 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2612                 FLAC__fixed_restore_signal(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, order, decoder->private_->output[channel]+order);
2613         }
2614
2615         return true;
2616 }
2617
2618 FLAC__bool read_subframe_lpc_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode)
2619 {
2620         FLAC__Subframe_LPC *subframe = &decoder->private_->frame.subframes[channel].data.lpc;
2621         FLAC__int32 i32;
2622         FLAC__uint32 u32;
2623         unsigned u;
2624
2625         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_LPC;
2626
2627         subframe->residual = decoder->private_->residual[channel];
2628         subframe->order = order;
2629
2630         /* read warm-up samples */
2631         for(u = 0; u < order; u++) {
2632                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2633                         return false; /* read_callback_ sets the state for us */
2634                 subframe->warmup[u] = i32;
2635         }
2636
2637         /* read qlp coeff precision */
2638         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
2639                 return false; /* read_callback_ sets the state for us */
2640         if(u32 == (1u << FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN) - 1) {
2641                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2642                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2643                 return true;
2644         }
2645         subframe->qlp_coeff_precision = u32+1;
2646
2647         /* read qlp shift */
2648         if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
2649                 return false; /* read_callback_ sets the state for us */
2650         subframe->quantization_level = i32;
2651
2652         /* read quantized lp coefficiencts */
2653         for(u = 0; u < order; u++) {
2654                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, subframe->qlp_coeff_precision))
2655                         return false; /* read_callback_ sets the state for us */
2656                 subframe->qlp_coeff[u] = i32;
2657         }
2658
2659         /* read entropy coding method info */
2660         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2661                 return false; /* read_callback_ sets the state for us */
2662         subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2663         switch(subframe->entropy_coding_method.type) {
2664                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2665                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2666                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2667                                 return false; /* read_callback_ sets the state for us */
2668                         subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2669                         subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2670                         break;
2671                 default:
2672                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2673                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2674                         return true;
2675         }
2676
2677         /* read residual */
2678         switch(subframe->entropy_coding_method.type) {
2679                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2680                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2681                         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))
2682                                 return false;
2683                         break;
2684                 default:
2685                         FLAC__ASSERT(0);
2686         }
2687
2688         /* decode the subframe */
2689         if(do_full_decode) {
2690                 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2691                 /*@@@@@@ technically not pessimistic enough, should be more like
2692                 if( (FLAC__uint64)order * ((((FLAC__uint64)1)<<bps)-1) * ((1<<subframe->qlp_coeff_precision)-1) < (((FLAC__uint64)-1) << 32) )
2693                 */
2694                 if(bps + subframe->qlp_coeff_precision + FLAC__bitmath_ilog2(order) <= 32)
2695                         if(bps <= 16 && subframe->qlp_coeff_precision <= 16)
2696                                 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);
2697                         else
2698                                 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);
2699                 else
2700                         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);
2701         }
2702
2703         return true;
2704 }
2705
2706 FLAC__bool read_subframe_verbatim_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2707 {
2708         FLAC__Subframe_Verbatim *subframe = &decoder->private_->frame.subframes[channel].data.verbatim;
2709         FLAC__int32 x, *residual = decoder->private_->residual[channel];
2710         unsigned i;
2711
2712         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_VERBATIM;
2713
2714         subframe->data = residual;
2715
2716         for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2717                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2718                         return false; /* read_callback_ sets the state for us */
2719                 residual[i] = x;
2720         }
2721
2722         /* decode the subframe */
2723         if(do_full_decode)
2724                 memcpy(decoder->private_->output[channel], subframe->data, sizeof(FLAC__int32) * decoder->private_->frame.header.blocksize);
2725
2726         return true;
2727 }
2728
2729 FLAC__bool read_residual_partitioned_rice_(FLAC__StreamDecoder *decoder, unsigned predictor_order, unsigned partition_order, FLAC__EntropyCodingMethod_PartitionedRiceContents *partitioned_rice_contents, FLAC__int32 *residual, FLAC__bool is_extended)
2730 {
2731         FLAC__uint32 rice_parameter;
2732         int i;
2733         unsigned partition, sample, u;
2734         const unsigned partitions = 1u << partition_order;
2735         const unsigned partition_samples = partition_order > 0? decoder->private_->frame.header.blocksize >> partition_order : decoder->private_->frame.header.blocksize - predictor_order;
2736         const unsigned plen = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_PARAMETER_LEN : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN;
2737         const unsigned pesc = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_ESCAPE_PARAMETER : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
2738
2739         /* sanity checks */
2740         if(partition_order == 0) {
2741                 if(decoder->private_->frame.header.blocksize < predictor_order) {
2742                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2743                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2744                         /* We have received a potentially malicious bit stream. All we can do is error out to avoid a heap overflow. */
2745                         return false;
2746                 }
2747         }
2748         else {
2749                 if(partition_samples < predictor_order) {
2750                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2751                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2752                         /* We have received a potentially malicious bit stream. All we can do is error out to avoid a heap overflow. */
2753                         return false;
2754                 }
2755         }
2756
2757         if(!FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(partitioned_rice_contents, flac_max(6u, partition_order))) {
2758                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
2759                 return false;
2760         }
2761
2762         sample = 0;
2763         for(partition = 0; partition < partitions; partition++) {
2764                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, plen))
2765                         return false; /* read_callback_ sets the state for us */
2766                 partitioned_rice_contents->parameters[partition] = rice_parameter;
2767                 if(rice_parameter < pesc) {
2768                         partitioned_rice_contents->raw_bits[partition] = 0;
2769                         u = (partition_order == 0 || partition > 0)? partition_samples : partition_samples - predictor_order;
2770                         if(!FLAC__bitreader_read_rice_signed_block(decoder->private_->input, residual + sample, u, rice_parameter))
2771                                 return false; /* read_callback_ sets the state for us */
2772                         sample += u;
2773                 }
2774                 else {
2775                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
2776                                 return false; /* read_callback_ sets the state for us */
2777                         partitioned_rice_contents->raw_bits[partition] = rice_parameter;
2778                         for(u = (partition_order == 0 || partition > 0)? 0 : predictor_order; u < partition_samples; u++, sample++) {
2779                                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i, rice_parameter))
2780                                         return false; /* read_callback_ sets the state for us */
2781                                 residual[sample] = i;
2782                         }
2783                 }
2784         }
2785
2786         return true;
2787 }
2788
2789 FLAC__bool read_zero_padding_(FLAC__StreamDecoder *decoder)
2790 {
2791         if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input)) {
2792                 FLAC__uint32 zero = 0;
2793                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &zero, FLAC__bitreader_bits_left_for_byte_alignment(decoder->private_->input)))
2794                         return false; /* read_callback_ sets the state for us */
2795                 if(zero != 0) {
2796                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2797                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2798                 }
2799         }
2800         return true;
2801 }
2802
2803 FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data)
2804 {
2805         FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder *)client_data;
2806
2807         if(
2808 #if FLAC__HAS_OGG
2809                 /* see [1] HACK NOTE below for why we don't call the eof_callback when decoding Ogg FLAC */
2810                 !decoder->private_->is_ogg &&
2811 #endif
2812                 decoder->private_->eof_callback && decoder->private_->eof_callback(decoder, decoder->private_->client_data)
2813         ) {
2814                 *bytes = 0;
2815                 decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2816                 return false;
2817         }
2818         else if(*bytes > 0) {
2819                 /* While seeking, it is possible for our seek to land in the
2820                  * middle of audio data that looks exactly like a frame header
2821                  * from a future version of an encoder.  When that happens, our
2822                  * error callback will get an
2823                  * FLAC__STREAM_DECODER_UNPARSEABLE_STREAM and increment its
2824                  * unparseable_frame_count.  But there is a remote possibility
2825                  * that it is properly synced at such a "future-codec frame",
2826                  * so to make sure, we wait to see many "unparseable" errors in
2827                  * a row before bailing out.
2828                  */
2829                 if(decoder->private_->is_seeking && decoder->private_->unparseable_frame_count > 20) {
2830                         decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2831                         return false;
2832                 }
2833                 else {
2834                         const FLAC__StreamDecoderReadStatus status =
2835 #if FLAC__HAS_OGG
2836                                 decoder->private_->is_ogg?
2837                                 read_callback_ogg_aspect_(decoder, buffer, bytes) :
2838 #endif
2839                                 decoder->private_->read_callback(decoder, buffer, bytes, decoder->private_->client_data)
2840                         ;
2841                         if(status == FLAC__STREAM_DECODER_READ_STATUS_ABORT) {
2842                                 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2843                                 return false;
2844                         }
2845                         else if(*bytes == 0) {
2846                                 if(
2847                                         status == FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM ||
2848                                         (
2849 #if FLAC__HAS_OGG
2850                                                 /* see [1] HACK NOTE below for why we don't call the eof_callback when decoding Ogg FLAC */
2851                                                 !decoder->private_->is_ogg &&
2852 #endif
2853                                                 decoder->private_->eof_callback && decoder->private_->eof_callback(decoder, decoder->private_->client_data)
2854                                         )
2855                                 ) {
2856                                         decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2857                                         return false;
2858                                 }
2859                                 else
2860                                         return true;
2861                         }
2862                         else
2863                                 return true;
2864                 }
2865         }
2866         else {
2867                 /* abort to avoid a deadlock */
2868                 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2869                 return false;
2870         }
2871         /* [1] @@@ HACK NOTE: The end-of-stream checking has to be hacked around
2872          * for Ogg FLAC.  This is because the ogg decoder aspect can lose sync
2873          * and at the same time hit the end of the stream (for example, seeking
2874          * to a point that is after the beginning of the last Ogg page).  There
2875          * is no way to report an Ogg sync loss through the callbacks (see note
2876          * in read_callback_ogg_aspect_()) so it returns CONTINUE with *bytes==0.
2877          * So to keep the decoder from stopping at this point we gate the call
2878          * to the eof_callback and let the Ogg decoder aspect set the
2879          * end-of-stream state when it is needed.
2880          */
2881 }
2882
2883 #if FLAC__HAS_OGG
2884 FLAC__StreamDecoderReadStatus read_callback_ogg_aspect_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes)
2885 {
2886         switch(FLAC__ogg_decoder_aspect_read_callback_wrapper(&decoder->protected_->ogg_decoder_aspect, buffer, bytes, read_callback_proxy_, decoder, decoder->private_->client_data)) {
2887                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK:
2888                         return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2889                 /* we don't really have a way to handle lost sync via read
2890                  * callback so we'll let it pass and let the underlying
2891                  * FLAC decoder catch the error
2892                  */
2893                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_LOST_SYNC:
2894                         return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2895                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM:
2896                         return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
2897                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_NOT_FLAC:
2898                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_UNSUPPORTED_MAPPING_VERSION:
2899                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT:
2900                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ERROR:
2901                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_MEMORY_ALLOCATION_ERROR:
2902                         return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2903                 default:
2904                         FLAC__ASSERT(0);
2905                         /* double protection */
2906                         return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2907         }
2908 }
2909
2910 FLAC__OggDecoderAspectReadStatus read_callback_proxy_(const void *void_decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
2911 {
2912         FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder*)void_decoder;
2913
2914         switch(decoder->private_->read_callback(decoder, buffer, bytes, client_data)) {
2915                 case FLAC__STREAM_DECODER_READ_STATUS_CONTINUE:
2916                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK;
2917                 case FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM:
2918                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM;
2919                 case FLAC__STREAM_DECODER_READ_STATUS_ABORT:
2920                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2921                 default:
2922                         /* double protection: */
2923                         FLAC__ASSERT(0);
2924                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2925         }
2926 }
2927 #endif
2928
2929 FLAC__StreamDecoderWriteStatus write_audio_frame_to_client_(FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[])
2930 {
2931         if(decoder->private_->is_seeking) {
2932                 FLAC__uint64 this_frame_sample = frame->header.number.sample_number;
2933                 FLAC__uint64 next_frame_sample = this_frame_sample + (FLAC__uint64)frame->header.blocksize;
2934                 FLAC__uint64 target_sample = decoder->private_->target_sample;
2935
2936                 FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
2937
2938 #if FLAC__HAS_OGG
2939                 decoder->private_->got_a_frame = true;
2940 #endif
2941                 decoder->private_->last_frame = *frame; /* save the frame */
2942                 if(this_frame_sample <= target_sample && target_sample < next_frame_sample) { /* we hit our target frame */
2943                         unsigned delta = (unsigned)(target_sample - this_frame_sample);
2944                         /* kick out of seek mode */
2945                         decoder->private_->is_seeking = false;
2946                         /* shift out the samples before target_sample */
2947                         if(delta > 0) {
2948                                 unsigned channel;
2949                                 const FLAC__int32 *newbuffer[FLAC__MAX_CHANNELS];
2950                                 for(channel = 0; channel < frame->header.channels; channel++)
2951                                         newbuffer[channel] = buffer[channel] + delta;
2952                                 decoder->private_->last_frame.header.blocksize -= delta;
2953                                 decoder->private_->last_frame.header.number.sample_number += (FLAC__uint64)delta;
2954                                 /* write the relevant samples */
2955                                 return decoder->private_->write_callback(decoder, &decoder->private_->last_frame, newbuffer, decoder->private_->client_data);
2956                         }
2957                         else {
2958                                 /* write the relevant samples */
2959                                 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2960                         }
2961                 }
2962                 else {
2963                         return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
2964                 }
2965         }
2966         else {
2967                 /*
2968                  * If we never got STREAMINFO, turn off MD5 checking to save
2969                  * cycles since we don't have a sum to compare to anyway
2970                  */
2971                 if(!decoder->private_->has_stream_info)
2972                         decoder->private_->do_md5_checking = false;
2973                 if(decoder->private_->do_md5_checking) {
2974                         if(!FLAC__MD5Accumulate(&decoder->private_->md5context, buffer, frame->header.channels, frame->header.blocksize, (frame->header.bits_per_sample+7) / 8))
2975                                 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
2976                 }
2977                 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2978         }
2979 }
2980
2981 void send_error_to_client_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status)
2982 {
2983         if(!decoder->private_->is_seeking)
2984                 decoder->private_->error_callback(decoder, status, decoder->private_->client_data);
2985         else if(status == FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM)
2986                 decoder->private_->unparseable_frame_count++;
2987 }
2988
2989 FLAC__bool seek_to_absolute_sample_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
2990 {
2991         FLAC__uint64 first_frame_offset = decoder->private_->first_frame_offset, lower_bound, upper_bound, lower_bound_sample, upper_bound_sample, this_frame_sample;
2992         FLAC__int64 pos = -1;
2993         int i;
2994         unsigned approx_bytes_per_frame;
2995         FLAC__bool first_seek = true;
2996         const FLAC__uint64 total_samples = FLAC__stream_decoder_get_total_samples(decoder);
2997         const unsigned min_blocksize = decoder->private_->stream_info.data.stream_info.min_blocksize;
2998         const unsigned max_blocksize = decoder->private_->stream_info.data.stream_info.max_blocksize;
2999         const unsigned max_framesize = decoder->private_->stream_info.data.stream_info.max_framesize;
3000         const unsigned min_framesize = decoder->private_->stream_info.data.stream_info.min_framesize;
3001         /* take these from the current frame in case they've changed mid-stream */
3002         unsigned channels = FLAC__stream_decoder_get_channels(decoder);
3003         unsigned bps = FLAC__stream_decoder_get_bits_per_sample(decoder);
3004         const FLAC__StreamMetadata_SeekTable *seek_table = decoder->private_->has_seek_table? &decoder->private_->seek_table.data.seek_table : 0;
3005
3006         /* use values from stream info if we didn't decode a frame */
3007         if(channels == 0)
3008                 channels = decoder->private_->stream_info.data.stream_info.channels;
3009         if(bps == 0)
3010                 bps = decoder->private_->stream_info.data.stream_info.bits_per_sample;
3011
3012         /* we are just guessing here */
3013         if(max_framesize > 0)
3014                 approx_bytes_per_frame = (max_framesize + min_framesize) / 2 + 1;
3015         /*
3016          * Check if it's a known fixed-blocksize stream.  Note that though
3017          * the spec doesn't allow zeroes in the STREAMINFO block, we may
3018          * never get a STREAMINFO block when decoding so the value of
3019          * min_blocksize might be zero.
3020          */
3021         else if(min_blocksize == max_blocksize && min_blocksize > 0) {
3022                 /* note there are no () around 'bps/8' to keep precision up since it's an integer calulation */
3023                 approx_bytes_per_frame = min_blocksize * channels * bps/8 + 64;
3024         }
3025         else
3026                 approx_bytes_per_frame = 4096 * channels * bps/8 + 64;
3027
3028         /*
3029          * First, we set an upper and lower bound on where in the
3030          * stream we will search.  For now we assume the worst case
3031          * scenario, which is our best guess at the beginning of
3032          * the first frame and end of the stream.
3033          */
3034         lower_bound = first_frame_offset;
3035         lower_bound_sample = 0;
3036         upper_bound = stream_length;
3037         upper_bound_sample = total_samples > 0 ? total_samples : target_sample /*estimate it*/;
3038
3039         /*
3040          * Now we refine the bounds if we have a seektable with
3041          * suitable points.  Note that according to the spec they
3042          * must be ordered by ascending sample number.
3043          *
3044          * Note: to protect against invalid seek tables we will ignore points
3045          * that have frame_samples==0 or sample_number>=total_samples
3046          */
3047         if(seek_table) {
3048                 FLAC__uint64 new_lower_bound = lower_bound;
3049                 FLAC__uint64 new_upper_bound = upper_bound;
3050                 FLAC__uint64 new_lower_bound_sample = lower_bound_sample;
3051                 FLAC__uint64 new_upper_bound_sample = upper_bound_sample;
3052
3053                 /* find the closest seek point <= target_sample, if it exists */
3054                 for(i = (int)seek_table->num_points - 1; i >= 0; i--) {
3055                         if(
3056                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3057                                 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3058                                 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */
3059                                 seek_table->points[i].sample_number <= target_sample
3060                         )
3061                                 break;
3062                 }
3063                 if(i >= 0) { /* i.e. we found a suitable seek point... */
3064                         new_lower_bound = first_frame_offset + seek_table->points[i].stream_offset;
3065                         new_lower_bound_sample = seek_table->points[i].sample_number;
3066                 }
3067
3068                 /* find the closest seek point > target_sample, if it exists */
3069                 for(i = 0; i < (int)seek_table->num_points; i++) {
3070                         if(
3071                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3072                                 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3073                                 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */