audio.processing.dynamic

Class Compressor

java.lang.Object

org.trianacode.taskgraph.Unit

audio.processing.dynamic.Compressor

public class Compressor
extends Unit

A Hard-Knee Compressor Effect which allows the user to attenuate the level of signal which is over a threshold set by the user. The attenuation is decided by the 'compression ratio', and the speed at which the signal is attenuated is decided by the attack and release times.

See Also:

Compressor

Field Summary

Fields inherited from class org.trianacode.taskgraph.Unit

CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, ESSENTIAL, ESSENTIAL_IF_CONNECTED, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, NO_UPDATE, ON_TASK_INSTANTATION, ON_USER_ACCESS, OPTIONAL, PROCESS_UPDATE, TRANSIENT, TRANSIENT_ACCESSIBLE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
Compressor()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Called when the unit is disposed of.
java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
java.lang.String[][]	getNodeInputTypes() This method should return an array of the data types accepted by specific nodes, with the node index providing the index for the array.
java.lang.String[][]	getNodeOutputTypes() This method should return an array of the data types output by specific nodes, with the node index providing the index for the array.
java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
void	init() Called when the unit is created.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value) Called a parameters is updated (e.g.
void	process() The main unit algorithm.
void	reset() Called when the unit is reset.

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, extractClipInState, getClipIn, getClipIn, getControlInterface, getDefaultInputNodes, getDefaultNodeRequirement, getDefaultOutputNodes, getDisplayName, getDisplayPackage, getGUIBuilderV2Info, getHelpFileLocation, getInputAtNode, getInputNodeCount, getMaximumInputNodes, getMaximumOutputNodes, getMinimumInputNodes, getMinimumOutputNodes, getOutputNodeCount, getOutputPolicy, getPackageName, getParameter, getParameterPanelClass, getParameterPanelInstantiate, getParameterType, getParameterUpdatePolicy, getPopUpDescription, getRunnableInterface, getTask, getTaskGraphContext, getToolName, getToolPackage, getToolTable, getVersion, hideParameterPanel, isClipInName, isInputAtNode, isOutputSent, isParameter, log, log, notifyError, notifyError, output, outputAtNode, outputAtNode, parameterUpdated, putClipIn, removeClipIn, removeParameter, restoreClipInState, setDefaultInputNodes, setDefaultNodeRequirement, setDefaultOutputNodes, setDisplayName, setDisplayPackage, setGUIBuilderV2Info, setHelpFileLocation, setMaximumInputNodes, setMaximumOutputNodes, setMinimumInputNodes, setMinimumOutputNodes, setOutputPolicy, setParameter, setParameterPanelClass, setParameterPanelInstantiate, setParameterUpdatePolicy, setPopUpDescription, setRunnableInterface, setToolName, setToolPackage, setVersion, showParameterPanel, stopping

Methods inherited from class java.lang.Object

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

Constructor Detail

Compressor

public Compressor()

Method Detail

process

public void process()
             throws java.lang.Exception

Description copied from class: Unit

The main unit algorithm. This method should be implemented with the appropriate algorihtm for the unit (if no algorithm is implemented deadlock occurs).

Specified by:

process in class Unit

Throws:

java.lang.Exception

init

public void init()

Called when the unit is created. Initialises the unit's properties and parameters.

Overrides:

init in class Unit

reset

public void reset()

Called when the unit is reset. Restores the unit's variables to values specified by the parameters.

Overrides:

reset in class Unit

dispose

public void dispose()

Called when the unit is disposed of.

Overrides:

dispose in class Unit

parameterUpdate

public void parameterUpdate(java.lang.String paramname,
                   java.lang.Object value)

Called a parameters is updated (e.g. by the GUI)

Overrides:

parameterUpdate in class Unit

getNodeInputTypes

public java.lang.String[][] getNodeInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by specific nodes, with the node index providing the index for the array. For nodes not covered by the array, the types specified by getInputTypes() are assumed.

Overrides:

getNodeInputTypes in class Unit

Returns:

an array of the types accepted by each input node. For node indexes not covered the types specified by getInputTypes() are assumed.

getInputTypes

public java.lang.String[] getInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getInputTypes in class Unit

Returns:

an array of the input types accepted by nodes not covered by getNodeInputTypes().

getNodeOutputTypes

public java.lang.String[][] getNodeOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by specific nodes, with the node index providing the index for the array. For nodes not covered by the array, the types specified by getOutputTypes() are assumed.

Overrides:

getNodeOutputTypes in class Unit

Returns:

an array of the types output by each output node. For node indexes not covered the types specified by getOutputTypes() are assumed.

getOutputTypes

public java.lang.String[] getOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getOutputTypes in class Unit

Returns:

an array of the input types output by nodes not covered by getNodeOutputTypes().