Host based tone generator implementation. More...

#include <tonegen.h>

Inheritance diagram for HostToneGen:

Collaboration diagram for HostToneGen:

Public Member Functions
	HostToneGen ()
	Default constructor.

bool	MixTone (int16_t *buf, size_t samples)
	Add the next samples of this tone to the signal in buf.

Public Member Functions inherited from ToneGen
	ToneGen ()
	Default constructor.

virtual	~ToneGen ()
	Virtual destructor.

void	Start (Config *tone, bool sync=false)
	Begin generation of a single tone.

void	Stop ()
	Stop tone generation.

State	GetState () const
	Return the current state of this `ToneGen`.

void	BeginSequence (Config *tone, bool sync=false)
	Prepare the tone generator for playing a sequence of related tones.

void	ContinueSequence ()
	Begin the next discrete tone in an atomic sequence.

void	EndSequence ()
	Signal the completion of an atomic sequence of tones.

void	SignalCompletion ()
	Notify the tone generator of an external completion event.

Config &	GetConfig () const
	Return the `ToneGen::Config` data.

Protected Member Functions
State	ImplStart ()
	Called by `Start()` for implementation specific operations.

Protected Member Functions inherited from ToneGen
virtual void	ImplStop ()
	Called by `Stop()` for implementation specific operations.

Additional Inherited Members
Public Types inherited from ToneGen
enum	State { IDLE , SEQUENCE , CONTINUOUS , ONESHOT }
	`ToneGen` state information More...

typedef std::vector< ToneGen * >	List
	Container type for a list of pointers to `ToneGen` structures.

typedef void(*	CompletionCallback) (ToneGen &)
	Call back type for tone completion notification.

Detailed Description

Host based tone generator implementation.

Member Function Documentation

State HostToneGen::ImplStart ( )

protectedvirtual

Called by Start() for implementation specific operations.

Implements ToneGen.

Add the next samples of this tone to the signal in buf.

Parameters

buf	A buffer of 16bit linear audio data to add this tone to.
samples	The number of tone samples to place in buf.