Initial surround code with new API
[opus.git] / include / opus_custom.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008-2012 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16
17    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 /**
31   @file opus_custom.h
32   @brief Opus-Custom reference implementation API
33  */
34
35 #ifndef OPUS_CUSTOM_H
36 #define OPUS_CUSTOM_H
37
38 #include "opus_defines.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #ifdef CUSTOM_MODES
45 # define OPUS_CUSTOM_EXPORT OPUS_EXPORT
46 # define OPUS_CUSTOM_EXPORT_STATIC OPUS_EXPORT
47 #else
48 # define OPUS_CUSTOM_EXPORT
49 # ifdef OPUS_BUILD
50 #  define OPUS_CUSTOM_EXPORT_STATIC static inline
51 # else
52 #  define OPUS_CUSTOM_EXPORT_STATIC
53 # endif
54 #endif
55
56 /** @defgroup opus_custom Opus Custom
57   * @{
58   *  Opus Custom is an optional part of the Opus specification and
59   * reference implementation which uses a distinct API from the regular
60   * API and supports frame sizes that are not normally supported.\ Use
61   * of Opus Custom is discouraged for all but very special applications
62   * for which a frame size different from 2.5, 5, 10, or 20 ms is needed
63   * (for either complexity or latency reasons) and where interoperability
64   * is less important.
65   *
66   * In addition to the interoperability limitations the use of Opus custom
67   * disables a substantial chunk of the codec and generally lowers the
68   * quality available at a given bitrate. Normally when an application needs
69   * a different frame size from the codec it should buffer to match the
70   * sizes but this adds a small amount of delay which may be important
71   * in some very low latency applications. Some transports (especially
72   * constant rate RF transports) may also work best with frames of
73   * particular durations.
74   *
75   * Libopus only supports custom modes if they are enabled at compile time.
76   *
77   * The Opus Custom API is similar to the regular API but the
78   * @ref opus_encoder_create and @ref opus_decoder_create calls take
79   * an additional mode parameter which is a structure produced by
80   * a call to @ref opus_custom_mode_create. Both the encoder and decoder
81   * must create a mode using the same sample rate (fs) and frame size
82   * (frame size) so these parameters must either be signaled out of band
83   * or fixed in a particular implementation.
84   *
85   * Similar to regular Opus the custom modes support on the fly frame size
86   * switching, but the sizes available depend on the particular frame size in
87   * use. For some initial frame sizes on a single on the fly size is available.
88   */
89
90 /** Contains the state of an encoder. One encoder state is needed
91     for each stream. It is initialized once at the beginning of the
92     stream. Do *not* re-initialize the state for every frame.
93    @brief Encoder state
94  */
95 typedef struct OpusCustomEncoder OpusCustomEncoder;
96
97 /** State of the decoder. One decoder state is needed for each stream.
98     It is initialized once at the beginning of the stream. Do *not*
99     re-initialize the state for every frame.
100    @brief Decoder state
101  */
102 typedef struct OpusCustomDecoder OpusCustomDecoder;
103
104 /** The mode contains all the information necessary to create an
105     encoder. Both the encoder and decoder need to be initialized
106     with exactly the same mode, otherwise the output will be
107     corrupted.
108    @brief Mode configuration
109  */
110 typedef struct OpusCustomMode OpusCustomMode;
111
112 /** Creates a new mode struct. This will be passed to an encoder or
113   * decoder. The mode MUST NOT BE DESTROYED until the encoders and
114   * decoders that use it are destroyed as well.
115   * @param [in] Fs <tt>int</tt>: Sampling rate (8000 to 96000 Hz)
116   * @param [in] frame_size <tt>int</tt>: Number of samples (per channel) to encode in each
117   *        packet (64 - 1024, prime factorization must contain zero or more 2s, 3s, or 5s and no other primes)
118   * @param [out] error <tt>int*</tt>: Returned error code (if NULL, no error will be returned)
119   * @return A newly created mode
120   */
121 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomMode *opus_custom_mode_create(opus_int32 Fs, int frame_size, int *error);
122
123 /** Destroys a mode struct. Only call this after all encoders and
124   * decoders using this mode are destroyed as well.
125   * @param [in] mode <tt>OpusCustomMode*</tt>: Mode to be freed.
126   */
127 OPUS_CUSTOM_EXPORT void opus_custom_mode_destroy(OpusCustomMode *mode);
128
129
130 #if !defined(OPUS_BUILD) || defined(CELT_ENCODER_C)
131
132 /* Encoder */
133 /** Gets the size of an OpusCustomEncoder structure.
134   * @param [in] mode <tt>OpusCustomMode *</tt>: Mode configuration
135   * @param [in] channels <tt>int</tt>: Number of channels
136   * @returns size
137   */
138 OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_encoder_get_size(
139     const OpusCustomMode *mode,
140     int channels
141 ) OPUS_ARG_NONNULL(1);
142
143 /** Initializes a previously allocated encoder state
144   * The memory pointed to by st must be the size returned by opus_custom_encoder_get_size.
145   * This is intended for applications which use their own allocator instead of malloc.
146   * @see opus_custom_encoder_create(),opus_custom_encoder_get_size()
147   * To reset a previously initialized state use the OPUS_RESET_STATE CTL.
148   * @param [in] st <tt>OpusCustomEncoder*</tt>: Encoder state
149   * @param [in] mode <tt>OpusCustomMode *</tt>: Contains all the information about the characteristics of
150   *  the stream (must be the same characteristics as used for the
151   *  decoder)
152   * @param [in] channels <tt>int</tt>: Number of channels
153   * @return OPUS_OK Success or @ref opus_errorcodes
154   */
155 OPUS_CUSTOM_EXPORT_STATIC int opus_custom_encoder_init(
156     OpusCustomEncoder *st,
157     const OpusCustomMode *mode,
158     int channels
159 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
160
161 #endif
162
163
164 /** Creates a new encoder state. Each stream needs its own encoder
165   * state (can't be shared across simultaneous streams).
166   * @param [in] mode <tt>OpusCustomMode*</tt>: Contains all the information about the characteristics of
167   *  the stream (must be the same characteristics as used for the
168   *  decoder)
169   * @param [in] channels <tt>int</tt>: Number of channels
170   * @param [out] error <tt>int*</tt>: Returns an error code
171   * @return Newly created encoder state.
172 */
173 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomEncoder *opus_custom_encoder_create(
174     const OpusCustomMode *mode,
175     int channels,
176     int *error
177 ) OPUS_ARG_NONNULL(1);
178
179
180 /** Destroys a an encoder state.
181   * @param[in] st <tt>OpusCustomEncoder*</tt>: State to be freed.
182   */
183 OPUS_CUSTOM_EXPORT void opus_custom_encoder_destroy(OpusCustomEncoder *st);
184
185 /** Encodes a frame of audio.
186   * @param [in] st <tt>OpusCustomEncoder*</tt>: Encoder state
187   * @param [in] pcm <tt>float*</tt>: PCM audio in float format, with a normal range of +/-1.0.
188   *          Samples with a range beyond +/-1.0 are supported but will
189   *          be clipped by decoders using the integer API and should
190   *          only be used if it is known that the far end supports
191   *          extended dynamic range. There must be exactly
192   *          frame_size samples per channel.
193   * @param [in] frame_size <tt>int</tt>: Number of samples per frame of input signal
194   * @param [out] compressed <tt>char *</tt>: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
195   * @param [in] maxCompressedBytes <tt>int</tt>: Maximum number of bytes to use for compressing the frame
196   *          (can change from one frame to another)
197   * @return Number of bytes written to "compressed".
198   *       If negative, an error has occurred (see error codes). It is IMPORTANT that
199   *       the length returned be somehow transmitted to the decoder. Otherwise, no
200   *       decoding is possible.
201   */
202 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode_float(
203     OpusCustomEncoder *st,
204     const float *pcm,
205     int frame_size,
206     unsigned char *compressed,
207     int maxCompressedBytes
208 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
209
210 /** Encodes a frame of audio.
211   * @param [in] st <tt>OpusCustomEncoder*</tt>: Encoder state
212   * @param [in] pcm <tt>opus_int16*</tt>: PCM audio in signed 16-bit format (native endian).
213   *          There must be exactly frame_size samples per channel.
214   * @param [in] frame_size <tt>int</tt>: Number of samples per frame of input signal
215   * @param [out] compressed <tt>char *</tt>: The compressed data is written here. This may not alias pcm and must be at least maxCompressedBytes long.
216   * @param [in] maxCompressedBytes <tt>int</tt>: Maximum number of bytes to use for compressing the frame
217   *          (can change from one frame to another)
218   * @return Number of bytes written to "compressed".
219   *       If negative, an error has occurred (see error codes). It is IMPORTANT that
220   *       the length returned be somehow transmitted to the decoder. Otherwise, no
221   *       decoding is possible.
222  */
223 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_encode(
224     OpusCustomEncoder *st,
225     const opus_int16 *pcm,
226     int frame_size,
227     unsigned char *compressed,
228     int maxCompressedBytes
229 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2) OPUS_ARG_NONNULL(4);
230
231 /** Perform a CTL function on an Opus custom encoder.
232   *
233   * Generally the request and subsequent arguments are generated
234   * by a convenience macro.
235   * @see opus_encoderctls
236   */
237 OPUS_CUSTOM_EXPORT int opus_custom_encoder_ctl(OpusCustomEncoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);
238
239
240 #if !defined(OPUS_BUILD) || defined(CELT_DECODER_C)
241 /* Decoder */
242
243 /** Gets the size of an OpusCustomDecoder structure.
244   * @param [in] mode <tt>OpusCustomMode *</tt>: Mode configuration
245   * @param [in] channels <tt>int</tt>: Number of channels
246   * @returns size
247   */
248 OPUS_CUSTOM_EXPORT_STATIC OPUS_WARN_UNUSED_RESULT int opus_custom_decoder_get_size(
249     const OpusCustomMode *mode,
250     int channels
251 ) OPUS_ARG_NONNULL(1);
252
253 /** Initializes a previously allocated decoder state
254   * The memory pointed to by st must be the size returned by opus_custom_decoder_get_size.
255   * This is intended for applications which use their own allocator instead of malloc.
256   * @see opus_custom_decoder_create(),opus_custom_decoder_get_size()
257   * To reset a previously initialized state use the OPUS_RESET_STATE CTL.
258   * @param [in] st <tt>OpusCustomDecoder*</tt>: Decoder state
259   * @param [in] mode <tt>OpusCustomMode *</tt>: Contains all the information about the characteristics of
260   *  the stream (must be the same characteristics as used for the
261   *  encoder)
262   * @param [in] channels <tt>int</tt>: Number of channels
263   * @return OPUS_OK Success or @ref opus_errorcodes
264   */
265 OPUS_CUSTOM_EXPORT_STATIC int opus_custom_decoder_init(
266     OpusCustomDecoder *st,
267     const OpusCustomMode *mode,
268     int channels
269 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(2);
270
271 #endif
272
273
274 /** Creates a new decoder state. Each stream needs its own decoder state (can't
275   * be shared across simultaneous streams).
276   * @param [in] mode <tt>OpusCustomMode</tt>: Contains all the information about the characteristics of the
277   *          stream (must be the same characteristics as used for the encoder)
278   * @param [in] channels <tt>int</tt>: Number of channels
279   * @param [out] error <tt>int*</tt>: Returns an error code
280   * @return Newly created decoder state.
281   */
282 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT OpusCustomDecoder *opus_custom_decoder_create(
283     const OpusCustomMode *mode,
284     int channels,
285     int *error
286 ) OPUS_ARG_NONNULL(1);
287
288 /** Destroys a an decoder state.
289   * @param[in] st <tt>OpusCustomDecoder*</tt>: State to be freed.
290   */
291 OPUS_CUSTOM_EXPORT void opus_custom_decoder_destroy(OpusCustomDecoder *st);
292
293 /** Decode an opus custom frame with floating point output
294   * @param [in] st <tt>OpusCustomDecoder*</tt>: Decoder state
295   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
296   * @param [in] len <tt>int</tt>: Number of bytes in payload
297   * @param [out] pcm <tt>float*</tt>: Output signal (interleaved if 2 channels). length
298   *  is frame_size*channels*sizeof(float)
299   * @param [in] frame_size Number of samples per channel of available space in *pcm.
300   * @returns Number of decoded samples or @ref opus_errorcodes
301   */
302 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode_float(
303     OpusCustomDecoder *st,
304     const unsigned char *data,
305     int len,
306     float *pcm,
307     int frame_size
308 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
309
310 /** Decode an opus custom frame
311   * @param [in] st <tt>OpusCustomDecoder*</tt>: Decoder state
312   * @param [in] data <tt>char*</tt>: Input payload. Use a NULL pointer to indicate packet loss
313   * @param [in] len <tt>int</tt>: Number of bytes in payload
314   * @param [out] pcm <tt>opus_int16*</tt>: Output signal (interleaved if 2 channels). length
315   *  is frame_size*channels*sizeof(opus_int16)
316   * @param [in] frame_size Number of samples per channel of available space in *pcm.
317   * @returns Number of decoded samples or @ref opus_errorcodes
318   */
319 OPUS_CUSTOM_EXPORT OPUS_WARN_UNUSED_RESULT int opus_custom_decode(
320     OpusCustomDecoder *st,
321     const unsigned char *data,
322     int len,
323     opus_int16 *pcm,
324     int frame_size
325 ) OPUS_ARG_NONNULL(1) OPUS_ARG_NONNULL(4);
326
327 /** Perform a CTL function on an Opus custom decoder.
328   *
329   * Generally the request and subsequent arguments are generated
330   * by a convenience macro.
331   * @see opus_genericctls
332   */
333 OPUS_CUSTOM_EXPORT int opus_custom_decoder_ctl(OpusCustomDecoder * OPUS_RESTRICT st, int request, ...) OPUS_ARG_NONNULL(1);
334
335 /**@}*/
336
337 #ifdef __cplusplus
338 }
339 #endif
340
341 #endif /* OPUS_CUSTOM_H */