Removes auto mode and fixes a force_mono issue
[opus.git] / src / opus.h
1 /* Copyright (c) 2010 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef OPUS_H
29 #define OPUS_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #if defined(__GNUC__) && defined(OPUS_BUILD)
36 #define OPUS_EXPORT __attribute__ ((visibility ("default")))
37 #elif defined(WIN32)
38 #define OPUS_EXPORT __declspec(dllexport)
39 #else
40 #define OPUS_EXPORT
41 #endif
42
43 #define __check_int(x) (((void)((x) == (int)0)), (int)(x))
44 #define __check_int_ptr(ptr) ((ptr) + ((ptr) - (int*)(ptr)))
45
46 /* Error codes */
47 /** No error */
48 #define OPUS_OK                0
49 /** An (or more) invalid argument (e.g. out of range) */
50 #define OPUS_BAD_ARG          -1
51 /** The mode struct passed is invalid */
52 #define OPUS_BUFFER_TOO_SMALL -2
53 /** An internal error was detected */
54 #define OPUS_INTERNAL_ERROR   -3
55 /** The data passed (e.g. compressed data to decoder) is corrupted */
56 #define OPUS_CORRUPTED_DATA   -4
57 /** Invalid/unsupported request number */
58 #define OPUS_UNIMPLEMENTED    -5
59 /** An encoder or decoder structure is invalid or already freed */
60 #define OPUS_INVALID_STATE    -6
61 /** Memory allocation has failed */
62 #define OPUS_ALLOC_FAIL       -7
63
64 #define OPUS_TEST_RANGE_CODER_STATE     1
65
66 #define OPUS_BITRATE_AUTO       -1
67
68 #define OPUS_MODE_VOICE         2000
69 #define OPUS_MODE_AUDIO         2001
70
71 #define MODE_SILK_ONLY          1000
72 #define MODE_HYBRID             1001
73 #define MODE_CELT_ONLY          1002
74
75 #define BANDWIDTH_AUTO          1100
76 #define BANDWIDTH_NARROWBAND    1101
77 #define BANDWIDTH_MEDIUMBAND    1102
78 #define BANDWIDTH_WIDEBAND      1103
79 #define BANDWIDTH_SUPERWIDEBAND 1104
80 #define BANDWIDTH_FULLBAND      1105
81
82
83
84 #define OPUS_SET_MODE_REQUEST 0
85 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
86 #define OPUS_GET_MODE_REQUEST 1
87 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
88
89 #define OPUS_SET_BITRATE_REQUEST 2
90 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
91 #define OPUS_GET_BITRATE_REQUEST 3
92 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
93
94 #define OPUS_SET_VBR_FLAG_REQUEST 6
95 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
96 #define OPUS_GET_VBR_FLAG_REQUEST 7
97 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
98
99 #define OPUS_SET_BANDWIDTH_REQUEST 8
100 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
101 #define OPUS_GET_BANDWIDTH_REQUEST 9
102 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
103
104 #define OPUS_SET_COMPLEXITY_REQUEST 10
105 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
106 #define OPUS_GET_COMPLEXITY_REQUEST 11
107 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
108
109 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
110 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
111 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
112 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
113
114 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
115 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
116 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
117 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
118
119 #define OPUS_SET_DTX_FLAG_REQUEST 16
120 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
121 #define OPUS_GET_DTX_FLAG_REQUEST 17
122 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
123
124 #define OPUS_SET_VOICE_RATIO_REQUEST 18
125 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __check_int(x)
126 #define OPUS_GET_VOICE_RATIO_REQUEST 19
127 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __check_int_ptr(x)
128
129 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
130 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __check_int(x)
131 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
132 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __check_int_ptr(x)
133
134 #define OPUS_SET_FORCE_MONO_REQUEST 22
135 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __check_int(x)
136 #define OPUS_GET_FORCE_MONO_REQUEST 23
137 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __check_int_ptr(x)
138
139 typedef struct OpusEncoder OpusEncoder;
140 typedef struct OpusDecoder OpusDecoder;
141
142 /* 
143  * There are two coding modes: 
144  * OPUS_MODE_VOICE gives best quality at a given bitrate for voice signals. It enhances the 
145  *    input signal by high-pass filtering and emphasizing formants and harmonics. Optionally
146  *    it includes in-band forward error correction to protect against packet loss. Use this
147  *    mode for typical VoIP applications. Because of the enhancement, even at high bitrates
148  *    the output may sound different from the input.
149  * OPUS_MODE_AUDIO gives best quality at a given bitrate for most non-voice signals like music.
150  *    Use this mode for music and mixed (music/voice) content, and applications requiring less 
151  *    than 15 ms of coding delay. 
152  */
153
154 /* Returns initialized encoder state */
155 OPUS_EXPORT OpusEncoder *opus_encoder_create(
156     int Fs,                     /* Sampling rate of input signal (Hz) */
157     int channels,               /* Number of channels (1/2) in input signal */
158     int mode                    /* Coding mode (OPUS_MODE_VOICE/OPUS_MODE_AUDIO) */
159 );
160
161 OPUS_EXPORT OpusEncoder *opus_encoder_init(
162     OpusEncoder *st,            /* Encoder state */
163     int Fs,                     /* Sampling rate of input signal (Hz) */
164     int channels,               /* Number of channels (1/2) in input signal */
165     int mode                    /* Coding mode (OPUS_MODE_VOICE/OPUS_MODE_AUDIO) */
166 );
167
168 /* returns length of data payload (in bytes) */
169 OPUS_EXPORT int opus_encode(
170     OpusEncoder *st,            /* Encoder state */
171     const short *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels */
172     int frame_size,             /* Number of samples per frame of input signal */
173     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
174     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
175 );
176
177 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
178
179 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
180
181 OPUS_EXPORT OpusDecoder *opus_decoder_create(
182     int Fs,                     /* Sampling rate of output signal (Hz) */
183     int channels                /* Number of channels (1/2) in output signal */
184 );
185
186 OPUS_EXPORT OpusDecoder *opus_decoder_init(OpusDecoder *st, 
187     int Fs,                     /* Sampling rate of output signal (Hz) */
188     int channels                /* Number of channels (1/2) in output signal */
189 );
190
191 /* returns (CELT) error code */
192 OPUS_EXPORT int opus_decode(
193     OpusDecoder *st,            /* Decoder state */
194     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
195     int len,                    /* Number of bytes in payload */
196     short *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels */
197     int frame_size,             /* Number of samples per frame of input signal */
198     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
199                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
200 );
201
202 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
203
204 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
205
206 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
207 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
208 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
209 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
210 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
211
212 /* For testing purposes: the encoder and decoder state should always be identical after coding a payload */
213 #if OPUS_TEST_RANGE_CODER_STATE
214 OPUS_EXPORT int opus_encoder_get_final_range(OpusEncoder *st);
215 OPUS_EXPORT int opus_decoder_get_final_range(OpusDecoder *st);
216 #endif
217
218
219 #ifdef __cplusplus
220 }
221 #endif
222
223 #endif /* OPUS_H */