ptolemy.actor.lib.jmf
Class PlaySound

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.actor.lib.jmf.PlaySound

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.media.ControllerListener, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class PlaySound
extends TypedAtomicActor
implements javax.media.ControllerListener

This actor plays audio from a file or URL when it fires. If the input has value true, then the sound is played. If it has value false, then the sound is stopped. If the input is not connected, or the actor fires with no input, then the sound is played when it fires. It requires the Java Media Framework.

Since:

Ptolemy II 3.0

Version:

$Id: PlaySound.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward Lee

See Also:

Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private javax.media.GainControl	_gainControl The gain control associated with the player.
private javax.media.Player	_player The player.
private javax.media.Time	_startTime Start time for an audio clip.
FileParameter	fileNameOrURL The file name or URL to read.
TypedIOPort	onOff The input port, which has type boolean.
IntRangeParameter	percentGain The gain (in percent).
Parameter	synchronizedPlay Indicator to play to the end before returning from fire().

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

PlaySound(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

void	attributeChanged(Attribute attribute) If the attribute is fileNameOrURL, then create a new player.
void	controllerUpdate(javax.media.ControllerEvent event) React to notification of a change in controller status.
void	fire() Play the audio file.
void	stopFire() Override the base class to stop the currently playing audio.
void	wrapup() Close the media processor.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

fileNameOrURL

public FileParameter fileNameOrURL

The file name or URL to read.

onOff

public TypedIOPort onOff

The input port, which has type boolean. A true input causes the sound to be played, and false input causes it to be stopped.

percentGain

public IntRangeParameter percentGain

The gain (in percent). This has as its value a record of the form {min = m, max = M, current = c}, where min <= c <= max.

synchronizedPlay

public Parameter synchronizedPlay

Indicator to play to the end before returning from fire(). This is a boolean, and defaults to true.

_gainControl

private javax.media.GainControl _gainControl

The gain control associated with the player.

_player

private javax.media.Player _player

The player.

_startTime

private javax.media.Time _startTime

Start time for an audio clip.

Constructor Detail

PlaySound

public PlaySound(CompositeEntity container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the attribute is fileNameOrURL, then create a new player.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the file cannot be opened or if the base class throws it.

controllerUpdate

public void controllerUpdate(javax.media.ControllerEvent event)

React to notification of a change in controller status. event The event.

Specified by:

controllerUpdate in interface javax.media.ControllerListener

fire

public void fire()
          throws IllegalActionException

Play the audio file.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If there's no director.

stopFire

public void stopFire()

Override the base class to stop the currently playing audio.

Specified by:

stopFire in interface Executable

Overrides:

stopFire in class AtomicActor

wrapup

public void wrapup()

Close the media processor.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor