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-2015 *
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.3.5"
35 #define ENCODE_VENDOR_STRING "Xiph.Org libVorbis I 20150105 (⛄⛄⛄⛄)"
38 static void _v_writestring(oggpack_buffer *o,const char *s, int bytes){
41 oggpack_write(o,*s++,8);
45 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
47 *buf++=oggpack_read(o,8);
51 void vorbis_comment_init(vorbis_comment *vc){
52 memset(vc,0,sizeof(*vc));
55 void vorbis_comment_add(vorbis_comment *vc,const char *comment){
56 vc->user_comments=_ogg_realloc(vc->user_comments,
57 (vc->comments+2)*sizeof(*vc->user_comments));
58 vc->comment_lengths=_ogg_realloc(vc->comment_lengths,
59 (vc->comments+2)*sizeof(*vc->comment_lengths));
60 vc->comment_lengths[vc->comments]=strlen(comment);
61 vc->user_comments[vc->comments]=_ogg_malloc(vc->comment_lengths[vc->comments]+1);
62 strcpy(vc->user_comments[vc->comments], comment);
64 vc->user_comments[vc->comments]=NULL;
67 void vorbis_comment_add_tag(vorbis_comment *vc, const char *tag, const char *contents){
68 /* Length for key and value +2 for = and \0 */
69 char *comment=_ogg_malloc(strlen(tag)+strlen(contents)+2);
72 strcat(comment, contents);
73 vorbis_comment_add(vc, comment);
77 /* This is more or less the same as strncasecmp - but that doesn't exist
78 * everywhere, and this is a fairly trivial function, so we include it */
79 static int tagcompare(const char *s1, const char *s2, int n){
82 if(toupper(s1[c]) != toupper(s2[c]))
89 char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count){
92 int taglen = strlen(tag)+1; /* +1 for the = we append */
93 char *fulltag = _ogg_malloc(taglen+1);
98 for(i=0;i<vc->comments;i++){
99 if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
101 /* We return a pointer to the data, not a copy */
103 return vc->user_comments[i] + taglen;
110 return NULL; /* didn't find anything */
113 int vorbis_comment_query_count(vorbis_comment *vc, const char *tag){
115 int taglen = strlen(tag)+1; /* +1 for the = we append */
116 char *fulltag = _ogg_malloc(taglen+1);
118 strcat(fulltag, "=");
120 for(i=0;i<vc->comments;i++){
121 if(!tagcompare(vc->user_comments[i], fulltag, taglen))
129 void vorbis_comment_clear(vorbis_comment *vc){
132 if(vc->user_comments){
133 for(i=0;i<vc->comments;i++)
134 if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
135 _ogg_free(vc->user_comments);
137 if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
138 if(vc->vendor)_ogg_free(vc->vendor);
139 memset(vc,0,sizeof(*vc));
143 /* blocksize 0 is guaranteed to be short, 1 is guaranteed to be long.
144 They may be equal, but short will never ge greater than long */
145 int vorbis_info_blocksize(vorbis_info *vi,int zo){
146 codec_setup_info *ci = vi->codec_setup;
147 return ci ? ci->blocksizes[zo] : -1;
150 /* used by synthesis, which has a full, alloced vi */
151 void vorbis_info_init(vorbis_info *vi){
152 memset(vi,0,sizeof(*vi));
153 vi->codec_setup=_ogg_calloc(1,sizeof(codec_setup_info));
156 void vorbis_info_clear(vorbis_info *vi){
157 codec_setup_info *ci=vi->codec_setup;
162 for(i=0;i<ci->modes;i++)
163 if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
165 for(i=0;i<ci->maps;i++) /* unpack does the range checking */
166 if(ci->map_param[i]) /* this may be cleaning up an aborted
167 unpack, in which case the below type
169 _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
171 for(i=0;i<ci->floors;i++) /* unpack does the range checking */
172 if(ci->floor_param[i]) /* this may be cleaning up an aborted
173 unpack, in which case the below type
175 _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
177 for(i=0;i<ci->residues;i++) /* unpack does the range checking */
178 if(ci->residue_param[i]) /* this may be cleaning up an aborted
179 unpack, in which case the below type
181 _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
183 for(i=0;i<ci->books;i++){
184 if(ci->book_param[i]){
185 /* knows if the book was not alloced */
186 vorbis_staticbook_destroy(ci->book_param[i]);
189 vorbis_book_clear(ci->fullbooks+i);
192 _ogg_free(ci->fullbooks);
194 for(i=0;i<ci->psys;i++)
195 _vi_psy_free(ci->psy_param[i]);
200 memset(vi,0,sizeof(*vi));
203 /* Header packing/unpacking ********************************************/
205 static int _vorbis_unpack_info(vorbis_info *vi,oggpack_buffer *opb){
206 codec_setup_info *ci=vi->codec_setup;
207 if(!ci)return(OV_EFAULT);
209 vi->version=oggpack_read(opb,32);
210 if(vi->version!=0)return(OV_EVERSION);
212 vi->channels=oggpack_read(opb,8);
213 vi->rate=oggpack_read(opb,32);
215 vi->bitrate_upper=oggpack_read(opb,32);
216 vi->bitrate_nominal=oggpack_read(opb,32);
217 vi->bitrate_lower=oggpack_read(opb,32);
219 ci->blocksizes[0]=1<<oggpack_read(opb,4);
220 ci->blocksizes[1]=1<<oggpack_read(opb,4);
222 if(vi->rate<1)goto err_out;
223 if(vi->channels<1)goto err_out;
224 if(ci->blocksizes[0]<64)goto err_out;
225 if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
226 if(ci->blocksizes[1]>8192)goto err_out;
228 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
232 vorbis_info_clear(vi);
233 return(OV_EBADHEADER);
236 static int _vorbis_unpack_comment(vorbis_comment *vc,oggpack_buffer *opb){
238 int vendorlen=oggpack_read(opb,32);
239 if(vendorlen<0)goto err_out;
240 if(vendorlen>opb->storage-8)goto err_out;
241 vc->vendor=_ogg_calloc(vendorlen+1,1);
242 _v_readstring(opb,vc->vendor,vendorlen);
243 i=oggpack_read(opb,32);
245 if(i>((opb->storage-oggpack_bytes(opb))>>2))goto err_out;
247 vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
248 vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
250 for(i=0;i<vc->comments;i++){
251 int len=oggpack_read(opb,32);
252 if(len<0)goto err_out;
253 if(len>opb->storage-oggpack_bytes(opb))goto err_out;
254 vc->comment_lengths[i]=len;
255 vc->user_comments[i]=_ogg_calloc(len+1,1);
256 _v_readstring(opb,vc->user_comments[i],len);
258 if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
262 vorbis_comment_clear(vc);
263 return(OV_EBADHEADER);
266 /* all of the real encoding details are here. The modes, books,
268 static int _vorbis_unpack_books(vorbis_info *vi,oggpack_buffer *opb){
269 codec_setup_info *ci=vi->codec_setup;
273 ci->books=oggpack_read(opb,8)+1;
274 if(ci->books<=0)goto err_out;
275 for(i=0;i<ci->books;i++){
276 ci->book_param[i]=vorbis_staticbook_unpack(opb);
277 if(!ci->book_param[i])goto err_out;
280 /* time backend settings; hooks are unused */
282 int times=oggpack_read(opb,6)+1;
283 if(times<=0)goto err_out;
284 for(i=0;i<times;i++){
285 int test=oggpack_read(opb,16);
286 if(test<0 || test>=VI_TIMEB)goto err_out;
290 /* floor backend settings */
291 ci->floors=oggpack_read(opb,6)+1;
292 if(ci->floors<=0)goto err_out;
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 if(ci->residues<=0)goto err_out;
303 for(i=0;i<ci->residues;i++){
304 ci->residue_type[i]=oggpack_read(opb,16);
305 if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
306 ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
307 if(!ci->residue_param[i])goto err_out;
310 /* map backend settings */
311 ci->maps=oggpack_read(opb,6)+1;
312 if(ci->maps<=0)goto err_out;
313 for(i=0;i<ci->maps;i++){
314 ci->map_type[i]=oggpack_read(opb,16);
315 if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
316 ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
317 if(!ci->map_param[i])goto err_out;
321 ci->modes=oggpack_read(opb,6)+1;
322 if(ci->modes<=0)goto err_out;
323 for(i=0;i<ci->modes;i++){
324 ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
325 ci->mode_param[i]->blockflag=oggpack_read(opb,1);
326 ci->mode_param[i]->windowtype=oggpack_read(opb,16);
327 ci->mode_param[i]->transformtype=oggpack_read(opb,16);
328 ci->mode_param[i]->mapping=oggpack_read(opb,8);
330 if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
331 if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
332 if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
333 if(ci->mode_param[i]->mapping<0)goto err_out;
336 if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
340 vorbis_info_clear(vi);
341 return(OV_EBADHEADER);
344 /* Is this packet a vorbis ID header? */
345 int vorbis_synthesis_idheader(ogg_packet *op){
350 oggpack_readinit(&opb,op->packet,op->bytes);
353 return(0); /* Not the initial packet */
355 if(oggpack_read(&opb,8) != 1)
356 return 0; /* not an ID header */
359 _v_readstring(&opb,buffer,6);
360 if(memcmp(buffer,"vorbis",6))
361 return 0; /* not vorbis */
369 /* The Vorbis header is in three packets; the initial small packet in
370 the first page that identifies basic parameters, a second packet
371 with bitstream comments and a third packet that holds the
374 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
378 oggpack_readinit(&opb,op->packet,op->bytes);
380 /* Which of the three types of header is this? */
381 /* Also verify header-ness, vorbis */
384 int packtype=oggpack_read(&opb,8);
386 _v_readstring(&opb,buffer,6);
387 if(memcmp(buffer,"vorbis",6)){
388 /* not a vorbis header */
389 return(OV_ENOTVORBIS);
392 case 0x01: /* least significant *bit* is read first */
394 /* Not the initial packet */
395 return(OV_EBADHEADER);
398 /* previously initialized info header */
399 return(OV_EBADHEADER);
402 return(_vorbis_unpack_info(vi,&opb));
404 case 0x03: /* least significant *bit* is read first */
406 /* um... we didn't get the initial header */
407 return(OV_EBADHEADER);
409 if(vc->vendor!=NULL){
410 /* previously initialized comment header */
411 return(OV_EBADHEADER);
414 return(_vorbis_unpack_comment(vc,&opb));
416 case 0x05: /* least significant *bit* is read first */
417 if(vi->rate==0 || vc->vendor==NULL){
418 /* um... we didn;t get the initial header or comments yet */
419 return(OV_EBADHEADER);
421 if(vi->codec_setup==NULL){
422 /* improperly initialized vorbis_info */
425 if(((codec_setup_info *)vi->codec_setup)->books>0){
426 /* previously initialized setup header */
427 return(OV_EBADHEADER);
430 return(_vorbis_unpack_books(vi,&opb));
433 /* Not a valid vorbis header type */
434 return(OV_EBADHEADER);
439 return(OV_EBADHEADER);
442 /* pack side **********************************************************/
444 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
445 codec_setup_info *ci=vi->codec_setup;
447 ci->blocksizes[0]<64||
448 ci->blocksizes[1]<ci->blocksizes[0]){
453 oggpack_write(opb,0x01,8);
454 _v_writestring(opb,"vorbis", 6);
456 /* basic information about the stream */
457 oggpack_write(opb,0x00,32);
458 oggpack_write(opb,vi->channels,8);
459 oggpack_write(opb,vi->rate,32);
461 oggpack_write(opb,vi->bitrate_upper,32);
462 oggpack_write(opb,vi->bitrate_nominal,32);
463 oggpack_write(opb,vi->bitrate_lower,32);
465 oggpack_write(opb,ov_ilog(ci->blocksizes[0]-1),4);
466 oggpack_write(opb,ov_ilog(ci->blocksizes[1]-1),4);
467 oggpack_write(opb,1,1);
472 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
473 int bytes = strlen(ENCODE_VENDOR_STRING);
476 oggpack_write(opb,0x03,8);
477 _v_writestring(opb,"vorbis", 6);
480 oggpack_write(opb,bytes,32);
481 _v_writestring(opb,ENCODE_VENDOR_STRING, bytes);
485 oggpack_write(opb,vc->comments,32);
488 for(i=0;i<vc->comments;i++){
489 if(vc->user_comments[i]){
490 oggpack_write(opb,vc->comment_lengths[i],32);
491 _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
493 oggpack_write(opb,0,32);
497 oggpack_write(opb,1,1);
502 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
503 codec_setup_info *ci=vi->codec_setup;
505 if(!ci)return(OV_EFAULT);
507 oggpack_write(opb,0x05,8);
508 _v_writestring(opb,"vorbis", 6);
511 oggpack_write(opb,ci->books-1,8);
512 for(i=0;i<ci->books;i++)
513 if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
515 /* times; hook placeholders */
516 oggpack_write(opb,0,6);
517 oggpack_write(opb,0,16);
520 oggpack_write(opb,ci->floors-1,6);
521 for(i=0;i<ci->floors;i++){
522 oggpack_write(opb,ci->floor_type[i],16);
523 if(_floor_P[ci->floor_type[i]]->pack)
524 _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
530 oggpack_write(opb,ci->residues-1,6);
531 for(i=0;i<ci->residues;i++){
532 oggpack_write(opb,ci->residue_type[i],16);
533 _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
537 oggpack_write(opb,ci->maps-1,6);
538 for(i=0;i<ci->maps;i++){
539 oggpack_write(opb,ci->map_type[i],16);
540 _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
544 oggpack_write(opb,ci->modes-1,6);
545 for(i=0;i<ci->modes;i++){
546 oggpack_write(opb,ci->mode_param[i]->blockflag,1);
547 oggpack_write(opb,ci->mode_param[i]->windowtype,16);
548 oggpack_write(opb,ci->mode_param[i]->transformtype,16);
549 oggpack_write(opb,ci->mode_param[i]->mapping,8);
551 oggpack_write(opb,1,1);
558 int vorbis_commentheader_out(vorbis_comment *vc,
563 oggpack_writeinit(&opb);
564 if(_vorbis_pack_comment(&opb,vc)){
565 oggpack_writeclear(&opb);
569 op->packet = _ogg_malloc(oggpack_bytes(&opb));
570 memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
572 op->bytes=oggpack_bytes(&opb);
578 oggpack_writeclear(&opb);
582 int vorbis_analysis_headerout(vorbis_dsp_state *v,
586 ogg_packet *op_code){
588 vorbis_info *vi=v->vi;
590 private_state *b=v->backend_state;
592 if(!b||vi->channels<=0){
597 /* first header packet **********************************************/
599 oggpack_writeinit(&opb);
600 if(_vorbis_pack_info(&opb,vi))goto err_out;
602 /* build the packet */
603 if(b->header)_ogg_free(b->header);
604 b->header=_ogg_malloc(oggpack_bytes(&opb));
605 memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
606 op->packet=b->header;
607 op->bytes=oggpack_bytes(&opb);
613 /* second header packet (comments) **********************************/
616 if(_vorbis_pack_comment(&opb,vc))goto err_out;
618 if(b->header1)_ogg_free(b->header1);
619 b->header1=_ogg_malloc(oggpack_bytes(&opb));
620 memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
621 op_comm->packet=b->header1;
622 op_comm->bytes=oggpack_bytes(&opb);
625 op_comm->granulepos=0;
628 /* third header packet (modes/codebooks) ****************************/
631 if(_vorbis_pack_books(&opb,vi))goto err_out;
633 if(b->header2)_ogg_free(b->header2);
634 b->header2=_ogg_malloc(oggpack_bytes(&opb));
635 memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
636 op_code->packet=b->header2;
637 op_code->bytes=oggpack_bytes(&opb);
640 op_code->granulepos=0;
643 oggpack_writeclear(&opb);
646 memset(op,0,sizeof(*op));
647 memset(op_comm,0,sizeof(*op_comm));
648 memset(op_code,0,sizeof(*op_code));
651 oggpack_writeclear(&opb);
652 if(b->header)_ogg_free(b->header);
653 if(b->header1)_ogg_free(b->header1);
654 if(b->header2)_ogg_free(b->header2);
662 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
663 if(granulepos == -1) return -1;
665 /* We're not guaranteed a 64 bit unsigned type everywhere, so we
666 have to put the unsigned granpo in a signed type. */
668 return((double)granulepos/v->vi->rate);
670 ogg_int64_t granuleoff=0xffffffff;
672 granuleoff|=0x7ffffffff;
673 return(((double)granulepos+2+granuleoff+granuleoff)/v->vi->rate);
677 const char *vorbis_version_string(void){
678 return GENERAL_VENDOR_STRING;