About Script

Directory script contains three different kinds of scripts

• get:

  generation or calculation tools

• analysis:

  analysis tools or environments

• run:

  regression or automation environments

Get

Directory get contains generation tools, which may contain tools like

• generation tools to produce test vectors

• calculation tools to get SNR, PSNR results

Analysis

Directory analysis contains analysis tools or environments, which may contain tools or environments like

• analysis tools to process the output of C models

• analysis environments to process the intermediate data of C models

• analysis environments to do pre-researches

Run

Directory run contains regression or automation environments, which may contain environments like

• automation environments to do updates or checks

• regression environments to run C models

Existing Environments

Information on several existing environments is listed below.

getAyuv1555FromYuv420p

• Function

  1. generate test vectors according to the information specified by parameter CSTR_INFO_ITEM_ALL

     and save them to directory CSTR_DIR_OUT (sure, this script converts yuv420p files to ayuv1555 files)

• Pre-Request

  item	my version
  python3	3.8.10

• Content

  item	description	postscript
  getAyuv1555FromYuv420p.sh	generating script (top)
  getAyuv1555FromYuv444pKnl.py	generating script (kernel)
  /mnt/e/DOWNLOAD/SEQUENCE/HM_AYUV1555	directory for generated vectors	generated by command getAyuv1555FromYuv420p.sh

• Usage

  In the WSL environment, change the directory to script/get/getAyuv1555FromYuv420p,

  then you can

  1. complete the above functions with

     ./getAyuv1555FromYuv420p.sh
     

     then you will get

     

runListUpdate

• Function

  1. update auto-generated codes like cfg_*.cpp

  2. convert files from DOS format to UNIX format

  3. delete trailing blanks

  4. collect markers like TODO, NOTE, ??? or !!!

  5. collect file status (draft, phase ??? or something alike)

  6. remove empty directory

• Pre-Request

  none

• Content

  item	description	postscript
  runListUpdate.sh	3.8.10
  dump	directory for collected informations	generated by command ./runListUpdate.sh

• Usage

  In the WSL environment, change the directory to script/run/runListUpdate,

  then you can

  • complete the above functions with

    ./runListUpdate.sh
    

    then you will get

    
    

runXkmsc

• Function

  1. generate executable file xkmsc

  2. create a directory named with sessionCSTR_TAG (session tag, default value is Test)

  3. copy run script runXkmsc.sh, executable file xkmsc, configuration file xkmsc.cfg to directory sessionCSTR_TAG

  4. change the directory to sessionCSTR_TAG and automatically run xkmsc to process test vectors specified with parameter CSTR_DIR_VECT (vector directory) and CSTR_INFO_VECT_ALL (vector information)

  5. calculate and note down md5sum of output files

  6. do correctness check (does not exist in this environment)

  7. extract/calculate and notedown SNR, PSNR or other performance related information (does not exist in this environment)

  8. change the directory back

• Pre-Request

  item	my version
  gcc, g++	9.3.0
  Make	4.2.1
  cmake	3.16.3
  md5sum	8.30

• Content

  File Name	Descriptions	postscript
  makefile	makefile
  runXkmsc.sh	regression script
  xkmsc.cfg	configuration file
  sessionTest	regression session	generated by command make run

• Usage

  In the WSL environment, change the directory to script/run/runXkmsc,

  then you can

  1. view help with

     make
     

     then you will get

     

  2. complete the above functions with

     make run
     

     then you will get

     

     ...

     

     ...

     

     ...

     

  3. clean files with

     make clean
     

     or

     make clean_all
     

     then you will get