TOP/拡張スクリプト/Main.callback_table テーブル

Main.callback_table テーブル

概要

BMX2WAV から各種タイミングでこのテーブルにセットされている関数を呼び出します。 ユーザが関数をセットすることで BMX2WAV の動作を変更・追加することができます。 関数の第一引数は必ず Main.Converter インスタンスになります。

プロパティ

before_initialize( converter )
after_initialize( converter )
before_parse( converter )
after_parse( converter )
before_read_audio_files( converter )
after_read_audio_files( converter )
before_mixin_waves( converter )
after_mixin_waves( converter )
before_affect_wave( converter )
after_affect_wave( converter )
before_output_to_file( converter )
after_output_to_file( converter )
before_finalize( converter )
after_finalize( converter )

各種変換時の特定の処理の前後で呼び出されます。

decide_output_file_path( converter ) -> string

出力ファイルのパスを決定する際に呼び出されます。 タイミング的には構文解析直後になります。 出力ファイルのパスの文字列を戻り値として返却する必要があります。

decide_audio_file_path( converter, filename ) -> string

filename は string で、 BMS ファイルで指定したそのままのファイルパス(絶対パス)になります。 音声ファイルを読み込む前にそのファイルのパスを決定する際に呼び出されます。 経緯としては wav ファイルか ogg ファイルのどちらを読み込むのかを決定する為にあります。 実際に読み込むファイルのパスの文字列を戻り値として返却する必要があります。

audio_file_read_start( converter, word, path )

word は integer 、 path は string です。 ヘッダ WAV@@ (@@ の数値が引数 word)に登録された音声ファイル(ファイルパスが引数path)を 読み込む直前に呼び出されます。

audio_file_read_end( converter, word, path )

word は integer 、 path は string です。 ヘッダ WAV@@ (@@ の数値が引数 word)に登録された音声ファイル(ファイルパスが引数path)を 読み込んだ直後に呼び出されます。

complete_normalize( converter, ratio )

ratio は float で、ノーマライズを実施した結果音量の元の音量との比率になります。 ノーマライズを実施した直後に呼び出されます。ノーマライズを実施しなかった場合は呼び出されません。

after_process( converter )

変換が終了し結果をファイルに出力した後に「後処理」枠として呼び出されます。 タイミング的には after_output_to_file の後で、 before_finalize の前になります。

aborted( converter, user_abort )

user_abort は真偽値です。 変換処理が中断された時に呼び出されます。 user_abort が true の場合はユーザの操作による中断になります。(false の場合は続行不能なエラーの場合)

exception_occurred( converter, exception )

exceptionConvertException インスタンスです。 何らかのエラーが発生した場合に呼び出されます。 構文解析中にエラーが発生した場合は呼び出されず後述の parser_exception_occurred が呼び出されます。

parser_exception_occurred( converter, exception )

exceptionBmsDescriptionException インスタンスです。 構文解析中にエラーが発生した場合に呼び出されます。 引数の exception にはエラーが発生した行番号情報があります。

TOP/拡張スクリプト/Main.callback_table テーブル