创建一个简单的VST之Channel Mixer

创建一个简单的VST之Channel Mixer

上次做了一个将数据直接透传的VST插件，意在熟悉VST SDK的开发过程。这次在之前的基础上，实现简单的声道重混缩功能。本来只想做调节音量功能来做练习，后来发现拓展个声道重混缩功能也是顺水推舟的事。
和上次相比不同的是，这次需要增加可调的参数。考虑一个Channel Mixer的功能，需要以下几个参数：
左声道输出的左声道比例、右声道比例
右声道输出的左声道比例、右声道比例
再外加一个整体增益，一共5个参数。

protected:
	float m_gain;
	float m_l_mix_l;
	float m_l_mix_r;
	float m_r_mix_l;
	float m_r_mix_r;

VST中有“预设”的概念，每个预设对应一组参数。在参考书给的例程中，专门定义了一个类来管理不同预设的参数，我不习惯这种写法，直接用C风格的struct搞定，定义成静态数组，还不用new，它不香吗。

typedef struct Preset_tag
{
	float m_gain;
	float m_l_mix_l;
	float m_l_mix_r;//因为懒，也定义成 m_开头了，方便复制
	float m_r_mix_l;
	float m_r_mix_r;
	char szPresetName[kVstMaxProgNameLen];
}Preset_t;

接着要实现父类各种虚函数，这部分很烦，代码相当重复。头文件可见一斑。

#pragma once
#include "audioeffectx.h"

enum em_presets
{
	PRST_DEFAULT = 0,
	PRST_AVER_MIX,
	PRST_VOCAL_CUT,
	PRST_WIDEN,
	PRST_USER,
	PRST_NUM,

};

enum em_parameters
{

	PARA_GAIN = 0,
	PARA_LML,
	PARA_LMR,
	PARA_RML,
	PARA_RMR,
	PARA_NUM,
};

#define PS_NAME_MAXLEN		24


typedef struct Preset_tag
{
	float m_gain;
	float m_l_mix_l;
	float m_l_mix_r;
	float m_r_mix_l;
	float m_r_mix_r;
	//bool m_inv_l;
	//bool m_inv_r;
	char szPresetName[kVstMaxProgNameLen];
}Preset_t;

class AVolume :
	public AudioEffectX
{
public:
	AVolume(audioMasterCallback audioMaster);
	virtual ~AVolume();

	virtual void processReplacing(float** inputs, float** outputs, VstInt32 sampleFrames);
//	virtual void processDoubleReplacing(double** inputs, double** outputs, VstInt32 sampleFrames);
	virtual void setProgram(VstInt32 program);
	virtual void setProgramName(char* name);// "Program" means Preset indeed
	virtual void getProgramName(char* name);

	/* 与参数相关的虚函数 */
	
	virtual void setParameter(VstInt32 index, float value);///< Called when a parameter changed
	virtual float getParameter(VstInt32 index);		///< Return the value of the parameter with \e index	
	virtual void getParameterName(VstInt32 index, char* text);      	///< Stuff \e text with the name ("Time", "Gain", "RoomType", etc...) of parameter \e index. Limited to #kVstMaxParamStrLen.
	virtual void getParameterLabel(VstInt32 index, char* label); ///< Stuff \e label with the units in which parameter \e index is displayed (i.e. "sec", "dB", "type", etc...). Limited to #kVstMaxParamStrLen.
	virtual void getParameterDisplay(VstInt32 index, char* text);///< Stuff \e text with a string representation ("0.5", "-3", "PLATE", etc...) of the value of parameter \e index. Limited to #kVstMaxParamStrLen.

	/* 与注册插件相关的虚函数 */
	virtual bool getEffectName(char* name);	
	virtual bool getVendorString(char* text);	///< Fill \e text with a string identifying the vendor
	virtual bool getProductString(char* text);	///< Fill \e text with a string identifying the product name
	virtual bool getProgramNameIndexed(VstInt32 category, VstInt32 index, char* text);
	virtual VstInt32 getVendorVersion();		///< Return vendor-specific version
	virtual VstPlugCategory getPlugCategory();	///< Specify a category that fits the plug (#VstPlugCategory)

protected:
	float m_gain;
	float m_l_mix_l;
	float m_l_mix_r;
	float m_r_mix_l;
	float m_r_mix_r;
	//bool m_inv_l;
	//bool m_inv_r;

	VstInt32 m_cur_preset;
	Preset_t m_presets[PRST_NUM];

};

SDK中把 Preset 叫做 program，让我感到非常别扭。还有一个吐槽的点，SDK中表示负无穷的字符串竟然是-oo，我改成了-Inf，因为主流插件都是这样做的。

凡是带Parameter、Program的函数都特别烦，每个case都要写一遍，让我有种想用脚本写代码的冲动。

漫长的搬砖之后，最后终于到了processReplacing函数。

void AVolume::processReplacing(float** inputs, float** outputs, VstInt32 sampleFrames)
{
	VstInt32 i = 0;
	float *in1 = inputs[0];		// L input
	float *in2 = inputs[1];		// R input
	float *out1 = outputs[0];	// L output
	float *out2 = outputs[1];	// R output

	float real_lml = (m_l_mix_l - 0.5f) * 2.0f;
	float real_lmr = (m_l_mix_r - 0.5f) * 2.0f;
	float real_rml = (m_r_mix_l - 0.5f) * 2.0f;
	float real_rmr = (m_r_mix_r - 0.5f) * 2.0f;

	for (i = 0; i < sampleFrames; ++i)
	{
		//out1[i] = (in1[i] * m_l_mix_l + in2[i] * m_l_mix_r) * m_gain;
		//out2[i] = (in1[i] * m_r_mix_l + in2[i] * m_r_mix_r) * m_gain;
		*out1++ = (*in1 * real_lml + *in2 * real_lmr) * m_gain;
		*out2++ = (*in1 * real_rml + *in2 * real_rmr) * m_gain;
		++in1;
		++in2;
	}
}

这里用了相当奇怪的写法 ，成员变量不作为代入计算的值，而是y = (x - 0.5) * 2。这样是为了适配自动生成的界面。自动生成的界面控件不能拉到负值（或者我暂时不知道），想了个招数骗过控件，让m_x_mix_x成员变量范围在0~1，转换到数据处理时变成-1~1，显示时变成-100%~100%。

// 获得参数显示的数值
void AVolume::getParameterDisplay(VstInt32 index, char* text)
{
	switch (index)
	{
	case PARA_GAIN:
		dB2string(m_gain, text, 5);
		break;

	case PARA_LML:
		float2string((m_l_mix_l - 0.5f) * 200.0f, text, 4);
		break;

	case PARA_LMR:
		float2string((m_l_mix_r - 0.5f) * 200.0f, text, 4);
		break;

	case PARA_RML:
		float2string((m_r_mix_l - 0.5f) * 200.0f, text, 4);
		break;

	case PARA_RMR:
		float2string((m_r_mix_r - 0.5f) * 200.0f, text, 4);
		break;
	}
}

这只是权宜之计，之后再搞定GUI。在下一个工程中，将主要进行VST GUI的练习。

过程中出现一个BUG，调用strcpy_s是没注意越界了，原因是名字太长了，kVstMaxParamStrLen实际只有8。

	// strcpy_s(text, kVstMaxParamStrLen, "R Right Mix");  越界，kVstMaxParamStrLen==8
	strcpy_s(text, kVstMaxParamStrLen, "R RMix");

实测在Audition下支持得比较好，但是重新生成后，原来的preset也不会更新，目前按照例程的写法，preset会被修改，这样是不对的，下个版本再注意。另外在Sequoia 12下控件有点不对，这个问题在有了GUI之后可能就不存在了，忽略。

之后主攻GUI。先不急着把压限器算法放进去，可以先做一个电平显示的东西。

VST SDK编程还是比较有章可循，主要是运作方式都固定了，需要实现的很多函数都是回调函数，不需要自己调用。