API doc improvements
[opus.git] / celt / opus_custom.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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef OPUS_CUSTOM_H
36 #define OPUS_CUSTOM_H
37
38
39 #include "opus_defines.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 #ifdef CUSTOM_MODES
46 #define OPUS_CUSTOM_EXPORT OPUS_EXPORT
47 #else
48 #define OPUS_CUSTOM_EXPORT
49 #endif
50
51 /** Contains the state of an encoder. One encoder state is needed
52     for each stream. It is initialised once at the beginning of the
53     stream. Do *not* re-initialise the state for every frame.
54    @brief Encoder state
55  */
56 typedef struct OpusCustomEncoder OpusCustomEncoder;
57
58 /** State of the decoder. One decoder state is needed for each stream.
59     It is initialised once at the beginning of the stream. Do *not*
60     re-initialise the state for every frame */
61 typedef struct OpusCustomDecoder OpusCustomDecoder;
62
63 /** The mode contains all the information necessary to create an
64     encoder. Both the encoder and decoder need to be initialised
65     with exactly the same mode, otherwise the quality will be very
66     bad */
67 typedef struct OpusCustomMode OpusCustomMode;
68
69
70 /** Creates a new mode struct. This will be passed to an encoder or
71     decoder. The mode MUST NOT BE DESTROYED until the encoders and
72     decoders that use it are destroyed as well.
73  @param Fs Sampling rate (32000 to 96000 Hz)
74  @param frame_size Number of samples (per channel) to encode in each
75                    packet (even values; 64 - 512)
76  @param error Returned error code (if NULL, no error will be returned)
77  @return A newly created mode
78 */
79 OPUS_CUSTOM_EXPORT OpusCustomMode *opus_custom_mode_create(opus_int32 Fs, int frame_size, int *error);
80
81 /** Destroys a mode struct. Only call this after all encoders and
82     decoders using this mode are destroyed as well.
83  @param mode Mode to be destroyed
84 */
85 OPUS_CUSTOM_EXPORT void opus_custom_mode_destroy(OpusCustomMode *mode);
86
87
88
89 /* Encoder */
90
91 OPUS_CUSTOM_EXPORT int opus_custom_encoder_get_size(const OpusCustomMode *mode, int channels);
92
93 /** Creates a new encoder state. Each stream needs its own encoder
94     state (can't be shared across simultaneous streams).
95  @param mode Contains all the information about the characteristics of
96  *  the stream (must be the same characteristics as used for the
97  *  decoder)
98  @param channels Number of channels
99  @param error Returns an error code
100  @return Newly created encoder state.
101 */
102 OPUS_CUSTOM_EXPORT OpusCustomEncoder *opus_custom_encoder_create(const OpusCustomMode *mode, int channels, int *error);
103
104 OPUS_CUSTOM_EXPORT int opus_custom_encoder_init(OpusCustomEncoder *st, const OpusCustomMode *mode, int channels);
105
106 /** Destroys a an encoder state.
107  @param st Encoder state to be destroyed
108  */
109 OPUS_CUSTOM_EXPORT void opus_custom_encoder_destroy(OpusCustomEncoder *st);
110
111 /** Encodes a frame of audio.
112  @param st Encoder state
113  @param pcm PCM audio in float format, with a normal range of +/-1.0.
114  *          Samples with a range beyond +/-1.0 are supported but will
115  *          be clipped by decoders using the integer API and should
116  *          only be used if it is known that the far end supports
117  *          extended dynmaic range. There must be exactly
118  *          frame_size samples per channel.
119  @param compressed The compressed data is written here. This may not alias pcm or
120  *                 optional_synthesis.
121  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
122  *          (can change from one frame to another)
123  @return Number of bytes written to "compressed". Will be the same as
124  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
125  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
126  *       the length returned be somehow transmitted to the decoder. Otherwise, no
127  *       decoding is possible.
128 */
129 OPUS_CUSTOM_EXPORT int opus_custom_encode_float(OpusCustomEncoder *st, const float *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
130
131 /** Encodes a frame of audio.
132  @param st Encoder state
133  @param pcm PCM audio in signed 16-bit format (native endian). There must be
134  *          exactly frame_size samples per channel.
135  @param compressed The compressed data is written here. This may not alias pcm or
136  *                         optional_synthesis.
137  @param nbCompressedBytes Maximum number of bytes to use for compressing the frame
138  *                        (can change from one frame to another)
139  @return Number of bytes written to "compressed". Will be the same as
140  *       "nbCompressedBytes" unless the stream is VBR and will never be larger.
141  *       If negative, an error has occurred (see error codes). It is IMPORTANT that
142  *       the length returned be somehow transmitted to the decoder. Otherwise, no
143  *       decoding is possible.
144  */
145 OPUS_CUSTOM_EXPORT int opus_custom_encode(OpusCustomEncoder *st, const opus_int16 *pcm, int frame_size, unsigned char *compressed, int maxCompressedBytes);
146
147 /** Query and set encoder parameters
148  @param st Encoder state
149  @param request Parameter to change or query
150  @param value Pointer to a 32-bit int value
151  @return Error code
152 */
153 OPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl(OpusCustomEncoder * restrict st, int request, ...);
154
155
156
157 /* Decoder */
158
159 OPUS_CUSTOM_EXPORT int opus_custom_decoder_get_size(const OpusCustomMode *mode, int channels);
160
161 /** Creates a new decoder state. Each stream needs its own decoder state (can't
162     be shared across simultaneous streams).
163  @param mode Contains all the information about the characteristics of the
164              stream (must be the same characteristics as used for the encoder)
165  @param channels Number of channels
166  @param error Returns an error code
167  @return Newly created decoder state.
168  */
169 OPUS_CUSTOM_EXPORT OpusCustomDecoder *opus_custom_decoder_create(const OpusCustomMode *mode, int channels, int *error);
170
171 OPUS_CUSTOM_EXPORT int opus_custom_decoder_init(OpusCustomDecoder *st, const OpusCustomMode *mode, int channels);
172
173 /** Destroys a a decoder state.
174  @param st Decoder state to be destroyed
175  */
176 OPUS_CUSTOM_EXPORT void opus_custom_decoder_destroy(OpusCustomDecoder *st);
177
178 /** Decodes a frame of audio.
179  @param st Decoder state
180  @param data Compressed data produced by an encoder
181  @param len Number of bytes to read from "data". This MUST be exactly the number
182             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
183  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
184             returned here in float format.
185  @return Error code.
186    */
187 OPUS_CUSTOM_EXPORT int opus_custom_decode_float(OpusCustomDecoder *st, const unsigned char *data, int len, float *pcm, int frame_size);
188
189 /** Decodes a frame of audio.
190  @param st Decoder state
191  @param data Compressed data produced by an encoder
192  @param len Number of bytes to read from "data". This MUST be exactly the number
193             of bytes returned by the encoder. Using a larger value WILL NOT WORK.
194  @param pcm One frame (frame_size samples per channel) of decoded PCM will be
195             returned here in 16-bit PCM format (native endian).
196  @return Error code.
197  */
198 OPUS_CUSTOM_EXPORT int opus_custom_decode(OpusCustomDecoder *st, const unsigned char *data, int len, opus_int16 *pcm, int frame_size);
199
200 /** Query and set decoder parameters
201    @param st Decoder state
202    @param request Parameter to change or query
203    @param value Pointer to a 32-bit int value
204    @return Error code
205  */
206 OPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl(OpusCustomDecoder * restrict st, int request, ...);
207
208
209 #ifdef __cplusplus
210 }
211 #endif
212
213 #endif /* OPUS_CUSTOM_H */