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

此公共类用于创建 onevpl::GSource 实例。更多...

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

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

公共类型
using	name_t = std::string
using	value_t

公共成员函数
	CfgParam (CfgParam &&src)
	CfgParam (const CfgParam &src)
	~CfgParam（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（解码器ID名称） ()
	decoder_id_name（解码器ID名称）
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（VPP帧池大小名称） ()
static constexpr const char *	vpp_in_crop_h_name（VPP输入裁剪高度名称） ()
static constexpr const char *	vpp_in_crop_w_name（VPP输入裁剪宽度名称） ()
static constexpr const char *	vpp_in_crop_x_name（VPP输入裁剪X坐标名称） ()
static constexpr const char *	vpp_in_crop_y_name（VPP输入裁剪Y坐标名称） ()
static constexpr const char *	vpp_in_height_name（VPP输入高度名称） ()
static constexpr const char *	vpp_in_width_name（VPP输入宽度名称） ()
static constexpr const char *	vpp_out_chroma_format_name（VPP输出色度格式名称） ()
static constexpr const char *	vpp_out_crop_h_name（VPP输出裁剪高度名称） ()
static constexpr const char *	vpp_out_crop_w_name（VPP输出裁剪宽度名称） ()
static constexpr const char *	vpp_out_crop_x_name（VPP输出裁剪X坐标名称） ()
static constexpr const char *	vpp_out_crop_y_name（VPP输出裁剪Y坐标名称） ()
static constexpr const char *	vpp_out_fourcc_name（VPP输出FourCC名称） ()
static constexpr const char *	vpp_out_framerate_d_name（VPP输出帧率分母名称） ()
static constexpr const char *	vpp_out_framerate_n_name（VPP输出帧率分子名称） ()
static constexpr const char *	vpp_out_height_name（VPP输出高度名称） ()
static constexpr const char *	vpp_out_pic_struct_name（VPP输出图像结构名称） ()
static constexpr const char *	vpp_out_width_name（VPP输出宽度名称） ()

详细描述

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

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

注意

由于 OneVPL 可能提供多个满足多项（或单项）CfgParam 标准的实现，因此可以配置 preferred（首选）参数。这类 CfgParam 使用 CfgParam::create 方法中的 is_major = false 参数创建，并且不用于创建特定的 OneVPL 实现。相反，它们用于填充“得分表”以从可用列表中选择更优的实现。将选择满足大多数这些可选参数的实现。如果不存在任何可选的 CfgParam 参数，则将应用第一个可用的 OneVPL 实现。有关 OneVPL 配置的使用，请参考 https://spec.oneapi.io/versions/latest/elements/oneVPL/source/API_ref/VPL_disp_api_func.html?highlight=mfxcreateconfig#mfxsetconfigfilterproperty。在此方案中，mfxU8 *name 表示 CfgParam::get_name()，mfxVariant value 是 CfgParam::get_value()。

成员 Typedef 文档

name_t

using cv::gapi::wip::onevpl::CfgParam::name_t = std::string

value_t

using 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 设备内存中的 MediaFrame

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

create()

template<typename ValueType >

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

inlinestatic

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

参数

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

create_acceleration_mode() [1/2]

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

static

create_acceleration_mode() [2/2]

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

static

create_decoder_id() [1/2]

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

static

create_decoder_id() [2/2]

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

static

create_frames_pool_size()

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

static

create_implementation() [1/2]

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

static

create_implementation() [2/2]

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

static

create_vpp_frames_pool_size()

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

static

create_vpp_in_crop_h()

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

static

create_vpp_in_crop_w()

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

static

create_vpp_in_crop_x()

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

static

create_vpp_in_crop_y()

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

static

create_vpp_in_height()

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

static

create_vpp_in_width()

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

static

create_vpp_out_chroma_format()

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

static

create_vpp_out_crop_h()

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

static

create_vpp_out_crop_w()

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

static

create_vpp_out_crop_x()

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

static

create_vpp_out_crop_y()

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

static

create_vpp_out_fourcc()

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

static

create_vpp_out_framerate_d()

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

static

create_vpp_out_framerate_n()

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

static

create_vpp_out_height()

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

static

create_vpp_out_pic_struct()

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

static

create_vpp_out_width()

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

static

decoder_id_name()

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

inlinestaticconstexpr

decoder_id_name（解码器ID名称）

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

注意

decoder_id_name 允许指定 VPL 解码器类型，该参数在 RAW 视频输入数据情况下必须存在，而当视频流封装在容器（*.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 操作消耗之前，将其保存在加速器内存中。如果您看到大量关于可用表面不足的 WARNING（警告），那么是时候增加 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