BeatDispatcher

このライブラリは現在作成中です。少々お待ちください☆ミ

登録しておいた小節、拍、Tick値のタイミングでイベントを発行してくれるライブラリです。
リズムマシンのような挙動のものが簡単に作れます。
BeatTimerのように、リズムに合わせて何かしたいときに使うと効果的です。

コード

現在コミット中

使い方

1.まずはインスタンスを作ります。

コンストラクタ
  BeatDispatcher(bpm:uint = 240, measure:uint = 1, beat:uint = 4, tpqn:uint = 2):void;
    第1引数 bpm = 1分間に含まれる拍数
    第2引数 measure = 1トラック(1ループ)を構成する小節数
    第3引数 beat = 1小節を構成する拍数
    第4引数 tpqn = 1拍を構成する音のリズムの最小単位(Tick)の数(Ticks Per Quater Noteの略)

今回は、BPMが120で、2小節から成るトラック、4拍子、1拍の中に4つリズムを刻むインスタンスを作ります。

beatdispatcher = new BeatDispatcher(120, 2, 4, 4);


2.続いて、イベントを登録していきます。

デフォルトで用意されているイベントはこんな感じ。

//BeatDispatcherEvent.TICK
//再生ヘッダが新しいTickに到達したときに発行されるイベント
beatdispatcher.addEventListener(BeatDispatcherEvent.TICK, myFunction);

//BeatDispatcherEvent.BEAT
//再生ヘッダが新しい拍に到達したときに発行されるイベント
beatdispatcher.addEventListener(BeatDispatcherEvent.BEAT, myFunction);

//BeatDispatcherEvent.MEASURE
//再生ヘッダが新しい小節に到達したときに発行されるイベント
beatdispatcher.addEventListener(BeatDispatcherEvent.MEASURE, myFunction);	

//BeatDispatcherEvent.START
//再生ヘッダがトラックの先頭に到達したときに発行されるイベント
beatdispatcher.addEventListener(BeatDispatcherEvent.START, myFunction);

//BeatDispatcherEvent.COMPLETE
//再生ヘッダがトラックの末尾に到達したときに発行されるイベント
beatdispatcher.addEventListener(BeatDispatcherEvent.COMPLETE, myFunction);


また、再生ヘッダが任意の小節・拍・Tickに到達したときにイベントを発行することができます。各インデックスは0から始まることに注意してください。
  addBeatEventListener(measure:uint, beat:uint, tick:uint, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void;
    第1引数 measure = イベントを発行させたい小節のインデックス
    第2引数 beat = イベントを発行させたい拍のインデックス
    第3引数 beat = イベントを発行させたいTickのインデックス
    第4引数 listener = イベントを受け取るハンドラ(関数)
    第5~7引数 普通のaddEventListenerと同じ

//2小節目の1拍目の3Tick目にmyFunctionを実行
beatdispatcher.addBeatEventListener(1, 0, 2, myFunction);


実行されるmyFunctionは引数としてBeatDispatcherEventを受け取ります。

function myFunction(e:BeatDispatcherEvent):void {
  //イベントが発行されたときの小節のインデックス
  e.currentMeasure;
  
  //イベントが発行されたときの拍のインデックス
  e.currentBeat;
  
  //イベントが発行されたときのTickのインデックス
  e.currentTick;
}


3.トラックを再生開始します。

beatdispatcher.start();

あとはイベントハンドラがリズムに合わせて呼び出されるのを待ちましょう。

ちなみに、beatdispatcherが提供する以下のプロパティによってトラックの情報を取得できます。

トラック情報に関するプロパティ
  bpm = 1分間に含まれる拍数
  measure = 1トラック(1ループ)を構成する小節数
  beat = 1小節を構成する拍数
  tpqn = 1拍を構成する音のリズムの最小単位(Tick)の数(Ticks Per Quater Noteの略)

再生ヘッダに関するプロパティ
  currentMeasure = 再生ヘッダが指している小節のインデックス
  currentBeat = 再生ヘッダが指している拍のインデックス
  currentTick = 再生ヘッダが指しているTickのインデックス

  isOnMeasure = 再生ヘッダが新しい小節に到達したフレームにおいてのみtrue
  isOnBeat = 再生ヘッダが新しい拍に到達したフレームにおいてのみtrue
  isOnTick = 再生ヘッダが新しいTickに到達したフレームにおいてのみtrue

  isOnStart = 再生ヘッダがトラック先頭に到達したフレームにおいてのみtrue
  isOnComplete = 再生ヘッダがトラック末尾に到達したフレームにおいてのみtrue

サンプル

現在制作中

ライセンス

Licensed under the MIT License

Copyright (c) 2008 BeInteractive! (www.be-interactive.org) and Spark project (www.libspark.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

作ってる人