| java.lang.Object
 com.db.media.audio.dsp.AbstractAudio
| AbstractAudio | | abstract public class AbstractAudio (Code) | | |
| Constructor Summary | |
| public | AbstractAudio(String name, int type)
AbstractAudio class constructor
NOTE: name and type are for informational purposes only and
serve to identify a specific device. |
| Method Summary | |
| public void | doReset()
Called to perform a reset operation on all participating device
stages. | | public boolean | equals(AbstractAudio a)
Function to determine if one AbstractAudio device is the
same as another. | | public boolean | getByPass()
Return the current by pass state of this device. | | public String | getName()
| | public int | getNumberOfChannels()
Retrieve the number of channel of the signal path. | | abstract public int | getSamples(short[] buffer, int length)
This method must be iplemented by all devices that extend
the AbstractAudio class. | | public int | getSamplingRate()
Retrieve the sample rate of the signal path. | | public void | hexo(int i)
| | public void | hexo(String s, int i)
| | public static void | hexo(long i)
| | public static void | hexo(String s, long i)
| | public void | minMaxChannels(int min, int max, int preferred)
Called to find the min, preferred and max values for the number
of channels the devices in the signal path find acceptable. | | public void | minMaxSamplingRate(int min, int max, int preferred)
Called to find the min, preferred and max values for sample rate
the devices in the signal path find acceptable. | | protected void | negotiateNumberOfChannels()
Called to instigate number of channel negotiation in the signal chain
of AbstractAudio device.
First it causes propagation towards the sink in the signal chain.
Next, the default number of channels value is set and the negotiation
is begun by a call to minMaxChannels. | | protected void | negotiateSamplingRate()
Called to instigate sample rate negotiation in the signal chain
of AbstractAudio device.
First it causes propagation towards the sink in the signal chain.
Next, the default sample rate values are set and the negotiation
is begun by a call to minMaxSamplingRate. | | public static void | o(String s)
| | protected void | propagateReset()
| | protected void | reset()
Override this method if reset functionality is required
for your AbstractAudio device derivative. | | public void | setByPass(boolean byPass)
| | public void | setChannelsRecursive(int ch)
Called to force the specified number of channels to be used
in the device chain. | | protected void | setNumberOfChannels(int channels)
| | protected void | setSamplingRate(int s)
| | public void | setSamplingRateRecursive(int sr)
Causes all the device stages to have their sampling rate set
to the specified value. | | public String | toString()
| | public static String | typeString(int type)
|
| ALLTYPES | | final public static int ALLTYPES(Code) | | |
| MONITOR | | final public static int MONITOR(Code) | | |
| NOTYPE | | final public static int NOTYPE(Code) | | |
| PROCESSOR | | final public static int PROCESSOR(Code) | | |
| SAMPLEBUFFERSIZE | | final public static int SAMPLEBUFFERSIZE(Code) | | |
| SINK | | final public static int SINK(Code) | | |
| SOURCE | | final public static int SOURCE(Code) | | |
| AbstractAudio | | public AbstractAudio(String name, int type)(Code) | | AbstractAudio class constructor
NOTE: name and type are for informational purposes only and
serve to identify a specific device.
Parameters:
String - name is the name given to this device int type is one of the device types listed above |
| doReset | | public void doReset()(Code) | | Called to perform a reset operation on all participating device
stages.
|
| equals | | public boolean equals(AbstractAudio a)(Code) | | Function to determine if one AbstractAudio device is the
same as another. Equality is assumed if name and type match. This
method is used in the LinkedListVector class to find specific
devices on the list.
boolean true if the name and type match, false otherwise. |
| getByPass | | public boolean getByPass()(Code) | | Return the current by pass state of this device.
boolean true if this stage of processing is bypassed andfalse otherwise. |
| getName | | public String getName()(Code) | | Return the name of this AbstractAudio device
String containing device's assigned name |
| getNumberOfChannels | | public int getNumberOfChannels()(Code) | | Retrieve the number of channel of the signal path. If not already
set, this call with instigate negotiation.
int containing the agreed upon number of channels |
| getSamples | | abstract public int getSamples(short[] buffer, int length)(Code) | | This method must be iplemented by all devices that extend
the AbstractAudio class. This is the method by which audio
samples are moved between device stages. Call the getSamples()
method on the device previous to this device in the signal path
causes samples to be pull from it.
short [] buffer is a buffer that this stage of processingshould fill with data for subsequent return to calling code. int length is the number of samples that are requested int indicating the number of samples available or -1 ifthe end of input or file has been reached. |
| getSamplingRate | | public int getSamplingRate()(Code) | | Retrieve the sample rate of the signal path. If not already
set, this call with instigate negotiation.
int containing the agreed upon sample rate |
| hexo | | public void hexo(int i)(Code) | | Hex string display method
int i is the value to convert to a hex string |
| hexo | | public void hexo(String s, int i)(Code) | | Labeled hex string display method
Parameters:
String - s is the label to prepend to the hex string int i is the value to convert to a hex string |
| hexo | | public static void hexo(long i)(Code) | | Hex string display method
long i is the value to convert to a hex string |
| hexo | | public static void hexo(String s, long i)(Code) | | Labeled hex string display method
Parameters:
String - s is the label to prepend to the hex string long i is the value to convert to a hex string |
| minMaxChannels | | public void minMaxChannels(int min, int max, int preferred)(Code) | | Called to find the min, preferred and max values for the number
of channels the devices in the signal path find acceptable.
Parameters:
MyInt - min is the wrapped minimum number of channelsthis signal path can tolerate.
Parameters:
MyInt - max is the wrapped maximum number of channelsthis signal path can tolerate.
Parameters:
MyInt - preferred is the wrapped number of channels thissignal path prefers. |
| minMaxSamplingRate | | public void minMaxSamplingRate(int min, int max, int preferred)(Code) | | Called to find the min, preferred and max values for sample rate
the devices in the signal path find acceptable.
Parameters:
MyInt - min is the wrapped minimum value of sampling ratethis signal path can tolerate.
Parameters:
MyInt - max is the wrapped maximum value of sampling ratethis signal path can tolerate.
Parameters:
MyInt - preferred is the wrapped sampling rate value thissignal path prefers. |
| negotiateNumberOfChannels | | protected void negotiateNumberOfChannels()(Code) | | Called to instigate number of channel negotiation in the signal chain
of AbstractAudio device.
First it causes propagation towards the sink in the signal chain.
Next, the default number of channels value is set and the negotiation
is begun by a call to minMaxChannels. Upon return from
negotiation, some checking is done to see that the negotiated channels
is acceptable and then setChannelsRecursive is called to force
the agreed upon number of channels into each of the AbstractAudio devices
in the signal chain.
|
| negotiateSamplingRate | | protected void negotiateSamplingRate()(Code) | | Called to instigate sample rate negotiation in the signal chain
of AbstractAudio device.
First it causes propagation towards the sink in the signal chain.
Next, the default sample rate values are set and the negotiation
is begun by a call to minMaxSamplingRate. Upon return from
negotiation, some checking is done to see that the negotiated rate
is acceptable and then setSamplingRateRecursive is called to force
the agreed upon sample rate into each of the AbstractAudio devices
in the signal chain.
|
| o | | public static void o(String s)(Code) | | Shortcut method for system.out.println
Parameters:
String - s is the string to write to standard out |
| propagateReset | | protected void propagateReset()(Code) | | Propagate reset call to all processing stages
|
| reset | | protected void reset()(Code) | | Override this method if reset functionality is required
for your AbstractAudio device derivative. If not overridden
nothing will happen in this device when a reset operation
occurs.
|
| setByPass | | public void setByPass(boolean byPass)(Code) | | Used to set the bypass state of this device
boolean byPass if true stage will be bypassed. |
| setChannelsRecursive | | public void setChannelsRecursive(int ch)(Code) | | Called to force the specified number of channels to be used
in the device chain. This causes a propagation towards the source
in the signal chain and then on return sets the number of channels
variable in each stage of the chain.
int ch is the number of channels to set either 1 for mono or2 for stereo. |
| setNumberOfChannels | | protected void setNumberOfChannels(int channels)(Code) | | Sets the number of channels for this device if possible
int channels is the number of channels to set |
| setSamplingRate | | protected void setSamplingRate(int s)(Code) | | Sets the sample rate for this device if possible
int s is the sample rate to set |
| setSamplingRateRecursive | | public void setSamplingRateRecursive(int sr)(Code) | | Causes all the device stages to have their sampling rate set
to the specified value.
int sr is the sampling rate that was negotiated and needstherefore to be set into each stage. |
| toString | | public String toString()(Code) | | Convert AbstractAudio parameters to a string for display
String containing description of this device |
| typeString | | public static String typeString(int type)(Code) | | Static method for displaying a type string given the device type
int type is the type of this AbstractAudio device |
|
|