Opus audio codec (RFC 6716): API and operations manual
| 1.3.1

opus_defines.h
Go to the documentation of this file.
1 /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited
2 Written by Jean-Marc Valin and Koen Vos */
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 COPYRIGHT OWNER
19 OR 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
33 #ifndef OPUS_DEFINES_H
34 #define OPUS_DEFINES_H
35
36 #include "opus_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
46 #define OPUS_OK 0
47
48 #define OPUS_BAD_ARG -1
49
50 #define OPUS_BUFFER_TOO_SMALL -2
51
52 #define OPUS_INTERNAL_ERROR -3
53
54 #define OPUS_INVALID_PACKET -4
55
56 #define OPUS_UNIMPLEMENTED -5
57
58 #define OPUS_INVALID_STATE -6
59
60 #define OPUS_ALLOC_FAIL -7
61
66 #ifndef OPUS_EXPORT
67 # if defined(WIN32)
68 # if defined(OPUS_BUILD) && defined(DLL_EXPORT)
69 # define OPUS_EXPORT __declspec(dllexport)
70 # else
71 # define OPUS_EXPORT
72 # endif
73 # elif defined(__GNUC__) && defined(OPUS_BUILD)
74 # define OPUS_EXPORT __attribute__ ((visibility ("default")))
75 # else
76 # define OPUS_EXPORT
77 # endif
78 #endif
79
80 # if !defined(OPUS_GNUC_PREREQ)
81 # if defined(__GNUC__)&&defined(__GNUC_MINOR__)
82 # define OPUS_GNUC_PREREQ(_maj,_min) \
83 ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
84 # else
85 # define OPUS_GNUC_PREREQ(_maj,_min) 0
86 # endif
87 # endif
88
89 #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
90 # if OPUS_GNUC_PREREQ(3,0)
91 # define OPUS_RESTRICT __restrict__
92 # elif (defined(_MSC_VER) && _MSC_VER >= 1400)
93 # define OPUS_RESTRICT __restrict
94 # else
95 # define OPUS_RESTRICT
96 # endif
97 #else
98 # define OPUS_RESTRICT restrict
99 #endif
100
101 #if (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L) )
102 # if OPUS_GNUC_PREREQ(2,7)
103 # define OPUS_INLINE __inline__
104 # elif (defined(_MSC_VER))
105 # define OPUS_INLINE __inline
106 # else
107 # define OPUS_INLINE
108 # endif
109 #else
110 # define OPUS_INLINE inline
111 #endif
112
116 #if defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
117 # define OPUS_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
118 #else
119 # define OPUS_WARN_UNUSED_RESULT
120 #endif
121 #if !defined(OPUS_BUILD) && defined(__GNUC__) && OPUS_GNUC_PREREQ(3, 4)
122 # define OPUS_ARG_NONNULL(_x) __attribute__ ((__nonnull__(_x)))
123 #else
124 # define OPUS_ARG_NONNULL(_x)
125 #endif
126
130 #define OPUS_SET_APPLICATION_REQUEST 4000
131 #define OPUS_GET_APPLICATION_REQUEST 4001
132 #define OPUS_SET_BITRATE_REQUEST 4002
133 #define OPUS_GET_BITRATE_REQUEST 4003
134 #define OPUS_SET_MAX_BANDWIDTH_REQUEST 4004
135 #define OPUS_GET_MAX_BANDWIDTH_REQUEST 4005
136 #define OPUS_SET_VBR_REQUEST 4006
137 #define OPUS_GET_VBR_REQUEST 4007
138 #define OPUS_SET_BANDWIDTH_REQUEST 4008
139 #define OPUS_GET_BANDWIDTH_REQUEST 4009
140 #define OPUS_SET_COMPLEXITY_REQUEST 4010
141 #define OPUS_GET_COMPLEXITY_REQUEST 4011
142 #define OPUS_SET_INBAND_FEC_REQUEST 4012
143 #define OPUS_GET_INBAND_FEC_REQUEST 4013
144 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 4014
145 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 4015
146 #define OPUS_SET_DTX_REQUEST 4016
147 #define OPUS_GET_DTX_REQUEST 4017
148 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 4020
149 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 4021
150 #define OPUS_SET_FORCE_CHANNELS_REQUEST 4022
151 #define OPUS_GET_FORCE_CHANNELS_REQUEST 4023
152 #define OPUS_SET_SIGNAL_REQUEST 4024
153 #define OPUS_GET_SIGNAL_REQUEST 4025
154 #define OPUS_GET_LOOKAHEAD_REQUEST 4027
155 /* #define OPUS_RESET_STATE 4028 */
156 #define OPUS_GET_SAMPLE_RATE_REQUEST 4029
157 #define OPUS_GET_FINAL_RANGE_REQUEST 4031
158 #define OPUS_GET_PITCH_REQUEST 4033
159 #define OPUS_SET_GAIN_REQUEST 4034
160 #define OPUS_GET_GAIN_REQUEST 4045 /* Should have been 4035 */
161 #define OPUS_SET_LSB_DEPTH_REQUEST 4036
162 #define OPUS_GET_LSB_DEPTH_REQUEST 4037
163 #define OPUS_GET_LAST_PACKET_DURATION_REQUEST 4039
164 #define OPUS_SET_EXPERT_FRAME_DURATION_REQUEST 4040
165 #define OPUS_GET_EXPERT_FRAME_DURATION_REQUEST 4041
166 #define OPUS_SET_PREDICTION_DISABLED_REQUEST 4042
167 #define OPUS_GET_PREDICTION_DISABLED_REQUEST 4043
168 /* Don't use 4045, it's already taken by OPUS_GET_GAIN_REQUEST */
169 #define OPUS_SET_PHASE_INVERSION_DISABLED_REQUEST 4046
170 #define OPUS_GET_PHASE_INVERSION_DISABLED_REQUEST 4047
171 #define OPUS_GET_IN_DTX_REQUEST 4049
172
174 #define OPUS_HAVE_OPUS_PROJECTION_H
175
176 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
177 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
178 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
179 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
180 #define __opus_check_val16_ptr(ptr) ((ptr) + ((ptr) - (opus_val16*)(ptr)))
181
187 /* Values for the various encoder CTLs */
188 #define OPUS_AUTO -1000
189 #define OPUS_BITRATE_MAX -1
193 #define OPUS_APPLICATION_VOIP 2048
194
196 #define OPUS_APPLICATION_AUDIO 2049
197
199 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
200
201 #define OPUS_SIGNAL_VOICE 3001
202 #define OPUS_SIGNAL_MUSIC 3002
203 #define OPUS_BANDWIDTH_NARROWBAND 1101
204 #define OPUS_BANDWIDTH_MEDIUMBAND 1102
205 #define OPUS_BANDWIDTH_WIDEBAND 1103
206 #define OPUS_BANDWIDTH_SUPERWIDEBAND 1104
207 #define OPUS_BANDWIDTH_FULLBAND 1105
209 #define OPUS_FRAMESIZE_ARG 5000
210 #define OPUS_FRAMESIZE_2_5_MS 5001
211 #define OPUS_FRAMESIZE_5_MS 5002
212 #define OPUS_FRAMESIZE_10_MS 5003
213 #define OPUS_FRAMESIZE_20_MS 5004
214 #define OPUS_FRAMESIZE_40_MS 5005
215 #define OPUS_FRAMESIZE_60_MS 5006
216 #define OPUS_FRAMESIZE_80_MS 5007
217 #define OPUS_FRAMESIZE_100_MS 5008
218 #define OPUS_FRAMESIZE_120_MS 5009
253 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
254
259 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
260
272 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
273
280 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
281
295 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
296
306 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
307
324 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
325
334 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
335
349 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
350
359 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
360
377 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
378
390 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
391
409 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
410
421 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
422
431 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
432
433
448 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
449
462 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
463
477 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
478
488 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
489
497 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
498
506 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
507
512 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
513
523 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
524
532 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
533
551 #define OPUS_SET_LSB_DEPTH(x) OPUS_SET_LSB_DEPTH_REQUEST, __opus_check_int(x)
552
557 #define OPUS_GET_LSB_DEPTH(x) OPUS_GET_LSB_DEPTH_REQUEST, __opus_check_int_ptr(x)
558
582 #define OPUS_SET_EXPERT_FRAME_DURATION(x) OPUS_SET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int(x)
583
599 #define OPUS_GET_EXPERT_FRAME_DURATION(x) OPUS_GET_EXPERT_FRAME_DURATION_REQUEST, __opus_check_int_ptr(x)
600
610 #define OPUS_SET_PREDICTION_DISABLED(x) OPUS_SET_PREDICTION_DISABLED_REQUEST, __opus_check_int(x)
611
619 #define OPUS_GET_PREDICTION_DISABLED(x) OPUS_GET_PREDICTION_DISABLED_REQUEST, __opus_check_int_ptr(x)
620
662 #define OPUS_RESET_STATE 4028
663
672 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
673
686 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
687
694 #define OPUS_GET_SAMPLE_RATE(x) OPUS_GET_SAMPLE_RATE_REQUEST, __opus_check_int_ptr(x)
695
709 #define OPUS_SET_PHASE_INVERSION_DISABLED(x) OPUS_SET_PHASE_INVERSION_DISABLED_REQUEST, __opus_check_int(x)
710
718 #define OPUS_GET_PHASE_INVERSION_DISABLED(x) OPUS_GET_PHASE_INVERSION_DISABLED_REQUEST, __opus_check_int_ptr(x)
719
728 #define OPUS_GET_IN_DTX(x) OPUS_GET_IN_DTX_REQUEST, __opus_check_int_ptr(x)
729
747 #define OPUS_SET_GAIN(x) OPUS_SET_GAIN_REQUEST, __opus_check_int(x)
748
752 #define OPUS_GET_GAIN(x) OPUS_GET_GAIN_REQUEST, __opus_check_int_ptr(x)
753
757 #define OPUS_GET_LAST_PACKET_DURATION(x) OPUS_GET_LAST_PACKET_DURATION_REQUEST, __opus_check_int_ptr(x)
758
769 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
770
782 OPUS_EXPORT const char *opus_strerror(int error);
783
792 OPUS_EXPORT const char *opus_get_version_string(void);
795 #ifdef __cplusplus
796 }
797 #endif
798
799 #endif /* OPUS_DEFINES_H */
opus_types.h
Opus reference implementation types.
opus_strerror
const char * opus_strerror(int error)
Converts an opus error code into a human readable string.
opus_get_version_string
const char * opus_get_version_string(void)
Gets the libopus version string.

For more information visit the Opus Website. |