CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
CdiAvmVideoConfig Struct Reference

Video payload configuration data. Used to define the format of the video payload conforming to the CDI baseline video profile. More...

#include <cdi_baseline_profile_01_00_api.h>

Data Fields

CdiAvmBaselineProfileVersion version
 Baseline profile version. NOTE: Must be first element (see CdiAvmBaselineProfileVersion).
 
uint16_t width
 Video frame width in pixels.
 
uint16_t height
 Video frame height in pixels.
 
CdiAvmVideoSampling sampling
 Video frame sampling format.
 
CdiAvmVideoAlphaChannel alpha_channel
 Alpha channel type.
 
CdiAvmVideoBitDepth depth
 Video frame bit depth.
 
uint32_t frame_rate_num
 Video frame rate numerator.
 
uint32_t frame_rate_den
 Video frame rate denominator.
 
CdiAvmColorimetry colorimetry
 Video frame colorimetry.
 
bool interlace
 If set true indicates interlaced or Progressive segmented Frame (PsF).
 
bool segmented
 If true indicates PsF. Invalid to set without setting interlace true.
 
CdiAvmVideoTcs tcs
 Transfer Characteristic System used.
 
CdiAvmVideoRange range
 Signal encoding range of the sample values.
 
uint16_t par_width
 Pixel Aspect Ratio (PAR) width is the first of two integer values that make up PAR. PAR width and height should be the smallest integer values that create the correct PAR value.
 
uint16_t par_height
 Pixel Aspect Ratio (PAR) height is the second of two integer values that make up PAR. PAR width and height should be the smallest integer values that create the correct PAR value.
 
uint16_t start_vertical_pos
 For transferring partial video frames in a payload, this value specifies the y-axis value of the first line of video frame data (zero based). For transferring all lines of data in a frame the value must be zero.
 
uint16_t vertical_size
 Number of video lines in payload. If zero, all lines of data in frame is assumed.
 
uint16_t start_horizontal_pos
 For transferring partial video frames in a payload, this value specifies the x-axis value of the first pixel of video frame data (zero based). For transferring all pixels in a video line the value must be zero.
 
uint16_t horizontal_size
 Number of pixels per line in the payload. If zero, entire lines of pixels are assumed.
 

Detailed Description

Video payload configuration data. Used to define the format of the video payload conforming to the CDI baseline video profile.

Field Documentation

◆ horizontal_size

uint16_t CdiAvmVideoConfig::horizontal_size

Number of pixels per line in the payload. If zero, entire lines of pixels are assumed.

See also
start_vertical_pos

◆ start_horizontal_pos

uint16_t CdiAvmVideoConfig::start_horizontal_pos

For transferring partial video frames in a payload, this value specifies the x-axis value of the first pixel of video frame data (zero based). For transferring all pixels in a video line the value must be zero.

See also
start_vertical_pos

◆ start_vertical_pos

uint16_t CdiAvmVideoConfig::start_vertical_pos

For transferring partial video frames in a payload, this value specifies the y-axis value of the first line of video frame data (zero based). For transferring all lines of data in a frame the value must be zero.

To specify sending partial frames use start_vertical_pos, start_horizontal_pos, vertical_size, and horizontal_size to specify a rectangle being sent. The start_vertical_pos and start_horizontal_pos specify the zero based starting coordinates of the rectangle to be sent where (0,0) is the upper left corner of the frame. The size of the rectangle is specified by vertical_size and horizontal_size where the rectangle is vertical_size lines tall and each line is horizontal_size pixels long. Using values of zero for horizontal_size or vertical_size indicates no horizontal and or vertical cropping is being performed. In this way if all of the variables mentioned are set to 0 a full uncropped frame is indicated.

◆ vertical_size

uint16_t CdiAvmVideoConfig::vertical_size

Number of video lines in payload. If zero, all lines of data in frame is assumed.

See also
start_vertical_pos

The documentation for this struct was generated from the following file: