Commit f877f2da authored by vaclav's avatar vaclav
Browse files

Merge branch '1090-merge-readme-of-txt-and-readme_split_rendering-txt' into 'main' 

Resolve "Merge Readme.of txt and readme_split_rendering.txt"

See merge request !1559
parents 4ab2cd8c daa116b7

readme.txt

+33 −12
Original line number Diff line number Diff line
@@ -33,11 +33,12 @@ 


These files represent the 3GPP EVS Codec Extension for Immersive Voice and 

Audio Services (IVAS) floating-point C simulation. All code is writtten

in ISO/IEC C99. The system is implemented as three separate programs:

in ISO/IEC C99. The system is implemented as four separate programs:



        IVAS_cod   Encoder

        IVAS_dec   Decoder

        IVAS_rend  Renderer

        IVAS_cod   	    IVAS Encoder

        IVAS_dec   	    IVAS Decoder

        IVAS_rend  	    IVAS External Renderer

        ISAR_post_rend  ISAR Post Renderer



For encoding using the coder program, the input is a binary

audio file (*.8k, *.16k, *.32k, *.48k) and the output is a binary
@@ -128,6 +129,8 @@ should have the following structure: 
    |-- lib_debug

    |-- lib_dec

    |-- lib_enc

    |-- lib_isar

    |-- lib_lc3plus

    |-- lib_rend    

    |-- lib_util

    |-- readme.txt
@@ -135,16 +138,16 @@ should have the following structure: 


The package includes a Makefile for gcc, which has been verified on

32-bit Linux systems. The code can be compiled by entering the directory

"c-code" and typing the command: make. The resulting encoder/decoder/renderer

executables are named "IVAS_cod", "IVAS_dec", and "IVAS_rend". All reside 

in the c-code directory.

"c-code" and typing the command: make. The resulting encoder/decoder/renderer/

ISAR_post_renderer executables are named "IVAS_cod", "IVAS_dec", "IVAS_rend",

and "ISAR_post_rend". All reside in the c-code directory.



The package also includes a solution-file for Microsoft Visual Studio 2017 (x86). 

To compile the code, please open "Workspace_msvc\Workspace_msvc.sln" and build 

"encoder" for the encoder, "decoder" for the decoder, and "renderer" for the 

renderer executable. The resulting encoder/decoder/renderer executables are 

"IVAS_cod.exe", "IVAS_dec.exe", and "IVAS_rend.exe". All reside in the c-code 

main directory. 

renderer executable. The resulting encoder/decoder/renderer/ISAR_post_renderer 

executables are "IVAS_cod.exe", "IVAS_dec.exe", "IVAS_rend.exe", and

"ISAR_post_rend.exe". All reside in the c-code main directory. 





                       RUNNING THE SOFTWARE
@@ -239,7 +242,8 @@ Usage for IVAS: IVAS_dec.exe [Options] OutputConf Fs bitstream_file output_file 
Mandatory parameters:

---------------------

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, EXT

                      HOA2, HOA3, BINAURAL, BINAURAL_ROOM_IR, BINAURAL_ROOM_REVERB, 

                      BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM, EXT

                       By default, channel order and loudspeaker positions are equal to the

                       encoder. For loudspeaker outputs, OutputConf can be a custom loudspeaker

                       layout file. See below for details.
@@ -284,6 +288,7 @@ Options: 
                      specified) for binaural output configuration

-aeid ID            : Acoustic environment ID (number >= 0) for BINAURAL_ROOM_REVERB output config.

-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation.

-om File            : Coded metadata File for BINAURAL_SPLIT_PCM OutputConf

                      Currently, all values default to level 3 (full functionality).

-q                  : Quiet mode, limit printouts to terminal, default is deactivated
@@ -329,11 +334,27 @@ Options: 
-g                  : Input gain (linear, not in dB) to be applied to input audio file

-l                  : List supported audio formats

-smd                : Metadata Synchronization Delay in ms, Default is 0. Quantized by 5ms subframes.

-om File            : Coded metadata File for BINAURAL_SPLIT_PCM output format

-level level        : Complexity level, level = (1, 2, 3), will be defined after characterisation.

                      Currently, all values default to level 3 (full functionality).

-q                  : Quiet mode, limit printouts to terminal, default is deactivated





The usage of the "ISAR_post_rend" program:

------------------------------------------



Usage: ISAR_post_rend [options]



Options:

--------

-i File             : Input File (input file is bitstream if format is BINAURAL_SPLIT_CODED, or PCM/WAV file if format is BINAURAL_SPLIT_PCM)

-if Format          : Input Format of input (BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM)

-im File            : Coded metadata File for BINAURAL_SPLIT_PCM input format

-o File             : Output Audio File in BINAURAL format

-fs                 : Input sampling rate in kHz (48)

-prbfi File         : BFI File





                       MULTICHANNEL LOUDSPEAKER INPUT / OUTPUT CONFIGURATIONS

                       ======================================================

The loudspeaker positions for each MC layouts are assumed to have the following azimuth and elevation

readme_split_rendering.txt

deleted100644 → 0
+0 −128
Original line number Diff line number Diff line 
/******************************************************************************************************



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

        ISAR_post_rend  ISAR_post_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_isar    

    |-- 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





The usage of the "ISAR_post_rend" program:

-------------------------------------



Usage: ISAR_post_rend [options]



Options:

--------

-i File             : Input File (input file is bitstream if format is BINAURAL_SPLIT_CODED, PCM or WAV file if format is BINAURAL_SPLIT_PCM)

-if Format          : Audio Format of input (BINAURAL_SPLIT_CODED, BINAURAL_SPLIT_PCM)

-im File            : Coded metadata File for BINAURAL_SPLIT_PCM input mode

-o File             : Output audio File (BINAURAL always)

-fs                 : Input sampling rate in kHz (48)

-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.