Adds 3rd clause to CELT license
[opus.git] / celt / celt.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /**
6   @file celt.h
7   @brief Contains all the functions for encoding and decoding audio
8  */
9
10 /*
11    Redistribution and use in source and binary forms, with or without
12    modification, are permitted provided that the following conditions
13    are met:
14
15    - Redistributions of source code must retain the above copyright
16    notice, this list of conditions and the following disclaimer.
17
18    - Redistributions in binary form must reproduce the above copyright
19    notice, this list of conditions and the following disclaimer in the
20    documentation and/or other materials provided with the distribution.
21
22    - Neither the name of Internet Society, IETF or IETF Trust, nor the
23    names of specific contributors, may be used to endorse or promote
24    products derived from this software without specific prior written
25    permission.
26
27    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
31    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 #ifndef CELT_H
41 #define CELT_H
42
43 #include "opus_types.h"
44 #include "opus_defines.h"
45 #include "opus_custom.h"
46 #include "entenc.h"
47 #include "entdec.h"
48 #include "arch.h"
49
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53
54 #define CELTEncoder OpusCustomEncoder
55 #define CELTDecoder OpusCustomDecoder
56 #define CELTMode OpusCustomMode
57
58 #define _celt_check_mode_ptr_ptr(ptr) ((ptr) + ((ptr) - (const CELTMode**)(ptr)))
59
60 /* Encoder/decoder Requests */
61
62 #define CELT_SET_PREDICTION_REQUEST    10002
63 /** Controls the use of interframe prediction.
64     0=Independent frames
65     1=Short term interframe prediction allowed
66     2=Long term prediction allowed
67  */
68 #define CELT_SET_PREDICTION(x) CELT_SET_PREDICTION_REQUEST, __opus_check_int(x)
69
70 #define CELT_SET_INPUT_CLIPPING_REQUEST    10004
71 #define CELT_SET_INPUT_CLIPPING(x) CELT_SET_INPUT_CLIPPING_REQUEST, __opus_check_int(x)
72
73 #define CELT_GET_AND_CLEAR_ERROR_REQUEST   10007
74 #define CELT_GET_AND_CLEAR_ERROR(x) CELT_GET_AND_CLEAR_ERROR_REQUEST, __opus_check_int_ptr(x)
75
76 #define CELT_SET_CHANNELS_REQUEST    10008
77 #define CELT_SET_CHANNELS(x) CELT_SET_CHANNELS_REQUEST, __opus_check_int(x)
78
79
80 /* Internal */
81 #define CELT_SET_START_BAND_REQUEST    10010
82 #define CELT_SET_START_BAND(x) CELT_SET_START_BAND_REQUEST, __opus_check_int(x)
83
84 #define CELT_SET_END_BAND_REQUEST    10012
85 #define CELT_SET_END_BAND(x) CELT_SET_END_BAND_REQUEST, __opus_check_int(x)
86
87 #define CELT_GET_MODE_REQUEST    10015
88 /** Get the CELTMode used by an encoder or decoder */
89 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
90
91 #define CELT_SET_SIGNALLING_REQUEST    10016
92 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, __opus_check_int(x)
93
94
95
96 /* Encoder stuff */
97
98 int celt_encoder_get_size(int channels);
99
100 int celt_encode_with_ec(OpusCustomEncoder * restrict st, const opus_val16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
101
102 int celt_encoder_init(CELTEncoder *st, opus_int32 sampling_rate, int channels);
103
104
105
106 /* Decoder stuff */
107
108 int celt_decoder_get_size(int channels);
109
110
111 int celt_decoder_init(CELTDecoder *st, opus_int32 sampling_rate, int channels);
112
113 int celt_decode_with_ec(OpusCustomDecoder * restrict st, const unsigned char *data, int len, opus_val16 * restrict pcm, int frame_size, ec_dec *dec);
114
115 #define celt_encoder_ctl opus_custom_encoder_ctl
116 #define celt_decoder_ctl opus_custom_decoder_ctl
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif /* CELT_H */