Category:MSX-AUDIO BASIC
This page was last modified 13:09, 31 January 2022 by Mars2000you. Based on work by Gdx and Rderooy.

Contents

Description

MSX-AUDIO BASIC is a BASIC extension that is only included on the complete MSX-AUDIO cartridge, the Panasonic FS-CA1. However, it is possible to upgrade the other MSX-AUDIO cartridges: Philips NMS 1205 (Music Module) and Toshiba HX-MU900 (FM-Synthesizer Unit).

Notes :

  • The extra instructions linked to any built-in software (CALL MUSICBOX, CALL SYN) are not part of the MSX-AUDIO BASIC instructions.

Stricto sensu, it should also be the case of CALL SYNTHE, as this instruction is not compatible with CALL AUDIO that is required to initialize the MSX-AUDIO system and use MSX-AUDIO BASIC. In a similar way to CALL FMPAC on the FM-PAC cartridge, it launches a built-in software and you can't use MSX-AUDIO BASIC (or MSX-MUSIC BASIC) inside the launched application.

However, the MSX-AUDIO standard specifies that this instruction must always be present in a complete MSX-AUDIO cartridge, to allow the launching of an MSX-AUDIO application and each manufacturer can include any MSX-AUDIO application. Only Panasonic did that by including a modified version of an application created by Toshiba. Theoretically, it would be possible to replace this application by another MSX-AUDIO application, that would be launched by CALL SYNTHE.

This hybrid situation explains why CALL SYNTHE is mentioned in the tables below, but when you use MSX-AUDIO BASIC in your own programs, you will actually never use this instruction.

  • MSX-AUDIO BASIC was initially planned to also be used for MIDI, but this was not realised until MSX-MIDI was finally supported on Turbo R machines by an updated version of MSX-MUSIC BASIC, also named MSX-MIDI BASIC.

Instructions (general info)

MSX-AUDIO BASIC extends the PLAY instruction and adds 37 new instructions, that can be generally divided into four types.

Notes:

  • CALL can be replaced by the character underscore (_). A space is not required after this character. See CALL for more info.
  • With exception for CALL APEEK, CALL APOKE and CALL AUDIO, all the general MSX-AUDIO BASIC instructions are also used by the MSX-MUSIC BASIC, sometimes they work a little differently. CALL AUDIO is replaced by CALL MUSIC in MSX-MUSIC BASIC.
  • In version 1.3 of the MSX-AUDIO BIOS, CALL MUSIC can also initialize MSX-AUDIO.
  • All these instructions are designed for the standard MSX1 to MSX2+.

Instructions (ordered per category)

General instructions

Instruction Effect
CALL APEEK Read a byte from the MSX-AUDIO Sample memory
CALL APOKE Write a byte to the MSX-AUDIO Sample memory
CALL AUDIO Initialize the MSX-AUDIO system
CALL AUDREG Write a byte to an register of the MSX-AUDIO LSI
CALL BGM Specify whether to perform background processing
CALL PITCH Specify the pitch of the FM sound source recording
CALL PLAY Check if music is being played and the PLAY instruction executed
CALL STOPM Stop background playing the PLAY instruction, ADPCM and MK recording
CALL SYNTHE Call the application program
CALL TEMPER Set the temperament for the FM sound source
CALL TRANSPOSE Transpose the musical sound of an FM sound source in units of half tones
CALL VOICE Set the sound timbre (voice) to each channel of the FM sound source
CALL VOICE COPY Copy the sound timbre (voice) parameter data


ADPCM/PCM instructions

Instruction Effect
CALL CONVA Convert PCM format data to ADPCM format
CALL CONVP Convert ADPCM format data to PCM format
CALL COPY PCM Copy the ADPCM/PCM data
CALL LOAD PCM Load ADPCM/PCM data file from disk
CALL PCM FREQ Set the frequency to play the ADPCM sampling in local mode from Sample RAM/ROM
CALL PCM VOL Set the volume of ADPCM/PCM to play
CALL PLAY PCM Play an ADPCM/PCM audio file
CALL REC PCM Record audio to ADPCM/PCM audio file
CALL SAVE PCM Save ADPCM/PCM audio file to disk
CALL SET PCM Initializes an ADPCM/PCM audio file


Instrument instructions

Instruction Effect
CALL INMK Report changes in the music keyboard
CALL KEY OFF Disable the MSX keyboard as instrument
CALL KEY ON Set the MSX keyboard as instrument
CALL MK PCM Specify the file number of the ADPCM sound to be played as an instrument
CALL MK TEMPO Set the speed of the metronome function for performance, recording and playback
CALL MK VEL Set the velocity for the instrument
CALL MK VOICE Set the instrument timbre (voice)
CALL MK VOL Set the instrument volume


Music Keyboard instructions

Instruction Effect
CALL APPEND MK Perform additional recording of MK recording
CALL CONT MK Resume the MK recording and playback stopped by CALL STOPM
CALL MK STAT Report the status of the MK recording system
CALL PLAY MK Play back the MK recording
CALL REC MK Record the performance of the instrument
CALL RECMOD Set the recording mode for MK recording


Instructions (alphabetical order)

Instruction Generation Type
CALL APEEK MSX1 General instruction
CALL APOKE MSX1 General instruction
CALL APPEND MK MSX1 Music Keyboard instruction
CALL AUDIO MSX1 General instruction
CALL AUDREG MSX1 General instruction
CALL BGM MSX1 General instruction
CALL CONT MK MSX1 Music Keyboard instruction
CALL CONVA MSX1 ADPCM/PCM instruction
CALL CONVP MSX1 ADPCM/PCM instruction
CALL COPY PCM MSX1 ADPCM/PCM instruction
CALL INMK MSX1 Instrument instruction
CALL KEY OFF MSX1 Instrument instruction
CALL KEY ON MSX1 Instrument instruction
CALL LOAD PCM MSX1 ADPCM/PCM instruction
CALL MK PCM MSX1 Instrument instruction
CALL MK STAT MSX1 Music Keyboard instruction
CALL MK TEMPO MSX1 Instrument instruction
CALL MK VEL MSX1 Instrument instruction
CALL MK VOICE MSX1 Instrument instruction
CALL MK VOL MSX1 Instrument instruction
CALL PCM FREQ MSX1 ADPCM/PCM instruction
CALL PCM VOL MSX1 ADPCM/PCM instruction
CALL PITCH MSX1 General instruction
CALL PLAY MSX1 General instruction
CALL PLAY MK MSX1 Music Keyboard instruction
CALL PLAY PCM MSX1 ADPCM/PCM instruction
CALL REC MK MSX1 Music Keyboard instruction
CALL RECMOD MSX1 Music Keyboard instruction
CALL REC PCM MSX1 ADPCM/PCM instruction
CALL SAVE PCM MSX1 ADPCM/PCM instruction
CALL SET PCM MSX1 ADPCM/PCM instruction
CALL STOPM MSX1 General instruction
CALL SYNTHE MSX1 General instruction
CALL TEMPER MSX1 General instruction
CALL TRANSPOSE MSX1 General instruction
CALL VOICE MSX1 General instruction
CALL VOICE COPY MSX1 General instruction