Multiplexed stream support for vorbisfile *IN PROGRESS*
[platform/upstream/libvorbis.git] / lib / info.c
1 /********************************************************************
2  *                                                                  *
3  * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
5  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
7  *                                                                  *
8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2003             *
9  * by the XIPHOPHORUS Company http://www.xiph.org/                  *
10  *                                                                  *
11  ********************************************************************
12
13  function: maintain the info structure, info <-> header packets
14  last mod: $Id$
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/ogg.h>
25 #include "vorbis/codec.h"
26 #include "codec_internal.h"
27 #include "codebook.h"
28 #include "registry.h"
29 #include "window.h"
30 #include "psy.h"
31 #include "misc.h"
32 #include "os.h"
33
34 /* helpers */
35 static int ilog2(unsigned int v){
36   int ret=0;
37   if(v)--v;
38   while(v){
39     ret++;
40     v>>=1;
41   }
42   return(ret);
43 }
44
45 static void _v_writestring(oggpack_buffer *o,char *s, int bytes){
46
47   while(bytes--){
48     oggpack_write(o,*s++,8);
49   }
50 }
51
52 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
53   while(bytes--){
54     *buf++=oggpack_read(o,8);
55   }
56 }
57
58 void vorbis_comment_init(vorbis_comment *vc){
59   memset(vc,0,sizeof(*vc));
60 }
61
62 void vorbis_comment_add(vorbis_comment *vc,char *comment){
63   vc->user_comments=_ogg_realloc(vc->user_comments,
64                             (vc->comments+2)*sizeof(*vc->user_comments));
65   vc->comment_lengths=_ogg_realloc(vc->comment_lengths,
66                             (vc->comments+2)*sizeof(*vc->comment_lengths));
67   vc->comment_lengths[vc->comments]=strlen(comment);
68   vc->user_comments[vc->comments]=_ogg_malloc(vc->comment_lengths[vc->comments]+1);
69   strcpy(vc->user_comments[vc->comments], comment);
70   vc->comments++;
71   vc->user_comments[vc->comments]=NULL;
72 }
73
74 void vorbis_comment_add_tag(vorbis_comment *vc, char *tag, char *contents){
75   char *comment=alloca(strlen(tag)+strlen(contents)+2); /* +2 for = and \0 */
76   strcpy(comment, tag);
77   strcat(comment, "=");
78   strcat(comment, contents);
79   vorbis_comment_add(vc, comment);
80 }
81
82 /* This is more or less the same as strncasecmp - but that doesn't exist
83  * everywhere, and this is a fairly trivial function, so we include it */
84 static int tagcompare(const char *s1, const char *s2, int n){
85   int c=0;
86   while(c < n){
87     if(toupper(s1[c]) != toupper(s2[c]))
88       return !0;
89     c++;
90   }
91   return 0;
92 }
93
94 char *vorbis_comment_query(vorbis_comment *vc, char *tag, int count){
95   long i;
96   int found = 0;
97   int taglen = strlen(tag)+1; /* +1 for the = we append */
98   char *fulltag = alloca(taglen+ 1);
99
100   strcpy(fulltag, tag);
101   strcat(fulltag, "=");
102   
103   for(i=0;i<vc->comments;i++){
104     if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
105       if(count == found)
106         /* We return a pointer to the data, not a copy */
107         return vc->user_comments[i] + taglen;
108       else
109         found++;
110     }
111   }
112   return NULL; /* didn't find anything */
113 }
114
115 int vorbis_comment_query_count(vorbis_comment *vc, char *tag){
116   int i,count=0;
117   int taglen = strlen(tag)+1; /* +1 for the = we append */
118   char *fulltag = alloca(taglen+1);
119   strcpy(fulltag,tag);
120   strcat(fulltag, "=");
121
122   for(i=0;i<vc->comments;i++){
123     if(!tagcompare(vc->user_comments[i], fulltag, taglen))
124       count++;
125   }
126
127   return count;
128 }
129
130 void vorbis_comment_clear(vorbis_comment *vc){
131   if(vc){
132     long i;
133     for(i=0;i<vc->comments;i++)
134       if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
135     if(vc->user_comments)_ogg_free(vc->user_comments);
136         if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
137     if(vc->vendor)_ogg_free(vc->vendor);
138     memset(vc,0,sizeof(*vc));
139   }
140 }
141
142 /* blocksize 0 is guaranteed to be short, 1 is guaranteed to be long.
143    They may be equal, but short will never ge greater than long */
144 int vorbis_info_blocksize(vorbis_info *vi,int zo){
145   codec_setup_info *ci = vi->codec_setup;
146   return ci ? ci->blocksizes[zo] : -1;
147 }
148
149 /* used by synthesis, which has a full, alloced vi */
150 void vorbis_info_init(vorbis_info *vi){
151   memset(vi,0,sizeof(*vi));
152   vi->codec_setup=_ogg_calloc(1,sizeof(codec_setup_info));
153 }
154
155 void vorbis_info_clear(vorbis_info *vi){
156   codec_setup_info     *ci=vi->codec_setup;
157   int i;
158
159   if(ci){
160
161     for(i=0;i<ci->modes;i++)
162       if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
163
164     for(i=0;i<ci->maps;i++) /* unpack does the range checking */
165       if(ci->map_param[i]) /* this may be cleaning up an aborted
166                               unpack, in which case the below type
167                               cannot be trusted */
168         _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
169
170     for(i=0;i<ci->floors;i++) /* unpack does the range checking */
171       if(ci->floor_param[i]) /* this may be cleaning up an aborted
172                                 unpack, in which case the below type
173                                 cannot be trusted */
174         _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
175     
176     for(i=0;i<ci->residues;i++) /* unpack does the range checking */
177       if(ci->residue_param[i]) /* this may be cleaning up an aborted
178                                   unpack, in which case the below type
179                                   cannot be trusted */
180         _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
181     
182     for(i=0;i<ci->books;i++){
183       if(ci->book_param[i]){
184         /* knows if the book was not alloced */
185         vorbis_staticbook_destroy(ci->book_param[i]);
186       }
187       if(ci->fullbooks)
188         vorbis_book_clear(ci->fullbooks+i);
189     }
190     if(ci->fullbooks)
191         _ogg_free(ci->fullbooks);
192     
193     for(i=0;i<ci->psys;i++)
194       _vi_psy_free(ci->psy_param[i]);
195
196     _ogg_free(ci);
197   }
198
199   memset(vi,0,sizeof(*vi));
200 }
201
202 /* Header packing/unpacking ********************************************/
203
204 static int _vorbis_unpack_info(vorbis_info *vi,oggpack_buffer *opb){
205   codec_setup_info     *ci=vi->codec_setup;
206   if(!ci)return(OV_EFAULT);
207
208   vi->version=oggpack_read(opb,32);
209   if(vi->version!=0)return(OV_EVERSION);
210
211   vi->channels=oggpack_read(opb,8);
212   vi->rate=oggpack_read(opb,32);
213
214   vi->bitrate_upper=oggpack_read(opb,32);
215   vi->bitrate_nominal=oggpack_read(opb,32);
216   vi->bitrate_lower=oggpack_read(opb,32);
217
218   ci->blocksizes[0]=1<<oggpack_read(opb,4);
219   ci->blocksizes[1]=1<<oggpack_read(opb,4);
220   
221   if(vi->rate<1)goto err_out;
222   if(vi->channels<1)goto err_out;
223   if(ci->blocksizes[0]<64)goto err_out; 
224   if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
225   if(ci->blocksizes[1]>8192)goto err_out;
226
227   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
228
229   return(0);
230  err_out:
231   vorbis_info_clear(vi);
232   return(OV_EBADHEADER);
233 }
234
235 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
236   int i;
237   int vendorlen=oggpack_read(opb,32);
238   if(vendorlen<0)goto err_out;
239   vc->vendor=_ogg_calloc(vendorlen+1,1);
240   _v_readstring(opb,vc->vendor,vendorlen);
241   vc->comments=oggpack_read(opb,32);
242   if(vc->comments<0)goto err_out;
243   vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
244   vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
245             
246   for(i=0;i<vc->comments;i++){
247     int len=oggpack_read(opb,32);
248     if(len<0)goto err_out;
249         vc->comment_lengths[i]=len;
250     vc->user_comments[i]=_ogg_calloc(len+1,1);
251     _v_readstring(opb,vc->user_comments[i],len);
252   }       
253   if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
254
255   return(0);
256  err_out:
257   vorbis_comment_clear(vc);
258   return(OV_EBADHEADER);
259 }
260
261 /* all of the real encoding details are here.  The modes, books,
262    everything */
263 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
264   codec_setup_info     *ci=vi->codec_setup;
265   int i;
266   if(!ci)return(OV_EFAULT);
267
268   /* codebooks */
269   ci->books=oggpack_read(opb,8)+1;
270   /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
271   for(i=0;i<ci->books;i++){
272     ci->book_param[i]=_ogg_calloc(1,sizeof(*ci->book_param[i]));
273     if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
274   }
275
276   /* time backend settings; hooks are unused */
277   {
278     int times=oggpack_read(opb,6)+1;
279     for(i=0;i<times;i++){
280       int test=oggpack_read(opb,16);
281       if(test<0 || test>=VI_TIMEB)goto err_out;
282     }
283   }
284
285   /* floor backend settings */
286   ci->floors=oggpack_read(opb,6)+1;
287   /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
288   /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
289   for(i=0;i<ci->floors;i++){
290     ci->floor_type[i]=oggpack_read(opb,16);
291     if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
292     ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
293     if(!ci->floor_param[i])goto err_out;
294   }
295
296   /* residue backend settings */
297   ci->residues=oggpack_read(opb,6)+1;
298   /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
299   /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
300   for(i=0;i<ci->residues;i++){
301     ci->residue_type[i]=oggpack_read(opb,16);
302     if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
303     ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
304     if(!ci->residue_param[i])goto err_out;
305   }
306
307   /* map backend settings */
308   ci->maps=oggpack_read(opb,6)+1;
309   /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
310   /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
311   for(i=0;i<ci->maps;i++){
312     ci->map_type[i]=oggpack_read(opb,16);
313     if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
314     ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
315     if(!ci->map_param[i])goto err_out;
316   }
317   
318   /* mode settings */
319   ci->modes=oggpack_read(opb,6)+1;
320   /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
321   for(i=0;i<ci->modes;i++){
322     ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
323     ci->mode_param[i]->blockflag=oggpack_read(opb,1);
324     ci->mode_param[i]->windowtype=oggpack_read(opb,16);
325     ci->mode_param[i]->transformtype=oggpack_read(opb,16);
326     ci->mode_param[i]->mapping=oggpack_read(opb,8);
327
328     if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
329     if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
330     if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
331   }
332   
333   if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
334
335   return(0);
336  err_out:
337   vorbis_info_clear(vi);
338   return(OV_EBADHEADER);
339 }
340
341 /* Is this packet a vorbis ID header? */
342 int vorbis_synthesis_idheader(ogg_packet *op){
343   oggpack_buffer opb;
344   char buffer[6];
345
346   if(op){
347     oggpack_readinit(&opb,op->packet,op->bytes);
348
349     if(!op->b_o_s)
350       return(0); /* Not the initial packet */
351
352     if(oggpack_read(&opb,8) != 1)
353       return 0; /* not an ID header */
354
355     memset(buffer,0,6);
356     _v_readstring(&opb,buffer,6);
357     if(memcmp(buffer,"vorbis",6))
358       return 0; /* not vorbis */
359
360     return 1;
361   }
362
363   return 0;
364 }
365
366 /* The Vorbis header is in three packets; the initial small packet in
367    the first page that identifies basic parameters, a second packet
368    with bitstream comments and a third packet that holds the
369    codebook. */
370
371 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
372   oggpack_buffer opb;
373   
374   if(op){
375     oggpack_readinit(&opb,op->packet,op->bytes);
376
377     /* Which of the three types of header is this? */
378     /* Also verify header-ness, vorbis */
379     {
380       char buffer[6];
381       int packtype=oggpack_read(&opb,8);
382       memset(buffer,0,6);
383       _v_readstring(&opb,buffer,6);
384       if(memcmp(buffer,"vorbis",6)){
385         /* not a vorbis header */
386         return(OV_ENOTVORBIS);
387       }
388       switch(packtype){
389       case 0x01: /* least significant *bit* is read first */
390         if(!op->b_o_s){
391           /* Not the initial packet */
392           return(OV_EBADHEADER);
393         }
394         if(vi->rate!=0){
395           /* previously initialized info header */
396           return(OV_EBADHEADER);
397         }
398
399         return(_vorbis_unpack_info(vi,&opb));
400
401       case 0x03: /* least significant *bit* is read first */
402         if(vi->rate==0){
403           /* um... we didn't get the initial header */
404           return(OV_EBADHEADER);
405         }
406
407         return(_vorbis_unpack_comment(vc,&opb));
408
409       case 0x05: /* least significant *bit* is read first */
410         if(vi->rate==0 || vc->vendor==NULL){
411           /* um... we didn;t get the initial header or comments yet */
412           return(OV_EBADHEADER);
413         }
414
415         return(_vorbis_unpack_books(vi,&opb));
416
417       default:
418         /* Not a valid vorbis header type */
419         return(OV_EBADHEADER);
420         break;
421       }
422     }
423   }
424   return(OV_EBADHEADER);
425 }
426
427 /* pack side **********************************************************/
428
429 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
430   codec_setup_info     *ci=vi->codec_setup;
431   if(!ci)return(OV_EFAULT);
432
433   /* preamble */  
434   oggpack_write(opb,0x01,8);
435   _v_writestring(opb,"vorbis", 6);
436
437   /* basic information about the stream */
438   oggpack_write(opb,0x00,32);
439   oggpack_write(opb,vi->channels,8);
440   oggpack_write(opb,vi->rate,32);
441
442   oggpack_write(opb,vi->bitrate_upper,32);
443   oggpack_write(opb,vi->bitrate_nominal,32);
444   oggpack_write(opb,vi->bitrate_lower,32);
445
446   oggpack_write(opb,ilog2(ci->blocksizes[0]),4);
447   oggpack_write(opb,ilog2(ci->blocksizes[1]),4);
448   oggpack_write(opb,1,1);
449
450   return(0);
451 }
452
453 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
454   char temp[]="Xiph.Org libVorbis I 20070622";
455   int bytes = strlen(temp);
456
457   /* preamble */  
458   oggpack_write(opb,0x03,8);
459   _v_writestring(opb,"vorbis", 6);
460
461   /* vendor */
462   oggpack_write(opb,bytes,32);
463   _v_writestring(opb,temp, bytes);
464   
465   /* comments */
466
467   oggpack_write(opb,vc->comments,32);
468   if(vc->comments){
469     int i;
470     for(i=0;i<vc->comments;i++){
471       if(vc->user_comments[i]){
472         oggpack_write(opb,vc->comment_lengths[i],32);
473         _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
474       }else{
475         oggpack_write(opb,0,32);
476       }
477     }
478   }
479   oggpack_write(opb,1,1);
480
481   return(0);
482 }
483  
484 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
485   codec_setup_info     *ci=vi->codec_setup;
486   int i;
487   if(!ci)return(OV_EFAULT);
488
489   oggpack_write(opb,0x05,8);
490   _v_writestring(opb,"vorbis", 6);
491
492   /* books */
493   oggpack_write(opb,ci->books-1,8);
494   for(i=0;i<ci->books;i++)
495     if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
496
497   /* times; hook placeholders */
498   oggpack_write(opb,0,6);
499   oggpack_write(opb,0,16);
500
501   /* floors */
502   oggpack_write(opb,ci->floors-1,6);
503   for(i=0;i<ci->floors;i++){
504     oggpack_write(opb,ci->floor_type[i],16);
505     if(_floor_P[ci->floor_type[i]]->pack)
506       _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
507     else
508       goto err_out;
509   }
510
511   /* residues */
512   oggpack_write(opb,ci->residues-1,6);
513   for(i=0;i<ci->residues;i++){
514     oggpack_write(opb,ci->residue_type[i],16);
515     _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
516   }
517
518   /* maps */
519   oggpack_write(opb,ci->maps-1,6);
520   for(i=0;i<ci->maps;i++){
521     oggpack_write(opb,ci->map_type[i],16);
522     _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
523   }
524
525   /* modes */
526   oggpack_write(opb,ci->modes-1,6);
527   for(i=0;i<ci->modes;i++){
528     oggpack_write(opb,ci->mode_param[i]->blockflag,1);
529     oggpack_write(opb,ci->mode_param[i]->windowtype,16);
530     oggpack_write(opb,ci->mode_param[i]->transformtype,16);
531     oggpack_write(opb,ci->mode_param[i]->mapping,8);
532   }
533   oggpack_write(opb,1,1);
534
535   return(0);
536 err_out:
537   return(-1);
538
539
540 int vorbis_commentheader_out(vorbis_comment *vc,
541                                       ogg_packet *op){
542
543   oggpack_buffer opb;
544
545   oggpack_writeinit(&opb);
546   if(_vorbis_pack_comment(&opb,vc)) return OV_EIMPL;
547
548   op->packet = _ogg_malloc(oggpack_bytes(&opb));
549   memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
550
551   op->bytes=oggpack_bytes(&opb);
552   op->b_o_s=0;
553   op->e_o_s=0;
554   op->granulepos=0;
555   op->packetno=1;
556
557   return 0;
558 }
559
560 int vorbis_analysis_headerout(vorbis_dsp_state *v,
561                               vorbis_comment *vc,
562                               ogg_packet *op,
563                               ogg_packet *op_comm,
564                               ogg_packet *op_code){
565   int ret=OV_EIMPL;
566   vorbis_info *vi=v->vi;
567   oggpack_buffer opb;
568   private_state *b=v->backend_state;
569
570   if(!b){
571     ret=OV_EFAULT;
572     goto err_out;
573   }
574
575   /* first header packet **********************************************/
576
577   oggpack_writeinit(&opb);
578   if(_vorbis_pack_info(&opb,vi))goto err_out;
579
580   /* build the packet */
581   if(b->header)_ogg_free(b->header);
582   b->header=_ogg_malloc(oggpack_bytes(&opb));
583   memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
584   op->packet=b->header;
585   op->bytes=oggpack_bytes(&opb);
586   op->b_o_s=1;
587   op->e_o_s=0;
588   op->granulepos=0;
589   op->packetno=0;
590
591   /* second header packet (comments) **********************************/
592
593   oggpack_reset(&opb);
594   if(_vorbis_pack_comment(&opb,vc))goto err_out;
595
596   if(b->header1)_ogg_free(b->header1);
597   b->header1=_ogg_malloc(oggpack_bytes(&opb));
598   memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
599   op_comm->packet=b->header1;
600   op_comm->bytes=oggpack_bytes(&opb);
601   op_comm->b_o_s=0;
602   op_comm->e_o_s=0;
603   op_comm->granulepos=0;
604   op_comm->packetno=1;
605
606   /* third header packet (modes/codebooks) ****************************/
607
608   oggpack_reset(&opb);
609   if(_vorbis_pack_books(&opb,vi))goto err_out;
610
611   if(b->header2)_ogg_free(b->header2);
612   b->header2=_ogg_malloc(oggpack_bytes(&opb));
613   memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
614   op_code->packet=b->header2;
615   op_code->bytes=oggpack_bytes(&opb);
616   op_code->b_o_s=0;
617   op_code->e_o_s=0;
618   op_code->granulepos=0;
619   op_code->packetno=2;
620
621   oggpack_writeclear(&opb);
622   return(0);
623  err_out:
624   oggpack_writeclear(&opb);
625   memset(op,0,sizeof(*op));
626   memset(op_comm,0,sizeof(*op_comm));
627   memset(op_code,0,sizeof(*op_code));
628
629   if(b){
630     if(b->header)_ogg_free(b->header);
631     if(b->header1)_ogg_free(b->header1);
632     if(b->header2)_ogg_free(b->header2);
633     b->header=NULL;
634     b->header1=NULL;
635     b->header2=NULL;
636   }
637   return(ret);
638 }
639
640 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
641   if(granulepos>=0)
642     return((double)granulepos/v->vi->rate);
643   return(-1);
644 }