Opus  0.9.14
IETFlow-delayaudiocodec
opus_defines.h
Go to the documentation of this file.
00001 /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited
00002    Written by Jean-Marc Valin and Koen Vos */
00003 /*
00004    Redistribution and use in source and binary forms, with or without
00005    modification, are permitted provided that the following conditions
00006    are met:
00007 
00008    - Redistributions of source code must retain the above copyright
00009    notice, this list of conditions and the following disclaimer.
00010 
00011    - Redistributions in binary form must reproduce the above copyright
00012    notice, this list of conditions and the following disclaimer in the
00013    documentation and/or other materials provided with the distribution.
00014 
00015    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00016    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00017    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00018    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00019    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00020    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00021    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00022    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00023    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00024    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00025    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026 */
00027 
00033 #ifndef OPUS_DEFINES_H
00034 #define OPUS_DEFINES_H
00035 
00036 #include "opus_types.h"
00037 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif
00041 
00046 #define OPUS_OK                0
00047 
00048 #define OPUS_BAD_ARG          -1
00049 
00050 #define OPUS_BUFFER_TOO_SMALL -2
00051 
00052 #define OPUS_INTERNAL_ERROR   -3
00053 
00054 #define OPUS_INVALID_PACKET   -4
00055 
00056 #define OPUS_UNIMPLEMENTED    -5
00057 
00058 #define OPUS_INVALID_STATE    -6
00059 
00060 #define OPUS_ALLOC_FAIL       -7
00061 
00066 #if defined(__GNUC__) && defined(OPUS_BUILD)
00067 # define OPUS_EXPORT __attribute__ ((visibility ("default")))
00068 #elif defined(WIN32)
00069 # ifdef OPUS_BUILD
00070 #   define OPUS_EXPORT __declspec(dllexport)
00071 # else
00072 #   define OPUS_EXPORT __declspec(dllimport)
00073 # endif
00074 #else
00075 # define OPUS_EXPORT
00076 #endif
00077 
00080 #define OPUS_SET_APPLICATION_REQUEST         4000
00081 #define OPUS_GET_APPLICATION_REQUEST         4001
00082 #define OPUS_SET_BITRATE_REQUEST             4002
00083 #define OPUS_GET_BITRATE_REQUEST             4003
00084 #define OPUS_SET_MAX_BANDWIDTH_REQUEST       4004
00085 #define OPUS_GET_MAX_BANDWIDTH_REQUEST       4005
00086 #define OPUS_SET_VBR_REQUEST                 4006
00087 #define OPUS_GET_VBR_REQUEST                 4007
00088 #define OPUS_SET_BANDWIDTH_REQUEST           4008
00089 #define OPUS_GET_BANDWIDTH_REQUEST           4009
00090 #define OPUS_SET_COMPLEXITY_REQUEST          4010
00091 #define OPUS_GET_COMPLEXITY_REQUEST          4011
00092 #define OPUS_SET_INBAND_FEC_REQUEST          4012
00093 #define OPUS_GET_INBAND_FEC_REQUEST          4013
00094 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST    4014
00095 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST    4015
00096 #define OPUS_SET_DTX_REQUEST                 4016
00097 #define OPUS_GET_DTX_REQUEST                 4017
00098 #define OPUS_SET_VBR_CONSTRAINT_REQUEST      4020
00099 #define OPUS_GET_VBR_CONSTRAINT_REQUEST      4021
00100 #define OPUS_SET_FORCE_CHANNELS_REQUEST      4022
00101 #define OPUS_GET_FORCE_CHANNELS_REQUEST      4023
00102 #define OPUS_SET_SIGNAL_REQUEST              4024
00103 #define OPUS_GET_SIGNAL_REQUEST              4025
00104 #define OPUS_GET_LOOKAHEAD_REQUEST           4027
00105 /* #define OPUS_RESET_STATE 4028 */
00106 #define OPUS_GET_FINAL_RANGE_REQUEST         4031
00107 #define OPUS_GET_PITCH_REQUEST               4033
00108 
00109 /* Macros to trigger compilation errors when the wrong types are provided to a CTL */
00110 #define __opus_check_int(x) (((void)((x) == (opus_int32)0)), (opus_int32)(x))
00111 #define __opus_check_int_ptr(ptr) ((ptr) + ((ptr) - (opus_int32*)(ptr)))
00112 #define __opus_check_uint_ptr(ptr) ((ptr) + ((ptr) - (opus_uint32*)(ptr)))
00113 
00119 /* Values for the various encoder CTLs */
00120 #define OPUS_AUTO                           -1000 
00121 #define OPUS_BITRATE_MAX                       -1 
00125 #define OPUS_APPLICATION_VOIP                2048
00126 
00128 #define OPUS_APPLICATION_AUDIO               2049
00129 
00131 #define OPUS_APPLICATION_RESTRICTED_LOWDELAY 2051
00132 
00133 #define OPUS_SIGNAL_VOICE                    3001 
00134 #define OPUS_SIGNAL_MUSIC                    3002 
00135 #define OPUS_BANDWIDTH_NARROWBAND            1101 
00136 #define OPUS_BANDWIDTH_MEDIUMBAND            1102 
00137 #define OPUS_BANDWIDTH_WIDEBAND              1103 
00138 #define OPUS_BANDWIDTH_SUPERWIDEBAND         1104 
00139 #define OPUS_BANDWIDTH_FULLBAND              1105 
00173 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __opus_check_int(x)
00174 
00177 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __opus_check_int_ptr(x)
00178 
00187 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __opus_check_int(x)
00188 
00191 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __opus_check_int_ptr(x)
00192 
00202 #define OPUS_SET_VBR(x) OPUS_SET_VBR_REQUEST, __opus_check_int(x)
00203 
00206 #define OPUS_GET_VBR(x) OPUS_GET_VBR_REQUEST, __opus_check_int_ptr(x)
00207 
00219 #define OPUS_SET_VBR_CONSTRAINT(x) OPUS_SET_VBR_CONSTRAINT_REQUEST, __opus_check_int(x)
00220 
00223 #define OPUS_GET_VBR_CONSTRAINT(x) OPUS_GET_VBR_CONSTRAINT_REQUEST, __opus_check_int_ptr(x)
00224 
00230 #define OPUS_SET_FORCE_CHANNELS(x) OPUS_SET_FORCE_CHANNELS_REQUEST, __opus_check_int(x)
00231 
00234 #define OPUS_GET_FORCE_CHANNELS(x) OPUS_GET_FORCE_CHANNELS_REQUEST, __opus_check_int_ptr(x)
00235 
00245 #define OPUS_SET_MAX_BANDWIDTH(x) OPUS_SET_MAX_BANDWIDTH_REQUEST, __opus_check_int(x)
00246 
00250 #define OPUS_GET_MAX_BANDWIDTH(x) OPUS_GET_MAX_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
00251 
00262 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __opus_check_int(x)
00263 
00272 #define OPUS_SET_SIGNAL(x) OPUS_SET_SIGNAL_REQUEST, __opus_check_int(x)
00273 
00277 #define OPUS_GET_SIGNAL(x) OPUS_GET_SIGNAL_REQUEST, __opus_check_int_ptr(x)
00278 
00279 
00289 #define OPUS_SET_APPLICATION(x) OPUS_SET_APPLICATION_REQUEST, __opus_check_int(x)
00290 
00294 #define OPUS_GET_APPLICATION(x) OPUS_GET_APPLICATION_REQUEST, __opus_check_int_ptr(x)
00295 
00309 #define OPUS_GET_LOOKAHEAD(x) OPUS_GET_LOOKAHEAD_REQUEST, __opus_check_int_ptr(x)
00310 
00316 #define OPUS_SET_INBAND_FEC(x) OPUS_SET_INBAND_FEC_REQUEST, __opus_check_int(x)
00317 
00321 #define OPUS_GET_INBAND_FEC(x) OPUS_GET_INBAND_FEC_REQUEST, __opus_check_int_ptr(x)
00322 
00330 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __opus_check_int(x)
00331 
00335 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __opus_check_int_ptr(x)
00336 
00342 #define OPUS_SET_DTX(x) OPUS_SET_DTX_REQUEST, __opus_check_int(x)
00343 
00347 #define OPUS_GET_DTX(x) OPUS_GET_DTX_REQUEST, __opus_check_int_ptr(x)
00348 
00389 #define OPUS_RESET_STATE 4028
00390 
00399 #define OPUS_GET_FINAL_RANGE(x) OPUS_GET_FINAL_RANGE_REQUEST, __opus_check_uint_ptr(x)
00400 
00411 #define OPUS_GET_PITCH(x) OPUS_GET_PITCH_REQUEST, __opus_check_int_ptr(x)
00412 
00416 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __opus_check_int_ptr(x)
00417 
00429 OPUS_EXPORT const char *opus_strerror(int error);
00430 
00435 OPUS_EXPORT const char *opus_get_version_string(void);
00438 #ifdef __cplusplus
00439 }
00440 #endif
00441 
00442 #endif /* OPUS_DEFINES_H */
 All Files Functions Typedefs Defines