hspmucom.txt

doclib\hspmucom.txt » Plain Format

------------------------------------------------------------------------------
HSPMUCOM REFERENCE MANUAL                           HSP : Hot Soup Processor  
HSP拡張拡張DLLリファレンス         copyright 2007-2020 (c) onion software  
------------------------------------------------------------------------------

・はじめに

	このDLLは、Hot Soup Processor ver3以降とともに使用することで、
	MUCOM88エミュレーションを使用した波形の再生、及び音楽データの再生を
	行なうことができるプラグインです。

	Hot Soup Processor公式HP
	https://hsp.tv/


・HSPMUCOMの機能概要

	NECのパソコンPC-8801シリーズで動作していた、FM音源のドライバー、
	MUCOM88(MUSIC LALF)というツールをWindows上で動作させることができる
	MUCOM88 Windowsの機能をDLLにまとめたものが、HSPMUCOMです。

	HSPMUCOMを使用することにより、単純な音楽の再生から、MMLの解釈まで
	スクリプト言語から幅広く制御することができます。
	HSPMUCOMで扱うことのできるフォーマットは、以下の通りです。

	・MUC形式       PC-8801上で動作するMUCOM88(MUSIC LALF)の書式で
	                記述されたMML(行番号を除く)SJIS形式のテキストファイル
	                として保存したもの。
	                FM音源(YM2608)6声、ADPCM1声とリズム音源6声、PSG3声の
			コントロールが可能です。
	                MMLの詳細はMUCOM88のマニュアルを参照下さい。

	・MUB形式       MUC形式をバイナリに変換したファイル形式。
	                演奏データ及びFM音色、ADPCMデータを内包します。

	Windowsのサウンド再生処理は、DirectX8以降のDirectSoundを
	使用しています。Windows XP以降の環境では、追加のコンポーネントを
	用意することなく動作させることができます。

	FM音源、PSGサウンドのエミュレーションは32bit/55KHzで合成し、
	出力されています。古いマシンでは、負荷が大きい場合があります。


・インストール

	HSPから使用するためには、拡張プラグインのファイル、HSPMUCOM.DLLを、
	HSPインストールフォルダ(HSED3.EXEおよび、HSP3.EXEのあるフォルダ)
	にコピーしてお使いください。
	また、HSPMUCOM.ASをスクリプトと同じディレクトリか、
	またはcommonフォルダ内にコピーされている必要があります。

	HSPから実行ファイルを作成した場合は、HSPMUCOM.DLLを同じフォルダに
	同梱してください。

	HSPMUCOMを使用する場合は、スクリプトの先頭に必ず
	「#include "hspmucom.as"」という行を追加してください。
	以上で、HSPの機能が拡張され、このリファレンスで説明をしている命令を
	使用することができるようになります。


・著作権とライセンス

	HSPMUCOMは、Open MUCOM88プロジェクトの一部として公開されています。
	Open MUCOM88プロジェクトについては、以下を参照してください。

	Open MUCOM88
	https://onitama.tv/mucom88/

	HSPMUCOMの著作権はおにたま(onion software)にあります。
	onion softwareは本プログラムによって生じた、いかなる損害についても
	保証いたしません。自己の責任の範囲で使用してください。
	また、付属のHSPスクリプトも自由に改変、公開していただいて構いません。

	HSPMUCOM.DLL及びソースコードは、無償(非営利)である限りは自由に紹介、
	複製、再配布することができます。その際には必ずドキュメントと
	ライセンス表記も含めるようにしてください。

	・Portable Z80 emulation作者 Yasuo Kuwahara氏
	  http://www.geocities.jp/kwhr0/
	・fmgen作者 cisc氏
	  http://www.retropc.net/cisc/
	・MUCOM88作者 古代祐三氏
	  https://twitter.com/yuzokoshiro
	・HSPMUCOM作者 おにたま(ONION software)
	  https://www.onionsoft.net/

	ユーザーがHSPMUCOMを使って作成したオリジナルのソフトウェア
	(実行ファイル)の権利は、それを作成したユーザーに属します。
	ただし、HSPMUCOMランタイムには、fmgen及び、Portable Z80 emulationの
	ライブラリを使用しており、配布規定に従う必要があります。

	fmgenソースコードの配布規定は、以下の通りです。

	・fmgenソースコードは作者(cisc@retropc.net) が著作権を所有しています。

	・本ソースコードはあるがままに提供されるものであり,
	  暗黙及び明示的な保証を一切含みません.

	・本ソースコードを利用したこと,利用しなかったこと,
	  利用できなかったことに関して生じたあるいは生じると予測される
	  損害について,作者は一切責任を負いません.

	・本ソースコードは,以下の制限を満たす限り自由に改変・組み込み・
	  配布・利用することができます.

	  1. 本ソフトの由来(作者, 著作権)を明記すること.
	  2. 配布する際にはフリーソフトとすること.
	  3. 改変したソースコードを配布する際は改変内容を明示すること.
	  4. ソースコードを配布する際にはこのテキストを一切改変せずに
	     そのまま添付すること.

	・公開の際に作者への連絡を頂ければ幸いです.

	・商用ソフト(シェアウェア含む) に本ソースコードの一部,または
	  全部を組み込む際には,事前に作者の合意を得る必要があります.

	各ライブラリについての詳細は、それぞれのソースコード及びドキュメントを
	参照ください。
	有償・商用での配布については、別途作者までお問い合わせください。


・命令一覧

	mucominit       MUCOM88初期化
	mucombye        MUCOM88を解放
	mucomreset      MUCOM88をリセット
	mucomplay       音楽の再生
	mucomstop       再生の停止
	mucomfade       フェードアウト再生
	mucomload       音楽データ読み込み
	mucomloadpcm    PCMデータ読み込み
	mucomloadvoice  FM音色データ読み込み
	mucomcomp       MMLのコンパイル
	mucomres        MUCOM88実行結果を取得
	mucomstat       MUCOM88のステータス取得
	mucomtag        タグデータの取得
	mucomloadtag    タグデータの読み込み

	命令の詳細は、ヘルプを参照してください。


-------------------------------------------------------------------------------
                                                HSP users manual / end of file 
-------------------------------------------------------------------------------