Merged Koen's encoder changes
[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 MODE_SILK_ONLY 1000
51 #define MODE_HYBRID    1001
52 #define MODE_CELT_ONLY 1002
53
54 #define BANDWIDTH_NARROWBAND    1100
55 #define BANDWIDTH_MEDIUMBAND    1101
56 #define BANDWIDTH_WIDEBAND      1102
57 #define BANDWIDTH_SUPERWIDEBAND 1103
58 #define BANDWIDTH_FULLBAND      1104
59
60
61
62 #define OPUS_SET_MODE_REQUEST 0
63 #define OPUS_SET_MODE(x) OPUS_SET_MODE_REQUEST, __check_int(x)
64 #define OPUS_GET_MODE_REQUEST 1
65 #define OPUS_GET_MODE(x) OPUS_GET_MODE_REQUEST, __check_int_ptr(x)
66
67 #define OPUS_SET_BITRATE_REQUEST 2
68 #define OPUS_SET_BITRATE(x) OPUS_SET_BITRATE_REQUEST, __check_int(x)
69 #define OPUS_GET_BITRATE_REQUEST 3
70 #define OPUS_GET_BITRATE(x) OPUS_GET_BITRATE_REQUEST, __check_int_ptr(x)
71
72 #define OPUS_SET_VBR_FLAG_REQUEST 6
73 #define OPUS_SET_VBR_FLAG(x) OPUS_SET_VBR_FLAG_REQUEST, __check_int(x)
74 #define OPUS_GET_VBR_FLAG_REQUEST 7
75 #define OPUS_GET_VBR_FLAG(x) OPUS_GET_VBR_FLAG_REQUEST, __check_int_ptr(x)
76
77 #define OPUS_SET_BANDWIDTH_REQUEST 8
78 #define OPUS_SET_BANDWIDTH(x) OPUS_SET_BANDWIDTH_REQUEST, __check_int(x)
79 #define OPUS_GET_BANDWIDTH_REQUEST 9
80 #define OPUS_GET_BANDWIDTH(x) OPUS_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
81
82 #define OPUS_SET_COMPLEXITY_REQUEST 10
83 #define OPUS_SET_COMPLEXITY(x) OPUS_SET_COMPLEXITY_REQUEST, __check_int(x)
84 #define OPUS_GET_COMPLEXITY_REQUEST 11
85 #define OPUS_GET_COMPLEXITY(x) OPUS_GET_COMPLEXITY_REQUEST, __check_int_ptr(x)
86
87 #define OPUS_SET_INBAND_FEC_FLAG_REQUEST 12
88 #define OPUS_SET_INBAND_FEC_FLAG(x) OPUS_SET_INBAND_FEC_FLAG_REQUEST, __check_int(x)
89 #define OPUS_GET_INBAND_FEC_FLAG_REQUEST 13
90 #define OPUS_GET_INBAND_FEC_FLAG(x) OPUS_GET_INBAND_FEC_FLAG_REQUEST, __check_int_ptr(x)
91
92 #define OPUS_SET_PACKET_LOSS_PERC_REQUEST 14
93 #define OPUS_SET_PACKET_LOSS_PERC(x) OPUS_SET_PACKET_LOSS_PERC_REQUEST, __check_int(x)
94 #define OPUS_GET_PACKET_LOSS_PERC_REQUEST 15
95 #define OPUS_GET_PACKET_LOSS_PERC(x) OPUS_GET_PACKET_LOSS_PERC_REQUEST, __check_int_ptr(x)
96
97 #define OPUS_SET_DTX_FLAG_REQUEST 16
98 #define OPUS_SET_DTX_FLAG(x) OPUS_SET_DTX_FLAG_REQUEST, __check_int(x)
99 #define OPUS_GET_DTX_FLAG_REQUEST 17
100 #define OPUS_GET_DTX_FLAG(x) OPUS_GET_DTX_FLAG_REQUEST, __check_int_ptr(x)
101
102 typedef struct OpusEncoder OpusEncoder;
103 typedef struct OpusDecoder OpusDecoder;
104
105 OpusEncoder *opus_encoder_create(int Fs, int channels);
106
107 int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
108                 unsigned char *data, int bytes_per_packet);
109
110 void opus_encoder_destroy(OpusEncoder *st);
111
112 void opus_encoder_ctl(OpusEncoder *st, int request, ...);
113
114 OpusDecoder *opus_decoder_create(int Fs, int channels);
115
116 int opus_decode(OpusDecoder *st, const unsigned char *data, int len,
117                 short *pcm, int frame_size);
118
119 void opus_decoder_ctl(OpusDecoder *st, int request, ...);
120
121 void opus_decoder_destroy(OpusDecoder *st);
122
123 #ifdef __cplusplus
124 }
125 #endif
126
127 #endif /* OPUS_H */