OSDLIPCCommands.h File Reference

#include "CeylanIPCCommands.h"

Include dependency graph for OSDLIPCCommands.h:

This graph shows which files directly or indirectly include this file:

Variables
const ARM9CommandID	PlaySoundRequest = 33
	This include file centralizes the OSDL-specific command identifiers for the FIFO-based IPC, notably for the Nintendo DS.
const ARM9CommandID	PlayMusicRequest = 34
	Request the ARM7 to play specified music.
const ARM9CommandID	FadeInMusicRequest = 35
	Request the ARM7 to fade-in current music, from volume zero to full volume.
const ARM9CommandID	FadeOutMusicRequest = 36
	Request the ARM7 to fade-out current music, from current volume to zero volume.
const ARM9CommandID	StopMusicRequest = 37
	Request the ARM7 to stop the playback of current music.
const ARM9CommandID	PauseMusicRequest = 38
	Request the ARM7 to pause the playback of current music.
const ARM9CommandID	UnpauseMusicRequest = 39
	Request the ARM7 to unpause the playback of current music.
const ARM9CommandID	EndOfEncodedStreamReached = 40
	Notification to the ARM7: the end of encoded stream has been reached while refilling buffers.
const ARM9CommandID	SetMusicVolumeRequest = 41
	Request the ARM7 to set the volume of current music to specified value.
const ARM7CommandID	NoAvailableChannelNotification = 33
	Notification of the ARM9 that a sound could not be played due to the lack of free audio channel (all are busy).
const ARM7CommandID	FirstBufferFillRequest = 34
	Notification of the ARM9 that the first music encoded buffer is not used currently and that it should be filled as soon as possible.
const ARM7CommandID	SecondBufferFillRequest = 35
	Notification of the ARM9 that the second music encoded buffer is not used currently and that it should be filled as soon as possible.
const ARM7CommandID	MusicEndedNotification = 36
	Notification of the ARM9 that the current music playback is over.
const ARM7CommandID	MusicFrameInformation = 37
	Notification of the ARM9 of some informations regarding a MP3 frame.

Variable Documentation

const ARM9CommandID EndOfEncodedStreamReached = 40

Notification to the ARM7: the end of encoded stream has been reached while refilling buffers.

No parameters set in the command element, no other element sent, no answer expected.

Definition at line 181 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID FadeInMusicRequest = 35

Request the ARM7 to fade-in current music, from volume zero to full volume.

The last 16 bits of the command element contain the requested fade-in duration, in milliseconds.

No answer expected.

See also:: FadeOutMusicRequest

Definition at line 114 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID FadeOutMusicRequest = 36

Request the ARM7 to fade-out current music, from current volume to zero volume.

The last 16 bits of the command element contain the requested fade-out duration, in milliseconds.

No answer expected.

See also:: FadeInMusicRequest

Definition at line 130 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM7CommandID FirstBufferFillRequest = 34

Notification of the ARM9 that the first music encoded buffer is not used currently and that it should be filled as soon as possible.

No parameters set in the command element, no direct answer expected.

See also:: FirstBufferFilled

Definition at line 225 of file OSDLIPCCommands.h.

Referenced by triggerFirstBufferRefill().

const ARM7CommandID MusicEndedNotification = 36

Notification of the ARM9 that the current music playback is over.

No parameters set in the command element, no direct answer expected.

Definition at line 248 of file OSDLIPCCommands.h.

Referenced by manageMP3Playback().

const ARM7CommandID MusicFrameInformation = 37

Notification of the ARM9 of some informations regarding a MP3 frame.

Definition at line 257 of file OSDLIPCCommands.h.

const ARM7CommandID NoAvailableChannelNotification = 33

Notification of the ARM9 that a sound could not be played due to the lack of free audio channel (all are busy).

No parameters set in the command element, no answer expected.

Definition at line 212 of file OSDLIPCCommands.h.

Referenced by handlePlaySoundRequest().

const ARM9CommandID PauseMusicRequest = 38

Request the ARM7 to pause the playback of current music.

No parameters set in the command element, no other element sent, no answer expected.

See also:: UnpauseMusicRequest

Definition at line 156 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID PlayMusicRequest = 34

Request the ARM7 to play specified music.

A boolean parameter is set in the command element: its last bit tells whether the playback should start from first buffer (if 1) or from second (if 0).

The second element is a pointer to the cache-aligned sound buffer, third is composed of the full size of the encoded buffer (16 first bits), then the delta value (the MP3 frame size upper bound, 16 last bits).

No answer expected.

See also:: StopMusicRequest

Definition at line 99 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID PlaySoundRequest = 33

This include file centralizes the OSDL-specific command identifiers for the FIFO-based IPC, notably for the Nintendo DS.

It is to be included by ARM7 C code and ARM9 C++ code.

typedef for FIFOCommandID is expected to be already defined (it cannot be defined here as its definition is specific to each ARM: Ceylan::Uint8/uint8).

enum not used as are int, thus 32-bit, whereas we want 8 bit. OSDL-specific command identifier values are in the [32..96] reserved range.

System-specific command identifier values range from 0 to 127.

Note:: Ceylan subdivided this range into [0..32], reserved for its own use, and [32..127], reserved for Ceylan-integrating libraries, notably OSDL, which reserved [32..96].

Hence other libraries can use [97..127], and each application can use [128..255]. Request the ARM7 to play specified sound.

No parameters set in the command element, next element is a pointer to the cache-aligned sound buffer, no answer expected.

Definition at line 79 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM7CommandID SecondBufferFillRequest = 35

Notification of the ARM9 that the second music encoded buffer is not used currently and that it should be filled as soon as possible.

No parameters set in the command element, no direct answer expected.

See also:: SecondBufferFilled

Definition at line 238 of file OSDLIPCCommands.h.

Referenced by triggerSecondBufferRefill().

const ARM9CommandID SetMusicVolumeRequest = 41

Request the ARM7 to set the volume of current music to specified value.

The new volume is set in the last byte of command element.

Definition at line 191 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID StopMusicRequest = 37

Request the ARM7 to stop the playback of current music.

No parameters set in the command element, no other element sent, no answer expected.

See also:: PlayMusicRequest

Definition at line 143 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

const ARM9CommandID UnpauseMusicRequest = 39

Request the ARM7 to unpause the playback of current music.

No parameters set in the command element, no other element sent, no answer expected.

See also:: PauseMusicRequest

Definition at line 169 of file OSDLIPCCommands.h.

Referenced by handleReceivedIntegratingLibrarySpecificCommand().

OSDLIPCCommands.h File Reference

Variables

Variable Documentation