HelpSource/Classes/DiskOut.schelp

   1 class:: DiskOut
   2 summary:: Record to a soundfile to disk.
   3 related:: Classes/RecordBuf, Classes/DiskIn
   4 categories::  UGens>InOut, UGens>Buffer
   5
   6 Description::
   7 Record to a soundfile to disk. Uses a link::Classes/Buffer::.
   8
   9 See link::Classes/RecordBuf:: for recording into a buffer in memory.
  10
  11 classmethods::
  12 private:: categories
  13
  14 method::ar
  15
  16 argument::bufnum
  17 The number of the buffer to write to (prepared with /b-write or
  18 Buffer.write)
  19 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. ::
  20
  21 argument::channelsArray
  22 The Array of channels to write to the file.
  23 Note:: The number of channels in the buffer and the channelsArray must be the same, otherwise DiskOut will fail silently (and not write anything to your file). ::
  24
  25 returns:: The number of frames written to disk.
  26
  27 instancemethods::
  28 private:: checkInputs
  29
  30 Examples::
  31 code::
  32 s.boot; // start the server
  33 (
  34 // something to record
  35 SynthDef("bubbles", {
  36         var f, zout;
  37         f = LFSaw.kr(0.4, 0, 24, LFSaw.kr([8,7.23], 0, 3, 80)).midicps; // glissando function
  38         zout = CombN.ar(SinOsc.ar(f, 0, 0.04), 0.2, 0.2, 4); // echoing sine wave
  39         Out.ar(0, zout);
  40 }).send(s);
  41
  42 // this will record to the disk
  43 SynthDef("help-Diskout", {arg bufnum;
  44         DiskOut.ar(bufnum, In.ar(0,2));
  45 }).send(s);
  46
  47 // this will play it back
  48 SynthDef("help-Diskin-2chan", { arg bufnum = 0;
  49         Out.ar(0, DiskIn.ar(2, bufnum));
  50 }).send(s);
  51 )
  52 ::
  53
  54 subsection:: Object Style
  55 code::
  56 // start something to record
  57 x = Synth.new("bubbles");
  58
  59 // allocate a disk i/o buffer
  60 b= Buffer.alloc(s, 65536, 2);
  61
  62 // create an output file for this buffer, leave it open
  63 b.write("~/diskouttest.aiff".standardizePath, "aiff", "int16", 0, 0, true);
  64 // create the diskout node; making sure it comes after the source
  65 d = Synth.tail(nil, "help-Diskout", ["bufnum", b]);
  66 // stop recording
  67 d.free;
  68 // stop the bubbles
  69 x.free;
  70 // close the buffer and the soundfile
  71 b.close;
  72 // free the buffer
  73 b.free;
  74
  75 // play it back
  76 (
  77 x = Synth.basicNew("help-Diskin-2chan");
  78 m = { arg buf; x.addToHeadMsg(nil, [\bufnum,buf])};
  79
  80 b = Buffer.cueSoundFile(s,"~/diskouttest.aiff".standardizePath, 0, 2, completionMessage: m);
  81 )
  82 x.free; b.close; b.free; // cleanup
  83 ::
  84
  85 subsection:: Messaging Style
  86 code::
  87 // The same thing done in Messaging Style (less overhead but without the convienence of objects)
  88 // start something to record
  89 s.sendMsg("/s_new", "bubbles", 2003, 1, 1);
  90
  91 // allocate a disk i/o buffer
  92 s.sendMsg("/b_alloc", 0, 65536, 2); // Buffer number is 0
  93
  94 // create an output file for this buffer, leave it open
  95 s.sendMsg("/b_write", 0, "~/diskouttest.aiff".standardizePath, "aiff", "int16", 0, 0, 1);
  96
  97 // create the diskout node
  98 s.sendMsg("/s_new", "help-Diskout", 2004, 3, 2003, "bufnum", 0);
  99
 100 s.sendMsg("/n_free", 2004); // stop recording
 101 s.sendMsg("/n_free", 2003); // stop the bubbles
 102
 103 s.sendMsg("/b_close", 0); // close the file.
 104 s.sendMsg("/b_free", 0);
 105 ::
 106