conrad committed Sep 11, 2004 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 /* Copyright (C) 2003 Commonwealth Scientific and Industrial Research Organisation (CSIRO) Australia Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - Neither the name of CSIRO Australia nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __OGGZ_READ_H__ #define __OGGZ_READ_H__ conrad committed Feb 03, 2005 36 37 38 39 /** \file * Interfaces for reading Ogg files and streams */ conrad committed Sep 11, 2004 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 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 94 95 96 97 98 99 /** \defgroup read_api OGGZ Read API * * OGGZ parses Ogg bitstreams, forming ogg_packet structures, and calling * your OggzReadPacket callback(s). * * You provide Ogg data to OGGZ with oggz_read() or oggz_read_input(), and * independently process it in OggzReadPacket callbacks. * It is possible to set a different callback per \a serialno (ie. for each * logical bitstream in the Ogg bitstream - see the \ref basics section for * more detail). * * See \ref seek_api for information on seeking on interleaved Ogg data. * * \{ */ /** * This is the signature of a callback which you must provide for Oggz * to call whenever it finds a new packet in the Ogg stream associated * with \a oggz. * * \param oggz The OGGZ handle * \param op The full ogg_packet (see ) * \param serialno Identify the logical bistream in \a oggz that contains * \a op * \param user_data A generic pointer you have provided earlier * \returns 0 to continue, non-zero to instruct OGGZ to stop. * * \note It is possible to provide different callbacks per logical * bitstream -- see oggz_set_read_callback() for more information. */ typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno, void * user_data); /** * Set a callback for Oggz to call when a new Ogg packet is found in the * stream. * * \param oggz An OGGZ handle previously opened for reading * \param serialno Identify the logical bitstream in \a oggz to attach * this callback to, or -1 to attach this callback to all unattached * logical bitstreams in \a oggz. * \param read_packet Your callback function * \param user_data Arbitrary data you wish to pass to your callback * \retval 0 Success * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing * logical bitstream in \a oggz. * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ * * \note Values of \a serialno other than -1 allows you to specify different * callback functions for each logical bitstream. * * \note It is safe to call this callback from within an OggzReadPacket * function, in order to specify that subsequent packets should be handled * by a different OggzReadPacket function. */ int oggz_set_read_callback (OGGZ * oggz, long serialno, OggzReadPacket read_packet, void * user_data); conrad committed Sep 12, 2004 100 101 102 103 104 105 106 107 108 109 110 /** * This is the signature of a callback which you must provide for Oggz * to call whenever it finds a new page in the Ogg stream associated * with \a oggz. * * \param oggz The OGGZ handle * \param op The full ogg_page (see ) * \param user_data A generic pointer you have provided earlier * \returns 0 to continue, non-zero to instruct OGGZ to stop. */ typedef int (*OggzReadPage) (OGGZ * oggz, const ogg_page * og, conrad committed Sep 20, 2004 111 long serialno, void * user_data); conrad committed Sep 12, 2004 112 113 114 115 116 117 /** * Set a callback for Oggz to call when a new Ogg page is found in the * stream. * * \param oggz An OGGZ handle previously opened for reading conrad committed Sep 20, 2004 118 119 120 * \param serialno Identify the logical bitstream in \a oggz to attach * this callback to, or -1 to attach this callback to all unattached * logical bitstreams in \a oggz. conrad committed Sep 12, 2004 121 122 123 124 125 126 * \param read_page Your OggzReadPage callback function * \param user_data Arbitrary data you wish to pass to your callback * \retval 0 Success * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ * conrad committed Sep 20, 2004 127 128 129 * \note Values of \a serialno other than -1 allows you to specify different * callback functions for each logical bitstream. * conrad committed Sep 12, 2004 130 131 132 133 * \note It is safe to call this callback from within an OggzReadPage * function, in order to specify that subsequent pages should be handled * by a different OggzReadPage function. */ conrad committed Sep 20, 2004 134 135 int oggz_set_read_page (OGGZ * oggz, long serialno, OggzReadPage read_page, void * user_data); conrad committed Sep 12, 2004 136 137 conrad committed Sep 11, 2004 138 139 140 141 142 143 144 145 146 /** * Read n bytes into \a oggz, calling any read callbacks on the fly. * \param oggz An OGGZ handle previously opened for reading * \param n A count of bytes to ingest * \retval "> 0" The number of bytes successfully ingested. * \retval 0 End of file * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ * \retval OGGZ_ERR_SYSTEM System error; check errno for details conrad committed Feb 11, 2006 147 148 149 150 * \retval OGGZ_ERR_STOP_OK Reading was stopped by a user callback * returning OGGZ_STOP_OK * \retval OGGZ_ERR_STOP_ERR Reading was stopped by a user callback * returning OGGZ_STOP_ERR conrad committed Sep 11, 2004 151 152 153 154 155 156 157 158 159 160 161 */ long oggz_read (OGGZ * oggz, long n); /** * Input data into \a oggz. * \param oggz An OGGZ handle previously opened for reading * \param buf A memory buffer * \param n A count of bytes to input * \retval "> 0" The number of bytes successfully ingested. * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ conrad committed Feb 11, 2006 162 163 164 165 * \retval OGGZ_ERR_STOP_OK Reading was stopped by a user callback * returning OGGZ_STOP_OK * \retval OGGZ_ERR_STOP_ERR Reading was stopped by a user callback * returning OGGZ_STOP_ERR conrad committed Sep 11, 2004 166 167 168 169 170 171 */ long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n); /** \} */ conrad committed Sep 11, 2004 172 173 174 175 176 177 178 179 180 181 182 183 /** * Erase any input buffered in OGGZ. This discards any input read from the * underlying IO system but not yet delivered as ogg_packets. * * \param oggz An OGGZ handle * \retval 0 Success * \retval OGGZ_ERR_SYSTEM Error seeking on underlying IO. * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ */ int oggz_purge (OGGZ * oggz); conrad committed Sep 11, 2004 184 #endif /* __OGGZ_READ_H__ */