src/test_libFLAC/encoders.c

   1 /* test_libFLAC - Unit tester for libFLAC
   2  * Copyright (C) 2002,2003,2004,2005,2006  Josh Coalson
   3  *
   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.
   8  *
   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.
  13  *
  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.
  17  */
  18
  19 #if HAVE_CONFIG_H
  20 #  include <config.h>
  21 #endif
  22
  23 #include <errno.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include "encoders.h"
  28 #include "FLAC/assert.h"
  29 #include "FLAC/stream_encoder.h"
  30 #include "share/grabbag.h"
  31 #include "test_libs_common/file_utils_flac.h"
  32 #include "test_libs_common/metadata_utils.h"
  33
  34 typedef enum {
  35         LAYER_STREAM = 0, /* FLAC__stream_encoder_init_stream() without seeking */
  36         LAYER_SEEKABLE_STREAM, /* FLAC__stream_encoder_init_stream() with seeking */
  37         LAYER_FILE, /* FLAC__stream_encoder_init_FILE() */
  38         LAYER_FILENAME /* FLAC__stream_encoder_init_file() */
  39 } Layer;
  40
  41 static const char * const LayerString[] = {
  42         "Stream",
  43         "Seekable Stream",
  44         "FILE*",
  45         "Filename"
  46 };
  47
  48 static FLAC__StreamMetadata streaminfo_, padding_, seektable_, application1_, application2_, vorbiscomment_, cuesheet_, unknown_;
  49 static FLAC__StreamMetadata *metadata_sequence_[] = { &padding_, &seektable_, &application1_, &application2_, &vorbiscomment_, &cuesheet_, &unknown_ };
  50 static const unsigned num_metadata_ = sizeof(metadata_sequence_) / sizeof(metadata_sequence_[0]);
  51 static const char *flacfilename_ = "metadata.flac";
  52
  53 static FLAC__bool die_(const char *msg)
  54 {
  55         printf("ERROR: %s\n", msg);
  56         return false;
  57 }
  58
  59 static FLAC__bool die_s_(const char *msg, const FLAC__StreamEncoder *encoder)
  60 {
  61         FLAC__StreamEncoderState state = FLAC__stream_encoder_get_state(encoder);
  62
  63         if(msg)
  64                 printf("FAILED, %s", msg);
  65         else
  66                 printf("FAILED");
  67
  68         printf(", state = %u (%s)\n", (unsigned)state, FLAC__StreamEncoderStateString[state]);
  69         if(state == FLAC__STREAM_ENCODER_VERIFY_DECODER_ERROR) {
  70                 FLAC__StreamDecoderState dstate = FLAC__stream_encoder_get_verify_decoder_state(encoder);
  71                 printf("      verify decoder state = %u (%s)\n", (unsigned)dstate, FLAC__StreamDecoderStateString[dstate]);
  72         }
  73
  74         return false;
  75 }
  76
  77 static void init_metadata_blocks_()
  78 {
  79         mutils__init_metadata_blocks(&streaminfo_, &padding_, &seektable_, &application1_, &application2_, &vorbiscomment_, &cuesheet_, &unknown_);
  80 }
  81
  82 static void free_metadata_blocks_()
  83 {
  84         mutils__free_metadata_blocks(&streaminfo_, &padding_, &seektable_, &application1_, &application2_, &vorbiscomment_, &cuesheet_, &unknown_);
  85 }
  86
  87 static FLAC__StreamEncoderWriteStatus stream_encoder_write_callback_(const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, void *client_data)
  88 {
  89         (void)encoder, (void)buffer, (void)bytes, (void)samples, (void)current_frame, (void)client_data;
  90         return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
  91 }
  92
  93 static FLAC__StreamEncoderSeekStatus stream_encoder_seek_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 absolute_byte_offset, void *client_data)
  94 {
  95         (void)encoder, (void)absolute_byte_offset, (void)client_data;
  96         return FLAC__STREAM_ENCODER_SEEK_STATUS_OK;
  97 }
  98
  99 static FLAC__StreamEncoderTellStatus stream_encoder_tell_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 *absolute_byte_offset, void *client_data)
 100 {
 101         (void)encoder, (void)client_data;
 102         *absolute_byte_offset = 0;
 103         return FLAC__STREAM_ENCODER_TELL_STATUS_OK;
 104 }
 105
 106 static void stream_encoder_metadata_callback_(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data)
 107 {
 108         (void)encoder, (void)metadata, (void)client_data;
 109 }
 110
 111 static void stream_encoder_progress_callback_(const FLAC__StreamEncoder *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data)
 112 {
 113         (void)encoder, (void)bytes_written, (void)samples_written, (void)frames_written, (void)total_frames_estimate, (void)client_data;
 114 }
 115
 116 static FLAC__bool test_stream_encoder(Layer layer)
 117 {
 118         FLAC__StreamEncoder *encoder;
 119         FLAC__StreamEncoderState state;
 120         FLAC__StreamDecoderState dstate;
 121         FILE *file = 0;
 122         FLAC__int32 samples[1024];
 123         FLAC__int32 *samples_array[1];
 124         unsigned i;
 125
 126         samples_array[0] = samples;
 127
 128         printf("\n+++ libFLAC unit test: FLAC__StreamEncoder (layer: %s)\n\n", LayerString[layer]);
 129
 130         printf("testing FLAC__stream_encoder_new()... ");
 131         encoder = FLAC__stream_encoder_new();
 132         if(0 == encoder) {
 133                 printf("FAILED, returned NULL\n");
 134                 return false;
 135         }
 136         printf("OK\n");
 137
 138         printf("testing FLAC__stream_encoder_set_verify()... ");
 139         if(!FLAC__stream_encoder_set_verify(encoder, true))
 140                 return die_s_("returned false", encoder);
 141         printf("OK\n");
 142
 143         printf("testing FLAC__stream_encoder_set_streamable_subset()... ");
 144         if(!FLAC__stream_encoder_set_streamable_subset(encoder, true))
 145                 return die_s_("returned false", encoder);
 146         printf("OK\n");
 147
 148         printf("testing FLAC__stream_encoder_set_do_mid_side_stereo()... ");
 149         if(!FLAC__stream_encoder_set_do_mid_side_stereo(encoder, false))
 150                 return die_s_("returned false", encoder);
 151         printf("OK\n");
 152
 153         printf("testing FLAC__stream_encoder_set_loose_mid_side_stereo()... ");
 154         if(!FLAC__stream_encoder_set_loose_mid_side_stereo(encoder, false))
 155                 return die_s_("returned false", encoder);
 156         printf("OK\n");
 157
 158         printf("testing FLAC__stream_encoder_set_channels()... ");
 159         if(!FLAC__stream_encoder_set_channels(encoder, streaminfo_.data.stream_info.channels))
 160                 return die_s_("returned false", encoder);
 161         printf("OK\n");
 162
 163         printf("testing FLAC__stream_encoder_set_bits_per_sample()... ");
 164         if(!FLAC__stream_encoder_set_bits_per_sample(encoder, streaminfo_.data.stream_info.bits_per_sample))
 165                 return die_s_("returned false", encoder);
 166         printf("OK\n");
 167
 168         printf("testing FLAC__stream_encoder_set_sample_rate()... ");
 169         if(!FLAC__stream_encoder_set_sample_rate(encoder, streaminfo_.data.stream_info.sample_rate))
 170                 return die_s_("returned false", encoder);
 171         printf("OK\n");
 172
 173         printf("testing FLAC__stream_encoder_set_blocksize()... ");
 174         if(!FLAC__stream_encoder_set_blocksize(encoder, streaminfo_.data.stream_info.min_blocksize))
 175                 return die_s_("returned false", encoder);
 176         printf("OK\n");
 177
 178         printf("testing FLAC__stream_encoder_set_max_lpc_order()... ");
 179         if(!FLAC__stream_encoder_set_max_lpc_order(encoder, 0))
 180                 return die_s_("returned false", encoder);
 181         printf("OK\n");
 182
 183         printf("testing FLAC__stream_encoder_set_qlp_coeff_precision()... ");
 184         if(!FLAC__stream_encoder_set_qlp_coeff_precision(encoder, 0))
 185                 return die_s_("returned false", encoder);
 186         printf("OK\n");
 187
 188         printf("testing FLAC__stream_encoder_set_do_qlp_coeff_prec_search()... ");
 189         if(!FLAC__stream_encoder_set_do_qlp_coeff_prec_search(encoder, false))
 190                 return die_s_("returned false", encoder);
 191         printf("OK\n");
 192
 193         printf("testing FLAC__stream_encoder_set_do_escape_coding()... ");
 194         if(!FLAC__stream_encoder_set_do_escape_coding(encoder, false))
 195                 return die_s_("returned false", encoder);
 196         printf("OK\n");
 197
 198         printf("testing FLAC__stream_encoder_set_do_exhaustive_model_search()... ");
 199         if(!FLAC__stream_encoder_set_do_exhaustive_model_search(encoder, false))
 200                 return die_s_("returned false", encoder);
 201         printf("OK\n");
 202
 203         printf("testing FLAC__stream_encoder_set_min_residual_partition_order()... ");
 204         if(!FLAC__stream_encoder_set_min_residual_partition_order(encoder, 0))
 205                 return die_s_("returned false", encoder);
 206         printf("OK\n");
 207
 208         printf("testing FLAC__stream_encoder_set_max_residual_partition_order()... ");
 209         if(!FLAC__stream_encoder_set_max_residual_partition_order(encoder, 0))
 210                 return die_s_("returned false", encoder);
 211         printf("OK\n");
 212
 213         printf("testing FLAC__stream_encoder_set_rice_parameter_search_dist()... ");
 214         if(!FLAC__stream_encoder_set_rice_parameter_search_dist(encoder, 0))
 215                 return die_s_("returned false", encoder);
 216         printf("OK\n");
 217
 218         printf("testing FLAC__stream_encoder_set_total_samples_estimate()... ");
 219         if(!FLAC__stream_encoder_set_total_samples_estimate(encoder, streaminfo_.data.stream_info.total_samples))
 220                 return die_s_("returned false", encoder);
 221         printf("OK\n");
 222
 223         printf("testing FLAC__stream_encoder_set_metadata()... ");
 224         if(!FLAC__stream_encoder_set_metadata(encoder, metadata_sequence_, num_metadata_))
 225                 return die_s_("returned false", encoder);
 226         printf("OK\n");
 227
 228         switch(layer) {
 229                 case LAYER_STREAM:
 230                         printf("testing FLAC__stream_encoder_init_stream()... ");
 231                         if(FLAC__stream_encoder_init_stream(encoder, stream_encoder_write_callback_, /*seek_callback=*/0, /*tell_callback=*/0, stream_encoder_metadata_callback_, /*client_data=*/0) != FLAC__STREAM_ENCODER_INIT_STATUS_OK)
 232                                 return die_s_(0, encoder);
 233                         break;
 234                 case LAYER_SEEKABLE_STREAM:
 235                         printf("testing FLAC__stream_encoder_init_stream()... ");
 236                         if(FLAC__stream_encoder_init_stream(encoder, stream_encoder_write_callback_, stream_encoder_seek_callback_, stream_encoder_tell_callback_, /*metadata_callback=*/0, /*client_data=*/0) != FLAC__STREAM_ENCODER_INIT_STATUS_OK)
 237                                 return die_s_(0, encoder);
 238                         break;
 239                 case LAYER_FILE:
 240                         printf("opening file for FLAC output... ");
 241                         file = fopen(flacfilename_, "w+b");
 242                         if(0 == file) {
 243                                 printf("ERROR (%s)\n", strerror(errno));
 244                                 return false;
 245                         }
 246                         printf("OK\n");
 247
 248                         printf("testing FLAC__stream_encoder_init_FILE()... ");
 249                         if(FLAC__stream_encoder_init_FILE(encoder, file, stream_encoder_progress_callback_, /*client_data=*/0) != FLAC__STREAM_ENCODER_INIT_STATUS_OK)
 250                                 return die_s_(0, encoder);
 251                         break;
 252                 case LAYER_FILENAME:
 253                         printf("testing FLAC__stream_encoder_init_file()... ");
 254                         if(FLAC__stream_encoder_init_file(encoder, flacfilename_, stream_encoder_progress_callback_, /*client_data=*/0) != FLAC__STREAM_ENCODER_INIT_STATUS_OK)
 255                                 return die_s_(0, encoder);
 256                         break;
 257                 default:
 258                         die_("internal error 001");
 259                         return false;
 260         }
 261         printf("OK\n");
 262
 263         printf("testing FLAC__stream_encoder_get_state()... ");
 264         state = FLAC__stream_encoder_get_state(encoder);
 265         printf("returned state = %u (%s)... OK\n", (unsigned)state, FLAC__StreamEncoderStateString[state]);
 266
 267         printf("testing FLAC__stream_encoder_get_verify_decoder_state()... ");
 268         dstate = FLAC__stream_encoder_get_verify_decoder_state(encoder);
 269         printf("returned state = %u (%s)... OK\n", (unsigned)dstate, FLAC__StreamDecoderStateString[dstate]);
 270
 271         {
 272                 FLAC__uint64 absolute_sample;
 273                 unsigned frame_number;
 274                 unsigned channel;
 275                 unsigned sample;
 276                 FLAC__int32 expected;
 277                 FLAC__int32 got;
 278
 279                 printf("testing FLAC__stream_encoder_get_verify_decoder_error_stats()... ");
 280                 FLAC__stream_encoder_get_verify_decoder_error_stats(encoder, &absolute_sample, &frame_number, &channel, &sample, &expected, &got);
 281                 printf("OK\n");
 282         }
 283
 284         printf("testing FLAC__stream_encoder_get_verify()... ");
 285         if(FLAC__stream_encoder_get_verify(encoder) != true) {
 286                 printf("FAILED, expected true, got false\n");
 287                 return false;
 288         }
 289         printf("OK\n");
 290
 291         printf("testing FLAC__stream_encoder_get_streamable_subset()... ");
 292         if(FLAC__stream_encoder_get_streamable_subset(encoder) != true) {
 293                 printf("FAILED, expected true, got false\n");
 294                 return false;
 295         }
 296         printf("OK\n");
 297
 298         printf("testing FLAC__stream_encoder_get_do_mid_side_stereo()... ");
 299         if(FLAC__stream_encoder_get_do_mid_side_stereo(encoder) != false) {
 300                 printf("FAILED, expected false, got true\n");
 301                 return false;
 302         }
 303         printf("OK\n");
 304
 305         printf("testing FLAC__stream_encoder_get_loose_mid_side_stereo()... ");
 306         if(FLAC__stream_encoder_get_loose_mid_side_stereo(encoder) != false) {
 307                 printf("FAILED, expected false, got true\n");
 308                 return false;
 309         }
 310         printf("OK\n");
 311
 312         printf("testing FLAC__stream_encoder_get_channels()... ");
 313         if(FLAC__stream_encoder_get_channels(encoder) != streaminfo_.data.stream_info.channels) {
 314                 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.channels, FLAC__stream_encoder_get_channels(encoder));
 315                 return false;
 316         }
 317         printf("OK\n");
 318
 319         printf("testing FLAC__stream_encoder_get_bits_per_sample()... ");
 320         if(FLAC__stream_encoder_get_bits_per_sample(encoder) != streaminfo_.data.stream_info.bits_per_sample) {
 321                 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.bits_per_sample, FLAC__stream_encoder_get_bits_per_sample(encoder));
 322                 return false;
 323         }
 324         printf("OK\n");
 325
 326         printf("testing FLAC__stream_encoder_get_sample_rate()... ");
 327         if(FLAC__stream_encoder_get_sample_rate(encoder) != streaminfo_.data.stream_info.sample_rate) {
 328                 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.sample_rate, FLAC__stream_encoder_get_sample_rate(encoder));
 329                 return false;
 330         }
 331         printf("OK\n");
 332
 333         printf("testing FLAC__stream_encoder_get_blocksize()... ");
 334         if(FLAC__stream_encoder_get_blocksize(encoder) != streaminfo_.data.stream_info.min_blocksize) {
 335                 printf("FAILED, expected %u, got %u\n", streaminfo_.data.stream_info.min_blocksize, FLAC__stream_encoder_get_blocksize(encoder));
 336                 return false;
 337         }
 338         printf("OK\n");
 339
 340         printf("testing FLAC__stream_encoder_get_max_lpc_order()... ");
 341         if(FLAC__stream_encoder_get_max_lpc_order(encoder) != 0) {
 342                 printf("FAILED, expected %u, got %u\n", 0, FLAC__stream_encoder_get_max_lpc_order(encoder));
 343                 return false;
 344         }
 345         printf("OK\n");
 346
 347         printf("testing FLAC__stream_encoder_get_qlp_coeff_precision()... ");
 348         (void)FLAC__stream_encoder_get_qlp_coeff_precision(encoder);
 349         /* we asked the encoder to auto select this so we accept anything */
 350         printf("OK\n");
 351
 352         printf("testing FLAC__stream_encoder_get_do_qlp_coeff_prec_search()... ");
 353         if(FLAC__stream_encoder_get_do_qlp_coeff_prec_search(encoder) != false) {
 354                 printf("FAILED, expected false, got true\n");
 355                 return false;
 356         }
 357         printf("OK\n");
 358
 359         printf("testing FLAC__stream_encoder_get_do_escape_coding()... ");
 360         if(FLAC__stream_encoder_get_do_escape_coding(encoder) != false) {
 361                 printf("FAILED, expected false, got true\n");
 362                 return false;
 363         }
 364         printf("OK\n");
 365
 366         printf("testing FLAC__stream_encoder_get_do_exhaustive_model_search()... ");
 367         if(FLAC__stream_encoder_get_do_exhaustive_model_search(encoder) != false) {
 368                 printf("FAILED, expected false, got true\n");
 369                 return false;
 370         }
 371         printf("OK\n");
 372
 373         printf("testing FLAC__stream_encoder_get_min_residual_partition_order()... ");
 374         if(FLAC__stream_encoder_get_min_residual_partition_order(encoder) != 0) {
 375                 printf("FAILED, expected %u, got %u\n", 0, FLAC__stream_encoder_get_min_residual_partition_order(encoder));
 376                 return false;
 377         }
 378         printf("OK\n");
 379
 380         printf("testing FLAC__stream_encoder_get_max_residual_partition_order()... ");
 381         if(FLAC__stream_encoder_get_max_residual_partition_order(encoder) != 0) {
 382                 printf("FAILED, expected %u, got %u\n", 0, FLAC__stream_encoder_get_max_residual_partition_order(encoder));
 383                 return false;
 384         }
 385         printf("OK\n");
 386
 387         printf("testing FLAC__stream_encoder_get_rice_parameter_search_dist()... ");
 388         if(FLAC__stream_encoder_get_rice_parameter_search_dist(encoder) != 0) {
 389                 printf("FAILED, expected %u, got %u\n", 0, FLAC__stream_encoder_get_rice_parameter_search_dist(encoder));
 390                 return false;
 391         }
 392         printf("OK\n");
 393
 394         printf("testing FLAC__stream_encoder_get_total_samples_estimate()... ");
 395         if(FLAC__stream_encoder_get_total_samples_estimate(encoder) != streaminfo_.data.stream_info.total_samples) {
 396                 printf("FAILED, expected %llu, got %llu\n", streaminfo_.data.stream_info.total_samples, FLAC__stream_encoder_get_total_samples_estimate(encoder));
 397                 return false;
 398         }
 399         printf("OK\n");
 400
 401         /* init the dummy sample buffer */
 402         for(i = 0; i < sizeof(samples) / sizeof(FLAC__int32); i++)
 403                 samples[i] = i & 7;
 404
 405         printf("testing FLAC__stream_encoder_process()... ");
 406         if(!FLAC__stream_encoder_process(encoder, (const FLAC__int32 * const *)samples_array, sizeof(samples) / sizeof(FLAC__int32)))
 407                 return die_s_("returned false", encoder);
 408         printf("OK\n");
 409
 410         printf("testing FLAC__stream_encoder_process_interleaved()... ");
 411         if(!FLAC__stream_encoder_process_interleaved(encoder, samples, sizeof(samples) / sizeof(FLAC__int32)))
 412                 return die_s_("returned false", encoder);
 413         printf("OK\n");
 414
 415         printf("testing FLAC__stream_encoder_finish()... ");
 416         FLAC__stream_encoder_finish(encoder);
 417         printf("OK\n");
 418
 419         printf("testing FLAC__stream_encoder_delete()... ");
 420         FLAC__stream_encoder_delete(encoder);
 421         printf("OK\n");
 422
 423         printf("\nPASSED!\n");
 424
 425         return true;
 426 }
 427
 428 FLAC__bool test_encoders()
 429 {
 430         init_metadata_blocks_();
 431
 432         if(!test_stream_encoder(LAYER_STREAM))
 433                 return false;
 434
 435         if(!test_stream_encoder(LAYER_SEEKABLE_STREAM))
 436                 return false;
 437
 438         if(!test_stream_encoder(LAYER_FILE))
 439                 return false;
 440
 441         if(!test_stream_encoder(LAYER_FILENAME))
 442                 return false;
 443
 444         (void) grabbag__file_remove_file(flacfilename_);
 445         free_metadata_blocks_();
 446
 447         return true;
 448 }