1 /* test_seeking - Seeking tester for libFLAC and libOggFLAC
2 * Copyright (C) 2004,2005 Josh Coalson
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program 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
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #if defined _MSC_VER || defined __MINGW32__
32 #include <sys/stat.h> /* for stat() */
33 #include "FLAC/assert.h"
34 #include "FLAC/file_decoder.h"
36 #include "OggFLAC/file_decoder.h"
41 FLAC__uint64 total_samples;
43 unsigned bits_per_sample;
44 FLAC__bool ignore_errors;
45 FLAC__bool error_occurred;
46 } decoder_client_data_struct;
48 static FLAC__bool stop_signal_ = false;
50 static void our_sigint_handler_(int signal)
53 printf("(caught SIGINT) ");
58 static FLAC__bool die_(const char *msg)
60 printf("ERROR: %s\n", msg);
64 static FLAC__bool die_f_(const char *msg, const FLAC__FileDecoder *decoder)
66 FLAC__FileDecoderState state = FLAC__file_decoder_get_state(decoder);
69 printf("FAILED, %s", msg);
73 printf(", state = %u (%s)\n", (unsigned)state, FLAC__FileDecoderStateString[state]);
74 if(state == FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR) {
75 FLAC__SeekableStreamDecoderState state_ = FLAC__file_decoder_get_seekable_stream_decoder_state(decoder);
76 printf(" seekable stream decoder state = %u (%s)\n", (unsigned)state, FLAC__SeekableStreamDecoderStateString[state_]);
77 if(state_ == FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR) {
78 FLAC__StreamDecoderState state__ = FLAC__file_decoder_get_stream_decoder_state(decoder);
79 printf(" stream decoder state = %u (%s)\n", (unsigned)state__, FLAC__StreamDecoderStateString[state__]);
87 static FLAC__bool die_of_(const char *msg, const OggFLAC__FileDecoder *decoder)
89 OggFLAC__FileDecoderState state = OggFLAC__file_decoder_get_state(decoder);
92 printf("FAILED, %s", msg);
96 printf(", state = %u (%s)\n", (unsigned)state, OggFLAC__SeekableStreamDecoderStateString[state]);
97 if(state == OggFLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR) {
98 OggFLAC__SeekableStreamDecoderState state_ = OggFLAC__file_decoder_get_seekable_stream_decoder_state(decoder);
99 printf(" seekable stream decoder state = %u (%s)\n", (unsigned)state_, OggFLAC__SeekableStreamDecoderStateString[state_]);
100 if(state_ == OggFLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR) {
101 OggFLAC__StreamDecoderState state__ = OggFLAC__file_decoder_get_stream_decoder_state(decoder);
102 printf(" stream decoder state = %u (%s)\n", (unsigned)state__, OggFLAC__StreamDecoderStateString[state__]);
103 if(state__ == OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR) {
104 FLAC__StreamDecoderState state___ = OggFLAC__file_decoder_get_FLAC_stream_decoder_state(decoder);
105 printf(" FLAC stream decoder state = %u (%s)\n", (unsigned)state___, FLAC__StreamDecoderStateString[state___]);
114 static off_t get_filesize_(const char *srcpath)
118 if(0 == stat(srcpath, &srcstat))
119 return srcstat.st_size;
124 static FLAC__StreamDecoderWriteStatus file_decoder_write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
126 decoder_client_data_struct *dcd = (decoder_client_data_struct*)client_data;
128 (void)decoder, (void)buffer;
131 printf("ERROR: client_data in write callback is NULL\n");
132 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
135 if(dcd->error_occurred)
136 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
138 if (frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_FRAME_NUMBER)
139 printf("frame@%uf(%u)... ", frame->header.number.frame_number, frame->header.blocksize);
140 else if (frame->header.number_type == FLAC__FRAME_NUMBER_TYPE_SAMPLE_NUMBER)
141 printf("frame@%llu(%u)... ", frame->header.number.sample_number, frame->header.blocksize);
144 dcd->error_occurred = true;
145 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
149 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
152 static void file_decoder_metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
154 decoder_client_data_struct *dcd = (decoder_client_data_struct*)client_data;
159 printf("ERROR: client_data in metadata callback is NULL\n");
163 if(dcd->error_occurred)
166 if (!dcd->got_data && metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
167 dcd->got_data = true;
168 dcd->total_samples = metadata->data.stream_info.total_samples;
169 dcd->channels = metadata->data.stream_info.channels;
170 dcd->bits_per_sample = metadata->data.stream_info.bits_per_sample;
174 static void file_decoder_error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
176 decoder_client_data_struct *dcd = (decoder_client_data_struct*)client_data;
181 printf("ERROR: client_data in error callback is NULL\n");
185 if(!dcd->ignore_errors) {
186 printf("ERROR: got error callback: err = %u (%s)\n", (unsigned)status, FLAC__StreamDecoderErrorStatusString[status]);
187 dcd->error_occurred = true;
191 static FLAC__bool seek_barrage_native_flac(const char *filename, off_t filesize, unsigned count)
193 FLAC__FileDecoder *decoder;
194 decoder_client_data_struct decoder_client_data;
198 decoder_client_data.got_data = false;
199 decoder_client_data.total_samples = 0;
200 decoder_client_data.ignore_errors = false;
201 decoder_client_data.error_occurred = false;
203 printf("\n+++ seek test: FLAC__FileDecoder\n\n");
205 decoder = FLAC__file_decoder_new();
207 return die_("FLAC__file_decoder_new() FAILED, returned NULL\n");
209 if(!FLAC__file_decoder_set_write_callback(decoder, file_decoder_write_callback_))
210 return die_f_("FLAC__file_decoder_set_write_callback() FAILED", decoder);
212 if(!FLAC__file_decoder_set_metadata_callback(decoder, file_decoder_metadata_callback_))
213 return die_f_("FLAC__file_decoder_set_metadata_callback() FAILED", decoder);
215 if(!FLAC__file_decoder_set_error_callback(decoder, file_decoder_error_callback_))
216 return die_f_("FLAC__file_decoder_set_error_callback() FAILED", decoder);
218 if(!FLAC__file_decoder_set_client_data(decoder, &decoder_client_data))
219 return die_f_("FLAC__file_decoder_set_client_data() FAILED", decoder);
221 if(!FLAC__file_decoder_set_filename(decoder, filename))
222 return die_f_("FLAC__file_decoder_set_filename() FAILED", decoder);
224 if(FLAC__file_decoder_init(decoder) != FLAC__FILE_DECODER_OK)
225 return die_f_("FLAC__file_decoder_init() FAILED", decoder);
227 if(!FLAC__file_decoder_process_until_end_of_metadata(decoder))
228 return die_f_("FLAC__file_decoder_process_until_end_of_metadata() FAILED", decoder);
230 printf("file's total_samples is %llu\n", decoder_client_data.total_samples);
231 if (decoder_client_data.total_samples > (FLAC__uint64)RAND_MAX) {
232 printf("ERROR: must be total_samples < %u\n", (unsigned)RAND_MAX);
235 n = (long int)decoder_client_data.total_samples;
237 /* if we don't have a total samples count, just guess based on the file size */
238 /* @@@ should get it from last page's granulepos */
240 /* 8 would imply no compression, 9 guarantees that we will get some samples off the end of the stream to test that case */
241 n = 9 * filesize / (decoder_client_data.channels * decoder_client_data.bits_per_sample);
246 printf("Begin seek barrage, count=%u\n", count);
248 for (i = 0; !stop_signal_ && (count == 0 || i < count); i++) {
251 /* for the first 10, seek to the first 10 samples */
252 if (n >= 10 && i < 10) {
255 /* for the second 10, seek to the last 10 samples */
256 else if (n >= 10 && i < 20) {
257 pos = n - 1 - (i-10);
259 /* for the third 10, seek past the end and make sure we fail properly as expected */
264 #if !defined _MSC_VER && !defined __MINGW32__
265 pos = (FLAC__uint64)(random() % n);
267 pos = (FLAC__uint64)(rand() % n);
271 printf("seek(%llu)... ", pos);
273 if(!FLAC__file_decoder_seek_absolute(decoder, pos)) {
274 if(pos < (FLAC__uint64)n && decoder_client_data.total_samples != 0)
275 return die_f_("FLAC__file_decoder_seek_absolute() FAILED", decoder);
276 else if(decoder_client_data.total_samples == 0)
277 printf("seek failed, assuming it was past EOF... ");
279 printf("seek past end failed as expected... ");
281 /* hack to work around a deficiency in the seek API's behavior */
282 /* seeking past EOF sets the file decoder state to non-OK and there's no ..._flush() or ..._reset() call to reset it */
283 if(!FLAC__file_decoder_finish(decoder))
284 return die_f_("FLAC__file_decoder_finish() FAILED", decoder);
286 if(!FLAC__file_decoder_set_write_callback(decoder, file_decoder_write_callback_))
287 return die_f_("FLAC__file_decoder_set_write_callback() FAILED", decoder);
289 if(!FLAC__file_decoder_set_metadata_callback(decoder, file_decoder_metadata_callback_))
290 return die_f_("FLAC__file_decoder_set_metadata_callback() FAILED", decoder);
292 if(!FLAC__file_decoder_set_error_callback(decoder, file_decoder_error_callback_))
293 return die_f_("FLAC__file_decoder_set_error_callback() FAILED", decoder);
295 if(!FLAC__file_decoder_set_client_data(decoder, &decoder_client_data))
296 return die_f_("FLAC__file_decoder_set_client_data() FAILED", decoder);
298 if(!FLAC__file_decoder_set_filename(decoder, filename))
299 return die_f_("FLAC__file_decoder_set_filename() FAILED", decoder);
301 if(FLAC__file_decoder_init(decoder) != FLAC__FILE_DECODER_OK)
302 return die_f_("FLAC__file_decoder_init() FAILED", decoder);
304 if(!FLAC__file_decoder_process_until_end_of_metadata(decoder))
305 return die_f_("FLAC__file_decoder_process_until_end_of_metadata() FAILED", decoder);
308 printf("decode_frame... ");
310 if(!FLAC__file_decoder_process_single(decoder))
311 return die_f_("FLAC__file_decoder_process_single() FAILED", decoder);
313 printf("decode_frame... ");
315 if(!FLAC__file_decoder_process_single(decoder))
316 return die_f_("FLAC__file_decoder_process_single() FAILED", decoder);
323 if(FLAC__file_decoder_get_state(decoder) != FLAC__FILE_DECODER_UNINITIALIZED) {
324 if(!FLAC__file_decoder_finish(decoder))
325 return die_f_("FLAC__file_decoder_finish() FAILED", decoder);
328 printf("\nPASSED!\n");
334 static FLAC__bool seek_barrage_ogg_flac(const char *filename, off_t filesize, unsigned count)
336 OggFLAC__FileDecoder *decoder;
337 decoder_client_data_struct decoder_client_data;
341 decoder_client_data.got_data = false;
342 decoder_client_data.total_samples = 0;
343 decoder_client_data.ignore_errors = false;
344 decoder_client_data.error_occurred = false;
346 printf("\n+++ seek test: OggFLAC__FileDecoder\n\n");
348 decoder = OggFLAC__file_decoder_new();
350 return die_("OggFLAC__file_decoder_new() FAILED, returned NULL\n");
352 if(!OggFLAC__file_decoder_set_write_callback(decoder, (OggFLAC__FileDecoderWriteCallback)file_decoder_write_callback_))
353 return die_of_("OggFLAC__file_decoder_set_write_callback() FAILED", decoder);
355 if(!OggFLAC__file_decoder_set_metadata_callback(decoder, (OggFLAC__FileDecoderMetadataCallback)file_decoder_metadata_callback_))
356 return die_of_("OggFLAC__file_decoder_set_metadata_callback() FAILED", decoder);
358 if(!OggFLAC__file_decoder_set_error_callback(decoder, (OggFLAC__FileDecoderErrorCallback)file_decoder_error_callback_))
359 return die_of_("OggFLAC__file_decoder_set_error_callback() FAILED", decoder);
361 if(!OggFLAC__file_decoder_set_client_data(decoder, &decoder_client_data))
362 return die_of_("OggFLAC__file_decoder_set_client_data() FAILED", decoder);
364 if(!OggFLAC__file_decoder_set_filename(decoder, filename))
365 return die_of_("OggFLAC__file_decoder_set_filename() FAILED", decoder);
367 if(OggFLAC__file_decoder_init(decoder) != OggFLAC__FILE_DECODER_OK)
368 return die_of_("OggFLAC__file_decoder_init() FAILED", decoder);
370 if(!OggFLAC__file_decoder_process_until_end_of_metadata(decoder))
371 return die_of_("OggFLAC__file_decoder_process_until_end_of_metadata() FAILED", decoder);
373 printf("file's total_samples is %llu\n", decoder_client_data.total_samples);
374 if (decoder_client_data.total_samples > (FLAC__uint64)RAND_MAX) {
375 printf("ERROR: must be total_samples < %u\n", (unsigned)RAND_MAX);
378 n = (long int)decoder_client_data.total_samples;
380 /* if we don't have a total samples count, just guess based on the file size */
382 /* 8 would imply no compression, 9 guarantees that we will get some samples off the end of the stream to test that case */
383 n = 9 * filesize / (decoder_client_data.channels * decoder_client_data.bits_per_sample);
388 printf("Begin seek barrage, count=%u\n", count);
390 for (i = 0; !stop_signal_ && (count == 0 || i < count); i++) {
393 /* for the first 10, seek to the first 10 samples */
394 if (n >= 10 && i < 10) {
397 /* for the second 10, seek to the last 10 samples */
398 else if (n >= 10 && i < 20) {
399 pos = n - 1 - (i-10);
401 /* for the third 10, seek past the end and make sure we fail properly as expected */
406 #if !defined _MSC_VER && !defined __MINGW32__
407 pos = (FLAC__uint64)(random() % n);
409 pos = (FLAC__uint64)(rand() % n);
413 printf("seek(%llu)... ", pos);
415 if(!OggFLAC__file_decoder_seek_absolute(decoder, pos)) {
416 if(pos < (FLAC__uint64)n && decoder_client_data.total_samples != 0)
417 return die_of_("OggFLAC__file_decoder_seek_absolute() FAILED", decoder);
418 else if(decoder_client_data.total_samples == 0)
419 printf("seek failed, assuming it was past EOF... ");
421 printf("seek past end failed as expected... ");
422 /* hack to work around a deficiency in the seek API's behavior */
423 /* seeking past EOF sets the file decoder state to non-OK and there's no ..._flush() or ..._reset() call to reset it */
424 if(!OggFLAC__file_decoder_finish(decoder))
425 return die_of_("OggFLAC__file_decoder_finish() FAILED", decoder);
427 if(!OggFLAC__file_decoder_set_write_callback(decoder, (OggFLAC__FileDecoderWriteCallback)file_decoder_write_callback_))
428 return die_of_("OggFLAC__file_decoder_set_write_callback() FAILED", decoder);
430 if(!OggFLAC__file_decoder_set_metadata_callback(decoder, (OggFLAC__FileDecoderMetadataCallback)file_decoder_metadata_callback_))
431 return die_of_("OggFLAC__file_decoder_set_metadata_callback() FAILED", decoder);
433 if(!OggFLAC__file_decoder_set_error_callback(decoder, (OggFLAC__FileDecoderErrorCallback)file_decoder_error_callback_))
434 return die_of_("OggFLAC__file_decoder_set_error_callback() FAILED", decoder);
436 if(!OggFLAC__file_decoder_set_client_data(decoder, &decoder_client_data))
437 return die_of_("OggFLAC__file_decoder_set_client_data() FAILED", decoder);
439 if(!OggFLAC__file_decoder_set_filename(decoder, filename))
440 return die_of_("OggFLAC__file_decoder_set_filename() FAILED", decoder);
442 if(OggFLAC__file_decoder_init(decoder) != OggFLAC__FILE_DECODER_OK)
443 return die_of_("OggFLAC__file_decoder_init() FAILED", decoder);
445 if(!OggFLAC__file_decoder_process_until_end_of_metadata(decoder))
446 return die_of_("OggFLAC__file_decoder_process_until_end_of_metadata() FAILED", decoder);
449 printf("decode_frame... ");
451 if(!OggFLAC__file_decoder_process_single(decoder))
452 return die_of_("OggFLAC__file_decoder_process_single() FAILED", decoder);
454 printf("decode_frame... ");
456 if(!OggFLAC__file_decoder_process_single(decoder))
457 return die_of_("OggFLAC__file_decoder_process_single() FAILED", decoder);
464 if(OggFLAC__file_decoder_get_state(decoder) != OggFLAC__FILE_DECODER_UNINITIALIZED) {
465 if(!OggFLAC__file_decoder_finish(decoder))
466 return die_of_("OggFLAC__file_decoder_finish() FAILED", decoder);
469 printf("\nPASSED!\n");
475 int main(int argc, char *argv[])
477 const char *filename;
481 static const char * const usage = "usage: test_seeking file.flac [#seeks]\n";
483 if (argc < 1 || argc > 3) {
484 fprintf(stderr, usage);
491 count = strtoul(argv[2], 0, 10);
494 fprintf(stderr, "WARNING: random seeks don't kick in until after 30 preprogrammed ones\n");
496 #if !defined _MSC_VER && !defined __MINGW32__
500 if (gettimeofday(&tv, 0) < 0) {
501 fprintf(stderr, "WARNING: couldn't seed RNG with time\n");
510 filesize = get_filesize_(filename);
512 fprintf(stderr, "ERROR: can't determine filesize for %s\n", filename);
516 (void) signal(SIGINT, our_sigint_handler_);
520 if (strlen(filename) > 4 && 0 == strcmp(filename+strlen(filename)-4, ".ogg")) {
522 ok = seek_barrage_ogg_flac(filename, filesize, count);
524 fprintf(stderr, "ERROR: Ogg FLAC not supported\n");
529 ok = seek_barrage_native_flac(filename, filesize, count);