Increase alignment of the internal state structures to sizeof(void *) from 4 bytes.
[opus.git] / src / opus_private.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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
16    names of specific contributors, may be used to endorse or promote
17    products derived from this software without specific prior written
18    permission.
19
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33
34 #ifndef OPUS_PRIVATE_H
35 #define OPUS_PRIVATE_H
36
37 #include "arch.h"
38 #include "opus.h"
39
40 struct OpusRepacketizer {
41    unsigned char toc;
42    int nb_frames;
43    const unsigned char *frames[48];
44    short len[48];
45    int framesize;
46 };
47
48
49 #define MODE_SILK_ONLY          1000
50 #define MODE_HYBRID             1001
51 #define MODE_CELT_ONLY          1002
52
53 #define OPUS_SET_VOICE_RATIO_REQUEST         11018
54 #define OPUS_GET_VOICE_RATIO_REQUEST         11019
55
56 /** Configures the encoder's expected percentage of voice
57   * opposed to music or other signals.
58   *
59   * @note This interface is currently more aspiration than actuality. It's
60   * ultimately expected to bias an automatic signal classifier, but it currently
61   * just shifts the static bitrate to mode mapping around a little bit.
62   *
63   * @param[in] x <tt>int</tt>:   Voice percentage in the range 0-100, inclusive.
64   * @hideinitializer */
65 #define OPUS_SET_VOICE_RATIO(x) OPUS_SET_VOICE_RATIO_REQUEST, __opus_check_int(x)
66 /** Gets the encoder's configured voice ratio value, @see OPUS_SET_VOICE_RATIO
67   *
68   * @param[out] x <tt>int*</tt>:  Voice percentage in the range 0-100, inclusive.
69   * @hideinitializer */
70 #define OPUS_GET_VOICE_RATIO(x) OPUS_GET_VOICE_RATIO_REQUEST, __opus_check_int_ptr(x)
71
72
73 #define OPUS_SET_FORCE_MODE_REQUEST    11002
74 #define OPUS_SET_FORCE_MODE(x) OPUS_SET_FORCE_MODE_REQUEST, __opus_check_int(x)
75
76
77 int encode_size(int size, unsigned char *data);
78
79 int opus_decode_native(OpusDecoder *st, const unsigned char *data, int len,
80       opus_val16 *pcm, int frame_size, int decode_fec, int self_delimited, int *packet_offset);
81
82 /* Make sure everything's aligned to sizeof(void *) bytes */
83 static inline int align(int i)
84 {
85     return (i+sizeof(void *)-1)&-sizeof(void *);
86 }
87
88 int opus_repacketizer_out_range_impl(OpusRepacketizer *rp, int begin, int end, unsigned char *data, int maxlen, int self_delimited);
89
90 #endif /* OPUS_PRIVATE_H */