Support for Channel Mapping 253
[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
92
93 #define MODE_SILK_ONLY          1000
94 #define MODE_HYBRID             1001
95 #define MODE_CELT_ONLY          1002
96
97 #define OPUS_SET_VOICE_RATIO_REQUEST         11018
98 #define OPUS_GET_VOICE_RATIO_REQUEST         11019
99
100 /** Configures the encoder's expected percentage of voice
101   * opposed to music or other signals.
102   *
103   * @note This interface is currently more aspiration than actuality. It's
104   * ultimately expected to bias an automatic signal classifier, but it currently
105   * just shifts the static bitrate to mode mapping around a little bit.
106   *
107   * @param[in] x <tt>int</tt>:   Voice percentage in the range 0-100, inclusive.
108   * @hideinitializer */
109 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
110 /** Gets the encoder's configured voice ratio value, @see OPUS_SET_VOICE_RATIO
111   *
112   * @param[out] x <tt>int*</tt>:  Voice percentage in the range 0-100, inclusive.
113   * @hideinitializer */
114 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
115
116
117 #define OPUS_SET_FORCE_MODE_REQUEST    11002
118 #define OPUS_SET_FORCE_MODE(x) OPUS_SET_FORCE_MODE_REQUEST, __opus_check_int(x)
119
120 typedef void (*downmix_func)(const void *, opus_val32 *, int, int, int, int, int);
121 void downmix_float(const void *_x, opus_val32 *sub, int subframe, int offset, int c1, int c2, int C);
122 void downmix_int(const void *_x, opus_val32 *sub, int subframe, int offset, int c1, int c2, int C);
123
124 int encode_size(int size, unsigned char *data);
125
126 opus_int32 frame_size_select(opus_int32 frame_size, int variable_duration, opus_int32 Fs);
127
128 opus_int32 opus_encode_native(OpusEncoder *st, const opus_val16 *pcm, int frame_size,
129       unsigned char *data, opus_int32 out_data_bytes, int lsb_depth,
130       const void *analysis_pcm, opus_int32 analysis_size, int c1, int c2,
131       int analysis_channels, downmix_func downmix, int float_api);
132
133 int opus_decode_native(OpusDecoder *st, const unsigned char *data, opus_int32 len,
134       opus_val16 *pcm, int frame_size, int decode_fec, int self_delimited,
135       opus_int32 *packet_offset, int soft_clip);
136
137 /* Make sure everything is properly aligned. */
138 static OPUS_INLINE int align(int i)
139 {
140     struct foo {char c; union { void* p; opus_int32 i; opus_val32 v; } u;};
141
142     unsigned int alignment = offsetof(struct foo, u);
143
144     /* Optimizing compilers should optimize div and multiply into and
145        for all sensible alignment values. */
146     return ((i + alignment - 1) / alignment) * alignment;
147 }
148
149 int opus_packet_parse_impl(const unsigned char *data, opus_int32 len,
150       int self_delimited, unsigned char *out_toc,
151       const unsigned char *frames[48], opus_int16 size[48],
152       int *payload_offset, opus_int32 *packet_offset);
153
154 opus_int32 opus_repacketizer_out_range_impl(OpusRepacketizer *rp, int begin, int end,
155       unsigned char *data, opus_int32 maxlen, int self_delimited, int pad);
156
157 int pad_frame(unsigned char *data, opus_int32 len, opus_int32 new_len);
158
159 #endif /* OPUS_PRIVATE_H */