xref: /aosp_15_r20/external/flac/test/test_metaflac.sh (revision 600f14f40d737144c998e2ec7a483122d3776fbc)
1#!/bin/sh -e
2
3#  FLAC - Free Lossless Audio Codec
4#  Copyright (C) 2002-2009  Josh Coalson
5#  Copyright (C) 2011-2023  Xiph.Org Foundation
6#
7#  This file is part the FLAC project.  FLAC is comprised of several
8#  components distributed under different 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. ./common.sh
22
23PATH="$(pwd)/../src/flac:$PATH"
24PATH="$(pwd)/../src/metaflac:$PATH"
25PATH="$(pwd)/../objs/$BUILD/bin:$PATH"
26
27if echo a | (grep -E '(a|b)') >/dev/null 2>&1
28	then EGREP='grep -E'
29	else EGREP='egrep'
30fi
31
32testdir="metaflac-test-files"
33flacfile="metaflac1.flac"
34
35flac${EXE} --help 1>/dev/null 2>/dev/null || die "ERROR can't find flac executable"
36metaflac${EXE} --help 1>/dev/null 2>/dev/null || die "ERROR can't find metaflac executable"
37
38run_flac ()
39{
40	if [ "$FLAC__TEST_WITH_VALGRIND" = yes ] ; then
41		echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 flac $*" >>test_metaflac.valgrind.log
42		valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 flac${EXE} ${TOTALLY_SILENT} --no-error-on-compression-fail $* 4>>test_metaflac.valgrind.log
43	else
44		flac${EXE} ${TOTALLY_SILENT} --no-error-on-compression-fail $*
45	fi
46}
47
48run_metaflac ()
49{
50	if [ "$FLAC__TEST_WITH_VALGRIND" = yes ] ; then
51		echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 metaflac $*" >>test_metaflac.valgrind.log
52		valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 metaflac${EXE} $* 4>>test_metaflac.valgrind.log
53	else
54		metaflac${EXE} $*
55	fi
56}
57
58run_metaflac_silent ()
59{
60	if [ -z "$SILENT" ] ; then
61		run_metaflac $*
62	else
63		if [ "$FLAC__TEST_WITH_VALGRIND" = yes ] ; then
64			echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 metaflac $*" >>test_metaflac.valgrind.log
65			valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 metaflac${EXE} $* 2>/dev/null 4>>test_metaflac.valgrind.log
66		else
67			metaflac${EXE} $* 2>/dev/null
68		fi
69	fi
70}
71
72run_metaflac_to_metaflac_silent ()
73{
74	if [ "$FLAC__TEST_WITH_VALGRIND" = yes ] ; then
75		echo "valgrind --leak-check=yes --show-reachable=yes --num-callers=50 metaflac $*" >>test_metaflac.valgrind.log
76		valgrind --leak-check=yes --show-reachable=yes --num-callers=50 --log-fd=4 metaflac${EXE} $* 2>/dev/null 4>>test_metaflac.valgrind.log
77	else
78		metaflac${EXE} $1 | metaflac${EXE} $2 2>/dev/null
79	fi
80}
81
82
83check_flac ()
84{
85	run_flac --silent --test $flacfile || die "ERROR in $flacfile" 1>&2
86}
87
88echo "Generating stream..."
89bytes=80000
90if dd if=/dev/zero ibs=1 count=$bytes 2>/dev/null | flac${EXE} ${TOTALLY_SILENT} --force --verify -0 --input-size=$bytes --output-name=$flacfile --force-raw-format --endian=big --sign=signed --channels=1 --bps=8 --sample-rate=8000 - ; then
91	chmod +w $flacfile
92else
93	die "ERROR during generation"
94fi
95
96check_flac
97
98testdatadir=${top_srcdir}/test/metaflac-test-files
99
100filter ()
101{
102	# minor danger, changing vendor strings will change the length of the
103	# VORBIS_COMMENT block, but if we add "^  length: " to the patterns,
104	# we lose info about PADDING size that we need
105	# grep pattern 1: remove vendor string
106	# grep pattern 2: remove minimum/maximum frame and block size from STREAMINFO
107	# grep pattern 3: remove hexdump data from PICTURE metadata blocks
108	# sed pattern 1: remove stream offset values from SEEKTABLE points
109	$EGREP -v '^  vendor string: |^  m..imum .....size: |^    0000[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]: ' \
110		| sed -e 's/, stream_offset.*//'
111}
112metaflac_test ()
113{
114	case="$testdatadir/$1"
115	desc="$2"
116	args="$3"
117	expect="$case-expect.meta"
118	echo $ECHO_N "test $1: $desc... " $ECHO_C
119	run_metaflac $args $flacfile | filter > $testdir/out1.meta || die "ERROR running metaflac"
120	# Ignore lengths which can be affected by the version string.
121	sed "s/length:.*/length: XXX/" $testdir/out1.meta > $testdir/out.meta
122	diff -w $expect $testdir/out.meta > /dev/null 2>&1 || die "ERROR: metadata does not match expected $expect"
123	# To blindly accept (and check later): cp -f $testdir/out.meta $expect
124	echo OK
125}
126
127metaflac_test_nofilter ()
128{
129	case="$testdatadir/$1"
130	desc="$2"
131	args="$3"
132	expect="$case-expect.meta"
133	echo $ECHO_N "test $1: $desc... " $ECHO_C
134	run_metaflac $args $flacfile > $testdir/out.meta || die "ERROR running metaflac"
135	diff -w $expect $testdir/out.meta || die "ERROR: metadata does not match expected $expect"
136	echo OK
137}
138
139metaflac_test_binary ()
140{
141	case="$testdatadir/$1"
142	desc="$2"
143	args="$3"
144	expect="$case-expect.meta"
145	echo $ECHO_N "test $1: $desc... " $ECHO_C
146	run_metaflac $args $flacfile > $testdir/out.meta || die "ERROR running metaflac"
147	cmp $expect $testdir/out.meta || die "ERROR: metadata does not match expected $expect"
148	echo OK
149}
150
151metaflac_test case00 "--list" "--list"
152
153metaflac_test case01 "STREAMINFO --show-* shortcuts" "
154	--show-md5sum
155	--show-min-blocksize
156	--show-max-blocksize
157	--show-min-framesize
158	--show-max-framesize
159	--show-sample-rate
160	--show-channels
161	--show-bps
162	--show-total-samples"
163
164run_metaflac --preserve-modtime --add-padding=12345 $flacfile
165check_flac
166metaflac_test case02 "--add-padding" "--list"
167
168# some flavors of /bin/sh (e.g. Darwin's) won't even handle quoted spaces, so we underscore:
169run_metaflac --set-tag="ARTIST=The_artist_formerly_known_as_the_artist..." $flacfile
170check_flac
171metaflac_test case03 "--set-tag=ARTIST" "--list"
172
173run_metaflac --set-tag="ARTIST=Chuck_Woolery" $flacfile
174check_flac
175metaflac_test case04 "--set-tag=ARTIST" "--list"
176
177run_metaflac --set-tag="ARTIST=Vern" $flacfile
178check_flac
179metaflac_test case05 "--set-tag=ARTIST" "--list"
180
181run_metaflac --set-tag="TITLE=He_who_smelt_it_dealt_it" $flacfile
182check_flac
183metaflac_test case06 "--set-tag=TITLE" "--list"
184
185if [ ! $git_commit_version_hash ] ; then
186	metaflac_test case07 "--show-vendor-tag --show-tag=ARTIST" "--show-vendor-tag --show-tag=ARTIST"
187else
188	echo "test case07 is skipped because version is taken from git"
189fi
190
191run_metaflac --remove-first-tag=ARTIST $flacfile
192check_flac
193metaflac_test case08 "--remove-first-tag=ARTIST" "--list"
194
195run_metaflac --remove-tag=ARTIST $flacfile
196check_flac
197metaflac_test case09 "--remove-tag=ARTIST" "--list"
198
199metaflac_test case10 "--list --block-type=VORBIS_COMMENT" "--list --block-type=VORBIS_COMMENT"
200metaflac_test case11 "--list --block-number=0" "--list --block-number=0"
201metaflac_test case12 "--list --block-number=1,2,999" "--list --block-number=1,2,999"
202metaflac_test case13 "--list --block-type=VORBIS_COMMENT,PADDING" "--list --block-type=VORBIS_COMMENT,PADDING"
203metaflac_test case14 "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT" "--list --except-block-type=SEEKTABLE,VORBIS_COMMENT"
204metaflac_test case15 "--list --except-block-type=STREAMINFO" "--list --except-block-type=STREAMINFO"
205
206run_metaflac --add-padding=4321 $flacfile $flacfile
207check_flac
208metaflac_test case16 "--add-padding=4321 * 2" "--list"
209
210run_metaflac --merge-padding $flacfile
211check_flac
212metaflac_test case17 "--merge-padding" "--list"
213
214run_metaflac --add-padding=0 $flacfile
215check_flac
216metaflac_test case18 "--add-padding=0" "--list"
217
218run_metaflac --sort-padding $flacfile
219check_flac
220metaflac_test case19 "--sort-padding" "--list"
221
222run_metaflac --add-padding=0 $flacfile
223check_flac
224metaflac_test case20 "--add-padding=0" "--list"
225
226run_metaflac --remove-all-tags $flacfile
227check_flac
228metaflac_test case21 "--remove-all-tags" "--list"
229
230run_metaflac --remove --block-number=1,99 --dont-use-padding $flacfile
231check_flac
232metaflac_test case22 "--remove --block-number=1,99 --dont-use-padding" "--list"
233
234run_metaflac --remove --block-number=99 --dont-use-padding $flacfile
235check_flac
236metaflac_test case23 "--remove --block-number=99 --dont-use-padding" "--list"
237
238run_metaflac --remove --block-type=PADDING $flacfile
239check_flac
240metaflac_test case24 "--remove --block-type=PADDING" "--list"
241
242run_metaflac --remove --block-type=PADDING --dont-use-padding $flacfile
243check_flac
244metaflac_test case25 "--remove --block-type=PADDING --dont-use-padding" "--list"
245
246run_metaflac --add-padding=0 $flacfile $flacfile
247check_flac
248metaflac_test case26 "--add-padding=0 * 2" "--list"
249
250run_metaflac --remove --except-block-type=PADDING $flacfile
251check_flac
252metaflac_test case27 "--remove --except-block-type=PADDING" "--list"
253
254run_metaflac --remove-all $flacfile
255check_flac
256metaflac_test case28 "--remove-all" "--list"
257
258run_metaflac --remove-all --dont-use-padding $flacfile
259check_flac
260metaflac_test case29 "--remove-all --dont-use-padding" "--list"
261
262run_metaflac --remove-all --dont-use-padding $flacfile
263check_flac
264metaflac_test case30 "--remove-all --dont-use-padding" "--list"
265
266run_metaflac --set-tag="f=0123456789abcdefghij" $flacfile
267check_flac
268metaflac_test case31 "--set-tag=..." "--list"
269
270run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
271check_flac
272metaflac_test case32 "--remove-all-tags --set-tag=..." "--list"
273
274run_metaflac --remove-all-tags --set-tag="f=0123456789abcde" $flacfile
275check_flac
276metaflac_test case33 "--remove-all-tags --set-tag=..." "--list"
277
278run_metaflac --remove-all-tags --set-tag="f=0" $flacfile
279check_flac
280metaflac_test case34 "--remove-all-tags --set-tag=..." "--list"
281
282run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
283check_flac
284metaflac_test case35 "--remove-all-tags --set-tag=..." "--list"
285
286run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghi" $flacfile
287check_flac
288metaflac_test case36 "--remove-all-tags --set-tag=..." "--list"
289
290run_metaflac --remove-all-tags --set-tag="f=0123456789" $flacfile
291check_flac
292metaflac_test case37 "--remove-all-tags --set-tag=..." "--list"
293
294run_metaflac --remove-all-tags --set-tag="f=0123456789abcdefghij" $flacfile
295check_flac
296metaflac_test case38 "--remove-all-tags --set-tag=..." "--list"
297
298echo "TITLE=Tittle" | run_metaflac --import-tags-from=- $flacfile
299check_flac
300metaflac_test case39 "--import-tags-from=-" "--list"
301
302cat > vc.txt << EOF
303artist=Fartist
304artist=artits
305EOF
306run_metaflac --import-tags-from=vc.txt $flacfile
307check_flac
308metaflac_test case40 "--import-tags-from=[FILE]" "--list"
309
310rm vc.txt
311
312run_metaflac --add-replay-gain $flacfile
313check_flac
314metaflac_test case41 "--add-replay-gain" "--list"
315
316run_metaflac --remove-replay-gain $flacfile
317check_flac
318metaflac_test case42 "--remove-replay-gain" "--list"
319
320run_metaflac --scan-replay-gain $flacfile
321check_flac
322metaflac_test case42 "--scan-replay-gain" "--list"
323
324# CUESHEET blocks
325cs_in=${top_srcdir}/test/cuesheets/good.000.cue
326cs_out=metaflac.cue
327cs_out2=metaflac2.cue
328run_metaflac --import-cuesheet-from="$cs_in" $flacfile
329check_flac
330metaflac_test case43 "--import-cuesheet-from" "--list"
331run_metaflac --export-cuesheet-to=$cs_out $flacfile
332run_metaflac --remove --block-type=CUESHEET $flacfile
333check_flac
334metaflac_test case44 "--remove --block-type=CUESHEET" "--list"
335run_metaflac --import-cuesheet-from=$cs_out $flacfile
336check_flac
337metaflac_test case45 "--import-cuesheet-from" "--list"
338run_metaflac --export-cuesheet-to=$cs_out2 $flacfile
339echo "comparing cuesheets:"
340diff $cs_out $cs_out2 || die "ERROR, cuesheets should be identical"
341echo identical
342
343rm -f $cs_out $cs_out2
344
345# PICTURE blocks
346ncase=46
347for f in \
348	0.gif \
349	1.gif \
350	2.gif \
351; do
352	run_metaflac --import-picture-from="|image/gif|$f||${top_srcdir}/test/pictures/$f" $flacfile
353	check_flac
354	metaflac_test "case$ncase" "--import-picture-from" "--list"
355	ncase=$((ncase + 1))
356done
357for f in \
358	0.jpg \
359	4.jpg \
360; do
361	run_metaflac --import-picture-from="4|image/jpeg|$f||${top_srcdir}/test/pictures/$f" $flacfile
362	check_flac
363	metaflac_test "case$ncase" "--import-picture-from" "--list"
364	ncase=$((ncase + 1))
365done
366for f in \
367	0.png \
368	1.png \
369	2.png \
370	3.png \
371	4.png \
372	5.png \
373	6.png \
374	7.png \
375	8.png \
376; do
377	run_metaflac --import-picture-from="5|image/png|$f||${top_srcdir}/test/pictures/$f" $flacfile
378	check_flac
379	metaflac_test "case$ncase" "--import-picture-from" "--list"
380	ncase=$((ncase + 1))
381done
382[ $ncase = 60 ] || die "expected case# to be 60"
383
384fn=export-picture-check
385echo $ECHO_N "Testing --export-picture-to... " $ECHO_C
386run_metaflac --export-picture-to=$fn $flacfile
387check_flac
388cmp $fn ${top_srcdir}/test/pictures/0.gif || die "ERROR, exported picture file and original differ"
389echo OK
390rm -f $fn
391echo $ECHO_N "Testing --block-number --export-picture-to... " $ECHO_C
392run_metaflac --block-number=9 --export-picture-to=$fn $flacfile
393check_flac
394cmp $fn ${top_srcdir}/test/pictures/0.png || die "ERROR, exported picture file and original differ"
395echo OK
396rm -f $fn
397
398run_metaflac --remove --block-type=PICTURE $flacfile
399check_flac
400metaflac_test case60 "--remove --block-type=PICTURE" "--list"
401run_metaflac --import-picture-from="1|image/png|standard_icon|32x32x24|${top_srcdir}/test/pictures/0.png" $flacfile
402check_flac
403metaflac_test case61 "--import-picture-from" "--list"
404run_metaflac --import-picture-from="2|image/png|icon|64x64x24|${top_srcdir}/test/pictures/1.png" $flacfile
405check_flac
406metaflac_test case62 "--import-picture-from" "--list"
407run_metaflac --remove-all-tags-except=artist=title $flacfile
408check_flac
409metaflac_test case63 "--remove-all-tags-except=artist=title" "--list"
410metaflac_test case64 "--export-tags-to=-" "--export-tags-to=-"
411metaflac_test case64 "--show-all-tags" "--show-all-tags"
412
413run_flac ${top_srcdir}/test/foreign-metadata-test-files/AIFF-ID3.aiff --keep-foreign-metadata -f -o $flacfile
414metaflac_test_binary case65 "--data-format=binary" "--list --data-format=binary-headerless --block-type=APPLICATION:aiff"
415
416# UNKNOWN blocks
417flacfile=metaflac2.flac
418echo $ECHO_N "Testing FLAC file with unknown metadata... " $ECHO_C
419cp -p ${top_srcdir}/test/metaflac.flac.in $flacfile
420# remove the VORBIS_COMMENT block so vendor string changes don't interfere with the comparison:
421run_metaflac --remove --block-type=VORBIS_COMMENT --dont-use-padding $flacfile
422cmp $flacfile ${top_srcdir}/test/metaflac.flac.ok || die "ERROR, $flacfile and metaflac.flac.ok differ"
423echo OK
424
425flacfile=metaflac3.flac
426cp -p ${top_srcdir}/test/metaflac.flac.in $flacfile
427
428flacfile2=metaflac4.flac
429cp $flacfile $flacfile2
430run_metaflac --remove-all --dont-use-padding $flacfile
431
432echo $ECHO_N "Appending a streaminfo metadata block... " $ECHO_C
433if run_metaflac_to_metaflac_silent "--list --data-format=binary $flacfile2" "--append $flacfile" ; then
434        die "ERROR: it should have failed but didn't"
435else
436        echo "OK, it failed as it should"
437fi
438
439echo $ECHO_N "Appending a seektable metadata block... " $ECHO_C
440if run_metaflac_to_metaflac_silent "--list --data-format=binary --except-block-type=STREAMINFO $flacfile2" "--append $flacfile" ; then
441        die "ERROR: it should have failed but didn't"
442else
443        echo "OK, it failed as it should"
444fi
445
446run_metaflac --add-seekpoint=0 $flacfile
447
448echo $ECHO_N "Appending a vorbis comment metadata block... " $ECHO_C
449if run_metaflac_to_metaflac_silent "--list --data-format=binary --block-type=VORBIS_COMMENT $flacfile2" "--append $flacfile" ; then
450        echo "OK"
451else
452        die "ERROR, couldn't add vorbis comment metadata block"
453fi
454
455echo $ECHO_N "Appending another vorbis comment metadata block... " $ECHO_C
456if run_metaflac_to_metaflac_silent "--list --data-format=binary --block-type=VORBIS_COMMENT $flacfile2" "--append $flacfile" ; then
457        die "ERROR: it should have failed but didn't"
458else
459        echo "OK, it failed as it should"
460fi
461
462if run_metaflac_to_metaflac_silent "--list --data-format=binary --except-block-type=STREAMINFO,SEEKTABLE,VORBIS_COMMENT $flacfile2" "--append $flacfile" ; then
463		:
464else
465        die "ERROR, couldn't add vorbis comment metadata block"
466fi
467
468metaflac_test_nofilter case66 "--append" "--list"
469
470if run_metaflac_to_metaflac_silent "--list --data-format=binary --except-block-type=STREAMINFO,SEEKTABLE,VORBIS_COMMENT $flacfile2" "--append --block-number=0 $flacfile" ; then
471		:
472else
473        die "ERROR, couldn't add vorbis comment metadata block"
474fi
475
476metaflac_test_nofilter case67 "--append --block-number=0" "--list"
477
478rm -f metaflac-test-files/out.meta  metaflac-test-files/out1.meta
479