dbf-halloween2015

annotate libs/ogg/ogg.h @ 1:c3f5c32cb210

find changesets by author, revision, files, or words in the commit message
barfed all the libraries in the source tree to make porting easier
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 01 Nov 2015 00:36:56 +0200
parents
children
rev   line source
nuclear@1 1 /********************************************************************
nuclear@1 2 * *
nuclear@1 3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
nuclear@1 4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
nuclear@1 5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
nuclear@1 6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
nuclear@1 7 * *
nuclear@1 8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
nuclear@1 9 * by the Xiph.Org Foundation http://www.xiph.org/ *
nuclear@1 10 * *
nuclear@1 11 ********************************************************************
nuclear@1 12
nuclear@1 13 function: toplevel libogg include
nuclear@1 14 last mod: $Id: ogg.h 18044 2011-08-01 17:55:20Z gmaxwell $
nuclear@1 15
nuclear@1 16 ********************************************************************/
nuclear@1 17 #ifndef _OGG_H
nuclear@1 18 #define _OGG_H
nuclear@1 19
nuclear@1 20 #ifdef __cplusplus
nuclear@1 21 extern "C" {
nuclear@1 22 #endif
nuclear@1 23
nuclear@1 24 #include <stddef.h>
nuclear@1 25 #include <ogg/os_types.h>
nuclear@1 26
nuclear@1 27 typedef struct {
nuclear@1 28 void *iov_base;
nuclear@1 29 size_t iov_len;
nuclear@1 30 } ogg_iovec_t;
nuclear@1 31
nuclear@1 32 typedef struct {
nuclear@1 33 long endbyte;
nuclear@1 34 int endbit;
nuclear@1 35
nuclear@1 36 unsigned char *buffer;
nuclear@1 37 unsigned char *ptr;
nuclear@1 38 long storage;
nuclear@1 39 } oggpack_buffer;
nuclear@1 40
nuclear@1 41 /* ogg_page is used to encapsulate the data in one Ogg bitstream page *****/
nuclear@1 42
nuclear@1 43 typedef struct {
nuclear@1 44 unsigned char *header;
nuclear@1 45 long header_len;
nuclear@1 46 unsigned char *body;
nuclear@1 47 long body_len;
nuclear@1 48 } ogg_page;
nuclear@1 49
nuclear@1 50 /* ogg_stream_state contains the current encode/decode state of a logical
nuclear@1 51 Ogg bitstream **********************************************************/
nuclear@1 52
nuclear@1 53 typedef struct {
nuclear@1 54 unsigned char *body_data; /* bytes from packet bodies */
nuclear@1 55 long body_storage; /* storage elements allocated */
nuclear@1 56 long body_fill; /* elements stored; fill mark */
nuclear@1 57 long body_returned; /* elements of fill returned */
nuclear@1 58
nuclear@1 59
nuclear@1 60 int *lacing_vals; /* The values that will go to the segment table */
nuclear@1 61 ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact
nuclear@1 62 this way, but it is simple coupled to the
nuclear@1 63 lacing fifo */
nuclear@1 64 long lacing_storage;
nuclear@1 65 long lacing_fill;
nuclear@1 66 long lacing_packet;
nuclear@1 67 long lacing_returned;
nuclear@1 68
nuclear@1 69 unsigned char header[282]; /* working space for header encode */
nuclear@1 70 int header_fill;
nuclear@1 71
nuclear@1 72 int e_o_s; /* set when we have buffered the last packet in the
nuclear@1 73 logical bitstream */
nuclear@1 74 int b_o_s; /* set after we've written the initial page
nuclear@1 75 of a logical bitstream */
nuclear@1 76 long serialno;
nuclear@1 77 long pageno;
nuclear@1 78 ogg_int64_t packetno; /* sequence number for decode; the framing
nuclear@1 79 knows where there's a hole in the data,
nuclear@1 80 but we need coupling so that the codec
nuclear@1 81 (which is in a separate abstraction
nuclear@1 82 layer) also knows about the gap */
nuclear@1 83 ogg_int64_t granulepos;
nuclear@1 84
nuclear@1 85 } ogg_stream_state;
nuclear@1 86
nuclear@1 87 /* ogg_packet is used to encapsulate the data and metadata belonging
nuclear@1 88 to a single raw Ogg/Vorbis packet *************************************/
nuclear@1 89
nuclear@1 90 typedef struct {
nuclear@1 91 unsigned char *packet;
nuclear@1 92 long bytes;
nuclear@1 93 long b_o_s;
nuclear@1 94 long e_o_s;
nuclear@1 95
nuclear@1 96 ogg_int64_t granulepos;
nuclear@1 97
nuclear@1 98 ogg_int64_t packetno; /* sequence number for decode; the framing
nuclear@1 99 knows where there's a hole in the data,
nuclear@1 100 but we need coupling so that the codec
nuclear@1 101 (which is in a separate abstraction
nuclear@1 102 layer) also knows about the gap */
nuclear@1 103 } ogg_packet;
nuclear@1 104
nuclear@1 105 typedef struct {
nuclear@1 106 unsigned char *data;
nuclear@1 107 int storage;
nuclear@1 108 int fill;
nuclear@1 109 int returned;
nuclear@1 110
nuclear@1 111 int unsynced;
nuclear@1 112 int headerbytes;
nuclear@1 113 int bodybytes;
nuclear@1 114 } ogg_sync_state;
nuclear@1 115
nuclear@1 116 /* Ogg BITSTREAM PRIMITIVES: bitstream ************************/
nuclear@1 117
nuclear@1 118 extern void oggpack_writeinit(oggpack_buffer *b);
nuclear@1 119 extern int oggpack_writecheck(oggpack_buffer *b);
nuclear@1 120 extern void oggpack_writetrunc(oggpack_buffer *b,long bits);
nuclear@1 121 extern void oggpack_writealign(oggpack_buffer *b);
nuclear@1 122 extern void oggpack_writecopy(oggpack_buffer *b,void *source,long bits);
nuclear@1 123 extern void oggpack_reset(oggpack_buffer *b);
nuclear@1 124 extern void oggpack_writeclear(oggpack_buffer *b);
nuclear@1 125 extern void oggpack_readinit(oggpack_buffer *b,unsigned char *buf,int bytes);
nuclear@1 126 extern void oggpack_write(oggpack_buffer *b,unsigned long value,int bits);
nuclear@1 127 extern long oggpack_look(oggpack_buffer *b,int bits);
nuclear@1 128 extern long oggpack_look1(oggpack_buffer *b);
nuclear@1 129 extern void oggpack_adv(oggpack_buffer *b,int bits);
nuclear@1 130 extern void oggpack_adv1(oggpack_buffer *b);
nuclear@1 131 extern long oggpack_read(oggpack_buffer *b,int bits);
nuclear@1 132 extern long oggpack_read1(oggpack_buffer *b);
nuclear@1 133 extern long oggpack_bytes(oggpack_buffer *b);
nuclear@1 134 extern long oggpack_bits(oggpack_buffer *b);
nuclear@1 135 extern unsigned char *oggpack_get_buffer(oggpack_buffer *b);
nuclear@1 136
nuclear@1 137 extern void oggpackB_writeinit(oggpack_buffer *b);
nuclear@1 138 extern int oggpackB_writecheck(oggpack_buffer *b);
nuclear@1 139 extern void oggpackB_writetrunc(oggpack_buffer *b,long bits);
nuclear@1 140 extern void oggpackB_writealign(oggpack_buffer *b);
nuclear@1 141 extern void oggpackB_writecopy(oggpack_buffer *b,void *source,long bits);
nuclear@1 142 extern void oggpackB_reset(oggpack_buffer *b);
nuclear@1 143 extern void oggpackB_writeclear(oggpack_buffer *b);
nuclear@1 144 extern void oggpackB_readinit(oggpack_buffer *b,unsigned char *buf,int bytes);
nuclear@1 145 extern void oggpackB_write(oggpack_buffer *b,unsigned long value,int bits);
nuclear@1 146 extern long oggpackB_look(oggpack_buffer *b,int bits);
nuclear@1 147 extern long oggpackB_look1(oggpack_buffer *b);
nuclear@1 148 extern void oggpackB_adv(oggpack_buffer *b,int bits);
nuclear@1 149 extern void oggpackB_adv1(oggpack_buffer *b);
nuclear@1 150 extern long oggpackB_read(oggpack_buffer *b,int bits);
nuclear@1 151 extern long oggpackB_read1(oggpack_buffer *b);
nuclear@1 152 extern long oggpackB_bytes(oggpack_buffer *b);
nuclear@1 153 extern long oggpackB_bits(oggpack_buffer *b);
nuclear@1 154 extern unsigned char *oggpackB_get_buffer(oggpack_buffer *b);
nuclear@1 155
nuclear@1 156 /* Ogg BITSTREAM PRIMITIVES: encoding **************************/
nuclear@1 157
nuclear@1 158 extern int ogg_stream_packetin(ogg_stream_state *os, ogg_packet *op);
nuclear@1 159 extern int ogg_stream_iovecin(ogg_stream_state *os, ogg_iovec_t *iov,
nuclear@1 160 int count, long e_o_s, ogg_int64_t granulepos);
nuclear@1 161 extern int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
nuclear@1 162 extern int ogg_stream_pageout_fill(ogg_stream_state *os, ogg_page *og, int nfill);
nuclear@1 163 extern int ogg_stream_flush(ogg_stream_state *os, ogg_page *og);
nuclear@1 164 extern int ogg_stream_flush_fill(ogg_stream_state *os, ogg_page *og, int nfill);
nuclear@1 165
nuclear@1 166 /* Ogg BITSTREAM PRIMITIVES: decoding **************************/
nuclear@1 167
nuclear@1 168 extern int ogg_sync_init(ogg_sync_state *oy);
nuclear@1 169 extern int ogg_sync_clear(ogg_sync_state *oy);
nuclear@1 170 extern int ogg_sync_reset(ogg_sync_state *oy);
nuclear@1 171 extern int ogg_sync_destroy(ogg_sync_state *oy);
nuclear@1 172 extern int ogg_sync_check(ogg_sync_state *oy);
nuclear@1 173
nuclear@1 174 extern char *ogg_sync_buffer(ogg_sync_state *oy, long size);
nuclear@1 175 extern int ogg_sync_wrote(ogg_sync_state *oy, long bytes);
nuclear@1 176 extern long ogg_sync_pageseek(ogg_sync_state *oy,ogg_page *og);
nuclear@1 177 extern int ogg_sync_pageout(ogg_sync_state *oy, ogg_page *og);
nuclear@1 178 extern int ogg_stream_pagein(ogg_stream_state *os, ogg_page *og);
nuclear@1 179 extern int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
nuclear@1 180 extern int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
nuclear@1 181
nuclear@1 182 /* Ogg BITSTREAM PRIMITIVES: general ***************************/
nuclear@1 183
nuclear@1 184 extern int ogg_stream_init(ogg_stream_state *os,int serialno);
nuclear@1 185 extern int ogg_stream_clear(ogg_stream_state *os);
nuclear@1 186 extern int ogg_stream_reset(ogg_stream_state *os);
nuclear@1 187 extern int ogg_stream_reset_serialno(ogg_stream_state *os,int serialno);
nuclear@1 188 extern int ogg_stream_destroy(ogg_stream_state *os);
nuclear@1 189 extern int ogg_stream_check(ogg_stream_state *os);
nuclear@1 190 extern int ogg_stream_eos(ogg_stream_state *os);
nuclear@1 191
nuclear@1 192 extern void ogg_page_checksum_set(ogg_page *og);
nuclear@1 193
nuclear@1 194 extern int ogg_page_version(const ogg_page *og);
nuclear@1 195 extern int ogg_page_continued(const ogg_page *og);
nuclear@1 196 extern int ogg_page_bos(const ogg_page *og);
nuclear@1 197 extern int ogg_page_eos(const ogg_page *og);
nuclear@1 198 extern ogg_int64_t ogg_page_granulepos(const ogg_page *og);
nuclear@1 199 extern int ogg_page_serialno(const ogg_page *og);
nuclear@1 200 extern long ogg_page_pageno(const ogg_page *og);
nuclear@1 201 extern int ogg_page_packets(const ogg_page *og);
nuclear@1 202
nuclear@1 203 extern void ogg_packet_clear(ogg_packet *op);
nuclear@1 204
nuclear@1 205
nuclear@1 206 #ifdef __cplusplus
nuclear@1 207 }
nuclear@1 208 #endif
nuclear@1 209
nuclear@1 210 #endif /* _OGG_H */