cv::gapi::wip::onevpl::CfgParam 结构体参考

公共类，用于创建onevpl::GSource 实例。更多…

#include <opencv2/gapi/streaming/onevpl/cfg_params.hpp>

cv::gapi::wip::onevpl::CfgParam 的协作图

公共类型
使用	name_t = std::string
使用	value_t

公共成员函数
	CfgParam (CfgParam &&src)
	CfgParam (const CfgParam &src)
	~CfgParam ()
const name_t &	get_name () const
const value_t &	get_value () const
bool	is_major () const
bool	operator!= (const CfgParam &rhs) const
bool	operator< (const CfgParam &rhs) const
CfgParam &	operator= (CfgParam &&src)
CfgParam &	operator= (const CfgParam &src)
bool	operator== (const CfgParam &rhs) const
std::string	to_string () const

静态公共成员函数
static constexpr const char *	acceleration_mode_name ()
	acceleration_mode_name
template<typename ValueType >
static CfgParam	create (const std::string &name, ValueType &&value, bool is_major=true)
static CfgParam	create_acceleration_mode (const char *value)
static CfgParam	create_acceleration_mode (uint32_t value)
static CfgParam	create_decoder_id (const char *value)
static CfgParam	create_decoder_id (uint32_t value)
static CfgParam	create_frames_pool_size (size_t value)
static CfgParam	create_implementation (const char *value)
static CfgParam	create_implementation (uint32_t value)
static CfgParam	create_vpp_frames_pool_size (size_t value)
static CfgParam	create_vpp_in_crop_h (uint16_t value)
static CfgParam	create_vpp_in_crop_w (uint16_t value)
static CfgParam	create_vpp_in_crop_x (uint16_t value)
static CfgParam	create_vpp_in_crop_y (uint16_t value)
static CfgParam	create_vpp_in_height (uint16_t value)
static CfgParam	create_vpp_in_width (uint16_t value)
static CfgParam	create_vpp_out_chroma_format (uint16_t value)
static CfgParam	create_vpp_out_crop_h (uint16_t value)
static CfgParam	create_vpp_out_crop_w (uint16_t value)
static CfgParam	create_vpp_out_crop_x (uint16_t value)
static CfgParam	create_vpp_out_crop_y (uint16_t value)
static CfgParam	create_vpp_out_fourcc (uint32_t value)
static CfgParam	create_vpp_out_framerate_d (uint32_t value)
static CfgParam	create_vpp_out_framerate_n (uint32_t value)
static CfgParam	create_vpp_out_height (uint16_t value)
static CfgParam	create_vpp_out_pic_struct (uint16_t value)
static CfgParam	create_vpp_out_width (uint16_t value)
static constexpr const char *	decoder_id_name ()
	decoder_id_name
static constexpr const char *	frames_pool_size_name ()
	frames_pool_size_name
static constexpr const char *	implementation_name ()
static constexpr const char *	vpp_frames_pool_size_name ()
static constexpr const char *	vpp_in_crop_h_name ()
static constexpr const char *	vpp_in_crop_w_name ()
static constexpr const char *	vpp_in_crop_x_name ()
static constexpr const char *	vpp_in_crop_y_name ()
static constexpr const char *	vpp_in_height_name ()
static constexpr const char *	vpp_in_width_name ()
static constexpr const char *	vpp_out_chroma_format_name ()
static constexpr const char *	vpp_out_crop_h_name ()
static constexpr const char *	vpp_out_crop_w_name ()
static constexpr const char *	vpp_out_crop_x_name ()
static constexpr const char *	vpp_out_crop_y_name ()
static constexpr const char *	vpp_out_fourcc_name ()
static constexpr const char *	vpp_out_framerate_d_name ()
static constexpr const char *	vpp_out_framerate_n_name ()
static constexpr const char *	vpp_out_height_name ()
static constexpr const char *	vpp_out_pic_struct_name ()
static constexpr const char *	vpp_out_width_name ()

详细描述

公共类，用于创建onevpl::GSource 实例。

通过方法CfgParam::get_name() 和 CfgParam::get_value() 可访问的类成员由onevpl::GSource 内部逻辑用来创建或查找 OneVPL 特定的实现（软件/硬件、特定 API 版本等）。

注意

由于 OneVPL 可能提供多个满足多个（或单个）CfgParam 条件的实现，因此可以配置“首选”参数。这种 CfgParams 是使用 CfgParam::create 方法中的 `is_major = false` 参数创建的，不用于创建 OneVPL 特定的实现。相反，它们填充“评分表”以从可用列表中选择首选实现。满足大多数这些可选参数的实现将被选中。如果没有可选的CfgParam 参数，则将应用第一个可用的 OneVPL 实现。请访问 https://spec.oneapi.io/versions/latest/elements/oneVPL/source/API_ref/VPL_disp_api_func.html?highlight=mfxcreateconfig#mfxsetconfigfilterproperty 以使用 OneVPL 配置。在此方案中，`mfxU8 *name` 代表CfgParam::get_name()，`mfxVariant value` 是CfgParam::get_value()

成员类型定义文档

name_t

使用 cv::gapi::wip::onevpl::CfgParam::name_t = std::string

value_t

使用 cv::gapi::wip::onevpl::CfgParam::value_t

初始值

 cv::util::variant<uint8_t, int8_t,
uint16_t, int16_t,
uint32_t, int32_t,
uint64_t, int64_t,
float_t,
double_t,
                                      void*,
std::string>

构造函数和析构函数文档

CfgParam() [1/2]

cv::gapi::wip::onevpl::CfgParam::CfgParam

(

const CfgParam &

src

)

CfgParam() [2/2]

cv::gapi::wip::onevpl::CfgParam::CfgParam

(

CfgParam &&

src

)

~CfgParam()

cv::gapi::wip::onevpl::CfgParam::~CfgParam

(

)

成员函数文档

acceleration_mode_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::acceleration_mode_name ( )

inlinestaticconstexpr

acceleration_mode_name

onevp::GSource 的特殊配置参数名称

注意

acceleration_mode_name 允许激活硬件加速和设备内存管理。支持的值

• MFX_ACCEL_MODE_VIA_D3D11 将激活 DX11 加速，并将生成在 DX11 设备内存中分配数据的 MediaFrames

如果未设置，则 MFX 实现将使用默认的加速行为：所有解码操作都使用默认的 GPU 资源，但MediaFrame 生成使用主机 RAM 分配的数据

create()

template<typename ValueType >

static CfgParam cv::gapi::wip::onevpl::CfgParam::create ( const std::string & name, ValueType && value, bool is_major = true )

inlinestatic

创建通用的 onevp::GSource 配置参数。

参数

name	参数名称。
value	参数值。
is_major	如果参数必须由 OneVPL 内部实现提供，则为 TRUE，否则为可选（用于解析多个可用的实现）。

create_acceleration_mode() [1/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_acceleration_mode ( const char * value )

static

create_acceleration_mode() [2/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_acceleration_mode ( uint32_t value )

static

create_decoder_id() [1/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_decoder_id ( const char * value )

static

create_decoder_id() [2/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_decoder_id ( uint32_t value )

static

create_frames_pool_size()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_frames_pool_size ( size_t value )

static

create_implementation() [1/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_implementation ( const char * value )

static

create_implementation() [2/2]

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_implementation ( uint32_t value )

static

create_vpp_frames_pool_size()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_frames_pool_size ( size_t value )

static

create_vpp_in_crop_h()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_crop_h ( uint16_t value )

static

create_vpp_in_crop_w()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_crop_w ( uint16_t value )

static

create_vpp_in_crop_x()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_crop_x ( uint16_t value )

static

create_vpp_in_crop_y()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_crop_y ( uint16_t value )

static

create_vpp_in_height()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_height ( uint16_t value )

static

create_vpp_in_width()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_in_width ( uint16_t value )

static

create_vpp_out_chroma_format()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_chroma_format ( uint16_t value )

static

create_vpp_out_crop_h()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_crop_h ( uint16_t value )

static

create_vpp_out_crop_w()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_crop_w ( uint16_t value )

static

create_vpp_out_crop_x()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_crop_x ( uint16_t value )

static

create_vpp_out_crop_y()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_crop_y ( uint16_t value )

static

create_vpp_out_fourcc()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_fourcc ( uint32_t value )

static

create_vpp_out_framerate_d()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_framerate_d ( uint32_t value )

static

create_vpp_out_framerate_n()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_framerate_n ( uint32_t value )

static

create_vpp_out_height()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_height ( uint16_t value )

static

create_vpp_out_pic_struct()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_pic_struct ( uint16_t value )

static

create_vpp_out_width()

static CfgParam cv::gapi::wip::onevpl::CfgParam::create_vpp_out_width ( uint16_t value )

static

decoder_id_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::decoder_id_name ( )

inlinestaticconstexpr

decoder_id_name

onevp::GSource 的特殊配置参数名称

注意

decoder_id_name 允许指定 VPL 解码器类型，在原始视频输入数据的情况下必须存在，如果视频流封装在容器（*.mp4、*.mkv 等）中，则作为CfgParam 必须不存在。在后一种情况下，onevp::GSource 将自动确定它。支持的值

• MFX_CODEC_AVC
• MFX_CODEC_HEVC
• MFX_CODEC_MPEG2
• MFX_CODEC_VC1
• MFX_CODEC_CAPTURE
• MFX_CODEC_VP9
• MFX_CODEC_AV1

frames_pool_size_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::frames_pool_size_name ( )

inlinestaticconstexpr

frames_pool_size_name

onevp::GSource 的特殊配置参数名称

注意

frames_pool_size_name 允许分配适当大小的表面池，以便在 onevp::GSource::pull 操作使用之前，将解码后的帧保存在加速器内存中。如果您看到很多关于可用表面不足的警告，那么就应该增加 frames_pool_size_name，但要注意加速器可用内存量。如果未设置，则 MFX 实现使用 mfxFrameAllocRequest::NumFrameSuggested 行为

get_name()

const name_t & cv::gapi::wip::onevpl::CfgParam::get_name

(

)

const

get_value()

const value_t & cv::gapi::wip::onevpl::CfgParam::get_value

(

)

const

implementation_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::implementation_name ( )

inlinestaticconstexpr

is_major()

bool cv::gapi::wip::onevpl::CfgParam::is_major

(

)

const

operator!=()

bool cv::gapi::wip::onevpl::CfgParam::operator!=

(

const CfgParam &

rhs

)

const

operator<()

bool cv::gapi::wip::onevpl::CfgParam::operator<

(

const CfgParam &

rhs

)

const

operator=() [1/2]

CfgParam & cv::gapi::wip::onevpl::CfgParam::operator=

(

CfgParam &&

src

)

operator=() [2/2]

CfgParam & cv::gapi::wip::onevpl::CfgParam::operator=

(

const CfgParam &

src

)

operator==()

bool cv::gapi::wip::onevpl::CfgParam::operator==

(

const CfgParam &

rhs

)

const

to_string()

std::string cv::gapi::wip::onevpl::CfgParam::to_string

(

)

const

vpp_frames_pool_size_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_frames_pool_size_name ( )

inlinestaticconstexpr

vpp_in_crop_h_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_crop_h_name ( )

inlinestaticconstexpr

vpp_in_crop_w_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_crop_w_name ( )

inlinestaticconstexpr

vpp_in_crop_x_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_crop_x_name ( )

inlinestaticconstexpr

vpp_in_crop_y_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_crop_y_name ( )

inlinestaticconstexpr

vpp_in_height_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_height_name ( )

inlinestaticconstexpr

vpp_in_width_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_in_width_name ( )

inlinestaticconstexpr

vpp_out_chroma_format_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_chroma_format_name ( )

inlinestaticconstexpr

vpp_out_crop_h_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_crop_h_name ( )

inlinestaticconstexpr

vpp_out_crop_w_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_crop_w_name ( )

inlinestaticconstexpr

vpp_out_crop_x_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_crop_x_name ( )

inlinestaticconstexpr

vpp_out_crop_y_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_crop_y_name ( )

inlinestaticconstexpr

vpp_out_fourcc_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_fourcc_name ( )

inlinestaticconstexpr

vpp_out_framerate_d_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_framerate_d_name ( )

inlinestaticconstexpr

vpp_out_framerate_n_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_framerate_n_name ( )

inlinestaticconstexpr

vpp_out_height_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_height_name ( )

inlinestaticconstexpr

vpp_out_pic_struct_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_pic_struct_name ( )

inlinestaticconstexpr

vpp_out_width_name()

static constexpr const char * cv::gapi::wip::onevpl::CfgParam::vpp_out_width_name ( )

inlinestaticconstexpr

---

此结构体的文档由以下文件生成：

• opencv2/gapi/streaming/onevpl/cfg_params.hpp