Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@akashic/complete-audio

akashic-games20MIT2.1.0

complement audio asset files

readme

complete-audio

Akashic Engine のゲームに必要な音声ファイルの形式を取り揃えるための変換ツールです。

以下の音声ファイルから、Akashic ゲームで使う .ogg, .m4a ファイル (のうち足りないもの) を生成します。

  • WAV ファイル (.wav)
  • Ogg Vorvis ファイル (.ogg)
  • AAC ファイル (.aac)
  • MP3 ファイル (.mp3)
  • AAC を格納した MP4 ファイル (.mp4, .m4a)

インストール方法

このソフトウェアを利用するには、 FFmpeg のインストールが必要です。 FFmpeg のインストール方法は 公式サイト を参照してください。

$ npm install -g @akashic/complete-audio

利用方法

akashicコンテンツで使用する音声ファイル名を指定してください。

$ complete-audio sound.wav

生成された音声ファイルの詳細な利用方法については、 Akashic Engine 入門 (v2版) - 音を鳴らす を参照してください。

FFmpegのライブラリについて

oggファイルを生成するときに libvorbis が存在する場合は

libvorbis > ffmpeg default

の順に使用されます。

aacファイルを生成するときに libfaaclibvo_aacenc が存在する場合は

libfaac > libvo_aacenc > ffmpeg default

の順に使用されます。

FFmpegのバイナリを直接指定して使う

complete-audio sound.wav --ffmpeg /path/to/your/ffmpeg

または、環境変数 FFMPEG_PATH にバイナリへのフルパスが設定されている場合、 complete-audio は環境変数 FFMPEG_PATH をFFmpegへのフルパスとして使用します。

ファイルの上書きについて

出力先のファイルが既に存在する場合、デフォルトでは上書きするかどうかの確認が行われます。

常に上書きしたい場合は

complete-audio sound.wav -f

のように指定してください。

常に上書きを行わないようにしたい場合は

complete-audio sound.wav -i

のように指定してください。

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。

changelog

CHANGELOG

2.1.0

  • Ogg Vorbisのlogical bitstreamのシリアルナンバーを指定する --ogg-serial-offset オプションを追加

2.0.1

  • カバー画像付きmp3を扱えない不具合を修正

2.0.0

  • デフォルトの出力先を入力ファイルと同じ場所に出力するように変更
  • 出力先を指定する -o オプションを追加

1.0.0

  • デフォルトの出力形式を .ogg.m4a に変更 (従来は .ogg.aac)
  • --experimental-output-m4a オプションを非推奨に
    • (このオプションの有無に関わらず .m4a が出力されます)
  • 以前の動作を行う --output-aac オプションを追加

0.3.1

  • 未知の拡張子に対する警告が誤って表示される不具合を修正

0.3.0

  • --output-experimental-m4a オプションを追加
  • コード全体をリライト

0.2.5

  • コマンド実行に起こるエラーの修正

0.2.4

  • 引数無しで実行したときヘルプを表示するように

0.2.3

  • -b -c -r オプションを追加

0.2.2

  • Ogg Vorbisを出力できない場合エラーを表示する

0.2.1

  • 入力オーディオ形式にMP3を追加

0.2.0

  • 出力オーディオ形式をMP4からAACに変更

0.1.1

  • 初期リリース