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"
34 #define GENERAL_VENDOR_STRING "Xiph.Org libVorbis 1.2.2"
35 #define ENCODE_VENDOR_STRING "Xiph.Org libVorbis I 20081127"
38 static int ilog2(unsigned int v){
48 static void _v_writestring(oggpack_buffer *o,const char *s, int bytes){
51 oggpack_write(o,*s++,8);
55 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
57 *buf++=oggpack_read(o,8);
61 void vorbis_comment_init(vorbis_comment *vc){
62 memset(vc,0,sizeof(*vc));
65 void vorbis_comment_add(vorbis_comment *vc,const char *comment){
66 vc->user_comments=_ogg_realloc(vc->user_comments,
67 (vc->comments+2)*sizeof(*vc->user_comments));
68 vc->comment_lengths=_ogg_realloc(vc->comment_lengths,
69 (vc->comments+2)*sizeof(*vc->comment_lengths));
70 vc->comment_lengths[vc->comments]=strlen(comment);
71 vc->user_comments[vc->comments]=_ogg_malloc(vc->comment_lengths[vc->comments]+1);
72 strcpy(vc->user_comments[vc->comments], comment);
74 vc->user_comments[vc->comments]=NULL;
77 void vorbis_comment_add_tag(vorbis_comment *vc, const char *tag, const char *contents){
78 char *comment=alloca(strlen(tag)+strlen(contents)+2); /* +2 for = and \0 */
81 strcat(comment, contents);
82 vorbis_comment_add(vc, comment);
85 /* This is more or less the same as strncasecmp - but that doesn't exist
86 * everywhere, and this is a fairly trivial function, so we include it */
87 static int tagcompare(const char *s1, const char *s2, int n){
90 if(toupper(s1[c]) != toupper(s2[c]))
97 char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count){
100 int taglen = strlen(tag)+1; /* +1 for the = we append */
101 char *fulltag = alloca(taglen+ 1);
103 strcpy(fulltag, tag);
104 strcat(fulltag, "=");
106 for(i=0;i<vc->comments;i++){
107 if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
109 /* We return a pointer to the data, not a copy */
110 return vc->user_comments[i] + taglen;
115 return NULL; /* didn't find anything */
118 int vorbis_comment_query_count(vorbis_comment *vc, const char *tag){
120 int taglen = strlen(tag)+1; /* +1 for the = we append */
121 char *fulltag = alloca(taglen+1);
123 strcat(fulltag, "=");
125 for(i=0;i<vc->comments;i++){
126 if(!tagcompare(vc->user_comments[i], fulltag, taglen))
133 void vorbis_comment_clear(vorbis_comment *vc){
136 if(vc->user_comments){
137 for(i=0;i<vc->comments;i++)
138 if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
139 _ogg_free(vc->user_comments);
141 if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
142 if(vc->vendor)_ogg_free(vc->vendor);
143 memset(vc,0,sizeof(*vc));
147 /* blocksize 0 is guaranteed to be short, 1 is guaranteed to be long.
148 They may be equal, but short will never ge greater than long */
149 int vorbis_info_blocksize(vorbis_info *vi,int zo){
150 codec_setup_info *ci = vi->codec_setup;
151 return ci ? ci->blocksizes[zo] : -1;
154 /* used by synthesis, which has a full, alloced vi */
155 void vorbis_info_init(vorbis_info *vi){
156 memset(vi,0,sizeof(*vi));
157 vi->codec_setup=_ogg_calloc(1,sizeof(codec_setup_info));
160 void vorbis_info_clear(vorbis_info *vi){
161 codec_setup_info *ci=vi->codec_setup;
166 for(i=0;i<ci->modes;i++)
167 if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
169 for(i=0;i<ci->maps;i++) /* unpack does the range checking */
170 if(ci->map_param[i]) /* this may be cleaning up an aborted
171 unpack, in which case the below type
173 _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
175 for(i=0;i<ci->floors;i++) /* unpack does the range checking */
176 if(ci->floor_param[i]) /* this may be cleaning up an aborted
177 unpack, in which case the below type
179 _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
181 for(i=0;i<ci->residues;i++) /* unpack does the range checking */
182 if(ci->residue_param[i]) /* this may be cleaning up an aborted
183 unpack, in which case the below type
185 _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
187 for(i=0;i<ci->books;i++){
188 if(ci->book_param[i]){
189 /* knows if the book was not alloced */
190 vorbis_staticbook_destroy(ci->book_param[i]);
193 vorbis_book_clear(ci->fullbooks+i);
196 _ogg_free(ci->fullbooks);
198 for(i=0;i<ci->psys;i++)
199 _vi_psy_free(ci->psy_param[i]);
204 memset(vi,0,sizeof(*vi));
207 /* Header packing/unpacking ********************************************/
209 static int _vorbis_unpack_info(vorbis_info *vi,oggpack_buffer *opb){
210 codec_setup_info *ci=vi->codec_setup;
211 if(!ci)return(OV_EFAULT);
213 vi->version=oggpack_read(opb,32);
214 if(vi->version!=0)return(OV_EVERSION);
216 vi->channels=oggpack_read(opb,8);
217 vi->rate=oggpack_read(opb,32);
219 vi->bitrate_upper=oggpack_read(opb,32);
220 vi->bitrate_nominal=oggpack_read(opb,32);
221 vi->bitrate_lower=oggpack_read(opb,32);
223 ci->blocksizes[0]=1<<oggpack_read(opb,4);
224 ci->blocksizes[1]=1<<oggpack_read(opb,4);
226 if(vi->rate<1)goto err_out;
227 if(vi->channels<1)goto err_out;
228 if(ci->blocksizes[0]<64)goto err_out;
229 if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
230 if(ci->blocksizes[1]>8192)goto err_out;
232 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
236 vorbis_info_clear(vi);
237 return(OV_EBADHEADER);
240 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
242 int vendorlen=oggpack_read(opb,32);
243 if(vendorlen<0)goto err_out;
244 if(vendorlen+8>opb->storage)goto err_out;
245 vc->vendor=_ogg_calloc(vendorlen+1,1);
246 _v_readstring(opb,vc->vendor,vendorlen);
247 i=oggpack_read(opb,32);
249 if(4*i+oggpack_bytes(opb)>opb->storage)goto err_out;
251 vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
252 vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
254 for(i=0;i<vc->comments;i++){
255 int len=oggpack_read(opb,32);
256 if(len<0)goto err_out;
257 if(len+oggpack_bytes(opb)>opb->storage)goto err_out;
258 vc->comment_lengths[i]=len;
259 vc->user_comments[i]=_ogg_calloc(len+1,1);
260 _v_readstring(opb,vc->user_comments[i],len);
262 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
266 vorbis_comment_clear(vc);
267 return(OV_EBADHEADER);
270 /* all of the real encoding details are here. The modes, books,
272 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
273 codec_setup_info *ci=vi->codec_setup;
275 if(!ci)return(OV_EFAULT);
278 ci->books=oggpack_read(opb,8)+1;
279 /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
280 for(i=0;i<ci->books;i++){
281 ci->book_param[i]=_ogg_calloc(1,sizeof(*ci->book_param[i]));
282 if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
285 /* time backend settings; hooks are unused */
287 int times=oggpack_read(opb,6)+1;
288 for(i=0;i<times;i++){
289 int test=oggpack_read(opb,16);
290 if(test<0 || test>=VI_TIMEB)goto err_out;
294 /* floor backend settings */
295 ci->floors=oggpack_read(opb,6)+1;
296 /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
297 /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
298 for(i=0;i<ci->floors;i++){
299 ci->floor_type[i]=oggpack_read(opb,16);
300 if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
301 ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
302 if(!ci->floor_param[i])goto err_out;
305 /* residue backend settings */
306 ci->residues=oggpack_read(opb,6)+1;
307 /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
308 /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
309 for(i=0;i<ci->residues;i++){
310 ci->residue_type[i]=oggpack_read(opb,16);
311 if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
312 ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
313 if(!ci->residue_param[i])goto err_out;
316 /* map backend settings */
317 ci->maps=oggpack_read(opb,6)+1;
318 /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
319 /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
320 for(i=0;i<ci->maps;i++){
321 ci->map_type[i]=oggpack_read(opb,16);
322 if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
323 ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
324 if(!ci->map_param[i])goto err_out;
328 ci->modes=oggpack_read(opb,6)+1;
329 /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
330 for(i=0;i<ci->modes;i++){
331 ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
332 ci->mode_param[i]->blockflag=oggpack_read(opb,1);
333 ci->mode_param[i]->windowtype=oggpack_read(opb,16);
334 ci->mode_param[i]->transformtype=oggpack_read(opb,16);
335 ci->mode_param[i]->mapping=oggpack_read(opb,8);
337 if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
338 if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
339 if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
342 if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
346 vorbis_info_clear(vi);
347 return(OV_EBADHEADER);
350 /* Is this packet a vorbis ID header? */
351 int vorbis_synthesis_idheader(ogg_packet *op){
356 oggpack_readinit(&opb,op->packet,op->bytes);
359 return(0); /* Not the initial packet */
361 if(oggpack_read(&opb,8) != 1)
362 return 0; /* not an ID header */
365 _v_readstring(&opb,buffer,6);
366 if(memcmp(buffer,"vorbis",6))
367 return 0; /* not vorbis */
375 /* The Vorbis header is in three packets; the initial small packet in
376 the first page that identifies basic parameters, a second packet
377 with bitstream comments and a third packet that holds the
380 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
384 oggpack_readinit(&opb,op->packet,op->bytes);
386 /* Which of the three types of header is this? */
387 /* Also verify header-ness, vorbis */
390 int packtype=oggpack_read(&opb,8);
392 _v_readstring(&opb,buffer,6);
393 if(memcmp(buffer,"vorbis",6)){
394 /* not a vorbis header */
395 return(OV_ENOTVORBIS);
398 case 0x01: /* least significant *bit* is read first */
400 /* Not the initial packet */
401 return(OV_EBADHEADER);
404 /* previously initialized info header */
405 return(OV_EBADHEADER);
408 return(_vorbis_unpack_info(vi,&opb));
410 case 0x03: /* least significant *bit* is read first */
412 /* um... we didn't get the initial header */
413 return(OV_EBADHEADER);
416 return(_vorbis_unpack_comment(vc,&opb));
418 case 0x05: /* least significant *bit* is read first */
419 if(vi->rate==0 || vc->vendor==NULL){
420 /* um... we didn;t get the initial header or comments yet */
421 return(OV_EBADHEADER);
424 return(_vorbis_unpack_books(vi,&opb));
427 /* Not a valid vorbis header type */
428 return(OV_EBADHEADER);
433 return(OV_EBADHEADER);
436 /* pack side **********************************************************/
438 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
439 codec_setup_info *ci=vi->codec_setup;
440 if(!ci)return(OV_EFAULT);
443 oggpack_write(opb,0x01,8);
444 _v_writestring(opb,"vorbis", 6);
446 /* basic information about the stream */
447 oggpack_write(opb,0x00,32);
448 oggpack_write(opb,vi->channels,8);
449 oggpack_write(opb,vi->rate,32);
451 oggpack_write(opb,vi->bitrate_upper,32);
452 oggpack_write(opb,vi->bitrate_nominal,32);
453 oggpack_write(opb,vi->bitrate_lower,32);
455 oggpack_write(opb,ilog2(ci->blocksizes[0]),4);
456 oggpack_write(opb,ilog2(ci->blocksizes[1]),4);
457 oggpack_write(opb,1,1);
462 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
463 int bytes = strlen(ENCODE_VENDOR_STRING);
466 oggpack_write(opb,0x03,8);
467 _v_writestring(opb,"vorbis", 6);
470 oggpack_write(opb,bytes,32);
471 _v_writestring(opb,ENCODE_VENDOR_STRING, bytes);
475 oggpack_write(opb,vc->comments,32);
478 for(i=0;i<vc->comments;i++){
479 if(vc->user_comments[i]){
480 oggpack_write(opb,vc->comment_lengths[i],32);
481 _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
483 oggpack_write(opb,0,32);
487 oggpack_write(opb,1,1);
492 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
493 codec_setup_info *ci=vi->codec_setup;
495 if(!ci)return(OV_EFAULT);
497 oggpack_write(opb,0x05,8);
498 _v_writestring(opb,"vorbis", 6);
501 oggpack_write(opb,ci->books-1,8);
502 for(i=0;i<ci->books;i++)
503 if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
505 /* times; hook placeholders */
506 oggpack_write(opb,0,6);
507 oggpack_write(opb,0,16);
510 oggpack_write(opb,ci->floors-1,6);
511 for(i=0;i<ci->floors;i++){
512 oggpack_write(opb,ci->floor_type[i],16);
513 if(_floor_P[ci->floor_type[i]]->pack)
514 _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
520 oggpack_write(opb,ci->residues-1,6);
521 for(i=0;i<ci->residues;i++){
522 oggpack_write(opb,ci->residue_type[i],16);
523 _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
527 oggpack_write(opb,ci->maps-1,6);
528 for(i=0;i<ci->maps;i++){
529 oggpack_write(opb,ci->map_type[i],16);
530 _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
534 oggpack_write(opb,ci->modes-1,6);
535 for(i=0;i<ci->modes;i++){
536 oggpack_write(opb,ci->mode_param[i]->blockflag,1);
537 oggpack_write(opb,ci->mode_param[i]->windowtype,16);
538 oggpack_write(opb,ci->mode_param[i]->transformtype,16);
539 oggpack_write(opb,ci->mode_param[i]->mapping,8);
541 oggpack_write(opb,1,1);
548 int vorbis_commentheader_out(vorbis_comment *vc,
553 oggpack_writeinit(&opb);
554 if(_vorbis_pack_comment(&opb,vc)) return OV_EIMPL;
556 op->packet = _ogg_malloc(oggpack_bytes(&opb));
557 memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
559 op->bytes=oggpack_bytes(&opb);
568 int vorbis_analysis_headerout(vorbis_dsp_state *v,
572 ogg_packet *op_code){
574 vorbis_info *vi=v->vi;
576 private_state *b=v->backend_state;
583 /* first header packet **********************************************/
585 oggpack_writeinit(&opb);
586 if(_vorbis_pack_info(&opb,vi))goto err_out;
588 /* build the packet */
589 if(b->header)_ogg_free(b->header);
590 b->header=_ogg_malloc(oggpack_bytes(&opb));
591 memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
592 op->packet=b->header;
593 op->bytes=oggpack_bytes(&opb);
599 /* second header packet (comments) **********************************/
602 if(_vorbis_pack_comment(&opb,vc))goto err_out;
604 if(b->header1)_ogg_free(b->header1);
605 b->header1=_ogg_malloc(oggpack_bytes(&opb));
606 memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
607 op_comm->packet=b->header1;
608 op_comm->bytes=oggpack_bytes(&opb);
611 op_comm->granulepos=0;
614 /* third header packet (modes/codebooks) ****************************/
617 if(_vorbis_pack_books(&opb,vi))goto err_out;
619 if(b->header2)_ogg_free(b->header2);
620 b->header2=_ogg_malloc(oggpack_bytes(&opb));
621 memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
622 op_code->packet=b->header2;
623 op_code->bytes=oggpack_bytes(&opb);
626 op_code->granulepos=0;
629 oggpack_writeclear(&opb);
632 oggpack_writeclear(&opb);
633 memset(op,0,sizeof(*op));
634 memset(op_comm,0,sizeof(*op_comm));
635 memset(op_code,0,sizeof(*op_code));
638 if(b->header)_ogg_free(b->header);
639 if(b->header1)_ogg_free(b->header1);
640 if(b->header2)_ogg_free(b->header2);
648 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
650 return((double)granulepos/v->vi->rate);
654 const char *vorbis_version_string(void){
655 return GENERAL_VENDOR_STRING;