Classes | UGens > InOut | UGens > Buffer

VDiskIn : MultiOutUGen : UGen : AbstractFunction : Object

Stream in audio from a file, with variable rate


Continuously play a longer soundfile from disk. This requires a buffer to be preloaded with one buffer size of sound.

Class Methods, bufnum, rate: 1, loop: 0, sendID: 0)



number of channels


buffer number

NOTE: The Buffer's numFrames must be a power of two and is recommended to be at least 65536 -- preferably 131072 or 262144. Smaller buffer sizes mean more frequent disk access, which can cause glitches.

controls the rate of playback. Values below 4 are probably fine, but the higher the value, the more disk activity there is, and the more likelihood there will be a problem.

WARNING: the rate does have a practical limit. The following must be true: rate < Buffer's size / ( 2 * s.options.blockSize) e.g with typical default values, this will be 32768 / (2 * 64) = 256.

If the rate is too high, the UGen will not execute, posting a warning.


If loop is set to 1, the soundfile will loop.


If a sendID is given, the UGen sends an OSC message with this ID and the frame index relative to the onset of the Synth each time it reloads the buffer: ['/diskin', nodeID, sendID, frame]. The true frame index into the file is determined by the startFrame given when reading the initial buffer's worth of data, using Buffer: -cueSoundFile or Buffer: -read. VDiskIn does not have access to the frame index used to cue the buffer. So, the frame index sent by OSC is always 0 at the start of the synth node. The user is responsible for adding the cue point: cueStartFrame + msg[3].


This UGen will set the 'done' flag when finished playing.

Inherited class methods

Instance Methods

Inherited instance methods


b = Buffer.cueSoundFile(s, Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0, 1);

x = {, b,, 2), 1, loop:1) }.play;


// again
// note the like named instance method, but different arguments
b.cueSoundFile(Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0);; b.close;;

// cue and play right away
SynthDef("help-VDiskin", { |out, bufnum = 0|,, bufnum,, 2.0)));
x = Synth.basicNew("help-VDiskin");
m = { arg buf; x.addToHeadMsg(nil, [\bufnum, buf])};

b = Buffer.cueSoundFile(s,Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff",0,1, completionMessage: m);
); b.close;;    // clean up

// sending back the file position.
// note:
// the ugen knows nothing of the loop (apply a modulo).
// if you load another file, you need to free the buffer and re-allocate it (see below)

b = Buffer.cueSoundFile(s, Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0, 1, bufferSize: 4096);
c = SoundFile(Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff").info;
x = {, b,, 0.9), 1, sendID: 14) }.play;

// register to receive this message

o = OSCFunc({ arg msg;
    var sendID = msg[2];
    var index = msg[3];
    "id: % pos: % frames (% sec)\n"
        .postf(sendID, index % c.numFrames, (index % c.numFrames / c.sampleRate));
},'/diskin', s.addr)


b.alloc; b.cueSoundFile(Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0); c = SoundFile(Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff").info;; b.close;;; // clean up eventually

The same example in OSC Messaging style, see Node Messaging

// allocate a disk i/o buffer
s.sendMsg("/b_alloc", 0, 65536, 1);

// open an input file for this buffer, leave it open
s.sendMsg("/b_read", 0, Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0, 65536, 0, 1);

// create a diskin node
s.sendMsg("/s_new", "help-VDiskin", x = s.nextNodeID, 1, 1);

s.sendMsg("/b_close", 0); // close the file (very important!)

// again
// don't need to reallocate and Synth is still reading
s.sendMsg("/b_read", 0, Platform.resourceDir +/+ "sounds/a11wlk01-44_1.aiff", 0, 0, 0, 1);

s.sendMsg("/n_free", x); // stop reading

s.sendMsg("/b_close", 0); // close the file.

s.sendMsg("/b_free", 0); // frees the buffer