Tremor/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 <stdlib.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
  32 /* helpers */
  33 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
  34   while(bytes--){
  35     *buf++=oggpack_read(o,8);
  36   }
  37 }
  38
  39 void vorbis_comment_init(vorbis_comment *vc){
  40   memset(vc,0,sizeof(*vc));
  41 }
  42
  43 /* This is more or less the same as strncasecmp - but that doesn't exist
  44  * everywhere, and this is a fairly trivial function, so we include it */
  45 static int tagcompare(const char *s1, const char *s2, int n){
  46   int c=0;
  47   while(c < n){
  48     if(toupper(s1[c]) != toupper(s2[c]))
  49       return !0;
  50     c++;
  51   }
  52   return 0;
  53 }
  54
  55 char *vorbis_comment_query(vorbis_comment *vc, char *tag, int count){
  56   long i;
  57   int found = 0;
  58   int taglen = strlen(tag)+1; /* +1 for the = we append */
  59   char *fulltag = (char *)alloca(taglen+ 1);
  60
  61   strcpy(fulltag, tag);
  62   strcat(fulltag, "=");
  63
  64   for(i=0;i<vc->comments;i++){
  65     if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
  66       if(count == found)
  67         /* We return a pointer to the data, not a copy */
  68         return vc->user_comments[i] + taglen;
  69       else
  70         found++;
  71     }
  72   }
  73   return NULL; /* didn't find anything */
  74 }
  75
  76 int vorbis_comment_query_count(vorbis_comment *vc, char *tag){
  77   int i,count=0;
  78   int taglen = strlen(tag)+1; /* +1 for the = we append */
  79   char *fulltag = (char *)alloca(taglen+1);
  80   strcpy(fulltag,tag);
  81   strcat(fulltag, "=");
  82
  83   for(i=0;i<vc->comments;i++){
  84     if(!tagcompare(vc->user_comments[i], fulltag, taglen))
  85       count++;
  86   }
  87
  88   return count;
  89 }
  90
  91 void vorbis_comment_clear(vorbis_comment *vc){
  92   if(vc){
  93     long i;
  94     for(i=0;i<vc->comments;i++)
  95       if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
  96     if(vc->user_comments)_ogg_free(vc->user_comments);
  97         if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
  98     if(vc->vendor)_ogg_free(vc->vendor);
  99   }
 100   memset(vc,0,sizeof(*vc));
 101 }
 102
 103 /* blocksize 0 is guaranteed to be short, 1 is guarantted to be long.
 104    They may be equal, but short will never ge greater than long */
 105 int vorbis_info_blocksize(vorbis_info *vi,int zo){
 106   codec_setup_info *ci = (codec_setup_info *)vi->codec_setup;
 107   return ci ? ci->blocksizes[zo] : -1;
 108 }
 109
 110 /* used by synthesis, which has a full, alloced vi */
 111 void vorbis_info_init(vorbis_info *vi){
 112   memset(vi,0,sizeof(*vi));
 113   vi->codec_setup=(codec_setup_info *)_ogg_calloc(1,sizeof(codec_setup_info));
 114 }
 115
 116 void vorbis_info_clear(vorbis_info *vi){
 117   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 118   int i;
 119
 120   if(ci){
 121
 122     for(i=0;i<ci->modes;i++)
 123       if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
 124
 125     for(i=0;i<ci->maps;i++) /* unpack does the range checking */
 126       _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
 127
 128     for(i=0;i<ci->floors;i++) /* unpack does the range checking */
 129       _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
 130
 131     for(i=0;i<ci->residues;i++) /* unpack does the range checking */
 132       _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
 133
 134     for(i=0;i<ci->books;i++){
 135       if(ci->book_param[i]){
 136         /* knows if the book was not alloced */
 137         vorbis_staticbook_destroy(ci->book_param[i]);
 138       }
 139       if(ci->fullbooks)
 140         vorbis_book_clear(ci->fullbooks+i);
 141     }
 142     if(ci->fullbooks)
 143         _ogg_free(ci->fullbooks);
 144
 145     _ogg_free(ci);
 146   }
 147
 148   memset(vi,0,sizeof(*vi));
 149 }
 150
 151 /* Header packing/unpacking ********************************************/
 152
 153 static int _vorbis_unpack_info(vorbis_info *vi,oggpack_buffer *opb){
 154   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 155   if(!ci)return(OV_EFAULT);
 156
 157   vi->version=oggpack_read(opb,32);
 158   if(vi->version!=0)return(OV_EVERSION);
 159
 160   vi->channels=oggpack_read(opb,8);
 161   vi->rate=oggpack_read(opb,32);
 162
 163   vi->bitrate_upper=oggpack_read(opb,32);
 164   vi->bitrate_nominal=oggpack_read(opb,32);
 165   vi->bitrate_lower=oggpack_read(opb,32);
 166
 167   ci->blocksizes[0]=1<<oggpack_read(opb,4);
 168   ci->blocksizes[1]=1<<oggpack_read(opb,4);
 169
 170   if(vi->rate<1)goto err_out;
 171   if(vi->channels<1)goto err_out;
 172   if(ci->blocksizes[0]<64)goto err_out;
 173   if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
 174   if(ci->blocksizes[1]>8192)goto err_out;
 175
 176   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
 177
 178   return(0);
 179  err_out:
 180   vorbis_info_clear(vi);
 181   return(OV_EBADHEADER);
 182 }
 183
 184 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
 185   int i;
 186   int vendorlen=oggpack_read(opb,32);
 187   if(vendorlen<0)goto err_out;
 188   vc->vendor=(char *)_ogg_calloc(vendorlen+1,1);
 189   _v_readstring(opb,vc->vendor,vendorlen);
 190   vc->comments=oggpack_read(opb,32);
 191   if(vc->comments<0)goto err_out;
 192   vc->user_comments=(char **)_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
 193   vc->comment_lengths=(int *)_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
 194
 195   for(i=0;i<vc->comments;i++){
 196     int len=oggpack_read(opb,32);
 197     if(len<0)goto err_out;
 198         vc->comment_lengths[i]=len;
 199     vc->user_comments[i]=(char *)_ogg_calloc(len+1,1);
 200     _v_readstring(opb,vc->user_comments[i],len);
 201   }
 202   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
 203
 204   return(0);
 205  err_out:
 206   vorbis_comment_clear(vc);
 207   return(OV_EBADHEADER);
 208 }
 209
 210 /* all of the real encoding details are here.  The modes, books,
 211    everything */
 212 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
 213   codec_setup_info     *ci=(codec_setup_info *)vi->codec_setup;
 214   int i;
 215   if(!ci)return(OV_EFAULT);
 216
 217   /* codebooks */
 218   ci->books=oggpack_read(opb,8)+1;
 219   /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
 220   for(i=0;i<ci->books;i++){
 221     ci->book_param[i]=(static_codebook *)_ogg_calloc(1,sizeof(*ci->book_param[i]));
 222     if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
 223   }
 224
 225   /* time backend settings */
 226   ci->times=oggpack_read(opb,6)+1;
 227   /*ci->time_type=_ogg_malloc(ci->times*sizeof(*ci->time_type));*/
 228   /*ci->time_param=_ogg_calloc(ci->times,sizeof(void *));*/
 229   for(i=0;i<ci->times;i++){
 230     ci->time_type[i]=oggpack_read(opb,16);
 231     if(ci->time_type[i]<0 || ci->time_type[i]>=VI_TIMEB)goto err_out;
 232     /* ci->time_param[i]=_time_P[ci->time_type[i]]->unpack(vi,opb);
 233        Vorbis I has no time backend */
 234     /*if(!ci->time_param[i])goto err_out;*/
 235   }
 236
 237   /* floor backend settings */
 238   ci->floors=oggpack_read(opb,6)+1;
 239   /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
 240   /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
 241   for(i=0;i<ci->floors;i++){
 242     ci->floor_type[i]=oggpack_read(opb,16);
 243     if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
 244     ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
 245     if(!ci->floor_param[i])goto err_out;
 246   }
 247
 248   /* residue backend settings */
 249   ci->residues=oggpack_read(opb,6)+1;
 250   /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
 251   /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
 252   for(i=0;i<ci->residues;i++){
 253     ci->residue_type[i]=oggpack_read(opb,16);
 254     if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
 255     ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
 256     if(!ci->residue_param[i])goto err_out;
 257   }
 258
 259   /* map backend settings */
 260   ci->maps=oggpack_read(opb,6)+1;
 261   /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
 262   /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
 263   for(i=0;i<ci->maps;i++){
 264     ci->map_type[i]=oggpack_read(opb,16);
 265     if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
 266     ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
 267     if(!ci->map_param[i])goto err_out;
 268   }
 269
 270   /* mode settings */
 271   ci->modes=oggpack_read(opb,6)+1;
 272   /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
 273   for(i=0;i<ci->modes;i++){
 274     ci->mode_param[i]=(vorbis_info_mode *)_ogg_calloc(1,sizeof(*ci->mode_param[i]));
 275     ci->mode_param[i]->blockflag=oggpack_read(opb,1);
 276     ci->mode_param[i]->windowtype=oggpack_read(opb,16);
 277     ci->mode_param[i]->transformtype=oggpack_read(opb,16);
 278     ci->mode_param[i]->mapping=oggpack_read(opb,8);
 279
 280     if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
 281     if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
 282     if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
 283   }
 284
 285   if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
 286
 287   return(0);
 288  err_out:
 289   vorbis_info_clear(vi);
 290   return(OV_EBADHEADER);
 291 }
 292
 293 /* The Vorbis header is in three packets; the initial small packet in
 294    the first page that identifies basic parameters, a second packet
 295    with bitstream comments and a third packet that holds the
 296    codebook. */
 297
 298 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
 299   oggpack_buffer opb;
 300
 301   if(op){
 302     oggpack_readinit(&opb,op->packet);
 303
 304     /* Which of the three types of header is this? */
 305     /* Also verify header-ness, vorbis */
 306     {
 307       char buffer[6];
 308       int packtype=oggpack_read(&opb,8);
 309       memset(buffer,0,6);
 310       _v_readstring(&opb,buffer,6);
 311       if(memcmp(buffer,"vorbis",6)){
 312         /* not a vorbis header */
 313         return(OV_ENOTVORBIS);
 314       }
 315       switch(packtype){
 316       case 0x01: /* least significant *bit* is read first */
 317         if(!op->b_o_s){
 318           /* Not the initial packet */
 319           return(OV_EBADHEADER);
 320         }
 321         if(vi->rate!=0){
 322           /* previously initialized info header */
 323           return(OV_EBADHEADER);
 324         }
 325
 326         return(_vorbis_unpack_info(vi,&opb));
 327
 328       case 0x03: /* least significant *bit* is read first */
 329         if(vi->rate==0){
 330           /* um... we didn't get the initial header */
 331           return(OV_EBADHEADER);
 332         }
 333
 334         return(_vorbis_unpack_comment(vc,&opb));
 335
 336       case 0x05: /* least significant *bit* is read first */
 337         if(vi->rate==0 || vc->vendor==NULL){
 338           /* um... we didn;t get the initial header or comments yet */
 339           return(OV_EBADHEADER);
 340         }
 341
 342         return(_vorbis_unpack_books(vi,&opb));
 343
 344       default:
 345         /* Not a valid vorbis header type */
 346         return(OV_EBADHEADER);
 347         break;
 348       }
 349     }
 350   }
 351   return(OV_EBADHEADER);
 352 }
 353