Adds 3rd clause to CELT license
[opus.git] / celt / 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 Internet Society, IETF or IETF Trust, nor the
18    names of specific contributors, may be used to endorse or promote
19    products derived from this software without specific prior written
20    permission.
21
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef MODES_H
36 #define MODES_H
37
38 #include "opus_types.h"
39 #include "celt.h"
40 #include "arch.h"
41 #include "mdct.h"
42 #include "entenc.h"
43 #include "entdec.h"
44
45 #define MAX_PERIOD 1024
46
47 #ifndef OVERLAP
48 #define OVERLAP(mode) ((mode)->overlap)
49 #endif
50
51 #ifndef FRAMESIZE
52 #define FRAMESIZE(mode) ((mode)->mdctSize)
53 #endif
54
55 typedef struct {
56    int size;
57    const opus_int16 *index;
58    const unsigned char *bits;
59    const unsigned char *caps;
60 } PulseCache;
61
62 /** Mode definition (opaque)
63  @brief Mode definition
64  */
65 struct OpusCustomMode {
66    opus_int32 Fs;
67    int          overlap;
68
69    int          nbEBands;
70    int          effEBands;
71    opus_val16    preemph[4];
72    const opus_int16   *eBands;   /**< Definition for each "pseudo-critical band" */
73
74    int         maxLM;
75    int         nbShortMdcts;
76    int         shortMdctSize;
77
78    int          nbAllocVectors; /**< Number of lines in the matrix below */
79    const unsigned char   *allocVectors;   /**< Number of bits in each band for several rates */
80    const opus_int16 *logN;
81
82    const opus_val16 *window;
83    mdct_lookup mdct;
84    PulseCache cache;
85 };
86
87
88 #endif