lib/backends.h

   1 /********************************************************************
   2  *                                                                  *
   3  * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
   4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
   5  * THE GNU LESSER/LIBRARY PUBLIC LICENSE, WHICH IS INCLUDED WITH    *
   6  * THIS SOURCE. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.        *
   7  *                                                                  *
   8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2000             *
   9  * by Monty <monty@xiph.org> and the XIPHOPHORUS Company            *
  10  * http://www.xiph.org/                                             *
  11  *                                                                  *
  12  ********************************************************************
  13
  14  function: libvorbis backend and mapping structures; needed for
  15            static mode headers
  16  last mod: $Id: backends.h,v 1.2 2000/11/06 00:07:00 xiphmont Exp $
  17
  18  ********************************************************************/
  19
  20 /* this is exposed up here because we need it for static modes.
  21    Lookups for each backend aren't exposed because there's no reason
  22    to do so */
  23
  24 #ifndef _vorbis_backend_h_
  25 #define _vorbis_backend_h_
  26
  27 #include "codec_internal.h"
  28
  29 /* this would all be simpler/shorter with templates, but.... */
  30 /* Transform backend generic *************************************/
  31
  32 /* only mdct right now.  Flesh it out more if we ever transcend mdct
  33    in the transform domain */
  34
  35 /* Time backend generic ******************************************/
  36 typedef struct{
  37   void              (*pack)  (vorbis_info_time *,oggpack_buffer *);
  38   vorbis_info_time *(*unpack)(vorbis_info *,oggpack_buffer *);
  39   vorbis_look_time *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  40                               vorbis_info_time *);
  41   vorbis_info_time *(*copy_info)(vorbis_info_time *);
  42
  43   void (*free_info) (vorbis_info_time *);
  44   void (*free_look) (vorbis_look_time *);
  45   int  (*forward)   (struct vorbis_block *,vorbis_look_time *,
  46                      float *,float *);
  47   int  (*inverse)   (struct vorbis_block *,vorbis_look_time *,
  48                      float *,float *);
  49 } vorbis_func_time;
  50
  51 typedef struct{
  52   int dummy;
  53 } vorbis_info_time0;
  54
  55 /* Floor backend generic *****************************************/
  56 typedef struct{
  57   void                   (*pack)  (vorbis_info_floor *,oggpack_buffer *);
  58   vorbis_info_floor     *(*unpack)(vorbis_info *,oggpack_buffer *);
  59   vorbis_look_floor     *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  60                                    vorbis_info_floor *);
  61   vorbis_info_floor     *(*copy_info)(vorbis_info_floor *);
  62   void (*free_info) (vorbis_info_floor *);
  63   void (*free_look) (vorbis_look_floor *);
  64   int  (*forward)   (struct vorbis_block *,vorbis_look_floor *,
  65                      float *,float *);
  66   int  (*inverse)   (struct vorbis_block *,vorbis_look_floor *,
  67                      float *);
  68 } vorbis_func_floor;
  69
  70 typedef struct{
  71   int   order;
  72   long  rate;
  73   long  barkmap;
  74
  75   int   ampbits;
  76   int   ampdB;
  77
  78   int   numbooks; /* <= 16 */
  79   int   books[16];
  80 } vorbis_info_floor0;
  81
  82 /* Residue backend generic *****************************************/
  83 typedef struct{
  84   void                 (*pack)  (vorbis_info_residue *,oggpack_buffer *);
  85   vorbis_info_residue *(*unpack)(vorbis_info *,oggpack_buffer *);
  86   vorbis_look_residue *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  87                                  vorbis_info_residue *);
  88   vorbis_info_residue *(*copy_info)(vorbis_info_residue *);
  89   void (*free_info)    (vorbis_info_residue *);
  90   void (*free_look)    (vorbis_look_residue *);
  91   int  (*forward)      (struct vorbis_block *,vorbis_look_residue *,
  92                         float **,int);
  93   int  (*inverse)      (struct vorbis_block *,vorbis_look_residue *,
  94                         float **,int);
  95 } vorbis_func_residue;
  96
  97 typedef struct vorbis_info_residue0{
  98 /* block-partitioned VQ coded straight residue */
  99   long  begin;
 100   long  end;
 101
 102   /* first stage (lossless partitioning) */
 103   int    grouping;         /* group n vectors per partition */
 104   int    partitions;       /* possible codebooks for a partition */
 105   int    groupbook;        /* huffbook for partitioning */
 106   int    secondstages[64]; /* expanded out to pointers in lookup */
 107   int    booklist[256];    /* list of second stage books */
 108
 109   /* encode-only heuristic settings */
 110   float  entmax[64];       /* book entropy threshholds*/
 111   float  ampmax[64];       /* book amp threshholds*/
 112   int    subgrp[64];       /* book heuristic subgroup size */
 113   int    blimit[64];       /* subgroup position limits */
 114
 115 } vorbis_info_residue0;
 116
 117 /* Mapping backend generic *****************************************/
 118 typedef struct{
 119   void                 (*pack)  (vorbis_info *,vorbis_info_mapping *,
 120                                  oggpack_buffer *);
 121   vorbis_info_mapping *(*unpack)(vorbis_info *,oggpack_buffer *);
 122   vorbis_look_mapping *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
 123                                  vorbis_info_mapping *);
 124   vorbis_info_mapping *(*copy_info)(vorbis_info_mapping *);
 125   void (*free_info)    (vorbis_info_mapping *);
 126   void (*free_look)    (vorbis_look_mapping *);
 127   int  (*forward)      (struct vorbis_block *vb,vorbis_look_mapping *);
 128   int  (*inverse)      (struct vorbis_block *vb,vorbis_look_mapping *);
 129 } vorbis_func_mapping;
 130
 131 typedef struct vorbis_info_mapping0{
 132   int   submaps;  /* <= 16 */
 133   int   chmuxlist[256];   /* up to 256 channels in a Vorbis stream */
 134
 135   int   timesubmap[16];    /* [mux] */
 136   int   floorsubmap[16];   /* [mux] submap to floors */
 137   int   residuesubmap[16]; /* [mux] submap to residue */
 138   int   psysubmap[16];     /* [mux]; encode only */
 139 } vorbis_info_mapping0;
 140
 141 #endif
 142
 143
 144
 145
 146