rszcopy_8h.tex

在DM6446上实现了编码和解码功能

\hypertarget{rszcopy_8h}{
\subsection{rszcopy.h File Reference}
\label{rszcopy_8h}\index{rszcopy.h@{rszcopy.h}}
}


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


This module uses the H/W resizer on the DM6446 to copy a frame from a source to a destination buffer.



\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{rszcopy_8h-source}{rszcopy.h}.

\subsubsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{struct_rszcopy___object}{Rszcopy\_\-Object}
\begin{CompactList}\small\item\em Internal structure containing the state of a resize job. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{rszcopy_8h_8d4cb5f8c9a2f15f5f7b08a86fc3aa94}{RSZCOPY\_\-SUCCESS}~1
\begin{CompactList}\small\item\em Indicates success of an API call. \item\end{CompactList}\item 
\#define \hyperlink{rszcopy_8h_81f0641571b1ea4a7e3884b7525cd42f}{RSZCOPY\_\-FAILURE}~0
\begin{CompactList}\small\item\em Indicates failure of an API call. \item\end{CompactList}\item 
\#define \hyperlink{rszcopy_8h_f82a2763f6d8cd0bea7848b57d2d439a}{RSZCOPY\_\-DEFAULTRSZRATE}~0xe
\begin{CompactList}\small\item\em Default rate of the resizer. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef \hyperlink{struct_rszcopy___object}{Rszcopy\_\-Object} $\ast$ \hyperlink{rszcopy_8h_816ba97f9cde7e9cfe8f6b6551785a7f}{Rszcopy\_\-Handle}
\begin{CompactList}\small\item\em A handle representing a resize job. \item\end{CompactList}\end{CompactItemize}
\subsubsection*{Functions}
\begin{CompactItemize}
\item 
\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} \hyperlink{rszcopy_8h_d00fcd1d172a56fe7372d1c2c088992b}{Rszcopy\_\-create} (int rsz\-Rate)
\begin{CompactList}\small\item\em Creates a new copy job. \item\end{CompactList}\item 
int \hyperlink{rszcopy_8h_2fb8d94f4c0be6639f34208de42898c2}{Rszcopy\_\-config} (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} h\-Rszcopy, int width, int height, int src\-Pitch, int dst\-Pitch)
\begin{CompactList}\small\item\em Configures a copy job. \item\end{CompactList}\item 
int \hyperlink{rszcopy_8h_fc0dd27b2db1543342cfc4812d1898f8}{Rszcopy\_\-execute} (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} h\-Rszcopy, unsigned long src\-Buf, unsigned long dst\-Buf)
\begin{CompactList}\small\item\em Executes a copy job. \item\end{CompactList}\item 
void \hyperlink{rszcopy_8h_07120d5c20fa6d6b804bf99d51c104b4}{Rszcopy\_\-delete} (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} h\-Rszcopy)
\begin{CompactList}\small\item\em Deletes a resize job. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Define Documentation}
\hypertarget{rszcopy_8h_8d4cb5f8c9a2f15f5f7b08a86fc3aa94}{
\index{rszcopy.h@{rszcopy.h}!RSZCOPY_SUCCESS@{RSZCOPY\_\-SUCCESS}}
\index{RSZCOPY_SUCCESS@{RSZCOPY\_\-SUCCESS}!rszcopy.h@{rszcopy.h}}
\paragraph[RSZCOPY\_\-SUCCESS]{\setlength{\rightskip}{0pt plus 5cm}\#define RSZCOPY\_\-SUCCESS~1}\hfill}
\label{rszcopy_8h_8d4cb5f8c9a2f15f5f7b08a86fc3aa94}


Indicates success of an API call. 



Definition at line 22 of file rszcopy.h.\hypertarget{rszcopy_8h_81f0641571b1ea4a7e3884b7525cd42f}{
\index{rszcopy.h@{rszcopy.h}!RSZCOPY_FAILURE@{RSZCOPY\_\-FAILURE}}
\index{RSZCOPY_FAILURE@{RSZCOPY\_\-FAILURE}!rszcopy.h@{rszcopy.h}}
\paragraph[RSZCOPY\_\-FAILURE]{\setlength{\rightskip}{0pt plus 5cm}\#define RSZCOPY\_\-FAILURE~0}\hfill}
\label{rszcopy_8h_81f0641571b1ea4a7e3884b7525cd42f}


Indicates failure of an API call. 



Definition at line 23 of file rszcopy.h.\hypertarget{rszcopy_8h_f82a2763f6d8cd0bea7848b57d2d439a}{
\index{rszcopy.h@{rszcopy.h}!RSZCOPY_DEFAULTRSZRATE@{RSZCOPY\_\-DEFAULTRSZRATE}}
\index{RSZCOPY_DEFAULTRSZRATE@{RSZCOPY\_\-DEFAULTRSZRATE}!rszcopy.h@{rszcopy.h}}
\paragraph[RSZCOPY\_\-DEFAULTRSZRATE]{\setlength{\rightskip}{0pt plus 5cm}\#define RSZCOPY\_\-DEFAULTRSZRATE~0xe}\hfill}
\label{rszcopy_8h_f82a2763f6d8cd0bea7848b57d2d439a}


Default rate of the resizer. 



Definition at line 25 of file rszcopy.h.

\subsubsection{Typedef Documentation}
\hypertarget{rszcopy_8h_816ba97f9cde7e9cfe8f6b6551785a7f}{
\index{rszcopy.h@{rszcopy.h}!Rszcopy_Handle@{Rszcopy\_\-Handle}}
\index{Rszcopy_Handle@{Rszcopy\_\-Handle}!rszcopy.h@{rszcopy.h}}
\paragraph[Rszcopy\_\-Handle]{\setlength{\rightskip}{0pt plus 5cm}typedef \hyperlink{struct_rszcopy___object}{Rszcopy\_\-Object}$\ast$ \hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle}}\hfill}
\label{rszcopy_8h_816ba97f9cde7e9cfe8f6b6551785a7f}


A handle representing a resize job. 



Definition at line 35 of file rszcopy.h.

\subsubsection{Function Documentation}
\hypertarget{rszcopy_8h_d00fcd1d172a56fe7372d1c2c088992b}{
\index{rszcopy.h@{rszcopy.h}!Rszcopy_create@{Rszcopy\_\-create}}
\index{Rszcopy_create@{Rszcopy\_\-create}!rszcopy.h@{rszcopy.h}}
\paragraph[Rszcopy\_\-create]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} Rszcopy\_\-create (int {\em rsz\-Rate})}\hfill}
\label{rszcopy_8h_d00fcd1d172a56fe7372d1c2c088992b}


Creates a new copy 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 Rszcopy job to pass to subsequent operations. \end{Desc}
\hypertarget{rszcopy_8h_2fb8d94f4c0be6639f34208de42898c2}{
\index{rszcopy.h@{rszcopy.h}!Rszcopy_config@{Rszcopy\_\-config}}
\index{Rszcopy_config@{Rszcopy\_\-config}!rszcopy.h@{rszcopy.h}}
\paragraph[Rszcopy\_\-config]{\setlength{\rightskip}{0pt plus 5cm}int Rszcopy\_\-config (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} {\em h\-Rszcopy}, int {\em width}, int {\em height}, int {\em src\-Pitch}, int {\em dst\-Pitch})}\hfill}
\label{rszcopy_8h_2fb8d94f4c0be6639f34208de42898c2}


Configures a copy job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rszcopy}]A handle to a previously created rszcopy job. \item[{\em width}]The width of the image to copy in pixels. \item[{\em height}]The height of the image to copy in pixels. \item[{\em src\-Pitch}]The horizontal pitch of the input image in bytes. \item[{\em dst\-Pitch}]The horizontal pitch of the output image in bytes. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]RSZCOPY\_\-SUCCESS on success and RSZCOPY\_\-FAILURE on failure. \end{Desc}
\hypertarget{rszcopy_8h_fc0dd27b2db1543342cfc4812d1898f8}{
\index{rszcopy.h@{rszcopy.h}!Rszcopy_execute@{Rszcopy\_\-execute}}
\index{Rszcopy_execute@{Rszcopy\_\-execute}!rszcopy.h@{rszcopy.h}}
\paragraph[Rszcopy\_\-execute]{\setlength{\rightskip}{0pt plus 5cm}int Rszcopy\_\-execute (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} {\em h\-Rszcopy}, unsigned long {\em src\-Buf}, unsigned long {\em dst\-Buf})}\hfill}
\label{rszcopy_8h_fc0dd27b2db1543342cfc4812d1898f8}


Executes a copy job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rszcopy}]The handle to a created and configured copy job to execute \item[{\em src\-Buf}]A physical pointer to the source buffer. This buffer should be of the size src\-Pitch $\ast$ src\-Height bytes set during the config call. \item[{\em dst\-Buf}]A physical pointer to the destination buffer. This buffer should be of the size dst\-Pitch $\ast$ dst\-Height bytes set during the config call. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]RSZCOPY\_\-SUCCESS on success and RSZCOPY\_\-FAILURE on failure. \end{Desc}
\hypertarget{rszcopy_8h_07120d5c20fa6d6b804bf99d51c104b4}{
\index{rszcopy.h@{rszcopy.h}!Rszcopy_delete@{Rszcopy\_\-delete}}
\index{Rszcopy_delete@{Rszcopy\_\-delete}!rszcopy.h@{rszcopy.h}}
\paragraph[Rszcopy\_\-delete]{\setlength{\rightskip}{0pt plus 5cm}void Rszcopy\_\-delete (\hyperlink{struct_rszcopy___object}{Rszcopy\_\-Handle} {\em h\-Rszcopy})}\hfill}
\label{rszcopy_8h_07120d5c20fa6d6b804bf99d51c104b4}


Deletes a resize job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em h\-Rszcopy}]The handle to a previously created resize job to be deleted. \end{description}
\end{Desc}