Setting CELT complexity
[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    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef OPUS_H
33 #define OPUS_H
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #if defined(__GNUC__) && defined(CELT_BUILD)
40 #define EXPORT __attribute__ ((visibility ("default")))
41 #elif defined(WIN32)
42 #define EXPORT __declspec(dllexport)
43 #else
44 #define EXPORT
45 #endif
46
47 #define __check_int(x) (((void)((x) == (int)0)), (int)(x))
48 #define __check_int_ptr(ptr) ((ptr) + ((ptr) - (int*)(ptr)))
49
50 #define OPUS_TEST_RANGE_CODER_STATE     1
51
52 #define MODE_SILK_ONLY 1000
53 #define MODE_HYBRID    1001
54 #define MODE_CELT_ONLY 1002
55
56 #define BANDWIDTH_NARROWBAND    1100
57 #define BANDWIDTH_MEDIUMBAND    1101
58 #define BANDWIDTH_WIDEBAND      1102
59 #define BANDWIDTH_SUPERWIDEBAND 1103
60 #define BANDWIDTH_FULLBAND      1104
61
62
63
64 #define OPUS_SET_MODE_REQUEST 0
65 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
66 #define OPUS_GET_MODE_REQUEST 1
67 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
68
69 #define OPUS_SET_BITRATE_REQUEST 2
70 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
71 #define OPUS_GET_BITRATE_REQUEST 3
72 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
73
74 #define OPUS_SET_VBR_FLAG_REQUEST 6
75 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
76 #define OPUS_GET_VBR_FLAG_REQUEST 7
77 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
78
79 #define OPUS_SET_BANDWIDTH_REQUEST 8
80 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
81 #define OPUS_GET_BANDWIDTH_REQUEST 9
82 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
83
84 #define OPUS_SET_COMPLEXITY_REQUEST 10
85 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
86 #define OPUS_GET_COMPLEXITY_REQUEST 11
87 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
88
89 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
90 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
91 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
92 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
93
94 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
95 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
96 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
97 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
98
99 #define OPUS_SET_DTX_FLAG_REQUEST 16
100 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
101 #define OPUS_GET_DTX_FLAG_REQUEST 17
102 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
103
104 typedef struct OpusEncoder OpusEncoder;
105 typedef struct OpusDecoder OpusDecoder;
106
107 OpusEncoder *opus_encoder_create(int Fs, int channels);
108
109 /* returns length of data payload (in bytes) */
110 int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
111                 unsigned char *data, int max_data_bytes);
112
113 void opus_encoder_destroy(OpusEncoder *st);
114
115 void opus_encoder_ctl(OpusEncoder *st, int request, ...);
116
117 OpusDecoder *opus_decoder_create(int Fs, int channels);
118
119 /* returns (CELT) error code */
120 int opus_decode(OpusDecoder *st, const unsigned char *data, int len,
121                 short *pcm, int frame_size);
122
123 void opus_decoder_ctl(OpusDecoder *st, int request, ...);
124
125 void opus_decoder_destroy(OpusDecoder *st);
126
127 #if OPUS_TEST_RANGE_CODER_STATE
128 int opus_encoder_get_final_range(OpusEncoder *st);
129 int opus_decoder_get_final_range(OpusDecoder *st);
130 #endif
131
132
133 #ifdef __cplusplus
134 }
135 #endif
136
137 #endif /* OPUS_H */