Remove ambisonics experimental flag
[opus.git] / src / opus_private.h
1 /* Copyright (c) 2012 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 COPYRIGHT OWNER
19    OR 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 #ifndef OPUS_PRIVATE_H
30 #define OPUS_PRIVATE_H
31
32 #include "arch.h"
33 #include "opus.h"
34 #include "celt.h"
35
36 #include <stdarg.h> /* va_list */
37 #include <stddef.h> /* offsetof */
38
39 struct OpusRepacketizer {
40    unsigned char toc;
41    int nb_frames;
42    const unsigned char *frames[48];
43    opus_int16 len[48];
44    int framesize;
45 };
46
47 typedef struct ChannelLayout {
48    int nb_channels;
49    int nb_streams;
50    int nb_coupled_streams;
51    unsigned char mapping[256];
52 } ChannelLayout;
53
54 typedef enum {
55   MAPPING_TYPE_NONE,
56   MAPPING_TYPE_SURROUND,
57   MAPPING_TYPE_AMBISONICS
58 } MappingType;
59
60 struct OpusMSEncoder {
61    ChannelLayout layout;
62    int arch;
63    int lfe_stream;
64    int application;
65    int variable_duration;
66    MappingType mapping_type;
67    opus_int32 bitrate_bps;
68    /* Encoder states go here */
69    /* then opus_val32 window_mem[channels*120]; */
70    /* then opus_val32 preemph_mem[channels]; */
71 };
72
73 struct OpusMSDecoder {
74    ChannelLayout layout;
75    /* Decoder states go here */
76 };
77
78 int opus_multistream_encoder_ctl_va_list(struct OpusMSEncoder *st, int request,
79   va_list ap);
80 int opus_multistream_decoder_ctl_va_list(struct OpusMSDecoder *st, int request,
81   va_list ap);
82
83 int validate_layout(const ChannelLayout *layout);
84 int get_left_channel(const ChannelLayout *layout, int stream_id, int prev);
85 int get_right_channel(const ChannelLayout *layout, int stream_id, int prev);
86 int get_mono_channel(const ChannelLayout *layout, int stream_id, int prev);
87
88 typedef void (*opus_copy_channel_in_func)(
89   opus_val16 *dst,
90   int dst_stride,
91   const void *src,
92   int src_stride,
93   int src_channel,
94   int frame_size,
95   void *user_data
96 );
97
98 typedef void (*opus_copy_channel_out_func)(
99   void *dst,
100   int dst_stride,
101   int dst_channel,
102   const opus_val16 *src,
103   int src_stride,
104   int frame_size,
105   void *user_data
106 );
107
108 #define MODE_SILK_ONLY          1000
109 #define MODE_HYBRID             1001
110 #define MODE_CELT_ONLY          1002
111
112 #define OPUS_SET_VOICE_RATIO_REQUEST         11018
113 #define OPUS_GET_VOICE_RATIO_REQUEST         11019
114
115 /** Configures the encoder's expected percentage of voice
116   * opposed to music or other signals.
117   *
118   * @note This interface is currently more aspiration than actuality. It's
119   * ultimately expected to bias an automatic signal classifier, but it currently
120   * just shifts the static bitrate to mode mapping around a little bit.
121   *
122   * @param[in] x <tt>int</tt>:   Voice percentage in the range 0-100, inclusive.
123   * @hideinitializer */
124 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
125 /** Gets the encoder's configured voice ratio value, @see OPUS_SET_VOICE_RATIO
126   *
127   * @param[out] x <tt>int*</tt>:  Voice percentage in the range 0-100, inclusive.
128   * @hideinitializer */
129 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
130
131
132 #define OPUS_SET_FORCE_MODE_REQUEST    11002
133 #define OPUS_SET_FORCE_MODE(x) OPUS_SET_FORCE_MODE_REQUEST, __opus_check_int(x)
134
135 typedef void (*downmix_func)(const void *, opus_val32 *, int, int, int, int, int);
136 void downmix_float(const void *_x, opus_val32 *sub, int subframe, int offset, int c1, int c2, int C);
137 void downmix_int(const void *_x, opus_val32 *sub, int subframe, int offset, int c1, int c2, int C);
138
139 int encode_size(int size, unsigned char *data);
140
141 opus_int32 frame_size_select(opus_int32 frame_size, int variable_duration, opus_int32 Fs);
142
143 opus_int32 opus_encode_native(OpusEncoder *st, const opus_val16 *pcm, int frame_size,
144       unsigned char *data, opus_int32 out_data_bytes, int lsb_depth,
145       const void *analysis_pcm, opus_int32 analysis_size, int c1, int c2,
146       int analysis_channels, downmix_func downmix, int float_api);
147
148 int opus_decode_native(OpusDecoder *st, const unsigned char *data, opus_int32 len,
149       opus_val16 *pcm, int frame_size, int decode_fec, int self_delimited,
150       opus_int32 *packet_offset, int soft_clip);
151
152 /* Make sure everything is properly aligned. */
153 static OPUS_INLINE int align(int i)
154 {
155     struct foo {char c; union { void* p; opus_int32 i; opus_val32 v; } u;};
156
157     unsigned int alignment = offsetof(struct foo, u);
158
159     /* Optimizing compilers should optimize div and multiply into and
160        for all sensible alignment values. */
161     return ((i + alignment - 1) / alignment) * alignment;
162 }
163
164 int opus_packet_parse_impl(const unsigned char *data, opus_int32 len,
165       int self_delimited, unsigned char *out_toc,
166       const unsigned char *frames[48], opus_int16 size[48],
167       int *payload_offset, opus_int32 *packet_offset);
168
169 opus_int32 opus_repacketizer_out_range_impl(OpusRepacketizer *rp, int begin, int end,
170       unsigned char *data, opus_int32 maxlen, int self_delimited, int pad);
171
172 int pad_frame(unsigned char *data, opus_int32 len, opus_int32 new_len);
173
174 int opus_multistream_encode_native
175 (
176   struct OpusMSEncoder *st,
177   opus_copy_channel_in_func copy_channel_in,
178   const void *pcm,
179   int analysis_frame_size,
180   unsigned char *data,
181   opus_int32 max_data_bytes,
182   int lsb_depth,
183   downmix_func downmix,
184   int float_api,
185   void *user_data
186 );
187
188 int opus_multistream_decode_native(
189   struct OpusMSDecoder *st,
190   const unsigned char *data,
191   opus_int32 len,
192   void *pcm,
193   opus_copy_channel_out_func copy_channel_out,
194   int frame_size,
195   int decode_fec,
196   int soft_clip,
197   void *user_data
198 );
199
200 #endif /* OPUS_PRIVATE_H */