STRAIGHT Library API Reference

基本関数

`straightInitConfig`

目的

STRAIGHT全体の設定を行う構造体を初期化します。

書式

#include <straight/straight.h>

stBool straightInitConfig(StraightConfig *config);

引数

config: StraightConfig型変数のアドレスを指定します。

戻り値

初期化に成功するとST_TRUEが返り、失敗するとST_FALSEが返ります。

説明

実体はマクロとなっており、構造体のメンバにバージョンIDなどを設定します。これにより、ライブラリのバイナリレベルでの互換性が保たれています。

関連項目

初期化関数用構造体

`straightInitialize`

目的

Straight型のメモリを確保するとともに、STRAIGHTエンジンを初期化します。

書式

#include <straight/straight.h>

Straight straightInitialize(StraightConfig *config);

引数

config: straightInitConfigを呼び出した後に所望の設定を行ったStraightConfig型変数のアドレスを指定します。

戻り値

初期化に成功するとメモリ確保されたStraight型が返り、失敗するとNULLが返ります。 STRAIGHTエンジンを解放する際には、straightDestroyを呼び、Straight型のメモリを解放して下さい。

説明

STRAIGHT Libraryが提供するほぼ全ての関数は、ここで得られるStraight型を引数として持ちます。 Straight型のメモリ確保、すなわちSTRAIGHTエンジンの初期化に失敗した場合は、ほぼ全ての関数が機能しません。

関連項目

straightInitConfig

`straightDestroy`

目的

Straight型のメモリを解放するとともに、STRAIGHTエンジンを解放します。

書式

#include <straight/straight.h>

stBool straightDestroy(Straight straight);

引数

straight: straightInitialize で得られたStraigh型を指定します。

戻り値

解放に成功するとST_TRUEが返り、失敗するとST_FALSEが返ります。

説明

STRAIGHTエンジンを再初期化する際には、一旦この関数を呼び出してエンジンを解放する必要があります。これを行わない場合、メモリリークが発生します。

関連項目

straightInitialize

`straightSetCallbackFunc`

目的

STRAIGHTエンジンにコールバック関数を設定します。

書式

#include <straight/straight.h>

stBool straightSetCallbackFunc(Straight straight, stCallbackType callbackMask, stCallbackFunc func, void *userData);

引数

straight: straightInitialize で得られたStraight型を指定します。
callbackMask: stCallbackTypeの中からコールバックタイプを選んで指定します。論理和記号 | を用いて複数のコールバックタイプを指定できます。また、STRAIGHT_PERCENTAGE_CALLBACK（全てのPERCENTAGE_CALLBACKの組み合わせ）などのいくつかのコールバックタイプをまとめたものも用意されています。
func: コールバック関数を指定します。この関数は、stCallbackFuncの定義に従う必要があります。

戻り値

解放に成功するとST_TRUEが返り、失敗するとST_FALSEが返ります。

説明

現在の実装では、1つのコールバック関数のみが指定できます。別のコールバック関数を指定した場合は、1つ目のコールバック関数は無効となります。

関連項目

straightInitialize

`straightGetSamplingFrequency`

目的

現在、STRAIGHTエンジンに設定されているサンプリング周波数を取得します。

書式

#include <straight/straight.h>

double straightGetSamplingFrequency(Straight straight);

引数

straight: straightInitialize で得られたStraight型を指定します。

戻り値

解放に成功するとサンプリング周波数が返り、失敗すると0.0が返ります。

説明

STRAIGHTエンジン内部で使用されているサンプリング周波数は、音声ファイルの読み込みなどによって更新されます。

関連項目

straightInitialize

`straightReadAudioFile`

目的

音声ファイルを読み込み、STRAIGHTエンジンにそのデータをセットします。

書式

#include <straight/straight.h>

stBool straightReadAudioFile(Straight straight, char *filename, char *pluginName);

引数

straight: straightInitialize で得られたStraight型を指定します。
filename: 音声ファイルのファイル名を指定します。
pluginName: ファイルの読み込みにおいて、ファイル形式を判別できなかった場合に使用するプラグイン名を指定します。実装によって対応しているプラグインが異なることがあります。 WAVファイルなど、ファイルから自動判別できるものを読み込む場合は、NULLを指定しても構いません。

戻り値

解放に成功するとST_TRUEが返り、失敗するとST_FALSEが返ります。

説明

STRAIGHTエンジンは、Straight型の内部に読み込んだ音声ファイル保持用のバッファを1つだけ持ちます。再度この関数を呼び出した場合には、以前読み込んだファイルの内容はクリアされます。

`straightWriteSynthAudioFile`

目的

合成された音声データを音声ファイルとして書き込みます。

書式

#include <straight/straight.h>

stBool straightWriteSynthAudioFile(Straight straight, StraightSynth synth,
                                   char *filename, char *pluginName, int bitsPerSample);

引数

straight: straightInitialize で得られたStraight型を指定します。
filename: 音声ファイルのファイル名を指定します。
pluginName: ファイルの書き込みの際に用いるプラグイン名を指定します。実装によって対応しているプラグインが異なることがあります。 WAVファイルの場合は、"output_wav"を指定します。

戻り値

解放に成功するとST_TRUEが返り、失敗するとST_FALSEが返ります。

説明

STRAIGHTエンジンは、合成音データ保持用のバッファを1つだけ持ちます。このバッファにデータが何も存在しない場合は、この関数の呼び出しに失敗します。

Last modified: "2008-10-30 11:02:23 hideki"