2.4　関数仕様

[サウンドシステム起動]

一 覧 表

Title 関数仕様

Function サウンドシステム起動

Function name SND_Init

No 1

　書　式

void SND_Init(SndIniDt *sys_ini)

　入　力

sys_ini：システム起動用データ

　出　力

なし

　関数値

なし

　機　能

指定されたシステム起動用データを元にプログラム、サウンドエリアマップの転送、およびレジスタの初期化を行い、サウンドシステムを起動します。サウンドシステムの起動の詳細は、サウンド開発マニュアルのサウンドドライバシステムインタフェースをご覧ください。

　備　考

転送にはSCU DMA転送を使用します。

　注　意

本関数は、割り込み処理内で使用しないでください。

［割り込み］

一 覧 表

Title 関数仕様

Function 割り込み許可設定

Function name SND_SET_ENA_INT

No 2

　書　式

void SND_SET_ENA_INT(Uint8 data)

　入　力

data：割り込み許可ビット(1：許可、0：禁止) 定数

ビット位置定数	説明
SND_INT_PCM_ADR	PCM address割り込み

　出　力

なし

　関数値

なし

　機　能

割り込み許可を設定します。これはサウンドシステムから割り込み信号を発生させるかどうかの設定であり、SCUの割り込みマスクの設定ではありません。

一 覧 表

Title 関数仕様

Function 割り込み許可取得

Function name SND_GET_ENA_INT

No 3

　書　式

Unit8 SND_SET ENA_INT(void)

　入　力

なし

　出　力

割り込み許可ビット(1：許可、0：禁止)

定数

ビット位置定数	説明
SND_INT_PCM_ADR	PCM address割り込み

　関数値

なし

　機　能

割り込み許可を取得します

一 覧 表

Title 関数仕様

Function 割り込み要因取得

Function name SND_SET_FCT_INT

No 4

　書　式

Unit8 SND_GET_FCT_INT(void)

　入　力

なし

　出　力

割り込み許可ビット

定数

定数	説明
SND_FCT_PCM_ADR	PCM adress更新

　関数値

なし

　機　能

割り込み要因を設定します。

一 覧 表

Title 関数仕様

Function 割り込みセット

Function name SND_RESET_INT

No 5

　書　式

void SND_RESET_INT(void)

　入　力

なし

　出　力

なし

　関数値

なし

　機　能

割り込みをリセットします。サウンドの割り込みが起きた後に実行してください。この関数を実行しないと割り込みが起きたままになります。

[演奏準備]

一 覧 表

Title 関数仕様

Function サウンドデータ転送

Function name SND_MoveData

No 6

　書　式

void SND_MoveData(Uint16 *source,Unit32 size,Uint16 data_kind,Uint16 data_no)

　入　力

source ：サウンドデータ転送元アドレス size ：転送サイズ(バイト単位) data_kind：データ種別

データ種別定数名

定数名	説明
SND_KD_TONE	音色バンクデータ
SND_KD_SEQ	シーケンスデータ
SND_KD_DSP_PRG	DSPプログラム
SND_KD_DSP_RAM	DSPワークRAM

data_no：データ番号

　出　力

なし

　関数値

なし

　機　能

指定されたデータ種別、データ番号に対応するマップ情報に従い、サウンドデータをサウンドメモリへ転送します。

　備　考

転送にはSCU DMA転送を使用します。
デフォルトの割込み優先度の場合、SND_MoveData()を割込み処理内で使用しないようにしてください。
割込み処理内で使用するためには、割込み優先度をDMA終了割込みが割込み処理内で取得できるように変更してください。
割込み優先度を変更するにはシステムライブラリを使用してください。

[サウンドコントロール]

共通

一 覧 表

Title 関数仕様

Function サウンドエリアマップ変更

Function name SND_ChgMap

No 7

　書　式

SndRet SND_ChgMap(SndAreaMap area_no)

　入　力

area_no：サウンドエリアマップ番号

　出　力

なし

　関数値

コマンド実行状態

　機　能

カレントのサウンドエリアマップをサウンドエリアマップ番号で示されるサウンドエリアマップに変更します。

　注　意

サウンドエリアマップ変更時に音がなっていたり，DSPが動作中だった場合に、 マップを切り替えたり、使用中のサウンドデータを入れ替 えたりするとサウンドドライバシステムが暴走する場合がありますので以下のことを必ず守ってください。

サウンドエリアマップ変更関数SND_ChgMap()は，CD-DAの音がなっていないと きに，以下の２つのコマンドを実行した後に実行してください。

• DSP中止関数　SND_StopDsp
• 全サウンド発音中止関数　SND_OffAllSound

一 覧 表

Title 関数仕様

Function DSP中止

Function name SND_StopDsp

No 8

　書　式

SndRet SND_StopDsp(void)

　入　力

なし

　出　力

なし

　関数値

コマンド実行状態

　機　能

DSPマイクロプログラムの実行を中止します。

　備　考

一 覧 表

Title 関数仕様

Function 全サウンド発音中止

Function name SND_OffAllSound

No 9

　書　式

SndRet SND_OffAllSound(void)

　入　力

なし

　出　力

なし

　関数値

コマンド実行状態

　機　能

全サウンド発音を中止します。

　備　考

一 覧 表

Title 関数仕様

Function 全体音量設定

Function name SND_SetTlVl

No 10

　書　式

SndRet SND_SetTlVl(SndTlVl vol)

　入　力

vol：全体音量

　出　力

なし

　関数値

コマンド実行状態

　機　能

全体音量を変更します。

　備　考

シーケンスとPCMにのみ影響します。

一 覧 表

Title 関数仕様

Function エフェクト変更

Function name SND_ChgEfct

No 11

　書　式

SndRet SND_ChgEfct(SndEfctBnkNum efct_no)

　入　力

efct_no：Effect bank number

　出　力

なし

　関数値

コマンド実行状態

　機　能

Effect bank numberで示されるDSPプログラムを実行します。

一 覧 表

Title 関数仕様

Function ミキサ変更

Function name SND_ChgMix

No 12

　書　式

SndRet SND_ChgMix(SndToneBnkNum tone_no, SndMixBnkNum mix_no)

　入　力

tone_no　　：音色 bank number mix_no　　 ：Mixer number

　出　力

なし

　関数値

コマンド実行状態

　機　能

ミキサを変更します。

一 覧 表

Title 関数仕様

Function ミキサパラメータ変更

Function name SND_ChgMixPrm

No 13

　書　式

SndRet SND_ChgMixPrm(SndEfctOut efct_out SndLev level, SndPan pan)

　入　力

efct_out:Effect out select level :Effect return Level pan :Effect Pan

　出　力

なし

　関数値

コマンド実行状態

　機　能

ミキサのパラメータを変更します。

一 覧 表

Title 関数仕様

Function ハードウェアチェック

Function name SND_ChkHard

No 14

　書　式

SndRet SndChkHard(SndHardStat *stat, SndHardChk prm)

　入　力

prm ：ハードチェックパラメータ

　出　力

stat：ハードチェックステータス

　関数値

コマンド実行状態

　機　能

ハードウェアパラメータに従いハードウェアチェックを行います。

シーケンス

一 覧 表

Title 関数仕様

Function シーケンス開始

Function name SND_StartSeq

No 15

　書　式

SndRet SND_StartSeq(SndSeqNum seq_no, SndSeqBnkNum seq_bk_no, SndSeqSongNum song_no, SndSeqPri pri_lev)

　入　力

seq_no ：発音管理番号 seq_bk_no：Sequence bank number song_no ：Sequence song number pri_lev ：Priorty level

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたシーケンスを開始します。

一 覧 表

Title 関数仕様

Function シーケンス中止

Function name SND_StopSeq

No 16

　書　式

SndRet SND_StopSeq(SndSeqNum seq_no)

　入　力

seq_no：発音管理番号

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたシーケンスを中止します。

一 覧 表

Title 関数仕様

Function シーケンス一時中断

Function name SND_PauseSeq

No 17

　書　式

SndRet SND_PauseSeq(SndSeqNum seq_no)

　入　力

seq_no：発音管理番号

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたシーケンスを一時中断します。

一 覧 表

Title 関数仕様

Function シーケンス一時中断解除

Function name SND_ContSeq

No 18

　書　式

SndRet SND_ContSeq(SndSeqNum seq_no)

　入　力

seq_no：発音管理番号

　出　力

なし

　関数値

なし

　機　能

指定されたシーケンスの一時中断を解除します。

一 覧 表

Title 関数仕様

Function シーケンス音量設定

Function name SND_SetSeqVl

No 19

　書　式

SndRet SND_SetSeqVl(SndSeqNum seq_no, SndSeqVl seq_vl, SndFade fade)

　入　力

seq_no：発音管理番号 seq_vl：Sequence Volume fade ：fade Rate

　出　力

なし

　関数値

コマンド実行状態

　機　能

シーケンスの音量を設定します。

一 覧 表

Title 関数仕様

Function シーケンスPAN設定

Function name SND_SetSeqPan

No 20

　書　式

SndRet SND_SetSeqPan(SndSeqNum seq_no, Uint8 ctrl_sw,Uint8 md_pan)

　入　力

seq_no	：発音管理番号
ctrl_sw	：コントロールスイッチ
	SND_SEQ_PAN_ON = Control ON
	SND_SEQ_PAN_OFF = Control OFF
md_pan	：MIDI PAN data

設定値の意味

left ←−− Center −−→ Right
0x00 ←−−  0x40  −−→ 0x7f 

　出　力

なし

　関数値

コマンド実行状態

　機　能

シーケンスのPANを設定します。

　参　照

『サウンドドライバプログラマーズガイド 』
サウンドコントロールコマンド詳細
●0EH SEQUENCE PAN

一 覧 表

Title 関数仕様

Function テンポ変更

Function name SND_ChgTempo

No 21

　書　式

SndRet SND_ChgTempo(SndSeqNum seq_no, SndTempo tempo)

　入　力

seq_no：発音管理番号 tempo ：Tempo

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたシーケンスを指定されたTempoにします。

一 覧 表

Title 関数仕様

Function MIDIダイレクトコントロール

Function name SND_CtrlDirMidi

No 22

　書　式

SndRet SND_CtrlDirMidi(SndSeqNum seq_no, SndSeqPri seq_pri, Uint8 md_com, Uint8 ch, Uint8 dt1, Uint8 dt2)

　入　力

seq_no ：発音管理番号 seq_pri：Priorty level md_com ：MIDI command(0H〜7H) ch ：MIDI channel(0H〜1FH) dt1 ：MIDI data1(00H〜7FH) dt2 ：MIDI data2(00H〜7FH)

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたパラメータに従ってMIDIをダイレクトにコントロールします。

PCM

一 覧 表

Title 関数仕様

Function PCM開始

Function name SND_StartPcm

No 23

　書　式

SndRet SND_StartPcm(SndPcmStartPrm *sprm, SndPcmChgPrm *cprm)

　入　力

sprm：PCM開始パラメータポインタ cprm：PCM変更パラメータポインタ

　出　力

なし

　関数値

コマンド実行状態

　機　能

指定されたパラメータに従ってPCMデータを再生します。

一 覧 表

Title 関数仕様

Function PCM中止

Function name SND_StopPcm

No 24

　書　式

SndRet SND_StopPcm(SndPcmNum pcm_num)

　入　力

pcm_num：再生停止PCMストリーム再生番号

　出　力

なし

　関数値

コマンド実行状態

　機　能

PCMデータの再生を中止します。

一 覧 表

Title 関数仕様

Function PCM変更

Function name SND_ChgPcm

No 25

　書　式

SndRet SND_ChgPcm(SndPcmChgPrm *cpcm)

　入　力

cpcm：PCM変更パラメータポインタ

　出　力

なし

　関数値

コマンド実行状態

　機　能

PCMデータの再生状態を変更します。

CD

一 覧 表

Title 関数仕様

Function 音量解析開始

Function name SND_StartVlAnl

No 26

　書　式

SndRet SND_StartVlAnl(void)

　入　力

なし

　出　力

なし

　関数値

コマンド実行状態

　機　能

音量解析を開始します。周波数帯域別音量と全体音量の解析を開始します。音量解析中止関数を実行するまで、音量解析は続いています。周波数帯域別音量解析する場合は、この関数の実行前に専用のＤＳＰプログラムをエフェクト変更で実行してください。全体音量の解析にはＤＳＰプログラムは必要ありません。

　備　考

周波数帯域別音量解析のためのＤＳＰプログラムを実行している間は、他のＤＳＰプログラムは実行できません。

一 覧 表

Title 関数仕様

Function 音量解析中止

Function name SND_StopVlAnl

No 27

　書　式

SndRet SND_StopVlAnl(void)

　入　力

なし

　出　力

なし

　関数値

コマンド実行状態

　機　能

音量解析を中止します。

一 覧 表

Title 関数仕様

Function CD-DA Level設定

Function name SND_SetCdDaLev

No 28

　書　式

SndRet SND_SetCdDaLev(SndLev left, SndLev right)

　入　力

left ：左出力の音量 right：右出力の音量

　出　力

なし

　関数値

コマンド実行状態

　機　能

現在のステレオ音量を変更します。

一 覧 表

Title 関数仕様

Function CD-DA Pan設定

Function name SND_SetCdDaPan

No 29

　書　式

SndRet SND_SetCdDaPan(SndPan left, SndPan right)

　入　力

left ：左出力のPAN right：右出力のPAN

　出　力

なし

　関数値

コマンド実行状態

　機　能

現在のステレオPANを変更します。

[ステータス取得]

シーケンス

一 覧 表

Title 関数仕様

Function シーケンスステータス取得

Function name SND_GetSeqStat

No 30

　書　式

void SND_GetSeqStat(SndSeqStat *status, SndSeqNum seq_no)

　入　力

seq_no：発音管理番号

　出　力

status：シーケンスステータスポインタ

　関数値

なし

　機　能

指定された発音管理番号のシーケンスステータスを取得します。

一 覧 表

Title 関数仕様

Function 発音管理番号再生位置取得

Function name SND_GetSeqPlayPos

No 31

　書　式

void SND_GetSeqPlayPos(SndSeqPlayPos *pos, SndSeqNum seq_no)

　入　力

seq_no：発音管理番号

　出　力

pos ：発音管理番号再生位置

　関数値

なし

　機　能

指定された発音管理番号の再生位置を取得します。

PCM

一 覧 表

Title 関数仕様

Function PCM実行アドレス取得

Function name SND_GetPcmPlayAdr

No 32

　書　式

void SND_GetPcmPlayAdr(SndPcmPlayAdr *adr, SndPcmNum num)

　入　力

num：PCM再生番号

　出　力

adr：PCM実行アドレス

　関数値

なし

　機　能

現在再生中のPCMデータのアドレスを取得します。

一 覧 表

Title 関数仕様

Function PCMアドレス更新割り込みステータス取得

Function name SND_GET_INT_STAT

No 33

　書　式

SndPcmIntStat SND_GET_INT_STAT(void)

　入　力

なし

　出　力

なし

　関数値

PCMアドレス更新割り込みステータス

　機　能

PCMアドレス更新割り込みステータスを取得します。割り込み要因をPCM addres更新割り込みしている場合有効です。どのPCM再生番号のアドレスが更新されたかがわかります。

CD

一 覧 表

Title 関数仕様

Function 解析全体ステレオ音量取得

Function name SND_GetAnlTlVl

No 34

　書　式

void SND_GetAnlTlVl(SndCdVlAnl *left, SndCdVlAnl *right)

　入　力

なし

　出　力

left ：左出力の全体解析音量 right：右出力の全体解析音量

　関数値

なし

　機　能

全体ステレオ解析音量を取得します。この関数の実行前に音量解析開始関数を実行してください。

　備　考

音量は16msec間隔で更新されます。

一 覧 表

Title 関数仕様

Function 解析周波数帯域別ステレオ音量取得

Function name SND_GetAnlHzVl

No 35

　書　式

void SND_GetAnlHzVl(SndCdHzSrVl *hz_vl)

　入　力

なし

　出　力

hz_vl：周波数帯域別ステレオ解析音量

　関数値

なし

　機　能

周波数帯域別ステレオ解析音量を取得します。この関数の実行前に音量解析開始関数を実行してください。

　備　考

音量は16msec(1/60sec)間隔で更新されます。

一 覧 表

Title 関数仕様

Function サウンドコントロール設定

Function name SND_SET_SND_CTRL

No 36

　書　式

void SND_SET_SND_CTRL(Uint8 snd_ctrl)

　入　力

サウンドコントロール値

　SND_CTRL_OUTPUT_STEREO ：ステレオ

　SND_CTRL_OUTPUT_MONO ：モノラル

　出　力

なし

　関数値

なし

　機　能

サウンドコントロール値を設定します。
現在はステレオ／モノラルのモードを選択し設定できます。

　備　考

一 覧 表

Title 関数仕様

Function サウンドコントロール取得

Function name SND_GET_SND_CTRL

No 37

　書　式

Uint8 SND_GET_SND_CTRL(void)

　入　力

なし

　出　力

サウンドコントロール値

　SND_CTRL_OUTPUT_STEREO ：ステレオ

　SND_CTRL_OUTPUT_MONO ：モノラル

　関数値

なし

　機　能

サウンドコントロール値を取得します。

　備　考

３Ｄサウンド

一 覧 表

Title 関数仕様

Function QSOUNDパラメ−タセット

Function name SND_SetQSound

No 1

　書　式

SndRet SND_SetQSound(Uint8 QCh, Uint8 QSt)

　入　力

QCh ：コントロ−ルするQSOUNDチャンネル

QSt ：QSOUND PAN data ( 0x00〜0x1e )

設定値の意味

left ←−− Center −−→ Right
0x00 ←−−  0x0f  −−→ 0x1e 

　出　力

なし

　関数値

コマンド実行状態

　機　能

QSOUNDの定位を設定します。

一 覧 表

Title 関数仕様

Function YAMAHA 3D パラメ−タセット

Function name SND_Set3D_Stat

No 2

　書　式

SndRet SND_Set3D_Stat(Uint8 Y3DDst, Uint8 Y3DAzm,Uint8 Y3DElv)

　入　力

Y3DDst ：距離 ( 0x00〜0x7f )

Y3DAzm ：方位 ( 0x00〜0x7f )

Y3DElv ：高さ ( 0x00〜0x7f )

　出　力

なし

　関数値

コマンド実行状態

　機　能

YAMAHA 3D の定位を設定します。

一 覧 表

Title 関数仕様

Function YAMAHA 3D 定位初期化

Function name SND_Set3D_Init

No 3

　書　式

SndRet SND_Set3D_Init()

　入　力

なし

　出　力

なし

　関数値

コマンド実行状態

　機　能

YAMAHA 3D の定位を正面中央に設定します。