This file contains some common data types. More...

#include <stddef.h>
#include <stdint.h>
#include <string>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	device_info

struct	device_info::mode

struct	device_option

struct	fec_desc

struct	pixfmt_desc

struct	tile
	Struct tile is an area of video_frame. More...

struct	video_desc

struct	video_frame
	Struct video_frame represents a video frame and contains video description. More...

struct	video_frame_callbacks
	Struct containing callbacks of a video_frame. More...

Macros
#define	FLEXIBLE_ARRAY_MEMBER 0

#define	VF_METADATA_END tile_count

#define	VF_METADATA_SIZE (offsetof(struct video_frame, VF_METADATA_END) - offsetof(struct video_frame, VF_METADATA_START))

#define	VF_METADATA_START fec_params

Typedefs
typedef void(*	device_probe_func) (struct device_info *available_cards, int count, void(*deleter) (void ))

typedef enum frame_type	frame_type_t

Enumerations
enum	{ kHz8 = 8000 , kHz48 = 48000 , kHz90 = 90000 }

enum	codec_t { VIDEO_CODEC_NONE = 0 , VC_NONE = VIDEO_CODEC_NONE , VIDEO_CODEC_FIRST , VC_FIRST = VIDEO_CODEC_FIRST , RGBA = VIDEO_CODEC_FIRST , UYVY , YUYV , R10k , R12L , v210 , DVS10 , DXT1 , DXT1_YUV , DXT5 , RGB , JPEG , RAW , H264 , H265 , MJPG , VP8 , VP9 , BGR , J2K , J2KR , HW_VDPAU , HFYU , FFV1 , CFHD , RG48 , AV1 , I420 , Y216 , Y416 , PRORES , PRORES_4444 , PRORES_4444_XQ , PRORES_422_HQ , PRORES_422 , PRORES_422_PROXY , PRORES_422_LT , DRM_PRIME , VIDEO_CODEC_COUNT , VC_COUNT = VIDEO_CODEC_COUNT , VC_END = VIDEO_CODEC_COUNT , VIDEO_CODEC_END = VIDEO_CODEC_COUNT }

enum	depth { DEPTH8 = 8 , DEPTH10 = 10 , DEPTH12 = 12 , DEPTH16 = 16 }

enum	fec_type { FEC_NONE = 0 , FEC_MULT = 1 , FEC_LDGM = 2 , FEC_RS = 3 }

enum	frame_flags_common { TIMESTAMP_VALID = 1 << 0 }
	flags common for both audio and video frame More...

enum	frame_type { INTRA = 0 , BFRAME , OTHER }

enum	hw_accel_type { HWACCEL_NONE , HWACCEL_VDPAU , HWACCEL_VAAPI , HWACCEL_VIDEOTOOLBOX , HWACCEL_CUDA , HWACCEL_VULKAN , HWACCEL_DRM_PRIME , HWACCEL_COUNT }

enum	interlacing_t { PROGRESSIVE = 0 , UPPER_FIELD_FIRST = 1 , LOWER_FIELD_FIRST = 2 , INTERLACED_MERGED = 3 , SEGMENTED_FRAME = 4 , INTERLACING_MAX = SEGMENTED_FRAME }

enum	mem_location_t { CPU_MEM = 0 , CUDA_MEM }

enum	subsampling { SUBS_420 = 4200 , SUBS_422 = 4220 , SUBS_444 = 4440 , SUBS_4444 = 4444 }

enum	tx_media_type { TX_MEDIA_AUDIO , TX_MEDIA_VIDEO }

enum	video_mode { VIDEO_UNKNOWN , VIDEO_NORMAL , VIDEO_DUAL , VIDEO_STEREO , VIDEO_4K , VIDEO_3X1 }

Functions
void	dev_add_option (struct device_info dev, const char name, const char desc, const char key, const char *opt_str, bool is_boolean)

Detailed Description

This file contains some common data types.

Author: Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

This file should be directly included only from header files, not implementation files.

Definition in file types.h.

Macro Definition Documentation

◆ FLEXIBLE_ARRAY_MEMBER

#define FLEXIBLE_ARRAY_MEMBER 0

Definition at line 295 of file types.h.

◆ VF_METADATA_END

#define VF_METADATA_END tile_count

Definition at line 340 of file types.h.

◆ VF_METADATA_SIZE

#define VF_METADATA_SIZE (offsetof(struct video_frame, VF_METADATA_END) - offsetof(struct video_frame, VF_METADATA_START))

Definition at line 348 of file types.h.

Referenced by vf_copy_metadata(), vf_restore_metadata(), and vf_store_metadata().

◆ VF_METADATA_START

#define VF_METADATA_START fec_params

Definition at line 327 of file types.h.

Referenced by vf_copy_metadata(), vf_restore_metadata(), and vf_store_metadata().

Typedef Documentation

◆ device_probe_func

typedef void(* device_probe_func) (struct device_info **available_cards, int *count, void(**deleter)(void *))

Definition at line 404 of file types.h.

◆ frame_type_t

typedef enum frame_type frame_type_t

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
kHz8
kHz48
kHz90	timestamp time base

Definition at line 146 of file types.h.

     {
        kHz8  = 8000,
        kHz48 = 48000,
        kHz90 = 90000, 
};

◆ codec_t

enum codec_t

Video codec identificator

See also: video_frame::color_spec

Enumerator
VIDEO_CODEC_NONE	dummy color spec
VC_NONE
VIDEO_CODEC_FIRST
VC_FIRST
RGBA	RGBA 8-bit, big-endian.
UYVY	YCbCr 422 8-bit - Cb Y0 Cr Y1.
YUYV	YCbCr 422 8-bit - Y0 Cb Y1 Cr.
R10k	RGB 10-bit packed - RGBX, big-endian (2 bit padding)
R12L	RGB 12-bit packed, little-endian.
v210	YCbCr 422 10-bit - xVY0U\|xY2UY1\|xUY3V\|xY5VY4, little-endian (2 bit padding /'x'/), line aligned to 128 B.
DVS10	DVS 10-bit format.
DXT1	S3 Texture Compression DXT1.
DXT1_YUV	Structure same as DXT1, instead of RGB, YCbCr values are stored.
DXT5	S3 Texture Compression DXT5.
RGB	RGB 8-bit (packed into 24-bit word)
JPEG	JPEG image, restart intervals may be used. Compatible with GPUJPEG.
RAW	RAW HD-SDI frame.
H264	H.264 frame.
H265	H.264 frame.
MJPG	JPEG image, without restart intervals. Note May include features not compatible with GPUJPEG.
VP8	VP8 frame.
VP9	VP9 frame.
BGR	8-bit BGR
J2K	JPEG 2000.
J2KR	JPEG 2000 RGB.
HW_VDPAU	VDPAU hardware surface.
HFYU	HuffYUV.
FFV1	FFV1.
CFHD	Cineform.
RG48	16-bit RGB little-endian (RlRhGl...)
AV1	AOMedia Video 1.
I420	planar YCbCr 4:2:0
Y216	YCbCr 422 16-bit little-endian - Y0 Cb Y1 Cr.
Y416	interleaved little-endian YCbCr 4444 16-bit - UYVA
PRORES	abstract Apple ProRes, must not be used in transmit
PRORES_4444	Apple ProRes 4444.
PRORES_4444_XQ	Apple ProRes 4444 (XQ)
PRORES_422_HQ	Apple ProRes 422 (HQ)
PRORES_422	Apple ProRes 422.
PRORES_422_PROXY	Apple ProRes 422 (Proxy)
PRORES_422_LT	Apple ProRes 422 (LT)
DRM_PRIME	DRM Prime buffer, data contains struct drm_prime_frame.
VIDEO_CODEC_COUNT	count of known video codecs (including VIDEO_CODEC_NONE)
VC_COUNT
VC_END
VIDEO_CODEC_END

Definition at line 65 of file types.h.

             {
        VIDEO_CODEC_NONE = 0, 
        VC_NONE          = VIDEO_CODEC_NONE, // shortcut
        VIDEO_CODEC_FIRST,
        VC_FIRST = VIDEO_CODEC_FIRST,
        RGBA = VIDEO_CODEC_FIRST, 
        UYVY,     
        YUYV,     
        R10k,     
        R12L,     
        v210,     
        DVS10,    
        DXT1,     
        DXT1_YUV, 
        DXT5,     
        RGB,      
        JPEG,     
        RAW,      
        H264,     
        H265,     
        MJPG,     
        VP8,      
        VP9,      
        BGR,      
        J2K,      
        J2KR,     
        HW_VDPAU, 
        HFYU,     
        FFV1,     
        CFHD,     
        RG48,     
        AV1,      
        I420,     
        Y216,     
        Y416,     
        PRORES,           
        PRORES_4444,      
        PRORES_4444_XQ,   
        PRORES_422_HQ,    
        PRORES_422,       
        PRORES_422_PROXY, 
        PRORES_422_LT,    
        DRM_PRIME, 
        VIDEO_CODEC_COUNT, 
        VC_COUNT        = VIDEO_CODEC_COUNT,
        VC_END          = VIDEO_CODEC_COUNT,
        VIDEO_CODEC_END = VIDEO_CODEC_COUNT
} codec_t;

◆ depth

enum depth

Enumerator
DEPTH8
DEPTH10
DEPTH12
DEPTH16

Definition at line 125 of file types.h.

           {
        DEPTH8  = 8,
        DEPTH10 = 10,
        DEPTH12 = 12,
        DEPTH16 = 16,
};

◆ fec_type

enum fec_type

Enumerator
FEC_NONE
FEC_MULT
FEC_LDGM
FEC_RS

Definition at line 200 of file types.h.

              {
        FEC_NONE = 0,
        FEC_MULT = 1,
        FEC_LDGM = 2,
        FEC_RS   = 3,
};

◆ frame_flags_common

enum frame_flags_common

flags common for both audio and video frame

Enumerator
TIMESTAMP_VALID	timestamp set by source (in 90 kHz clock)

Definition at line 222 of file types.h.

                        {
        TIMESTAMP_VALID = 1 << 0, 
};

◆ frame_type

enum frame_type

Enumerator
INTRA
BFRAME
OTHER

Definition at line 194 of file types.h.

                        {
    INTRA = 0,
    BFRAME,
    OTHER
} frame_type_t;

◆ hw_accel_type

enum hw_accel_type

Enumerator
HWACCEL_NONE
HWACCEL_VDPAU
HWACCEL_VAAPI
HWACCEL_VIDEOTOOLBOX
HWACCEL_CUDA
HWACCEL_VULKAN
HWACCEL_DRM_PRIME
HWACCEL_COUNT

Definition at line 114 of file types.h.

                   {
        HWACCEL_NONE,
        HWACCEL_VDPAU,
        HWACCEL_VAAPI,
        HWACCEL_VIDEOTOOLBOX,
        HWACCEL_CUDA,
        HWACCEL_VULKAN,
        HWACCEL_DRM_PRIME,
        HWACCEL_COUNT
};

◆ interlacing_t

enum interlacing_t

Specifies interlacing mode of the frame

See also: video_frame::interlacing

Enumerator
PROGRESSIVE	progressive frame
UPPER_FIELD_FIRST	First stored field is top, followed by bottom.
LOWER_FIELD_FIRST	First stored field is bottom, followed by top.
INTERLACED_MERGED	Columngs of both fields are interlaced together.
SEGMENTED_FRAME	Segmented frame. Contains the same data as progressive frame. Note This is included to allow describing video mode, not content of a frame.
INTERLACING_MAX

Definition at line 163 of file types.h.

                   {
        PROGRESSIVE       = 0, 
        UPPER_FIELD_FIRST = 1, 
        LOWER_FIELD_FIRST = 2, 
        INTERLACED_MERGED = 3, 
        SEGMENTED_FRAME   = 4,  
        INTERLACING_MAX   = SEGMENTED_FRAME,
};

◆ mem_location_t

enum mem_location_t

Enumerator
CPU_MEM
CUDA_MEM

Definition at line 297 of file types.h.

                    {
        CPU_MEM = 0,
        CUDA_MEM
};

◆ subsampling

enum subsampling

Enumerator
SUBS_420
SUBS_422
SUBS_444
SUBS_4444

Definition at line 132 of file types.h.

                 {
        SUBS_420  = 4200,
        SUBS_422  = 4220,
        SUBS_444  = 4440,
        SUBS_4444 = 4444,
};

◆ tx_media_type

enum tx_media_type

Enumerator
TX_MEDIA_AUDIO
TX_MEDIA_VIDEO

Definition at line 363 of file types.h.

                   {
        TX_MEDIA_AUDIO,
        TX_MEDIA_VIDEO
};

◆ video_mode

enum video_mode

Video Mode

Video mode metadata are stored in file video.c in video_mode_info.

Enumerator
VIDEO_UNKNOWN	unspecified video mode
VIDEO_NORMAL	normal video (one tile)
VIDEO_DUAL	1x2 video grid (is this ever used?)
VIDEO_STEREO	stereoscopic 3D video (full left and right eye)
VIDEO_4K	tiled 4K video
VIDEO_3X1	3x1 video

Definition at line 354 of file types.h.

                {
        VIDEO_UNKNOWN, 
        VIDEO_NORMAL,  
        VIDEO_DUAL,    
        VIDEO_STEREO,  
        VIDEO_4K,      
        VIDEO_3X1,     
};

Function Documentation

◆ dev_add_option()

void dev_add_option	(	struct device_info *	dev,
		const char *	name,
		const char *	desc,
		const char *	key,
		const char *	opt_str,
		bool	is_boolean )

Definition at line 652 of file video_display.c.

                                                                                                                                       {
 
    int idx = 0;
    while(*dev->options[idx].key)
        idx++;
 
    strncpy(dev->options[idx].display_name, name, sizeof(dev->options[idx].display_name) - 1);
    strncpy(dev->options[idx].display_desc, desc, sizeof(dev->options[idx].display_desc) - 1);
    strncpy(dev->options[idx].key, key, sizeof(dev->options[idx].key) - 1);
    strncpy(dev->options[idx].opt_str, opt_str, sizeof(dev->options[idx].opt_str) - 1);
    dev->options[idx].is_boolean = is_boolean;
}

References desc, device_option::display_desc, device_option::display_name, device_option::is_boolean, is_boolean, device_option::key, key, name, device_option::opt_str, opt_str, and device_info::options.

Referenced by display_decklink_probe(), display_sdl2_probe(), vidcap_decklink_probe(), vidcap_dshow_probe_internal(), and vidcap_testcard_probe().

Classes

Macros

Typedefs

Enumerations

Functions