SILK stereo fix
[opus.git] / src / opus_multistream.h
1 /* Copyright (c) 2011 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 /**
29  * @file opus_multistream.h
30  * @brief Opus reference implementation multistream API
31  */
32
33 #ifndef OPUS_MULTISTREAM_H
34 #define OPUS_MULTISTREAM_H
35
36 #include "opus.h"
37
38 typedef struct OpusMSEncoder OpusMSEncoder;
39 typedef struct OpusMSDecoder OpusMSDecoder;
40
41 #define __opus_check_encstate_ptr(ptr) ((ptr) + ((ptr) - (OpusEncoder**)(ptr)))
42 #define __opus_check_decstate_ptr(ptr) ((ptr) + ((ptr) - (OpusDecoder**)(ptr)))
43
44 #define OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST 5120
45 #define OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST 5122
46
47 #define OPUS_MULTISTREAM_GET_ENCODER_STATE(x,y) OPUS_MULTISTREAM_GET_ENCODER_STATE_REQUEST, __opus_check_int(x), __opus_check_encstate_ptr(y)
48 #define OPUS_MULTISTREAM_GET_DECODER_STATE(x,y) OPUS_MULTISTREAM_GET_DECODER_STATE_REQUEST, __opus_check_int(x), __opus_check_decstate_ptr(y)
49
50 /** Allocate and initialize a multistream encoder state object.
51  *  Call opus_multistream_encoder_destroy() to release
52  *  this object when finished. */
53 OPUS_EXPORT OpusMSEncoder *opus_multistream_encoder_create(
54       opus_int32 Fs,            /**< Sampling rate of input signal (Hz) */
55       int channels,             /**< Number of channels in the input signal */
56       int streams,              /**< Total number of streams to encode from the input */
57       int coupled_streams,      /**< Number of coupled (stereo) streams to encode */
58       unsigned char *mapping,   /**< Encoded mapping between channels and streams */
59       int application,          /**< Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
60       int *error                /**< Error code */
61 );
62
63 /** Initialize an already allocated multistream encoder state. */
64 OPUS_EXPORT int opus_multistream_encoder_init(
65       OpusMSEncoder *st,        /**< Encoder state */
66       opus_int32 Fs,            /**< Sampling rate of input signal (Hz) */
67       int channels,             /**< Number of channels in the input signal */
68       int streams,              /**< Total number of streams to encode from the input */
69       int coupled_streams,      /**< Number of coupled (stereo) streams to encode */
70       unsigned char *mapping,   /**< Encoded mapping between channels and streams */
71       int application           /**< Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
72 );
73
74 /** Returns length of the data payload (in bytes) or a negative error code */
75 OPUS_EXPORT int opus_multistream_encode(
76     OpusMSEncoder *st,          /**< Encoder state */
77     const opus_int16 *pcm,      /**< Input signal as interleaved samples. Length is frame_size*channels */
78     int frame_size,             /**< Number of samples per frame of input signal */
79     unsigned char *data,        /**< Output buffer for the compressed payload (no more than max_data_bytes long) */
80     int max_data_bytes          /**< Allocated memory for payload; don't use for controlling bitrate */
81 );
82
83 /** Returns length of the data payload (in bytes) or a negative error code. */
84 OPUS_EXPORT int opus_multistream_encode_float(
85       OpusMSEncoder *st,        /**< Encoder state */
86       const float *pcm,         /**< Input signal interleaved in channel order. length is frame_size*channels */
87       int frame_size,           /**< Number of samples per frame of input signal */
88       unsigned char *data,      /**< Output buffer for the compressed payload (no more than max_data_bytes long) */
89       int max_data_bytes        /**< Allocated memory for payload; don't use for controlling bitrate */
90   );
91
92 /** Deallocate a multstream encoder state */
93 OPUS_EXPORT void opus_multistream_encoder_destroy(OpusMSEncoder *st);
94
95 /** Get or set options on a multistream encoder state */
96 OPUS_EXPORT int opus_multistream_encoder_ctl(OpusMSEncoder *st, int request, ...);
97
98 /** Allocate and initialize a multistream decoder state object.
99  *  Call opus_multistream_decoder_destroy() to release
100  *  this object when finished. */
101 OPUS_EXPORT OpusMSDecoder *opus_multistream_decoder_create(
102       opus_int32 Fs,            /**< Sampling rate to decode at (Hz) */
103       int channels,             /**< Number of channels to decode */
104       int streams,              /**< Total number of coded streams in the multistream */
105       int coupled_streams,      /**< Number of coupled (stereo) streams in the multistream */
106       unsigned char *mapping,   /**< Stream to channel mapping table */
107       int *error                /**< Error code */
108 );
109
110 /** Intialize a previously allocated decoder state object. */
111 OPUS_EXPORT int opus_multistream_decoder_init(
112       OpusMSDecoder *st,        /**< Encoder state */
113       opus_int32 Fs,            /**< Sample rate of input signal (Hz) */
114       int channels,             /**< Number of channels in the input signal */
115       int streams,              /**< Total number of coded streams */
116       int coupled_streams,      /**< Number of coupled (stereo) streams */
117       unsigned char *mapping    /**< Stream to channel mapping table */
118 );
119
120 /** Returns the number of samples decoded or a negative error code */
121 OPUS_EXPORT int opus_multistream_decode(
122     OpusMSDecoder *st,          /**< Decoder state */
123     const unsigned char *data,  /**< Input payload. Use a NULL pointer to indicate packet loss */
124     int len,                    /**< Number of bytes in payload */
125     opus_int16 *pcm,            /**< Output signal, samples interleaved in channel order . length is frame_size*channels */
126     int frame_size,             /**< Number of samples per frame of input signal */
127     int decode_fec              /**< Flag (0/1) to request that any in-band forward error correction data be */
128                                 /**< decoded. If no such data is available the frame is decoded as if it were lost. */
129 );
130
131 /** Returns the number of samples decoded or a negative error code */
132 OPUS_EXPORT int opus_multistream_decode_float(
133     OpusMSDecoder *st,          /**< Decoder state */
134     const unsigned char *data,  /**< Input payload buffer. Use a NULL pointer to indicate packet loss */
135     int len,                    /**< Number of payload bytes in data */
136     float *pcm,                 /**< Buffer for the output signal (interleaved iin channel order). length is frame_size*channels */
137     int frame_size,             /**< Number of samples per frame of input signal */
138     int decode_fec              /**< Flag (0/1) to request that any in-band forward error correction data be */
139                                 /**< decoded. If no such data is available the frame is decoded as if it were lost. */
140 );
141
142
143 /** Get or set options on a multistream decoder state */
144 OPUS_EXPORT int opus_multistream_decoder_ctl(OpusMSDecoder *st, int request, ...);
145
146 /** Deallocate a multistream decoder state object */
147 OPUS_EXPORT void opus_multistream_decoder_destroy(OpusMSDecoder *st);
148
149 #endif /* OPUS_MULTISTREAM_H */