From 8b49c0eda6fa005b1d925b9275599ea96f9060f7 Mon Sep 17 00:00:00 2001 From: Archit Tamarapu Date: Tue, 26 Aug 2025 11:03:45 +0200 Subject: [PATCH 1/4] update READMEs and rename file used for selection testing --- README.md | 333 +++++++++++------- characterization_tests.md | 56 +++ ...rate_test.py => generate_test_selection.py | 0 ivas_processing_scripts/bin/README.md | 46 ++- tests/test_experiments.py | 2 +- 5 files changed, 298 insertions(+), 139 deletions(-) create mode 100644 characterization_tests.md rename generate_test.py => generate_test_selection.py (100%) diff --git a/README.md b/README.md index d47e2ea3..2e456315 100755 --- a/README.md +++ b/README.md @@ -1,32 +1,32 @@ -**** @@ -47,6 +47,111 @@ --- +# Running characterization experiments + +For an overview of the experiments, see [characterization_tests.md](characterization_tests.md) + +## Prerequisites + +- A working python environment (minimum version >= 3.9) with the required packages installed. +- The required additional binaries from ITU STL or the respective 3GPP contributions: + - The binaries must be placed in ivas_processing_scripts/bin OR + - a path specified in [binary_paths.yml](ivas_processing_scripts/binary_paths.yml) configuration file (please read the instructions carefully if using). + - Please note the required patch for networkSimulator_g192 that must be manually applied. +- EVS fixed point binaries + - These should be placed in the bin folder and named EVS_cod_fx and EVS_dec_fx +- Compiled versions of the codec from the BASOP repository: + - Binaries compiled with ivas_float_update should be placed in the bin folder and named IVAS_cod_flt_ref and IVAS_dec_flt_ref + - Binaries compiled with main (BASOP) should be placed in the bin folder and named IVAS_cod_fx and IVAS_dec_fx +- IVAS_rend from the floating-point repository: + - This should be placed in the bin folder and named named IVAS_rend +- A local clone of this repository + +## Setup + +- Ensure you are on the latest version of the main branch of the processing scripts repo (`git pull`) +- Navigate to the box.com folder “Inbox_selected” for the experiment you wish to run. +- Download the experiment folder, e.g., “Inbox_selected/P.800/P.800-1” +- Copy/move the downloaded items into the corresponding folder in experiments/characterization in your copy of the processing scripts repo. +- e.g., `cp -r ~/Downloads/P.800-1/\* experiments/characterization/P800-1/` + +## Processing + +Run the processing from the root directory of the repository by invoking the python module with the experiment configuration YAML file: + +```sh +python3 -m ivas_processing_scripts experiments/characterization/P800-1/config/P800-1_cat1_STEREO-16LKFS.yml +``` + +Repeat the above step for all configuration files to process all categories and levels. + +Notes: + +- The python module does NOT accept a list of configs; they must be run individually. +- This can be somewhat worked around with a shell loop, but please note this can make finding an error more difficult: + +```sh +for config in $(ls experiments/characterization/P800-1/config/*.yml); do python3 -m ivas_processing_scripts $config; done +``` + +## Follow up tasks + +After the processing is finished, the outputs will be present in the respective `proc_output` directories. + +- For P.800 tests, these outputs need to be collected according to the test plan to assemble the final outputs required for P.800 test software. +- For MUSHRA tests, the outputs may be used directly, or in case of multi-input format experiments again need to be manually assembled. + +At this point of time there is no script to automatically perform this. + +## Directory structure + +### P.800 experiments + +```bash +. +└── P800-1 + ├── background_noise + │ └── + ├── config + │ └── + ├── proc_input + │ ├── cat1 + │ │ ├── + │ │ ├── for ISM metadata + │ │ └── for MASA metadata + │ ├── cat2... + │ └── ...cat6 + └── proc_output + ├── cat1 + │ ├── out_-16LKFS + │ │ ├── c01 + │ │ │ └── + │ │ ├── c02... + │ │ └── ...cXX + │ ├── out_-26LKFS + │ └── out_-36LKFS + ├── cat2... + └── ...cat6 +``` + +### BS.1534 experiments + +```bash +. +└── BS1534-1 + ├── config + │ └── + ├── proc_input[_FMT] # for multiple input formats, suffix is present + │ ├── + │ ├── for ISM metadata + │ └── for MASA metadata + └── proc_output[_FMT] # for multiple input formats, suffix is present + ├── c01 + │ └── + ├── c02... + └── ...cXX +``` + # 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). @@ -86,7 +191,7 @@ Start by running a single scene to verify settings. Output includes both audio a The addition of custom background noise at specific level is supported for the STEREO and SBA formats only. For ISMs it's not applicable. For OMASA and OSBA formats, it is expected that the backround noise is provided in the FOA/HOA2/HOA3 format as the first item in the `input` list. -### Item processing +### Item processing (selection) The input has to be in the folder `experiments/selection/P800-{X}/proc_input_{l}`. If item generation is performed previous to this step, the corresponding files are already in the right folder. If this step is performed independently of the previous one the input files have to be copied to the respective folder sorted by category. @@ -104,7 +209,7 @@ For more information about this processing step see The set up for the MUSHRA test only consists of the item processing. -### Item processing +### Item processing (Selection) To process a BS1534-{X}{x} (X = 1, 2, ...7, x = a, b) listening test, the input files have to be placed in the folder `experiments/selection/BS1534-{X}{x}/proc_input_{l}` and the command `python generate_test.py BS1534-{X}{x},{l}` has to be run from the root of the repository. 'l' stands for the listening lab designator: a (Force Technology), b (HEAD acoustics), c (MQ University), d (Mesaqin.com). @@ -220,18 +325,18 @@ output_path: "./tmp_output" ### If input format is ISM{1-4} a path for the metadata files can be specified; ### default = null (for ISM search for item_name.{wav, raw, pcm}.{0-3}.csv in input folder, otherise ignored) # metadata_path: - ### Path can be set for all items with the 'all_items' key (automatic search for item_name.{wav, raw, pcm}.{0-3}.csv within this folder) - # all_items: ".../metadata_folder" - ### Path can be set for all items individually with 'item{1-4}' keys - ### 'item{1-4}' keys can also be renamed to the input file names including extension {wav, raw, pcm} - ### Either list individual files for all objects or name folder for automatic search for one item - # item1: - # - ".../meta_all_obj" - # item2: - # - ".../meta_obj1.csv" - # - ".../meta_ob2.csv" - # noise.wav: - # - ".../metadata_folder_for_noise_item" +### Path can be set for all items with the 'all_items' key (automatic search for item_name.{wav, raw, pcm}.{0-3}.csv within this folder) +# all_items: ".../metadata_folder" +### Path can be set for all items individually with 'item{1-4}' keys +### 'item{1-4}' keys can also be renamed to the input file names including extension {wav, raw, pcm} +### Either list individual files for all objects or name folder for automatic search for one item +# item1: +# - ".../meta_all_obj" +# item2: +# - ".../meta_obj1.csv" +# - ".../meta_ob2.csv" +# noise.wav: +# - ".../metadata_folder_for_noise_item" ### Select only a subset of items ### searches for the specified substring in found filenames; default = null @@ -269,31 +374,31 @@ input: ### Pre-processing step performed prior to core processing for all conditions ### If not defined, preprocessing step is skipped # preprocessing: - ### Target format used in rendering from input format; default = null (no rendering) - # fmt: "7_1_4" - ### Define mask (HP50 or 20KBP) for input signal filtering; default = null - # mask: "HP50" - ### Gain factor to be applied BEFORE any other processing (linear, or add dB suffix) - # gain_pre: 10 dB - ### Gain factor to be applied AFTER any other processing (linear, or add dB suffix) - # gain_post: 3.1622776602 - ### Target sampling rate in Hz for resampling; default = null (no resampling) - # fs: 16000 - ### Target loudness in LKFS; default = null (no loudness change applied) - # loudness: -26 - ### Spatial audio format in which loudness is adjusted (only used if preprocessing loudness is not null); - ### default = null (uses postprocessing fmt) - # loudness_fmt: "BINAURAL" - ### Pre-/post-trim individual signal(s) (ms) (negative values pad silence); default = 0 - # trim: - # - 50 - # - -50 - ### Flag for using noise (amplitude +-4) instead of silence for padding; default = false (silence) - # pad_noise: true - ### Value for application of delay (ms) (negative values advance); default = 0 - # delay: 20 - ### Length of window used at start/end of signal (ms); default = 0 - # window: 100 +### Target format used in rendering from input format; default = null (no rendering) +# fmt: "7_1_4" +### Define mask (HP50 or 20KBP) for input signal filtering; default = null +# mask: "HP50" +### Gain factor to be applied BEFORE any other processing (linear, or add dB suffix) +# gain_pre: 10 dB +### Gain factor to be applied AFTER any other processing (linear, or add dB suffix) +# gain_post: 3.1622776602 +### Target sampling rate in Hz for resampling; default = null (no resampling) +# fs: 16000 +### Target loudness in LKFS; default = null (no loudness change applied) +# loudness: -26 +### Spatial audio format in which loudness is adjusted (only used if preprocessing loudness is not null); +### default = null (uses postprocessing fmt) +# loudness_fmt: "BINAURAL" +### Pre-/post-trim individual signal(s) (ms) (negative values pad silence); default = 0 +# trim: +# - 50 +# - -50 +### Flag for using noise (amplitude +-4) instead of silence for padding; default = false (silence) +# pad_noise: true +### Value for application of delay (ms) (negative values advance); default = 0 +# delay: 20 +### Length of window used at start/end of signal (ms); default = 0 +# window: 100 ``` @@ -305,29 +410,29 @@ input: ```yaml # preprocessing_2: - ### Options for processing of the concatenated item (concatenate_input: true) or - ### the individual items (concatenate_input: false) after previous pre-processing step - ### Horizontally concatenate input items into one long file; default = false - # concatenate_input: true - ### Specify the concatenation order in a list of strings. If not specified, the concatenation order would be - ### as per the filesystem on the users' device - ### Should only be used if concatenate_input = true - # concatenation_order: [] - ### Specify preamble duration in ms; default = 0 - # preamble: 10000 - ### Flag wheter to use noise (amplitude +-4) for the preamble or silence; default = false (silence) - # preamble_noise: true - ### Additive background noise - # background_noise: - ### SNR for background noise in dB; REQUIRED for prerecorded background noise and ignored for low level noise - # snr: 10 - ### REQUIRED: Either background noise path or low level noise flag - ### Path to background noise, must have same format and sampling rate as input signal(s); default = null - # background_noise_path: ".../noise.wav" - ### Flag for using low level [-4,+4] background noise; default = false - # low_level_noise: true - ### Flag for repeating the whole signal once and discarding the first half after processing - # repeat_signal: true +### Options for processing of the concatenated item (concatenate_input: true) or +### the individual items (concatenate_input: false) after previous pre-processing step +### Horizontally concatenate input items into one long file; default = false +# concatenate_input: true +### Specify the concatenation order in a list of strings. If not specified, the concatenation order would be +### as per the filesystem on the users' device +### Should only be used if concatenate_input = true +# concatenation_order: [] +### Specify preamble duration in ms; default = 0 +# preamble: 10000 +### Flag wheter to use noise (amplitude +-4) for the preamble or silence; default = false (silence) +# preamble_noise: true +### Additive background noise +# background_noise: +### SNR for background noise in dB; REQUIRED for prerecorded background noise and ignored for low level noise +# snr: 10 +### REQUIRED: Either background noise path or low level noise flag +### Path to background noise, must have same format and sampling rate as input signal(s); default = null +# background_noise_path: ".../noise.wav" +### Flag for using low level [-4,+4] background noise; default = false +# low_level_noise: true +### Flag for repeating the whole signal once and discarding the first half after processing +# repeat_signal: true ``` @@ -342,22 +447,22 @@ input: ### e.g. frame error insertion or transport simulation for JBM testing ### can be given globally or in individual conditions of type ivas or evs # tx: - ### REQUIRED: Type of bitstream processing; possible types: "JBM" or "FER" - #type: "JBM" - ### JBM - ### REQUIRED: either error_pattern or error_profile - ### delay error profile file - # error_pattern: ".../dly_error_profile.dat" - ### Index of one of the existing delay error profile files to use (1-11) - # error_profile: 5 - ## nFramesPerPacket parameter for the network simulator (optional); default = 1 - # n_frames_per_packet: 2 - ### FER - ### REQUIRED: either error_pattern or error_rate - ### Frame error pattern file - # error_pattern: "path/pattern.192" - ### Error rate in percent - # error_rate: 5 +### REQUIRED: Type of bitstream processing; possible types: "JBM" or "FER" +#type: "JBM" +### JBM +### REQUIRED: either error_pattern or error_profile +### delay error profile file +# error_pattern: ".../dly_error_profile.dat" +### Index of one of the existing delay error profile files to use (1-11) +# error_profile: 5 +## nFramesPerPacket parameter for the network simulator (optional); default = 1 +# n_frames_per_packet: 2 +### FER +### REQUIRED: either error_pattern or error_rate +### Frame error pattern file +# error_pattern: "path/pattern.192" +### Error rate in percent +# error_rate: 5 ``` @@ -628,19 +733,7 @@ The processing chain is as follows: The following additional executables are needed for the different processing steps: -| Processing step | Executable | Where to find | -| ------------------------------------------------------------------------------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------- | -| Loudness measurement and adjustment | bs1770demo | (Note branch) | -| MNRU | p50fbmnru | | -| ESDRU | esdru | | -| Frame error pattern application | eid-xor | | -| Error pattern generation | gen-patt | (Note: Version in is buggy!) | -| Reverberation module | reverb | | -| Filtering, Resampling | filter | | -| Random offset/seed generation (necessary for background noise and FER bitstream processing) | random | | -| JBM network simulator | networkSimulator_g192 | | -| MASA rendering (also used in loudness measurement of MASA items) | masaRenderer, masaAnalyzer | | -| EVS reference conditions | EVS_cod, EVS_dec | | +--8<-- "ivas_processing_scripts/bin/README.md" The necessary binaries have to be either placed in the [ivas_processing_scripts/bin](./ivas_processing_scripts/bin) folder or the path has to be specified in [ivas_processing_scripts/binary_paths.yml](./ivas_processing_scripts/binary_paths.yml). diff --git a/characterization_tests.md b/characterization_tests.md new file mode 100644 index 00000000..3a15f3d3 --- /dev/null +++ b/characterization_tests.md @@ -0,0 +1,56 @@ +# Characterization experiments + +Each link in the table leads to the config directory of the respective experiment. + +## P.800 + +| Experiment | Format | +| ------------------------------------------------------- | -------------------- | +| [P800-1](experiments/characterization/P800-1/config/) | Stereo | +| [P800-2](experiments/characterization/P800-2/config/) | Stereo | +| [P800-3](experiments/characterization/P800-3/config/) | FOA | +| [P800-4](experiments/characterization/P800-4/config/) | HOA2 | +| [P800-5](experiments/characterization/P800-5/config/) | HOA3 | +| [P800-6](experiments/characterization/P800-6/config/) | MC 5.1, 7.1 | +| [P800-7](experiments/characterization/P800-7/config/) | MC 5.1+4, 7.1+4 | +| [P800-8](experiments/characterization/P800-8/config/) | MC - Mixed CICP | +| [P800-9](experiments/characterization/P800-9/config/) | 1-2 Objects | +| [P800-10](experiments/characterization/P800-10/config/) | 3-4 Objects | +| [P800-11](experiments/characterization/P800-11/config/) | 1-4 Objects | +| [P800-12](experiments/characterization/P800-12/config/) | MASA 1 TC | +| [P800-13](experiments/characterization/P800-13/config/) | MASA 2 TCs | +| [P800-14](experiments/characterization/P800-14/config/) | MASA 1-2 TC | +| [P800-15](experiments/characterization/P800-15/config/) | OSBA (1-2 objects) | +| [P800-16](experiments/characterization/P800-16/config/) | OSBA (3-4 objects) | +| [P800-17](experiments/characterization/P800-17/config/) | OSBA (1-4 objects) | +| [P800-18](experiments/characterization/P800-18/config/) | OMASA (1-2 objects) | +| [P800-19](experiments/characterization/P800-19/config/) | OMASA (3-4 objects) | +| [P800-20](experiments/characterization/P800-20/config/) | OMASA (1-4 objects) | +| [P800-21](experiments/characterization/P800-21/config/) | JBM with Stereo | +| [P800-22](experiments/characterization/P800-22/config/) | JBM with 1-2 objects | +| [P800-23](experiments/characterization/P800-23/config/) | JBM with FOA | + +## BS.1534 + +| Experiment | Format | +| ----------------------------------------------------------- | -------------------------- | +| [BS1534-1](experiments/characterization/BS1534-1/config/) | Stereo | +| [BS1534-2](experiments/characterization/BS1534-2/config/) | Stereo | +| [BS1534-3](experiments/characterization/BS1534-3/config/) | FOA | +| [BS1534-4](experiments/characterization/BS1534-4/config/) | FOA | +| [BS1534-5](experiments/characterization/BS1534-5/config/) | HOA3 | +| [BS1534-6](experiments/characterization/BS1534-6/config/) | Multichannel 5.1 | +| [BS1534-7](experiments/characterization/BS1534-7/config/) | Multi-channel 5.1, 7.1 | +| [BS1534-8](experiments/characterization/BS1534-8/config/) | Multi-channel 5.1+2, 5.1+4 | +| [BS1534-9](experiments/characterization/BS1534-9/config/) | Multi-channel 7.1+4 | +| [BS1534-10](experiments/characterization/BS1534-10/config/) | ISM 1-2 | +| [BS1534-11](experiments/characterization/BS1534-11/config/) | ISM 3-4 | +| [BS1534-12](experiments/characterization/BS1534-12/config/) | ISM 3-4 | +| [BS1534-13](experiments/characterization/BS1534-13/config/) | MASA (1TC) | +| [BS1534-14](experiments/characterization/BS1534-14/config/) | MASA (1TC) | +| [BS1534-15](experiments/characterization/BS1534-15/config/) | MASA (2TC) | +| [BS1534-16](experiments/characterization/BS1534-16/config/) | OSBA (1-4 obj.) | +| [BS1534-17](experiments/characterization/BS1534-17/config/) | OSBA (1-4 obj.) | +| [BS1534-18](experiments/characterization/BS1534-18/config/) | OMASA (1-4 obj.) | +| [BS1534-19](experiments/characterization/BS1534-19/config/) | Stereo downmix for EVS | +| [BS1534-20](experiments/characterization/BS1534-20/config/) | ISM 6 DoF (4 objects) | diff --git a/generate_test.py b/generate_test_selection.py similarity index 100% rename from generate_test.py rename to generate_test_selection.py diff --git a/ivas_processing_scripts/bin/README.md b/ivas_processing_scripts/bin/README.md index 413de93a..e3842a91 100755 --- a/ivas_processing_scripts/bin/README.md +++ b/ivas_processing_scripts/bin/README.md @@ -1,20 +1,30 @@ -Necessary additional executables: +# Necessary additional executables -| Processing step | Executable | Where to find | -| ---------------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------- | -| Loudness measurement and adjustment | bs1770demo | https://github.com/ErikNorvell-Ericsson/STL (Note branch) | -| MNRU | p50fbmnru | https://github.com/openitu/STL | -| ESDRU | esdru | https://github.com/openitu/STL | -| Frame error pattern application | eid-xor | https://github.com/openitu/STL | -| Reverberation module | reverb | https://github.com/openitu/STL | -| Error pattern generation | gen-patt | https://www.itu.int/rec/T-REC-G.191-201003-S/en (Note: Version in https://github.com/openitu/STL is buggy!) | -| Filtering, Resampling | filter | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip | -| Random offset/seed generation [^1] | random | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip | -| JBM network simulator [^2] | networkSimulator_g192 | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip | -| Patch to MAX_FRAME_SIZE for JBM network simulator from above | networkSimulator_g192 | https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_123-e/Docs/S4-230604.zip | -| MASA rendering (also used in loudness measurement of MASA items) | masaRenderer | https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_122_Athens/Docs/S4-230221.zip | -| EVS reference conditions | EVS_cod, EVS_dec | https://www.3gpp.org/ftp/Specs/archive/26_series/26.443/26443-h00.zip | -| EVS JBM conditions | dlyerr_2_errpat | http://ftp.3gpp.org/tsg_sa/WG4_CODEC/TSGS4_70/Docs/S4-121077.zip | + +| Processing Step | Executable | Source | +|----------------------------------------------|----------------------------|--------------------------------------------------------------------------------------------| +| Loudness measurement and adjustment | `bs1770demo` | [ErikNorvell-Ericsson/STL (Note branch)](https://github.com/ErikNorvell-Ericsson/STL) | +| EVS JBM conditions | `dlyerr_2_errpat` | [3GPP S4-121077](http://ftp.3gpp.org/tsg_sa/WG4_CODEC/TSGS4_70/Docs/S4-121077.zip) | +| Frame error pattern application | `eid-xor` | [openitu/STL](https://github.com/openitu/STL) | +| ESDRU | `esdru` | [openitu/STL](https://github.com/openitu/STL) | +| EVS reference conditions (floating-point) | `EVS_cod`, `EVS_dec` | [3GPP 26.443](https://www.3gpp.org/ftp/Specs/archive/26_series/26.443/26443-h00.zip) | +| EVS reference conditions (fixed-point) | `EVS_cod_fx`, `EVS_dec_fx` | [3GPP 26.452](https://www.3gpp.org/ftp/Specs/archive/26_series/26.452/26452-i00.zip) | +| Filtering, Resampling | `filter` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | +| Error pattern generation | `gen-patt` | [ITU-T G.191](https://www.itu.int/rec/T-REC-G.191-201003-S/en) :warning: [^1] | +| MASA rendering and loudness measurement [^2] | `IVAS_rend` | [IVAS Codec](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec) | +| MASA format creation | `masaAnalyzer` | [Nokia MASA tools](https://github.com/Nokia-Bell-Labs/MASA_tools_for_IVAS) | +| JBM network simulator [^3] | `networkSimulator_g192` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | +| JBM network simulator patch | `networkSimulator_g192` | [3GPP S4-230604](https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_123-e/Docs/S4-230604.zip) | +| MNRU | `p50fbmnru` | [openitu/STL](https://github.com/openitu/STL) | +| Random offset/seed generation [^4] | `random` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | +| Reverberation module | `reverb` | [openitu/STL](https://github.com/openitu/STL) | -[^1]: necessary for background noise and FER bitstream processing -[^2]: requires manual patching +[^1]: :warning: version in STL is buggy! + +[^2]: formerly required masaRenderer (now deprecated: https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_122_Athens/Docs/S4-230221.zip) + +[^3]: requires manual patching + +[^4]: necessary for background noise and FER bitstream processing + + \ No newline at end of file diff --git a/tests/test_experiments.py b/tests/test_experiments.py index b645d3a9..fe959f61 100644 --- a/tests/test_experiments.py +++ b/tests/test_experiments.py @@ -51,7 +51,7 @@ from tests.constants import ( HERE = Path(__file__).parent.absolute() sys.path.append(HERE.parent) -from generate_test import Arguments, create_experiment_setup # NOQA +from generate_test_selection import Arguments, create_experiment_setup # NOQA N_INPUT_SIGNALS = 2 -- GitLab From 0647ba3bbfe9f81f45eb15a3a9c9034c2d25b74e Mon Sep 17 00:00:00 2001 From: Archit Tamarapu Date: Tue, 26 Aug 2025 11:11:24 +0200 Subject: [PATCH 2/4] try different include syntax --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e456315..91d8301c 100755 --- a/README.md +++ b/README.md @@ -733,7 +733,7 @@ The processing chain is as follows: The following additional executables are needed for the different processing steps: ---8<-- "ivas_processing_scripts/bin/README.md" +::include{ivas_processing_scripts/bin/README.md} The necessary binaries have to be either placed in the [ivas_processing_scripts/bin](./ivas_processing_scripts/bin) folder or the path has to be specified in [ivas_processing_scripts/binary_paths.yml](./ivas_processing_scripts/binary_paths.yml). -- GitLab From 363db6effeedb648ca8fa4ef75c3bcc3044d18b3 Mon Sep 17 00:00:00 2001 From: Archit Tamarapu Date: Tue, 26 Aug 2025 11:13:23 +0200 Subject: [PATCH 3/4] reference file instead of attempting to include it --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 91d8301c..c0bebb30 100755 --- a/README.md +++ b/README.md @@ -731,9 +731,7 @@ The processing chain is as follows: ## Additional Executables -The following additional executables are needed for the different processing steps: - -::include{ivas_processing_scripts/bin/README.md} +Additional executables are needed for the different processing steps, please see the dedicated [README](ivas_processing_scripts/bin/README.md). The necessary binaries have to be either placed in the [ivas_processing_scripts/bin](./ivas_processing_scripts/bin) folder or the path has to be specified in [ivas_processing_scripts/binary_paths.yml](./ivas_processing_scripts/binary_paths.yml). -- GitLab From 0533226b3d117228680a5f60dc7edc8752b8a71b Mon Sep 17 00:00:00 2001 From: Archit Tamarapu Date: Tue, 26 Aug 2025 11:18:48 +0200 Subject: [PATCH 4/4] update link for gen-patt --- ivas_processing_scripts/bin/README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/ivas_processing_scripts/bin/README.md b/ivas_processing_scripts/bin/README.md index fc513627..8c44045e 100755 --- a/ivas_processing_scripts/bin/README.md +++ b/ivas_processing_scripts/bin/README.md @@ -11,18 +11,17 @@ | EVS reference conditions (floating-point) | `EVS_cod`, `EVS_dec` | [3GPP 26.443](https://www.3gpp.org/ftp/Specs/archive/26_series/26.443/26443-h00.zip) | | EVS reference conditions (fixed-point) | `EVS_cod_fx`, `EVS_dec_fx` | [3GPP 26.452](https://www.3gpp.org/ftp/Specs/archive/26_series/26.452/26452-i00.zip) | | Filtering, Resampling | `filter` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | -| Error pattern generation | `gen-patt` | [ITU-T G.191](https://www.itu.int/rec/T-REC-G.191-201003-S/en) :warning: [^1] | -| MASA rendering and loudness measurement [^2] | `IVAS_rend` | [IVAS Codec](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec) | +| Error pattern generation | `gen-patt` | [openitu/STL](https://github.com/openitu/STL) | +| MASA rendering and loudness measurement [^1] | `IVAS_rend` | [IVAS Codec](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec) | | MASA format creation | `masaAnalyzer` | [Nokia MASA tools](https://github.com/Nokia-Bell-Labs/MASA_tools_for_IVAS) | -| JBM network simulator [^3] | `networkSimulator_g192` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | +| JBM network simulator [^2] | `networkSimulator_g192` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | | JBM network simulator patch | `networkSimulator_g192` | [3GPP S4-230604](https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_123-e/Docs/S4-230604.zip) | | MNRU | `p50fbmnru` | [openitu/STL](https://github.com/openitu/STL) | -| Random offset/seed generation [^4] | `random` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | +| Random offset/seed generation [^3] | `random` | [3GPP S4-131277](https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip) | | Reverberation module | `reverb` | [openitu/STL](https://github.com/openitu/STL) | -[^1]: :warning: version in STL is buggy! -[^2]: formerly required masaRenderer (now deprecated: https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_122_Athens/Docs/S4-230221.zip) -[^3]: requires manual patching -[^4]: necessary for background noise and FER bitstream processing +[^1]: formerly required masaRenderer (now deprecated: https://www.3gpp.org/ftp/TSG_SA/WG4_CODEC/TSGS4_122_Athens/Docs/S4-230221.zip) +[^2]: requires manual patching +[^3]: necessary for background noise and FER bitstream processing -- GitLab