SILK bugfix
[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(CELT_BUILD)
36 #define EXPORT __attribute__ ((visibility ("default")))
37 #elif defined(WIN32)
38 #define EXPORT __declspec(dllexport)
39 #else
40 #define 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 #define OPUS_TEST_RANGE_CODER_STATE     1
47
48 #define MODE_SILK_ONLY 1000
49 #define MODE_HYBRID    1001
50 #define MODE_CELT_ONLY 1002
51
52 #define BANDWIDTH_NARROWBAND    1100
53 #define BANDWIDTH_MEDIUMBAND    1101
54 #define BANDWIDTH_WIDEBAND      1102
55 #define BANDWIDTH_SUPERWIDEBAND 1103
56 #define BANDWIDTH_FULLBAND      1104
57
58
59
60 #define OPUS_SET_MODE_REQUEST 0
61 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
62 #define OPUS_GET_MODE_REQUEST 1
63 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
64
65 #define OPUS_SET_BITRATE_REQUEST 2
66 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
67 #define OPUS_GET_BITRATE_REQUEST 3
68 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
69
70 #define OPUS_SET_VBR_FLAG_REQUEST 6
71 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
72 #define OPUS_GET_VBR_FLAG_REQUEST 7
73 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
74
75 #define OPUS_SET_BANDWIDTH_REQUEST 8
76 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
77 #define OPUS_GET_BANDWIDTH_REQUEST 9
78 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
79
80 #define OPUS_SET_COMPLEXITY_REQUEST 10
81 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
82 #define OPUS_GET_COMPLEXITY_REQUEST 11
83 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
84
85 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
86 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
87 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
88 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
89
90 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
91 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
92 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
93 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
94
95 #define OPUS_SET_DTX_FLAG_REQUEST 16
96 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
97 #define OPUS_GET_DTX_FLAG_REQUEST 17
98 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
99
100 typedef struct OpusEncoder OpusEncoder;
101 typedef struct OpusDecoder OpusDecoder;
102
103 OpusEncoder *opus_encoder_create(int Fs, int channels);
104
105 /* returns length of data payload (in bytes) */
106 int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
107                 unsigned char *data, int max_data_bytes);
108
109 void opus_encoder_destroy(OpusEncoder *st);
110
111 void opus_encoder_ctl(OpusEncoder *st, int request, ...);
112
113 OpusDecoder *opus_decoder_create(int Fs, int channels);
114
115 /* returns (CELT) error code */
116 int opus_decode(OpusDecoder *st, const unsigned char *data, int len,
117                 short *pcm, int frame_size, int decode_fec);
118
119 void opus_decoder_ctl(OpusDecoder *st, int request, ...);
120
121 void opus_decoder_destroy(OpusDecoder *st);
122
123 #if OPUS_TEST_RANGE_CODER_STATE
124 int opus_encoder_get_final_range(OpusEncoder *st);
125 int opus_decoder_get_final_range(OpusDecoder *st);
126 #endif
127
128
129 #ifdef __cplusplus
130 }
131 #endif
132
133 #endif /* OPUS_H */