AuroraMiddleware/ogg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve ogg_stream_state documentation formatting.

Browse Source 
Copy the struct definition from ogg.h which has better comment
alignment.
This commit is contained in:
Ralph Giles 2019-08-13 08:55:32 -07:00
parent 3461004ef0
commit 51b74c367b
No known key found for this signature in database
GPG Key ID: 9259A8F2D2D44C84
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/libogg/ogg_stream_state.html
View File

@ -18,7 +18,8 @@
<p><i>declared in "ogg/ogg.h"</i></p>
<p>
The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream.
The ogg_stream_state struct tracks the current encode/decode state
of the current logical bitstream.
<p>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@ -32,10 +33,10 @@ typedef struct {
long body_returned; /* elements of fill returned */
int *lacing_vals; /* The values that will go to the segment table */
ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact
this way, but it is simple coupled to the
lacing fifo */
int *lacing_vals; /* The values that will go to the segment table */
ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact
this way, but it is simple coupled to the
lacing fifo */
long lacing_storage;
long lacing_fill;
long lacing_packet;
@ -48,9 +49,9 @@ typedef struct {
logical bitstream */
int b_o_s; /* set after we've written the initial page
of a logical bitstream */
long serialno;
long pageno;
ogg_int64_t packetno; /* sequence number for decode; the framing
long serialno;
long pageno;
ogg_int64_t packetno; /* sequence number for decode; the framing
knows where there's a hole in the data,
but we need coupling so that the codec
(which is in a separate abstraction