openFrameworksでCCMapperを実装する

2022/11/4
「問題点」の記述に間違いがあったので修正した。

2022/11/3
初版

概要

「re.corder/ElefueをCCMapper経由で外部音源(Aria/Windows)と接続する(WIDI_Bud_Pro使用)」の続編として、pythonで実装したCCMaperをopenFrameworks(windows版)で実装してみる。

準備

1.以下のwindows用frameworkをダウンロードして解凍する；

https://github.com/openframeworks/openFrameworks/releases/download/0.11.2/of_v0.11.2_vs2017_release.zip

今回、解凍したframeworkを以下に置いた：
C:\of_v0.11.2_vs2017_release

2.VisualStudio

visual studio setup guide

上の説明から以下のurlからダウンロード&インストールする：

https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community&rel=16

addOn追加(ofxMidi追加)

今回のプログラムはMIDIを使用するのでaddOnとしてofxMidiを追加する。

1.以下のurlからダウンロードして解凍する：

https://github.com/danomatika/ofxMidi/archive/refs/heads/master.zip

2.解凍後、できたofxMidi-master(ディレクトリ)をofxMidiにリネームして、addonsのなかにコピーする。

プロジェクト設定

新規プロジェクトをビルドするためには,slnなどが必要であり、または既存プロジェクトのディレクトリを移動した場合は.slnなどの変更が必要となる。

このためにはprojctGeneratorを使用する：
# 以下に置いてあるので.exeをクリックする

C:\of_v0.11.2_vs2017_release\projectGenerator\projectGenerator.exe

新規プロジェクトの場合：

projectGeneratorを立ち上げる
プロジェクトファイル名を決める
保存先は of/apps/myApps にする（任意だが、ここがデフォルト）
addonは無し
[Generate]をクリックする
ここで[Open in IDE ]か[close]するかを選択する。

既にあるプロジェクトの.slnなどを生成する場合

projectGeneratorを立ち上げる。
[import]をクリックして.slnを生成したいプロジェクト(ディレクトリ)を指定する。
[Update]をクリックすると自動的に.slnなどビルドに必要なファイルが自動生成される。
ここで[Open in IDE ]か[close]するかを選択する。

以上で、.slnファイルが出来たらVisualStudioで開く。

あとは通常のVisualStudioの操作でビルドを行い実行する。

CCMapper(source code)

以下が今回のソースコードになる。

以下を入力したら、projectGeneratorで.slnなどを作成しビルドする。

置き場所は任意だが以下においた：

C:\of_v0.11.2_vs2017_release\examples\midi\CCMapper\src

src/ofApp.cpp

// CCMapper for wind controler
// this program is forked from midiInputExample/midiOutputExample
// by xshige
// on 2022/11/3

/*
 * Copyright (c) 2013 Dan Wilcox <danomatika@gmail.com>
 *
 * BSD Simplified License.
 * For information on usage and redistribution, and for a DISCLAIMER OF ALL
 * WARRANTIES, see the file, "LICENSE.txt," in this distribution.
 *
 * See https://github.com/danomatika/ofxMidi for documentation
 *
 */
#include "ofApp.h"

//--------------------------------------------------------------
void ofApp::setup() {
	//ofSetVerticalSync(true);
	ofSetVerticalSync(false);
	ofSetFrameRate(240);
	ofBackground(255, 255, 255);
	//ofSetLogLevel(OF_LOG_VERBOSE);

	// print input ports to console
	midiIn.listInPorts();

	// open port by number (you may need to change this)
	//midiIn.openPort(1);

	midiIn.openPort("WIDI Bud Pro 1");
	//midiIn.openPort("WIDI Bud Pro 2");
	
	//midiIn.openPort("IAC Pure Data In");	// by name
	//midiIn.openVirtualPort("ofxMidiIn Input"); // open a virtual port

	//<------------------------------------------------------------------
	
	// print the available output ports to the console
	midiOut.listOutPorts();

	// connect
	//midiOut.openPort(3); // by number

	midiOut.openPort("loopMIDI Port 1 3"); // by name
	//midiOut.openPort("MidiView 4"); // by name

	/////midiOut.openPort(0); // by number
	//midiOut.openPort("IAC Driver Pure Data In"); // by name
	//midiOut.openVirtualPort("ofxMidiOut"); // open a virtual port

	//>------------------------------------------------------------------


	// don't ignore sysex, timing, & active sense messages,
	// these are ignored by default
	midiIn.ignoreTypes(false, false, false);

	// add ofApp as a listener
	midiIn.addListener(this);

	// print received messages to the console
	midiIn.setVerbose(true);
}

//--------------------------------------------------------------
void ofApp::update() {
}

//--------------------------------------------------------------
void ofApp::draw() {

	for(unsigned int i = 0; i < midiMessages.size(); ++i) {

		ofxMidiMessage &message = midiMessages[i];
		int x = 10;
		int y = i*40 + 40;

		// draw the last recieved message contents to the screen,
		// this doesn't print all the data from every status type
		// but you should get the general idea
		stringstream text;
		text << ofxMidiMessage::getStatusString(message.status);
		while(text.str().length() < 16) { // pad status width
			text << " ";
		}

		ofSetColor(127);
		if(message.status < MIDI_SYSEX) {
			text << "chan: " << message.channel;
			if(message.status == MIDI_NOTE_ON ||
			   message.status == MIDI_NOTE_OFF) {
				text << "\tpitch: " << message.pitch;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.pitch, 0, 127, 0, ofGetWidth()*0.2), 10);
				text << "\tvel: " << message.velocity;
				ofDrawRectangle(x + (ofGetWidth()*0.2 * 2), y + 12,
					ofMap(message.velocity, 0, 127, 0, ofGetWidth()*0.2), 10);

				if (message.status == MIDI_NOTE_ON) midiOut.sendNoteOn(message.channel, message.pitch, message.velocity);
				if (message.status == MIDI_NOTE_OFF) midiOut.sendNoteOff(message.channel, message.pitch, message.velocity);

				//ofLog(OF_LOG_NOTICE, "channel:%d status:%3d pitch:%3d velocity:%3d", message.channel, message.status, message.pitch, message.velocity);
				
				std::this_thread::sleep_for(std::chrono::milliseconds(1));

			}
			else if(message.status == MIDI_CONTROL_CHANGE) {
				text << "\tSTATUS: " << message.status;
				text << "\tctl: " << message.control;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.control, 0, 127, 0, ofGetWidth()*0.2), 10);
				text << "\tval: " << message.value;
				ofDrawRectangle(x + ofGetWidth()*0.2 * 2, y + 12,
					ofMap(message.value, 0, 127, 0, ofGetWidth()*0.2), 10);


				if (message.control == 2 || message.control == 11) {
					// for Aria
					midiOut.sendControlChange(message.channel, 2, message.value);
					std::this_thread::sleep_for(std::chrono::milliseconds(1));

					midiOut.sendControlChange(message.channel, 7, message.value);
					std::this_thread::sleep_for(std::chrono::milliseconds(1));

					midiOut.sendControlChange(message.channel, 26, message.value);
					std::this_thread::sleep_for(std::chrono::milliseconds(1));

					//ofLog(OF_LOG_NOTICE, "channel:%d CC#:%3d value:%3d", message.channel, message.control, message.value);

				} else midiOut.sendControlChange(message.channel, message.control, message.value);

			}
			else if(message.status == MIDI_PROGRAM_CHANGE) {
				text << "\tpgm: " << message.value;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.value, 0, 127, 0, ofGetWidth()*0.2), 10);
			}
			else if(message.status == MIDI_PITCH_BEND) {
				text << "\tval: " << message.value;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.value, 0, MIDI_MAX_BEND, 0, ofGetWidth()*0.2), 10);
			}
			else if(message.status == MIDI_AFTERTOUCH) {
				text << "\tval: " << message.value;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.value, 0, 127, 0, ofGetWidth()*0.2), 10);
			}
			else if(message.status == MIDI_POLY_AFTERTOUCH) {
				text << "\tpitch: " << message.pitch;
				ofDrawRectangle(x + ofGetWidth()*0.2, y + 12,
					ofMap(message.pitch, 0, 127, 0, ofGetWidth()*0.2), 10);
				text << "\tval: " << message.value;
				ofDrawRectangle(x + ofGetWidth()*0.2 * 2, y + 12,
					ofMap(message.value, 0, 127, 0, ofGetWidth()*0.2), 10);
			}
			text << " "; // pad for delta print
		}
		else {
			text << message.bytes.size() << " bytes ";
		}

		text << "delta: " << message.deltatime;
		ofSetColor(0);
		ofDrawBitmapString(text.str(), x, y);
		text.str(""); // clear

	}
}

//--------------------------------------------------------------
void ofApp::exit() {

	// clean up
	midiIn.closePort();
	midiIn.removeListener(this);
	midiOut.closePort();
}

//--------------------------------------------------------------
void ofApp::newMidiMessage(ofxMidiMessage& msg) {

	// add the latest message to the message queue
	midiMessages.push_back(msg);

	// remove any old messages if we have too many
	while(midiMessages.size() > maxMessages) {
		midiMessages.erase(midiMessages.begin());
	}
}

//--------------------------------------------------------------
void ofApp::keyPressed(int key) {
	switch(key) {
		case '?':
			midiIn.listInPorts();
			midiOut.listOutPorts();
			break;
	}
}

//--------------------------------------------------------------
void ofApp::keyReleased(int key) {
}

//--------------------------------------------------------------
void ofApp::mouseMoved(int x, int y) {
}

//--------------------------------------------------------------
void ofApp::mouseDragged(int x, int y, int button) {
}

//--------------------------------------------------------------
void ofApp::mousePressed(int x, int y, int button) {
}

//--------------------------------------------------------------
void ofApp::mouseReleased() {
}

setup()の中の以下の部分は実行環境に依存しているので
自分の環境に合わせて変更すること：

	midiIn.openPort("WIDI Bud Pro 1");
	//midiIn.openPort("WIDI Bud Pro 2");
	
...
...
	midiOut.openPort("loopMIDI Port 1 3"); // by name
	//midiOut.openPort("MidiView 4"); // by name

src/ofApp,h

/*
 * Copyright (c) 2013 Dan Wilcox <danomatika@gmail.com>
 *
 * BSD Simplified License.
 * For information on usage and redistribution, and for a DISCLAIMER OF ALL
 * WARRANTIES, see the file, "LICENSE.txt," in this distribution.
 *
 * See https://github.com/danomatika/ofxMidi for documentation
 *
 */
#pragma once

#include "ofMain.h"
#include "ofxMidi.h"

class ofApp : public ofBaseApp, public ofxMidiListener {
	
public:
	
	void setup();
	void update();
	void draw();
	void exit();
	
	void keyPressed(int key);
	void keyReleased(int key);
	
	void mouseMoved(int x, int y );
	void mouseDragged(int x, int y, int button);
	void mousePressed(int x, int y, int button);
	void mouseReleased();
	
	void newMidiMessage(ofxMidiMessage& eventArgs);
	
	ofxMidiIn midiIn;
	std::vector<ofxMidiMessage> midiMessages;
	std::size_t maxMessages = 10; //< max number of messages to keep track of  
	
	ofxMidiOut midiOut;
	int channel;
	
	unsigned int currentPgm;
	int note, velocity;
	int pan, bend, touch, polytouch;

};

src/main.cpp

/*
 * Copyright (c) 2013 Dan Wilcox <danomatika@gmail.com>
 *
 * BSD Simplified License.
 * For information on usage and redistribution, and for a DISCLAIMER OF ALL
 * WARRANTIES, see the file, "LICENSE.txt," in this distribution.
 *
 * See https://github.com/danomatika/ofxMidi for documentation
 *
 */
#include "ofMain.h"
#include "ofApp.h"

int main(){
	ofSetupOpenGL(640, 480, OF_WINDOW);
	ofRunApp(new ofApp());
}

実行

VisualStudioから実行するとコンソール画面が現れて以下のような表示になる。

コンソール出力例

[notice ] ofxMidiIn: 2 ports available
[notice ] ofxMidiIn: 0: loopMIDI Port 1 0
[notice ] ofxMidiIn: 1: WIDI Bud Pro 1
[notice ] ofxMidiOut: 5 ports available
[notice ] ofxMidiOut: 0: CoolSoft MIDIMapper 0
[notice ] ofxMidiOut: 1: Microsoft GS Wavetable Synth 1
[notice ] ofxMidiOut: 2: VirtualMIDISynth #1 2
[notice ] ofxMidiOut: 3: loopMIDI Port 1 3
[notice ] ofxMidiOut: 4: WIDI Bud Pro 4

上のように接続している入力MIDIデバイス、出力MIDIデバイスが表示される。

MIDI接続状況：
MIDIとしての接続は「re.corder/ElefueをCCMapper経由で外部音源(Aria/Windows)と接続する(WIDI_Bud_Pro使用)」と同じ接続にする。

問題点

openFramworksの特性上、描画フレームのリフレッシュ時にdraw()のなかで、MIDI受信バッファからデータを引き出し、処理してMIDIデータを送信しているが、そのタイミングがフレームレートになっており、随時受信したものを処理しているわけでない。
そのためMIDIデータの送信タイミングもフレームレートに従っているものになり、MIDIデータとしてスムースな流れになっていない。
また、フレーム描画時にMIDI受信バッファを覗きこんで、その内容をバーグラフで表示しているだけなので、その時点でMIDI送信しても、それに対応した受信したMIDIデータを受信バッファから消去していない。そのため、タイミングによっては結果的にダブったデータを送信していることがあるようだ。
以上の回避策としてフレームレートを上げているが最終的な解決にはなっていない。

トラブルシュート

VisualStudioでビルド中に原因不明のエラーが出たことがあったがプロジェクトのディレクトリのなかの.vs、xxxx.slnなどを削除したあと projectGeneraterのimportで再度.slnなどを作成し直すとエラーが解消した。

openFrameworksでCCMapperを実装する

概要

準備

addOn追加(ofxMidi追加)

プロジェクト設定

CCMapper(source code)

実行

問題点

トラブルシュート

関連情報