smooth_8h.tex

来自「在DM6446上实现了编码和解码功能」· TEX 代码 · 共 174 行

\hypertarget{smooth_8h}{
\subsection{smooth.h File Reference}
\label{smooth_8h}\index{smooth.h@{smooth.h}}
}


\subsubsection{Detailed Description}
\begin{Desc}
\item[Version:]00.13 \end{Desc}


This module uses the resizer H/W module of the VPSS on the DM6446 to remove interlacing artifacts in a YUV422 interleaved image. It does this by removing the odd field and extrapolating the odd lines using the surrounding even lines. See the application note spraa\-XXXX for details.



\footnotesize\begin{verbatim}
 * ============================================================================
 * Copyright (c) Texas Instruments Inc 2007
 *
 * Use of this software is controlled by the terms and conditions found in the
 * license agreement under which this software has been supplied or provided.
 * ============================================================================
 * \end{verbatim}
\normalsize
 

Definition in file \hyperlink{smooth_8h-source}{smooth.h}.

\subsubsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{struct_smooth___object}{Smooth\_\-Object}
\begin{CompactList}\small\item\em Internal structure containing the state of a smooth job. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{smooth_8h_0567e3f4faba6f048a4089dda4c941e8}{SMOOTH\_\-SUCCESS}~1
\begin{CompactList}\small\item\em Indicates success of an API call. \item\end{CompactList}\item 
\#define \hyperlink{smooth_8h_ac7bb87d1625cf5a0ab530d166ff805d}{SMOOTH\_\-FAILURE}~0
\begin{CompactList}\small\item\em Indicates failure of an API call. \item\end{CompactList}\item 
\#define \hyperlink{smooth_8h_7066fa21027ed722abc630c8061f988a}{SMOOTH\_\-DEFAULTRSZRATE}~0xe
\begin{CompactList}\small\item\em The default rate of the resizer. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef \hyperlink{struct_smooth___object}{Smooth\_\-Object} $\ast$ \hyperlink{smooth_8h_b55950728e74ef36928e8516138b478c}{Smooth\_\-Handle}
\begin{CompactList}\small\item\em A handle representing a smooth job. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{struct_smooth___object}{Smooth\_\-Handle} \hyperlink{smooth_8h_a5a8308aa339bf007b7282464c6296d4}{Smooth\_\-create} (int rsz\-Rate)
\begin{CompactList}\small\item\em Creates a new smooth job. \item\end{CompactList}\item 
int \hyperlink{smooth_8h_387acab9f588ab640ac51c3e6a6daab2}{Smooth\_\-config} (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} s\-Handle, int width, int height)
\begin{CompactList}\small\item\em Configures a smooth job which has been previously created. \item\end{CompactList}\item 
int \hyperlink{smooth_8h_08f4e2d1f7be1db609a78679e5b47323}{Smooth\_\-execute} (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} s\-Handle, unsigned long in\-Buf, unsigned long out\-Buf)
\begin{CompactList}\small\item\em Executes a smooth job which has been created and configured. \item\end{CompactList}\item 
void \hyperlink{smooth_8h_cae5f157d2308207e045d126253505f8}{Smooth\_\-delete} (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} s\-Handle)
\begin{CompactList}\small\item\em Deletes a smooth job. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Define Documentation}
\hypertarget{smooth_8h_0567e3f4faba6f048a4089dda4c941e8}{
\index{smooth.h@{smooth.h}!SMOOTH_SUCCESS@{SMOOTH\_\-SUCCESS}}
\index{SMOOTH_SUCCESS@{SMOOTH\_\-SUCCESS}!smooth.h@{smooth.h}}
\paragraph[SMOOTH\_\-SUCCESS]{\setlength{\rightskip}{0pt plus 5cm}\#define SMOOTH\_\-SUCCESS~1}\hfill}
\label{smooth_8h_0567e3f4faba6f048a4089dda4c941e8}


Indicates success of an API call. 



Definition at line 24 of file smooth.h.\hypertarget{smooth_8h_ac7bb87d1625cf5a0ab530d166ff805d}{
\index{smooth.h@{smooth.h}!SMOOTH_FAILURE@{SMOOTH\_\-FAILURE}}
\index{SMOOTH_FAILURE@{SMOOTH\_\-FAILURE}!smooth.h@{smooth.h}}
\paragraph[SMOOTH\_\-FAILURE]{\setlength{\rightskip}{0pt plus 5cm}\#define SMOOTH\_\-FAILURE~0}\hfill}
\label{smooth_8h_ac7bb87d1625cf5a0ab530d166ff805d}


Indicates failure of an API call. 



Definition at line 25 of file smooth.h.\hypertarget{smooth_8h_7066fa21027ed722abc630c8061f988a}{
\index{smooth.h@{smooth.h}!SMOOTH_DEFAULTRSZRATE@{SMOOTH\_\-DEFAULTRSZRATE}}
\index{SMOOTH_DEFAULTRSZRATE@{SMOOTH\_\-DEFAULTRSZRATE}!smooth.h@{smooth.h}}
\paragraph[SMOOTH\_\-DEFAULTRSZRATE]{\setlength{\rightskip}{0pt plus 5cm}\#define SMOOTH\_\-DEFAULTRSZRATE~0xe}\hfill}
\label{smooth_8h_7066fa21027ed722abc630c8061f988a}


The default rate of the resizer. 



Definition at line 27 of file smooth.h.

\subsubsection{Typedef Documentation}
\hypertarget{smooth_8h_b55950728e74ef36928e8516138b478c}{
\index{smooth.h@{smooth.h}!Smooth_Handle@{Smooth\_\-Handle}}
\index{Smooth_Handle@{Smooth\_\-Handle}!smooth.h@{smooth.h}}
\paragraph[Smooth\_\-Handle]{\setlength{\rightskip}{0pt plus 5cm}typedef \hyperlink{struct_smooth___object}{Smooth\_\-Object}$\ast$ \hyperlink{struct_smooth___object}{Smooth\_\-Handle}}\hfill}
\label{smooth_8h_b55950728e74ef36928e8516138b478c}


A handle representing a smooth job. 



Definition at line 37 of file smooth.h.

\subsubsection{Function Documentation}
\hypertarget{smooth_8h_a5a8308aa339bf007b7282464c6296d4}{
\index{smooth.h@{smooth.h}!Smooth_create@{Smooth\_\-create}}
\index{Smooth_create@{Smooth\_\-create}!smooth.h@{smooth.h}}
\paragraph[Smooth\_\-create]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct_smooth___object}{Smooth\_\-Handle} Smooth\_\-create (int {\em rsz\-Rate})}\hfill}
\label{smooth_8h_a5a8308aa339bf007b7282464c6296d4}


Creates a new smooth job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em rsz\-Rate}]The rate to use for the resizer peripheral. This will set the SDR\_\-REQ\_\-EXP register in the VPSS for $\ast$all$\ast$ resizer operations. A negative value will bypass changing this register. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A handle to the created Smooth job to pass in to subsequent API calls, or SMOOTH\_\-FAILURE if an error occured. \end{Desc}
\hypertarget{smooth_8h_387acab9f588ab640ac51c3e6a6daab2}{
\index{smooth.h@{smooth.h}!Smooth_config@{Smooth\_\-config}}
\index{Smooth_config@{Smooth\_\-config}!smooth.h@{smooth.h}}
\paragraph[Smooth\_\-config]{\setlength{\rightskip}{0pt plus 5cm}int Smooth\_\-config (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} {\em s\-Handle}, int {\em width}, int {\em height})}\hfill}
\label{smooth_8h_387acab9f588ab640ac51c3e6a6daab2}


Configures a smooth job which has been previously created. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s\-Handle}]The handle to the smooth job to be configured. \item[{\em width}]The width of the frame in pixels. The value must be between 16 and 720, and an even multiple of 16. \item[{\em height}]The height of the frame in pixels. The value must be between 144 and 720, and an even multiple of 16. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SMOOTH\_\-SUCCESS on success and SMOOTH\_\-FAILURE on failure. \end{Desc}
\hypertarget{smooth_8h_08f4e2d1f7be1db609a78679e5b47323}{
\index{smooth.h@{smooth.h}!Smooth_execute@{Smooth\_\-execute}}
\index{Smooth_execute@{Smooth\_\-execute}!smooth.h@{smooth.h}}
\paragraph[Smooth\_\-execute]{\setlength{\rightskip}{0pt plus 5cm}int Smooth\_\-execute (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} {\em s\-Handle}, unsigned long {\em in\-Buf}, unsigned long {\em out\-Buf})}\hfill}
\label{smooth_8h_08f4e2d1f7be1db609a78679e5b47323}


Executes a smooth job which has been created and configured. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s\-Handle}]The handle to the smooth job to execute. \item[{\em in\-Buf}]A physical pointer to the input buffer. The buffer should be of size width $\ast$ height $\ast$ 2 (for 16 bpp) where the width and height are set during the config call. \item[{\em out\-Buf}]A physical pointer to the output buffer. The buffer should be of size width $\ast$ height $\ast$ 2 (for 16 bpp) where the width and height are set during the config call. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]SMOOTH\_\-SUCCESS on success and SMOOTH\_\-FAILURE on failure. \end{Desc}
\hypertarget{smooth_8h_cae5f157d2308207e045d126253505f8}{
\index{smooth.h@{smooth.h}!Smooth_delete@{Smooth\_\-delete}}
\index{Smooth_delete@{Smooth\_\-delete}!smooth.h@{smooth.h}}
\paragraph[Smooth\_\-delete]{\setlength{\rightskip}{0pt plus 5cm}void Smooth\_\-delete (\hyperlink{struct_smooth___object}{Smooth\_\-Handle} {\em s\-Handle})}\hfill}
\label{smooth_8h_cae5f157d2308207e045d126253505f8}


Deletes a smooth job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s\-Handle}]The handle to the previously created smooth job to be deleted. \end{description}
\end{Desc}