1 /********************************************************************
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. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
9 * by the Xiph.Org Foundation http://www.xiph.org/ *
11 ********************************************************************
13 function: maintain the info structure, info <-> header packets
16 ********************************************************************/
18 /* general handling of the header and the vorbis_info structure (and
25 #include "vorbis/codec.h"
26 #include "codec_internal.h"
35 static int ilog2(unsigned int v){
45 static void _v_writestring(oggpack_buffer *o,const char *s, int bytes){
48 oggpack_write(o,*s++,8);
52 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
54 *buf++=oggpack_read(o,8);
58 void vorbis_comment_init(vorbis_comment *vc){
59 memset(vc,0,sizeof(*vc));
62 void vorbis_comment_add(vorbis_comment *vc,const 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);
71 vc->user_comments[vc->comments]=NULL;
74 void vorbis_comment_add_tag(vorbis_comment *vc, const char *tag, const char *contents){
75 char *comment=alloca(strlen(tag)+strlen(contents)+2); /* +2 for = and \0 */
78 strcat(comment, contents);
79 vorbis_comment_add(vc, comment);
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){
87 if(toupper(s1[c]) != toupper(s2[c]))
94 char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count){
97 int taglen = strlen(tag)+1; /* +1 for the = we append */
98 char *fulltag = alloca(taglen+ 1);
100 strcpy(fulltag, tag);
101 strcat(fulltag, "=");
103 for(i=0;i<vc->comments;i++){
104 if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
106 /* We return a pointer to the data, not a copy */
107 return vc->user_comments[i] + taglen;
112 return NULL; /* didn't find anything */
115 int vorbis_comment_query_count(vorbis_comment *vc, const char *tag){
117 int taglen = strlen(tag)+1; /* +1 for the = we append */
118 char *fulltag = alloca(taglen+1);
120 strcat(fulltag, "=");
122 for(i=0;i<vc->comments;i++){
123 if(!tagcompare(vc->user_comments[i], fulltag, taglen))
130 void vorbis_comment_clear(vorbis_comment *vc){
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));
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;
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));
155 void vorbis_info_clear(vorbis_info *vi){
156 codec_setup_info *ci=vi->codec_setup;
161 for(i=0;i<ci->modes;i++)
162 if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
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
168 _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
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
174 _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
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
180 _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
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]);
188 vorbis_book_clear(ci->fullbooks+i);
191 _ogg_free(ci->fullbooks);
193 for(i=0;i<ci->psys;i++)
194 _vi_psy_free(ci->psy_param[i]);
199 memset(vi,0,sizeof(*vi));
202 /* Header packing/unpacking ********************************************/
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);
208 vi->version=oggpack_read(opb,32);
209 if(vi->version!=0)return(OV_EVERSION);
211 vi->channels=oggpack_read(opb,8);
212 vi->rate=oggpack_read(opb,32);
214 vi->bitrate_upper=oggpack_read(opb,32);
215 vi->bitrate_nominal=oggpack_read(opb,32);
216 vi->bitrate_lower=oggpack_read(opb,32);
218 ci->blocksizes[0]=1<<oggpack_read(opb,4);
219 ci->blocksizes[1]=1<<oggpack_read(opb,4);
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;
227 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
231 vorbis_info_clear(vi);
232 return(OV_EBADHEADER);
235 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
237 int vendorlen=oggpack_read(opb,32);
238 if(vendorlen<0)goto err_out;
239 if(vendorlen+8>opb->storage)goto err_out;
240 vc->vendor=_ogg_calloc(vendorlen+1,1);
241 _v_readstring(opb,vc->vendor,vendorlen);
242 i=oggpack_read(opb,32);
244 if(4*i+oggpack_bytes(opb)>opb->storage)goto err_out;
246 vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
247 vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
249 for(i=0;i<vc->comments;i++){
250 int len=oggpack_read(opb,32);
251 if(len<0)goto err_out;
252 if(len+oggpack_bytes(opb)>opb->storage)goto err_out;
253 vc->comment_lengths[i]=len;
254 vc->user_comments[i]=_ogg_calloc(len+1,1);
255 _v_readstring(opb,vc->user_comments[i],len);
257 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
261 vorbis_comment_clear(vc);
262 return(OV_EBADHEADER);
265 /* all of the real encoding details are here. The modes, books,
267 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
268 codec_setup_info *ci=vi->codec_setup;
270 if(!ci)return(OV_EFAULT);
273 ci->books=oggpack_read(opb,8)+1;
274 /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
275 for(i=0;i<ci->books;i++){
276 ci->book_param[i]=_ogg_calloc(1,sizeof(*ci->book_param[i]));
277 if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
280 /* time backend settings; hooks are unused */
282 int times=oggpack_read(opb,6)+1;
283 for(i=0;i<times;i++){
284 int test=oggpack_read(opb,16);
285 if(test<0 || test>=VI_TIMEB)goto err_out;
289 /* floor backend settings */
290 ci->floors=oggpack_read(opb,6)+1;
291 /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
292 /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
293 for(i=0;i<ci->floors;i++){
294 ci->floor_type[i]=oggpack_read(opb,16);
295 if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
296 ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
297 if(!ci->floor_param[i])goto err_out;
300 /* residue backend settings */
301 ci->residues=oggpack_read(opb,6)+1;
302 /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
303 /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
304 for(i=0;i<ci->residues;i++){
305 ci->residue_type[i]=oggpack_read(opb,16);
306 if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
307 ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
308 if(!ci->residue_param[i])goto err_out;
311 /* map backend settings */
312 ci->maps=oggpack_read(opb,6)+1;
313 /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
314 /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
315 for(i=0;i<ci->maps;i++){
316 ci->map_type[i]=oggpack_read(opb,16);
317 if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
318 ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
319 if(!ci->map_param[i])goto err_out;
323 ci->modes=oggpack_read(opb,6)+1;
324 /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
325 for(i=0;i<ci->modes;i++){
326 ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
327 ci->mode_param[i]->blockflag=oggpack_read(opb,1);
328 ci->mode_param[i]->windowtype=oggpack_read(opb,16);
329 ci->mode_param[i]->transformtype=oggpack_read(opb,16);
330 ci->mode_param[i]->mapping=oggpack_read(opb,8);
332 if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
333 if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
334 if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
337 if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
341 vorbis_info_clear(vi);
342 return(OV_EBADHEADER);
345 /* Is this packet a vorbis ID header? */
346 int vorbis_synthesis_idheader(ogg_packet *op){
351 oggpack_readinit(&opb,op->packet,op->bytes);
354 return(0); /* Not the initial packet */
356 if(oggpack_read(&opb,8) != 1)
357 return 0; /* not an ID header */
360 _v_readstring(&opb,buffer,6);
361 if(memcmp(buffer,"vorbis",6))
362 return 0; /* not vorbis */
370 /* The Vorbis header is in three packets; the initial small packet in
371 the first page that identifies basic parameters, a second packet
372 with bitstream comments and a third packet that holds the
375 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
379 oggpack_readinit(&opb,op->packet,op->bytes);
381 /* Which of the three types of header is this? */
382 /* Also verify header-ness, vorbis */
385 int packtype=oggpack_read(&opb,8);
387 _v_readstring(&opb,buffer,6);
388 if(memcmp(buffer,"vorbis",6)){
389 /* not a vorbis header */
390 return(OV_ENOTVORBIS);
393 case 0x01: /* least significant *bit* is read first */
395 /* Not the initial packet */
396 return(OV_EBADHEADER);
399 /* previously initialized info header */
400 return(OV_EBADHEADER);
403 return(_vorbis_unpack_info(vi,&opb));
405 case 0x03: /* least significant *bit* is read first */
407 /* um... we didn't get the initial header */
408 return(OV_EBADHEADER);
411 return(_vorbis_unpack_comment(vc,&opb));
413 case 0x05: /* least significant *bit* is read first */
414 if(vi->rate==0 || vc->vendor==NULL){
415 /* um... we didn;t get the initial header or comments yet */
416 return(OV_EBADHEADER);
419 return(_vorbis_unpack_books(vi,&opb));
422 /* Not a valid vorbis header type */
423 return(OV_EBADHEADER);
428 return(OV_EBADHEADER);
431 /* pack side **********************************************************/
433 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
434 codec_setup_info *ci=vi->codec_setup;
435 if(!ci)return(OV_EFAULT);
438 oggpack_write(opb,0x01,8);
439 _v_writestring(opb,"vorbis", 6);
441 /* basic information about the stream */
442 oggpack_write(opb,0x00,32);
443 oggpack_write(opb,vi->channels,8);
444 oggpack_write(opb,vi->rate,32);
446 oggpack_write(opb,vi->bitrate_upper,32);
447 oggpack_write(opb,vi->bitrate_nominal,32);
448 oggpack_write(opb,vi->bitrate_lower,32);
450 oggpack_write(opb,ilog2(ci->blocksizes[0]),4);
451 oggpack_write(opb,ilog2(ci->blocksizes[1]),4);
452 oggpack_write(opb,1,1);
457 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
458 char temp[]="Xiph.Org libVorbis I 20080501";
459 int bytes = strlen(temp);
462 oggpack_write(opb,0x03,8);
463 _v_writestring(opb,"vorbis", 6);
466 oggpack_write(opb,bytes,32);
467 _v_writestring(opb,temp, bytes);
471 oggpack_write(opb,vc->comments,32);
474 for(i=0;i<vc->comments;i++){
475 if(vc->user_comments[i]){
476 oggpack_write(opb,vc->comment_lengths[i],32);
477 _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
479 oggpack_write(opb,0,32);
483 oggpack_write(opb,1,1);
488 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
489 codec_setup_info *ci=vi->codec_setup;
491 if(!ci)return(OV_EFAULT);
493 oggpack_write(opb,0x05,8);
494 _v_writestring(opb,"vorbis", 6);
497 oggpack_write(opb,ci->books-1,8);
498 for(i=0;i<ci->books;i++)
499 if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
501 /* times; hook placeholders */
502 oggpack_write(opb,0,6);
503 oggpack_write(opb,0,16);
506 oggpack_write(opb,ci->floors-1,6);
507 for(i=0;i<ci->floors;i++){
508 oggpack_write(opb,ci->floor_type[i],16);
509 if(_floor_P[ci->floor_type[i]]->pack)
510 _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
516 oggpack_write(opb,ci->residues-1,6);
517 for(i=0;i<ci->residues;i++){
518 oggpack_write(opb,ci->residue_type[i],16);
519 _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
523 oggpack_write(opb,ci->maps-1,6);
524 for(i=0;i<ci->maps;i++){
525 oggpack_write(opb,ci->map_type[i],16);
526 _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
530 oggpack_write(opb,ci->modes-1,6);
531 for(i=0;i<ci->modes;i++){
532 oggpack_write(opb,ci->mode_param[i]->blockflag,1);
533 oggpack_write(opb,ci->mode_param[i]->windowtype,16);
534 oggpack_write(opb,ci->mode_param[i]->transformtype,16);
535 oggpack_write(opb,ci->mode_param[i]->mapping,8);
537 oggpack_write(opb,1,1);
544 int vorbis_commentheader_out(vorbis_comment *vc,
549 oggpack_writeinit(&opb);
550 if(_vorbis_pack_comment(&opb,vc)) return OV_EIMPL;
552 op->packet = _ogg_malloc(oggpack_bytes(&opb));
553 memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
555 op->bytes=oggpack_bytes(&opb);
564 int vorbis_analysis_headerout(vorbis_dsp_state *v,
568 ogg_packet *op_code){
570 vorbis_info *vi=v->vi;
572 private_state *b=v->backend_state;
579 /* first header packet **********************************************/
581 oggpack_writeinit(&opb);
582 if(_vorbis_pack_info(&opb,vi))goto err_out;
584 /* build the packet */
585 if(b->header)_ogg_free(b->header);
586 b->header=_ogg_malloc(oggpack_bytes(&opb));
587 memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
588 op->packet=b->header;
589 op->bytes=oggpack_bytes(&opb);
595 /* second header packet (comments) **********************************/
598 if(_vorbis_pack_comment(&opb,vc))goto err_out;
600 if(b->header1)_ogg_free(b->header1);
601 b->header1=_ogg_malloc(oggpack_bytes(&opb));
602 memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
603 op_comm->packet=b->header1;
604 op_comm->bytes=oggpack_bytes(&opb);
607 op_comm->granulepos=0;
610 /* third header packet (modes/codebooks) ****************************/
613 if(_vorbis_pack_books(&opb,vi))goto err_out;
615 if(b->header2)_ogg_free(b->header2);
616 b->header2=_ogg_malloc(oggpack_bytes(&opb));
617 memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
618 op_code->packet=b->header2;
619 op_code->bytes=oggpack_bytes(&opb);
622 op_code->granulepos=0;
625 oggpack_writeclear(&opb);
628 oggpack_writeclear(&opb);
629 memset(op,0,sizeof(*op));
630 memset(op_comm,0,sizeof(*op_comm));
631 memset(op_code,0,sizeof(*op_code));
634 if(b->header)_ogg_free(b->header);
635 if(b->header1)_ogg_free(b->header1);
636 if(b->header2)_ogg_free(b->header2);
644 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
646 return((double)granulepos/v->vi->rate);