Updated Doxygen comments, removed an incorrectly placed LGPL header (we own
[opus.git] / libcelt / celt.h
1 /* (C) 2007 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 /* Error codes */
47 /** No error */
48 #define CELT_OK                0
49 /** An (or more) invalid argument (e.g. out of range) */
50 #define CELT_BAD_ARG          -1
51 /** The mode struct passed is invalid */
52 #define CELT_INVALID_MODE     -2
53 /** An internal error was detected */
54 #define CELT_INTERNAL_ERROR   -3
55 /** The data passed (e.g. compressed data to decoder) is corrupted */
56 #define CELT_CORRUPTED_DATA   -4
57
58 /* Requests */
59 #define CELT_GET_FRAME_SIZE   1000
60 #define CELT_GET_LOOKAHEAD    1001
61 #define CELT_GET_NB_CHANNELS  1002
62
63
64 /** Contains the state of an encoder. One encoder state is needed for each 
65     stream. It is initialised once at the beginning of the stream. Do *not*
66     re-initialise the state for every frame.
67    @brief Encoder state
68  */
69 typedef struct CELTEncoder CELTEncoder;
70
71 /** State of the decoder. One decoder state is needed for each stream. It is
72     initialised once at the beginning of the stream. Do *not* re-initialise
73     the state for every frame */
74 typedef struct CELTDecoder CELTDecoder;
75
76 /** The mode contains all the information necessary to create an encoder. Both
77     the encoder and decoder need to be initialised with exactly the same mode,
78     otherwise the quality will be very bad */
79 typedef struct CELTMode CELTMode;
80
81 /* To be removed soon */
82 #define celt_mono celt_mode_create(44100, 1, 256, 128, NULL)
83 #define celt_stereo celt_mode_create(44100, 2, 256, 128, NULL)
84
85
86
87 /** \defgroup codec Encoding and decoding */
88 /*  @{ */
89
90 /* Mode calls */
91
92 /** Creates a new mode struct. This will be passed to an encoder or decoder.
93     The mode MUST NOT BE DESTROYED until the encoders and decoders that use it
94     are destroyed as well.
95  @param Fs Sampling rate (32000 to 64000 Hz)
96  @param channels Number of channels
97  @param frame_size Number of samples (per channel) to encode in each packet (64 - 256)
98  @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)
99  @param error Returned error code (if NULL, no error will be returned)
100  @return A newly created mode
101 */
102 CELTMode *celt_mode_create(int Fs, int channels, int frame_size, int lookahead, int *error);
103
104 /** Destroys a mode struct. Only call this after all encoders and decoders
105     using this mode are destroyed as well.
106  @param mode Mode to be destroyed
107 */
108 void celt_mode_destroy(CELTMode *mode);
109
110 /** Query information from a mode */
111 int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
112
113
114 /* Encoder stuff */
115
116
117 /** Creates a new encoder state. Each stream needs its own encoder state (can't
118     be shared across simultaneous streams).
119  @param mode Contains all the information about the characteristics of the stream
120              (must be the same characteristics as used for the decoder)
121  @return Newly created encoder state.
122 */
123 CELTEncoder *celt_encoder_create(const CELTMode *mode);
124
125 /** Destroys a an encoder state.
126  @param st Encoder state to be destroyed
127  */
128 void celt_encoder_destroy(CELTEncoder *st);
129
130 /** Encodes a frame of audio.
131  @param st Encoder state
132  @param pcm PCM audio in signed 16-bit format (native endian). There must be 
133             exactly frame_size samples per channel. The input data is 
134             overwritten by a copy of what the remote decoder would decode.
135  @param compressed The compressed data is written here
136  @param nbCompressedBytes Number of bytes to use for compressing the frame
137                           (can change from one frame to another)
138  @return Number of bytes written to "compressed". Should be the same as 
139          "nbCompressedBytes" unless the stream is VBR. If negative, an error
140          has occured (see error codes). It is IMPORTANT that the length returned
141          be somehow transmitted to the decoder. Otherwise, no decoding is possible.
142 */
143 int celt_encode(CELTEncoder *st, celt_int16_t *pcm, unsigned char *compressed, int nbCompressedBytes);
144
145 /* Decoder stuff */
146
147
148 /** Creates a new decoder state. Each stream needs its own decoder state (can't
149     be shared across simultaneous streams).
150  @param mode Contains all the information about the characteristics of the
151              stream (must be the same characteristics as used for the encoder)
152  @return Newly created decoder state.
153  */
154 CELTDecoder *celt_decoder_create(const CELTMode *mode);
155
156 /** Destroys a a decoder state.
157  @param st Decoder state to be destroyed
158  */
159 void celt_decoder_destroy(CELTDecoder *st);
160
161 /** Decodes a frame of audio.
162  @param st Decoder state
163  @param data Compressed data produced by an encoder
164  @param len Number of bytes to read from "data". This MUST be exactly the number
165             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
166  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
167             returned here. 
168  @return Error code.
169    */
170 int celt_decode(CELTDecoder *st, unsigned char *data, int len, celt_int16_t *pcm);
171
172 /*  @} */
173
174
175 #ifdef __cplusplus
176 }
177 #endif
178
179 #endif /*CELT_H */