Adding a decent auto/default bit-rate choice
[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_AUTO          2000
69 #define OPUS_MODE_VOICE         2001
70 #define OPUS_MODE_AUDIO         2002
71
72 #define MODE_SILK_ONLY 1000
73 #define MODE_HYBRID    1001
74 #define MODE_CELT_ONLY 1002
75
76 #define BANDWIDTH_AUTO          1100
77 #define BANDWIDTH_NARROWBAND    1101
78 #define BANDWIDTH_MEDIUMBAND    1102
79 #define BANDWIDTH_WIDEBAND      1103
80 #define BANDWIDTH_SUPERWIDEBAND 1104
81 #define BANDWIDTH_FULLBAND      1105
82
83
84
85 #define OPUS_SET_MODE_REQUEST 0
86 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
87 #define OPUS_GET_MODE_REQUEST 1
88 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
89
90 #define OPUS_SET_BITRATE_REQUEST 2
91 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
92 #define OPUS_GET_BITRATE_REQUEST 3
93 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
94
95 #define OPUS_SET_VBR_FLAG_REQUEST 6
96 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
97 #define OPUS_GET_VBR_FLAG_REQUEST 7
98 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
99
100 #define OPUS_SET_BANDWIDTH_REQUEST 8
101 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
102 #define OPUS_GET_BANDWIDTH_REQUEST 9
103 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
104
105 #define OPUS_SET_COMPLEXITY_REQUEST 10
106 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
107 #define OPUS_GET_COMPLEXITY_REQUEST 11
108 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
109
110 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
111 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
112 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
113 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
114
115 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
116 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
117 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
118 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
119
120 #define OPUS_SET_DTX_FLAG_REQUEST 16
121 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
122 #define OPUS_GET_DTX_FLAG_REQUEST 17
123 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
124
125 #define OPUS_SET_VOICE_RATIO_REQUEST 18
126 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __check_int(x)
127 #define OPUS_GET_VOICE_RATIO_REQUEST 19
128 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __check_int_ptr(x)
129
130 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 20
131 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __check_int(x)
132 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 21
133 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __check_int_ptr(x)
134
135 typedef struct OpusEncoder OpusEncoder;
136 typedef struct OpusDecoder OpusDecoder;
137
138 OPUS_EXPORT OpusEncoder *opus_encoder_init(OpusEncoder* st, int Fs, int channels);
139
140 OPUS_EXPORT OpusEncoder *opus_encoder_create(int Fs, int channels);
141
142 /* returns length of data payload (in bytes) */
143 OPUS_EXPORT int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
144                 unsigned char *data, int max_data_bytes);
145
146 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
147
148 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
149
150 OPUS_EXPORT OpusDecoder *opus_decoder_init(OpusDecoder *st, int Fs, int channels);
151
152 OPUS_EXPORT OpusDecoder *opus_decoder_create(int Fs, int channels);
153
154 /* returns (CELT) error code */
155 OPUS_EXPORT int opus_decode(OpusDecoder *st, const unsigned char *data, int len,
156                 short *pcm, int frame_size, int decode_fec);
157
158 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
159
160 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
161
162 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
163 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, int Fs);
164 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
165 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
166 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
167
168
169 #if OPUS_TEST_RANGE_CODER_STATE
170 OPUS_EXPORT int opus_encoder_get_final_range(OpusEncoder *st);
171 OPUS_EXPORT int opus_decoder_get_final_range(OpusDecoder *st);
172 #endif
173
174
175 #ifdef __cplusplus
176 }
177 #endif
178
179 #endif /* OPUS_H */