コミット: master - PWMDAC_Synth (git)

ATMEGA328を搭載した Arduino Duemilanove 互換機で音をPWM D/A変換出力するシンセサイザーライブラリです。

コミットメタ情報

• リビジョン: 3c6fdeedb6f0127f4fa8ced72842e82e8be5716d (tree)
• 日時: 2020-04-18 23:56:21
• 作者: Akiyoshi Kamide <kamide@yk.r...>
• コミッター: Akiyoshi Kamide

ログメッセージ

Doc/keywords update, and macro refactored

変更サマリ

• modified: PWMDAC_Synth.h
• modified: README.txt
• modified: keywords.txt

差分

--- a/PWMDAC_Synth.h
+++ b/PWMDAC_Synth.h
@@ -1,5 +1,5 @@
 //
-// PWM DAC Synthesizer ver.20200413
+// PWM DAC Synthesizer ver.20200418
 //  by Akiyoshi Kamide (Twitter: @akiyoshi_kamide)
 //  http://kamide.b.osdn.me/pwmdac_synth_lib/
 //  https://osdn.jp/users/kamide/pf/PWMDAC_Synth/
@@ -16,17 +16,7 @@
 #define cbi16(sfr, bit) (_SFR_WORD(sfr) &= ~_BV(bit))
 #define sbi16(sfr, bit) (_SFR_WORD(sfr) |= _BV(bit))
 
-// Function-to-array generator
-#define FX2(f,x)    f(x), f(x + 1)
-#define FX4(f,x)    FX2(f,x), FX2(f,x + 2)
-#define FX8(f,x)    FX4(f,x), FX4(f,x + 4)
-#define FX16(f,x)   FX8(f,x), FX8(f,x + 8)
-#define FX32(f,x)   FX16(f,x),FX16(f,x + 16)
-#define FX64(f,x)   FX32(f,x),FX32(f,x + 32)
-#define FX128(f,x)  FX64(f,x),FX64(f,x + 64)
-#define ARRAY128(f) {FX128(f,0)}
-#define ARRAY256(f) {FX128(f,0),FX128(f,128)}
-
+// Default parameter
 #ifndef PWMDAC_OUTPUT_PIN
 #define PWMDAC_OUTPUT_PIN 3
 #endif
@@ -37,7 +27,8 @@
 #define PWMDAC_POLYPHONY 6
 #endif
 
-// Built-in wavetable generator
+//
+// Built-in wavetable functions
 //  x = Phase angle : 0x00...0x80(PI_radian)...0xFF
 //  f(x) = Wave voltage at the x : 0x00(min)...0x80(center)...0xFF(max)
 #define PWMDAC_SQUARE_WAVE(x)   (((x) < 0x80 ? 0x00 : 0xFF) / PWMDAC_POLYPHONY)
@@ -46,17 +37,26 @@
 #define PWMDAC_MAX_VOLUME_SINE_WAVE(x)  ((byte)( 0x80 * (1 + sin(PI * (x) / 0x80)) ))
 #define PWMDAC_SINE_WAVE(x)     ((byte)( 0x80 * (1 + sin(PI * (x) / 0x80)) / PWMDAC_POLYPHONY ))
 #define PWMDAC_SHEPARD_TONE(x)  ((byte)( 0x80 * (8 \
-    +sin(PI * (x) / 0x80) \
-    +sin(PI * (x) / 0x40) \
-    +sin(PI * (x) / 0x20) \
-    +sin(PI * (x) / 0x10) \
-    +sin(PI * (x) / 0x08) \
-    +sin(PI * (x) / 0x04) \
-    +sin(PI * (x) / 0x02) \
-    +sin(PI * (x) / 0x01) \
-    ) / (8 * PWMDAC_POLYPHONY) ))
+  +sin(PI * (x) / 0x80) \
+  +sin(PI * (x) / 0x40) \
+  +sin(PI * (x) / 0x20) \
+  +sin(PI * (x) / 0x10) \
+  +sin(PI * (x) / 0x08) \
+  +sin(PI * (x) / 0x04) \
+  +sin(PI * (x) / 0x02) \
+  +sin(PI * (x) / 0x01) \
+  ) / (8 * PWMDAC_POLYPHONY) ))
+
+#define FX2(f,x)    f(x), f(x + 1)
+#define FX4(f,x)    FX2(f,x), FX2(f,x + 2)
+#define FX8(f,x)    FX4(f,x), FX4(f,x + 4)
+#define FX16(f,x)   FX8(f,x), FX8(f,x + 8)
+#define FX32(f,x)   FX16(f,x), FX16(f,x + 16)
+#define FX64(f,x)   FX32(f,x), FX32(f,x + 32)
+#define FX128(f,x)  FX64(f,x), FX64(f,x + 64)
+#define FX256(f,x)  FX128(f,x), FX128(f,x + 128)
 
-#define PWMDAC_CREATE_WAVETABLE(table, function) PROGMEM const byte table[] = ARRAY256(function)
+#define PWMDAC_CREATE_WAVETABLE(table, func) PROGMEM const byte table[] = { FX256(func,0) }
 
 // [Phase-correct PWM dual-slope]
 //    TCNTn value changes to:
@@ -277,7 +277,7 @@ class PWMDACSynth {
           wavetable = this->channel->wavetable;
           envelope = this->channel->envelope;
           modulation = &(this->channel->modulation);
-          static PROGMEM const unsigned long phase_speed_table[] = ARRAY128(PHASE_SPEED_OF);
+          static PROGMEM const unsigned long phase_speed_table[] = { FX128(PHASE_SPEED_OF,0) };
           dphase32_original = pgm_read_dword(phase_speed_table + (this->note = note));
           dphase32_bended = this->channel->bendedPitchOf(dphase32_original);
           dphase32_real = dphase32_bended + dphase32_moffset;

--- a/README.txt
+++ b/README.txt
@@ -1,17 +1,17 @@
 
 [PWMDAC_Synth - PWM DAC synthesizer library for Arduino]
 
-ver.20200405
+ver.20200418
 
 https://osdn.jp/users/kamide/pf/PWMDAC_Synth/wiki/FrontPage
 
-Arduinoで動作する簡易シンセサイザライブラリです。
 
 これは、CAmiDion
 
   http://www.yk.rim.or.jp/~kamide/music/chordhelper/hardware/
 
-の２号機以降で実装した音源をライブラリ化したものです。
+の２号機以降で実装した音源をライブラリとして独立させた、
+Arduino互換機用のPWMシンセサイザライブラリです。
 
 
 ●Arduinoで楽器を作ろうとして、こんな問題にぶち当たったことはありませんか？
@@ -52,6 +52,8 @@ Arduino
 	基本的な使い方を下記に示します。なお、ノートオン、ノートオフなど、音の出し方については
 	Arduino IDE のメニューからたどれる「スケッチの例」を参考にしてください。
 
+	【サンプルコード】
+	//
 	// 必要に応じ、PWMDAC_Synth.h をインクルードする前に #define で下記を指定できます。
 	//
 	#define PWMDAC_OUTPUT_PIN  3 // PWM出力ピン番号（省略可：下記「●出力ピン(PWM)」参照）
@@ -101,9 +103,14 @@ Arduino
 	デフォルトは6重和音です。
 	PWMDAC_POLYPHONY に数値を設定してコンパイルし直すことで増減可能です。
 
-	同時発音数を増やすと、その分、割り込み処理 ISR() の実行に時間がかかります。
-	割り込み以外の処理を行うための時間的余裕がなくなった時点で動作しなくなります。
-	そうなる寸前が、事実上の同時発音数の上限です。
+	※ 同時発音数を増やしていくと、その分
+	ISR() (Interrupt Service Routine: 割り込みサービスルーチン)における
+	ループ回数が増え、多忙になってきます。あまりに多忙過ぎて loop() を実行する
+	暇がなくなると、動作不能に陥ります。そうなる寸前が、同時発音数の事実上の上限です。
+
+	※ ISR() などで動作速度が要求されるため、PWMDAC_Synth.h には
+	#pragma GCC optimize ("-O3")
+	が指定されています。コンパイルの最適化基準を、このライブラリだけ速度優先にするためです。
 
 	特定のMIDIチャンネルに対しボイスアサインの優先度を上げることもできます。
 	後述の「●チャンネル優先度指定」を参照。
@@ -126,27 +133,23 @@ Arduino
 
 ●MIDIチャンネル操作
 
-	PWM_SYNTH のメソッドで、
+	PWMDACSynth::getChannel() で
 
 		MIDIチャンネル番号(1〜16) ⇔ MIDIチャンネルへのポインタ
 
-	を相互変換できます。
-
-	MidiChannel *getChannel(char channel)
-	char getChannel(MidiChannel *cp)
-
-	MIDIチャンネルへのポインタを介してチャンネル単位に持たせる
-	パラメータを操作できます。
+	を相互変換できます。MIDIチャンネルへのポインタを介して、
+	チャンネル単位に持たせるパラメータを操作できます。
+	（操作方法については PWMDAC_Synth.h を参照）
 
 	なお、ノートオン、ノートオフ、ピッチベンドなど、今出ている音
-	（アサインされているボイス）に即座に反映させるには、
-	MidiChannel ではなく PWMDACSynth のメンバ関数を呼び出す必要があります。
+	（アサインされているボイス）に即座に反映させるには、PWMDACSynth のほうで
+	用意しているメンバ関数を呼び出し、チャンネルとボイスを同時に更新する必要があります。
 
 
 ●MIDI関数
 
-	PWM_SYNTH 静的オブジェクトには、MIDIライブラリの MIDI.setHandleXxxx() に
-	直接指定できるよう、引数の順序や型を合わせた関数をいくつか用意しています。
+	PWMDACSynth で定義されたいくつかの static オブジェクトは、
+	MIDIライブラリの MIDI.setHandleXxxx() に直接指定できる形式になっています。
 
 	ただし、接続相手のMIDIデバイスによっては、NOTE OFF の代わりに
 	velocity=0 の NOTE ON を送ってくることがあるので、その場合だけ
@@ -158,39 +161,29 @@ Arduino
 
 ●音色変更
 
-	波形とエンベロープパラメータ（ADSR）を MidiChannel クラスの
-	wavetable と env_param に指定することで、音色を変更できます。
-
-	ADSRの設定は EnvelopeParam クラスを介して行います。
-	コンストラクタで次の値を指定して初期化できます。
-
-	・attack_time - アタック時間（大きいほどノートオン直後の立ち上がりがゆっくり）
-	・decay_time - ディケイ時間（大きいほどノートオン後の減衰がゆっくり）
-	・sustain_level - サスティンレベル（減衰が止まったあと維持する音量）
-	・release_time - リリース時間（大きいほどノートオフ後の減衰がゆっくり）
-
-	値の範囲は sustain_level が 0〜255、それ以外は 0〜15 です。
-	実時間は loop() 内で update() を呼び出す頻度によって変わります。
+	波形テーブルとADSRエンベロープパラメータを、それぞれ MidiChannel クラスの
+	wavetable と envelope[] に指定することで、音色を変更できます。
 
-	各ADSRパラメータ値へのポインタは getParam() メソッドで取得できます。
+	また、Instrument 構造体定数をプログラムメモリ領域に作り、それを
+	programChange() に指定するだけで、波形とエンベロープを一度に設定できます。
+	MIDIのプログラムチェンジを実装するときに便利です。
 
+	【波形】 wavetable
 	波形テーブルは、要素数256のbyte型PROGMEM配列として生成します。
 	それを wavetable に指定することで、波形を切り替えることができます。
-
-	波形テーブル配列の生成は、PWMDAC_Synth.h 上で定義された
-	マクロを使い、必要な波形テーブルだけを生成してください。
-
-	このマクロは、同時発音数が増えても信号レベルが255を超えて音割れせず、
-	かつ最大音量の出るような計算式になっています。
-	これに習って自分で波形を定義すれば、それを指定して
-	独自の音色を生み出すことも可能です。
-
-	プログラムメモリ領域に Instrument 構造体定数を作って、
-	それを指定することで音色を変更することもできます。
-	MIDIのプログラムチェンジの実装にはこの方法がおすすめです。
-	現在のバージョンでは、プログラムチェンジ対応に伴い、
-	エンベロープの初期化に Instrument 構造体定数を使うインターフェースに
-	してRAMへの展開を最小限に抑えられるようにしました。
+	波形関数のマクロを PWMDAC_CREATE_WAVETABLE() マクロに指定するか、
+	またはそれにならって自分で配列を定義することで、任意の波形を生成することが可能です。
+
+	※ 波高は（255÷同時発音数：デフォルト6重和音のとき42）を超えないようにしてください。
+	同時発音数いっぱいに鳴らしたときに最大音量255を超えてオーバーフローし、ノイズが
+	発生する恐れがあります。
+
+	【ADSRエンベロープ】 envelope[]
+	  ADSR_ATTACK_VALUE - アタック時間（0〜15、大きいほどノートオン直後の立ち上がりがゆっくり）
+	  ADSR_DECAY_VALUE - ディケイ時間（0〜15、大きいほどノートオン後の減衰がゆっくり）
+	  ADSR_SUSTAIN_VALUE - サスティンレベル（0〜255、減衰が止まったあと維持する音量）
+	  ADSR_RELEASE_VALUE - リリース時間（0〜15、大きいほどノートオフ後の減衰がゆっくり）
+	実時間は loop() 内で update() を呼び出す頻度によって変わります。
 
 
 ●チャンネル優先度指定
@@ -217,10 +210,6 @@ Arduino
 	多重和音感が失われることがありますので、適宜調整してください。
 
 
-●その他の関数
-
-	その他、利用できる関数についてはソースコードのヘッダ PWMDAC_Synth.h を参照。
-
 
 作者：＠きよし - Akiyoshi Kamide
 	http://www.yk.rim.or.jp/~kamide/

--- a/keywords.txt
+++ b/keywords.txt
@@ -6,10 +6,8 @@
 # Datatypes (KEYWORD1)
 #######################################
 
-EnvelopeParam	KEYWORD1
 Instrument	KEYWORD1
 MidiChannel	KEYWORD1
-VoiceStatus	KEYWORD1
 PWMDACSynth	KEYWORD1
 
 #######################################
@@ -24,7 +22,6 @@ pitchBend	KEYWORD2
 controlChange	KEYWORD2
 systemReset	KEYWORD2
 getChannel	KEYWORD2
-setEnvelope	KEYWORD2
 setPriority	KEYWORD2
 
 #######################################
@@ -35,3 +32,4 @@ PWMDAC_NOTE_A_FREQUENCY	LITERAL1
 PWMDAC_POLYPHONY	LITERAL1
 PWMDAC_OUTPUT_PIN	LITERAL1
 PWMDAC_CHANNEL_PRIORITY_SUPPORT	LITERAL1
+