Commit 82881a81 authored by Jan Kiene's avatar Jan Kiene
Browse files

revert deletion of readme file

parent 5e50eca5
Loading
Loading
Loading
Loading
Loading
+82 −0
Original line number Diff line number Diff line
/******************************************************************************************************

   (C) 2022-2025 IVAS codec Public Collaboration with portions copyright Dolby International AB, Ericsson AB,
   Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V., Huawei Technologies Co. LTD.,
   Koninklijke Philips N.V., Nippon Telegraph and Telephone Corporation, Nokia Technologies Oy, Orange,
   Panasonic Holdings Corporation, Qualcomm Technologies, Inc., VoiceAge Corporation, and other
   contributors to this repository. All Rights Reserved.

   This software is protected by copyright law and by international treaties.
   The IVAS codec Public Collaboration consisting of Dolby International AB, Ericsson AB,
   Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V., Huawei Technologies Co. LTD.,
   Koninklijke Philips N.V., Nippon Telegraph and Telephone Corporation, Nokia Technologies Oy, Orange,
   Panasonic Holdings Corporation, Qualcomm Technologies, Inc., VoiceAge Corporation, and other
   contributors to this repository retain full ownership rights in their respective contributions in
   the software. This notice grants no license of any kind, including but not limited to patent
   license, nor is any license granted by implication, estoppel or otherwise.

   Contributors are required to enter into the IVAS codec Public Collaboration agreement before making
   contributions.

   This software is provided "AS IS", without any express or implied warranties. The software is in the
   development stage. It is intended exclusively for experts who have experience with such software and
   solely for the purpose of inspection. All implied warranties of non-infringement, merchantability
   and fitness for a particular purpose are hereby disclaimed and excluded.

   Any dispute, controversy or claim arising under or in relation to providing this software shall be
   submitted to and settled by the final, binding jurisdiction of the courts of Munich, Germany in
   accordance with the laws of the Federal Republic of Germany excluding its conflict of law rules and
   the United Nations Convention on Contracts on the International Sales of Goods.

*******************************************************************************************************/

Mixer conv sofa to rom table or binary files converter program
------------------------------

The sofa to rom format or binary files converter is used to generate the c files (*.h,*.c) or binary files containing the binary representation of the binaural 
filters for renderer MIXER_CONV and MIXER_CONV_ROOM 

First, build the converter under scripts/binauralRenderer_interface in VSCode (using CMakeList) or using the following command lines :
   - mkdir build
   - cd build
   - cmake ..
   - cmake --build . (option --config=release)
   - cd ..
   - Test :
      - run py run.py (require matplotlib) -> no error and a figure with impulse response shall appear

Requirements:
------------
   - Python version 3.9.* with pip
   - numpy (pip install numpy)
   - netCDF4 (pip install netCDF4)
   - SofaReader.py file must be in the same folder as the executable generate_crend_ivas_tables

Usage: 
------
generate_crend_ivas_tables [Options]

Mandatory parameters : 
   - Frame size in ms (5 or 20)
   - list of sofa files at least one. For rom files generation it is needed :
      - one with HRIR with directions of IVAS combined speakers configuration or more
      - one with FOA to binaural filters, can be obtain from HRIR using ./matlab_hrir_generation_scripts/convert_SD2SHD_HRIRs.m matlab script
      - one with HOA order 2 to binaural filters, can be obtain from HRIR using ./matlab_hrir_generation_scripts/convert_SD2SHD_HRIRs.m matlab script 
      - one with HOA order 3 to binaural filters, can be obtain from HRIR using ./matlab_hrir_generation_scripts/convert_SD2SHD_HRIRs.m matlab script
      - one with BRIR filters that directions of IVAS combined speakers configuration or more

Options :
   -lib_rend_path             : path where header and c files will be created (if missing rom files not generated).
   -binary_files_path                        : path where binary files will be created (if missing binary files not generated)\n
   -binary_common_file_name                  : common name for binary files that will be created (crend_hrir-53_brir-Fhg for example
   -compute_reverb_rom sofa_file_path        : if present reverb rom tables and binary files are computed using sofa_file_path as input HRIRs
   -brir_optim_config_path config_file_path  : if present brir optimisation process uses parameters stored in config_file_path 
                                                Configuration example files are provided in folder :
                                                   -brir_no_optim.cfg : for exact convolution of the BRIR by IVAS decoder or renderer
                                                   -brir_default_optim.cfg : default values BRIR optimisation used by IVAS decoder or renderer
                                                   -brir_low_complexity_optim.cfg : values for BRIR optimisation reducing IVAS decoder or renderer complexity

For example :

.\\generate_crend_ivas_tables.exe -lib_rend_path ../../lib_rend 5 ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_FOA.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_HOA2.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_HOA3.sofa ./BRIRs_sofa/IIS_BRIR_officialMPEG_Combined.sofa
./generate_crend_ivas_tables -lib_rend_path ../../lib_rend 5 ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_FOA.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_HAO2.sofa ./HRIRs_sofa/HRIR_128_Meth5_IRC_53_Q10_symL_Itrp1_48000_HOA3.sofa ./BRIRs_sofa/IIS_BRIR_officialMPEG_Combined.sofa