Minor comment typo fix.
[opusfile.git] / src / opusfile.c
1 /********************************************************************
2  *                                                                  *
3  * THIS FILE IS PART OF THE libopusfile 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.       *
7  *                                                                  *
8  * THE libopusfile SOURCE CODE IS (C) COPYRIGHT 1994-2012           *
9  * by the Xiph.Org Foundation and contributors http://www.xiph.org/ *
10  *                                                                  *
11  ********************************************************************
12
13  function: stdio-based convenience library for opening/seeking/decoding
14  last mod: $Id: vorbisfile.c 17573 2010-10-27 14:53:59Z xiphmont $
15
16  ********************************************************************/
17 #ifdef HAVE_CONFIG_H
18 #include "config.h"
19 #endif
20
21 #include "internal.h"
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <errno.h>
25 #include <limits.h>
26 #include <string.h>
27 #include <math.h>
28
29 #include "opusfile.h"
30
31 /*This implementation is largely based off of libvorbisfile.
32   All of the Ogg bits work roughly the same, though I have made some
33    "improvements" that have not been folded back there, yet.*/
34
35 /*A 'chained bitstream' is an Ogg Opus bitstream that contains more than one
36    logical bitstream arranged end to end (the only form of Ogg multiplexing
37    supported by this library.
38   Grouping (parallel multiplexing) is not supported, except to the extent that
39    if there are multiple logical Ogg streams in a single link of the chain, we
40    will ignore all but the first Opus stream we find.*/
41
42 /*An Ogg Opus file can be played beginning to end (streamed) without worrying
43    ahead of time about chaining (see opusdec from the opus-tools package).
44   If we have the whole file, however, and want random access
45    (seeking/scrubbing) or desire to know the total length/time of a file, we
46    need to account for the possibility of chaining.*/
47
48 /*We can handle things a number of ways.
49   We can determine the entire bitstream structure right off the bat, or find
50    pieces on demand.
51   This library determines and caches structure for the entire bitstream, but
52    builds a virtual decoder on the fly when moving between links in the chain.*/
53
54 /*There are also different ways to implement seeking.
55   Enough information exists in an Ogg bitstream to seek to sample-granularity
56    positions in the output.
57   Or, one can seek by picking some portion of the stream roughly in the desired
58    area if we only want coarse navigation through the stream.
59   We implement and expose both strategies.*/
60
61 /*The maximum number of bytes in a page (including the page headers).*/
62 #define OP_PAGE_SIZE_MAX  (65307)
63 /*The default amount to seek backwards per step when trying to find the
64    previous page.
65   This must be at least as large as the maximum size of a page.*/
66 #define OP_CHUNK_SIZE     (65536)
67 /*The maximum amount to seek backwards per step when trying to find the
68    previous page.*/
69 #define OP_CHUNK_SIZE_MAX (1024*(opus_int32)1024)
70 /*A smaller read size is needed for low-rate streaming.*/
71 #define OP_READ_SIZE      (2048)
72
73 int op_test(OpusHead *_head,
74  const unsigned char *_initial_data,size_t _initial_bytes){
75   ogg_sync_state  oy;
76   char           *data;
77   int             err;
78   /*The first page of a normal Opus file will be at most 57 bytes (27 Ogg
79      page header bytes + 1 lacing value + 21 Opus header bytes + 8 channel
80      mapping bytes).
81     It will be at least 47 bytes (27 Ogg page header bytes + 1 lacing value +
82      19 Opus header bytes using channel mapping family 0).
83     If we don't have at least that much data, give up now.*/
84   if(_initial_bytes<47)return OP_FALSE;
85   /*Only proceed if we start with the magic OggS string.
86     This is to prevent us spending a lot of time allocating memory and looking
87      for Ogg pages in non-Ogg files.*/
88   if(memcmp(_initial_data,"OggS",4)!=0)return OP_ENOTFORMAT;
89   ogg_sync_init(&oy);
90   data=ogg_sync_buffer(&oy,_initial_bytes);
91   if(data!=NULL){
92     ogg_stream_state os;
93     ogg_page         og;
94     int              ret;
95     memcpy(data,_initial_data,_initial_bytes);
96     ogg_sync_wrote(&oy,_initial_bytes);
97     ogg_stream_init(&os,-1);
98     err=OP_FALSE;
99     do{
100       ogg_packet op;
101       ret=ogg_sync_pageout(&oy,&og);
102       /*Ignore holes.*/
103       if(ret<0)continue;
104       /*Stop if we run out of data.*/
105       if(!ret)break;
106       ogg_stream_reset_serialno(&os,ogg_page_serialno(&og));
107       ogg_stream_pagein(&os,&og);
108       /*Only process the first packet on this page (if it's a BOS packet,
109          it's required to be the only one).*/
110       if(ogg_stream_packetout(&os,&op)==1){
111         if(op.b_o_s){
112           ret=opus_head_parse(_head,op.packet,op.bytes);
113           /*If this didn't look like Opus, keep going.*/
114           if(ret==OP_ENOTFORMAT)continue;
115           /*Otherwise we're done, one way or another.*/
116           err=ret;
117         }
118         /*We finished parsing the headers.
119           There is no Opus to be found.*/
120         else err=OP_ENOTFORMAT;
121       }
122     }
123     while(err==OP_FALSE);
124     ogg_stream_clear(&os);
125   }
126   else err=OP_EFAULT;
127   ogg_sync_clear(&oy);
128   return err;
129 }
130
131 /*Many, many internal helpers.
132   The intention is not to be confusing.
133   Rampant duplication and monolithic function implementation (though we do have
134    some large, omnibus functions still) would be harder to understand anyway.
135   The high level functions are last.
136   Begin grokking near the end of the file if you prefer to read things
137    top-down.*/
138
139 /*The read/seek functions track absolute position within the stream.*/
140
141 /*Read a little more data from the file/pipe into the ogg_sync framer.
142   _nbytes: The maximum number of bytes to read.
143   Return: A positive number of bytes read on success, 0 on end-of-file, or a
144            negative value on failure.*/
145 static int op_get_data(OggOpusFile *_of,int _nbytes){
146   unsigned char *buffer;
147   int            nbytes;
148   OP_ASSERT(_nbytes>0);
149   buffer=(unsigned char *)ogg_sync_buffer(&_of->oy,_nbytes);
150   nbytes=(int)(*_of->callbacks.read)(_of->source,buffer,_nbytes);
151   OP_ASSERT(nbytes<=_nbytes);
152   if(OP_LIKELY(nbytes>0))ogg_sync_wrote(&_of->oy,nbytes);
153   return nbytes;
154 }
155
156 /*Save a tiny smidge of verbosity to make the code more readable.*/
157 static int op_seek_helper(OggOpusFile *_of,opus_int64 _offset){
158   if(_offset==_of->offset)return 0;
159   if(_of->callbacks.seek==NULL
160    ||(*_of->callbacks.seek)(_of->source,_offset,SEEK_SET)){
161     return OP_EREAD;
162   }
163   _of->offset=_offset;
164   ogg_sync_reset(&_of->oy);
165   return 0;
166 }
167
168 /*Get the current position indicator of the underlying source.
169   This should be the same as the value reported by tell().*/
170 static opus_int64 op_position(const OggOpusFile *_of){
171   /*The current position indicator is _not_ simply offset.
172     We may also have unprocessed, buffered data in the sync state.*/
173   return _of->offset+_of->oy.fill-_of->oy.returned;
174 }
175
176 /*From the head of the stream, get the next page.
177   _boundary specifies if the function is allowed to fetch more data from the
178    stream (and how much) or only use internally buffered data.
179   _boundary: -1: Unbounded search.
180               0: Read no additional data.
181                  Use only cached data.
182               n: Search for the start of a new page up to file position n.
183   Return: n>=0:       Found a page at absolute offset n.
184           OP_FALSE:   Hit the _boundary limit.
185           OP_EREAD:   An underlying read operation failed.
186           OP_BADLINK: We hit end-of-file before reaching _boundary.*/
187 static opus_int64 op_get_next_page(OggOpusFile *_of,ogg_page *_og,
188  opus_int64 _boundary){
189   while(_boundary<=0||_of->offset<_boundary){
190     int more;
191     more=ogg_sync_pageseek(&_of->oy,_og);
192     /*Skipped (-more) bytes.*/
193     if(OP_UNLIKELY(more<0))_of->offset-=more;
194     else if(more==0){
195       int read_nbytes;
196       int ret;
197       /*Send more paramedics.*/
198       if(!_boundary)return OP_FALSE;
199       if(_boundary<0)read_nbytes=OP_READ_SIZE;
200       else{
201         opus_int64 position;
202         position=op_position(_of);
203         if(position>=_boundary)return OP_FALSE;
204         read_nbytes=(int)OP_MIN(_boundary-position,OP_READ_SIZE);
205       }
206       ret=op_get_data(_of,read_nbytes);
207       if(OP_UNLIKELY(ret<0))return OP_EREAD;
208       if(OP_UNLIKELY(ret==0)){
209         /*Only fail cleanly on EOF if we didn't have a known boundary.
210           Otherwise, we should have been able to reach that boundary, and this
211            is a fatal error.*/
212         return OP_UNLIKELY(_boundary<0)?OP_FALSE:OP_EBADLINK;
213       }
214     }
215     else{
216       /*Got a page.
217         Return the page start offset and advance the internal offset past the
218          page end.*/
219       opus_int64 page_offset;
220       page_offset=_of->offset;
221       _of->offset+=more;
222       OP_ASSERT(page_offset>=0);
223       return page_offset;
224     }
225   }
226   return OP_FALSE;
227 }
228
229 static int op_add_serialno(const ogg_page *_og,
230  ogg_uint32_t **_serialnos,int *_nserialnos,int *_cserialnos){
231   ogg_uint32_t *serialnos;
232   int           nserialnos;
233   int           cserialnos;
234   ogg_uint32_t s;
235   s=ogg_page_serialno(_og);
236   serialnos=*_serialnos;
237   nserialnos=*_nserialnos;
238   cserialnos=*_cserialnos;
239   if(OP_UNLIKELY(nserialnos>=cserialnos)){
240     if(OP_UNLIKELY(cserialnos>INT_MAX/(int)sizeof(*serialnos)-1>>1)){
241       return OP_EFAULT;
242     }
243     cserialnos=2*cserialnos+1;
244     OP_ASSERT(nserialnos<cserialnos);
245     serialnos=(ogg_uint32_t *)_ogg_realloc(serialnos,
246      sizeof(*serialnos)*cserialnos);
247     if(OP_UNLIKELY(serialnos==NULL))return OP_EFAULT;
248   }
249   serialnos[nserialnos++]=s;
250   *_serialnos=serialnos;
251   *_nserialnos=nserialnos;
252   *_cserialnos=cserialnos;
253   return 0;
254 }
255
256 /*Returns nonzero if found.*/
257 static int op_lookup_serialno(ogg_uint32_t _s,
258  const ogg_uint32_t *_serialnos,int _nserialnos){
259   int i;
260   for(i=0;i<_nserialnos&&_serialnos[i]!=_s;i++);
261   return i<_nserialnos;
262 }
263
264 static int op_lookup_page_serialno(const ogg_page *_og,
265  const ogg_uint32_t *_serialnos,int _nserialnos){
266   return op_lookup_serialno(ogg_page_serialno(_og),_serialnos,_nserialnos);
267 }
268
269 typedef struct OpusSeekRecord OpusSeekRecord;
270
271 /*We use this to remember the pages we found while enumerating the links of a
272    chained stream.
273   We keep track of the starting and ending offsets, as well as the point we
274    started searching from, so we know where to bisect.
275   We also keep the serial number, so we can tell if the page belonged to the
276    current link or not, as well as the granule position, to aid in estimating
277    the start of the link.*/
278 struct OpusSeekRecord{
279   /*The earliest byte we know of such that reading forward from it causes
280      capture to be regained at this page.*/
281   opus_int64   search_start;
282   /*The offset of this page.*/
283   opus_int64   offset;
284   /*The size of this page.*/
285   opus_int32   size;
286   /*The serial number of this page.*/
287   ogg_uint32_t serialno;
288   /*The granule position of this page.*/
289   ogg_int64_t  gp;
290 };
291
292 /*Find the last page beginning before _offset with a valid granule position.
293   There is no '_boundary' parameter as it will always have to read more data.
294   This is much dirtier than the above, as Ogg doesn't have any backward search
295    linkage.
296   This search prefers pages of the specified serial number.
297   If a page of the specified serial number is spotted during the
298    seek-back-and-read-forward, it will return the info of last page of the
299    matching serial number, instead of the very last page, unless the very last
300    page belongs to a different link than preferred serial number.
301   If no page of the specified serial number is seen, it will return the info of
302    the last page.
303   [out] _sr:   Returns information about the page that was found on success.
304   _offset:     The _offset before which to find a page.
305                Any page returned will consist of data entirely before _offset.
306   _serialno:   The preferred serial number.
307                If a page with this serial number is found, it will be returned
308                 even if another page in the same link is found closer to
309                 _offset.
310                This is purely opportunistic: there is no guarantee such a page
311                 will be found if it exists.
312   _serialnos:  The list of serial numbers in the link that contains the
313                 preferred serial number.
314   _nserialnos: The number of serial numbers in the current link.
315   Return: 0 on success, or a negative value on failure.
316           OP_EREAD:    Failed to read more data (error or EOF).
317           OP_EBADLINK: We couldn't find a page even after seeking back to the
318                         start of the stream.*/
319 static int op_get_prev_page_serial(OggOpusFile *_of,OpusSeekRecord *_sr,
320  opus_int64 _offset,ogg_uint32_t _serialno,
321  const ogg_uint32_t *_serialnos,int _nserialnos){
322   OpusSeekRecord preferred_sr;
323   ogg_page       og;
324   opus_int64     begin;
325   opus_int64     end;
326   opus_int64     original_end;
327   opus_int32     chunk_size;
328   int            preferred_found;
329   original_end=end=begin=_offset;
330   preferred_found=0;
331   _offset=-1;
332   chunk_size=OP_CHUNK_SIZE;
333   do{
334     opus_int64 search_start;
335     int        ret;
336     OP_ASSERT(chunk_size>=OP_PAGE_SIZE_MAX);
337     begin=OP_MAX(begin-chunk_size,0);
338     ret=op_seek_helper(_of,begin);
339     if(OP_UNLIKELY(ret<0))return ret;
340     search_start=begin;
341     while(_of->offset<end){
342       opus_int64   llret;
343       ogg_uint32_t serialno;
344       llret=op_get_next_page(_of,&og,end);
345       if(OP_UNLIKELY(llret<OP_FALSE))return (int)llret;
346       else if(llret==OP_FALSE)break;
347       serialno=ogg_page_serialno(&og);
348       /*Save the information for this page.
349         We're not interested in the page itself... just the serial number, byte
350          offset, page size, and granule position.*/
351       _sr->search_start=search_start;
352       _sr->offset=_offset=llret;
353       _sr->serialno=serialno;
354       OP_ASSERT(_of->offset-_offset>=0);
355       OP_ASSERT(_of->offset-_offset<=OP_PAGE_SIZE_MAX);
356       _sr->size=(opus_int32)(_of->offset-_offset);
357       _sr->gp=ogg_page_granulepos(&og);
358       /*If this page is from the stream we're looking for, remember it.*/
359       if(serialno==_serialno){
360         preferred_found=1;
361         *&preferred_sr=*_sr;
362       }
363       if(!op_lookup_serialno(serialno,_serialnos,_nserialnos)){
364         /*We fell off the end of the link, which means we seeked back too far
365            and shouldn't have been looking in that link to begin with.
366           If we found the preferred serial number, forget that we saw it.*/
367         preferred_found=0;
368       }
369       search_start=llret+1;
370     }
371     /*We started from the beginning of the stream and found nothing.
372       This should be impossible unless the contents of the source changed out
373        from under us after we read from it.*/
374     if(OP_UNLIKELY(!begin)&&OP_UNLIKELY(_offset<0))return OP_EBADLINK;
375     /*Bump up the chunk size.
376       This is mildly helpful when seeks are very expensive (http).*/
377     chunk_size=OP_MIN(2*chunk_size,OP_CHUNK_SIZE_MAX);
378     /*Avoid quadratic complexity if we hit an invalid patch of the file.*/
379     end=OP_MIN(begin+OP_PAGE_SIZE_MAX-1,original_end);
380   }
381   while(_offset<0);
382   if(preferred_found)*_sr=*&preferred_sr;
383   return 0;
384 }
385
386 /*Find the last page beginning before _offset with the given serial number and
387    a valid granule position.
388   Unlike the above search, this continues until it finds such a page, but does
389    not stray outside the current link.
390   We could implement it (inefficiently) by calling op_get_prev_page_serial()
391    repeatedly until it returned a page that had both our preferred serial
392    number and a valid granule position, but doing it with a separate function
393    allows us to avoid repeatedly re-scanning valid pages from other streams as
394    we seek-back-and-read-forward.
395   [out] _gp:   Returns the granule position of the page that was found on
396                 success.
397   _offset:     The _offset before which to find a page.
398                Any page returned will consist of data entirely before _offset.
399   _serialno:   The target serial number.
400   _serialnos:  The list of serial numbers in the link that contains the
401                 preferred serial number.
402   _nserialnos: The number of serial numbers in the current link.
403   Return: The offset of the page on success, or a negative value on failure.
404           OP_EREAD:    Failed to read more data (error or EOF).
405           OP_EBADLINK: We couldn't find a page even after seeking back past the
406                         beginning of the link.*/
407 static opus_int64 op_get_last_page(OggOpusFile *_of,ogg_int64_t *_gp,
408  opus_int64 _offset,ogg_uint32_t _serialno,
409  const ogg_uint32_t *_serialnos,int _nserialnos){
410   ogg_page    og;
411   ogg_int64_t gp;
412   opus_int64  begin;
413   opus_int64  end;
414   opus_int64  original_end;
415   opus_int32  chunk_size;
416   /*The target serial number must belong to the current link.*/
417   OP_ASSERT(op_lookup_serialno(_serialno,_serialnos,_nserialnos));
418   original_end=end=begin=_offset;
419   _offset=-1;
420   /*We shouldn't have to initialize gp, but gcc is too dumb to figure out that
421      ret>=0 implies we entered the if(page_gp!=-1) block at least once.*/
422   gp=-1;
423   chunk_size=OP_CHUNK_SIZE;
424   do{
425     int left_link;
426     int ret;
427     OP_ASSERT(chunk_size>=OP_PAGE_SIZE_MAX);
428     begin=OP_MAX(begin-chunk_size,0);
429     ret=op_seek_helper(_of,begin);
430     if(OP_UNLIKELY(ret<0))return ret;
431     left_link=0;
432     while(_of->offset<end){
433       opus_int64   llret;
434       ogg_uint32_t serialno;
435       llret=op_get_next_page(_of,&og,end);
436       if(OP_UNLIKELY(llret<OP_FALSE))return llret;
437       else if(llret==OP_FALSE)break;
438       serialno=ogg_page_serialno(&og);
439       if(serialno==_serialno){
440         ogg_int64_t page_gp;
441         /*The page is from the right stream...*/
442         page_gp=ogg_page_granulepos(&og);
443         if(page_gp!=-1){
444           /*And has a valid granule position.
445             Let's remember it.*/
446           _offset=llret;
447           gp=page_gp;
448         }
449       }
450       else if(OP_UNLIKELY(!op_lookup_serialno(serialno,
451        _serialnos,_nserialnos))){
452         /*We fell off the start of the link, which means we don't need to keep
453            seeking any farther back.*/
454         left_link=1;
455       }
456     }
457     /*We started from at or before the beginning of the link and found nothing.
458       This should be impossible unless the contents of the source changed out
459        from under us after we read from it.*/
460     if((OP_UNLIKELY(left_link)||OP_UNLIKELY(!begin))&&OP_UNLIKELY(_offset<0)){
461       return OP_EBADLINK;
462     }
463     /*Bump up the chunk size.
464       This is mildly helpful when seeks are very expensive (http).*/
465     chunk_size=OP_MIN(2*chunk_size,OP_CHUNK_SIZE_MAX);
466     /*Avoid quadratic complexity if we hit an invalid patch of the file.*/
467     end=OP_MIN(begin+OP_PAGE_SIZE_MAX-1,original_end);
468   }
469   while(_offset<0);
470   *_gp=gp;
471   return _offset;
472 }
473
474 /*Uses the local ogg_stream storage in _of.
475   This is important for non-streaming input sources.*/
476 static int op_fetch_headers_impl(OggOpusFile *_of,OpusHead *_head,
477  OpusTags *_tags,ogg_uint32_t **_serialnos,int *_nserialnos,
478  int *_cserialnos,ogg_page *_og){
479   ogg_packet op;
480   int        ret;
481   if(_serialnos!=NULL)*_nserialnos=0;
482   /*Extract the serialnos of all BOS pages plus the first set of Opus headers
483      we see in the link.*/
484   while(ogg_page_bos(_og)){
485     if(_serialnos!=NULL){
486       if(OP_UNLIKELY(op_lookup_page_serialno(_og,*_serialnos,*_nserialnos))){
487         /*A dupe serialnumber in an initial header packet set==invalid stream.*/
488         return OP_EBADHEADER;
489       }
490       ret=op_add_serialno(_og,_serialnos,_nserialnos,_cserialnos);
491       if(OP_UNLIKELY(ret<0))return ret;
492     }
493     if(_of->ready_state<OP_STREAMSET){
494       /*We don't have an Opus stream in this link yet, so begin prospective
495          stream setup.
496         We need a stream to get packets.*/
497       ogg_stream_reset_serialno(&_of->os,ogg_page_serialno(_og));
498       ogg_stream_pagein(&_of->os,_og);
499       if(OP_LIKELY(ogg_stream_packetout(&_of->os,&op)>0)){
500         ret=opus_head_parse(_head,op.packet,op.bytes);
501         /*Found a valid Opus header.
502           Continue setup.*/
503         if(OP_LIKELY(ret>=0))_of->ready_state=OP_STREAMSET;
504         /*If it's just a stream type we don't recognize, ignore it.
505           Everything else is fatal.*/
506         else if(ret!=OP_ENOTFORMAT)return ret;
507       }
508     }
509     /*Get the next page.
510       No need to clamp the boundary offset against _of->end, as all errors
511        become OP_ENOTFORMAT or OP_EBADHEADER.*/
512     if(OP_UNLIKELY(op_get_next_page(_of,_og,
513      OP_ADV_OFFSET(_of->offset,OP_CHUNK_SIZE))<0)){
514       return _of->ready_state<OP_STREAMSET?OP_ENOTFORMAT:OP_EBADHEADER;
515     }
516   }
517   if(OP_UNLIKELY(_of->ready_state!=OP_STREAMSET))return OP_ENOTFORMAT;
518   /*If the first non-header page belonged to our Opus stream, submit it.*/
519   if(_of->os.serialno==ogg_page_serialno(_og))ogg_stream_pagein(&_of->os,_og);
520   /*Loop getting packets.*/
521   for(;;){
522     switch(ogg_stream_packetout(&_of->os,&op)){
523       case 0:{
524         /*Loop getting pages.*/
525         for(;;){
526           /*No need to clamp the boundary offset against _of->end, as all
527              errors become OP_EBADHEADER.*/
528           if(OP_UNLIKELY(op_get_next_page(_of,_og,
529            OP_ADV_OFFSET(_of->offset,OP_CHUNK_SIZE))<0)){
530             return OP_EBADHEADER;
531           }
532           /*If this page belongs to the correct stream, go parse it.*/
533           if(_of->os.serialno==ogg_page_serialno(_og)){
534             ogg_stream_pagein(&_of->os,_og);
535             break;
536           }
537           /*If the link ends before we see the Opus comment header, abort.*/
538           if(OP_UNLIKELY(ogg_page_bos(_og)))return OP_EBADHEADER;
539           /*Otherwise, keep looking.*/
540         }
541       }break;
542       /*We shouldn't get a hole in the headers!*/
543       case -1:return OP_EBADHEADER;
544       default:{
545         /*Got a packet.
546           It should be the comment header.*/
547         ret=opus_tags_parse(_tags,op.packet,op.bytes);
548         if(OP_UNLIKELY(ret<0))return ret;
549         /*Make sure the page terminated at the end of the comment header.
550           If there is another packet on the page, or part of a packet, then
551            reject the stream.
552           Otherwise seekable sources won't be able to seek back to the start
553            properly.*/
554         ret=ogg_stream_packetout(&_of->os,&op);
555         if(OP_UNLIKELY(ret!=0)
556          ||OP_UNLIKELY(_og->header[_og->header_len-1]==255)){
557           /*If we fail, the caller assumes our tags are uninitialized.*/
558           opus_tags_clear(_tags);
559           return OP_EBADHEADER;
560         }
561         return 0;
562       }
563     }
564   }
565 }
566
567 static int op_fetch_headers(OggOpusFile *_of,OpusHead *_head,
568  OpusTags *_tags,ogg_uint32_t **_serialnos,int *_nserialnos,
569  int *_cserialnos,ogg_page *_og){
570   ogg_page og;
571   int      ret;
572   if(!_og){
573     /*No need to clamp the boundary offset against _of->end, as all errors
574        become OP_ENOTFORMAT.*/
575     if(OP_UNLIKELY(op_get_next_page(_of,&og,
576      OP_ADV_OFFSET(_of->offset,OP_CHUNK_SIZE))<0)){
577       return OP_ENOTFORMAT;
578     }
579     _og=&og;
580   }
581   _of->ready_state=OP_OPENED;
582   ret=op_fetch_headers_impl(_of,_head,_tags,_serialnos,_nserialnos,
583    _cserialnos,_og);
584   /*Revert back from OP_STREAMSET to OP_OPENED on failure, to prevent
585      double-free of the tags in an unseekable stream.*/
586   if(OP_UNLIKELY(ret<0))_of->ready_state=OP_OPENED;
587   return ret;
588 }
589
590 /*Granule position manipulation routines.
591   A granule position is defined to be an unsigned 64-bit integer, with the
592    special value -1 in two's complement indicating an unset or invalid granule
593    position.
594   We are not guaranteed to have an unsigned 64-bit type, so we construct the
595    following routines that
596    a) Properly order negative numbers as larger than positive numbers, and
597    b) Check for underflow or overflow past the special -1 value.
598   This lets us operate on the full, valid range of granule positions in a
599    consistent and safe manner.
600   This full range is organized into distinct regions:
601    [ -1 (invalid) ][ 0 ... OP_INT64_MAX ][ OP_INT64_MIN ... -2 ][-1 (invalid) ]
602
603   No one should actually use granule positions so large that they're negative,
604    even if they are technically valid, as very little software handles them
605    correctly (including most of Xiph.Org's).
606   This library also refuses to support durations so large they won't fit in a
607    signed 64-bit integer (to avoid exposing this mess to the application, and
608    to simplify a good deal of internal arithmetic), so the only way to use them
609    successfully is if pcm_start is very large.
610   This means there isn't anything you can do with negative granule positions
611    that you couldn't have done with purely non-negative ones.
612   The main purpose of these routines is to allow us to think very explicitly
613    about the possible failure cases of all granule position manipulations.*/
614
615 /*Safely adds a small signed integer to a valid (not -1) granule position.
616   The result can use the full 64-bit range of values (both positive and
617    negative), but will fail on overflow (wrapping past -1; wrapping past
618    OP_INT64_MAX is explicitly okay).
619   [out] _dst_gp: The resulting granule position.
620                  Only modified on success.
621   _src_gp:       The granule position to add to.
622                  This must not be -1.
623   _delta:        The amount to add.
624                  This is allowed to be up to 32 bits to support the maximum
625                   duration of a single Ogg page (255 packets * 120 ms per
626                   packet == 1,468,800 samples at 48 kHz).
627   Return: 0 on success, or OP_EINVAL if the result would wrap around past -1.*/
628 static int op_granpos_add(ogg_int64_t *_dst_gp,ogg_int64_t _src_gp,
629  opus_int32 _delta){
630   /*The code below handles this case correctly, but there's no reason we
631      should ever be called with these values, so make sure we aren't.*/
632   OP_ASSERT(_src_gp!=-1);
633   if(_delta>0){
634     /*Adding this amount to the granule position would overflow its 64-bit
635        range.*/
636     if(OP_UNLIKELY(_src_gp<0)&&OP_UNLIKELY(_src_gp>=-1-_delta))return OP_EINVAL;
637     if(OP_UNLIKELY(_src_gp>OP_INT64_MAX-_delta)){
638       /*Adding this amount to the granule position would overflow the positive
639          half of its 64-bit range.
640         Since signed overflow is undefined in C, do it in a way the compiler
641          isn't allowed to screw up.*/
642       _delta-=(opus_int32)(OP_INT64_MAX-_src_gp)+1;
643       _src_gp=OP_INT64_MIN;
644     }
645   }
646   else if(_delta<0){
647     /*Subtracting this amount from the granule position would underflow its
648        64-bit range.*/
649     if(_src_gp>=0&&OP_UNLIKELY(_src_gp<-_delta))return OP_EINVAL;
650     if(OP_UNLIKELY(_src_gp<OP_INT64_MIN-_delta)){
651       /*Subtracting this amount from the granule position would underflow the
652          negative half of its 64-bit range.
653         Since signed underflow is undefined in C, do it in a way the compiler
654          isn't allowed to screw up.*/
655       _delta+=(opus_int32)(_src_gp-OP_INT64_MIN)+1;
656       _src_gp=OP_INT64_MAX;
657     }
658   }
659   *_dst_gp=_src_gp+_delta;
660   return 0;
661 }
662
663 /*Safely computes the difference between two granule positions.
664   The difference must fit in a signed 64-bit integer, or the function fails.
665   It correctly handles the case where the granule position has wrapped around
666    from positive values to negative ones.
667   [out] _delta: The difference between the granule positions.
668                 Only modified on success.
669   _gp_a:        The granule position to subtract from.
670                 This must not be -1.
671   _gp_b:        The granule position to subtract.
672                 This must not be -1.
673   Return: 0 on success, or OP_EINVAL if the result would not fit in a signed
674            64-bit integer.*/
675 static int op_granpos_diff(ogg_int64_t *_delta,
676  ogg_int64_t _gp_a,ogg_int64_t _gp_b){
677   int gp_a_negative;
678   int gp_b_negative;
679   /*The code below handles these cases correctly, but there's no reason we
680      should ever be called with these values, so make sure we aren't.*/
681   OP_ASSERT(_gp_a!=-1);
682   OP_ASSERT(_gp_b!=-1);
683   gp_a_negative=OP_UNLIKELY(_gp_a<0);
684   gp_b_negative=OP_UNLIKELY(_gp_b<0);
685   if(OP_UNLIKELY(gp_a_negative^gp_b_negative)){
686     ogg_int64_t da;
687     ogg_int64_t db;
688     if(gp_a_negative){
689       /*_gp_a has wrapped to a negative value but _gp_b hasn't: the difference
690          should be positive.*/
691       /*Step 1: Handle wrapping.*/
692       /*_gp_a < 0 => da < 0.*/
693       da=(OP_INT64_MIN-_gp_a)-1;
694       /*_gp_b >= 0  => db >= 0.*/
695       db=OP_INT64_MAX-_gp_b;
696       /*Step 2: Check for overflow.*/
697       if(OP_UNLIKELY(OP_INT64_MAX+da<db))return OP_EINVAL;
698       *_delta=db-da;
699     }
700     else{
701       /*_gp_b has wrapped to a negative value but _gp_a hasn't: the difference
702          should be negative.*/
703       /*Step 1: Handle wrapping.*/
704       /*_gp_a >= 0 => da <= 0*/
705       da=_gp_a+OP_INT64_MIN;
706       /*_gp_b < 0 => db <= 0*/
707       db=OP_INT64_MIN-_gp_b;
708       /*Step 2: Check for overflow.*/
709       if(OP_UNLIKELY(da<OP_INT64_MIN-db))return OP_EINVAL;
710       *_delta=da+db;
711     }
712   }
713   else *_delta=_gp_a-_gp_b;
714   return 0;
715 }
716
717 static int op_granpos_cmp(ogg_int64_t _gp_a,ogg_int64_t _gp_b){
718   /*The invalid granule position -1 should behave like NaN: neither greater
719      than nor less than any other granule position, nor equal to any other
720      granule position, including itself.
721     However, that means there isn't anything we could sensibly return from this
722      function for it.*/
723   OP_ASSERT(_gp_a!=-1);
724   OP_ASSERT(_gp_b!=-1);
725   /*Handle the wrapping cases.*/
726   if(OP_UNLIKELY(_gp_a<0)){
727     if(_gp_b>=0)return 1;
728     /*Else fall through.*/
729   }
730   else if(OP_UNLIKELY(_gp_b<0))return -1;
731   /*No wrapping case.*/
732   return (_gp_a>_gp_b)-(_gp_b>_gp_a);
733 }
734
735 /*Returns the duration of the packet (in samples at 48 kHz), or a negative
736    value on error.*/
737 static int op_get_packet_duration(const unsigned char *_data,int _len){
738   int nframes;
739   int frame_size;
740   int nsamples;
741   nframes=opus_packet_get_nb_frames(_data,_len);
742   if(OP_UNLIKELY(nframes<0))return OP_EBADPACKET;
743   frame_size=opus_packet_get_samples_per_frame(_data,48000);
744   nsamples=nframes*frame_size;
745   if(OP_UNLIKELY(nsamples>120*48))return OP_EBADPACKET;
746   return nsamples;
747 }
748
749 /*This function more properly belongs in info.c, but we define it here to allow
750    the static granule position manipulation functions to remain static.*/
751 ogg_int64_t opus_granule_sample(const OpusHead *_head,ogg_int64_t _gp){
752   opus_int32 pre_skip;
753   pre_skip=_head->pre_skip;
754   if(_gp!=-1&&op_granpos_add(&_gp,_gp,-pre_skip))_gp=-1;
755   return _gp;
756 }
757
758 /*Grab all the packets currently in the stream state, and compute their
759    durations.
760   _of->op_count is set to the number of packets collected.
761   [out] _durations: Returns the durations of the individual packets.
762   Return: The total duration of all packets, or OP_HOLE if there was a hole.*/
763 static opus_int32 op_collect_audio_packets(OggOpusFile *_of,
764  int _durations[255]){
765   opus_int32 total_duration;
766   int        op_count;
767   /*Count the durations of all packets in the page.*/
768   op_count=0;
769   total_duration=0;
770   for(;;){
771     int ret;
772     /*This takes advantage of undocumented libogg behavior that returned
773        ogg_packet buffers are valid at least until the next page is
774        submitted.
775       Relying on this is not too terrible, as _none_ of the Ogg memory
776        ownership/lifetime rules are well-documented.
777       But I can read its code and know this will work.*/
778     ret=ogg_stream_packetout(&_of->os,_of->op+op_count);
779     if(!ret)break;
780     if(OP_UNLIKELY(ret<0)){
781       /*We shouldn't get holes in the middle of pages.*/
782       OP_ASSERT(op_count==0);
783       /*Set the return value and break out of the loop.
784         We want to make sure op_count gets set to 0, because we've ingested a
785          page, so any previously loaded packets are now invalid.*/
786       total_duration=OP_HOLE;
787       break;
788     }
789     /*Unless libogg is broken, we can't get more than 255 packets from a
790        single page.*/
791     OP_ASSERT(op_count<255);
792     _durations[op_count]=op_get_packet_duration(_of->op[op_count].packet,
793      _of->op[op_count].bytes);
794     if(OP_LIKELY(_durations[op_count]>0)){
795       /*With at most 255 packets on a page, this can't overflow.*/
796       total_duration+=_durations[op_count++];
797     }
798     /*Ignore packets with an invalid TOC sequence.*/
799     else if(op_count>0){
800       /*But save the granule position, if there was one.*/
801       _of->op[op_count-1].granulepos=_of->op[op_count].granulepos;
802     }
803   }
804   _of->op_pos=0;
805   _of->op_count=op_count;
806   return total_duration;
807 }
808
809 /*Starting from current cursor position, get the initial PCM offset of the next
810    page.
811   This also validates the granule position on the first page with a completed
812    audio data packet, as required by the spec.
813   If this link is completely empty (no pages with completed packets), then this
814    function sets pcm_start=pcm_end=0 and returns the BOS page of the next link
815    (if any).
816   In the seekable case, we initialize pcm_end=-1 before calling this function,
817    so that later we can detect that the link was empty before calling
818    op_find_final_pcm_offset().
819   [inout] _link: The link for which to find pcm_start.
820   [out] _og:     Returns the BOS page of the next link if this link was empty.
821                  In the unseekable case, we can then feed this to
822                   op_fetch_headers() to start the next link.
823                  The caller may pass NULL (e.g., for seekable streams), in
824                   which case this page will be discarded.
825   Return: 0 on success, 1 if there is a buffered BOS page available, or a
826            negative value on unrecoverable error.*/
827 static int op_find_initial_pcm_offset(OggOpusFile *_of,
828  OggOpusLink *_link,ogg_page *_og){
829   ogg_page     og;
830   opus_int64   page_offset;
831   ogg_int64_t  pcm_start;
832   ogg_int64_t  prev_packet_gp;
833   ogg_int64_t  cur_page_gp;
834   ogg_uint32_t serialno;
835   opus_int32   total_duration;
836   int          durations[255];
837   int          cur_page_eos;
838   int          op_count;
839   int          pi;
840   if(_og==NULL)_og=&og;
841   serialno=_of->os.serialno;
842   op_count=0;
843   /*We shouldn't have to initialize total_duration, but gcc is too dumb to
844      figure out that op_count>0 implies we've been through the whole loop at
845      least once.*/
846   total_duration=0;
847   do{
848     page_offset=op_get_next_page(_of,_og,_of->end);
849     /*We should get a page unless the file is truncated or mangled.
850       Otherwise there are no audio data packets in the whole logical stream.*/
851     if(OP_UNLIKELY(page_offset<0)){
852       /*Fail if there was a read error.*/
853       if(page_offset<OP_FALSE)return (int)page_offset;
854       /*Fail if the pre-skip is non-zero, since it's asking us to skip more
855          samples than exist.*/
856       if(_link->head.pre_skip>0)return OP_EBADTIMESTAMP;
857       /*Set pcm_end and end_offset so we can skip the call to
858          op_find_final_pcm_offset().*/
859       _link->pcm_start=_link->pcm_end=0;
860       _link->end_offset=_link->data_offset;
861       return 0;
862     }
863     /*Similarly, if we hit the next link in the chain, we've gone too far.*/
864     if(OP_UNLIKELY(ogg_page_bos(_og))){
865       if(_link->head.pre_skip>0)return OP_EBADTIMESTAMP;
866       /*Set pcm_end and end_offset so we can skip the call to
867          op_find_final_pcm_offset().*/
868       _link->pcm_end=_link->pcm_start=0;
869       _link->end_offset=_link->data_offset;
870       /*Tell the caller we've got a buffered page for them.*/
871       return 1;
872     }
873     /*Ignore pages from other streams (not strictly necessary, because of the
874        checks in ogg_stream_pagein(), but saves some work).*/
875     if(serialno!=(ogg_uint32_t)ogg_page_serialno(_og))continue;
876     ogg_stream_pagein(&_of->os,_og);
877     /*Bitrate tracking: add the header's bytes here.
878       The body bytes are counted when we consume the packets.*/
879     _of->bytes_tracked+=_og->header_len;
880     /*Count the durations of all packets in the page.*/
881     do total_duration=op_collect_audio_packets(_of,durations);
882     /*Ignore holes.*/
883     while(OP_UNLIKELY(total_duration<0));
884     op_count=_of->op_count;
885   }
886   while(op_count<=0);
887   /*We found the first page with a completed audio data packet: actually look
888      at the granule position.
889     RFC 3533 says, "A special value of -1 (in two's complement) indicates that
890      no packets finish on this page," which does not say that a granule
891      position that is NOT -1 indicates that some packets DO finish on that page
892      (even though this was the intention, libogg itself violated this intention
893      for years before we fixed it).
894     The Ogg Opus specification only imposes its start-time requirements
895      on the granule position of the first page with completed packets,
896      so we ignore any set granule positions until then.*/
897   cur_page_gp=_of->op[op_count-1].granulepos;
898   /*But getting a packet without a valid granule position on the page is not
899      okay.*/
900   if(cur_page_gp==-1)return OP_EBADTIMESTAMP;
901   cur_page_eos=_of->op[op_count-1].e_o_s;
902   if(OP_LIKELY(!cur_page_eos)){
903     /*The EOS flag wasn't set.
904       Work backwards from the provided granule position to get the starting PCM
905        offset.*/
906     if(OP_UNLIKELY(op_granpos_add(&pcm_start,cur_page_gp,-total_duration)<0)){
907       /*The starting granule position MUST not be smaller than the amount of
908          audio on the first page with completed packets.*/
909       return OP_EBADTIMESTAMP;
910     }
911   }
912   else{
913     /*The first page with completed packets was also the last.*/
914     if(OP_LIKELY(op_granpos_add(&pcm_start,cur_page_gp,-total_duration)<0)){
915       /*If there's less audio on the page than indicated by the granule
916          position, then we're doing end-trimming, and the starting PCM offset
917          is zero by spec mandate.*/
918       pcm_start=0;
919       /*However, the end-trimming MUST not ask us to trim more samples than
920          exist after applying the pre-skip.*/
921       if(OP_UNLIKELY(op_granpos_cmp(cur_page_gp,_link->head.pre_skip)<0)){
922         return OP_EBADTIMESTAMP;
923       }
924     }
925   }
926   /*Timestamp the individual packets.*/
927   prev_packet_gp=pcm_start;
928   for(pi=0;pi<op_count;pi++){
929     if(cur_page_eos){
930       ogg_int64_t diff;
931       OP_ALWAYS_TRUE(!op_granpos_diff(&diff,cur_page_gp,prev_packet_gp));
932       diff=durations[pi]-diff;
933       /*If we have samples to trim...*/
934       if(diff>0){
935         /*If we trimmed the entire packet, stop (the spec says encoders
936            shouldn't do this, but we support it anyway).*/
937         if(OP_UNLIKELY(diff>durations[pi]))break;
938         _of->op[pi].granulepos=prev_packet_gp=cur_page_gp;
939         /*Move the EOS flag to this packet, if necessary, so we'll trim the
940            samples.*/
941         _of->op[pi].e_o_s=1;
942         continue;
943       }
944     }
945     /*Update the granule position as normal.*/
946     OP_ALWAYS_TRUE(!op_granpos_add(&_of->op[pi].granulepos,
947      prev_packet_gp,durations[pi]));
948     prev_packet_gp=_of->op[pi].granulepos;
949   }
950   /*Update the packet count after end-trimming.*/
951   _of->op_count=pi;
952   _of->cur_discard_count=_link->head.pre_skip;
953   _of->prev_packet_gp=_link->pcm_start=pcm_start;
954   _of->prev_page_offset=page_offset;
955   return 0;
956 }
957
958 /*Starting from current cursor position, get the final PCM offset of the
959    previous page.
960   This also validates the duration of the link, which, while not strictly
961    required by the spec, we need to ensure duration calculations don't
962    overflow.
963   This is only done for seekable sources.
964   We must validate that op_find_initial_pcm_offset() succeeded for this link
965    before calling this function, otherwise it will scan the entire stream
966    backwards until it reaches the start, and then fail.*/
967 static int op_find_final_pcm_offset(OggOpusFile *_of,
968  const ogg_uint32_t *_serialnos,int _nserialnos,OggOpusLink *_link,
969  opus_int64 _offset,ogg_uint32_t _end_serialno,ogg_int64_t _end_gp,
970  ogg_int64_t *_total_duration){
971   ogg_int64_t  total_duration;
972   ogg_int64_t  duration;
973   ogg_uint32_t cur_serialno;
974   /*For the time being, fetch end PCM offset the simple way.*/
975   cur_serialno=_link->serialno;
976   if(_end_serialno!=cur_serialno||_end_gp==-1){
977     _offset=op_get_last_page(_of,&_end_gp,_offset,
978      cur_serialno,_serialnos,_nserialnos);
979     if(OP_UNLIKELY(_offset<0))return (int)_offset;
980   }
981   /*At worst we should have found the first page with completed packets.*/
982   if(OP_UNLIKELY(_offset<_link->data_offset))return OP_EBADLINK;
983   /*This implementation requires that the difference between the first and last
984      granule positions in each link be representable in a signed, 64-bit
985      number, and that each link also have at least as many samples as the
986      pre-skip requires.*/
987   if(OP_UNLIKELY(op_granpos_diff(&duration,_end_gp,_link->pcm_start)<0)
988    ||OP_UNLIKELY(duration<_link->head.pre_skip)){
989     return OP_EBADTIMESTAMP;
990   }
991   /*We also require that the total duration be representable in a signed,
992      64-bit number.*/
993   duration-=_link->head.pre_skip;
994   total_duration=*_total_duration;
995   if(OP_UNLIKELY(OP_INT64_MAX-duration<total_duration))return OP_EBADTIMESTAMP;
996   *_total_duration=total_duration+duration;
997   _link->pcm_end=_end_gp;
998   _link->end_offset=_offset;
999   return 0;
1000 }
1001
1002 /*Rescale the number _x from the range [0,_from] to [0,_to].
1003   _from and _to must be positive.*/
1004 static opus_int64 op_rescale64(opus_int64 _x,opus_int64 _from,opus_int64 _to){
1005   opus_int64 frac;
1006   opus_int64 ret;
1007   int        i;
1008   if(_x>=_from)return _to;
1009   if(_x<=0)return 0;
1010   frac=0;
1011   for(i=0;i<63;i++){
1012     frac<<=1;
1013     OP_ASSERT(_x<=_from);
1014     if(_x>=_from>>1){
1015       _x-=_from-_x;
1016       frac|=1;
1017     }
1018     else _x<<=1;
1019   }
1020   ret=0;
1021   for(i=0;i<63;i++){
1022     if(frac&1)ret=(ret&_to&1)+(ret>>1)+(_to>>1);
1023     else ret>>=1;
1024     frac>>=1;
1025   }
1026   return ret;
1027 }
1028
1029 /*The minimum granule position spacing allowed for making predictions.
1030   This corresponds to about 1 second of audio at 48 kHz for both Opus and
1031    Vorbis, or one keyframe interval in Theora with the default keyframe spacing
1032    of 256.*/
1033 #define OP_GP_SPACING_MIN (48000)
1034
1035 /*Try to estimate the location of the next link using the current seek
1036    records, assuming the initial granule position of any streams we've found is
1037    0.*/
1038 static opus_int64 op_predict_link_start(const OpusSeekRecord *_sr,int _nsr,
1039  opus_int64 _searched,opus_int64 _end_searched,opus_int32 _bias){
1040   opus_int64 bisect;
1041   int        sri;
1042   int        srj;
1043   /*Require that we be at least OP_CHUNK_SIZE from the end.
1044     We don't require that we be at least OP_CHUNK_SIZE from the beginning,
1045      because if we are we'll just scan forward without seeking.*/
1046   _end_searched-=OP_CHUNK_SIZE;
1047   if(_searched>=_end_searched)return -1;
1048   bisect=_end_searched;
1049   for(sri=0;sri<_nsr;sri++){
1050     ogg_int64_t  gp1;
1051     ogg_int64_t  gp2_min;
1052     ogg_uint32_t serialno1;
1053     opus_int64   offset1;
1054     /*If the granule position is negative, either it's invalid or we'd cause
1055        overflow.*/
1056     gp1=_sr[sri].gp;
1057     if(gp1<0)continue;
1058     /*We require some minimum distance between granule positions to make an
1059        estimate.
1060       We don't actually know what granule position scheme is being used,
1061        because we have no idea what kind of stream these came from.
1062       Therefore we require a minimum spacing between them, with the
1063        expectation that while bitrates and granule position increments might
1064        vary locally in quite complex ways, they are globally smooth.*/
1065     if(OP_UNLIKELY(op_granpos_add(&gp2_min,gp1,OP_GP_SPACING_MIN)<0)){
1066       /*No granule position would satisfy us.*/
1067       continue;
1068     }
1069     offset1=_sr[sri].offset;
1070     serialno1=_sr[sri].serialno;
1071     for(srj=sri;srj-->0;){
1072       ogg_int64_t gp2;
1073       opus_int64  offset2;
1074       opus_int64  num;
1075       ogg_int64_t den;
1076       ogg_int64_t ipart;
1077       gp2=_sr[srj].gp;
1078       if(gp2<gp2_min)continue;
1079       /*Oh, and also make sure these came from the same stream.*/
1080       if(_sr[srj].serialno!=serialno1)continue;
1081       offset2=_sr[srj].offset;
1082       /*For once, we can subtract with impunity.*/
1083       den=gp2-gp1;
1084       ipart=gp2/den;
1085       num=offset2-offset1;
1086       OP_ASSERT(num>0);
1087       if(ipart>0&&(offset2-_searched)/ipart<num)continue;
1088       offset2-=ipart*num;
1089       gp2-=ipart*den;
1090       offset2-=op_rescale64(gp2,den,num)-_bias;
1091       if(offset2<_searched)continue;
1092       bisect=OP_MIN(bisect,offset2);
1093       break;
1094     }
1095   }
1096   return bisect>=_end_searched?-1:bisect;
1097 }
1098
1099 /*Finds each bitstream link, one at a time, using a bisection search.
1100   This has to begin by knowing the offset of the first link's initial page.*/
1101 static int op_bisect_forward_serialno(OggOpusFile *_of,
1102  opus_int64 _searched,OpusSeekRecord *_sr,int _csr,
1103  ogg_uint32_t **_serialnos,int *_nserialnos,int *_cserialnos){
1104   ogg_page      og;
1105   OggOpusLink  *links;
1106   int           nlinks;
1107   int           clinks;
1108   ogg_uint32_t *serialnos;
1109   int           nserialnos;
1110   ogg_int64_t   total_duration;
1111   int           nsr;
1112   int           ret;
1113   links=_of->links;
1114   nlinks=clinks=_of->nlinks;
1115   total_duration=0;
1116   /*We start with one seek record, for the last page in the file.
1117     We build up a list of records for places we seek to during link
1118      enumeration.
1119     This list is kept sorted in reverse order.
1120     We only care about seek locations that were _not_ in the current link,
1121      therefore we can add them one at a time to the end of the list as we
1122      improve the lower bound on the location where the next link starts.*/
1123   nsr=1;
1124   for(;;){
1125     opus_int64  end_searched;
1126     opus_int64  bisect;
1127     opus_int64  next;
1128     opus_int64  last;
1129     ogg_int64_t end_offset;
1130     ogg_int64_t end_gp;
1131     int         sri;
1132     serialnos=*_serialnos;
1133     nserialnos=*_nserialnos;
1134     if(OP_UNLIKELY(nlinks>=clinks)){
1135       if(OP_UNLIKELY(clinks>INT_MAX-1>>1))return OP_EFAULT;
1136       clinks=2*clinks+1;
1137       OP_ASSERT(nlinks<clinks);
1138       links=(OggOpusLink *)_ogg_realloc(links,sizeof(*links)*clinks);
1139       if(OP_UNLIKELY(links==NULL))return OP_EFAULT;
1140       _of->links=links;
1141     }
1142     /*Invariants:
1143       We have the headers and serial numbers for the link beginning at 'begin'.
1144       We have the offset and granule position of the last page in the file
1145        (potentially not a page we care about).*/
1146     /*Scan the seek records we already have to save us some bisection.*/
1147     for(sri=0;sri<nsr;sri++){
1148       if(op_lookup_serialno(_sr[sri].serialno,serialnos,nserialnos))break;
1149     }
1150     /*Is the last page in our current list of serial numbers?*/
1151     if(sri<=0)break;
1152     /*Last page wasn't found.
1153       We have at least one more link.*/
1154     last=-1;
1155     end_searched=_sr[sri-1].search_start;
1156     next=_sr[sri-1].offset;
1157     end_gp=-1;
1158     if(sri<nsr){
1159       _searched=_sr[sri].offset+_sr[sri].size;
1160       if(_sr[sri].serialno==links[nlinks-1].serialno){
1161         end_gp=_sr[sri].gp;
1162         end_offset=_sr[sri].offset;
1163       }
1164     }
1165     nsr=sri;
1166     bisect=-1;
1167     /*If we've already found the end of at least one link, try to pick the
1168        first bisection point at twice the average link size.
1169       This is a good choice for files with lots of links that are all about the
1170        same size.*/
1171     if(nlinks>1){
1172       opus_int64 last_offset;
1173       opus_int64 avg_link_size;
1174       opus_int64 upper_limit;
1175       last_offset=links[nlinks-1].offset;
1176       avg_link_size=last_offset/(nlinks-1);
1177       upper_limit=end_searched-OP_CHUNK_SIZE-avg_link_size;
1178       if(OP_LIKELY(last_offset>_searched-avg_link_size)
1179        &&OP_LIKELY(last_offset<upper_limit)){
1180         bisect=last_offset+avg_link_size;
1181         if(OP_LIKELY(bisect<upper_limit))bisect+=avg_link_size;
1182       }
1183     }
1184     /*We guard against garbage separating the last and first pages of two
1185        links below.*/
1186     while(_searched<end_searched){
1187       opus_int32 next_bias;
1188       /*If we don't have a better estimate, use simple bisection.*/
1189       if(bisect==-1)bisect=_searched+(end_searched-_searched>>1);
1190       /*If we're within OP_CHUNK_SIZE of the start, scan forward.*/
1191       if(bisect-_searched<OP_CHUNK_SIZE)bisect=_searched;
1192       /*Otherwise we're skipping data.
1193         Forget the end page, if we saw one, as we might miss a later one.*/
1194       else end_gp=-1;
1195       ret=op_seek_helper(_of,bisect);
1196       if(OP_UNLIKELY(ret<0))return ret;
1197       last=op_get_next_page(_of,&og,_sr[nsr-1].offset);
1198       if(OP_UNLIKELY(last<OP_FALSE))return (int)last;
1199       next_bias=0;
1200       if(last==OP_FALSE)end_searched=bisect;
1201       else{
1202         ogg_uint32_t serialno;
1203         ogg_int64_t  gp;
1204         serialno=ogg_page_serialno(&og);
1205         gp=ogg_page_granulepos(&og);
1206         if(!op_lookup_serialno(serialno,serialnos,nserialnos)){
1207           end_searched=bisect;
1208           next=last;
1209           /*In reality we should always have enough room, but be paranoid.*/
1210           if(OP_LIKELY(nsr<_csr)){
1211             _sr[nsr].search_start=bisect;
1212             _sr[nsr].offset=last;
1213             OP_ASSERT(_of->offset-last>=0);
1214             OP_ASSERT(_of->offset-last<=OP_PAGE_SIZE_MAX);
1215             _sr[nsr].size=(opus_int32)(_of->offset-last);
1216             _sr[nsr].serialno=serialno;
1217             _sr[nsr].gp=gp;
1218             nsr++;
1219           }
1220         }
1221         else{
1222           _searched=_of->offset;
1223           next_bias=OP_CHUNK_SIZE;
1224           if(serialno==links[nlinks-1].serialno){
1225             /*This page was from the stream we want, remember it.
1226               If it's the last such page in the link, we won't have to go back
1227                looking for it later.*/
1228             end_gp=gp;
1229             end_offset=last;
1230           }
1231         }
1232       }
1233       bisect=op_predict_link_start(_sr,nsr,_searched,end_searched,next_bias);
1234     }
1235     /*Bisection point found.
1236       Get the final granule position of the previous link, assuming
1237        op_find_initial_pcm_offset() didn't already determine the link was
1238        empty.*/
1239     if(OP_LIKELY(links[nlinks-1].pcm_end==-1)){
1240       if(end_gp==-1){
1241         /*If we don't know where the end page is, we'll have to seek back and
1242            look for it, starting from the end of the link.*/
1243         end_offset=next;
1244         /*Also forget the last page we read.
1245           It won't be available after the seek.*/
1246         last=-1;
1247       }
1248       ret=op_find_final_pcm_offset(_of,serialnos,nserialnos,
1249        links+nlinks-1,end_offset,links[nlinks-1].serialno,end_gp,
1250        &total_duration);
1251       if(OP_UNLIKELY(ret<0))return ret;
1252     }
1253     if(last!=next){
1254       /*The last page we read was not the first page the next link.
1255         Move the cursor position to the offset of that first page.
1256         This only performs an actual seek if the first page of the next link
1257          does not start at the end of the last page from the current Opus
1258          stream with a valid granule position.*/
1259       ret=op_seek_helper(_of,next);
1260       if(OP_UNLIKELY(ret<0))return ret;
1261     }
1262     ret=op_fetch_headers(_of,&links[nlinks].head,&links[nlinks].tags,
1263      _serialnos,_nserialnos,_cserialnos,last!=next?NULL:&og);
1264     if(OP_UNLIKELY(ret<0))return ret;
1265     links[nlinks].offset=next;
1266     links[nlinks].data_offset=_of->offset;
1267     links[nlinks].serialno=_of->os.serialno;
1268     links[nlinks].pcm_end=-1;
1269     /*This might consume a page from the next link, however the next bisection
1270        always starts with a seek.*/
1271     ret=op_find_initial_pcm_offset(_of,links+nlinks,NULL);
1272     if(OP_UNLIKELY(ret<0))return ret;
1273     _searched=_of->offset;
1274     /*Mark the current link count so it can be cleaned up on error.*/
1275     _of->nlinks=++nlinks;
1276   }
1277   /*Last page is in the starting serialno list, so we've reached the last link.
1278     Now find the last granule position for it (if we didn't the first time we
1279      looked at the end of the stream, and if op_find_initial_pcm_offset()
1280      didn't already determine the link was empty).*/
1281   if(OP_LIKELY(links[nlinks-1].pcm_end==-1)){
1282     ret=op_find_final_pcm_offset(_of,serialnos,nserialnos,
1283      links+nlinks-1,_sr[0].offset,_sr[0].serialno,_sr[0].gp,&total_duration);
1284     if(OP_UNLIKELY(ret<0))return ret;
1285   }
1286   /*Trim back the links array if necessary.*/
1287   links=(OggOpusLink *)_ogg_realloc(links,sizeof(*links)*nlinks);
1288   if(OP_LIKELY(links!=NULL))_of->links=links;
1289   /*We also don't need these anymore.*/
1290   _ogg_free(*_serialnos);
1291   *_serialnos=NULL;
1292   *_cserialnos=*_nserialnos=0;
1293   return 0;
1294 }
1295
1296 static void op_update_gain(OggOpusFile *_of){
1297   OpusHead   *head;
1298   opus_int32  gain_q8;
1299   int         li;
1300   /*If decode isn't ready, then we'll apply the gain when we initialize the
1301      decoder.*/
1302   if(_of->ready_state<OP_INITSET)return;
1303   gain_q8=_of->gain_offset_q8;
1304   li=_of->seekable?_of->cur_link:0;
1305   head=&_of->links[li].head;
1306   /*We don't have to worry about overflow here because the header gain and
1307      track gain must lie in the range [-32768,32767], and the user-supplied
1308      offset has been pre-clamped to [-98302,98303].*/
1309   switch(_of->gain_type){
1310     case OP_ALBUM_GAIN:{
1311       int album_gain_q8;
1312       album_gain_q8=0;
1313       opus_tags_get_album_gain(&_of->links[li].tags,&album_gain_q8);
1314       gain_q8+=album_gain_q8;
1315       gain_q8+=head->output_gain;
1316     }break;
1317     case OP_TRACK_GAIN:{
1318       int track_gain_q8;
1319       track_gain_q8=0;
1320       opus_tags_get_track_gain(&_of->links[li].tags,&track_gain_q8);
1321       gain_q8+=track_gain_q8;
1322       gain_q8+=head->output_gain;
1323     }break;
1324     case OP_HEADER_GAIN:gain_q8+=head->output_gain;break;
1325     case OP_ABSOLUTE_GAIN:break;
1326     default:OP_ASSERT(0);
1327   }
1328   gain_q8=OP_CLAMP(-32768,gain_q8,32767);
1329   OP_ASSERT(_of->od!=NULL);
1330 #if defined(OPUS_SET_GAIN)
1331   opus_multistream_decoder_ctl(_of->od,OPUS_SET_GAIN(gain_q8));
1332 #else
1333 /*A fallback that works with both float and fixed-point is a bunch of work,
1334    so just force people to use a sufficiently new version.
1335   This is deployed well enough at this point that this shouldn't be a burden.*/
1336 # error "libopus 1.0.1 or later required"
1337 #endif
1338 }
1339
1340 static int op_make_decode_ready(OggOpusFile *_of){
1341   const OpusHead *head;
1342   int             li;
1343   int             stream_count;
1344   int             coupled_count;
1345   int             channel_count;
1346   if(_of->ready_state>OP_STREAMSET)return 0;
1347   if(OP_UNLIKELY(_of->ready_state<OP_STREAMSET))return OP_EFAULT;
1348   li=_of->seekable?_of->cur_link:0;
1349   head=&_of->links[li].head;
1350   stream_count=head->stream_count;
1351   coupled_count=head->coupled_count;
1352   channel_count=head->channel_count;
1353   /*Check to see if the current decoder is compatible with the current link.*/
1354   if(_of->od!=NULL&&_of->od_stream_count==stream_count
1355    &&_of->od_coupled_count==coupled_count&&_of->od_channel_count==channel_count
1356    &&memcmp(_of->od_mapping,head->mapping,
1357    sizeof(*head->mapping)*channel_count)==0){
1358     opus_multistream_decoder_ctl(_of->od,OPUS_RESET_STATE);
1359   }
1360   else{
1361     int err;
1362     opus_multistream_decoder_destroy(_of->od);
1363     _of->od=opus_multistream_decoder_create(48000,channel_count,
1364      stream_count,coupled_count,head->mapping,&err);
1365     if(_of->od==NULL)return OP_EFAULT;
1366     _of->od_stream_count=stream_count;
1367     _of->od_coupled_count=coupled_count;
1368     _of->od_channel_count=channel_count;
1369     memcpy(_of->od_mapping,head->mapping,sizeof(*head->mapping)*channel_count);
1370   }
1371   _of->ready_state=OP_INITSET;
1372   _of->bytes_tracked=0;
1373   _of->samples_tracked=0;
1374 #if !defined(OP_FIXED_POINT)
1375   _of->state_channel_count=0;
1376   /*Use the serial number for the PRNG seed to get repeatable output for
1377      straight play-throughs.*/
1378   _of->dither_seed=_of->links[li].serialno;
1379 #endif
1380   op_update_gain(_of);
1381   return 0;
1382 }
1383
1384 static int op_open_seekable2_impl(OggOpusFile *_of){
1385   /*64 seek records should be enough for anybody.
1386     Actually, with a bisection search in a 63-bit range down to OP_CHUNK_SIZE
1387      granularity, much more than enough.*/
1388   OpusSeekRecord sr[64];
1389   opus_int64     data_offset;
1390   int            ret;
1391   /*We can seek, so set out learning all about this file.*/
1392   (*_of->callbacks.seek)(_of->source,0,SEEK_END);
1393   _of->offset=_of->end=(*_of->callbacks.tell)(_of->source);
1394   if(OP_UNLIKELY(_of->end<0))return OP_EREAD;
1395   data_offset=_of->links[0].data_offset;
1396   if(OP_UNLIKELY(_of->end<data_offset))return OP_EBADLINK;
1397   /*Get the offset of the last page of the physical bitstream, or, if we're
1398      lucky, the last Opus page of the first link, as most Ogg Opus files will
1399      contain a single logical bitstream.*/
1400   ret=op_get_prev_page_serial(_of,sr,_of->end,
1401    _of->links[0].serialno,_of->serialnos,_of->nserialnos);
1402   if(OP_UNLIKELY(ret<0))return ret;
1403   /*If there's any trailing junk, forget about it.*/
1404   _of->end=sr[0].offset+sr[0].size;
1405   if(OP_UNLIKELY(_of->end<data_offset))return OP_EBADLINK;
1406   /*Now enumerate the bitstream structure.*/
1407   return op_bisect_forward_serialno(_of,data_offset,sr,sizeof(sr)/sizeof(*sr),
1408    &_of->serialnos,&_of->nserialnos,&_of->cserialnos);
1409 }
1410
1411 static int op_open_seekable2(OggOpusFile *_of){
1412   ogg_sync_state    oy_start;
1413   ogg_stream_state  os_start;
1414   ogg_packet       *op_start;
1415   opus_int64        prev_page_offset;
1416   opus_int64        start_offset;
1417   int               start_op_count;
1418   int               ret;
1419   /*We're partially open and have a first link header state in storage in _of.
1420     Save off that stream state so we can come back to it.
1421     It would be simpler to just dump all this state and seek back to
1422      links[0].data_offset when we're done.
1423     But we do the extra work to allow us to seek back to _exactly_ the same
1424      stream position we're at now.
1425     This allows, e.g., the HTTP backend to continue reading from the original
1426      connection (if it's still available), instead of opening a new one.
1427     This means we can open and start playing a normal Opus file with a single
1428      link and reasonable packet sizes using only two HTTP requests.*/
1429   start_op_count=_of->op_count;
1430   /*This is a bit too large to put on the stack unconditionally.*/
1431   op_start=(ogg_packet *)_ogg_malloc(sizeof(*op_start)*start_op_count);
1432   if(op_start==NULL)return OP_EFAULT;
1433   *&oy_start=_of->oy;
1434   *&os_start=_of->os;
1435   prev_page_offset=_of->prev_page_offset;
1436   start_offset=_of->offset;
1437   memcpy(op_start,_of->op,sizeof(*op_start)*start_op_count);
1438   OP_ASSERT((*_of->callbacks.tell)(_of->source)==op_position(_of));
1439   ogg_sync_init(&_of->oy);
1440   ogg_stream_init(&_of->os,-1);
1441   ret=op_open_seekable2_impl(_of);
1442   /*Restore the old stream state.*/
1443   ogg_stream_clear(&_of->os);
1444   ogg_sync_clear(&_of->oy);
1445   *&_of->oy=*&oy_start;
1446   *&_of->os=*&os_start;
1447   _of->offset=start_offset;
1448   _of->op_count=start_op_count;
1449   memcpy(_of->op,op_start,sizeof(*_of->op)*start_op_count);
1450   _ogg_free(op_start);
1451   _of->prev_packet_gp=_of->links[0].pcm_start;
1452   _of->prev_page_offset=prev_page_offset;
1453   _of->cur_discard_count=_of->links[0].head.pre_skip;
1454   if(OP_UNLIKELY(ret<0))return ret;
1455   /*And restore the position indicator.*/
1456   ret=(*_of->callbacks.seek)(_of->source,op_position(_of),SEEK_SET);
1457   return OP_UNLIKELY(ret<0)?OP_EREAD:0;
1458 }
1459
1460 /*Clear out the current logical bitstream decoder.*/
1461 static void op_decode_clear(OggOpusFile *_of){
1462   /*We don't actually free the decoder.
1463     We might be able to re-use it for the next link.*/
1464   _of->op_count=0;
1465   _of->od_buffer_size=0;
1466   _of->prev_packet_gp=-1;
1467   _of->prev_page_offset=-1;
1468   if(!_of->seekable){
1469     OP_ASSERT(_of->ready_state>=OP_INITSET);
1470     opus_tags_clear(&_of->links[0].tags);
1471   }
1472   _of->ready_state=OP_OPENED;
1473 }
1474
1475 static void op_clear(OggOpusFile *_of){
1476   OggOpusLink *links;
1477   _ogg_free(_of->od_buffer);
1478   if(_of->od!=NULL)opus_multistream_decoder_destroy(_of->od);
1479   links=_of->links;
1480   if(!_of->seekable){
1481     if(_of->ready_state>OP_OPENED||_of->ready_state==OP_PARTOPEN){
1482       opus_tags_clear(&links[0].tags);
1483     }
1484   }
1485   else if(OP_LIKELY(links!=NULL)){
1486     int nlinks;
1487     int link;
1488     nlinks=_of->nlinks;
1489     for(link=0;link<nlinks;link++)opus_tags_clear(&links[link].tags);
1490   }
1491   _ogg_free(links);
1492   _ogg_free(_of->serialnos);
1493   ogg_stream_clear(&_of->os);
1494   ogg_sync_clear(&_of->oy);
1495   if(_of->callbacks.close!=NULL)(*_of->callbacks.close)(_of->source);
1496 }
1497
1498 static int op_open1(OggOpusFile *_of,
1499  void *_source,const OpusFileCallbacks *_cb,
1500  const unsigned char *_initial_data,size_t _initial_bytes){
1501   ogg_page  og;
1502   ogg_page *pog;
1503   int       seekable;
1504   int       ret;
1505   memset(_of,0,sizeof(*_of));
1506   _of->end=-1;
1507   _of->source=_source;
1508   *&_of->callbacks=*_cb;
1509   /*At a minimum, we need to be able to read data.*/
1510   if(OP_UNLIKELY(_of->callbacks.read==NULL))return OP_EREAD;
1511   /*Initialize the framing state.*/
1512   ogg_sync_init(&_of->oy);
1513   /*Perhaps some data was previously read into a buffer for testing against
1514      other stream types.
1515     Allow initialization from this previously read data (especially as we may
1516      be reading from a non-seekable stream).
1517     This requires copying it into a buffer allocated by ogg_sync_buffer() and
1518      doesn't support seeking, so this is not a good mechanism to use for
1519      decoding entire files from RAM.*/
1520   if(_initial_bytes>0){
1521     char *buffer;
1522     buffer=ogg_sync_buffer(&_of->oy,_initial_bytes);
1523     memcpy(buffer,_initial_data,_initial_bytes*sizeof(*buffer));
1524     ogg_sync_wrote(&_of->oy,_initial_bytes);
1525   }
1526   /*Can we seek?
1527     Stevens suggests the seek test is portable.*/
1528   seekable=_cb->seek!=NULL&&(*_cb->seek)(_source,0,SEEK_CUR)!=-1;
1529   /*If seek is implemented, tell must also be implemented.*/
1530   if(seekable){
1531     opus_int64 pos;
1532     if(OP_UNLIKELY(_of->callbacks.tell==NULL))return OP_EINVAL;
1533     pos=(*_of->callbacks.tell)(_of->source);
1534     /*If the current position is not equal to the initial bytes consumed,
1535        absolute seeking will not work.*/
1536     if(OP_UNLIKELY(pos!=(opus_int64)_initial_bytes))return OP_EINVAL;
1537   }
1538   _of->seekable=seekable;
1539   /*Don't seek yet.
1540     Set up a 'single' (current) logical bitstream entry for partial open.*/
1541   _of->links=(OggOpusLink *)_ogg_malloc(sizeof(*_of->links));
1542   /*The serialno gets filled in later by op_fetch_headers().*/
1543   ogg_stream_init(&_of->os,-1);
1544   pog=NULL;
1545   for(;;){
1546     /*Fetch all BOS pages, store the Opus header and all seen serial numbers,
1547       and load subsequent Opus setup headers.*/
1548     ret=op_fetch_headers(_of,&_of->links[0].head,&_of->links[0].tags,
1549      &_of->serialnos,&_of->nserialnos,&_of->cserialnos,pog);
1550     if(OP_UNLIKELY(ret<0))break;
1551     _of->nlinks=1;
1552     _of->links[0].offset=0;
1553     _of->links[0].data_offset=_of->offset;
1554     _of->links[0].pcm_end=-1;
1555     _of->links[0].serialno=_of->os.serialno;
1556     /*Fetch the initial PCM offset.*/
1557     ret=op_find_initial_pcm_offset(_of,_of->links,&og);
1558     if(seekable||OP_LIKELY(ret<=0))break;
1559     /*This link was empty, but we already have the BOS page for the next one in
1560        og.
1561       We can't seek, so start processing the next link right now.*/
1562     opus_tags_clear(&_of->links[0].tags);
1563     _of->nlinks=0;
1564     if(!seekable)_of->cur_link++;
1565     pog=&og;
1566   }
1567   if(OP_LIKELY(ret>=0))_of->ready_state=OP_PARTOPEN;
1568   return ret;
1569 }
1570
1571 static int op_open2(OggOpusFile *_of){
1572   int ret;
1573   OP_ASSERT(_of->ready_state==OP_PARTOPEN);
1574   if(_of->seekable){
1575     _of->ready_state=OP_OPENED;
1576     ret=op_open_seekable2(_of);
1577   }
1578   else ret=0;
1579   if(OP_LIKELY(ret>=0)){
1580     /*We have buffered packets from op_find_initial_pcm_offset().
1581       Move to OP_INITSET so we can use them.*/
1582     _of->ready_state=OP_STREAMSET;
1583     ret=op_make_decode_ready(_of);
1584     if(OP_LIKELY(ret>=0))return 0;
1585   }
1586   /*Don't auto-close the stream on failure.*/
1587   _of->callbacks.close=NULL;
1588   op_clear(_of);
1589   return ret;
1590 }
1591
1592 OggOpusFile *op_test_callbacks(void *_source,const OpusFileCallbacks *_cb,
1593  const unsigned char *_initial_data,size_t _initial_bytes,int *_error){
1594   OggOpusFile *of;
1595   int          ret;
1596   of=(OggOpusFile *)_ogg_malloc(sizeof(*of));
1597   ret=OP_EFAULT;
1598   if(OP_LIKELY(of!=NULL)){
1599     ret=op_open1(of,_source,_cb,_initial_data,_initial_bytes);
1600     if(OP_LIKELY(ret>=0)){
1601       if(_error!=NULL)*_error=0;
1602       return of;
1603     }
1604     /*Don't auto-close the stream on failure.*/
1605     of->callbacks.close=NULL;
1606     op_clear(of);
1607     _ogg_free(of);
1608   }
1609   if(_error!=NULL)*_error=ret;
1610   return NULL;
1611 }
1612
1613 OggOpusFile *op_open_callbacks(void *_source,const OpusFileCallbacks *_cb,
1614  const unsigned char *_initial_data,size_t _initial_bytes,int *_error){
1615   OggOpusFile *of;
1616   of=op_test_callbacks(_source,_cb,_initial_data,_initial_bytes,_error);
1617   if(OP_LIKELY(of!=NULL)){
1618     int ret;
1619     ret=op_open2(of);
1620     if(OP_LIKELY(ret>=0))return of;
1621     if(_error!=NULL)*_error=ret;
1622     _ogg_free(of);
1623   }
1624   return NULL;
1625 }
1626
1627 /*Convenience routine to clean up from failure for the open functions that
1628    create their own streams.*/
1629 static OggOpusFile *op_open_close_on_failure(void *_source,
1630  const OpusFileCallbacks *_cb,int *_error){
1631   OggOpusFile *of;
1632   if(OP_UNLIKELY(_source==NULL)){
1633     if(_error!=NULL)*_error=OP_EFAULT;
1634     return NULL;
1635   }
1636   of=op_open_callbacks(_source,_cb,NULL,0,_error);
1637   if(OP_UNLIKELY(of==NULL))(*_cb->close)(_source);
1638   return of;
1639 }
1640
1641 OggOpusFile *op_open_file(const char *_path,int *_error){
1642   OpusFileCallbacks cb;
1643   return op_open_close_on_failure(op_fopen(&cb,_path,"rb"),&cb,_error);
1644 }
1645
1646 OggOpusFile *op_open_memory(const unsigned char *_data,size_t _size,
1647  int *_error){
1648   OpusFileCallbacks cb;
1649   return op_open_close_on_failure(op_mem_stream_create(&cb,_data,_size),&cb,
1650    _error);
1651 }
1652
1653 /*Convenience routine to clean up from failure for the open functions that
1654    create their own streams.*/
1655 static OggOpusFile *op_test_close_on_failure(void *_source,
1656  const OpusFileCallbacks *_cb,int *_error){
1657   OggOpusFile *of;
1658   if(OP_UNLIKELY(_source==NULL)){
1659     if(_error!=NULL)*_error=OP_EFAULT;
1660     return NULL;
1661   }
1662   of=op_test_callbacks(_source,_cb,NULL,0,_error);
1663   if(OP_UNLIKELY(of==NULL))(*_cb->close)(_source);
1664   return of;
1665 }
1666
1667 OggOpusFile *op_test_file(const char *_path,int *_error){
1668   OpusFileCallbacks cb;
1669   return op_test_close_on_failure(op_fopen(&cb,_path,"rb"),&cb,_error);
1670 }
1671
1672 OggOpusFile *op_test_memory(const unsigned char *_data,size_t _size,
1673  int *_error){
1674   OpusFileCallbacks cb;
1675   return op_test_close_on_failure(op_mem_stream_create(&cb,_data,_size),&cb,
1676    _error);
1677 }
1678
1679 int op_test_open(OggOpusFile *_of){
1680   int ret;
1681   if(OP_UNLIKELY(_of->ready_state!=OP_PARTOPEN))return OP_EINVAL;
1682   ret=op_open2(_of);
1683   /*op_open2() will clear this structure on failure.
1684     Reset its contents to prevent double-frees in op_free().*/
1685   if(OP_UNLIKELY(ret<0))memset(_of,0,sizeof(*_of));
1686   return ret;
1687 }
1688
1689 void op_free(OggOpusFile *_of){
1690   if(OP_LIKELY(_of!=NULL)){
1691     op_clear(_of);
1692     _ogg_free(_of);
1693   }
1694 }
1695
1696 int op_seekable(const OggOpusFile *_of){
1697   return _of->seekable;
1698 }
1699
1700 int op_link_count(const OggOpusFile *_of){
1701   return _of->nlinks;
1702 }
1703
1704 ogg_uint32_t op_serialno(const OggOpusFile *_of,int _li){
1705   if(OP_UNLIKELY(_li>=_of->nlinks))_li=_of->nlinks-1;
1706   if(!_of->seekable)_li=0;
1707   return _of->links[_li<0?_of->cur_link:_li].serialno;
1708 }
1709
1710 int op_channel_count(const OggOpusFile *_of,int _li){
1711   return op_head(_of,_li)->channel_count;
1712 }
1713
1714 opus_int64 op_raw_total(const OggOpusFile *_of,int _li){
1715   if(OP_UNLIKELY(_of->ready_state<OP_OPENED)
1716    ||OP_UNLIKELY(!_of->seekable)
1717    ||OP_UNLIKELY(_li>=_of->nlinks)){
1718     return OP_EINVAL;
1719   }
1720   if(_li<0)return _of->end-_of->links[0].offset;
1721   return (_li+1>=_of->nlinks?_of->end:_of->links[_li+1].offset)
1722    -_of->links[_li].offset;
1723 }
1724
1725 ogg_int64_t op_pcm_total(const OggOpusFile *_of,int _li){
1726   OggOpusLink *links;
1727   ogg_int64_t  diff;
1728   int          nlinks;
1729   nlinks=_of->nlinks;
1730   if(OP_UNLIKELY(_of->ready_state<OP_OPENED)
1731    ||OP_UNLIKELY(!_of->seekable)
1732    ||OP_UNLIKELY(_li>=nlinks)){
1733     return OP_EINVAL;
1734   }
1735   links=_of->links;
1736   /*We verify that the granule position differences are larger than the
1737      pre-skip and that the total duration does not overflow during link
1738      enumeration, so we don't have to check here.*/
1739   if(_li<0){
1740     ogg_int64_t pcm_total;
1741     int         li;
1742     pcm_total=0;
1743     for(li=0;li<nlinks;li++){
1744       OP_ALWAYS_TRUE(!op_granpos_diff(&diff,
1745        links[li].pcm_end,links[li].pcm_start));
1746       pcm_total+=diff-links[li].head.pre_skip;
1747     }
1748     return pcm_total;
1749   }
1750   OP_ALWAYS_TRUE(!op_granpos_diff(&diff,
1751    links[_li].pcm_end,links[_li].pcm_start));
1752   return diff-links[_li].head.pre_skip;
1753 }
1754
1755 const OpusHead *op_head(const OggOpusFile *_of,int _li){
1756   if(OP_UNLIKELY(_li>=_of->nlinks))_li=_of->nlinks-1;
1757   if(!_of->seekable)_li=0;
1758   return &_of->links[_li<0?_of->cur_link:_li].head;
1759 }
1760
1761 const OpusTags *op_tags(const OggOpusFile *_of,int _li){
1762   if(OP_UNLIKELY(_li>=_of->nlinks))_li=_of->nlinks-1;
1763   if(!_of->seekable){
1764     if(_of->ready_state<OP_STREAMSET&&_of->ready_state!=OP_PARTOPEN){
1765       return NULL;
1766     }
1767     _li=0;
1768   }
1769   else if(_li<0)_li=_of->ready_state>=OP_STREAMSET?_of->cur_link:0;
1770   return &_of->links[_li].tags;
1771 }
1772
1773 int op_current_link(const OggOpusFile *_of){
1774   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
1775   return _of->cur_link;
1776 }
1777
1778 /*Compute an average bitrate given a byte and sample count.
1779   Return: The bitrate in bits per second.*/
1780 static opus_int32 op_calc_bitrate(opus_int64 _bytes,ogg_int64_t _samples){
1781   /*These rates are absurd, but let's handle them anyway.*/
1782   if(OP_UNLIKELY(_bytes>(OP_INT64_MAX-(_samples>>1))/(48000*8))){
1783     ogg_int64_t den;
1784     if(OP_UNLIKELY(_bytes/(OP_INT32_MAX/(48000*8))>=_samples)){
1785       return OP_INT32_MAX;
1786     }
1787     den=_samples/(48000*8);
1788     return (opus_int32)((_bytes+(den>>1))/den);
1789   }
1790   if(OP_UNLIKELY(_samples<=0))return OP_INT32_MAX;
1791   /*This can't actually overflow in normal operation: even with a pre-skip of
1792      545 2.5 ms frames with 8 streams running at 1282*8+1 bytes per packet
1793      (1275 byte frames + Opus framing overhead + Ogg lacing values), that all
1794      produce a single sample of decoded output, we still don't top 45 Mbps.
1795     The only way to get bitrates larger than that is with excessive Opus
1796      padding, more encoded streams than output channels, or lots and lots of
1797      Ogg pages with no packets on them.*/
1798   return (opus_int32)OP_MIN((_bytes*48000*8+(_samples>>1))/_samples,
1799    OP_INT32_MAX);
1800 }
1801
1802 opus_int32 op_bitrate(const OggOpusFile *_of,int _li){
1803   if(OP_UNLIKELY(_of->ready_state<OP_OPENED)||OP_UNLIKELY(!_of->seekable)
1804    ||OP_UNLIKELY(_li>=_of->nlinks)){
1805     return OP_EINVAL;
1806   }
1807   return op_calc_bitrate(op_raw_total(_of,_li),op_pcm_total(_of,_li));
1808 }
1809
1810 opus_int32 op_bitrate_instant(OggOpusFile *_of){
1811   ogg_int64_t samples_tracked;
1812   opus_int32  ret;
1813   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
1814   samples_tracked=_of->samples_tracked;
1815   if(OP_UNLIKELY(samples_tracked==0))return OP_FALSE;
1816   ret=op_calc_bitrate(_of->bytes_tracked,samples_tracked);
1817   _of->bytes_tracked=0;
1818   _of->samples_tracked=0;
1819   return ret;
1820 }
1821
1822 /*Fetch and process a page.
1823   This handles the case where we're at a bitstream boundary and dumps the
1824    decoding machine.
1825   If the decoding machine is unloaded, it loads it.
1826   It also keeps prev_packet_gp up to date (seek and read both use this).
1827   Return: <0) Error, OP_HOLE (lost packet), or OP_EOF.
1828            0) Got at least one audio data packet.*/
1829 static int op_fetch_and_process_page(OggOpusFile *_of,
1830  ogg_page *_og,opus_int64 _page_offset,int _spanp,int _ignore_holes){
1831   OggOpusLink  *links;
1832   ogg_uint32_t  cur_serialno;
1833   int           seekable;
1834   int           cur_link;
1835   int           ret;
1836   /*We shouldn't get here if we have unprocessed packets.*/
1837   OP_ASSERT(_of->ready_state<OP_INITSET||_of->op_pos>=_of->op_count);
1838   seekable=_of->seekable;
1839   links=_of->links;
1840   cur_link=seekable?_of->cur_link:0;
1841   cur_serialno=links[cur_link].serialno;
1842   /*Handle one page.*/
1843   for(;;){
1844     ogg_page og;
1845     OP_ASSERT(_of->ready_state>=OP_OPENED);
1846     /*This loop is not strictly necessary, but there's no sense in doing the
1847        extra checks of the larger loop for the common case in a multiplexed
1848        bistream where the page is simply part of a different logical
1849        bitstream.*/
1850     do{
1851       /*If we were given a page to use, use it.*/
1852       if(_og!=NULL){
1853         *&og=*_og;
1854         _og=NULL;
1855       }
1856       /*Keep reading until we get a page with the correct serialno.*/
1857       else _page_offset=op_get_next_page(_of,&og,_of->end);
1858       /*EOF: Leave uninitialized.*/
1859       if(_page_offset<0)return _page_offset<OP_FALSE?(int)_page_offset:OP_EOF;
1860       if(OP_LIKELY(_of->ready_state>=OP_STREAMSET)){
1861         if(cur_serialno!=(ogg_uint32_t)ogg_page_serialno(&og)){
1862           /*Two possibilities:
1863              1) Another stream is multiplexed into this logical section, or*/
1864           if(OP_LIKELY(!ogg_page_bos(&og)))continue;
1865           /* 2) Our decoding just traversed a bitstream boundary.*/
1866           if(!_spanp)return OP_EOF;
1867           if(OP_LIKELY(_of->ready_state>=OP_INITSET))op_decode_clear(_of);
1868           break;
1869         }
1870       }
1871       /*Bitrate tracking: add the header's bytes here.
1872         The body bytes are counted when we consume the packets.*/
1873       _of->bytes_tracked+=og.header_len;
1874     }
1875     while(0);
1876     /*Do we need to load a new machine before submitting the page?
1877       This is different in the seekable and non-seekable cases.
1878       In the seekable case, we already have all the header information loaded
1879        and cached.
1880       We just initialize the machine with it and continue on our merry way.
1881       In the non-seekable (streaming) case, we'll only be at a boundary if we
1882        just left the previous logical bitstream, and we're now nominally at the
1883        header of the next bitstream.*/
1884     if(OP_UNLIKELY(_of->ready_state<OP_STREAMSET)){
1885       if(seekable){
1886         ogg_uint32_t serialno;
1887         int          nlinks;
1888         int          li;
1889         serialno=ogg_page_serialno(&og);
1890         /*Match the serialno to bitstream section.
1891           We use this rather than offset positions to avoid problems near
1892            logical bitstream boundaries.*/
1893         nlinks=_of->nlinks;
1894         for(li=0;li<nlinks&&links[li].serialno!=serialno;li++);
1895         /*Not a desired Opus bitstream section.
1896           Keep trying.*/
1897         if(li>=nlinks)continue;
1898         cur_serialno=serialno;
1899         _of->cur_link=cur_link=li;
1900         ogg_stream_reset_serialno(&_of->os,serialno);
1901         _of->ready_state=OP_STREAMSET;
1902         /*If we're at the start of this link, initialize the granule position
1903            and pre-skip tracking.*/
1904         if(_page_offset<=links[cur_link].data_offset){
1905           _of->prev_packet_gp=links[cur_link].pcm_start;
1906           _of->prev_page_offset=-1;
1907           _of->cur_discard_count=links[cur_link].head.pre_skip;
1908           /*Ignore a hole at the start of a new link (this is common for
1909              streams joined in the middle) or after seeking.*/
1910           _ignore_holes=1;
1911         }
1912       }
1913       else{
1914         do{
1915           /*We're streaming.
1916             Fetch the two header packets, build the info struct.*/
1917           ret=op_fetch_headers(_of,&links[0].head,&links[0].tags,
1918            NULL,NULL,NULL,&og);
1919           if(OP_UNLIKELY(ret<0))return ret;
1920           /*op_find_initial_pcm_offset() will suppress any initial hole for us,
1921              so no need to set _ignore_holes.*/
1922           ret=op_find_initial_pcm_offset(_of,links,&og);
1923           if(OP_UNLIKELY(ret<0))return ret;
1924           _of->links[0].serialno=cur_serialno=_of->os.serialno;
1925           _of->cur_link++;
1926         }
1927         /*If the link was empty, keep going, because we already have the
1928            BOS page of the next one in og.*/
1929         while(OP_UNLIKELY(ret>0));
1930         /*If we didn't get any packets out of op_find_initial_pcm_offset(),
1931            keep going (this is possible if end-trimming trimmed them all).*/
1932         if(_of->op_count<=0)continue;
1933         /*Otherwise, we're done.*/
1934         ret=op_make_decode_ready(_of);
1935         if(OP_UNLIKELY(ret<0))return ret;
1936         return 0;
1937       }
1938     }
1939     /*The buffered page is the data we want, and we're ready for it.
1940       Add it to the stream state.*/
1941     if(OP_UNLIKELY(_of->ready_state==OP_STREAMSET)){
1942       ret=op_make_decode_ready(_of);
1943       if(OP_UNLIKELY(ret<0))return ret;
1944     }
1945     /*Extract all the packets from the current page.*/
1946     ogg_stream_pagein(&_of->os,&og);
1947     if(OP_LIKELY(_of->ready_state>=OP_INITSET)){
1948       opus_int32 total_duration;
1949       int        durations[255];
1950       int        op_count;
1951       total_duration=op_collect_audio_packets(_of,durations);
1952       if(OP_UNLIKELY(total_duration<0)){
1953         /*Drain the packets from the page anyway.*/
1954         total_duration=op_collect_audio_packets(_of,durations);
1955         OP_ASSERT(total_duration>=0);
1956         /*Report holes to the caller.*/
1957         if(!_ignore_holes)return OP_HOLE;
1958       }
1959       op_count=_of->op_count;
1960       /*If we found at least one audio data packet, compute per-packet granule
1961          positions for them.*/
1962       if(op_count>0){
1963         ogg_int64_t diff;
1964         ogg_int64_t prev_packet_gp;
1965         ogg_int64_t cur_packet_gp;
1966         ogg_int64_t cur_page_gp;
1967         int         cur_page_eos;
1968         int         pi;
1969         cur_page_gp=_of->op[op_count-1].granulepos;
1970         cur_page_eos=_of->op[op_count-1].e_o_s;
1971         prev_packet_gp=_of->prev_packet_gp;
1972         if(OP_UNLIKELY(prev_packet_gp==-1)){
1973           opus_int32 cur_discard_count;
1974           /*This is the first call after a raw seek.
1975             Try to reconstruct prev_packet_gp from scratch.*/
1976           OP_ASSERT(seekable);
1977           if(OP_UNLIKELY(cur_page_eos)){
1978             /*If the first page we hit after our seek was the EOS page, and
1979                we didn't start from data_offset or before, we don't have
1980                enough information to do end-trimming.
1981               Proceed to the next link, rather than risk playing back some
1982                samples that shouldn't have been played.*/
1983             _of->op_count=0;
1984             continue;
1985           }
1986           /*By default discard 80 ms of data after a seek, unless we seek
1987              into the pre-skip region.*/
1988           cur_discard_count=80*48;
1989           cur_page_gp=_of->op[op_count-1].granulepos;
1990           /*Try to initialize prev_packet_gp.
1991             If the current page had packets but didn't have a granule
1992              position, or the granule position it had was too small (both
1993              illegal), just use the starting granule position for the link.*/
1994           prev_packet_gp=links[cur_link].pcm_start;
1995           if(OP_LIKELY(cur_page_gp!=-1)){
1996             op_granpos_add(&prev_packet_gp,cur_page_gp,-total_duration);
1997           }
1998           if(OP_LIKELY(!op_granpos_diff(&diff,
1999            prev_packet_gp,links[cur_link].pcm_start))){
2000             opus_int32 pre_skip;
2001             /*If we start at the beginning of the pre-skip region, or we're
2002                at least 80 ms from the end of the pre-skip region, we discard
2003                to the end of the pre-skip region.
2004               Otherwise, we still use the 80 ms default, which will discard
2005                past the end of the pre-skip region.*/
2006             pre_skip=links[cur_link].head.pre_skip;
2007             if(diff>=0&&diff<=OP_MAX(0,pre_skip-80*48)){
2008               cur_discard_count=pre_skip-(int)diff;
2009             }
2010           }
2011           _of->cur_discard_count=cur_discard_count;
2012         }
2013         if(OP_UNLIKELY(cur_page_gp==-1)){
2014           /*This page had completed packets but didn't have a valid granule
2015              position.
2016             This is illegal, but we'll try to handle it by continuing to count
2017              forwards from the previous page.*/
2018           if(op_granpos_add(&cur_page_gp,prev_packet_gp,total_duration)<0){
2019             /*The timestamp for this page overflowed.*/
2020             cur_page_gp=links[cur_link].pcm_end;
2021           }
2022         }
2023         /*If we hit the last page, handle end-trimming.*/
2024         if(OP_UNLIKELY(cur_page_eos)
2025          &&OP_LIKELY(!op_granpos_diff(&diff,cur_page_gp,prev_packet_gp))
2026          &&OP_LIKELY(diff<total_duration)){
2027           cur_packet_gp=prev_packet_gp;
2028           for(pi=0;pi<op_count;pi++){
2029             diff=durations[pi]-diff;
2030             /*If we have samples to trim...*/
2031             if(diff>0){
2032               /*If we trimmed the entire packet, stop (the spec says encoders
2033                  shouldn't do this, but we support it anyway).*/
2034               if(OP_UNLIKELY(diff>durations[pi]))break;
2035               cur_packet_gp=cur_page_gp;
2036               /*Move the EOS flag to this packet, if necessary, so we'll trim
2037                  the samples during decode.*/
2038               _of->op[pi].e_o_s=1;
2039             }
2040             else{
2041               /*Update the granule position as normal.*/
2042               OP_ALWAYS_TRUE(!op_granpos_add(&cur_packet_gp,
2043                cur_packet_gp,durations[pi]));
2044             }
2045             _of->op[pi].granulepos=cur_packet_gp;
2046             OP_ALWAYS_TRUE(!op_granpos_diff(&diff,cur_page_gp,cur_packet_gp));
2047           }
2048         }
2049         else{
2050           /*Propagate timestamps to earlier packets.
2051             op_granpos_add(&prev_packet_gp,prev_packet_gp,total_duration)
2052              should succeed and give prev_packet_gp==cur_page_gp.
2053             But we don't bother to check that, as there isn't much we can do
2054              if it's not true, and it actually will not be true on the first
2055              page after a seek, if there was a continued packet.
2056             The only thing we guarantee is that the start and end granule
2057              positions of the packets are valid, and that they are monotonic
2058              within a page.
2059             They might be completely out of range for this link (we'll check
2060              that elsewhere), or non-monotonic between pages.*/
2061           if(OP_UNLIKELY(op_granpos_add(&prev_packet_gp,
2062            cur_page_gp,-total_duration)<0)){
2063             /*The starting timestamp for the first packet on this page
2064                underflowed.
2065               This is illegal, but we ignore it.*/
2066             prev_packet_gp=0;
2067           }
2068           for(pi=0;pi<op_count;pi++){
2069             if(OP_UNLIKELY(op_granpos_add(&cur_packet_gp,
2070              cur_page_gp,-total_duration)<0)){
2071               /*The start timestamp for this packet underflowed.
2072                 This is illegal, but we ignore it.*/
2073               cur_packet_gp=0;
2074             }
2075             total_duration-=durations[pi];
2076             OP_ASSERT(total_duration>=0);
2077             OP_ALWAYS_TRUE(!op_granpos_add(&cur_packet_gp,
2078              cur_packet_gp,durations[pi]));
2079             _of->op[pi].granulepos=cur_packet_gp;
2080           }
2081           OP_ASSERT(total_duration==0);
2082         }
2083         _of->prev_packet_gp=prev_packet_gp;
2084         _of->prev_page_offset=_page_offset;
2085         _of->op_count=pi;
2086         /*If end-trimming didn't trim all the packets, we're done.*/
2087         if(OP_LIKELY(pi>0))return 0;
2088       }
2089     }
2090   }
2091 }
2092
2093 int op_raw_seek(OggOpusFile *_of,opus_int64 _pos){
2094   int ret;
2095   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
2096   /*Don't dump the decoder state if we can't seek.*/
2097   if(OP_UNLIKELY(!_of->seekable))return OP_ENOSEEK;
2098   if(OP_UNLIKELY(_pos<0)||OP_UNLIKELY(_pos>_of->end))return OP_EINVAL;
2099   /*Clear out any buffered, decoded data.*/
2100   op_decode_clear(_of);
2101   _of->bytes_tracked=0;
2102   _of->samples_tracked=0;
2103   ret=op_seek_helper(_of,_pos);
2104   if(OP_UNLIKELY(ret<0))return OP_EREAD;
2105   ret=op_fetch_and_process_page(_of,NULL,-1,1,1);
2106   /*If we hit EOF, op_fetch_and_process_page() leaves us uninitialized.
2107     Instead, jump to the end.*/
2108   if(ret==OP_EOF){
2109     int cur_link;
2110     op_decode_clear(_of);
2111     cur_link=_of->nlinks-1;
2112     _of->cur_link=cur_link;
2113     _of->prev_packet_gp=_of->links[cur_link].pcm_end;
2114     _of->cur_discard_count=0;
2115     ret=0;
2116   }
2117   return ret;
2118 }
2119
2120 /*Convert a PCM offset relative to the start of the whole stream to a granule
2121    position in an individual link.*/
2122 static ogg_int64_t op_get_granulepos(const OggOpusFile *_of,
2123  ogg_int64_t _pcm_offset,int *_li){
2124   const OggOpusLink *links;
2125   ogg_int64_t        duration;
2126   int                nlinks;
2127   int                li;
2128   OP_ASSERT(_pcm_offset>=0);
2129   nlinks=_of->nlinks;
2130   links=_of->links;
2131   for(li=0;OP_LIKELY(li<nlinks);li++){
2132     ogg_int64_t pcm_start;
2133     opus_int32  pre_skip;
2134     pcm_start=links[li].pcm_start;
2135     pre_skip=links[li].head.pre_skip;
2136     OP_ALWAYS_TRUE(!op_granpos_diff(&duration,links[li].pcm_end,pcm_start));
2137     duration-=pre_skip;
2138     if(_pcm_offset<duration){
2139       _pcm_offset+=pre_skip;
2140       if(OP_UNLIKELY(pcm_start>OP_INT64_MAX-_pcm_offset)){
2141         /*Adding this amount to the granule position would overflow the positive
2142            half of its 64-bit range.
2143           Since signed overflow is undefined in C, do it in a way the compiler
2144            isn't allowed to screw up.*/
2145         _pcm_offset-=OP_INT64_MAX-pcm_start+1;
2146         pcm_start=OP_INT64_MIN;
2147       }
2148       pcm_start+=_pcm_offset;
2149       *_li=li;
2150       return pcm_start;
2151     }
2152     _pcm_offset-=duration;
2153   }
2154   return -1;
2155 }
2156
2157 /*A small helper to determine if an Ogg page contains data that continues onto
2158    a subsequent page.*/
2159 static int op_page_continues(const ogg_page *_og){
2160   int nlacing;
2161   OP_ASSERT(_og->header_len>=27);
2162   nlacing=_og->header[26];
2163   OP_ASSERT(_og->header_len>=27+nlacing);
2164   /*This also correctly handles the (unlikely) case of nlacing==0, because
2165      0!=255.*/
2166   return _og->header[27+nlacing-1]==255;
2167 }
2168
2169 /*A small helper to buffer the continued packet data from a page.*/
2170 static void op_buffer_continued_data(OggOpusFile *_of,ogg_page *_og){
2171   ogg_packet op;
2172   ogg_stream_pagein(&_of->os,_og);
2173   /*Drain any packets that did end on this page (and ignore holes).
2174     We only care about the continued packet data.*/
2175   while(ogg_stream_packetout(&_of->os,&op));
2176 }
2177
2178 /*This controls how close the target has to be to use the current stream
2179    position to subdivide the initial range.
2180   Two minutes seems to be a good default.*/
2181 #define OP_CUR_TIME_THRESH (120*48*(opus_int32)1000)
2182
2183 /*Note: The OP_SMALL_FOOTPRINT #define doesn't (currently) save much code size,
2184    but it's meant to serve as documentation for portions of the seeking
2185    algorithm that are purely optional, to aid others learning from/porting this
2186    code to other contexts.*/
2187 /*#define OP_SMALL_FOOTPRINT (1)*/
2188
2189 /*Search within link _li for the page with the highest granule position
2190    preceding (or equal to) _target_gp.
2191   There is a danger here: missing pages or incorrect frame number information
2192    in the bitstream could make our task impossible.
2193   Account for that (and report it as an error condition).*/
2194 static int op_pcm_seek_page(OggOpusFile *_of,
2195  ogg_int64_t _target_gp,int _li){
2196   const OggOpusLink *link;
2197   ogg_page           og;
2198   ogg_int64_t        pcm_pre_skip;
2199   ogg_int64_t        pcm_start;
2200   ogg_int64_t        pcm_end;
2201   ogg_int64_t        best_gp;
2202   ogg_int64_t        diff;
2203   ogg_uint32_t       serialno;
2204   opus_int32         pre_skip;
2205   opus_int64         begin;
2206   opus_int64         end;
2207   opus_int64         boundary;
2208   opus_int64         best;
2209   opus_int64         best_start;
2210   opus_int64         page_offset;
2211   opus_int64         d0;
2212   opus_int64         d1;
2213   opus_int64         d2;
2214   int                force_bisect;
2215   int                buffering;
2216   int                ret;
2217   _of->bytes_tracked=0;
2218   _of->samples_tracked=0;
2219   link=_of->links+_li;
2220   best_gp=pcm_start=link->pcm_start;
2221   pcm_end=link->pcm_end;
2222   serialno=link->serialno;
2223   best=best_start=begin=link->data_offset;
2224   page_offset=-1;
2225   buffering=0;
2226   /*We discard the first 80 ms of data after a seek, so seek back that much
2227      farther.
2228     If we can't, simply seek to the beginning of the link.*/
2229   if(OP_UNLIKELY(op_granpos_add(&_target_gp,_target_gp,-80*48)<0)
2230    ||OP_UNLIKELY(op_granpos_cmp(_target_gp,pcm_start)<0)){
2231     _target_gp=pcm_start;
2232   }
2233   /*Special case seeking to the start of the link.*/
2234   pre_skip=link->head.pre_skip;
2235   OP_ALWAYS_TRUE(!op_granpos_add(&pcm_pre_skip,pcm_start,pre_skip));
2236   if(op_granpos_cmp(_target_gp,pcm_pre_skip)<0)end=boundary=begin;
2237   else{
2238     end=boundary=link->end_offset;
2239 #if !defined(OP_SMALL_FOOTPRINT)
2240     /*If we were decoding from this link, we can narrow the range a bit.*/
2241     if(_li==_of->cur_link&&_of->ready_state>=OP_INITSET){
2242       opus_int64 offset;
2243       int        op_count;
2244       op_count=_of->op_count;
2245       /*The only way the offset can be invalid _and_ we can fail the granule
2246          position checks below is if someone changed the contents of the last
2247          page since we read it.
2248         We'd be within our rights to just return OP_EBADLINK in that case, but
2249          we'll simply ignore the current position instead.*/
2250       offset=_of->offset;
2251       if(op_count>0&&OP_LIKELY(offset<=end)){
2252         ogg_int64_t gp;
2253         /*Make sure the timestamp is valid.
2254           The granule position might be -1 if we collected the packets from a
2255            page without a granule position after reporting a hole.*/
2256         gp=_of->op[op_count-1].granulepos;
2257         if(OP_LIKELY(gp!=-1)&&OP_LIKELY(op_granpos_cmp(pcm_start,gp)<0)
2258          &&OP_LIKELY(op_granpos_cmp(pcm_end,gp)>0)){
2259           OP_ALWAYS_TRUE(!op_granpos_diff(&diff,gp,_target_gp));
2260           /*We only actually use the current time if either
2261             a) We can cut off at least half the range, or
2262             b) We're seeking sufficiently close to the current position that
2263                 it's likely to be informative.
2264             Otherwise it appears using the whole link range to estimate the
2265              first seek location gives better results, on average.*/
2266           if(diff<0){
2267             OP_ASSERT(offset>=begin);
2268             if(offset-begin>=end-begin>>1||diff>-OP_CUR_TIME_THRESH){
2269               best=begin=offset;
2270               best_gp=pcm_start=gp;
2271               /*If we have buffered data from a continued packet, remember the
2272                  offset of the previous page's start, so that if we do wind up
2273                  having to seek back here later, we can prime the stream with
2274                  the continued packet data.
2275                 With no continued packet, we remember the end of the page.*/
2276               best_start=_of->os.body_returned<_of->os.body_fill?
2277                _of->prev_page_offset:best;
2278               /*If there's completed packets and data in the stream state,
2279                  prev_page_offset should always be set.*/
2280               OP_ASSERT(best_start>=0);
2281               /*Buffer any continued packet data starting from here.*/
2282               buffering=1;
2283             }
2284           }
2285           else{
2286             ogg_int64_t prev_page_gp;
2287             /*We might get lucky and already have the packet with the target
2288                buffered.
2289               Worth checking.
2290               For very small files (with all of the data in a single page,
2291                generally 1 second or less), we can loop them continuously
2292                without seeking at all.*/
2293             OP_ALWAYS_TRUE(!op_granpos_add(&prev_page_gp,_of->op[0].granulepos,
2294              -op_get_packet_duration(_of->op[0].packet,_of->op[0].bytes)));
2295             if(op_granpos_cmp(prev_page_gp,_target_gp)<=0){
2296               /*Don't call op_decode_clear(), because it will dump our
2297                  packets.*/
2298               _of->op_pos=0;
2299               _of->od_buffer_size=0;
2300               _of->prev_packet_gp=prev_page_gp;
2301               /*_of->prev_page_offset already points to the right place.*/
2302               _of->ready_state=OP_STREAMSET;
2303               return op_make_decode_ready(_of);
2304             }
2305             /*No such luck.
2306               Check if we can cut off at least half the range, though.*/
2307             if(offset-begin<=end-begin>>1||diff<OP_CUR_TIME_THRESH){
2308               /*We really want the page start here, but this will do.*/
2309               end=boundary=offset;
2310               pcm_end=gp;
2311             }
2312           }
2313         }
2314       }
2315     }
2316 #endif
2317   }
2318   /*This code was originally based on the "new search algorithm by HB (Nicholas
2319      Vinen)" from libvorbisfile.
2320     It has been modified substantially since.*/
2321   op_decode_clear(_of);
2322   if(!buffering)ogg_stream_reset_serialno(&_of->os,serialno);
2323   _of->cur_link=_li;
2324   _of->ready_state=OP_STREAMSET;
2325   /*Initialize the interval size history.*/
2326   d2=d1=d0=end-begin;
2327   force_bisect=0;
2328   while(begin<end){
2329     opus_int64 bisect;
2330     opus_int64 next_boundary;
2331     opus_int32 chunk_size;
2332     if(end-begin<OP_CHUNK_SIZE)bisect=begin;
2333     else{
2334       /*Update the interval size history.*/
2335       d0=d1>>1;
2336       d1=d2>>1;
2337       d2=end-begin>>1;
2338       if(force_bisect)bisect=begin+(end-begin>>1);
2339       else{
2340         ogg_int64_t diff2;
2341         OP_ALWAYS_TRUE(!op_granpos_diff(&diff,_target_gp,pcm_start));
2342         OP_ALWAYS_TRUE(!op_granpos_diff(&diff2,pcm_end,pcm_start));
2343         /*Take a (pretty decent) guess.*/
2344         bisect=begin+op_rescale64(diff,diff2,end-begin)-OP_CHUNK_SIZE;
2345       }
2346       if(bisect-OP_CHUNK_SIZE<begin)bisect=begin;
2347       force_bisect=0;
2348     }
2349     if(bisect!=_of->offset){
2350       /*Discard any buffered continued packet data.*/
2351       if(buffering)ogg_stream_reset(&_of->os);
2352       buffering=0;
2353       page_offset=-1;
2354       ret=op_seek_helper(_of,bisect);
2355       if(OP_UNLIKELY(ret<0))return ret;
2356     }
2357     chunk_size=OP_CHUNK_SIZE;
2358     next_boundary=boundary;
2359     /*Now scan forward and figure out where we landed.
2360       In the ideal case, we will see a page with a granule position at or
2361        before our target, followed by a page with a granule position after our
2362        target (or the end of the search interval).
2363       Then we can just drop out and will have all of the data we need with no
2364        additional seeking.
2365       If we landed too far before, or after, we'll break out and do another
2366        bisection.*/
2367     while(begin<end){
2368       page_offset=op_get_next_page(_of,&og,boundary);
2369       if(page_offset<0){
2370         if(page_offset<OP_FALSE)return (int)page_offset;
2371         /*There are no more pages in our interval from our stream with a valid
2372            timestamp that start at position bisect or later.*/
2373         /*If we scanned the whole interval, we're done.*/
2374         if(bisect<=begin+1)end=begin;
2375         else{
2376           /*Otherwise, back up one chunk.
2377             First, discard any data from a continued packet.*/
2378           if(buffering)ogg_stream_reset(&_of->os);
2379           buffering=0;
2380           bisect=OP_MAX(bisect-chunk_size,begin);
2381           ret=op_seek_helper(_of,bisect);
2382           if(OP_UNLIKELY(ret<0))return ret;
2383           /*Bump up the chunk size.*/
2384           chunk_size=OP_MIN(2*chunk_size,OP_CHUNK_SIZE_MAX);
2385           /*If we did find a page from another stream or without a timestamp,
2386              don't read past it.*/
2387           boundary=next_boundary;
2388         }
2389       }
2390       else{
2391         ogg_int64_t gp;
2392         int         has_packets;
2393         /*Save the offset of the first page we found after the seek, regardless
2394            of the stream it came from or whether or not it has a timestamp.*/
2395         next_boundary=OP_MIN(page_offset,next_boundary);
2396         if(serialno!=(ogg_uint32_t)ogg_page_serialno(&og))continue;
2397         has_packets=ogg_page_packets(&og)>0;
2398         /*Force the gp to -1 (as it should be per spec) if no packets end on
2399            this page.
2400           Otherwise we might get confused when we try to pull out a packet
2401            with that timestamp and can't find it.*/
2402         gp=has_packets?ogg_page_granulepos(&og):-1;
2403         if(gp==-1){
2404           if(buffering){
2405             if(OP_LIKELY(!has_packets))ogg_stream_pagein(&_of->os,&og);
2406             else{
2407               /*If packets did end on this page, but we still didn't have a
2408                  valid granule position (in violation of the spec!), stop
2409                  buffering continued packet data.
2410                 Otherwise we might continue past the packet we actually
2411                  wanted.*/
2412               ogg_stream_reset(&_of->os);
2413               buffering=0;
2414             }
2415           }
2416           continue;
2417         }
2418         if(op_granpos_cmp(gp,_target_gp)<0){
2419           /*We found a page that ends before our target.
2420             Advance to the raw offset of the next page.*/
2421           begin=_of->offset;
2422           if(OP_UNLIKELY(op_granpos_cmp(pcm_start,gp)>0)
2423            ||OP_UNLIKELY(op_granpos_cmp(pcm_end,gp)<0)){
2424             /*Don't let pcm_start get out of range!
2425               That could happen with an invalid timestamp.*/
2426             break;
2427           }
2428           /*Save the byte offset of the end of the page with this granule
2429              position.*/
2430           best=best_start=begin;
2431           /*Buffer any data from a continued packet, if necessary.
2432             This avoids the need to seek back here if the next timestamp we
2433              encounter while scanning forward lies after our target.*/
2434           if(buffering)ogg_stream_reset(&_of->os);
2435           if(op_page_continues(&og)){
2436             op_buffer_continued_data(_of,&og);
2437             /*If we have a continued packet, remember the offset of this
2438                page's start, so that if we do wind up having to seek back here
2439                later, we can prime the stream with the continued packet data.
2440               With no continued packet, we remember the end of the page.*/
2441             best_start=page_offset;
2442           }
2443           /*Then force buffering on, so that if a packet starts (but does not
2444              end) on the next page, we still avoid the extra seek back.*/
2445           buffering=1;
2446           best_gp=pcm_start=gp;
2447           OP_ALWAYS_TRUE(!op_granpos_diff(&diff,_target_gp,pcm_start));
2448           /*If we're more than a second away from our target, break out and
2449              do another bisection.*/
2450           if(diff>48000)break;
2451           /*Otherwise, keep scanning forward (do NOT use begin+1).*/
2452           bisect=begin;
2453         }
2454         else{
2455           /*We found a page that ends after our target.*/
2456           /*If we scanned the whole interval before we found it, we're done.*/
2457           if(bisect<=begin+1)end=begin;
2458           else{
2459             end=bisect;
2460             /*In later iterations, don't read past the first page we found.*/
2461             boundary=next_boundary;
2462             /*If we're not making much progress shrinking the interval size,
2463                start forcing straight bisection to limit the worst case.*/
2464             force_bisect=end-begin>d0*2;
2465             /*Don't let pcm_end get out of range!
2466               That could happen with an invalid timestamp.*/
2467             if(OP_LIKELY(op_granpos_cmp(pcm_end,gp)>0)
2468              &&OP_LIKELY(op_granpos_cmp(pcm_start,gp)<=0)){
2469               pcm_end=gp;
2470             }
2471             break;
2472           }
2473         }
2474       }
2475     }
2476   }
2477   /*Found our page.*/
2478   OP_ASSERT(op_granpos_cmp(best_gp,pcm_start)>=0);
2479   /*Seek, if necessary.
2480     If we were buffering data from a continued packet, we should be able to
2481      continue to scan forward to get the rest of the data (even if
2482      page_offset==-1).
2483     Otherwise, we need to seek back to best_start.*/
2484   if(!buffering){
2485     if(best_start!=page_offset){
2486       page_offset=-1;
2487       ret=op_seek_helper(_of,best_start);
2488       if(OP_UNLIKELY(ret<0))return ret;
2489     }
2490     if(best_start<best){
2491       /*Retrieve the page at best_start, if we do not already have it.*/
2492       if(page_offset<0){
2493         page_offset=op_get_next_page(_of,&og,link->end_offset);
2494         if(OP_UNLIKELY(page_offset<OP_FALSE))return (int)page_offset;
2495         if(OP_UNLIKELY(page_offset!=best_start))return OP_EBADLINK;
2496       }
2497       op_buffer_continued_data(_of,&og);
2498       page_offset=-1;
2499     }
2500   }
2501   /*Update prev_packet_gp to allow per-packet granule position assignment.*/
2502   _of->prev_packet_gp=best_gp;
2503   _of->prev_page_offset=best_start;
2504   ret=op_fetch_and_process_page(_of,page_offset<0?NULL:&og,page_offset,0,1);
2505   if(OP_UNLIKELY(ret<0))return OP_EBADLINK;
2506   /*Verify result.*/
2507   if(OP_UNLIKELY(op_granpos_cmp(_of->prev_packet_gp,_target_gp)>0)){
2508     return OP_EBADLINK;
2509   }
2510   /*Our caller will set cur_discard_count to handle pre-roll.*/
2511   return 0;
2512 }
2513
2514 int op_pcm_seek(OggOpusFile *_of,ogg_int64_t _pcm_offset){
2515   const OggOpusLink *link;
2516   ogg_int64_t        pcm_start;
2517   ogg_int64_t        target_gp;
2518   ogg_int64_t        prev_packet_gp;
2519   ogg_int64_t        skip;
2520   ogg_int64_t        diff;
2521   int                op_count;
2522   int                op_pos;
2523   int                ret;
2524   int                li;
2525   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
2526   if(OP_UNLIKELY(!_of->seekable))return OP_ENOSEEK;
2527   if(OP_UNLIKELY(_pcm_offset<0))return OP_EINVAL;
2528   target_gp=op_get_granulepos(_of,_pcm_offset,&li);
2529   if(OP_UNLIKELY(target_gp==-1))return OP_EINVAL;
2530   link=_of->links+li;
2531   pcm_start=link->pcm_start;
2532   OP_ALWAYS_TRUE(!op_granpos_diff(&_pcm_offset,target_gp,pcm_start));
2533 #if !defined(OP_SMALL_FOOTPRINT)
2534   /*For small (90 ms or less) forward seeks within the same link, just decode
2535      forward.
2536     This also optimizes the case of seeking to the current position.*/
2537   if(li==_of->cur_link&&_of->ready_state>=OP_INITSET){
2538     ogg_int64_t gp;
2539     gp=_of->prev_packet_gp;
2540     if(OP_LIKELY(gp!=-1)){
2541       int nbuffered;
2542       nbuffered=OP_MAX(_of->od_buffer_size-_of->od_buffer_pos,0);
2543       OP_ALWAYS_TRUE(!op_granpos_add(&gp,gp,-nbuffered));
2544       /*We do _not_ add cur_discard_count to gp.
2545         Otherwise the total amount to discard could grow without bound, and it
2546          would be better just to do a full seek.*/
2547       if(OP_LIKELY(!op_granpos_diff(&diff,gp,pcm_start))){
2548         ogg_int64_t discard_count;
2549         discard_count=_pcm_offset-diff;
2550         /*We use a threshold of 90 ms instead of 80, since 80 ms is the
2551            _minimum_ we would have discarded after a full seek.
2552           Assuming 20 ms frames (the default), we'd discard 90 ms on average.*/
2553         if(discard_count>=0&&OP_UNLIKELY(discard_count<90*48)){
2554           _of->cur_discard_count=(opus_int32)discard_count;
2555           return 0;
2556         }
2557       }
2558     }
2559   }
2560 #endif
2561   ret=op_pcm_seek_page(_of,target_gp,li);
2562   if(OP_UNLIKELY(ret<0))return ret;
2563   /*Now skip samples until we actually get to our target.*/
2564   /*Figure out where we should skip to.*/
2565   if(_pcm_offset<=link->head.pre_skip)skip=0;
2566   else skip=OP_MAX(_pcm_offset-80*48,0);
2567   OP_ASSERT(_pcm_offset-skip>=0);
2568   OP_ASSERT(_pcm_offset-skip<OP_INT32_MAX-120*48);
2569   /*Skip packets until we find one with samples past our skip target.*/
2570   for(;;){
2571     op_count=_of->op_count;
2572     prev_packet_gp=_of->prev_packet_gp;
2573     for(op_pos=_of->op_pos;op_pos<op_count;op_pos++){
2574       ogg_int64_t cur_packet_gp;
2575       cur_packet_gp=_of->op[op_pos].granulepos;
2576       if(OP_LIKELY(!op_granpos_diff(&diff,cur_packet_gp,pcm_start))
2577        &&diff>skip){
2578         break;
2579       }
2580       prev_packet_gp=cur_packet_gp;
2581     }
2582     _of->prev_packet_gp=prev_packet_gp;
2583     _of->op_pos=op_pos;
2584     if(op_pos<op_count)break;
2585     /*We skipped all the packets on this page.
2586       Fetch another.*/
2587     ret=op_fetch_and_process_page(_of,NULL,-1,0,1);
2588     if(OP_UNLIKELY(ret<0))return OP_EBADLINK;
2589   }
2590   OP_ALWAYS_TRUE(!op_granpos_diff(&diff,prev_packet_gp,pcm_start));
2591   /*We skipped too far.
2592     Either the timestamps were illegal or there was a hole in the data.*/
2593   if(diff>skip)return OP_EBADLINK;
2594   OP_ASSERT(_pcm_offset-diff<OP_INT32_MAX);
2595   /*TODO: If there are further holes/illegal timestamps, we still won't decode
2596      to the correct sample.
2597     However, at least op_pcm_tell() will report the correct value immediately
2598      after returning.*/
2599   _of->cur_discard_count=(opus_int32)(_pcm_offset-diff);
2600   return 0;
2601 }
2602
2603 opus_int64 op_raw_tell(const OggOpusFile *_of){
2604   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
2605   return _of->offset;
2606 }
2607
2608 /*Convert a granule position from a given link to a PCM offset relative to the
2609    start of the whole stream.
2610   For unseekable sources, this gets reset to 0 at the beginning of each link.*/
2611 static ogg_int64_t op_get_pcm_offset(const OggOpusFile *_of,
2612  ogg_int64_t _gp,int _li){
2613   const OggOpusLink *links;
2614   ogg_int64_t        pcm_offset;
2615   ogg_int64_t        delta;
2616   int                li;
2617   links=_of->links;
2618   pcm_offset=0;
2619   OP_ASSERT(_li<_of->nlinks);
2620   for(li=0;li<_li;li++){
2621     OP_ALWAYS_TRUE(!op_granpos_diff(&delta,
2622      links[li].pcm_end,links[li].pcm_start));
2623     delta-=links[li].head.pre_skip;
2624     pcm_offset+=delta;
2625   }
2626   OP_ASSERT(_li>=0);
2627   if(_of->seekable&&OP_UNLIKELY(op_granpos_cmp(_gp,links[_li].pcm_end)>0)){
2628     _gp=links[_li].pcm_end;
2629   }
2630   if(OP_LIKELY(op_granpos_cmp(_gp,links[_li].pcm_start)>0)){
2631     if(OP_UNLIKELY(op_granpos_diff(&delta,_gp,links[_li].pcm_start)<0)){
2632       /*This means an unseekable stream claimed to have a page from more than
2633          2 billion days after we joined.*/
2634       OP_ASSERT(!_of->seekable);
2635       return OP_INT64_MAX;
2636     }
2637     if(delta<links[_li].head.pre_skip)delta=0;
2638     else delta-=links[_li].head.pre_skip;
2639     /*In the seekable case, _gp was limited by pcm_end.
2640       In the unseekable case, pcm_offset should be 0.*/
2641     OP_ASSERT(pcm_offset<=OP_INT64_MAX-delta);
2642     pcm_offset+=delta;
2643   }
2644   return pcm_offset;
2645 }
2646
2647 ogg_int64_t op_pcm_tell(const OggOpusFile *_of){
2648   ogg_int64_t gp;
2649   int         nbuffered;
2650   int         li;
2651   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
2652   gp=_of->prev_packet_gp;
2653   if(gp==-1)return 0;
2654   nbuffered=OP_MAX(_of->od_buffer_size-_of->od_buffer_pos,0);
2655   OP_ALWAYS_TRUE(!op_granpos_add(&gp,gp,-nbuffered));
2656   li=_of->seekable?_of->cur_link:0;
2657   if(op_granpos_add(&gp,gp,_of->cur_discard_count)<0){
2658     gp=_of->links[li].pcm_end;
2659   }
2660   return op_get_pcm_offset(_of,gp,li);
2661 }
2662
2663 void op_set_decode_callback(OggOpusFile *_of,
2664  op_decode_cb_func _decode_cb,void *_ctx){
2665   _of->decode_cb=_decode_cb;
2666   _of->decode_cb_ctx=_ctx;
2667 }
2668
2669 int op_set_gain_offset(OggOpusFile *_of,
2670  int _gain_type,opus_int32 _gain_offset_q8){
2671   if(_gain_type!=OP_HEADER_GAIN&&_gain_type!=OP_ALBUM_GAIN
2672    &&_gain_type!=OP_TRACK_GAIN&&_gain_type!=OP_ABSOLUTE_GAIN){
2673     return OP_EINVAL;
2674   }
2675   _of->gain_type=_gain_type;
2676   /*The sum of header gain and track gain lies in the range [-65536,65534].
2677     These bounds allow the offset to set the final value to anywhere in the
2678      range [-32768,32767], which is what we'll clamp it to before applying.*/
2679   _of->gain_offset_q8=OP_CLAMP(-98302,_gain_offset_q8,98303);
2680   op_update_gain(_of);
2681   return 0;
2682 }
2683
2684 void op_set_dither_enabled(OggOpusFile *_of,int _enabled){
2685 #if !defined(OP_FIXED_POINT)
2686   _of->dither_disabled=!_enabled;
2687   if(!_enabled)_of->dither_mute=65;
2688 #endif
2689 }
2690
2691 /*Allocate the decoder scratch buffer.
2692   This is done lazily, since if the user provides large enough buffers, we'll
2693    never need it.*/
2694 static int op_init_buffer(OggOpusFile *_of){
2695   int nchannels_max;
2696   if(_of->seekable){
2697     const OggOpusLink *links;
2698     int                nlinks;
2699     int                li;
2700     links=_of->links;
2701     nlinks=_of->nlinks;
2702     nchannels_max=1;
2703     for(li=0;li<nlinks;li++){
2704       nchannels_max=OP_MAX(nchannels_max,links[li].head.channel_count);
2705     }
2706   }
2707   else nchannels_max=OP_NCHANNELS_MAX;
2708   _of->od_buffer=(op_sample *)_ogg_malloc(
2709    sizeof(*_of->od_buffer)*nchannels_max*120*48);
2710   if(_of->od_buffer==NULL)return OP_EFAULT;
2711   return 0;
2712 }
2713
2714 /*Decode a single packet into the target buffer.*/
2715 static int op_decode(OggOpusFile *_of,op_sample *_pcm,
2716  const ogg_packet *_op,int _nsamples,int _nchannels){
2717   int ret;
2718   /*First we try using the application-provided decode callback.*/
2719   if(_of->decode_cb!=NULL){
2720 #if defined(OP_FIXED_POINT)
2721     ret=(*_of->decode_cb)(_of->decode_cb_ctx,_of->od,_pcm,_op,
2722      _nsamples,_nchannels,OP_DEC_FORMAT_SHORT,_of->cur_link);
2723 #else
2724     ret=(*_of->decode_cb)(_of->decode_cb_ctx,_of->od,_pcm,_op,
2725      _nsamples,_nchannels,OP_DEC_FORMAT_FLOAT,_of->cur_link);
2726 #endif
2727   }
2728   else ret=OP_DEC_USE_DEFAULT;
2729   /*If the application didn't want to handle decoding, do it ourselves.*/
2730   if(ret==OP_DEC_USE_DEFAULT){
2731 #if defined(OP_FIXED_POINT)
2732     ret=opus_multistream_decode(_of->od,
2733      _op->packet,_op->bytes,_pcm,_nsamples,0);
2734 #else
2735     ret=opus_multistream_decode_float(_of->od,
2736      _op->packet,_op->bytes,_pcm,_nsamples,0);
2737 #endif
2738     OP_ASSERT(ret<0||ret==_nsamples);
2739   }
2740   /*If the application returned a positive value other than 0 or
2741      OP_DEC_USE_DEFAULT, fail.*/
2742   else if(OP_UNLIKELY(ret>0))return OP_EBADPACKET;
2743   if(OP_UNLIKELY(ret<0))return OP_EBADPACKET;
2744   return ret;
2745 }
2746
2747 /*Read more samples from the stream, using the same API as op_read() or
2748    op_read_float().*/
2749 static int op_read_native(OggOpusFile *_of,
2750  op_sample *_pcm,int _buf_size,int *_li){
2751   if(OP_UNLIKELY(_of->ready_state<OP_OPENED))return OP_EINVAL;
2752   for(;;){
2753     int ret;
2754     if(OP_LIKELY(_of->ready_state>=OP_INITSET)){
2755       int nchannels;
2756       int od_buffer_pos;
2757       int nsamples;
2758       int op_pos;
2759       nchannels=_of->links[_of->seekable?_of->cur_link:0].head.channel_count;
2760       od_buffer_pos=_of->od_buffer_pos;
2761       nsamples=_of->od_buffer_size-od_buffer_pos;
2762       /*If we have buffered samples, return them.*/
2763       if(nsamples>0){
2764         if(nsamples*nchannels>_buf_size)nsamples=_buf_size/nchannels;
2765         memcpy(_pcm,_of->od_buffer+nchannels*od_buffer_pos,
2766          sizeof(*_pcm)*nchannels*nsamples);
2767         od_buffer_pos+=nsamples;
2768         _of->od_buffer_pos=od_buffer_pos;
2769         if(_li!=NULL)*_li=_of->cur_link;
2770         return nsamples;
2771       }
2772       /*If we have buffered packets, decode one.*/
2773       op_pos=_of->op_pos;
2774       if(OP_LIKELY(op_pos<_of->op_count)){
2775         const ogg_packet *pop;
2776         ogg_int64_t       diff;
2777         opus_int32        cur_discard_count;
2778         int               duration;
2779         int               trimmed_duration;
2780         pop=_of->op+op_pos++;
2781         _of->op_pos=op_pos;
2782         cur_discard_count=_of->cur_discard_count;
2783         duration=op_get_packet_duration(pop->packet,pop->bytes);
2784         /*We don't buffer packets with an invalid TOC sequence.*/
2785         OP_ASSERT(duration>0);
2786         trimmed_duration=duration;
2787         /*Perform end-trimming.*/
2788         if(OP_UNLIKELY(pop->e_o_s)){
2789           if(OP_UNLIKELY(op_granpos_cmp(pop->granulepos,
2790            _of->prev_packet_gp)<=0)){
2791             trimmed_duration=0;
2792           }
2793           else if(OP_LIKELY(!op_granpos_diff(&diff,
2794            pop->granulepos,_of->prev_packet_gp))){
2795             trimmed_duration=(int)OP_MIN(diff,trimmed_duration);
2796           }
2797         }
2798         _of->prev_packet_gp=pop->granulepos;
2799         if(OP_UNLIKELY(duration*nchannels>_buf_size)){
2800           op_sample *buf;
2801           /*If the user's buffer is too small, decode into a scratch buffer.*/
2802           buf=_of->od_buffer;
2803           if(OP_UNLIKELY(buf==NULL)){
2804             ret=op_init_buffer(_of);
2805             if(OP_UNLIKELY(ret<0))return ret;
2806             buf=_of->od_buffer;
2807           }
2808           ret=op_decode(_of,buf,pop,duration,nchannels);
2809           if(OP_UNLIKELY(ret<0))return ret;
2810           /*Perform pre-skip/pre-roll.*/
2811           od_buffer_pos=(int)OP_MIN(trimmed_duration,cur_discard_count);
2812           cur_discard_count-=od_buffer_pos;
2813           _of->cur_discard_count=cur_discard_count;
2814           _of->od_buffer_pos=od_buffer_pos;
2815           _of->od_buffer_size=trimmed_duration;
2816           /*Update bitrate tracking based on the actual samples we used from
2817              what was decoded.*/
2818           _of->bytes_tracked+=pop->bytes;
2819           _of->samples_tracked+=trimmed_duration-od_buffer_pos;
2820         }
2821         else{
2822           /*Otherwise decode directly into the user's buffer.*/
2823           ret=op_decode(_of,_pcm,pop,duration,nchannels);
2824           if(OP_UNLIKELY(ret<0))return ret;
2825           if(OP_LIKELY(trimmed_duration>0)){
2826             /*Perform pre-skip/pre-roll.*/
2827             od_buffer_pos=(int)OP_MIN(trimmed_duration,cur_discard_count);
2828             cur_discard_count-=od_buffer_pos;
2829             _of->cur_discard_count=cur_discard_count;
2830             trimmed_duration-=od_buffer_pos;
2831             if(OP_LIKELY(trimmed_duration>0)
2832              &&OP_UNLIKELY(od_buffer_pos>0)){
2833               memmove(_pcm,_pcm+od_buffer_pos*nchannels,
2834                sizeof(*_pcm)*trimmed_duration*nchannels);
2835             }
2836             /*Update bitrate tracking based on the actual samples we used from
2837                what was decoded.*/
2838             _of->bytes_tracked+=pop->bytes;
2839             _of->samples_tracked+=trimmed_duration;
2840             if(OP_LIKELY(trimmed_duration>0)){
2841               if(_li!=NULL)*_li=_of->cur_link;
2842               return trimmed_duration;
2843             }
2844           }
2845         }
2846         /*Don't grab another page yet.
2847           This one might have more packets, or might have buffered data now.*/
2848         continue;
2849       }
2850     }
2851     /*Suck in another page.*/
2852     ret=op_fetch_and_process_page(_of,NULL,-1,1,0);
2853     if(OP_UNLIKELY(ret==OP_EOF)){
2854       if(_li!=NULL)*_li=_of->cur_link;
2855       return 0;
2856     }
2857     if(OP_UNLIKELY(ret<0))return ret;
2858   }
2859 }
2860
2861 /*A generic filter to apply to the decoded audio data.
2862   _src is non-const because we will destructively modify the contents of the
2863    source buffer that we consume in some cases.*/
2864 typedef int (*op_read_filter_func)(OggOpusFile *_of,void *_dst,int _dst_sz,
2865  op_sample *_src,int _nsamples,int _nchannels);
2866
2867 /*Decode some samples and then apply a custom filter to them.
2868   This is used to convert to different output formats.*/
2869 static int op_filter_read_native(OggOpusFile *_of,void *_dst,int _dst_sz,
2870  op_read_filter_func _filter,int *_li){
2871   int ret;
2872   /*Ensure we have some decoded samples in our buffer.*/
2873   ret=op_read_native(_of,NULL,0,_li);
2874   /*Now apply the filter to them.*/
2875   if(OP_LIKELY(ret>=0)&&OP_LIKELY(_of->ready_state>=OP_INITSET)){
2876     int od_buffer_pos;
2877     od_buffer_pos=_of->od_buffer_pos;
2878     ret=_of->od_buffer_size-od_buffer_pos;
2879     if(OP_LIKELY(ret>0)){
2880       int nchannels;
2881       nchannels=_of->links[_of->seekable?_of->cur_link:0].head.channel_count;
2882       ret=(*_filter)(_of,_dst,_dst_sz,
2883        _of->od_buffer+nchannels*od_buffer_pos,ret,nchannels);
2884       OP_ASSERT(ret>=0);
2885       OP_ASSERT(ret<=_of->od_buffer_size-od_buffer_pos);
2886       od_buffer_pos+=ret;
2887       _of->od_buffer_pos=od_buffer_pos;
2888     }
2889   }
2890   return ret;
2891 }
2892
2893 #if !defined(OP_FIXED_POINT)||!defined(OP_DISABLE_FLOAT_API)
2894
2895 /*Matrices for downmixing from the supported channel counts to stereo.
2896   The matrices with 5 or more channels are normalized to a total volume of 2.0,
2897    since most mixes sound too quiet if normalized to 1.0 (as there is generally
2898    little volume in the side/rear channels).*/
2899 static const float OP_STEREO_DOWNMIX[OP_NCHANNELS_MAX-2][OP_NCHANNELS_MAX][2]={
2900   /*3.0*/
2901   {
2902     {0.5858F,0.0F},{0.4142F,0.4142F},{0.0F,0.5858F}
2903   },
2904   /*quadrophonic*/
2905   {
2906     {0.4226F,0.0F},{0.0F,0.4226F},{0.366F,0.2114F},{0.2114F,0.336F}
2907   },
2908   /*5.0*/
2909   {
2910     {0.651F,0.0F},{0.46F,0.46F},{0.0F,0.651F},{0.5636F,0.3254F},
2911     {0.3254F,0.5636F}
2912   },
2913   /*5.1*/
2914   {
2915     {0.529F,0.0F},{0.3741F,0.3741F},{0.0F,0.529F},{0.4582F,0.2645F},
2916     {0.2645F,0.4582F},{0.3741F,0.3741F}
2917   },
2918   /*6.1*/
2919   {
2920     {0.4553F,0.0F},{0.322F,0.322F},{0.0F,0.4553F},{0.3943F,0.2277F},
2921     {0.2277F,0.3943F},{0.2788F,0.2788F},{0.322F,0.322F}
2922   },
2923   /*7.1*/
2924   {
2925     {0.3886F,0.0F},{0.2748F,0.2748F},{0.0F,0.3886F},{0.3366F,0.1943F},
2926     {0.1943F,0.3366F},{0.3366F,0.1943F},{0.1943F,0.3366F},{0.2748F,0.2748F}
2927   }
2928 };
2929
2930 #endif
2931
2932 #if defined(OP_FIXED_POINT)
2933
2934 /*Matrices for downmixing from the supported channel counts to stereo.
2935   The matrices with 5 or more channels are normalized to a total volume of 2.0,
2936    since most mixes sound too quiet if normalized to 1.0 (as there is generally
2937    little volume in the side/rear channels).
2938   Hence we keep the coefficients in Q14, so the downmix values won't overflow a
2939    32-bit number.*/
2940 static const opus_int16 OP_STEREO_DOWNMIX_Q14
2941  [OP_NCHANNELS_MAX-2][OP_NCHANNELS_MAX][2]={
2942   /*3.0*/
2943   {
2944     {9598,0},{6786,6786},{0,9598}
2945   },
2946   /*quadrophonic*/
2947   {
2948     {6924,0},{0,6924},{5996,3464},{3464,5996}
2949   },
2950   /*5.0*/
2951   {
2952     {10666,0},{7537,7537},{0,10666},{9234,5331},{5331,9234}
2953   },
2954   /*5.1*/
2955   {
2956     {8668,0},{6129,6129},{0,8668},{7507,4335},{4335,7507},{6129,6129}
2957   },
2958   /*6.1*/
2959   {
2960     {7459,0},{5275,5275},{0,7459},{6460,3731},{3731,6460},{4568,4568},
2961     {5275,5275}
2962   },
2963   /*7.1*/
2964   {
2965     {6368,0},{4502,4502},{0,6368},{5515,3183},{3183,5515},{5515,3183},
2966     {3183,5515},{4502,4502}
2967   }
2968 };
2969
2970 int op_read(OggOpusFile *_of,opus_int16 *_pcm,int _buf_size,int *_li){
2971   return op_read_native(_of,_pcm,_buf_size,_li);
2972 }
2973
2974 static int op_stereo_filter(OggOpusFile *_of,void *_dst,int _dst_sz,
2975  op_sample *_src,int _nsamples,int _nchannels){
2976   (void)_of;
2977   _nsamples=OP_MIN(_nsamples,_dst_sz>>1);
2978   if(_nchannels==2)memcpy(_dst,_src,_nsamples*2*sizeof(*_src));
2979   else{
2980     opus_int16 *dst;
2981     int         i;
2982     dst=(opus_int16 *)_dst;
2983     if(_nchannels==1){
2984       for(i=0;i<_nsamples;i++)dst[2*i+0]=dst[2*i+1]=_src[i];
2985     }
2986     else{
2987       for(i=0;i<_nsamples;i++){
2988         opus_int32 l;
2989         opus_int32 r;
2990         int        ci;
2991         l=r=0;
2992         for(ci=0;ci<_nchannels;ci++){
2993           opus_int32 s;
2994           s=_src[_nchannels*i+ci];
2995           l+=OP_STEREO_DOWNMIX_Q14[_nchannels-3][ci][0]*s;
2996           r+=OP_STEREO_DOWNMIX_Q14[_nchannels-3][ci][1]*s;
2997         }
2998         /*TODO: For 5 or more channels, we should do soft clipping here.*/
2999         dst[2*i+0]=(opus_int16)OP_CLAMP(-32768,l+8192>>14,32767);
3000         dst[2*i+1]=(opus_int16)OP_CLAMP(-32768,r+8192>>14,32767);
3001       }
3002     }
3003   }
3004   return _nsamples;
3005 }
3006
3007 int op_read_stereo(OggOpusFile *_of,opus_int16 *_pcm,int _buf_size){
3008   return op_filter_read_native(_of,_pcm,_buf_size,op_stereo_filter,NULL);
3009 }
3010
3011 # if !defined(OP_DISABLE_FLOAT_API)
3012
3013 static int op_short2float_filter(OggOpusFile *_of,void *_dst,int _dst_sz,
3014  op_sample *_src,int _nsamples,int _nchannels){
3015   float *dst;
3016   int    i;
3017   (void)_of;
3018   dst=(float *)_dst;
3019   if(OP_UNLIKELY(_nsamples*_nchannels>_dst_sz))_nsamples=_dst_sz/_nchannels;
3020   _dst_sz=_nsamples*_nchannels;
3021   for(i=0;i<_dst_sz;i++)dst[i]=(1.0F/32768)*_src[i];
3022   return _nsamples;
3023 }
3024
3025 int op_read_float(OggOpusFile *_of,float *_pcm,int _buf_size,int *_li){
3026   return op_filter_read_native(_of,_pcm,_buf_size,op_short2float_filter,_li);
3027 }
3028
3029 static int op_short2float_stereo_filter(OggOpusFile *_of,
3030  void *_dst,int _dst_sz,op_sample *_src,int _nsamples,int _nchannels){
3031   float *dst;
3032   int    i;
3033   dst=(float *)_dst;
3034   _nsamples=OP_MIN(_nsamples,_dst_sz>>1);
3035   if(_nchannels==1){
3036     _nsamples=op_short2float_filter(_of,dst,_nsamples,_src,_nsamples,1);
3037     for(i=_nsamples;i-->0;)dst[2*i+0]=dst[2*i+1]=dst[i];
3038   }
3039   else if(_nchannels<5){
3040     /*For 3 or 4 channels, we can downmix in fixed point without risk of
3041        clipping.*/
3042     if(_nchannels>2){
3043       _nsamples=op_stereo_filter(_of,_src,_nsamples*2,
3044        _src,_nsamples,_nchannels);
3045     }
3046     return op_short2float_filter(_of,dst,_dst_sz,_src,_nsamples,2);
3047   }
3048   else{
3049     /*For 5 or more channels, we convert to floats and then downmix (so that we
3050        don't risk clipping).*/
3051     for(i=0;i<_nsamples;i++){
3052       float l;
3053       float r;
3054       int   ci;
3055       l=r=0;
3056       for(ci=0;ci<_nchannels;ci++){
3057         float s;
3058         s=(1.0F/32768)*_src[_nchannels*i+ci];
3059         l+=OP_STEREO_DOWNMIX[_nchannels-3][ci][0]*s;
3060         r+=OP_STEREO_DOWNMIX[_nchannels-3][ci][1]*s;
3061       }
3062       dst[2*i+0]=l;
3063       dst[2*i+1]=r;
3064     }
3065   }
3066   return _nsamples;
3067 }
3068
3069 int op_read_float_stereo(OggOpusFile *_of,float *_pcm,int _buf_size){
3070   return op_filter_read_native(_of,_pcm,_buf_size,
3071    op_short2float_stereo_filter,NULL);
3072 }
3073
3074 # endif
3075
3076 #else
3077
3078 # if defined(OP_HAVE_LRINTF)
3079 #  include <math.h>
3080 #  define op_float2int(_x) (lrintf(_x))
3081 # else
3082 #  define op_float2int(_x) ((int)((_x)+((_x)<0?-0.5F:0.5F)))
3083 # endif
3084
3085 /*The dithering code here is adapted from opusdec, part of opus-tools.
3086   It was originally written by Greg Maxwell.*/
3087
3088 static opus_uint32 op_rand(opus_uint32 _seed){
3089   return _seed*96314165+907633515&0xFFFFFFFFU;
3090 }
3091
3092 /*This implements 16-bit quantization with full triangular dither and IIR noise
3093    shaping.
3094   The noise shaping filters were designed by Sebastian Gesemann, and are based
3095    on the LAME ATH curves with flattening to limit their peak gain to 20 dB.
3096   Everyone else's noise shaping filters are mildly crazy.
3097   The 48 kHz version of this filter is just a warped version of the 44.1 kHz
3098    filter and probably could be improved by shifting the HF shelf up in
3099    frequency a little bit, since 48 kHz has a bit more room and being more
3100    conservative against bat-ears is probably more important than more noise
3101    suppression.
3102   This process can increase the peak level of the signal (in theory by the peak
3103    error of 1.5 +20 dB, though that is unobservably rare).
3104   To avoid clipping, the signal is attenuated by a couple thousandths of a dB.
3105   Initially, the approach taken here was to only attenuate by the 99.9th
3106    percentile, making clipping rare but not impossible (like SoX), but the
3107    limited gain of the filter means that the worst case was only two
3108    thousandths of a dB more, so this just uses the worst case.
3109   The attenuation is probably also helpful to prevent clipping in the DAC
3110    reconstruction filters or downstream resampling, in any case.*/
3111
3112 # define OP_GAIN (32753.0F)
3113
3114 # define OP_PRNG_GAIN (1.0F/0xFFFFFFFF)
3115
3116 /*48 kHz noise shaping filter, sd=2.34.*/
3117
3118 static const float OP_FCOEF_B[4]={
3119   2.2374F,-0.7339F,-0.1251F,-0.6033F
3120 };
3121
3122 static const float OP_FCOEF_A[4]={
3123   0.9030F,0.0116F,-0.5853F,-0.2571F
3124 };
3125
3126 static int op_float2short_filter(OggOpusFile *_of,void *_dst,int _dst_sz,
3127  float *_src,int _nsamples,int _nchannels){
3128   opus_int16 *dst;
3129   int         ci;
3130   int         i;
3131   dst=(opus_int16 *)_dst;
3132   if(OP_UNLIKELY(_nsamples*_nchannels>_dst_sz))_nsamples=_dst_sz/_nchannels;
3133 # if defined(OP_SOFT_CLIP)
3134   if(_of->state_channel_count!=_nchannels){
3135     for(ci=0;ci<_nchannels;ci++)_of->clip_state[ci]=0;
3136   }
3137   opus_pcm_soft_clip(_src,_nsamples,_nchannels,_of->clip_state);
3138 # endif
3139   if(_of->dither_disabled){
3140     for(i=0;i<_nchannels*_nsamples;i++){
3141       dst[i]=op_float2int(OP_CLAMP(-32768,32768.0F*_src[i],32767));
3142     }
3143   }
3144   else{
3145     opus_uint32 seed;
3146     int         mute;
3147     seed=_of->dither_seed;
3148     mute=_of->dither_mute;
3149     if(_of->state_channel_count!=_nchannels)mute=65;
3150     /*In order to avoid replacing digital silence with quiet dither noise, we
3151        mute if the output has been silent for a while.*/
3152     if(mute>64)memset(_of->dither_a,0,sizeof(*_of->dither_a)*4*_nchannels);
3153     for(i=0;i<_nsamples;i++){
3154       int silent;
3155       silent=1;
3156       for(ci=0;ci<_nchannels;ci++){
3157         float r;
3158         float s;
3159         float err;
3160         int   si;
3161         int   j;
3162         s=_src[_nchannels*i+ci];
3163         silent&=s==0;
3164         s*=OP_GAIN;
3165         err=0;
3166         for(j=0;j<4;j++){
3167           err+=OP_FCOEF_B[j]*_of->dither_b[ci*4+j]
3168            -OP_FCOEF_A[j]*_of->dither_a[ci*4+j];
3169         }
3170         for(j=3;j-->0;)_of->dither_a[ci*4+j+1]=_of->dither_a[ci*4+j];
3171         for(j=3;j-->0;)_of->dither_b[ci*4+j+1]=_of->dither_b[ci*4+j];
3172         _of->dither_a[ci*4]=err;
3173         s-=err;
3174         if(mute>16)r=0;
3175         else{
3176           seed=op_rand(seed);
3177           r=seed*OP_PRNG_GAIN;
3178           seed=op_rand(seed);
3179           r-=seed*OP_PRNG_GAIN;
3180         }
3181         /*Clamp in float out of paranoia that the input will be > 96 dBFS and
3182            wrap if the integer is clamped.*/
3183         si=op_float2int(OP_CLAMP(-32768,s+r,32767));
3184         dst[_nchannels*i+ci]=(opus_int16)si;
3185         /*Including clipping in the noise shaping is generally disastrous: the
3186            futile effort to restore the clipped energy results in more clipping.
3187           However, small amounts---at the level which could normally be created
3188            by dither and rounding---are harmless and can even reduce clipping
3189            somewhat due to the clipping sometimes reducing the dither + rounding
3190            error.*/
3191         _of->dither_b[ci*4]=mute>16?0:OP_CLAMP(-1.5F,si-s,1.5F);
3192       }
3193       mute++;
3194       if(!silent)mute=0;
3195     }
3196     _of->dither_mute=OP_MIN(mute,65);
3197     _of->dither_seed=seed;
3198   }
3199   _of->state_channel_count=_nchannels;
3200   return _nsamples;
3201 }
3202
3203 int op_read(OggOpusFile *_of,opus_int16 *_pcm,int _buf_size,int *_li){
3204   return op_filter_read_native(_of,_pcm,_buf_size,op_float2short_filter,_li);
3205 }
3206
3207 int op_read_float(OggOpusFile *_of,float *_pcm,int _buf_size,int *_li){
3208   _of->state_channel_count=0;
3209   return op_read_native(_of,_pcm,_buf_size,_li);
3210 }
3211
3212 static int op_stereo_filter(OggOpusFile *_of,void *_dst,int _dst_sz,
3213  op_sample *_src,int _nsamples,int _nchannels){
3214   (void)_of;
3215   _nsamples=OP_MIN(_nsamples,_dst_sz>>1);
3216   if(_nchannels==2)memcpy(_dst,_src,_nsamples*2*sizeof(*_src));
3217   else{
3218     float *dst;
3219     int    i;
3220     dst=(float *)_dst;
3221     if(_nchannels==1){
3222       for(i=0;i<_nsamples;i++)dst[2*i+0]=dst[2*i+1]=_src[i];
3223     }
3224     else{
3225       for(i=0;i<_nsamples;i++){
3226         float l;
3227         float r;
3228         int   ci;
3229         l=r=0;
3230         for(ci=0;ci<_nchannels;ci++){
3231           l+=OP_STEREO_DOWNMIX[_nchannels-3][ci][0]*_src[_nchannels*i+ci];
3232           r+=OP_STEREO_DOWNMIX[_nchannels-3][ci][1]*_src[_nchannels*i+ci];
3233         }
3234         dst[2*i+0]=l;
3235         dst[2*i+1]=r;
3236       }
3237     }
3238   }
3239   return _nsamples;
3240 }
3241
3242 static int op_float2short_stereo_filter(OggOpusFile *_of,
3243  void *_dst,int _dst_sz,op_sample *_src,int _nsamples,int _nchannels){
3244   opus_int16 *dst;
3245   dst=(opus_int16 *)_dst;
3246   if(_nchannels==1){
3247     int i;
3248     _nsamples=op_float2short_filter(_of,dst,_dst_sz>>1,_src,_nsamples,1);
3249     for(i=_nsamples;i-->0;)dst[2*i+0]=dst[2*i+1]=dst[i];
3250   }
3251   else{
3252     if(_nchannels>2){
3253       _nsamples=OP_MIN(_nsamples,_dst_sz>>1);
3254       _nsamples=op_stereo_filter(_of,_src,_nsamples*2,
3255        _src,_nsamples,_nchannels);
3256     }
3257     _nsamples=op_float2short_filter(_of,dst,_dst_sz,_src,_nsamples,2);
3258   }
3259   return _nsamples;
3260 }
3261
3262 int op_read_stereo(OggOpusFile *_of,opus_int16 *_pcm,int _buf_size){
3263   return op_filter_read_native(_of,_pcm,_buf_size,
3264    op_float2short_stereo_filter,NULL);
3265 }
3266
3267 int op_read_float_stereo(OggOpusFile *_of,float *_pcm,int _buf_size){
3268   _of->state_channel_count=0;
3269   return op_filter_read_native(_of,_pcm,_buf_size,op_stereo_filter,NULL);
3270 }
3271
3272 #endif