gstreamer 1.1.0-x86-mingw32

data/vendor/local/share/doc/libtheora-1.1.1/latex/structtheora__state.tex

@@ -0,0 +1,45 @@
+\section{theora\-\_\-state \-Struct \-Reference}
+\label{structtheora__state}\index{theora\-\_\-state@{theora\-\_\-state}}
+
+
+\-Codec internal state and context.  
+
+
+
+
+{\ttfamily \#include $<$theora.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+{\bf theora\-\_\-info} $\ast$ {\bf i}
+\item 
+ogg\-\_\-int64\-\_\-t {\bf granulepos}
+\item 
+void $\ast$ {\bf internal\-\_\-encode}
+\item 
+void $\ast$ {\bf internal\-\_\-decode}
+\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-Codec internal state and context. 
+
+\subsection{\-Field \-Documentation}
+\index{theora\-\_\-state@{theora\-\_\-state}!granulepos@{granulepos}}
+\index{granulepos@{granulepos}!theora_state@{theora\-\_\-state}}
+\subsubsection[{granulepos}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-int64\-\_\-t {\bf theora\-\_\-state\-::granulepos}}\label{structtheora__state_a5dd344a3f79ea7501b18c756772fab7b}
+\index{theora\-\_\-state@{theora\-\_\-state}!i@{i}}
+\index{i@{i}!theora_state@{theora\-\_\-state}}
+\subsubsection[{i}]{\setlength{\rightskip}{0pt plus 5cm}{\bf theora\-\_\-info}$\ast$ {\bf theora\-\_\-state\-::i}}\label{structtheora__state_a0efc7ac581ef260b0ca17f518ace0731}
+\index{theora\-\_\-state@{theora\-\_\-state}!internal\-\_\-decode@{internal\-\_\-decode}}
+\index{internal\-\_\-decode@{internal\-\_\-decode}!theora_state@{theora\-\_\-state}}
+\subsubsection[{internal\-\_\-decode}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ {\bf theora\-\_\-state\-::internal\-\_\-decode}}\label{structtheora__state_ad20c4eebbc5ed9764cf03ba8b90e796e}
+\index{theora\-\_\-state@{theora\-\_\-state}!internal\-\_\-encode@{internal\-\_\-encode}}
+\index{internal\-\_\-encode@{internal\-\_\-encode}!theora_state@{theora\-\_\-state}}
+\subsubsection[{internal\-\_\-encode}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ {\bf theora\-\_\-state\-::internal\-\_\-encode}}\label{structtheora__state_a1fbfd82fb7210cbcc4233cb680ec2af6}
+
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf theora.\-h}\end{DoxyCompactItemize}

data/vendor/local/share/doc/libtheora-1.1.1/latex/structyuv__buffer.tex

@@ -0,0 +1,114 @@
+\section{yuv\-\_\-buffer \-Struct \-Reference}
+\label{structyuv__buffer}\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}}
+
+
+\-A \-Y\-U\-V buffer for passing uncompressed frames to and from the codec.  
+
+
+
+
+{\ttfamily \#include $<$theora.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+int {\bf y\-\_\-width}
+\begin{DoxyCompactList}\small\item\em \-Width of the \-Y' luminance plane. \end{DoxyCompactList}\item 
+int {\bf y\-\_\-height}
+\begin{DoxyCompactList}\small\item\em \-Height of the luminance plane. \end{DoxyCompactList}\item 
+int {\bf y\-\_\-stride}
+\begin{DoxyCompactList}\small\item\em \-Offset in bytes between successive rows. \end{DoxyCompactList}\item 
+int {\bf uv\-\_\-width}
+\begin{DoxyCompactList}\small\item\em \-Width of the \-Cb and \-Cr chroma planes. \end{DoxyCompactList}\item 
+int {\bf uv\-\_\-height}
+\begin{DoxyCompactList}\small\item\em \-Height of the chroma planes. \end{DoxyCompactList}\item 
+int {\bf uv\-\_\-stride}
+\begin{DoxyCompactList}\small\item\em \-Offset between successive chroma rows. \end{DoxyCompactList}\item 
+unsigned char $\ast$ {\bf y}
+\begin{DoxyCompactList}\small\item\em \-Pointer to start of luminance data. \end{DoxyCompactList}\item 
+unsigned char $\ast$ {\bf u}
+\begin{DoxyCompactList}\small\item\em \-Pointer to start of \-Cb data. \end{DoxyCompactList}\item 
+unsigned char $\ast$ {\bf v}
+\begin{DoxyCompactList}\small\item\em \-Pointer to start of \-Cr data. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-A \-Y\-U\-V buffer for passing uncompressed frames to and from the codec. 
+
+\-This holds a \-Y'\-Cb\-Cr frame in planar format. \-The \-Cb\-Cr planes can be subsampled and have their own separate dimensions and row stride offsets. \-Note that the strides may be negative in some configurations. \-For theora the width and height of the largest plane must be a multiple of 16. \-The actual meaningful picture size and offset are stored in the \doxyref{theora\-\_\-info}{p.}{structtheora__info} structure; frames returned by the decoder may need to be cropped for display.
+
+\-All samples are 8 bits. \-Within each plane samples are ordered by row from the top of the frame to the bottom. \-Within each row samples are ordered from left to right.
+
+\-During decode, the \doxyref{yuv\-\_\-buffer}{p.}{structyuv__buffer} struct is allocated by the user, but all fields (including luma and chroma pointers) are filled by the library. \-These pointers address library-\/internal memory and their contents should not be modified.
+
+\-Conversely, during encode the user allocates the struct and fills out all fields. \-The user also manages the data addressed by the luma and chroma pointers. \-See the encoder\-\_\-example.\-c and dump\-\_\-video.\-c example files in theora/examples/ for more information. 
+
+\subsection{\-Field \-Documentation}
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!u@{u}}
+\index{u@{u}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{u}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char$\ast$ {\bf yuv\-\_\-buffer\-::u}}\label{structyuv__buffer_a8b1857afe3ffac28f259499a57a559e1}
+
+
+\-Pointer to start of \-Cb data. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!uv\-\_\-height@{uv\-\_\-height}}
+\index{uv\-\_\-height@{uv\-\_\-height}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{uv\-\_\-height}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::uv\-\_\-height}}\label{structyuv__buffer_a640f1a0b456d3807f9f0538b22f10097}
+
+
+\-Height of the chroma planes. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!uv\-\_\-stride@{uv\-\_\-stride}}
+\index{uv\-\_\-stride@{uv\-\_\-stride}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{uv\-\_\-stride}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::uv\-\_\-stride}}\label{structyuv__buffer_ab265cc24ffb5650bf52daf223b0debb9}
+
+
+\-Offset between successive chroma rows. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!uv\-\_\-width@{uv\-\_\-width}}
+\index{uv\-\_\-width@{uv\-\_\-width}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{uv\-\_\-width}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::uv\-\_\-width}}\label{structyuv__buffer_a8c59a57c35af0be519ee47f15e49fe2b}
+
+
+\-Width of the \-Cb and \-Cr chroma planes. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!v@{v}}
+\index{v@{v}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{v}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char$\ast$ {\bf yuv\-\_\-buffer\-::v}}\label{structyuv__buffer_aa429491dd112adb0254672c59ef55075}
+
+
+\-Pointer to start of \-Cr data. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!y@{y}}
+\index{y@{y}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{y}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char$\ast$ {\bf yuv\-\_\-buffer\-::y}}\label{structyuv__buffer_a725727c70eeced6b8c90866973399ac1}
+
+
+\-Pointer to start of luminance data. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!y\-\_\-height@{y\-\_\-height}}
+\index{y\-\_\-height@{y\-\_\-height}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{y\-\_\-height}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::y\-\_\-height}}\label{structyuv__buffer_a5a8b60e012247e2caffcbbaca99414e0}
+
+
+\-Height of the luminance plane. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!y\-\_\-stride@{y\-\_\-stride}}
+\index{y\-\_\-stride@{y\-\_\-stride}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{y\-\_\-stride}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::y\-\_\-stride}}\label{structyuv__buffer_a9cdf61834c11b2351640a4a243ad0549}
+
+
+\-Offset in bytes between successive rows. 
+
+\index{yuv\-\_\-buffer@{yuv\-\_\-buffer}!y\-\_\-width@{y\-\_\-width}}
+\index{y\-\_\-width@{y\-\_\-width}!yuv_buffer@{yuv\-\_\-buffer}}
+\subsubsection[{y\-\_\-width}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf yuv\-\_\-buffer\-::y\-\_\-width}}\label{structyuv__buffer_aaa6c06c071da933231647238418d5fc0}
+
+
+\-Width of the \-Y' luminance plane. 
+
+
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf theora.\-h}\end{DoxyCompactItemize}

data/vendor/local/share/doc/libtheora-1.1.1/latex/theora_8h.tex

@@ -0,0 +1,191 @@
+\section{theora.\-h \-File \-Reference}
+\label{theora_8h}\index{theora.\-h@{theora.\-h}}
+
+
+\-The libtheora pre-\/1.\-0 legacy \-C \-A\-P\-I.  
+
+
+{\ttfamily \#include $<$stddef.\-h$>$}\*
+{\ttfamily \#include $<$ogg/ogg.\-h$>$}\*
+\subsection*{\-Data \-Structures}
+\begin{DoxyCompactItemize}
+\item 
+struct {\bf yuv\-\_\-buffer}
+\begin{DoxyCompactList}\small\item\em \-A \-Y\-U\-V buffer for passing uncompressed frames to and from the codec. \end{DoxyCompactList}\item 
+struct {\bf theora\-\_\-info}
+\begin{DoxyCompactList}\small\item\em \-Theora bitstream info. \end{DoxyCompactList}\item 
+struct {\bf theora\-\_\-state}
+\begin{DoxyCompactList}\small\item\em \-Codec internal state and context. \end{DoxyCompactList}\item 
+struct {\bf theora\-\_\-comment}
+\begin{DoxyCompactList}\small\item\em \-Comment header metadata. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{\-Defines}
+\begin{DoxyCompactItemize}
+\item 
+\#define {\bf \-O\-C\-\_\-\-F\-A\-U\-L\-T}~-\/1
+\begin{DoxyCompactList}\small\item\em \-General failure. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-E\-I\-N\-V\-A\-L}~-\/10
+\begin{DoxyCompactList}\small\item\em \-Library encountered invalid internal data. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-D\-I\-S\-A\-B\-L\-E\-D}~-\/11
+\begin{DoxyCompactList}\small\item\em \-Requested action is disabled. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-B\-A\-D\-H\-E\-A\-D\-E\-R}~-\/20
+\begin{DoxyCompactList}\small\item\em \-Header packet was corrupt/invalid. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-N\-O\-T\-F\-O\-R\-M\-A\-T}~-\/21
+\begin{DoxyCompactList}\small\item\em \-Packet is not a theora packet. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-V\-E\-R\-S\-I\-O\-N}~-\/22
+\begin{DoxyCompactList}\small\item\em \-Bitstream version is not handled. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-I\-M\-P\-L}~-\/23
+\begin{DoxyCompactList}\small\item\em \-Feature or action not implemented. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-B\-A\-D\-P\-A\-C\-K\-E\-T}~-\/24
+\begin{DoxyCompactList}\small\item\em \-Packet is corrupt. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-N\-E\-W\-P\-A\-C\-K\-E\-T}~-\/25
+\begin{DoxyCompactList}\small\item\em \-Packet is an (ignorable) unhandled extension. \end{DoxyCompactList}\item 
+\#define {\bf \-O\-C\-\_\-\-D\-U\-P\-F\-R\-A\-M\-E}~1
+\begin{DoxyCompactList}\small\item\em \-Packet is a dropped frame. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{Indent}{\bf theora\-\_\-control() codes}\par
+\begin{DoxyCompactItemize}
+\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}~(1)
+\begin{DoxyCompactList}\small\item\em \-Get the maximum post-\/processing level. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}~(3)
+\begin{DoxyCompactList}\small\item\em \-Set the post-\/processing level. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-E\-N\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-K\-E\-Y\-F\-R\-A\-M\-E\-\_\-\-F\-R\-E\-Q\-U\-E\-N\-C\-Y\-\_\-\-F\-O\-R\-C\-E}~(4)
+\begin{DoxyCompactList}\small\item\em \-Sets the maximum distance between key frames. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}~(5)
+\begin{DoxyCompactList}\small\item\em \-Set the granule position. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-E\-N\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-Q\-U\-A\-N\-T\-\_\-\-P\-A\-R\-A\-M\-S}~(2)
+\begin{DoxyCompactList}\small\item\em \-Sets the quantization parameters to use. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-E\-N\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-V\-P3\-\_\-\-C\-O\-M\-P\-A\-T\-I\-B\-L\-E}~(10)
+\begin{DoxyCompactList}\small\item\em \-Disables any encoder features that would prevent lossless transcoding back to \-V\-P3. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-E\-N\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-S\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}~(12)
+\begin{DoxyCompactList}\small\item\em \-Gets the maximum speed level. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-E\-N\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-P\-L\-E\-V\-E\-L}~(14)
+\begin{DoxyCompactList}\small\item\em \-Sets the speed level. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\end{Indent}
+\subsection*{\-Typedefs}
+\begin{DoxyCompactItemize}
+\item 
+typedef struct {\bf theora\-\_\-comment} {\bf theora\-\_\-comment}
+\begin{DoxyCompactList}\small\item\em \-Comment header metadata. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{\-Enumerations}
+\begin{DoxyCompactItemize}
+\item 
+enum {\bf theora\-\_\-colorspace} \{ {\bf \-O\-C\-\_\-\-C\-S\-\_\-\-U\-N\-S\-P\-E\-C\-I\-F\-I\-E\-D}, 
+{\bf \-O\-C\-\_\-\-C\-S\-\_\-\-I\-T\-U\-\_\-\-R\-E\-C\-\_\-470\-M}, 
+{\bf \-O\-C\-\_\-\-C\-S\-\_\-\-I\-T\-U\-\_\-\-R\-E\-C\-\_\-470\-B\-G}, 
+{\bf \-O\-C\-\_\-\-C\-S\-\_\-\-N\-S\-P\-A\-C\-E\-S}
+ \}
+\begin{DoxyCompactList}\small\item\em \-A \-Colorspace. \end{DoxyCompactList}\item 
+enum {\bf theora\-\_\-pixelformat} \{ {\bf \-O\-C\-\_\-\-P\-F\-\_\-420}, 
+{\bf \-O\-C\-\_\-\-P\-F\-\_\-\-R\-S\-V\-D}, 
+{\bf \-O\-C\-\_\-\-P\-F\-\_\-422}, 
+{\bf \-O\-C\-\_\-\-P\-F\-\_\-444}
+ \}
+\begin{DoxyCompactList}\small\item\em \-A \-Chroma subsampling. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{\-Functions}
+\begin{DoxyCompactItemize}
+\item 
+const char $\ast$ {\bf theora\-\_\-version\-\_\-string} (void)
+\begin{DoxyCompactList}\small\item\em \-Retrieve a human-\/readable string to identify the encoder vendor and version. \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-version\-\_\-number} (void)
+\begin{DoxyCompactList}\small\item\em \-Retrieve a 32-\/bit version number. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-init} ({\bf theora\-\_\-state} $\ast$th, {\bf theora\-\_\-info} $\ast$ti)
+\begin{DoxyCompactList}\small\item\em \-Initialize the theora encoder. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-\-Y\-U\-Vin} ({\bf theora\-\_\-state} $\ast$t, {\bf yuv\-\_\-buffer} $\ast$yuv)
+\begin{DoxyCompactList}\small\item\em \-Submit a \-Y\-U\-V buffer to the theora encoder. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-packetout} ({\bf theora\-\_\-state} $\ast$t, int last\-\_\-p, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Request the next packet of encoded video. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-header} ({\bf theora\-\_\-state} $\ast$t, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Request a packet containing the initial header. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-comment} ({\bf theora\-\_\-comment} $\ast$tc, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Request a comment header packet from provided metadata. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-encode\-\_\-tables} ({\bf theora\-\_\-state} $\ast$t, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Request a packet containing the codebook tables for the stream. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-decode\-\_\-header} ({\bf theora\-\_\-info} $\ast$ci, {\bf theora\-\_\-comment} $\ast$cc, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Decode an \-Ogg packet, with the expectation that the packet contains an initial header, comment data or codebook tables. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-decode\-\_\-init} ({\bf theora\-\_\-state} $\ast$th, {\bf theora\-\_\-info} $\ast$c)
+\begin{DoxyCompactList}\small\item\em \-Initialize a \doxyref{theora\-\_\-state}{p.}{structtheora__state} handle for decoding. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-decode\-\_\-packetin} ({\bf theora\-\_\-state} $\ast$th, ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Input a packet containing encoded data into the theora decoder. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-decode\-\_\-\-Y\-U\-Vout} ({\bf theora\-\_\-state} $\ast$th, {\bf yuv\-\_\-buffer} $\ast$yuv)
+\begin{DoxyCompactList}\small\item\em \-Output the next available frame of decoded \-Y\-U\-V data. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-packet\-\_\-isheader} (ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Report whether a theora packet is a header or not \-This function does no verification beyond checking the header flag bit so it should not be used for bitstream identification; use \doxyref{theora\-\_\-decode\-\_\-header()}{p.}{group__oldfuncs_ga02915e63c1bd733ee291f577a8b75a82} for that. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-packet\-\_\-iskeyframe} (ogg\-\_\-packet $\ast$op)
+\begin{DoxyCompactList}\small\item\em \-Report whether a theora packet is a keyframe or not. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-granule\-\_\-shift} ({\bf theora\-\_\-info} $\ast$ti)
+\begin{DoxyCompactList}\small\item\em \-Report the granulepos shift radix. \end{DoxyCompactList}\item 
+ogg\-\_\-int64\-\_\-t {\bf theora\-\_\-granule\-\_\-frame} ({\bf theora\-\_\-state} $\ast$th, ogg\-\_\-int64\-\_\-t granulepos)
+\begin{DoxyCompactList}\small\item\em \-Convert a granulepos to an absolute frame index, starting at 0. \end{DoxyCompactList}\item 
+double {\bf theora\-\_\-granule\-\_\-time} ({\bf theora\-\_\-state} $\ast$th, ogg\-\_\-int64\-\_\-t granulepos)
+\begin{DoxyCompactList}\small\item\em \-Convert a granulepos to absolute time in seconds. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-info\-\_\-init} ({\bf theora\-\_\-info} $\ast$c)
+\begin{DoxyCompactList}\small\item\em \-Initialize a \doxyref{theora\-\_\-info}{p.}{structtheora__info} structure. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-info\-\_\-clear} ({\bf theora\-\_\-info} $\ast$c)
+\begin{DoxyCompactList}\small\item\em \-Clear a \doxyref{theora\-\_\-info}{p.}{structtheora__info} structure. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-clear} ({\bf theora\-\_\-state} $\ast$t)
+\begin{DoxyCompactList}\small\item\em \-Free all internal data associated with a \doxyref{theora\-\_\-state}{p.}{structtheora__state} handle. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-comment\-\_\-init} ({\bf theora\-\_\-comment} $\ast$tc)
+\begin{DoxyCompactList}\small\item\em \-Initialize an allocated \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} structure. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-comment\-\_\-add} ({\bf theora\-\_\-comment} $\ast$tc, char $\ast$comment)
+\begin{DoxyCompactList}\small\item\em \-Add a comment to an initialized \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} structure. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-comment\-\_\-add\-\_\-tag} ({\bf theora\-\_\-comment} $\ast$tc, char $\ast$tag, char $\ast$value)
+\begin{DoxyCompactList}\small\item\em \-Add a comment to an initialized \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} structure. \end{DoxyCompactList}\item 
+char $\ast$ {\bf theora\-\_\-comment\-\_\-query} ({\bf theora\-\_\-comment} $\ast$tc, char $\ast$tag, int count)
+\begin{DoxyCompactList}\small\item\em \-Look up a comment value by tag. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-comment\-\_\-query\-\_\-count} ({\bf theora\-\_\-comment} $\ast$tc, char $\ast$tag)
+\begin{DoxyCompactList}\small\item\em \-Look up the number of instances of a tag. \end{DoxyCompactList}\item 
+void {\bf theora\-\_\-comment\-\_\-clear} ({\bf theora\-\_\-comment} $\ast$tc)
+\begin{DoxyCompactList}\small\item\em \-Clear an allocated \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} struct so that it can be freed. \end{DoxyCompactList}\item 
+int {\bf theora\-\_\-control} ({\bf theora\-\_\-state} $\ast$th, int req, void $\ast$buf, size\-\_\-t buf\-\_\-sz)
+\begin{DoxyCompactList}\small\item\em \-Encoder control function. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-The libtheora pre-\/1.\-0 legacy \-C \-A\-P\-I. \subsection{\-Introduction}\label{index_intro}
+\-This is the documentation for the libtheora legacy \-C \-A\-P\-I, declared in the \doxyref{theora.\-h}{p.}{theora_8h} header, which describes the old interface used before the 1.\-0 release. \-This \-A\-P\-I was widely deployed for several years and remains supported, but for new code we recommend the cleaner \-A\-P\-I declared in \doxyref{theoradec.\-h}{p.}{theoradec_8h} and \doxyref{theoraenc.\-h}{p.}{theoraenc_8h}.
+
+libtheora is the reference implementation for {\tt \-Theora}, a free video codec. \-Theora is derived from \-On2's \-V\-P3 codec with improved integration with \-Ogg multimedia formats by {\tt \-Xiph.\-Org}.\subsection{\-Overview}\label{theora_8h_overview}
+\-This library will both decode and encode theora packets to/from raw \-Y\-U\-V frames. \-In either case, the packets will most likely either come from or need to be embedded in an \-Ogg stream. \-Use {\tt libogg} or {\tt liboggz} to extract/package these packets.\subsection{\-Decoding Process}\label{theora_8h_decoding}
+\-Decoding can be separated into the following steps\-:
+\begin{DoxyEnumerate}
+\item initialise \doxyref{theora\-\_\-info}{p.}{structtheora__info} and \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} structures using \doxyref{theora\-\_\-info\-\_\-init()}{p.}{group__oldfuncs_ga3091c87d48f1faba018c5956379a6d90} and \doxyref{theora\-\_\-comment\-\_\-init()}{p.}{group__oldfuncs_ga811b92785df3bdbbebb3de612d9d6ce0}\-: \begin{DoxyVerb}
+ theora_info     info;
+ theora_comment  comment;
+   
+ theora_info_init(&info);
+ theora_comment_init(&comment);
+ \end{DoxyVerb}
+
+\item retrieve header packets from \-Ogg stream (there should be 3) and decode into \doxyref{theora\-\_\-info}{p.}{structtheora__info} and \doxyref{theora\-\_\-comment}{p.}{structtheora__comment} structures using \doxyref{theora\-\_\-decode\-\_\-header()}{p.}{group__oldfuncs_ga02915e63c1bd733ee291f577a8b75a82}. \-See \doxyref{\-Identifying \-Theora \-Packets}{p.}{theora_8h_identification} for more information on identifying which packets are theora packets. \begin{DoxyVerb}
+ int i;
+ for (i = 0; i < 3; i++)
+ {
+   (get a theora packet "op" from the Ogg stream)
+   theora_decode_header(&info, &comment, op);
+ }
+ \end{DoxyVerb}
+
+\item initialise the decoder based on the information retrieved into the \doxyref{theora\-\_\-info}{p.}{structtheora__info} struct by \doxyref{theora\-\_\-decode\-\_\-header()}{p.}{group__oldfuncs_ga02915e63c1bd733ee291f577a8b75a82}. \-You will need a \doxyref{theora\-\_\-state}{p.}{structtheora__state} struct. \begin{DoxyVerb}
+ theora_state state;
+ 
+ theora_decode_init(&state, &info);
+ \end{DoxyVerb}
+
+\item pass in packets and retrieve decoded frames! \-See the \doxyref{yuv\-\_\-buffer}{p.}{structyuv__buffer} documentation for information on how to retrieve raw \-Y\-U\-V data. \begin{DoxyVerb}
+ yuf_buffer buffer;
+ while (last packet was not e_o_s) {
+   (get a theora packet "op" from the Ogg stream)
+   theora_decode_packetin(&state, op);
+   theora_decode_YUVout(&state, &buffer);
+ }
+ \end{DoxyVerb}
+
+\end{DoxyEnumerate}\subsubsection{\-Identifying Theora Packets}\label{theora_8h_identification}
+\-All streams inside an \-Ogg file have a unique serial\-\_\-no attached to the stream. \-Typically, you will want to
+\begin{DoxyItemize}
+\item retrieve the serial\-\_\-no for each b\-\_\-o\-\_\-s (beginning of stream) page encountered within the \-Ogg file;
+\item test the first (only) packet on that page to determine if it is a theora packet;
+\item once you have found a theora b\-\_\-o\-\_\-s page then use the retrieved serial\-\_\-no to identify future packets belonging to the same theora stream.
+\end{DoxyItemize}
+
+\-Note that you {\itshape cannot\/} use \doxyref{theora\-\_\-packet\-\_\-isheader()}{p.}{group__oldfuncs_gab969f9d0407683f0e5abe73d0839a25b} to determine if a packet is a theora packet or not, as this function does not perform any checking beyond whether a header bit is present. \-Instead, use the \doxyref{theora\-\_\-decode\-\_\-header()}{p.}{group__oldfuncs_ga02915e63c1bd733ee291f577a8b75a82} function and check the return value; or examine the header bytes at the beginning of the \-Ogg page. 

data/vendor/local/share/doc/libtheora-1.1.1/latex/theoradec_8h.tex

@@ -0,0 +1,251 @@
+\section{theoradec.\-h \-File \-Reference}
+\label{theoradec_8h}\index{theoradec.\-h@{theoradec.\-h}}
+
+
+\-The {\ttfamily libtheoradec} \-C decoding \-A\-P\-I.  
+
+
+{\ttfamily \#include $<$stddef.\-h$>$}\*
+{\ttfamily \#include $<$ogg/ogg.\-h$>$}\*
+{\ttfamily \#include \char`\"{}codec.\-h\char`\"{}}\*
+\subsection*{\-Data \-Structures}
+\begin{DoxyCompactItemize}
+\item 
+struct {\bf th\-\_\-stripe\-\_\-callback}
+\begin{DoxyCompactList}\small\item\em \-The striped decode callback data to pass to \doxyref{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}{p.}{theoradec_8h_ac95cc9e109474b0fa4bb920ab2cfdf1e}. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{\-Defines}
+\begin{DoxyCompactItemize}
+\item 
+\#define {\bf \-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-}~(1)
+\end{DoxyCompactItemize}
+\begin{Indent}{\bf th\-\_\-decode\-\_\-ctl() codes}\par
+{\em \label{theoradec_8h_decctlcodes}%
+ \-These are the available request codes for \doxyref{th\-\_\-decode\-\_\-ctl()}{p.}{group__decfuncs_ga1a8051958d75b1012573b6e3c8f670e1}. \-By convention, these are odd, to distinguish them from the \doxyref{encoder control codes}{p.}{theoraenc_8h_encctlcodes}. \-Keep any experimental or vendor-\/specific values above {\ttfamily 0x8000}. }\begin{DoxyCompactItemize}
+\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}~(1)
+\begin{DoxyCompactList}\small\item\em \-Gets the maximum post-\/processing level. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}~(3)
+\begin{DoxyCompactList}\small\item\em \-Sets the post-\/processing level. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}~(5)
+\begin{DoxyCompactList}\small\item\em \-Sets the granule position. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}~(7)
+\begin{DoxyCompactList}\small\item\em \-Sets the striped decode callback function. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E}~(9)
+\begin{DoxyCompactList}\small\item\em \-Enables telemetry and sets the macroblock display mode. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V}~(11)
+\begin{DoxyCompactList}\small\item\em \-Enables telemetry and sets the motion vector display mode. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I}~(13)
+\begin{DoxyCompactList}\small\item\em \-Enables telemetry and sets the adaptive quantization display mode. \end{DoxyCompactList}\item 
+\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S}~(15)
+\begin{DoxyCompactList}\small\item\em \-Enables telemetry and sets the bitstream breakdown visualization mode. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\end{Indent}
+\subsection*{\-Typedefs}
+\begin{DoxyCompactItemize}
+\item 
+typedef void($\ast$ {\bf th\-\_\-stripe\-\_\-decoded\-\_\-func} )(void $\ast$\-\_\-ctx, {\bf th\-\_\-ycbcr\-\_\-buffer} \-\_\-buf, int \-\_\-yfrag0, int \-\_\-yfrag\-\_\-end)
+\begin{DoxyCompactList}\small\item\em \-A callback function for striped decode. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{Indent}{\bf \-Decoder state}\par
+{\em \-The following data structures are opaque, and their contents are not publicly defined by this \-A\-P\-I.
+
+\-Referring to their internals directly is unsupported, and may break without warning. }\begin{DoxyCompactItemize}
+\item 
+typedef struct {\bf th\-\_\-dec\-\_\-ctx} {\bf th\-\_\-dec\-\_\-ctx}
+\begin{DoxyCompactList}\small\item\em \-The decoder context. \end{DoxyCompactList}\item 
+typedef struct {\bf th\-\_\-setup\-\_\-info} {\bf th\-\_\-setup\-\_\-info}
+\begin{DoxyCompactList}\small\item\em \-Setup information. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\end{Indent}
+\subsection*{\-Functions}
+\begin{Indent}{\bf \-Functions for decoding}\par
+{\em \-You must link to {\ttfamily libtheoradec} if you use any of the functions in this section.
+
+\-The functions are listed in the order they are used in a typical decode. \-The basic steps are\-:
+\begin{DoxyItemize}
+\item \-Parse the header packets by repeatedly calling \doxyref{th\-\_\-decode\-\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}.
+\item \-Allocate a \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle with \doxyref{th\-\_\-decode\-\_\-alloc()}{p.}{group__decfuncs_ga0ef07a9a97849054aa606c595a2d807e}.
+\item \-Call \doxyref{th\-\_\-setup\-\_\-free()}{p.}{group__decfuncs_gadef55431b68aaa59d0d7b32b2f118f27} to free any memory used for codec setup information.
+\item \-Perform any additional decoder configuration with \doxyref{th\-\_\-decode\-\_\-ctl()}{p.}{group__decfuncs_ga1a8051958d75b1012573b6e3c8f670e1}.
+\item \-For each video data packet\-:
+\begin{DoxyItemize}
+\item \-Submit the packet to the decoder via \doxyref{th\-\_\-decode\-\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}.
+\item \-Retrieve the uncompressed video data via \doxyref{th\-\_\-decode\-\_\-ycbcr\-\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}.
+\end{DoxyItemize}
+\item \-Call \doxyref{th\-\_\-decode\-\_\-free()}{p.}{group__decfuncs_gafb6684ad8ba507b71112bc9de148e7d0} to release all decoder memory. 
+\end{DoxyItemize}}\begin{DoxyCompactItemize}
+\item 
+int {\bf th\-\_\-decode\-\_\-headerin} ({\bf th\-\_\-info} $\ast$\-\_\-info, {\bf th\-\_\-comment} $\ast$\-\_\-tc, {\bf th\-\_\-setup\-\_\-info} $\ast$$\ast$\-\_\-setup, ogg\-\_\-packet $\ast$\-\_\-op)
+\begin{DoxyCompactList}\small\item\em \-Decodes the header packets of a \-Theora stream. \end{DoxyCompactList}\item 
+{\bf th\-\_\-dec\-\_\-ctx} $\ast$ {\bf th\-\_\-decode\-\_\-alloc} (const {\bf th\-\_\-info} $\ast$\-\_\-info, const {\bf th\-\_\-setup\-\_\-info} $\ast$\-\_\-setup)
+\begin{DoxyCompactList}\small\item\em \-Allocates a decoder instance. \end{DoxyCompactList}\item 
+void {\bf th\-\_\-setup\-\_\-free} ({\bf th\-\_\-setup\-\_\-info} $\ast$\-\_\-setup)
+\begin{DoxyCompactList}\small\item\em \-Releases all storage used for the decoder setup information. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-decode\-\_\-ctl} ({\bf th\-\_\-dec\-\_\-ctx} $\ast$\-\_\-dec, int \-\_\-req, void $\ast$\-\_\-buf, size\-\_\-t \-\_\-buf\-\_\-sz)
+\begin{DoxyCompactList}\small\item\em \-Decoder control function. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-decode\-\_\-packetin} ({\bf th\-\_\-dec\-\_\-ctx} $\ast$\-\_\-dec, const ogg\-\_\-packet $\ast$\-\_\-op, ogg\-\_\-int64\-\_\-t $\ast$\-\_\-granpos)
+\begin{DoxyCompactList}\small\item\em \-Submits a packet containing encoded video data to the decoder. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-decode\-\_\-ycbcr\-\_\-out} ({\bf th\-\_\-dec\-\_\-ctx} $\ast$\-\_\-dec, {\bf th\-\_\-ycbcr\-\_\-buffer} \-\_\-ycbcr)
+\begin{DoxyCompactList}\small\item\em \-Outputs the next available frame of decoded \-Y'\-Cb\-Cr data. \end{DoxyCompactList}\item 
+void {\bf th\-\_\-decode\-\_\-free} ({\bf th\-\_\-dec\-\_\-ctx} $\ast$\-\_\-dec)
+\begin{DoxyCompactList}\small\item\em \-Frees an allocated decoder instance. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\end{Indent}
+
+
+\subsection{\-Detailed \-Description}
+\-The {\ttfamily libtheoradec} \-C decoding \-A\-P\-I. 
+
+\subsection{\-Define \-Documentation}
+\index{theoradec.\-h@{theoradec.\-h}!\-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-@{\-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-}}
+\index{\-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-@{\-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-\_\-\-O\-\_\-\-T\-H\-E\-O\-R\-A\-\_\-\-T\-H\-E\-O\-R\-A\-D\-E\-C\-\_\-\-H\-\_\-}~(1)}\label{theoradec_8h_a0d78767a326c34dbf84d5b845cba7b4a}
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}~(1)}\label{theoradec_8h_ab31f251c9319f2140d247585d30b3d07}
+
+
+\-Gets the maximum post-\/processing level. 
+
+\-The decoder supports a post-\/processing filter that can improve the appearance of the decoded images. \-This returns the highest level setting for this post-\/processor, corresponding to maximum improvement and computational expense.
+
+
+\begin{DoxyParams}[1]{\-Parameters}
+\mbox{\tt out}  & {\em \-\_\-buf} & int\-: \-The maximum post-\/processing level. \\
+\hline
+\end{DoxyParams}
+
+\begin{DoxyRetVals}{\-Return values}
+{\em \-T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec\-\_\-ctx\/} or {\itshape \-\_\-buf\/} is {\ttfamily \-N\-U\-L\-L}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-N\-V\-A\-L} & {\itshape \-\_\-buf\-\_\-sz\/} is not {\ttfamily sizeof(int)}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-M\-P\-L} & \-Not supported by this implementation. \\
+\hline
+\end{DoxyRetVals}
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}~(5)}\label{theoradec_8h_a1e870c654d35394f0d490045df04e0f5}
+
+
+\-Sets the granule position. 
+
+\-Call this after a seek, before decoding the first frame, to ensure that the proper granule position is returned for all subsequent frames. \-If you track timestamps yourself and do not use the granule position returned by the decoder, then you need not call this function.
+
+
+\begin{DoxyParams}[1]{\-Parameters}
+\mbox{\tt in}  & {\em \-\_\-buf} & {\ttfamily ogg\-\_\-int64\-\_\-t}\-: \-The granule position of the next frame. \\
+\hline
+\end{DoxyParams}
+
+\begin{DoxyRetVals}{\-Return values}
+{\em \-T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec\-\_\-ctx\/} or {\itshape \-\_\-buf\/} is {\ttfamily \-N\-U\-L\-L}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-N\-V\-A\-L} & {\itshape \-\_\-buf\-\_\-sz\/} is not {\ttfamily sizeof(ogg\-\_\-int64\-\_\-t)}, or the granule position is negative. \\
+\hline
+\end{DoxyRetVals}
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L}~(3)}\label{theoradec_8h_a87774c35e1a755a84e2d705b38ebef0d}
+
+
+\-Sets the post-\/processing level. 
+
+\-By default, post-\/processing is disabled.
+
+\-Sets the level of post-\/processing to use when decoding the compressed stream. \-This must be a value between zero (off) and the maximum returned by \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X.
+
+
+\begin{DoxyParams}[1]{\-Parameters}
+\mbox{\tt in}  & {\em \-\_\-buf} & int\-: \-The new post-\/processing level. 0 to disable; larger values use more \-C\-P\-U. \\
+\hline
+\end{DoxyParams}
+
+\begin{DoxyRetVals}{\-Return values}
+{\em \-T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec\-\_\-ctx\/} or {\itshape \-\_\-buf\/} is {\ttfamily \-N\-U\-L\-L}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-N\-V\-A\-L} & {\itshape \-\_\-buf\-\_\-sz\/} is not {\ttfamily sizeof(int)}, or the post-\/processing level is out of bounds. \-The maximum post-\/processing level may be implementation-\/specific, and can be obtained via \doxyref{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-G\-E\-T\-\_\-\-P\-P\-L\-E\-V\-E\-L\-\_\-\-M\-A\-X}{p.}{theoradec_8h_ab31f251c9319f2140d247585d30b3d07}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-M\-P\-L} & \-Not supported by this implementation. \\
+\hline
+\end{DoxyRetVals}
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}~(7)}\label{theoradec_8h_ac95cc9e109474b0fa4bb920ab2cfdf1e}
+
+
+\-Sets the striped decode callback function. 
+
+\-If set, this function will be called as each piece of a frame is fully decoded in \doxyref{th\-\_\-decode\-\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}. \-You can pass in a \doxyref{th\-\_\-stripe\-\_\-callback}{p.}{structth__stripe__callback} with \doxyref{th\-\_\-stripe\-\_\-callback\-::stripe\-\_\-decoded}{p.}{structth__stripe__callback_a977c725680a37e3446e459f063b1f4a5} set to {\ttfamily \-N\-U\-L\-L} to disable the callbacks at any point. \-Enabling striped decode does not prevent you from calling \doxyref{th\-\_\-decode\-\_\-ycbcr\-\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb} after the frame is fully decoded.
+
+
+\begin{DoxyParams}[1]{\-Parameters}
+\mbox{\tt in}  & {\em \-\_\-buf} & \doxyref{th\-\_\-stripe\-\_\-callback}{p.}{structth__stripe__callback}\-: \-The callback parameters. \\
+\hline
+\end{DoxyParams}
+
+\begin{DoxyRetVals}{\-Return values}
+{\em \-T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec\-\_\-ctx\/} or {\itshape \-\_\-buf\/} is {\ttfamily \-N\-U\-L\-L}. \\
+\hline
+{\em \-T\-H\-\_\-\-E\-I\-N\-V\-A\-L} & {\itshape \-\_\-buf\-\_\-sz\/} is not {\ttfamily sizeof(th\-\_\-stripe\-\_\-callback)}. \\
+\hline
+\end{DoxyRetVals}
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-B\-I\-T\-S}~(15)}\label{theoradec_8h_a7f43fec07486f8a5f00e92aab7d44a25}
+
+
+\-Enables telemetry and sets the bitstream breakdown visualization mode. 
+
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-B\-M\-O\-D\-E}~(9)}\label{theoradec_8h_a8d5e0b9b4c8898f93f241acbeb7e7ffb}
+
+
+\-Enables telemetry and sets the macroblock display mode. 
+
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-M\-V}~(11)}\label{theoradec_8h_a829285a03d24832c583f33c6357df8aa}
+
+
+\-Enables telemetry and sets the motion vector display mode. 
+
+\index{theoradec.\-h@{theoradec.\-h}!\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I}}
+\index{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I@{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{\-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I}]{\setlength{\rightskip}{0pt plus 5cm}\#define {\bf \-T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-T\-E\-L\-E\-M\-E\-T\-R\-Y\-\_\-\-Q\-I}~(13)}\label{theoradec_8h_ae3e2f7674ad92fe67b63915d48c9df5b}
+
+
+\-Enables telemetry and sets the adaptive quantization display mode. 
+
+
+
+\subsection{\-Typedef \-Documentation}
+\index{theoradec.\-h@{theoradec.\-h}!th\-\_\-dec\-\_\-ctx@{th\-\_\-dec\-\_\-ctx}}
+\index{th\-\_\-dec\-\_\-ctx@{th\-\_\-dec\-\_\-ctx}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{th\-\_\-dec\-\_\-ctx}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf th\-\_\-dec\-\_\-ctx} {\bf th\-\_\-dec\-\_\-ctx}}\label{theoradec_8h_a843d70bb02563885a8d54b9c1a781729}
+
+
+\-The decoder context. 
+
+\index{theoradec.\-h@{theoradec.\-h}!th\-\_\-setup\-\_\-info@{th\-\_\-setup\-\_\-info}}
+\index{th\-\_\-setup\-\_\-info@{th\-\_\-setup\-\_\-info}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{th\-\_\-setup\-\_\-info}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf th\-\_\-setup\-\_\-info} {\bf th\-\_\-setup\-\_\-info}}\label{theoradec_8h_ab71cd2657455cc27d6c0127c66a89f28}
+
+
+\-Setup information. 
+
+\-This contains auxiliary information (\-Huffman tables and quantization parameters) decoded from the setup header by \doxyref{th\-\_\-decode\-\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50} to be passed to \doxyref{th\-\_\-decode\-\_\-alloc()}{p.}{group__decfuncs_ga0ef07a9a97849054aa606c595a2d807e}. \-It can be re-\/used to initialize any number of decoders, and can be freed via \doxyref{th\-\_\-setup\-\_\-free()}{p.}{group__decfuncs_gadef55431b68aaa59d0d7b32b2f118f27} at any time. \index{theoradec.\-h@{theoradec.\-h}!th\-\_\-stripe\-\_\-decoded\-\_\-func@{th\-\_\-stripe\-\_\-decoded\-\_\-func}}
+\index{th\-\_\-stripe\-\_\-decoded\-\_\-func@{th\-\_\-stripe\-\_\-decoded\-\_\-func}!theoradec.h@{theoradec.\-h}}
+\subsubsection[{th\-\_\-stripe\-\_\-decoded\-\_\-func}]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$ {\bf th\-\_\-stripe\-\_\-decoded\-\_\-func})(void $\ast$\-\_\-ctx, {\bf th\-\_\-ycbcr\-\_\-buffer} \-\_\-buf, int \-\_\-yfrag0, int \-\_\-yfrag\-\_\-end)}\label{theoradec_8h_a25dfc8713157545abd81eda476ca4b54}
+
+
+\-A callback function for striped decode. 
+
+\-This is a function pointer to an application-\/provided function that will be called each time a section of the image is fully decoded in \doxyref{th\-\_\-decode\-\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}. \-This allows the application to process the section immediately, while it is still in cache. \-Note that the frame is decoded bottom to top, so {\itshape \-\_\-yfrag0\/} will steadily decrease with each call until it reaches 0, at which point the full frame is decoded. \-The number of fragment rows made available in each call depends on the pixel format and the number of post-\/processing filters enabled, and may not even be constant for the entire frame. \-If a non-\/{\ttfamily \-N\-U\-L\-L} {\itshape \-\_\-granpos\/} pointer is passed to \doxyref{th\-\_\-decode\-\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}, the granule position for the frame will be stored in it before the first callback is made. \-If an entire frame is dropped (a 0-\/byte packet), then no callbacks will be made at all for that frame. 
+\begin{DoxyParams}{\-Parameters}
+{\em \-\_\-ctx} & \-An application-\/provided context pointer. \\
+\hline
+{\em \-\_\-buf} & \-The image buffer for the decoded frame. \\
+\hline
+{\em \-\_\-yfrag0} & \-The \-Y coordinate of the first row of 8x8 fragments decoded. \-Multiply this by 8 to obtain the pixel row number in the luma plane. \-If the chroma planes are subsampled in the \-Y direction, this will always be divisible by two. \\
+\hline
+{\em \-\_\-yfrag\-\_\-end} & \-The \-Y coordinate of the first row of 8x8 fragments past the newly decoded section. \-If the chroma planes are subsampled in the \-Y direction, this will always be divisible by two. \-I.\-e., this section contains fragment rows {\ttfamily {\itshape \-\_\-yfrag0\/} ...{\itshape \-\_\-yfrag\-\_\-end\/} -\/1}. \\
+\hline
+\end{DoxyParams}