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