Commit 4b6b14ee authored by Anika Treffehn's avatar Anika Treffehn
Browse files

Merge branch 'main' of... 

Merge branch 'main' of https://forge.3gpp.org/rep/ivas-codec-pc/ivas-processing-scripts into small_fixes
parents 2b4a6ce6 cfbf2238

README.md

+15 −3
Original line number Diff line number Diff line
@@ -47,6 +47,13 @@ 


---



# Item generation



The `item_generation_scripts` module may be used to generate audio items for the P.800 listening test according to the scene description. All scenes must be fully described in the `SCENE.yml` file. The module takes monophonic audio

files from the specified input directory as the input and store the audio items in the requested format specification to the specified output directory. The module also generates the associated metadata files in case the target format requires so.



This module may be executed from the command-line with `python -m ivas_processing_scripts.generation item_gen_configs/SCENE.YML`.



# Listening test generation



The `ivas_processing_scripts` module helps to quickly setup listening tests with multiple (pre-)processing and post-processing options.
@@ -202,7 +209,7 @@ input: 
    ### 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 preprocessing fmt if possible)

    ### default = null (uses postprocessing fmt)

    # loudness_fmt: "BINAURAL"

    ### Pre-/post-trim individual signal(s) (ms) (negative values pad silence); default = 0

    # trim:
@@ -349,6 +356,8 @@ conditions_to_generate: 
          # fs: 48000

          ### Additional commandline options; default = null

          # opts: ["-q", "-no_delay_cmp"]

	  ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_fmt: "PLANARFOA"



  ### IVAS condition ###############################

  c07:
@@ -376,6 +385,8 @@ conditions_to_generate: 
          # fs: 48000

          ### Additional commandline options; default = null

          # opts: ["-q", "-no_delay_cmp"]

	  ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_fmt: "PLANARFOA"

            

  ### EVS condition ################################

  c08:
@@ -400,7 +411,7 @@ conditions_to_generate: 
          ### Decoder output sampling rate; default = null (same as input)

          # fs: 48000

	  ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_format: "PLANARFOA"

      # sba_fmt: "PLANARFOA"

```



</details>
@@ -473,8 +484,8 @@ This configuration has to match the channel configuration. If the provided list 
For the encoding stage `cod` and the decoding stage `dec`, the path to the IVAS_cod and IVAS_dec binaries can be specified under the key `bin`.

Additionally some resampling can be applied by using the key `fs` followed by the desired sampling rate.

The general bitstream processing configuration can be locally overwritten for each EVS and IVAS condition with the key `tx`.

For IVAS and EVS conditions the `sba_fmt` key is available to specify a SBA format of lower or same order compared to the input for SBA input formats.

The additional key `evs_lfe_9k6bps_nb` is only available for EVS conditions and ensures a bitrate of 9.6kbps and narrow band processing of the LFE channel(s).

Also only available for EVS conditions is the `sba_format` key where a SBA format of lower order than the input can be specified for SBA input formats.

#### IVAS

The configuration of the IVAS condition is similar to the EVS condition. However, only one bitrate for all channels (and metadata) can be specified.

In addition to that, the encoder and decoder take some additional arguments defined by the key `opts`.
@@ -521,6 +532,7 @@ The following additional executables are needed for the different processing ste 
| ESDRU                                           | esdru                 | https://github.com/openitu/STL                                                                              |

| Frame error pattern application                 | eid-xor               | 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!) |

| Reverberation module                            | reverb                | https://github.com/openitu/STL                                                                              |

| Filtering, Resampling                           | filter                | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip                                       |

| Random offset/seed generation (necessary for background noise and FER bitstream processing)   | random                | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip                                       |

| JBM network simulator                           | networkSimulator_g192 | https://www.3gpp.org/ftp/tsg_sa/WG4_CODEC/TSGS4_76/docs/S4-131277.zip                                       |

examples/TEMPLATE.yml

+6 −2
Original line number Diff line number Diff line
@@ -77,7 +77,7 @@ input: 
    ### 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 preprocessing fmt if possible)

    ### default = null (uses postprocessing fmt)

    # loudness_fmt: "BINAURAL"

    ### Pre-/post-trim individual signal(s) (ms) (negative values pad silence); default = 0

    # trim:
@@ -211,6 +211,8 @@ conditions_to_generate: 
      ### Bitstream options

      # tx:

          ### For possible arguments see overall bitstream modification

      ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_fmt: "PLANARFOA"



  ### IVAS condition ###############################

  c07:
@@ -241,6 +243,8 @@ conditions_to_generate: 
      ### Bitstream options

      # tx:

          ### For possible arguments see overall bitstream modification

      ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_fmt: "PLANARFOA"

            

  ### EVS condition ################################

  c08:
@@ -270,7 +274,7 @@ conditions_to_generate: 
      # tx:

          ### For possible arguments see overall bitstream modification

      ### Option to use SBA format of lower or same order (planar also possible) for SBA input formats

      # sba_format: "PLANARFOA"

      # sba_fmt: "PLANARFOA"



################################################

### Post-processing

experiments/selection/BS1534-4a/config/BS1534-4a.yml

+6 −6
Original line number Diff line number Diff line
@@ -51,52 +51,52 @@ conditions_to_generate: 
    ### EVS condition ################################

    c03:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 24400

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec:

    c04:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 32000

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec:

    c05:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 48000

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec:



    ### IVAS condition ###############################

    c06:

        type: ivas

        sba_fmt: "FOA"

        bitrates:

            - 96000

        cod:

            fmt: "FOA"

        dec:

            fmt: "HOA3"

    c07:

        type: ivas

        sba_fmt: "FOA"

        bitrates:

            - 128000

        cod:

            fmt: "FOA"

        dec:

            fmt: "HOA3"

    c08:

        type: ivas

        sba_fmt: "FOA"

        bitrates:

            - 160000

        cod:

            fmt: "FOA"

        dec:

            fmt: "HOA3"

experiments/selection/BS1534-4b/config/BS1534-4b.yml

+10 −18
Original line number Diff line number Diff line
@@ -51,52 +51,44 @@ conditions_to_generate: 
    ### EVS condition ################################

    c03:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 24400

            - 48000

        cod:

            fmt: "HOA2"

            opts: ["-max_band", "FB"]

        dec:

    c04:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 32000

            - 64000

        cod:

            fmt: "HOA2"

            opts: ["-max_band", "FB"]

        dec:

    c05:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 48000

            - 96000

        cod:

            fmt: "HOA2"

            opts: ["-max_band", "FB"]

        dec:



    ### IVAS condition ###############################

    c06:

        type: ivas

        sba_fmt: "HOA2"

        bitrates:

            - 96000

            - 192000

        cod:

            fmt: "HOA2"

        dec:

            fmt: "HOA3"

    c07:

        type: ivas

        sba_fmt: "HOA2"

        bitrates:

            - 128000

        cod:

            fmt: "HOA2"

        dec:

            fmt: "HOA3"

    c08:

        type: ivas

        bitrates:

            - 160000

            - 256000

        cod:

            fmt: "HOA2"

        dec:

            fmt: "HOA3"

experiments/selection/BS1534-5a/config/BS1534-5a.yml

+3 −3
Original line number Diff line number Diff line
@@ -51,26 +51,26 @@ conditions_to_generate: 
    ### EVS condition ################################

    c03:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 48000

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec:

    c04:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 64000

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec:

    c05:

        type: evs

        sba_fmt: "FOA"

        bitrates:

            - 96000

        cod:

            fmt: "FOA"

            opts: ["-max_band", "FB"]

        dec: