Adding the auto-generated static modes for float and fixed
[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    - Neither the name of the Xiph.org Foundation nor the names of its
18    contributors may be used to endorse or promote products derived from
19    this software without specific prior written permission.
20    
21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
25    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef MODES_H
35 #define MODES_H
36
37 #include "celt_types.h"
38 #include "celt.h"
39 #include "arch.h"
40 #include "mdct.h"
41 #include "entenc.h"
42 #include "entdec.h"
43
44 #define MAX_CONFIG_SIZES 5
45
46 #define CELT_BITSTREAM_VERSION 0x8000000f
47
48 #define MAX_PERIOD 1024
49
50 #ifndef CHANNELS
51 # ifdef DISABLE_STEREO
52 #  define CHANNELS(_C) (1)
53 # else
54 #  define CHANNELS(_C) (_C)
55 # endif
56 #endif
57
58 #ifndef OVERLAP
59 #define OVERLAP(mode) ((mode)->overlap)
60 #endif
61
62 #ifndef FRAMESIZE
63 #define FRAMESIZE(mode) ((mode)->mdctSize)
64 #endif
65
66 typedef struct {
67    int size;
68    const celt_int16 *index;
69    const unsigned char *bits;
70 } PulseCache;
71
72 /** Mode definition (opaque)
73  @brief Mode definition 
74  */
75 struct CELTMode {
76    celt_int32 Fs;
77    int          overlap;
78
79    int          nbEBands;
80    int          effEBands;
81    celt_word16    preemph[4];
82    const celt_int16   *eBands;   /**< Definition for each "pseudo-critical band" */
83    
84    int          nbAllocVectors; /**< Number of lines in the matrix below */
85    const unsigned char   *allocVectors;   /**< Number of bits in each band for several rates */
86    
87    /* Stuff that could go in the {en,de}coder, but we save space this way */
88    mdct_lookup mdct;
89
90    const celt_word16 *window;
91
92    int         maxLM;
93    int         nbShortMdcts;
94    int         shortMdctSize;
95
96    const celt_int16 *logN;
97
98    PulseCache cache;
99 };
100
101 /* Prototypes for _ec versions of the encoder/decoder calls (not public) */
102 int celt_encode_with_ec(CELTEncoder * restrict st, const celt_int16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
103 int celt_encode_with_ec_float(CELTEncoder * restrict st, const float * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
104 int celt_decode_with_ec(CELTDecoder * restrict st, const unsigned char *data, int len, celt_int16 * restrict pcm, int frame_size, ec_dec *dec);
105 int celt_decode_with_ec_float(CELTDecoder * restrict st, const unsigned char *data, int len, float * restrict pcm, int frame_size, ec_dec *dec);
106 #endif