diff options
Diffstat (limited to 'doc')
70 files changed, 0 insertions, 5687 deletions
diff --git a/doc/.cvsignore b/doc/.cvsignore deleted file mode 100644 index 282522db..00000000 --- a/doc/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/Makefile.am b/doc/Makefile.am deleted file mode 100644 index 251e9973..00000000 --- a/doc/Makefile.am +++ /dev/null @@ -1,13 +0,0 @@ -## Process this with automake to create Makefile.in - -AUTOMAKE_OPTIONS = foreign - -SUBDIRS = vorbisfile vorbisenc - -docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION) - -doc_DATA = v-comment.html vorbisword2.png white-ogg.png programming.html\ - vorbis.html wait.png white-xifish.png vorbis-clip.txt\ - vorbis-errors.txt - -EXTRA_DIST = $(doc_DATA) diff --git a/doc/eightphase.png b/doc/eightphase.png Binary files differdeleted file mode 100644 index c5c4bc25..00000000 --- a/doc/eightphase.png +++ /dev/null diff --git a/doc/fourphase.png b/doc/fourphase.png Binary files differdeleted file mode 100644 index a7c12ce5..00000000 --- a/doc/fourphase.png +++ /dev/null diff --git a/doc/programming.html b/doc/programming.html deleted file mode 100644 index 7f6e62fe..00000000 --- a/doc/programming.html +++ /dev/null @@ -1,507 +0,0 @@ -<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE> -<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000"> -<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p> - - -<h1><font color=#000070> -Programming with Xiphophorus <tt>libvorbis</tt> -</font></h1> - -<em>Last update to this document: July 22, 1999</em><br> - -<h2>Description</h2> - -Libvorbis is Xiphophorus's portable Ogg Vorbis CODEC implemented as a -programmatic library. Libvorbis provides primitives to handle framing -and manipulation of Ogg bitstreams (used by the Vorbis for -streaming), a full analysis (encoding) interface as well as packet -decoding and synthesis for playback. <p> - -The libvorbis library does not provide any system interface; a -full-featured demonstration player included with the library -distribtion provides example code for a variety of system interfaces -as well as a working example of using libvorbis in production code. - -<h2>Encoding Overview</h2> - - - -<h2>Decoding Overview</h2> - -Decoding a bitstream with libvorbis follows roughly the following -steps: - -<ol> -<li>Frame the incoming bitstream into pages -<li>Sort the pages by logical bitstream and buffer then into logical streams -<li>Decompose the logical streams into raw packets -<li>Reconstruct segments of the original data from each packet -<li>Glue the reconstructed segments back into a decoded stream -</ol> - -<h3>Framing</h3> - -An Ogg bitstream is logically arranged into pages, but to decode -the pages, we have to find them first. The raw bitstream is first fed -into an <tt>ogg_sync_state</tt> buffer using <tt>ogg_sync_buffer()</tt> -and <tt>ogg_sync_wrote()</tt>. After each block we submit to the sync -buffer, we should check to see if we can frame and extract a complete -page or pages using <tt>ogg_sync_pageout()</tt>. Extra pages are -buffered; allowing them to build up in the <tt>ogg_sync_state</tt> -buffer will eventually exhaust memory.<p> - -The Ogg pages returned from <tt>ogg_sync_pageout</tt> need not be -decoded further to be used as landmarks in seeking; seeking can be -either a rough process of simply jumping to approximately intuited -portions of the bitstream, or it can be a precise bisection process -that captures pages and inspects data position. When seeking, -however, sequential multiplexing (chaining) must be accounted for; -beginning play in a new logical bitstream requires initializing a -synthesis engine with the headers from that bitstream. Vorbis -bitstreams do not make use of concurent multiplexing (grouping).<p> - -<h3>Sorting</h3> - -The pages produced by <tt>ogg_sync_pageout</tt> are then sorted by -serial number to seperate logical bitstreams. Initialize logical -bitstream buffers (<tt>og_stream_state</tt>) using -<tt>ogg_stream_init()</tt>. Pages are submitted to the matching -logical bitstream buffer using <tt>ogg_stream_pagein</tt>; the serial -number of the page and the stream buffer must match, or the page will -be rejected. A page submitted out of sequence will simply be noted, -and in the course of outputting packets, the hole will be flagged -(<tt>ogg_sync_pageout</tt> and <tt>ogg_stream_packetout</tt> will -return a negative value at positions where they had to recapture the -stream). - -<h3>Extracting packets</h3> - -After submitting page[s] to a logical stream, read available packets -using <tt>ogg_stream_packetout</tt>. - -<h3>Decoding packets</h3> - -<h3>Reassembling data segments</h3> - - -<h2>Ogg Bitstream Manipulation Structures</h3> - -Two of the Ogg bitstream data structures are intended to be -transparent to the developer; the fields should be used directly.<p> - -<h3>ogg_packet</h3> - -<pre> -typedef struct { - unsigned char *packet; - long bytes; - long b_o_s; - long e_o_s; - - size64 frameno; - -} ogg_packet; -</pre> - -<dl> -<dt>packet: <dd>a pointer to the byte data of the raw packet -<dt>bytes: <dd>the size of the packet' raw data -<dt>b_o_s: <dd>beginning of stream; nonzero if this is the first packet of - the logical bitstream -<dt>e_o_s: <dd>end of stream; nonzero if this is the last packet of the - logical bitstream -<dt>frameno: <dd>the absolute position of this packet in the original - uncompressed data stream. -</dl> - -<h4>encoding notes</h4> The encoder is responsible for setting all of -the fields of the packet to appropriate values before submission to -<tt>ogg_stream_packetin()</tt>; however, it is noted that the value in -<tt>b_o_s</tt> is ignored; the first page produced from a given -<tt>ogg_stream_state</tt> structure will be stamped as the initial -page. <tt>e_o_s</tt>, however, must be set; this is the means by -which the stream encoding primitives handle end of stream and cleanup. - -<h4>decoding notes</h4><tt>ogg_stream_packetout()</tt> sets the fields -to appropriate values. Note that frameno will be >= 0 only in the -case that the given packet actually represents that position (ie, only -the last packet completed on any page will have a meaningful -<tt>frameno</tt>). Intervening frames will see <tt>frameno</tt> set -to -1. - -<h3>ogg_page</h3> - -<pre> -typedef struct { - unsigned char *header; - long header_len; - unsigned char *body; - long body_len; -} ogg_page; -</pre> - -<dl> -<dt>header: <dd>pointer to the page header data -<dt>header_len: <dd>length of the page header in bytes -<dt>body: <dd>pointer to the page body -<dt>body_len: <dd>length of the page body -</dl> - -Note that although the <tt>header</tt> and <tt>body</tt> pointers do -not necessarily point into a single contiguous page vector, the page -body must immediately follow the header in the bitstream.<p> - -<h2>Ogg Bitstream Manipulation Functions</h3> - -<h3> -int ogg_page_bos(ogg_page *og); -</h3> - -Returns the 'beginning of stream' flag for the given Ogg page. The -beginning of stream flag is set on the initial page of a logical -bitstream.<P> - -Zero indicates the flag is cleared (this is not the initial page of a -logical bitstream). Nonzero indicates the flag is set (this is the -initial page of a logical bitstream).<p> - -<h3> -int ogg_page_continued(ogg_page *og); -</h3> - -Returns the 'packet continued' flag for the given Ogg page. The packet -continued flag indicates whether or not the body data of this page -begins with packet continued from a preceeding page.<p> -Zero (unset) indicates that the body data begins with a new packet. -Nonzero (set) indicates that the first packet data on the page is a -continuation from the preceeding page. - -<h3> -int ogg_page_eos(ogg_page *og); -</h3> - -Returns the 'end of stream' flag for a give Ogg page. The end of page -flag is set on the last (terminal) page of a logical bitstream.<p> - -Zero (unset) indicates that this is not the last page of a logical -bitstream. Nonzero (set) indicates that this is the last page of a -logical bitstream and that no addiitonal pages belonging to this -bitstream may follow.<p> - -<h3> -size64 ogg_page_frameno(ogg_page *og); -</h3> - -Returns the position of this page as an absolute position within the -original uncompressed data. The position, as returned, is 'frames -encoded to date up to and including the last whole packet on this -page'. Partial packets begun on this page but continued to the -following page are not included. If no packet ends on this page, the -frame position value will be equal to the frame position value of the -preceeding page. If none of the original uncompressed data is yet -represented in the logical bitstream (for example, the first page of a -bitstream consists only of a header packet; this packet encodes only -metadata), the value shall be zero.<p> - -The units of the framenumber are determined by media mapping. A -vorbis audio bitstream, for example, defines one frame to be the -channel values from a single sampling period (eg, a 16 bit stereo -bitstream consists of two samples of two bytes for a total of four -bytes, thus a frame would be four bytes). A video stream defines one -frame to be a single frame of video.<p> - -<h3> -int ogg_page_pageno(ogg_page *og); -</h3> - -Returns the sequential page number of the given Ogg page. The first -page in a logical bitstream is numbered zero; following pages are -numbered in increasing monotonic order.<p> - -<h3> -int ogg_page_serialno(ogg_page *og); -</h3> - -Returns the serial number of the given Ogg page. The serial number is -used as a handle to distinguish various logical bitstreams in a -physical Ogg bitstresm. Every logical bitstream within a -physical bitstream must use a unique (within the scope of the physical -bitstream) serial number, which is stamped on all bitstream pages.<p> - -<h3> -int ogg_page_version(ogg_page *og); -</h3> - -Returns the revision of the Ogg bitstream structure of the given page. -Currently, the only permitted number is zero. Later revisions of the -bitstream spec will increment this version should any changes be -incompatable.</p> - -<h3> -int ogg_stream_clear(ogg_stream_state *os); -</h3> - -Clears and deallocates the internal storage of the given Ogg stream. -After clearing, the stream structure is not initialized for use; -<tt>ogg_stream_init</tt> must be called to reinitialize for use. -Use <tt>ogg_stream_reset</tt> to reset the stream state -to a fresh, intiialized state.<p> - -<tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer -<tt>os</tt>, allowing use of this call on stream structures in static -or automatic storage. <tt>ogg_stream_destroy</tt>is a complimentary -function that frees the pointer as well.<p> - -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -int ogg_stream_destroy(ogg_stream_state *os); -</h3> - -Clears and deallocates the internal storage of the given Ogg stream, -then frees the storage associated with the pointer <tt>os</tt>.<p> - -<tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer -<tt>os</tt>, allowing use of that call on stream structures in static -or automatic storage.<p> - -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -int ogg_stream_init(ogg_stream_state *os,int serialno); -</h3> - -Initialize the storage associated with <tt>os</tt> for use as an Ogg -stream. This call is used to initialize a stream for both encode and -decode. The given serial number is the serial number that will be -stamped on pages of the produced bitstream (during encode), or used as -a check that pages match (during decode).<p> - -Returns zero on success, nonzero on failure.<p> - -<h3> -int ogg_stream_packetin(ogg_stream_state *os, ogg_packet *op); -</h3> - -Used during encoding to add the given raw packet to the given Ogg -bitstream. The contents of <tt>op</tt> are copied; -<tt>ogg_stream_packetin</tt> does not retain any pointers into -<tt>op</tt>'s storage. The encoding proccess buffers incoming packets -until enough packets have been assembled to form an entire page; -<tt>ogg_stream_pageout</tt> is used to read complete pages.<p> - -Returns zero on success, nonzero on failure.<p> - -<h3> -int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op); -</h3> - -Used during decoding to read raw packets from the given logical -bitstream. <tt>ogg_stream_packetout</tt> will only return complete -packets for which checksumming indicates no corruption. The size and -contents of the packet exactly match those given in the encoding -process. <p> - -Returns zero if the next packet is not ready to be read (not buffered -or incomplete), positive if it returned a complete packet in -<tt>op</tt> and negative if there is a gap, extra bytes or corruption -at this position in the bitstream (essentially that the bitstream had -to be recaptured). A negative value is not necessarily an error. It -would be a common occurence when seeking, for example, which requires -recapture of the bitstream at the position decoding continued.<p> - -Iff the return value is positive, <tt>ogg_stream_packetout</tt> placed -a packet in <tt>op</tt>. The data in <t>op</tt> points to static -storage that is valid until the next call to -<tt>ogg_stream_pagein</tt>, <tt>ogg_stream_clear</tt>, -<tt>ogg_stream_reset</tt>, or <tt>ogg_stream_destroy</tt>. The -pointers are not invalidated by more calls to -<tt>ogg_stream_packetout</tt>.<p> - -<h3> -int ogg_stream_pagein(ogg_stream_state *os, ogg_page *og); -</h3> - -Used during decoding to buffer the given complete, pre-verified page -for decoding into raw Ogg packets. The given page must be framed, -normally produced by <tt>ogg_sync_pageout</tt>, and from the logical -bitstream associated with <tt>os</tt> (the serial numbers must match). -The contents of the given page are copied; <tt>ogg_stream_pagein</tt> -retains no pointers into <tt>og</tt> storage.<p> - -Returns zero on success and non-zero on failure.<p> - -<h3> -int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og); -</h3> - -Used during encode to read complete pages from the stream buffer. The -returned page is ready for sending out to the real world.<p> - -Returns zero if there is no complete page ready for reading. Returns -nonzero when it has placed data for a complete page into -<tt>og</tt>. Note that the storage returned in og points into internal -storage; the pointers in <tt>og</tt> are valid until the next call to -<tt>ogg_stream_pageout</tt>, <tt>ogg_stream_packetin</tt>, -<tt>ogg_stream_reset</tt>, <tt>ogg_stream_clear</tt> or -<tt>ogg_stream_destroy</tt>. - -<h3> -int ogg_stream_reset(ogg_stream_state *os); -</h3> - -Resets the given stream's state to that of a blank, unused stream; -this may be used during encode or decode. <p> - -Note that if used during encode, it does not alter the stream's serial -number. In addition, the next page produced during encoding will be -marked as the 'initial' page of the logical bitstream.<p> - -When used during decode, this simply clears the data buffer of any -pending pages. Beginning and end of stream cues are read from the -bitstream and are unaffected by reset.<p> - -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -char *ogg_sync_buffer(ogg_sync_state *oy, long size); -</h3> - -This call is used to buffer a raw bitstream for framing and -verification. <tt>ogg_sync_buffer</tt> handles stream capture and -recapture, checksumming, and division into Ogg pages (as required by -<tt>ogg_stream_pagein</tt>).<p> - -<tt>ogg_sync_buffer</tt> exposes a buffer area into which the decoder -copies the next (up to) <tt>size</tt> bytes. We expose the buffer -(rather than taking a buffer) in order to avoid an extra copy many -uses; this way, for example, <tt>read()</tt> can transfer data -directly into the stream buffer without first needing to place it in -temporary storage.<p> - -Returns a pointer into <tt>oy</tt>'s internal bitstream sync buffer; -the remaining space in the sync buffer is at least <tt>size</tt> -bytes. The decoder need not write all of <tt>size</tt> bytes; -<tt>ogg_sync_wrote</tt> is used to inform the engine how many bytes -were actually written. Use of <tt>ogg_sync_wrote</tt> after writing -into the exposed buffer is mandantory.<p> - -<h3> -int ogg_sync_clear(ogg_sync_state *oy); -</h3> - -<tt>ogg_sync_clear</tt> - -Clears and deallocates the internal storage of the given Ogg sync -buffer. After clearing, the sync structure is not initialized for -use; <tt>ogg_sync_init</tt> must be called to reinitialize for use. -Use <tt>ogg_sync_reset</tt> to reset the sync state and buffer to a -fresh, intiialized state.<p> - -<tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer -<tt>oy</tt>, allowing use of this call on sync structures in static -or automatic storage. <tt>ogg_sync_destroy</tt>is a complimentary -function that frees the pointer as well.<p> - -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -int ogg_sync_destroy(ogg_sync_state *oy); -</h3> - -Clears and deallocates the internal storage of the given Ogg sync -buffer, then frees the storage associated with the pointer -<tt>oy</tt>.<p> - -<tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer -<tt>oy</tt>, allowing use of that call on stream structures in static -or automatic storage.<p> - -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -int ogg_sync_init(ogg_sync_state *oy); -</h3> - -Initializes the sync buffer <tt>oy</tt> for use.<p> -Returns zero on success and non-zero on failure. This function always -succeeds.<p> - -<h3> -int ogg_sync_pageout(ogg_sync_state *oy, ogg_page *og); -</h3> - -Reads complete, framed, verified Ogg pages from the sync buffer, -placing the page data in <tt>og</tt>.<p> - -Returns zero when there's no complete pages buffered for -retrieval. Returns negative when a loss of sync or recapture occurred -(this is not necessarily an error; recapture would be required after -seeking, for example). Returns positive when a page is returned in -<tt>og</tt>. Note that the data in <tt>og</tt> points into the sync -buffer storage; the pointers are valid until the next call to -<tt>ogg_sync_buffer</tt>, <tt>ogg_sync_clear</tt>, -<tt>ogg_sync_destroy</tt> or <tt>ogg_sync_reset</tt>. - - -<h3> -int ogg_sync_reset(ogg_sync_state *oy); -</h3> - -<tt>ogg_sync_reset</tt> resets the sync state in <tt>oy</tt> to a -clean, empty state. This is useful, for example, when seeking to a -new location in a bitstream.<p> - -Returns zero on success, nonzero on failure.<p> - -<h3> -int ogg_sync_wrote(ogg_sync_state *oy, long bytes); -</h3> - -Used to inform the sync state as to how many bytes were actually -written into the exposed sync buffer. It must be equal to or less -than the size of the buffer requested.<p> - -Returns zero on success and non-zero on failure; failure occurs only -when the number of bytes written were larger than the buffer.<p> - -<hr> -<a href="http://www.xiph.org/"> -<img src="white-xifish.png" align=left border=0> -</a> -<font size=-2 color=#505050> - -Ogg is a <a href="http://www.xiph.org">Xiphophorus</a> effort to -protect essential tenets of Internet multimedia from corporate -hostage-taking; Open Source is the net's greatest tool to keep -everyone honest. See <a href="http://www.xiph.org/about.html">About -Xiphophorus</a> for details. -<p> - -Ogg Vorbis is the first Ogg audio CODEC. Anyone may -freely use and distribute the Ogg and Vorbis specification, -whether in a private, public or corporate capacity. However, -Xiphophorus and the Ogg project (xiph.org) reserve the right to set -the Ogg/Vorbis specification and certify specification compliance.<p> - -Xiphophorus's Vorbis software CODEC implementation is distributed -under the Lesser/Library GNU Public License. This does not restrict -third parties from distributing independent implementations of Vorbis -software under other licenses.<p> - -OggSquish, Vorbis, Xiphophorus and their logos are trademarks (tm) of -<a href="http://www.xiph.org/">Xiphophorus</a>. These pages are -copyright (C) 1994-2000 Xiphophorus. All rights reserved.<p> - -</body> - - - - - - diff --git a/doc/squarepolar.png b/doc/squarepolar.png Binary files differdeleted file mode 100644 index 179a53ca..00000000 --- a/doc/squarepolar.png +++ /dev/null diff --git a/doc/stereo.html b/doc/stereo.html deleted file mode 100644 index 78ee74c4..00000000 --- a/doc/stereo.html +++ /dev/null @@ -1,494 +0,0 @@ -<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE> -<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000"> -<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p> - - -<h1><font color=#000070> -Stereo Channel Coupling in the Vorbis CODEC -</font></h1> - -<em>Last update to this document: June 27, 2001</em><br> - -<h2>Abstract</h2> The Vorbis audio CODEC provides a channel coupling -mechanisms designed to reduce effective bitrate by both eliminating -interchannel redundancy and eliminating stereo image information -labelled inaudible or undesireable according to spatial psychoacoustic -models. This document describes both the mechanical coupling -mechanisms available within the Vorbis specification, as well as the -specific stereo coupling models used by the reference -<tt>libvorbis</tt> CODEC provided by xiph.org. - -<h2>Terminology</h2> Terminology as used in this document is based on -common terminology associated with contemporary CODECs such as MPEG I -audio layer 3 (mp3). However, some differences in terminology are -useful in the context of Vorbis as Vorbis functions somewhat -differently than most current formats. For clarity, a few terms are -defined beforehand here, and others will be defined where they first -appear in context.<p> - -<h3>Subjective and Objective</h3> - -<em>Objective</em> fidelity is a measure, based on a computable, -mechanical metric, of how carefully an output matches an input. For -example, a stereo amplifier may claim to introduce less that .01% -total harmonic distortion when amplifying an input signal; this claim -is easy to verify given proper equiment, and any number of testers are -likely to arrive at the same, exact results. One need not listen to -the equipment to make this measurement.<p> - -However, given two amplifiers with identical, verifiable objective -specifications, listeners may strongly prefer the sound quality of one -over the other. This is actually the case in the decades old debate -[some would say jihad] among audiophiles involving vacuum tube versus -solid state amplifiers. There are people who can tell the difference, -and strongly prefer one over the other despite seemingly identical, -measurable quality. This preference is <em>subjective</em> and -difficult to measure but nonetheless real. - -Individual elements of subjective differences often can be qualified, -but overall subjective quality generally is not measurable. Different -observers are likely to disagree on the exact results of a subjective -test as each observer's perspective differs. When measuring -subjective qualities, the best one can hope for is average, empirical -results that show statistical significance across a group.<p> - -Perceptual codecs are most concerned with subjective, not objective, -quality. This is why evaluating a perceptual codec via distortion -measures and sonograms alone is useless; these objective measures may -provide insight into the quality or functioning of a codec, but cannot -answer the much squishier subjective question, "Does it sound -good?". The tube amplifier example is perhaps not the best as very few -people can hear, or care to hear, the minute differences between tubes -and transistors, whereas the subjective differences in perceptual -codecs tend to be quite large even when objective differences are -not.<p> - -<h3>Fidelity, Artifacts and Differences</h3> Audio <em>artifacts</em> -and loss of fidelity or more simply put, audio <em>differences</em> -are not the same thing.<p> - -A loss of fidelity implies differences between the perceived input and -output signal; it does not necessarily imply that the differences in -output are displeasing or that the output sounds poor (although this -is often the case). Tube amplifiers are <em>not</em> higher fidelity -than modern solid state and digital systems. They simply produce a -form of distortion and coloring that is either unnoticable or actually -pleasing to many ears.<p> - -As compared to an original signal using hard metrics, all perceptual -codecs [ASPEC, ATRAC, MP3, WMA, AAC, TwinVQ, AC3 and Vorbis included] -lose objective fidelity in order to reduce bitrate. This is fact. The -idea is to lose fidelity in ways that cannot be perceived. However, -most current streaming applications demand bitrates lower than what -can be acheived by sacrificing only objective fidelity; this is also -fact, despite whatever various company press releases might claim. -Subjective fidelity eventually must suffer in one way or another.<p> - -The goal is to choose the best possible tradeoff such that the -fidelity loss is graceful and not obviously noticable. Most listeners -of FM radio do not realize how much lower fidelity that medium is as -compared to compact discs or DAT. However, when compared directly to -source material, the difference is obvious. A cassette tape is lower -fidelity still, and yet the degredation, relatively speaking, is -graceful and generally easy not to notice. Compare this graceful loss -of quality to an average 44.1kHz stereo mp3 encoded at 80 or 96kbps. -The mp3 might actually be higher objective fidelity but subjectively -sounds much worse.<p> - -Thus, when a CODEC <em>must</em> sacrifice subjective quality in order -to satisfy a user's requirements, the result should be a -<em>difference</em> that is generally either difficult to notice -without comparison, or easy to ignore. An <em>artifact</em>, on the -other hand, is an element introduced into the output that is -immediately noticable, obviously foreign, and undesired. The famous -'underwater' or 'twinkling' effect synonymous with low bitrate (or -poorly encoded) mp3 is an example of an <em>artifact</em>. This -working definition differs slightly from common usage, but the coined -distinction between differences and artifacts is useful for our -discussion.<p> - -The goal, when it is absolutely necessary to sacrifice subjective -fidelity, is obviously to strive for differences and not artifacts. -The vast majority of CODECs today fail at this task miserably, -predictably, and regularly in one way or another. Avoiding such -failures when it is necessary to sacrifice subjective quality is a -fundamental design objective of Vorbis and that objective is reflected -in Vorbis's channel coupling design.<p> - -<h2>Mechanisms</h2> - -In encoder release beta 4 and earlier, Vorbis supported multiple -channel encoding, but the channels were encoded entirely seperately -with no cross-analysis or redundancy elimination between channels. -This multichannel strategy is very similar to the mp3's <em>dual -stereo</em> mode and Vorbis uses the same name for it's analagous -uncoupled multichannel modes. - -However, the Vorbis spec provides for, and Vorbis release 1.0 rc1 and -later implement a coupled channel strategy. Vorbis has two specific -mechanisms that may be used alone or in conjunction to implement -channel coupling. The first is <em>channel interleaving</em> via -residue backend #2, and the second is <em>square polar mapping</em>. -These two general mechanisms are particularly well suited to coupling -due to the structure of Vorbis encoding, as we'll explore below, and -using both we can implement both totally <em>lossless stereo image -coupling</em>, as well as various lossy models that seek to eliminate -inaudible or unimportant aspects of the stereo image in order to -enhance bitrate. The exact coupling implementation is generalized to -allow the encoder a great deal of flexibility in implementation of a -stereo model without requiring any significant complexity increase -over the combinatorically simpler mid/side joint stereo of mp3 and -other current audio codecs.<p> - -Channel interleaving may be applied directly to more than a single -channel and polar mapping is hierarchical such that polar coupling may be -extrapolated to an arbitrary number of channels and is not restricted -to only stereo, quadriphonics, ambisonics or 5.1 surround. However, -the scope of this document restricts itself to the stereo coupling -case.<p> - -<h3>Square Polar Mapping</h3> - -<h4>maximal correlation</h4> - -Recall that the basic structure of a a Vorbis I stream first generates -from input audio a spectral 'floor' function that serves as an -MDCT-domain whitening filter. This floor is meant to represent the -rough envelope of the frequency spectrum, using whatever metric the -encoder cares to define. This floor is subtracted from the log -frequency spectrum, effectively normalizing the spectrum by frequency. -Each input channel is associated with a unique floor function.<p> - -The basic idea behind any stereo coupling is that the left and right -channels usually correlate. This correlation is even stronger if one -first accounts for energy differences in any given frequency band -across left and right; think for example of individual instruments -mixed into different portions of the stereo image, or a stereo -recording with a dominant feature not perfectly in the center. The -floor functions, each specific to a channel, provide the perfect means -of normaizing left and right energies across the spectrum to maximize -correlation before coupling. This feature of the Vorbis format is not -a convenient accident.<p> - -Because we strive to maximally correlate the left and right channels -and generally succeed in doing so, left and right residue is typically -nearly identical. We could use channel interleaving (discussed below) -alone to efficiently remove the redundancy between the left and right -channels as a side effect of entropy encoding, but a polar -representation gives benefits when left/right correlation is -strong. <p> - -<h4>point and diffuse imaging</h4> - -The first advantage of a polar representation is that it effectively -seperates the spatial audio information into a 'point image' -(magnitude) at a given frequency and located somewhere in the sound -field, and a 'diffuse image' (angle) that fills a large amount of -space silmultaneously. Even if we preserve only the magnitude (point) -data, a detailed and carefully chosen floor function in each channel -provides us with a free, fine-grained, frequency relative intensity -stereo*. Angle information represents diffuse sound fields, such as -reverberation that fills the entre space silmultaneously.<p> - -*<em>Because the Vorbis model supports a number of different possible -stereo models and these models may be mixed, we do not use the term -'intensity stereo' talking about Vorbis; instead we use the terms -'point stereo', 'phase stereo' and subcategories of each.</em><p> - -The majority of a stereo image is representable by polar magnitude -alone, as strong sounds tend to be produced at near-point sources; -even non-diffuse, fast, sharp echoes track very accurately using -magnitude representation almost alone (for those experimenting with -Vorbis tuning, this strategy works much better with the precise, -piecewise control of floor 1; the continuous approximation of floor 0 -results in unstable imaging). Reverberation and diffuse sounds tend -to contain less energy and be psychoacoustically dominated by the -point sources embedded in them. Thus, we again tend to concentrate -more represented energy into a predictably smaller number of numbers. -Seperating representation of point and diffuse imaging also allows us -to model and manipulate point and diffuse qualities seperately.<p> - -<h4>controlling bit leakage and symbol crosstalk</h4> Because polar -representation concentrates represented energy into fewer large -values, we reduce bit 'leakage' during cascading (multistage VQ -encoding) as a secondary benefit. A single large, monolithic VQ -codebook is more efficient than a cascaded book due to entropy -'crosstalk' among symbols between different stages of a multistage cascade. -Polar representation is a way of further concentrating entropy into -predictable locations so that codebook design can take steps to -improve multistage codebook efficiency. It also allows us to cascade -various elements of the stereo image independently.<p> - -<h4>eliminating trigonometry and rounding</h4> - -Rounding and computational complexity are potential problems with a -polar representation. As our encoding process involves quantization, -mixing a polar representation and quantization makes it potentially -impossible, depending on implementation, to construct a coupled stereo -mechanism that results in bit-identical decompressed output compared -to an uncoupled encoding should the encoder desire it.<p> - -Vorbis uses a mapping that preserves the most useful qualities of -polar representation, relies only on addition/subtraction, and makes -it trivial before or after quantization to represent an -angle/magnitude through a one-to-one mapping from possible left/right -value permutations. We do this by basing our polar representation on -the unit square rather than the unit-circle.<p> - -Given a magnitude and angle, we recover left and right using the -following function (note that A/B may be left/right or right/left -depending on the coupling definition used by the encoder):<p> - -<pre> - if(magnitude>0) - if(angle>0){ - A=magnitude; - B=magnitude-angle; - }else{ - B=magnitude; - A=magnitude+angle; - } - else - if(angle>0){ - A=magnitude; - B=magnitude+angle; - }else{ - B=magnitude; - A=magnitude-angle; - } - } -</pre> - -The function is antisymmetric for positive and negative magnitudes in -order to eliminate a redundant value when quantizing. For example, if -we're quantizing to integer values, we can visualize a magnitude of 5 -and an angle of -2 as follows:<p> - -<img src="squarepolar.png"> - -<p> -This representation loses or replicates no values; if the range of A -and B are integral -5 through 5, the number of possible Cartesian -permutations is 121. Represented in square polar notation, the -possible values are: - -<pre> - 0, 0 - --1,-2 -1,-1 -1, 0 -1, 1 - - 1,-2 1,-1 1, 0 1, 1 - --2,-4 -2,-3 -2,-2 -2,-1 -2, 0 -2, 1 -2, 2 -2, 3 - - 2,-4 2,-3 ... following the pattern ... - - ... 5, 1 5, 2 5, 3 5, 4 5, 5 5, 6 5, 7 5, 8 5, 9 - -</pre> - -...for a grand total of 121 possible values, the same number as in -Cartesian representation (note that, for example, <tt>5,-10</tt> is -the same as <tt>-5,10</tt>, so there's no reason to represent -both. 2,10 cannot happen, and there's no reason to account for it.) -It's also obvious that this mapping is exactly reversable.<p> - -<h3>Channel interleaving</h3> - -We can remap and A/B vector using polar mapping into a magnitude/angle -vector, and it's clear that, in general, this concentrates energy in -the magnitude vector and reduces the amount of information to encode -in the angle vector. Encoding these vectors independently with -residue backend #0 or residue backend #1 will result in substantial -bitrate savings. However, there are still implicit correlations -between the magnitude and angle vectors. The most obvious is that the -amplitude of the angle is bounded by its corresponding magnitude -value.<p> - -Entropy coding the results, then, further benefits from the entropy -model being able to compress magnitude and angle silmultaneously. For -this reason, Vorbis implements residuebackend #2 which preinterleaves -a number of input vectors (in the stereo case, two, A and B) into a -single output vector (with the elements in the order of -A_0, B_0, A_1, B_1, A_2 ... A_n-1, B_n-1) before entropy encoding. Thus -each vector to be coded by the vector quantization backend consists of -matching magnitude and angle values.<p> - -The astute reader, at this point, will notice that in the theoretical -case in which we can use monolithic codebooks of arbitrarily large -size, we can directly interleave and encode left and right without -polar mapping; in fact, the polar mapping does not appear to lend any -benefit whatsoever to the efficiency of the entropy coding. In fact, -it is perfectly possible and reasonable to build a Vorbis encoder that -dispenses with polar mapping entirely and merely interleaves the -channel. Libvorbis based encoders may configure such an encoding and -it will work as intended.<p> - -However, when we leave the ideal/theoretical domain, we notice that -polar mapping does give additional practical benefits, as discussed in -the above section on polar mapping and summarised again here:<p> -<ul> -<li>Polar mapping aids in controlling entropy 'leakage' between stages -of a cascaded codebook. <li>Polar mapping seperates the stereo image -into point and diffuse components which may be analyzed and handled -differently. -</ul> - -<h2>Stereo Models</h2> - -<h3>Dual Stereo</h3> - -Dual stereo referrs to stereo encoding where the channels are entirely -seperate; they are analyzed and encoded as entirely distinct entities. -This terminology is familiar from mp3.<p> - -<h3>Lossless Stereo</h3> - -Using polar mapping and/or channel interleaving, it's possible to -couple Vorbis channels losslessly, that is, construct a stereo -coupling encoding that both saves space but also decodes -bit-identically to dual stereo. OggEnc 1.0 and later offers this -mode.<p> - -Overall, this stereo mode is overkill; however, it offers a safe -alternative to users concerned about the slightest possible -degredation to the stereo image or archival quality audio.<p> - -<h3>Phase Stereo</h3> - -Phase stereo is the least aggressive means of gracefully dropping -resolution from the stereo image; it affects only diffuse imaging.<p> - -It's often quoted that the human ear is nearly entirely deaf to signal -phase above about 4kHz; this is nearly true and a passable rule of -thumb, but it can be demonstrated that even an average user can tell -the difference between high frequency in-phase and out-of-phase noise. -Obviously then, the statement is not entirely true. However, it's -also the case that one must resort to nearly such an extreme -demostration before finding the counterexample.<p> - -'Phase stereo' is simply a more aggressive quantization of the polar -angle vector; above 4kHz it's generally quite safe to quantize noise -and noisy elements to only a handful of allowed phases. The phases of -high ampliude pure tones may or may not be preserved more carefully -(they are relatively rare and L/R tend to be in phase, so there is -generally little reason not to spend a few more bits on them) <p> - -<h4>eight phase stereo</h4> - -Vorbis implements phase stereo coupling by preserving the entirety of the magnitude vector (essential to fine amlitdude and energy resolution overall) and quantizing the angle vector to one of only four possible values. Given that the magnitude vector may be positive or negative, this results in left and right phase having eight possible permutation, thus 'eight phase stereo':<p> - -<img src="eightphase.png"><p> - -Left and right may be in phase (positive or negative), the most common -case by far, or out of phase by 90 or 180 degrees.<p> - -<h4>four phase stereo</h4> - -Four phase stereo takes the quantization one step further; it allows -only in-phase and 180 degree out-out-phase signals:<p> - -<img src="fourphase.png"><p> - -<h3>Point Stereo</h3> - -Point stero eliminates the possibility of out-of-phase signal -entirely. Any diffuse quality to a sound source tends to collapse -inward to a point somewhere within the stereo image. A practical -example would be balanced reverberations within a large, live space; -normally the sound is diffuse and soft, giving a sonic impression of -volume. In point-stereo, the reverberations would still exist, but -sound fairly firmly centered within the image (assuming the -reverberation was centered overall; if the reverberation is stronger -to the left, then the point of localization in point stereo would be -to the left). This effect is most noticable at low and mid -frequencies and using headphones (which grant perfect stereo -seperation). Point stereo is is a graceful but generally easy to -detect degrdation to the sound quality and is thus used in frequency -ranges where it is least noticable.<p> - -<h3>Mixed Stereo</h3> - -Mixed stereo is the silmultaneous use of more than one of the above -stereo encoding models, generally using more aggressive modes in -higher frequencies, lower amplitudes or 'nearly' in-phase sound.<p> - -It is also the case that near-DC frequencies should be encoded using -lossless coupling to avoid frame blocking artifacts.<p> - -<h3>Vorbis Stereo Modes</h3> - -Vorbis, for the most part, uses lossless stereo and a number of mixed -modes constructed out of the above models. As of the current pre-1.0 -testing version of the encoder, oggenc supports the following modes. -Oggenc's default choice varies by bitrate and each mode is selectable -by the user:<p> - -<dl> -<dt>dual stereo -<dd>uncoupled stereo encoding<p> - -<dt>lossless stereo -<dd>lossless stereo coupling; produces exactly equivalent output to dual stereo<p> - -<dt>eight phase stereo -<dd>a mixed mode combining lossless stereo for frequencies to approximately 4 kHz (and all strong pure tones) and eight phase stereo above<p> - -<dt>aggressive eight phase stereo -<dd>a mixed mode combining lossless stereo for frequencies to approximately 2 kHz (and for all strong pure tones) and eight phase stereo above<p> - -<dt>eight/four phase stero <dd>A mixed mode combining lossless stereo -for bass, eight phase stereo for noisy content and lossless stereo for -tones to approximately 4kHz and four phase stereo above 4kHz.<p> - -<dt>eight phase/point stero <dd>A mixed mode combining lossless stereo -for bass, eight phase stereo for noisy content and lossless stereo for -tones to approximately 4kHz and point stereo above 4kHz.<p> - -<dt>aggressive eight phase/point stero -<dd>A mixed mode combining lossless stereo -for bass, eight phase stereo to approximately 2kHz and point stereo above 2kHz.<p> - -<dt>point stereo -<dd>A mixed mode combining lossless stereo to approximately 4kHz and point stereo above 4kHz.<p> - -<dt>aggressive point stereo -<dd>A mixed mode combining lossless stereo to approximately 1-2kHz and point stereo above.<p> - -</dl> - -<hr> -<a href="http://www.xiph.org/"> -<img src="white-xifish.png" align=left border=0> -</a> -<font size=-2 color=#505050> - -Ogg is a <a href="http://www.xiph.org">Xiphophorus</a> effort to -protect essential tenets of Internet multimedia from corporate -hostage-taking; Open Source is the net's greatest tool to keep -everyone honest. See <a href="http://www.xiph.org/about.html">About -Xiphophorus</a> for details. -<p> - -Ogg Vorbis is the first Ogg audio CODEC. Anyone may -freely use and distribute the Ogg and Vorbis specification, -whether in a private, public or corporate capacity. However, -Xiphophorus and the Ogg project (xiph.org) reserve the right to set -the Ogg/Vorbis specification and certify specification compliance.<p> - -Xiphophorus's Vorbis software CODEC implementation is distributed -under a BSD-like License. This does not restrict third parties from -distributing independent implementations of Vorbis software under -other licenses.<p> - -OggSquish, Vorbis, Xiphophorus and their logos are trademarks (tm) of -<a href="http://www.xiph.org/">Xiphophorus</a>. These pages are -copyright (C) 1994-2001 Xiphophorus. All rights reserved.<p> - -</body> - - - - - - diff --git a/doc/v-comment.html b/doc/v-comment.html deleted file mode 100644 index 99876df2..00000000 --- a/doc/v-comment.html +++ /dev/null @@ -1,194 +0,0 @@ -<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE> -<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000"> -<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p> - - -<h1><font color=#000070> -Ogg Vorbis comment field specification -</font></h1> - -<em>Last update to this document: February 9, 2001</em><p> - -The text comment header is the second (of three) header packets that -begin a Vorbis bitstream. It is meant for short, text comments, -not arbitrary metadata; arbitrary metadata belongs in a -metadata stream (usually an XML stream type).<p> - -<h2>Comment use rationale</h2> - -The comment field is meant to be used much like someone jotting a -quick note on the bottom of a CDR. It should be a little information to -remember the disc by and explain it to others; a short, to-the-point -text note that need not only be a couple words, but isn't going to be -more than a short paragraph. The essentials, in other words, whatever -they turn out to be, eg: - -<blockquote> -"Honest Bob and the Factory-to-Dealer-Incentives, _I'm Still Around_, -opening for Moxy Fruvous, 1997" -</blockquote> - -<h2>Structure</h2> - -The comment header logically is a list of eight-bit-clean vectors; the -number of vectors is bounded to 2^32-1 and the length of each vector -is limited to 2^32-1 bytes. The vector length is encoded; the vector -is not null terminated. In addition to the vector list, there is a -single vector for vendor name (also 8 bit clean, length encoded in 32 -bits). Libvorbis currently sets the vendor string to "Xiphophorus -libVorbis I 20010119".<p> - -The comment vectors are structured similarly to a UNIX environment. -That is, comment fields consist of a field name and a field value and -look like: - -<pre> -comment[0]="ARTIST=me"; -comment[1]="TITLE=the sound of vorbis"; -</pre> - -<h2>Content vector format</h2> - -<ul> -<li>A case-insensitive field name that may consist of ASCII 0x20 through -0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive (A-Z) is -to be considered equivalent to ASCII 0x61 through 0x7A inclusive -(a-z). - -<li>The field name is immediately followed by ASCII 0x3D ('='); this -equals sign is used to terminate the field name. - -<li>0x3D is followed by 8 bit clean UTF-8 field contents to the end of -the field. -</ul> - -<h3>Field names</h3> - -Below is a proposed, minimal list of standard filed names with a -description of intended use. No single or group of field names is -mandatory; a comment header may contain one, all or none of the names -in this list. -<dl> -<dt>TITLE<dd>Track name - -<dt>VERSION<dd>The version field may be used to differentiate multiple -version of the same track title in a single collection. (e.g. remix info) - -<dt>ALBUM<dd>The collection name to which this track belongs - -<dt>TRACKNUMBER<dd>The track number of this piece if part of a specific larger collection or album - -<dt>ARTIST<dd>Track performer - -<dt>ORGANIZATION<dd>Name of the organization producing the track (i.e. -the 'record label') - -<dt>DESCRIPTION<dd>A short text description of the contents - -<dt>GENRE<dd>A short text indication of music genre - -<dt>DATE<dd>Date the track was recorded - -<dt>LOCATION<dd>Location where track was recorded - -<dt>COPYRIGHT<dd>Copyright information - -<dt>ISRC<dd>ISRC number for the track; see <a href="http://www.ifpi.org/online/isrc_intro.html">the ISRC intro page</a> for more information on ISRC numbers. - -</dl> - -<h3>Implications</h3> -<ul> -<li> -Field names should not be 'internationalized'; this is a -concession to simplicity not an attempt to exclude the majority of -the world that doesn't speak English. Field *contents*, however, -are represented in UTF-8 to allow easy representation of any language. -<li> -We have the length of the entirety of the field and restrictions on -the field name so that the field name is bounded in a known way. Thus -we also have the length of the field contents. -<li> -Individual 'vendors' may use non-standard field names within -reason. The proper use of comment fields should be clear through -context at this point. Abuse will be discouraged. -<li> -There is no vendor-specific prefix to 'nonstandard' field names. -Vendors should make some effort to avoid arbitrarily polluting the -common namespace. -<li> -Field names are not required to be unique (occur once) within a -comment header. As an example, assume a track was recorded by three -well know artists; the following is permissible, and encouraged: -<pre> - ARTIST=Dizzy Gillespie - ARTIST=Sonny Rollins - ARTIST=Sonny Stitt -</pre> - -</ul> - -<h2>Encoding</h2> - -The comment header comprises the entirety of the second bitstream -header packet. Unlike the first bitstream header packet, it is not -generally the only packet on the second page and may not be restricted -to within the second bitstream page. The length of the comment header -packet is [practically] unbounded. The comment header packet is not -optional; it must be present in the bitstream even if it is -effectively empty.<p> - -The comment header is encoded as follows (as per Ogg's standard -bitstream mapping which renders least-significant-bit of the word to be -coded into the least significant available bit of the current -bitstream octet first): - -<ol> -<li> -Vendor string length (32 bit unsigned quantity specifying number of octets) - -<li> -Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated) - -<li>Number of comment fields (32 bit unsigned quantity specifying number of fields) - -<li>Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned quantity specifying number of octets) - -<li> -Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated) - -<li>Comment field 1 length (if [Number of comment fields]>1...)... -</ol> - -This is actually somewhat easier to describe in code; implementation of the above can be found in vorbis/lib/info.c:_vorbis_pack_comment(),_vorbis_unpack_comment() - -<hr> -<a href="http://www.xiph.org/"> -<img src="white-xifish.png" align=left border=0> -</a> -<font size=-2 color=#505050> - -Ogg is a <a href="http://www.xiph.org">Xiphophorus</a> effort to -protect essential tenets of Internet multimedia from corporate -hostage-taking; Open Source is the net's greatest tool to keep -everyone honest. See <a href="http://www.xiph.org/about.html">About -Xiphophorus</a> for details. -<p> - -Ogg Vorbis is the first Ogg audio CODEC. Anyone may -freely use and distribute the Ogg and Vorbis specification, -whether in a private, public or corporate capacity. However, -Xiphophorus and the Ogg project (xiph.org) reserve the right to set -the Ogg/Vorbis specification and certify specification compliance.<p> - -Xiphophorus's Vorbis software CODEC implementation is distributed -under the Lesser/Library GNU Public License. This does not restrict -third parties from distributing independent implementations of Vorbis -software under other licenses.<p> - -OggSquish, Vorbis, Xiphophorus and their logos are trademarks (tm) of -<a href="http://www.xiph.org/">Xiphophorus</a>. These pages are -copyright (C) 1994-2001 Xiphophorus. All rights reserved.<p> - -</body> - diff --git a/doc/vorbis-clip.txt b/doc/vorbis-clip.txt deleted file mode 100644 index 2e670344..00000000 --- a/doc/vorbis-clip.txt +++ /dev/null @@ -1,139 +0,0 @@ -Topic: - -Sample granularity editing of a Vorbis file; inferred arbitrary sample -length starting offsets / PCM stream lengths - -Overview: - -Vorbis, like mp3, is a frame-based* audio compression where audio is -broken up into discrete short time segments. These segments are -'atomic' that is, one must recover the entire short time segment from -the frame packet; there's no way to recover only a part of the PCM time -segment from part of the coded packet without expanding the entire -packet and then discarding a portion of the resulting PCM audio. - -* In mp3, the data segment representing a given time period is called - a 'frame'; the roughly equivalent Vorbis construct is a 'packet'. - -Thus, when we edit a Vorbis stream, the finest physical editing -granularity is on these packet boundaries (the mp3 case is -actually somewhat more complex and mp3 editing is more complicated -than just snipping on a frame boundary because time data can be spread -backward or forward over frames. In Vorbis, packets are all -stand-alone). Thus, at the physical packet level, Vorbis is still -limited to streams that contain an integral number of packets. - -However, Vorbis streams may still exactly represent and be edited to a -PCM stream of arbitrary length and starting offset without padding the -beginning or end of the decoded stream or requiring that the desired -edit points be packet aligned. Vorbis makes use of Ogg stream -framing, and this framing provides time-stamping data, called a -'granule position'; our starting offset and finished stream length may -be inferred from correct usage of the granule position data. - -Time stamping mechanism: - -Vorbis packets are bundled into into Ogg pages (note that pages do not -necessarily contain integral numbers of packets, but that isn't -inportant in this discussion. More about Ogg framing can be found in -ogg/doc/framing.html). Each page that contains a packet boundary is -stamped with the absolute sample-granularity offset of the data, that -is, 'complete samples-to-date' up to the last completed packet of that -page. (The same mechanism is used for eg, video, where the number -represents complete 2-D frames, and so on). - -(It's possible but rare for a packet to span more than two pages such -that page[s] in the middle have no packet boundary; these packets have -a granule position of '-1'.) - -This granule position mechaism in Ogg is used by Vorbis to indicate when the -PCM data intended to be represented in a Vorbis segment begins a -number of samples into the data represented by the first packet[s] -and/or ends before the physical PCM data represented in the last -packet[s]. - -File length a non-integral number of frames: - -A file to be encoded in Vorbis will probably not encode into an -integral number of packets; such a file is encoded with the last -packet containing 'extra'* samples. These samples are not padding; they -will be discarded in decode. - -*(For best results, the encoder should use extra samples that preserve -the character of the last frame. Simply setting them to zero will -introduce a 'cliff' that's hard to encode, resulting in spread-frame -noise. Libvorbis extrapolates the last frame past the end of data to -produce the extra samples. Even simply duplicating the last value is -better than clamping the signal to zero). - -The encoder indicates to the decoder that the file is actually shorter -than all of the samples ('original' + 'extra') by setting the granule -position in the last page to a short value, that is, the last -timestamp is the original length of the file discarding extra samples. -The decoder will see that the number of samples it has decoded in the -last page is too many; it is 'original' + 'extra', where the -granulepos says that through the last packet we only have 'original' -number of samples. The decoder then ignores the 'extra' samples. -This behavior is to occur only when the end-of-stream bit is set in -the page (indicating last page of the logical stream). - -Note that it not legal for the granule position of the last page to -indicate that there are more samples in the file than actually exist, -however, implementations should handle such an illegal file gracefully -in the interests of robust programming. - -Beginning point not on integral packet boundary: - -It is possible that we will the PCM data represented by a Vorbis -stream to begin at a position later than where the decoded PCM data -really begins after an integral packet boundary, a situation analagous -to the above description where the PCM data does not end at an -integral packet boundary. The easiest example is taking a clip out of -a larger Vorbis stream, and choosing a beginning point of the clip -that is not on a packet boundary; we need to ignore a few samples to -get the desired beginning point. - -The process of marking the desired beginning point is similar to -marking an arbitrary ending point. If the encoder wishes sample zero -to be some location past the actual beginning of data, it associates a -'short' granule position value with the completion of the second* -audio packet. The granule position is associated with the second -packet simply by making sure the second packet completes its page. - -*(We associate the short value with the second packet for two reasons. - a) The first packet only primes the overlap/add buffer. No data is - returned before decoding the second packet; this places the decision - information at the point of decision. b) Placing the short value on - the first packet would make the value negative (as the first packet - normally represents position zero); a negative value would break the - requirement that granule positions increase; the headers have - position values of zero) - -The decoder sees that on the first page that will return -data from the overlap/add queue, we have more samples than the granule -position accounts for, and discards the 'surplus' from the beginning -of the queue. - -Note that short granule values (indicating less than the actually -returned about of data) are not legal in the Vorbis spec outside of -indicating beginning and ending sample positions. However, decoders -should, at minimum, tolerate inadvertant short values elsewhere in the -stream (just as they should tolerate out-of-order/non-increasing -granulepos values, although this too is illegal). - -Beginning point at arbitrary positive timestamp (no 'zero' sample): - -It's also possible that the granule position of the first page of an -audio stream is a 'long value', that is, a value larger than the -amount of PCM audio decoded. This implies only that we are starting -playback at some point into the logical stream, a potentially common -occurence in streaming applications where the decoder may be -connecting into a live stream. The decoder should not treat the long -value specially. - -A long value elsewhere in the stream would normally occur only when a -page is lost or out of sequence, as indicated by the page's sequence -number. A long value under any other situation is not legal, however -a decoder should tolerate both possibilities. - - diff --git a/doc/vorbis-errors.txt b/doc/vorbis-errors.txt deleted file mode 100644 index e873d8ab..00000000 --- a/doc/vorbis-errors.txt +++ /dev/null @@ -1,103 +0,0 @@ -Error return codes possible from libvorbis and libvorbisfile: - -All 'failure' style returns are <0; this either indicates a generic -'false' value (eg, ready? T or F) or an error condition. Code can -safely just test for < 0, or look at the specific return code for more -detail. - -*** Return codes: - -OV_FALSE The call returned a 'false' status (eg, ov_bitrate_instant - can return OV_FALSE if playback is not in progress, and thus - there is no instantaneous bitrate information to report. - -OV_HOLE libvorbis/libvorbisfile is alerting the application that - there was an interruption in the data (one of: garbage - between pages, loss of sync followed by recapture, or a - corrupt page) - -OV_EREAD A read from media returned an error. - -OV_EFAULT Internal logic fault; indicates a bug or heap/stack - corruption. - -OV_EIMPL The bitstream makes use of a feature not implemented in this - library version. - -OV_EINVAL Invalid argument value. - -OV_ENOTVORBIS Bitstream/page/packet is not Vorbis data. - -OV_EBADHEADER Invalid Vorbis bitstream header. - -OV_EVERSION Vorbis version mismatch. - -OV_ENOTAUDIO Packet data submitted to vorbis_synthesis is not audio data. - -OV_EBADPACKET Invalid packet submitted to vorbis_synthesis. - -OV_EBADLINK Invalid stream section supplied to libvorbis/libvorbisfile, - or the requested link is corrupt. - -OV_ENOSEEK Bitstream is not seekable. - - -**************************************************************** -*** Libvorbis functions that can return failure/error codes: - -int vorbis_analysis_headerout() - OV_EIMPL - -int vorbis_analysis_wrote() - OV_EINVAL - -int vorbis_synthesis_headerin() - OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER - -int vorbis_synthesis() - OV_ENOTAUDIO, OV_EBADPACKET - -int vorbis_synthesis_read() - OV_EINVAL - -**************************************************************** -*** Libvorbisfile functions that can return failure/error codes: - -int ov_open_callbacks() - OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT - -int ov_open() - OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT - -long ov_bitrate() - OV_EINVAL, OV_FALSE - -long ov_bitrate_instant() - OV_FALSE - -ogg_int64_t ov_raw_total() - OV_EINVAL - -ogg_int64_t ov_pcm_total() - OV_EINVAL - -double ov_time_total() - OV_EINVAL - -int ov_raw_seek() - OV_ENOSEEK, OV_EINVAL, OV_BADLINK - -int ov_pcm_seek_page() - OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT - -int ov_pcm_seek() - OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT - -int ov_time_seek() - OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT - -int ov_time_seek_page() - OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT - -long ov_read() - OV_HOLE, OV_EBADLINK diff --git a/doc/vorbis.html b/doc/vorbis.html deleted file mode 100644 index 27e3a5b0..00000000 --- a/doc/vorbis.html +++ /dev/null @@ -1,196 +0,0 @@ -<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE> -<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000"> -<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p> - - -<h1><font color=#000070> -Ogg Vorbis encoding format documentation -</font></h1> - -<em>Last update to this document: July 15, 1999</em><br> -<em>Last update to Vorbis documentation: July 21, 1999</em><p> - -<table><tr><td> -<img src=wait.png> -</td><td valign=center> -As of writing, not all the below document -links are live. They will be populated as we complete the -documents. -</td></tr></table> - -<p> -<h2>Documents</h2> -<ul> -<li><a href="packet.html">Vorbis packet structure</a> -<li><a href="envelope.html">Temporal envelope shaping and blocksize</a> -<li><a href="mdct.html">Time domain segmentation and MDCT transform</a> -<li><a href="resolution.html">The resolution floor</a> -<li><a href="residuals.html">MDCT-domain fine structure</a><p> - -<li><a href="probmodel.html">The Vorbis probability model</a> - -<li><a href="bitpack.html">The Vorbis bitpacker</a><p> - -<li><a href="oggstream.html">Ogg bitstream overview</a> -<li><a href="framing.html">Ogg logical bitstream and framing spec</a> -<li><a href="vorbis-stream.html">Vorbis packet->Ogg bitstream - mapping</a><p> - -<li><a href="programming.html">Programming with libvorbis</a><p> -</ul> - -<h2>Description</h2> -Ogg Vorbis is a general purpose compressed audio format -for high quality (44.1-48.0kHz, 16+ bit, polyphonic) audio and music -at moderate fixed and variable bitrates (40-80 kb/s/channel). This -places Vorbis in the same class as audio representations including -MPEG-1 audio layer 3, MPEG-4 audio (AAC and TwinVQ), and PAC.<p> - -Vorbis is the first of a planned family of Ogg multimedia coding -formats being developed as part of Xiphophorus's Ogg multimedia -project. See <a href="http://www.xiph.org/">http://www.xiph.org/</a> -for more information. - -<h2>Vorbis technical documents</h2> - -A Vorbis encoder takes in overlapping (but contiguous) short-time -segments of audio data. The encoder analyzes the content of the audio -to determine an optimal compact representation; this phase of encoding -is known as <em>analysis</em>. For each short-time block of sound, -the encoder then packs an efficient representation of the signal, as -determined by analysis, into a raw packet much smaller than the size -required by the original signal; this phase is <em>coding</em>. -Lastly, in a streaming environment, the raw packets are then -structured into a continuous stream of octets; this last phase is -<em>streaming</em>. Note that the stream of octets is referred to both -as a 'byte-' and 'bit-'stream; the latter usage is acceptible as the -stream of octets is a physical representation of a true logical -bit-by-bit stream.<p> - -A Vorbis decoder performs a mirror image process of extracting the -original sequence of raw packets from an Ogg stream (<em>stream -decomposition</em>), reconstructing the signal representation from the -raw data in the packet (<em>decoding</em>) and them reconstituting an -audio signal from the decoded representation (<em>synthesis</em>).<p> - -The <a href="programming.html">Programming with libvorbis</a> -documents discuss use of the reference Vorbis codec library -(libvorbis) produced by Xiphophorus.<p> - -The data representations and algorithms necessary at each step to -encode and decode Ogg Vorbis bitstreams are described by the below -documents in sufficient detail to construct a complete Vorbis codec. -Note that at the time of writing, Vorbis is still in a 'Request For -Comments' stage of development; despite being in advanced stages of -development, input from the multimedia community is welcome.<p> - -<h3>Vorbis analysis and synthesis</h3> - -Analysis begins by seperating an input audio stream into individual, -overlapping short-time segments of audio data. These segments are -then transformed into an alternate representation, seeking to -represent the original signal in a more efficient form that codes into -a smaller number of bytes. The analysis and transformation stage is -the most complex element of producing a Vorbis bitstream.<p> - -The corresponding synthesis step in the decoder is simpler; there is -no analysis to perform, merely a mechanical, deterministic -reconstruction of the original audio data from the transform-domain -representation.<p> - -<ul> -<li><a href="packet.html">Vorbis packet structure</a>: Describes the basic analysis components necessary to produce Vorbis packets and the structure of the packet itself. -<li><a href="envelope.html">Temporal envelope shaping and blocksize</a>: Use of temporal envelope shaping and variable blocksize to minimize time-domain energy leakage during wide dynamic range and spectral energy swings. Also discusses time-related principles of psychoacoustics. -<li><a href="mdct.html">Time domain segmentation and MDCT transform</a>: Division of time domain data into individual overlapped, windowed short-time vectors and transformation using the MDCT -<li><a href="resolution.html">The resolution floor</a>: Use of frequency doamin psychoacoustics, and the MDCT-domain noise, masking and resolution floors -<li><a href="residuals.html">MDCT-domain fine structure</a>: Production, quantization and massaging of MDCT-spectrum fine structure -</ul> - -<h3>Vorbis coding and decoding</h3> - -Coding and decoding converts the transform-domain representation of -the original audio produced by analysis to and from a bitwise packed -raw data packet. Coding and decoding consist of two logically -orthogonal concepts, <em>back-end coding</em> and <em>bitpacking</em>.<p> - -<em>Back-end coding</em> uses a probability model to represent the raw numbers -of the audio representation in as few physical bits as possible; -familiar examples of back-end coding include Huffman coding and Vector -Quantization.<p> - -<em>Bitpacking</em> arranges the variable sized words of the back-end -coding into a vector of octets without wasting space. The octets -produced by coding a single short-time audio segment is one raw Vorbis -packet.<p> - -<ul> - -<li><a href="probmodel.html">The Vorbis probability model</a> - -<li><a href="bitpack.html">The Vorbis bitpacker</a>: Arrangement of -variable bit-length words into an octet-aligned packet. - -</ul> - -<h3>Vorbis streaming and stream decomposition</h3> - -Vorbis packets contain the raw, bitwise-compressed representation of a -snippet of audio. These packets contain no structure and cannot be -strung together directly into a stream; for streamed transmission and -storage, Vorbis packets are encoded into an Ogg bitstream.<p> - -<ul> - -<li><a href="oggstream.html">Ogg bitstream overview</a>: High-level -description of Ogg logical bitstreams, how logical bitstreams -(of mixed media types) can be combined into physical bitstreams, and -restrictions on logical-to-physical mapping. Note that this document is -not specific only to Ogg Vorbis. - -<li><a href="framing.html">Ogg logical bitstream and framing -spec</a>: Low level, complete specification of Ogg logical -bitstream pages. Note that this document is not specific only to Ogg -Vorbis. - -<li><a href="vorbis-stream.html">Vorbis bitstream mapping</a>: -Specifically describes mapping Vorbis data into an -Ogg physical bitstream. - -</ul> - - -<hr> -<a href="http://www.xiph.org/"> -<img src="white-xifish.png" align=left border=0> -</a> -<font size=-2 color=#505050> - -Ogg is a <a href="http://www.xiph.org">Xiphophorus</a> effort to -protect essential tenets of Internet multimedia from corporate -hostage-taking; Open Source is the net's greatest tool to keep -everyone honest. See <a href="http://www.xiph.org/about.html">About -Xiphophorus</a> for details. -<p> - -Ogg Vorbis is the first Ogg audio CODEC. Anyone may -freely use and distribute the Ogg and Vorbis specification, -whether in a private, public or corporate capacity. However, -Xiphophorus and the Ogg project (xiph.org) reserve the right to set -the Ogg/Vorbis specification and certify specification compliance.<p> - -Xiphophorus's Vorbis software CODEC implementation is distributed -under the Lesser/Library GNU Public License. This does not restrict -third parties from distributing independent implementations of Vorbis -software under other licenses.<p> - -OggSquish, Vorbis, Xiphophorus and their logos are trademarks (tm) of -<a href="http://www.xiph.org/">Xiphophorus</a>. These pages are -copyright (C) 1994-2000 Xiphophorus. All rights reserved.<p> - -</body> - - - - - - diff --git a/doc/vorbisenc/.cvsignore b/doc/vorbisenc/.cvsignore deleted file mode 100644 index 282522db..00000000 --- a/doc/vorbisenc/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/vorbisenc/Makefile.am b/doc/vorbisenc/Makefile.am deleted file mode 100644 index 3eca0bbb..00000000 --- a/doc/vorbisenc/Makefile.am +++ /dev/null @@ -1,10 +0,0 @@ -## Process this file with automake to produce Makefile.in - -AUTOMAKE_OPTIONS = foreign - -docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/vorbisenc - -doc_DATA = index.html overview.html reference.html style.css\ - vorbis_encode_ctl.html vorbis_encode_init.html vorbis_info.html - -EXTRA_DIST = $(doc_DATA) diff --git a/doc/vorbisenc/index.html b/doc/vorbisenc/index.html deleted file mode 100644 index 57903d66..00000000 --- a/doc/vorbisenc/index.html +++ /dev/null @@ -1,38 +0,0 @@ -<html> - -<head> -<title>libvorbisenc - Documentation</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td> -</tr> -</table> - -<h1>Libvorbisenc Documentation</h1> - -<p> -Libvorbisenc is a convenient API for setting up an encoding environment using libvorbis. Libvorbisenc encapsulates the actions needed to set up the encoder properly. -<p> -<a href="overview.html">libvorbisenc api overview</a><br> -<a href="reference.html">libvorbisenc api reference</a><br> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisenc/overview.html b/doc/vorbisenc/overview.html deleted file mode 100644 index 1be1ea26..00000000 --- a/doc/vorbisenc/overview.html +++ /dev/null @@ -1,53 +0,0 @@ -<html> - -<head> -<title>libvorbisenc - API Overview</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td> -</tr> -</table> - -<h1>Libvorbisenc API Overview</h1> -
-<p>The current version of libvorbisenc is very simple. It contains an initialization function to set up the encoding engine properly.
-It also contains a control function to be used in the future to tweak encoder settings.
-<p> -All the <b>libvorbisenc</b> routines are declared in "vorbis/vorbisenc.h". - -<p> -<table border=1 color=black width=50% cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td><b>function</b></td> - <td><b>purpose</b></td> -</tr> -<tr valign=top> - <td><a href="vorbis_encode_init.html">vorbis_encode_init</a></td> - <td>This function takes a <a href="vorbis_info.html">vorbis_info</a> struct and encoding parameters and sets up a proper encoding environment.</tt></a>.</td> -</tr>
-<tr valign=top> - <td><a href="vorbis_encode_ctl.html">vorbis_encode_ctl</a></td> - <td>Function in progress, to be used in future versions of this API.</td> -</tr> -</table> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisenc/reference.html b/doc/vorbisenc/reference.html deleted file mode 100644 index 0649e22f..00000000 --- a/doc/vorbisenc/reference.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - -<head> -<title>Vorbisfile API Reference</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Vorbisfile API Reference</h1> - -<p> -<b>Data Structures</b><br> -<a href="OggVorbis_File.html">OggVorbis_File</a><br> -<a href="vorbis_comment.html">vorbis_comment</a><br> -<a href="vorbis_info.html">vorbis_info</a><br> -<a href="ov_callbacks.html">ov_callbacks</a><br> -<br> -<b>Setup/Teardown</b><br> -<a href="ov_open.html">ov_open()</a><br> -<a href="ov_open_callbacks.html">ov_open_callbacks()</a><br> -<a href="ov_clear.html">ov_clear()</a><br> -<br> -<b>Decoding</b><br> -<a href="ov_read.html">ov_read()</a><br> -<br> -<b>Seeking</b><br> -<a href="ov_raw_seek.html">ov_raw_seek()</a><br> -<a href="ov_pcm_seek.html">ov_pcm_seek()</a><br> -<a href="ov_time_seek.html">ov_time_seek()</a><br> -<br> -<b>File Information</b><br> -<a href="ov_bitrate.html">ov_bitrate()</a><br> -<a href="ov_bitrate_instant.html">ov_bitrate_instant()</a><br> -<a href="ov_streams.html">ov_streams()</a><br> -<a href="ov_seekable.html">ov_seekable()</a><br> -<a href="ov_serialnumber.html">ov_serialnumber()</a><br> -<a href="ov_raw_total.html">ov_raw_total()</a><br> -<a href="ov_pcm_total.html">ov_pcm_total()</a><br> -<a href="ov_time_total.html">ov_time_total()</a><br> -<a href="ov_raw_tell.html">ov_raw_tell()</a><br> -<a href="ov_pcm_tell.html">ov_pcm_tell()</a><br> -<a href="ov_time_tell.html">ov_time_tell()</a><br> -<a href="ov_info.html">ov_info()</a><br> -<a href="ov_comment.html">ov_comment()</a><br> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisenc/style.css b/doc/vorbisenc/style.css deleted file mode 100644 index 332f809e..00000000 --- a/doc/vorbisenc/style.css +++ /dev/null @@ -1,7 +0,0 @@ -BODY { font-family: helvetica, sans-serif } -TD { font-family: helvetica, sans-serif } -P { font-family: helvetica, sans-serif } -H1 { font-family: helvetica, sans-serif } -H2 { font-family: helvetica, sans-serif } -H4 { font-family: helvetica, sans-serif } -P.tiny { font-size: 8pt } diff --git a/doc/vorbisenc/vorbis_encode_ctl.html b/doc/vorbisenc/vorbis_encode_ctl.html deleted file mode 100644 index 1ad98f49..00000000 --- a/doc/vorbisenc/vorbis_encode_ctl.html +++ /dev/null @@ -1,67 +0,0 @@ -<html> - -<head> -<title>libvorbisenc - function - vorbis_encode_ctl</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td> -</tr> -</table> - -<h1>vorbis_encode_ctl</h1> - -<p><i>declared in "vorbis/libvorbisenc.h";</i></p> - -<p>This function is part of the libvorbisenc API, but has not yet been implemented. -<p>However, the API call is set and will not change. -<p> -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_encode_ctl(vorbis_info *vi,int number,void *arg);
- -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
-<dt><i>number</i></dt>
-<dd>Not yet implemented.</dd>
-<dt><i>arg</i></dt>
-<dd>Not yet implemented.</dd> - - -<h3>Return Values</h3> -<blockquote> -<li>
-<li>OV_EIMPL is always returned, as this function has not yet been implemented.</li>
-</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 xiph.org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001106</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisenc/vorbis_encode_init.html b/doc/vorbisenc/vorbis_encode_init.html deleted file mode 100644 index 4cd5e5cb..00000000 --- a/doc/vorbisenc/vorbis_encode_init.html +++ /dev/null @@ -1,86 +0,0 @@ -<html> - -<head> -<title>libvorbisenc - function - vorbis_encode_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td> -</tr> -</table> - -<h1>vorbis_encode_init</h1> - -<p><i>declared in "vorbis/libvorbisenc.h";</i></p> - -<p>This is the primary function within libvorbisenc. This is used to properly set up an encoding environment using libvorbisenc.
-<p>Before this function is called, the <a href="vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called. -<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up. -<p> -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_encode_init(<a href="vorbis_info.html">vorbis_info</a> *vi,
- long channels,
- long rate,
-
- long max_bitrate,
- long nominal_bitrate,
- long min_bitrate);
- -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd> -<dt><i>channels</i></dt> -<dd>The number of channels to be encoded.</dd> -<dt><i>rate</i></dt> -<dd>The sampling rate of the source audio.</dd> -<dt><i>max_bitrate</i></dt> -<dd>Desired maximum bitrate (limit).</dd>
-<dt><i>nominal_bitrate</i></dt> -<dd>Desired average, or central, bitrate.</dd>
-<dt><i>min_bitrate</i></dt> -<dd>Desired minimum bitrate.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li>less than zero for failure:</li>
-<ul>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li> -</ul>
-</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 xiph.org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbisenc documentation</p></td> -<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001106</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisenc/vorbis_info.html b/doc/vorbisenc/vorbis_info.html deleted file mode 100644 index 2e824099..00000000 --- a/doc/vorbisenc/vorbis_info.html +++ /dev/null @@ -1,102 +0,0 @@ -<html> - -<head> -<title>vorbis - datatype - vorbis_info</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>vorbis_info</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_info structure contains information about a vorbis bitstream. Most of the information in this struct is more complex and in-depth than we need when using basic API calls. - -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_info{ - int version; - int channels; - long rate; - - long bitrate_upper; - long bitrate_nominal; - long bitrate_lower; - - long blocksizes[2]; - - int modes; - int maps; - int times; - int floors; - int residues; - int books; - int psys; /* encode only */ - - vorbis_info_mode *mode_param[64]; - int map_type[64]; - vorbis_info_mapping *map_param[64]; - int time_type[64]; - vorbis_info_time *time_param[64]; - int floor_type[64]; - vorbis_info_floor *floor_param[64]; - int residue_type[64]; - vorbis_info_residue *residue_param[64]; - static_codebook *book_param[256]; - vorbis_info_psy *psy_param[64]; /* encode only */ - - /* for block long/sort tuning; encode only */ - int envelopesa; - double preecho_thresh; - double preecho_clamp; - -} vorbis_info;</b></pre> - </td> -</tr> -</table> - -<h3>Relevant Struct Members</h3> -<dl> -<dt><i>version</i></dt> -<dd>Vorbis encoder version used to create this bitstream.</dd> -<dt><i>channels</i></dt> -<dd>Int signifying number of channels in bitstream.</dd> -<dt><i>rate</i></dt> -<dd>Sampling rate of the bitstream.</dd> -<dt><i>bitrate_upper</i></dt> -<dd>Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> -<dt><i>bitrate_nominal</i></dt> -<dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd> -<dt><i>bitrate_lower</i></dt> -<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> -<dt><i>blocksizes[2]</i></dt> -<dd>Contains the sizes of the long and short blocks for this particular bitstream. These are variable and can be set by the encoder. Vorbis only supports two sizes, long and short.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/.cvsignore b/doc/vorbisfile/.cvsignore deleted file mode 100644 index 282522db..00000000 --- a/doc/vorbisfile/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/vorbisfile/Makefile.am b/doc/vorbisfile/Makefile.am deleted file mode 100644 index 702543a8..00000000 --- a/doc/vorbisfile/Makefile.am +++ /dev/null @@ -1,19 +0,0 @@ -## Process this file with automake to produce Makefile.in - -AUTOMAKE_OPTIONS = foreign - -docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/vorbisfile - -doc_DATA = OggVorbis_File.html chaining_example_c.html chainingexample.html\ - datastructures.html decoding.html example.html exampleindex.html\ - fileinfo.html index.html initialization.html ov_bitrate.html\ - ov_bitrate_instant.html ov_callbacks.html ov_clear.html\ - ov_comment.html ov_info.html ov_open.html ov_open_callbacks.html\ - ov_pcm_seek.html ov_pcm_tell.html ov_pcm_total.html ov_raw_seek.html\ - ov_raw_tell.html ov_raw_total.html ov_read.html ov_seekable.html\ - ov_serialnumber.html ov_streams.html ov_time_seek.html\ - ov_time_tell.html ov_time_total.html overview.html reference.html\ - seekexample.html seeking.html seeking_test_c.html seekingexample.html\ - style.css vorbis_comment.html vorbis_info.html vorbisfile_example_c.html - -EXTRA_DIST = $(doc_DATA) diff --git a/doc/vorbisfile/OggVorbis_File.html b/doc/vorbisfile/OggVorbis_File.html deleted file mode 100644 index 6748deef..00000000 --- a/doc/vorbisfile/OggVorbis_File.html +++ /dev/null @@ -1,105 +0,0 @@ -<html> - -<head> -<title>vorbisfile - datatype - OggVorbis_File</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>OggVorbis_File</h1> - -<p><i>declared in "vorbis/vorbisfile.h"</i></p> - -<p> -The OggVorbis_File structure defines an Ogg Vorbis file. -<p> -This structure is used in all vorbisfile routines. Before it can be used, it must be initialized by <a href="ov_open.html">ov_open</a> or <a href="ov_open_callbacks.html">ov_open_callbacks</a>. -<p> -After use, the OggVorbis_File structure must be deallocated with a call to <a href="ov_clear.html">ov_clear()</a>.
-<p>Once a file or data source is passed to libvorbisfile, it is owned by vorbisfile. The file should not be used by any other applications or functions outside the Vorbisfile API. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct { - void *datasource; /* Pointer to a FILE *, etc. */ - int seekable; - int64_t offset; - int64_t end; - ogg_sync_state oy; - - /* If the FILE handle isn't seekable (eg, a pipe), only the current - stream appears */ - int links; - int64_t *offsets; - int64_t *dataoffsets; - long *serialnos; - int64_t *pcmlengths; - vorbis_info *vi; - vorbis_comment *vc; - - /* Decoding working state local storage */ - int64_t pcm_offset; - int decode_ready; - long current_serialno; - int current_link; - - double bittrack; - double samptrack; - - ogg_stream_state os; /* take physical pages, weld into a logical - stream of packets */ - vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */ - vorbis_block vb; /* local working space for packet->PCM decode */ - - <a href="ov_callbacks.html">ov_callbacks</a> callbacks; - -} OggVorbis_File;</b></pre> - </td> -</tr> -</table> - -<h3>Relevant Struct Members</h3> -<dl> -<dt><i>datasource</i></dt> -<dd>Pointer to file or other ogg source.</dd> -<dt><i>seekable</i></dt> -<dd>Read-only int indicating whether file is seekable, i.e., physical file is seekable, a pipe isn't.</dd> -<dt><i>links</i></dt> -<dd>Read-only int indicating the number of logical bitstreams within the physical bitstream.</dd>
-<dt><i>ov_callbacks</i></dt>
-<dd>Collection of file manipulation routines to be used on this data source.</dd> -</dl> - -<h3>Notes</h3> - -<p>If your system's <tt><sys/types.h></tt> does not -define <tt>int64_t,</tt> you will need to define this as a 64-bit type -inside your system's project file/Makefile, etc. On win32, for example, -this should be defined as <tt>__int64</tt>. On the Unix platform, these -are usually defined properly in the system header files. -<p> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/chaining_example_c.html b/doc/vorbisfile/chaining_example_c.html deleted file mode 100644 index 6131693a..00000000 --- a/doc/vorbisfile/chaining_example_c.html +++ /dev/null @@ -1,86 +0,0 @@ -<html> - -<head> -<title>vorbisfile - chaining_example.c</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>chaining_example.c</h1> - -<p> -The example program source: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - -#include <vorbis/codec.h>
-#include <vorbis/vorbisfile.h>
-
-int main(){
- OggVorbis_File ov;
- int i;
-
- /* open the file/pipe on stdin */
- if(ov_open(stdin,&ov,NULL,-1)<0){
- printf("Could not open input as an OggVorbis file.\n\n");
- exit(1);
- }
-
- /* print details about each logical bitstream in the input */
- if(ov_seekable(&ov)){
- printf("Input bitstream contained %ld logical bitstream section(s).\n",
- ov_streams(&ov));
- printf("Total bitstream playing time: %ld seconds\n\n",
- (long)ov_time_total(&ov,-1));
-
- }else{
- printf("Standard input was not seekable.\n"
- "First logical bitstream information:\n\n");
- }
-
- for(i=0;i<ov_streams(&ov);i++){
- vorbis_info *vi=ov_info(&ov,i);
- printf("\tlogical bitstream section %d information:\n",i+1);
- printf("\t\t%ldHz %d channels bitrate %ldkbps serial number=%ld\n",
- vi->rate,vi->channels,ov_bitrate(&ov,i)/1000,
- ov_serialnumber(&ov,i));
- printf("\t\tcompressed length: %ld bytes ",(long)(ov_raw_total(&ov,i)));
- printf(" play time: %lds\n",(long)ov_time_total(&ov,i));
- }
-
- ov_clear(&ov);
- return 0;
-}
- -</b></pre> - </td> -</tr> -</table> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/chainingexample.html b/doc/vorbisfile/chainingexample.html deleted file mode 100644 index f7c251b5..00000000 --- a/doc/vorbisfile/chainingexample.html +++ /dev/null @@ -1,158 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Example Code</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Chaining Example Code</h1> - -<p> -The following is a run-through of the chaining example program supplied -with vorbisfile - <a href="chaining_example_c.html">chaining_example.c</a>. -This program demonstrates how to work with a chained bitstream. - -<p> -First, relevant headers, including vorbis-specific "codec.h" and "vorbisfile.h" have to be included. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -#include "../lib/misc.h" -</b></pre> - </td> -</tr> -</table> - -<p>Inside main(), we declare our primary OggVorbis_File structure. We also declare a other helpful variables to track our progress within the file. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int main(){ - OggVorbis_File ov; - int i; -</b></pre> - </td> -</tr> -</table> - -<p><a href="ov_open.html">ov_open()</a> must be -called to initialize the <a href="OggVorbis_File.html">OggVorbis_File</a> structure with default values. -<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - if(ov_open(stdin,&ov,NULL,-1)<0){
- printf("Could not open input as an OggVorbis file.\n\n"); - exit(1); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -First we check to make sure the stream is seekable using <a href="ov_seekable.html">ov_seekable</a>. - -<p>Then we're going to find the number of logical bitstreams in the physical bitstream using <a href="ov_streams.html">ov_streams</a>. - -<p>We use <a href="ov_time_total.html">ov_time_total</a> to determine the total length of the physical bitstream. We specify that we want the entire bitstream by using the argument <tt>-1</tt>. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - if(ov_seekable(&ov)){ - printf("Input bitstream contained %ld logical bitstream section(s).\n", - ov_streams(&ov)); - printf("Total bitstream playing time: %ld seconds\n\n", - (long)ov_time_total(&ov,-1)); - - }else{ - printf("Standard input was not seekable.\n" - "First logical bitstream information:\n\n"); - } - -</b></pre> - </td> -</tr> -</table> - -<p>Now we're going to iterate through each logical bitstream and print information about that bitstream. - -<p>We use <a href="ov_info.html">ov_info</a> to pull out the <a href="vorbis_info.html">vorbis_info</a> struct for each logical bitstream. This struct contains bitstream-specific info. - -<p><a href="ov_serialnumber.html">ov_serialnumber</a> retrieves the unique serial number for the logical bistream. <a href="ov_raw_total.html">ov_raw_total</a> gives the total compressed bytes for the logical bitstream, and <a href="ov_time_total.html">ov_time_total</a> gives the total time in the logical bitstream. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - for(i=0;i<ov_streams(&ov);i++){ - vorbis_info *vi=ov_info(&ov,i); - printf("\tlogical bitstream section %d information:\n",i+1); - printf("\t\t%ldHz %d channels bitrate %ldkbps serial number=%ld\n", - vi->rate,vi->channels,ov_bitrate(&ov,i)/1000, - ov_serialnumber(&ov,i)); - printf("\t\tcompressed length: %ld bytes ",(long)(ov_raw_total(&ov,i))); - printf(" play time: %lds\n",(long)ov_time_total(&ov,i)); - } -</b></pre> - </td> -</tr> -</table> -<p> -When we're done with the entire physical bitstream, we need to call <a href="ov_clear.html">ov_clear()</a> to release the bitstream. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - ov_clear(&ov); - return 0; -} -</b></pre> - </td> -</tr> -</table> - -<p> -The full source for chaining_example.c can be found with the vorbis -distribution in <a href="chaining_example_c.html">chaining_example.c</a>. - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/datastructures.html b/doc/vorbisfile/datastructures.html deleted file mode 100644 index 955b9c7f..00000000 --- a/doc/vorbisfile/datastructures.html +++ /dev/null @@ -1,63 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Base Data Structures</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Base Data Structures</h1> -<p>There are several data structures used to hold file and bitstream information during vorbisfile decoding. -<p> -All the <b>vorbisfile</b> specific data structures are declared in "vorbis/vorbisfile.h" or "vorbis/codec.h". -<p>
-<p>When using vorbisfile, we usually won't need to know about most of the contents of these data structures, but it may be helpful to understand what they contain.
-<br><br> - -<table border=1 color=black width=50% cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td><b>datatype</b></td> - <td><b>purpose</b></td> -</tr> -<tr valign=top> - <td><a href="OggVorbis_File.html">OggVorbis_File</a></td> - <td>This structure represents the basic file information. It contains - a pointer to the physical file or bitstream and various information about that bitstream.</td> -</tr> -<tr valign=top> -<td><a href="vorbis_comment.html">vorbis_comment</a></td> - <td>This structure contains the file comments. It contains - a pointer to unlimited user comments, information about the number of comments, and a vendor description.</td> -</tr> -<tr valign=top> -<td><a href="vorbis_info.html">vorbis_info</a></td> - <td>This structure contains encoder-related information about the bitstream. It includes encoder info, channel info, and bitrate limits.</td> -</tr> -<tr valign=top> -<td><a href="ov_callbacks.html">ov_callbacks</a></td> - <td>This structure contains pointers to file manipulation routines. Can be user-specified for use with <a href="ov_open_callbacks.html">ov_open_callbacks()</a>.</td> -</tr> -</table> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/decoding.html b/doc/vorbisfile/decoding.html deleted file mode 100644 index bc35fd77..00000000 --- a/doc/vorbisfile/decoding.html +++ /dev/null @@ -1,50 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Decoding</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Decoding</h1> - -<p> -All the <b>vorbisfile</b> decoding routines are declared in "vorbis/vorbisfile.h". -<p> - -<table border=1 color=black width=50% cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td><b>function</b></td> - <td><b>purpose</b></td> -</tr> -<tr valign=top> - <td><a href="ov_read.html">ov_read</a></td> - <td>This function makes up the main chunk of a decode loop. It takes an -OggVorbis_File structure, which must have been initialized by a previous -call to <a href="ov_open.html"><tt>ov_open()</tt></a>.</td> -</tr> -</table> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 Xiphophorus</p></td> -<td align=right><p class=tiny><a href="http://www.vorbis.org/">www.vorbis.org</a><br><a href="mailto:team@icecast.org">team@icecast.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/example.html b/doc/vorbisfile/example.html deleted file mode 100644 index d0574849..00000000 --- a/doc/vorbisfile/example.html +++ /dev/null @@ -1,205 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Example Code</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Example Code</h1> - -<p> -The following is a run-through of the decoding example program supplied -with vorbisfile - <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>. -This program takes a vorbis bitstream from stdin and writes raw pcm to stdout. - -<p> -First, relevant headers, including vorbis-specific "codec.h" and "vorbisfile.h" have to be included. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#include <stdio.h> -#include <stdlib.h> -#include <math.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -</b></pre> - </td> -</tr> -</table> -<p> -We also have to make a concession to Windows users here. If we are using windows for decoding, we must declare these libraries so that we can set stdin/stdout to binary. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#ifdef _WIN32 -#include <io.h> -#include <fcntl.h> -#endif -</b></pre> - </td> -</tr> -</table> -<p> -Next, a buffer for the pcm audio output is declared. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -char pcmout[4096]; -</b></pre> - </td> -</tr> -</table> - -<p>Inside main(), we declare our primary OggVorbis_File structure. We also declare a few other helpful variables to track out progress within the file. -Also, we make our final concession to Windows users by setting the stdin and stdout to binary mode. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int main(int argc, char **argv){ - OggVorbis_File vf; - int eof=0; - int current_section; - -#ifdef _WIN32 - _setmode( _fileno( stdin ), _O_BINARY ); - _setmode( _fileno( stdout ), _O_BINARY ); -#endif -</b></pre> - </td> -</tr> -</table> - -<p><a href="ov_open.html">ov_open()</a> must be -called to initialize the <b>OggVorbis_File</b> structure with default values. -<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - if(ov_open(stdin, &vf, NULL, 0) < 0) { - fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n"); - exit(1); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -We're going to pull the channel and bitrate info from the file using <a href="ov_info.html">ov_info()</a> and show them to the user. -We also want to pull out and show the user a comment attached to the file using <a href="ov_comment.html">ov_comment()</a>. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - { - char **ptr=ov_comment(&vf,-1)->user_comments; - vorbis_info *vi=ov_info(&vf,-1); - while(*ptr){ - fprintf(stderr,"%s\n",*ptr); - ++ptr; - } - fprintf(stderr,"\nBitstream is %d channel, %ldHz\n",vi->channels,vi->rate); - fprintf(stderr,"Encoded by: %s\n\n",ov_comment(&vf,-1)->vendor); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -Here's the read loop: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - - while(!eof){
- long ret=ov_read(&vf,pcmout,sizeof(pcmout),0,2,1,¤t_section);
- if (ret == 0) {
- /* EOF */
- eof=1;
- } else if (ret < 0) {
- /* error in the stream. Not a problem, just reporting it in
- case we (the app) cares. In this case, we don't. */
- } else {
- /* we don't bother dealing with sample rate changes, etc, but
- you'll have to*/
- fwrite(pcmout,1,ret,stdout);
- }
- }
- - -</b></pre> - </td> -</tr> -</table> - -<p> -The code is reading blocks of data using <a href="ov_read.html">ov_read()</a>. -Based on the value returned, we know if we're at the end of the file or have invalid data. If we have valid data, we write it to the pcm output. - -<p> -Now that we've finished playing, we can pack up and go home. It's important to call <a href="ov_clear.html">ov_clear()</a> when we're finished. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - - ov_clear(&vf); - - fprintf(stderr,"Done.\n"); - return(0); -} -</b></pre> - </td> -</tr> -</table> - -<p> -The full source for vorbisfile_example.c can be found with the vorbis -distribution in <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>. - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/exampleindex.html b/doc/vorbisfile/exampleindex.html deleted file mode 100644 index 1575e273..00000000 --- a/doc/vorbisfile/exampleindex.html +++ /dev/null @@ -1,39 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Documentation</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>VorbisFile Example Code</h1> - -<p> -Three sample programs are included with the vorbisfile distribution. -<p> -<a href="example.html">vorbisfile decoding</a><br> -<a href="seekexample.html">vorbisfile seeking</a><br> -<a href="chainingexample.html">vorbisfile bitstream chaining</a><br> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/fileinfo.html b/doc/vorbisfile/fileinfo.html deleted file mode 100644 index 27f6370e..00000000 --- a/doc/vorbisfile/fileinfo.html +++ /dev/null @@ -1,96 +0,0 @@ -<html>
-
-<head>
-<title>vorbisfile - File Information</title>
-<link rel=stylesheet href="style.css" type="text/css">
-</head>
-
-<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
-<table border=0 width=100%>
-<tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-<h1>File Information</h1>
-<p>Vorbisfile contains many functions to get information about bitstream attributes and decoding status.
-<p>
-All the <b>vorbisfile</b> file information routines are declared in "vorbis/vorbisfile.h".
-<p>
-
-<table border=1 color=black width=50% cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
- <td><b>function</b></td>
- <td><b>purpose</b></td>
-</tr>
-<tr valign=top>
- <td><a href="ov_bitrate.html">ov_bitrate</a></td>
- <td>Returns the average bitrate of the current logical bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_bitrate_instant.html">ov_bitrate_instant</a></td>
- <td>Returns the exact bitrate since the last call of this function, or -1 if beginning of the bitream or no new info is available.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_streams.html">ov_streams</a></td>
- <td>Gives the number of logical bitstreams within the current physical bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_seekable.html">ov_seekable</a></td>
- <td>Indicates whether the bitstream is seekable.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_serialnumber.html">ov_serialnumber</a></td>
- <td>Returns the unique serial number of the specified logical bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_raw_total.html">ov_raw_total</a></td>
- <td>Returns the total (compressed) bytes in a physical or logical seekable bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_pcm_total.html">ov_pcm_total</a></td>
- <td>Returns the total number of samples in a physical or logical seekable bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_time_total.html">ov_time_total</a></td>
- <td>Returns the total time length in seconds of a physical or logical seekable bitstream.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_raw_tell.html">ov_raw_tell</a></td>
- <td>Returns the byte location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_pcm_tell.html">ov_pcm_tell</a></td>
- <td>Returns the sample location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_time_tell.html">ov_time_tell</a></td>
- <td>Returns the time location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_info.html">ov_info</a></td>
- <td>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for a specific bitstream section.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_comment.html">ov_comment</a></td>
- <td>Returns attached <a href="vorbis_comment.html">comments</a> for the current bitstream.</td>
-</tr>
-</table>
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright © 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
-</tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-
-</body>
-
-</html>
diff --git a/doc/vorbisfile/index.html b/doc/vorbisfile/index.html deleted file mode 100644 index 102636a4..00000000 --- a/doc/vorbisfile/index.html +++ /dev/null @@ -1,42 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Documentation</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>VorbisFile Documentation</h1> - -<p> -VorbisFile is a stdio-based convenience library for decoding vorbis bitstreams. -It is the simplest and quickest way to go from file to raw PCM audio samples--if -your decoder doesn't need to read from anything other than a file, use -this. This document explains how to use the vorbisfile API in detail. -<p> -<a href="overview.html">vorbisfile api overview</a><br> -<a href="exampleindex.html">vorbisfile example code</a><br> -<a href="reference.html">vorbisfile api reference</a><br> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/initialization.html b/doc/vorbisfile/initialization.html deleted file mode 100644 index be09f651..00000000 --- a/doc/vorbisfile/initialization.html +++ /dev/null @@ -1,56 +0,0 @@ -<html> - -<head> -<title>libvorbisfile - Setup/Teardown</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Setup/Teardown</h1> -<p>In order to decode audio using libvorbisfile, a bitstream containing vorbis audio must be properly initialized and cleared when decoding is finished. -<p> -All the <b>vorbisfile</b> initialization and deallocation routines are declared in "vorbis/vorbisfile.h". -<p> - -<table border=1 color=black width=50% cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td><b>function</b></td> - <td><b>purpose</b></td> -</tr> -<tr valign=top> - <td><a href="ov_open.html">ov_open</a></td> - <td>Initializes the Ogg Vorbis bitstream with a pointer to a bitstream and default values. This must be called before other functions in the library may be - used.</td> -</tr> -<tr valign=top> - <td><a href="ov_open_callbacks.html">ov_open_callbacks</a></td> - <td>Initializes the Ogg Vorbis bitstream with a pointer to a bitstream, default values, and custom file/bitstream manipulation routines. Used instead of <a href="ov_open.html">ov_open</a> when working with a data source other than a file.</td> -</tr> -<tr valign=top> - <td><a href="ov_clear.html">ov_clear</a></td> - <td>Closes the bitstream and cleans up loose ends. Must be called when we're done with the bitstream.</td> -</tr> -</table> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/ov_bitrate.html b/doc/vorbisfile/ov_bitrate.html deleted file mode 100644 index ad402615..00000000 --- a/doc/vorbisfile/ov_bitrate.html +++ /dev/null @@ -1,73 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_bitrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_bitrate</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>This function returns the average bitrate for the specified logical bitstream. This may be different from the <a href=ov_info.html>ov_info->nominal_bitrate</a> value, as it is based on the actual average for this bitstream if the file is seekable.
-<p>Nonseekable files will return the nominal bitrate setting or the average of the upper and lower bounds, if any of these values are set. -<p> - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_bitrate(OggVorbis_File *vf,int i); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>i</i></dt> -<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the bitrate for the entire bitstream, this parameter should be set to -1.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>OV_EINVAL indicates that an invalid argument value was submitted.</li>
-<li>OV_FALSE means the call returned a 'false' status, which in this case most likely indicates that the file is nonseekable and the upper, lower, and nominal bitrates were unset. -<li><i>n</i> indicates the bitrate for the given logical bitstream or the entire - physical bitstream. If the file is open for random (seekable) access, it will - find the *actual* average bitrate. If the file is streaming (nonseekable), it - returns the nominal bitrate (if set) or else the average of the - upper/lower bounds (if set).</li> -</blockquote> -<p> - -<br> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_bitrate_instant.html b/doc/vorbisfile/ov_bitrate_instant.html deleted file mode 100644 index 7f53b701..00000000 --- a/doc/vorbisfile/ov_bitrate_instant.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_bitrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_bitrate_instant</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Used to find the most recent bitrate played back within the file. Will return 0 if the bitrate has not changed or it is the beginning of the file. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_bitrate_instant(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 indicates the beginning of the file or unchanged bitrate info.</li> -<li><i>n</i> indicates the actual bitrate since the last call.</li>
-<li>OV_FALSE indicates that the call returned a 'false' status. In this case, this error code is returned if playback is not in progress, and thus there is no instantaneous bitrate information to report.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_callbacks.html b/doc/vorbisfile/ov_callbacks.html deleted file mode 100644 index 9d73c68e..00000000 --- a/doc/vorbisfile/ov_callbacks.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - -<head> -<title>vorbisfile - datatype - ov_callbacks</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_callbacks</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The ov_callbacks structure contains file manipulation function prototypes necessary for opening, closing, seeking, and location. -<p> -The ov_callbacks structure does not need to be user-defined if you are working with a standard file. The typical <a href="ov_open.html">ov_open()</a> call will fill ov_callbacks for you. However, ov_callbacks should be defined if you are using other data sources. In this situation, use <a href="ov_open_callbacks.html">ov_open_callbacks()</a> instead of <a href="ov_open.html">ov_open()</a>. -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct { - size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource); - int (*seek_func) (void *datasource, int64_t offset, int whence); - int (*close_func) (void *datasource); - long (*tell_func) (void *datasource); -} ov_callbacks;</b></pre> - </td> -</tr> -</table> - -<h3>Relevant Struct Members</h3> -<dl> -<dt><i>read_func</i></dt> -<dd>Pointer to custom data reading function.</dd> -<dt><i>seek_func</i></dt> -<dd>Pointer to custom data seeking function.</dd> -<dt><i>close_func</i></dt> -<dd>Pointer to custom data source closure function.</dd> -<dt><i>tell_func</i></dt> -<dd>Pointer to custom data location function.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/ov_clear.html b/doc/vorbisfile/ov_clear.html deleted file mode 100644 index 81eb0ea0..00000000 --- a/doc/vorbisfile/ov_clear.html +++ /dev/null @@ -1,63 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_clear</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_clear</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p> After a bitstream has been opened using <a href="ov_open.html">ov_open</a> and decoding is complete, you must call <tt>ov_clear()</tt> to clear -the decoder's buffers and close the file for you. -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_clear(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> -</blockquote> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_comment.html b/doc/vorbisfile/ov_comment.html deleted file mode 100644 index 654fa981..00000000 --- a/doc/vorbisfile/ov_comment.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_bitrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_comment</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns a pointer to the <a href="vorbis_comment.html">vorbis_comment</a> struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream. -<p> - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -vorbis_comment *ov_comment(OggVorbis_File *vf,int link); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>i</i></dt> -<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_comment.html">vorbis_comment</a> struct for the current bitstream, this parameter should be set to -1.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>Returns the vorbis_comment struct for the specified bitstream.</li> -<li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_info.html b/doc/vorbisfile/ov_info.html deleted file mode 100644 index e410274a..00000000 --- a/doc/vorbisfile/ov_info.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_info</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_info</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for the specified bitstream. For nonseekable files, always returns the current vorbis_info struct. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -vorbis_info *ov_info(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,int link); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. <b></strong>Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</b></dd> -<dt><i>i</i></dt> -<dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>Returns the vorbis_info struct for the specified bitstream. Returns vorbis_info for current bitstream if the file is nonseekable or i=-1.</li> -<li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_open.html b/doc/vorbisfile/ov_open.html deleted file mode 100644 index 1a55527c..00000000 --- a/doc/vorbisfile/ov_open.html +++ /dev/null @@ -1,112 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_open</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_open</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>This is the main function used to open and initialize an OggVorbis_File -structure. It sets up all the related decoding structure. -<p>The first argument must be a file pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream). <tt>vf</tt> should be a pointer to the -OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <a href="OggVorbis_File.html">OggVorbis_File</a> -struct should be passed to all the vorbisfile functions. -<p>Also, you should be aware that ov_open(), once successful, takes complete possession of the file resource. After you have opened a file using ov_open(), you MUST close it using <a href="ov_clear.html">ov_clear()</a>, not fclose() or any other function. -<p> -It is often useful to call <tt>ov_open()</tt> -simply to determine whether a given file is a vorbis bitstream. If the -<tt>ov_open()</tt> -call fails, then the file is not recognizable as such. When you use <tt>ov_open() -</tt>for -this, you should <tt>fclose()</tt> the file pointer if, and only if, the -<tt>ov_open()</tt> -call fails. If it succeeds, you must call <a href="ov_clear.html">ov_clear()</a> to clear -the decoder's buffers and close the file for you. -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_open(FILE *f,<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,char *initial,long ibytes); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>f</i></dt> -<dd>File pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream).</dd> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</dd> -<dt><i>initial</i></dt> -<dd>Typically set to NULL. This parameter is useful if some data has already been -read from the file and the stream is not seekable. It is used in conjunction with <tt>ibytes</tt>. In this case, <tt>initial</tt> -should be a pointer to a buffer containing the data read.</dd> -<dt><i>ibytes</i></dt> -<dd>Typically set to 0. This parameter is useful if some data has already been -read from the file and the stream is not seekable. In this case, <tt>ibytes</tt> -should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li>less than zero for failure:</li>
-<ul> -<li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
-<li>OV_EVERSION - Vorbis version mismatch.</li>
-<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
-</ul> -</blockquote> -<p> - -<h3>Notes</h3> -<p>If your decoder is threaded, it is recommended that you NOT call -<tt>ov_open()</tt> -in the main control thread--instead, call <tt>ov_open()</tt> IN your decode/playback -thread. This is important because <tt>ov_open()</tt> may be a fairly time-consuming -call, given that the full structure of the file is determined at this point, -which may require reading large parts of the file under certain circumstances -(determining all the logical bitstreams in one physical bitstream, for -example). - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_open_callbacks.html b/doc/vorbisfile/ov_open_callbacks.html deleted file mode 100644 index 9ac61bda..00000000 --- a/doc/vorbisfile/ov_open_callbacks.html +++ /dev/null @@ -1,108 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_open_callbacks</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_open_callbacks</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>This is an alternative function used to open and initialize an OggVorbis_File -structure when using a data source other than a file. It allows you to specify custom file manipulation routines and sets up all the related decoding structure. -<p>Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions. -<p> -It is often useful to call <tt>ov_open_callbacks()</tt> -simply to determine whether a given file is a vorbis bitstream. If the -<tt>ov_open_callbacks()</tt> -call fails, then the file is not recognizable as such. When you use <tt>ov_open_callbacks() -</tt>for -this, you should <tt>fclose()</tt> the file pointer if, and only if, the -<tt>ov_open_callbacks()</tt> -call fails. If it succeeds, you must call <a href=ov_clear.html>ov_clear()</a> to clear -the decoder's buffers and close the file for you. -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_open_callbacks(void *datasource, <a href="OggVorbis_File.html">OggVorbis_File</a> *vf, char *initial, long ibytes, <a href="ov_callbacks.html">ov_callbacks</a> callbacks); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>f</i></dt> -<dd>File pointer to an already opened file -or pipe (it need not be seekable--though this obviously restricts what -can be done with the bitstream).</dd> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</dd> -<dt><i>initial</i></dt> -<dd>Typically set to NULL. This parameter is useful if some data has already been -read from the file and the stream is not seekable. It is used in conjunction with <tt>ibytes</tt>. In this case, <tt>initial</tt> -should be a pointer to a buffer containing the data read.</dd> -<dt><i>ibytes</i></dt> -<dd>Typically set to 0. This parameter is useful if some data has already been -read from the file and the stream is not seekable. In this case, <tt>ibytes</tt> -should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt>.</dd> -<dt><i>callbacks</i></dt> -<dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> -<li>less than zero for failure:</li>
-<ul> -<li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
-<li>OV_EVERSION - Vorbis version mismatch.</li>
-<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
-</ul> -</blockquote> -<p> - -<h3>Notes</h3> -<p>If your decoder is threaded, it is recommended that you NOT call -<tt>ov_open_callbacks()</tt> -in the main control thread--instead, call <tt>ov_open_callbacks()</tt> IN your decode/playback -thread. This is important because <tt>ov_open_callbacks()</tt> may be a fairly time-consuming -call, given that the full structure of the file is determined at this point, -which may require reading large parts of the file under certain circumstances -(determining all the logical bitstreams in one physical bitstream, for -example). - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_pcm_seek.html b/doc/vorbisfile/ov_pcm_seek.html deleted file mode 100644 index 43e50157..00000000 --- a/doc/vorbisfile/ov_pcm_seek.html +++ /dev/null @@ -1,82 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_bitrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_pcm_seek</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Seeks to the offset specified (in pcm samples) within the physical bitstream. This function only works for seekable streams. -<p>This also updates everything needed within the -decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from -the newly seeked to position. -<p> - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_pcm_seek(OggVorbis_File *vf,int64_t pos); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>pos</i></dt> -<dd>Position in pcm samples to seek to in the bitstream.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li> -nonzero indicates failure, described by several error codes:</li>
-<ul>
-<li>OV_ENOSEEK - Bitstream is not seekable.
-</li>
-<li>OV_EINVAL - Invalid argument value.
-</li>
-<li>OV_EREAD - A read from media returned an error.
-</li>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
- corruption.
-</li>
-<li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
-</li>
-</ul></blockquote> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_pcm_seek_page.html b/doc/vorbisfile/ov_pcm_seek_page.html deleted file mode 100644 index 1f97db86..00000000 --- a/doc/vorbisfile/ov_pcm_seek_page.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_pcm_seek_page</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_pcm_seek_page</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Seeks to the closest page preceding the specified location (in pcm samples) within the physical bitstream. This function only works for seekable streams.
-<p>This function is faster than <a href="ov_pcm_seek.html">ov_pcm_seek</a> because the function can begin decoding at a page boundary rather than seeking through any remaining samples before the specified location. However, it is less accurate. -<p>This also updates everything needed within the -decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from -the newly seeked to position. -<p> - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_pcm_seek(OggVorbis_File *vf,int64_t pos); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>pos</i></dt> -<dd>Position in pcm samples to seek to in the bitstream.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li> -nonzero indicates failure, described by several error codes:</li>
-<ul>
-<li>OV_ENOSEEK - Bitstream is not seekable.
-</li>
-<li>OV_EINVAL - Invalid argument value.
-</li>
-<li>OV_EREAD - A read from media returned an error.
-</li>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
- corruption.
-</li>
-<li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
-</li>
-</ul></</blockquote> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_pcm_tell.html b/doc/vorbisfile/ov_pcm_tell.html deleted file mode 100644 index f277a416..00000000 --- a/doc/vorbisfile/ov_pcm_tell.html +++ /dev/null @@ -1,61 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_pcm_tell</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_pcm_tell</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the current offset in samples. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int64_t ov_pcm_tell(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li><i>n</i> indicates the current offset in samples.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_pcm_total.html b/doc/vorbisfile/ov_pcm_total.html deleted file mode 100644 index bb205c21..00000000 --- a/doc/vorbisfile/ov_pcm_total.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_pcm_total</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_pcm_total</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the total pcm samples of the physical bitstream or a specified logical bitstream. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int64_t ov_pcm_total(OggVorbis_File *vf,int i); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>i</i></dt> -<dd>Link to the desired logical bitstream. To retrieve the total pcm samples for the entire physical bitstream, this parameter should be set to -1.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote>
-<li>OV_EINVAL means that the argument was invalid. In this case, the requested bitstream did not exist or the bitstream is unseekable.</li> -<li> -total length in pcm samples of content if i=-1.</li> -<li>length in pcm samples of logical bitstream if i=1 to n.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_raw_seek.html b/doc/vorbisfile/ov_raw_seek.html deleted file mode 100644 index dba16b4e..00000000 --- a/doc/vorbisfile/ov_raw_seek.html +++ /dev/null @@ -1,77 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_raw_seek</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_raw_seek</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Seeks to the offset specified (in compressed raw bytes) within the physical bitstream. This function only works for seekable streams. -<p>This also updates everything needed within the -decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from -the newly seeked to position. -<p>When seek speed is a priority, this is the best vorbisfile seek funtion to use. -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_raw_seek(OggVorbis_File *vf,long pos); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</dd> -<dt><i>pos</i></dt> -<dd>Position in compressed bytes to seek to in the bitstream.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 indicates success</li> -<li>nonzero indicates failure, described by several error codes:</li>
-<ul>
-<li>OV_ENOSEEK - Bitstream is not seekable.
-</li>
-<li>OV_EINVAL - Invalid argument value.
-</li>
-<li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
-</li>
-</ul> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_raw_tell.html b/doc/vorbisfile/ov_raw_tell.html deleted file mode 100644 index d2b649d3..00000000 --- a/doc/vorbisfile/ov_raw_tell.html +++ /dev/null @@ -1,61 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_raw_tell</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_raw_tell</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the current offset in raw compressed bytes. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int64_t ov_raw_tell(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li><i>n</i> indicates the current offset in bytes.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_raw_total.html b/doc/vorbisfile/ov_raw_total.html deleted file mode 100644 index 9732a0dc..00000000 --- a/doc/vorbisfile/ov_raw_total.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_raw_total</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_raw_total</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the total (compressed) bytes of the physical bitstream or a specified logical bitstream. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int64_t ov_raw_total(OggVorbis_File *vf,int i); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>i</i></dt> -<dd><b>Link to the desired logical bitstream. To retrieve the total bytes for the entire physical bitstream, this parameter should be set to -1.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>OV_EINVAL means that the argument was invalid. In this case, the requested bitstream did not exist or the bitstream is nonseekable</li> -<li> -total length in compressed bytes of content if i=-1.</li> -<li>length in compressed bytes of logical bitstream if i=1 to n.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_read.html b/doc/vorbisfile/ov_read.html deleted file mode 100644 index 09052684..00000000 --- a/doc/vorbisfile/ov_read.html +++ /dev/null @@ -1,117 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_read</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_read()</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p> - This is the main function used to decode a Vorbis file within a loop. -</p><p> - This function deals with more complicated bitstream chaining issues. - Up to this point, everything could more or less hide the multiple - logical bitstream nature of chaining from the toplevel application - if the toplevel application didn't particularly care. However, when we actually read audio back, we must be aware that multiple bitstream sections do not necessarily - have to have the same number of channels or sampling rate. -</p><p> - <tt>ov_read()</tt> passes back the index of the sequential logical - bitstream currently being decoded along with the PCM data in order - that the toplevel application can take action on channel/sample rate - changes. This number will be incremented at chaining boundaries even - for non-seekable streams. For seekable streams, it represents the - actual chaining index within the physical bitstream. -<tt>ov_read()</tt> passes back the logical bitstream number currently - being decoded along with the PCM data in order that the toplevel - application can take action on channel/sample rate changes. -</p> - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_read(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, char *buffer, int length, int bigendianp, int word, int sgned, int *bitstream); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions.</dd> -<dt><i>buffer</i></dt> -<dd>A pointer to an output buffer. The decoded output is inserted into this buffer.</dd> -<dt><i>length</i></dt> -<dd>Number of bytes to be read into the buffer. Should be the same size as the buffer. A typical value is 4096.</dd> -<dt><i>bigendianp</i></dt> -<dd>Specifies big or little endian byte packing. 0 for little endian, 1 for big endian. Typical value is 0.</dd> -<dt><i>word</i></dt> -<dd>Specifies word size. Possible arguments are 1 for 8-bit samples, or 2 or 16-bit samples. Typical value is 2.</dd> -<dt><i>sgned</i></dt> -<dd>Signed or unsigned data. 0 for unsigned, 1 for signed. Typically 1.</dd> -<dt><i>bitstream</i></dt> -<dd>A pointer to the number of the current logical bitstream.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<dl> -<dt>OV_HOLE</dt> - <dd>indicates there was an interruption in the data. - <br>(one of: garbage between pages, loss of sync followed by - recapture, or a corrupt page)</dd> -<dt>OV_EBADLINK</dt> - <dd>indicates that an invalid stream section was supplied to - libvorbisfile, or the requested link is corrupt.</dd> -<dt>0</dt> - <dd>indicates EOF</dd> -<dt><i>n</i></dt> - <dd>indicates actual number of bytes read. <tt>ov_read()</tt> will - decode at most one vorbis packet per invocation, so the value - returned will generally be less than <tt>length</tt>. -</dl> -</blockquote> - -<h3>Notes</h3> -<p><b>Typical usage:</b> -<blockquote> -<tt>bytes_read = ov_read(&vf, -buffer, 4096,0,2,1,&current_section)</tt> -</blockquote> - -This reads up to 4096 bytes into a buffer, with signed 16-bit -little-endian samples. -</p> - -<br> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_seekable.html b/doc/vorbisfile/ov_seekable.html deleted file mode 100644 index e369ee9c..00000000 --- a/doc/vorbisfile/ov_seekable.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_seekable</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_seekable</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>This indicates whether or not the bitstream is seekable. - - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_seekable(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. <b>Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 indicates that the file is not seekable.</li> -<li>1 indicates that the file is seekable.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_serialnumber.html b/doc/vorbisfile/ov_serialnumber.html deleted file mode 100644 index 0c2a733d..00000000 --- a/doc/vorbisfile/ov_serialnumber.html +++ /dev/null @@ -1,67 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_serialnumber</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_serialnumber</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the serialnumber of the specified logical bitstream. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_serialnumber(OggVorbis_File *vf,int i); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</dd> -<dt><i>i</i></dt> -<dd><b>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> --1 if the specified logical bitstream <i>i</i> does not exist.</li> - -<li>Returns the serial number of the logical bitstream <i>i</i> or the serial number of the current bitstream if the file is nonseekable.</li> -</blockquote> -<p> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_streams.html b/doc/vorbisfile/ov_streams.html deleted file mode 100644 index ba4b31ef..00000000 --- a/doc/vorbisfile/ov_streams.html +++ /dev/null @@ -1,65 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_streams</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_streams</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the number of logical bitstreams within our physical bitstream. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -long ov_streams(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. <b>Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -1 indicates a single logical bitstream or an unseekable file.</li> -<li><i>n</i> indicates the number of logical bitstreams.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_time_seek.html b/doc/vorbisfile/ov_time_seek.html deleted file mode 100644 index 8e88e9c8..00000000 --- a/doc/vorbisfile/ov_time_seek.html +++ /dev/null @@ -1,71 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_time_seek</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_time_seek</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>For seekable -streams, this seeks to the given time. For implementing seeking in a player, -this is the only function generally needed. This also updates everything needed within the -decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from -the newly seeked to position. For obvious reasons, this doesn't work for unseekable streams. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_time_seek(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double seconds); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd> -<dt><i>seconds</i></dt> -<dd>Location to seek to within the file, specified in seconds.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li> -Nonzero for failure</li> -</blockquote> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_time_seek_page.html b/doc/vorbisfile/ov_time_seek_page.html deleted file mode 100644 index b3b96160..00000000 --- a/doc/vorbisfile/ov_time_seek_page.html +++ /dev/null @@ -1,84 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_time_seek_page</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_time_seek_page</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>For seekable -streams, this seeks to closest full page preceding the given time. This function is faster than <a href="ov_time_seek.html">ov_time_seek</a> because it doesn't seek through the last few samples to reach an exact time, but it is also less accurate. This should be used when speed is important.
-<p>This function also updates everything needed within the -decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from -the newly seeked to position.
-<p>For obvious reasons, this doesn't work for unseekable streams. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double seconds); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd> -<dt><i>seconds</i></dt> -<dd>Location to seek to within the file, specified in seconds.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> - -<li> -nonzero indicates failure, described by several error codes:</li>
-<ul>
-<li>OV_ENOSEEK - Bitstream is not seekable.
-</li>
-<li>OV_EINVAL - Invalid argument value.
-</li>
-<li>OV_EREAD - A read from media returned an error.
-</li>
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
- corruption.
-</li>
-<li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
-</li>
-</ul></blockquote> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_time_tell.html b/doc/vorbisfile/ov_time_tell.html deleted file mode 100644 index 1377926c..00000000 --- a/doc/vorbisfile/ov_time_tell.html +++ /dev/null @@ -1,63 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_bitrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_time_tell</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - -<p>Returns the current offset in seconds. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -double ov_time_tell(OggVorbis_File *vf); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. <b>Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li><i>n</i> indicates the current offset in bytes.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/ov_time_total.html b/doc/vorbisfile/ov_time_total.html deleted file mode 100644 index 1fa81a57..00000000 --- a/doc/vorbisfile/ov_time_total.html +++ /dev/null @@ -1,74 +0,0 @@ -<html> - -<head> -<title>vorbisfile - function - ov_time_total</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>ov_time_total</h1> - -<p><i>declared in "vorbis/vorbisfile.h";</i></p> - - -<p>Returns the total time in seconds of the physical bitstream or a specified logical bitstream. - - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -double ov_time_total(OggVorbis_File *vf,int i); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vf</i></dt> -<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile -functions. Once this has been called, the same <tt>OggVorbis_File</tt> -struct should be passed to all the vorbisfile functions.</dd> -<dt><i>i</i></dt> -<dd><b>Link to the desired logical bitstream. To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</b></dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>OV_EINVAL means that the argument was invalid. In this case, the requested bitstream did not exist or the bitstream is nonseekable.</li> -<li> -total length in seconds of content if i=-1.</li> -<li>length in seconds of logical bitstream if i=1 to n.</li> -</blockquote> -<p> -<h3>Notes</h3> -<p><b>Typical usage:</b> <tt>bytes_read = ov_read(&vf, buffer, 4096,0,2,1,&current_section)</tt> -<br>This reads up to 4096 bytes into a buffer, with signed 16-bit little-endian -samples. -<br> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - - -</body> - -</html> diff --git a/doc/vorbisfile/overview.html b/doc/vorbisfile/overview.html deleted file mode 100644 index 99b384d2..00000000 --- a/doc/vorbisfile/overview.html +++ /dev/null @@ -1,44 +0,0 @@ -<html> - -<head> -<title>libvorbisfile - API Overview</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>VorbisFile API Overview</h1> -
-<p>The makeup of the vorbisfile API is relatively simple. It revolves around a single file resource. This resource is passed to the Vorbisfile API, where it is opened, manipulated, and closed, in the form of an <a href="OggVorbis_File.html">OggVorbis_File</a> struct. -<p> -The vorbisfile API consists of the following functional categories: -<p> -<ul> -<li><p><a href="datastructures.html">Base data structures</a> -<li><p><a href="initialization.html">Setup/Teardown</a> -<li><p><a href="decoding.html">Decoding</a> -<li><p><a href="seeking.html">Seeking</a> -<li><p><a href="fileinfo.html">File Information</a> -</ul> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/reference.html b/doc/vorbisfile/reference.html deleted file mode 100644 index 0649e22f..00000000 --- a/doc/vorbisfile/reference.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - -<head> -<title>Vorbisfile API Reference</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Vorbisfile API Reference</h1> - -<p> -<b>Data Structures</b><br> -<a href="OggVorbis_File.html">OggVorbis_File</a><br> -<a href="vorbis_comment.html">vorbis_comment</a><br> -<a href="vorbis_info.html">vorbis_info</a><br> -<a href="ov_callbacks.html">ov_callbacks</a><br> -<br> -<b>Setup/Teardown</b><br> -<a href="ov_open.html">ov_open()</a><br> -<a href="ov_open_callbacks.html">ov_open_callbacks()</a><br> -<a href="ov_clear.html">ov_clear()</a><br> -<br> -<b>Decoding</b><br> -<a href="ov_read.html">ov_read()</a><br> -<br> -<b>Seeking</b><br> -<a href="ov_raw_seek.html">ov_raw_seek()</a><br> -<a href="ov_pcm_seek.html">ov_pcm_seek()</a><br> -<a href="ov_time_seek.html">ov_time_seek()</a><br> -<br> -<b>File Information</b><br> -<a href="ov_bitrate.html">ov_bitrate()</a><br> -<a href="ov_bitrate_instant.html">ov_bitrate_instant()</a><br> -<a href="ov_streams.html">ov_streams()</a><br> -<a href="ov_seekable.html">ov_seekable()</a><br> -<a href="ov_serialnumber.html">ov_serialnumber()</a><br> -<a href="ov_raw_total.html">ov_raw_total()</a><br> -<a href="ov_pcm_total.html">ov_pcm_total()</a><br> -<a href="ov_time_total.html">ov_time_total()</a><br> -<a href="ov_raw_tell.html">ov_raw_tell()</a><br> -<a href="ov_pcm_tell.html">ov_pcm_tell()</a><br> -<a href="ov_time_tell.html">ov_time_tell()</a><br> -<a href="ov_info.html">ov_info()</a><br> -<a href="ov_comment.html">ov_comment()</a><br> -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/seekexample.html b/doc/vorbisfile/seekexample.html deleted file mode 100644 index 1c5e36b3..00000000 --- a/doc/vorbisfile/seekexample.html +++ /dev/null @@ -1,139 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Example Code</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Example Code</h1> - -<p> -The following is a run-through of the seeking example program supplied -with vorbisfile - <a href="seeking_test_c.html">seeking_test.c</a>. -This program tests the vorbisfile <a href="ov_time_seek.html">ov_time_seek</a> function by seeking to random points within the file. - -<p> -First, relevant headers, including vorbis-specific "codec.h" and "vorbisfile.h" have to be included. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#include <stdlib.h> -#include <stdio.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -#include "../lib/misc.h" -</b></pre> - </td> -</tr> -</table> - -<p>Inside main(), we declare our primary OggVorbis_File structure. We also declare a other helpful variables to track our progress within the file. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int main(){ - OggVorbis_File ov; - int i; -</b></pre> - </td> -</tr> -</table> - -<p><a href="ov_open.html">ov_open()</a> must be -called to initialize the <a href="OggVorbis_File.html">OggVorbis_File</a> structure with default values. -<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - if(ov_open(stdin,&ov,NULL,-1)<0){ - printf("Could not open input as an OggVorbis file.\n\n"); - exit(1); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -First we check to make sure the stream is seekable using <a href="ov_seekable.html">ov_seekable</a>. - -<p>Then we seek to 100 random spots in the bitstream using <a href="ov_time_seek.html">ov_time_seek</a> with randomly generated values. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - - /* print details about each logical bitstream in the input */ - if(ov_seekable(&ov)){ - double length=ov_time_total(&ov,-1); - printf("testing seeking to random places in %g seconds....\n",length); - for(i=0;i<100;i++){ - double val=(double)rand()/RAND_MAX*length; - ov_time_seek(&ov,val); - printf("\r\t%d [%gs]... ",i,val); - fflush(stdout); - } - - printf("\r \nOK.\n\n"); - }else{ - printf("Standard input was not seekable.\n"); - } - -</b></pre> - </td> -</tr> -</table> -<p> -When we're done seeking, we need to call <a href="ov_clear.html">ov_clear()</a> to release the bitstream. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - ov_clear(&ov); - return 0; -} -</b></pre> - </td> -</tr> -</table> - -<p> -The full source for seeking_test.c can be found with the vorbis -distribution in <a href="seeking_test_c.html">seeking_test.c</a>. - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/seeking.html b/doc/vorbisfile/seeking.html deleted file mode 100644 index 6b5ac18b..00000000 --- a/doc/vorbisfile/seeking.html +++ /dev/null @@ -1,67 +0,0 @@ -<html>
-
-<head>
-<title>vorbisfile - Seeking</title>
-<link rel=stylesheet href="style.css" type="text/css">
-</head>
-
-<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
-<table border=0 width=100%>
-<tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-<h1>Seeking</h1>
-<p>Seeking functions allow you to specify a specific point in the stream to begin or continue decoding.
-<p>
-All the <b>vorbisfile</b> seeking routines are declared in "vorbis/vorbisfile.h".
-<p>
-<p>Certain seeking functions are best suited to different situations. When speed is important, page-level seeking should be used.
-
-</ul>
-
-<table border=1 color=black width=50% cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
- <td><b>function</b></td>
- <td><b>purpose</b></td>
-</tr>
-<tr valign=top>
- <td><a href="ov_raw_seek.html">ov_raw_seek</a></td>
- <td>This function seeks to a specific byte in the bitstream, specified in bytes.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_pcm_seek.html">ov_pcm_seek</a></td>
- <td>This function seeks to a specific point in the bitstream, specified in pcm samples.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_pcm_seek.html">ov_pcm_seek_page</a></td>
- <td>This function seeks to the closest page preceding a point in the bitstream, specified in pcm samples.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_time_seek.html">ov_time_seek</a></td>
- <td>This function seeks to a time in the bitstream, specified in seconds. The easiest and simplest seeking method.</td>
-</tr>
-<tr valign=top>
- <td><a href="ov_time_seek_page.html">ov_time_seek_page</a></td>
- <td>This function seeks to the closest page preceding a time in the bitstream, specified in seconds.</td>
-</tr>
-</table>
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright © 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
-</tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
-</tr>
-</table>
-
-
-</body>
-
-</html>
diff --git a/doc/vorbisfile/seeking_example_c.html b/doc/vorbisfile/seeking_example_c.html deleted file mode 100644 index 0ffcf821..00000000 --- a/doc/vorbisfile/seeking_example_c.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> - -<head> -<title>vorbisfile - seeking_test.c</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>seeking_test.c</h1> - -<p> -The example program source: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - -#include <stdlib.h> -#include <stdio.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -#include "../lib/misc.h" - -int main(){ - OggVorbis_File ov; - int i; - - /* open the file/pipe on stdin */ - if(ov_open(stdin,&ov,NULL,-1)==-1){ - printf("Could not open input as an OggVorbis file.\n\n"); - exit(1); - } - - /* print details about each logical bitstream in the input */ - if(ov_seekable(&ov)){ - double length=ov_time_total(&ov,-1); - printf("testing seeking to random places in %g seconds....\n",length); - for(i=0;i<100;i++){ - double val=(double)rand()/RAND_MAX*length; - ov_time_seek(&ov,val); - printf("\r\t%d [%gs]... ",i,val); - fflush(stdout); - } - - printf("\r \nOK.\n\n"); - }else{ - printf("Standard input was not seekable.\n"); - } - - ov_clear(&ov); - return 0; -} - -</b></pre> - </td> -</tr> -</table> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/seeking_test_c.html b/doc/vorbisfile/seeking_test_c.html deleted file mode 100644 index 0ffcf821..00000000 --- a/doc/vorbisfile/seeking_test_c.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> - -<head> -<title>vorbisfile - seeking_test.c</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>seeking_test.c</h1> - -<p> -The example program source: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - -#include <stdlib.h> -#include <stdio.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -#include "../lib/misc.h" - -int main(){ - OggVorbis_File ov; - int i; - - /* open the file/pipe on stdin */ - if(ov_open(stdin,&ov,NULL,-1)==-1){ - printf("Could not open input as an OggVorbis file.\n\n"); - exit(1); - } - - /* print details about each logical bitstream in the input */ - if(ov_seekable(&ov)){ - double length=ov_time_total(&ov,-1); - printf("testing seeking to random places in %g seconds....\n",length); - for(i=0;i<100;i++){ - double val=(double)rand()/RAND_MAX*length; - ov_time_seek(&ov,val); - printf("\r\t%d [%gs]... ",i,val); - fflush(stdout); - } - - printf("\r \nOK.\n\n"); - }else{ - printf("Standard input was not seekable.\n"); - } - - ov_clear(&ov); - return 0; -} - -</b></pre> - </td> -</tr> -</table> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/seekingexample.html b/doc/vorbisfile/seekingexample.html deleted file mode 100644 index a137786b..00000000 --- a/doc/vorbisfile/seekingexample.html +++ /dev/null @@ -1,204 +0,0 @@ -<html> - -<head> -<title>vorbisfile - Example Code</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>Example Code</h1> - -<p> -The following is a run-through of the decoding example program supplied -with vorbisfile - <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>. -This program takes a vorbis bitstream from stdin and writes raw pcm to stdout. - -<p> -First, relevant headers, including vorbis-specific "codec.h" and "vorbisfile.h" have to be included. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#include <stdio.h> -#include <stdlib.h> -#include <math.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" -</b></pre> - </td> -</tr> -</table> -<p> -We also have to make a concession to Windows users here. If we are using windows for decoding, we must declare these libraries so that we can set stdin/stdout to binary. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#ifdef _WIN32 -#include <io.h> -#include <fcntl.h> -#endif -</b></pre> - </td> -</tr> -</table> -<p> -Next, a buffer for the pcm audio output is declared. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -char pcmout[4096]; -</b></pre> - </td> -</tr> -</table> - -<p>Inside main(), we declare our primary OggVorbis_File structure. We also declare a few other helpful variables to track out progress within the file. -Also, we make our final concession to Windows users by setting the stdin and stdout to binary mode. -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int main(int argc, char **argv){ - OggVorbis_File vf; - int eof=0; - int current_section; - -#ifdef _WIN32 - _setmode( _fileno( stdin ), _O_BINARY ); - _setmode( _fileno( stdout ), _O_BINARY ); -#endif -</b></pre> - </td> -</tr> -</table> - -<p><a href="ov_open.html">ov_open()</a> must be -called to initialize the <b>OggVorbis_File</b> structure with default values. -<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - if(ov_open(stdin, &vf, NULL, 0) < 0) { - fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n"); - exit(1); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -We're going to pull the channel and bitrate info from the file using <a href="ov_info.html">ov_info()</a> and show them to the user. -We also want to pull out and show the user a comment attached to the file using <a href="ov_comment.html">ov_comment()</a>. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - { - char **ptr=ov_comment(&vf,-1)->user_comments; - vorbis_info *vi=ov_info(&vf,-1); - while(*ptr){ - fprintf(stderr,"%s\n",*ptr); - ++ptr; - } - fprintf(stderr,"\nBitstream is %d channel, %ldHz\n",vi->channels,vi->rate); - fprintf(stderr,"Encoded by: %s\n\n",ov_comment(&vf,-1)->vendor); - } - -</b></pre> - </td> -</tr> -</table> - -<p> -Here's the read loop: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - - while(!eof){ - long ret=ov_read(&vf,pcmout,sizeof(pcmout),0,2,1,¤t_section); - switch(ret){ - case 0: - /* EOF */ - eof=1; - break; - case -1: - break; - default: - fwrite(pcmout,1,ret,stdout); - break; - } - } - -</b></pre> - </td> -</tr> -</table> - -<p> -The code is reading blocks of data using <a href="ov_read.html">ov_read()</a>. -Based on the value returned, we know if we're at the end of the file or have invalid data. If we have valid data, we write it to the pcm output. - -<p> -Now that we've finished playing, we can pack up and go home. It's important to call <a href="ov_clear.html">ov_clear()</a> when we're finished. - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> - - ov_clear(&vf); - - fprintf(stderr,"Done.\n"); - return(0); -} -</b></pre> - </td> -</tr> -</table> - -<p> -The full source for vorbisfile_example.c can be found with the vorbis -distribution in <a href="vorbisfile_example_c.html">vorbisfile_example.c</a>. - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/style.css b/doc/vorbisfile/style.css deleted file mode 100644 index 332f809e..00000000 --- a/doc/vorbisfile/style.css +++ /dev/null @@ -1,7 +0,0 @@ -BODY { font-family: helvetica, sans-serif } -TD { font-family: helvetica, sans-serif } -P { font-family: helvetica, sans-serif } -H1 { font-family: helvetica, sans-serif } -H2 { font-family: helvetica, sans-serif } -H4 { font-family: helvetica, sans-serif } -P.tiny { font-size: 8pt } diff --git a/doc/vorbisfile/vorbis_comment.html b/doc/vorbisfile/vorbis_comment.html deleted file mode 100644 index 53f5b744..00000000 --- a/doc/vorbisfile/vorbis_comment.html +++ /dev/null @@ -1,67 +0,0 @@ -<html> - -<head> -<title>vorbisfile - datatype - vorbis_comment</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>vorbis_comment</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_comment structure defines an Ogg Vorbis comment. -<p> -Only the fields the program needs must be defined. If a field isn't -defined by the application, it will either be blank (if it's a string value) -or set to some reasonable default (usually 0). -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_comment{ - /* unlimited user comment fields. */ - char **user_comments; - int comments; - char *vendor; - -} vorbis_comment;</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>user_comments</i></dt> -<dd>Unlimited user comment array. Comments stored in normal C 0-terminated strings.</dd> -<dt><i>comments</i></dt> -<dd>Int signifying number of user comments in user_comments field.</dd> -<dt><i>vendor</i></dt> -<dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/vorbis_info.html b/doc/vorbisfile/vorbis_info.html deleted file mode 100644 index b9ae7de5..00000000 --- a/doc/vorbisfile/vorbis_info.html +++ /dev/null @@ -1,102 +0,0 @@ -<html> - -<head> -<title>vorbisfile - datatype - vorbis_info</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>vorbis_info</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_info structure contains information about a vorbis bitstream. Most of the information in this struct is more complex and in-depth than we need for vorbisfile decoding. However, the info's there if we need or want it. - -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_info{ - int version; - int channels; - long rate; - - long bitrate_upper; - long bitrate_nominal; - long bitrate_lower; - - long blocksizes[2]; - - int modes; - int maps; - int times; - int floors; - int residues; - int books; - int psys; /* encode only */ - - vorbis_info_mode *mode_param[64]; - int map_type[64]; - vorbis_info_mapping *map_param[64]; - int time_type[64]; - vorbis_info_time *time_param[64]; - int floor_type[64]; - vorbis_info_floor *floor_param[64]; - int residue_type[64]; - vorbis_info_residue *residue_param[64]; - static_codebook *book_param[256]; - vorbis_info_psy *psy_param[64]; /* encode only */ - - /* for block long/sort tuning; encode only */ - int envelopesa; - double preecho_thresh; - double preecho_clamp; - -} vorbis_info;</b></pre> - </td> -</tr> -</table> - -<h3>Relevant Struct Members</h3> -<dl> -<dt><i>version</i></dt> -<dd>Vorbis encoder version used to create this bitstream.</dd> -<dt><i>channels</i></dt> -<dd>Int signifying number of channels in bitstream.</dd> -<dt><i>rate</i></dt> -<dd>Sampling rate of the bitstream.</dd> -<dt><i>bitrate_upper</i></dt> -<dd>Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> -<dt><i>bitrate_nominal</i></dt> -<dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd> -<dt><i>bitrate_lower</i></dt> -<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> -<dt><i>blocksizes[2]</i></dt> -<dd>Contains the sizes of the long and short blocks for this particular bitstream. These are variable and can be set by the encoder. Vorbis only supports two sizes, long and short.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisfile/vorbisfile_example_c.html b/doc/vorbisfile/vorbisfile_example_c.html deleted file mode 100644 index 38068db0..00000000 --- a/doc/vorbisfile/vorbisfile_example_c.html +++ /dev/null @@ -1,106 +0,0 @@ -<html> - -<head> -<title>vorbisfile - vorbisfile_example.c</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -<h1>vorbisfile_example.c</h1> - -<p> -The example program source: - -<br><br> -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -#include <stdio.h> -#include <stdlib.h> -#include <math.h> -#include "vorbis/codec.h" -#include "vorbis/vorbisfile.h" - -#ifdef _WIN32 -#include <io.h> -#include <fcntl.h> -#endif - -char pcmout[4096]; - -int main(int argc, char **argv){ - OggVorbis_File vf; - int eof=0; - int current_section; - -#ifdef _WIN32 - _setmode( _fileno( stdin ), _O_BINARY ); - _setmode( _fileno( stdout ), _O_BINARY ); -#endif - - if(ov_open(stdin, &vf, NULL, 0) < 0) { - fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n"); - exit(1); - } - - { - char **ptr=ov_comment(&vf,-1)->user_comments; - vorbis_info *vi=ov_info(&vf,-1); - while(*ptr){ - fprintf(stderr,"%s\n",*ptr); - ++ptr; - } - fprintf(stderr,"\nBitstream is %d channel, %ldHz\n",vi->channels,vi->rate); - fprintf(stderr,"Encoded by: %s\n\n",ov_comment(&vf,-1)->vendor); - } - - while(!eof){
- long ret=ov_read(&vf,pcmout,sizeof(pcmout),0,2,1,¤t_section);
- if (ret == 0) {
- /* EOF */
- eof=1;
- } else if (ret < 0) {
- /* error in the stream. Not a problem, just reporting it in
- case we (the app) cares. In this case, we don't. */
- } else {
- /* we don't bother dealing with sample rate changes, etc, but
- you'll have to*/
- fwrite(pcmout,1,ret,stdout);
- }
- }
-
- ov_clear(&vf); - - fprintf(stderr,"Done.\n"); - return(0); -} - -</b></pre> - </td> -</tr> -</table> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000 vorbis team</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> -</tr><tr> -<td><p class=tiny>vorbisfile documentation</p></td> -<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td> -</tr> -</table> - -</body> - -</html> diff --git a/doc/vorbisword2.png b/doc/vorbisword2.png Binary files differdeleted file mode 100644 index 12e3d316..00000000 --- a/doc/vorbisword2.png +++ /dev/null diff --git a/doc/wait.png b/doc/wait.png Binary files differdeleted file mode 100644 index 2d10af60..00000000 --- a/doc/wait.png +++ /dev/null diff --git a/doc/white-ogg.png b/doc/white-ogg.png Binary files differdeleted file mode 100644 index 2694296b..00000000 --- a/doc/white-ogg.png +++ /dev/null diff --git a/doc/white-xifish.png b/doc/white-xifish.png Binary files differdeleted file mode 100644 index ab25cc8f..00000000 --- a/doc/white-xifish.png +++ /dev/null |
