サンプル共通事項



サンプルのフォルダ構成

CRI ADX2 LE for Cocos2d-x のサンプルはSDKの以下の場所にあります。

SDK内のサンプルフォルダ構成
  * cri

  \ * cocos2dx

    \ * samples

      \ * criatom

        o * programs

        | \ * AtomSamples

        |   o * Classes

        |   o * proj.android

        |   o * proj.ios_mac

        |   o * proj.win32

        |   o * Resources

        |   \ * CMakeLists.txt

        \ * AtomCraftWork

 

 

 

: CRI ADX2サンプル

 

: [プログラム]

: サンプルコード

 

 

 

: プログラムが読み込むデータ

 

: サンプルデータを作成するためのツールプロジェクトおよび素材

 



サンプルのビルドと実行

サンプルフォルダの準備
ADX2 LEのサンプルプログラムには Cocos2d-x のファイルは含まれていません。
Cocos2d-xで新規作成した空のプロジェクトから、cocos2dフォルダをサンプルプログラムのフォルダにコピーしてください。
<新規プロジェクト作成の例>
Cocos2d-xの環境がセットアップ済みであれば、次のコマンドで新規プロジェクトが作成できます。
cocos new -l cpp

cocos_new_command.png
例:Cocos2d-xの新規プロジェクト作成
コマンド実行後、しばらく待つとプロジェクト作成が完了し、MyCppGameというフォルダが出来ます。 そのなかのcocos2dフォルダを、ADX2 LEのサンプルプログラムフォルダにコピーしてください。
次のようなフォルダ構成になっていれば、ファイルの準備は完了です。
ビルド可能なサンプルプログラムのフォルダ構成
  * AtomSamples

  o * Classes

  o * cocos2d

  o * proj.android

  o * proj.ios_mac

  o * proj.win32

  o * Resources

  \ * CMakeLists.txt

 

: サンプルコード

: 【追加】新規作成したCocos2d-xプロジェクトからコピーしたフォルダ

: Android用のプロジェクト

: iOS/Mac用のプロジェクト

: PC用のプロジェクト

: プログラムが読み込むデータ

 

 



ビルドと実行(PC)
(1) AtomSamples/proj.win32/AtomSamples.sln をVisualStudioで開きます。
(2) AtomSamples をスタートアッププロジェクトに設定してビルド&実行してください。
cocos_sample_build_windows.png
VisualStudioでサンプルプロジェクトを開いた状態

ビルドと実行(iOS)
(1) AtomSamples/proj.ios_mac/AtomSamples.xcodeproj をXcodeで開きます。
(2) AtomSamples iOSをアクティブスキームに設定してビルド&実行してください。(デバイス、シミュレータどちらも実行可能です)
cocos_sample_build_ios.png
Xcodeでサンプルプロジェクトを開いた状態

ビルドと実行(Android)

以下の手順を行う前に、開発ホストマシンにAndroid端末が有線接続されていることを確認してください。
例えば "adb devices" コマンドを実行し、標準出力にAndroidデバイスIDが正しく表示されるか注意してください。

<Eclipseを使う場合の手順>
(1) ADT導入済みのEclipseを開きます。
(2) 同様に AtomSamples/cocos2d/cocos/platform/android/java をインポートしてビルドします。
(3) EclipseのFileメニューから AtomSamples/proj.android をインポートしてビルドします。
(4) AtomSamples/proj.android/build_native.py を pythonで実行して libcocos2dcpp.so をビルドします。
(5) EclipseのRunメニュー –> Run As から Android Applicationを選択して AtomSamples を実行します。

<Cocos2d-consoleを使う場合の手順>
(1) コマンドプロンプト等から次のコマンドを入力、実行してください。
> cocos run -p android -s <サンプルプロジェクトのパス>

以上の手順でAndroidプロジェクトがビルドされ、apkがホストマシンに接続中のAndroid端末へインストールされます。


ビルドと実行(Mac)
(1) AtomSamples/proj.ios_mac/AtomSamples.xcodeproj をXcodeで開きます。
(2) AtomSamples Macをアクティブスキームに設定してビルド&実行してください。
cocos_sample_build_mac.png
Xcodeでサンプルプロジェクトを開いた状態

サンプル用簡易ADX2ラッパ

本SDKのサンプルプログラムは、複数のシーンでADX2の初期化や再生処理を流用できるように簡易ADX2ラッパを使用しています。
簡易ADX2ラッパ
  * cri

  \ * cocos2dx

    \ * samples

      \ * criatom

        \ * programs

          \ * AtomSamples

            \ * Classes

              o * AtomUtil.cpp

              \ * AtomUtil.h

 

 

 

 

 

 

 

: ADX2簡易ラッパのソースコード

: ADX2簡易ラッパのヘッダ

 

ADX2簡易ラッパを使うことで、ADX2の複雑な初期化処理などを気にせずに簡単にサウンド再生が可能になります。
サンプルコードで criadx2le:: で始まっている関数群が簡易ラッパで実装されています。
もっと細かなサウンド制御を行いたい場合は、簡易ラッパの実装を参考にアプリケーションでADX2関数の呼び出しを実装してください。
ADX2簡易ラッパの初期化設定内容
ADX2簡易ラッパは次のような初期化設定を行っています。
全体設定(ACF)のファイル名とDSPバス設定名は文字列を決め打ちで定義してありますので、流用する場合は注意してください。
ADX2簡易ラッパの初期化設定
ACFファイル名 ADX2_samples.acf
DSPバス設定名 DspBusSetting_0
HCA-MXコーデック再生 可能
最大ボイス数 ADX/HCAコーデックで8本
HCA-MXコーデックで8本
最大ストリーム再生数 最大ボイス数と同じ
HCA-MXサンプリングレート 32000
最大ピッチ 96000
インゲームプレビュー 可能
ADX2簡易ラッパの仕様
ADX2簡易ラッパの仕様は次のようなシンプルな使い方に制限されています。
ゲーム開発で本格的に使うには機能が不足していますが、これだけの実装でもデータ側に設定した音楽のクロスフェードやダッキング演出は利用できます。
ADX2簡易ラッパの仕様
読み込めるACBファイル 1つのみ
キューの指定 ID指定のみ
プレーヤハンドル 全体で1つを共有
再生制御 開始、停止、全体停止、全体ポーズ
AISACの利用 AISACコントロールIDの0番に対してのみ可能

サンプルデータの構成

サンプルプログラムで使用する全てのサウンドデータは、ひとつのCRI Atom Craft プロジェクトで作成することができます。
CRI Atom Craft のサンプルプロジェクト
  * cri

  \ * cocos2dx

    \ * samples

      \ * criatom

        \ * AtomCraftWork

          o * Materials

          o * WorkUnits

          o * AtomCraftWork_samples.atmcglobal

          o * AtomCraftWork_samples.atmcproj

          \ * AtomCraftWork_samples.materialinfo

 

 

 

 

 

 

 

 

: CRI Atom Craft のプロジェクトファイル

 

 

このプロジェクトファイルは、3つのキューシートを含んでいます。
ADX2 LE for Cocos2d-x のサンプルが使用するのはこのうち、キューシート Basic と InteractiveSound です。
lepc_tool_sample_project.png
サンプルデータ用のCRI Atom Craftプロジェクト


サンプルデータが使用しているコーデック
サンプルプロジェクトでは、ターゲットコンフィグのデフォルト設定から圧縮コーデックの選択を変更しています。
以下の2つの設定です。
  • 「エンコーディングタイプ(メモリ)」を「HCA」に変更。
  • 「エンコード品質」を「最低品質(最高圧縮)」に変更。

lepc_tool_sample_target_config.png
ターゲットコンフィグの設定変更

また、一部のデータは「HCA-MX」コーデックで圧縮するように設定してあります。
キューシート Basic の キュー bomb_limit が HCA-MX コーデックです。
バイナリファイルの出力フォルダ
CRI Atom Craft でプロジェクトをビルドすると、バイナリファイルは次のフォルダに出力されます。
サウンドデータの出力フォルダ
  * cri

  \ * cocos2dx

    \ * samples

      \ * criatom

        \ * AtomCraftWork

          \ * Public

            \ * inGamePreview

 

 

 

 

 

: バイナリファイルの出力フォルダ

: インゲームプレビュー用のバイナリファイル出力フォルダ

 


サンプルプログラムは Resources フォルダからバイナリファイルを読み込みます。
CRI Atom Craft でビルドしたバイナリファイルに置き換える場合は、サンプルの実行前に手動でコピーしてください。
なお、本SDKのRecourcesフォルダにはインゲームプレビュー用にビルドしたバイナリファイルが格納されています。
手動コピーを省略手段として、CRI Atom Craftにはビルド後のバッチ処理を登録する仕組みもあります。
詳細はツールマニュアルを参照してください。


インゲームプレビュー対応

サンプルプログラムはインゲームプレビュー機能が利用できるようになっています。
インゲームプレビューの実行手順については「 インゲームプレビューの使用 」を参照してください。


CRI Middleware logo Copyright (c) 2012-2018 CRI Middleware Co., Ltd. CRI ADX2 LE マニュアル (for Cocos2d-x) SDKVer.2.10版