annotate win32-mingw/include/ogg/ogg.h @ 23:619f715526df sv_v2.1

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