Image Data

This Command receives the image data and writes it into the VPS DRAM Buffer. It performs decompression if required. Due to the limitation of USB, the entire image data may not be sent in one go. Hence, this command has to be called multiple times in order to load the entire image. It also stores any bytes that are unprocessed by the API (if the API does not have all the bytes required to perform an operation). These unprocessed bytes are sent over to callback function the next time data is received. The API displays the loaded splash once the entire image is loaded into the memory. The remaining pixels to load the image is also returned by the callback function.

This command loads a pre-defined XPR Calibration pattern as a splash image and displays it on the screen. A 64x64 pattern is repeated over a 3840x2160 display area.

Orientation number. Range 0 - 23.

This command sets the orientation number of the actuator position (which gets stored in EEPROM) There are 24 possible options 0 - 23; use this commmand while performing XPR calibration using TI provided XPR calibration splash image.

Note : Use Display Image Size command to make sure the display area is 3840x2160 If the reported display resolution is less than or equal to 1080p this command will not have any influence on the displayed image.

XPR Command

0 = Fixed Output Enable

1 = DAC Gain

2 = Subframe delay

3 = Actuator Type (READ ONLY)

4 = Output Enable/Disable

5 = Clock Width

6 = DAC Offset

7 = Number of Segments

8 = Segment Length

9 = Invert PWM A

10 = Invert PWM B

11 = Subframe Filter Value

12 = Subframe Watch Dog

13 = Fixed Output Value

Channel number (0 or 1) of Actuator waveform control for which the command parameter has to be applied

Data that needs to be passed to the command

This command configures/sets up the Actuator Waveform Control(AWC) block. Here, AWCx can be AWC 0 or 1. Bytes 2-5 contains the XPR command data as mentioned in Byte 0. Byte 1 contains AWC channel number, possible values are 0 or 1.

Fixed Output Enable : Configures Actuator in fixed output mode.

Byte 2 : 0x00 - Disable 0x01 - Enable

Bytes 3-5 : Reserved must be set to 0x000000

Gain : Set Waveform Generator DAC/PWM Gain.

Byte 2 : Range 0 - 255 format u1.7 (0 to 1.9921875)

Bytes 3-5 : Reserved must be set to 0x000000

Subframe delay : Subframe delay Bytes 2-5; Range 0 - 262143 and lsb = 133.333ns

Actuator Type (READ ONLY) : Actuator type

Byte 2 :

0x00 - NONE

0x01 - Optotune (XPR-25 Model)

0x80 - TI Actuator Interface (EEPROM)

0x81 - TI Actuator Interface (MCU)

Bytes 3-5 : Reserved must be set to 0x000000

Output Enable/Disable : Actuator output enable/disable

Byte 2 : 0x00 - Disable 0x01 - Enable

Bytes 3-5 : Reserved must be set to 0x000000

Note : Both AWC0 and AWC1 disabled/enabled together

Clock Width : Defines the high and low width for the output clock (the clock period will be 2*(ClkWidth+1))

0 = 1 (Clock period is two clocks); lsb = 8.33ns

Bytes 2-5 : ClkWidth

Example : ClkWidth = 0; will generate clock of 2*(0+1)*8.33 = 16.66ns

Offset : DAC/PWM Output Offset

Byte 2 : Range -128 - +127 format S7 (-128 to +127)

Bytes 3-5 : Reserved must be set to 0x000000

Number of Segments : Defines number of segments

Byte 2 : Range 2 - 255

Bytes 3-5 : Reserved must be set to 0x000000

Segments Length : Defines size of the segments

Bytes 2-3 : Range 19 - 4095

Bytes 4-5 : Reserved must be set to 0x0000

Invert PWM A : Applicable when AWC is configured to PWM type instead of DAC

Byte 2 : 0x00 - No inversion

0x01 - Inverted

Bytes 3-5 : Reserved must be set to 0x000000

Invert PWM B : Applicable when AWC is configured to PWM type instead of DAC

Byte 2 : 0x00 - No inversion 0x01 - Inverted

Bytes 3-5 : Reserved must be set to 0x000000

Subframe Filter Value : Sets Subframe Filter Value - defines the minimum time between Subframe edges. Edges closer than the set value will be filtered out

Byte 2 : 0 = Filter disabled, 0 = Filter time will be Val x 60us, Range : 0 - 255

Bytes 3-5 : Reserved must be set to 0x000000

Subframe Watch Dog : Defines the maximum time between Subframe edges; if timer expires, then the WG will automatically output the Fixed Output value, and the normal output will resume on the next subframe edge.

Bytes 2-3 : 0 = Subframe watchdog disabled, 0 = Watchdog time will be Time x 60us, Range : Range : 0 - 1023

Bytes 4-5 : Reserved must be set to 0x0000

Fixed Output Value : Defines the value to be output on DAC/PWM when fixed output mode is selected.

Byte 2 : Value to be output on DAC/PWM, Range -128 to 127 Bytes 3-5 : Reserved must be set to 0x000000

Note : To use Subframe Filter Value and Subframe Watch Dog care must be taken to set a value which aproximately 10% more than 2x of the operating frequency.

For example - 4K @ 60Hz, the value can be set as (1/(60*2))*1.10*10^6 = 9166us.

number of lines top of border. Range 0 - 4095

number of lines bottom of border. Range 0 - 4095

number of pixels of left border. Range 0 - 4095

number of pixels of right border. Range 0 - 4095

This command configures area of the DynamicBlack border region for the border exclusion function. The border exclusion function allows the user to reduce the letterbox (black border) effect on a primarily bright image where letterbox area reduces the overall scene brightness for the algorithm. It also helps the algorithm better handle images with bright subtitles where the subtitles increase the overall scene brightness. This command will also be used in a multi-controller configuration to exclude any image overlap required for other image processing algorithms.

Weight value of border pixels 0 = 0% weighted; 1 = 25% weighted; 2 = 50% weighted; 3 = 75% weighted

0 = Weighted 0%

1 = Weighted 25%

2 = Weighted 50%

3 = Weighted 75%

Number of pixels that can be clipped. Range = 0 to 65535.

This command returns currently configured number of steps to allow the DynamicBlack aperture to move.

Gain value. Typical value range is 1.0 to 8.0.

Format = u4.12

This command controls the DynamicBlack gain value. Typical value range is 1.0 to 8.0. Manual Mode needs to be enabled to set the gain as it will override the gain value that is calculated every frame.

Start address of the DB histogram array. Array size is 34. The LSB of each bin represents 32 pixels. Each bin saturates at 0x0003FFFF.

This command returns the start address of the DynamicBlack(DB) histogram data. The histogram contains scene brightness data from the previous frame. The DB histogram contains 34 bins measuring non-overlapping intensity ranges in the displayed image. The value of each bin equals the number of pixels within the bin's intensity range. Each pixel's intensity is calculated as the maximum of its red, green, and blue values. In other words, pixel intensity = MAX( R, G, B ). Each pixel has a format of unsigned 8.8, making 16 bit values. Bins 32 and 33 are special bins that represent pixels that have values of exactly zero and only fractional values respectively. This function can be used independently of aperture control for image improvement in dark scenes.

Chromatic x coordinate in (Transmitted in u1.15 format)

Format = u1.15

Chromatic y coordinate in (Transmitted in u1.15 format)

Format = u1.15

Luminance Y coordinate

Gets x,y coordinates of system's current white point. WPC should be initialized and calibration data should be set before calling this command.

Searches available duty cycles and sets the optimal one for corerct LED white point. Sensor calibration Data should be set before using this command.

LED Color

0 = Red

1 = Green

2 = Blue

Chromatic x coordinate in u1.15 format

Chromatic y coordinate in u1.15 format

Luminance Y coordinate

Set WPC sensor calibration data through this command. WPC_Init() should complete succesfully before invoking this command.

Red

Green

Blue

Returns Output of Integrating Sensor for Red, Blue and Green

Color

0 = SSI SPI/PWM designator for RED

1 = SSI SPI/PWM designator for GREEN

2 = SSI SPI/PWM designator for BLUE

3 = Sample1 for SPI systems.

4 = Sample2 C2

5 = SSI SPI Yellow/ IR for PWM systems.

6 = SSI CYAN for SPI SENSE for PWM systems

7 = SSI MAGENTA for SPI / Frequency for PWM systems

8 = SSI SPI designator for WHITE

9 = SSI SPI designator for Black

10 = SSI SPI designator for IR

Max Drive Level

Set Maximum Drive Level

Index

Select Duty Cycle index for SSI

1 - Calibration mode enabled

This command sets the system in bypass mode. Setting the system in bypass mode disables any image processing to establish one to one correspondence between pixels on input source image and display image. Desirable for seeing clear splits of XPR subframes. There is no exit from calibration mode. Please restart the system.

LED Color

0 = Red

1 = Green

2 = Blue

Chromatic x coordinate in u1.15 format

Chromatic y coordinate in u1.15 format

Luminance Y coordinate

Red Sensor Output

Green Sensor Output

Blue Sensor Output

Duty Cycle

Format = u8.8

Set the entire WPC sensor calibration data structure through this command. WPC_Init() should complete succesfully before invoking this command.