API: Change celt_encode and celt_encode_float so that they take an optional synthesis...
[opus.git] / libcelt / celt.h
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
3 /**
4   @file celt.h
5   @brief Contains all the functions for encoding and decoding audio streams
6  */
7
8 /*
9    Redistribution and use in source and binary forms, with or without
10    modification, are permitted provided that the following conditions
11    are met:
12    
13    - Redistributions of source code must retain the above copyright
14    notice, this list of conditions and the following disclaimer.
15    
16    - Redistributions in binary form must reproduce the above copyright
17    notice, this list of conditions and the following disclaimer in the
18    documentation and/or other materials provided with the distribution.
19    
20    - Neither the name of the Xiph.org Foundation nor the names of its
21    contributors may be used to endorse or promote products derived from
22    this software without specific prior written permission.
23    
24    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
28    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
31    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37 #ifndef CELT_H
38 #define CELT_H
39
40 #include "celt_types.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #if defined(__GNUC__) && defined(CELT_BUILD)
47 #define EXPORT __attribute__ ((visibility ("default")))
48 #elif defined(WIN32)
49 #define EXPORT __declspec(dllexport)
50 #else
51 #define EXPORT
52 #endif
53
54 /* Error codes */
55 /** No error */
56 #define CELT_OK                0
57 /** An (or more) invalid argument (e.g. out of range) */
58 #define CELT_BAD_ARG          -1
59 /** The mode struct passed is invalid */
60 #define CELT_INVALID_MODE     -2
61 /** An internal error was detected */
62 #define CELT_INTERNAL_ERROR   -3
63 /** The data passed (e.g. compressed data to decoder) is corrupted */
64 #define CELT_CORRUPTED_DATA   -4
65 /** Invalid/unsupported request number */
66 #define CELT_BAD_REQUEST      -5
67
68 /* Requests */
69 #define CELT_SET_COMPLEXITY    0
70
71 /** GET the frame size used in the current mode */
72 #define CELT_GET_FRAME_SIZE   1000
73 /** GET the lookahead used in the current mode */
74 #define CELT_GET_LOOKAHEAD    1001
75 /** GET the number of channels used in the current mode */
76 #define CELT_GET_NB_CHANNELS  1002
77
78 /** GET the bit-stream version for compatibility check */
79 #define CELT_GET_BITSTREAM_VERSION 2000
80
81
82 /** Contains the state of an encoder. One encoder state is needed for each 
83     stream. It is initialised once at the beginning of the stream. Do *not*
84     re-initialise the state for every frame.
85    @brief Encoder state
86  */
87 typedef struct CELTEncoder CELTEncoder;
88
89 /** State of the decoder. One decoder state is needed for each stream. It is
90     initialised once at the beginning of the stream. Do *not* re-initialise
91     the state for every frame */
92 typedef struct CELTDecoder CELTDecoder;
93
94 /** The mode contains all the information necessary to create an encoder. Both
95     the encoder and decoder need to be initialised with exactly the same mode,
96     otherwise the quality will be very bad */
97 typedef struct CELTMode CELTMode;
98
99
100 /** \defgroup codec Encoding and decoding */
101 /*  @{ */
102
103 /* Mode calls */
104
105 /** Creates a new mode struct. This will be passed to an encoder or decoder.
106     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
107     are destroyed as well.
108  @param Fs Sampling rate (32000 to 64000 Hz)
109  @param channels Number of channels
110  @param frame_size Number of samples (per channel) to encode in each packet (64 - 256)
111  @param lookahead Extra latency (in samples per channel) in addition to the frame size (between 32 and frame_size). The larger that value, the better the quality (at the expense of latency)
112  @param error Returned error code (if NULL, no error will be returned)
113  @return A newly created mode
114 */
115 EXPORT CELTMode *celt_mode_create(celt_int32_t Fs, int channels, int frame_size, int *error);
116
117 /** Destroys a mode struct. Only call this after all encoders and decoders
118     using this mode are destroyed as well.
119  @param mode Mode to be destroyed
120 */
121 EXPORT void celt_mode_destroy(CELTMode *mode);
122
123 /** Query information from a mode */
124 EXPORT int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
125
126 /* Encoder stuff */
127
128
129 /** Creates a new encoder state. Each stream needs its own encoder state (can't
130     be shared across simultaneous streams).
131  @param mode Contains all the information about the characteristics of the stream
132              (must be the same characteristics as used for the decoder)
133  @return Newly created encoder state.
134 */
135 EXPORT CELTEncoder *celt_encoder_create(const CELTMode *mode);
136
137 /** Destroys a an encoder state.
138  @param st Encoder state to be destroyed
139  */
140 EXPORT void celt_encoder_destroy(CELTEncoder *st);
141
142 /** Encodes a frame of audio.
143  @param st Encoder state
144  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
145             exactly frame_size samples per channel. The input data is 
146             overwritten by a copy of what the remote decoder would decode.
147  @param compressed The compressed data is written here
148  @param nbCompressedBytes Number of bytes to use for compressing the frame
149                           (can change from one frame to another)
150  @return Number of bytes written to "compressed". Should be the same as 
151          "nbCompressedBytes" unless the stream is VBR. If negative, an error
152          has occured (see error codes). It is IMPORTANT that the length returned
153          be somehow transmitted to the decoder. Otherwise, no decoding is possible.
154 */
155 EXPORT int celt_encode_float(CELTEncoder *st, const float *pcm, float *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
156 EXPORT int celt_encode(CELTEncoder *st, const celt_int16_t *pcm, celt_int16_t *optional_synthesis, unsigned char *compressed, int nbCompressedBytes);
157
158 /** Query and set encoder parameters 
159  @param st Encoder state
160  @param request Parameter to change or query
161  @param value Pointer to a 32-bit int value
162  @return Error code
163 */
164 EXPORT int celt_encoder_ctl(CELTEncoder * st, int request, celt_int32_t *value);
165
166 /* Decoder stuff */
167
168
169 /** Creates a new decoder state. Each stream needs its own decoder state (can't
170     be shared across simultaneous streams).
171  @param mode Contains all the information about the characteristics of the
172              stream (must be the same characteristics as used for the encoder)
173  @return Newly created decoder state.
174  */
175 EXPORT CELTDecoder *celt_decoder_create(const CELTMode *mode);
176
177 /** Destroys a a decoder state.
178  @param st Decoder state to be destroyed
179  */
180 EXPORT void celt_decoder_destroy(CELTDecoder *st);
181
182 /** Decodes a frame of audio.
183  @param st Decoder state
184  @param data Compressed data produced by an encoder
185  @param len Number of bytes to read from "data". This MUST be exactly the number
186             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
187  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
188             returned here. 
189  @return Error code.
190    */
191 EXPORT int celt_decode_float(CELTDecoder *st, unsigned char *data, int len, float *pcm);
192 EXPORT int celt_decode(CELTDecoder *st, unsigned char *data, int len, celt_int16_t *pcm);
193
194 /*  @} */
195
196
197 #ifdef __cplusplus
198 }
199 #endif
200
201 #endif /*CELT_H */