Commit e1890245 authored by Ripinder Singh's avatar Ripinder Singh
Browse files

Make refrence generation section collapsible



* Fix markdown lint fixes

Signed-off-by: default avatarRipinder Singh <ripinder.singh@dolby.com>
parent 961ad4a7
Loading
Loading
Loading
Loading
Loading
+60 −52
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
This folder contains scripts for running IVAS conformance tests.

## Setup for Reference Platform

  Reference platform is Ubuntu 24.04

- Verify the Ubuntu Linux release is 24.04
@@ -29,7 +30,7 @@ This folder contains scripts for running IVAS conformance tests.
  InstalledDir: /usr/bin
  ```

  It might be required to set Clang-18 as the defauly clang on the machine
  It might be required to set Clang-18 as the default clang on the machine

  ```shell
  sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-18 100
@@ -51,15 +52,20 @@ This folder contains scripts for running IVAS conformance tests.
  ```

## Reference Conformance Package Generation

<details>
<summary> <i> Expand for detailed procedure </i> </summary>

To generate reference conformance package for distribution
  #### Generate Reference Outputs and Readme.txt files

### Generate Reference Outputs and Readme.txt files

  ```shell
  sh ivas_be_conf_test_gen.sh
  ```

<details>
    <summary>Example Output</summary>
<summary> Example output of reference test generation </summary>
<pre><code>
::::::::::::::::::::::::
------------------------------------------
@@ -74,18 +80,20 @@ This folder contains scripts for running IVAS conformance tests.
</code></pre>
</details>

#### Generate Reference Decoded Outputs for the Reference Encoded files
### Generate Reference Decoded Outputs for the Reference Encoded files

  ```shell
  PYTHONPATH=scripts python scripts/ivas_conformance/runConformance.py --testvecDir $PWD/testvec --ref_build_path=testvec/bin  --regenerate-enc-refs
  ```

#### Generate a conformance package zip
### Generate a conformance package zip

  ```shell
  zip -r conformance.zip testvec scripts/ivas_conformance scripts/tools
  ```

</details>

## Run CUT tests on Target platform

  To run CUT binaries on the targeted platform, it is necessary to replicate the initial setup for python and dependency packages. The CUT build of the IVAS binaries should be made available in a selected folder and needed for the next step
@@ -128,10 +136,10 @@ This folder contains scripts for running IVAS conformance tests.
    +- dec/             : Folder containing all decoder tests CUT outputs
    +- enc/             : Folder containing all encoder tests CUT outputs
    +- renderer_short/  : Folder containing all renderer tests CUT outputs
      +- split_rendering/ : Folder containing all split rendering enc/dec testsCUT outputs
    +- split_rendering/ : Folder containing all split rendering enc/dec tests
  ```

## Perform the MLD based analysis on the CUT outputs on refernce platform (Ubuntu 24.04)
## Perform the MLD based analysis on the CUT outputs on reference platform (Ubuntu 24.04)

   If CUT test execution is done on a different platform, the scripts/CUT_OUTPUTS must be copied and provided in the reference platform's scripts/CUT_OUTPUTS. Then the following command is used to perform MLD based analysis on the same, encoded outputs will be implicitly decoded using reference decoder executables and MLD analysis performed on the reference decoded outputs.