Chris@2438: #!/bin/bash
Chris@2438: #
Chris@2438: # Regression tests for layer export to CSV
Chris@2438: # Must be run from directory that contains this script
Chris@2438: 
Chris@2438: # NB hardcoded assumptions here about the contents of the session
Chris@2438: # file, so the session file (all.sv) is also hardcoded. The session is
Chris@2438: # expected to consist of:
Chris@2438: # 
Chris@2438: # - pane 1 with 3 layers (ruler, waveform, instants)
Chris@2438: # - pane 2 with 3 layers (ruler, waveform, values)
Chris@2438: # - pane 3 with 3 layers (ruler, image, regions)
Chris@2438: # - pane 4 with 3 layers (ruler, text, notes)
Chris@2438: # - pane 5 with 2 layers (ruler, 3d plot)
Chris@2438: # - pane 6 with 3 layers (ruler, spectrogram, boxes)
Chris@2438: # - pane 7 with 2 layers (ruler, peak frequency spectrogram)
Chris@2438: 
Chris@2438: set -e
Chris@2438: 
Chris@2438: if [ -n "$1" ]; then
Chris@2438:     echo "Usage: $0" 1>&2
Chris@2438:     exit 2
Chris@2438: fi
Chris@2438: 
Chris@2438: set -u
Chris@2438: 
Chris@2438: sv="../sonic-visualiser"
Chris@2438: if [ ! -f "$sv" -o ! -x "$sv" ]; then
Chris@2438:     echo "This script must be run from the sonic-visualiser/test directory" 1>&2
Chris@2438:     exit 1
Chris@2438: fi
Chris@2438: 
Chris@2557: version=$("$sv" -v 2>&1 | grep -v App)
Chris@2438: adequate=no
Chris@2438: case "$version" in
Chris@2438:     [012].*) ;;
Chris@2438:     3.[012]) ;;
Chris@2438:     3.[012].*) ;;
Chris@2438:     [1-9]*) adequate=yes ;;
Chris@2438:     *) echo "Failed to query Sonic Visualiser version" 1>&2
Chris@2438:        exit 1 ;;
Chris@2438: esac
Chris@2438: if [ "$adequate" = "no" ]; then
Chris@2438:     echo "Sonic Visualiser version must be at least 3.3 (supporting --osc-script option)" 1>&2
Chris@2438:     exit 1
Chris@2438: fi
Chris@2438: 
Chris@2438: session="all.sv"
Chris@2438: 
Chris@2438: if [ ! -f "$session" ]; then
Chris@2438:     echo "Session file $session not found" 1>&2
Chris@2438:     exit 1
Chris@2438: fi
Chris@2438: 
Chris@2438: tmpdir=$(mktemp -d)
Chris@2443: trap "rm -rf $tmpdir" 0
Chris@2438: 
Chris@2438: input="$tmpdir/input.sv"
Chris@2438: 
Chris@2438: cp "$session" "$input"
Chris@2438: 
Chris@2438: cat > "$tmpdir/script" <<EOF
Chris@2439: # Load the session file
Chris@2438: /open "$input"
Chris@2439: 
Chris@2439: # Select each exportable layer in turn and export to a CSV file
Chris@2438: /setcurrent 1 3
Chris@2438: /exportlayer "$tmpdir/instants.csv"
Chris@2438: /setcurrent 2 3
Chris@2438: /exportlayer "$tmpdir/values.csv"
Chris@2438: /setcurrent 3 2
Chris@2438: /exportlayer "$tmpdir/image.csv"
Chris@2438: /setcurrent 3 3
Chris@2438: /exportlayer "$tmpdir/regions.csv"
Chris@2438: /setcurrent 4 2
Chris@2438: /exportlayer "$tmpdir/text.csv"
Chris@2438: /setcurrent 4 3
Chris@2438: /exportlayer "$tmpdir/notes.csv"
Chris@2438: /setcurrent 5 2
Chris@2438: /exportlayer "$tmpdir/3dplot.csv"
Chris@2438: /setcurrent 6 2
Chris@2438: /exportlayer "$tmpdir/spectrogram.csv"
Chris@2438: /setcurrent 6 3
Chris@2438: /exportlayer "$tmpdir/boxes.csv"
Chris@2438: /setcurrent 7 2
Chris@2438: /exportlayer "$tmpdir/peakfreq.csv"
Chris@2439: 
Chris@2439: # Note layer can also be exported as MIDI
Chris@2439: /setcurrent 4 3
Chris@2439: /exportlayer "$tmpdir/notes.mid"
Chris@2439: 
Chris@2509: # And everything as SVL
Chris@2509: /setcurrent 1 3
Chris@2509: /exportlayer "$tmpdir/instants.svl"
Chris@2509: /setcurrent 2 3
Chris@2509: /exportlayer "$tmpdir/values.svl"
Chris@2509: /setcurrent 3 2
Chris@2509: /exportlayer "$tmpdir/image.svl"
Chris@2509: /setcurrent 3 3
Chris@2509: /exportlayer "$tmpdir/regions.svl"
Chris@2509: /setcurrent 4 2
Chris@2509: /exportlayer "$tmpdir/text.svl"
Chris@2509: /setcurrent 4 3
Chris@2509: /exportlayer "$tmpdir/notes.svl"
Chris@2509: /setcurrent 5 2
Chris@2509: /exportlayer "$tmpdir/3dplot.svl"
Chris@2509: /setcurrent 6 2
Chris@2509: /exportlayer "$tmpdir/spectrogram.svl"
Chris@2509: /setcurrent 6 3
Chris@2509: /exportlayer "$tmpdir/boxes.svl"
Chris@2509: /setcurrent 7 2
Chris@2509: /exportlayer "$tmpdir/peakfreq.svl"
Chris@2509: 
Chris@2509: # Now test exporting only the contents of a (multiple) selection. This
Chris@2509: # is only supported for CSV files.
Chris@2439: # First set waveform layer as current, to avoid snapping the selection
Chris@2439: # to the contents of an annotation layer.
Chris@2439: /setcurrent 1 2
Chris@2439: 
Chris@2439: # Make a selection
Chris@2439: /select 8 10
Chris@2439: /addselect 14 16
Chris@2439: 
Chris@2439: # And repeat all the previous exports
Chris@2439: /setcurrent 1 3
Chris@2439: /exportlayer "$tmpdir/selected-instants.csv"
Chris@2439: /setcurrent 2 3
Chris@2439: /exportlayer "$tmpdir/selected-values.csv"
Chris@2439: /setcurrent 3 2
Chris@2439: /exportlayer "$tmpdir/selected-image.csv"
Chris@2439: /setcurrent 3 3
Chris@2439: /exportlayer "$tmpdir/selected-regions.csv"
Chris@2439: /setcurrent 4 2
Chris@2439: /exportlayer "$tmpdir/selected-text.csv"
Chris@2439: /setcurrent 4 3
Chris@2439: /exportlayer "$tmpdir/selected-notes.csv"
Chris@2439: /setcurrent 5 2
Chris@2439: /exportlayer "$tmpdir/selected-3dplot.csv"
Chris@2439: /setcurrent 6 2
Chris@2439: /exportlayer "$tmpdir/selected-spectrogram.csv"
Chris@2439: /setcurrent 6 3
Chris@2439: /exportlayer "$tmpdir/selected-boxes.csv"
Chris@2439: /setcurrent 7 2
Chris@2439: /exportlayer "$tmpdir/selected-peakfreq.csv"
Chris@2439: 
Chris@2439: /setcurrent 4 3
Chris@2439: /exportlayer "$tmpdir/selected-notes.mid"
Chris@2439: 
Chris@2444: # If we also zoom in vertically in the 3d plot, our export should
Chris@2444: # include only the zoomed area - check this
Chris@2444: /setcurrent 5 2
Chris@2444: /zoomvertical 0 12
Chris@2444: /exportlayer "$tmpdir/selected-zoomed-3dplot.csv"
Chris@2444: 
Chris@2438: /quit
Chris@2438: EOF
Chris@2438: 
Chris@2438: "$sv" --no-splash --osc-script "$tmpdir/script"
Chris@2438: 
Chris@2438: for type in instants values image regions text notes 3dplot spectrogram boxes peakfreq ; do
Chris@2509:     for format in csv svl ; do
Chris@2509:         for pfx in "" "selected-"; do
Chris@2509:             if [ "$format" = "svl" ] && [ -n "$pfx" ]; then
Chris@2509:                 continue
Chris@2499:             fi
Chris@2509:             actual="$tmpdir/$pfx$type.$format"
Chris@2509:             expected="layers-expected/$pfx$type.$format"
Chris@2509:             if ! cmp -s "$actual" "$expected" ; then
Chris@2509:                 echo
Chris@2509:                 if [ -z "$pfx" ]; then
Chris@2509:                     echo "Test failed for file type $format, layer type \"$type\"!"
Chris@2509:                 else
Chris@2509:                     echo "Test failed for selected regions in layer type \"$type\"!"
Chris@2509:                 fi
Chris@2509:                 echo
Chris@2509:                 echo "Actual:"
Chris@2509:                 ls -l "$actual"
Chris@2509:                 echo "Expected:"
Chris@2509:                 ls -l "$expected"
Chris@2509:                 echo
Chris@2509:                 echo "Diff begins:"
Chris@2509:                 git diff --no-index --word-diff=color --word-diff-regex=. "$actual" "$expected" | head
Chris@2509:                 echo
Chris@2509:             fi
Chris@2509:         done
Chris@2439:     done
Chris@2439: done
Chris@2439: 
Chris@2444: for csv in selected-zoomed-3dplot.csv ; do
Chris@2444:     actual="$tmpdir/$csv"
Chris@2444:     expected="layers-expected/$csv"
Chris@2444:     if ! cmp -s "$actual" "$expected" ; then
Chris@2444:         echo
Chris@2444:         echo "Test failed for \"$csv\"!"
Chris@2444:         echo
Chris@2444:         echo "Actual:"
Chris@2444:         ls -l "$actual"
Chris@2444:         echo "Expected:"
Chris@2444:         ls -l "$expected"
Chris@2444:         echo
Chris@2444:         echo "Diff begins:"
Chris@2499:         git diff --no-index --word-diff=color --word-diff-regex=. "$actual" "$expected" | head
Chris@2444:         echo
Chris@2444:     fi
Chris@2444: done
Chris@2444: 
Chris@2439: for other in notes.mid selected-notes.mid ; do
Chris@2439:     actual="$tmpdir/$other"
Chris@2439:     expected="layers-expected/$other"
Chris@2438:     if ! cmp -s "$actual" "$expected" ; then
Chris@2438:         echo
Chris@2439:         if [ -z "$pfx" ]; then
Chris@2439:             echo "Test failed for \"$other\"!"
Chris@2439:         fi            
Chris@2438:         echo
Chris@2438:         echo "Actual:"
Chris@2438:         ls -l "$actual"
Chris@2439:         echo "Expected:"
Chris@2438:         ls -l "$expected"
Chris@2438:         echo
Chris@2439:         od -c "$actual" > "$actual".txt
Chris@2439:         od -c "$expected" > "$tmpdir/expected-$other".txt
Chris@2439:         echo
Chris@2439:         echo "Diff:"
Chris@2499:         git diff --no-index --word-diff=color --word-diff-regex=. "$actual".txt "expected-$other".txt | head
Chris@2438:         echo
Chris@2438:     fi
Chris@2438: done
Chris@2438: