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[0]=1<<oggpack_read(opb,4);
 124   ci->blocksizes[1]=1<<oggpack_read(opb,4);
 125
 126   if(vi->rate<1)goto err_out;
 127   if(vi->channels<1)goto err_out;
 128   if(ci->blocksizes[0]<64)goto err_out;
 129   if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
 130   if(ci->blocksizes[1]>8192)goto err_out;
 131
 132   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
 133
 134   return(0);
 135  err_out:
 136   vorbis_info_clear(vi);
 137   return(OV_EBADHEADER);
 138 }
 139
 140 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
 141   int i;
 142   int vendorlen=oggpack_read(opb,32);
 143   if(vendorlen<0)goto err_out;
 144   vc->vendor=(char *)_ogg_calloc(vendorlen+1,1);
 145   _v_readstring(opb,vc->vendor,vendorlen);
 146   vc->comments=oggpack_read(opb,32);
 147   if(vc->comments<0)goto err_out;
 148   vc->user_comments=(char **)_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
 149   vc->comment_lengths=(int *)_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
 150
 151   for(i=0;i<vc->comments;i++){
 152      int len=oggpack_read(opb,32);
 153      if(len<0)goto err_out;
 154      vc->comment_lengths[i]=len;
 155      if(len>10000){  /*truncate long comments rather then seg faulting*/
 156          vc->user_comments[i]=(char *)_ogg_calloc(10001,1);
 157          _v_readstring(opb,vc->user_comments[i],10000);
 158          /*just to be neat, consumed and discard the rest of the comment*/
 159          len-=10000;
 160          while(len--)
 161              oggpack_read(opb,8);
 162      }else{
 163          vc->user_comments[i]=(char *)_ogg_calloc(len+1,1);
 164          _v_readstring(opb,vc->user_comments[i],len);
 165      }
 166    }
 167   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
 168
 169   return(0);
 170  err_out:
 171   vorbis_comment_clear(vc);
 172   return(OV_EBADHEADER);
 173 }
 174
 175 /* all of the real encoding details are here.  The modes, books,
 176    everything */
 177 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
 178   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 179   int i;
 180   if(!ci)return(OV_EFAULT);
 181
 182   /* codebooks */
 183   ci->books=oggpack_read(opb,8)+1;
 184   /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
 185   for(i=0;i<ci->books;i++){
 186     ci->book_param[i]=(static_codebook *)_ogg_calloc(1,sizeof(*ci->book_param[i]));
 187     if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
 188   }
 189
 190   /* time backend settings */
 191   ci->times=oggpack_read(opb,6)+1;
 192   /*ci->time_type=_ogg_malloc(ci->times*sizeof(*ci->time_type));*/
 193   /*ci->time_param=_ogg_calloc(ci->times,sizeof(void *));*/
 194   for(i=0;i<ci->times;i++){
 195     ci->time_type[i]=oggpack_read(opb,16);
 196     if(ci->time_type[i]<0 || ci->time_type[i]>=VI_TIMEB)goto err_out;
 197     /* ci->time_param[i]=_time_P[ci->time_type[i]]->unpack(vi,opb);
 198        Vorbis I has no time backend */
 199     /*if(!ci->time_param[i])goto err_out;*/
 200   }
 201
 202   /* floor backend settings */
 203   ci->floors=oggpack_read(opb,6)+1;
 204   /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
 205   /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
 206   for(i=0;i<ci->floors;i++){
 207     ci->floor_type[i]=oggpack_read(opb,16);
 208     if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
 209     ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
 210     if(!ci->floor_param[i])goto err_out;
 211   }
 212
 213   /* residue backend settings */
 214   ci->residues=oggpack_read(opb,6)+1;
 215   /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
 216   /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
 217   for(i=0;i<ci->residues;i++){
 218     ci->residue_type[i]=oggpack_read(opb,16);
 219     if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
 220     ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
 221     if(!ci->residue_param[i])goto err_out;
 222   }
 223
 224   /* map backend settings */
 225   ci->maps=oggpack_read(opb,6)+1;
 226   /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
 227   /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
 228   for(i=0;i<ci->maps;i++){
 229     ci->map_type[i]=oggpack_read(opb,16);
 230     if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
 231     ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
 232     if(!ci->map_param[i])goto err_out;
 233   }
 234
 235   /* mode settings */
 236   ci->modes=oggpack_read(opb,6)+1;
 237   /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
 238   for(i=0;i<ci->modes;i++){
 239     ci->mode_param[i]=(vorbis_info_mode *)_ogg_calloc(1,sizeof(*ci->mode_param[i]));
 240     ci->mode_param[i]->blockflag=oggpack_read(opb,1);
 241     ci->mode_param[i]->windowtype=oggpack_read(opb,16);
 242     ci->mode_param[i]->transformtype=oggpack_read(opb,16);
 243     ci->mode_param[i]->mapping=oggpack_read(opb,8);
 244
 245     if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
 246     if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
 247     if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
 248   }
 249
 250   if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
 251
 252   return(0);
 253  err_out:
 254   vorbis_info_clear(vi);
 255   return(OV_EBADHEADER);
 256 }
 257
 258 /* The Vorbis header is in three packets; the initial small packet in
 259    the first page that identifies basic parameters, a second packet
 260    with bitstream comments and a third packet that holds the
 261    codebook. */
 262
 263 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
 264   oggpack_buffer opb;
 265
 266   if(op){
 267     oggpack_readinit(&opb,op->packet);
 268
 269     /* Which of the three types of header is this? */
 270     /* Also verify header-ness, vorbis */
 271     {
 272       char buffer[6];
 273       int packtype=oggpack_read(&opb,8);
 274       memset(buffer,0,6);
 275       _v_readstring(&opb,buffer,6);
 276       if(memcmp(buffer,"vorbis",6)){
 277         /* not a vorbis header */
 278         return(OV_ENOTVORBIS);
 279       }
 280       switch(packtype){
 281       case 0x01: /* least significant *bit* is read first */
 282         if(!op->b_o_s){
 283           /* Not the initial packet */
 284           return(OV_EBADHEADER);
 285         }
 286         if(vi->rate!=0){
 287           /* previously initialized info header */
 288           return(OV_EBADHEADER);
 289         }
 290
 291         return(_vorbis_unpack_info(vi,&opb));
 292
 293       case 0x03: /* least significant *bit* is read first */
 294         if(vi->rate==0){
 295           /* um... we didn't get the initial header */
 296           return(OV_EBADHEADER);
 297         }
 298
 299         return(_vorbis_unpack_comment(vc,&opb));
 300
 301       case 0x05: /* least significant *bit* is read first */
 302         if(vi->rate==0 || vc->vendor==NULL){
 303           /* um... we didn;t get the initial header or comments yet */
 304           return(OV_EBADHEADER);
 305         }
 306
 307         return(_vorbis_unpack_books(vi,&opb));
 308
 309       default:
 310         /* Not a valid vorbis header type */
 311         return(OV_EBADHEADER);
 312         break;
 313       }
 314     }
 315   }
 316   return(OV_EBADHEADER);
 317 }
 318