apps/codecs/libtremor/info.c

   1 /********************************************************************
   2  *                                                                  *
   3  * THIS FILE IS PART OF THE OggVorbis 'TREMOR' CODEC SOURCE CODE.   *
   4  *                                                                  *
   5  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
   6  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
   7  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
   8  *                                                                  *
   9  * THE OggVorbis 'TREMOR' SOURCE CODE IS (C) COPYRIGHT 1994-2003    *
  10  * BY THE Xiph.Org FOUNDATION http://www.xiph.org/                  *
  11  *                                                                  *
  12  ********************************************************************
  13
  14  function: maintain the info structure, info <-> header packets
  15
  16  ********************************************************************/
  17
  18 /* general handling of the header and the vorbis_info structure (and
  19    substructures) */
  20
  21 #include "config-tremor.h"
  22 #include <string.h>
  23 #include <ctype.h>
  24 #include "ogg.h"
  25 #include "ivorbiscodec.h"
  26 #include "codec_internal.h"
  27 #include "codebook.h"
  28 #include "registry.h"
  29 #include "window.h"
  30 #include "misc.h"
  31 #include "os.h"
  32
  33 /* helpers */
  34 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
  35   while(bytes--){
  36     *buf++=oggpack_read(o,8);
  37   }
  38 }
  39
  40 void vorbis_comment_init(vorbis_comment *vc){
  41   memset(vc,0,sizeof(*vc));
  42 }
  43
  44 void vorbis_comment_clear(vorbis_comment *vc){
  45   if(vc){
  46     long i;
  47     for(i=0;i<vc->comments;i++)
  48       if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
  49     if(vc->user_comments)_ogg_free(vc->user_comments);
  50     if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
  51     if(vc->vendor)_ogg_free(vc->vendor);
  52     memset(vc,0,sizeof(*vc));
  53   }
  54 }
  55
  56 /* blocksize 0 is guaranteed to be short, 1 is guarantted to be long.
  57    They may be equal, but short will never ge greater than long */
  58 int vorbis_info_blocksize(vorbis_info *vi,int zo){
  59   codec_setup_info *ci = (codec_setup_info *)vi->codec_setup;
  60   return ci ? ci->blocksizes[zo] : -1;
  61 }
  62
  63 /* used by synthesis, which has a full, alloced vi */
  64 void vorbis_info_init(vorbis_info *vi){
  65   memset(vi,0,sizeof(*vi));
  66   vi->codec_setup=(codec_setup_info *)_ogg_calloc(1,sizeof(codec_setup_info));
  67 }
  68
  69 void vorbis_info_clear(vorbis_info *vi){
  70   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
  71   int i;
  72
  73   if(ci){
  74
  75     for(i=0;i<ci->modes;i++)
  76       if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
  77
  78     for(i=0;i<ci->maps;i++) /* unpack does the range checking */
  79       if(ci->map_param[i])
  80     _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
  81
  82     for(i=0;i<ci->floors;i++) /* unpack does the range checking */
  83       if(ci->floor_param[i])
  84     _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
  85
  86     for(i=0;i<ci->residues;i++) /* unpack does the range checking */
  87       if(ci->residue_param[i])
  88     _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
  89
  90     for(i=0;i<ci->books;i++){
  91       if(ci->book_param[i]){
  92     /* knows if the book was not alloced */
  93     vorbis_staticbook_destroy(ci->book_param[i]);
  94       }
  95       if(ci->fullbooks)
  96     vorbis_book_clear(ci->fullbooks+i);
  97     }
  98     if(ci->fullbooks)
  99     _ogg_free(ci->fullbooks);
 100
 101     _ogg_free(ci);
 102   }
 103
 104   memset(vi,0,sizeof(*vi));
 105 }
 106
 107 /* Header packing/unpacking ********************************************/
 108
 109 static int _vorbis_unpack_info(vorbis_info *vi,oggpack_buffer *opb){
 110   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 111   if(!ci)return(OV_EFAULT);
 112
 113   vi->version=oggpack_read(opb,32);
 114   if(vi->version!=0)return(OV_EVERSION);
 115
 116   vi->channels=oggpack_read(opb,8);
 117   vi->rate=oggpack_read(opb,32);
 118
 119   vi->bitrate_upper=oggpack_read(opb,32);
 120   vi->bitrate_nominal=oggpack_read(opb,32);
 121   vi->bitrate_lower=oggpack_read(opb,32);
 122
 123   ci->blocksizes_nbits[0]=oggpack_read(opb,4);
 124   ci->blocksizes_nbits[1]=oggpack_read(opb,4);
 125   ci->blocksizes[0]=1<<(ci->blocksizes_nbits[0]);
 126   ci->blocksizes[1]=1<<(ci->blocksizes_nbits[1]);
 127
 128   if(vi->rate<1)goto err_out;
 129   if(vi->channels<1)goto err_out;
 130   if(ci->blocksizes[0]<64)goto err_out;
 131   if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
 132   if(ci->blocksizes[1]>8192)goto err_out;
 133
 134   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
 135
 136   return(0);
 137  err_out:
 138   vorbis_info_clear(vi);
 139   return(OV_EBADHEADER);
 140 }
 141
 142 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
 143   int vendorlen=oggpack_read(opb,32);
 144   if(vendorlen<0)goto err_out;
 145   vc->vendor=(char *)_ogg_calloc(vendorlen+1,1);
 146   _v_readstring(opb,vc->vendor,vendorlen);
 147   vc->comments=0;
 148   return(0);
 149  err_out:
 150   vorbis_comment_clear(vc);
 151   return(OV_EBADHEADER);
 152 }
 153
 154 /* all of the real encoding details are here.  The modes, books,
 155    everything */
 156 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
 157   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 158   int i;
 159   if(!ci)return(OV_EFAULT);
 160
 161   /* codebooks */
 162   ci->books=oggpack_read(opb,8)+1;
 163   /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
 164   for(i=0;i<ci->books;i++){
 165     ci->book_param[i]=(static_codebook *)_ogg_calloc(1,sizeof(*ci->book_param[i]));
 166     if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
 167   }
 168
 169   /* time backend settings */
 170   ci->times=oggpack_read(opb,6)+1;
 171   /*ci->time_type=_ogg_malloc(ci->times*sizeof(*ci->time_type));*/
 172   /*ci->time_param=_ogg_calloc(ci->times,sizeof(void *));*/
 173   for(i=0;i<ci->times;i++){
 174     ci->time_type[i]=oggpack_read(opb,16);
 175     if(ci->time_type[i]<0 || ci->time_type[i]>=VI_TIMEB)goto err_out;
 176     /* ci->time_param[i]=_time_P[ci->time_type[i]]->unpack(vi,opb);
 177        Vorbis I has no time backend */
 178     /*if(!ci->time_param[i])goto err_out;*/
 179   }
 180
 181   /* floor backend settings */
 182   ci->floors=oggpack_read(opb,6)+1;
 183   /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
 184   /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
 185   for(i=0;i<ci->floors;i++){
 186     ci->floor_type[i]=oggpack_read(opb,16);
 187     if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
 188     ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
 189     if(!ci->floor_param[i])goto err_out;
 190   }
 191
 192   /* residue backend settings */
 193   ci->residues=oggpack_read(opb,6)+1;
 194   /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
 195   /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
 196   for(i=0;i<ci->residues;i++){
 197     ci->residue_type[i]=oggpack_read(opb,16);
 198     if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
 199     ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
 200     if(!ci->residue_param[i])goto err_out;
 201   }
 202
 203   /* map backend settings */
 204   ci->maps=oggpack_read(opb,6)+1;
 205   /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
 206   /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
 207   for(i=0;i<ci->maps;i++){
 208     ci->map_type[i]=oggpack_read(opb,16);
 209     if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
 210     ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
 211     if(!ci->map_param[i])goto err_out;
 212   }
 213
 214   /* mode settings */
 215   ci->modes=oggpack_read(opb,6)+1;
 216   /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
 217   for(i=0;i<ci->modes;i++){
 218     ci->mode_param[i]=(vorbis_info_mode *)_ogg_calloc(1,sizeof(*ci->mode_param[i]));
 219     ci->mode_param[i]->blockflag=oggpack_read(opb,1);
 220     ci->mode_param[i]->windowtype=oggpack_read(opb,16);
 221     ci->mode_param[i]->transformtype=oggpack_read(opb,16);
 222     ci->mode_param[i]->mapping=oggpack_read(opb,8);
 223
 224     if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
 225     if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
 226     if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
 227   }
 228
 229   if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
 230
 231   return(0);
 232  err_out:
 233   vorbis_info_clear(vi);
 234   return(OV_EBADHEADER);
 235 }
 236
 237 /* Is this packet a vorbis ID header? */
 238 int vorbis_synthesis_idheader(ogg_packet *op){
 239   oggpack_buffer opb;
 240   char buffer[6];
 241
 242   if(op){
 243     oggpack_readinit(&opb,op->packet);
 244
 245     if(!op->b_o_s)
 246       return(0); /* Not the initial packet */
 247
 248     if(oggpack_read(&opb,8) != 1)
 249       return 0; /* not an ID header */
 250
 251     memset(buffer,0,6);
 252     _v_readstring(&opb,buffer,6);
 253     if(memcmp(buffer,"vorbis",6))
 254       return 0; /* not vorbis */
 255
 256     return 1;
 257   }
 258
 259   return 0;
 260 }
 261
 262 /* The Vorbis header is in three packets; the initial small packet in
 263    the first page that identifies basic parameters, a second packet
 264    with bitstream comments and a third packet that holds the
 265    codebook. */
 266
 267 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
 268   oggpack_buffer opb;
 269
 270   if(op){
 271     oggpack_readinit(&opb,op->packet);
 272
 273     /* Which of the three types of header is this? */
 274     /* Also verify header-ness, vorbis */
 275     {
 276       char buffer[6];
 277       int packtype=oggpack_read(&opb,8);
 278       memset(buffer,0,6);
 279       _v_readstring(&opb,buffer,6);
 280       if(memcmp(buffer,"vorbis",6)){
 281     /* not a vorbis header */
 282     return(OV_ENOTVORBIS);
 283       }
 284       switch(packtype){
 285       case 0x01: /* least significant *bit* is read first */
 286     if(!op->b_o_s){
 287       /* Not the initial packet */
 288       return(OV_EBADHEADER);
 289     }
 290     if(vi->rate!=0){
 291       /* previously initialized info header */
 292       return(OV_EBADHEADER);
 293     }
 294
 295     return(_vorbis_unpack_info(vi,&opb));
 296
 297       case 0x03: /* least significant *bit* is read first */
 298     if(vi->rate==0){
 299       /* um... we didn't get the initial header */
 300       return(OV_EBADHEADER);
 301     }
 302
 303     return(_vorbis_unpack_comment(vc,&opb));
 304
 305       case 0x05: /* least significant *bit* is read first */
 306     if(vi->rate==0 || vc->vendor==NULL){
 307       /* um... we didn;t get the initial header or comments yet */
 308       return(OV_EBADHEADER);
 309     }
 310
 311     return(_vorbis_unpack_books(vi,&opb));
 312
 313       default:
 314     /* Not a valid vorbis header type */
 315     return(OV_EBADHEADER);
 316     break;
 317       }
 318     }
 319   }
 320   return(OV_EBADHEADER);
 321 }
 322