#include <sound_handler_sdl.h>

Inheritance diagram for gnash::sound::SDL_sound_handler:

Public Member Functions
	SDL_sound_handler (media::MediaHandler *m)

	~SDL_sound_handler ()

virtual int	createStreamingSound (const media::SoundInfo &sinfo)
	Streaming sound functions: More...

virtual int	create_sound (std::unique_ptr< SimpleBuffer > data, const media::SoundInfo &sinfo)
	Event sound functions: More...

virtual StreamBlockId	addSoundBlock (SimpleBuffer buf, size_t sample_count, int seekSamples, int streamId)

virtual void	stopEventSound (int sound_handle)
	Remove scheduled requests to play the specified sound buffer slot. More...

virtual void	stopAllEventSounds ()
	Stop all instances of all playing event sounds. More...

virtual void	stopStreamingSound (int sound_handle)
	Remove scheduled requests to play the specified sound buffer slot. More...

virtual void	delete_sound (int sound_handle)
	Discard the sound data for an embedded event sound. More...

virtual void	reset ()
	Discard all sound inputs (slots and aux streamers) and clear scheduling. More...

virtual void	stop_all_sounds ()
	Mixed functions: More...

virtual int	get_volume (int sound_handle) const
	Gets the volume for a given sound buffer slot. More...

virtual void	set_volume (int sound_handle, int volume)
	Sets the volume for a given event sound. More...

virtual media::SoundInfo *	get_sound_info (int soundHandle) const
	Returns a SoundInfo object for the sound with the given id. More...

virtual void	pause ()
	gnash calls this to pause audio More...

virtual void	unpause ()
	gnash calls this to unpause audio More...

virtual unsigned int	get_duration (int sound_handle) const
	Gets the duration in milliseconds of an event sound. More...

virtual unsigned int	tell (int sound_handle) const
	Gets the playhead position in milliseconds of an event sound. More...

void	plugInputStream (std::unique_ptr< InputStream > in)
	Plug an InputStream to the mixer. More...

void	unplugInputStream (InputStream *id)
	Unplug an external InputStream from the mixer. More...

void	fetchSamples (std::int16_t *to, unsigned int nSamples)
	Fetch mixed samples. More...

Public Member Functions inherited from gnash::sound::sound_handler
virtual	~sound_handler ()

void	startSound (int id, int loops, const SoundEnvelopes *env, bool allowMultiple, unsigned int inPoint=0, unsigned int outPoint=std::numeric_limits< unsigned int >::max())
	Start playback of an event sound. More...

bool	isSoundPlaying (int id) const
	Check if an event sound is playing. More...

void	playStream (int handle, StreamBlockId blockId)
	Start playback of a streaming sound, if not playing already. More...

int	getStreamBlock (int handle) const
	Get the identifier for the block playing in a specific stream. More...

int	getFinalVolume () const
	Sound output functions. More...

void	setFinalVolume (int v)
	Set the volume to apply to mixed output. More...

void	mute ()
	Call this to mute audio. More...

void	unmute ()
	Call this to unmute audio. More...

bool	is_muted () const
	Returns whether or not sound is muted. More...

bool	isPaused () const
	return true if audio is paused More...

virtual InputStream *	attach_aux_streamer (aux_streamer_ptr ptr, void *udata)
	Plug an external InputStream into the mixer. More...

size_t	numSoundsStarted () const
	Special test-fuction. Reports how many times a sound has been started. More...

size_t	numSoundsStopped () const
	Special test-fuction. Reports how many times a sound has been stopped. More...

void	setAudioDump (const std::string &wavefile)
	Request to dump audio to the given filename. More...

bool	streamingSound () const
	Check if a streaming sound is playing. More...

Additional Inherited Members
Public Types inherited from gnash::sound::sound_handler
typedef unsigned long	StreamBlockId
	Identifier of a streaming sound block. More...

Protected Member Functions inherited from gnash::sound::sound_handler
	sound_handler (media::MediaHandler *m)

virtual void	unplugAllInputStreams ()
	Unplug all input streams. More...

bool	hasInputStreams () const
	Does the mixer have input streams ? More...

virtual void	delete_all_sounds ()
	Stop and delete all sounds. More...

Detailed Description

SDL-based sound_handler.

Constructor & Destructor Documentation

§ SDL_sound_handler()

gnash::sound::SDL_sound_handler::SDL_sound_handler ( media::MediaHandler * m )

Referenced by gnash::sound::create_sound_handler_sdl().

§ ~SDL_sound_handler()

gnash::sound::SDL_sound_handler::~SDL_sound_handler ( )

References gnash::log_debug().

Member Function Documentation

§ addSoundBlock()

sound_handler::StreamBlockId gnash::sound::SDL_sound_handler::addSoundBlock	(	SimpleBuffer	data,
		size_t	sampleCount,
		int	seekSamples,
		int	streamId
	)

virtual

Append data for a streaming sound.

Gnash's parser calls this to fill up soundstreams data.

Parameters

data	The sound data to be stored. This should be appropriately padded (

See also: MediaHandler::getInputPaddingBytes()), or a reallocation will take place here.

Parameters

sampleCount	Number of samples in the data
seekSamples	Offset of sound to frame data
streamId	The soundhandlers id of the sound we want to add data to

Returns: a handler for the new block for use in playStream()

Exceptions

SoundException on error

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::addSoundBlock().

§ create_sound()

int gnash::sound::SDL_sound_handler::create_sound	(	std::unique_ptr< SimpleBuffer >	data,
		const media::SoundInfo &	sinfo
	)

virtual

Event sound functions:

Create a sound buffer slot, for on-demand playback.

Parameters

data	The sound data to be stored. May not be null. This should be appropriately padded (

See also: MediaHandler::getInputPaddingBytes()), or a reallocation will take place here.

Parameters

sinfo A SoundInfo object containing info about samplerate, samplecount, stereo etc.

Returns: handle for later identification.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::create_sound().

§ createStreamingSound()

int gnash::sound::SDL_sound_handler::createStreamingSound ( const media::SoundInfo & sinfo )

virtual

Streaming sound functions:

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::createStreamingSound().

§ delete_sound()

void gnash::sound::SDL_sound_handler::delete_sound ( int sound_handle )

virtual

Discard the sound data for an embedded event sound.

Only embedded event sounds are deleted; this happens when the associated sound_sample is deleted.

Parameters

sound_handle The id for the event sound to be deleted

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::delete_sound().

§ fetchSamples()

void gnash::sound::SDL_sound_handler::fetchSamples	(	std::int16_t *	to,
		unsigned int	nSamples
	)

virtual

Fetch mixed samples.

We run through all the plugged InputStreams fetching decoded audio blocks and mixing them into the given output stream.

Parameters

to The buffer to write mixed samples to. Buffer must be big enough to hold nSamples samples.

nSamples The amount of samples to fetch. NOTE: this number currently refers to "mono" samples due to some bad design decision. It is so expected that the user fetches 44100 * 2 samples which has to be interpreted as series of left,right channel couples. TODO: use actual number of samples so that it's expected to fetch 44100 per second and let expose a function to give interpretation of what comes back (how many bytes per channel, which format).

Reimplemented from gnash::sound::sound_handler.

References _, fetchSamples(), gnash::sound::sound_handler::fetchSamples(), gnash::sound::sound_handler::hasInputStreams(), gnash::log_debug(), gnash::log_error(), and volume.

Referenced by fetchSamples().

§ get_duration()

unsigned int gnash::sound::SDL_sound_handler::get_duration ( int sound_handle ) const

virtual

Gets the duration in milliseconds of an event sound.

Parameters

sound_handle The id of the event sound

Returns: the duration of the sound in milliseconds

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::get_duration().

§ get_sound_info()

media::SoundInfo * gnash::sound::SDL_sound_handler::get_sound_info ( int handle ) const

virtual

Returns a SoundInfo object for the sound with the given id.

Note: This should only be used for streaming sounds. The SoundInfo object is still owned by the soundhandler.

Parameters

soundHandle The soundhandlers id of the sound we want some info about.

Returns: a pointer to the SoundInfo object for the sound with the given id or 0 if no such sound exists.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::get_sound_info().

§ get_volume()

int gnash::sound::SDL_sound_handler::get_volume ( int sound_handle ) const

virtual

Gets the volume for a given sound buffer slot.

Only use for event sounds!

Parameters

sound_handle The sound to get the volume for.

Returns: the sound volume level as an integer from 0 to 100, where 0 is off and 100 is full volume. The default setting is 100.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::get_volume().

§ pause()

void gnash::sound::SDL_sound_handler::pause ( )

virtual

gnash calls this to pause audio

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::pause().

§ plugInputStream()

void gnash::sound::SDL_sound_handler::plugInputStream ( std::unique_ptr< InputStream > in )

virtual

Plug an InputStream to the mixer.

Parameters

in	The InputStream to plug, ownership transferred

Reimplemented from gnash::sound::sound_handler.

References gnash::log_debug(), and gnash::sound::sound_handler::plugInputStream().

§ reset()

void gnash::sound::SDL_sound_handler::reset ( )

virtual

Discard all sound inputs (slots and aux streamers) and clear scheduling.

Gnash calls this on movie restart.

The function should stop all sounds and get ready for a "parse from scratch" operation.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::stop_all_sounds().

§ set_volume()

void gnash::sound::SDL_sound_handler::set_volume	(	int	sound_handle,
		int	volume
	)

virtual

Sets the volume for a given event sound.

Only used by the AS Sound class

Parameters

sound_handle	The handle of the event sound to set volume for.
volume	A number from 0 to 100 representing a volume level. 100 is full volume and 0 is no volume. The default setting is 100.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::set_volume().

§ stop_all_sounds()

void gnash::sound::SDL_sound_handler::stop_all_sounds ( )

virtual

Mixed functions:

Remove all scheduled request for playback of sound buffer slots This applies both to streaming and event sounds.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::stop_all_sounds().

§ stopAllEventSounds()

void gnash::sound::SDL_sound_handler::stopAllEventSounds ( )

virtual

Stop all instances of all playing event sounds.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::stopAllEventSounds().

§ stopEventSound()

void gnash::sound::SDL_sound_handler::stopEventSound ( int sound_handle )

virtual

Remove scheduled requests to play the specified sound buffer slot.

Stop all instances of the specified event sound if it's playing. (Normally a full-featured sound API would take a handle specifying the instance of a playing sample, but SWF is not expressive that way.)

Parameters

sound_handle id for the sound to be stopped

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::stopEventSound().

§ stopStreamingSound()

void gnash::sound::SDL_sound_handler::stopStreamingSound ( int handle )

virtual

Remove scheduled requests to play the specified sound buffer slot.

Parameters

sound_handle The sound_handlers id for the sound to be stopped.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::stopStreamingSound().

§ tell()

unsigned int gnash::sound::SDL_sound_handler::tell ( int sound_handle ) const

virtual

Gets the playhead position in milliseconds of an event sound.

Parameters

sound_handle The id of the event sound

Returns: The playhead position of the sound in milliseconds

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::tell().

§ unpause()

void gnash::sound::SDL_sound_handler::unpause ( )

virtual

gnash calls this to unpause audio

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::hasInputStreams(), and gnash::sound::sound_handler::unpause().

§ unplugInputStream()

void gnash::sound::SDL_sound_handler::unplugInputStream ( InputStream * id )

virtual

Unplug an external InputStream from the mixer.

This is called by AS classes NetStream or Sound to dettach callback, so that audio from the classes no longer will be played through the soundhandler.

Parameters

id	The key identifying the auxiliary streamer, as returned by attach_aux_streamer.

Reimplemented from gnash::sound::sound_handler.

References gnash::sound::sound_handler::unplugInputStream().

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ SDL_sound_handler()

§ ~SDL_sound_handler()

Member Function Documentation

§ addSoundBlock()

§ create_sound()

§ createStreamingSound()

§ delete_sound()

§ fetchSamples()

§ get_duration()

§ get_sound_info()

§ get_volume()

§ pause()

§ plugInputStream()

§ reset()

§ set_volume()

§ stop_all_sounds()

§ stopAllEventSounds()

§ stopEventSound()

§ stopStreamingSound()

§ tell()

§ unpause()

§ unplugInputStream()