Skip to content

Commit

Permalink
added a Readme regarding osce testing
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGrumpySnail01 committed Oct 20, 2024
1 parent eef6d0a commit 5733c02
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions dnn/torch/osce/stndrd/qualification/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
This folder contains scripts for creating and running tests for qualifying a speech coding
enhancement method for use with Opus SILK.

The scripts have been tested with python 3.9, 3.10 and 3.11. Python dependencies are listed
in requirements.txt. In addition, the create_bistreams.py script will require sox to be
installed in PATH.

To run the test, download and extract testvectors https://media.xiph.org/opus/ietf/osce_testvectors_v0.zip.
The run_osce_tests.py script requires an executable of the enhanced opus decoder with
the same call signature as opus_demo, i.e.

EXECUTABLE -d SAMPLING_RATE NUMBER_OF_CHANNELS \[OPTIONS\] BITSTREAM PCM_OUTPUT

that produces a 16-bit PCM output file. To start the test, run

python run_osce_tests.py osce_testvectors_v0 my_test_output --opus-demo EXECUTABLE --opus-demo-options OPTIONS

which will prodce a text file my_test_output/test_results.txt containing the results (PASS/FAIL) for each
individual test. Furthermore, reference and test MOC scores are stored in yaml format in my_test_output/TESTNAME_moc.yml
under their group as primary key and clip name as secondary key.

Testvectors have been created from https://media.xiph.org/opus/ietf/osce_test_clips.zip using the script create_bitstreams.py.

0 comments on commit 5733c02

Please sign in to comment.