test/test_metaflac.sh

   1 #!/bin/sh
   2
   3 #  FLAC - Free Lossless Audio Codec
   4 #  Copyright (C) 2002-2009  Josh Coalson
   5 #  Copyright (C) 2011-2013  Xiph.Org Foundation
   6 #
   7 #  This file is part the FLAC project.  FLAC is comprised of several
   8 #  components distributed under difference licenses.  The codec libraries
   9 #  are distributed under Xiph.Org's BSD-like license (see the file
  10 #  COPYING.Xiph in this distribution).  All other programs, libraries, and
  11 #  plugins are distributed under the GPL (see COPYING.GPL).  The documentation
  12 #  is distributed under the Gnu FDL (see COPYING.FDL).  Each file in the
  13 #  FLAC distribution contains at the top the terms under which it may be
  14 #  distributed.
  15 #
  16 #  Since this particular file is relevant to all components of FLAC,
  17 #  it may be distributed under the Xiph.Org license, which is the least
  18 #  restrictive of those mentioned above.  See the file COPYING.Xiph in this
  19 #  distribution.
  20
  21 die ()
  22 {
  23         echo $* 1>&2
  24         exit 1
  25 }
  26
  27 if [ x = x"$1" ] ; then
  28         BUILD=debug
  29 else
  30         BUILD="$1"
  31 fi
  32
  33 # change to 'false' to show all flac/metaflac output (useful for debugging)
  34 if true ; then
  35         SILENT='--silent'
  36         TOTALLY_SILENT='--totally-silent'
  37 else
  38         SILENT=''
  39         TOTALLY_SILENT=''
  40 fi
  41
  42 LD_LIBRARY_PATH=`pwd`/../src/libFLAC/.libs:$LD_LIBRARY_PATH
  43 LD_LIBRARY_PATH=`pwd`/../src/share/grabbag/.libs:$LD_LIBRARY_PATH
  44 LD_LIBRARY_PATH=`pwd`/../src/share/getopt/.libs:$LD_LIBRARY_PATH
  45 LD_LIBRARY_PATH=`pwd`/../src/share/replaygain_analysis/.libs:$LD_LIBRARY_PATH
  46 LD_LIBRARY_PATH=`pwd`/../src/share/replaygain_synthesis/.libs:$LD_LIBRARY_PATH
  47 LD_LIBRARY_PATH=`pwd`/../src/share/utf8/.libs:$LD_LIBRARY_PATH
  48 LD_LIBRARY_PATH=`pwd`/../objs/$BUILD/lib:$LD_LIBRARY_PATH
  49 export LD_LIBRARY_PATH
  50 export MALLOC_CHECK_=3
  51 export MALLOC_PERTURB_=$((1$(date +%N) % 255 + 1))
  52 PATH=`pwd`/../src/flac:$PATH
  53 PATH=`pwd`/../src/metaflac:$PATH
  54 PATH=`pwd`/../objs/$BUILD/bin:$PATH
  55
  56 if echo a | (grep -E '(a|b)') >/dev/null 2>&1
  57         then EGREP='grep -E'
  58         else EGREP='egrep'
  59 fi
  60
  61 testdir="metaflac-test-files"
  62 flacfile="metaflac.flac"
  63
  64 flac --help 1>/dev/null 2>/dev/null || die "ERROR can't find flac executable"
  65 metaflac --help 1>/dev/null 2>/dev/null || die "ERROR can't find metaflac executable"
  66
  67 run_flac ()
  68 {
  69         if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
  70                 echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 flac $*" >>test_metaflac.valgrind.log
  71                 valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 flac $* 4>>test_metaflac.valgrind.log
  72         else
  73                 flac $*
  74         fi
  75 }
  76
  77 run_metaflac ()
  78 {
  79         if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
  80                 echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 metaflac $*" >>test_metaflac.valgrind.log
  81                 valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 metaflac $* 4>>test_metaflac.valgrind.log
  82         else
  83                 metaflac $*
  84         fi
  85 }
  86
  87 run_metaflac_silent ()
  88 {
  89         if [ -z "$SILENT" ] ; then
  90                 run_metaflac $*
  91         else
  92                 if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
  93                         echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 metaflac $*" >>test_metaflac.valgrind.log
  94                         valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 metaflac $* 2>/dev/null 4>>test_metaflac.valgrind.log
  95                 else
  96                         metaflac $* 2>/dev/null
  97                 fi
  98         fi
  99 }
 100
 101 check_flac ()
 102 {
 103         run_flac --silent --test $flacfile || die "ERROR in $flacfile" 1>&2
 104 }
 105
 106 echo "Generating stream..."
 107 bytes=80000
 108 if dd if=/dev/zero ibs=1 count=$bytes | flac --force --verify -0 --input-size=$bytes --output-name=$flacfile --force-raw-format --endian=big --sign=signed --channels=1 --bps=8 --sample-rate=8000 - ; then
 109         chmod +w $flacfile
 110 else
 111         die "ERROR during generation"
 112 fi
 113
 114 check_flac
 115
 116 echo
 117
 118 filter ()
 119 {
 120         # minor danger, changing vendor strings will change the length of the
 121         # VORBIS_COMMENT block, but if we add "^  length: " to the patterns,
 122         # we lose info about PADDING size that we need
 123         # grep pattern 1: remove vendor string
 124         # grep pattern 2: remove minimum/maximum frame and block size from STREAMINFO
 125         # grep pattern 3: remove hexdump data from PICTURE metadata blocks
 126         # sed pattern 1: remove stream offset values from SEEKTABLE points
 127         $EGREP -v '^  vendor string: |^  m..imum .....size: |^    0000[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]: ' | sed -e 's/, stream_offset.*//'
 128 }
 129 metaflac_test ()
 130 {
 131         case="$1"
 132         desc="$2"
 133         args="$3"
 134         expect="$testdir/$case-expect.meta"
 135         echo -n "test $case: $desc... "
 136         run_metaflac $args $flacfile | filter > $testdir/out.meta || die "ERROR running metaflac"
 137         diff -w $expect $testdir/out.meta > /dev/null 2>&1 || die "ERROR: metadata does not match expected $expect"
 138         echo OK
 139 }
 140
 141 metaflac_test case00 "--list" "--list"
 142
 143 metaflac_test case01 "STREAMINFO --show-* shortcuts" "
 144         --show-md5sum
 145         --show-min-blocksize
 146         --show-max-blocksize
 147         --show-min-framesize
 148         --show-max-framesize
 149         --show-sample-rate
 150         --show-channels
 151         --show-bps
 152         --show-total-samples"
 153
 154 run_metaflac --preserve-modtime --add-padding=12345 $flacfile
 155 check_flac
 156 metaflac_test case02 "--add-padding" "--list"
 157
 158 # some flavors of /bin/sh (e.g. Darwin's) won't even handle quoted spaces, so we underscore:
 159 run_metaflac --set-tag="ARTIST=The_artist_formerly_known_as_the_artist..." $flacfile
 160 check_flac
 161 metaflac_test case03 "--set-tag=ARTIST" "--list"
 162
 163 run_metaflac --set-tag="ARTIST=Chuck_Woolery" $flacfile
 164 check_flac
 165 metaflac_test case04 "--set-tag=ARTIST" "--list"
 166
 167 run_metaflac --set-tag="ARTIST=Vern" $flacfile
 168 check_flac
 169 metaflac_test case05 "--set-tag=ARTIST" "--list"
 170
 171 run_metaflac --set-tag="TITLE=He_who_smelt_it_dealt_it" $flacfile
 172 check_flac
 173 metaflac_test case06 "--set-tag=TITLE" "--list"
 174
 175 metaflac_test case07 "--show-vendor-tag --show-tag=ARTIST" "--show-vendor-tag --show-tag=ARTIST"
 176
 177 run_metaflac --remove-first-tag=ARTIST $flacfile
 178 check_flac
 179 metaflac_test case08 "--remove-first-tag=ARTIST" "--list"
 180
 181 run_metaflac --remove-tag=ARTIST $flacfile
 182 check_flac
 183 metaflac_test case09 "--remove-tag=ARTIST" "--list"
 184
 185 metaflac_test case10 "--list --block-type=VORBIS_COMMENT" "--list --block-type=VORBIS_COMMENT"
 186 metaflac_test case11 "--list --block-number=0" "--list --block-number=0"
 187 metaflac_test case12 "--list --block-number=1,2,999" "--list --block-number=1,2,999"
 188 metaflac_test case13 "--list --block-type=VORBIS_COMMENT,PADDING" "--list --block-type=VORBIS_COMMENT,PADDING"
 189 metaflac_test case14 "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT" "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT"
 190 metaflac_test case15 "--list --except-block-type=STREAMINFO" "--list --except-block-type=STREAMINFO"
 191
 192 run_metaflac --add-padding=4321 $flacfile $flacfile
 193 check_flac
 194 metaflac_test case16 "--add-padding=4321 * 2" "--list"
 195
 196 run_metaflac --merge-padding $flacfile
 197 check_flac
 198 metaflac_test case17 "--merge-padding" "--list"
 199
 200 run_metaflac --add-padding=0 $flacfile
 201 check_flac
 202 metaflac_test case18 "--add-padding=0" "--list"
 203
 204 run_metaflac --sort-padding $flacfile
 205 check_flac
 206 metaflac_test case19 "--sort-padding" "--list"
 207
 208 run_metaflac --add-padding=0 $flacfile
 209 check_flac
 210 metaflac_test case20 "--add-padding=0" "--list"
 211
 212 run_metaflac --remove-all-tags $flacfile
 213 check_flac
 214 metaflac_test case21 "--remove-all-tags" "--list"
 215
 216 run_metaflac --remove --block-number=1,99 --dont-use-padding $flacfile
 217 check_flac
 218 metaflac_test case22 "--remove --block-number=1,99 --dont-use-padding" "--list"
 219
 220 run_metaflac --remove --block-number=99 --dont-use-padding $flacfile
 221 check_flac
 222 metaflac_test case23 "--remove --block-number=99 --dont-use-padding" "--list"
 223
 224 run_metaflac --remove --block-type=PADDING $flacfile
 225 check_flac
 226 metaflac_test case24 "--remove --block-type=PADDING" "--list"
 227
 228 run_metaflac --remove --block-type=PADDING --dont-use-padding $flacfile
 229 check_flac
 230 metaflac_test case25 "--remove --block-type=PADDING --dont-use-padding" "--list"
 231
 232 run_metaflac --add-padding=0 $flacfile $flacfile
 233 check_flac
 234 metaflac_test case26 "--add-padding=0 * 2" "--list"
 235
 236 run_metaflac --remove --except-block-type=PADDING $flacfile
 237 check_flac
 238 metaflac_test case27 "--remove --except-block-type=PADDING" "--list"
 239
 240 run_metaflac --remove-all $flacfile
 241 check_flac
 242 metaflac_test case28 "--remove-all" "--list"
 243
 244 run_metaflac --remove-all --dont-use-padding $flacfile
 245 check_flac
 246 metaflac_test case29 "--remove-all --dont-use-padding" "--list"
 247
 248 run_metaflac --remove-all --dont-use-padding $flacfile
 249 check_flac
 250 metaflac_test case30 "--remove-all --dont-use-padding" "--list"
 251
 252 run_metaflac --set-tag="f=0123456789abcdefghij" $flacfile
 253 check_flac
 254 metaflac_test case31 "--set-tag=..." "--list"
 255
 256 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
 257 check_flac
 258 metaflac_test case32 "--remove-all-tags --set-tag=..." "--list"
 259
 260 run_metaflac --remove-all-tags --set-tag="f=0123456789abcde" $flacfile
 261 check_flac
 262 metaflac_test case33 "--remove-all-tags --set-tag=..." "--list"
 263
 264 run_metaflac --remove-all-tags --set-tag="f=0" $flacfile
 265 check_flac
 266 metaflac_test case34 "--remove-all-tags --set-tag=..." "--list"
 267
 268 run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
 269 check_flac
 270 metaflac_test case35 "--remove-all-tags --set-tag=..." "--list"
 271
 272 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
 273 check_flac
 274 metaflac_test case36 "--remove-all-tags --set-tag=..." "--list"
 275
 276 run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
 277 check_flac
 278 metaflac_test case37 "--remove-all-tags --set-tag=..." "--list"
 279
 280 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghij" $flacfile
 281 check_flac
 282 metaflac_test case38 "--remove-all-tags --set-tag=..." "--list"
 283
 284 echo "TITLE=Tittle" | run_metaflac --import-tags-from=- $flacfile
 285 check_flac
 286 metaflac_test case39 "--import-tags-from=-" "--list"
 287
 288 cat > vc.txt << EOF
 289 artist=Fartist
 290 artist=artits
 291 EOF
 292 run_metaflac --import-tags-from=vc.txt $flacfile
 293 check_flac
 294 metaflac_test case40 "--import-tags-from=[FILE]" "--list"
 295
 296 rm vc.txt
 297
 298 run_metaflac --add-replay-gain $flacfile
 299 check_flac
 300 metaflac_test case41 "--add-replay-gain" "--list"
 301
 302 run_metaflac --remove-replay-gain $flacfile
 303 check_flac
 304 metaflac_test case42 "--remove-replay-gain" "--list"
 305
 306 # CUESHEET blocks
 307 cs_in=cuesheets/good.000.cue
 308 cs_out=metaflac.cue
 309 cs_out2=metaflac2.cue
 310 run_metaflac --import-cuesheet-from="$cs_in" $flacfile
 311 check_flac
 312 metaflac_test case43 "--import-cuesheet-from" "--list"
 313 run_metaflac --export-cuesheet-to=$cs_out $flacfile
 314 run_metaflac --remove --block-type=CUESHEET $flacfile
 315 check_flac
 316 metaflac_test case44 "--remove --block-type=CUESHEET" "--list"
 317 run_metaflac --import-cuesheet-from=$cs_out $flacfile
 318 check_flac
 319 metaflac_test case45 "--import-cuesheet-from" "--list"
 320 run_metaflac --export-cuesheet-to=$cs_out2 $flacfile
 321 echo "comparing cuesheets:"
 322 diff $cs_out $cs_out2 || die "ERROR, cuesheets should be identical"
 323 echo identical
 324
 325 rm -f $cs_out $cs_out2
 326
 327 # PICTURE blocks
 328 ncase=46
 329 for f in \
 330         0.gif \
 331         1.gif \
 332         2.gif \
 333 ; do
 334         run_metaflac --import-picture-from="|image/gif|$f||pictures/$f" $flacfile
 335         check_flac
 336         metaflac_test "case$ncase" "--import-picture-from" "--list"
 337         ncase=`expr $ncase + 1`
 338 done
 339 for f in \
 340         0.jpg \
 341         4.jpg \
 342 ; do
 343         run_metaflac --import-picture-from="4|image/jpeg|$f||pictures/$f" $flacfile
 344         check_flac
 345         metaflac_test "case$ncase" "--import-picture-from" "--list"
 346         ncase=`expr $ncase + 1`
 347 done
 348 for f in \
 349         0.png \
 350         1.png \
 351         2.png \
 352         3.png \
 353         4.png \
 354         5.png \
 355         6.png \
 356         7.png \
 357         8.png \
 358 ; do
 359         run_metaflac --import-picture-from="5|image/png|$f||pictures/$f" $flacfile
 360         check_flac
 361         metaflac_test "case$ncase" "--import-picture-from" "--list"
 362         ncase=`expr $ncase + 1`
 363 done
 364 [ $ncase = 60 ] || die "expected case# to be 60"
 365
 366 fn=export-picture-check
 367 echo -n "Testing --export-picture-to... "
 368 run_metaflac --export-picture-to=$fn $flacfile
 369 check_flac
 370 cmp $fn pictures/0.gif || die "ERROR, exported picture file and original differ"
 371 echo OK
 372 rm -f $fn
 373 echo -n "Testing --block-number --export-picture-to... "
 374 run_metaflac --block-number=9 --export-picture-to=$fn $flacfile
 375 check_flac
 376 cmp $fn pictures/0.png || die "ERROR, exported picture file and original differ"
 377 echo OK
 378 rm -f $fn
 379
 380 run_metaflac --remove --block-type=PICTURE $flacfile
 381 check_flac
 382 metaflac_test case60 "--remove --block-type=PICTURE" "--list"
 383 run_metaflac --import-picture-from="1|image/png|standard_icon|32x32x24|pictures/0.png" $flacfile
 384 check_flac
 385 metaflac_test case61 "--import-picture-from" "--list"
 386 run_metaflac --import-picture-from="2|image/png|icon|64x64x24|pictures/1.png" $flacfile
 387 check_flac
 388 metaflac_test case62 "--import-picture-from" "--list"
 389
 390 # UNKNOWN blocks
 391 echo -n "Testing FLAC file with unknown metadata... "
 392 cp -p metaflac.flac.in $flacfile
 393 # remove the VORBIS_COMMENT block so vendor string changes don't interfere with the comparison:
 394 run_metaflac --remove --block-type=VORBIS_COMMENT --dont-use-padding $flacfile
 395 cmp $flacfile metaflac.flac.ok || die "ERROR, $flacfile and metaflac.flac.ok differ"
 396 echo OK
 397
 398 # Replay gain tests - Test the rates which have specific filter table entries
 399 # and verify that harmonics can be processed correctly.
 400
 401 tonegenerator ()
 402 {
 403         # When using GAWK, use --lint=posix to identify non-POSIX awk usages.
 404     awk -- '
 405     BEGIN {
 406             samplerate = '$1';
 407
 408             tone = 1000;
 409             duration = 1;
 410             bitspersample = 24;
 411
 412             samplemidpoint = 1;
 413                         for (sps = 0 ; sps < bitspersample - 1 ; sps++) {
 414                                 samplemidpoint *= 2;
 415                         }
 416
 417             samplerange = samplemidpoint - 1;
 418
 419             pi = 4 * atan2(1,1);
 420
 421             for (ix = 0; ix < duration * samplerate; ++ix) {
 422                     sample = sin(2 * pi * tone * ix / samplerate);
 423                     sample *= samplerange;
 424                     sample += samplemidpoint;
 425                     sample = int(sample);
 426                     for (bx = 0; bx < bitspersample/8; ++bx) {
 427                             byte[bx] = sample % 256;
 428                             sample /= 256;
 429                     }
 430                     while (bx--) {
 431                             printf("%c", byte[bx]);
 432                     }
 433             }
 434
 435     }' /dev/null |
 436     flac --silent \
 437         --endian=big --channels=1 --bps=24 --sample-rate=$1 --sign=unsigned -
 438 }
 439
 440 REPLAYGAIN_FREQ=
 441 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ  8000/-12.73"
 442 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 11025/-12.93"
 443 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 11025/-12.93"
 444 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 12000/-12.98"
 445 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 16000/-13.27"
 446 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 18900/-13.41"
 447 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 22050/-13.77"
 448 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 24000/-13.82"
 449 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 28000/-14.06"
 450 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 32000/-14.08"
 451 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 36000/-14.12"
 452 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 37800/-14.18"
 453 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 44100/-14.17"
 454 REPLAYGAIN_FREQ="$REPLAYGAIN_FREQ 48000/-14.16:1:2:4"
 455
 456 set -e
 457
 458 for ACTION in $REPLAYGAIN_FREQ ; do
 459   if [ -n "${ACTION##*:*}" ] ; then
 460     HARMONICS=1
 461   else
 462     HARMONICS="${ACTION#*:}"
 463   fi
 464   FREQ="${ACTION%%/*}"
 465   GAIN="${ACTION#*/}"
 466   GAIN="${GAIN%%:*}"
 467   while [ -n "$HARMONICS" ] ; do
 468     MULTIPLE="${HARMONICS%%:*}"
 469     if [ x"$MULTIPLE" = x"$HARMONICS" ] ; then
 470       HARMONICS=
 471     else
 472       HARMONICS="${HARMONICS#*:}"
 473     fi
 474     RATE=$(($MULTIPLE * FREQ))
 475     [ $MULTIPLE -eq 1 -o -n "${REPLAYGAIN_FREQ##* $RATE/*}" ] || break
 476     echo -n "Testing FLAC replaygain $RATE ($FREQ x $MULTIPLE) ... "
 477     tonegenerator $RATE > $flacfile
 478     run_metaflac --add-replay-gain $flacfile
 479     run_metaflac --list $flacfile | grep REPLAYGAIN.*GAIN= |
 480     while read -r REPLAYGAIN ; do
 481       MEASUREDGAIN="${REPLAYGAIN##*=}"
 482       MEASUREDGAIN="${MEASUREDGAIN%% *}"
 483       if [ x"$MEASUREDGAIN" != x"$GAIN" ] ; then
 484         die "ERROR, Expected $GAIN db instead of $REPLAYGAIN"
 485       fi
 486     done
 487     echo OK
 488   done
 489 done
 490
 491
 492 rm -f $testdir/out.flac $testdir/out.meta
 493
 494 exit 0