Modules/ayfx/ayfx player

ayfx/ayfx_player

Code: ayfx/ayfx_player.h

Category: Audio

Dependencies: None

Samples:

• s_ayfx

✍

The ayfx/ayfx_player module lets you play sound effect in ayFX format.

note:

• You can use ayFX editor to create single sound effect data, or banks containing several sound effects.
• ayFX replayer can be used in combination with those modules:
  • pt3/pt3_player,
  • wyz/wyz_player,
  • vgm/vgm_player,
  • vgm/lvgm_player.

Usage

To use this module, include "ayfx/ayfx_player.h" in your source code, and add "ayfx/ayfx_player" to the modules list (LibModules) in your project's configuration file (project_config.js).

✍

Samples

See module use cases in the sample programs:

• s_ayfx

Settings

✍

Library configuration (msxgl_config.h):

// ayFX options
// - AYFX_BUFFER_DEFAULT .......... Use PSG module's PSG registers buffer
// - AYFX_BUFFER_PSG2 ............. Use PSG module's 2nd PSG registers buffer (only if PSG_CHIP == PSG_BOTH)
// - AYFX_BUFFER_PT3 .............. Use PT3 module's PSG registers buffer
#define AYFX_BUFFER					AYFX_BUFFER_PT3

When using PT3 replayer, use AYFX_BUFFER_PT3 option. For other replayers (WYZ, VGM or lVGM), use AYFX_BUFFER_DEFAULT option.

Dependencies

Dependency on other modules: None