Commit 6fabec96 authored by Stephane Ragot's avatar Stephane Ragot
Browse files

addition of readme file for table format converter

parent 69d70a59
Loading
Loading
Loading
Loading
+60 −0
Original line number Diff line number Diff line
/******************************************************************************************************

   (C) 2022 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.

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

Table Format Converter program
------------------------------

The table format converter is used to generate the file containing the binary representation of the binaural 
filters for renderers (dynamic loading of generated file using –hrtf argument).
This tool is able :
   - to generate binary file for MIXER_CONV, MIXER_CONV_ROOM (tables conversion from ROM);
   - to aggregate the binary HR filter of OBJECTS_TD (to be done : FASTCONV and PARAMETRIC binaural)

First, build the converter under scripts/binauralRenderer_interface/Table_Format_Converter/ in VSCode (using CMakeList).

Usage: 
------
tables_format_converter [Options]

Mandatory parameters : 

Options :
-output_file_path : Path where output file will be created (with separator, default = './').
-output_file_name : Name of output file (without extension .bin, default = 'ivas_binaural').
-16 : Select 16 kHz sampling frequency (no multiple values, all frequencies by default).
-32 : Select 32 kHz sampling frequency (no multiple values, all frequencies by default).
-48 : Select 48 kHz sampling frequency (no multiple values, all frequencies by default).
-input_td_file_path : Path of binary files for time-domain renderer (with separator, used as flag).
-input_td_file_name : Name of input td file (without extension .bin, default = 'hrfilter_model').

For example :
table_format_converter(.exe) -output_file_path './' -48 -input_td_file_path './../../../td_object_renderer/hrtf_data/Orange_53/' -input_td_file_name 'hrfilter_model_v002'
 No newline at end of file