Video Features

class videoFeatures.VideoFeatures

Bases: object

Implements the video methods for most Devices.

This Class implements video features used by all devices except the PROPixx. If a video feature can be used in a DATAPixx as well as a VIEWPixx, it is included in this Class.

getRasterLinePixelSync()

Gets the raster line on which the pixel sync sequence is expected.

Returns:

line on which pixel sync sequence is expected.

Return type:

line (int)

getVideoDotFrequency()

Gets the video dot frequency (pixel sync.).

Returns:

frequency in Hz.

Return type:

frequency (int)

getVideoHorizontalLineFrequency()

Gets the video horizontal line frequency.

Returns:

frequency in Hz.

Return type:

frequency (int)

getVideoHorizontalTotal()

Gets the total number of clocks per horizontal line.

This method allows the user to get the total number of clocks in one horizontal scan line. This value includes the horizontal blanking interval.

Returns:

number of clocks per horizontal lines.

Return type:

number (int)

getVideoMode()

Gets the current video processing mode.

This method allows the user to know what is the current display mode of the VPixx device.

Warning

Mode RB24 is available on VIEWPixx ONLY, revision 21 or higher.

Returns:

video mode is one of the following predefined constants:

• C24: Straight pass through from DVI 8-bit (or HDMI “deep” 10/12-bit) RGB to VGA 8/10/12-bit RGB

• L48: DVI RED[7:0] is used as an index into a 256-entry 16-bit RGB color lookup table

• M16: DVI RED[7:0] & GREEN[7:0] concatenate into a VGA 16-bit value sent to all three RGB components

• C48: Even/Odd pixel RED/GREEN/BLUE[7:0] concatenate to generate 16-bit RGB components at half the horizontal resolution

• L48D: DVI RED[7:4] & GREEN[7:4] concatenate to form an 8-bit index into a 256-entry 16-bit RGB color lookup table

• M16D: DVI RED[7:3] & GREEN[7:3] & BLUE[7:2] concatenate into a VGA 16-bit value sent to all three RGB components

• C36D: Even/Odd pixel RED/GREEN/BLUE[7:2] concatenate to generate 12-bit RGB components at half the horizontal resolution

• RB24: DVI RED[7:0] & GREEN[7:4] concatenate to form 12-bit RED value, DVI BLUE[7:0] & GREEN[3:0] concatenate to form 12-bit BLUE value, GREEN is forced to 0

Return type:

mode (string)

getVideoVerticalFrameFrequency()

Gets the video vertical frame frequency.

Returns:

frequency in Hz.

Return type:

frequency (int)

getVideoVerticalFramePeriod()

Gets the video vertical frame period.

Returns:

Period in nanoseconds.

Return type:

period (int)

getVideoVerticalTotal()

Gets the total number of clocks per vertical line.

This method allows the user to get the total number of clocks in one vertical frame. This value includes the vertical blanking interval.

Returns:

number of clocks per vertical lines.

Return type:

number (int)

getVisibleLinePerVerticalFrame()

Gets the number of visible lines in one vertical frame.

Returns:

Number of visible lines.

Return type:

number (int)

getVisiblePixelsPerHorizontalLine()

Gets the number of visible pixels in one horizontal scan line.

Returns:

Number of pixels.

Return type:

number (int)

isPixelSyncLineBlackEnabled()

Verifies the pixel synchronization black line mode state.

Allows the user to know if the raster line displayed black mode is enabled or not. When enable is True, the raster line displayed black mode is enabled. When disabled, the raster line is displayed normally.

Returns:

True if black line mode is enabled, False otherwise.

Return type:

enable (Bool)

isPixelSyncOnSingleLineEnabled()

Verifies the pixel synchronization mode state.

Allows the user to know if the pixel synchronization is done on a single raster line or on any line.

Returns:

True if pixel synchronization is only recognized on a single raster line, False otherwise.

Return type:

enable (Bool)

isVideoOnDualLinkDvi()

Verifies if the device is currently receiving video data over dual-link DVI.

Returns:

True if the device is receiving over dual-link DVI, otherwise False.

Return type:

state (Bool)

isVideoOnDvi()

Verifies if the device is currently receiving video data over DVI link.

Returns:

True if the device is currently receiving video data over DVI link, otherwise False.

Return type:

state (Bool)

isVideoTimingDisplayable()

Verifies if the device can display the incoming data.

This method allows the user to know if the device is currently receiving video whose timing can be directly driven by the display.

Returns:

True if the device can display the video signal, otherwise False.

Return type:

state (Bool)

isVideoTimingTooHigh()

Verifies if the video clock frequency is too high.

This method allows the user to know if the clock frequency of the incoming data is too high for the device to display.

Returns:

True if the clock frequency is too high, otherwise False.

Return type:

state (Bool)

isVideoVesaBluelineEnabled()

Verifies the video blue line mode state.

Returns:

True if blue line mode is enabled, False otherwise.

Return type:

enable (Bool)

setCLUT(CLUT)

Sets the video color look up table data to be displayed.

Pass 3x256 16-bit video data, [[R1…R256], [G1…G256], [B1…B256]]. Or if you want a different CLUT for the console and the test display, Pass a 3x512 16-bit video, [[R1…R512], [G1…G512], [B1…B512]].

Warning

Since this is 16-bits, the colors RGB must vary between 0 and 65535.

This functions returns immediately, and CLUT is implemented at next vertical blanking interval.

Parameters:

CLUT (list of lists of int) – Color look-up table .

setPixelSyncLineBlack(enable)

Sets the Video pixel synchronization black line mode.

Allows the user to display the raster line black for video pixel synchronization. When enabled, the raster line is always displayed black. When disabled, the raster line is displayed normally.

Parameters:

enable (Bool) – True to enable the black line mode. False to disable it on any line.

setPixelSyncOnSingleLine(enable)

Sets the Video pixel synchronization on a single raster line.

Allows the user to set the video pixel synchronization on a single raster line or on any raster line.

Parameters:

enable (Bool) – True to enable pixel synchronization on a single raster line. False to allow synchronization on any line.

setRasterLinePixelSync(line)

Sets the raster line on which the pixel synchronization sequence is expected.

Parameters:

line (int) – line on which the pixel synchronization sequence is expected.

setVideoMode(mode)

Sets the video processing mode.

This method allows the user to change the display mode of the VPixx device. Each mode changes how the input video signal is used to display the video on the display.

Warning

Mode RB24 is available on VIEWPixx ONLY, revision 21 or higher.

Parameters:

mode (string) –

video mode is one of the following predefined constants:

• C24: Straight pass through from DVI 8-bit (or HDMI “deep” 10/12-bit) RGB to VGA 8/10/12-bit RGB

• L48: DVI RED[7:0] is used as an index into a 256-entry 16-bit RGB color lookup table

• M16: DVI RED[7:0] & GREEN[7:0] concatenate into a VGA 16-bit value sent to all three RGB components

• C48: Even/Odd pixel RED/GREEN/BLUE[7:0] concatenate to generate 16-bit RGB components at half the horizontal resolution

• L48D: DVI RED[7:4] & GREEN[7:4] concatenate to form an 8-bit index into a 256-entry 16-bit RGB color lookup table

• M16D: DVI RED[7:3] & GREEN[7:3] & BLUE[7:2] concatenate into a VGA 16-bit value sent to all three RGB components

• C36D: Even/Odd pixel RED/GREEN/BLUE[7:2] concatenate to generate 12-bit RGB components at half the horizontal resolution

• RB24: DVI RED[7:0] & GREEN[7:4] concatenate to form 12-bit RED value, DVI BLUE[7:0] & GREEN[3:0] concatenate to form 12-bit BLUE value, GREEN is forced to 0.

setVideoVesaBlueline(enable)

Sets the Video blue line mode.

When enabled, the VESA 3D output interprets the middle pixel on the last raster line as a blue line code. When disabled, the VESA 3D output is not dependent on video content.

Parameters:

enable (Bool) – Activate or deactivate the blue line mode.