1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001,2002 Josh Coalson
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 #include <stdlib.h> /* for malloc() */
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 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 const char * const FLAC__SeekableStreamDecoderReadStatusString[] = {
92 "FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK",
93 "FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR"
96 const char * const FLAC__SeekableStreamDecoderSeekStatusString[] = {
97 "FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK",
98 "FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR"
101 const char * const FLAC__SeekableStreamDecoderTellStatusString[] = {
102 "FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK",
103 "FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR"
106 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__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*)malloc(sizeof(FLAC__SeekableStreamDecoder));
128 decoder->protected_ = (FLAC__SeekableStreamDecoderProtected*)malloc(sizeof(FLAC__SeekableStreamDecoderProtected));
129 if(decoder->protected_ == 0) {
133 decoder->private_ = (FLAC__SeekableStreamDecoderPrivate*)malloc(sizeof(FLAC__SeekableStreamDecoderPrivate));
134 if(decoder->private_ == 0) {
135 free(decoder->protected_);
140 decoder->private_->stream_decoder = FLAC__stream_decoder_new();
142 if(0 == decoder->private_->stream_decoder) {
143 free(decoder->private_);
144 free(decoder->protected_);
149 set_defaults_(decoder);
151 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED;
156 void FLAC__seekable_stream_decoder_delete(FLAC__SeekableStreamDecoder *decoder)
158 FLAC__ASSERT(0 != decoder);
159 FLAC__ASSERT(0 != decoder->protected_);
160 FLAC__ASSERT(0 != decoder->private_);
161 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
163 (void)FLAC__seekable_stream_decoder_finish(decoder);
165 FLAC__stream_decoder_delete(decoder->private_->stream_decoder);
167 free(decoder->private_);
168 free(decoder->protected_);
172 /***********************************************************************
174 * Public class methods
176 ***********************************************************************/
178 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_init(FLAC__SeekableStreamDecoder *decoder)
180 FLAC__ASSERT(0 != decoder);
182 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
183 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED;
185 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)
186 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK;
188 if(0 == decoder->private_->write_callback || 0 == decoder->private_->metadata_callback || 0 == decoder->private_->error_callback)
189 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK;
191 decoder->private_->seek_table = 0;
193 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
195 /* We initialize the MD5Context even though we may never use it. This is
196 * because md5 checking may be turned on to start and then turned off if a
197 * seek occurs. So we always init the context here and finalize it in
198 * FLAC__seekable_stream_decoder_finish() to make sure things are always
199 * cleaned up properly.
201 MD5Init(&decoder->private_->md5context);
203 FLAC__stream_decoder_set_read_callback(decoder->private_->stream_decoder, read_callback_);
204 FLAC__stream_decoder_set_write_callback(decoder->private_->stream_decoder, write_callback_);
205 FLAC__stream_decoder_set_metadata_callback(decoder->private_->stream_decoder, metadata_callback_);
206 FLAC__stream_decoder_set_error_callback(decoder->private_->stream_decoder, error_callback_);
207 FLAC__stream_decoder_set_client_data(decoder->private_->stream_decoder, decoder);
209 /* We always want to see these blocks. Whether or not we pass them up
210 * through the metadata callback will be determined by flags set in our
211 * implementation of ..._set_metadata_respond/ignore...()
213 FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, FLAC__METADATA_TYPE_STREAMINFO);
214 FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, FLAC__METADATA_TYPE_SEEKTABLE);
216 if(FLAC__stream_decoder_init(decoder->private_->stream_decoder) != FLAC__STREAM_DECODER_SEARCH_FOR_METADATA)
217 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
219 return decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
222 FLAC__bool FLAC__seekable_stream_decoder_finish(FLAC__SeekableStreamDecoder *decoder)
224 FLAC__bool md5_failed = false;
226 FLAC__ASSERT(0 != decoder);
227 FLAC__ASSERT(0 != decoder->private_);
228 FLAC__ASSERT(0 != decoder->protected_);
230 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
233 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
235 /* see the comment in FLAC__seekable_stream_decoder_init() as to why we
236 * always call MD5Final()
238 MD5Final(decoder->private_->computed_md5sum, &decoder->private_->md5context);
240 FLAC__stream_decoder_finish(decoder->private_->stream_decoder);
242 if(decoder->private_->do_md5_checking) {
243 if(memcmp(decoder->private_->stored_md5sum, decoder->private_->computed_md5sum, 16))
247 set_defaults_(decoder);
249 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED;
254 FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking(FLAC__SeekableStreamDecoder *decoder, FLAC__bool value)
256 FLAC__ASSERT(0 != decoder);
257 FLAC__ASSERT(0 != decoder->protected_);
258 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
260 decoder->protected_->md5_checking = value;
264 FLAC__bool FLAC__seekable_stream_decoder_set_read_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderReadCallback value)
266 FLAC__ASSERT(0 != decoder);
267 FLAC__ASSERT(0 != decoder->private_);
268 FLAC__ASSERT(0 != decoder->protected_);
269 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
271 decoder->private_->read_callback = value;
275 FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderSeekCallback value)
277 FLAC__ASSERT(0 != decoder);
278 FLAC__ASSERT(0 != decoder->private_);
279 FLAC__ASSERT(0 != decoder->protected_);
280 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
282 decoder->private_->seek_callback = value;
286 FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderTellCallback value)
288 FLAC__ASSERT(0 != decoder);
289 FLAC__ASSERT(0 != decoder->private_);
290 FLAC__ASSERT(0 != decoder->protected_);
291 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
293 decoder->private_->tell_callback = value;
297 FLAC__bool FLAC__seekable_stream_decoder_set_length_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderLengthCallback value)
299 FLAC__ASSERT(0 != decoder);
300 FLAC__ASSERT(0 != decoder->private_);
301 FLAC__ASSERT(0 != decoder->protected_);
302 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
304 decoder->private_->length_callback = value;
308 FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderEofCallback value)
310 FLAC__ASSERT(0 != decoder);
311 FLAC__ASSERT(0 != decoder->private_);
312 FLAC__ASSERT(0 != decoder->protected_);
313 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
315 decoder->private_->eof_callback = value;
319 FLAC__bool FLAC__seekable_stream_decoder_set_write_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderWriteCallback value)
321 FLAC__ASSERT(0 != decoder);
322 FLAC__ASSERT(0 != decoder->private_);
323 FLAC__ASSERT(0 != decoder->protected_);
324 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
326 decoder->private_->write_callback = value;
330 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderMetadataCallback value)
332 FLAC__ASSERT(0 != decoder);
333 FLAC__ASSERT(0 != decoder->private_);
334 FLAC__ASSERT(0 != decoder->protected_);
335 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
337 decoder->private_->metadata_callback = value;
341 FLAC__bool FLAC__seekable_stream_decoder_set_error_callback(FLAC__SeekableStreamDecoder *decoder, FLAC__SeekableStreamDecoderErrorCallback value)
343 FLAC__ASSERT(0 != decoder);
344 FLAC__ASSERT(0 != decoder->private_);
345 FLAC__ASSERT(0 != decoder->protected_);
346 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
348 decoder->private_->error_callback = value;
352 FLAC__bool FLAC__seekable_stream_decoder_set_client_data(FLAC__SeekableStreamDecoder *decoder, void *value)
354 FLAC__ASSERT(0 != decoder);
355 FLAC__ASSERT(0 != decoder->private_);
356 FLAC__ASSERT(0 != decoder->protected_);
357 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
359 decoder->private_->client_data = value;
363 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type)
365 FLAC__ASSERT(0 != decoder);
366 FLAC__ASSERT(0 != decoder->private_);
367 FLAC__ASSERT(0 != decoder->protected_);
368 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
369 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
371 if(type == FLAC__METADATA_TYPE_STREAMINFO)
372 decoder->private_->ignore_stream_info_block = false;
373 else if(type == FLAC__METADATA_TYPE_SEEKTABLE)
374 decoder->private_->ignore_seek_table_block = false;
375 return FLAC__stream_decoder_set_metadata_respond(decoder->private_->stream_decoder, type);
378 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4])
380 FLAC__ASSERT(0 != decoder);
381 FLAC__ASSERT(0 != decoder->private_);
382 FLAC__ASSERT(0 != decoder->protected_);
383 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
384 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
386 return FLAC__stream_decoder_set_metadata_respond_application(decoder->private_->stream_decoder, id);
389 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all(FLAC__SeekableStreamDecoder *decoder)
391 FLAC__ASSERT(0 != decoder);
392 FLAC__ASSERT(0 != decoder->private_);
393 FLAC__ASSERT(0 != decoder->protected_);
394 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
395 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
397 decoder->private_->ignore_stream_info_block = false;
398 decoder->private_->ignore_seek_table_block = false;
399 return FLAC__stream_decoder_set_metadata_respond_all(decoder->private_->stream_decoder);
402 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore(FLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type)
404 FLAC__ASSERT(0 != decoder);
405 FLAC__ASSERT(0 != decoder->private_);
406 FLAC__ASSERT(0 != decoder->protected_);
407 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
408 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
410 if(type == FLAC__METADATA_TYPE_STREAMINFO)
411 decoder->private_->ignore_stream_info_block = true;
412 else if(type == FLAC__METADATA_TYPE_SEEKTABLE)
413 decoder->private_->ignore_seek_table_block = true;
414 return FLAC__stream_decoder_set_metadata_ignore(decoder->private_->stream_decoder, type);
417 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application(FLAC__SeekableStreamDecoder *decoder, const FLAC__byte id[4])
419 FLAC__ASSERT(0 != decoder);
420 FLAC__ASSERT(0 != decoder->private_);
421 FLAC__ASSERT(0 != decoder->protected_);
422 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
423 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
425 return FLAC__stream_decoder_set_metadata_ignore_application(decoder->private_->stream_decoder, id);
428 FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all(FLAC__SeekableStreamDecoder *decoder)
430 FLAC__ASSERT(0 != decoder);
431 FLAC__ASSERT(0 != decoder->private_);
432 FLAC__ASSERT(0 != decoder->protected_);
433 FLAC__ASSERT(0 != decoder->private_->stream_decoder);
434 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED)
436 decoder->private_->ignore_stream_info_block = true;
437 decoder->private_->ignore_seek_table_block = true;
438 return FLAC__stream_decoder_set_metadata_ignore_all(decoder->private_->stream_decoder);
441 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_state(const FLAC__SeekableStreamDecoder *decoder)
443 FLAC__ASSERT(0 != decoder);
444 FLAC__ASSERT(0 != decoder->protected_);
445 return decoder->protected_->state;
448 FLAC__SeekableStreamDecoderState FLAC__seekable_stream_decoder_get_stream_decoder_state(const FLAC__SeekableStreamDecoder *decoder)
450 FLAC__ASSERT(0 != decoder);
451 FLAC__ASSERT(0 != decoder->private_);
452 return FLAC__stream_decoder_get_state(decoder->private_->stream_decoder);
455 FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking(const FLAC__SeekableStreamDecoder *decoder)
457 FLAC__ASSERT(0 != decoder);
458 FLAC__ASSERT(0 != decoder->protected_);
459 return decoder->protected_->md5_checking;
462 unsigned FLAC__seekable_stream_decoder_get_channels(const FLAC__SeekableStreamDecoder *decoder)
464 FLAC__ASSERT(0 != decoder);
465 FLAC__ASSERT(0 != decoder->private_);
466 return FLAC__stream_decoder_get_channels(decoder->private_->stream_decoder);
469 FLAC__ChannelAssignment FLAC__seekable_stream_decoder_get_channel_assignment(const FLAC__SeekableStreamDecoder *decoder)
471 FLAC__ASSERT(0 != decoder);
472 FLAC__ASSERT(0 != decoder->private_);
473 return FLAC__stream_decoder_get_channel_assignment(decoder->private_->stream_decoder);
476 unsigned FLAC__seekable_stream_decoder_get_bits_per_sample(const FLAC__SeekableStreamDecoder *decoder)
478 FLAC__ASSERT(0 != decoder);
479 FLAC__ASSERT(0 != decoder->private_);
480 return FLAC__stream_decoder_get_bits_per_sample(decoder->private_->stream_decoder);
483 unsigned FLAC__seekable_stream_decoder_get_sample_rate(const FLAC__SeekableStreamDecoder *decoder)
485 FLAC__ASSERT(0 != decoder);
486 FLAC__ASSERT(0 != decoder->private_);
487 return FLAC__stream_decoder_get_sample_rate(decoder->private_->stream_decoder);
490 unsigned FLAC__seekable_stream_decoder_get_blocksize(const FLAC__SeekableStreamDecoder *decoder)
492 FLAC__ASSERT(0 != decoder);
493 FLAC__ASSERT(0 != decoder->private_);
494 return FLAC__stream_decoder_get_blocksize(decoder->private_->stream_decoder);
497 FLAC__bool FLAC__seekable_stream_decoder_flush(FLAC__SeekableStreamDecoder *decoder)
499 FLAC__ASSERT(0 != decoder);
500 FLAC__ASSERT(0 != decoder->private_);
501 FLAC__ASSERT(0 != decoder->protected_);
503 decoder->private_->do_md5_checking = false;
505 if(!FLAC__stream_decoder_flush(decoder->private_->stream_decoder)) {
506 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
510 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
515 FLAC__bool FLAC__seekable_stream_decoder_reset(FLAC__SeekableStreamDecoder *decoder)
517 FLAC__ASSERT(0 != decoder);
518 FLAC__ASSERT(0 != decoder->private_);
519 FLAC__ASSERT(0 != decoder->protected_);
521 if(!FLAC__seekable_stream_decoder_flush(decoder)) {
522 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
526 if(!FLAC__stream_decoder_reset(decoder->private_->stream_decoder)) {
527 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
531 decoder->private_->seek_table = 0;
533 decoder->private_->do_md5_checking = decoder->protected_->md5_checking;
535 /* We initialize the MD5Context even though we may never use it. This is
536 * because md5 checking may be turned on to start and then turned off if a
537 * seek occurs. So we always init the context here and finalize it in
538 * FLAC__seekable_stream_decoder_finish() to make sure things are always
539 * cleaned up properly.
541 MD5Init(&decoder->private_->md5context);
543 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
548 FLAC__bool FLAC__seekable_stream_decoder_process_single(FLAC__SeekableStreamDecoder *decoder)
551 FLAC__ASSERT(0 != decoder);
553 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
554 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
556 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
559 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
561 ret = FLAC__stream_decoder_process_single(decoder->private_->stream_decoder);
563 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
568 FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_metadata(FLAC__SeekableStreamDecoder *decoder)
571 FLAC__ASSERT(0 != decoder);
573 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
574 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
576 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
579 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
581 ret = FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->stream_decoder);
583 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
588 FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_stream(FLAC__SeekableStreamDecoder *decoder)
591 FLAC__ASSERT(0 != decoder);
593 if(decoder->private_->stream_decoder->protected_->state == FLAC__STREAM_DECODER_END_OF_STREAM)
594 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
596 if(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM)
599 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK);
601 ret = FLAC__stream_decoder_process_until_end_of_stream(decoder->private_->stream_decoder);
603 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
608 FLAC__bool FLAC__seekable_stream_decoder_seek_absolute(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 sample)
612 FLAC__ASSERT(0 != decoder);
613 FLAC__ASSERT(decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_OK || decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM);
615 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEKING;
617 /* turn off md5 checking if a seek is attempted */
618 decoder->private_->do_md5_checking = false;
620 if(!FLAC__stream_decoder_reset(decoder->private_->stream_decoder)) {
621 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
624 /* get the file length */
625 if(decoder->private_->length_callback(decoder, &length, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK) {
626 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
630 if(decoder->private_->seek_callback(decoder, 0, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK) {
631 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
634 if(!FLAC__stream_decoder_process_until_end_of_metadata(decoder->private_->stream_decoder)) {
635 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
638 if(decoder->private_->stream_info.total_samples > 0 && sample > decoder->private_->stream_info.total_samples) {
639 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
643 return seek_to_absolute_sample_(decoder, length, sample);
646 /***********************************************************************
648 * Private class methods
650 ***********************************************************************/
652 void set_defaults_(FLAC__SeekableStreamDecoder *decoder)
654 decoder->private_->read_callback = 0;
655 decoder->private_->seek_callback = 0;
656 decoder->private_->tell_callback = 0;
657 decoder->private_->length_callback = 0;
658 decoder->private_->eof_callback = 0;
659 decoder->private_->write_callback = 0;
660 decoder->private_->metadata_callback = 0;
661 decoder->private_->error_callback = 0;
662 decoder->private_->client_data = 0;
663 /* WATCHOUT: these should match the default behavior of FLAC__StreamDecoder */
664 decoder->private_->ignore_stream_info_block = false;
665 decoder->private_->ignore_seek_table_block = true;
667 decoder->protected_->md5_checking = false;
670 FLAC__StreamDecoderReadStatus read_callback_(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)
672 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
674 if(seekable_stream_decoder->private_->eof_callback(seekable_stream_decoder, seekable_stream_decoder->private_->client_data)) {
675 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
676 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
678 else if(*bytes > 0) {
679 unsigned bytes_read = *bytes;
680 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) {
681 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR;
682 return FLAC__STREAM_DECODER_READ_STATUS_ABORT;
684 if(bytes_read == 0) {
685 if(seekable_stream_decoder->private_->eof_callback(seekable_stream_decoder, seekable_stream_decoder->private_->client_data)) {
686 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM;
687 return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM;
690 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
694 return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE;
698 return FLAC__STREAM_DECODER_READ_STATUS_ABORT; /* abort to avoid a deadlock */
701 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
703 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
706 if(seekable_stream_decoder->protected_->state == FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
707 FLAC__uint64 this_frame_sample = frame->header.number.sample_number;
708 FLAC__uint64 next_frame_sample = this_frame_sample + (FLAC__uint64)frame->header.blocksize;
709 FLAC__uint64 target_sample = seekable_stream_decoder->private_->target_sample;
711 FLAC__ASSERT(frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
713 seekable_stream_decoder->private_->last_frame = *frame; /* save the frame */
714 if(this_frame_sample <= target_sample && target_sample < next_frame_sample) { /* we hit our target frame */
715 unsigned delta = (unsigned)(target_sample - this_frame_sample);
716 /* kick out of seek mode */
717 seekable_stream_decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_OK;
718 /* shift out the samples before target_sample */
721 const FLAC__int32 *newbuffer[FLAC__MAX_CHANNELS];
722 for(channel = 0; channel < frame->header.channels; channel++)
723 newbuffer[channel] = buffer[channel] + delta;
724 seekable_stream_decoder->private_->last_frame.header.blocksize -= delta;
725 seekable_stream_decoder->private_->last_frame.header.number.sample_number += (FLAC__uint64)delta;
726 /* write the relevant samples */
727 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, &seekable_stream_decoder->private_->last_frame, newbuffer, seekable_stream_decoder->private_->client_data);
730 /* write the relevant samples */
731 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, frame, buffer, seekable_stream_decoder->private_->client_data);
735 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
739 if(seekable_stream_decoder->private_->do_md5_checking) {
740 if(!FLAC__MD5Accumulate(&seekable_stream_decoder->private_->md5context, buffer, frame->header.channels, frame->header.blocksize, (frame->header.bits_per_sample+7) / 8))
741 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
743 return seekable_stream_decoder->private_->write_callback(seekable_stream_decoder, frame, buffer, seekable_stream_decoder->private_->client_data);
747 void metadata_callback_(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
749 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
752 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
753 seekable_stream_decoder->private_->stream_info = metadata->data.stream_info;
754 /* save the MD5 signature for comparison later */
755 memcpy(seekable_stream_decoder->private_->stored_md5sum, metadata->data.stream_info.md5sum, 16);
756 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))
757 seekable_stream_decoder->private_->do_md5_checking = false;
759 else if(metadata->type == FLAC__METADATA_TYPE_SEEKTABLE) {
760 seekable_stream_decoder->private_->seek_table = &metadata->data.seek_table;
763 if(seekable_stream_decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
764 FLAC__bool ignore_block = false;
765 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO && seekable_stream_decoder->private_->ignore_stream_info_block)
767 else if(metadata->type == FLAC__METADATA_TYPE_SEEKTABLE && seekable_stream_decoder->private_->ignore_seek_table_block)
770 seekable_stream_decoder->private_->metadata_callback(seekable_stream_decoder, metadata, seekable_stream_decoder->private_->client_data);
774 void error_callback_(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
776 FLAC__SeekableStreamDecoder *seekable_stream_decoder = (FLAC__SeekableStreamDecoder *)client_data;
779 if(seekable_stream_decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING)
780 seekable_stream_decoder->private_->error_callback(seekable_stream_decoder, status, seekable_stream_decoder->private_->client_data);
783 FLAC__bool seek_to_absolute_sample_(FLAC__SeekableStreamDecoder *decoder, FLAC__uint64 stream_length, FLAC__uint64 target_sample)
785 FLAC__uint64 first_frame_offset, lower_bound, upper_bound;
786 FLAC__int64 pos = -1, last_pos = -1;
787 int i, lower_seek_point = -1, upper_seek_point = -1;
788 unsigned approx_bytes_per_frame;
789 FLAC__uint64 last_frame_sample = 0xffffffffffffffff;
790 FLAC__bool needs_seek;
791 const FLAC__uint64 total_samples = decoder->private_->stream_info.total_samples;
792 const unsigned min_blocksize = decoder->private_->stream_info.min_blocksize;
793 const unsigned max_blocksize = decoder->private_->stream_info.max_blocksize;
794 const unsigned max_framesize = decoder->private_->stream_info.max_framesize;
795 const unsigned channels = FLAC__seekable_stream_decoder_get_channels(decoder);
796 const unsigned bps = FLAC__seekable_stream_decoder_get_bits_per_sample(decoder);
798 /* we are just guessing here, but we want to guess high, not low */
799 if(max_framesize > 0) {
800 approx_bytes_per_frame = max_framesize;
803 * Check if it's a known fixed-blocksize stream. Note that though
804 * the spec doesn't allow zeroes in the STREAMINFO block, we may
805 * never get a STREAMINFO block when decoding so the value of
806 * min_blocksize might be zero.
808 else if(min_blocksize == max_blocksize && min_blocksize > 0) {
809 /* note there are no () around 'bps/8' to keep precision up since it's an integer calulation */
810 approx_bytes_per_frame = min_blocksize * channels * bps/8 + 64;
813 approx_bytes_per_frame = 4608 * channels * bps/8 + 64;
816 * The stream position is currently at the first frame plus any read
817 * ahead data, so first we get the stream position, then subtract
818 * uncomsumed bytes to get the position of the first frame in the
821 if(decoder->private_->tell_callback(decoder, &first_frame_offset, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK) {
822 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
825 FLAC__ASSERT(first_frame_offset >= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder));
826 first_frame_offset -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder);
829 * First, we set an upper and lower bound on where in the
830 * stream we will search. For now we assume the worst case
831 * scenario, which is our best guess at the beginning of
832 * the first and last frames.
834 lower_bound = first_frame_offset;
836 /* calc the upper_bound, beyond which we never want to seek */
837 if(max_framesize > 0)
838 upper_bound = stream_length - (max_framesize + 128 + 2); /* 128 for a possible ID3V1 tag, 2 for indexing differences */
840 upper_bound = stream_length - ((channels * bps * FLAC__MAX_BLOCK_SIZE) / 8 + 128 + 2);
843 * Now we refine the bounds if we have a seektable with
844 * suitable points. Note that according to the spec they
845 * must be ordered by ascending sample number.
847 if(0 != decoder->private_->seek_table) {
848 /* find the closest seek point <= target_sample, if it exists */
849 for(i = (int)decoder->private_->seek_table->num_points - 1; i >= 0; i--) {
850 if(decoder->private_->seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER && decoder->private_->seek_table->points[i].sample_number <= target_sample)
853 if(i >= 0) { /* i.e. we found a suitable seek point... */
854 lower_bound = first_frame_offset + decoder->private_->seek_table->points[i].stream_offset;
855 lower_seek_point = i;
858 /* find the closest seek point > target_sample, if it exists */
859 for(i = 0; i < (int)decoder->private_->seek_table->num_points; i++) {
860 if(decoder->private_->seek_table->points[i].sample_number != FLAC__STREAM_METADATA_SEEKPOINT_PLACEHOLDER && decoder->private_->seek_table->points[i].sample_number > target_sample)
863 if(i < (int)decoder->private_->seek_table->num_points) { /* i.e. we found a suitable seek point... */
864 upper_bound = first_frame_offset + decoder->private_->seek_table->points[i].stream_offset;
865 upper_seek_point = i;
870 * Now guess at where within those bounds our target
873 if(lower_seek_point >= 0) {
874 /* first see if our sample is within a few frames of the lower seekpoint */
875 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)) {
876 pos = (FLAC__int64)lower_bound;
878 else if(upper_seek_point >= 0) {
879 const FLAC__uint64 target_offset = target_sample - decoder->private_->seek_table->points[lower_seek_point].sample_number;
880 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;
881 const FLAC__uint64 range_bytes = upper_bound - lower_bound;
882 #if defined _MSC_VER || defined __MINGW32__
883 /* with VC++ you have to spoon feed it the casting */
884 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;
886 pos = (FLAC__int64)lower_bound + (FLAC__int64)((double)target_offset / (double)range_samples * (double)(range_bytes-1)) - approx_bytes_per_frame;
892 * If there's no seek table, we need to use the metadata (if we
893 * have it) and the filelength to estimate the position of the
894 * frame with the correct sample.
896 if(pos < 0 && total_samples > 0) {
897 #if defined _MSC_VER || defined __MINGW32__
898 /* with VC++ you have to spoon feed it the casting */
899 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;
901 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;
906 * If there's no seek table and total_samples is unknown, we
907 * don't even bother trying to figure out a target, we just use
908 * our current position.
912 if(decoder->private_->tell_callback(decoder, &upos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK) {
913 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
916 pos = (FLAC__int32)upos;
922 /* clip the position to the bounds, lower bound takes precedence */
923 if(pos >= (FLAC__int64)upper_bound) {
924 pos = (FLAC__int64)upper_bound-1;
927 if(pos < (FLAC__int64)lower_bound) {
928 pos = (FLAC__int64)lower_bound;
932 decoder->private_->target_sample = target_sample;
935 if(decoder->private_->seek_callback(decoder, (FLAC__uint64)pos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK) {
936 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
939 if(!FLAC__stream_decoder_flush(decoder->private_->stream_decoder)) {
940 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR;
944 if(!FLAC__stream_decoder_process_single(decoder->private_->stream_decoder)) {
945 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
948 /* our write callback will change the state when it gets to the target frame */
949 if(decoder->protected_->state != FLAC__SEEKABLE_STREAM_DECODER_SEEKING) {
952 else { /* we need to narrow the search */
953 FLAC__uint64 this_frame_sample = decoder->private_->last_frame.header.number.sample_number;
954 FLAC__ASSERT(decoder->private_->last_frame.header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER);
955 if(this_frame_sample == last_frame_sample) {
956 /* our last move backwards wasn't big enough */
957 pos -= (last_pos - pos);
961 if(target_sample < this_frame_sample) {
963 approx_bytes_per_frame = decoder->private_->last_frame.header.blocksize * channels * bps/8 + 64;
964 pos -= approx_bytes_per_frame;
967 else { /* target_sample >= this_frame_sample + this frame's blocksize */
969 if(decoder->private_->tell_callback(decoder, &upos, decoder->private_->client_data) != FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK) {
970 decoder->protected_->state = FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR;
974 pos = (FLAC__int32)upos;
975 pos -= FLAC__stream_decoder_get_input_bytes_unconsumed(decoder->private_->stream_decoder);
979 if(pos < (FLAC__int64)lower_bound)
980 pos = (FLAC__int64)lower_bound;
981 last_frame_sample = this_frame_sample;