\section{th\_\-comment Struct Reference}
\label{structth__comment}\index{th_comment@{th\_\-comment}}
The comment information.  


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

\subsection*{Data Fields}
\begin{CompactItemize}
\item 
char $\ast$$\ast$ {\bf user\_\-comments}\label{structth__comment_9e397f7c4b1cbd756a68bc368ee26722}

\begin{CompactList}\small\item\em The array of comment string vectors. \item\end{CompactList}\item 
int $\ast$ {\bf comment\_\-lengths}\label{structth__comment_9aa79eab8cb11f9d9ade7d8b09a67643}

\begin{CompactList}\small\item\em An array of the corresponding length of each vector, in bytes. \item\end{CompactList}\item 
int {\bf comments}\label{structth__comment_f5f9d654cb25ac026e7ddace2fa3f24c}

\begin{CompactList}\small\item\em The total number of comment strings. \item\end{CompactList}\item 
char $\ast$ {\bf vendor}
\begin{CompactList}\small\item\em The null-terminated vendor string. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
The comment information. 

This structure holds the in-stream metadata corresponding to the 'comment' header packet. The comment header is meant to be used much like someone jotting a quick note on the label of a video. It should be a short, to the point text note that can be more than a couple words, but not more than a short paragraph.

The metadata is stored as a series of (tag, value) pairs, in length-encoded string vectors. The first occurrence of the '=' character delimits the tag and value. A particular tag may occur more than once, and order is significant. The character set encoding for the strings is always UTF-8, but the tag names are limited to ASCII, and treated as case-insensitive. See {\tt the Theora specification}, Section 6.3.3 for details.

In filling in this structure, \doxyref{th\_\-decode\_\-headerin()}{p.}{group__decfuncs_gb6616614374d049781bf883f995b43d8} will null-terminate the user\_\-comment strings for safety. However, the bitstream format itself treats them as 8-bit clean vectors, possibly containing null characters, and so the length array should be treated as their authoritative length. 



\subsection{Field Documentation}
\index{th_comment@{th\_\-comment}!vendor@{vendor}}
\index{vendor@{vendor}!th_comment@{th\_\-comment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf th\_\-comment::vendor}}\label{structth__comment_78bddb386b091a0af511176369ee8edc}


The null-terminated vendor string. 

This identifies the software used to encode the stream. 

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