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
15 ********************************************************************/
17 /* general handling of the header and the vorbis_info structure (and
24 #include "vorbis/codec.h"
25 #include "codec_internal.h"
33 #define GENERAL_VENDOR_STRING "Xiph.Org libVorbis 1.3.6"
34 #define ENCODE_VENDOR_STRING "Xiph.Org libVorbis I 20180316 (Now 100% fewer shells)"
37 static void _v_writestring(oggpack_buffer *o,const char *s, int bytes){
40 oggpack_write(o,*s++,8);
44 static void _v_readstring(oggpack_buffer *o,char *buf,int bytes){
46 *buf++=oggpack_read(o,8);
50 void vorbis_comment_init(vorbis_comment *vc){
51 memset(vc,0,sizeof(*vc));
54 void vorbis_comment_add(vorbis_comment *vc,const char *comment){
55 vc->user_comments=_ogg_realloc(vc->user_comments,
56 (vc->comments+2)*sizeof(*vc->user_comments));
57 vc->comment_lengths=_ogg_realloc(vc->comment_lengths,
58 (vc->comments+2)*sizeof(*vc->comment_lengths));
59 vc->comment_lengths[vc->comments]=strlen(comment);
60 vc->user_comments[vc->comments]=_ogg_malloc(vc->comment_lengths[vc->comments]+1);
61 strcpy(vc->user_comments[vc->comments], comment);
63 vc->user_comments[vc->comments]=NULL;
66 void vorbis_comment_add_tag(vorbis_comment *vc, const char *tag, const char *contents){
67 /* Length for key and value +2 for = and \0 */
68 char *comment=_ogg_malloc(strlen(tag)+strlen(contents)+2);
71 strcat(comment, contents);
72 vorbis_comment_add(vc, comment);
76 /* This is more or less the same as strncasecmp - but that doesn't exist
77 * everywhere, and this is a fairly trivial function, so we include it */
78 static int tagcompare(const char *s1, const char *s2, int n){
81 if(toupper(s1[c]) != toupper(s2[c]))
88 char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count){
91 int taglen = strlen(tag)+1; /* +1 for the = we append */
92 char *fulltag = _ogg_malloc(taglen+1);
97 for(i=0;i<vc->comments;i++){
98 if(!tagcompare(vc->user_comments[i], fulltag, taglen)){
100 /* We return a pointer to the data, not a copy */
102 return vc->user_comments[i] + taglen;
109 return NULL; /* didn't find anything */
112 int vorbis_comment_query_count(vorbis_comment *vc, const char *tag){
114 int taglen = strlen(tag)+1; /* +1 for the = we append */
115 char *fulltag = _ogg_malloc(taglen+1);
117 strcat(fulltag, "=");
119 for(i=0;i<vc->comments;i++){
120 if(!tagcompare(vc->user_comments[i], fulltag, taglen))
128 void vorbis_comment_clear(vorbis_comment *vc){
131 if(vc->user_comments){
132 for(i=0;i<vc->comments;i++)
133 if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
134 _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;
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=(ogg_int32_t)oggpack_read(opb,32);
216 vi->bitrate_nominal=(ogg_int32_t)oggpack_read(opb,32);
217 vi->bitrate_lower=(ogg_int32_t)oggpack_read(opb,32);
219 bs = oggpack_read(opb,4);
220 if(bs<0)goto err_out;
221 ci->blocksizes[0]=1<<bs;
222 bs = oggpack_read(opb,4);
223 if(bs<0)goto err_out;
224 ci->blocksizes[1]=1<<bs;
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>opb->storage-8)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(i>((opb->storage-oggpack_bytes(opb))>>2))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>opb->storage-oggpack_bytes(opb))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;
277 ci->books=oggpack_read(opb,8)+1;
278 if(ci->books<=0)goto err_out;
279 for(i=0;i<ci->books;i++){
280 ci->book_param[i]=vorbis_staticbook_unpack(opb);
281 if(!ci->book_param[i])goto err_out;
284 /* time backend settings; hooks are unused */
286 int times=oggpack_read(opb,6)+1;
287 if(times<=0)goto err_out;
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 if(ci->floors<=0)goto err_out;
297 for(i=0;i<ci->floors;i++){
298 ci->floor_type[i]=oggpack_read(opb,16);
299 if(ci->floor_type[i]<0 || ci->floor_type[i]>=VI_FLOORB)goto err_out;
300 ci->floor_param[i]=_floor_P[ci->floor_type[i]]->unpack(vi,opb);
301 if(!ci->floor_param[i])goto err_out;
304 /* residue backend settings */
305 ci->residues=oggpack_read(opb,6)+1;
306 if(ci->residues<=0)goto err_out;
307 for(i=0;i<ci->residues;i++){
308 ci->residue_type[i]=oggpack_read(opb,16);
309 if(ci->residue_type[i]<0 || ci->residue_type[i]>=VI_RESB)goto err_out;
310 ci->residue_param[i]=_residue_P[ci->residue_type[i]]->unpack(vi,opb);
311 if(!ci->residue_param[i])goto err_out;
314 /* map backend settings */
315 ci->maps=oggpack_read(opb,6)+1;
316 if(ci->maps<=0)goto err_out;
317 for(i=0;i<ci->maps;i++){
318 ci->map_type[i]=oggpack_read(opb,16);
319 if(ci->map_type[i]<0 || ci->map_type[i]>=VI_MAPB)goto err_out;
320 ci->map_param[i]=_mapping_P[ci->map_type[i]]->unpack(vi,opb);
321 if(!ci->map_param[i])goto err_out;
325 ci->modes=oggpack_read(opb,6)+1;
326 if(ci->modes<=0)goto err_out;
327 for(i=0;i<ci->modes;i++){
328 ci->mode_param[i]=_ogg_calloc(1,sizeof(*ci->mode_param[i]));
329 ci->mode_param[i]->blockflag=oggpack_read(opb,1);
330 ci->mode_param[i]->windowtype=oggpack_read(opb,16);
331 ci->mode_param[i]->transformtype=oggpack_read(opb,16);
332 ci->mode_param[i]->mapping=oggpack_read(opb,8);
334 if(ci->mode_param[i]->windowtype>=VI_WINDOWB)goto err_out;
335 if(ci->mode_param[i]->transformtype>=VI_WINDOWB)goto err_out;
336 if(ci->mode_param[i]->mapping>=ci->maps)goto err_out;
337 if(ci->mode_param[i]->mapping<0)goto err_out;
340 if(oggpack_read(opb,1)!=1)goto err_out; /* top level EOP check */
344 vorbis_info_clear(vi);
345 return(OV_EBADHEADER);
348 /* Is this packet a vorbis ID header? */
349 int vorbis_synthesis_idheader(ogg_packet *op){
354 oggpack_readinit(&opb,op->packet,op->bytes);
357 return(0); /* Not the initial packet */
359 if(oggpack_read(&opb,8) != 1)
360 return 0; /* not an ID header */
363 _v_readstring(&opb,buffer,6);
364 if(memcmp(buffer,"vorbis",6))
365 return 0; /* not vorbis */
373 /* The Vorbis header is in three packets; the initial small packet in
374 the first page that identifies basic parameters, a second packet
375 with bitstream comments and a third packet that holds the
378 int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,ogg_packet *op){
382 oggpack_readinit(&opb,op->packet,op->bytes);
384 /* Which of the three types of header is this? */
385 /* Also verify header-ness, vorbis */
388 int packtype=oggpack_read(&opb,8);
390 _v_readstring(&opb,buffer,6);
391 if(memcmp(buffer,"vorbis",6)){
392 /* not a vorbis header */
393 return(OV_ENOTVORBIS);
396 case 0x01: /* least significant *bit* is read first */
398 /* Not the initial packet */
399 return(OV_EBADHEADER);
402 /* previously initialized info header */
403 return(OV_EBADHEADER);
406 return(_vorbis_unpack_info(vi,&opb));
408 case 0x03: /* least significant *bit* is read first */
410 /* um... we didn't get the initial header */
411 return(OV_EBADHEADER);
413 if(vc->vendor!=NULL){
414 /* previously initialized comment header */
415 return(OV_EBADHEADER);
418 return(_vorbis_unpack_comment(vc,&opb));
420 case 0x05: /* least significant *bit* is read first */
421 if(vi->rate==0 || vc->vendor==NULL){
422 /* um... we didn;t get the initial header or comments yet */
423 return(OV_EBADHEADER);
425 if(vi->codec_setup==NULL){
426 /* improperly initialized vorbis_info */
429 if(((codec_setup_info *)vi->codec_setup)->books>0){
430 /* previously initialized setup header */
431 return(OV_EBADHEADER);
434 return(_vorbis_unpack_books(vi,&opb));
437 /* Not a valid vorbis header type */
438 return(OV_EBADHEADER);
443 return(OV_EBADHEADER);
446 /* pack side **********************************************************/
448 static int _vorbis_pack_info(oggpack_buffer *opb,vorbis_info *vi){
449 codec_setup_info *ci=vi->codec_setup;
451 ci->blocksizes[0]<64||
452 ci->blocksizes[1]<ci->blocksizes[0]){
457 oggpack_write(opb,0x01,8);
458 _v_writestring(opb,"vorbis", 6);
460 /* basic information about the stream */
461 oggpack_write(opb,0x00,32);
462 oggpack_write(opb,vi->channels,8);
463 oggpack_write(opb,vi->rate,32);
465 oggpack_write(opb,vi->bitrate_upper,32);
466 oggpack_write(opb,vi->bitrate_nominal,32);
467 oggpack_write(opb,vi->bitrate_lower,32);
469 oggpack_write(opb,ov_ilog(ci->blocksizes[0]-1),4);
470 oggpack_write(opb,ov_ilog(ci->blocksizes[1]-1),4);
471 oggpack_write(opb,1,1);
476 static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
477 int bytes = strlen(ENCODE_VENDOR_STRING);
480 oggpack_write(opb,0x03,8);
481 _v_writestring(opb,"vorbis", 6);
484 oggpack_write(opb,bytes,32);
485 _v_writestring(opb,ENCODE_VENDOR_STRING, bytes);
489 oggpack_write(opb,vc->comments,32);
492 for(i=0;i<vc->comments;i++){
493 if(vc->user_comments[i]){
494 oggpack_write(opb,vc->comment_lengths[i],32);
495 _v_writestring(opb,vc->user_comments[i], vc->comment_lengths[i]);
497 oggpack_write(opb,0,32);
501 oggpack_write(opb,1,1);
506 static int _vorbis_pack_books(oggpack_buffer *opb,vorbis_info *vi){
507 codec_setup_info *ci=vi->codec_setup;
509 if(!ci)return(OV_EFAULT);
511 oggpack_write(opb,0x05,8);
512 _v_writestring(opb,"vorbis", 6);
515 oggpack_write(opb,ci->books-1,8);
516 for(i=0;i<ci->books;i++)
517 if(vorbis_staticbook_pack(ci->book_param[i],opb))goto err_out;
519 /* times; hook placeholders */
520 oggpack_write(opb,0,6);
521 oggpack_write(opb,0,16);
524 oggpack_write(opb,ci->floors-1,6);
525 for(i=0;i<ci->floors;i++){
526 oggpack_write(opb,ci->floor_type[i],16);
527 if(_floor_P[ci->floor_type[i]]->pack)
528 _floor_P[ci->floor_type[i]]->pack(ci->floor_param[i],opb);
534 oggpack_write(opb,ci->residues-1,6);
535 for(i=0;i<ci->residues;i++){
536 oggpack_write(opb,ci->residue_type[i],16);
537 _residue_P[ci->residue_type[i]]->pack(ci->residue_param[i],opb);
541 oggpack_write(opb,ci->maps-1,6);
542 for(i=0;i<ci->maps;i++){
543 oggpack_write(opb,ci->map_type[i],16);
544 _mapping_P[ci->map_type[i]]->pack(vi,ci->map_param[i],opb);
548 oggpack_write(opb,ci->modes-1,6);
549 for(i=0;i<ci->modes;i++){
550 oggpack_write(opb,ci->mode_param[i]->blockflag,1);
551 oggpack_write(opb,ci->mode_param[i]->windowtype,16);
552 oggpack_write(opb,ci->mode_param[i]->transformtype,16);
553 oggpack_write(opb,ci->mode_param[i]->mapping,8);
555 oggpack_write(opb,1,1);
562 int vorbis_commentheader_out(vorbis_comment *vc,
567 oggpack_writeinit(&opb);
568 if(_vorbis_pack_comment(&opb,vc)){
569 oggpack_writeclear(&opb);
573 op->packet = _ogg_malloc(oggpack_bytes(&opb));
574 memcpy(op->packet, opb.buffer, oggpack_bytes(&opb));
576 op->bytes=oggpack_bytes(&opb);
582 oggpack_writeclear(&opb);
586 int vorbis_analysis_headerout(vorbis_dsp_state *v,
590 ogg_packet *op_code){
592 vorbis_info *vi=v->vi;
594 private_state *b=v->backend_state;
596 if(!b||vi->channels<=0||vi->channels>256){
602 /* first header packet **********************************************/
604 oggpack_writeinit(&opb);
605 if(_vorbis_pack_info(&opb,vi))goto err_out;
607 /* build the packet */
608 if(b->header)_ogg_free(b->header);
609 b->header=_ogg_malloc(oggpack_bytes(&opb));
610 memcpy(b->header,opb.buffer,oggpack_bytes(&opb));
611 op->packet=b->header;
612 op->bytes=oggpack_bytes(&opb);
618 /* second header packet (comments) **********************************/
621 if(_vorbis_pack_comment(&opb,vc))goto err_out;
623 if(b->header1)_ogg_free(b->header1);
624 b->header1=_ogg_malloc(oggpack_bytes(&opb));
625 memcpy(b->header1,opb.buffer,oggpack_bytes(&opb));
626 op_comm->packet=b->header1;
627 op_comm->bytes=oggpack_bytes(&opb);
630 op_comm->granulepos=0;
633 /* third header packet (modes/codebooks) ****************************/
636 if(_vorbis_pack_books(&opb,vi))goto err_out;
638 if(b->header2)_ogg_free(b->header2);
639 b->header2=_ogg_malloc(oggpack_bytes(&opb));
640 memcpy(b->header2,opb.buffer,oggpack_bytes(&opb));
641 op_code->packet=b->header2;
642 op_code->bytes=oggpack_bytes(&opb);
645 op_code->granulepos=0;
648 oggpack_writeclear(&opb);
651 memset(op,0,sizeof(*op));
652 memset(op_comm,0,sizeof(*op_comm));
653 memset(op_code,0,sizeof(*op_code));
656 if(vi->channels>0)oggpack_writeclear(&opb);
657 if(b->header)_ogg_free(b->header);
658 if(b->header1)_ogg_free(b->header1);
659 if(b->header2)_ogg_free(b->header2);
667 double vorbis_granule_time(vorbis_dsp_state *v,ogg_int64_t granulepos){
668 if(granulepos == -1) return -1;
670 /* We're not guaranteed a 64 bit unsigned type everywhere, so we
671 have to put the unsigned granpo in a signed type. */
673 return((double)granulepos/v->vi->rate);
675 ogg_int64_t granuleoff=0xffffffff;
677 granuleoff|=0x7ffffffff;
678 return(((double)granulepos+2+granuleoff+granuleoff)/v->vi->rate);
682 const char *vorbis_version_string(void){
683 return GENERAL_VENDOR_STRING;