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 #include "pitch.h"
  41
  42 #define CELT_BITSTREAM_VERSION 0x80000007
  43
  44 #ifdef STATIC_MODES
  45 #include "static_modes.h"
  46 #endif
  47
  48 #define MAX_PERIOD 1024
  49
  50 #ifndef CHANNELS
  51 # ifdef DISABLE_STEREO
  52 #  define CHANNELS(mode) (1)
  53 # else
  54 #  define CHANNELS(mode) ((mode)->nbChannels)
  55 # endif
  56 #endif
  57
  58 #define MDCT(mode) (&(mode)->mdct)
  59
  60 #ifndef OVERLAP
  61 #define OVERLAP(mode) ((mode)->overlap)
  62 #endif
  63
  64 #ifndef FRAMESIZE
  65 #define FRAMESIZE(mode) ((mode)->mdctSize)
  66 #endif
  67
  68 /** Mode definition (opaque)
  69  @brief Mode definition
  70  */
  71 struct CELTMode {
  72    celt_uint32_t marker_start;
  73    celt_int32_t Fs;
  74    int          overlap;
  75    int          mdctSize;
  76    int          nbChannels;
  77
  78    int          nbEBands;
  79    int          nbPBands;
  80    int          pitchEnd;
  81
  82    const celt_int16_t   *eBands;   /**< Definition for each "pseudo-critical band" */
  83    const celt_int16_t   *pBands;   /**< Definition of the bands used for the pitch */
  84
  85    celt_word16_t ePredCoef;/**< Prediction coefficient for the energy encoding */
  86
  87    int          nbAllocVectors; /**< Number of lines in the matrix below */
  88    const celt_int16_t   *allocVectors;   /**< Number of bits in each band for several rates */
  89
  90    const celt_int16_t * const *bits; /**< Cache for pulses->bits mapping in each band */
  91
  92    /* Stuff that could go in the {en,de}coder, but we save space this way */
  93    mdct_lookup mdct;
  94    kiss_fftr_cfg fft;
  95
  96    const celt_word16_t *window;
  97
  98    int         nbShortMdcts;
  99    int         shortMdctSize;
 100    mdct_lookup shortMdct;
 101    const celt_word16_t *shortWindow;
 102
 103    struct PsyDecay psy;
 104
 105    int *prob;
 106    celt_uint32_t marker_end;
 107 };
 108
 109 int check_mode(const CELTMode *mode);
 110
 111 #endif