\section{theora\_\-info Struct Reference}
\label{structtheora__info}\index{theora_info@{theora\_\-info}}
Theora bitstream info.  


{\tt \#include $<$theora.h$>$}

\subsection*{Data Fields}
\begin{CompactItemize}
\item 
ogg\_\-uint32\_\-t {\bf width}\label{structtheora__info_o0}

\begin{CompactList}\small\item\em encoded frame width \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf height}\label{structtheora__info_o1}

\begin{CompactList}\small\item\em encoded frame height \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf frame\_\-width}\label{structtheora__info_o2}

\begin{CompactList}\small\item\em display frame width \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf frame\_\-height}\label{structtheora__info_o3}

\begin{CompactList}\small\item\em display frame height \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf offset\_\-x}\label{structtheora__info_o4}

\begin{CompactList}\small\item\em horizontal offset of the displayed frame \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf offset\_\-y}\label{structtheora__info_o5}

\begin{CompactList}\small\item\em vertical offset of the displayed frame \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf fps\_\-numerator}\label{structtheora__info_o6}

\begin{CompactList}\small\item\em frame rate numerator \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf fps\_\-denominator}\label{structtheora__info_o7}

\begin{CompactList}\small\item\em frame rate denominator \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf aspect\_\-numerator}\label{structtheora__info_o8}

\begin{CompactList}\small\item\em pixel aspect ratio numerator \item\end{CompactList}\item 
ogg\_\-uint32\_\-t {\bf aspect\_\-denominator}\label{structtheora__info_o9}

\begin{CompactList}\small\item\em pixel aspect ratio denominator \item\end{CompactList}\item 
{\bf theora\_\-colorspace} {\bf colorspace}\label{structtheora__info_o10}

\begin{CompactList}\small\item\em colorspace \item\end{CompactList}\item 
int {\bf target\_\-bitrate}\label{structtheora__info_o11}

\begin{CompactList}\small\item\em nominal bitrate in bits per second \item\end{CompactList}\item 
int {\bf quality}\label{structtheora__info_o12}

\begin{CompactList}\small\item\em Nominal quality setting, 0-63. \item\end{CompactList}\item 
int {\bf quick\_\-p}\label{structtheora__info_o13}

\begin{CompactList}\small\item\em Quick encode/decode. \item\end{CompactList}\item 
unsigned char {\bf version\_\-major}\label{structtheora__info_o14}

\item 
unsigned char {\bf version\_\-minor}\label{structtheora__info_o15}

\item 
unsigned char {\bf version\_\-subminor}\label{structtheora__info_o16}

\item 
void $\ast$ {\bf codec\_\-setup}\label{structtheora__info_o17}

\item 
int {\bf dropframes\_\-p}\label{structtheora__info_o18}

\item 
int {\bf keyframe\_\-auto\_\-p}\label{structtheora__info_o19}

\item 
ogg\_\-uint32\_\-t {\bf keyframe\_\-frequency}\label{structtheora__info_o20}

\item 
ogg\_\-uint32\_\-t {\bf keyframe\_\-frequency\_\-force}\label{structtheora__info_o21}

\item 
ogg\_\-uint32\_\-t {\bf keyframe\_\-data\_\-target\_\-bitrate}\label{structtheora__info_o22}

\item 
ogg\_\-int32\_\-t {\bf keyframe\_\-auto\_\-threshold}\label{structtheora__info_o23}

\item 
ogg\_\-uint32\_\-t {\bf keyframe\_\-mindistance}\label{structtheora__info_o24}

\item 
ogg\_\-int32\_\-t {\bf noise\_\-sensitivity}\label{structtheora__info_o25}

\item 
ogg\_\-int32\_\-t {\bf sharpness}\label{structtheora__info_o26}

\item 
{\bf theora\_\-pixelformat} {\bf pixelformat}\label{structtheora__info_o27}

\begin{CompactList}\small\item\em chroma subsampling mode to expect \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Theora bitstream info. 

Contains the basic playback parameters for a stream, corresponds to the initial 'info' header packet.

Encoded theora frames must be a multiple of 16 is size; this is what the width and height members represent. To handle other sizes, a crop rectangle is specified in frame\_\-height and frame\_\-width, offset\_\-x and 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. So is the aspect ratio. Note that this refers to the aspect ratio of the frame pixels, not of the overall frame itself.

see the example code for use of the other parameters and good default settings for the encoder parameters.



The documentation for this struct was generated from the following file:\begin{CompactItemize}
\item 
{\bf theora.h}\end{CompactItemize}
