Commit 4940cd51 authored by TYAGIRIS's avatar TYAGIRIS
Browse files

modify readme and sparate readme for package generation

parent 419ba7c2

scripts/ivas_conformance/README.md

+1 −44
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 


This folder contains scripts for running IVAS conformance tests.



## Setup for Reference Platform

## Setup Used for Conformance package generation Platform



  Reference platform is Ubuntu 24.04
@@ -51,49 +51,6 @@ This folder contains scripts for running IVAS conformance tests. 
  python -m pip install -r tests/requirements.txt

  ```



## 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



  ```shell

  sh scripts/ivas_conformance/ivas_be_conf_test_gen.sh

  ```



<details>

<summary> Example output of reference test generation </summary>

<pre><code>

::::::::::::::::::::::::

------------------------------------------

Generated html report: file:///home/dolby/git/ivas-codec/report_cmd.htm

------------------------------------------

=================================================

2571 passed, 538 skipped, 230 xfailed in 377.10s (0:06:17)

=================================================

Identified 5430 files from scripts

Removed 1515 files

Kept 5422 files

</code></pre>

</details>



### 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



  ```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

scripts/ivas_conformance/README_Package_Gen.md

0 → 100644
+96 −0
Original line number Diff line number Diff line 
# IVAS Conformance Scripts



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



  ```shell

  lsb_release -d | grep Ubuntu

  ```



  <span style="color: green;"> # It might be similar to Ubuntu 24.04.3 LTS </span>



- Install Clang 18 compiler



  ```shell

  sudo apt install clang-18

  clang-18 --version

  ```



  Example version observed on Ubuntu 24.04.3 LTS



  ```text

  Ubuntu clang version 18.1.3 (1ubuntu1)

  Target: x86_64-pc-linux-gnu

  Thread model: posix

  InstalledDir: /usr/bin

  ```



  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

  ```



- Install Python3.13 on Ubuntu 24.04 LTS



  ```shell

  sudo apt install python3.13 python3.13-venv

  ```



- Create virtual environment for Python 3.13 and install requirements



  ```shell

  python3.13 -m venv pyConformance

  source pyConformance/bin/activate

  cd ivas-codec

  python -m pip install -r tests/requirements.txt

  ```



## 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



  ```shell

  sh scripts/ivas_conformance/ivas_be_conf_test_gen.sh

  ```



<details>

<summary> Example output of reference test generation </summary>

<pre><code>

::::::::::::::::::::::::

------------------------------------------

Generated html report: file:///home/dolby/git/ivas-codec/report_cmd.htm

------------------------------------------

=================================================

2571 passed, 538 skipped, 230 xfailed in 377.10s (0:06:17)

=================================================

Identified 5430 files from scripts

Removed 1515 files

Kept 5422 files

</code></pre>

</details>



### 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



  ```shell

  zip -r conformance.zip testvec scripts/ivas_conformance/runConformance.py  scripts/ivas_conformance/requirements.txt scripts/ivas_conformance/README.md scripts/ivas_conformance/thirdPartyLegalNotices.txt scripts/tools/Darwin/thirdPartyLegalnotices  scripts/tools/Darwin/LICENSE_wav-diff.txt scripts/tools/Darwin/wav-diff scripts/tools/Linux/thirdPartyLegalnotices  scripts/tools/Linux/LICENSE_wav-diff.txt scripts/tools/Linux/wav-diff scripts/tools/Win32/thirdPartyLegalnotices  scripts/tools/Win32/LICENSE_wav-diff.txt scripts/tools/Win32/wav-diff.exe

  ```



</details>

scripts/ivas_conformance/thirdPartyLegalNotices.txt

0 → 100755
+1898 −0

File added.

Preview size limit exceeded, changes collapsed.