通过前面几篇文章的学习,我们知道了Codec2参数结构,以及如何定义一个Codec2参数。接下来的几篇文章我们将简单了解上层是如何请求组件支持的参数、如何配置参数,以及参数是如何反射给上层的。本篇文章我们将了解接口参数实例化。
1、C2InterfaceHelper
C2InterfaceHelper是Codec2框架提供的用于实现组件接口的工具类,在Codec2中组件被拆分为数据处理部分和接口两个部分,接口存储有组件所有的参数,是独立于数据处理组件的。我们可以独立创建接口,获取组件支持的参数,也可以尝试设定参数。接口中的默认参数设定是best effort的,也就是最优的。
在C2PlatformComponentStore的构造函数中可以看到实例化了一个Interface对象,这个对象继承于C2InterfaceHelper。
struct Interface : public C2InterfaceHelper {
std::shared_ptr<C2StoreIonUsageInfo> mIonUsageInfo;
std::shared_ptr<C2StoreDmaBufUsageInfo> mDmaBufUsageInfo;
Interface(std::shared_ptr<C2ReflectorHelper> reflector)
: C2InterfaceHelper(reflector) {
addParameter(
DefineParam(mIonUsageInfo, "ion-usage")
.withDefault(new C2StoreIonUsageInfo())
.withFields({
C2F(mIonUsageInfo, usage).flags({C2MemoryUsage::CPU_READ | C2MemoryUsage::CPU_WRITE}),
C2F(mIonUsageInfo, capacity).inRange(0, UINT32_MAX, 1024),
C2F(mIonUsageInfo, heapMask).any(),
C2F(mIonUsageInfo, allocFlags).flags({}),
C2F(mIonUsageInfo, minAlignment).equalTo(0)
})
.withSetter(Setter::setIonUsage)
.build());
}
}
Interface内部定义了两个C2参数,从这里可以看出接口和模块(组件或ComponentStore)是相互独立的,实例化模块时,需要先创建一个接口,然后将接口传递给模块。每次配置参数,修改的是模块实例持有的接口实例。模块销毁后,对接口做的修改也就失效了。如果我们独立创建接口,对接口中的参数做修改,实际上不会对任何模块实例产生任何影响,因为独立创建的接口没有和模块实例做绑定。
组件或ComponentStore支持的所有参数都需要使用C2InterfaceHelper来定义,否则将无法实现查询、修改和反射功能。接下来我们将了解如何通过C2InterfaceHelper提供的方法来定义参数。
2、DefineParam
template<typename T>
static ParamBuilder<T> DefineParam(std::shared_ptr<T> ¶m, C2StringLiteral name) {
return ParamBuilder<T>(param, name);
}