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