lpc_intrin_sse41.c : Optimize decoding 24 bit files on 32 bit platforms.
[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-2013  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 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);
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                 if(x == ID3V2_TAG_[id]) {
1365                         id++;
1366                         i = 0;
1367                         if(id == 3) {
1368                                 if(!skip_id3v2_tag_(decoder))
1369                                         return false; /* skip_id3v2_tag_ sets the state for us */
1370                         }
1371                         continue;
1372                 }
1373                 id = 0;
1374                 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1375                         decoder->private_->header_warmup[0] = (FLAC__byte)x;
1376                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1377                                 return false; /* read_callback_ sets the state for us */
1378
1379                         /* 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 */
1380                         /* else we have to check if the second byte is the end of a sync code */
1381                         if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1382                                 decoder->private_->lookahead = (FLAC__byte)x;
1383                                 decoder->private_->cached = true;
1384                         }
1385                         else if(x >> 1 == 0x7c) { /* MAGIC NUMBER for the last 6 sync bits and reserved 7th bit */
1386                                 decoder->private_->header_warmup[1] = (FLAC__byte)x;
1387                                 decoder->protected_->state = FLAC__STREAM_DECODER_READ_FRAME;
1388                                 return true;
1389                         }
1390                 }
1391                 i = 0;
1392                 if(first) {
1393                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
1394                         first = false;
1395                 }
1396         }
1397
1398         decoder->protected_->state = FLAC__STREAM_DECODER_READ_METADATA;
1399         return true;
1400 }
1401
1402 FLAC__bool read_metadata_(FLAC__StreamDecoder *decoder)
1403 {
1404         FLAC__bool is_last;
1405         FLAC__uint32 i, x, type, length;
1406
1407         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1408
1409         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_IS_LAST_LEN))
1410                 return false; /* read_callback_ sets the state for us */
1411         is_last = x? true : false;
1412
1413         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &type, FLAC__STREAM_METADATA_TYPE_LEN))
1414                 return false; /* read_callback_ sets the state for us */
1415
1416         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &length, FLAC__STREAM_METADATA_LENGTH_LEN))
1417                 return false; /* read_callback_ sets the state for us */
1418
1419         if(type == FLAC__METADATA_TYPE_STREAMINFO) {
1420                 if(!read_metadata_streaminfo_(decoder, is_last, length))
1421                         return false;
1422
1423                 decoder->private_->has_stream_info = true;
1424                 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))
1425                         decoder->private_->do_md5_checking = false;
1426                 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_STREAMINFO] && decoder->private_->metadata_callback)
1427                         decoder->private_->metadata_callback(decoder, &decoder->private_->stream_info, decoder->private_->client_data);
1428         }
1429         else if(type == FLAC__METADATA_TYPE_SEEKTABLE) {
1430                 if(!read_metadata_seektable_(decoder, is_last, length))
1431                         return false;
1432
1433                 decoder->private_->has_seek_table = true;
1434                 if(!decoder->private_->is_seeking && decoder->private_->metadata_filter[FLAC__METADATA_TYPE_SEEKTABLE] && decoder->private_->metadata_callback)
1435                         decoder->private_->metadata_callback(decoder, &decoder->private_->seek_table, decoder->private_->client_data);
1436         }
1437         else {
1438                 FLAC__bool skip_it = !decoder->private_->metadata_filter[type];
1439                 unsigned real_length = length;
1440                 FLAC__StreamMetadata block;
1441
1442                 memset(&block, 0, sizeof(block));
1443                 block.is_last = is_last;
1444                 block.type = (FLAC__MetadataType)type;
1445                 block.length = length;
1446
1447                 if(type == FLAC__METADATA_TYPE_APPLICATION) {
1448                         if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.id, FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8))
1449                                 return false; /* read_callback_ sets the state for us */
1450
1451                         if(real_length < FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8) { /* underflow check */
1452                                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;/*@@@@@@ maybe wrong error? need to resync?*/
1453                                 return false;
1454                         }
1455
1456                         real_length -= FLAC__STREAM_METADATA_APPLICATION_ID_LEN/8;
1457
1458                         if(decoder->private_->metadata_filter_ids_count > 0 && has_id_filtered_(decoder, block.data.application.id))
1459                                 skip_it = !skip_it;
1460                 }
1461
1462                 if(skip_it) {
1463                         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1464                                 return false; /* read_callback_ sets the state for us */
1465                 }
1466                 else {
1467                         FLAC__bool ok = true;
1468                         switch(type) {
1469                                 case FLAC__METADATA_TYPE_PADDING:
1470                                         /* skip the padding bytes */
1471                                         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, real_length))
1472                                                 ok = false; /* read_callback_ sets the state for us */
1473                                         break;
1474                                 case FLAC__METADATA_TYPE_APPLICATION:
1475                                         /* remember, we read the ID already */
1476                                         if(real_length > 0) {
1477                                                 if(0 == (block.data.application.data = malloc(real_length))) {
1478                                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1479                                                         ok = false;
1480                                                 }
1481                                                 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.application.data, real_length))
1482                                                         ok = false; /* read_callback_ sets the state for us */
1483                                         }
1484                                         else
1485                                                 block.data.application.data = 0;
1486                                         break;
1487                                 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1488                                         if(!read_metadata_vorbiscomment_(decoder, &block.data.vorbis_comment))
1489                                                 ok = false;
1490                                         break;
1491                                 case FLAC__METADATA_TYPE_CUESHEET:
1492                                         if(!read_metadata_cuesheet_(decoder, &block.data.cue_sheet))
1493                                                 ok = false;
1494                                         break;
1495                                 case FLAC__METADATA_TYPE_PICTURE:
1496                                         if(!read_metadata_picture_(decoder, &block.data.picture))
1497                                                 ok = false;
1498                                         break;
1499                                 case FLAC__METADATA_TYPE_STREAMINFO:
1500                                 case FLAC__METADATA_TYPE_SEEKTABLE:
1501                                         FLAC__ASSERT(0);
1502                                         break;
1503                                 default:
1504                                         if(real_length > 0) {
1505                                                 if(0 == (block.data.unknown.data = malloc(real_length))) {
1506                                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1507                                                         ok = false;
1508                                                 }
1509                                                 else if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, block.data.unknown.data, real_length))
1510                                                         ok = false; /* read_callback_ sets the state for us */
1511                                         }
1512                                         else
1513                                                 block.data.unknown.data = 0;
1514                                         break;
1515                         }
1516                         if(ok && !decoder->private_->is_seeking && decoder->private_->metadata_callback)
1517                                 decoder->private_->metadata_callback(decoder, &block, decoder->private_->client_data);
1518
1519                         /* now we have to free any malloc()ed data in the block */
1520                         switch(type) {
1521                                 case FLAC__METADATA_TYPE_PADDING:
1522                                         break;
1523                                 case FLAC__METADATA_TYPE_APPLICATION:
1524                                         if(0 != block.data.application.data)
1525                                                 free(block.data.application.data);
1526                                         break;
1527                                 case FLAC__METADATA_TYPE_VORBIS_COMMENT:
1528                                         if(0 != block.data.vorbis_comment.vendor_string.entry)
1529                                                 free(block.data.vorbis_comment.vendor_string.entry);
1530                                         if(block.data.vorbis_comment.num_comments > 0)
1531                                                 for(i = 0; i < block.data.vorbis_comment.num_comments; i++)
1532                                                         if(0 != block.data.vorbis_comment.comments[i].entry)
1533                                                                 free(block.data.vorbis_comment.comments[i].entry);
1534                                         if(0 != block.data.vorbis_comment.comments)
1535                                                 free(block.data.vorbis_comment.comments);
1536                                         break;
1537                                 case FLAC__METADATA_TYPE_CUESHEET:
1538                                         if(block.data.cue_sheet.num_tracks > 0)
1539                                                 for(i = 0; i < block.data.cue_sheet.num_tracks; i++)
1540                                                         if(0 != block.data.cue_sheet.tracks[i].indices)
1541                                                                 free(block.data.cue_sheet.tracks[i].indices);
1542                                         if(0 != block.data.cue_sheet.tracks)
1543                                                 free(block.data.cue_sheet.tracks);
1544                                         break;
1545                                 case FLAC__METADATA_TYPE_PICTURE:
1546                                         if(0 != block.data.picture.mime_type)
1547                                                 free(block.data.picture.mime_type);
1548                                         if(0 != block.data.picture.description)
1549                                                 free(block.data.picture.description);
1550                                         if(0 != block.data.picture.data)
1551                                                 free(block.data.picture.data);
1552                                         break;
1553                                 case FLAC__METADATA_TYPE_STREAMINFO:
1554                                 case FLAC__METADATA_TYPE_SEEKTABLE:
1555                                         FLAC__ASSERT(0);
1556                                 default:
1557                                         if(0 != block.data.unknown.data)
1558                                                 free(block.data.unknown.data);
1559                                         break;
1560                         }
1561
1562                         if(!ok) /* anything that unsets "ok" should also make sure decoder->protected_->state is updated */
1563                                 return false;
1564                 }
1565         }
1566
1567         if(is_last) {
1568                 /* if this fails, it's OK, it's just a hint for the seek routine */
1569                 if(!FLAC__stream_decoder_get_decode_position(decoder, &decoder->private_->first_frame_offset))
1570                         decoder->private_->first_frame_offset = 0;
1571                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
1572         }
1573
1574         return true;
1575 }
1576
1577 FLAC__bool read_metadata_streaminfo_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length)
1578 {
1579         FLAC__uint32 x;
1580         unsigned bits, used_bits = 0;
1581
1582         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1583
1584         decoder->private_->stream_info.type = FLAC__METADATA_TYPE_STREAMINFO;
1585         decoder->private_->stream_info.is_last = is_last;
1586         decoder->private_->stream_info.length = length;
1587
1588         bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_BLOCK_SIZE_LEN;
1589         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, bits))
1590                 return false; /* read_callback_ sets the state for us */
1591         decoder->private_->stream_info.data.stream_info.min_blocksize = x;
1592         used_bits += bits;
1593
1594         bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN;
1595         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_BLOCK_SIZE_LEN))
1596                 return false; /* read_callback_ sets the state for us */
1597         decoder->private_->stream_info.data.stream_info.max_blocksize = x;
1598         used_bits += bits;
1599
1600         bits = FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN;
1601         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN))
1602                 return false; /* read_callback_ sets the state for us */
1603         decoder->private_->stream_info.data.stream_info.min_framesize = x;
1604         used_bits += bits;
1605
1606         bits = FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN;
1607         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN))
1608                 return false; /* read_callback_ sets the state for us */
1609         decoder->private_->stream_info.data.stream_info.max_framesize = x;
1610         used_bits += bits;
1611
1612         bits = FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN;
1613         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_SAMPLE_RATE_LEN))
1614                 return false; /* read_callback_ sets the state for us */
1615         decoder->private_->stream_info.data.stream_info.sample_rate = x;
1616         used_bits += bits;
1617
1618         bits = FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN;
1619         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_CHANNELS_LEN))
1620                 return false; /* read_callback_ sets the state for us */
1621         decoder->private_->stream_info.data.stream_info.channels = x+1;
1622         used_bits += bits;
1623
1624         bits = FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN;
1625         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_STREAMINFO_BITS_PER_SAMPLE_LEN))
1626                 return false; /* read_callback_ sets the state for us */
1627         decoder->private_->stream_info.data.stream_info.bits_per_sample = x+1;
1628         used_bits += bits;
1629
1630         bits = FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN;
1631         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))
1632                 return false; /* read_callback_ sets the state for us */
1633         used_bits += bits;
1634
1635         if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, decoder->private_->stream_info.data.stream_info.md5sum, 16))
1636                 return false; /* read_callback_ sets the state for us */
1637         used_bits += 16*8;
1638
1639         /* skip the rest of the block */
1640         FLAC__ASSERT(used_bits % 8 == 0);
1641         length -= (used_bits / 8);
1642         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1643                 return false; /* read_callback_ sets the state for us */
1644
1645         return true;
1646 }
1647
1648 FLAC__bool read_metadata_seektable_(FLAC__StreamDecoder *decoder, FLAC__bool is_last, unsigned length)
1649 {
1650         FLAC__uint32 i, x;
1651         FLAC__uint64 xx;
1652
1653         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1654
1655         decoder->private_->seek_table.type = FLAC__METADATA_TYPE_SEEKTABLE;
1656         decoder->private_->seek_table.is_last = is_last;
1657         decoder->private_->seek_table.length = length;
1658
1659         decoder->private_->seek_table.data.seek_table.num_points = length / FLAC__STREAM_METADATA_SEEKPOINT_LENGTH;
1660
1661         /* use realloc since we may pass through here several times (e.g. after seeking) */
1662         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)))) {
1663                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1664                 return false;
1665         }
1666         for(i = 0; i < decoder->private_->seek_table.data.seek_table.num_points; i++) {
1667                 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_SAMPLE_NUMBER_LEN))
1668                         return false; /* read_callback_ sets the state for us */
1669                 decoder->private_->seek_table.data.seek_table.points[i].sample_number = xx;
1670
1671                 if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &xx, FLAC__STREAM_METADATA_SEEKPOINT_STREAM_OFFSET_LEN))
1672                         return false; /* read_callback_ sets the state for us */
1673                 decoder->private_->seek_table.data.seek_table.points[i].stream_offset = xx;
1674
1675                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_SEEKPOINT_FRAME_SAMPLES_LEN))
1676                         return false; /* read_callback_ sets the state for us */
1677                 decoder->private_->seek_table.data.seek_table.points[i].frame_samples = x;
1678         }
1679         length -= (decoder->private_->seek_table.data.seek_table.num_points * FLAC__STREAM_METADATA_SEEKPOINT_LENGTH);
1680         /* if there is a partial point left, skip over it */
1681         if(length > 0) {
1682                 /*@@@ do a send_error_to_client_() here?  there's an argument for either way */
1683                 if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, length))
1684                         return false; /* read_callback_ sets the state for us */
1685         }
1686
1687         return true;
1688 }
1689
1690 FLAC__bool read_metadata_vorbiscomment_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_VorbisComment *obj)
1691 {
1692         FLAC__uint32 i;
1693
1694         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1695
1696         /* read vendor string */
1697         FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1698         if(!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->vendor_string.length))
1699                 return false; /* read_callback_ sets the state for us */
1700         if(obj->vendor_string.length > 0) {
1701                 if(0 == (obj->vendor_string.entry = safe_malloc_add_2op_(obj->vendor_string.length, /*+*/1))) {
1702                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1703                         return false;
1704                 }
1705                 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->vendor_string.entry, obj->vendor_string.length))
1706                         return false; /* read_callback_ sets the state for us */
1707                 obj->vendor_string.entry[obj->vendor_string.length] = '\0';
1708         }
1709         else
1710                 obj->vendor_string.entry = 0;
1711
1712         /* read num comments */
1713         FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_NUM_COMMENTS_LEN == 32);
1714         if(!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->num_comments))
1715                 return false; /* read_callback_ sets the state for us */
1716
1717         /* read comments */
1718         if(obj->num_comments > 0) {
1719                 if(0 == (obj->comments = safe_malloc_mul_2op_p(obj->num_comments, /*times*/sizeof(FLAC__StreamMetadata_VorbisComment_Entry)))) {
1720                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1721                         return false;
1722                 }
1723                 for(i = 0; i < obj->num_comments; i++) {
1724                         FLAC__ASSERT(FLAC__STREAM_METADATA_VORBIS_COMMENT_ENTRY_LENGTH_LEN == 32);
1725                         if(!FLAC__bitreader_read_uint32_little_endian(decoder->private_->input, &obj->comments[i].length))
1726                                 return false; /* read_callback_ sets the state for us */
1727                         if(obj->comments[i].length > 0) {
1728                                 if(0 == (obj->comments[i].entry = safe_malloc_add_2op_(obj->comments[i].length, /*+*/1))) {
1729                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1730                                         return false;
1731                                 }
1732                                 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->comments[i].entry, obj->comments[i].length))
1733                                         return false; /* read_callback_ sets the state for us */
1734                                 obj->comments[i].entry[obj->comments[i].length] = '\0';
1735                         }
1736                         else
1737                                 obj->comments[i].entry = 0;
1738                 }
1739         }
1740         else {
1741                 obj->comments = 0;
1742         }
1743
1744         return true;
1745 }
1746
1747 FLAC__bool read_metadata_cuesheet_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_CueSheet *obj)
1748 {
1749         FLAC__uint32 i, j, x;
1750
1751         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1752
1753         memset(obj, 0, sizeof(FLAC__StreamMetadata_CueSheet));
1754
1755         FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_MEDIA_CATALOG_NUMBER_LEN % 8 == 0);
1756         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))
1757                 return false; /* read_callback_ sets the state for us */
1758
1759         if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &obj->lead_in, FLAC__STREAM_METADATA_CUESHEET_LEAD_IN_LEN))
1760                 return false; /* read_callback_ sets the state for us */
1761
1762         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_IS_CD_LEN))
1763                 return false; /* read_callback_ sets the state for us */
1764         obj->is_cd = x? true : false;
1765
1766         if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_RESERVED_LEN))
1767                 return false; /* read_callback_ sets the state for us */
1768
1769         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_NUM_TRACKS_LEN))
1770                 return false; /* read_callback_ sets the state for us */
1771         obj->num_tracks = x;
1772
1773         if(obj->num_tracks > 0) {
1774                 if(0 == (obj->tracks = safe_calloc_(obj->num_tracks, sizeof(FLAC__StreamMetadata_CueSheet_Track)))) {
1775                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1776                         return false;
1777                 }
1778                 for(i = 0; i < obj->num_tracks; i++) {
1779                         FLAC__StreamMetadata_CueSheet_Track *track = &obj->tracks[i];
1780                         if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &track->offset, FLAC__STREAM_METADATA_CUESHEET_TRACK_OFFSET_LEN))
1781                                 return false; /* read_callback_ sets the state for us */
1782
1783                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_NUMBER_LEN))
1784                                 return false; /* read_callback_ sets the state for us */
1785                         track->number = (FLAC__byte)x;
1786
1787                         FLAC__ASSERT(FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN % 8 == 0);
1788                         if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, (FLAC__byte*)track->isrc, FLAC__STREAM_METADATA_CUESHEET_TRACK_ISRC_LEN/8))
1789                                 return false; /* read_callback_ sets the state for us */
1790
1791                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_TYPE_LEN))
1792                                 return false; /* read_callback_ sets the state for us */
1793                         track->type = x;
1794
1795                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_PRE_EMPHASIS_LEN))
1796                                 return false; /* read_callback_ sets the state for us */
1797                         track->pre_emphasis = x;
1798
1799                         if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_TRACK_RESERVED_LEN))
1800                                 return false; /* read_callback_ sets the state for us */
1801
1802                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_TRACK_NUM_INDICES_LEN))
1803                                 return false; /* read_callback_ sets the state for us */
1804                         track->num_indices = (FLAC__byte)x;
1805
1806                         if(track->num_indices > 0) {
1807                                 if(0 == (track->indices = safe_calloc_(track->num_indices, sizeof(FLAC__StreamMetadata_CueSheet_Index)))) {
1808                                         decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1809                                         return false;
1810                                 }
1811                                 for(j = 0; j < track->num_indices; j++) {
1812                                         FLAC__StreamMetadata_CueSheet_Index *indx = &track->indices[j];
1813                                         if(!FLAC__bitreader_read_raw_uint64(decoder->private_->input, &indx->offset, FLAC__STREAM_METADATA_CUESHEET_INDEX_OFFSET_LEN))
1814                                                 return false; /* read_callback_ sets the state for us */
1815
1816                                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_CUESHEET_INDEX_NUMBER_LEN))
1817                                                 return false; /* read_callback_ sets the state for us */
1818                                         indx->number = (FLAC__byte)x;
1819
1820                                         if(!FLAC__bitreader_skip_bits_no_crc(decoder->private_->input, FLAC__STREAM_METADATA_CUESHEET_INDEX_RESERVED_LEN))
1821                                                 return false; /* read_callback_ sets the state for us */
1822                                 }
1823                         }
1824                 }
1825         }
1826
1827         return true;
1828 }
1829
1830 FLAC__bool read_metadata_picture_(FLAC__StreamDecoder *decoder, FLAC__StreamMetadata_Picture *obj)
1831 {
1832         FLAC__uint32 x;
1833
1834         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
1835
1836         /* read type */
1837         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_TYPE_LEN))
1838                 return false; /* read_callback_ sets the state for us */
1839         obj->type = x;
1840
1841         /* read MIME type */
1842         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_MIME_TYPE_LENGTH_LEN))
1843                 return false; /* read_callback_ sets the state for us */
1844         if(0 == (obj->mime_type = safe_malloc_add_2op_(x, /*+*/1))) {
1845                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1846                 return false;
1847         }
1848         if(x > 0) {
1849                 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, (FLAC__byte*)obj->mime_type, x))
1850                         return false; /* read_callback_ sets the state for us */
1851         }
1852         obj->mime_type[x] = '\0';
1853
1854         /* read description */
1855         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__STREAM_METADATA_PICTURE_DESCRIPTION_LENGTH_LEN))
1856                 return false; /* read_callback_ sets the state for us */
1857         if(0 == (obj->description = safe_malloc_add_2op_(x, /*+*/1))) {
1858                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1859                 return false;
1860         }
1861         if(x > 0) {
1862                 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->description, x))
1863                         return false; /* read_callback_ sets the state for us */
1864         }
1865         obj->description[x] = '\0';
1866
1867         /* read width */
1868         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->width, FLAC__STREAM_METADATA_PICTURE_WIDTH_LEN))
1869                 return false; /* read_callback_ sets the state for us */
1870
1871         /* read height */
1872         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->height, FLAC__STREAM_METADATA_PICTURE_HEIGHT_LEN))
1873                 return false; /* read_callback_ sets the state for us */
1874
1875         /* read depth */
1876         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->depth, FLAC__STREAM_METADATA_PICTURE_DEPTH_LEN))
1877                 return false; /* read_callback_ sets the state for us */
1878
1879         /* read colors */
1880         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &obj->colors, FLAC__STREAM_METADATA_PICTURE_COLORS_LEN))
1881                 return false; /* read_callback_ sets the state for us */
1882
1883         /* read data */
1884         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &(obj->data_length), FLAC__STREAM_METADATA_PICTURE_DATA_LENGTH_LEN))
1885                 return false; /* read_callback_ sets the state for us */
1886         if(0 == (obj->data = safe_malloc_(obj->data_length))) {
1887                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
1888                 return false;
1889         }
1890         if(obj->data_length > 0) {
1891                 if(!FLAC__bitreader_read_byte_block_aligned_no_crc(decoder->private_->input, obj->data, obj->data_length))
1892                         return false; /* read_callback_ sets the state for us */
1893         }
1894
1895         return true;
1896 }
1897
1898 FLAC__bool skip_id3v2_tag_(FLAC__StreamDecoder *decoder)
1899 {
1900         FLAC__uint32 x;
1901         unsigned i, skip;
1902
1903         /* skip the version and flags bytes */
1904         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 24))
1905                 return false; /* read_callback_ sets the state for us */
1906         /* get the size (in bytes) to skip */
1907         skip = 0;
1908         for(i = 0; i < 4; i++) {
1909                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1910                         return false; /* read_callback_ sets the state for us */
1911                 skip <<= 7;
1912                 skip |= (x & 0x7f);
1913         }
1914         /* skip the rest of the tag */
1915         if(!FLAC__bitreader_skip_byte_block_aligned_no_crc(decoder->private_->input, skip))
1916                 return false; /* read_callback_ sets the state for us */
1917         return true;
1918 }
1919
1920 FLAC__bool frame_sync_(FLAC__StreamDecoder *decoder)
1921 {
1922         FLAC__uint32 x;
1923         FLAC__bool first = true;
1924
1925         /* If we know the total number of samples in the stream, stop if we've read that many. */
1926         /* This will stop us, for example, from wasting time trying to sync on an ID3V1 tag. */
1927         if(FLAC__stream_decoder_get_total_samples(decoder) > 0) {
1928                 if(decoder->private_->samples_decoded >= FLAC__stream_decoder_get_total_samples(decoder)) {
1929                         decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
1930                         return true;
1931                 }
1932         }
1933
1934         /* make sure we're byte aligned */
1935         if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input)) {
1936                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__bitreader_bits_left_for_byte_alignment(decoder->private_->input)))
1937                         return false; /* read_callback_ sets the state for us */
1938         }
1939
1940         while(1) {
1941                 if(decoder->private_->cached) {
1942                         x = (FLAC__uint32)decoder->private_->lookahead;
1943                         decoder->private_->cached = false;
1944                 }
1945                 else {
1946                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1947                                 return false; /* read_callback_ sets the state for us */
1948                 }
1949                 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1950                         decoder->private_->header_warmup[0] = (FLAC__byte)x;
1951                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
1952                                 return false; /* read_callback_ sets the state for us */
1953
1954                         /* 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 */
1955                         /* else we have to check if the second byte is the end of a sync code */
1956                         if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
1957                                 decoder->private_->lookahead = (FLAC__byte)x;
1958                                 decoder->private_->cached = true;
1959                         }
1960                         else if(x >> 1 == 0x7c) { /* MAGIC NUMBER for the last 6 sync bits and reserved 7th bit */
1961                                 decoder->private_->header_warmup[1] = (FLAC__byte)x;
1962                                 decoder->protected_->state = FLAC__STREAM_DECODER_READ_FRAME;
1963                                 return true;
1964                         }
1965                 }
1966                 if(first) {
1967                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
1968                         first = false;
1969                 }
1970         }
1971
1972         return true;
1973 }
1974
1975 FLAC__bool read_frame_(FLAC__StreamDecoder *decoder, FLAC__bool *got_a_frame, FLAC__bool do_full_decode)
1976 {
1977         unsigned channel;
1978         unsigned i;
1979         FLAC__int32 mid, side;
1980         unsigned frame_crc; /* the one we calculate from the input stream */
1981         FLAC__uint32 x;
1982
1983         *got_a_frame = false;
1984
1985         /* init the CRC */
1986         frame_crc = 0;
1987         frame_crc = FLAC__CRC16_UPDATE(decoder->private_->header_warmup[0], frame_crc);
1988         frame_crc = FLAC__CRC16_UPDATE(decoder->private_->header_warmup[1], frame_crc);
1989         FLAC__bitreader_reset_read_crc16(decoder->private_->input, (FLAC__uint16)frame_crc);
1990
1991         if(!read_frame_header_(decoder))
1992                 return false;
1993         if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means we didn't sync on a valid header */
1994                 return true;
1995         if(!allocate_output_(decoder, decoder->private_->frame.header.blocksize, decoder->private_->frame.header.channels))
1996                 return false;
1997         for(channel = 0; channel < decoder->private_->frame.header.channels; channel++) {
1998                 /*
1999                  * first figure the correct bits-per-sample of the subframe
2000                  */
2001                 unsigned bps = decoder->private_->frame.header.bits_per_sample;
2002                 switch(decoder->private_->frame.header.channel_assignment) {
2003                         case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
2004                                 /* no adjustment needed */
2005                                 break;
2006                         case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
2007                                 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2008                                 if(channel == 1)
2009                                         bps++;
2010                                 break;
2011                         case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
2012                                 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2013                                 if(channel == 0)
2014                                         bps++;
2015                                 break;
2016                         case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
2017                                 FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2018                                 if(channel == 1)
2019                                         bps++;
2020                                 break;
2021                         default:
2022                                 FLAC__ASSERT(0);
2023                 }
2024                 /*
2025                  * now read it
2026                  */
2027                 if(!read_subframe_(decoder, channel, bps, do_full_decode))
2028                         return false;
2029                 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2030                         return true;
2031         }
2032         if(!read_zero_padding_(decoder))
2033                 return false;
2034         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) */
2035                 return true;
2036
2037         /*
2038          * Read the frame CRC-16 from the footer and check
2039          */
2040         frame_crc = FLAC__bitreader_get_read_crc16(decoder->private_->input);
2041         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, FLAC__FRAME_FOOTER_CRC_LEN))
2042                 return false; /* read_callback_ sets the state for us */
2043         if(frame_crc == x) {
2044                 if(do_full_decode) {
2045                         /* Undo any special channel coding */
2046                         switch(decoder->private_->frame.header.channel_assignment) {
2047                                 case FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT:
2048                                         /* do nothing */
2049                                         break;
2050                                 case FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE:
2051                                         FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2052                                         for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2053                                                 decoder->private_->output[1][i] = decoder->private_->output[0][i] - decoder->private_->output[1][i];
2054                                         break;
2055                                 case FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE:
2056                                         FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2057                                         for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2058                                                 decoder->private_->output[0][i] += decoder->private_->output[1][i];
2059                                         break;
2060                                 case FLAC__CHANNEL_ASSIGNMENT_MID_SIDE:
2061                                         FLAC__ASSERT(decoder->private_->frame.header.channels == 2);
2062                                         for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2063 #if 1
2064                                                 mid = decoder->private_->output[0][i];
2065                                                 side = decoder->private_->output[1][i];
2066                                                 mid <<= 1;
2067                                                 mid |= (side & 1); /* i.e. if 'side' is odd... */
2068                                                 decoder->private_->output[0][i] = (mid + side) >> 1;
2069                                                 decoder->private_->output[1][i] = (mid - side) >> 1;
2070 #else
2071                                                 /* OPT: without 'side' temp variable */
2072                                                 mid = (decoder->private_->output[0][i] << 1) | (decoder->private_->output[1][i] & 1); /* i.e. if 'side' is odd... */
2073                                                 decoder->private_->output[0][i] = (mid + decoder->private_->output[1][i]) >> 1;
2074                                                 decoder->private_->output[1][i] = (mid - decoder->private_->output[1][i]) >> 1;
2075 #endif
2076                                         }
2077                                         break;
2078                                 default:
2079                                         FLAC__ASSERT(0);
2080                                         break;
2081                         }
2082                 }
2083         }
2084         else {
2085                 /* Bad frame, emit error and zero the output signal */
2086                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH);
2087                 if(do_full_decode) {
2088                         for(channel = 0; channel < decoder->private_->frame.header.channels; channel++) {
2089                                 memset(decoder->private_->output[channel], 0, sizeof(FLAC__int32) * decoder->private_->frame.header.blocksize);
2090                         }
2091                 }
2092         }
2093
2094         *got_a_frame = true;
2095
2096         /* we wait to update fixed_block_size until here, when we're sure we've got a proper frame and hence a correct blocksize */
2097         if(decoder->private_->next_fixed_block_size)
2098                 decoder->private_->fixed_block_size = decoder->private_->next_fixed_block_size;
2099
2100         /* put the latest values into the public section of the decoder instance */
2101         decoder->protected_->channels = decoder->private_->frame.header.channels;
2102         decoder->protected_->channel_assignment = decoder->private_->frame.header.channel_assignment;
2103         decoder->protected_->bits_per_sample = decoder->private_->frame.header.bits_per_sample;
2104         decoder->protected_->sample_rate = decoder->private_->frame.header.sample_rate;
2105         decoder->protected_->blocksize = decoder->private_->frame.header.blocksize;
2106
2107         FLAC__ASSERT(decoder->private_->frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
2108         decoder->private_->samples_decoded = decoder->private_->frame.header.number.sample_number + decoder->private_->frame.header.blocksize;
2109
2110         /* write it */
2111         if(do_full_decode) {
2112                 if(write_audio_frame_to_client_(decoder, &decoder->private_->frame, (const FLAC__int32 * const *)decoder->private_->output) != FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE)
2113                         return false;
2114         }
2115
2116         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2117         return true;
2118 }
2119
2120 FLAC__bool read_frame_header_(FLAC__StreamDecoder *decoder)
2121 {
2122         FLAC__uint32 x;
2123         FLAC__uint64 xx;
2124         unsigned i, blocksize_hint = 0, sample_rate_hint = 0;
2125         FLAC__byte crc8, raw_header[16]; /* MAGIC NUMBER based on the maximum frame header size, including CRC */
2126         unsigned raw_header_len;
2127         FLAC__bool is_unparseable = false;
2128
2129         FLAC__ASSERT(FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input));
2130
2131         /* init the raw header with the saved bits from synchronization */
2132         raw_header[0] = decoder->private_->header_warmup[0];
2133         raw_header[1] = decoder->private_->header_warmup[1];
2134         raw_header_len = 2;
2135
2136         /* check to make sure that reserved bit is 0 */
2137         if(raw_header[1] & 0x02) /* MAGIC NUMBER */
2138                 is_unparseable = true;
2139
2140         /*
2141          * Note that along the way as we read the header, we look for a sync
2142          * code inside.  If we find one it would indicate that our original
2143          * sync was bad since there cannot be a sync code in a valid header.
2144          *
2145          * Three kinds of things can go wrong when reading the frame header:
2146          *  1) We may have sync'ed incorrectly and not landed on a frame header.
2147          *     If we don't find a sync code, it can end up looking like we read
2148          *     a valid but unparseable header, until getting to the frame header
2149          *     CRC.  Even then we could get a false positive on the CRC.
2150          *  2) We may have sync'ed correctly but on an unparseable frame (from a
2151          *     future encoder).
2152          *  3) We may be on a damaged frame which appears valid but unparseable.
2153          *
2154          * For all these reasons, we try and read a complete frame header as
2155          * long as it seems valid, even if unparseable, up until the frame
2156          * header CRC.
2157          */
2158
2159         /*
2160          * read in the raw header as bytes so we can CRC it, and parse it on the way
2161          */
2162         for(i = 0; i < 2; i++) {
2163                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2164                         return false; /* read_callback_ sets the state for us */
2165                 if(x == 0xff) { /* MAGIC NUMBER for the first 8 frame sync bits */
2166                         /* if we get here it means our original sync was erroneous since the sync code cannot appear in the header */
2167                         decoder->private_->lookahead = (FLAC__byte)x;
2168                         decoder->private_->cached = true;
2169                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2170                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2171                         return true;
2172                 }
2173                 raw_header[raw_header_len++] = (FLAC__byte)x;
2174         }
2175
2176         switch(x = raw_header[2] >> 4) {
2177                 case 0:
2178                         is_unparseable = true;
2179                         break;
2180                 case 1:
2181                         decoder->private_->frame.header.blocksize = 192;
2182                         break;
2183                 case 2:
2184                 case 3:
2185                 case 4:
2186                 case 5:
2187                         decoder->private_->frame.header.blocksize = 576 << (x-2);
2188                         break;
2189                 case 6:
2190                 case 7:
2191                         blocksize_hint = x;
2192                         break;
2193                 case 8:
2194                 case 9:
2195                 case 10:
2196                 case 11:
2197                 case 12:
2198                 case 13:
2199                 case 14:
2200                 case 15:
2201                         decoder->private_->frame.header.blocksize = 256 << (x-8);
2202                         break;
2203                 default:
2204                         FLAC__ASSERT(0);
2205                         break;
2206         }
2207
2208         switch(x = raw_header[2] & 0x0f) {
2209                 case 0:
2210                         if(decoder->private_->has_stream_info)
2211                                 decoder->private_->frame.header.sample_rate = decoder->private_->stream_info.data.stream_info.sample_rate;
2212                         else
2213                                 is_unparseable = true;
2214                         break;
2215                 case 1:
2216                         decoder->private_->frame.header.sample_rate = 88200;
2217                         break;
2218                 case 2:
2219                         decoder->private_->frame.header.sample_rate = 176400;
2220                         break;
2221                 case 3:
2222                         decoder->private_->frame.header.sample_rate = 192000;
2223                         break;
2224                 case 4:
2225                         decoder->private_->frame.header.sample_rate = 8000;
2226                         break;
2227                 case 5:
2228                         decoder->private_->frame.header.sample_rate = 16000;
2229                         break;
2230                 case 6:
2231                         decoder->private_->frame.header.sample_rate = 22050;
2232                         break;
2233                 case 7:
2234                         decoder->private_->frame.header.sample_rate = 24000;
2235                         break;
2236                 case 8:
2237                         decoder->private_->frame.header.sample_rate = 32000;
2238                         break;
2239                 case 9:
2240                         decoder->private_->frame.header.sample_rate = 44100;
2241                         break;
2242                 case 10:
2243                         decoder->private_->frame.header.sample_rate = 48000;
2244                         break;
2245                 case 11:
2246                         decoder->private_->frame.header.sample_rate = 96000;
2247                         break;
2248                 case 12:
2249                 case 13:
2250                 case 14:
2251                         sample_rate_hint = x;
2252                         break;
2253                 case 15:
2254                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2255                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2256                         return true;
2257                 default:
2258                         FLAC__ASSERT(0);
2259         }
2260
2261         x = (unsigned)(raw_header[3] >> 4);
2262         if(x & 8) {
2263                 decoder->private_->frame.header.channels = 2;
2264                 switch(x & 7) {
2265                         case 0:
2266                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_LEFT_SIDE;
2267                                 break;
2268                         case 1:
2269                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_RIGHT_SIDE;
2270                                 break;
2271                         case 2:
2272                                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_MID_SIDE;
2273                                 break;
2274                         default:
2275                                 is_unparseable = true;
2276                                 break;
2277                 }
2278         }
2279         else {
2280                 decoder->private_->frame.header.channels = (unsigned)x + 1;
2281                 decoder->private_->frame.header.channel_assignment = FLAC__CHANNEL_ASSIGNMENT_INDEPENDENT;
2282         }
2283
2284         switch(x = (unsigned)(raw_header[3] & 0x0e) >> 1) {
2285                 case 0:
2286                         if(decoder->private_->has_stream_info)
2287                                 decoder->private_->frame.header.bits_per_sample = decoder->private_->stream_info.data.stream_info.bits_per_sample;
2288                         else
2289                                 is_unparseable = true;
2290                         break;
2291                 case 1:
2292                         decoder->private_->frame.header.bits_per_sample = 8;
2293                         break;
2294                 case 2:
2295                         decoder->private_->frame.header.bits_per_sample = 12;
2296                         break;
2297                 case 4:
2298                         decoder->private_->frame.header.bits_per_sample = 16;
2299                         break;
2300                 case 5:
2301                         decoder->private_->frame.header.bits_per_sample = 20;
2302                         break;
2303                 case 6:
2304                         decoder->private_->frame.header.bits_per_sample = 24;
2305                         break;
2306                 case 3:
2307                 case 7:
2308                         is_unparseable = true;
2309                         break;
2310                 default:
2311                         FLAC__ASSERT(0);
2312                         break;
2313         }
2314
2315         /* check to make sure that reserved bit is 0 */
2316         if(raw_header[3] & 0x01) /* MAGIC NUMBER */
2317                 is_unparseable = true;
2318
2319         /* read the frame's starting sample number (or frame number as the case may be) */
2320         if(
2321                 raw_header[1] & 0x01 ||
2322                 /*@@@ 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 */
2323                 (decoder->private_->has_stream_info && decoder->private_->stream_info.data.stream_info.min_blocksize != decoder->private_->stream_info.data.stream_info.max_blocksize)
2324         ) { /* variable blocksize */
2325                 if(!FLAC__bitreader_read_utf8_uint64(decoder->private_->input, &xx, raw_header, &raw_header_len))
2326                         return false; /* read_callback_ sets the state for us */
2327                 if(xx == FLAC__U64L(0xffffffffffffffff)) { /* i.e. non-UTF8 code... */
2328                         decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2329                         decoder->private_->cached = true;
2330                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2331                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2332                         return true;
2333                 }
2334                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2335                 decoder->private_->frame.header.number.sample_number = xx;
2336         }
2337         else { /* fixed blocksize */
2338                 if(!FLAC__bitreader_read_utf8_uint32(decoder->private_->input, &x, raw_header, &raw_header_len))
2339                         return false; /* read_callback_ sets the state for us */
2340                 if(x == 0xffffffff) { /* i.e. non-UTF8 code... */
2341                         decoder->private_->lookahead = raw_header[raw_header_len-1]; /* back up as much as we can */
2342                         decoder->private_->cached = true;
2343                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2344                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2345                         return true;
2346                 }
2347                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER;
2348                 decoder->private_->frame.header.number.frame_number = x;
2349         }
2350
2351         if(blocksize_hint) {
2352                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2353                         return false; /* read_callback_ sets the state for us */
2354                 raw_header[raw_header_len++] = (FLAC__byte)x;
2355                 if(blocksize_hint == 7) {
2356                         FLAC__uint32 _x;
2357                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2358                                 return false; /* read_callback_ sets the state for us */
2359                         raw_header[raw_header_len++] = (FLAC__byte)_x;
2360                         x = (x << 8) | _x;
2361                 }
2362                 decoder->private_->frame.header.blocksize = x+1;
2363         }
2364
2365         if(sample_rate_hint) {
2366                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2367                         return false; /* read_callback_ sets the state for us */
2368                 raw_header[raw_header_len++] = (FLAC__byte)x;
2369                 if(sample_rate_hint != 12) {
2370                         FLAC__uint32 _x;
2371                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &_x, 8))
2372                                 return false; /* read_callback_ sets the state for us */
2373                         raw_header[raw_header_len++] = (FLAC__byte)_x;
2374                         x = (x << 8) | _x;
2375                 }
2376                 if(sample_rate_hint == 12)
2377                         decoder->private_->frame.header.sample_rate = x*1000;
2378                 else if(sample_rate_hint == 13)
2379                         decoder->private_->frame.header.sample_rate = x;
2380                 else
2381                         decoder->private_->frame.header.sample_rate = x*10;
2382         }
2383
2384         /* read the CRC-8 byte */
2385         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8))
2386                 return false; /* read_callback_ sets the state for us */
2387         crc8 = (FLAC__byte)x;
2388
2389         if(FLAC__crc8(raw_header, raw_header_len) != crc8) {
2390                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER);
2391                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2392                 return true;
2393         }
2394
2395         /* calculate the sample number from the frame number if needed */
2396         decoder->private_->next_fixed_block_size = 0;
2397         if(decoder->private_->frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER) {
2398                 x = decoder->private_->frame.header.number.frame_number;
2399                 decoder->private_->frame.header.number_type = FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER;
2400                 if(decoder->private_->fixed_block_size)
2401                         decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->fixed_block_size * (FLAC__uint64)x;
2402                 else if(decoder->private_->has_stream_info) {
2403                         if(decoder->private_->stream_info.data.stream_info.min_blocksize == decoder->private_->stream_info.data.stream_info.max_blocksize) {
2404                                 decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->stream_info.data.stream_info.min_blocksize * (FLAC__uint64)x;
2405                                 decoder->private_->next_fixed_block_size = decoder->private_->stream_info.data.stream_info.max_blocksize;
2406                         }
2407                         else
2408                                 is_unparseable = true;
2409                 }
2410                 else if(x == 0) {
2411                         decoder->private_->frame.header.number.sample_number = 0;
2412                         decoder->private_->next_fixed_block_size = decoder->private_->frame.header.blocksize;
2413                 }
2414                 else {
2415                         /* can only get here if the stream has invalid frame numbering and no STREAMINFO, so assume it's not the last (possibly short) frame */
2416                         decoder->private_->frame.header.number.sample_number = (FLAC__uint64)decoder->private_->frame.header.blocksize * (FLAC__uint64)x;
2417                 }
2418         }
2419
2420         if(is_unparseable) {
2421                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2422                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2423                 return true;
2424         }
2425
2426         return true;
2427 }
2428
2429 FLAC__bool read_subframe_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2430 {
2431         FLAC__uint32 x;
2432         FLAC__bool wasted_bits;
2433         unsigned i;
2434
2435         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &x, 8)) /* MAGIC NUMBER */
2436                 return false; /* read_callback_ sets the state for us */
2437
2438         wasted_bits = (x & 1);
2439         x &= 0xfe;
2440
2441         if(wasted_bits) {
2442                 unsigned u;
2443                 if(!FLAC__bitreader_read_unary_unsigned(decoder->private_->input, &u))
2444                         return false; /* read_callback_ sets the state for us */
2445                 decoder->private_->frame.subframes[channel].wasted_bits = u+1;
2446                 bps -= decoder->private_->frame.subframes[channel].wasted_bits;
2447         }
2448         else
2449                 decoder->private_->frame.subframes[channel].wasted_bits = 0;
2450
2451         /*
2452          * Lots of magic numbers here
2453          */
2454         if(x & 0x80) {
2455                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2456                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2457                 return true;
2458         }
2459         else if(x == 0) {
2460                 if(!read_subframe_constant_(decoder, channel, bps, do_full_decode))
2461                         return false;
2462         }
2463         else if(x == 2) {
2464                 if(!read_subframe_verbatim_(decoder, channel, bps, do_full_decode))
2465                         return false;
2466         }
2467         else if(x < 16) {
2468                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2469                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2470                 return true;
2471         }
2472         else if(x <= 24) {
2473                 if(!read_subframe_fixed_(decoder, channel, bps, (x>>1)&7, do_full_decode))
2474                         return false;
2475                 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2476                         return true;
2477         }
2478         else if(x < 64) {
2479                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2480                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2481                 return true;
2482         }
2483         else {
2484                 if(!read_subframe_lpc_(decoder, channel, bps, ((x>>1)&31)+1, do_full_decode))
2485                         return false;
2486                 if(decoder->protected_->state == FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC) /* means bad sync or got corruption */
2487                         return true;
2488         }
2489
2490         if(wasted_bits && do_full_decode) {
2491                 x = decoder->private_->frame.subframes[channel].wasted_bits;
2492                 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2493                         decoder->private_->output[channel][i] <<= x;
2494         }
2495
2496         return true;
2497 }
2498
2499 FLAC__bool read_subframe_constant_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2500 {
2501         FLAC__Subframe_Constant *subframe = &decoder->private_->frame.subframes[channel].data.constant;
2502         FLAC__int32 x;
2503         unsigned i;
2504         FLAC__int32 *output = decoder->private_->output[channel];
2505
2506         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_CONSTANT;
2507
2508         if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2509                 return false; /* read_callback_ sets the state for us */
2510
2511         subframe->value = x;
2512
2513         /* decode the subframe */
2514         if(do_full_decode) {
2515                 for(i = 0; i < decoder->private_->frame.header.blocksize; i++)
2516                         output[i] = x;
2517         }
2518
2519         return true;
2520 }
2521
2522 FLAC__bool read_subframe_fixed_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode)
2523 {
2524         FLAC__Subframe_Fixed *subframe = &decoder->private_->frame.subframes[channel].data.fixed;
2525         FLAC__int32 i32;
2526         FLAC__uint32 u32;
2527         unsigned u;
2528
2529         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_FIXED;
2530
2531         subframe->residual = decoder->private_->residual[channel];
2532         subframe->order = order;
2533
2534         /* read warm-up samples */
2535         for(u = 0; u < order; u++) {
2536                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2537                         return false; /* read_callback_ sets the state for us */
2538                 subframe->warmup[u] = i32;
2539         }
2540
2541         /* read entropy coding method info */
2542         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2543                 return false; /* read_callback_ sets the state for us */
2544         subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2545         switch(subframe->entropy_coding_method.type) {
2546                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2547                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2548                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2549                                 return false; /* read_callback_ sets the state for us */
2550                         subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2551                         subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2552                         break;
2553                 default:
2554                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2555                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2556                         return true;
2557         }
2558
2559         /* read residual */
2560         switch(subframe->entropy_coding_method.type) {
2561                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2562                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2563                         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))
2564                                 return false;
2565                         break;
2566                 default:
2567                         FLAC__ASSERT(0);
2568         }
2569
2570         /* decode the subframe */
2571         if(do_full_decode) {
2572                 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2573                 FLAC__fixed_restore_signal(decoder->private_->residual[channel], decoder->private_->frame.header.blocksize-order, order, decoder->private_->output[channel]+order);
2574         }
2575
2576         return true;
2577 }
2578
2579 FLAC__bool read_subframe_lpc_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, const unsigned order, FLAC__bool do_full_decode)
2580 {
2581         FLAC__Subframe_LPC *subframe = &decoder->private_->frame.subframes[channel].data.lpc;
2582         FLAC__int32 i32;
2583         FLAC__uint32 u32;
2584         unsigned u;
2585
2586         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_LPC;
2587
2588         subframe->residual = decoder->private_->residual[channel];
2589         subframe->order = order;
2590
2591         /* read warm-up samples */
2592         for(u = 0; u < order; u++) {
2593                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, bps))
2594                         return false; /* read_callback_ sets the state for us */
2595                 subframe->warmup[u] = i32;
2596         }
2597
2598         /* read qlp coeff precision */
2599         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN))
2600                 return false; /* read_callback_ sets the state for us */
2601         if(u32 == (1u << FLAC__SUBFRAME_LPC_QLP_COEFF_PRECISION_LEN) - 1) {
2602                 send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2603                 decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2604                 return true;
2605         }
2606         subframe->qlp_coeff_precision = u32+1;
2607
2608         /* read qlp shift */
2609         if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, FLAC__SUBFRAME_LPC_QLP_SHIFT_LEN))
2610                 return false; /* read_callback_ sets the state for us */
2611         subframe->quantization_level = i32;
2612
2613         /* read quantized lp coefficiencts */
2614         for(u = 0; u < order; u++) {
2615                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i32, subframe->qlp_coeff_precision))
2616                         return false; /* read_callback_ sets the state for us */
2617                 subframe->qlp_coeff[u] = i32;
2618         }
2619
2620         /* read entropy coding method info */
2621         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_TYPE_LEN))
2622                 return false; /* read_callback_ sets the state for us */
2623         subframe->entropy_coding_method.type = (FLAC__EntropyCodingMethodType)u32;
2624         switch(subframe->entropy_coding_method.type) {
2625                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2626                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2627                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &u32, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ORDER_LEN))
2628                                 return false; /* read_callback_ sets the state for us */
2629                         subframe->entropy_coding_method.data.partitioned_rice.order = u32;
2630                         subframe->entropy_coding_method.data.partitioned_rice.contents = &decoder->private_->partitioned_rice_contents[channel];
2631                         break;
2632                 default:
2633                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM);
2634                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2635                         return true;
2636         }
2637
2638         /* read residual */
2639         switch(subframe->entropy_coding_method.type) {
2640                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE:
2641                 case FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2:
2642                         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))
2643                                 return false;
2644                         break;
2645                 default:
2646                         FLAC__ASSERT(0);
2647         }
2648
2649         /* decode the subframe */
2650         if(do_full_decode) {
2651                 memcpy(decoder->private_->output[channel], subframe->warmup, sizeof(FLAC__int32) * order);
2652                 /*@@@@@@ technically not pessimistic enough, should be more like
2653                 if( (FLAC__uint64)order * ((((FLAC__uint64)1)<<bps)-1) * ((1<<subframe->qlp_coeff_precision)-1) < (((FLAC__uint64)-1) << 32) )
2654                 */
2655                 if(bps + subframe->qlp_coeff_precision + FLAC__bitmath_ilog2(order) <= 32)
2656                         if(bps <= 16 && subframe->qlp_coeff_precision <= 16)
2657                                 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);
2658                         else
2659                                 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);
2660                 else
2661                         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);
2662         }
2663
2664         return true;
2665 }
2666
2667 FLAC__bool read_subframe_verbatim_(FLAC__StreamDecoder *decoder, unsigned channel, unsigned bps, FLAC__bool do_full_decode)
2668 {
2669         FLAC__Subframe_Verbatim *subframe = &decoder->private_->frame.subframes[channel].data.verbatim;
2670         FLAC__int32 x, *residual = decoder->private_->residual[channel];
2671         unsigned i;
2672
2673         decoder->private_->frame.subframes[channel].type = FLAC__SUBFRAME_TYPE_VERBATIM;
2674
2675         subframe->data = residual;
2676
2677         for(i = 0; i < decoder->private_->frame.header.blocksize; i++) {
2678                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &x, bps))
2679                         return false; /* read_callback_ sets the state for us */
2680                 residual[i] = x;
2681         }
2682
2683         /* decode the subframe */
2684         if(do_full_decode)
2685                 memcpy(decoder->private_->output[channel], subframe->data, sizeof(FLAC__int32) * decoder->private_->frame.header.blocksize);
2686
2687         return true;
2688 }
2689
2690 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)
2691 {
2692         FLAC__uint32 rice_parameter;
2693         int i;
2694         unsigned partition, sample, u;
2695         const unsigned partitions = 1u << partition_order;
2696         const unsigned partition_samples = partition_order > 0? decoder->private_->frame.header.blocksize >> partition_order : decoder->private_->frame.header.blocksize - predictor_order;
2697         const unsigned plen = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_PARAMETER_LEN : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_PARAMETER_LEN;
2698         const unsigned pesc = is_extended? FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE2_ESCAPE_PARAMETER : FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_ESCAPE_PARAMETER;
2699
2700         /* sanity checks */
2701         if(partition_order == 0) {
2702                 if(decoder->private_->frame.header.blocksize < predictor_order) {
2703                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2704                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2705                         return true;
2706                 }
2707         }
2708         else {
2709                 if(partition_samples < predictor_order) {
2710                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2711                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2712                         return true;
2713                 }
2714         }
2715
2716         if(!FLAC__format_entropy_coding_method_partitioned_rice_contents_ensure_size(partitioned_rice_contents, flac_max(6u, partition_order))) {
2717                 decoder->protected_->state = FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR;
2718                 return false;
2719         }
2720
2721         sample = 0;
2722         for(partition = 0; partition < partitions; partition++) {
2723                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, plen))
2724                         return false; /* read_callback_ sets the state for us */
2725                 partitioned_rice_contents->parameters[partition] = rice_parameter;
2726                 if(rice_parameter < pesc) {
2727                         partitioned_rice_contents->raw_bits[partition] = 0;
2728                         u = (partition_order == 0 || partition > 0)? partition_samples : partition_samples - predictor_order;
2729                         if(!FLAC__bitreader_read_rice_signed_block(decoder->private_->input, residual + sample, u, rice_parameter))
2730                                 return false; /* read_callback_ sets the state for us */
2731                         sample += u;
2732                 }
2733                 else {
2734                         if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &rice_parameter, FLAC__ENTROPY_CODING_METHOD_PARTITIONED_RICE_RAW_LEN))
2735                                 return false; /* read_callback_ sets the state for us */
2736                         partitioned_rice_contents->raw_bits[partition] = rice_parameter;
2737                         for(u = (partition_order == 0 || partition > 0)? 0 : predictor_order; u < partition_samples; u++, sample++) {
2738                                 if(!FLAC__bitreader_read_raw_int32(decoder->private_->input, &i, rice_parameter))
2739                                         return false; /* read_callback_ sets the state for us */
2740                                 residual[sample] = i;
2741                         }
2742                 }
2743         }
2744
2745         return true;
2746 }
2747
2748 FLAC__bool read_zero_padding_(FLAC__StreamDecoder *decoder)
2749 {
2750         if(!FLAC__bitreader_is_consumed_byte_aligned(decoder->private_->input)) {
2751                 FLAC__uint32 zero = 0;
2752                 if(!FLAC__bitreader_read_raw_uint32(decoder->private_->input, &zero, FLAC__bitreader_bits_left_for_byte_alignment(decoder->private_->input)))
2753                         return false; /* read_callback_ sets the state for us */
2754                 if(zero != 0) {
2755                         send_error_to_client_(decoder, FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC);
2756                         decoder->protected_->state = FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC;
2757                 }
2758         }
2759         return true;
2760 }
2761
2762 FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data)
2763 {
2764         FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder *)client_data;
2765
2766         if(
2767 #if FLAC__HAS_OGG
2768                 /* see [1] HACK NOTE below for why we don't call the eof_callback when decoding Ogg FLAC */
2769                 !decoder->private_->is_ogg &&
2770 #endif
2771                 decoder->private_->eof_callback && decoder->private_->eof_callback(decoder, decoder->private_->client_data)
2772         ) {
2773                 *bytes = 0;
2774                 decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2775                 return false;
2776         }
2777         else if(*bytes > 0) {
2778                 /* While seeking, it is possible for our seek to land in the
2779                  * middle of audio data that looks exactly like a frame header
2780                  * from a future version of an encoder.  When that happens, our
2781                  * error callback will get an
2782                  * FLAC__STREAM_DECODER_UNPARSEABLE_STREAM and increment its
2783                  * unparseable_frame_count.  But there is a remote possibility
2784                  * that it is properly synced at such a "future-codec frame",
2785                  * so to make sure, we wait to see many "unparseable" errors in
2786                  * a row before bailing out.
2787                  */
2788                 if(decoder->private_->is_seeking && decoder->private_->unparseable_frame_count > 20) {
2789                         decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2790                         return false;
2791                 }
2792                 else {
2793                         const FLAC__StreamDecoderReadStatus status =
2794 #if FLAC__HAS_OGG
2795                                 decoder->private_->is_ogg?
2796                                 read_callback_ogg_aspect_(decoder, buffer, bytes) :
2797 #endif
2798                                 decoder->private_->read_callback(decoder, buffer, bytes, decoder->private_->client_data)
2799                         ;
2800                         if(status == FLAC__STREAM_DECODER_READ_STATUS_ABORT) {
2801                                 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2802                                 return false;
2803                         }
2804                         else if(*bytes == 0) {
2805                                 if(
2806                                         status == FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM ||
2807                                         (
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                                 ) {
2815                                         decoder->protected_->state = FLAC__STREAM_DECODER_END_OF_STREAM;
2816                                         return false;
2817                                 }
2818                                 else
2819                                         return true;
2820                         }
2821                         else
2822                                 return true;
2823                 }
2824         }
2825         else {
2826                 /* abort to avoid a deadlock */
2827                 decoder->protected_->state = FLAC__STREAM_DECODER_ABORTED;
2828                 return false;
2829         }
2830         /* [1] @@@ HACK NOTE: The end-of-stream checking has to be hacked around
2831          * for Ogg FLAC.  This is because the ogg decoder aspect can lose sync
2832          * and at the same time hit the end of the stream (for example, seeking
2833          * to a point that is after the beginning of the last Ogg page).  There
2834          * is no way to report an Ogg sync loss through the callbacks (see note
2835          * in read_callback_ogg_aspect_()) so it returns CONTINUE with *bytes==0.
2836          * So to keep the decoder from stopping at this point we gate the call
2837          * to the eof_callback and let the Ogg decoder aspect set the
2838          * end-of-stream state when it is needed.
2839          */
2840 }
2841
2842 #if FLAC__HAS_OGG
2843 FLAC__StreamDecoderReadStatus read_callback_ogg_aspect_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes)
2844 {
2845         switch(FLAC__ogg_decoder_aspect_read_callback_wrapper(&decoder->protected_->ogg_decoder_aspect, buffer, bytes, read_callback_proxy_, decoder, decoder->private_->client_data)) {
2846                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK:
2847                         return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2848                 /* we don't really have a way to handle lost sync via read
2849                  * callback so we'll let it pass and let the underlying
2850                  * FLAC decoder catch the error
2851                  */
2852                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_LOST_SYNC:
2853                         return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
2854                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM:
2855                         return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
2856                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_NOT_FLAC:
2857                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_UNSUPPORTED_MAPPING_VERSION:
2858                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT:
2859                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_ERROR:
2860                 case FLAC__OGG_DECODER_ASPECT_READ_STATUS_MEMORY_ALLOCATION_ERROR:
2861                         return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2862                 default:
2863                         FLAC__ASSERT(0);
2864                         /* double protection */
2865                         return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
2866         }
2867 }
2868
2869 FLAC__OggDecoderAspectReadStatus read_callback_proxy_(const void *void_decoder, FLAC__byte buffer[], size_t *bytes, void *client_data)
2870 {
2871         FLAC__StreamDecoder *decoder = (FLAC__StreamDecoder*)void_decoder;
2872
2873         switch(decoder->private_->read_callback(decoder, buffer, bytes, client_data)) {
2874                 case FLAC__STREAM_DECODER_READ_STATUS_CONTINUE:
2875                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK;
2876                 case FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM:
2877                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM;
2878                 case FLAC__STREAM_DECODER_READ_STATUS_ABORT:
2879                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2880                 default:
2881                         /* double protection: */
2882                         FLAC__ASSERT(0);
2883                         return FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT;
2884         }
2885 }
2886 #endif
2887
2888 FLAC__StreamDecoderWriteStatus write_audio_frame_to_client_(FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[])
2889 {
2890         if(decoder->private_->is_seeking) {
2891                 FLAC__uint64 this_frame_sample = frame->header.number.sample_number;
2892                 FLAC__uint64 next_frame_sample = this_frame_sample + (FLAC__uint64)frame->header.blocksize;
2893                 FLAC__uint64 target_sample = decoder->private_->target_sample;
2894
2895                 FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
2896
2897 #if FLAC__HAS_OGG
2898                 decoder->private_->got_a_frame = true;
2899 #endif
2900                 decoder->private_->last_frame = *frame; /* save the frame */
2901                 if(this_frame_sample <= target_sample && target_sample < next_frame_sample) { /* we hit our target frame */
2902                         unsigned delta = (unsigned)(target_sample - this_frame_sample);
2903                         /* kick out of seek mode */
2904                         decoder->private_->is_seeking = false;
2905                         /* shift out the samples before target_sample */
2906                         if(delta > 0) {
2907                                 unsigned channel;
2908                                 const FLAC__int32 *newbuffer[FLAC__MAX_CHANNELS];
2909                                 for(channel = 0; channel < frame->header.channels; channel++)
2910                                         newbuffer[channel] = buffer[channel] + delta;
2911                                 decoder->private_->last_frame.header.blocksize -= delta;
2912                                 decoder->private_->last_frame.header.number.sample_number += (FLAC__uint64)delta;
2913                                 /* write the relevant samples */
2914                                 return decoder->private_->write_callback(decoder, &decoder->private_->last_frame, newbuffer, decoder->private_->client_data);
2915                         }
2916                         else {
2917                                 /* write the relevant samples */
2918                                 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2919                         }
2920                 }
2921                 else {
2922                         return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
2923                 }
2924         }
2925         else {
2926                 /*
2927                  * If we never got STREAMINFO, turn off MD5 checking to save
2928                  * cycles since we don't have a sum to compare to anyway
2929                  */
2930                 if(!decoder->private_->has_stream_info)
2931                         decoder->private_->do_md5_checking = false;
2932                 if(decoder->private_->do_md5_checking) {
2933                         if(!FLAC__MD5Accumulate(&decoder->private_->md5context, buffer, frame->header.channels, frame->header.blocksize, (frame->header.bits_per_sample+7) / 8))
2934                                 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
2935                 }
2936                 return decoder->private_->write_callback(decoder, frame, buffer, decoder->private_->client_data);
2937         }
2938 }
2939
2940 void send_error_to_client_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status)
2941 {
2942         if(!decoder->private_->is_seeking)
2943                 decoder->private_->error_callback(decoder, status, decoder->private_->client_data);
2944         else if(status == FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM)
2945                 decoder->private_->unparseable_frame_count++;
2946 }
2947
2948 FLAC__bool seek_to_absolute_sample_(FLAC__StreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
2949 {
2950         FLAC__uint64 first_frame_offset = decoder->private_->first_frame_offset, lower_bound, upper_bound, lower_bound_sample, upper_bound_sample, this_frame_sample;
2951         FLAC__int64 pos = -1;
2952         int i;
2953         unsigned approx_bytes_per_frame;
2954         FLAC__bool first_seek = true;
2955         const FLAC__uint64 total_samples = FLAC__stream_decoder_get_total_samples(decoder);
2956         const unsigned min_blocksize = decoder->private_->stream_info.data.stream_info.min_blocksize;
2957         const unsigned max_blocksize = decoder->private_->stream_info.data.stream_info.max_blocksize;
2958         const unsigned max_framesize = decoder->private_->stream_info.data.stream_info.max_framesize;
2959         const unsigned min_framesize = decoder->private_->stream_info.data.stream_info.min_framesize;
2960         /* take these from the current frame in case they've changed mid-stream */
2961         unsigned channels = FLAC__stream_decoder_get_channels(decoder);
2962         unsigned bps = FLAC__stream_decoder_get_bits_per_sample(decoder);
2963         const FLAC__StreamMetadata_SeekTable *seek_table = decoder->private_->has_seek_table? &decoder->private_->seek_table.data.seek_table : 0;
2964
2965         /* use values from stream info if we didn't decode a frame */
2966         if(channels == 0)
2967                 channels = decoder->private_->stream_info.data.stream_info.channels;
2968         if(bps == 0)
2969                 bps = decoder->private_->stream_info.data.stream_info.bits_per_sample;
2970
2971         /* we are just guessing here */
2972         if(max_framesize > 0)
2973                 approx_bytes_per_frame = (max_framesize + min_framesize) / 2 + 1;
2974         /*
2975          * Check if it's a known fixed-blocksize stream.  Note that though
2976          * the spec doesn't allow zeroes in the STREAMINFO block, we may
2977          * never get a STREAMINFO block when decoding so the value of
2978          * min_blocksize might be zero.
2979          */
2980         else if(min_blocksize == max_blocksize && min_blocksize > 0) {
2981                 /* note there are no () around 'bps/8' to keep precision up since it's an integer calulation */
2982                 approx_bytes_per_frame = min_blocksize * channels * bps/8 + 64;
2983         }
2984         else
2985                 approx_bytes_per_frame = 4096 * channels * bps/8 + 64;
2986
2987         /*
2988          * First, we set an upper and lower bound on where in the
2989          * stream we will search.  For now we assume the worst case
2990          * scenario, which is our best guess at the beginning of
2991          * the first frame and end of the stream.
2992          */
2993         lower_bound = first_frame_offset;
2994         lower_bound_sample = 0;
2995         upper_bound = stream_length;
2996         upper_bound_sample = total_samples > 0 ? total_samples : target_sample /*estimate it*/;
2997
2998         /*
2999          * Now we refine the bounds if we have a seektable with
3000          * suitable points.  Note that according to the spec they
3001          * must be ordered by ascending sample number.
3002          *
3003          * Note: to protect against invalid seek tables we will ignore points
3004          * that have frame_samples==0 or sample_number>=total_samples
3005          */
3006         if(seek_table) {
3007                 FLAC__uint64 new_lower_bound = lower_bound;
3008                 FLAC__uint64 new_upper_bound = upper_bound;
3009                 FLAC__uint64 new_lower_bound_sample = lower_bound_sample;
3010                 FLAC__uint64 new_upper_bound_sample = upper_bound_sample;
3011
3012                 /* find the closest seek point <= target_sample, if it exists */
3013                 for(i = (int)seek_table->num_points - 1; i >= 0; i--) {
3014                         if(
3015                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3016                                 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3017                                 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */
3018                                 seek_table->points[i].sample_number <= target_sample
3019                         )
3020                                 break;
3021                 }
3022                 if(i >= 0) { /* i.e. we found a suitable seek point... */
3023                         new_lower_bound = first_frame_offset + seek_table->points[i].stream_offset;
3024                         new_lower_bound_sample = seek_table->points[i].sample_number;
3025                 }
3026
3027                 /* find the closest seek point > target_sample, if it exists */
3028                 for(i = 0; i < (int)seek_table->num_points; i++) {
3029                         if(
3030                                 seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER &&
3031                                 seek_table->points[i].frame_samples > 0 && /* defense against bad seekpoints */
3032                                 (total_samples <= 0 || seek_table->points[i].sample_number < total_samples) && /* defense against bad seekpoints */
3033                                 seek_table->points[i].sample_number > target_sample
3034                         )
3035                                 break;
3036                 }
3037                 if(i < (int)seek_table->num_points) { /* i.e. we found a suitable seek point... */
3038                         new_upper_bound = first_frame_offset + seek_table->points[i].stream_offset;
3039                         new_upper_bound_sample = seek_table->points[i].sample_number;
3040                 }
3041                 /* final protection against unsorted seek tables; keep original values if bogus */
3042                 if(new_upper_bound >= new_lower_bound) {
3043                         lower_bound = new_lower_bound;
3044                         upper_bound = new_upper_bound;
3045                         lower_bound_sample = new_lower_bound_sample;
3046                         upper_bound_sample = new_upper_bound_sample;
3047                 }
3048         }
3049
3050         FLAC__ASSERT(upper_bound_sample >= lower_bound_sample);
3051         /* there are 2 insidious ways that the following equality occurs, which
3052          * we need to fix:
3053          *  1) total_samples is 0 (unknown) and target_sample is 0
3054          *  2) total_samples is 0 (unknown) and target_sample happens to be
3055          *     exactly equal to the last seek point in the seek table; this
3056          *     means there is no seek point above it, and upper_bound_samples
3057          *     remains equal to the estimate (of target_samples) we made above
3058          * in either case it does not hurt to move upper_bound_sample up by 1
3059          */
3060         if(upper_bound_sample == lower_bound_sample)
3061                 upper_bound_sample++;
3062
3063         decoder->private_->target_sample = target_sample;
3064         while(1) {
3065                 /* check if the bounds are still ok */
3066                 if (lower_bound_sample >= upper_bound_sample || lower_bound > upper_bound) {
3067                         decoder->protected_->state = FLAC__STREAM_DECODER_SEEK_ERROR;
3068                         return false;
3069                 }
3070 #ifndef FLAC__INTEGER_ONLY_LIBRARY
3071                 pos = (FLAC__int64)lower_bound + (FLAC__int64)((FLAC__double)(target_sample - lower_bound_sample) / (FLAC__double)(upper_bound_sample - lower_bound_sample) * (FLAC__double)(upper_bound - lower_bound)) - approx_bytes_per_frame;
3072 #else
3073                 /* a little less accurate: */
3074                 if(upper_bound - lower_bound < 0xffffffff)
3075                         pos = (FLAC__int64)lower_bound + (FLAC__int64)(((target_sample - lower_bound_sample) * (upper_bound - lower_bound)) / (upper_bound_sample - lower_bound_sample)) - approx_bytes_per_frame;
3076                 else /* @@@ WATCHOUT, ~2TB limit */
3077                         pos = (FLAC__int64)lower_bound + (FLAC__int64)((((target_sample - lower_bound_sample)>>8) * ((upper_bound - lower_bound)>>8)) / ((upper_bound_sample - lower_bound_sample)>>16)) - approx_bytes_per_frame;
3078 #endif
3079                 if(pos >= (FLAC__int64)upper_bound)
3080                         pos = (FLAC__int64)upper_bound - 1;
3081                 if(pos < (FLAC__int64)lower_bound)
3082                         pos = (FLAC__int64)lower_bound;
3083                 if(decoder->private_->seek_callback(decoder, (FLAC__uint64)pos, decoder->private_->client_data) != FLAC__STREAM_DECODER_SEEK_STATUS_OK) {