annotate win64-mingw/include/ogg/ogg.h @ 42:2cd0e3b3e1fd

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