Merge branch 'main' into...

  # TODO: temporarily use the RC1b tag

  - git restore .

  - git fetch

  - git checkout 20230516-RC1b-listening-tests

  - git checkout 20230616-selection-prerelease

  - echo "--------------------------------------------"

  - echo "Building codec on commit $(git rev-parse HEAD --short)"

  - echo "--------------------------------------------"

    - linux

  allow_failure: true

  script:

    - flake8 --max-line-length 88 --extend-ignore=E203,E501,E741

    - flake8 --max-line-length 88 --extend-ignore=E203,E402,E501,E741

format:

  stage: analyze

# Quick guide: How to set up a listening test

The setup for a listening test from the experiments folder according to the Processing Plan (IVAS-7) and Test Plan (IVAS-8) consists of two steps:

item generation and item processing.

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).

In the following sections the only purpose of the curly brackets is to mark the variables that thave to be replaced with the actual values.

## P800

The setup for a P800 test from the experiments folder consists of two steps:

item generation and item processing. The two steps can be applied independent of each other.

### Item generation

To set up the P800-{X} listening test (X = 1, 2, ...9) copy your mono input files to 'experiments/selection/P800-{X}/gen_input/items_mono'.

These files have to follow the naming scheme '{l}{LL}p0{X}{name_of_item}' where 'l' stands for the listening lab designator: a (Force Technology),

b (HEAD acoustics), c (MQ University), d (Mesaqin.com), and 'LL' stands for the language: EN, GE, JA, MA, DA, FR.

b (HEAD acoustics), c (MQ University), d (Mesaqin.com), and 'LL' stands for the language: EN, GE, JP, MA, DK, FR.

The impluse responses have to be copied to experiments/selection/P800-{X}/gen_input/IRs.

To generate the items run `python -m ivas_processing_scripts.generation experiments/selection/P800-{X}/config/item_gen_P800-{X}_{l}.yml` from the root folder of the repository.

The resulting files can be found in 'experiments/selection/P800-{X}/proc_input' sorted by category.

The resulting files can be found in 'experiments/selection/P800-{X}/proc_input_{l}' sorted by category.

For P800-3 the input files for the processing are already provided by the listening lab. This means this step can be skipped.

For tests with ISM input format (P800-6 and P800-7) no IRs are needed, only mono sentences

### Item processing

If the tests includes background noise, the corresponding files have to be copied to 'experiments/selection/P800-{X}/background_noise'.

The naming has to follow the scheme 'background_noise_cat{c}.wav' where 'c' denotes the category with a number between one and six.

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.

If the test includes background noise, the corresponding files have to be copied to 'experiments/selection/P800-{X}/background_noise'.

For most tests the naming has to follow the scheme 'background_noise_cat{c}.wav' where 'c' denotes the category with a number between one and six. For the P800-2 test, the naming has to follow 'background_noise_cat{c}-lab_{l}.wav'

To process the items run `python generate_test.py P800-{X},{l}` from the root folder of this repository.

The results can be found in 'experiments/selection/P800-{X}/proc_output'.

To process the items run `python generate_test.py P800-{X},{l}` from the root folder of the repository.

The results can be found in 'experiments/selection/P800-{X}/proc_output_{l}'.

For more information about this processing step see 

[How to generate the configs and process items for the selection test experiments](#how-to-generate-the-configs-and-process-items-for-the-selection-test-experiments).

# MUSHRA

todo

## MUSHRA

The set up for the MUSHRA test only consists of the item processing.

### Item processing

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).

The output can then be found in 'experiments7selection/BS1534-{X}{x}/proc_output_{l}'

The BS1534-7a and BS1534-7b tests are MASA experiments with FOA and HOA2 inputs. Therefore the input folder contains two subfolders called 'FOA' and 'HOA2'.

The input files have to be placed in the folders according to their format.

---