platf::kms::display_ram_t Class Reference

KMS capture backend that copies frames into system memory. More...

Inheritance diagram for platf::kms::display_ram_t:

Collaboration diagram for platf::kms::display_ram_t:

Public Member Functions
std::shared_ptr< img_t >	alloc_img () override
	Allocate an image buffer compatible with this display backend.
void	blend_cursor (img_t &img)
	Blend the captured cursor plane into a KMS frame.
capture_e	capture (const push_captured_image_cb_t &push_captured_image_cb, const pull_free_image_cb_t &pull_free_image_cb, bool *cursor) override
	Capture a frame.
	display_ram_t (mem_type_e mem_type)
	Initialize a KMS display backend that copies frames through RAM.
int	dummy_img (platf::img_t *img) override
	Populate a fallback image when real capture data is unavailable.
int	init (const std::string &display_name, const ::video::config_t &config)
	Initialize KMS capture that copies frames into system memory.
std::unique_ptr< avcodec_encode_device_t >	make_avcodec_encode_device (pix_fmt_e pix_fmt) override
	Create AVCodec encode device.
capture_e	snapshot (const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr< platf::img_t > &img_out, std::chrono::milliseconds timeout, bool cursor)
	Capture a display frame into the provided image object.
Public Member Functions inherited from platf::kms::display_t
	display_t (mem_type_e mem_type)
	Initialize common KMS display state for the requested memory type.
bool	get_hdr_metadata (SS_HDR_METADATA &metadata)
	Read HDR metadata for the active display mode.
int	init (const std::string &display_name, const ::video::config_t &config)
	Initialize the base KMS capture state for the selected monitor.
bool	is_hdr ()
	Report whether the active display mode is HDR.
capture_e	refresh (file_t *file, egl::surface_descriptor_t *sd, std::optional< std::chrono::steady_clock::time_point > &frame_timestamp)
	Refresh cached platform state from the operating system.
void	update_cursor ()
	Update cached cursor-plane image and position.
Public Member Functions inherited from platf::display_t
virtual bool	is_codec_supported (std::string_view name, const ::video::config_t &config)
	Check that a given codec is supported by the display device.
virtual std::unique_ptr< nvenc_encode_device_t >	make_nvenc_encode_device (pix_fmt_e pix_fmt)
	Create NVENC encode device.

Public Attributes
egl::ctx_t	ctx
	EGL context used to copy KMS frames into RAM.
egl::display_t	display
	EGL display created from the GBM device.
gbm::gbm_t	gbm
	GBM device used for buffer allocation.
Public Attributes inherited from platf::kms::display_t
cursor_t	captured_cursor {}
	Captured cursor.
card_t	card
	Card.
std::optional< uint32_t >	connector_id
	Connector ID.
int	crtc_id
	Crtc ID.
int	crtc_index
	Crtc index.
int	cursor_plane_id
	Cursor plane ID.
std::chrono::nanoseconds	delay
	Delay before the timer task becomes eligible to run.
std::optional< uint64_t >	hdr_metadata_blob_id
	HDR metadata blob ID.
int	img_height
	Img height.
int	img_offset_x
	Img offset x.
int	img_offset_y
	Img offset y.
int	img_width
	Img width.
mem_type_e	mem_type
	Mem type.
int	plane_id
	Plane ID.
Public Attributes inherited from platf::display_t
int	env_height {0}
	Height of the full capture environment in physical pixels.
int	env_logical_height {0}
	Height of the full capture environment after display scaling.
int	env_logical_width {0}
	Width of the full capture environment after display scaling.
int	env_width {0}
	Width of the full capture environment in physical pixels.
int	height {0}
	Height of the captured display in physical pixels.
int	logical_height {0}
	Height of the captured display after display scaling.
int	logical_width {0}
	Width of the captured display after display scaling.
int	offset_x {0}
	Horizontal capture offset in physical pixels.
int	offset_y {0}
	Vertical capture offset in physical pixels.
int	width {0}
	Width of the captured display in physical pixels.

Additional Inherited Members
Public Types inherited from platf::display_t
using	pull_free_image_cb_t = std::function<bool(std::shared_ptr<img_t> &img_out)>
	Get free image from pool. Calls must be synchronized. Blocks until there is free image in the pool or capture is interrupted.
using	push_captured_image_cb_t = std::function<bool(std::shared_ptr<img_t> &&img, bool frame_captured)>
	Callback for when a new image is ready. When display has a new image ready or a timeout occurs, this callback will be called with the image. If a frame was captured, frame_captured will be true. If a timeout occurred, it will be false.
Protected Attributes inherited from platf::display_t
logging::time_delta_periodic_logger	sleep_overshoot_logger = {debug, "Frame capture sleep overshoot"}
	Periodic logger for capture sleep overshoot measurements.

Detailed Description

KMS capture backend that copies frames into system memory.

Constructor & Destructor Documentation

display_ram_t()

platf::kms::display_ram_t::display_ram_t ( mem_type_e mem_type )

inline

Initialize a KMS display backend that copies frames through RAM.

Parameters

mem_type

Mem type.

Member Function Documentation

alloc_img()

std::shared_ptr< img_t > platf::kms::display_ram_t::alloc_img ( )

inlineoverridevirtual

Allocate an image buffer compatible with this display backend.

Returns

Allocated img object, or null when unavailable.

Implements platf::display_t.

blend_cursor()

void platf::kms::display_ram_t::blend_cursor ( img_t & img )

inline

Blend the captured cursor plane into a KMS frame.

Parameters

img	Image or frame object to read from or populate.

capture()

capture_e platf::kms::display_ram_t::capture ( const push_captured_image_cb_t & push_captured_image_cb, const pull_free_image_cb_t & pull_free_image_cb, bool * cursor )

inlineoverridevirtual

Capture a frame.

Parameters

push_captured_image_cb	The callback that is called with captured image, must be called from the same thread as capture()
pull_free_image_cb	Capture backends call this callback to get empty image from the pool. If backend uses multiple threads, calls to this callback must be synchronized. Calls to this callback and push_captured_image_cb must be synchronized as well.
cursor	A pointer to the flag that indicates whether the cursor should be captured as well.

Return values

capture_e::ok	When stopping
capture_e::error	On error
capture_e::reinit	When need of reinitialization

Implements platf::display_t.

dummy_img()

int platf::kms::display_ram_t::dummy_img ( platf::img_t * img )

inlineoverridevirtual

Populate a fallback image when real capture data is unavailable.

Parameters

img	Image or frame object to read from or populate.

Returns

Capture status reported to the streaming pipeline.

Implements platf::display_t.

init()

int platf::kms::display_ram_t::init ( const std::string & display_name, const ::video::config_t & config )

inline

Initialize KMS capture that copies frames into system memory.

Parameters

display_name	Display name.
config	Configuration values to apply.

Returns

0 on success; nonzero or negative platform status on failure.

make_avcodec_encode_device()

std::unique_ptr< avcodec_encode_device_t > platf::kms::display_ram_t::make_avcodec_encode_device ( pix_fmt_e pix_fmt )

inlineoverridevirtual

Create AVCodec encode device.

Parameters

pix_fmt

Sunshine pixel format to convert or allocate for.

Returns

Constructed AVCodec encode device object.

Reimplemented from platf::display_t.

snapshot()

capture_e platf::kms::display_ram_t::snapshot ( const pull_free_image_cb_t & pull_free_image_cb, std::shared_ptr< platf::img_t > & img_out, std::chrono::milliseconds timeout, bool cursor )

inline

Capture a display frame into the provided image object.

Parameters

pull_free_image_cb	Callback that provides an available image buffer.
img_out	Captured KMS image returned to the streaming pipeline.
timeout	Maximum time to wait for the operation.
cursor	Cursor image or visibility state to composite.

Returns

Capture status reported to the streaming pipeline.

---

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

• src/platform/linux/kmsgrab.cpp