bump version number to 1.1.4
[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  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 PATH=`pwd`/../src/flac:$PATH
50 PATH=`pwd`/../src/metaflac:$PATH
51 PATH=`pwd`/../obj/$BUILD/bin:$PATH
52
53 testdir="metaflac-test-files"
54 flacfile="metaflac.flac"
55
56 flac --help 1>/dev/null 2>/dev/null || die "ERROR can't find flac executable"
57 metaflac --help 1>/dev/null 2>/dev/null || die "ERROR can't find metaflac executable"
58
59 run_flac ()
60 {
61         if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
62                 echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=100 flac $*" >>test_metaflac.valgrind.log
63                 valgrind --leak-check=yes --show-reachable=yes --num-callers=100 --logfile-fd=4 flac $* 4>>test_metaflac.valgrind.log
64         else
65                 flac $*
66         fi
67 }
68
69 run_metaflac ()
70 {
71         if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
72                 echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=100 metaflac $*" >>test_metaflac.valgrind.log
73                 valgrind --leak-check=yes --show-reachable=yes --num-callers=100 --logfile-fd=4 metaflac $* 4>>test_metaflac.valgrind.log
74         else
75                 metaflac $*
76         fi
77 }
78
79 run_metaflac_silent ()
80 {
81         if [ -z "$SILENT" ] ; then
82                 run_metaflac $*
83         else
84                 if [ x"$FLAC__TEST_WITH_VALGRIND" = xyes ] ; then
85                         echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=100 metaflac $*" >>test_metaflac.valgrind.log
86                         valgrind --leak-check=yes --show-reachable=yes --num-callers=100 --logfile-fd=4 metaflac $* 2>/dev/null 4>>test_metaflac.valgrind.log
87                 else
88                         metaflac $* 2>/dev/null
89                 fi
90         fi
91 }
92
93 check_flac ()
94 {
95         run_flac --silent --test $flacfile || die "ERROR in $flacfile" 1>&2
96 }
97
98 echo "Generating stream..."
99 bytes=80000
100 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
101         chmod +w $flacfile
102 else
103         die "ERROR during generation"
104 fi
105
106 check_flac
107
108 echo
109
110 filter ()
111 {
112         # minor danger, changing vendor strings will change the length of the
113         # VORBIS_COMMENT block, but if we add "^  length: " to the patterns,
114         # we lose info about PADDING size that we need
115         # grep pattern 1: remove vendor string
116         # grep pattern 2: remove minimum/maximum frame and block size from STREAMINFO
117         # grep pattern 3: remove hexdump data from PICTURE metadata blocks
118         # sed pattern 1: remove stream offset values from SEEKTABLE points
119         grep -Ev '^  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.*//'
120 }
121 metaflac_test ()
122 {
123         case="$1"
124         desc="$2"
125         args="$3"
126         expect="$testdir/$case-expect.meta"
127         echo -n "test $case: $desc... "
128         run_metaflac $args $flacfile | filter > $testdir/out.meta || die "ERROR running metaflac"
129         diff -q -w $expect $testdir/out.meta 2>/dev/null || die "ERROR: metadata does not match expected $expect"
130         echo OK
131 }
132
133 metaflac_test case00 "--list" "--list"
134
135 metaflac_test case01 "STREAMINFO --show-* shortcuts" "
136         --show-md5sum
137         --show-min-blocksize
138         --show-max-blocksize
139         --show-min-framesize
140         --show-max-framesize
141         --show-sample-rate
142         --show-channels
143         --show-bps
144         --show-total-samples"
145
146 run_metaflac --preserve-modtime --add-padding=12345 $flacfile
147 check_flac
148 metaflac_test case02 "--add-padding" "--list"
149
150 # some flavors of /bin/sh (e.g. Darwin's) won't even handle quoted spaces, so we underscore:
151 run_metaflac --set-tag="ARTIST=The_artist_formerly_known_as_the_artist..." $flacfile
152 check_flac
153 metaflac_test case03 "--set-tag=ARTIST" "--list"
154
155 run_metaflac --set-tag="ARTIST=Chuck_Woolery" $flacfile
156 check_flac
157 metaflac_test case04 "--set-tag=ARTIST" "--list"
158
159 run_metaflac --set-tag="ARTIST=Vern" $flacfile
160 check_flac
161 metaflac_test case05 "--set-tag=ARTIST" "--list"
162
163 run_metaflac --set-tag="TITLE=He_who_smelt_it_dealt_it" $flacfile
164 check_flac
165 metaflac_test case06 "--set-tag=TITLE" "--list"
166
167 metaflac_test case07 "--show-vendor-tag --show-tag=ARTIST" "--show-vendor-tag --show-tag=ARTIST"
168
169 run_metaflac --remove-first-tag=ARTIST $flacfile
170 check_flac
171 metaflac_test case08 "--remove-first-tag=ARTIST" "--list"
172
173 run_metaflac --remove-tag=ARTIST $flacfile
174 check_flac
175 metaflac_test case09 "--remove-tag=ARTIST" "--list"
176
177 metaflac_test case10 "--list --block-type=VORBIS_COMMENT" "--list --block-type=VORBIS_COMMENT"
178 metaflac_test case11 "--list --block-number=0" "--list --block-number=0"
179 metaflac_test case12 "--list --block-number=1,2,999" "--list --block-number=1,2,999"
180 metaflac_test case13 "--list --block-type=VORBIS_COMMENT,PADDING" "--list --block-type=VORBIS_COMMENT,PADDING"
181 metaflac_test case14 "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT" "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT"
182 metaflac_test case15 "--list --except-block-type=STREAMINFO" "--list --except-block-type=STREAMINFO"
183
184 run_metaflac --add-padding=4321 $flacfile $flacfile
185 check_flac
186 metaflac_test case16 "--add-padding=4321 * 2" "--list"
187
188 run_metaflac --merge-padding $flacfile
189 check_flac
190 metaflac_test case17 "--merge-padding" "--list"
191
192 run_metaflac --add-padding=0 $flacfile
193 check_flac
194 metaflac_test case18 "--add-padding=0" "--list"
195
196 run_metaflac --sort-padding $flacfile
197 check_flac
198 metaflac_test case19 "--sort-padding" "--list"
199
200 run_metaflac --add-padding=0 $flacfile
201 check_flac
202 metaflac_test case20 "--add-padding=0" "--list"
203
204 run_metaflac --remove-all-tags $flacfile
205 check_flac
206 metaflac_test case21 "--remove-all-tags" "--list"
207
208 run_metaflac --remove --block-number=1,99 --dont-use-padding $flacfile
209 check_flac
210 metaflac_test case22 "--remove --block-number=1,99 --dont-use-padding" "--list"
211
212 run_metaflac --remove --block-number=99 --dont-use-padding $flacfile
213 check_flac
214 metaflac_test case23 "--remove --block-number=99 --dont-use-padding" "--list"
215
216 run_metaflac --remove --block-type=PADDING $flacfile
217 check_flac
218 metaflac_test case24 "--remove --block-type=PADDING" "--list"
219
220 run_metaflac --remove --block-type=PADDING --dont-use-padding $flacfile
221 check_flac
222 metaflac_test case25 "--remove --block-type=PADDING --dont-use-padding" "--list"
223
224 run_metaflac --add-padding=0 $flacfile $flacfile
225 check_flac
226 metaflac_test case26 "--add-padding=0 * 2" "--list"
227
228 run_metaflac --remove --except-block-type=PADDING $flacfile
229 check_flac
230 metaflac_test case27 "--remove --except-block-type=PADDING" "--list"
231
232 run_metaflac --remove-all $flacfile
233 check_flac
234 metaflac_test case28 "--remove-all" "--list"
235
236 run_metaflac --remove-all --dont-use-padding $flacfile
237 check_flac
238 metaflac_test case29 "--remove-all --dont-use-padding" "--list"
239
240 run_metaflac --remove-all --dont-use-padding $flacfile
241 check_flac
242 metaflac_test case30 "--remove-all --dont-use-padding" "--list"
243
244 run_metaflac --set-tag="f=0123456789abcdefghij" $flacfile
245 check_flac
246 metaflac_test case31 "--set-tag=..." "--list"
247
248 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
249 check_flac
250 metaflac_test case32 "--remove-all-tags --set-tag=..." "--list"
251
252 run_metaflac --remove-all-tags --set-tag="f=0123456789abcde" $flacfile
253 check_flac
254 metaflac_test case33 "--remove-all-tags --set-tag=..." "--list"
255
256 run_metaflac --remove-all-tags --set-tag="f=0" $flacfile
257 check_flac
258 metaflac_test case34 "--remove-all-tags --set-tag=..." "--list"
259
260 run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
261 check_flac
262 metaflac_test case35 "--remove-all-tags --set-tag=..." "--list"
263
264 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
265 check_flac
266 metaflac_test case36 "--remove-all-tags --set-tag=..." "--list"
267
268 run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
269 check_flac
270 metaflac_test case37 "--remove-all-tags --set-tag=..." "--list"
271
272 run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghij" $flacfile
273 check_flac
274 metaflac_test case38 "--remove-all-tags --set-tag=..." "--list"
275
276 echo "TITLE=Tittle" | run_metaflac --import-tags-from=- $flacfile
277 check_flac
278 metaflac_test case39 "--import-tags-from=-" "--list"
279
280 cat > vc.txt << EOF
281 artist=Fartist
282 artist=artits
283 EOF
284 run_metaflac --import-tags-from=vc.txt $flacfile
285 check_flac
286 metaflac_test case40 "--import-tags-from=[FILE]" "--list"
287
288 rm vc.txt
289
290 run_metaflac --add-replay-gain $flacfile
291 check_flac
292 metaflac_test case41 "--add-replay-gain" "--list"
293
294 run_metaflac --remove-replay-gain $flacfile
295 check_flac
296 metaflac_test case42 "--remove-replay-gain" "--list"
297
298 # CUESHEET blocks
299 cs_in=cuesheets/good.000.cue
300 cs_out=metaflac.cue
301 cs_out2=metaflac2.cue
302 run_metaflac --import-cuesheet-from="$cs_in" $flacfile
303 check_flac
304 metaflac_test case43 "--import-cuesheet-from" "--list"
305 run_metaflac --export-cuesheet-to=$cs_out $flacfile
306 run_metaflac --remove --block-type=CUESHEET $flacfile
307 check_flac
308 metaflac_test case44 "--remove --block-type=CUESHEET" "--list"
309 run_metaflac --import-cuesheet-from=$cs_out $flacfile
310 check_flac
311 metaflac_test case45 "--import-cuesheet-from" "--list"
312 run_metaflac --export-cuesheet-to=$cs_out2 $flacfile
313 echo "comparing cuesheets:"
314 diff $cs_out $cs_out2 || die "ERROR, cuesheets should be identical"
315 echo identical
316
317 rm -f $cs_out $cs_out2
318
319 # PICTURE blocks
320 ncase=46
321 for f in \
322         0.gif \
323         1.gif \
324         2.gif \
325 ; do
326         run_metaflac --import-picture-from="|image/gif|$f||pictures/$f" $flacfile
327         check_flac
328         metaflac_test "case$ncase" "--import-picture-from" "--list"
329         ncase=`expr $ncase + 1`
330 done
331 for f in \
332         0.jpg \
333         4.jpg \
334 ; do
335         run_metaflac --import-picture-from="4|image/jpeg|$f||pictures/$f" $flacfile
336         check_flac
337         metaflac_test "case$ncase" "--import-picture-from" "--list"
338         ncase=`expr $ncase + 1`
339 done
340 for f in \
341         0.png \
342         1.png \
343         2.png \
344         3.png \
345         4.png \
346         5.png \
347         6.png \
348         7.png \
349         8.png \
350 ; do
351         run_metaflac --import-picture-from="5|image/png|$f||pictures/$f" $flacfile
352         check_flac
353         metaflac_test "case$ncase" "--import-picture-from" "--list"
354         ncase=`expr $ncase + 1`
355 done
356 [ $ncase = 60 ] || die "expected case# to be 60"
357
358 fn=export-picture-check
359 echo -n "Testing --export-picture-to... "
360 run_metaflac --export-picture-to=$fn $flacfile
361 check_flac
362 cmp $fn pictures/0.gif || die "ERROR, exported picture file and original differ"
363 echo OK
364 rm -f $fn
365 echo -n "Testing --block-number --export-picture-to... "
366 run_metaflac --block-number=9 --export-picture-to=$fn $flacfile
367 check_flac
368 cmp $fn pictures/0.png || die "ERROR, exported picture file and original differ"
369 echo OK
370 rm -f $fn
371
372 run_metaflac --remove --block-type=PICTURE $flacfile
373 check_flac
374 metaflac_test case60 "--remove --block-type=PICTURE" "--list"
375 run_metaflac --import-picture-from="1|image/png|standard_icon|32x32x24|pictures/0.png" $flacfile
376 check_flac
377 metaflac_test case61 "--import-picture-from" "--list"
378 run_metaflac --import-picture-from="2|image/png|icon|64x64x24|pictures/1.png" $flacfile
379 check_flac
380 metaflac_test case62 "--import-picture-from" "--list"
381
382 # UNKNOWN blocks
383 echo -n "Testing FLAC file with unknown metadata... "
384 cp -p metaflac.flac.in $flacfile
385 # remove the VORBIS_COMMENT block so vendor string changes don't interfere with the comparison:
386 run_metaflac --remove --block-type=VORBIS_COMMENT --dont-use-padding $flacfile
387 cmp $flacfile metaflac.flac.ok || die "ERROR, $flacfile and metaflac.flac.ok differ"
388 echo OK
389
390 rm -f $testdir/out.flac $testdir/out.meta
391
392 exit 0