v_hdmi_common
Xilinx SDK Drivers API Documentation
Hdmi_common_v1_0

Data Structures

struct  XHdmiC_VicTable
 This typedef contains Video identification information in tabular form. More...
 
struct  XHDMIC_AVI_InfoFrame
 This typedef contains the data structure for Auxiliary Video Information Info frame. More...
 
struct  XHdmiC_GCP_Packet
 This typedef contains the data structure for General Control Packet. More...
 
struct  XHdmiC_Audio_InfoFrame
 This typedef contains the data structure for Audio Infoframe. More...
 

Typedefs

typedef struct XHDMIC_AVI_InfoFrame XHdmiC_AVI_InfoFrame
 This typedef contains the data structure for Auxiliary Video Information Info frame. More...
 
typedef struct XHdmiC_GCP_Packet XHdmiC_GeneralControlPacket
 This typedef contains the data structure for General Control Packet. More...
 
typedef struct XHdmiC_Audio_InfoFrame XHdmiC_AudioInfoFrame
 This typedef contains the data structure for Audio Infoframe. More...
 

Enumerations

enum  XHdmiC_Colorspace { , XHDMIC_COLORSPACE_YUV420 }
 

Functions

void XV_HdmiC_ParseAVIInfoFrame (XHdmiC_Aux *AuxPtr, XHdmiC_AVI_InfoFrame *infoFramePtr)
 This function retrieves the Auxiliary Video Information Info Frame. More...
 
void XV_HdmiC_ParseGCP (XHdmiC_Aux *AuxPtr, XHdmiC_GeneralControlPacket *GcpPtr)
 This function retrieves the General Control Packet. More...
 
void XV_HdmiC_ParseAudioInfoFrame (XHdmiC_Aux *AuxPtr, XHdmiC_AudioInfoFrame *AudIFPtr)
 This function retrieves the Audio Info Frame. More...
 
XHdmiC_Aux XV_HdmiC_AVIIF_GeneratePacket (XHdmiC_AVI_InfoFrame *infoFramePtr)
 This function generates and sends Auxilliary Video Infoframes. More...
 
XHdmiC_Aux XV_HdmiC_AudioIF_GeneratePacket (XHdmiC_AudioInfoFrame *AudioInfoFrame)
 This function generates and sends Audio Infoframes. More...
 
XHdmiC_Colorspace XV_HdmiC_XVidC_To_IfColorformat (XVidC_ColorFormat ColorFormat)
 This function converts the XVidC_ColorFormat to XHdmiC_Colorspace. More...
 
XVidC_AspectRatio XV_HdmiC_IFAspectRatio_To_XVidC (XHdmiC_PicAspectRatio AR)
 This function converts the XVidC_ColorDepth to XHdmiC_ColorDepth. More...
 

Variables

const XHdmiC_VicTable VicTable [VICTABLE_SIZE]
 This table contains the attributes for various standard resolutions. More...
 
const XHdmiC_VicTable VicTable [VICTABLE_SIZE]
 This table contains the attributes for various standard resolutions. More...
 

Typedef Documentation

◆ XHdmiC_AudioInfoFrame

#include <xv_hdmic.h>

This typedef contains the data structure for Audio Infoframe.

◆ XHdmiC_AVI_InfoFrame

#include <xv_hdmic.h>

This typedef contains the data structure for Auxiliary Video Information Info frame.

◆ XHdmiC_GeneralControlPacket

#include <xv_hdmic.h>

This typedef contains the data structure for General Control Packet.

Enumeration Type Documentation

◆ XHdmiC_Colorspace

#include <xv_hdmic.h>

Enumerator
XHDMIC_COLORSPACE_YUV420 

Version 3 AVI InfoFrame.

Function Documentation

◆ XV_HdmiC_AudioIF_GeneratePacket()

XHdmiC_Aux XV_HdmiC_AudioIF_GeneratePacket ( XHdmiC_AudioInfoFrame AudioInfoFrame)

#include <xv_hdmic.c>

This function generates and sends Audio Infoframes.

Parameters
InstancePtris a pointer to the HDMI TX Subsystem instance.
Returns
None.
Note
None.

◆ XV_HdmiC_AVIIF_GeneratePacket()

XHdmiC_Aux XV_HdmiC_AVIIF_GeneratePacket ( XHdmiC_AVI_InfoFrame infoFramePtr)

#include <xv_hdmic.c>

This function generates and sends Auxilliary Video Infoframes.

Parameters
InstancePtris a pointer to the HDMI TX Subsystem instance.
Returns
None.
Note
None.

◆ XV_HdmiC_IFAspectRatio_To_XVidC()

XVidC_AspectRatio XV_HdmiC_IFAspectRatio_To_XVidC ( XHdmiC_PicAspectRatio  AR)

#include <xv_hdmic.c>

This function converts the XVidC_ColorDepth to XHdmiC_ColorDepth.

Parameters
Bpcis the XVidC_ColorDepth value to be converted
Returns
XHdmiC_ColorDepth value.
Note
None.

◆ XV_HdmiC_ParseAudioInfoFrame()

void XV_HdmiC_ParseAudioInfoFrame ( XHdmiC_Aux *  AuxPtr,
XHdmiC_AudioInfoFrame AudIFPtr 
)

#include <xv_hdmic.c>

This function retrieves the Audio Info Frame.

Parameters
None.
Returns
None.
Note
None.

◆ XV_HdmiC_ParseAVIInfoFrame()

void XV_HdmiC_ParseAVIInfoFrame ( XHdmiC_Aux *  AuxPtr,
XHdmiC_AVI_InfoFrame infoFramePtr 
)

#include <xv_hdmic.c>

This function retrieves the Auxiliary Video Information Info Frame.

Parameters
None.
Returns
None.
Note
None.

◆ XV_HdmiC_ParseGCP()

void XV_HdmiC_ParseGCP ( XHdmiC_Aux *  AuxPtr,
XHdmiC_GeneralControlPacket GcpPtr 
)

#include <xv_hdmic.c>

This function retrieves the General Control Packet.

Parameters
None.
Returns
None.
Note
None.

◆ XV_HdmiC_XVidC_To_IfColorformat()

XHdmiC_Colorspace XV_HdmiC_XVidC_To_IfColorformat ( XVidC_ColorFormat  ColorFormat)

#include <xv_hdmic.c>

This function converts the XVidC_ColorFormat to XHdmiC_Colorspace.

Parameters
ColorFormatis the XVidC_ColorFormat value to be converted
Returns
XHdmiC_Colorspace value.
Note
None.

Variable Documentation

◆ VicTable [1/2]

const XHdmiC_VicTable VicTable[VICTABLE_SIZE]

#include <xv_hdmic.c>

This table contains the attributes for various standard resolutions.

Each entry is of the format: 1) Resolution ID 2) Video Identification Code.

◆ VicTable [2/2]

const XHdmiC_VicTable VicTable[VICTABLE_SIZE]

#include <xv_hdmic.h>

This table contains the attributes for various standard resolutions.

Each entry is of the format: 1) Resolution ID 2) Video Identification Code.