Loading README.md +34 −0 Original line number Diff line number Diff line Loading @@ -259,6 +259,40 @@ This is essentially the contents of the `proc_final` directory produced from the └── BS1534-1_hashes.txt ``` ## Reporting issues If you encounter an issue while running the characterization tests, please follow the steps below depending on the type of issue you encounter. ### Crash in fixed point codec Example output for a crash: ```shell SystemError: Command returned non-zero exit status (-6): ivas_processing_scripts/bin/IVAS_cod_fx -max_band SWB -q -stereo 24400 32 experiments/characterization/P800_ACR-1/proc_output/cat1/out_-26LKFS/tmp_c27/20ms_aligned_files_concatenated.cod_fmt.wav experiments/characterization/P800_ACR-1/proc_output/cat1/out_-26LKFS/tmp_c27/20ms_aligned_files_concatenated.ivas.192 ``` 1. Copy the **entire traceback** to a text file for upload 2. Inspect the output for more information, and possibly the command that caused the crash, example: 3. Try to determine the output directory used, usually with the prefix `tmp_` in `proc_output`, in this case `tmp_c27` 4. Inspect the output files in the given directory, checking `.log` files for further info about commands that were run 5. Try to reproduce the crash outside of the scripts 6. Upload the required files to a new folder under [_EXTERNAL_IVAS_CHAR_MC/Issues](https://dolby.box.com/s/oc7k3ck8n04wbcknxu71t3wyvkq2cev4) 7. File an issue on the [BASOP repository](https://forge.3gpp.org/rep/sa4/audio/ivas-basop/-/issues) - Report git SHA for float reference codec, fixed point codec and processing scripts! ### Crash / unexpected behaviour in the scripts 1. Copy the **entire traceback** to a text file for upload 2. Inspect the output for more information, and where the exception occurred 3. If it is related to a certain condition in the script identify the related `tmp_` folder in `proc_output` 4. Collect the following files for upload - The `.yml` configuration file in **`proc_output`** - this is produced by the scripts and is NOT the one used to run the experiment - The main log file for the experiment, named the same as the above file with suffix `.log` - Any files in the related `tmp_` condition directory, if applicable. Use your discretion to choose pertinent files. 5. Upload the required files to a new folder under [_EXTERNAL_IVAS_CHAR_MC/Issues](https://dolby.box.com/s/oc7k3ck8n04wbcknxu71t3wyvkq2cev4) 6. File an issue on the [Processing scripts repository](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-processing-scripts/-/issues) - Report git SHA for float reference codec, fixed point codec and processing scripts! # Quick guide: How to set up a listening test This section describes step by step how to set up a listening test according to the Processing Plan (IVAS-7) and Test Plan (IVAS-8). Loading Loading
README.md +34 −0 Original line number Diff line number Diff line Loading @@ -259,6 +259,40 @@ This is essentially the contents of the `proc_final` directory produced from the └── BS1534-1_hashes.txt ``` ## Reporting issues If you encounter an issue while running the characterization tests, please follow the steps below depending on the type of issue you encounter. ### Crash in fixed point codec Example output for a crash: ```shell SystemError: Command returned non-zero exit status (-6): ivas_processing_scripts/bin/IVAS_cod_fx -max_band SWB -q -stereo 24400 32 experiments/characterization/P800_ACR-1/proc_output/cat1/out_-26LKFS/tmp_c27/20ms_aligned_files_concatenated.cod_fmt.wav experiments/characterization/P800_ACR-1/proc_output/cat1/out_-26LKFS/tmp_c27/20ms_aligned_files_concatenated.ivas.192 ``` 1. Copy the **entire traceback** to a text file for upload 2. Inspect the output for more information, and possibly the command that caused the crash, example: 3. Try to determine the output directory used, usually with the prefix `tmp_` in `proc_output`, in this case `tmp_c27` 4. Inspect the output files in the given directory, checking `.log` files for further info about commands that were run 5. Try to reproduce the crash outside of the scripts 6. Upload the required files to a new folder under [_EXTERNAL_IVAS_CHAR_MC/Issues](https://dolby.box.com/s/oc7k3ck8n04wbcknxu71t3wyvkq2cev4) 7. File an issue on the [BASOP repository](https://forge.3gpp.org/rep/sa4/audio/ivas-basop/-/issues) - Report git SHA for float reference codec, fixed point codec and processing scripts! ### Crash / unexpected behaviour in the scripts 1. Copy the **entire traceback** to a text file for upload 2. Inspect the output for more information, and where the exception occurred 3. If it is related to a certain condition in the script identify the related `tmp_` folder in `proc_output` 4. Collect the following files for upload - The `.yml` configuration file in **`proc_output`** - this is produced by the scripts and is NOT the one used to run the experiment - The main log file for the experiment, named the same as the above file with suffix `.log` - Any files in the related `tmp_` condition directory, if applicable. Use your discretion to choose pertinent files. 5. Upload the required files to a new folder under [_EXTERNAL_IVAS_CHAR_MC/Issues](https://dolby.box.com/s/oc7k3ck8n04wbcknxu71t3wyvkq2cev4) 6. File an issue on the [Processing scripts repository](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-processing-scripts/-/issues) - Report git SHA for float reference codec, fixed point codec and processing scripts! # Quick guide: How to set up a listening test This section describes step by step how to set up a listening test according to the Processing Plan (IVAS-7) and Test Plan (IVAS-8). Loading
