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