v_hdmirx
Xilinx SDK Drivers API Documentation
xv_hdmirx_vsif.h File Reference

Overview

This is the main header file for Vendor Specific InfoFrames used in HDMI.

MODIFICATION HISTORY:
Ver   Who  Date        Changes

X.XX XX YYYY/MM/DD ... 1.00 RHe 2015/10/06 Initial release. 2.00 EB 2018/01/23 This file is deprecated. All the APIs are now moved to HDMI Common library

Data Structures

struct  XV_HdmiRx_3D_MetaData
 Structure for 3D meta data. More...
 
struct  XV_HdmiRx_3D_Info
 Structure containing 3D information. More...
 
struct  XV_HdmiRx_VSIF
 Structure for holding the VSIF. More...
 

Macros

#define XV_HDMIRX_3D_META_MAX_SIZE   8
 Maximum 3D Metadata size in bytes. More...
 
Vendor Specific InfoFrame Field Masks and Shifts.
#define XV_HDMIRX_VSIF_VIDEO_FORMAT_SHIFT   5
 
#define XV_HDMIRX_VSIF_VIDEO_FORMAT_MASK   (0x7 << XV_HDMIRX_VSIF_VIDEO_FORMAT_SHIFT)
 
#define XV_HDMIRX_3D_STRUCT_SHIFT   4
 
#define XV_HDMIRX_3D_STRUCT_MASK   (0xF << XV_HDMIRX_3D_STRUCT_SHIFT)
 
#define XV_HDMIRX_3D_SAMP_METHOD_SHIFT   6
 
#define XV_HDMIRX_3D_SAMP_METHOD_MASK   (0x3 << XV_HDMIRX_3D_SAMP_METHOD_SHIFT)
 
#define XV_HDMIRX_3D_SAMP_POS_SHIFT   4
 
#define XV_HDMIRX_3D_SAMP_POS_MASK   (0x3 << XV_HDMIRX_3D_SAMP_POS_SHIFT)
 
#define XV_HDMIRX_3D_META_PRESENT_SHIFT   3
 
#define XV_HDMIRX_3D_META_PRESENT_MASK   (0x1 << XV_HDMIRX_3D_META_PRESENT_SHIFT)
 
#define XV_HDMIRX_3D_META_TYPE_SHIFT   5
 
#define XV_HDMIRX_3D_META_TYPE_MASK   (0x7 << XV_HDMIRX_3D_META_TYPE_SHIFT)
 
#define XV_HDMIRX_3D_META_LENGTH_SHIFT   0
 
#define XV_HDMIRX_3D_META_LENGTH_MASK   (0x1F << XV_HDMIRX_3D_META_LENGTH_SHIFT)
 

Enumerations

enum  XV_HdmiRx_VSIF_Video_Format { XV_HDMIRX_VSIF_VF_NOINFO = 0, XV_HDMIRX_VSIF_VF_EXTRES = 1, XV_HDMIRX_VSIF_VF_3D = 2 }
 HDMI Video Format. More...
 
enum  XV_HdmiRx_3D_Struct_Field {
  XV_HDMIRX_3D_STRUCT_FRAME_PACKING = 0, XV_HDMIRX_3D_STRUCT_FIELD_ALTERNATIVE = 1, XV_HDMIRX_3D_STRUCT_LINE_ALTERNATIVE = 2, XV_HDMIRX_3D_STRUCT_SIDE_BY_SIDE_FULL = 3,
  XV_HDMIRX_3D_STRUCT_L_DEPTH = 4, XV_HDMIRX_3D_STRUCT_L_DEPTH_GRAPH_GDEPTH = 5, XV_HDMIRX_3D_STRUCT_TOP_AND_BOTTOM = 6, XV_HDMIRX_3D_STRUCT_SIDE_BY_SIDE_HALF = 8
}
 3D structure definitions as defined in the HDMI 1.4a specification More...
 
enum  XV_HdmiRx_3D_Sampling_Method { XV_HDMIRX_3D_SAMPLING_HORIZONTAL = 0, XV_HDMIRX_3D_SAMPLING_QUINCUNX = 1 }
 Sub-sampling methods for Side-by-side(half) More...
 
enum  XV_HdmiRx_3D_Sampling_Position { XV_HDMIRX_3D_SAMPPOS_OLOR = 0, XV_HDMIRX_3D_SAMPPOS_OLER = 1, XV_HDMIRX_3D_SAMPPOS_ELOR = 2, XV_HDMIRX_3D_SAMPPOS_ELER = 3 }
 Sub-sampling positions for the sub-sampling methods. More...
 
enum  XV_HdmiRx_3D_MetaData_Type { XV_HDMIRX_3D_META_PARALLAX = 0 }
 3D Metadata types More...
 

Macro Definition Documentation

◆ XV_HDMIRX_3D_META_MAX_SIZE

#define XV_HDMIRX_3D_META_MAX_SIZE   8

Maximum 3D Metadata size in bytes.

Enumeration Type Documentation

◆ XV_HdmiRx_3D_MetaData_Type

3D Metadata types

Enumerator
XV_HDMIRX_3D_META_PARALLAX 

Parallax information.

◆ XV_HdmiRx_3D_Sampling_Method

Sub-sampling methods for Side-by-side(half)

Enumerator
XV_HDMIRX_3D_SAMPLING_HORIZONTAL 

Horizontal sub-sampling.

XV_HDMIRX_3D_SAMPLING_QUINCUNX 

Quincunx matrix.

◆ XV_HdmiRx_3D_Sampling_Position

Sub-sampling positions for the sub-sampling methods.

Enumerator
XV_HDMIRX_3D_SAMPPOS_OLOR 

Odd/Left, Odd/Right.

XV_HDMIRX_3D_SAMPPOS_OLER 

Odd/Left, Even/Right.

XV_HDMIRX_3D_SAMPPOS_ELOR 

Even/Left, Odd/Right.

XV_HDMIRX_3D_SAMPPOS_ELER 

Even/Left, Even/Right.

◆ XV_HdmiRx_3D_Struct_Field

3D structure definitions as defined in the HDMI 1.4a specification

Enumerator
XV_HDMIRX_3D_STRUCT_FRAME_PACKING 

Frame packing.

XV_HDMIRX_3D_STRUCT_FIELD_ALTERNATIVE 

Field alternative.

XV_HDMIRX_3D_STRUCT_LINE_ALTERNATIVE 

Line alternative.

XV_HDMIRX_3D_STRUCT_SIDE_BY_SIDE_FULL 

Side-by-side (full)

XV_HDMIRX_3D_STRUCT_L_DEPTH 

L + depth.

XV_HDMIRX_3D_STRUCT_L_DEPTH_GRAPH_GDEPTH 

L + depth + graphics + graphics-depth.

XV_HDMIRX_3D_STRUCT_TOP_AND_BOTTOM 

Top-and-bottom.

XV_HDMIRX_3D_STRUCT_SIDE_BY_SIDE_HALF 

Side-by-side (half)

◆ XV_HdmiRx_VSIF_Video_Format

HDMI Video Format.

Enumerator
XV_HDMIRX_VSIF_VF_NOINFO 

No additional HDMI video format is presented.

XV_HDMIRX_VSIF_VF_EXTRES 

Extended resolution format present.

XV_HDMIRX_VSIF_VF_3D 

3D format indication present