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