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