faa4bfa3298b45e42c8aad3d7da924943e69aa3e
[opus.git] / libcelt / modes.h
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
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 the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef MODES_H
33 #define MODES_H
34
35 #include "celt_types.h"
36 #include "celt.h"
37 #include "arch.h"
38 #include "mdct.h"
39 #include "psy.h"
40
41 #ifdef STATIC_MODES
42 #include "static_modes.h"
43 #endif
44
45 #define MAX_PERIOD 1024
46
47 #ifndef CHANNELS
48 # ifdef DISABLE_STEREO
49 #  define CHANNELS(mode) (1)
50 # else
51 #  define CHANNELS(mode) ((mode)->nbChannels)
52 # endif
53 #endif
54
55 #define MDCT(mode) (&(mode)->mdct)
56
57 #ifndef OVERLAP
58 #define OVERLAP(mode) ((mode)->overlap)
59 #endif
60
61 #ifndef FRAMESIZE
62 #define FRAMESIZE(mode) ((mode)->mdctSize)
63 #endif
64
65 /** Mode definition (opaque)
66  @brief Mode definition 
67  */
68 struct CELTMode {
69    celt_uint32_t marker_start;
70    celt_int32_t Fs;
71    int          overlap;
72    int          mdctSize;
73    int          nbChannels;
74    
75    int          nbEBands;
76    int          nbPBands;
77    int          pitchEnd;
78    
79    const celt_int16_t   *eBands;   /**< Definition for each "pseudo-critical band" */
80    const celt_int16_t   *pBands;   /**< Definition of the bands used for the pitch */
81    
82    celt_word16_t ePredCoef;/**< Prediction coefficient for the energy encoding */
83    
84    int          nbAllocVectors; /**< Number of lines in the matrix below */
85    const celt_int16_t   *allocVectors;   /**< Number of bits in each band for several rates */
86    
87    const celt_int16_t * const *bits; /**< Cache for pulses->bits mapping in each band */
88
89    /* Stuff that could go in the {en,de}coder, but we save space this way */
90    mdct_lookup mdct;
91    
92    const celt_word16_t *window;
93
94    struct PsyDecay psy;
95
96    celt_uint32_t marker_end;
97 };
98
99 int check_mode(const CELTMode *mode);
100
101 #endif