hmi.elckerlyc.audioengine
Class AudioPlanner

java.lang.Object
  hmi.elckerlyc.AbstractPlanner
      hmi.elckerlyc.audioengine.AudioPlanner

All Implemented Interfaces:

Planner

public class AudioPlanner
extends AbstractPlanner

Field Summary

private static org.slf4j.Logger	logger
private AudioPlayer	player
private static double	TIMEPEG_TOLERANCE

Constructor Summary

AudioPlanner(AudioPlayer p)

Method Summary

List<SyncAndTimePeg>	addBehaviour(BMLBlockPeg bbPeg, Behaviour b, List<TimePegAndConstraint> sacs, PlanUnit planElement) Creates a AudioUnit that satisfies sacs and adds it to the audio plan.
void	addExceptionListener(BMLExceptionListener war)
void	clearAll(double time) Removes all behaviors from the plan
private AudioUnit	createAudioUnit(BMLBlockPeg bbPeg, Behaviour b)
AudioPlayer	getAudioPlayer() Addition to getPlayer, to save on class casting
Set<String>	getInvalidBehaviours() Checks if the behavior plan is still consistent (e.g. after modifying the timing of some TimePegs).
Player	getPlayer() Returns the Player for this planner. useful for, e.g., resetting the player of any planner (see BMLRealizer.reset).
List<Class<? extends Behaviour>>	getSupportedBehaviours()
List<Class<? extends Behaviour>>	getSupportedDescriptionExtensions()
void	interruptBehaviour(String behaviourId, String BMLId, double globalTime) Interrupts the behavior, sending the appropiate feedback callbacks if the behavior was running, just removes it otherwise.
void	removeAllExceptionListeners()
void	removeBehaviour(String behaviourId, String BMLId) Removes behavior with behaviourId and bmlId from the plan Callback behavior is unspecified
void	reset() Resets the player, that is: stops running behavior and returns the player to its startup state (default pose etc) This does not clear any behaviours from the plans.
PlanUnit	resolveSynchs(BMLBlockPeg bbPeg, Behaviour b, List<TimePegAndConstraint> sacs) Resolves TimePegs for behavior b, given some known time pegs and constraints
void	setParameterValue(String behId, String bmlId, String paramId, float value)
void	setParameterValue(String behId, String bmlId, String paramId, String value)

Methods inherited from class hmi.elckerlyc.AbstractPlanner

addFeedbackListener, getBehaviours, getEndTime, getFeedbackListeners, interruptBehaviourBlock, removeAllFeedbackListeners, removeFeedbackListener, setBMLBlockState, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

player

private AudioPlayer player

logger

private static org.slf4j.Logger logger

TIMEPEG_TOLERANCE

private static final double TIMEPEG_TOLERANCE

See Also:

Constant Field Values

Constructor Detail

AudioPlanner

public AudioPlanner(AudioPlayer p)

Method Detail

createAudioUnit

private AudioUnit createAudioUnit(BMLBlockPeg bbPeg,
                                  Behaviour b)
                           throws BehaviourPlanningException

Throws:

BehaviourPlanningException

addBehaviour

public List<SyncAndTimePeg> addBehaviour(BMLBlockPeg bbPeg,
                                         Behaviour b,
                                         List<TimePegAndConstraint> sacs,
                                         PlanUnit planElement)
                                  throws BehaviourPlanningException

Creates a AudioUnit that satisfies sacs and adds it to the audio plan. All registered BMLFeedbackListeners are linked to this AudioUnit.

planElement - planElement obtained from resolveSynchs, null to create a new planElement

Returns:

a list of all syncs of the behavior and their linked TimePegs

Throws:

BehaviourPlanningException - if no behavior satisfying sac can be constructed

resolveSynchs

public PlanUnit resolveSynchs(BMLBlockPeg bbPeg,
                              Behaviour b,
                              List<TimePegAndConstraint> sacs)
                       throws BehaviourPlanningException

Description copied from interface: Planner

Resolves TimePegs for behavior b, given some known time pegs and constraints

b - the behavior

sacs - the provided time pegs and constraints, missing constraints are filled out by this method

Returns:

the object to be placed in the plan (a TimedMotionUnit, SpeechUnit, ...)

Throws:

BehaviourPlanningException - if no behavior satisfying sac can be constructed

getInvalidBehaviours

public Set<String> getInvalidBehaviours()

Description copied from interface: Planner

Checks if the behavior plan is still consistent (e.g. after modifying the timing of some TimePegs). Returns id's of behaviors with invalid timing

clearAll

public void clearAll(double time)

Description copied from interface: Planner

Removes all behaviors from the plan

removeBehaviour

public void removeBehaviour(String behaviourId,
                            String BMLId)

Description copied from interface: Planner

Removes behavior with behaviourId and bmlId from the plan Callback behavior is unspecified

interruptBehaviour

public void interruptBehaviour(String behaviourId,
                               String BMLId,
                               double globalTime)

Description copied from interface: Planner

Interrupts the behavior, sending the appropiate feedback callbacks if the behavior was running, just removes it otherwise.

getAudioPlayer

public AudioPlayer getAudioPlayer()

Addition to getPlayer, to save on class casting

Returns:

the player

getPlayer

public Player getPlayer()

Description copied from interface: Planner

Returns the Player for this planner. useful for, e.g., resetting the player of any planner (see BMLRealizer.reset).

addExceptionListener

public void addExceptionListener(BMLExceptionListener war)

removeAllExceptionListeners

public void removeAllExceptionListeners()

getSupportedBehaviours

public List<Class<? extends Behaviour>> getSupportedBehaviours()

getSupportedDescriptionExtensions

public List<Class<? extends Behaviour>> getSupportedDescriptionExtensions()

reset

public void reset()

Description copied from interface: Planner

Resets the player, that is: stops running behavior and returns the player to its startup state (default pose etc) This does not clear any behaviours from the plans.

setParameterValue

public void setParameterValue(String behId,
                              String bmlId,
                              String paramId,
                              float value)

setParameterValue

public void setParameterValue(String behId,
                              String bmlId,
                              String paramId,
                              String value)