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