opusfile.h 85.2 KB
Newer Older
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/********************************************************************
 *                                                                  *
 * THIS FILE IS PART OF THE libopusfile SOFTWARE CODEC SOURCE CODE. *
 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
 *                                                                  *
 * THE libopusfile SOURCE CODE IS (C) COPYRIGHT 1994-2012           *
 * by the Xiph.Org Foundation and contributors http://www.xiph.org/ *
 *                                                                  *
 ********************************************************************

 function: stdio-based convenience library for opening/seeking/decoding
 last mod: $Id: vorbisfile.h 17182 2010-04-29 03:48:32Z xiphmont $

 ********************************************************************/
17
18
#if !defined(_opusfile_h)
# define _opusfile_h (1)
19
# include <stdarg.h>
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
20

21
22
23
24
25
26
27
28
29
30
31
32
33
34
/**\mainpage
   \section Introduction

   This is the documentation for the <tt>libopusfile</tt> C API.

   The <tt>libopusfile</tt> package provides a convenient high-level API for
    decoding and basic manipulation of all Ogg Opus audio streams.
   <tt>libopusfile</tt> is implemented as a layer on top of Xiph.Org's
    reference
    <tt><a href="https://www.xiph.org/ogg/doc/libogg/reference.html">libogg</a></tt>
    and
    <tt><a href="https://mf4.xiph.org/jenkins/view/opus/job/opus/ws/doc/html/index.html">libopus</a></tt>
    libraries.

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
35
   <tt>libopusfile</tt> provides several sets of built-in routines for
36
37
38
39
    file/stream access, and may also use custom stream I/O routines provided by
    the embedded environment.
   There are built-in I/O routines provided for ANSI-compliant
    <code>stdio</code> (<code>FILE *</code>), memory buffers, and URLs
40
    (including <file:> URLs, plus optionally <http:> and <https:> URLs).
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

   \section Organization

   The main API is divided into several sections:
   - \ref stream_open_close
   - \ref stream_info
   - \ref stream_decoding
   - \ref stream_seeking

   Several additional sections are not tied to the main API.
   - \ref stream_callbacks
   - \ref header_info
   - \ref error_codes*/


Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
56
57
58
59
60
61
# if defined(__cplusplus)
extern "C" {
# endif

# include <stdio.h>
# include <ogg/ogg.h>
62
# include <opus_multistream.h>
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

/*Enable special features for gcc and gcc-compatible compilers.*/
# if !defined(OP_GNUC_PREREQ)
#  if defined(__GNUC__)&&defined(__GNUC_MINOR__)
#   define OP_GNUC_PREREQ(_maj,_min) \
 ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
#  else
#   define OP_GNUC_PREREQ(_maj,_min) 0
#  endif
# endif

# if OP_GNUC_PREREQ(4,0)
#  pragma GCC visibility push(default)
# endif

typedef struct OpusHead    OpusHead;
typedef struct OpusTags    OpusTags;
typedef struct OggOpusFile OggOpusFile;

/*Warning attributes for libopusfile functions.*/
# if OP_GNUC_PREREQ(3,4)
#  define OP_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
# else
#  define OP_WARN_UNUSED_RESULT
# endif
# if OP_GNUC_PREREQ(3,4)
#  define OP_ARG_NONNULL(_x) __attribute__((__nonnull__(_x)))
# else
#  define OP_ARG_NONNULL(_x)
# endif

94
95
96
97
98
99
100
101
102
/**\defgroup error_codes Error Codes*/
/*@{*/
/**\name List of possible error codes
   Many of the functions in this library return a negative error code when a
    function fails.
   This list provides a brief explanation of the common errors.
   See each individual function for more details on what a specific error code
    means in that context.*/
/*@{*/
103

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/**A request did not succeed.*/
#define OP_FALSE         (-1)
/*Currently not used externally.*/
#define OP_EOF           (-2)
/**There was a hole in the page sequence numbers (e.g., a page was corrupt or
    missing).*/
#define OP_HOLE          (-3)
/**An underlying read, seek, or tell operation failed when it should have
    succeeded.*/
#define OP_EREAD         (-128)
/**A <code>NULL</code> pointer was passed where one was unexpected, or an
    internal memory allocation failed, or an internal library error was
    encountered.*/
#define OP_EFAULT        (-129)
/**The stream used a feature that is not implemented, such as an unsupported
    channel family.*/
#define OP_EIMPL         (-130)
/**One or more parameters to a function were invalid.*/
#define OP_EINVAL        (-131)
123
/**A purported Ogg Opus stream did not begin with an Ogg page, a purported
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
124
    header packet did not start with one of the required strings, "OpusHead" or
125
126
    "OpusTags", or a link in a chained file was encountered that did not
    contain any logical Opus streams.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
#define OP_ENOTFORMAT    (-132)
/**A required header packet was not properly formatted, contained illegal
    values, or was missing altogether.*/
#define OP_EBADHEADER    (-133)
/**The ID header contained an unrecognized version number.*/
#define OP_EVERSION      (-134)
/*Currently not used at all.*/
#define OP_ENOTAUDIO     (-135)
/**An audio packet failed to decode properly.
   This is usually caused by a multistream Ogg packet where the durations of
    the individual Opus packets contained in it are not all the same.*/
#define OP_EBADPACKET    (-136)
/**We failed to find data we had seen before, or the bitstream structure was
    sufficiently malformed that seeking to the target destination was
    impossible.*/
#define OP_EBADLINK      (-137)
/**An operation that requires seeking was requested on an unseekable stream.*/
#define OP_ENOSEEK       (-138)
/**The first or last granule position of a link failed basic validity checks.*/
#define OP_EBADTIMESTAMP (-139)
147

148
149
150
151
152
/*@}*/
/*@}*/

/**\defgroup header_info Header Information*/
/*@{*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

/**The maximum number of channels in an Ogg Opus stream.*/
#define OPUS_CHANNEL_COUNT_MAX (255)

/**Ogg Opus bitstream information.
   This contains the basic playback parameters for a stream, and corresponds to
    the initial ID header packet of an Ogg Opus stream.*/
struct OpusHead{
  /**The Ogg Opus format version, in the range 0...255.
     The top 4 bits represent a "major" version, and the bottom four bits
      represent backwards-compatible "minor" revisions.
     The current specification describes version 1.
     This library will recognize versions up through 15 as backwards compatible
      with the current specification.
     An earlier draft of the specification described a version 0, but the only
      difference between version 1 and version 0 is that version 0 did
      not specify the semantics for handling the version field.*/
  int           version;
  /**The number of channels, in the range 1...255.*/
  int           channel_count;
  /**The number of samples that should be discarded from the beginning of the
      stream.*/
  unsigned      pre_skip;
  /**The sampling rate of the original input.
     All Opus audio is coded at 48 kHz, and should also be decoded at 48 kHz
      for playback (unless the target hardware does not support this sampling
      rate).
     However, this field may be used to resample the audio back to the original
      sampling rate, for example, when saving the output to a file.*/
  opus_uint32   input_sample_rate;
  /**The gain to apply to the decoded output, in dB, as a Q8 value in the range
      -32768...32767.
     The decoder will automatically scale the output by
      pow(10,output_gain/(20.0*256)).*/
  int           output_gain;
  /**The channel mapping family, in the range 0...255.
     Channel mapping family 0 covers mono or stereo in a single stream.
     Channel mapping family 1 covers 1 to 8 channels in one or more streams,
      using the Vorbis speaker assignments.
     Channel mapping family 255 covers 1 to 255 channels in one or more
      streams, but without any defined speaker assignment.*/
  int           mapping_family;
  /**The number of Opus streams in each Ogg packet, in the range 1...255.*/
  int           stream_count;
  /**The number of coupled Opus streams in each Ogg packet, in the range
      0...127.
     This must satisfy <code>0 <= coupled_count <= stream_count</code> and
      <code>coupled_count + stream_count <= 255</code>.
     The coupled streams appear first, before all uncoupled streams, in an Ogg
      Opus packet.*/
  int           coupled_count;
  /**The mapping from coded stream channels to output channels.
     Let <code>index=mapping[k]</code> be the value for channel <code>k</code>.
     If <code>index<2*coupled_count</code>, then it refers to the left channel
      from stream <code>(index/2)</code> if even, and the right channel from
      stream <code>(index/2)</code> if odd.
     Otherwise, it refers to the output of the uncoupled stream
      <code>(index-coupled_count)</code>.*/
  unsigned char mapping[OPUS_CHANNEL_COUNT_MAX];
};

/**The metadata from an Ogg Opus stream.

   This structure holds the in-stream metadata corresponding to the 'comment'
    header packet of an Ogg Opus stream.
   The comment header is meant to be used much like someone jotting a quick
    note on the label of a CD.
   It should be a short, to the point text note that can be more than a couple
    words, but not more than a short paragraph.

   The metadata is stored as a series of (tag, value) pairs, in length-encoded
    string vectors, using the same format as Vorbis (without the final "framing
    bit"), Theora, and Speex, except for the packet header.
   The first occurrence of the '=' character delimits the tag and value.
   A particular tag may occur more than once, and order is significant.
   The character set encoding for the strings is always UTF-8, but the tag
    names are limited to ASCII, and treated as case-insensitive.
   See <a href="http://www.xiph.org/vorbis/doc/v-comment.html">the Vorbis
    comment header specification</a> for details.

233
   In filling in this structure, <tt>libopusfile</tt> will null-terminate the
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    #user_comments strings for safety.
   However, the bitstream format itself treats them as 8-bit clean vectors,
    possibly containing NUL characters, so the #comment_lengths array should be
    treated as their authoritative length.

   This structure is binary and source-compatible with a
    <code>vorbis_comment</code>, and pointers to it may be freely cast to
    <code>vorbis_comment</code> pointers, and vice versa.
   It is provided as a separate type to avoid introducing a compile-time
    dependency on the libvorbis headers.*/
struct OpusTags{
  /**The array of comment string vectors.*/
  char **user_comments;
  /**An array of the corresponding length of each vector, in bytes.*/
  int   *comment_lengths;
  /**The total number of comment streams.*/
  int    comments;
  /**The null-terminated vendor string.
     This identifies the software used to encode the stream.*/
  char  *vendor;
};

/**\name Functions for manipulating header data
257

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
258
   These functions manipulate the #OpusHead and #OpusTags structures,
259
260
261
262
    which describe the audio parameters and tag-value metadata, respectively.
   These can be used to query the headers returned by <tt>libopusfile</tt>, or
    to parse Opus headers from sources other than an Ogg Opus stream, provided
    they use the same format.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
263
/*@{*/
264

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/**Parses the contents of the ID header packet of an Ogg Opus stream.
   \param[out] _head Returns the contents of the parsed packet.
                     The contents of this structure are untouched on error.
                     This may be <code>NULL</code> to merely test the header
                      for validity.
   \param[in]  _data The contents of the ID header packet.
   \param      _len  The number of bytes of data in the ID header packet.
   \return 0 on success or a negative value on error.
   \retval #OP_ENOTFORMAT If the data does not start with the "OpusHead"
                           string.
   \retval #OP_EVERSION   If the version field signaled a version this library
                           does not know how to parse.
   \retval #OP_EIMPL      If the channel mapping family was 255, which general
                           purpose players should not attempt to play.
   \retval #OP_EBADHEADER If the contents of the packet otherwise violate the
                           Ogg Opus specification:
                          <ul>
                           <li>Insufficient data,</li>
                           <li>Too much data for the known minor versions,</li>
                           <li>An unrecognized channel mapping family,</li>
                           <li>Zero channels or too many channels,</li>
                           <li>Zero coded streams,</li>
                           <li>Too many coupled streams, or</li>
                           <li>An invalid channel mapping index.</li>
                          </ul>*/
OP_WARN_UNUSED_RESULT int opus_head_parse(OpusHead *_head,
 const unsigned char *_data,size_t _len) OP_ARG_NONNULL(2);
292

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/**Converts a granule position to a sample offset for a given Ogg Opus stream.
   The sample offset is simply <code>_gp-_head->pre_skip</code>.
   Granule position values smaller than OpusHead#pre_skip correspond to audio
    that should never be played, and thus have no associated sample offset.
   This function returns -1 for such values.
   This function also correctly handles extremely large granule positions,
    which may have wrapped around to a negative number when stored in a signed
    ogg_int64_t value.
   \param _head The #OpusHead information from the ID header of the stream.
   \param _gp   The granule position to convert.
   \return The sample offset associated with the given granule position
            (counting at a 48 kHz sampling rate), or the special value -1 on
            error (i.e., the granule position was smaller than the pre-skip
            amount).*/
ogg_int64_t opus_granule_sample(const OpusHead *_head,ogg_int64_t _gp)
 OP_ARG_NONNULL(1);

/**Parses the contents of the 'comment' header packet of an Ogg Opus stream.
   \param[out] _tags An uninitialized #OpusTags structure.
                     This returns the contents of the parsed packet.
                     The contents of this structure are untouched on error.
                     This may be <code>NULL</code> to merely test the header
                      for validity.
   \param[in]  _data The contents of the 'comment' header packet.
   \param      _len  The number of bytes of data in the 'info' header packet.
   \retval 0             Success.
   \retval #OP_ENOTFORMAT If the data does not start with the "OpusTags"
                           string.
   \retval #OP_EBADHEADER If the contents of the packet otherwise violate the
                           Ogg Opus specification.
   \retval #OP_EFAULT     If there wasn't enough memory to store the tags.*/
OP_WARN_UNUSED_RESULT int opus_tags_parse(OpusTags *_tags,
 const unsigned char *_data,size_t _len) OP_ARG_NONNULL(2);
326

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
327
328
329
330
331
/**Initializes an #OpusTags structure.
   This should be called on a freshly allocated #OpusTags structure before
    attempting to use it.
   \param _tags The #OpusTags structure to initialize.*/
void opus_tags_init(OpusTags *_tags) OP_ARG_NONNULL(1);
332

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
333
334
335
336
337
/**Add a (tag, value) pair to an initialized #OpusTags structure.
   \note Neither opus_tags_add() nor opus_tags_add_comment() support values
    containing embedded NULs, although the bitstream format does support them.
   To add such tags, you will need to manipulate the #OpusTags structure
    directly.
338
339
340
341
   \param _tags  The #OpusTags structure to add the (tag, value) pair to.
   \param _tag   A NUL-terminated, case-insensitive, ASCII string containing
                  the tag to add (without an '=' character).
   \param _value A NUL-terminated UTF-8 containing the corresponding value.
342
   \return 0 on success, or a negative value on failure.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
343
   \retval #OP_EFAULT An internal memory allocation failed.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
344
345
int opus_tags_add(OpusTags *_tags,const char *_tag,const char *_value)
 OP_ARG_NONNULL(1) OP_ARG_NONNULL(2) OP_ARG_NONNULL(3);
346

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
347
348
349
350
351
352
353
/**Add a comment to an initialized #OpusTags structure.
   \note Neither opus_tags_add_comment() nor opus_tags_add() support comments
    containing embedded NULs, although the bitstream format does support them.
   To add such tags, you will need to manipulate the #OpusTags structure
    directly.
   \param _tags    The #OpusTags structure to add the comment to.
   \param _comment A NUL-terminated UTF-8 string containing the comment in
354
355
                    "TAG=value" form.
   \return 0 on success, or a negative value on failure.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
356
   \retval #OP_EFAULT An internal memory allocation failed.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
357
358
int opus_tags_add_comment(OpusTags *_tags,const char *_comment)
 OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
359

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
360
361
362
363
364
365
366
367
368
369
370
371
372
373
/**Look up a comment value by its tag.
   \param _tags  An initialized #OpusTags structure.
   \param _tag   The tag to look up.
   \param _count The instance of the tag.
                 The same tag can appear multiple times, each with a distinct
                  value, so an index is required to retrieve them all.
                 The order in which these values appear is significant and
                  should be preserved.
                 Use opus_tags_query_count() to get the legal range for the
                  \a _count parameter.
   \return A pointer to the queried tag's value.
           This points directly to data in the #OpusTags structure.
           It should not be modified or freed by the application, and
            modifications to the structure may invalidate the pointer.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
374
   \retval NULL If no matching tag is found.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
375
376
const char *opus_tags_query(const OpusTags *_tags,const char *_tag,int _count)
 OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
377

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
378
379
380
381
382
383
384
385
386
/**Look up the number of instances of a tag.
   Call this first when querying for a specific tag and then iterate over the
    number of instances with separate calls to opus_tags_query() to retrieve
    all the values for that tag in order.
   \param _tags An initialized #OpusTags structure.
   \param _tag  The tag to look up.
   \return The number of instances of this particular tag.*/
int opus_tags_query_count(const OpusTags *_tags,const char *_tag)
 OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
387

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
388
389
390
391
392
393
394
395
396
/**Clears the #OpusTags structure.
   This should be called on an #OpusTags structure after it is no longer
    needed.
   It will free all memory used by the structure members.
   \param _tags The #OpusTags structure to clear.*/
void opus_tags_clear(OpusTags *_tags) OP_ARG_NONNULL(1);

/*@}*/

397
398
/*@}*/

399
/**\defgroup url_options URL Reading Options*/
400
/*@{*/
401
402
403
404
405
406
407
408
/**\name URL reading options
   Options for op_url_stream_create() and associated functions.
   These allow you to provide proxy configuration parameters, skip SSL
    certificate checks, etc.
   Options are processed in order, and if the same option is passed multiple
    times, only the value specified by the last occurrence has an effect
    (unless otherwise specified).
   They may be expanded in the future.*/
409
410
/*@{*/

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/*These are the raw numbers used to define the request codes.
  They should not be used directly.*/
#define OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST (6464)
#define OP_HTTP_PROXY_HOST_REQUEST            (6528)
#define OP_HTTP_PROXY_PORT_REQUEST            (6592)
#define OP_HTTP_PROXY_USER_REQUEST            (6656)
#define OP_HTTP_PROXY_PASS_REQUEST            (6720)

#define OP_URL_OPT(_request) ((_request)+(char *)0)

/*These macros trigger compilation errors or warnings if the wrong types are
   provided to one of the URL options.*/
#define OP_CHECK_INT(_x) ((void)((_x)==(opus_int32)0),(opus_int32)(_x))
#define OP_CHECK_CONST_CHAR_PTR(_x) ((_x)+((_x)-(const char *)(_x)))

/**Skip the certificate check when connecting via TLS/SSL (https).
   \param _b <code>opus_int32</code>: Whether or not to skip the certificate
              check.
             The check will be skipped if \a _b is non-zero, and will not be
              skipped if \a _b is zero.
   \hideinitializer*/
#define OP_SSL_SKIP_CERTIFICATE_CHECK(_b) \
 OP_URL_OPT(OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST),OP_CHECK_INT(_b)

/**Proxy connections through the given host.
   If no port is specified via #OP_HTTP_PROXY_PORT, the port number defaults
    to 8080 (http-alt).
   All proxy parameters are ignored for non-http and non-https URLs.
   \param _host <code>const char *</code>: The proxy server hostname.
                This may be <code>NULL</code> to disable the use of a proxy
                 server.
   \hideinitializer*/
#define OP_HTTP_PROXY_HOST(_host) \
 OP_URL_OPT(OP_HTTP_PROXY_HOST_REQUEST),OP_CHECK_CONST_CHAR_PTR(_host)

/**Use the given port when proxying connections.
   This option only has an effect if #OP_HTTP_PROXY_HOST is specified with a
    non-<code>NULL</code> \a _host.
   If this option is not provided, the proxy port number defaults to 8080
    (http-alt).
   All proxy parameters are ignored for non-http and non-https URLs.
   \param _port <code>opus_int32</code>: The proxy server port.
                This must be in the range 0...65535 (inclusive), or the
                 URL function this is passed to will fail.
   \hideinitializer*/
#define OP_HTTP_PROXY_PORT(_port) \
 OP_URL_OPT(OP_HTTP_PROXY_PORT_REQUEST),OP_CHECK_INT(_port)

/**Use the given user name for authentication when proxying connections.
   All proxy parameters are ignored for non-http and non-https URLs.
   \param _user const char *: The proxy server user name.
                              This may be <code>NULL</code> to disable proxy
                               authentication.
                              A non-<code>NULL</code> value only has an effect
                               if #OP_HTTP_PROXY_HOST and #OP_HTTP_PROXY_PASS
                               are also specified with non-<code>NULL</code>
                               arguments.
   \hideinitializer*/
#define OP_HTTP_PROXY_USER(_user) \
 OP_URL_OPT(OP_HTTP_PROXY_USER_REQUEST),OP_CHECK_CONST_CHAR_PTR(_host)

/**Use the given password for authentication when proxying connections.
   All proxy parameters are ignored for non-http and non-https URLs.
   \param _pass const char *: The proxy server password.
                              This may be <code>NULL</code> to disable proxy
                               authentication.
                              A non-<code>NULL</code> value only has an effect
                               if #OP_HTTP_PROXY_HOST and #OP_HTTP_PROXY_USER
                               are also specified with non-<code>NULL</code>
                               arguments.
   \hideinitializer*/
#define OP_HTTP_PROXY_PASS(_pass) \
 OP_URL_OPT(OP_HTTP_PROXY_PASS_REQUEST),OP_CHECK_CONST_CHAR_PTR(_host)
484
485
486
487

/*@}*/
/*@}*/

488
/**\defgroup stream_callbacks Abstract Stream Reading Interface*/
489
/*@{*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
490
491
492
493
494
495
/**\name Functions for reading from streams
   These functions define the interface used to read from and seek in a stream
    of data.
   A stream does not need to implement seeking, but the decoder will not be
    able to seek if it does not do so.
   These functions also include some convenience routines for working with
496
497
    standard <code>FILE</code> pointers, complete streams stored in a single
    block of memory, or URLs.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
498
499
500
501
/*@{*/

typedef struct OpusFileCallbacks OpusFileCallbacks;

502
503
504
505
506
507
508
509
510
/**Reads up to \a _nbytes bytes of data from \a _stream.
   \param      _stream The stream to read from.
   \param[out] _ptr    The buffer to store the data in.
   \param      _nbytes The maximum number of bytes to read.
                       This function may return fewer, though it will not
                        return zero unless it reaches end-of-file.
   \return The number of bytes successfully read, or a negative value on
            error.*/
typedef int (*op_read_func)(void *_stream,unsigned char *_ptr,int _nbytes);
511

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
512
513
514
515
516
517
518
519
520
521
/**Sets the position indicator for \a _stream.
   The new position, measured in bytes, is obtained by adding \a _offset
    bytes to the position specified by \a _whence.
   If \a _whence is set to <code>SEEK_SET</code>, <code>SEEK_CUR</code>, or
    <code>SEEK_END</code>, the offset is relative to the start of the stream,
    the current position indicator, or end-of-file, respectively.
   \retval 0  Success.
   \retval -1 Seeking is not supported or an error occurred.
              <code>errno</code> need not be set.*/
typedef int (*op_seek_func)(void *_stream,opus_int64 _offset,int _whence);
522

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
523
524
525
/**Obtains the current value of the position indicator for \a _stream.
   \return The current position indicator.*/
typedef opus_int64 (*op_tell_func)(void *_stream);
526

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
527
528
529
530
531
532
/**Closes the underlying stream.
   \retval 0   Success.
   \retval EOF An error occurred.
               <code>errno</code> need not be set.*/
typedef int (*op_close_func)(void *_stream);

533
/**The callbacks used to access non-<code>FILE</code> stream resources.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
534
535
536
537
538
   The function prototypes are basically the same as for the stdio functions
    <code>fread()</code>, <code>fseek()</code>, <code>ftell()</code>, and
    <code>fclose()</code>.
   The differences are that the <code>FILE *</code> arguments have been
    replaced with a <code>void *</code>, which is to be used as a pointer to
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
539
540
541
    whatever internal data these functions might need, that #seek and #tell
    take and return 64-bit offsets, and that #seek <em>must</em> return -1 if
    the stream is unseekable.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
struct OpusFileCallbacks{
  /**Used to read data from the stream.
     This must not be <code>NULL</code>.*/
  op_read_func  read;
  /**Used to seek in the stream.
     This may be <code>NULL</code> if seeking is not implemented.*/
  op_seek_func  seek;
  /**Used to return the current read position in the stream.
     This may be <code>NULL</code> if seeking is not implemented.*/
  op_tell_func  tell;
  /**Used to close the stream when the decoder is freed.
     This may be <code>NULL</code> to leave the stream open.*/
  op_close_func close;
};

/**Opens a stream with <code>fopen()</code> and fills in a set of callbacks
    that can be used to access it.
   This is useful to avoid writing your own portable 64-bit seeking wrappers,
    and also avoids cross-module linking issues on Windows, where a
    <code>FILE *</code> must be accessed by routines defined in the same module
    that opened it.
   \param[out] _cb   The callbacks to use for this file.
                     If there is an error opening the file, nothing will be
                      filled in here.
   \param      _path The path to the file to open.
   \param      _mode The mode to open the file in.
568
569
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
570
571
572
OP_WARN_UNUSED_RESULT void *op_fopen(OpusFileCallbacks *_cb,
 const char *_path,const char *_mode) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
 OP_ARG_NONNULL(3);
573

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
574
575
576
577
578
579
580
581
582
583
584
/**Opens a stream with <code>fdopen()</code> and fills in a set of callbacks
    that can be used to access it.
   This is useful to avoid writing your own portable 64-bit seeking wrappers,
    and also avoids cross-module linking issues on Windows, where a
    <code>FILE *</code> must be accessed by routines defined in the same module
    that opened it.
   \param[out] _cb   The callbacks to use for this file.
                     If there is an error opening the file, nothing will be
                      filled in here.
   \param      _fd   The file descriptor to open.
   \param      _mode The mode to open the file in.
585
586
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
587
588
OP_WARN_UNUSED_RESULT void *op_fdopen(OpusFileCallbacks *_cb,
 int _fd,const char *_mode) OP_ARG_NONNULL(1) OP_ARG_NONNULL(3);
589

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
590
591
592
593
594
595
596
597
598
599
600
601
602
/**Opens a stream with <code>freopen()</code> and fills in a set of callbacks
    that can be used to access it.
   This is useful to avoid writing your own portable 64-bit seeking wrappers,
    and also avoids cross-module linking issues on Windows, where a
    <code>FILE *</code> must be accessed by routines defined in the same module
    that opened it.
   \param[out] _cb     The callbacks to use for this file.
                       If there is an error opening the file, nothing will be
                        filled in here.
   \param      _path   The path to the file to open.
   \param      _mode   The mode to open the file in.
   \param      _stream A stream previously returned by op_fopen(), op_fdopen(),
                        or op_freopen().
603
604
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
605
606
607
OP_WARN_UNUSED_RESULT void *op_freopen(OpusFileCallbacks *_cb,
 const char *_path,const char *_mode,void *_stream) OP_ARG_NONNULL(1)
 OP_ARG_NONNULL(2) OP_ARG_NONNULL(3) OP_ARG_NONNULL(4);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
608
609

/**Creates a stream that reads from the given block of memory.
610
611
   This block of memory must contain the complete stream to decode.
   This is useful for caching small streams (e.g., sound effects) in RAM.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
612
613
614
615
616
   \param[out] _cb   The callbacks to use for this stream.
                     If there is an error creating the stream, nothing will be
                      filled in here.
   \param      _data The block of memory to read from.
   \param      _size The size of the block of memory.
617
618
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
619
OP_WARN_UNUSED_RESULT void *op_mem_stream_create(OpusFileCallbacks *_cb,
620
621
622
 const unsigned char *_data,size_t _size) OP_ARG_NONNULL(1);

/**Creates a stream that reads from the given URL.
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
   This function behaves identically to op_url_stream_create(), except that it
    takes a va_list instead of a variable number of arguments.
   It does not call the <code>va_end</code> macro, and because it invokes the
    <code>va_arg</code> macro, the value of \a _ap is undefined after the call.
   \param[out]    _cb  The callbacks to use for this stream.
                       If there is an error creating the stream, nothing will
                        be filled in here.
   \param         _url The URL to read from.
                       Currently only the <file:>, <http:>, and <https:>
                        schemes are supported.
                       Both <http:> and <https:> may be disabled at compile
                        time, in which case opening such URLs will always fail.
   \param[in,out] _ap  A list of the \ref url_options "optional flags" to use.
                       This is a variable-length list of options terminated
                        with <code>NULL</code>.
638
639
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
640
641
OP_WARN_UNUSED_RESULT void *op_url_stream_vcreate(OpusFileCallbacks *_cb,
 const char *_url,va_list _ap) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
642
643

/**Creates a stream that reads from the given URL using the specified proxy.
644
645
646
647
648
649
650
651
652
653
654
   \param[out] _cb  The callbacks to use for this stream.
                    If there is an error creating the stream, nothing will be
                     filled in here.
   \param      _url The URL to read from.
                    Currently only the <file:>, <http:>, and <https:> schemes
                     are supported.
                    Both <http:> and <https:> may be disabled at compile time,
                     in which case opening such URLs will always fail.
   \param      ...  The \ref url_options "optional flags" to use.
                    This is a variable-length list of options terminated with
                     <code>NULL</code>.
655
656
   \return A stream handle to use with the callbacks, or <code>NULL</code> on
            error.*/
657
658
OP_WARN_UNUSED_RESULT void *op_url_stream_create(OpusFileCallbacks *_cb,
 const char *_url,...) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
659
660

/*@}*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
661
662
/*@}*/

663
/**\defgroup stream_open_close Opening and Closing*/
664
665
666
667
668
669
670
671
672
/*@{*/
/**\name Functions for opening and closing streams

   These functions allow you to test a stream to see if it is Opus, open it,
    and close it.
   Several flavors are provided for each of the built-in stream types, plus a
    more general version which takes a set of application-provided callbacks.*/
/*@{*/

673
/**Test to see if this is an Opus stream.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
674
   For good results, you will need at least 57 bytes (for a pure Opus-only
675
    stream).
676
677
   Something like 512 bytes will give more reliable results for multiplexed
    streams.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
678
679
   This function is meant to be a quick-rejection filter.
   Its purpose is not to guarantee that a stream is a valid Opus stream, but to
680
681
682
    ensure that it looks enough like Opus that it isn't going to be recognized
    as some other format (except possibly an Opus stream that is also
    multiplexed with other codecs, such as video).
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
   \param[out] _head     The parsed ID header contents.
                         You may pass <code>NULL</code> if you do not need
                          this information.
                         If the function fails, the contents of this structure
                          remain untouched.
   \param _initial_data  An initial buffer of data from the start of the
                          stream.
   \param _initial_bytes The number of bytes in \a _initial_data.
   \return 0 if the data appears to be Opus, or a negative value on error.
   \retval #OP_FALSE      There was not enough data to tell if this was an Opus
                           stream or not.
   \retval #OP_EFAULT     An internal memory allocation failed.
   \retval #OP_EIMPL      The stream used a feature that is not implemented,
                           such as an unsupported channel family.
   \retval #OP_ENOTFORMAT If the data did not contain a recognizable ID
                           header for an Opus stream.
   \retval #OP_EVERSION   If the version field signaled a version this library
                           does not know how to parse.
701
702
   \retval #OP_EBADHEADER The ID header was not properly formatted or contained
                           illegal values.*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
703
704
705
706
707
708
int op_test(OpusHead *_head,
 const unsigned char *_initial_data,size_t _initial_bytes);

/**Open a stream from the given file path.
   \param      _path  The path to the file to open.
   \param[out] _error Returns 0 on success, or a failure code on error.
709
710
                      You may pass in <code>NULL</code> if you don't want the
                       failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
711
712
713
                      The failure code will be #OP_EFAULT if the file could not
                       be opened, or one of the other failure codes from
                       op_open_callbacks() otherwise.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
714
   \return A freshly opened \c OggOpusFile, or <code>NULL</code> on error.*/
715
716
OP_WARN_UNUSED_RESULT OggOpusFile *op_open_file(const char *_path,int *_error)
 OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
717
718
719
720
721

/**Open a stream from a memory buffer.
   \param      _data  The memory buffer to open.
   \param      _size  The number of bytes in the buffer.
   \param[out] _error Returns 0 on success, or a failure code on error.
722
723
                      You may pass in <code>NULL</code> if you don't want the
                       failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
724
                      See op_open_callbacks() for a full list of failure codes.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
725
   \return A freshly opened \c OggOpusFile, or <code>NULL</code> on error.*/
726
727
OP_WARN_UNUSED_RESULT OggOpusFile *op_open_memory(const unsigned char *_data,
 size_t _size,int *_error);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
728

729
/**Open a stream from a URL.
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
   This function behaves identically to op_open_url(), except that it
    takes a va_list instead of a variable number of arguments.
   It does not call the <code>va_end</code> macro, and because it invokes the
    <code>va_arg</code> macro, the value of \a _ap is undefined after the call.
   \param         _url   The URL to open.
                         Currently only the <file:>, <http:>, and <https:>
                          schemes are supported.
                         Both <http:> and <https:> may be disabled at compile
                          time, in which case opening such URLs will always
                          fail.
   \param[out]    _error Returns 0 on success, or a failure code on error.
                         You may pass in <code>NULL</code> if you don't want
                          the failure code.
                         See op_open_callbacks() for a full list of failure
                          codes.
   \param[in,out] _ap    A list of the \ref url_options "optional flags" to
                          use.
                         This is a variable-length list of options terminated
                          with <code>NULL</code>.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
749
   \return A freshly opened \c OggOpusFile, or <code>NULL</code> on error.*/
750
751
OP_WARN_UNUSED_RESULT OggOpusFile *op_vopen_url(const char *_url,
 int *_error,va_list _ap) OP_ARG_NONNULL(1);
752

753
/**Open a stream from a URL.
754
755
   However, this approach will not work for live streams or HTTP/1.0 servers
    (which do not support Range requets).
756
757
758
759
760
761
762
763
764
765
766
767
   \param      _url   The URL to open.
                      Currently only the <file:>, <http:>, and <https:> schemes
                       are supported.
                      Both <http:> and <https:> may be disabled at compile
                       time, in which case opening such URLs will always fail.
   \param[out] _error Returns 0 on success, or a failure code on error.
                      You may pass in <code>NULL</code> if you don't want the
                       failure code.
                      See op_open_callbacks() for a full list of failure codes.
   \param      ...    The \ref url_options "optional flags" to use.
                      This is a variable-length list of options terminated with
                       <code>NULL</code>.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
768
   \return A freshly opened \c OggOpusFile, or <code>NULL</code> on error.*/
769
770
OP_WARN_UNUSED_RESULT OggOpusFile *op_open_url(const char *_url,
 int *_error,...) OP_ARG_NONNULL(1);
771

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
/**Open a stream using the given set of callbacks to access it.
   \param _source        The stream to read from (e.g., a <code>FILE *</code>).
   \param _cb            The callbacks with which to access the stream.
                         <code><a href="#op_read_func">read()</a></code> must
                          be implemented.
                         <code><a href="#op_seek_func">seek()</a></code> and
                          <code><a href="#op_tell_func">tell()</a></code> may
                          be <code>NULL</code>, or may always return -1 to
                          indicate a source is unseekable, but if
                          <code><a href="#op_seek_func">seek()</a></code> is
                          implemented and succeeds on a particular source, then
                          <code><a href="#op_tell_func">tell()</a></code> must
                          also.
                         <code><a href="#op_close_func">close()</a></code> may
                          be <code>NULL</code>, but if it is not, it will be
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
787
                          called when the \c OggOpusFile is destroyed by
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
                          op_free().
                         It will not be called if op_open_callbacks() fails
                          with an error.
   \param _initial_data  An initial buffer of data from the start of the
                          stream.
                         Applications can read some number of bytes from the
                          start of the stream to help identify this as an Opus
                          stream, and then provide them here to allow the
                          stream to be opened, even if it is unseekable.
   \param _initial_bytes The number of bytes in \a _initial_data.
                         If the stream is seekable, its current position (as
                          reported by
                          <code><a href="#opus_tell_func">tell()</a></code>
                          at the start of this function) must be equal to
                          \a _initial_bytes.
                         Otherwise, seeking to absolute positions will
                          generate inconsistent results.
   \param[out] _error    Returns 0 on success, or a failure code on error.
806
807
                         You may pass in <code>NULL</code> if you don't want
                          the failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
                         The failure code will be one of
                         <dl>
                           <dt>#OP_EREAD</dt>
                           <dd>An underlying read, seek, or tell operation
                            failed when it should have succeeded, or we failed
                            to find data in the stream we had seen before.</dd>
                           <dt>#OP_EFAULT</dt>
                           <dd>There was a memory allocation failure, or an
                            internal library error.</dd>
                           <dt>#OP_EIMPL</dt>
                           <dd>The stream used a feature that is not
                            implemented, such as an unsupported channel
                            family.</dd>
                           <dt>#OP_EINVAL</dt>
                           <dd><code><a href="#op_seek_func">seek()</a></code>
                            was implemented and succeeded on this source, but
                            <code><a href="#op_tell_func">tell()</a></code>
                            did not, or the starting position indicator was
                            not equal to \a _initial_bytes.</dd>
                           <dt>#OP_ENOTFORMAT</dt>
                           <dd>The stream contained a link that did not have
                            any logical Opus streams in it.</dd>
                           <dt>#OP_EBADHEADER</dt>
                           <dd>A required header packet was not properly
                            formatted, contained illegal values, or was missing
                            altogether.</dd>
                           <dt>#OP_EVERSION</dt>
                           <dd>An ID header contained an unrecognized version
                            number.</dd>
                           <dt>#OP_EBADLINK</dt>
                           <dd>We failed to find data we had seen before after
                            seeking.</dd>
                           <dt>#OP_EBADTIMESTAMP</dt>
                           <dd>The first or last timestamp in a link failed
                            basic validity checks.</dd>
                         </dl>
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
844
   \return A freshly opened \c OggOpusFile, or <code>NULL</code> on error.*/
845
846
847
OP_WARN_UNUSED_RESULT OggOpusFile *op_open_callbacks(void *_source,
 const OpusFileCallbacks *_cb,const unsigned char *_initial_data,
 size_t _initial_bytes,int *_error) OP_ARG_NONNULL(2);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
848
849

/**Partially open a stream from the given file path.
850
   \see op_test_callbacks
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
851
852
   \param      _path  The path to the file to open.
   \param[out] _error Returns 0 on success, or a failure code on error.
853
854
                      You may pass in <code>NULL</code> if you don't want the
                       failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
855
856
857
                      The failure code will be #OP_EFAULT if the file could not
                       be opened, or one of the other failure codes from
                       op_open_callbacks() otherwise.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
858
   \return A partially opened \c OggOpusFile, or <code>NULL</code> on error.*/
859
860
OP_WARN_UNUSED_RESULT OggOpusFile *op_test_file(const char *_path,int *_error)
 OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
861
862

/**Partially open a stream from a memory buffer.
863
   \see op_test_callbacks
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
864
865
866
   \param      _data  The memory buffer to open.
   \param      _size  The number of bytes in the buffer.
   \param[out] _error Returns 0 on success, or a failure code on error.
867
868
                      You may pass in <code>NULL</code> if you don't want the
                       failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
869
                      See op_open_callbacks() for a full list of failure codes.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
870
   \return A partially opened \c OggOpusFile, or <code>NULL</code> on error.*/
871
872
OP_WARN_UNUSED_RESULT OggOpusFile *op_test_memory(const unsigned char *_data,
 size_t _size,int *_error);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
873

874
/**Partially open a stream from a URL.
875
876
877
878
879
   This function behaves identically to op_test_url(), except that it
    takes a va_list instead of a variable number of arguments.
   It does not call the <code>va_end</code> macro, and because it invokes the
    <code>va_arg</code> macro, the value of \a _ap is undefined after the call.
   \see op_test_url
880
   \see op_test_callbacks
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
   \param         _url    The URL to open.
                          Currently only the <file:>, <http:>, and <https:>
                           schemes are supported.
                          Both <http:> and <https:> may be disabled at compile
                           time, in which case opening such URLs will always
                           fail.
   \param[out]    _error  Returns 0 on success, or a failure code on error.
                          You may pass in <code>NULL</code> if you don't want
                           the failure code.
                          See op_open_callbacks() for a full list of failure
                           codes.
   \param[in,out] _ap     A list of the \ref url_options "optional flags" to
                           use.
                          This is a variable-length list of options terminated
                           with <code>NULL</code>.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
896
   \return A partially opened \c OggOpusFile, or <code>NULL</code> on error.*/
897
898
OP_WARN_UNUSED_RESULT OggOpusFile *op_vtest_url(const char *_url,
 int *_error,va_list _ap) OP_ARG_NONNULL(1);
899

900
/**Partially open a stream from a URL.
901
   \see op_test_callbacks
902
903
904
905
906
907
908
909
910
911
912
913
914
   \param      _url    The URL to open.
                       Currently only the <file:>, <http:>, and <https:>
                        schemes are supported.
                       Both <http:> and <https:> may be disabled at compile
                        time, in which case opening such URLs will always fail.
   \param[out] _error  Returns 0 on success, or a failure code on error.
                       You may pass in <code>NULL</code> if you don't want the
                        failure code.
                       See op_open_callbacks() for a full list of failure
                        codes.
   \param      ...     The \ref url_options "optional flags" to use.
                       This is a variable-length list of options terminated
                        with <code>NULL</code>.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
915
   \return A partially opened \c OggOpusFile, or <code>NULL</code> on error.*/
916
917
OP_WARN_UNUSED_RESULT OggOpusFile *op_test_url(const char *_url,
 int *_error,...) OP_ARG_NONNULL(1);
918

919
/**Partially open a stream using the given set of callbacks to access it.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
920
921
   This tests for Opusness and loads the headers for the first link.
   It does not seek (although it tests for seekability).
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
   You can query a partially open stream for the few pieces of basic
    information returned by op_serialno(), op_channel_count(), op_head(), and
    op_tags() (but only for the first link).
   You may also determine if it is seekable via a call to op_seekable().
   You cannot read audio from the stream, seek, get the size or duration,
    get information from links other than the first one, or even get the total
    number of links until you finish opening the stream with op_test_open().
   If you do not need to do any of these things, you can dispose of it with
    op_free() instead.

   This function is provided mostly to simplify porting existing code that used
    <tt>libvorbisfile</tt>.
   For new code, you are likely better off using op_test() instead, which
    is less resource-intensive, requires less data to succeed, and imposes a
    hard limit on the amount of data it examines (important for unseekable
    sources, where all such data must be buffered until you are sure of the
    stream type).
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
939
940
941
942
943
944
945
946
947
948
949
950
951
952
   \param _source        The stream to read from (e.g., a <code>FILE *</code>).
   \param _cb            The callbacks with which to access the stream.
                         <code><a href="#op_read_func">read()</a></code> must
                          be implemented.
                         <code><a href="#op_seek_func">seek()</a></code> and
                          <code><a href="#op_tell_func">tell()</a></code> may
                          be <code>NULL</code>, or may always return -1 to
                          indicate a source is unseekable, but if
                          <code><a href="#op_seek_func">seek()</a></code> is
                          implemented and succeeds on a particular source, then
                          <code><a href="#op_tell_func">tell()</a></code> must
                          also.
                         <code><a href="#op_close_func">close()</a></code> may
                          be <code>NULL</code>, but if it is not, it will be
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
953
                          called when the \c OggOpusFile is destroyed by
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
                          op_free().
                         It will not be called if op_open_callbacks() fails
                          with an error.
   \param _initial_data  An initial buffer of data from the start of the
                          stream.
                         Applications can read some number of bytes from the
                          start of the stream to help identify this as an Opus
                          stream, and then provide them here to allow the
                          stream to be tested more thoroughly, even if it is
                          unseekable.
   \param _initial_bytes The number of bytes in \a _initial_data.
                         If the stream is seekable, its current position (as
                          reported by
                          <code><a href="#opus_tell_func">tell()</a></code>
                          at the start of this function) must be equal to
                          \a _initial_bytes.
                         Otherwise, seeking to absolute positions will
                          generate inconsistent results.
   \param[out] _error    Returns 0 on success, or a failure code on error.
973
974
                         You may pass in <code>NULL</code> if you don't want
                          the failure code.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
975
976
                         See op_open_callbacks() for a full list of failure
                          codes.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
977
   \return A partially opened \c OggOpusFile, or <code>NULL</code> on error.*/
978
979
980
OP_WARN_UNUSED_RESULT OggOpusFile *op_test_callbacks(void *_source,
 const OpusFileCallbacks *_cb,const unsigned char *_initial_data,
 size_t _initial_bytes,int *_error) OP_ARG_NONNULL(2);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
981
982
983
984

/**Finish opening a stream partially opened with op_test_callbacks() or one of
    the associated convenience functions.
   If this function fails, you are still responsible for freeing the
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
985
986
    \c OggOpusFile with op_free().
   \param _of The \c OggOpusFile to finish opening.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
   \return 0 on success, or a negative value on error.
   \retval #OP_EREAD         An underlying read, seek, or tell operation failed
                              when it should have succeeded.
   \retval #OP_EFAULT        There was a memory allocation failure, or an
                              internal library error.
   \retval #OP_EIMPL         The stream used a feature that is not implemented,
                              such as an unsupported channel family.
   \retval #OP_EINVAL        The stream was not partially opened with
                              op_test_callbacks() or one of the associated
                              convenience functions.
   \retval #OP_ENOTFORMAT    The stream contained a link that did not have any
                              logical Opus streams in it.
   \retval #OP_EBADHEADER    A required header packet was not properly
                              formatted, contained illegal values, or was
                              missing altogether.
   \retval #OP_EVERSION      An ID header contained an unrecognized version
                              number.
   \retval #OP_EBADLINK      We failed to find data we had seen before after
                              seeking.
   \retval #OP_EBADTIMESTAMP The first or last timestamp in a link failed basic
                              validity checks.*/
1008
int op_test_open(OggOpusFile *_of) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1009

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1010
1011
/**Release all memory used by an \c OggOpusFile.
   \param _of The \c OggOpusFile to free.*/
1012
1013
void op_free(OggOpusFile *_of);

1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
/*@}*/
/*@}*/

/**\defgroup stream_info Stream Information*/
/*@{*/
/**\name Functions for obtaining information about streams

   These functions allow you to get basic information about a stream, including
    seekability, the number of links (for chained streams), plus the size,
    duration, bitrate, header parameters, and meta information for each link
    (or, where available, the stream as a whole).
   Some of these (size, duration) are only available for seekable streams.
   You can also query the current stream position, link, and playback time,
    and instantaneous bitrate during playback.

   Some of these functions may be used successfully on the partially open
1030
1031
    streams returned by op_test_callbacks() or one of the associated
    convenience functions.
1032
1033
1034
   Their documention will indicate so explicitly.*/
/*@{*/

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1035
1036
/**Returns whether or not the data source being read is seekable.
   This is true if
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
   <ol>
   <li>The <code><a href="#op_seek_func">seek()</a></code> and
    <code><a href="#op_tell_func">tell()</a></code> callbacks are both
    non-<code>NULL</code>,</li>
   <li>The <code><a href="#op_seek_func">seek()</a></code> callback was
    successfully executed at least once, and</li>
   <li>The <code><a href="#op_tell_func">tell()</a></code> callback was
    successfully able to report the position indicator afterwards.</li>
   </ol>
   This function may be called on partially-opened streams.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1047
   \param _of The \c OggOpusFile whose seekable status is to be returned.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1048
   \return A non-zero value if seekable, and 0 if unseekable.*/
1049
int op_seekable(OggOpusFile *_of) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1050

1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
/**Returns the number of links in this chained stream.
   This function may be called on partially-opened streams, but it will always
    return 1.
   The actual number of links is not known until the stream is fully opened.
   \param _of The \c OggOpusFile from which to retrieve the link count.
   \return For fully-open seekable sources, this returns the total number of
            links in the whole stream.
           For partially-open or unseekable sources, this always returns 1.*/
int op_link_count(OggOpusFile *_of) OP_ARG_NONNULL(1);

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1061
1062
/**Get the serial number of the given link in a (possibly-chained) Ogg Opus
    stream.
1063
1064
   This function may be called on partially-opened streams, but it will always
    return the serial number of the Opus stream in the first link.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1065
   \param _of The \c OggOpusFile from which to retrieve the serial number.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1066
1067
1068
1069
1070
1071
1072
1073
   \param _li The index of the link whose serial number should be retrieved.
              Use a negative number to get the serial number of the current
               link.
   \return The serial number of the given link.
           If \a _li is greater than the total number of links, this returns
            the serial number of the last link.
           If the source is not seekable, this always returns the serial number
            of the current link.*/
1074
opus_uint32 op_serialno(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1075

1076
/**Get the channel count of the given link in a (possibly-chained) Ogg Opus
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1077
1078
1079
    stream.
   This is equivalent to <code>op_head(_of,_li)->channel_count</code>, but
    is provided for convenience.
1080
   This function may be called on partially-opened streams, but it will always
1081
    return the channel count of the Opus stream in the first link.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1082
   \param _of The \c OggOpusFile from which to retrieve the channel count.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1083
1084
1085
1086
1087
1088
1089
1090
   \param _li The index of the link whose channel count should be retrieved.
              Use a negative number to get the channel count of the current
               link.
   \return The channel count of the given link.
           If \a _li is greater than the total number of links, this returns
            the channel count of the last link.
           If the source is not seekable, this always returns the channel count
            of the current link.*/
1091
int op_channel_count(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1092
1093

/**Get the total (compressed) size of the stream, or of an individual link in
1094
1095
    a (possibly-chained) Ogg Opus stream, including all headers and Ogg muxing
    overhead.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1096
   \param _of The \c OggOpusFile from which to retrieve the compressed size.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1097
1098
1099
1100
1101
1102
   \param _li The index of the link whose compressed size should be computed.
              Use a negative number to get the compressed size of the entire
               stream.
   \return The compressed size of the entire stream if \a _li is negative, the
            compressed size of link \a _li if it is non-negative, or a negative
            value on error.
1103
1104
1105
           The compressed size of the entire stream may be smaller than that
            of the underlying source if trailing garbage was detected in the
            file.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1106
1107
1108
   \retval #OP_EINVAL The source is not seekable (so we can't know the length),
                       \a _li wasn't less than the total number of links in
                       the stream, or the stream was only partially open.*/
1109
opus_int64 op_raw_total(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1110
1111

/**Get the total PCM length (number of samples at 48 kHz) of the stream, or of
1112
    an individual link in a (possibly-chained) Ogg Opus stream.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1113
1114
1115
1116
1117
   Users looking for <code>op_time_total()</code> should use op_pcm_total()
    instead.
   Because timestamps in Opus are fixed at 48 kHz, there is no need for a
    separate function to convert this to seconds (and leaving it out avoids
    introducing floating point to the API, for those that wish to avoid it).
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1118
   \param _of The \c OggOpusFile from which to retrieve the PCM offset.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1119
1120
1121
1122
1123
1124
1125
1126
   \param _li The index of the link whose PCM length should be computed.
              Use a negative number to get the PCM length of the entire stream.
   \return The PCM length of the entire stream if \a _li is negative, the PCM
            length of link \a _li if it is non-negative, or a negative value on
            error.
   \retval #OP_EINVAL The source is not seekable (so we can't know the length),
                       \a _li wasn't less than the total number of links in
                       the stream, or the stream was only partially open.*/
1127
ogg_int64_t op_pcm_total(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1128
1129
1130

/**Get the ID header information for the given link in a (possibly chained) Ogg
    Opus stream.
1131
1132
   This function may be called on partially-opened streams, but it will always
    return the ID header information of the Opus stream in the first link.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1133
   \param _of The \c OggOpusFile from which to retrieve the ID header
1134
               information.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1135
1136
1137
1138
1139
1140
1141
   \param _li The index of the link whose ID header information should be
               retrieved.
              Use a negative number to get the ID header information of the
               current link.
              For an unseekable stream, \a _li is ignored, and the ID header
               information for the current link is always returned, if
               available.
1142
   \return The contents of the ID header for the given link.*/
1143
const OpusHead *op_head(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1144
1145
1146

/**Get the comment header information for the given link in a (possibly
    chained) Ogg Opus stream.
1147
1148
   This function may be called on partially-opened streams, but it will always
    return the tags from the Opus stream in the first link.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1149
   \param _of The \c OggOpusFile from which to retrieve the comment header
1150
               information.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1151
1152
1153
1154
1155
1156
1157
1158
   \param _li The index of the link whose comment header information should be
               retrieved.
              Use a negative number to get the comment header information of
               the current link.
              For an unseekable stream, \a _li is ignored, and the comment
               header information for the current link is always returned, if
               available.
   \return The contents of the comment header for the given link, or
1159
1160
            <code>NULL</code> if this is an unseekable stream that encountered
            an invalid link.*/
1161
const OpusTags *op_tags(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1162

1163
1164
1165
1166
1167
1168
/**Retrieve the index of the current link.
   This is the link that produced the data most recently read by
    op_read_float() or its associated functions, or, after a seek, the link
    that the seek target landed in.
   Reading more data may advance the link index (even on the first read after a
    seek).
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1169
   \param _of The \c OggOpusFile from which to retrieve the current link index.
1170
   \return The index of the current link on success, or a negative value on
1171
            failure.
1172
1173
1174
1175
1176
           For seekable streams, this is a number between 0 and the value
            returned by op_link_count().
           For unseekable streams, this value starts at 0 and increments by one
            each time a new link is encountered (even though op_link_count()
            always returns 1).
1177
   \retval #OP_EINVAL The stream was only partially open.*/
1178
int op_current_link(OggOpusFile *_of) OP_ARG_NONNULL(1);
1179

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1180
1181
1182
1183
/**Computes the bitrate for a given link in a (possibly chained) Ogg Opus
    stream.
   The stream must be seekable to compute the bitrate.
   For unseekable streams, use op_bitrate_instant() to get periodic estimates.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1184
   \param _of The \c OggOpusFile from which to retrieve the bitrate.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1185
1186
1187
   \param _li The index of the link whose bitrate should be computed.
              USe a negative number to get the bitrate of the whole stream.
   \return The bitrate on success, or a negative value on error.
1188
   \retval #OP_EINVAL The stream was only partially open, the stream was not
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1189
1190
                       seekable, or \a _li was larger than the number of
                       links.*/
1191
opus_int32 op_bitrate(OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1192
1193

/**Compute the instantaneous bitrate, measured as the ratio of bits to playable
1194
    samples decoded since a) the last call to op_bitrate_instant(), b) the last
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1195
1196
1197
1198
    seek, or c) the start of playback, whichever was most recent.
   This will spike somewhat after a seek or at the start/end of a chain
    boundary, as pre-skip, pre-roll, and end-trimming causes samples to be
    decoded but not played.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1199
   \param _of The \c OggOpusFile from which to retrieve the bitrate.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1200
   \return The bitrate, in bits per second, or a negative value on error.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1201
   \retval #OP_FALSE  No data has been decoded since any of the events
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1202
                       described above.
1203
   \retval #OP_EINVAL The stream was only partially open.*/
1204
opus_int32 op_bitrate_instant(OggOpusFile *_of) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1205

1206
/**Obtain the current value of the position indicator for \a _of.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1207
   \param _of The \c OggOpusFile from which to retrieve the position indicator.
1208
   \return The byte position that is currently being read from.
1209
   \retval #OP_EINVAL The stream was only partially open.*/
1210
1211
1212
1213
1214
1215
opus_int64 op_raw_tell(OggOpusFile *_of) OP_ARG_NONNULL(1);

/**Obtain the PCM offset of the next sample to be read.
   If the stream is not properly timestamped, this might not increment by the
    proper amount between reads, or even return monotonically increasing
    values.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1216
   \param _of The \c OggOpusFile from which to retrieve the PCM offset.
1217
   \return The PCM offset of the next sample to be read.
1218
   \retval #OP_EINVAL The stream was only partially open.*/
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
ogg_int64_t op_pcm_tell(OggOpusFile *_of) OP_ARG_NONNULL(1);

/*@}*/
/*@}*/

/**\defgroup stream_seeking Seeking*/
/*@{*/
/**\name Functions for seeking in Opus streams

   These functions let you seek in Opus streams, if the underlying source
    support it.
   Seeking is implemented for all built-in stream I/O routines, though some
    individual sources may not be seekable (pipes, live HTTP streams, or HTTP
    streams from a server that does not support <code>Range</code> requests).

   op_raw_seek() is the fastest: it is guaranteed to perform at most one
    physical seek, but, since the target is a byte position, makes no guarantee
    how close to a given time it will come.
   op_pcm_seek() provides sample-accurate seeking.
   The number of physical seeks it requires is still quite small (often 1 or
    2, even in highly variable bitrate streams).

   Seeking in Opus requires decoding some pre-roll amount before playback to
    allow the internal state to converge (as if recovering from packet loss).
   This is handled internally by <tt>libopusfile</tt>, but means there is
    little extra overhead for decoding up to the exact position requested
    (since it must decode some amount of audio anyway).
   It also means that decoding after seeking may not return exactly the same
    values as would be obtained by decoding the stream straight through.
   However, such differences are expected to be smaller than the loss
    introduced by Opus's lossy compression.*/
/*@{*/

Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1252
1253
1254
1255
/**Seek to a byte offset relative to the <b>compressed</b> data.
   This also scans packets to update the PCM cursor.
   It will cross a logical bitstream boundary, but only if it can't get any
    packets out of the tail of the link to which it seeks.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1256
   \param _of          The \c OggOpusFile in which to seek.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1257
1258
   \param _byte_offset The byte position to seek to.
   \return 0 on success, or a negative error code on failure.
1259
   \retval #OP_EREAD    The underlying seek operation failed.
1260
   \retval #OP_EINVAL   The stream was only partially open, or the target was
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1261
1262
1263
1264
                         outside the valid range for the stream.
   \retval #OP_ENOSEEK  This stream is not seekable.
   \retval #OP_EBADLINK Failed to initialize a decoder for a stream for an
                         unknown reason.*/
1265
int op_raw_seek(OggOpusFile *_of,opus_int64 _byte_offset) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1266
1267
1268

/**Seek to the specified PCM offset, such that decoding will begin at exactly
    the requested position.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1269
   \param _of         The \c OggOpusFile in which to seek.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1270
1271
1272
1273
   \param _pcm_offset The PCM offset to seek to.
                      This is in samples at 48 kHz relative to the start of the
                       stream.
   \return 0 on success, or a negative value on error.
1274
1275
1276
1277
1278
1279
1280
   \retval #OP_EREAD    An underlying read or seek operation failed.
   \retval #OP_EINVAL   The stream was only partially open, or the target was
                         outside the valid range for the stream.
   \retval #OP_ENOSEEK  This stream is not seekable.
   \retval #OP_EBADLINK We failed to find data we had seen before, or the
                         bitstream structure was sufficiently malformed that
                         seeking to the target destination was impossible.*/
1281
int op_pcm_seek(OggOpusFile *_of,ogg_int64_t _pcm_offset) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1282

1283
1284
/*@}*/
/*@}*/
1285

1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
/**\defgroup stream_decoding Decoding*/
/*@{*/
/**\name Functions for decoding audio data

   These functions retrieve actual decoded audio data from the stream.
   The general functions, op_read() and op_read_float() return 16-bit or
    floating-point output, both using native endian ordering.
   The number of channels returned can change from link to link in a chained
    stream.
   There are special functions, op_read_stereo() and op_read_float_stereo(),
    which always output two channels, to simplify applications which do not
    wish to handle multichannel audio.
   These downmix multichannel files to two channels, so they can always return
    samples in the same format for every link in a chained file.

   If the rest of your audio processing chain can handle floating point, those
    routines should be preferred, as floating point output avoids introducing
    clipping and other issues which might be avoided entirely if, e.g., you
    scale down the volume at some other stage.
   However, if you intend to direct consume 16-bit samples, the conversion in
    <tt>libopusfile</tt> provides noise-shaping dithering API.

   <tt>libopusfile</tt> can also be configured at compile time to use the
    fixed-point <tt>libopus</tt> API.
   If so, the floating-point API may also be disabled.
   In that configuration, nothing in <tt>libopusfile</tt> will use any
    floating-point operations, to simplify support on devices without an
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
    adequate FPU.

   \warning HTTPS streams may be be vulnerable to truncation attacks if you do
    not check the error return code from op_read_float() or its associated
    functions.
   If the remote peer does not close the connection gracefully (with a TLS
    "close notify" message), these functions will return OP_EREAD instead of 0
    when they reach the end of the file.
   If you are reading from an <https:> URL (particularly if seeking is not
    supported), you should make sure to check for this error and warn the user
    appropriately.*/
1324
/*@{*/
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1325
1326

/**Reads more samples from the stream.
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
   \note Although \a _buf_size must indicate the total number of values that
    can be stored in \a _pcm, the return value is the number of samples
    <em>per channel</em>.
   This is done because
   <ol>
   <li>The channel count cannot be known a prior (reading more samples might
        advance us into the next link, with a different channel count), so
        \a _buf_size cannot also be in units of samples per channel,</li>
   <li>Returning the samples per channel matches the <code>libopus</code> API
        as closely as we're able,</li>
   <li>Returning the total number of values instead of samples per channel
        would mean the caller would need a division to compute the samples per
        channel, and might worry about the possibility of getting back samples
        for some channels and not others, and</li>
   <li>This approach is relatively fool-proof: if an application passes too
        small a value to \a _buf_size, they will simply get fewer samples back,
        and if they assume the return value is the total number of values, then
        they will simply read too few (rather than reading too many and going
        off the end of the buffer).</li>
   </ol>
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1347
   \param      _of       The \c OggOpusFile from which to read.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
   \param[out] _pcm      A buffer in which to store the output PCM samples, as
                          signed native-endian 16-bit values with a nominal
                          range of <code>[-32768,32767)</code>.
                         Multiple channels are interleaved using the
                          <a href="http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">Vorbis
                          channel ordering</a>.
                         This must have room for at least \a _buf_size values.
   \param      _buf_size The number of values that can be stored in \a _pcm.
                         It is reccommended that this be large enough for at
                          least 120 ms of data at 48 kHz per channel (5760
                          values per channel).
                         Smaller buffers will simply return less data, possibly
                          consuming more memory to buffer the data internally.
1361
1362
1363
1364
                         <tt>libopusfile</tt> may return less data than
                          requested.
                         If so, there is no guarantee that the remaining data
                          in \a _pcm will be unmodified.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1365
   \param[out] _li       The index of the link this data was decoded from.
1366
1367
                         You may pass <code>NULL</code> if you do not need this
                          information.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1368
1369
1370
1371
1372
1373
1374
                         If this function fails (returning a negative value),
                          this parameter is left unset.
   \return The number of samples read per channel on success, or a negative
            value on failure.
           The channel count can be retrieved on success by calling
            <code>op_head(_of,*_li)</code>.
           The number of samples returned may be 0 if the buffer was too small
1375
            to store even a single sample for all channels, or if end-of-file
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1376
1377
1378
1379
            was reached.
           The list of possible failure codes follows.
           Most of them can only be returned by unseekable, chained streams
            that encounter a new link.
1380
1381
1382
1383
1384
1385
1386
   \retval #OP_HOLE          There was a hole in the data, and some samples
                              may have been skipped.
                             Call this function again to continue decoding
                              past the hole.
   \retval #OP_EREAD         An underlying read operation failed.
                             This may signal a truncation attack from an
                              <https:> source.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1387
1388
1389
1390
   \retval #OP_EFAULT        An internal memory allocation failed.
   \retval #OP_EIMPL         An unseekable stream encountered a new link that
                              used a feature that is not implemented, such as
                              an unsupported channel family.
1391
   \retval #OP_EINVAL        The stream was only partially open.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1392
   \retval #OP_ENOTFORMAT    An unseekable stream encountered a new link that
1393
                              did not have any logical Opus streams in it.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1394
1395
1396
1397
1398
1399
1400
1401
   \retval #OP_EBADHEADER    An unseekable stream encountered a new link with a
                              required header packet that was not properly
                              formatted, contained illegal values, or was
                              missing altogether.
   \retval #OP_EVERSION      An unseekable stream encountered a new link with
                              an ID header that contained an unrecognized
                              version number.
   \retval #OP_EBADPACKET    Failed to properly decode the next packet.
1402
   \retval #OP_EBADLINK      We failed to find data we had seen before.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1403
1404
1405
   \retval #OP_EBADTIMESTAMP An unseekable stream encountered a new link with
                              a starting timestamp that failed basic validity
                              checks.*/
1406
1407
OP_WARN_UNUSED_RESULT int op_read(OggOpusFile *_of,
 opus_int16 *_pcm,int _buf_size,int *_li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1408
1409

/**Reads more samples from the stream.
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
   \note Although \a _buf_size must indicate the total number of values that
    can be stored in \a _pcm, the return value is the number of samples
    <em>per channel</em>.
   <ol>
   <li>The channel count cannot be known a prior (reading more samples might
        advance us into the next link, with a different channel count), so
        \a _buf_size cannot also be in units of samples per channel,</li>
   <li>Returning the samples per channel matches the <code>libopus</code> API
        as closely as we're able,</li>
   <li>Returning the total number of values instead of samples per channel
        would mean the caller would need a division to compute the samples per
        channel, and might worry about the possibility of getting back samples
        for some channels and not others, and</li>
   <li>This approach is relatively fool-proof: if an application passes too
        small a value to \a _buf_size, they will simply get fewer samples back,
        and if they assume the return value is the total number of values, then
        they will simply read too few (rather than reading too many and going
        off the end of the buffer).</li>
   </ol>
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1429
   \param      _of       The \c OggOpusFile from which to read.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
   \param[out] _pcm      A buffer in which to store the output PCM samples as
                          signed floats with a nominal range of
                          <code>[-1.0,1.0]</code>.
                         Multiple channels are interleaved using the
                          <a href="http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">Vorbis
                          channel ordering</a>.
                         This must have room for at least \a _buf_size floats.
   \param      _buf_size The number of floats that can be stored in \a _pcm.
                         It is reccommended that this be large enough for at
                          least 120 ms of data at 48 kHz per channel (5760
                          samples per channel).
                         Smaller buffers will simply return less data, possibly
                          consuming more memory to buffer the data internally.
1443
1444
1445
                         If less than \a _buf_size values are returned,
                          <tt>libopusfile</tt> makes no guarantee that the
                          remaining data in \a _pcm will be unmodified.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1446
   \param[out] _li       The index of the link this data was decoded from.
1447
1448
                         You may pass <code>NULL</code> if you do not need this
                          information.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1449
1450
1451
1452
1453
1454
1455
                         If this function fails (returning a negative value),
                          this parameter is left unset.
   \return The number of samples read per channel on success, or a negative
            value on failure.
           The channel count can be retrieved on success by calling
            <code>op_head(_of,*_li)</code>.
           The number of samples returned may be 0 if the buffer was too small
1456
            to store even a single sample for all channels, or if end-of-file
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1457
1458
1459
1460
            was reached.
           The list of possible failure codes follows.
           Most of them can only be returned by unseekable, chained streams
            that encounter a new link.
1461
1462
1463
1464
1465
1466
1467
   \retval #OP_HOLE          There was a hole in the data, and some samples
                              may have been skipped.
                             Call this function again to continue decoding
                              past the hole.
   \retval #OP_EREAD         An underlying read operation failed.
                             This may signal a truncation attack from an
                              <https:> source.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1468
1469
1470
1471
   \retval #OP_EFAULT        An internal memory allocation failed.
   \retval #OP_EIMPL         An unseekable stream encountered a new link that
                              used a feature that is not implemented, such as
                              an unsupported channel family.
1472
   \retval #OP_EINVAL        The stream was only partially open.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1473
   \retval #OP_ENOTFORMAT    An unseekable stream encountered a new link that
1474
                              did not have any logical Opus streams in it.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1475
1476
1477
1478
1479
1480
1481
1482
   \retval #OP_EBADHEADER    An unseekable stream encountered a new link with a
                              required header packet that was not properly
                              formatted, contained illegal values, or was
                              missing altogether.
   \retval #OP_EVERSION      An unseekable stream encountered a new link with
                              an ID header that contained an unrecognized
                              version number.
   \retval #OP_EBADPACKET    Failed to properly decode the next packet.
1483
   \retval #OP_EBADLINK      We failed to find data we had seen before.
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1484
1485
1486
   \retval #OP_EBADTIMESTAMP An unseekable stream encountered a new link with
                              a starting timestamp that failed basic validity
                              checks.*/
1487
1488
OP_WARN_UNUSED_RESULT int op_read_float(OggOpusFile *_of,
 float *_pcm,int _buf_size,int *_li) OP_ARG_NONNULL(1);
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1489

1490
1491
1492
1493
/**Reads more samples from the stream and downmixes to stereo, if necessary.
   This function is intended for simple players that want a uniform output
    format, even if the channel count changes between links in a chained
    stream.
1494
1495
1496
1497
   \note \a _buf_size indicates the total number of values that can be stored
    in \a _pcm, while the return value is the number of samples <em>per
    channel</em>, even though the channel count is known, for consistency with
    op_read().
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1498
   \param      _of       The \c OggOpusFile from which to read.
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
   \param[out] _pcm      A buffer in which to store the output PCM samples, as
                          signed native-endian 16-bit values with a nominal
                          range of <code>[-32768,32767)</code>.
                         The left and right channels are interleaved in the
                          buffer.
                         This must have room for at least \a _buf_size values.
   \param      _buf_size The number of values that can be stored in \a _pcm.
                         It is reccommended that this be large enough for at
                          least 120 ms of data at 48 kHz per channel (11520
                          values total).
                         Smaller buffers will simply return less data, possibly
                          consuming more memory to buffer the data internally.
1511
1512
1513
                         If less than \a _buf_size values are returned,
                          <tt>libopusfile</tt> makes no guarantee that the
                          remaining data in \a _pcm will be unmodified.
1514
1515
1516
   \return The number of samples read per channel on success, or a negative
            value on failure.
           The number of samples returned may be 0 if the buffer was too small
1517
            to store even a single sample for both channels, or if end-of-file
1518
1519
1520
1521
            was reached.
           The list of possible failure codes follows.
           Most of them can only be returned by unseekable, chained streams
            that encounter a new link.
1522
1523
1524
1525
1526
1527
1528
   \retval #OP_HOLE          There was a hole in the data, and some samples
                              may have been skipped.
                             Call this function again to continue decoding
                              past the hole.
   \retval #OP_EREAD         An underlying read operation failed.
                             This may signal a truncation attack from an
                              <https:> source.
1529
1530
1531
1532
   \retval #OP_EFAULT        An internal memory allocation failed.
   \retval #OP_EIMPL         An unseekable stream encountered a new link that
                              used a feature that is not implemented, such as
                              an unsupported channel family.
1533
   \retval #OP_EINVAL        The stream was only partially open.
1534
   \retval #OP_ENOTFORMAT    An unseekable stream encountered a new link that
1535
                              did not have any logical Opus streams in it.
1536
1537
1538
1539
1540
1541
1542
1543
   \retval #OP_EBADHEADER    An unseekable stream encountered a new link with a
                              required header packet that was not properly
                              formatted, contained illegal values, or was
                              missing altogether.
   \retval #OP_EVERSION      An unseekable stream encountered a new link with
                              an ID header that contained an unrecognized
                              version number.
   \retval #OP_EBADPACKET    Failed to properly decode the next packet.
1544
   \retval #OP_EBADLINK      We failed to find data we had seen before.
1545
1546
1547
   \retval #OP_EBADTIMESTAMP An unseekable stream encountered a new link with
                              a starting timestamp that failed basic validity
                              checks.*/
1548
1549
OP_WARN_UNUSED_RESULT int op_read_stereo(OggOpusFile *_of,
 opus_int16 *_pcm,int _buf_size) OP_ARG_NONNULL(1);
1550
1551
1552
1553
1554

/**Reads more samples from the stream and downmixes to stereo, if necessary.
   This function is intended for simple players that want a uniform output
    format, even if the channel count changes between links in a chained
    stream.
1555
1556
1557
1558
   \note \a _buf_size indicates the total number of values that can be stored
    in \a _pcm, while the return value is the number of samples <em>per
    channel</em>, even though the channel count is known, for consistency with
    op_read_float().
Timothy B. Terriberry's avatar
Timothy B. Terriberry committed
1559
   \param      _of       The \c OggOpusFile from which to read.
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
   \param[out] _pcm      A buffer in which to store the output PCM samples, as
                          signed floats with a nominal range of
                          <code>[-1.0,1.0]</code>.
                         The left and right channels are interleaved in the
                          buffer.
                         This must have room for at least \a _buf_size values.
   \param      _buf_size The number of values that can be stored in \a _pcm.
                         It is reccommended that this be large enough for at
                          least 120 ms of data at 48 kHz per channel (11520
                          values total).
                         Smaller buffers will simply return less data, possibly
                          consuming more memory to buffer the data internally.
1572
1573
1574
                         If less than \a _buf_size values are returned,
                          <tt>libopusfile</tt> makes no guarantee that the
                          remaining data in \a _pcm will be unmodified.
1575
1576
1577
   \return The number of samples read per channel on success, or a negative
            value on failure.
           The number of samples returned may be 0 if the buffer was too small
1578
            to store even a single sample for both channels, or if end-of-file
1579
1580
1581
1582
            was reached.
           The list of possible failure codes follows.
           Most of them can only be returned by unseekable, chained streams
            that encounter a new link.
1583
1584
1585
1586
1587
1588
1589
   \retval #OP_HOLE          There was a hole in the data, and some samples
                              may have been skipped.
                             Call this function again to continue decoding
                              past the hole.
   \retval #OP_EREAD         An underlying read operation failed.
                             This may signal a truncation attack from an
                              <https:> source.
1590
1591
1592
1593
   \retval #OP_EFAULT        An internal memory allocation failed.
   \retval #OP_EIMPL         An unseekable stream encountered a new link that
                              used a feature that is not implemented, such as
                              an unsupported channel family.