33cd038506249f6b874a4d459e69d4a417011225
[opus.git] / libcelt / modes.h
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Copyright (c) 2008 Gregory Maxwell
4    Written by Jean-Marc Valin and Gregory Maxwell */
5 /*
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9
10    - Redistributions of source code must retain the above copyright
11    notice, this list of conditions and the following disclaimer.
12
13    - Redistributions in binary form must reproduce the above copyright
14    notice, this list of conditions and the following disclaimer in the
15    documentation and/or other materials provided with the distribution.
16
17    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
21    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef MODES_H
31 #define MODES_H
32
33 #include "opus_types.h"
34 #include "celt.h"
35 #include "arch.h"
36 #include "mdct.h"
37 #include "entenc.h"
38 #include "entdec.h"
39
40 #define MAX_PERIOD 1024
41
42 #ifndef CHANNELS
43 # ifdef DISABLE_STEREO
44 #  define CHANNELS(_C) (1)
45 # else
46 #  define CHANNELS(_C) (_C)
47 # endif
48 #endif
49
50 #ifndef OVERLAP
51 #define OVERLAP(mode) ((mode)->overlap)
52 #endif
53
54 #ifndef FRAMESIZE
55 #define FRAMESIZE(mode) ((mode)->mdctSize)
56 #endif
57
58 typedef struct {
59    int size;
60    const opus_int16 *index;
61    const unsigned char *bits;
62    const unsigned char *caps;
63 } PulseCache;
64
65 /** Mode definition (opaque)
66  @brief Mode definition
67  */
68 struct CELTMode {
69    opus_int32 Fs;
70    int          overlap;
71
72    int          nbEBands;
73    int          effEBands;
74    opus_val16    preemph[4];
75    const opus_int16   *eBands;   /**< Definition for each "pseudo-critical band" */
76
77    int         maxLM;
78    int         nbShortMdcts;
79    int         shortMdctSize;
80
81    int          nbAllocVectors; /**< Number of lines in the matrix below */
82    const unsigned char   *allocVectors;   /**< Number of bits in each band for several rates */
83    const opus_int16 *logN;
84
85    const opus_val16 *window;
86    mdct_lookup mdct;
87    PulseCache cache;
88 };
89
90 #ifndef OPUS_BUILD
91 #define CELT_STATIC static
92 #else
93 #define CELT_STATIC
94 #endif
95
96 #ifdef OPUS_BUILD
97 #define CELT_SET_SIGNALLING_REQUEST    10003
98 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, _celt_check_int(x)
99
100 #define CELT_GET_MODE_REQUEST    10004
101 /** Get the CELTMode used by an encoder or decoder */
102 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
103
104 /* Prototypes for _ec versions of the encoder/decoder calls (not public) */
105 int celt_encode_with_ec(CELTEncoder * restrict st, const opus_int16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
106 int celt_encode_with_ec_float(CELTEncoder * restrict st, const float * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
107 int celt_decode_with_ec(CELTDecoder * restrict st, const unsigned char *data, int len, opus_int16 * restrict pcm, int frame_size, ec_dec *dec);
108 int celt_decode_with_ec_float(CELTDecoder * restrict st, const unsigned char *data, int len, float * restrict pcm, int frame_size, ec_dec *dec);
109 #endif /* OPUS_BUILD */
110
111 #endif