Merge pull request #2 from MPEGGroup/develop

Develop

Author: QuentinGalvane

.clang-tidy

@@ -24,17 +24,17 @@ CheckOptions:
   - key:    readability-identifier-length.MinimumLoopCounterNameLength
     value:  1
   - key:    readability-function-size.LineThreshold
-    value:  130
+    value:  175
   - key:    readability-function-size.StatementThreshold
-    value:  110
+    value:  120
   - key:    readability-function-size.ParameterThreshold
     value:  6
   - key:    readability-function-size.NestingThreshold
     value:  7
   - key:    readability-function-size.VariableThreshold
-    value:  35
+    value:  40
   - key:    readability-function-cognitive-complexity.Threshold
-    value:  60
+    value:  65
   - key:    bugprone-easily-swappable-parameters.MinimumLength
     value:  4
   - key:    bugprone-easily-swappable-parameters.ModelImplicitConversions

.gitignore

@@ -182,6 +182,8 @@ AutoTest.Net/
 # Web workbench (sass)
 .sass-cache/
 
+out/
+
 # Installshield output folder
 [Ee]xpress/
 

.gitlab-ci.yml

@@ -1,10 +1,18 @@
+variables:
+  JOB_TAG: "linux"
+  IMAGE_CBACHHUBER_CLANG_PREFIX: ""
+  IMAGE_CBACHHUBER_CLANG_TAG: "cbachhuber/clang:12"
+  GIT_MPEG_EXPERT_ACCESS_URL: "https://gitlab-ci-token:${CI_JOB_TOKEN}@git.mpeg.expert"
+
 stages:
   - check
   - build
   - test
 
 default:
   interruptible: true
+  tags:
+    - ${JOB_TAG}
 
 include:
   - /.gitlab/checks.yml

.gitlab/builds.yml

@@ -1,10 +1,9 @@
 Clang 12 Debug:
   stage: build
-  image: cbachhuber/clang:12
-  tags: [linux]
+  image: ${IMAGE_CBACHHUBER_CLANG_PREFIX}${IMAGE_CBACHHUBER_CLANG_TAG}
   script:
     - git config --global http.sslVerify "false"
-    - echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@git.mpeg.expert" > ~/git.store
+    - echo "${GIT_MPEG_EXPERT_ACCESS_URL}" > ~/git.store
     - git config --global credential.helper 'store --file ~/git.store'
     - mkdir -p build && cd build
     - > 
@@ -35,14 +34,15 @@ Clang 12 Debug:
 
 GCC 10 Release:
   stage: build
-  image: rikorose/gcc-cmake
-  tags: [linux]
+  variables:
+    IMAGE_RIKOROSE_GCC_CMAKE_PREFIX: ""
+  image: ${IMAGE_RIKOROSE_GCC_CMAKE_PREFIX}rikorose/gcc-cmake
   before_script:
     - export CXX=/usr/bin/g++-10
     - export CC=/usr/bin/gcc-10
   script:
     - git config --global http.sslVerify "false"
-    - echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@git.mpeg.expert" > ~/git.store
+    - echo "${GIT_MPEG_EXPERT_ACCESS_URL}" > ~/git.store
     - git config --global credential.helper 'store --file ~/git.store'
     - mkdir -p build && cd build
     - cmake -DENABLE_CLANG_TIDY=OFF -DCMAKE_CXX_FLAGS="-Wall -Wextra -Wpedantic -Werror" -DCMAKE_BUILD_TYPE=Release ..

.gitlab/checks.yml

@@ -1,7 +1,6 @@
 clang-format:
   stage: check
-  image: cbachhuber/clang:12
-  tags: [ linux ]
+  image: ${IMAGE_CBACHHUBER_CLANG_PREFIX}${IMAGE_CBACHHUBER_CLANG_TAG}
   script:
     - python3 scripts/check/clang_format.py
     - git diff

.gitlab/tests.yml

@@ -1,13 +1,14 @@
 Metrics:
   stage: test
-  image: gcc-cmake-python:RM0
-  tags: [linux]
+  variables:
+    IMAGE_GCC_CMAKE_PYTHON_PREFIX: ""
+  image: ${IMAGE_GCC_CMAKE_PYTHON_PREFIX}gcc-cmake-python:RM0
   before_script:
     - export CXX=/usr/bin/g++-10
     - export CC=/usr/bin/gcc-10
   script:
     - git config --global http.sslVerify "false"
-    - echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@git.mpeg.expert" > ~/git.store
+    - echo "${GIT_MPEG_EXPERT_ACCESS_URL}" > ~/git.store
     - git config --global credential.helper 'store --file ~/git.store'
     - mkdir -p build && cd build
     - cmake -DENABLE_CLANG_TIDY=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/install ..

CMakeLists.txt

@@ -10,6 +10,7 @@ endif()
 option(BUILD_DECODER "Enable building Decoder" ON)
 option(BUILD_ENCODER "Enable building Encoder" ON)
 option(BUILD_SYNTHESIZER "Enable building Synthesizer" ON)
+option(BUILD_CONFORMANCE "Enable building Conformance" ON)
 
 option(NO_INTERNET "Use pre-downloaded source archives for external libraries, e.g. Catch2" OFF)
 

cmake/pugixml.cmake

@@ -4,7 +4,7 @@ include(FetchContent)
 if(NO_INTERNET)
     set(LOCAL_PUGIXML_DIR ${CMAKE_SOURCE_DIR}/../pugixml CACHE PATH "Path to the local PUGIXML directory" )
     message(STATUS "Looking for a local copy of the PUGIXML test framework in ${LOCAL_PUGIXML_DIR}")
-    fetchcontent_declare(DR_LIBS URL ${LOCAL_PUGIXML_DIR})
+    fetchcontent_declare(PUGIXML URL ${LOCAL_PUGIXML_DIR})
 else()
         FetchContent_Declare(pugixml
             GIT_REPOSITORY "https://github.com/zeux/pugixml"

scripts/RM_submission/config.json

@@ -5,7 +5,7 @@
   "synthesizer_path": "Synthesizer\\Synthesizer.exe",
 
   "reference_files": {
-    "main_folder": "..\\..\\..\\..\\..\\..\\..\\Data\\Part40-HapticSupport",
+    "main_folder": "..\\..\\..\\..\\..\\..\\Data\\Part31-HapticSupport",
     "reference_bitratePSNR": "reference_bitratePSNR.csv",
     "short_effects": [
       {

scripts/RM_submission/conformance_check.py

@@ -44,6 +44,7 @@
 from soundfile import read, write
 
 RM_INSTALL_DIR = "RM_install_dir"
+CONFORMANCE_PATH_KEY = "conformance_path"
 ENCODER_PATH_KEY = "encoder_path"
 DECODER_PATH_KEY = "decoder_path"
 SYNTHESIZER_PATH_KEY = "synthesizer_path"
@@ -59,8 +60,11 @@
 CONFORMANCE_FILES_KEY = "conformance_files"
 CONFORMANCE_TEST_SET_KEYS = [
     "schemas_checks",
-    "semantic_checks"
+    "semantic_checks",
+    "hmpg_compatibility_checks",
+    "hmpg_conformance_checks"
 ]
+CONFORMANCE_TEST_SET_KEY = "conversion_checks"
 
 def checkSoftwarePath(config: dict):
     def _check_software(dir_key: str,path_key: str):
@@ -71,6 +75,7 @@ def _check_software(dir_key: str,path_key: str):
         assert os.path.exists(config_file), f"{path_key} should be an existing file"
         assert os.access(config_file, os.X_OK), f"{path_key} should be executable"
 
+    _check_software(RM_INSTALL_DIR, CONFORMANCE_PATH_KEY)
     _check_software(RM_INSTALL_DIR, ENCODER_PATH_KEY)
     _check_software(RM_INSTALL_DIR, DECODER_PATH_KEY)
     _check_software(RM_INSTALL_DIR, SYNTHESIZER_PATH_KEY)
@@ -85,15 +90,13 @@ def main():
     if os.path.exists(output_folder):
         shutil.rmtree(output_folder)
 
-
-    #text_file = open("testlog.txt", "w")
+    print("####### HJIF Conformance Tests")
     nb_tests = 0
     nb_success = 0
     check_fails = []
     for conformance_check_type in CONFORMANCE_TEST_SET_KEYS:
         print("\n****** ",conformance_check_type," ******")
         test_number = 1;
-        #text_file.write("****** "+conformance_check_type+" ******\n")
         for conformance_check in config[CONFORMANCE_FILES_KEY][conformance_check_type]:
             input_file_path = conformance_check[HAPTIC_FILE_PATH_KEY]
             if MAIN_FOLDER_KEY in config[CONFORMANCE_FILES_KEY]:
@@ -105,27 +108,64 @@ def main():
                 input_file_path = os.path.join(config[CONFORMANCE_FILES_KEY][MAIN_FOLDER_KEY], input_file_path)
                 if(not os.path.exists(input_file_path)):
                     print(f"FILE NOT FOUND: {input_file_path}")
+                    nb_tests+=1
+                    test_number+=1
                     continue
-            #print("\n",conformance_check[NAME_KEY])
-            #print(datetime.now().strftime(f"[ %Hh : %Mm : %Ss ] => Encoder on : {input_file_path}"))
-            result = subprocess.run(f"{os.path.join(config[RM_INSTALL_DIR], config[ENCODER_PATH_KEY])} -f {input_file_path} -o test.hjif",shell=True, capture_output=True, text=True)
-            valid = result.stderr.splitlines()==conformance_check[EXPECTED_OUTPUT_KEY].splitlines()
+            result = subprocess.run(f"{os.path.join(config[RM_INSTALL_DIR], config[CONFORMANCE_PATH_KEY])} -f {input_file_path}",shell=True, capture_output=True, text=True)
+            expected_output = conformance_check[EXPECTED_OUTPUT_KEY].replace("{main_folder}",config[CONFORMANCE_FILES_KEY][MAIN_FOLDER_KEY])
+            valid = result.stderr.splitlines()==expected_output.splitlines()
             if(not valid):
-                check_fails.append("*********\n"+conformance_check_type +" #"+str(test_number)+" failed: "+conformance_check[NAME_KEY]+"\n")
+                check_fails.append("\n---------------------\n"+conformance_check_type +" #"+str(test_number)+" failed: "+conformance_check[NAME_KEY]+"\n")
                 check_fails.append("- Output : \n"+result.stderr)
-                check_fails.append("- Expected output: \n"+conformance_check[EXPECTED_OUTPUT_KEY])
+                check_fails.append("- Expected output: \n"+expected_output)
             print("Test #",test_number,":\t",valid,"\t|\t",conformance_check[NAME_KEY])
             nb_tests+=1
             test_number+=1
             if(valid):
                 nb_success+=1
-            #text_file.write('\\n'.join(result.stderr.replace("\\","\\\\").splitlines())+"\n\n")
-    #text_file.close()
-    print("####### Conformance Results")
-    if(nb_success == nb_tests):
-        print("SUCCESS: ",nb_success,"/",nb_tests," valid tests")
+        if(nb_success == nb_tests):
+            print("\nSUCCESS: ",nb_success,"/",nb_tests," valid tests")
+        else:
+            print("\nFAIL: ",nb_success,"/",nb_tests," valid tests")
+            print("The following tests failed:")
+            print("\n".join(check_fails))
+
+        check_fails = []
+        test_number = 1;
+        nb_success = 0;
+        nb_tests = 0;
+    
+    print("\n####### Conversion Conformance Tests\n")
+    for conversion_check in config[CONFORMANCE_FILES_KEY][CONFORMANCE_TEST_SET_KEY]:
+        input_file_path = conversion_check[HAPTIC_FILE_PATH_KEY]
+        if MAIN_FOLDER_KEY in config[CONFORMANCE_FILES_KEY]:
+            if(input_file_path == ""):
+                print("Conversion Test ",conversion_check[NAME_KEY],"TO DO\t")
+                test_number+=1
+                continue
+            input_file_path = os.path.join(config[CONFORMANCE_FILES_KEY][MAIN_FOLDER_KEY], input_file_path)
+            if(not os.path.exists(input_file_path)):
+                print(f"FILE NOT FOUND: {input_file_path}")
+                test_number+=1
+                continue
+        binary_encoding_result = subprocess.run(f"{os.path.join(config[RM_INSTALL_DIR], config[ENCODER_PATH_KEY])} -f {input_file_path} -o test.hmpg -b",shell=True, capture_output=True, text=True)
+        decoding_result = subprocess.run(f"{os.path.join(config[RM_INSTALL_DIR], config[DECODER_PATH_KEY])} -f test.hmpg -o testDecoded.hjif",shell=True, capture_output=True, text=True)
+        comparison = subprocess.run(f"{os.path.join(config[RM_INSTALL_DIR], config[CONFORMANCE_PATH_KEY])} -f {input_file_path} -c testDecoded.hjif",shell=True, capture_output=True, text=True)
+        expected_output = conversion_check[EXPECTED_OUTPUT_KEY].replace("{main_folder}",config[CONFORMANCE_FILES_KEY][MAIN_FOLDER_KEY])
+        valid = comparison.stderr.splitlines()==expected_output.splitlines()
+        if(not valid):
+            check_fails.append("\n---------------------\n\nConversion #"+str(test_number)+" failed: "+conversion_check[NAME_KEY]+"\n")
+            check_fails.append("- Output : \n"+comparison.stderr)
+            check_fails.append("- Expected output: \n"+expected_output)
+        else:
+            nb_success+=1
+        print("Test #",test_number,":\t",valid,"\t|\t",conversion_check[NAME_KEY])
+        test_number+=1
+        
+    if(nb_success == test_number-1):
+        print("\nSUCCESS: ",nb_success,"/",test_number-1," valid tests")
     else:
-        print("FAIL: ",nb_success,"/",nb_tests," valid tests")
+        print("\nFAIL: ",nb_success,"/",test_number-1," valid tests")
         print("The following test failed:")
         print("\n".join(check_fails))