OSDL Namespace Reference

Definition of the main OSDL common non-specialized types. More...

Namespaces
namespace	Audio
namespace	Data
namespace	Engine
namespace	Events
	Deals with all events of interest for a multimedia engine.
namespace	MVC
namespace	Rendering
namespace	Utils
	Various convenient helpers are defined here.
namespace	Video
Classes
class	CommonModule
	Root of all OSDL modules. More...
class	CDTrack
	Describes a CD track, it is just an object-oriented view of an actual track. More...
class	CDROMDrive
	A CD-ROM drive allows to control a particular CD-ROM device attached to the system. More...
class	CDROMDriveException
	Exception returned whenever an error concerning a CD-ROM drive occured. More...
class	CDROMDriveHandler
	A CD-ROM drive handler manages all CD-ROM device attached to the system, so they can be used easily and safely, by ensuring at most one CD-ROM drive object is associated to an actual device. More...
class	EmbeddedDirectory
	Encapsulates embedded directories, i.e. More...
class	EmbeddedFileException
	Mother class for all exceptions related to embedded files. More...
class	EmbeddedFile
	Encapsulates embedded files, i.e. More...
class	EmbeddedFileSystemManagerException
class	EmbeddedFileSystemManager
	Allows to interact with embedded filesystem services, i.e. More...
class	Exception
	OSDL exception. More...
class	TestException
	Test class for OSDL::Exception. More...
Typedefs
typedef ::SDL_CD	LowLevelCDROM
typedef ::SDL_CDtrack	LowLevelCDROMTrack
typedef Ceylan::Count	TrackNumber
typedef Ceylan::Uint32	FrameCount
	Describes a number of CD frames.
typedef Ceylan::Count	CDROMDriveNumber
	CD-ROM drive numbers are mainly used to identify a CD-ROM drive.
typedef Ceylan::Uint16	FileTag
	Describes a tag used to identify the type of an OSDL-specific file.
Enumerations
enum	TrackType { audioTrack, dataTrack }
	Describes the different kinds of tracks. More...
Functions
OSDL_DLL const Ceylan::LibtoolVersion &	GetVersion ()
	Returns the version of the OSDL library currently linked.
OSDL_DLL void	stop ()
	Shutdowns all OSDL services.
OSDL_DLL CommonModule &	getCommonModule (Ceylan::Flags flags)
	Returns a common module, already existing or, otherwise, created as a side-effect of this call.
OSDL_DLL bool	hasExistingCommonModule ()
	Tells whether there already exists a common module.
OSDL_DLL CommonModule &	getExistingCommonModule ()
	This function is intended to be the usual means of getting a reference to the common module, which must already exist.
OSDL_DLL bool	IsAValidOSDLFileTag (FileTag tag)
	Tells whether specified tag is a valid OSDL one.
OSDL_DLL const std::string &	DescribeFileTag (FileTag tag)
	Returns a textual description of specified file tag.
Variables
OSDL_DLL const FileTag	SoundTag = 1
	Tag corresponding to OSDL punctual sounds, not longer musics.
OSDL_DLL const FileTag	MusicTag = 2
	Tag corresponding to MP3-based OSDL musics, not shorter punctual sounds.
OSDL_DLL const FileTag	PaletteTag = 3
	Tag corresponding to an OSDL palette, useful for color indexed modes.
OSDL_DLL const FileTag	FrameTag = 4
	Tag corresponding to an OSDL frame, part of an animation.
OSDL_DLL const std::string	actualOSDLHeaderLibtoolVersion = "0.5.0"
	This is the libtool version of the OSDL headers, as defined in the configure step.

Detailed Description

Definition of the main OSDL common non-specialized types.

Definition of the main OSDL video types.

As much as possible, consider using strong typing.

See also:: OSDLVideoTypes.h for specialized video types.

As much as possible, consider using strong typing.

Note:: These units are not chosen so that they are completely accurate, as some physic computations would require. Their purpose is only to efficiently fulfill most multimedia needs.

Typedef Documentation

typedef Ceylan::Count OSDL::CDROMDriveNumber

CD-ROM drive numbers are mainly used to identify a CD-ROM drive.

They range from 0 (included) to n, 0 being the default drive, if any.

Definition at line 65 of file OSDLCDROMDriveHandler.h.

typedef Ceylan::Uint16 OSDL::FileTag

Describes a tag used to identify the type of an OSDL-specific file.

Definition at line 66 of file OSDLFileTags.h.

typedef Ceylan::Uint32 OSDL::FrameCount

Describes a number of CD frames.

Definition at line 86 of file OSDLCDROMDrive.h.

typedef ::SDL_CD OSDL::LowLevelCDROM

Definition at line 69 of file OSDLCDROMDrive.h.

typedef ::SDL_CDtrack OSDL::LowLevelCDROMTrack

Definition at line 70 of file OSDLCDROMDrive.h.

typedef Ceylan::Count OSDL::TrackNumber

Definition at line 82 of file OSDLCDROMDrive.h.

Enumeration Type Documentation

enum OSDL::TrackType

Describes the different kinds of tracks.

Enumerator:

audioTrack
dataTrack

Definition at line 90 of file OSDLCDROMDrive.h.

Function Documentation

const std::string & OSDL::DescribeFileTag ( FileTag tag )

Returns a textual description of specified file tag.

Exceptions:

OSDL::Exception

if the tag is not known.

Definition at line 66 of file OSDLFileTags.cc.

References FrameTag, FrameTagDescription, MusicTag, MusicTagDescription, PaletteTag, PaletteTagDescription, SoundTag, SoundTagDescription, and UnknownTagDescription.

Referenced by OSDL::Audio::Sound::load(), OSDL::Audio::Music::load(), and OSDL::Video::Palette::Palette().

OSDL_DLL CommonModule& OSDL::getCommonModule ( Ceylan::Flags flags )

Returns a common module, already existing or, otherwise, created as a side-effect of this call.

This friend function is intended to be the initial means of getting a reference to the common module: this is the entry point to the whole OSDL system.

Parameters:

flags

The requested flags for this common root module, any OR'd combination of CommonModule static flags, so that associated subsystems are instanciated.

See also:: UseTimer, UseAudio, UseVideo, UseCDROM, UseJoystick, UseEverything, NoParachute, UseEventThread, UseGUI, etc.

Note:: UseVideo is required to start the event loop, so it is implied by the UseJoystick flag.; This method is not static to avoid pitfalls of static initializer ordering.

CommonModule & OSDL::getExistingCommonModule ( )

This function is intended to be the usual means of getting a reference to the common module, which must already exist.

This friend function is intended to be the usual means of getting a reference to the common module, which must already exist.

Exceptions:

OSDL::Exception

if the common module does not exist already.

Note:: This function is mainly useful for the OSDL internals, if sub-modules, such as the event module, needed access to the common module.

See also:: hasCommonModule()

Note:: This method is not static to avoid pitfalls of static initializer ordering.

Definition at line 1210 of file OSDLBasic.cc.

Referenced by OSDL::Events::EventsModule::enterBasicMainLoop(), OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Audio::getExistingAudioModule(), OSDL::Video::VideoModule::IsDisplayInitialized(), OSDL::Events::EventsModule::onResizedWindow(), OSDL::Events::EventsModule::onScreenNeedsRedraw(), OSDL::Video::Overlay::Overlay(), OSDL::Engine::Scheduler::schedule(), smarterKeyHandler(), and OSDL::Video::OpenGL::GLTexture::upload().

const Ceylan::LibtoolVersion & OSDL::GetVersion ( )

Returns the version of the OSDL library currently linked.

Exceptions:

OSDL::Exception

if the operation failed.

Definition at line 118 of file OSDLBasic.cc.

References OSDL_LIBTOOL_VERSION.

Referenced by OSDL::CommonModule::toString().

bool OSDL::hasExistingCommonModule ( )

Tells whether there already exists a common module.

Definition at line 1201 of file OSDLBasic.cc.

Referenced by OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Video::VideoModule::IsDisplayInitialized(), and OSDL::Video::Overlay::Overlay().

bool OSDL::IsAValidOSDLFileTag ( FileTag tag )

Tells whether specified tag is a valid OSDL one.

Definition at line 57 of file OSDLFileTags.cc.

References FirstFreeTag.

void OSDL::stop ( )

Shutdowns all OSDL services.

This friend function allows to shutdown all OSDL services.

Definition at line 1223 of file OSDLBasic.cc.

Variable Documentation

OSDL_DLL const std::string OSDL::actualOSDLHeaderLibtoolVersion = "0.5.0"

This is the libtool version of the OSDL headers, as defined in the configure step.

Allows to detect run-time mismatches between the OSDL headers a program or a library was compiled with, and the actual OSDL library it is then linked to.

Definition at line 48 of file OSDLHeaderVersion.h.

const FileTag OSDL::FrameTag = 4

Tag corresponding to an OSDL frame, part of an animation.

It is a list of color index to a palette, prepended by a header.

The corresponding header after this tag is defined in: trunk/tools/media/video/animation-management/pngToOSDLFrame.cc

See also:: trunk/src/code/video/twoDimensional/OSDLAnimation.cc, in Animation::loadFrame for the actual decoding.

Definition at line 40 of file OSDLFileTags.cc.

Referenced by DescribeFileTag().

const FileTag OSDL::MusicTag = 2

Tag corresponding to MP3-based OSDL musics, not shorter punctual sounds.

It is a MP3 file prepended by a header.

The corresponding header after this tag is defined in: trunk/tools/media/audio/mp3ToOSDLMusic.cc

See also:: code/audio/OSDLMusic.cc, in Music::load for the actual decoding.

Note:: Only relevant for embedded platforms, as on PC the format is determined automatically.

Definition at line 38 of file OSDLFileTags.cc.

Referenced by DescribeFileTag(), and OSDL::Audio::Music::load().

const FileTag OSDL::PaletteTag = 3

Tag corresponding to an OSDL palette, useful for color indexed modes.

The corresponding header after this tag is defined in: trunk/src/code/video/OSDLPalette.h.

See also:: trunk/src/code/video/OSDLPalette.cc for the corresponding encoding/decoding.

Definition at line 39 of file OSDLFileTags.cc.

Referenced by DescribeFileTag(), OSDL::Video::Palette::Palette(), and OSDL::Video::Palette::save().

const FileTag OSDL::SoundTag = 1

Tag corresponding to OSDL punctual sounds, not longer musics.

It is the lightweight counterpart of a Wave file, based on an OSDL header followed by the raw PCM or IMA ADPCM (not Microsoft ADPCM) encoded samples.

The corresponding header after this tag is:

1 Uint16: frequency, in Hertz (ex: 22 050 Hz)
1 Uint16: format, i.e. bit depth for PCM samples (ex: 8 bit/16 bit), supposed signed little endian, or IMA ADPCM.
1 Uint16: mode, i.e. number of channels (ex: mono, stereo)

See also:: code/audio/OSDLSound.cc, in Sound::load for the actual decoding.

Note:: Only relevant for embedded platforms, as on PC the format is determined automatically.

Definition at line 37 of file OSDLFileTags.cc.

Referenced by DescribeFileTag(), and OSDL::Audio::Sound::load().

OSDL Namespace Reference

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation