1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001,2002,2003 Josh Coalson
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 #include <stdlib.h> /* for calloc() */
22 #include <string.h> /* for memcpy()/memcmp() */
23 #include "FLAC/assert.h"
24 #include "protected/seekable_stream_decoder.h"
25 #include "protected/stream_decoder.h"
26 #include "private/md5.h"
28 /***********************************************************************
30 * Private class method prototypes
32 ***********************************************************************/
34 static void set_defaults_(FLAC__SeekableStreamDecoder *decoder);
35 static FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
36 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
37 static void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
38 static void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
39 static FLAC__bool seek_to_absolute_sample_(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample);
41 /***********************************************************************
45 ***********************************************************************/
47 typedef struct FLAC__SeekableStreamDecoderPrivate {
48 FLAC__SeekableStreamDecoderReadCallback read_callback;
49 FLAC__SeekableStreamDecoderSeekCallback seek_callback;
50 FLAC__SeekableStreamDecoderTellCallback tell_callback;
51 FLAC__SeekableStreamDecoderLengthCallback length_callback;
52 FLAC__SeekableStreamDecoderEofCallback eof_callback;
53 FLAC__SeekableStreamDecoderWriteCallback write_callback;
54 FLAC__SeekableStreamDecoderMetadataCallback metadata_callback;
55 FLAC__SeekableStreamDecoderErrorCallback error_callback;
57 FLAC__StreamDecoder *stream_decoder;
58 FLAC__bool do_md5_checking; /* initially gets protected_->md5_checking but is turned off after a seek */
59 struct MD5Context md5context;
60 FLAC__byte stored_md5sum[16]; /* this is what is stored in the metadata */
61 FLAC__byte computed_md5sum[16]; /* this is the sum we computed from the decoded data */
62 /* the rest of these are only used for seeking: */
63 FLAC__StreamMetadata_StreamInfo stream_info; /* we keep this around so we can figure out how to seek quickly */
64 const FLAC__StreamMetadata_SeekTable *seek_table; /* we hold a pointer to the stream decoder's seek table for the same reason */
65 /* Since we always want to see the STREAMINFO and SEEK_TABLE blocks at this level, we need some extra flags to keep track of whether they should be passed on up through the metadata_callback */
66 FLAC__bool ignore_stream_info_block;
67 FLAC__bool ignore_seek_table_block;
68 FLAC__Frame last_frame; /* holds the info of the last frame we seeked to */
69 FLAC__uint64 target_sample;
70 } FLAC__SeekableStreamDecoderPrivate;
72 /***********************************************************************
74 * Public static class data
76 ***********************************************************************/
78 FLAC_API const char * const FLAC__SeekableStreamDecoderStateString[] = {
79 "FLAC__SEEKABLE_STREAM_DECODER_OK",
80 "FLAC__SEEKABLE_STREAM_DECODER_SEEKING",
81 "FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM",
82 "FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR",
83 "FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR",
84 "FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR",
85 "FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR",
86 "FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED",
87 "FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK",
88 "FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED"
91 FLAC_API const char * const FLAC__SeekableStreamDecoderReadStatusString[] = {
92 "FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK",
93 "FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR"
96 FLAC_API const char * const FLAC__SeekableStreamDecoderSeekStatusString[] = {
97 "FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK",
98 "FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR"
101 FLAC_API const char * const FLAC__SeekableStreamDecoderTellStatusString[] = {
102 "FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK",
103 "FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR"
106 FLAC_API const char * const FLAC__SeekableStreamDecoderLengthStatusString[] = {
107 "FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK",
108 "FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR"
112 /***********************************************************************
114 * Class constructor/destructor
116 ***********************************************************************/
118 FLAC_API FLAC__SeekableStreamDecoder *FLAC__seekable_stream_decoder_new()
120 FLAC__SeekableStreamDecoder *decoder;
122 FLAC__ASSERT(sizeof(int) >= 4); /* we want to die right away if this is not true */
124 decoder = (FLAC__SeekableStreamDecoder*)calloc(1, sizeof(FLAC__SeekableStreamDecoder));
129 decoder->protected_ = (FLAC__SeekableStreamDecoderProtected*)calloc(1, sizeof(FLAC__SeekableStreamDecoderProtected));
130 if(decoder->protected_ == 0) {
135 decoder->private_ = (FLAC__SeekableStreamDecoderPrivate*)calloc(1, sizeof(FLAC__SeekableStreamDecoderPrivate));
136 if(decoder->private_ == 0) {
137 free(decoder->protected_);
142 decoder->private_->stream_decoder = FLAC__stream_decoder_new();
143 if(0 == decoder->private_->stream_decoder) {
144 free(decoder->private_);
145 free(decoder->protected_);
150 set_defaults_(decoder);
152 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED;
157 FLAC_API void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *decoder)
159 FLAC__ASSERT(0 != decoder);
160 FLAC__ASSERT(0 != decoder->protected_);
161 FLAC__ASSERT(0 != decoder->private_);
162 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
164 (void)FLAC__seekable_stream_decoder_finish(decoder);
166 FLAC__stream_decoder_delete(decoder->private_->stream_decoder);
168 free(decoder->private_);
169 free(decoder->protected_);
173 /***********************************************************************
175 * Public class methods
177 ***********************************************************************/
179 FLAC_API FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder)
181 FLAC__ASSERT(0 != decoder);
183 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
184 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED;
186 if(0 == decoder->private_->read_callback || 0 == decoder->private_->seek_callback || 0 == decoder->private_->tell_callback || 0 == decoder->private_->length_callback || 0 == decoder->private_->eof_callback)
187 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK;
189 if(0 == decoder->private_->write_callback || 0 == decoder->private_->metadata_callback || 0 == decoder->private_->error_callback)
190 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK;
192 decoder->private_->seek_table = 0;
194 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
196 /* We initialize the MD5Context even though we may never use it. This is
197 * because md5 checking may be turned on to start and then turned off if a
198 * seek occurs. So we always init the context here and finalize it in
199 * FLAC__seekable_stream_decoder_finish() to make sure things are always
200 * cleaned up properly.
202 MD5Init(&decoder->private_->md5context);
204 FLAC__stream_decoder_set_read_callback(decoder->private_->stream_decoder, read_callback_);
205 FLAC__stream_decoder_set_write_callback(decoder->private_->stream_decoder, write_callback_);
206 FLAC__stream_decoder_set_metadata_callback(decoder->private_->stream_decoder, metadata_callback_);
207 FLAC__stream_decoder_set_error_callback(decoder->private_->stream_decoder, error_callback_);
208 FLAC__stream_decoder_set_client_data(decoder->private_->stream_decoder, decoder);
210 /* We always want to see these blocks. Whether or not we pass them up
211 * through the metadata callback will be determined by flags set in our
212 * implementation of ..._set_metadata_respond/ignore...()
214 FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, FLAC__METADATA_TYPE_STREAMINFO);
215 FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, FLAC__METADATA_TYPE_SEEKTABLE);
217 if(FLAC__stream_decoder_init(decoder->private_->stream_decoder) != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA)
218 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
220 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
223 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder)
225 FLAC__bool md5_failed = false;
227 FLAC__ASSERT(0 != decoder);
228 FLAC__ASSERT(0 != decoder->private_);
229 FLAC__ASSERT(0 != decoder->protected_);
231 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
234 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
236 /* see the comment in FLAC__seekable_stream_decoder_init() as to why we
237 * always call MD5Final()
239 MD5Final(decoder->private_->computed_md5sum, &decoder->private_->md5context);
241 FLAC__stream_decoder_finish(decoder->private_->stream_decoder);
243 if(decoder->private_->do_md5_checking) {
244 if(memcmp(decoder->private_->stored_md5sum, decoder->private_->computed_md5sum, 16))
248 set_defaults_(decoder);
250 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED;
255 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value)
257 FLAC__ASSERT(0 != decoder);
258 FLAC__ASSERT(0 != decoder->protected_);
259 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
261 decoder->protected_->md5_checking = value;
265 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_read_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderReadCallback value)
267 FLAC__ASSERT(0 != decoder);
268 FLAC__ASSERT(0 != decoder->private_);
269 FLAC__ASSERT(0 != decoder->protected_);
270 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
272 decoder->private_->read_callback = value;
276 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderSeekCallback value)
278 FLAC__ASSERT(0 != decoder);
279 FLAC__ASSERT(0 != decoder->private_);
280 FLAC__ASSERT(0 != decoder->protected_);
281 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
283 decoder->private_->seek_callback = value;
287 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderTellCallback value)
289 FLAC__ASSERT(0 != decoder);
290 FLAC__ASSERT(0 != decoder->private_);
291 FLAC__ASSERT(0 != decoder->protected_);
292 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
294 decoder->private_->tell_callback = value;
298 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_length_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderLengthCallback value)
300 FLAC__ASSERT(0 != decoder);
301 FLAC__ASSERT(0 != decoder->private_);
302 FLAC__ASSERT(0 != decoder->protected_);
303 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
305 decoder->private_->length_callback = value;
309 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderEofCallback value)
311 FLAC__ASSERT(0 != decoder);
312 FLAC__ASSERT(0 != decoder->private_);
313 FLAC__ASSERT(0 != decoder->protected_);
314 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
316 decoder->private_->eof_callback = value;
320 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_write_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderWriteCallback value)
322 FLAC__ASSERT(0 != decoder);
323 FLAC__ASSERT(0 != decoder->private_);
324 FLAC__ASSERT(0 != decoder->protected_);
325 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
327 decoder->private_->write_callback = value;
331 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderMetadataCallback value)
333 FLAC__ASSERT(0 != decoder);
334 FLAC__ASSERT(0 != decoder->private_);
335 FLAC__ASSERT(0 != decoder->protected_);
336 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
338 decoder->private_->metadata_callback = value;
342 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderErrorCallback value)
344 FLAC__ASSERT(0 != decoder);
345 FLAC__ASSERT(0 != decoder->private_);
346 FLAC__ASSERT(0 != decoder->protected_);
347 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
349 decoder->private_->error_callback = value;
353 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value)
355 FLAC__ASSERT(0 != decoder);
356 FLAC__ASSERT(0 != decoder->private_);
357 FLAC__ASSERT(0 != decoder->protected_);
358 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
360 decoder->private_->client_data = value;
364 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type)
366 FLAC__ASSERT(0 != decoder);
367 FLAC__ASSERT(0 != decoder->private_);
368 FLAC__ASSERT(0 != decoder->protected_);
369 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
370 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
372 if(type == FLAC__METADATA_TYPE_STREAMINFO)
373 decoder->private_->ignore_stream_info_block = false;
374 else if(type == FLAC__METADATA_TYPE_SEEKTABLE)
375 decoder->private_->ignore_seek_table_block = false;
376 return FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, type);
379 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4])
381 FLAC__ASSERT(0 != decoder);
382 FLAC__ASSERT(0 != decoder->private_);
383 FLAC__ASSERT(0 != decoder->protected_);
384 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
385 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
387 return FLAC__stream_decoder_set_metadata_respond_application(decoder->private_->stream_decoder, id);
390 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder)
392 FLAC__ASSERT(0 != decoder);
393 FLAC__ASSERT(0 != decoder->private_);
394 FLAC__ASSERT(0 != decoder->protected_);
395 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
396 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
398 decoder->private_->ignore_stream_info_block = false;
399 decoder->private_->ignore_seek_table_block = false;
400 return FLAC__stream_decoder_set_metadata_respond_all(decoder->private_->stream_decoder);
403 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type)
405 FLAC__ASSERT(0 != decoder);
406 FLAC__ASSERT(0 != decoder->private_);
407 FLAC__ASSERT(0 != decoder->protected_);
408 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
409 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
411 if(type == FLAC__METADATA_TYPE_STREAMINFO)
412 decoder->private_->ignore_stream_info_block = true;
413 else if(type == FLAC__METADATA_TYPE_SEEKTABLE)
414 decoder->private_->ignore_seek_table_block = true;
415 return FLAC__stream_decoder_set_metadata_ignore(decoder->private_->stream_decoder, type);
418 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4])
420 FLAC__ASSERT(0 != decoder);
421 FLAC__ASSERT(0 != decoder->private_);
422 FLAC__ASSERT(0 != decoder->protected_);
423 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
424 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
426 return FLAC__stream_decoder_set_metadata_ignore_application(decoder->private_->stream_decoder, id);
429 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder)
431 FLAC__ASSERT(0 != decoder);
432 FLAC__ASSERT(0 != decoder->private_);
433 FLAC__ASSERT(0 != decoder->protected_);
434 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
435 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
437 decoder->private_->ignore_stream_info_block = true;
438 decoder->private_->ignore_seek_table_block = true;
439 return FLAC__stream_decoder_set_metadata_ignore_all(decoder->private_->stream_decoder);
442 FLAC_API FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder)
444 FLAC__ASSERT(0 != decoder);
445 FLAC__ASSERT(0 != decoder->protected_);
446 return decoder->protected_->state;
449 FLAC_API FLAC__StreamDecoderState FLAC__seekable_stream_decoder_get_stream_decoder_state(const FLAC__SeekableStreamDecoder *decoder)
451 FLAC__ASSERT(0 != decoder);
452 FLAC__ASSERT(0 != decoder->private_);
453 return FLAC__stream_decoder_get_state(decoder->private_->stream_decoder);
456 FLAC_API const char *FLAC__seekable_stream_decoder_get_resolved_state_string(const FLAC__SeekableStreamDecoder *decoder)
458 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR)
459 return FLAC__SeekableStreamDecoderStateString[decoder->protected_->state];
461 return FLAC__StreamDecoderStateString[FLAC__stream_decoder_get_state(decoder->private_->stream_decoder)];
464 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder)
466 FLAC__ASSERT(0 != decoder);
467 FLAC__ASSERT(0 != decoder->protected_);
468 return decoder->protected_->md5_checking;
471 FLAC_API unsigned FLAC__seekable_stream_decoder_get_channels(const FLAC__SeekableStreamDecoder *decoder)
473 FLAC__ASSERT(0 != decoder);
474 FLAC__ASSERT(0 != decoder->private_);
475 return FLAC__stream_decoder_get_channels(decoder->private_->stream_decoder);
478 FLAC_API FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder)
480 FLAC__ASSERT(0 != decoder);
481 FLAC__ASSERT(0 != decoder->private_);
482 return FLAC__stream_decoder_get_channel_assignment(decoder->private_->stream_decoder);
485 FLAC_API unsigned FLAC__seekable_stream_decoder_get_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder)
487 FLAC__ASSERT(0 != decoder);
488 FLAC__ASSERT(0 != decoder->private_);
489 return FLAC__stream_decoder_get_bits_per_sample(decoder->private_->stream_decoder);
492 FLAC_API unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder)
494 FLAC__ASSERT(0 != decoder);
495 FLAC__ASSERT(0 != decoder->private_);
496 return FLAC__stream_decoder_get_sample_rate(decoder->private_->stream_decoder);
499 FLAC_API unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder)
501 FLAC__ASSERT(0 != decoder);
502 FLAC__ASSERT(0 != decoder->private_);
503 return FLAC__stream_decoder_get_blocksize(decoder->private_->stream_decoder);
506 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_get_decode_position(const FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 *position)
508 FLAC__ASSERT(0 != decoder);
509 FLAC__ASSERT(0 != decoder->private_);
510 FLAC__ASSERT(0 != position);
512 if(decoder->private_->tell_callback(decoder, position, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK)
514 FLAC__ASSERT(*position >= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder));
515 *position -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder);
519 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder)
521 FLAC__ASSERT(0 != decoder);
522 FLAC__ASSERT(0 != decoder->private_);
523 FLAC__ASSERT(0 != decoder->protected_);
525 decoder->private_->do_md5_checking = false;
527 if(!FLAC__stream_decoder_flush(decoder->private_->stream_decoder)) {
528 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
532 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
537 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder)
539 FLAC__ASSERT(0 != decoder);
540 FLAC__ASSERT(0 != decoder->private_);
541 FLAC__ASSERT(0 != decoder->protected_);
543 if(!FLAC__seekable_stream_decoder_flush(decoder)) {
544 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
548 if(!FLAC__stream_decoder_reset(decoder->private_->stream_decoder)) {
549 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
553 decoder->private_->seek_table = 0;
555 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
557 /* We initialize the MD5Context even though we may never use it. This is
558 * because md5 checking may be turned on to start and then turned off if a
559 * seek occurs. So we always init the context here and finalize it in
560 * FLAC__seekable_stream_decoder_finish() to make sure things are always
561 * cleaned up properly.
563 MD5Init(&decoder->private_->md5context);
565 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
570 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_process_single(FLAC__SeekableStreamDecoder *decoder)
573 FLAC__ASSERT(0 != decoder);
575 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
576 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
578 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
581 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
583 ret = FLAC__stream_decoder_process_single(decoder->private_->stream_decoder);
585 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
590 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_metadata(FLAC__SeekableStreamDecoder *decoder)
593 FLAC__ASSERT(0 != decoder);
595 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
596 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
598 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
601 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
603 ret = FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->stream_decoder);
605 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
610 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_stream(FLAC__SeekableStreamDecoder *decoder)
613 FLAC__ASSERT(0 != decoder);
615 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
616 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
618 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
621 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
623 ret = FLAC__stream_decoder_process_until_end_of_stream(decoder->private_->stream_decoder);
625 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
630 FLAC_API FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample)
634 FLAC__ASSERT(0 != decoder);
635 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK || decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM);
637 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEKING;
639 /* turn off md5 checking if a seek is attempted */
640 decoder->private_->do_md5_checking = false;
642 if(!FLAC__stream_decoder_reset(decoder->private_->stream_decoder)) {
643 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
646 /* get the file length */
647 if(decoder->private_->length_callback(decoder, &length, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK) {
648 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
652 if(decoder->private_->seek_callback(decoder, 0, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK) {
653 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
656 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->stream_decoder)) {
657 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
660 if(decoder->private_->stream_info.total_samples > 0 && sample > decoder->private_->stream_info.total_samples) {
661 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
665 return seek_to_absolute_sample_(decoder, length, sample);
668 /***********************************************************************
670 * Private class methods
672 ***********************************************************************/
674 void set_defaults_(FLAC__SeekableStreamDecoder *decoder)
676 decoder->private_->read_callback = 0;
677 decoder->private_->seek_callback = 0;
678 decoder->private_->tell_callback = 0;
679 decoder->private_->length_callback = 0;
680 decoder->private_->eof_callback = 0;
681 decoder->private_->write_callback = 0;
682 decoder->private_->metadata_callback = 0;
683 decoder->private_->error_callback = 0;
684 decoder->private_->client_data = 0;
685 /* WATCHOUT: these should match the default behavior of FLAC__StreamDecoder */
686 decoder->private_->ignore_stream_info_block = false;
687 decoder->private_->ignore_seek_table_block = true;
689 decoder->protected_->md5_checking = false;
692 FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)
694 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
696 if(seekable_stream_decoder->private_->eof_callback(seekable_stream_decoder, seekable_stream_decoder->private_->client_data)) {
697 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
698 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
700 else if(*bytes > 0) {
701 unsigned bytes_read = *bytes;
702 if(seekable_stream_decoder->private_->read_callback(seekable_stream_decoder, buffer, &bytes_read, seekable_stream_decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK) {
703 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR;
704 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
706 if(bytes_read == 0) {
707 if(seekable_stream_decoder->private_->eof_callback(seekable_stream_decoder, seekable_stream_decoder->private_->client_data)) {
708 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
709 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
712 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
716 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
720 return FLAC__STREAM_DECODER_READ_STATUS_ABORT; /* abort to avoid a deadlock */
723 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
725 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
728 if(seekable_stream_decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
729 FLAC__uint64 this_frame_sample = frame->header.number.sample_number;
730 FLAC__uint64 next_frame_sample = this_frame_sample + (FLAC__uint64)frame->header.blocksize;
731 FLAC__uint64 target_sample = seekable_stream_decoder->private_->target_sample;
733 FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
735 seekable_stream_decoder->private_->last_frame = *frame; /* save the frame */
736 if(this_frame_sample <= target_sample && target_sample < next_frame_sample) { /* we hit our target frame */
737 unsigned delta = (unsigned)(target_sample - this_frame_sample);
738 /* kick out of seek mode */
739 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
740 /* shift out the samples before target_sample */
743 const FLAC__int32 *newbuffer[FLAC__MAX_CHANNELS];
744 for(channel = 0; channel < frame->header.channels; channel++)
745 newbuffer[channel] = buffer[channel] + delta;
746 seekable_stream_decoder->private_->last_frame.header.blocksize -= delta;
747 seekable_stream_decoder->private_->last_frame.header.number.sample_number += (FLAC__uint64)delta;
748 /* write the relevant samples */
749 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, &seekable_stream_decoder->private_->last_frame, newbuffer, seekable_stream_decoder->private_->client_data);
752 /* write the relevant samples */
753 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, frame, buffer, seekable_stream_decoder->private_->client_data);
757 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
761 if(seekable_stream_decoder->private_->do_md5_checking) {
762 if(!FLAC__MD5Accumulate(&seekable_stream_decoder->private_->md5context, buffer, frame->header.channels, frame->header.blocksize, (frame->header.bits_per_sample+7) / 8))
763 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
765 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, frame, buffer, seekable_stream_decoder->private_->client_data);
769 void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
771 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
774 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
775 seekable_stream_decoder->private_->stream_info = metadata->data.stream_info;
776 /* save the MD5 signature for comparison later */
777 memcpy(seekable_stream_decoder->private_->stored_md5sum, metadata->data.stream_info.md5sum, 16);
778 if(0 == memcmp(seekable_stream_decoder->private_->stored_md5sum, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0", 16))
779 seekable_stream_decoder->private_->do_md5_checking = false;
781 else if(metadata->type == FLAC__METADATA_TYPE_SEEKTABLE) {
782 seekable_stream_decoder->private_->seek_table = &metadata->data.seek_table;
785 if(seekable_stream_decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
786 FLAC__bool ignore_block = false;
787 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO && seekable_stream_decoder->private_->ignore_stream_info_block)
789 else if(metadata->type == FLAC__METADATA_TYPE_SEEKTABLE && seekable_stream_decoder->private_->ignore_seek_table_block)
792 seekable_stream_decoder->private_->metadata_callback(seekable_stream_decoder, metadata, seekable_stream_decoder->private_->client_data);
796 void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
798 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
801 if(seekable_stream_decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING)
802 seekable_stream_decoder->private_->error_callback(seekable_stream_decoder, status, seekable_stream_decoder->private_->client_data);
805 FLAC__bool seek_to_absolute_sample_(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
807 FLAC__uint64 first_frame_offset, lower_bound, upper_bound;
808 FLAC__int64 pos = -1, last_pos = -1;
809 int i, lower_seek_point = -1, upper_seek_point = -1;
810 unsigned approx_bytes_per_frame;
811 FLAC__uint64 last_frame_sample = 0xffffffffffffffff;
812 FLAC__bool needs_seek;
813 const FLAC__uint64 total_samples = decoder->private_->stream_info.total_samples;
814 const unsigned min_blocksize = decoder->private_->stream_info.min_blocksize;
815 const unsigned max_blocksize = decoder->private_->stream_info.max_blocksize;
816 const unsigned max_framesize = decoder->private_->stream_info.max_framesize;
817 const unsigned channels = FLAC__seekable_stream_decoder_get_channels(decoder);
818 const unsigned bps = FLAC__seekable_stream_decoder_get_bits_per_sample(decoder);
820 /* we are just guessing here, but we want to guess high, not low */
821 if(max_framesize > 0) {
822 approx_bytes_per_frame = max_framesize;
825 * Check if it's a known fixed-blocksize stream. Note that though
826 * the spec doesn't allow zeroes in the STREAMINFO block, we may
827 * never get a STREAMINFO block when decoding so the value of
828 * min_blocksize might be zero.
830 else if(min_blocksize == max_blocksize && min_blocksize > 0) {
831 /* note there are no () around 'bps/8' to keep precision up since it's an integer calulation */
832 approx_bytes_per_frame = min_blocksize * channels * bps/8 + 64;
835 approx_bytes_per_frame = 4608 * channels * bps/8 + 64;
838 * The decode position is currently at the first frame since we
839 * rewound and processed metadata.
841 if(!FLAC__seekable_stream_decoder_get_decode_position(decoder, &first_frame_offset)) {
842 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
847 * First, we set an upper and lower bound on where in the
848 * stream we will search. For now we assume the worst case
849 * scenario, which is our best guess at the beginning of
850 * the first and last frames.
852 lower_bound = first_frame_offset;
854 /* calc the upper_bound, beyond which we never want to seek */
855 if(max_framesize > 0)
856 upper_bound = stream_length - (max_framesize + 128 + 2); /* 128 for a possible ID3V1 tag, 2 for indexing differences */
858 upper_bound = stream_length - ((channels * bps * FLAC__MAX_BLOCK_SIZE) / 8 + 128 + 2);
861 * Now we refine the bounds if we have a seektable with
862 * suitable points. Note that according to the spec they
863 * must be ordered by ascending sample number.
865 if(0 != decoder->private_->seek_table) {
866 /* find the closest seek point <= target_sample, if it exists */
867 for(i = (int)decoder->private_->seek_table->num_points - 1; i >= 0; i--) {
868 if(decoder->private_->seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER && decoder->private_->seek_table->points[i].sample_number <= target_sample)
871 if(i >= 0) { /* i.e. we found a suitable seek point... */
872 lower_bound = first_frame_offset + decoder->private_->seek_table->points[i].stream_offset;
873 lower_seek_point = i;
876 /* find the closest seek point > target_sample, if it exists */
877 for(i = 0; i < (int)decoder->private_->seek_table->num_points; i++) {
878 if(decoder->private_->seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER && decoder->private_->seek_table->points[i].sample_number > target_sample)
881 if(i < (int)decoder->private_->seek_table->num_points) { /* i.e. we found a suitable seek point... */
882 upper_bound = first_frame_offset + decoder->private_->seek_table->points[i].stream_offset;
883 upper_seek_point = i;
888 * Now guess at where within those bounds our target
891 if(lower_seek_point >= 0) {
892 /* first see if our sample is within a few frames of the lower seekpoint */
893 if(decoder->private_->seek_table->points[lower_seek_point].sample_number <= target_sample && target_sample < decoder->private_->seek_table->points[lower_seek_point].sample_number + (decoder->private_->seek_table->points[lower_seek_point].frame_samples * 4)) {
894 pos = (FLAC__int64)lower_bound;
896 else if(upper_seek_point >= 0) {
897 const FLAC__uint64 target_offset = target_sample - decoder->private_->seek_table->points[lower_seek_point].sample_number;
898 const FLAC__uint64 range_samples = decoder->private_->seek_table->points[upper_seek_point].sample_number - decoder->private_->seek_table->points[lower_seek_point].sample_number;
899 const FLAC__uint64 range_bytes = upper_bound - lower_bound;
900 #if defined _MSC_VER || defined __MINGW32__
901 /* with VC++ you have to spoon feed it the casting */
902 pos = (FLAC__int64)lower_bound + (FLAC__int64)((double)(FLAC__int64)target_offset / (double)(FLAC__int64)range_samples * (double)(FLAC__int64)(range_bytes-1)) - approx_bytes_per_frame;
904 pos = (FLAC__int64)lower_bound + (FLAC__int64)((double)target_offset / (double)range_samples * (double)(range_bytes-1)) - approx_bytes_per_frame;
910 * If there's no seek table, we need to use the metadata (if we
911 * have it) and the filelength to estimate the position of the
912 * frame with the correct sample.
914 if(pos < 0 && total_samples > 0) {
915 #if defined _MSC_VER || defined __MINGW32__
916 /* with VC++ you have to spoon feed it the casting */
917 pos = (FLAC__int64)first_frame_offset + (FLAC__int64)((double)(FLAC__int64)target_sample / (double)(FLAC__int64)total_samples * (double)(FLAC__int64)(stream_length-first_frame_offset-1)) - approx_bytes_per_frame;
919 pos = (FLAC__int64)first_frame_offset + (FLAC__int64)((double)target_sample / (double)total_samples * (double)(stream_length-first_frame_offset-1)) - approx_bytes_per_frame;
924 * If there's no seek table and total_samples is unknown, we
925 * don't even bother trying to figure out a target, we just use
926 * our current position.
930 if(decoder->private_->tell_callback(decoder, &upos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK) {
931 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
934 pos = (FLAC__int32)upos;
940 /* clip the position to the bounds, lower bound takes precedence */
941 if(pos >= (FLAC__int64)upper_bound) {
942 pos = (FLAC__int64)upper_bound-1;
945 if(pos < (FLAC__int64)lower_bound) {
946 pos = (FLAC__int64)lower_bound;
950 decoder->private_->target_sample = target_sample;
953 if(decoder->private_->seek_callback(decoder, (FLAC__uint64)pos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK) {
954 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
957 if(!FLAC__stream_decoder_flush(decoder->private_->stream_decoder)) {
958 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
962 if(!FLAC__stream_decoder_process_single(decoder->private_->stream_decoder)) {
963 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
966 /* our write callback will change the state when it gets to the target frame */
967 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
970 else { /* we need to narrow the search */
971 FLAC__uint64 this_frame_sample = decoder->private_->last_frame.header.number.sample_number;
972 FLAC__ASSERT(decoder->private_->last_frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
973 if(this_frame_sample == last_frame_sample) {
974 /* our last move backwards wasn't big enough */
975 pos -= (last_pos - pos);
979 if(target_sample < this_frame_sample) {
981 approx_bytes_per_frame = decoder->private_->last_frame.header.blocksize * channels * bps/8 + 64;
982 pos -= approx_bytes_per_frame;
985 else { /* target_sample >= this_frame_sample + this frame's blocksize */
987 if(decoder->private_->tell_callback(decoder, &upos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK) {
988 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
992 pos = (FLAC__int32)upos;
993 pos -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder);
997 if(pos < (FLAC__int64)lower_bound)
998 pos = (FLAC__int64)lower_bound;
999 last_frame_sample = this_frame_sample;