platf::display_t Class Reference

Inheritance diagram for platf::display_t:

Collaboration diagram for platf::display_t:

Public Types
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.

Public Member Functions
virtual std::shared_ptr< img_t >	alloc_img ()=0
virtual 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)=0
	Capture a frame.
virtual int	dummy_img (img_t *img)=0
virtual bool	get_hdr_metadata (SS_HDR_METADATA &metadata)
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 bool	is_hdr ()
virtual std::unique_ptr< avcodec_encode_device_t >	make_avcodec_encode_device (pix_fmt_e pix_fmt)
virtual std::unique_ptr< nvenc_encode_device_t >	make_nvenc_encode_device (pix_fmt_e pix_fmt)

Public Attributes
int	env_height
int	env_width
int	height
int	offset_x
int	offset_y
int	width

Protected Attributes
logging::time_delta_periodic_logger	sleep_overshoot_logger = {debug, "Frame capture sleep overshoot"}

Member Typedef Documentation

pull_free_image_cb_t

using platf::display_t::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.

Return values

true	On success, img_out contains free image
false	When capture has been interrupted, img_out contains nullptr

push_captured_image_cb_t

using platf::display_t::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.

Return values

true	On success
false	On break request

Member Function Documentation

capture()

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

pure virtual

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

Implemented in platf::kms::display_vram_t, cuda::nvfbc::display_t, platf::kms::display_ram_t, wl::wlr_ram_t, wl::wlr_vram_t, platf::x11_attr_t, platf::shm_attr_t, platf::av_display_t, and platf::dxgi::display_base_t.

is_codec_supported()

virtual bool platf::display_t::is_codec_supported ( std::string_view name, const ::video::config_t & config )

inlinevirtual

Check that a given codec is supported by the display device.

Parameters

name	The FFmpeg codec name (or similar for non-FFmpeg codecs).
config	The codec configuration.

Returns

true if supported, false otherwise.

Reimplemented in platf::dxgi::display_vram_t.

---

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

• src/platform/common.h