summaryrefslogtreecommitdiff
path: root/README
blob: f3e2880b02886cc0339a35894afd9efea203f9f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
This is a prototype codec and for now it has limited functionality. 

To build from a distribution tarball, you only need to do the following:

% ./configure --disable-shared
% make

To build from the git repository, the following steps are necessary

0) Clone the repository:

% git clone git://git.xiph.org/users/jm/ietfcodec.git
% cd ietfcodec

1) Get the celt and silk submodules:

% git submodule update --init

2) Compiling

% ./autogen.sh
% ./configure --disable-shared
% make


Once you have compiled the codec, there will be a test_opus executable in
the src/ directory. This can be in the following way:

% ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>

mode: 0 for audo, 1 for voice, 2 for audio:
options:
-cbr                 : enable constant bitrate; default: VBR
-bandwidth <NB|MB|WB|SWB|FB>  : audio bandwidth (from narrowband to fullband); default: sampling rate
-framesize <2.5|5|10|20|40|60>  : frame size in ms; default: 20 
-max_payload <bytes> : maximum payload size in bytes, default: 1024
-complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
-inbandfec           : enable SILK inband FEC
-dtx                 : enable SILK DTX
-loss <perc>         : simulate packet loss, in percent (0-100); default: 0

input and output are 16-bit PCM files (machine endian)