Energy quantization tuning.
[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 "pitch.h"
42 #include "entenc.h"
43 #include "entdec.h"
44
45 #define MAX_CONFIG_SIZES 5
46
47 #define CELT_BITSTREAM_VERSION 0x8000000d
48
49 #ifdef STATIC_MODES
50 #include "static_modes.h"
51 #endif
52
53 #define MAX_PERIOD 1024
54
55 #ifndef CHANNELS
56 # ifdef DISABLE_STEREO
57 #  define CHANNELS(_C) (1)
58 # else
59 #  define CHANNELS(_C) (_C)
60 # endif
61 #endif
62
63 #ifndef OVERLAP
64 #define OVERLAP(mode) ((mode)->overlap)
65 #endif
66
67 #ifndef FRAMESIZE
68 #define FRAMESIZE(mode) ((mode)->mdctSize)
69 #endif
70
71 /** Mode definition (opaque)
72  @brief Mode definition 
73  */
74 struct CELTMode {
75    celt_uint32 marker_start;
76    celt_int32 Fs;
77    int          overlap;
78
79    int          nbEBands;
80    int          effEBands;
81    int          pitchEnd;
82    celt_word16    preemph[4];
83    const celt_int16   *eBands;   /**< Definition for each "pseudo-critical band" */
84    
85    int          nbAllocVectors; /**< Number of lines in the matrix below */
86    const unsigned char   *allocVectors;   /**< Number of bits in each band for several rates */
87    
88    const celt_int16 * const **bits;
89    const celt_int16 * const *(_bits[MAX_CONFIG_SIZES]); /**< Cache for pulses->bits mapping in each band */
90
91    /* Stuff that could go in the {en,de}coder, but we save space this way */
92    mdct_lookup mdct;
93
94    const celt_word16 *window;
95
96    int         maxLM;
97    int         nbShortMdcts;
98    int         shortMdctSize;
99
100    int *prob;
101    const celt_int16 *logN;
102    celt_uint32 marker_end;
103 };
104
105 int check_mode(const CELTMode *mode);
106
107 /* Prototypes for _ec versions of the encoder/decoder calls (not public) */
108 int celt_encode_with_ec(CELTEncoder * restrict st, const celt_int16 * pcm, celt_int16 * optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
109 int celt_encode_with_ec_float(CELTEncoder * restrict st, const float * pcm, float * optional_resynthesis, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
110 int celt_decode_with_ec(CELTDecoder * restrict st, const unsigned char *data, int len, celt_int16 * restrict pcm, int frame_size, ec_dec *dec);
111 int celt_decode_with_ec_float(CELTDecoder * restrict st, const unsigned char *data, int len, float * restrict pcm, int frame_size, ec_dec *dec);
112 #endif