v_vscaler
Vitis Drivers API Documentation
Overview

Functions

int XV_VScalerInitialize (XV_Vscaler_l2 *InstancePtr, u16 DeviceId)
 This function initializes the core instance. More...
 
void XV_VScalerStart (XV_Vscaler_l2 *InstancePtr)
 This function starts the vertical scaler core. More...
 
void XV_VScalerStop (XV_Vscaler_l2 *InstancePtr)
 This function stops the vertical scaler core. More...
 
void XV_VScalerLoadExtCoeff (XV_Vscaler_l2 *InstancePtr, u16 num_phases, u16 num_taps, const short *Coeff)
 This function loads user defined filter coefficients in the scaler coefficient storage. More...
 
int XV_VScalerSetup (XV_Vscaler_l2 *InstancePtr, u32 WidthIn, u32 HeightIn, u32 HeightOut, u32 ColorFormat)
 This function configures the scaler core registers with the specified configuration parameters of the AXI stream. More...
 
void XV_VScalerDbgReportStatus (XV_Vscaler_l2 *InstancePtr)
 This function prints V Scaler status on the console. More...
 

Variables

const short XV_vscaler_Lanczos2_taps6 [XV_VSCALER_MAX_V_PHASES][XV_VSCALER_TAPS_6]
 XV_vscaler_Lanczos2_taps6 Default fixed coefficient set for 6-tap Lanczos2 vertical scaler filter. More...
 
const short XV_vscaler_Lanczos2_taps6 [XV_VSCALER_MAX_V_PHASES][XV_VSCALER_TAPS_6]
 XV_vscaler_Lanczos2_taps6 Default fixed coefficient set for 6-tap Lanczos2 vertical scaler filter. More...
 

Function Documentation

int XV_VScalerInitialize ( XV_Vscaler_l2 InstancePtr,
u16  DeviceId 
)

This function initializes the core instance.

Parameters
InstancePtris a pointer to core instance to be worked upon
DeviceIdis instance id of the core
Returns
XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found

References XV_vscaler_Initialize().

void XV_VScalerLoadExtCoeff ( XV_Vscaler_l2 InstancePtr,
u16  num_phases,
u16  num_taps,
const short *  Coeff 
)

This function loads user defined filter coefficients in the scaler coefficient storage.

Parameters
InstancePtris a pointer to the core instance to be worked on.
num_phasesis the number of phases in coefficient table
num_tapsis the number of taps in coefficient table
Coeffis a pointer to user defined filter coefficients table
Returns
None

References XV_vscaler::Config, and XV_vscaler_Config::PhaseShift.

int XV_VScalerSetup ( XV_Vscaler_l2 InstancePtr,
u32  WidthIn,
u32  HeightIn,
u32  HeightOut,
u32  ColorFormat 
)

This function configures the scaler core registers with the specified configuration parameters of the AXI stream.

Parameters
InstancePtris a pointer to the core instance to be worked on.
WidthInis the input stream width.
HeightInis the input stream height.
HeightOutis the output stream height.
ColorFormatis the color format of the stream.
Returns
XST_SUCCESS if successful, XST_FAILURE otherwise.

References XV_vscaler::Config, XV_vscaler_Config::PixPerClk, XV_vscaler_Config::ScalerType, XV_vscaler_Set_HwReg_ColorMode(), XV_vscaler_Set_HwReg_HeightIn(), XV_vscaler_Set_HwReg_HeightOut(), XV_vscaler_Set_HwReg_LineRate(), XV_vscaler_Set_HwReg_Width(), and XV_VscalerIs420Enabled.

void XV_VScalerStart ( XV_Vscaler_l2 InstancePtr)

This function starts the vertical scaler core.

Parameters
InstancePtris a pointer to the core instance to be worked on.
Returns
None

References XV_vscaler_EnableAutoRestart(), and XV_vscaler_Start().

void XV_VScalerStop ( XV_Vscaler_l2 InstancePtr)

This function stops the vertical scaler core.

Parameters
InstancePtris a pointer to the core instance to be worked on.
Returns
None

References XV_vscaler_DisableAutoRestart().

Variable Documentation

const short XV_vscaler_Lanczos2_taps6[XV_VSCALER_MAX_V_PHASES][XV_VSCALER_TAPS_6]

XV_vscaler_Lanczos2_taps6 Default fixed coefficient set for 6-tap Lanczos2 vertical scaler filter.

Each row represents a phase; columns are tap coefficients. Values are in Q12 fixed-point format.

const short XV_vscaler_Lanczos2_taps6[XV_VSCALER_MAX_V_PHASES][XV_VSCALER_TAPS_6]

XV_vscaler_Lanczos2_taps6 Default fixed coefficient set for 6-tap Lanczos2 vertical scaler filter.

Each row represents a phase; columns are tap coefficients. Values are in Q12 fixed-point format.