video_common
Vitis Drivers API Documentation
xvidc.c File Reference

Functions

u32 XVidC_RegisterCustomTimingModes (const XVidC_VideoTimingMode *CustomTable, u16 NumElems)
 This function registers a user-defined custom video mode timing table with video_common. More...
 
void XVidC_UnregisterCustomTimingModes (void)
 This function unregisters the user-defined custom video mode timing table previously registered by XVidC_RegisterCustomTimingModes(). More...
 
u64 XVidC_GetPixelClockHzByHVFr (u32 HTotal, u32 VTotal, u8 FrameRate)
 This function calculates pixel clock based on the inputs. More...
 
u64 XVidC_GetPixelClockHzByVmId (XVidC_VideoMode VmId)
 This function calculates pixel clock from video mode. More...
 
XVidC_VideoFormat XVidC_GetVideoFormat (XVidC_VideoMode VmId)
 This function checks if the input video mode is interlaced/progressive based on its ID from the video timings table. More...
 
u8 XVidC_IsInterlaced (XVidC_VideoMode VmId)
 This function checks if the input video mode is interlaced based on its ID from the video timings table. More...
 
XVidC_VideoMode XVidC_GetVideoModeIdWBlanking (const XVidC_VideoTiming *Timing, u32 FrameRate, u8 IsInterlaced)
 This function returns the Video Mode ID that matches the detected input timing, frame rate and I/P flag. More...
 
XVidC_VideoMode XVidC_GetVideoModeId (u32 Width, u32 Height, u32 FrameRate, u8 IsInterlaced)
 This function returns the Video Mode ID that matches the detected input width, height, frame rate and I/P flag. More...
 
XVidC_VideoMode XVidC_GetVideoModeIdExtensive (XVidC_VideoTiming *Timing, u32 FrameRate, u8 IsInterlaced, u8 IsExtensive)
 This function returns the Video Mode ID that matches the detected input timing, frame rate and I/P flag. More...
 
XVidC_VideoMode XVidC_GetVideoModeIdRb (u32 Width, u32 Height, u32 FrameRate, u8 IsInterlaced, u8 RbN)
 This function returns the video mode ID that matches the detected input width, height, frame rate, interlaced or progressive, and reduced blanking. More...
 
const XVidC_VideoTimingModeXVidC_GetVideoModeData (XVidC_VideoMode VmId)
 This function returns the pointer to video mode data at index provided. More...
 
const char * XVidC_GetVideoModeStr (XVidC_VideoMode VmId)
 This function returns the resolution name for index specified. More...
 
const char * XVidC_GetFrameRateStr (XVidC_VideoMode VmId)
 This function returns the frame rate name for index specified. More...
 
const char * XVidC_Get3DFormatStr (XVidC_3DFormat Format)
 This function returns a string representation of the enumerated type, XVidC_3DFormat. More...
 
const char * XVidC_GetColorFormatStr (XVidC_ColorFormat ColorFormatId)
 This function returns the color format name for index specified. More...
 
XVidC_FrameRate XVidC_GetFrameRate (XVidC_VideoMode VmId)
 This function returns the frame rate for index specified. More...
 
const XVidC_VideoTimingXVidC_GetTimingInfo (XVidC_VideoMode VmId)
 This function returns the timing parameters for specified resolution. More...
 
u32 XVidC_SetVideoStream (XVidC_VideoStream *VidStrmPtr, XVidC_VideoMode VmId, XVidC_ColorFormat ColorFormat, XVidC_ColorDepth Bpc, XVidC_PixelsPerClock Ppc)
 This function sets the VideoStream structure for the specified video format. More...
 
u32 XVidC_Set3DVideoStream (XVidC_VideoStream *VidStrmPtr, XVidC_VideoMode VmId, XVidC_ColorFormat ColorFormat, XVidC_ColorDepth Bpc, XVidC_PixelsPerClock Ppc, XVidC_3DInfo *Info3DPtr)
 This function sets the VideoStream structure for the specified 3D video format. More...
 
void XVidC_ReportStreamInfo (const XVidC_VideoStream *Stream)
 This function prints the stream information on STDIO/UART console. More...
 
void XVidC_ReportTiming (const XVidC_VideoTiming *Timing, u8 IsInterlaced)
 This function prints timing information on STDIO/Uart console. More...
 

Variables

const XVidC_VideoTimingMode XVidC_VideoTimingModes [XVIDC_VM_NUM_SUPPORTED]
 This table contains the main stream attributes for various standard resolutions. More...