Implements CELT_SET_LOSS_PERC
[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 "celt_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 CELT_BITSTREAM_VERSION 0x80000010
41
42 #define MAX_PERIOD 1024
43
44 #ifndef CHANNELS
45 # ifdef DISABLE_STEREO
46 #  define CHANNELS(_C) (1)
47 # else
48 #  define CHANNELS(_C) (_C)
49 # endif
50 #endif
51
52 #ifndef OVERLAP
53 #define OVERLAP(mode) ((mode)->overlap)
54 #endif
55
56 #ifndef FRAMESIZE
57 #define FRAMESIZE(mode) ((mode)->mdctSize)
58 #endif
59
60 typedef struct {
61    int size;
62    const celt_int16 *index;
63    const unsigned char *bits;
64    const unsigned char *caps;
65 } PulseCache;
66
67 /** Mode definition (opaque)
68  @brief Mode definition 
69  */
70 struct CELTMode {
71    celt_int32 Fs;
72    int          overlap;
73
74    int          nbEBands;
75    int          effEBands;
76    celt_word16    preemph[4];
77    const celt_int16   *eBands;   /**< Definition for each "pseudo-critical band" */
78    
79    int          nbAllocVectors; /**< Number of lines in the matrix below */
80    const unsigned char   *allocVectors;   /**< Number of bits in each band for several rates */
81    
82    /* Stuff that could go in the {en,de}coder, but we save space this way */
83    mdct_lookup mdct;
84
85    const celt_word16 *window;
86
87    int         maxLM;
88    int         nbShortMdcts;
89    int         shortMdctSize;
90
91    const celt_int16 *logN;
92
93    PulseCache cache;
94 };
95
96 #ifndef OPUS_BUILD
97 #define CELT_STATIC static
98 #else
99 #define CELT_STATIC
100 #endif
101
102 #ifdef OPUS_BUILD
103 #define CELT_SET_SIGNALLING_REQUEST    10003
104 #define CELT_SET_SIGNALLING(x) CELT_SET_SIGNALLING_REQUEST, _celt_check_int(x)
105
106 #define CELT_GET_MODE_REQUEST    10004
107 /** Get the CELTMode used by an encoder or decoder */
108 #define CELT_GET_MODE(x) CELT_GET_MODE_REQUEST, _celt_check_mode_ptr_ptr(x)
109
110 /* Prototypes for _ec versions of the encoder/decoder calls (not public) */
111 int celt_encode_with_ec(CELTEncoder * restrict st, const celt_int16 * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
112 int celt_encode_with_ec_float(CELTEncoder * restrict st, const float * pcm, int frame_size, unsigned char *compressed, int nbCompressedBytes, ec_enc *enc);
113 int celt_decode_with_ec(CELTDecoder * restrict st, const unsigned char *data, int len, celt_int16 * restrict pcm, int frame_size, ec_dec *dec);
114 int celt_decode_with_ec_float(CELTDecoder * restrict st, const unsigned char *data, int len, float * restrict pcm, int frame_size, ec_dec *dec);
115 #endif /* OPUS_BUILD */
116
117 #endif