1 /* test_libFLAC++ - Unit tester for libFLAC++
2 * Copyright (C) 2002-2009 Josh Coalson
3 * Copyright (C) 2011-2023 Xiph.Org Foundation
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include "encoders.h"
25 #include "FLAC/assert.h"
26 #include "FLAC++/encoder.h"
27 #include "share/grabbag.h"
28 extern "C" {
29 #include "test_libs_common/file_utils_flac.h"
30 #include "test_libs_common/metadata_utils.h"
31 }
32 #include <errno.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36 #include "share/compat.h"
37
38 #ifdef _MSC_VER
39 // warning C4800: 'int' : forcing to bool 'true' or 'false' (performance warning)
40 #pragma warning ( disable : 4800 )
41 #endif
42
43 typedef enum {
44 LAYER_STREAM = 0, /* FLAC__stream_encoder_init_stream() without seeking */
45 LAYER_SEEKABLE_STREAM, /* FLAC__stream_encoder_init_stream() with seeking */
46 LAYER_FILE, /* FLAC__stream_encoder_init_FILE() */
47 LAYER_FILENAME /* FLAC__stream_encoder_init_file() */
48 } Layer;
49
50 static const char * const LayerString[] = {
51 "Stream",
52 "Seekable Stream",
53 "FILE*",
54 "Filename"
55 };
56
57 static ::FLAC__StreamMetadata streaminfo_, padding_, seektable_, application1_, application2_, vorbiscomment_, cuesheet_, picture_, unknown_;
58 static ::FLAC__StreamMetadata *metadata_sequence_[] = { &vorbiscomment_, &padding_, &seektable_, &application1_, &application2_, &cuesheet_, &picture_, &unknown_ };
59 static const uint32_t num_metadata_ = sizeof(metadata_sequence_) / sizeof(metadata_sequence_[0]);
60
flacfilename(bool is_ogg)61 static const char *flacfilename(bool is_ogg)
62 {
63 return is_ogg? "metadata.oga" : "metadata.flac";
64 }
65
die_(const char * msg)66 static bool die_(const char *msg)
67 {
68 printf("ERROR: %s\n", msg);
69 return false;
70 }
71
die_s_(const char * msg,const FLAC::Encoder::Stream * encoder)72 static bool die_s_(const char *msg, const FLAC::Encoder::Stream *encoder)
73 {
74 FLAC::Encoder::Stream::State state = encoder->get_state();
75
76 if(msg)
77 printf("FAILED, %s", msg);
78 else
79 printf("FAILED");
80
81 printf(", state = %u (%s)\n", (uint32_t)((::FLAC__StreamEncoderState)state), state.as_cstring());
82 if(state == ::FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR) {
83 FLAC::Decoder::Stream::State dstate = encoder->get_verify_decoder_state();
84 printf(" verify decoder state = %u (%s)\n", (uint32_t)((::FLAC__StreamDecoderState)dstate), dstate.as_cstring());
85 }
86
87 return false;
88 }
89
init_metadata_blocks_()90 static void init_metadata_blocks_()
91 {
92 mutils__init_metadata_blocks(&streaminfo_, &padding_, &seektable_, &application1_, &application2_, &vorbiscomment_, &cuesheet_, &picture_, &unknown_);
93 }
94
free_metadata_blocks_()95 static void free_metadata_blocks_()
96 {
97 mutils__free_metadata_blocks(&streaminfo_, &padding_, &seektable_, &application1_, &application2_, &vorbiscomment_, &cuesheet_, &picture_, &unknown_);
98 }
99
100 class StreamEncoder : public FLAC::Encoder::Stream {
101 public:
102 Layer layer_;
103 FILE *file_;
104
StreamEncoder(Layer layer)105 StreamEncoder(Layer layer): FLAC::Encoder::Stream(), layer_(layer), file_(0) { }
~StreamEncoder()106 ~StreamEncoder() { }
107
108 // from FLAC::Encoder::Stream
109 ::FLAC__StreamEncoderReadStatus read_callback(FLAC__byte buffer[], size_t *bytes);
110 ::FLAC__StreamEncoderWriteStatus write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame);
111 ::FLAC__StreamEncoderSeekStatus seek_callback(FLAC__uint64 absolute_byte_offset);
112 ::FLAC__StreamEncoderTellStatus tell_callback(FLAC__uint64 *absolute_byte_offset);
113 void metadata_callback(const ::FLAC__StreamMetadata *metadata);
114 private:
115 StreamEncoder(const StreamEncoder&);
116 StreamEncoder&operator=(const StreamEncoder&);
117 };
118
read_callback(FLAC__byte buffer[],size_t * bytes)119 ::FLAC__StreamEncoderReadStatus StreamEncoder::read_callback(FLAC__byte buffer[], size_t *bytes)
120 {
121 if(*bytes > 0) {
122 *bytes = fread(buffer, sizeof(FLAC__byte), *bytes, file_);
123 if(ferror(file_))
124 return ::FLAC__STREAM_ENCODER_READ_STATUS_ABORT;
125 else if(*bytes == 0)
126 return ::FLAC__STREAM_ENCODER_READ_STATUS_END_OF_STREAM;
127 else
128 return ::FLAC__STREAM_ENCODER_READ_STATUS_CONTINUE;
129 }
130 else
131 return ::FLAC__STREAM_ENCODER_READ_STATUS_ABORT;
132 }
133
write_callback(const FLAC__byte buffer[],size_t bytes,uint32_t samples,uint32_t current_frame)134 ::FLAC__StreamEncoderWriteStatus StreamEncoder::write_callback(const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame)
135 {
136 (void)samples, (void)current_frame;
137
138 if(fwrite(buffer, 1, bytes, file_) != bytes)
139 return ::FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
140 else
141 return ::FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
142 }
143
seek_callback(FLAC__uint64 absolute_byte_offset)144 ::FLAC__StreamEncoderSeekStatus StreamEncoder::seek_callback(FLAC__uint64 absolute_byte_offset)
145 {
146 if(layer_==LAYER_STREAM)
147 return ::FLAC__STREAM_ENCODER_SEEK_STATUS_UNSUPPORTED;
148 else if(fseeko(file_, (FLAC__off_t)absolute_byte_offset, SEEK_SET) < 0)
149 return FLAC__STREAM_ENCODER_SEEK_STATUS_ERROR;
150 else
151 return FLAC__STREAM_ENCODER_SEEK_STATUS_OK;
152 }
153
tell_callback(FLAC__uint64 * absolute_byte_offset)154 ::FLAC__StreamEncoderTellStatus StreamEncoder::tell_callback(FLAC__uint64 *absolute_byte_offset)
155 {
156 FLAC__off_t pos;
157 if(layer_==LAYER_STREAM)
158 return ::FLAC__STREAM_ENCODER_TELL_STATUS_UNSUPPORTED;
159 else if((pos = ftello(file_)) < 0)
160 return FLAC__STREAM_ENCODER_TELL_STATUS_ERROR;
161 else {
162 *absolute_byte_offset = (FLAC__uint64)pos;
163 return FLAC__STREAM_ENCODER_TELL_STATUS_OK;
164 }
165 }
166
metadata_callback(const::FLAC__StreamMetadata * metadata)167 void StreamEncoder::metadata_callback(const ::FLAC__StreamMetadata *metadata)
168 {
169 (void)metadata;
170 }
171
172 class FileEncoder : public FLAC::Encoder::File {
173 public:
174 Layer layer_;
175
FileEncoder(Layer layer)176 FileEncoder(Layer layer): FLAC::Encoder::File(), layer_(layer) { }
~FileEncoder()177 ~FileEncoder() { }
178
179 // from FLAC::Encoder::File
180 void progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate);
181 };
182
progress_callback(FLAC__uint64 bytes_written,FLAC__uint64 samples_written,uint32_t frames_written,uint32_t total_frames_estimate)183 void FileEncoder::progress_callback(FLAC__uint64 bytes_written, FLAC__uint64 samples_written, uint32_t frames_written, uint32_t total_frames_estimate)
184 {
185 (void)bytes_written, (void)samples_written, (void)frames_written, (void)total_frames_estimate;
186 }
187
new_by_layer(Layer layer)188 static FLAC::Encoder::Stream *new_by_layer(Layer layer)
189 {
190 if(layer < LAYER_FILE)
191 return new StreamEncoder(layer);
192 else
193 return new FileEncoder(layer);
194 }
195
test_stream_encoder(Layer layer,bool is_ogg)196 static bool test_stream_encoder(Layer layer, bool is_ogg)
197 {
198 FLAC::Encoder::Stream *encoder;
199 ::FLAC__StreamEncoderInitStatus init_status;
200 FILE *file = 0;
201 FLAC__int32 samples[1024];
202 FLAC__int32 *samples_array[1] = { samples };
203 uint32_t i;
204
205 printf("\n+++ libFLAC++ unit test: FLAC::Encoder::%s (layer: %s, format: %s)\n\n", layer<LAYER_FILE? "Stream":"File", LayerString[layer], is_ogg? "Ogg FLAC":"FLAC");
206
207 printf("allocating encoder instance... ");
208 encoder = new_by_layer(layer);
209 if(0 == encoder) {
210 printf("FAILED, new returned NULL\n");
211 return false;
212 }
213 printf("OK\n");
214
215 printf("testing is_valid()... ");
216 if(!encoder->is_valid()) {
217 printf("FAILED, returned false\n");
218 delete encoder;
219 return false;
220 }
221 printf("OK\n");
222
223 if(is_ogg) {
224 printf("testing set_ogg_serial_number()... ");
225 if(!encoder->set_ogg_serial_number(file_utils__ogg_serial_number))
226 return die_s_("returned false", encoder);
227 printf("OK\n");
228 }
229
230 printf("testing set_verify()... ");
231 if(!encoder->set_verify(true))
232 return die_s_("returned false", encoder);
233 printf("OK\n");
234
235 printf("testing set_streamable_subset()... ");
236 if(!encoder->set_streamable_subset(true))
237 return die_s_("returned false", encoder);
238 printf("OK\n");
239
240 printf("testing set_channels()... ");
241 if(!encoder->set_channels(streaminfo_.data.stream_info.channels))
242 return die_s_("returned false", encoder);
243 printf("OK\n");
244
245 printf("testing set_bits_per_sample()... ");
246 if(!encoder->set_bits_per_sample(streaminfo_.data.stream_info.bits_per_sample))
247 return die_s_("returned false", encoder);
248 printf("OK\n");
249
250 printf("testing set_sample_rate()... ");
251 if(!encoder->set_sample_rate(streaminfo_.data.stream_info.sample_rate))
252 return die_s_("returned false", encoder);
253 printf("OK\n");
254
255 printf("testing set_compression_level()... ");
256 if(!encoder->set_compression_level((uint32_t)(-1)))
257 return die_s_("returned false", encoder);
258 printf("OK\n");
259
260 printf("testing set_blocksize()... ");
261 if(!encoder->set_blocksize(streaminfo_.data.stream_info.min_blocksize))
262 return die_s_("returned false", encoder);
263 printf("OK\n");
264
265 printf("testing set_do_mid_side_stereo()... ");
266 if(!encoder->set_do_mid_side_stereo(false))
267 return die_s_("returned false", encoder);
268 printf("OK\n");
269
270 printf("testing set_loose_mid_side_stereo()... ");
271 if(!encoder->set_loose_mid_side_stereo(false))
272 return die_s_("returned false", encoder);
273 printf("OK\n");
274
275 printf("testing set_max_lpc_order()... ");
276 if(!encoder->set_max_lpc_order(0))
277 return die_s_("returned false", encoder);
278 printf("OK\n");
279
280 printf("testing set_qlp_coeff_precision()... ");
281 if(!encoder->set_qlp_coeff_precision(0))
282 return die_s_("returned false", encoder);
283 printf("OK\n");
284
285 printf("testing set_do_qlp_coeff_prec_search()... ");
286 if(!encoder->set_do_qlp_coeff_prec_search(false))
287 return die_s_("returned false", encoder);
288 printf("OK\n");
289
290 printf("testing set_do_escape_coding()... ");
291 if(!encoder->set_do_escape_coding(false))
292 return die_s_("returned false", encoder);
293 printf("OK\n");
294
295 printf("testing set_do_exhaustive_model_search()... ");
296 if(!encoder->set_do_exhaustive_model_search(false))
297 return die_s_("returned false", encoder);
298 printf("OK\n");
299
300 printf("testing set_min_residual_partition_order()... ");
301 if(!encoder->set_min_residual_partition_order(0))
302 return die_s_("returned false", encoder);
303 printf("OK\n");
304
305 printf("testing set_max_residual_partition_order()... ");
306 if(!encoder->set_max_residual_partition_order(0))
307 return die_s_("returned false", encoder);
308 printf("OK\n");
309
310 printf("testing set_rice_parameter_search_dist()... ");
311 if(!encoder->set_rice_parameter_search_dist(0))
312 return die_s_("returned false", encoder);
313 printf("OK\n");
314
315 printf("testing set_total_samples_estimate()... ");
316 if(!encoder->set_total_samples_estimate(streaminfo_.data.stream_info.total_samples))
317 return die_s_("returned false", encoder);
318 printf("OK\n");
319
320 printf("testing set_metadata()... ");
321 if(!encoder->set_metadata(metadata_sequence_, num_metadata_))
322 return die_s_("returned false", encoder);
323 printf("OK\n");
324
325 printf("testing set_limit_min_bitrate()... ");
326 if(!encoder->set_limit_min_bitrate(true))
327 return die_s_("returned false", encoder);
328 printf("OK\n");
329
330 if(layer < LAYER_FILENAME) {
331 printf("opening file for FLAC output... ");
332 file = ::flac_fopen(flacfilename(is_ogg), "w+b");
333 if(0 == file) {
334 printf("ERROR (%s)\n", strerror(errno));
335 return false;
336 }
337 printf("OK\n");
338 if(layer < LAYER_FILE)
339 dynamic_cast<StreamEncoder*>(encoder)->file_ = file;
340 }
341
342 switch(layer) {
343 case LAYER_STREAM:
344 case LAYER_SEEKABLE_STREAM:
345 printf("testing init%s()... ", is_ogg? "_ogg":"");
346 init_status = is_ogg? encoder->init_ogg() : encoder->init();
347 break;
348 case LAYER_FILE:
349 printf("testing init%s()... ", is_ogg? "_ogg":"");
350 init_status = is_ogg?
351 dynamic_cast<FLAC::Encoder::File*>(encoder)->init_ogg(file) :
352 dynamic_cast<FLAC::Encoder::File*>(encoder)->init(file);
353 break;
354 case LAYER_FILENAME:
355 printf("testing init%s()... ", is_ogg? "_ogg":"");
356 init_status = is_ogg?
357 dynamic_cast<FLAC::Encoder::File*>(encoder)->init_ogg(flacfilename(is_ogg)) :
358 dynamic_cast<FLAC::Encoder::File*>(encoder)->init(flacfilename(is_ogg));
359 break;
360 default:
361 die_("internal error 001");
362 return false;
363 }
364 if(init_status != ::FLAC__STREAM_ENCODER_INIT_STATUS_OK)
365 return die_s_(0, encoder);
366 printf("OK\n");
367
368 printf("testing get_state()... ");
369 FLAC::Encoder::Stream::State state = encoder->get_state();
370 printf("returned state = %u (%s)... OK\n", (uint32_t)((::FLAC__StreamEncoderState)state), state.as_cstring());
371
372 printf("testing get_verify_decoder_state()... ");
373 FLAC::Decoder::Stream::State dstate = encoder->get_verify_decoder_state();
374 printf("returned state = %u (%s)... OK\n", (uint32_t)((::FLAC__StreamDecoderState)dstate), dstate.as_cstring());
375
376 {
377 FLAC__uint64 absolute_sample;
378 uint32_t frame_number;
379 uint32_t channel;
380 uint32_t sample;
381 FLAC__int32 expected;
382 FLAC__int32 got;
383
384 printf("testing get_verify_decoder_error_stats()... ");
385 encoder->get_verify_decoder_error_stats(&absolute_sample, &frame_number, &channel, &sample, &expected, &got);
386 printf("OK\n");
387 }
388
389 printf("testing get_verify()... ");
390 if(encoder->get_verify() != true) {
391 printf("FAILED, expected true, got false\n");
392 return false;
393 }
394 printf("OK\n");
395
396 printf("testing get_streamable_subset()... ");
397 if(encoder->get_streamable_subset() != true) {
398 printf("FAILED, expected true, got false\n");
399 return false;
400 }
401 printf("OK\n");
402
403 printf("testing get_do_mid_side_stereo()... ");
404 if(encoder->get_do_mid_side_stereo() != false) {
405 printf("FAILED, expected false, got true\n");
406 return false;
407 }
408 printf("OK\n");
409
410 printf("testing get_loose_mid_side_stereo()... ");
411 if(encoder->get_loose_mid_side_stereo() != false) {
412 printf("FAILED, expected false, got true\n");
413 return false;
414 }
415 printf("OK\n");
416
417 printf("testing get_channels()... ");
418 if(encoder->get_channels() != streaminfo_.data.stream_info.channels) {
419 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.channels, encoder->get_channels());
420 return false;
421 }
422 printf("OK\n");
423
424 printf("testing get_bits_per_sample()... ");
425 if(encoder->get_bits_per_sample() != streaminfo_.data.stream_info.bits_per_sample) {
426 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.bits_per_sample, encoder->get_bits_per_sample());
427 return false;
428 }
429 printf("OK\n");
430
431 printf("testing get_sample_rate()... ");
432 if(encoder->get_sample_rate() != streaminfo_.data.stream_info.sample_rate) {
433 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.sample_rate, encoder->get_sample_rate());
434 return false;
435 }
436 printf("OK\n");
437
438 printf("testing get_blocksize()... ");
439 if(encoder->get_blocksize() != streaminfo_.data.stream_info.min_blocksize) {
440 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.min_blocksize, encoder->get_blocksize());
441 return false;
442 }
443 printf("OK\n");
444
445 printf("testing get_max_lpc_order()... ");
446 if(encoder->get_max_lpc_order() != 0) {
447 printf("FAILED, expected %d, got %u\n", 0, encoder->get_max_lpc_order());
448 return false;
449 }
450 printf("OK\n");
451
452 printf("testing get_qlp_coeff_precision()... ");
453 (void)encoder->get_qlp_coeff_precision();
454 /* we asked the encoder to auto select this so we accept anything */
455 printf("OK\n");
456
457 printf("testing get_do_qlp_coeff_prec_search()... ");
458 if(encoder->get_do_qlp_coeff_prec_search() != false) {
459 printf("FAILED, expected false, got true\n");
460 return false;
461 }
462 printf("OK\n");
463
464 printf("testing get_do_escape_coding()... ");
465 if(encoder->get_do_escape_coding() != false) {
466 printf("FAILED, expected false, got true\n");
467 return false;
468 }
469 printf("OK\n");
470
471 printf("testing get_do_exhaustive_model_search()... ");
472 if(encoder->get_do_exhaustive_model_search() != false) {
473 printf("FAILED, expected false, got true\n");
474 return false;
475 }
476 printf("OK\n");
477
478 printf("testing get_min_residual_partition_order()... ");
479 if(encoder->get_min_residual_partition_order() != 0) {
480 printf("FAILED, expected %d, got %u\n", 0, encoder->get_min_residual_partition_order());
481 return false;
482 }
483 printf("OK\n");
484
485 printf("testing get_max_residual_partition_order()... ");
486 if(encoder->get_max_residual_partition_order() != 0) {
487 printf("FAILED, expected %d, got %u\n", 0, encoder->get_max_residual_partition_order());
488 return false;
489 }
490 printf("OK\n");
491
492 printf("testing get_rice_parameter_search_dist()... ");
493 if(encoder->get_rice_parameter_search_dist() != 0) {
494 printf("FAILED, expected %d, got %u\n", 0, encoder->get_rice_parameter_search_dist());
495 return false;
496 }
497 printf("OK\n");
498
499 printf("testing get_total_samples_estimate()... ");
500 if(encoder->get_total_samples_estimate() != streaminfo_.data.stream_info.total_samples) {
501 printf("FAILED, expected %" PRIu64 ", got %" PRIu64 "\n", streaminfo_.data.stream_info.total_samples, encoder->get_total_samples_estimate());
502 return false;
503 }
504 printf("OK\n");
505
506 printf("testing get_limit_min_bitrate()... ");
507 if(encoder->get_limit_min_bitrate() != true) {
508 printf("FAILED, expected true, got false\n");
509 return false;
510 }
511 printf("OK\n");
512
513 /* init the dummy sample buffer */
514 for(i = 0; i < sizeof(samples) / sizeof(FLAC__int32); i++)
515 samples[i] = i & 7;
516
517 printf("testing process()... ");
518 if(!encoder->process(samples_array, sizeof(samples) / sizeof(FLAC__int32)))
519 return die_s_("returned false", encoder);
520 printf("OK\n");
521
522 printf("testing process_interleaved()... ");
523 if(!encoder->process_interleaved(samples, sizeof(samples) / sizeof(FLAC__int32)))
524 return die_s_("returned false", encoder);
525 printf("OK\n");
526
527 printf("testing finish()... ");
528 if(!encoder->finish()) {
529 state = encoder->get_state();
530 printf("FAILED, returned false, state = %u (%s)\n", (uint32_t)((::FLAC__StreamEncoderState)state), state.as_cstring());
531 return false;
532 }
533 printf("OK\n");
534
535 if(layer < LAYER_FILE)
536 ::fclose(dynamic_cast<StreamEncoder*>(encoder)->file_);
537
538 printf("freeing encoder instance... ");
539 delete encoder;
540 printf("OK\n");
541
542 printf("\nPASSED!\n");
543
544 return true;
545 }
546
test_encoders()547 bool test_encoders()
548 {
549 FLAC__bool is_ogg = false;
550
551 while(1) {
552 init_metadata_blocks_();
553
554 if(!test_stream_encoder(LAYER_STREAM, is_ogg))
555 return false;
556
557 if(!test_stream_encoder(LAYER_SEEKABLE_STREAM, is_ogg))
558 return false;
559
560 if(!test_stream_encoder(LAYER_FILE, is_ogg))
561 return false;
562
563 if(!test_stream_encoder(LAYER_FILENAME, is_ogg))
564 return false;
565
566 (void) grabbag__file_remove_file(flacfilename(is_ogg));
567
568 free_metadata_blocks_();
569
570 if(!FLAC_API_SUPPORTS_OGG_FLAC || is_ogg)
571 break;
572 is_ogg = true;
573 }
574
575 return true;
576 }
577