Opus
Opus audio codec (RFC 6716): API and operations manual
1.1-beta
 All Files Functions Typedefs Macros Groups Pages
opus_custom.h
Go to the documentation of this file.
1 /* Copyright (c) 2007-2008 CSIRO
2  Copyright (c) 2007-2009 Xiph.Org Foundation
3  Copyright (c) 2008-2012 Gregory Maxwell
4  Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9 
10  - Redistributions of source code must retain the above copyright
11  notice, this list of conditions and the following disclaimer.
12 
13  - Redistributions in binary form must reproduce the above copyright
14  notice, this list of conditions and the following disclaimer in the
15  documentation and/or other materials provided with the distribution.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29 
35 #ifndef OPUS_CUSTOM_H
36 #define OPUS_CUSTOM_H
37 
38 #include "opus_defines.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 #ifdef CUSTOM_MODES
45 # define OPUS_CUSTOM_EXPORT OPUS_EXPORT
46 # define OPUS_CUSTOM_EXPORT_STATIC OPUS_EXPORT
47 #else
48 # define OPUS_CUSTOM_EXPORT
49 # ifdef OPUS_BUILD
50 # define OPUS_CUSTOM_EXPORT_STATIC static inline
51 # else
52 # define OPUS_CUSTOM_EXPORT_STATIC
53 # endif
54 #endif
55 
96 
103 
111 
121 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomMode *opus_custom_mode_create(opus_int32 Fs, int frame_size, int *error);
122 
128 
129 
130 #if !defined(OPUS_BUILD) || defined(CELT_ENCODER_C)
131 
132 /* Encoder */
138 OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_encoder_get_size(
139  const OpusCustomMode *mode,
140  int channels
141 ) OPUS_ARG_NONNULL(1);
142 
156  OpusCustomEncoder *st,
157  const OpusCustomMode *mode,
158  int channels
159 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
160 
161 #endif
162 
163 
174  const OpusCustomMode *mode,
175  int channels,
176  int *error
177 ) OPUS_ARG_NONNULL(1);
178 
179 
184 
202 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode_float(
203  OpusCustomEncoder *st,
204  const float *pcm,
205  int frame_size,
206  unsigned char *compressed,
207  int maxCompressedBytes
208 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
209 
223 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode(
224  OpusCustomEncoder *st,
225  const opus_int16 *pcm,
226  int frame_size,
227  unsigned char *compressed,
228  int maxCompressedBytes
229 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
230 
237 OPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl(OpusCustomEncoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);
238 
239 
240 #if !defined(OPUS_BUILD) || defined(CELT_DECODER_C)
241 /* Decoder */
242 
248 OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_decoder_get_size(
249  const OpusCustomMode *mode,
250  int channels
251 ) OPUS_ARG_NONNULL(1);
252 
266  OpusCustomDecoder *st,
267  const OpusCustomMode *mode,
268  int channels
269 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
270 
271 #endif
272 
273 
283  const OpusCustomMode *mode,
284  int channels,
285  int *error
286 ) OPUS_ARG_NONNULL(1);
287 
292 
302 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode_float(
303  OpusCustomDecoder *st,
304  const unsigned char *data,
305  int len,
306  float *pcm,
307  int frame_size
308 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
309 
319 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode(
320  OpusCustomDecoder *st,
321  const unsigned char *data,
322  int len,
323  opus_int16 *pcm,
324  int frame_size
325 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
326 
333 OPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl(OpusCustomDecoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);
334 
337 #ifdef __cplusplus
338 }
339 #endif
340 
341 #endif /* OPUS_CUSTOM_H */
For more information visit the Opus Website.