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-2003 *
9 * by the XIPHOPHORUS Company 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,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,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, char *tag, 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, 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, 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;
226 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
230 vorbis_info_clear(vi);
231 return(OV_EBADHEADER);
234 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
236 int vendorlen=oggpack_read(opb,32);
237 if(vendorlen<0)goto err_out;
238 vc->vendor=_ogg_calloc(vendorlen+1,1);
239 _v_readstring(opb,vc->vendor,vendorlen);
240 vc->comments=oggpack_read(opb,32);
241 if(vc->comments<0)goto err_out;
242 vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
243 vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
245 for(i=0;i<vc->comments;i++){
246 int len=oggpack_read(opb,32);
247 if(len<0)goto err_out;
248 vc->comment_lengths[i]=len;
249 vc->user_comments[i]=_ogg_calloc(len+1,1);
250 _v_readstring(opb,vc->user_comments[i],len);
252 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
256 vorbis_comment_clear(vc);
257 return(OV_EBADHEADER);
260 /* all of the real encoding details are here. The modes, books,
262 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
263 codec_setup_info *ci=vi->codec_setup;
265 if(!ci)return(OV_EFAULT);
268 ci->books=oggpack_read(opb,8)+1;
269 /*ci->book_param=_ogg_calloc(ci->books,sizeof(*ci->book_param));*/
270 for(i=0;i<ci->books;i++){
271 ci->book_param[i]=_ogg_calloc(1,sizeof(*ci->book_param[i]));
272 if(vorbis_staticbook_unpack(opb,ci->book_param[i]))goto err_out;
275 /* time backend settings; hooks are unused */
277 int times=oggpack_read(opb,6)+1;
278 for(i=0;i<times;i++){
279 int test=oggpack_read(opb,16);
280 if(test<0 || test>=VI_TIMEB)goto err_out;
284 /* floor backend settings */
285 ci->floors=oggpack_read(opb,6)+1;
286 /*ci->floor_type=_ogg_malloc(ci->floors*sizeof(*ci->floor_type));*/
287 /*ci->floor_param=_ogg_calloc(ci->floors,sizeof(void *));*/
288 for(i=0;i<ci->floors;i++){
289 ci->floor_type[i]=oggpack_read(opb,16);
290 if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
291 ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
292 if(!ci->floor_param[i])goto err_out;
295 /* residue backend settings */
296 ci->residues=oggpack_read(opb,6)+1;
297 /*ci->residue_type=_ogg_malloc(ci->residues*sizeof(*ci->residue_type));*/
298 /*ci->residue_param=_ogg_calloc(ci->residues,sizeof(void *));*/
299 for(i=0;i<ci->residues;i++){
300 ci->residue_type[i]=oggpack_read(opb,16);
301 if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
302 ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
303 if(!ci->residue_param[i])goto err_out;
306 /* map backend settings */
307 ci->maps=oggpack_read(opb,6)+1;
308 /*ci->map_type=_ogg_malloc(ci->maps*sizeof(*ci->map_type));*/
309 /*ci->map_param=_ogg_calloc(ci->maps,sizeof(void *));*/
310 for(i=0;i<ci->maps;i++){
311 ci->map_type[i]=oggpack_read(opb,16);
312 if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
313 ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
314 if(!ci->map_param[i])goto err_out;
318 ci->modes=oggpack_read(opb,6)+1;
319 /*vi->mode_param=_ogg_calloc(vi->modes,sizeof(void *));*/
320 for(i=0;i<ci->modes;i++){
321 ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
322 ci->mode_param[i]->blockflag=oggpack_read(opb,1);
323 ci->mode_param[i]->windowtype=oggpack_read(opb,16);
324 ci->mode_param[i]->transformtype=oggpack_read(opb,16);
325 ci->mode_param[i]->mapping=oggpack_read(opb,8);
327 if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
328 if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
329 if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
332 if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
336 vorbis_info_clear(vi);
337 return(OV_EBADHEADER);
340 /* The Vorbis header is in three packets; the initial small packet in
341 the first page that identifies basic parameters, a second packet
342 with bitstream comments and a third packet that holds the
345 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
349 oggpack_readinit(&opb,op->packet,op->bytes);
351 /* Which of the three types of header is this? */
352 /* Also verify header-ness, vorbis */
355 int packtype=oggpack_read(&opb,8);
357 _v_readstring(&opb,buffer,6);
358 if(memcmp(buffer,"vorbis",6)){
359 /* not a vorbis header */
360 return(OV_ENOTVORBIS);
363 case 0x01: /* least significant *bit* is read first */
365 /* Not the initial packet */
366 return(OV_EBADHEADER);
369 /* previously initialized info header */
370 return(OV_EBADHEADER);
373 return(_vorbis_unpack_info(vi,&opb));
375 case 0x03: /* least significant *bit* is read first */
377 /* um... we didn't get the initial header */
378 return(OV_EBADHEADER);
381 return(_vorbis_unpack_comment(vc,&opb));
383 case 0x05: /* least significant *bit* is read first */
384 if(vi->rate==0 || vc->vendor==NULL){
385 /* um... we didn;t get the initial header or comments yet */
386 return(OV_EBADHEADER);
389 return(_vorbis_unpack_books(vi,&opb));
392 /* Not a valid vorbis header type */
393 return(OV_EBADHEADER);
398 return(OV_EBADHEADER);
401 /* pack side **********************************************************/
403 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
404 codec_setup_info *ci=vi->codec_setup;
405 if(!ci)return(OV_EFAULT);
408 oggpack_write(opb,0x01,8);
409 _v_writestring(opb,"vorbis", 6);
411 /* basic information about the stream */
412 oggpack_write(opb,0x00,32);
413 oggpack_write(opb,vi->channels,8);
414 oggpack_write(opb,vi->rate,32);
416 oggpack_write(opb,vi->bitrate_upper,32);
417 oggpack_write(opb,vi->bitrate_nominal,32);
418 oggpack_write(opb,vi->bitrate_lower,32);
420 oggpack_write(opb,ilog2(ci->blocksizes[0]),4);
421 oggpack_write(opb,ilog2(ci->blocksizes[1]),4);
422 oggpack_write(opb,1,1);
427 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
428 char temp[]="Xiph.Org libVorbis I 20070621";
429 int bytes = strlen(temp);
432 oggpack_write(opb,0x03,8);
433 _v_writestring(opb,"vorbis", 6);
436 oggpack_write(opb,bytes,32);
437 _v_writestring(opb,temp, bytes);
441 oggpack_write(opb,vc->comments,32);
444 for(i=0;i<vc->comments;i++){
445 if(vc->user_comments[i]){
446 oggpack_write(opb,vc->comment_lengths[i],32);
447 _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
449 oggpack_write(opb,0,32);
453 oggpack_write(opb,1,1);
458 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
459 codec_setup_info *ci=vi->codec_setup;
461 if(!ci)return(OV_EFAULT);
463 oggpack_write(opb,0x05,8);
464 _v_writestring(opb,"vorbis", 6);
467 oggpack_write(opb,ci->books-1,8);
468 for(i=0;i<ci->books;i++)
469 if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
471 /* times; hook placeholders */
472 oggpack_write(opb,0,6);
473 oggpack_write(opb,0,16);
476 oggpack_write(opb,ci->floors-1,6);
477 for(i=0;i<ci->floors;i++){
478 oggpack_write(opb,ci->floor_type[i],16);
479 if(_floor_P[ci->floor_type[i]]->pack)
480 _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
486 oggpack_write(opb,ci->residues-1,6);
487 for(i=0;i<ci->residues;i++){
488 oggpack_write(opb,ci->residue_type[i],16);
489 _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
493 oggpack_write(opb,ci->maps-1,6);
494 for(i=0;i<ci->maps;i++){
495 oggpack_write(opb,ci->map_type[i],16);
496 _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
500 oggpack_write(opb,ci->modes-1,6);
501 for(i=0;i<ci->modes;i++){
502 oggpack_write(opb,ci->mode_param[i]->blockflag,1);
503 oggpack_write(opb,ci->mode_param[i]->windowtype,16);
504 oggpack_write(opb,ci->mode_param[i]->transformtype,16);
505 oggpack_write(opb,ci->mode_param[i]->mapping,8);
507 oggpack_write(opb,1,1);
514 int vorbis_commentheader_out(vorbis_comment *vc,
519 oggpack_writeinit(&opb);
520 if(_vorbis_pack_comment(&opb,vc)) return OV_EIMPL;
522 op->packet = _ogg_malloc(oggpack_bytes(&opb));
523 memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
525 op->bytes=oggpack_bytes(&opb);
534 int vorbis_analysis_headerout(vorbis_dsp_state *v,
538 ogg_packet *op_code){
540 vorbis_info *vi=v->vi;
542 private_state *b=v->backend_state;
549 /* first header packet **********************************************/
551 oggpack_writeinit(&opb);
552 if(_vorbis_pack_info(&opb,vi))goto err_out;
554 /* build the packet */
555 if(b->header)_ogg_free(b->header);
556 b->header=_ogg_malloc(oggpack_bytes(&opb));
557 memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
558 op->packet=b->header;
559 op->bytes=oggpack_bytes(&opb);
565 /* second header packet (comments) **********************************/
568 if(_vorbis_pack_comment(&opb,vc))goto err_out;
570 if(b->header1)_ogg_free(b->header1);
571 b->header1=_ogg_malloc(oggpack_bytes(&opb));
572 memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
573 op_comm->packet=b->header1;
574 op_comm->bytes=oggpack_bytes(&opb);
577 op_comm->granulepos=0;
580 /* third header packet (modes/codebooks) ****************************/
583 if(_vorbis_pack_books(&opb,vi))goto err_out;
585 if(b->header2)_ogg_free(b->header2);
586 b->header2=_ogg_malloc(oggpack_bytes(&opb));
587 memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
588 op_code->packet=b->header2;
589 op_code->bytes=oggpack_bytes(&opb);
592 op_code->granulepos=0;
595 oggpack_writeclear(&opb);
598 oggpack_writeclear(&opb);
599 memset(op,0,sizeof(*op));
600 memset(op_comm,0,sizeof(*op_comm));
601 memset(op_code,0,sizeof(*op_code));
604 if(b->header)_ogg_free(b->header);
605 if(b->header1)_ogg_free(b->header1);
606 if(b->header2)_ogg_free(b->header2);
614 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
616 return((double)granulepos/v->vi->rate);