Commit 4bb554cc authored by vaclav's avatar vaclav
Browse files

Merge branch '684-update-of-readme-txt' into 'main'

Resolve "Update of Readme.txt"

See merge request !933
parents 80e44b05 97582990
Loading
Loading
Loading
Loading
Loading
+116 −0
Original line number Diff line number Diff line
/******************************************************************************************************

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

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

For the IVAS Readme.txt, please refer to Readme.txt.

This readme_split_rendering.txt describes a usage of the binaural split 
rendering feature in the IVAS codec. This feature is implemented as part of 
the following two separate programs:

        IVAS_dec   Decoder
        IVAS_rend  Renderer
		


                      INSTALLING THE SOFTWARE
                      =======================

Same as described in Readme.txt while the structure looks as follows:

.
`-- c-code
    |-- Makefile
    |-- Workspace_msvc
    |-- apps
    |-- lib_com
    |-- lib_debug
    |-- lib_dec
    |-- lib_enc
    |-- lib_lc3plus
    |-- lib_rend
    |-- lib_util
    |-- readme.txt
    |-- readme_split_rendering.txt



                       RUNNING THE SOFTWARE
                       ====================

The usage of the "IVAS_cod" program:
------------------------------------

Same as described in Readme.txt.



The usage of the "IVAS_dec" program:
------------------------------------

Same as described in Readme.txt while more command-line options are avilable.

Usage for IVAS:  IVAS_dec.exe [Options] OutputConf Fs bitstream_file output_file

Additional options:
-------------------
OutputConf          : Output configuration: MONO, STEREO, 5_1, 7_1, 5_1_2, 5_1_4, 7_1_4, FOA,
                      HOA2, HOA3, BINAURAL, BINAURAL_ROOM_IR, BINAURAL_ROOM_REVERB, 
                      BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM, EXT
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output mode



The usage of the "IVAS_rend" program:
-------------------------------------

Same as described in Readme.txt while more command-line options are avilable.

Usage: IVAS_rend [options]

Additional options:
-------------------
-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output mode
-im                 : Metadata files for ISM (one file per object) or MASA inputs or 
                      BINAURAL_SPLIT_PCM input mode
-prbfi File         : Split rendering option: bfi File


                       

                       RUNNING THE SELF TEST
                       =====================

Same as described in Readme.txt except of the renderer configuration text file which 
can additionally be used to configure the pre-rendering step of the split binaural 
renderer. All split renderer parameters are optional. 

The detailed syntax of the renderer configuration text can be found in 3GPP TS 26.258.