opusfile  0.5
Stand-alone decoder library for .opus files.
 All Data Structures Functions Variables Typedefs Groups
opusfile.h
1 /********************************************************************
2  * *
3  * THIS FILE IS PART OF THE libopusfile SOFTWARE CODEC SOURCE CODE. *
4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
7  * *
8  * THE libopusfile SOURCE CODE IS (C) COPYRIGHT 1994-2012 *
9  * by the Xiph.Org Foundation and contributors http://www.xiph.org/ *
10  * *
11  ********************************************************************
12 
13  function: stdio-based convenience library for opening/seeking/decoding
14  last mod: $Id: vorbisfile.h 17182 2010-04-29 03:48:32Z xiphmont $
15 
16  ********************************************************************/
17 #if !defined(_opusfile_h)
18 # define _opusfile_h (1)
19 
103 # if defined(__cplusplus)
104 extern "C" {
105 # endif
106 
107 # include <stdarg.h>
108 # include <stdio.h>
109 # include <ogg/ogg.h>
110 # include <opus_multistream.h>
111 
114 /*Enable special features for gcc and gcc-compatible compilers.*/
115 # if !defined(OP_GNUC_PREREQ)
116 # if defined(__GNUC__)&&defined(__GNUC_MINOR__)
117 # define OP_GNUC_PREREQ(_maj,_min) \
118  ((__GNUC__<<16)+__GNUC_MINOR__>=((_maj)<<16)+(_min))
119 # else
120 # define OP_GNUC_PREREQ(_maj,_min) 0
121 # endif
122 # endif
123 
124 # if OP_GNUC_PREREQ(4,0)
125 # pragma GCC visibility push(default)
126 # endif
127 
128 typedef struct OpusHead OpusHead;
129 typedef struct OpusTags OpusTags;
130 typedef struct OpusPictureTag OpusPictureTag;
131 typedef struct OpusServerInfo OpusServerInfo;
132 typedef struct OpusFileCallbacks OpusFileCallbacks;
133 typedef struct OggOpusFile OggOpusFile;
134 
135 /*Warning attributes for libopusfile functions.*/
136 # if OP_GNUC_PREREQ(3,4)
137 # define OP_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
138 # else
139 # define OP_WARN_UNUSED_RESULT
140 # endif
141 # if OP_GNUC_PREREQ(3,4)
142 # define OP_ARG_NONNULL(_x) __attribute__((__nonnull__(_x)))
143 # else
144 # define OP_ARG_NONNULL(_x)
145 # endif
146 
158 
160 #define OP_FALSE (-1)
161 /*Currently not used externally.*/
162 #define OP_EOF (-2)
163 
165 #define OP_HOLE (-3)
166 
168 #define OP_EREAD (-128)
169 
172 #define OP_EFAULT (-129)
173 
175 #define OP_EIMPL (-130)
176 
177 #define OP_EINVAL (-131)
178 
182 #define OP_ENOTFORMAT (-132)
183 
185 #define OP_EBADHEADER (-133)
186 
187 #define OP_EVERSION (-134)
188 /*Currently not used at all.*/
189 #define OP_ENOTAUDIO (-135)
190 
193 #define OP_EBADPACKET (-136)
194 
197 #define OP_EBADLINK (-137)
198 
199 #define OP_ENOSEEK (-138)
200 
201 #define OP_EBADTIMESTAMP (-139)
202 
205 
208 
210 #define OPUS_CHANNEL_COUNT_MAX (255)
211 
215 struct OpusHead{
225  int version;
230  unsigned pre_skip;
237  opus_uint32 input_sample_rate;
268 };
269 
300 struct OpusTags{
306  int comments;
309  char *vendor;
310 };
311 
314 
317 #define OP_PIC_FORMAT_UNKNOWN (-1)
318 
319 #define OP_PIC_FORMAT_URL (0)
320 
321 #define OP_PIC_FORMAT_JPEG (1)
322 
323 #define OP_PIC_FORMAT_PNG (2)
324 
325 #define OP_PIC_FORMAT_GIF (3)
326 
357  opus_int32 type;
364  char *mime_type;
366  char *description;
368  opus_uint32 width;
370  opus_uint32 height;
373  opus_uint32 depth;
376  opus_uint32 colors;
378  opus_uint32 data_length;
380  unsigned char *data;
390  int format;
391 };
392 
401 
427 OP_WARN_UNUSED_RESULT int opus_head_parse(OpusHead *_head,
428  const unsigned char *_data,size_t _len) OP_ARG_NONNULL(2);
429 
444 ogg_int64_t opus_granule_sample(const OpusHead *_head,ogg_int64_t _gp)
445  OP_ARG_NONNULL(1);
446 
461 OP_WARN_UNUSED_RESULT int opus_tags_parse(OpusTags *_tags,
462  const unsigned char *_data,size_t _len) OP_ARG_NONNULL(2);
463 
471 int opus_tags_copy(OpusTags *_dst,const OpusTags *_src) OP_ARG_NONNULL(1);
472 
477 void opus_tags_init(OpusTags *_tags) OP_ARG_NONNULL(1);
478 
490 int opus_tags_add(OpusTags *_tags,const char *_tag,const char *_value)
491  OP_ARG_NONNULL(1) OP_ARG_NONNULL(2) OP_ARG_NONNULL(3);
492 
503 int opus_tags_add_comment(OpusTags *_tags,const char *_comment)
504  OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
505 
521 const char *opus_tags_query(const OpusTags *_tags,const char *_tag,int _count)
522  OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
523 
531 int opus_tags_query_count(const OpusTags *_tags,const char *_tag)
532  OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
533 
549 int opus_tags_get_track_gain(const OpusTags *_tags,int *_gain_q8)
550  OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
551 
557 void opus_tags_clear(OpusTags *_tags) OP_ARG_NONNULL(1);
558 
568 int opus_tagcompare(const char *_tag_name,const char *_comment);
569 
583 int opus_tagncompare(const char *_tag_name,int _tag_len,const char *_comment);
584 
615 OP_WARN_UNUSED_RESULT int opus_picture_tag_parse(OpusPictureTag *_pic,
616  const char *_tag) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
617 
622 void opus_picture_tag_init(OpusPictureTag *_pic) OP_ARG_NONNULL(1);
623 
629 void opus_picture_tag_clear(OpusPictureTag *_pic) OP_ARG_NONNULL(1);
630 
634 
646 
649 /*These are the raw numbers used to define the request codes.
650  They should not be used directly.*/
651 #define OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST (6464)
652 #define OP_HTTP_PROXY_HOST_REQUEST (6528)
653 #define OP_HTTP_PROXY_PORT_REQUEST (6592)
654 #define OP_HTTP_PROXY_USER_REQUEST (6656)
655 #define OP_HTTP_PROXY_PASS_REQUEST (6720)
656 #define OP_GET_SERVER_INFO_REQUEST (6784)
657 
658 #define OP_URL_OPT(_request) ((_request)+(char *)0)
659 
660 /*These macros trigger compilation errors or warnings if the wrong types are
661  provided to one of the URL options.*/
662 #define OP_CHECK_INT(_x) ((void)((_x)==(opus_int32)0),(opus_int32)(_x))
663 #define OP_CHECK_CONST_CHAR_PTR(_x) ((_x)+((_x)-(const char *)(_x)))
664 #define OP_CHECK_SERVER_INFO_PTR(_x) ((_x)+((_x)-(OpusServerInfo *)(_x)))
665 
673  char *name;
677  char *description;
681  char *genre;
685  char *url;
688  char *server;
696  opus_int32 bitrate_kbps;
706  int is_ssl;
707 };
708 
713 void opus_server_info_init(OpusServerInfo *_info) OP_ARG_NONNULL(1);
714 
721 void opus_server_info_clear(OpusServerInfo *_info) OP_ARG_NONNULL(1);
722 
729 #define OP_SSL_SKIP_CERTIFICATE_CHECK(_b) \
730  OP_URL_OPT(OP_SSL_SKIP_CERTIFICATE_CHECK_REQUEST),OP_CHECK_INT(_b)
731 
740 #define OP_HTTP_PROXY_HOST(_host) \
741  OP_URL_OPT(OP_HTTP_PROXY_HOST_REQUEST),OP_CHECK_CONST_CHAR_PTR(_host)
742 
753 #define OP_HTTP_PROXY_PORT(_port) \
754  OP_URL_OPT(OP_HTTP_PROXY_PORT_REQUEST),OP_CHECK_INT(_port)
755 
766 #define OP_HTTP_PROXY_USER(_user) \
767  OP_URL_OPT(OP_HTTP_PROXY_USER_REQUEST),OP_CHECK_CONST_CHAR_PTR(_user)
768 
779 #define OP_HTTP_PROXY_PASS(_pass) \
780  OP_URL_OPT(OP_HTTP_PROXY_PASS_REQUEST),OP_CHECK_CONST_CHAR_PTR(_pass)
781 
800 #define OP_GET_SERVER_INFO(_info) \
801  OP_URL_OPT(OP_GET_SERVER_INFO_REQUEST),OP_CHECK_SERVER_INFO_PTR(_info)
802 
805 
817 
826 typedef int (*op_read_func)(void *_stream,unsigned char *_ptr,int _nbytes);
827 
837 typedef int (*op_seek_func)(void *_stream,opus_int64 _offset,int _whence);
838 
841 typedef opus_int64 (*op_tell_func)(void *_stream);
842 
847 typedef int (*op_close_func)(void *_stream);
848 
871 };
872 
890 OP_WARN_UNUSED_RESULT void *op_fopen(OpusFileCallbacks *_cb,
891  const char *_path,const char *_mode) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
892  OP_ARG_NONNULL(3);
893 
907 OP_WARN_UNUSED_RESULT void *op_fdopen(OpusFileCallbacks *_cb,
908  int _fd,const char *_mode) OP_ARG_NONNULL(1) OP_ARG_NONNULL(3);
909 
929 OP_WARN_UNUSED_RESULT void *op_freopen(OpusFileCallbacks *_cb,
930  const char *_path,const char *_mode,void *_stream) OP_ARG_NONNULL(1)
931  OP_ARG_NONNULL(2) OP_ARG_NONNULL(3) OP_ARG_NONNULL(4);
932 
943 OP_WARN_UNUSED_RESULT void *op_mem_stream_create(OpusFileCallbacks *_cb,
944  const unsigned char *_data,size_t _size) OP_ARG_NONNULL(1);
945 
969 OP_WARN_UNUSED_RESULT void *op_url_stream_vcreate(OpusFileCallbacks *_cb,
970  const char *_url,va_list _ap) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
971 
991 OP_WARN_UNUSED_RESULT void *op_url_stream_create(OpusFileCallbacks *_cb,
992  const char *_url,...) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2);
993 
996 
1006 
1037 int op_test(OpusHead *_head,
1038  const unsigned char *_initial_data,size_t _initial_bytes);
1039 
1049 OP_WARN_UNUSED_RESULT OggOpusFile *op_open_file(const char *_path,int *_error)
1050  OP_ARG_NONNULL(1);
1051 
1060 OP_WARN_UNUSED_RESULT OggOpusFile *op_open_memory(const unsigned char *_data,
1061  size_t _size,int *_error);
1062 
1089 OP_WARN_UNUSED_RESULT OggOpusFile *op_vopen_url(const char *_url,
1090  int *_error,va_list _ap) OP_ARG_NONNULL(1);
1091 
1111 OP_WARN_UNUSED_RESULT OggOpusFile *op_open_url(const char *_url,
1112  int *_error,...) OP_ARG_NONNULL(1);
1113 
1191 OP_WARN_UNUSED_RESULT OggOpusFile *op_open_callbacks(void *_source,
1192  const OpusFileCallbacks *_cb,const unsigned char *_initial_data,
1193  size_t _initial_bytes,int *_error) OP_ARG_NONNULL(2);
1194 
1205 OP_WARN_UNUSED_RESULT OggOpusFile *op_test_file(const char *_path,int *_error)
1206  OP_ARG_NONNULL(1);
1207 
1217 OP_WARN_UNUSED_RESULT OggOpusFile *op_test_memory(const unsigned char *_data,
1218  size_t _size,int *_error);
1219 
1248 OP_WARN_UNUSED_RESULT OggOpusFile *op_vtest_url(const char *_url,
1249  int *_error,va_list _ap) OP_ARG_NONNULL(1);
1250 
1272 OP_WARN_UNUSED_RESULT OggOpusFile *op_test_url(const char *_url,
1273  int *_error,...) OP_ARG_NONNULL(1);
1274 
1338 OP_WARN_UNUSED_RESULT OggOpusFile *op_test_callbacks(void *_source,
1339  const OpusFileCallbacks *_cb,const unsigned char *_initial_data,
1340  size_t _initial_bytes,int *_error) OP_ARG_NONNULL(2);
1341 
1368 int op_test_open(OggOpusFile *_of) OP_ARG_NONNULL(1);
1369 
1372 void op_free(OggOpusFile *_of);
1373 
1376 
1394 
1409 int op_seekable(const OggOpusFile *_of) OP_ARG_NONNULL(1);
1410 
1419 int op_link_count(const OggOpusFile *_of) OP_ARG_NONNULL(1);
1420 
1434 opus_uint32 op_serialno(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1435 
1451 int op_channel_count(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1452 
1469 opus_int64 op_raw_total(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1470 
1487 ogg_int64_t op_pcm_total(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1488 
1503 const OpusHead *op_head(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1504 
1521 const OpusTags *op_tags(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1522 
1538 int op_current_link(const OggOpusFile *_of) OP_ARG_NONNULL(1);
1539 
1551 opus_int32 op_bitrate(const OggOpusFile *_of,int _li) OP_ARG_NONNULL(1);
1552 
1564 opus_int32 op_bitrate_instant(OggOpusFile *_of) OP_ARG_NONNULL(1);
1565 
1570 opus_int64 op_raw_tell(const OggOpusFile *_of) OP_ARG_NONNULL(1);
1571 
1579 ogg_int64_t op_pcm_tell(const OggOpusFile *_of) OP_ARG_NONNULL(1);
1580 
1583 
1611 
1625 int op_raw_seek(OggOpusFile *_of,opus_int64 _byte_offset) OP_ARG_NONNULL(1);
1626 
1641 int op_pcm_seek(OggOpusFile *_of,ogg_int64_t _pcm_offset) OP_ARG_NONNULL(1);
1642 
1645 
1686 
1689 #define OP_DEC_FORMAT_SHORT (7008)
1690 
1692 #define OP_DEC_FORMAT_FLOAT (7040)
1693 
1696 #define OP_DEC_USE_DEFAULT (6720)
1697 
1728 typedef int (*op_decode_cb_func)(void *_ctx,OpusMSDecoder *_decoder,void *_pcm,
1729  const ogg_packet *_op,int _nsamples,int _nchannels,int _format,int _li);
1730 
1744 void op_set_decode_callback(OggOpusFile *_of,
1745  op_decode_cb_func _decode_cb,void *_ctx) OP_ARG_NONNULL(1);
1746 
1750 #define OP_HEADER_GAIN (0)
1751 
1754 #define OP_TRACK_GAIN (3008)
1755 
1758 #define OP_ABSOLUTE_GAIN (3009)
1759 
1777 int op_set_gain_offset(OggOpusFile *_of,
1778  int _gain_type,opus_int32 _gain_offset_q8) OP_ARG_NONNULL(1);
1779 
1790 void op_set_dither_enabled(OggOpusFile *_of,int _enabled) OP_ARG_NONNULL(1);
1791 
1872 OP_WARN_UNUSED_RESULT int op_read(OggOpusFile *_of,
1873  opus_int16 *_pcm,int _buf_size,int *_li) OP_ARG_NONNULL(1);
1874 
1953 OP_WARN_UNUSED_RESULT int op_read_float(OggOpusFile *_of,
1954  float *_pcm,int _buf_size,int *_li) OP_ARG_NONNULL(1);
1955 
2014 OP_WARN_UNUSED_RESULT int op_read_stereo(OggOpusFile *_of,
2015  opus_int16 *_pcm,int _buf_size) OP_ARG_NONNULL(1);
2016 
2075 OP_WARN_UNUSED_RESULT int op_read_float_stereo(OggOpusFile *_of,
2076  float *_pcm,int _buf_size) OP_ARG_NONNULL(1);
2077 
2080 
2081 # if OP_GNUC_PREREQ(4,0)
2082 # pragma GCC visibility pop
2083 # endif
2084 
2085 # if defined(__cplusplus)
2086 }
2087 # endif
2088 
2089 #endif
#define OPUS_CHANNEL_COUNT_MAX
The maximum number of channels in an Ogg Opus stream.
Definition: opusfile.h:210
char ** user_comments
The array of comment string vectors.
Definition: opusfile.h:302
int(* op_close_func)(void *_stream)
Closes the underlying stream.
Definition: opusfile.h:847
int op_test(OpusHead *_head, const unsigned char *_initial_data, size_t _initial_bytes)
Test to see if this is an Opus stream.
int coupled_count
The number of coupled Opus streams in each Ogg packet, in the range 0...127.
Definition: opusfile.h:259
op_tell_func tell
Used to return the current read position in the stream.
Definition: opusfile.h:867
ogg_int64_t op_pcm_tell(const OggOpusFile *_of) OP_ARG_NONNULL(1)
Obtain the PCM offset of the next sample to be read.
opus_int32 bitrate_kbps
The nominal stream bitrate in kbps (icy-br/ice-bitrate).
Definition: opusfile.h:696
char * genre
The genre the server falls under (icy-genre/ice-genre).
Definition: opusfile.h:681
int opus_tags_copy(OpusTags *_dst, const OpusTags *_src) OP_ARG_NONNULL(1)
Performs a deep copy of an OpusTags structure.
int opus_tags_add_comment(OpusTags *_tags, const char *_comment) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Add a comment to an initialized OpusTags structure.
opus_int32 type
The picture type according to the ID3v2 APIC frame:
Definition: opusfile.h:357
int op_channel_count(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the channel count of the given link in a (possibly-chained) Ogg Opus stream.
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)
Open a stream using the given set of callbacks to access it.
OP_WARN_UNUSED_RESULT int opus_picture_tag_parse(OpusPictureTag *_pic, const char *_tag) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Parse a single METADATA_BLOCK_PICTURE tag.
int comments
The total number of comment streams.
Definition: opusfile.h:306
OP_WARN_UNUSED_RESULT int op_read_stereo(OggOpusFile *_of, opus_int16 *_pcm, int _buf_size) OP_ARG_NONNULL(1)
Reads more samples from the stream and downmixes to stereo, if necessary.
OP_WARN_UNUSED_RESULT OggOpusFile * op_vopen_url(const char *_url, int *_error, va_list _ap) OP_ARG_NONNULL(1)
Open a stream from a URL.
char * vendor
The null-terminated vendor string.
Definition: opusfile.h:309
int opus_tags_get_track_gain(const OpusTags *_tags, int *_gain_q8) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Get the track gain from an R128_TRACK_GAIN tag, if one was specified.
void op_free(OggOpusFile *_of)
Release all memory used by an OggOpusFile.
OP_WARN_UNUSED_RESULT OggOpusFile * op_test_memory(const unsigned char *_data, size_t _size, int *_error)
Partially open a stream from a memory buffer.
HTTP/Shoutcast/Icecast server information associated with a URL.
Definition: opusfile.h:669
int version
The Ogg Opus format version, in the range 0...255.
Definition: opusfile.h:225
int mapping_family
The channel mapping family, in the range 0...255.
Definition: opusfile.h:250
const OpusHead * op_head(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the ID header information for the given link in a (possibly chained) Ogg Opus stream...
int op_current_link(const OggOpusFile *_of) OP_ARG_NONNULL(1)
Retrieve the index of the current link.
The metadata from an Ogg Opus stream.
Definition: opusfile.h:300
int op_test_open(OggOpusFile *_of) OP_ARG_NONNULL(1)
Finish opening a stream partially opened with op_test_callbacks() or one of the associated convenienc...
int(* op_decode_cb_func)(void *_ctx, OpusMSDecoder *_decoder, void *_pcm, const ogg_packet *_op, int _nsamples, int _nchannels, int _format, int _li)
Called to decode an Opus packet.
Definition: opusfile.h:1728
unsigned char mapping[OPUS_CHANNEL_COUNT_MAX]
The mapping from coded stream channels to output channels.
Definition: opusfile.h:267
OP_WARN_UNUSED_RESULT int op_read_float_stereo(OggOpusFile *_of, float *_pcm, int _buf_size) OP_ARG_NONNULL(1)
Reads more samples from the stream and downmixes to stereo, if necessary.
int opus_tags_query_count(const OpusTags *_tags, const char *_tag) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Look up the number of instances of a tag.
void opus_picture_tag_init(OpusPictureTag *_pic) OP_ARG_NONNULL(1)
Initializes an OpusPictureTag structure.
OP_WARN_UNUSED_RESULT OggOpusFile * op_open_memory(const unsigned char *_data, size_t _size, int *_error)
Open a stream from a memory buffer.
opus_uint32 depth
The color depth of the picture in bits-per-pixel (not bits-per-channel).
Definition: opusfile.h:373
char * url
The homepage for the server (icy-url/ice-url).
Definition: opusfile.h:685
opus_int64 op_raw_total(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the total (compressed) size of the stream, or of an individual link in a (possibly-chained) Ogg O...
opus_uint32 op_serialno(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the serial number of the given link in a (possibly-chained) Ogg Opus stream.
int opus_tagcompare(const char *_tag_name, const char *_comment)
Check if _comment is an instance of a _tag_name tag.
Ogg Opus bitstream information.
Definition: opusfile.h:215
int output_gain
The gain to apply to the decoded output, in dB, as a Q8 value in the range -32768...32767.
Definition: opusfile.h:243
opus_int32 op_bitrate_instant(OggOpusFile *_of) OP_ARG_NONNULL(1)
Compute the instantaneous bitrate, measured as the ratio of bits to playable samples decoded since a)...
int format
The format of the picture data, if known.
Definition: opusfile.h:390
opus_int64(* op_tell_func)(void *_stream)
Obtains the current value of the position indicator for _stream.
Definition: opusfile.h:841
const OpusTags * op_tags(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the comment header information for the given link in a (possibly chained) Ogg Opus stream...
int is_public
Flag indicating whether the server is public (1) or not (0) (icy-pub/ice-public). ...
Definition: opusfile.h:701
void opus_tags_clear(OpusTags *_tags) OP_ARG_NONNULL(1)
Clears the OpusTags structure.
opus_uint32 input_sample_rate
The sampling rate of the original input.
Definition: opusfile.h:237
int(* op_seek_func)(void *_stream, opus_int64 _offset, int _whence)
Sets the position indicator for _stream.
Definition: opusfile.h:837
ogg_int64_t op_pcm_total(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Get the total PCM length (number of samples at 48 kHz) of the stream, or of an individual link in a (...
void opus_picture_tag_clear(OpusPictureTag *_pic) OP_ARG_NONNULL(1)
Clears the OpusPictureTag structure.
opus_uint32 height
The height of the picture in pixels.
Definition: opusfile.h:370
char * server
The software used by the origin server (Server).
Definition: opusfile.h:688
opus_uint32 data_length
The length of the picture data in bytes.
Definition: opusfile.h:378
opus_uint32 colors
For indexed-color pictures (e.g., GIF), the number of colors used, or 0 for non-indexed pictures...
Definition: opusfile.h:376
void opus_server_info_clear(OpusServerInfo *_info) OP_ARG_NONNULL(1)
Clears the OpusServerInfo structure.
opus_int64 op_raw_tell(const OggOpusFile *_of) OP_ARG_NONNULL(1)
Obtain the current value of the position indicator for _of.
OP_WARN_UNUSED_RESULT void * op_url_stream_create(OpusFileCallbacks *_cb, const char *_url,...) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Creates a stream that reads from the given URL.
opus_uint32 width
The width of the picture in pixels.
Definition: opusfile.h:368
OP_WARN_UNUSED_RESULT void * op_fdopen(OpusFileCallbacks *_cb, int _fd, const char *_mode) OP_ARG_NONNULL(1) OP_ARG_NONNULL(3)
Opens a stream with fdopen() and fills in a set of callbacks that can be used to access it...
void opus_server_info_init(OpusServerInfo *_info) OP_ARG_NONNULL(1)
Initializes an OpusServerInfo structure.
The contents of a METADATA_BLOCK_PICTURE tag.
Definition: opusfile.h:330
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)
Opens a stream with fopen() and fills in a set of callbacks that can be used to access it...
int op_set_gain_offset(OggOpusFile *_of, int _gain_type, opus_int32 _gain_offset_q8) OP_ARG_NONNULL(1)
Sets the gain to be used for decoded output.
The callbacks used to access non-FILE stream resources.
Definition: opusfile.h:858
const char * opus_tags_query(const OpusTags *_tags, const char *_tag, int _count) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2)
Look up a comment value by its tag.
char * mime_type
The MIME type of the picture, in printable ASCII characters 0x20-0x7E.
Definition: opusfile.h:364
OP_WARN_UNUSED_RESULT OggOpusFile * op_test_url(const char *_url, int *_error,...) OP_ARG_NONNULL(1)
Partially open a stream from a URL.
int op_seekable(const OggOpusFile *_of) OP_ARG_NONNULL(1)
Returns whether or not the data source being read is seekable.
char * description
The description of the picture, in UTF-8.
Definition: opusfile.h:366
OP_WARN_UNUSED_RESULT OggOpusFile * op_open_file(const char *_path, int *_error) OP_ARG_NONNULL(1)
Open a stream from the given file path.
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)
Opens a stream with freopen() and fills in a set of callbacks that can be used to access it...
int opus_tags_add(OpusTags *_tags, const char *_tag, const char *_value) OP_ARG_NONNULL(1) OP_ARG_NONNULL(2) OP_ARG_NONNULL(3)
Add a (tag, value) pair to an initialized OpusTags structure.
int op_raw_seek(OggOpusFile *_of, opus_int64 _byte_offset) OP_ARG_NONNULL(1)
Seek to a byte offset relative to the compressed data.
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)
Creates a stream that reads from the given URL.
void op_set_decode_callback(OggOpusFile *_of, op_decode_cb_func _decode_cb, void *_ctx) OP_ARG_NONNULL(1)
Sets the packet decode callback function.
op_read_func read
Used to read data from the stream.
Definition: opusfile.h:861
void op_set_dither_enabled(OggOpusFile *_of, int _enabled) OP_ARG_NONNULL(1)
Sets whether or not dithering is enabled for 16-bit decoding.
ogg_int64_t opus_granule_sample(const OpusHead *_head, ogg_int64_t _gp) OP_ARG_NONNULL(1)
Converts a granule position to a sample offset for a given Ogg Opus stream.
OP_WARN_UNUSED_RESULT OggOpusFile * op_test_file(const char *_path, int *_error) OP_ARG_NONNULL(1)
Partially open a stream from the given file path.
int op_pcm_seek(OggOpusFile *_of, ogg_int64_t _pcm_offset) OP_ARG_NONNULL(1)
Seek to the specified PCM offset, such that decoding will begin at exactly the requested position...
op_close_func close
Used to close the stream when the decoder is freed.
Definition: opusfile.h:870
op_seek_func seek
Used to seek in the stream.
Definition: opusfile.h:864
OP_WARN_UNUSED_RESULT int opus_head_parse(OpusHead *_head, const unsigned char *_data, size_t _len) OP_ARG_NONNULL(2)
Parses the contents of the ID header packet of an Ogg Opus stream.
char * content_type
The media type of the entity sent to the recepient (Content-Type).
Definition: opusfile.h:692
OP_WARN_UNUSED_RESULT void * op_mem_stream_create(OpusFileCallbacks *_cb, const unsigned char *_data, size_t _size) OP_ARG_NONNULL(1)
Creates a stream that reads from the given block of memory.
unsigned char * data
The binary picture data.
Definition: opusfile.h:380
opus_int32 op_bitrate(const OggOpusFile *_of, int _li) OP_ARG_NONNULL(1)
Computes the bitrate for a given link in a (possibly chained) Ogg Opus stream.
int stream_count
The number of Opus streams in each Ogg packet, in the range 1...255.
Definition: opusfile.h:252
OP_WARN_UNUSED_RESULT int op_read_float(OggOpusFile *_of, float *_pcm, int _buf_size, int *_li) OP_ARG_NONNULL(1)
Reads more samples from the stream.
int is_ssl
Flag indicating whether the server is using HTTPS instead of HTTP.
Definition: opusfile.h:706
int(* op_read_func)(void *_stream, unsigned char *_ptr, int _nbytes)
Reads up to _nbytes bytes of data from _stream.
Definition: opusfile.h:826
char * name
The name of the server (icy-name/ice-name).
Definition: opusfile.h:673
OP_WARN_UNUSED_RESULT int op_read(OggOpusFile *_of, opus_int16 *_pcm, int _buf_size, int *_li) OP_ARG_NONNULL(1)
Reads more samples from the stream.
int opus_tagncompare(const char *_tag_name, int _tag_len, const char *_comment)
Check if _comment is an instance of a _tag_name tag.
int channel_count
The number of channels, in the range 1...255.
Definition: opusfile.h:227
void opus_tags_init(OpusTags *_tags) OP_ARG_NONNULL(1)
Initializes an OpusTags structure.
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)
Partially open a stream using the given set of callbacks to access it.
OP_WARN_UNUSED_RESULT OggOpusFile * op_vtest_url(const char *_url, int *_error, va_list _ap) OP_ARG_NONNULL(1)
Partially open a stream from a URL.
OP_WARN_UNUSED_RESULT OggOpusFile * op_open_url(const char *_url, int *_error,...) OP_ARG_NONNULL(1)
Open a stream from a URL.
char * description
A short description of the server (icy-description/ice-description).
Definition: opusfile.h:677
int * comment_lengths
An array of the corresponding length of each vector, in bytes.
Definition: opusfile.h:304
int op_link_count(const OggOpusFile *_of) OP_ARG_NONNULL(1)
Returns the number of links in this chained stream.
OP_WARN_UNUSED_RESULT int opus_tags_parse(OpusTags *_tags, const unsigned char *_data, size_t _len) OP_ARG_NONNULL(2)
Parses the contents of the 'comment' header packet of an Ogg Opus stream.
unsigned pre_skip
The number of samples that should be discarded from the beginning of the stream.
Definition: opusfile.h:230