net.happybrackets.core.instruments

Class SampleModule

java.lang.Object

net.beadsproject.beads.core.Bead

net.happybrackets.core.instruments.SampleModule

public class SampleModule
extends net.beadsproject.beads.core.Bead

Encapsulates a basic Sample player into a single class object. It is possible to define the sample name through setSample(String), define looping through setLoopStart(UGen), setLoopStart(double), setLoopEnd(UGen), setLoopEnd(UGen), setLoopStart(UGen) and setLoopType(SamplePlayer.LoopType).

The playback rate of the sample can be controlled through setRate(UGen) and setRate(double).

The position of the player can be set through setPosition(double) and setToEnd().
Sample playback can paused through pause(boolean)
The gain can be set to a UGen object via setGainObject(UGen) or to a specific value * via setGainValue(double).

An example of using the SampleModule might be as follows

 // define our start and end loop points
 final float LOOP_START = 0;
 final  float LOOP_END = 2000;

 final String sample_name = "data/audio/Roje/i-write.wav";
 SampleModule samplePlayer = new SampleModule();
 if (samplePlayer.setSample(sample_name)) {
    samplePlayer.connectTo(HB.getAudioOutput());

    // define our loop type. we will loop forwards
    samplePlayer.setLoopType(SamplePlayer.LoopType.LOOP_FORWARDS);

     // now set the loop start and end in the actual sample player
    samplePlayer.setLoopStart(LOOP_START);
    samplePlayer.setLoopEnd(LOOP_END);
 } else {
    HB.sendStatus("Failed sample " + sample_name);
 }
  

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	EXAMPLE_SAMPLE_NAME

Constructor Summary

Constructors

Constructor and Description
SampleModule() Creates basic SampleModule for playing wave files

Method Summary

Modifier and Type	Method and Description
SampleModule	connectTo(net.beadsproject.beads.core.UGen input_device) Connect the output of this instrument to the input of another device.
protected void	connectToDevice(net.beadsproject.beads.core.UGen input_device) Connect the output of this instrument to the input of another device
net.beadsproject.beads.core.UGen	getGainAmplifier() Get the final gain Object
net.beadsproject.beads.core.UGen	getGainControl() Get the gain Control Object
net.beadsproject.beads.core.UGen	getKillTrigger() Deprecated. use the class instead. Eg, instead of new KillTrigger(player.getKillTrigger() use new KillTrigger(waveModule)
net.beadsproject.beads.ugens.SamplePlayer	getSamplePlayer() Get the Beads SamplePlayer Object of this object
boolean	isRestartSample() FLag indicating we will restart when a new sample name is added
void	kill() Kill the current control and release resources Enables the instrument to be added to a kill trigger
void	pause(boolean pause_playing) Pause the Sample Playback
protected void	setGainObject(net.beadsproject.beads.core.UGen gain_control) Set an object to control the gain of this instrument For example, the set the Gain of a WaveModule so it follows an Envelope we would do as follows
void	setGainValue(double new_gain) Set the gain to a new value
SampleModule	setLoopEnd(double loop_end) Set the End Loop position See setLoopStart(double) for example code
SampleModule	setLoopEnd(net.beadsproject.beads.core.UGen loop_end) Set the End Loop using a UGen.
SampleModule	setLoopStart(double loop_start) Set the startLoop position An example of using the SampleModule loops might be as follows
SampleModule	setLoopStart(net.beadsproject.beads.core.UGen loop_start) Set the start Loop Control using a UGen.
SampleModule	setLoopType(net.beadsproject.beads.ugens.SamplePlayer.LoopType loop_type) Sets the SamplePlayer.LoopType Type for this Sampler
SampleModule	setPosition(double new_position) Set SamplePlayer to new position
SampleModule	setRate(double new_rate) set the playback rate to this value.
SampleModule	setRate(net.beadsproject.beads.core.UGen new_rate_control) set an object to control the playback rate of the samplePlayer.
SampleModule	setRestartSample(boolean restart_on_new_sample) Cause the sample player to start playing new samples at the start
boolean	setSample(java.lang.String filename) Set the sample.
SampleModule	setToEnd() Set SamplePlayer to end

Methods inherited from class net.beadsproject.beads.core.Bead

getKillListener, getName, isDeleted, isPaused, message, messageReceived, setKillListener, setName, start, toString

Methods inherited from class java.lang.Object

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

Field Detail

EXAMPLE_SAMPLE_NAME

public final java.lang.String EXAMPLE_SAMPLE_NAME

See Also:

Constant Field Values

Constructor Detail

SampleModule

public SampleModule()

Creates basic SampleModule for playing wave files

Method Detail

setSample

public boolean setSample(java.lang.String filename)

Set the sample. Note that the path is relative to Device/HappyBrackets. Generally, the audio would be in "data/audio/" The example filename is located "data/audio/Roje/i-write.wav"

     final String s = "data/audio/Roje/i-write.wav";
     SampleModule sampleModule = new SampleModule();
     if (sampleModule.setSample(s))
     {

     }
     

Parameters:

filename - the filename of the sample

Returns:

true if the sample was loaded

pause

public void pause(boolean pause_playing)

Pause the Sample Playback

Overrides:

pause in class net.beadsproject.beads.core.Bead

Parameters:

pause_playing - true if we want to pause. Set to false to start playing

setPosition

public SampleModule setPosition(double new_position)

Set SamplePlayer to new position

Parameters:

new_position - new position in milliseconds

Returns:

this

setToEnd

public SampleModule setToEnd()

Set SamplePlayer to end

Returns:

this

setRate

public SampleModule setRate(net.beadsproject.beads.core.UGen new_rate_control)

set an object to control the playback rate of the samplePlayer. For example, to set the playback rate using an envelop, we might use the following code:

     Envelope sampleRateEnvelope =  new Envelope(0);

     final String s = "data/audio/Roje/i-write.wav";
     SampleModule sampleModule = new SampleModule();
     if (sampleModule.setSample(s)) {// Write your code below this line
        sampleModule.setRate(sampleRateEnvelope);
        sampleModule.connectTo(HB.getAudioOutput());

        sampleRateEnvelope.addSegment(2, 3000); // Set Rate to 2X over 3 seconds
        sampleRateEnvelope.addSegment(1, 2000); // Set Rate to 1X over 2 seconds

        // Write your code above this line
     } else {
        HB.HBInstance.setStatus("Failed sample " + s);
     }// End samplePlayer code
 

Parameters:

new_rate_control - the new object that will control the playback rate

Returns:

this

setRate

public SampleModule setRate(double new_rate)

set the playback rate to this value. A negative value makes the sample play backwards

Parameters:

new_rate - the new frequency

Returns:

this

isRestartSample

public boolean isRestartSample()

FLag indicating we will restart when a new sample name is added

Returns:

the value of restartSample

setRestartSample

public SampleModule setRestartSample(boolean restart_on_new_sample)

Cause the sample player to start playing new samples at the start

Parameters:

restart_on_new_sample - true if we want to play new samples at the start

Returns:

this

setLoopStart

public SampleModule setLoopStart(double loop_start)

Set the startLoop position

An example of using the SampleModule loops might be as follows

     // define our start and end loop points
     final float LOOP_START = 0;
     final  float LOOP_END = 2000;

     final String sample_name = "data/audio/Roje/i-write.wav";
     SampleModule samplePlayer = new SampleModule();
     if (samplePlayer.setSample(sample_name)) {
        samplePlayer.connectTo(HB.getAudioOutput());

        // define our loop type. we will loop forwards
        samplePlayer.setLoopType(SamplePlayer.LoopType.LOOP_FORWARDS);

        // now set the loop start and end in the actual sample player
        samplePlayer.setLoopStart(LOOP_START);
        samplePlayer.setLoopEnd(LOOP_END);
     } else {
        HB.sendStatus("Failed sample " + sample_name);
     }
  

Parameters:

loop_start - loopPoint

Returns:

this

setLoopStart

public SampleModule setLoopStart(net.beadsproject.beads.core.UGen loop_start)

Set the start Loop Control using a UGen. EG

     Glide loopStart = new Glide(0);
     Glide loopEnd = new Glide(2000);

     final String sample_name = "data/audio/Roje/i-write.wav";
     SampleModule samplePlayer = new SampleModule();
     if (samplePlayer.setSample(sample_name)) {
        samplePlayer.connectTo(HB.getAudioOutput());

        // define our loop type. we will loop forwards
        samplePlayer.setLoopType(SamplePlayer.LoopType.LOOP_FORWARDS);

        // now set the loop start and end in the actual sample player
        samplePlayer.setLoopStart(loopStart);
        samplePlayer.setLoopEnd(loopEnd);
     } else {
        HB.sendStatus("Failed sample " + sample_name);
     }
     

Parameters:

loop_start - the Object that will control loopStart

Returns:

this

setLoopEnd

public SampleModule setLoopEnd(double loop_end)

Set the End Loop position See setLoopStart(double) for example code

Parameters:

loop_end - loopPoint

Returns:

this

setLoopEnd

public SampleModule setLoopEnd(net.beadsproject.beads.core.UGen loop_end)

Set the End Loop using a UGen. EG For an example see setLoopStart(UGen)

Parameters:

loop_end - the Object that will control loopEnd

Returns:

this

connectTo

public SampleModule connectTo(net.beadsproject.beads.core.UGen input_device)

Connect the output of this instrument to the input of another device. For example, to connect the SampleModule output to a Reverb, you could do the following:

     Reverb reverb = new Reverb();
     final String sample_name = "data/audio/Roje/i-write.wav";
     SampleModule samplePlayer = new SampleModule();
     if (samplePlayer.setSample(sample_name)) {
        samplePlayer.connectTo(reverb);
     

Parameters:

input_device - the device we want to connect it to

Returns:

this

setLoopType

public SampleModule setLoopType(net.beadsproject.beads.ugens.SamplePlayer.LoopType loop_type)

Sets the SamplePlayer.LoopType Type for this Sampler

Parameters:

loop_type - the type of loop

Returns:

this

getSamplePlayer

public net.beadsproject.beads.ugens.SamplePlayer getSamplePlayer()

Get the Beads SamplePlayer Object of this object

Returns:

the SamplePlayer

getGainControl

public net.beadsproject.beads.core.UGen getGainControl()

Get the gain Control Object

Returns:

the object that controls the gain

getGainAmplifier

public net.beadsproject.beads.core.UGen getGainAmplifier()

Get the final gain Object

Returns:

the gainObject

getKillTrigger

public net.beadsproject.beads.core.UGen getKillTrigger()

Deprecated. use the class instead. Eg, instead of

    new KillTrigger(player.getKillTrigger()

use

    new KillTrigger(waveModule)

Get the object we need to connect our kill trigger to. For example, if we wanted to kill a WaveModule instrument and the end of an envelope we might code the function as follows:

   Envelope gainEnvelope = new Envelope(0);

   WaveModule player = new WaveModule();
   player.setGain(gainEnvelope);
   // Now plug the  object into the audio output
   player.connectTo(HB.getAudioOutput());

   // first add a segment to progress to the higher volume
   gainEnvelope.addSegment(0.1f, 100);

   // now add a segment to make the gainEnvelope stay at that volume
   // we do this by setting the start of the segment to the value as our MAX_VOLUME
   gainEnvelope.addSegment(0.1f, 1000);

   //Now make our gain fade out to 0 and then kill it
   gainEnvelope.addSegment(0, 10, new KillTrigger(player));

Returns:

the object to send our kill trigger to

setGainObject

protected void setGainObject(net.beadsproject.beads.core.UGen gain_control)

Set an object to control the gain of this instrument For example, the set the Gain of a WaveModule so it follows an Envelope we would do as follows

 Envelope gainEnvelope = new Envelope(0);

 WaveModule player = new WaveModule();
 player.setGain(gainEnvelope);
 

Parameters:

gain_control - the new Object that will control the gain

setGainValue

public void setGainValue(double new_gain)

Set the gain to a new value

Parameters:

new_gain - the new gain to set this nstrument to

kill

public void kill()

Kill the current control and release resources Enables the instrument to be added to a kill trigger

Overrides:

kill in class net.beadsproject.beads.core.Bead

connectToDevice

protected void connectToDevice(net.beadsproject.beads.core.UGen input_device)

Connect the output of this instrument to the input of another device

Parameters:

input_device - the device we want to connect it to