gstreamer 1.1.0-x86-mingw32

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

@@ -0,0 +1,95 @@
+\section{th\-\_\-quant\-\_\-info \-Struct \-Reference}
+\label{structth__quant__info}\index{th\-\_\-quant\-\_\-info@{th\-\_\-quant\-\_\-info}}
+
+
+\-A complete set of quantization parameters.  
+
+
+
+
+{\ttfamily \#include $<$codec.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+ogg\-\_\-uint16\-\_\-t {\bf dc\-\_\-scale} [64]
+\begin{DoxyCompactList}\small\item\em \-The \-D\-C scaling factors. \end{DoxyCompactList}\item 
+ogg\-\_\-uint16\-\_\-t {\bf ac\-\_\-scale} [64]
+\begin{DoxyCompactList}\small\item\em \-The \-A\-C scaling factors. \end{DoxyCompactList}\item 
+unsigned char {\bf loop\-\_\-filter\-\_\-limits} [64]
+\begin{DoxyCompactList}\small\item\em \-The loop filter limit values. \end{DoxyCompactList}\item 
+{\bf th\-\_\-quant\-\_\-ranges} {\bf qi\-\_\-ranges} [2][3]
+\begin{DoxyCompactList}\small\item\em \-The {\itshape qi\/} ranges for each {\itshape ci\/} and {\itshape pli\/}. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-A complete set of quantization parameters. 
+
+\-The quantizer for each coefficient is calculated as\-: 
+\begin{DoxyCode}
+    Q=MAX(MIN(qmin[qti][ci!=0],scale[ci!=0][qi]*base[qti][pli][qi][ci]/100),
+     1024).
+\end{DoxyCode}
+
+
+{\itshape qti\/} is the quantization type index\-: 0 for intra, 1 for inter. {\ttfamily ci!=0} is 0 for the \-D\-C coefficient and 1 for \-A\-C coefficients. {\itshape qi\/} is the quality index, ranging between 0 (low quality) and 63 (high quality). {\itshape pli\/} is the color plane index\-: 0 for \-Y', 1 for \-Cb, 2 for \-Cr. {\itshape ci\/} is the \-D\-C\-T coefficient index. \-Coefficient indices correspond to the normal 2\-D \-D\-C\-T block ordering-\/-\/row-\/major with low frequencies first-\/-\/{\itshape not\/} zig-\/zag order.
+
+\-Minimum quantizers are constant, and are given by\-: 
+\begin{DoxyCode}
+   qmin[2][2]={{4,2},{8,4}}.
+\end{DoxyCode}
+
+
+\-Parameters that can be stored in the bitstream are as follows\-:
+\begin{DoxyItemize}
+\item \-The two scale matrices ac\-\_\-scale and dc\-\_\-scale. 
+\begin{DoxyCode}
+      scale[2][64]={dc_scale,ac_scale}.
+\end{DoxyCode}
+
+\item \-The base matrices for each {\itshape qi\/}, {\itshape qti\/} and {\itshape pli\/} (up to 384 in all). \-In order to avoid storing a full 384 base matrices, only a sparse set of matrices are stored, and the rest are linearly interpolated. \-This is done as follows. \-For each {\itshape qti\/} and {\itshape pli\/}, a series of {\itshape n\/} {\itshape qi\/} ranges is defined. \-The size of each {\itshape qi\/} range can vary arbitrarily, but they must sum to 63. \-Then, {\ttfamily n+1} matrices are specified, one for each endpoint of the ranges. \-For interpolation purposes, each range's endpoints are the first {\itshape qi\/} value it contains and one past the last {\itshape qi\/} value it contains. \-Fractional values are rounded to the nearest integer, with ties rounded away from zero.
+\end{DoxyItemize}
+
+\-Base matrices are stored by reference, so if the same matrices are used multiple times, they will only appear once in the bitstream. \-The bitstream is also capable of omitting an entire set of ranges and its associated matrices if they are the same as either the previous set (indexed in row-\/major order) or if the inter set is the same as the intra set.
+
+
+\begin{DoxyItemize}
+\item \-Loop filter limit values. \-The same limits are used for the loop filter in all color planes, despite potentially differing levels of quantization in each.
+\end{DoxyItemize}
+
+\-For the current encoder, {\ttfamily scale[ci!=0][qi]} must be no greater than {\ttfamily scale[ci!=0][qi-\/1]} and {\ttfamily base[qti][pli][qi][ci]} must be no greater than {\ttfamily base[qti][pli][qi-\/1][ci]}. \-These two conditions ensure that the actual quantizer for a given {\itshape qti\/}, {\itshape pli\/}, and {\itshape ci\/} does not increase as {\itshape qi\/} increases. \-This is not required by the decoder. 
+
+\subsection{\-Field \-Documentation}
+\index{th\-\_\-quant\-\_\-info@{th\-\_\-quant\-\_\-info}!ac\-\_\-scale@{ac\-\_\-scale}}
+\index{ac\-\_\-scale@{ac\-\_\-scale}!th_quant_info@{th\-\_\-quant\-\_\-info}}
+\subsubsection[{ac\-\_\-scale}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint16\-\_\-t {\bf th\-\_\-quant\-\_\-info\-::ac\-\_\-scale}[64]}\label{structth__quant__info_a102f079c8f4a135dc0895c10768aeb06}
+
+
+\-The \-A\-C scaling factors. 
+
+\index{th\-\_\-quant\-\_\-info@{th\-\_\-quant\-\_\-info}!dc\-\_\-scale@{dc\-\_\-scale}}
+\index{dc\-\_\-scale@{dc\-\_\-scale}!th_quant_info@{th\-\_\-quant\-\_\-info}}
+\subsubsection[{dc\-\_\-scale}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint16\-\_\-t {\bf th\-\_\-quant\-\_\-info\-::dc\-\_\-scale}[64]}\label{structth__quant__info_ad5c1c0d1aa4127fcf864ae747d732ed9}
+
+
+\-The \-D\-C scaling factors. 
+
+\index{th\-\_\-quant\-\_\-info@{th\-\_\-quant\-\_\-info}!loop\-\_\-filter\-\_\-limits@{loop\-\_\-filter\-\_\-limits}}
+\index{loop\-\_\-filter\-\_\-limits@{loop\-\_\-filter\-\_\-limits}!th_quant_info@{th\-\_\-quant\-\_\-info}}
+\subsubsection[{loop\-\_\-filter\-\_\-limits}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char {\bf th\-\_\-quant\-\_\-info\-::loop\-\_\-filter\-\_\-limits}[64]}\label{structth__quant__info_a4ac56bf0a45b5743b36daf85d5cd9e33}
+
+
+\-The loop filter limit values. 
+
+\index{th\-\_\-quant\-\_\-info@{th\-\_\-quant\-\_\-info}!qi\-\_\-ranges@{qi\-\_\-ranges}}
+\index{qi\-\_\-ranges@{qi\-\_\-ranges}!th_quant_info@{th\-\_\-quant\-\_\-info}}
+\subsubsection[{qi\-\_\-ranges}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\-\_\-quant\-\_\-ranges} {\bf th\-\_\-quant\-\_\-info\-::qi\-\_\-ranges}[2][3]}\label{structth__quant__info_a6feacf4b365e305a7df7b93d87ee7bb8}
+
+
+\-The {\itshape qi\/} ranges for each {\itshape ci\/} and {\itshape pli\/}. 
+
+
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf codec.\-h}\end{DoxyCompactItemize}

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

@@ -0,0 +1,54 @@
+\section{th\-\_\-quant\-\_\-ranges \-Struct \-Reference}
+\label{structth__quant__ranges}\index{th\-\_\-quant\-\_\-ranges@{th\-\_\-quant\-\_\-ranges}}
+
+
+\-A set of {\itshape qi\/} ranges.  
+
+
+
+
+{\ttfamily \#include $<$codec.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+int {\bf nranges}
+\begin{DoxyCompactList}\small\item\em \-The number of ranges in the set. \end{DoxyCompactList}\item 
+const int $\ast$ {\bf sizes}
+\begin{DoxyCompactList}\small\item\em \-The size of each of the \doxyref{nranges}{p.}{structth__quant__ranges_a53e5a3d7f7a112100b4b670929b3ebab} ranges. \end{DoxyCompactList}\item 
+const {\bf th\-\_\-quant\-\_\-base} $\ast$ {\bf base\-\_\-matrices}
+\begin{DoxyCompactList}\small\item\em \doxyref{nranges}{p.}{structth__quant__ranges_a53e5a3d7f7a112100b4b670929b3ebab} {\ttfamily +1} base matrices. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-A set of {\itshape qi\/} ranges. 
+
+
+
+\subsection{\-Field \-Documentation}
+\index{th\-\_\-quant\-\_\-ranges@{th\-\_\-quant\-\_\-ranges}!base\-\_\-matrices@{base\-\_\-matrices}}
+\index{base\-\_\-matrices@{base\-\_\-matrices}!th_quant_ranges@{th\-\_\-quant\-\_\-ranges}}
+\subsubsection[{base\-\_\-matrices}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf th\-\_\-quant\-\_\-base}$\ast$ {\bf th\-\_\-quant\-\_\-ranges\-::base\-\_\-matrices}}\label{structth__quant__ranges_a52cb432f034737087492ea448de20bdb}
+
+
+\doxyref{nranges}{p.}{structth__quant__ranges_a53e5a3d7f7a112100b4b670929b3ebab} {\ttfamily +1} base matrices. 
+
+\-Matrices {\itshape i\/} and {\ttfamily i+1} form the endpoints of range {\itshape i\/}. \index{th\-\_\-quant\-\_\-ranges@{th\-\_\-quant\-\_\-ranges}!nranges@{nranges}}
+\index{nranges@{nranges}!th_quant_ranges@{th\-\_\-quant\-\_\-ranges}}
+\subsubsection[{nranges}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf th\-\_\-quant\-\_\-ranges\-::nranges}}\label{structth__quant__ranges_a53e5a3d7f7a112100b4b670929b3ebab}
+
+
+\-The number of ranges in the set. 
+
+\index{th\-\_\-quant\-\_\-ranges@{th\-\_\-quant\-\_\-ranges}!sizes@{sizes}}
+\index{sizes@{sizes}!th_quant_ranges@{th\-\_\-quant\-\_\-ranges}}
+\subsubsection[{sizes}]{\setlength{\rightskip}{0pt plus 5cm}const int$\ast$ {\bf th\-\_\-quant\-\_\-ranges\-::sizes}}\label{structth__quant__ranges_af3188a373bc0b8ffaa330d0ab4c1a194}
+
+
+\-The size of each of the \doxyref{nranges}{p.}{structth__quant__ranges_a53e5a3d7f7a112100b4b670929b3ebab} ranges. 
+
+\-These must sum to 63. 
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf codec.\-h}\end{DoxyCompactItemize}

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

@@ -0,0 +1,45 @@
+\section{th\-\_\-stripe\-\_\-callback \-Struct \-Reference}
+\label{structth__stripe__callback}\index{th\-\_\-stripe\-\_\-callback@{th\-\_\-stripe\-\_\-callback}}
+
+
+\-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}.  
+
+
+
+
+{\ttfamily \#include $<$theoradec.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+void $\ast$ {\bf ctx}
+\begin{DoxyCompactList}\small\item\em \-An application-\/provided context pointer. \end{DoxyCompactList}\item 
+{\bf th\-\_\-stripe\-\_\-decoded\-\_\-func} {\bf stripe\-\_\-decoded}
+\begin{DoxyCompactList}\small\item\em \-The callback function pointer. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-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}. 
+
+
+
+\subsection{\-Field \-Documentation}
+\index{th\-\_\-stripe\-\_\-callback@{th\-\_\-stripe\-\_\-callback}!ctx@{ctx}}
+\index{ctx@{ctx}!th_stripe_callback@{th\-\_\-stripe\-\_\-callback}}
+\subsubsection[{ctx}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ {\bf th\-\_\-stripe\-\_\-callback\-::ctx}}\label{structth__stripe__callback_ab895162ce29a411fa98e0ba9661f47d4}
+
+
+\-An application-\/provided context pointer. 
+
+\-This will be passed back verbatim to the application. \index{th\-\_\-stripe\-\_\-callback@{th\-\_\-stripe\-\_\-callback}!stripe\-\_\-decoded@{stripe\-\_\-decoded}}
+\index{stripe\-\_\-decoded@{stripe\-\_\-decoded}!th_stripe_callback@{th\-\_\-stripe\-\_\-callback}}
+\subsubsection[{stripe\-\_\-decoded}]{\setlength{\rightskip}{0pt plus 5cm}{\bf th\-\_\-stripe\-\_\-decoded\-\_\-func} {\bf th\-\_\-stripe\-\_\-callback\-::stripe\-\_\-decoded}}\label{structth__stripe__callback_a977c725680a37e3446e459f063b1f4a5}
+
+
+\-The callback function pointer. 
+
+
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf theoradec.\-h}\end{DoxyCompactItemize}

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

@@ -0,0 +1,67 @@
+\section{theora\-\_\-comment \-Struct \-Reference}
+\label{structtheora__comment}\index{theora\-\_\-comment@{theora\-\_\-comment}}
+
+
+\-Comment header metadata.  
+
+
+
+
+{\ttfamily \#include $<$theora.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+char $\ast$$\ast$ {\bf user\-\_\-comments}
+\begin{DoxyCompactList}\small\item\em \-An array of comment string vectors. \end{DoxyCompactList}\item 
+int $\ast$ {\bf comment\-\_\-lengths}
+\begin{DoxyCompactList}\small\item\em \-An array of corresponding string vector lengths in bytes. \end{DoxyCompactList}\item 
+int {\bf comments}
+\begin{DoxyCompactList}\small\item\em \-The total number of comment string vectors. \end{DoxyCompactList}\item 
+char $\ast$ {\bf vendor}
+\begin{DoxyCompactList}\small\item\em \-The vendor string identifying the encoder, null terminated. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-Comment header metadata. 
+
+\-This structure holds the in-\/stream metadata corresponding to the 'comment' header packet.
+
+\-Meta data is stored as a series of (tag, value) pairs, in length-\/encoded string vectors. \-The first occurence of the '=' character delimits the tag and value. \-A particular tag may occur more than once. \-The character set encoding for the strings is always \-U\-T\-F-\/8, but the tag names are limited to case-\/insensitive \-A\-S\-C\-I\-I. \-See the spec for details.
+
+\-In filling in this structure, \doxyref{theora\-\_\-decode\-\_\-header()}{p.}{group__oldfuncs_ga02915e63c1bd733ee291f577a8b75a82} will null-\/terminate the user\-\_\-comment strings for safety. \-However, the bitstream format itself treats them as 8-\/bit clean, and so the length array should be treated as authoritative for their length. 
+
+\subsection{\-Field \-Documentation}
+\index{theora\-\_\-comment@{theora\-\_\-comment}!comment\-\_\-lengths@{comment\-\_\-lengths}}
+\index{comment\-\_\-lengths@{comment\-\_\-lengths}!theora_comment@{theora\-\_\-comment}}
+\subsubsection[{comment\-\_\-lengths}]{\setlength{\rightskip}{0pt plus 5cm}int$\ast$ {\bf theora\-\_\-comment\-::comment\-\_\-lengths}}\label{structtheora__comment_a5ab4a376d3c217282a684577c9c9f49a}
+
+
+\-An array of corresponding string vector lengths in bytes. 
+
+\index{theora\-\_\-comment@{theora\-\_\-comment}!comments@{comments}}
+\index{comments@{comments}!theora_comment@{theora\-\_\-comment}}
+\subsubsection[{comments}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-comment\-::comments}}\label{structtheora__comment_a122393035c8352ff9be42d69e73aee00}
+
+
+\-The total number of comment string vectors. 
+
+\index{theora\-\_\-comment@{theora\-\_\-comment}!user\-\_\-comments@{user\-\_\-comments}}
+\index{user\-\_\-comments@{user\-\_\-comments}!theora_comment@{theora\-\_\-comment}}
+\subsubsection[{user\-\_\-comments}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$$\ast$ {\bf theora\-\_\-comment\-::user\-\_\-comments}}\label{structtheora__comment_a1e236fd180dfce19be89081399444cf5}
+
+
+\-An array of comment string vectors. 
+
+\index{theora\-\_\-comment@{theora\-\_\-comment}!vendor@{vendor}}
+\index{vendor@{vendor}!theora_comment@{theora\-\_\-comment}}
+\subsubsection[{vendor}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf theora\-\_\-comment\-::vendor}}\label{structtheora__comment_adb371baf8f0daed42af8b875cf8430ef}
+
+
+\-The vendor string identifying the encoder, null terminated. 
+
+
+
+\-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/structtheora__info.tex

@@ -0,0 +1,233 @@
+\section{theora\-\_\-info \-Struct \-Reference}
+\label{structtheora__info}\index{theora\-\_\-info@{theora\-\_\-info}}
+
+
+\-Theora bitstream info.  
+
+
+
+
+{\ttfamily \#include $<$theora.\-h$>$}
+
+\subsection*{\-Data \-Fields}
+\begin{DoxyCompactItemize}
+\item 
+ogg\-\_\-uint32\-\_\-t {\bf width}
+\begin{DoxyCompactList}\small\item\em encoded frame width \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf height}
+\begin{DoxyCompactList}\small\item\em encoded frame height \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf frame\-\_\-width}
+\begin{DoxyCompactList}\small\item\em display frame width \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf frame\-\_\-height}
+\begin{DoxyCompactList}\small\item\em display frame height \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf offset\-\_\-x}
+\begin{DoxyCompactList}\small\item\em horizontal offset of the displayed frame \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf offset\-\_\-y}
+\begin{DoxyCompactList}\small\item\em vertical offset of the displayed frame \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf fps\-\_\-numerator}
+\begin{DoxyCompactList}\small\item\em frame rate numerator \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf fps\-\_\-denominator}
+\begin{DoxyCompactList}\small\item\em frame rate denominator \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf aspect\-\_\-numerator}
+\begin{DoxyCompactList}\small\item\em pixel aspect ratio numerator \end{DoxyCompactList}\item 
+ogg\-\_\-uint32\-\_\-t {\bf aspect\-\_\-denominator}
+\begin{DoxyCompactList}\small\item\em pixel aspect ratio denominator \end{DoxyCompactList}\item 
+{\bf theora\-\_\-colorspace} {\bf colorspace}
+\begin{DoxyCompactList}\small\item\em colorspace \end{DoxyCompactList}\item 
+int {\bf target\-\_\-bitrate}
+\begin{DoxyCompactList}\small\item\em nominal bitrate in bits per second \end{DoxyCompactList}\item 
+int {\bf quality}
+\begin{DoxyCompactList}\small\item\em \-Nominal quality setting, 0-\/63. \end{DoxyCompactList}\item 
+int {\bf quick\-\_\-p}
+\begin{DoxyCompactList}\small\item\em \-Quick encode/decode. \end{DoxyCompactList}\item 
+unsigned char {\bf version\-\_\-major}
+\item 
+unsigned char {\bf version\-\_\-minor}
+\item 
+unsigned char {\bf version\-\_\-subminor}
+\item 
+void $\ast$ {\bf codec\-\_\-setup}
+\item 
+int {\bf dropframes\-\_\-p}
+\item 
+int {\bf keyframe\-\_\-auto\-\_\-p}
+\item 
+ogg\-\_\-uint32\-\_\-t {\bf keyframe\-\_\-frequency}
+\item 
+ogg\-\_\-uint32\-\_\-t {\bf keyframe\-\_\-frequency\-\_\-force}
+\item 
+ogg\-\_\-uint32\-\_\-t {\bf keyframe\-\_\-data\-\_\-target\-\_\-bitrate}
+\item 
+ogg\-\_\-int32\-\_\-t {\bf keyframe\-\_\-auto\-\_\-threshold}
+\item 
+ogg\-\_\-uint32\-\_\-t {\bf keyframe\-\_\-mindistance}
+\item 
+ogg\-\_\-int32\-\_\-t {\bf noise\-\_\-sensitivity}
+\item 
+ogg\-\_\-int32\-\_\-t {\bf sharpness}
+\item 
+{\bf theora\-\_\-pixelformat} {\bf pixelformat}
+\begin{DoxyCompactList}\small\item\em chroma subsampling mode to expect \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{\-Detailed \-Description}
+\-Theora bitstream info. 
+
+\-Contains the basic playback parameters for a stream, corresponding to the initial 'info' header packet.
+
+\-Encoded theora frames must be a multiple of 16 in width and height. \-To handle other frame sizes, a crop rectangle is specified in frame\-\_\-height and frame\-\_\-width, offset\-\_\-x and $\ast$ offset\-\_\-y. \-The offset and size should still be a multiple of 2 to avoid chroma sampling shifts. \-Offset values in this structure are measured from the upper left of the image.
+
+\-Frame rate, in frames per second, is stored as a rational fraction. \-Aspect ratio is also stored as a rational fraction, and refers to the aspect ratio of the frame pixels, not of the overall frame itself.
+
+\-See {\tt examples/encoder\-\_\-example.\-c} for usage examples of the other paramters and good default settings for the encoder parameters. 
+
+\subsection{\-Field \-Documentation}
+\index{theora\-\_\-info@{theora\-\_\-info}!aspect\-\_\-denominator@{aspect\-\_\-denominator}}
+\index{aspect\-\_\-denominator@{aspect\-\_\-denominator}!theora_info@{theora\-\_\-info}}
+\subsubsection[{aspect\-\_\-denominator}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::aspect\-\_\-denominator}}\label{structtheora__info_afebc4d0cbfb34b68c833a8c79e83ae12}
+
+
+pixel aspect ratio denominator 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!aspect\-\_\-numerator@{aspect\-\_\-numerator}}
+\index{aspect\-\_\-numerator@{aspect\-\_\-numerator}!theora_info@{theora\-\_\-info}}
+\subsubsection[{aspect\-\_\-numerator}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::aspect\-\_\-numerator}}\label{structtheora__info_a5a3ed8c79815fba1aa06c3f7d8e48b35}
+
+
+pixel aspect ratio numerator 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!codec\-\_\-setup@{codec\-\_\-setup}}
+\index{codec\-\_\-setup@{codec\-\_\-setup}!theora_info@{theora\-\_\-info}}
+\subsubsection[{codec\-\_\-setup}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ {\bf theora\-\_\-info\-::codec\-\_\-setup}}\label{structtheora__info_a719a1d77a4a3bfeab79aa5747dbbb04c}
+\index{theora\-\_\-info@{theora\-\_\-info}!colorspace@{colorspace}}
+\index{colorspace@{colorspace}!theora_info@{theora\-\_\-info}}
+\subsubsection[{colorspace}]{\setlength{\rightskip}{0pt plus 5cm}{\bf theora\-\_\-colorspace} {\bf theora\-\_\-info\-::colorspace}}\label{structtheora__info_a5eaba99c96706d47b426ab7b7602dc5d}
+
+
+colorspace 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!dropframes\-\_\-p@{dropframes\-\_\-p}}
+\index{dropframes\-\_\-p@{dropframes\-\_\-p}!theora_info@{theora\-\_\-info}}
+\subsubsection[{dropframes\-\_\-p}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-info\-::dropframes\-\_\-p}}\label{structtheora__info_af294db65a8363a0bcf43f4727763b291}
+\index{theora\-\_\-info@{theora\-\_\-info}!fps\-\_\-denominator@{fps\-\_\-denominator}}
+\index{fps\-\_\-denominator@{fps\-\_\-denominator}!theora_info@{theora\-\_\-info}}
+\subsubsection[{fps\-\_\-denominator}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::fps\-\_\-denominator}}\label{structtheora__info_a9aa7e826e0323a4ae8cd8646a6cfbfea}
+
+
+frame rate denominator 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!fps\-\_\-numerator@{fps\-\_\-numerator}}
+\index{fps\-\_\-numerator@{fps\-\_\-numerator}!theora_info@{theora\-\_\-info}}
+\subsubsection[{fps\-\_\-numerator}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::fps\-\_\-numerator}}\label{structtheora__info_a3478199aa5ab213816c1819f70085ad7}
+
+
+frame rate numerator 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!frame\-\_\-height@{frame\-\_\-height}}
+\index{frame\-\_\-height@{frame\-\_\-height}!theora_info@{theora\-\_\-info}}
+\subsubsection[{frame\-\_\-height}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::frame\-\_\-height}}\label{structtheora__info_a287e4c194f1d2e6deb39d59f1748ea48}
+
+
+display frame height 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!frame\-\_\-width@{frame\-\_\-width}}
+\index{frame\-\_\-width@{frame\-\_\-width}!theora_info@{theora\-\_\-info}}
+\subsubsection[{frame\-\_\-width}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::frame\-\_\-width}}\label{structtheora__info_a8f28f4018a25634d40e4ae861fbbccfa}
+
+
+display frame width 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!height@{height}}
+\index{height@{height}!theora_info@{theora\-\_\-info}}
+\subsubsection[{height}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::height}}\label{structtheora__info_ae6f0274fc4a7f285c422d91abb35f9c6}
+
+
+encoded frame height 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-auto\-\_\-p@{keyframe\-\_\-auto\-\_\-p}}
+\index{keyframe\-\_\-auto\-\_\-p@{keyframe\-\_\-auto\-\_\-p}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-auto\-\_\-p}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-info\-::keyframe\-\_\-auto\-\_\-p}}\label{structtheora__info_a23648173369174f687085c0ce85ef30e}
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-auto\-\_\-threshold@{keyframe\-\_\-auto\-\_\-threshold}}
+\index{keyframe\-\_\-auto\-\_\-threshold@{keyframe\-\_\-auto\-\_\-threshold}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-auto\-\_\-threshold}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-int32\-\_\-t {\bf theora\-\_\-info\-::keyframe\-\_\-auto\-\_\-threshold}}\label{structtheora__info_a95cb8958e29ad3d24047ee8f9e7fd99b}
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-data\-\_\-target\-\_\-bitrate@{keyframe\-\_\-data\-\_\-target\-\_\-bitrate}}
+\index{keyframe\-\_\-data\-\_\-target\-\_\-bitrate@{keyframe\-\_\-data\-\_\-target\-\_\-bitrate}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-data\-\_\-target\-\_\-bitrate}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::keyframe\-\_\-data\-\_\-target\-\_\-bitrate}}\label{structtheora__info_a588942d1ee90a26a7effdf6a0e98b9ce}
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-frequency@{keyframe\-\_\-frequency}}
+\index{keyframe\-\_\-frequency@{keyframe\-\_\-frequency}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-frequency}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::keyframe\-\_\-frequency}}\label{structtheora__info_a03e1b3e337af5f9dabaaaeb9050f145a}
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-frequency\-\_\-force@{keyframe\-\_\-frequency\-\_\-force}}
+\index{keyframe\-\_\-frequency\-\_\-force@{keyframe\-\_\-frequency\-\_\-force}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-frequency\-\_\-force}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::keyframe\-\_\-frequency\-\_\-force}}\label{structtheora__info_ad9d2e22c44a53473010e6d1042dfe0d8}
+\index{theora\-\_\-info@{theora\-\_\-info}!keyframe\-\_\-mindistance@{keyframe\-\_\-mindistance}}
+\index{keyframe\-\_\-mindistance@{keyframe\-\_\-mindistance}!theora_info@{theora\-\_\-info}}
+\subsubsection[{keyframe\-\_\-mindistance}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::keyframe\-\_\-mindistance}}\label{structtheora__info_aa79ca8c0e77a884d4487fd627fae32e9}
+\index{theora\-\_\-info@{theora\-\_\-info}!noise\-\_\-sensitivity@{noise\-\_\-sensitivity}}
+\index{noise\-\_\-sensitivity@{noise\-\_\-sensitivity}!theora_info@{theora\-\_\-info}}
+\subsubsection[{noise\-\_\-sensitivity}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-int32\-\_\-t {\bf theora\-\_\-info\-::noise\-\_\-sensitivity}}\label{structtheora__info_ac4789034f547b57d1075e035050eeed9}
+\index{theora\-\_\-info@{theora\-\_\-info}!offset\-\_\-x@{offset\-\_\-x}}
+\index{offset\-\_\-x@{offset\-\_\-x}!theora_info@{theora\-\_\-info}}
+\subsubsection[{offset\-\_\-x}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::offset\-\_\-x}}\label{structtheora__info_af5949a02bef29512f2705e6f6c944e3b}
+
+
+horizontal offset of the displayed frame 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!offset\-\_\-y@{offset\-\_\-y}}
+\index{offset\-\_\-y@{offset\-\_\-y}!theora_info@{theora\-\_\-info}}
+\subsubsection[{offset\-\_\-y}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::offset\-\_\-y}}\label{structtheora__info_a91c3922097ba32a85acd584a01dc2c93}
+
+
+vertical offset of the displayed frame 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!pixelformat@{pixelformat}}
+\index{pixelformat@{pixelformat}!theora_info@{theora\-\_\-info}}
+\subsubsection[{pixelformat}]{\setlength{\rightskip}{0pt plus 5cm}{\bf theora\-\_\-pixelformat} {\bf theora\-\_\-info\-::pixelformat}}\label{structtheora__info_a65ab4376ab5242ee82e06c78fb7008ab}
+
+
+chroma subsampling mode to expect 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!quality@{quality}}
+\index{quality@{quality}!theora_info@{theora\-\_\-info}}
+\subsubsection[{quality}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-info\-::quality}}\label{structtheora__info_a71a4748a5f31bd58d0e403b7806c980d}
+
+
+\-Nominal quality setting, 0-\/63. 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!quick\-\_\-p@{quick\-\_\-p}}
+\index{quick\-\_\-p@{quick\-\_\-p}!theora_info@{theora\-\_\-info}}
+\subsubsection[{quick\-\_\-p}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-info\-::quick\-\_\-p}}\label{structtheora__info_a2dfae4fd175dbd19254eaf0697778ff5}
+
+
+\-Quick encode/decode. 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!sharpness@{sharpness}}
+\index{sharpness@{sharpness}!theora_info@{theora\-\_\-info}}
+\subsubsection[{sharpness}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-int32\-\_\-t {\bf theora\-\_\-info\-::sharpness}}\label{structtheora__info_a3fb695de2b2f56dd0203b9e2eb0df1cc}
+\index{theora\-\_\-info@{theora\-\_\-info}!target\-\_\-bitrate@{target\-\_\-bitrate}}
+\index{target\-\_\-bitrate@{target\-\_\-bitrate}!theora_info@{theora\-\_\-info}}
+\subsubsection[{target\-\_\-bitrate}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf theora\-\_\-info\-::target\-\_\-bitrate}}\label{structtheora__info_a0cfba041767ae2416dd190a406afe713}
+
+
+nominal bitrate in bits per second 
+
+\index{theora\-\_\-info@{theora\-\_\-info}!version\-\_\-major@{version\-\_\-major}}
+\index{version\-\_\-major@{version\-\_\-major}!theora_info@{theora\-\_\-info}}
+\subsubsection[{version\-\_\-major}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char {\bf theora\-\_\-info\-::version\-\_\-major}}\label{structtheora__info_a7c5ebb9e6700aaef87f29f7c6074e474}
+\index{theora\-\_\-info@{theora\-\_\-info}!version\-\_\-minor@{version\-\_\-minor}}
+\index{version\-\_\-minor@{version\-\_\-minor}!theora_info@{theora\-\_\-info}}
+\subsubsection[{version\-\_\-minor}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char {\bf theora\-\_\-info\-::version\-\_\-minor}}\label{structtheora__info_a75eda4f30270d833c7b9dba43932a06a}
+\index{theora\-\_\-info@{theora\-\_\-info}!version\-\_\-subminor@{version\-\_\-subminor}}
+\index{version\-\_\-subminor@{version\-\_\-subminor}!theora_info@{theora\-\_\-info}}
+\subsubsection[{version\-\_\-subminor}]{\setlength{\rightskip}{0pt plus 5cm}unsigned char {\bf theora\-\_\-info\-::version\-\_\-subminor}}\label{structtheora__info_aa07967ecd6e20bd2928ead42b6397b3d}
+\index{theora\-\_\-info@{theora\-\_\-info}!width@{width}}
+\index{width@{width}!theora_info@{theora\-\_\-info}}
+\subsubsection[{width}]{\setlength{\rightskip}{0pt plus 5cm}ogg\-\_\-uint32\-\_\-t {\bf theora\-\_\-info\-::width}}\label{structtheora__info_a17c2fc651bb3329f1ea6b13ff1d3957b}
+
+
+encoded frame width 
+
+
+
+\-The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+{\bf theora.\-h}\end{DoxyCompactItemize}