gstreamer 1.2.2-x86-mingw32 → 1.2.3-x86-mingw32

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

@@ -1,111 +1,226 @@
 \section{Functions for Decoding}
 \label{group__decfuncs}\index{Functions for Decoding@{Functions for Decoding}}
 \subsection*{Functions for decoding}
-\label{_amgrp9d29c94aa62f20426aa5ff062c7daedd}
+\label{_amgrp9d29c94aa62f20426aa5ff062c7daedd}%
 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:
+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:
+\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}.
+\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. 
+\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. \item\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. \item\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. \item\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. \item\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. \item\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'CbCr data. \item\end{DoxyCompactList}\item 
-void {\bf th\_\-decode\_\-free} ({\bf th\_\-dec\_\-ctx} $\ast$\_\-dec)
-\begin{DoxyCompactList}\small\item\em Frees an allocated decoder instance. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+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}
+
+
+\subsection{Detailed Description}
 
 
 \subsection{Function Documentation}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-alloc@{th\_\-decode\_\-alloc}}
-\index{th\_\-decode\_\-alloc@{th\_\-decode\_\-alloc}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-alloc}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\_\-dec\_\-ctx}$\ast$ th\_\-decode\_\-alloc (const {\bf th\_\-info} $\ast$ {\em \_\-info}, \/  const {\bf th\_\-setup\_\-info} $\ast$ {\em \_\-setup})}\label{group__decfuncs_ga0ef07a9a97849054aa606c595a2d807e}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-alloc@{th\-\_\-decode\-\_\-alloc}}
+\index{th\-\_\-decode\-\_\-alloc@{th\-\_\-decode\-\_\-alloc}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-alloc}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\-\_\-dec\-\_\-ctx}$\ast$ th\-\_\-decode\-\_\-alloc (
+\begin{DoxyParamCaption}
+\item[{const {\bf th\-\_\-info} $\ast$}]{\-\_\-info, }
+\item[{const {\bf th\-\_\-setup\-\_\-info} $\ast$}]{\-\_\-setup}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_ga0ef07a9a97849054aa606c595a2d807e}
 
 
-Allocates a decoder instance. {\bfseries Security Warning:} The Theora format supports very large frame sizes, potentially even larger than the address space of a 32-\/bit machine, and creating a decoder context allocates the space for several frames of data. If the allocation fails here, your program will crash, possibly at some future point because the OS kernel returned a valid memory range and will only fail when it tries to map the pages in it the first time they are used. Even if it succeeds, you may experience a denial of service if the frame size is large enough to cause excessive paging. If you are integrating libtheora in a larger application where such things are undesirable, it is highly recommended that you check the frame size in {\itshape \_\-info\/} before calling this function and refuse to decode streams where it is larger than some reasonable maximum. libtheora will not check this for you, because there may be machines that can handle such streams and applications that wish to. 
+Allocates a decoder instance. 
+
+{\bfseries Security Warning\-:} The Theora format supports very large frame sizes, potentially even larger than the address space of a 32-\/bit machine, and creating a decoder context allocates the space for several frames of data. If the allocation fails here, your program will crash, possibly at some future point because the O\-S kernel returned a valid memory range and will only fail when it tries to map the pages in it the first time they are used. Even if it succeeds, you may experience a denial of service if the frame size is large enough to cause excessive paging. If you are integrating libtheora in a larger application where such things are undesirable, it is highly recommended that you check the frame size in {\itshape \-\_\-info} before calling this function and refuse to decode streams where it is larger than some reasonable maximum. libtheora will not check this for you, because there may be machines that can handle such streams and applications that wish to. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-info}]A \doxyref{th\_\-info}{p.}{structth__info} struct filled via \doxyref{th\_\-decode\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. \item[{\em \_\-setup}]A \doxyref{th\_\-setup\_\-info}{p.}{theoradec_8h_ab71cd2657455cc27d6c0127c66a89f28} handle returned via \doxyref{th\_\-decode\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. \end{DoxyParams}
+{\em \-\_\-info} & A \doxyref{th\-\_\-info}{p.}{structth__info} struct filled via \doxyref{th\-\_\-decode\-\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. \\
+\hline
+{\em \-\_\-setup} & A \doxyref{th\-\_\-setup\-\_\-info}{p.}{theoradec_8h_ab71cd2657455cc27d6c0127c66a89f28} handle returned via \doxyref{th\-\_\-decode\-\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. \\
+\hline
+\end{DoxyParams}
 \begin{DoxyReturn}{Returns}
-The initialized \doxyref{th\_\-dec\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. 
+The initialized \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. 
 \end{DoxyReturn}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em NULL}]If the decoding parameters were invalid. \end{DoxyRetVals}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-ctl@{th\_\-decode\_\-ctl}}
-\index{th\_\-decode\_\-ctl@{th\_\-decode\_\-ctl}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-ctl}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-decode\_\-ctl ({\bf th\_\-dec\_\-ctx} $\ast$ {\em \_\-dec}, \/  int {\em \_\-req}, \/  void $\ast$ {\em \_\-buf}, \/  size\_\-t {\em \_\-buf\_\-sz})}\label{group__decfuncs_ga1a8051958d75b1012573b6e3c8f670e1}
-
-
-Decoder control function. This is used to provide advanced control of the decoding process. 
+{\em N\-U\-L\-L} & If the decoding parameters were invalid. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-ctl@{th\-\_\-decode\-\_\-ctl}}
+\index{th\-\_\-decode\-\_\-ctl@{th\-\_\-decode\-\_\-ctl}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-ctl}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-decode\-\_\-ctl (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-dec\-\_\-ctx} $\ast$}]{\-\_\-dec, }
+\item[{int}]{\-\_\-req, }
+\item[{void $\ast$}]{\-\_\-buf, }
+\item[{size\-\_\-t}]{\-\_\-buf\-\_\-sz}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_ga1a8051958d75b1012573b6e3c8f670e1}
+
+
+Decoder control function. 
+
+This is used to provide advanced control of the decoding process. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-dec}]A \doxyref{th\_\-dec\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \item[{\em \_\-req}]The control code to process. See \doxyref{the list of available control codes}{p.}{theoradec_8h_decctlcodes} for details. \item[{\em \_\-buf}]The parameters for this control code. \item[{\em \_\-buf\_\-sz}]The size of the parameter buffer. \end{DoxyParams}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-free@{th\_\-decode\_\-free}}
-\index{th\_\-decode\_\-free@{th\_\-decode\_\-free}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\_\-decode\_\-free ({\bf th\_\-dec\_\-ctx} $\ast$ {\em \_\-dec})}\label{group__decfuncs_gafb6684ad8ba507b71112bc9de148e7d0}
+{\em \-\_\-dec} & A \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \\
+\hline
+{\em \-\_\-req} & The control code to process. See \doxyref{the list of available control codes}{p.}{theoradec_8h_decctlcodes} for details. \\
+\hline
+{\em \-\_\-buf} & The parameters for this control code. \\
+\hline
+{\em \-\_\-buf\-\_\-sz} & The size of the parameter buffer. \\
+\hline
+\end{DoxyParams}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-free@{th\-\_\-decode\-\_\-free}}
+\index{th\-\_\-decode\-\_\-free@{th\-\_\-decode\-\_\-free}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\-\_\-decode\-\_\-free (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-dec\-\_\-ctx} $\ast$}]{\-\_\-dec}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_gafb6684ad8ba507b71112bc9de148e7d0}
 
 
 Frees an allocated decoder instance. 
-\begin{DoxyParams}{Parameters}
-\item[{\em \_\-dec}]A \doxyref{th\_\-dec\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \end{DoxyParams}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-headerin@{th\_\-decode\_\-headerin}}
-\index{th\_\-decode\_\-headerin@{th\_\-decode\_\-headerin}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-headerin}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-decode\_\-headerin ({\bf th\_\-info} $\ast$ {\em \_\-info}, \/  {\bf th\_\-comment} $\ast$ {\em \_\-tc}, \/  {\bf th\_\-setup\_\-info} $\ast$$\ast$ {\em \_\-setup}, \/  ogg\_\-packet $\ast$ {\em \_\-op})}\label{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}
 
 
-Decodes the header packets of a Theora stream. This should be called on the initial packets of the stream, in succession, until it returns {\ttfamily 0}, indicating that all headers have been processed, or an error is encountered. At least three header packets are required, and additional optional header packets may follow. This can be used on the first packet of any logical stream to determine if that stream is a Theora stream. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-info}]A \doxyref{th\_\-info}{p.}{structth__info} structure to fill in. This must have been previously initialized with \doxyref{th\_\-info\_\-init()}{p.}{group__basefuncs_ga430d9c605816a6ca0bdce3a0b965b926}. The application may immediately begin using the contents of this structure after the first header is decoded, though it must continue to be passed in on all subsequent calls. \item[{\em \_\-tc}]A \doxyref{th\_\-comment}{p.}{structth__comment} structure to fill in. The application may immediately begin using the contents of this structure after the second header is decoded, though it must continue to be passed in on all subsequent calls. \item[{\em \_\-setup}]Returns a pointer to additional, private setup information needed by the decoder. The contents of this pointer must be initialized to {\ttfamily NULL} on the first call, and the returned value must continue to be passed in on all subsequent calls. \item[{\em \_\-op}]An {\ttfamily ogg\_\-packet} structure which contains one of the initial packets of an Ogg logical stream. \end{DoxyParams}
+{\em \-\_\-dec} & A \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \\
+\hline
+\end{DoxyParams}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-headerin@{th\-\_\-decode\-\_\-headerin}}
+\index{th\-\_\-decode\-\_\-headerin@{th\-\_\-decode\-\_\-headerin}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-headerin}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-decode\-\_\-headerin (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-info} $\ast$}]{\-\_\-info, }
+\item[{{\bf th\-\_\-comment} $\ast$}]{\-\_\-tc, }
+\item[{{\bf th\-\_\-setup\-\_\-info} $\ast$$\ast$}]{\-\_\-setup, }
+\item[{ogg\-\_\-packet $\ast$}]{\-\_\-op}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}
+
+
+Decodes the header packets of a Theora stream. 
+
+This should be called on the initial packets of the stream, in succession, until it returns {\ttfamily 0}, indicating that all headers have been processed, or an error is encountered. At least three header packets are required, and additional optional header packets may follow. This can be used on the first packet of any logical stream to determine if that stream is a Theora stream. 
+\begin{DoxyParams}{Parameters}
+{\em \-\_\-info} & A \doxyref{th\-\_\-info}{p.}{structth__info} structure to fill in. This must have been previously initialized with \doxyref{th\-\_\-info\-\_\-init()}{p.}{group__basefuncs_ga430d9c605816a6ca0bdce3a0b965b926}. The application may immediately begin using the contents of this structure after the first header is decoded, though it must continue to be passed in on all subsequent calls. \\
+\hline
+{\em \-\_\-tc} & A \doxyref{th\-\_\-comment}{p.}{structth__comment} structure to fill in. The application may immediately begin using the contents of this structure after the second header is decoded, though it must continue to be passed in on all subsequent calls. \\
+\hline
+{\em \-\_\-setup} & Returns a pointer to additional, private setup information needed by the decoder. The contents of this pointer must be initialized to {\ttfamily N\-U\-L\-L} on the first call, and the returned value must continue to be passed in on all subsequent calls. \\
+\hline
+{\em \-\_\-op} & An {\ttfamily ogg\-\_\-packet} structure which contains one of the initial packets of an Ogg logical stream. \\
+\hline
+\end{DoxyParams}
 \begin{DoxyReturn}{Returns}
 A positive value indicates that a Theora header was successfully processed. 
 \end{DoxyReturn}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em 0}]The first video data packet was encountered after all required header packets were parsed. The packet just passed in on this call should be saved and fed to \doxyref{th\_\-decode\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb} to begin decoding video data. \item[{\em TH\_\-EFAULT}]One of {\itshape \_\-info\/}, {\itshape \_\-tc\/}, or {\itshape \_\-setup\/} was {\ttfamily NULL}. \item[{\em TH\_\-EBADHEADER}]{\itshape \_\-op\/} was {\ttfamily NULL}, the packet was not the next header packet in the expected sequence, or the format of the header data was invalid. \item[{\em TH\_\-EVERSION}]The packet data was a Theora info header, but for a bitstream version not decodable with this version of {\ttfamily libtheoradec}. \item[{\em TH\_\-ENOTFORMAT}]The packet was not a Theora header. \end{DoxyRetVals}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-packetin@{th\_\-decode\_\-packetin}}
-\index{th\_\-decode\_\-packetin@{th\_\-decode\_\-packetin}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-packetin}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-decode\_\-packetin ({\bf th\_\-dec\_\-ctx} $\ast$ {\em \_\-dec}, \/  const ogg\_\-packet $\ast$ {\em \_\-op}, \/  ogg\_\-int64\_\-t $\ast$ {\em \_\-granpos})}\label{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}
+{\em 0} & The first video data packet was encountered after all required header packets were parsed. The packet just passed in on this call should be saved and fed to \doxyref{th\-\_\-decode\-\_\-packetin()}{p.}{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb} to begin decoding video data. \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & One of {\itshape \-\_\-info}, {\itshape \-\_\-tc}, or {\itshape \-\_\-setup} was {\ttfamily N\-U\-L\-L}. \\
+\hline
+{\em T\-H\-\_\-\-E\-B\-A\-D\-H\-E\-A\-D\-E\-R} & {\itshape \-\_\-op} was {\ttfamily N\-U\-L\-L}, the packet was not the next header packet in the expected sequence, or the format of the header data was invalid. \\
+\hline
+{\em T\-H\-\_\-\-E\-V\-E\-R\-S\-I\-O\-N} & The packet data was a Theora info header, but for a bitstream version not decodable with this version of {\ttfamily libtheoradec}. \\
+\hline
+{\em T\-H\-\_\-\-E\-N\-O\-T\-F\-O\-R\-M\-A\-T} & The packet was not a Theora header. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-packetin@{th\-\_\-decode\-\_\-packetin}}
+\index{th\-\_\-decode\-\_\-packetin@{th\-\_\-decode\-\_\-packetin}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-packetin}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-decode\-\_\-packetin (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-dec\-\_\-ctx} $\ast$}]{\-\_\-dec, }
+\item[{const ogg\-\_\-packet $\ast$}]{\-\_\-op, }
+\item[{ogg\-\_\-int64\-\_\-t $\ast$}]{\-\_\-granpos}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_ga31c814bf09b2232aff69c57ae20f04eb}
 
 
 Submits a packet containing encoded video data to the decoder. 
-\begin{DoxyParams}{Parameters}
-\item[{\em \_\-dec}]A \doxyref{th\_\-dec\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \item[{\em \_\-op}]An {\ttfamily ogg\_\-packet} containing encoded video data. \item[{\em \_\-granpos}]Returns the granule position of the decoded packet. If non-\/{\ttfamily NULL}, the granule position for this specific packet is stored in this location. This is computed incrementally from previously decoded packets. After a seek, the correct granule position must be set via \doxyref{TH\_\-DECCTL\_\-SET\_\-GRANPOS}{p.}{theoradec_8h_a1e870c654d35394f0d490045df04e0f5} for this to work properly. \end{DoxyParams}
-
-\begin{DoxyRetVals}{Return values}
-\item[{\em 0}]Success. A new decoded frame can be retrieved by calling \doxyref{th\_\-decode\_\-ycbcr\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}. \item[{\em TH\_\-DUPFRAME}]The packet represented a dropped (0-\/byte) frame. The player can skip the call to \doxyref{th\_\-decode\_\-ycbcr\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}, as the contents of the decoded frame buffer have not changed. \item[{\em TH\_\-EFAULT}]{\itshape \_\-dec\/} or {\itshape \_\-op\/} was {\ttfamily NULL}. \item[{\em TH\_\-EBADPACKET}]{\itshape \_\-op\/} does not contain encoded video data. \item[{\em TH\_\-EIMPL}]The video data uses bitstream features which this library does not support. \end{DoxyRetVals}
-\index{decfuncs@{decfuncs}!th\_\-decode\_\-ycbcr\_\-out@{th\_\-decode\_\-ycbcr\_\-out}}
-\index{th\_\-decode\_\-ycbcr\_\-out@{th\_\-decode\_\-ycbcr\_\-out}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-decode\_\-ycbcr\_\-out}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-decode\_\-ycbcr\_\-out ({\bf th\_\-dec\_\-ctx} $\ast$ {\em \_\-dec}, \/  {\bf th\_\-ycbcr\_\-buffer} {\em \_\-ycbcr})}\label{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}
 
 
-Outputs the next available frame of decoded Y'CbCr data. If a striped decode callback has been set with \doxyref{TH\_\-DECCTL\_\-SET\_\-STRIPE\_\-CB}{p.}{theoradec_8h_ac95cc9e109474b0fa4bb920ab2cfdf1e}, then the application does not need to call this function. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-dec}]A \doxyref{th\_\-dec\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \item[{\em \_\-ycbcr}]A video buffer structure to fill in. {\ttfamily libtheoradec} will fill in all the members of this structure, including the pointers to the uncompressed video data. The memory for this video data is owned by {\ttfamily libtheoradec}. It may be freed or overwritten without notification when subsequent frames are decoded. \end{DoxyParams}
+{\em \-\_\-dec} & A \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \\
+\hline
+{\em \-\_\-op} & An {\ttfamily ogg\-\_\-packet} containing encoded video data. \\
+\hline
+{\em \-\_\-granpos} & Returns the granule position of the decoded packet. If non-\/{\ttfamily N\-U\-L\-L}, the granule position for this specific packet is stored in this location. This is computed incrementally from previously decoded packets. After a seek, the correct granule position must be set via \doxyref{T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-G\-R\-A\-N\-P\-O\-S}{p.}{theoradec_8h_a1e870c654d35394f0d490045df04e0f5} for this to work properly. \\
+\hline
+\end{DoxyParams}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em 0}]Success \item[{\em TH\_\-EFAULT}]{\itshape \_\-dec\/} or {\itshape \_\-ycbcr\/} was {\ttfamily NULL}. \end{DoxyRetVals}
-\index{decfuncs@{decfuncs}!th\_\-setup\_\-free@{th\_\-setup\_\-free}}
-\index{th\_\-setup\_\-free@{th\_\-setup\_\-free}!decfuncs@{decfuncs}}
-\subsubsection[{th\_\-setup\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\_\-setup\_\-free ({\bf th\_\-setup\_\-info} $\ast$ {\em \_\-setup})}\label{group__decfuncs_gadef55431b68aaa59d0d7b32b2f118f27}
-
+{\em 0} & Success. A new decoded frame can be retrieved by calling \doxyref{th\-\_\-decode\-\_\-ycbcr\-\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}. \\
+\hline
+{\em T\-H\-\_\-\-D\-U\-P\-F\-R\-A\-M\-E} & The packet represented a dropped (0-\/byte) frame. The player can skip the call to \doxyref{th\-\_\-decode\-\_\-ycbcr\-\_\-out()}{p.}{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}, as the contents of the decoded frame buffer have not changed. \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec} or {\itshape \-\_\-op} was {\ttfamily N\-U\-L\-L}. \\
+\hline
+{\em T\-H\-\_\-\-E\-B\-A\-D\-P\-A\-C\-K\-E\-T} & {\itshape \-\_\-op} does not contain encoded video data. \\
+\hline
+{\em T\-H\-\_\-\-E\-I\-M\-P\-L} & The video data uses bitstream features which this library does not support. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-decode\-\_\-ycbcr\-\_\-out@{th\-\_\-decode\-\_\-ycbcr\-\_\-out}}
+\index{th\-\_\-decode\-\_\-ycbcr\-\_\-out@{th\-\_\-decode\-\_\-ycbcr\-\_\-out}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-decode\-\_\-ycbcr\-\_\-out}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-decode\-\_\-ycbcr\-\_\-out (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-dec\-\_\-ctx} $\ast$}]{\-\_\-dec, }
+\item[{{\bf th\-\_\-ycbcr\-\_\-buffer}}]{\-\_\-ycbcr}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_gaa9cc8af63fa8540e0fc95572f259cdcb}
+
+
+Outputs the next available frame of decoded Y'Cb\-Cr data. 
+
+If a striped decode callback has been set with \doxyref{T\-H\-\_\-\-D\-E\-C\-C\-T\-L\-\_\-\-S\-E\-T\-\_\-\-S\-T\-R\-I\-P\-E\-\_\-\-C\-B}{p.}{theoradec_8h_ac95cc9e109474b0fa4bb920ab2cfdf1e}, then the application does not need to call this function. 
+\begin{DoxyParams}{Parameters}
+{\em \-\_\-dec} & A \doxyref{th\-\_\-dec\-\_\-ctx}{p.}{theoradec_8h_a843d70bb02563885a8d54b9c1a781729} handle. \\
+\hline
+{\em \-\_\-ycbcr} & A video buffer structure to fill in. {\ttfamily libtheoradec} will fill in all the members of this structure, including the pointers to the uncompressed video data. The memory for this video data is owned by {\ttfamily libtheoradec}. It may be freed or overwritten without notification when subsequent frames are decoded. \\
+\hline
+\end{DoxyParams}
 
-Releases all storage used for the decoder setup information. This should be called after you no longer want to create any decoders for a stream whose headers you have parsed with \doxyref{th\_\-decode\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. 
+\begin{DoxyRetVals}{Return values}
+{\em 0} & Success \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-dec} or {\itshape \-\_\-ycbcr} was {\ttfamily N\-U\-L\-L}. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Decoding@{Functions for Decoding}!th\-\_\-setup\-\_\-free@{th\-\_\-setup\-\_\-free}}
+\index{th\-\_\-setup\-\_\-free@{th\-\_\-setup\-\_\-free}!Functions for Decoding@{Functions for Decoding}}
+\subsubsection[{th\-\_\-setup\-\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\-\_\-setup\-\_\-free (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-setup\-\_\-info} $\ast$}]{\-\_\-setup}
+\end{DoxyParamCaption}
+)}\label{group__decfuncs_gadef55431b68aaa59d0d7b32b2f118f27}
+
+
+Releases all storage used for the decoder setup information. 
+
+This should be called after you no longer want to create any decoders for a stream whose headers you have parsed with \doxyref{th\-\_\-decode\-\_\-headerin()}{p.}{group__decfuncs_ga006d01d36fbe64768c571e6a12b7fc50}. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-setup}]The setup information to free. This can safely be {\ttfamily NULL}. \end{DoxyParams}
+{\em \-\_\-setup} & The setup information to free. This can safely be {\ttfamily N\-U\-L\-L}. \\
+\hline
+\end{DoxyParams}

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

@@ -1,107 +1,198 @@
 \section{Functions for Encoding}
 \label{group__encfuncs}\index{Functions for Encoding@{Functions for Encoding}}
 \subsection*{Functions for encoding}
-\label{_amgrpc58fb8743a7ca83eb895d57e29e032c8}
+\label{_amgrpc58fb8743a7ca83eb895d57e29e032c8}%
 You must link to {\ttfamily libtheoraenc} and {\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 encode. The basic steps are:
+The functions are listed in the order they are used in a typical encode. The basic steps are\-:
 \begin{DoxyItemize}
-\item Fill in a \doxyref{th\_\-info}{p.}{structth__info} structure with details on the format of the video you wish to encode.
-\item Allocate a \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle with \doxyref{th\_\-encode\_\-alloc()}{p.}{group__encfuncs_gaa91e47bc9dd5f6ee52045bd7b815e5a7}.
-\item Perform any additional encoder configuration required with \doxyref{th\_\-encode\_\-ctl()}{p.}{group__encfuncs_ga3a427f6514dfdc01ea72172c469d51d9}.
-\item Repeatedly call \doxyref{th\_\-encode\_\-flushheader()}{p.}{group__encfuncs_ga9439d61b566039d194ff782681fbc408} to retrieve all the header packets.
-\item For each uncompressed frame:
+\item Fill in a \doxyref{th\-\_\-info}{p.}{structth__info} structure with details on the format of the video you wish to encode.
+\item Allocate a \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle with \doxyref{th\-\_\-encode\-\_\-alloc()}{p.}{group__encfuncs_gaa91e47bc9dd5f6ee52045bd7b815e5a7}.
+\item Perform any additional encoder configuration required with \doxyref{th\-\_\-encode\-\_\-ctl()}{p.}{group__encfuncs_ga3a427f6514dfdc01ea72172c469d51d9}.
+\item Repeatedly call \doxyref{th\-\_\-encode\-\_\-flushheader()}{p.}{group__encfuncs_ga9439d61b566039d194ff782681fbc408} to retrieve all the header packets.
+\item For each uncompressed frame\-:
 \begin{DoxyItemize}
-\item Submit the uncompressed frame via \doxyref{th\_\-encode\_\-ycbcr\_\-in()}{p.}{group__encfuncs_gadbe7dd66b411c2d61ab8153c15308750}
-\item Repeatedly call \doxyref{th\_\-encode\_\-packetout()}{p.}{group__encfuncs_ga96d8ac1dda53187455352f99bbb5b04b} to retrieve any video data packets that are ready.
+\item Submit the uncompressed frame via \doxyref{th\-\_\-encode\-\_\-ycbcr\-\_\-in()}{p.}{group__encfuncs_gadbe7dd66b411c2d61ab8153c15308750}
+\item Repeatedly call \doxyref{th\-\_\-encode\-\_\-packetout()}{p.}{group__encfuncs_ga96d8ac1dda53187455352f99bbb5b04b} to retrieve any video data packets that are ready.
 \end{DoxyItemize}
-\item Call \doxyref{th\_\-encode\_\-free()}{p.}{group__encfuncs_ga36b23d216532231925c4107894204680} to release all encoder memory. 
+\item Call \doxyref{th\-\_\-encode\-\_\-free()}{p.}{group__encfuncs_ga36b23d216532231925c4107894204680} to release all encoder memory. 
 \end{DoxyItemize}\begin{DoxyCompactItemize}
 \item 
-{\bf th\_\-enc\_\-ctx} $\ast$ {\bf th\_\-encode\_\-alloc} (const {\bf th\_\-info} $\ast$\_\-info)
-\begin{DoxyCompactList}\small\item\em Allocates an encoder instance. \item\end{DoxyCompactList}\item 
-int {\bf th\_\-encode\_\-ctl} ({\bf th\_\-enc\_\-ctx} $\ast$\_\-enc, int \_\-req, void $\ast$\_\-buf, size\_\-t \_\-buf\_\-sz)
-\begin{DoxyCompactList}\small\item\em Encoder control function. \item\end{DoxyCompactList}\item 
-int {\bf th\_\-encode\_\-flushheader} ({\bf th\_\-enc\_\-ctx} $\ast$\_\-enc, {\bf th\_\-comment} $\ast$\_\-comments, ogg\_\-packet $\ast$\_\-op)
-\begin{DoxyCompactList}\small\item\em Outputs the next header packet. \item\end{DoxyCompactList}\item 
-int {\bf th\_\-encode\_\-ycbcr\_\-in} ({\bf th\_\-enc\_\-ctx} $\ast$\_\-enc, {\bf th\_\-ycbcr\_\-buffer} \_\-ycbcr)
-\begin{DoxyCompactList}\small\item\em Submits an uncompressed frame to the encoder. \item\end{DoxyCompactList}\item 
-int {\bf th\_\-encode\_\-packetout} ({\bf th\_\-enc\_\-ctx} $\ast$\_\-enc, int \_\-last, ogg\_\-packet $\ast$\_\-op)
-\begin{DoxyCompactList}\small\item\em Retrieves encoded video data packets. \item\end{DoxyCompactList}\item 
-void {\bf th\_\-encode\_\-free} ({\bf th\_\-enc\_\-ctx} $\ast$\_\-enc)
-\begin{DoxyCompactList}\small\item\em Frees an allocated encoder instance. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+{\bf th\-\_\-enc\-\_\-ctx} $\ast$ {\bf th\-\_\-encode\-\_\-alloc} (const {\bf th\-\_\-info} $\ast$\-\_\-info)
+\begin{DoxyCompactList}\small\item\em Allocates an encoder instance. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-encode\-\_\-ctl} ({\bf th\-\_\-enc\-\_\-ctx} $\ast$\-\_\-enc, int \-\_\-req, void $\ast$\-\_\-buf, size\-\_\-t \-\_\-buf\-\_\-sz)
+\begin{DoxyCompactList}\small\item\em Encoder control function. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-encode\-\_\-flushheader} ({\bf th\-\_\-enc\-\_\-ctx} $\ast$\-\_\-enc, {\bf th\-\_\-comment} $\ast$\-\_\-comments, ogg\-\_\-packet $\ast$\-\_\-op)
+\begin{DoxyCompactList}\small\item\em Outputs the next header packet. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-encode\-\_\-ycbcr\-\_\-in} ({\bf th\-\_\-enc\-\_\-ctx} $\ast$\-\_\-enc, {\bf th\-\_\-ycbcr\-\_\-buffer} \-\_\-ycbcr)
+\begin{DoxyCompactList}\small\item\em Submits an uncompressed frame to the encoder. \end{DoxyCompactList}\item 
+int {\bf th\-\_\-encode\-\_\-packetout} ({\bf th\-\_\-enc\-\_\-ctx} $\ast$\-\_\-enc, int \-\_\-last, ogg\-\_\-packet $\ast$\-\_\-op)
+\begin{DoxyCompactList}\small\item\em Retrieves encoded video data packets. \end{DoxyCompactList}\item 
+void {\bf th\-\_\-encode\-\_\-free} ({\bf th\-\_\-enc\-\_\-ctx} $\ast$\-\_\-enc)
+\begin{DoxyCompactList}\small\item\em Frees an allocated encoder instance. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
 
 
 \subsection{Function Documentation}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-alloc@{th\_\-encode\_\-alloc}}
-\index{th\_\-encode\_\-alloc@{th\_\-encode\_\-alloc}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-alloc}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\_\-enc\_\-ctx}$\ast$ th\_\-encode\_\-alloc (const {\bf th\_\-info} $\ast$ {\em \_\-info})}\label{group__encfuncs_gaa91e47bc9dd5f6ee52045bd7b815e5a7}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-alloc@{th\-\_\-encode\-\_\-alloc}}
+\index{th\-\_\-encode\-\_\-alloc@{th\-\_\-encode\-\_\-alloc}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-alloc}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\-\_\-enc\-\_\-ctx}$\ast$ th\-\_\-encode\-\_\-alloc (
+\begin{DoxyParamCaption}
+\item[{const {\bf th\-\_\-info} $\ast$}]{\-\_\-info}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_gaa91e47bc9dd5f6ee52045bd7b815e5a7}
 
 
 Allocates an encoder instance. 
+
+
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-info}]A \doxyref{th\_\-info}{p.}{structth__info} struct filled with the desired encoding parameters. \end{DoxyParams}
+{\em \-\_\-info} & A \doxyref{th\-\_\-info}{p.}{structth__info} struct filled with the desired encoding parameters. \\
+\hline
+\end{DoxyParams}
 \begin{DoxyReturn}{Returns}
-The initialized \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. 
+The initialized \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. 
 \end{DoxyReturn}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em NULL}]If the encoding parameters were invalid. \end{DoxyRetVals}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-ctl@{th\_\-encode\_\-ctl}}
-\index{th\_\-encode\_\-ctl@{th\_\-encode\_\-ctl}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-ctl}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-encode\_\-ctl ({\bf th\_\-enc\_\-ctx} $\ast$ {\em \_\-enc}, \/  int {\em \_\-req}, \/  void $\ast$ {\em \_\-buf}, \/  size\_\-t {\em \_\-buf\_\-sz})}\label{group__encfuncs_ga3a427f6514dfdc01ea72172c469d51d9}
-
-
-Encoder control function. This is used to provide advanced control the encoding process. 
+{\em N\-U\-L\-L} & If the encoding parameters were invalid. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-ctl@{th\-\_\-encode\-\_\-ctl}}
+\index{th\-\_\-encode\-\_\-ctl@{th\-\_\-encode\-\_\-ctl}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-ctl}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-encode\-\_\-ctl (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-enc\-\_\-ctx} $\ast$}]{\-\_\-enc, }
+\item[{int}]{\-\_\-req, }
+\item[{void $\ast$}]{\-\_\-buf, }
+\item[{size\-\_\-t}]{\-\_\-buf\-\_\-sz}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_ga3a427f6514dfdc01ea72172c469d51d9}
+
+
+Encoder control function. 
+
+This is used to provide advanced control the encoding process. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-enc}]A \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \item[{\em \_\-req}]The control code to process. See \doxyref{the list of available control codes}{p.}{theoraenc_8h_encctlcodes} for details. \item[{\em \_\-buf}]The parameters for this control code. \item[{\em \_\-buf\_\-sz}]The size of the parameter buffer. \end{DoxyParams}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-flushheader@{th\_\-encode\_\-flushheader}}
-\index{th\_\-encode\_\-flushheader@{th\_\-encode\_\-flushheader}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-flushheader}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-encode\_\-flushheader ({\bf th\_\-enc\_\-ctx} $\ast$ {\em \_\-enc}, \/  {\bf th\_\-comment} $\ast$ {\em \_\-comments}, \/  ogg\_\-packet $\ast$ {\em \_\-op})}\label{group__encfuncs_ga9439d61b566039d194ff782681fbc408}
-
-
-Outputs the next header packet. This should be called repeatedly after encoder initialization until it returns 0 in order to get all of the header packets, in order, before encoding actual video data. 
+{\em \-\_\-enc} & A \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \\
+\hline
+{\em \-\_\-req} & The control code to process. See \doxyref{the list of available control codes}{p.}{theoraenc_8h_encctlcodes} for details. \\
+\hline
+{\em \-\_\-buf} & The parameters for this control code. \\
+\hline
+{\em \-\_\-buf\-\_\-sz} & The size of the parameter buffer. \\
+\hline
+\end{DoxyParams}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-flushheader@{th\-\_\-encode\-\_\-flushheader}}
+\index{th\-\_\-encode\-\_\-flushheader@{th\-\_\-encode\-\_\-flushheader}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-flushheader}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-encode\-\_\-flushheader (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-enc\-\_\-ctx} $\ast$}]{\-\_\-enc, }
+\item[{{\bf th\-\_\-comment} $\ast$}]{\-\_\-comments, }
+\item[{ogg\-\_\-packet $\ast$}]{\-\_\-op}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_ga9439d61b566039d194ff782681fbc408}
+
+
+Outputs the next header packet. 
+
+This should be called repeatedly after encoder initialization until it returns 0 in order to get all of the header packets, in order, before encoding actual video data. 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-enc}]A \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \item[{\em \_\-comments}]The metadata to place in the comment header, when it is encoded. \item[{\em \_\-op}]An {\ttfamily ogg\_\-packet} structure to fill. All of the elements of this structure will be set, including a pointer to the header data. The memory for the header data is owned by {\ttfamily libtheoraenc}, and may be invalidated when the next encoder function is called. \end{DoxyParams}
+{\em \-\_\-enc} & A \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \\
+\hline
+{\em \-\_\-comments} & The metadata to place in the comment header, when it is encoded. \\
+\hline
+{\em \-\_\-op} & An {\ttfamily ogg\-\_\-packet} structure to fill. All of the elements of this structure will be set, including a pointer to the header data. The memory for the header data is owned by {\ttfamily libtheoraenc}, and may be invalidated when the next encoder function is called. \\
+\hline
+\end{DoxyParams}
 \begin{DoxyReturn}{Returns}
 A positive value indicates that a header packet was successfully produced. 
 \end{DoxyReturn}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em 0}]No packet was produced, and no more header packets remain. \item[{\em TH\_\-EFAULT}]{\itshape \_\-enc\/}, {\itshape \_\-comments\/}, or {\itshape \_\-op\/} was {\ttfamily NULL}. \end{DoxyRetVals}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-free@{th\_\-encode\_\-free}}
-\index{th\_\-encode\_\-free@{th\_\-encode\_\-free}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\_\-encode\_\-free ({\bf th\_\-enc\_\-ctx} $\ast$ {\em \_\-enc})}\label{group__encfuncs_ga36b23d216532231925c4107894204680}
+{\em 0} & No packet was produced, and no more header packets remain. \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-enc}, {\itshape \-\_\-comments}, or {\itshape \-\_\-op} was {\ttfamily N\-U\-L\-L}. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-free@{th\-\_\-encode\-\_\-free}}
+\index{th\-\_\-encode\-\_\-free@{th\-\_\-encode\-\_\-free}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void th\-\_\-encode\-\_\-free (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-enc\-\_\-ctx} $\ast$}]{\-\_\-enc}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_ga36b23d216532231925c4107894204680}
 
 
 Frees an allocated encoder instance. 
-\begin{DoxyParams}{Parameters}
-\item[{\em \_\-enc}]A \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \end{DoxyParams}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-packetout@{th\_\-encode\_\-packetout}}
-\index{th\_\-encode\_\-packetout@{th\_\-encode\_\-packetout}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-packetout}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-encode\_\-packetout ({\bf th\_\-enc\_\-ctx} $\ast$ {\em \_\-enc}, \/  int {\em \_\-last}, \/  ogg\_\-packet $\ast$ {\em \_\-op})}\label{group__encfuncs_ga96d8ac1dda53187455352f99bbb5b04b}
 
 
-Retrieves encoded video data packets. This should be called repeatedly after each frame is submitted to flush any encoded packets, until it returns 0. The encoder will not buffer these packets as subsequent frames are compressed, so a failure to do so will result in lost video data. \begin{DoxyNote}{Note}
+\begin{DoxyParams}{Parameters}
+{\em \-\_\-enc} & A \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \\
+\hline
+\end{DoxyParams}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-packetout@{th\-\_\-encode\-\_\-packetout}}
+\index{th\-\_\-encode\-\_\-packetout@{th\-\_\-encode\-\_\-packetout}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-packetout}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-encode\-\_\-packetout (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-enc\-\_\-ctx} $\ast$}]{\-\_\-enc, }
+\item[{int}]{\-\_\-last, }
+\item[{ogg\-\_\-packet $\ast$}]{\-\_\-op}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_ga96d8ac1dda53187455352f99bbb5b04b}
+
+
+Retrieves encoded video data packets. 
+
+This should be called repeatedly after each frame is submitted to flush any encoded packets, until it returns 0. The encoder will not buffer these packets as subsequent frames are compressed, so a failure to do so will result in lost video data. \begin{DoxyNote}{Note}
 Currently the encoder operates in a one-\/frame-\/in, one-\/packet-\/out manner. However, this may be changed in the future. 
 \end{DoxyNote}
 
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-enc}]A \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \item[{\em \_\-last}]Set this flag to a non-\/zero value if no more uncompressed frames will be submitted. This ensures that a proper EOS flag is set on the last packet. \item[{\em \_\-op}]An {\ttfamily ogg\_\-packet} structure to fill. All of the elements of this structure will be set, including a pointer to the video data. The memory for the video data is owned by {\ttfamily libtheoraenc}, and may be invalidated when the next encoder function is called. \end{DoxyParams}
+{\em \-\_\-enc} & A \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \\
+\hline
+{\em \-\_\-last} & Set this flag to a non-\/zero value if no more uncompressed frames will be submitted. This ensures that a proper E\-O\-S flag is set on the last packet. \\
+\hline
+{\em \-\_\-op} & An {\ttfamily ogg\-\_\-packet} structure to fill. All of the elements of this structure will be set, including a pointer to the video data. The memory for the video data is owned by {\ttfamily libtheoraenc}, and may be invalidated when the next encoder function is called. \\
+\hline
+\end{DoxyParams}
 \begin{DoxyReturn}{Returns}
 A positive value indicates that a video data packet was successfully produced. 
 \end{DoxyReturn}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em 0}]No packet was produced, and no more encoded video data remains. \item[{\em TH\_\-EFAULT}]{\itshape \_\-enc\/} or {\itshape \_\-op\/} was {\ttfamily NULL}. \end{DoxyRetVals}
-\index{encfuncs@{encfuncs}!th\_\-encode\_\-ycbcr\_\-in@{th\_\-encode\_\-ycbcr\_\-in}}
-\index{th\_\-encode\_\-ycbcr\_\-in@{th\_\-encode\_\-ycbcr\_\-in}!encfuncs@{encfuncs}}
-\subsubsection[{th\_\-encode\_\-ycbcr\_\-in}]{\setlength{\rightskip}{0pt plus 5cm}int th\_\-encode\_\-ycbcr\_\-in ({\bf th\_\-enc\_\-ctx} $\ast$ {\em \_\-enc}, \/  {\bf th\_\-ycbcr\_\-buffer} {\em \_\-ycbcr})}\label{group__encfuncs_gadbe7dd66b411c2d61ab8153c15308750}
+{\em 0} & No packet was produced, and no more encoded video data remains. \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-enc} or {\itshape \-\_\-op} was {\ttfamily N\-U\-L\-L}. \\
+\hline
+\end{DoxyRetVals}
+\index{Functions for Encoding@{Functions for Encoding}!th\-\_\-encode\-\_\-ycbcr\-\_\-in@{th\-\_\-encode\-\_\-ycbcr\-\_\-in}}
+\index{th\-\_\-encode\-\_\-ycbcr\-\_\-in@{th\-\_\-encode\-\_\-ycbcr\-\_\-in}!Functions for Encoding@{Functions for Encoding}}
+\subsubsection[{th\-\_\-encode\-\_\-ycbcr\-\_\-in}]{\setlength{\rightskip}{0pt plus 5cm}int th\-\_\-encode\-\_\-ycbcr\-\_\-in (
+\begin{DoxyParamCaption}
+\item[{{\bf th\-\_\-enc\-\_\-ctx} $\ast$}]{\-\_\-enc, }
+\item[{{\bf th\-\_\-ycbcr\-\_\-buffer}}]{\-\_\-ycbcr}
+\end{DoxyParamCaption}
+)}\label{group__encfuncs_gadbe7dd66b411c2d61ab8153c15308750}
 
 
 Submits an uncompressed frame to the encoder. 
+
+
 \begin{DoxyParams}{Parameters}
-\item[{\em \_\-enc}]A \doxyref{th\_\-enc\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \item[{\em \_\-ycbcr}]A buffer of Y'CbCr data to encode. \end{DoxyParams}
+{\em \-\_\-enc} & A \doxyref{th\-\_\-enc\-\_\-ctx}{p.}{theoraenc_8h_af5cc40472b925456d42526a035d66edd} handle. \\
+\hline
+{\em \-\_\-ycbcr} & A buffer of Y'Cb\-Cr data to encode. \\
+\hline
+\end{DoxyParams}
 
 \begin{DoxyRetVals}{Return values}
-\item[{\em 0}]Success. \item[{\em TH\_\-EFAULT}]{\itshape \_\-enc\/} or {\itshape \_\-ycbcr\/} is {\ttfamily NULL}. \item[{\em TH\_\-EINVAL}]The buffer size does not match the frame size the encoder was initialized with, or encoding has already completed. \end{DoxyRetVals}
+{\em 0} & Success. \\
+\hline
+{\em T\-H\-\_\-\-E\-F\-A\-U\-L\-T} & {\itshape \-\_\-enc} or {\itshape \-\_\-ycbcr} is {\ttfamily N\-U\-L\-L}. \\
+\hline
+{\em T\-H\-\_\-\-E\-I\-N\-V\-A\-L} & The buffer size does not match the frame size the encoder was initialized with, or encoding has already completed. \\
+\hline
+\end{DoxyRetVals}