include/vorbis/backends.h

   1 /********************************************************************
   2  *                                                                  *
   3  * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
   4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
   5  * THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE.    *
   6  * PLEASE READ THESE TERMS DISTRIBUTING.                            *
   7  *                                                                  *
   8  * THE OggSQUISH 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.12 2000/10/12 03:12:40 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_time_backend_h_
  25 #define _vorbis_time_backend_h_
  26
  27 /* this would all be simpler/shorter with templates, but.... */
  28 /* Transform backend generic *************************************/
  29
  30 /* only mdct right now.  Flesh it out more if we ever transcend mdct
  31    in the transform domain */
  32
  33 /* Time backend generic ******************************************/
  34 typedef struct{
  35   void              (*pack)  (vorbis_info_time *,oggpack_buffer *);
  36   vorbis_info_time *(*unpack)(vorbis_info *,oggpack_buffer *);
  37   vorbis_look_time *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  38                               vorbis_info_time *);
  39   void (*free_info) (vorbis_info_time *);
  40   void (*free_look) (vorbis_look_time *);
  41   int  (*forward)   (struct vorbis_block *,vorbis_look_time *,
  42                      float *,float *);
  43   int  (*inverse)   (struct vorbis_block *,vorbis_look_time *,
  44                      float *,float *);
  45 } vorbis_func_time;
  46
  47 typedef struct{
  48   int dummy;
  49 } vorbis_info_time0;
  50
  51 /* Floor backend generic *****************************************/
  52 typedef struct{
  53   void                   (*pack)  (vorbis_info_floor *,oggpack_buffer *);
  54   vorbis_info_floor     *(*unpack)(vorbis_info *,oggpack_buffer *);
  55   vorbis_look_floor     *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  56                                    vorbis_info_floor *);
  57   void (*free_info) (vorbis_info_floor *);
  58   void (*free_look) (vorbis_look_floor *);
  59   int  (*forward)   (struct vorbis_block *,vorbis_look_floor *,
  60                      float *,float *);
  61   int  (*inverse)   (struct vorbis_block *,vorbis_look_floor *,
  62                      float *);
  63 } vorbis_func_floor;
  64
  65 typedef struct{
  66   int   order;
  67   long  rate;
  68   long  barkmap;
  69
  70   int   ampbits;
  71   int   ampdB;
  72
  73   int   numbooks; /* <= 16 */
  74   int   books[16];
  75 } vorbis_info_floor0;
  76
  77 /* Residue backend generic *****************************************/
  78 typedef struct{
  79   void                 (*pack)  (vorbis_info_residue *,oggpack_buffer *);
  80   vorbis_info_residue *(*unpack)(vorbis_info *,oggpack_buffer *);
  81   vorbis_look_residue *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
  82                                  vorbis_info_residue *);
  83   void (*free_info)    (vorbis_info_residue *);
  84   void (*free_look)    (vorbis_look_residue *);
  85   int  (*forward)      (struct vorbis_block *,vorbis_look_residue *,
  86                         float **,int);
  87   int  (*inverse)      (struct vorbis_block *,vorbis_look_residue *,
  88                         float **,int);
  89 } vorbis_func_residue;
  90
  91 typedef struct vorbis_info_residue0{
  92 /* block-partitioned VQ coded straight residue */
  93   long  begin;
  94   long  end;
  95
  96   /* first stage (lossless partitioning) */
  97   int    grouping;         /* group n vectors per partition */
  98   int    partitions;       /* possible codebooks for a partition */
  99   int    groupbook;        /* huffbook for partitioning */
 100   int    secondstages[64]; /* expanded out to pointers in lookup */
 101   int    booklist[256];    /* list of second stage books */
 102
 103   /* encode-only heuristic settings */
 104   float  entmax[64];       /* book entropy threshholds*/
 105   float  ampmax[64];       /* book amp threshholds*/
 106   int    subgrp[64];       /* book heuristic subgroup size */
 107   int    blimit[64];       /* subgroup position limits */
 108
 109 } vorbis_info_residue0;
 110
 111 /* Mapping backend generic *****************************************/
 112 typedef struct{
 113   void                 (*pack)  (vorbis_info *,vorbis_info_mapping *,
 114                                  oggpack_buffer *);
 115   vorbis_info_mapping *(*unpack)(vorbis_info *,oggpack_buffer *);
 116   vorbis_look_mapping *(*look)  (vorbis_dsp_state *,vorbis_info_mode *,
 117                                  vorbis_info_mapping *);
 118   void (*free_info)    (vorbis_info_mapping *);
 119   void (*free_look)    (vorbis_look_mapping *);
 120   int  (*forward)      (struct vorbis_block *vb,vorbis_look_mapping *);
 121   int  (*inverse)      (struct vorbis_block *vb,vorbis_look_mapping *);
 122 } vorbis_func_mapping;
 123
 124 typedef struct vorbis_info_mapping0{
 125   int   submaps;  /* <= 16 */
 126   int   chmuxlist[256];   /* up to 256 channels in a Vorbis stream */
 127
 128   int   timesubmap[16];    /* [mux] */
 129   int   floorsubmap[16];   /* [mux] submap to floors */
 130   int   residuesubmap[16]; /* [mux] submap to residue */
 131   int   psysubmap[16];     /* [mux]; encode only */
 132 } vorbis_info_mapping0;
 133
 134 #endif
 135
 136
 137
 138
 139