1c07262364af4fdcb5ee75471eeeed3f527782c1
[opus.git] / libcelt / opus_defines.h
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 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_DEFINES_H
29 #define OPUS_DEFINES_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 __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
56 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
57 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
58
59 /* Error codes */
60 /** No error */
61 #define OPUS_OK                0
62 /** An (or more) invalid argument (e.g. out of range) */
63 #define OPUS_BAD_ARG          -1
64 /** The mode struct passed is invalid */
65 #define OPUS_BUFFER_TOO_SMALL -2
66 /** An internal error was detected */
67 #define OPUS_INTERNAL_ERROR   -3
68 /** The data passed (e.g. compressed data to decoder) is corrupted */
69 #define OPUS_CORRUPTED_DATA   -4
70 /** Invalid/unsupported request number */
71 #define OPUS_UNIMPLEMENTED    -5
72 /** An encoder or decoder structure is invalid or already freed */
73 #define OPUS_INVALID_STATE    -6
74 /** Memory allocation has failed */
75 #define OPUS_ALLOC_FAIL       -7
76
77
78
79 /* OPUS_APPLICATION_VOIP or OPUS_APPLICATION_AUDIO */
80 #define OPUS_SET_APPLICATION_REQUEST 4000
81 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
82 #define OPUS_GET_APPLICATION_REQUEST 4001
83 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
84
85 /* Coding bit-rate in bit/second */
86 #define OPUS_SET_BITRATE_REQUEST 4002
87 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
88 #define OPUS_GET_BITRATE_REQUEST 4003
89 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
90
91 /* 0 for CBR, 1 for VBR */
92 #define OPUS_SET_VBR_REQUEST 4006
93 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
94 #define OPUS_GET_VBR_REQUEST 4007
95 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
96
97 #define OPUS_SET_BANDWIDTH_REQUEST 4008
98 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
99 #define OPUS_GET_BANDWIDTH_REQUEST 4009
100 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
101
102 #define OPUS_SET_COMPLEXITY_REQUEST 4010
103 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
104 #define OPUS_GET_COMPLEXITY_REQUEST 4011
105 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
106
107 #define OPUS_SET_INBAND_FEC_REQUEST 4012
108 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
109 #define OPUS_GET_INBAND_FEC_REQUEST 4013
110 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
111
112 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 4014
113 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
114 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 4015
115 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
116
117 #define OPUS_SET_DTX_REQUEST 4016
118 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
119 #define OPUS_GET_DTX_REQUEST 4017
120 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
121
122 #define OPUS_SET_VOICE_RATIO_REQUEST 4018
123 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
124 #define OPUS_GET_VOICE_RATIO_REQUEST 4019
125 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
126
127 #define OPUS_SET_VBR_CONSTRAINT_REQUEST 4020
128 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
129 #define OPUS_GET_VBR_CONSTRAINT_REQUEST 4021
130 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
131
132 #define OPUS_SET_FORCE_MONO_REQUEST 4022
133 #define OPUS_SET_FORCE_MONO(x) OPUS_SET_FORCE_MONO_REQUEST, __opus_check_int(x)
134 #define OPUS_GET_FORCE_MONO_REQUEST 4023
135 #define OPUS_GET_FORCE_MONO(x) OPUS_GET_FORCE_MONO_REQUEST, __opus_check_int_ptr(x)
136
137 #define OPUS_SET_SIGNAL_REQUEST 4024
138 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
139 #define OPUS_GET_SIGNAL_REQUEST 4025
140 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
141
142 #define OPUS_GET_LOOKAHEAD_REQUEST 4027
143 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
144
145 #define OPUS_RESET_STATE 4028
146
147 /* For testing purposes: the encoder and decoder state should
148    always be identical after coding a payload */
149 #define OPUS_GET_FINAL_RANGE_REQUEST 29
150 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
151
152
153
154 OPUS_EXPORT const char *opus_strerror(int error);
155
156 OPUS_EXPORT const char *opus_get_version_string(void);
157
158
159 #ifdef __cplusplus
160 }
161 #endif
162
163 #endif /* OPUS_H */