6eeba31eb50877e2dda4a59c8d6aa7400a8b89c9
[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_BITRATE_AUTO       -1
65
66 #define OPUS_APPLICATION_VOIP        2000
67 #define OPUS_APPLICATION_AUDIO       2001
68
69 #define OPUS_SIGNAL_AUTO             3000
70 #define OPUS_SIGNAL_VOICE            3001
71 #define OPUS_SIGNAL_MUSIC            3002
72
73 #define MODE_SILK_ONLY          1000
74 #define MODE_HYBRID             1001
75 #define MODE_CELT_ONLY          1002
76
77 #define OPUS_BANDWIDTH_AUTO          1100
78 #define OPUS_BANDWIDTH_NARROWBAND    1101
79 #define OPUS_BANDWIDTH_MEDIUMBAND    1102
80 #define OPUS_BANDWIDTH_WIDEBAND      1103
81 #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104
82 #define OPUS_BANDWIDTH_FULLBAND      1105
83
84
85
86 #define OPUS_SET_MODE_REQUEST 0
87 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
88 #define OPUS_GET_MODE_REQUEST 1
89 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
90
91 #define OPUS_SET_BITRATE_REQUEST 2
92 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
93 #define OPUS_GET_BITRATE_REQUEST 3
94 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
95
96 #define OPUS_SET_VBR_FLAG_REQUEST 6
97 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
98 #define OPUS_GET_VBR_FLAG_REQUEST 7
99 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
100
101 #define OPUS_SET_BANDWIDTH_REQUEST 8
102 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
103 #define OPUS_GET_BANDWIDTH_REQUEST 9
104 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
105
106 #define OPUS_SET_COMPLEXITY_REQUEST 10
107 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
108 #define OPUS_GET_COMPLEXITY_REQUEST 11
109 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
110
111 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
112 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
113 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
114 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
115
116 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
117 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
118 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
119 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
120
121 #define OPUS_SET_DTX_FLAG_REQUEST 16
122 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
123 #define OPUS_GET_DTX_FLAG_REQUEST 17
124 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
125
126 #define OPUS_SET_VOICE_RATIO_REQUEST 18
127 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __check_int(x)
128 #define OPUS_GET_VOICE_RATIO_REQUEST 19
129 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __check_int_ptr(x)
130
131 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
132 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __check_int(x)
133 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
134 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __check_int_ptr(x)
135
136 #define OPUS_SET_FORCE_MONO_REQUEST 22
137 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __check_int(x)
138 #define OPUS_GET_FORCE_MONO_REQUEST 23
139 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __check_int_ptr(x)
140
141 #define OPUS_SET_SIGNAL_REQUEST 24
142 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __check_int(x)
143 #define OPUS_GET_SIGNAL_REQUEST 25
144 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __check_int_ptr(x)
145
146 typedef struct OpusEncoder OpusEncoder;
147 typedef struct OpusDecoder OpusDecoder;
148
149 /* 
150  * There are two coding modes: 
151  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice signals. It enhances the 
152  *    input signal by high-pass filtering and emphasizing formants and harmonics. Optionally
153  *    it includes in-band forward error correction to protect against packet loss. Use this
154  *    mode for typical VoIP applications. Because of the enhancement, even at high bitrates
155  *    the output may sound different from the input.
156  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most non-voice signals like music.
157  *    Use this mode for music and mixed (music/voice) content, broadcast, and applications requiring less 
158  *    than 15 ms of coding delay. 
159  */
160
161 /* Returns initialized encoder state */
162 OPUS_EXPORT OpusEncoder *opus_encoder_create(
163     int Fs,                     /* Sampling rate of input signal (Hz) */
164     int channels,               /* Number of channels (1/2) in input signal */
165     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
166 );
167
168 OPUS_EXPORT OpusEncoder *opus_encoder_init(
169     OpusEncoder *st,            /* Encoder state */
170     int Fs,                     /* Sampling rate of input signal (Hz) */
171     int channels,               /* Number of channels (1/2) in input signal */
172     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
173 );
174
175 /* Returns length of the data payload (in bytes) */
176 OPUS_EXPORT int opus_encode(
177     OpusEncoder *st,            /* Encoder state */
178     const short *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels */
179     int frame_size,             /* Number of samples per frame of input signal */
180     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
181     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
182 );
183
184 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
185
186 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
187
188 OPUS_EXPORT OpusDecoder *opus_decoder_create(
189     int Fs,                     /* Sampling rate of output signal (Hz) */
190     int channels                /* Number of channels (1/2) in output signal */
191 );
192
193 OPUS_EXPORT OpusDecoder *opus_decoder_init(OpusDecoder *st, 
194     int Fs,                     /* Sampling rate of output signal (Hz) */
195     int channels                /* Number of channels (1/2) in output signal */
196 );
197
198 /* Returns the number of samples decoded or a negative error code */
199 OPUS_EXPORT int opus_decode(
200     OpusDecoder *st,            /* Decoder state */
201     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
202     int len,                    /* Number of bytes in payload */
203     short *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels */
204     int frame_size,             /* Number of samples per frame of input signal */
205     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
206                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
207 );
208
209 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
210
211 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
212
213 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
214 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
215 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
216 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
217 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
218
219 OPUS_EXPORT const char *opus_strerror(int error);
220
221 /* For testing purposes: the encoder and decoder state should always be identical after coding a payload */
222 OPUS_EXPORT int opus_encoder_get_final_range(OpusEncoder *st);
223 OPUS_EXPORT int opus_decoder_get_final_range(OpusDecoder *st);
224
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif /* OPUS_H */