1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
// Sorceress // Copyright (C) 2021 Wesley Merkel // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see <https://www.gnu.org/licenses/>. //! The library of UGens. //! //! UGens, short for *unit generators*, are primitives offered by SuperCollider that generate and //! process audio and control signals. UGens are used in [synth definitions](crate::synthdef) as //! nodes in the signal graphs that eventually produce sound. pub mod envelope; use crate::synthdef::{DoneAction, Input, Rate, Scalar, SignalRange, UGenInput, UGenSpec, Value}; use crate::vectree::VecTree; use envelope::Env; macro_rules! ugen_rate_constructor { ( ar ) => { /// Create a UGen that calculates samples at audio rate. pub fn ar() -> Self { Self::new_with_rate(Rate::Audio) } }; ( ir ) => { /// Create a UGen that calculates samples at initialization only. pub fn ir() -> Self { Self::new_with_rate(Rate::Scalar) } }; ( kr ) => { /// Create a UGen that calculates samples at control rate. pub fn kr() -> Self { Self::new_with_rate(Rate::Control) } }; } macro_rules! ugen_set_value { ( $spec:ident, $ugen:ident, multi, $input:ident ) => { $spec = $spec.input(UGenInput::Multi($ugen.$input)); }; ( $spec:ident, $ugen:ident, $t:ty, $input:ident ) => { $spec = $spec.input(UGenInput::Simple($ugen.$input)); }; } macro_rules! ugen_set_option { ( $spec:ident, $ugen:ident, num_outputs, $count:expr) => { $spec = $spec.outputs(vec![$ugen.rate; $count]); }; ( $spec:ident, $ugen:ident, special_index, $index:expr) => { $spec = $spec.special_index($index); }; ( $spec:ident, $ugen:ident, signal_range, $signal_range:expr) => { $spec = $spec.signal_range($signal_range); }; } macro_rules! ugen { ( $(#[$struct_meta:meta])* $name:ident[ $( $rate:ident ),* ] { inputs: $inputs:tt } ) => { ugen! { $(#[$struct_meta])* $name[ $( $rate ),* ] { inputs: $inputs, options: {} } } }; ( $(#[$struct_meta:meta])* $name:ident[ $( $rate:ident ),* ] { inputs: { $( $(#[$input_meta:meta])* $input:ident: $type:tt = $default_value:expr ),* }, options: { $( $option:ident: $option_value:expr ),* } } ) => { $(#[$struct_meta])* #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct $name { rate: Rate, $( $input: Value, )* } impl $name { fn new_with_rate(rate: Rate) -> Self { Self{ rate, $( $input: $default_value.into_value(), )* } } $( ugen_rate_constructor!($rate); )* $( $(#[$input_meta])* pub fn $input(mut self, value: impl Input) -> Self { self.$input = value.into_value(); self } )* } impl Input for $name { fn into_value(self) -> Value { let mut _spec = UGenSpec::new(stringify!($name), self.rate); $( ugen_set_value!(_spec, self, $type, $input); )* $( ugen_set_option!(_spec, self, $option, $option_value); )* _spec.into_value() } } }; } macro_rules! value_setter { ( $(#[$meta:meta])* $field:ident ) => { $(#[$meta])* pub fn $field(mut self, value: impl Input) -> Self { self.$field = value.into_value(); self } }; } macro_rules! simple_setter { ( $(#[$meta:meta])* $field:ident: $type:ty ) => { $(#[$meta])* pub fn $field(mut self, value: $type) -> Self { self.$field = value; self } }; } ugen! { /// Two channel equal power pan. /// /// `Pan2` takes the square root of the linear scaling factor going from 1 (left or right) to /// `sqrt(0.5)` (~=0.707) in the center, which is about 3dB reduction. With linear panning /// [`LinPan2`] the signal is lowered as it approaches center using a straight line from 1 /// (left or right) to 0.5 (center) for a 6dB reduction in the middle. A problem inherent to /// linear panning is that the perceived volume of the signal drops in the middle. `Pan2` /// solves this. Pan2[ar, kr] { inputs: { /// The input signal. input: f32 = 0, /// Pan position, -1 is left, +1 is right. pos: f32 = 0, /// A control rate level input. level: f32 = 1 }, options: { num_outputs: 2 } } } ugen! { /// A stereo signal balancer. /// /// Equal power panning balances two channels. By panning from left (pos = -1) to right (pos = /// 1) you are decrementing the level of the left channel from 1 to 0 taking the square root of /// the linear scaling factor, while at the same time incrementing the level of the right /// channel from 0 to 1 using the same curve. In the center position (pos = 0) this results in /// a level for both channels of the square root of one half (~=0.707 or -3dB). The output of /// `Balance2` remains a stereo signal. Balance2[ar, kr] { inputs: { /// Channel 1 of input stereo signal. left: f32 = 0, /// Channel 2 of input stereo signal. right: f32 = 0, /// Pan position, `-1` is left, `+1` is right. pos: f32 = 0, /// A control rate level input. level: f32 = 1 }, options: { num_outputs: 2 } } } /// Bring signals and floats into the UGen graph of a SynthDef. /// /// A `Control` is a UGen that can be set and routed externally to interact with a running Synth. /// Typically, Controls are created from parameters in synth definitions. /// /// Generally you do not create Controls yourself. (See Arrays example below). /// /// The rate may be either `kr` (continuous control rate signal) or `ir` (a static value, set at /// the time the synth starts up, and subsequently unchangeable). For `ar`, see [`AudioControl::ar`]. /// /// Synth definitions create these automatically when encoding the UGen graph. They are created for /// you, you use them, and you don't really need to worry about them if you don't want to. // // For a more concise combination of name, default value and lag, see [NamedControl] // // TODO: port Control examples from SuperCollider docs #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct Control { rate: Rate, values: Vec<Value>, } impl Control { /// Create a UGen that calculates samples at control rate. pub fn kr<T: Input>(values: impl IntoIterator<Item = T>) -> Control { Control { rate: Rate::Control, values: values.into_iter().map(Input::into_value).collect(), } } /// Create a UGen that calculates samples at initialization only. pub fn ir<T: Input>(values: impl IntoIterator<Item = T>) -> Control { Control { rate: Rate::Scalar, values: values.into_iter().map(Input::into_value).collect(), } } } impl Input for Control { fn into_value(self) -> Value { UGenSpec::new("Control", self.rate) .inputs(self.values.into_iter().map(UGenInput::Simple)) .outputs(vec![Rate::Audio]) .into_value() } } ugen! { /// Band limited sawtooth wave generator. Saw[ar, kr] { inputs: { /// Frequency in hertz. freq: f32 = 440 } } } ugen! { /// A non-band-limited sawtooth oscillator. /// /// Output ranges from -1 to +1. LFSaw[ar, kr] { inputs: { /// Frequency in hertz. freq: f32 = 440, /// Initial phase offset. For efficiency reasons this is a value ranging from 0 to 2. initial_phase: f32 = 0.0 } } } ugen! { /// A resonant low pass filter. RLPF[ar, kr] { inputs: { /// The input signal. input: f32 = 0.0, /// Cutoff frequency in hertz. /// /// WARNING: due to the nature of its implementation frequency values close to 0 may /// cause glitches and/or extremely loud audio artifacts! freq: f32 = 440.0, /// The reciprocal of Q (bandwidth / cutoffFreq). rq: f32 = 1.0 } } } ugen! { /// Cursor tracking UGen. /// /// Tracks the x coordinate of the mouse position. MouseX[kr] { inputs: { /// Value corresponding to the left edge of the screen. minval: f32 = 0.0, /// Value corresponding to the right edge of the screen. maxval: f32 = 1.0, /// Mapping curve. 0 is linear, 1 is exponential (e. g. for frequency or times). /// Alternatively you can specify: [`MouseWarp::Linear`] or [`MouseWarp::Exponential`]. warp: f32 = 0.0, /// Lag factor to dezipper cursor movement. lag: f32 = 0.2 }, options: { signal_range: SignalRange::Unipolar } } } ugen! { /// Cursor tracking UGen. /// /// Tracks the x coordinate of the mouse position. MouseY[kr] { inputs: { /// Value corresponding to the left edge of the screen. minval: f32 = 0.0, /// Value corresponding to the right edge of the screen. maxval: f32 = 1.0, /// Mapping curve. 0 is linear, 1 is exponential (e. g. for frequency or times). /// Alternatively you can specify: [`MouseWarp::Linear`] or [`MouseWarp::Exponential`]. warp: f32 = 0.0, /// Lag factor to dezipper cursor movement. lag: f32 = 0.2 }, options: { signal_range: SignalRange::Unipolar } } } /// The warp value of the [`MouseX`] and [`MouseY`] UGens. pub enum MouseWarp { Linear = 0, Exponential = 1, } impl Input for MouseWarp { fn into_value(self) -> Value { (self as i16 as f32).into_value() } } ugen! { /// Comb delay line with no interpolation. /// /// See also [`CombLwhich`] uses linear interpolation, and [`CombC`] which uses cubic /// interpolation. Cubic and linear interpolation are more computationally expensive, but more /// accurate. /// /// This UGen will create aliasing artifacts if you modulate the delay time, which is also /// quantized to the nearest sample period. If these are undesirable properties, use `CombL` or /// `CombC`. But if your delay time is fixed and sub-sample accuracy is not needed, this is the /// most CPU-efficient choice with no loss in quality. /// /// The feedback coefficient is given by a mathmatical function that looks like this, where 0.001 is -60 dBFS: /// /// ``` /// fn feedback(delay: f32, decay: f32) -> f32 { /// let sign = if decay < 0.0 { /// -1.0 /// } else if decay > 0.0 { /// 1.0 /// } else { /// 0.0 /// }; /// 0.001f32.powf((delay / decay.abs()) * sign) /// } /// ``` CombN[ar, kr] { inputs: { /// The input signal. input: f32 = 0.0, /// The maximum delay time in seconds. Used to initialize the delay buffer size. /// /// Defaults to 0.2. max_delay_time: f32 = 0.2, /// Delay time in seconds. /// /// Defaults to 0.2. delay_time: f32 = 0.2, /// Time for the echoes to decay by 60 decibels. If this time is negative, then the /// feedback coefficient will be negative, thus emphasizing only odd harmonics at an /// octave lower. /// /// Large decay times are sensitive to DC bias, so use a [`LeakDC`] if this is an /// issue. /// /// Infinite decay times are permitted. A decay time of [`f32::INFINITY`] leads to a /// feedback coefficient of 1, and a decay time of `-f32::INFINITY` leads to a feedback /// coefficient of -1. /// /// Defaults to 1. decay_time: f32 = 1.0 } } } ugen! { /// A timed trigger. /// /// When a nonpositive to positive transition occurs at the input, `Trig` outputs the level of /// the triggering input for the specified duration, otherwise it outputs zero. Trig[ar, kr] { inputs: { /// The trigger, which can be any signal. A trigger happens when the signal changes /// from non-positive to positive. input: f32 = 0, /// Duration of the trigger output. duration: f32 = 0.1 }, options: { signal_range: SignalRange::Unipolar } } } ugen! { /// Impulse oscillator. /// /// Outputs non-bandlimited single sample impulses. An `Impulse` with frequency `0` returns a /// single impulse. Impulse[ar, kr] { inputs: { /// The frequency in hertz. freq: i32 = 440, /// Phase offset in cycles, from `0` to `1`. phase: f32 = 0 }, options: { signal_range: SignalRange::Unipolar } } } ugen! { /// Interpolating sine wavetable oscillator. /// /// Generates a sine wave. Uses a wavetable lookup oscillator with linear interpolation. /// Frequency and phase modulation are provided for audio-rate modulation. Technically, /// `SinOsc` uses the same implementation as [`Osc`] except that its table is fixed to be a /// sine wave made of 8192 samples. /// /// # Other Sinewave Oscillators /// /// * [`FSinOsc`] – fast sinewave oscillator /// * [`SinOscFB`] – sinewave with phase feedback /// * [`PMOsc`] – phase modulation sine oscillator /// * [`Klang`] – bank of sinewave oscillators /// * [`DynKlang`] – modulable bank of sinewave oscillators SinOsc[ar, kr] { inputs: { /// Frequency in hertz. Sampled at audio-rate. freq: f32 = 440, /// Phase in radians. Sampled at audio-rate. /// /// **Note**: phase values should be within the range +-8pi. If your phase values are /// larger then simply use [`.modulo()`](crate::synthdef::Input::modulo) with /// [`TAU`](std::f32::consts::TAU) to wrap them. phase: f32 = 0 } } } /// Phase modulation oscillator pair. #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct PMOsc { sin_osc: fn() -> SinOsc, carfreq: Value, modfreq: Value, pmindex: Value, modphase: Value, } impl PMOsc { /// Create a UGen that calculates samples at audio rate. pub fn ar() -> PMOsc { PMOsc::new(SinOsc::ar) } /// Create a UGen that calculates samples at control rate. pub fn kr() -> PMOsc { PMOsc::new(SinOsc::kr) } fn new(sin_osc: fn() -> SinOsc) -> PMOsc { PMOsc { sin_osc, carfreq: 440.0.into_value(), modfreq: 440.0.into_value(), pmindex: 0.0.into_value(), modphase: 0.0.into_value(), } } value_setter! { /// Carrier frequency in cycles per second. /// /// Defaults to `440.0`. carfreq } value_setter! { /// Modulator frequency in cycles per second. /// /// Defaults to `440.0`. modfreq } value_setter! { /// Modulation index in radians. /// /// Defaults to `0.0`. pmindex } value_setter! { /// A modulation input for the modulator's phase in radians. /// /// Defaults to `0.0`. modphase } } impl Input for PMOsc { fn into_value(self) -> Value { let mod_signal = (self.sin_osc)() .freq(self.modfreq) .phase(self.modphase) .mul(self.pmindex); (self.sin_osc)() .freq(self.carfreq) .phase(mod_signal) .into_value() } } ugen! { /// Write a signal to a bus. // // TODO: add a bus type // // Note that using the Bus class to allocate a multichannel bus simply reserves a series of // adjacent bus indices with the Server object's bus allocators. abus.index simply returns the // first of those indices. When using a Bus with an In or Out UGen there is nothing to stop // you from reading to or writing from a larger range, or from hardcoding to a bus that has // been allocated. You are responsible for making sure that the number of channels match and // that there are no conflicts. /// /// **Note**: Out is subject to control rate jitter. Where sample accurate output is needed, /// use [`OffsetOut`]. /// /// See the [Server Architecture] and [Bus] SuperCollider helpfiles for more information on /// buses and how they are used. /// /// [Server Architecture]: https://doc.sccode.org/Reference/Server-Architecture.html /// [Bus]: https://doc.sccode.org/Classes/Bus.html Out[ar, kr] { inputs: { /// The index of the bus to write out to. The lowest numbers are written to the audio /// hardware. bus: f32 = 0, /// A list of channels or single output to write out. You cannot change the size of /// this once a synth definition has been built. channels: multi = 0 }, options: { num_outputs: 0 } } } ugen! { /// Write a signal to a bus with sample accurate timing. /// /// Output signal to a bus, the sample offset within the bus is kept exactly; i.e. if the synth /// is scheduled to be started part way through a control cycle, `OffsetOut` will maintain the /// correct offset by buffering the output and delaying it until the exact time that the synth /// was scheduled for. /// /// **Note**: If you have an input to the synth, it will be coming in and its normal time, then /// mixed in your synth, and then delayed with the output. So you shouldn't use OffsetOut for /// effects or gating. /// /// See the [Server Architecture] and [Bus] SuperCollider helpfiles for more information on /// buses and how they are used. /// /// [Server Architecture]: https://doc.sccode.org/Reference/Server-Architecture.html /// [Bus]: https://doc.sccode.org/Classes/Bus.html OffsetOut[ar, kr] { inputs: { /// The index of the bus to write out to. The lowest numbers are written to the audio /// hardware. bus: f32 = 0, /// A list of channels or single output to write out. You cannot change the size of /// this once a synth definition has been built. channels: multi = 0 }, options: { num_outputs: 0 } } } ugen! { /// Record to a soundfile to disk. Uses a Buffer. /// /// Returns the number of frames written to disk. See [`RecordBuf`] for recording into a buffer /// in memory. /// /// # Disk recording procedure: /// /// Recording to disk involves several steps, which should be taken in the right order. To /// record buses using DiskOut, make sure to do the following: /// /// 1. Define a DiskOut SynthDef, as shown in the example below. /// 2. Allocate a buffer using [`BufferAllocate`](crate::server::BufferAllocate) for recording. /// * The buffer size should be a power of two. /// * A duration of at least one second is recommended. /// * Do not allocate the buffer inside the SynthDef. /// /// 3. Specify the file path and recording format using /// [`BufferWrite`](crate::server::BufferWrite) with the /// [`leave_file_open()`](crate::server::BufferWrite::leave_file_open) flag enabled. /// This is the only way to set the file path and recording format. /// 4. Create a synth node to run the DiskOut UGen with [`SynthNew`](crate::server::SynthNew). /// 5. When recording is finished, stop the `DiskOut` synth. /// 6. Close the buffer with [`BufferClose`](crate::server::BufferClose). This step updates the /// recorded file's audio header. Without it, the file will be unusable. /// 7. Free the buffer with [`BufferFree`](crate::server::BufferFree). /// /// These steps are illustrated in the Examples section. /// /// # Examples /// /// ```no_run /// use sorceress::{ /// server::{self, Control, Server}, /// synthdef::{encoder::encode_synth_defs, Input, SynthDef}, /// ugen, /// }; /// use std::{thread, time::Duration}; /// /// # fn main() -> sorceress::server::Result<()> { /// // Declared here because we refer to it multiple times. /// let buffer_number = 0; /// /// // Connect to a running SuperCollider server. /// let server = Server::connect("127.0.0.1:57110")?; /// /// // This generates an interesting sound. /// let bubbles = SynthDef::new("bubbles", |_| { /// let glissando_function = ugen::LFSaw::kr() /// .freq(0.4) /// .madd(24, ugen::LFSaw::kr().freq(vec![8.0, 7.23]).madd(3, 80)) /// .midicps(); /// let echoing_sine_wave = ugen::CombN::ar() /// .input(ugen::SinOsc::ar().freq(glissando_function).mul(0.04)) /// .decay_time(4); /// ugen::Out::ar().bus(0).channels(echoing_sine_wave) /// }); /// /// // This will record the audio signal to disk. /// let diskout = SynthDef::new("diskout", |_| { /// ugen::DiskOut::ar() /// .bufnum(buffer_number) /// .channels(ugen::In::ar().bus(0).number_of_channels(2)) /// }); /// /// // Send the synth definitions to the server. /// let encoded_synthdef = encode_synth_defs(vec![bubbles, diskout]); /// server.send_sync(server::SynthDefRecv::new(&encoded_synthdef))?; /// /// // Start something to record. /// let source_synth_id = 2003i32; /// server.send(server::SynthNew::new("bubbles", 1).synth_id(source_synth_id))?; /// /// // Allocate a buffer for disk I/O. /// server.send_sync(server::BufferAllocate::new(buffer_number, 65536).number_of_channels(2))?; /// /// // Create an output file for this buffer and leave it open. /// server.send_sync( /// server::BufferWrite::new( /// buffer_number, /// "diskout-test.aiff", /// server::HeaderFormat::Aiff, /// server::SampleFormat::Int16, /// ) /// .number_of_frames(0) /// .leave_file_open(), /// )?; /// /// // Create the DiskOut node. /// let recording_synth_id = 2004; /// server.send( /// server::SynthNew::new("diskout", source_synth_id) /// .controls(vec![Control::new("bufnum", buffer_number)]) /// .synth_id(recording_synth_id) /// .add_action(server::AddAction::AfterNode) /// )?; /// /// // Let it play for a while /// thread::sleep(Duration::from_secs(5)); /// /// // Stop recording. /// server.send(server::NodeFree::new(vec![recording_synth_id]))?; /// // Stop the audio source. /// server.send(server::NodeFree::new(vec![source_synth_id]))?; /// /// // Close the file and free the buffer's memory. /// server.send_sync(server::BufferClose::new(buffer_number))?; /// server.send_sync(server::BufferFree::new(buffer_number))?; /// # Ok(()) /// # } /// ``` DiskOut[ar] { inputs: { /// The number of the buffer to write to. /// /// The buffer must have been prepared to write to a file using /// [`BufferWrite`](crate::server::BufferWrite) with /// [`leave_file_open`](crate::server::BufferWrite::leave_file_open) enabled. bufnum: f32 = 0, /// A list of channels to write to the file. channels: multi = 0 }, options: { num_outputs: 1 } } } ugen! { /// Number of output buses. NumOutputBuses[ir] { inputs: {}, options: { num_outputs: 1 } } } /// Read signals from an audio or control bus. /// /// [`In::ar`] and [`In::kr`] read signals from audio and control buses, respectively. (See the /// [Buses] chapter of the [Getting Started] tutorial series for details on buses.) /// /// `In::ar` and `In::kr` behave slightly differently with respect to signals left on the bus in /// the previous calculation cycle. /// /// `In::ar` can access audio signals that were generated in the current calculation cycle by Synth /// nodes located earlier in the node tree (see [Order of execution]). It does not read signals /// left on an audio bus from the previous calculation cycle. If synth A reads from audio bus 0 and /// synth B writes to audio bus 0, and synth A is earlier than synth B, In.ar in synth A will read /// 0's (silence). This is to prevent accidental feedback. [`InFeedback`] supports audio signal /// feedback. /// /// `In::kr` is for control buses. Control signals may be generated by Synth nodes within the /// server, or they may be set by the client and expected to hold steady. Therefore, `In::kr` does /// not distinguish between "new" and "old" data: it will always read the current value on the bus, /// whether it was generated earlier in this calculation cycle, left over from the last one, or set /// by the client. /// // TODO: figure how we want to manage buses and recommend it here // // Note that using the Bus class to allocate a multichannel bus simply reserves a series of // adjacent bus indices with the Server object's bus allocators. abus.index simply returns the // first of those indices. // // When using a bus with an `In` or [`Out`] UGen there is nothing to stop you from reading to or // writing from a larger range, or from hardcoding to a bus that has been allocated. You are // responsible for making sure that the number of channels match and that there are no conflicts. // See the [Server Architecture] and Bus helpfiles for more information on buses and how they are // used. // /// The hardware input buses begin just after the hardware output buses and can be read from using /// `In::ar` (See [Server Architecture] for more details). The number of hardware input and output /// buses can vary depending on your Server's options. For a convenient wrapper class which deals /// with this issue see [`SoundIn`]. /// /// [Buses]: https://doc.sccode.org/Tutorials/Getting-Started/11-Buses.html /// [Getting Started]: https://doc.sccode.org/Tutorials/Getting-Started/00-Getting-Started-With-SC.html /// [Order of execution]: https://doc.sccode.org/Guides/Order-of-execution.html /// [Server Architecture]: https://doc.sccode.org/Reference/Server-Architecture.html #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct In { rate: Rate, bus: Value, number_of_channels: usize, } impl In { /// Create a UGen that calculates samples at audio rate. pub fn ar() -> In { In::new(Rate::Audio) } /// Create a UGen that calculates samples at control rate. pub fn kr() -> In { In::new(Rate::Control) } fn new(rate: Rate) -> In { In { rate, bus: 0.into_value(), number_of_channels: 1, } } value_setter! { /// The index of the bus to read in from. bus } simple_setter! { /// The number of channels (i.e. adjacent buses) to read in. /// /// You cannot modulate this number by assigning it to an parameter in a synth definition. /// Defaults to 1. number_of_channels: usize } } impl Input for In { fn into_value(self) -> Value { UGenSpec::new("In", self.rate) .inputs(vec![UGenInput::Simple(self.bus)]) .outputs(vec![self.rate; self.number_of_channels]) .into_value() } } /// An envelope generator. /// /// Plays back break point envelopes. The envelopes are instances of the Env class. The envelope /// and the arguments for levelScale, levelBias, and timeScale are polled when the EnvGen is /// triggered and remain constant for the duration of the envelope. #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct EnvGen { rate: Rate, envelope: Env, gate: Value, level_scale: Value, level_bias: Value, time_scale: Value, done_action: DoneAction, } impl EnvGen { /// Create a UGen that calculates samples at audio rate. pub fn ar() -> EnvGen { EnvGen::new(Rate::Audio) } /// Create a UGen that calculates samples at control rate. pub fn kr() -> EnvGen { EnvGen::new(Rate::Control) } fn new(rate: Rate) -> EnvGen { EnvGen { rate, envelope: Env::default(), gate: 1.into_value(), level_scale: 1.into_value(), level_bias: 0.into_value(), time_scale: 1.into_value(), done_action: DoneAction::None, } } /// An Envelope value, or an Array of Controls. // (See Control and the example below for how to use this.) /// /// The envelope is polled when the `EnvGen` is triggered. The Envelope inputs can be other /// UGens. pub fn envelope(mut self, envelope: Env) -> EnvGen { self.envelope = envelope; self } value_setter! { /// Triggers the envelope and holds it open while > 0. /// /// If the [`Env`](envelope::Env) is fixed-length (e.g. /// [`Env:linen`](envelope::Env:linen), [`Env::perc`](envelope::Env::perc)), the `gate` /// argument is used as a simple trigger. If it is an sustaining envelope (e.g. /// [`Env::adsr`](envelope::Env::adsr), [`Env::asr`](envelope::Env::asr)), the envelope is /// held open until the gate becomes 0, at which point is released. /// /// If `gate` < 0, force release with time -1.0 - gate. See Forced release below. gate } value_setter! { /// The levels of the breakpoints are multiplied by this value /// /// This value can be modulated, but is only sampled at the start of a new envelope /// segment. level_scale } value_setter! { /// This value is added as an offset to the levels of the breakpoints. /// /// This value can be modulated, but is only sampled at the start of a new envelope /// segment. level_bias } value_setter! { /// The durations of the segments are multiplied by this value. /// /// This value can be modulated, but is only sampled at the start of a new envelope /// segment. time_scale } simple_setter! { /// An action to be executed when the env is finished playing. /// /// This can be used to free the enclosing synth, etc. See [`DoneAction`] for more detail. done_action: DoneAction } } impl Input for EnvGen { fn into_value(self) -> Value { UGenSpec::new("EnvGen", self.rate) .inputs(vec![ UGenInput::Simple(self.gate), UGenInput::Simple(self.level_scale), UGenInput::Simple(self.level_bias), UGenInput::Simple(self.time_scale), UGenInput::Simple(self.done_action.into_value()), ]) .inputs( self.envelope .into_values() .into_iter() .map(UGenInput::Simple), ) .into_value() } } /// Sample playback oscillator. /// /// Plays back a sample resident in memory. /// /// # Required Arguments /// /// * `number_of_channels` - Number of channels that the buffer will be. This must be a fixed /// integer. The architecture of the synth definition cannot change after it is compiled. #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct PlayBuf { ugen_rate: Rate, number_of_channels: usize, bufnum: Value, rate: Value, trigger: Value, start_pos: Value, loop_buffer: Value, done_action: DoneAction, } impl PlayBuf { /// Create a UGen that calculates samples at audio rate. pub fn ar(number_of_channels: usize) -> PlayBuf { PlayBuf::new(number_of_channels, Rate::Audio) } /// Create a UGen that calculates samples at control rate. pub fn kr(number_of_channels: usize) -> PlayBuf { PlayBuf::new(number_of_channels, Rate::Control) } fn new(number_of_channels: usize, rate: Rate) -> PlayBuf { PlayBuf { ugen_rate: rate, number_of_channels, bufnum: 0.0.into_value(), rate: 1.0.into_value(), trigger: 1.0.into_value(), start_pos: 0.0.into_value(), loop_buffer: 0.0.into_value(), done_action: DoneAction::None, } } value_setter! { /// The index of the buffer to use. /// /// **Note**: If you supply a buffer number of a buffer with a differing number of channels /// than the one specified in this [`PlayBuf`], it will post a warning and output the /// channels it can. bufnum } value_setter! { /// 1.0 is the server's sample rate, 2.0 is one octave up, 0.5 is one octave down -1.0 is /// backwards normal rate… etc. Interpolation is cubic. rate } value_setter! { /// A trigger causes a jump to the [`start_pos`](PlayBuf::start_pos). A trigger occurs when /// a signal changes from negative value to positive value. trigger } value_setter! { /// Sample frame to start playback. start_pos } value_setter! { /// 1 means true, 0 means false. This is modulateable. loop_buffer } simple_setter! { /// An integer representing an action to be executed when the buffer is finished playing. /// This can be used to free the enclosing synth, etc. See [`Done`] for more detail. /// `done_action` is only evaluated if loop is 0. done_action: DoneAction } } impl Input for PlayBuf { fn into_value(self) -> Value { UGenSpec::new("PlayBuf", self.ugen_rate) .inputs(vec![ UGenInput::Simple(self.bufnum), UGenInput::Simple(self.rate), UGenInput::Simple(self.trigger), UGenInput::Simple(self.start_pos), UGenInput::Simple(self.loop_buffer), UGenInput::Simple(self.done_action.into_value()), ]) .outputs(vec![self.ugen_rate; self.number_of_channels]) .into_value() } } /// Read audio from a system audio device. /// /// `SoundIn` is a convenience UGen to read audio from the input of your computer or soundcard. It /// is a wrapper UGen based on [`In`], which offsets the index such that `0` will always correspond /// to the first input regardless of the number of inputs present. #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct SoundIn { bus: Value, } impl SoundIn { /// Create a UGen that calculates samples at audio rate. pub fn ar() -> Self { Self { bus: 0.into_value(), } } value_setter! { /// The channel (or array of channels) to read in. These start at `0`, which will /// correspond to the first audio input. bus } } impl Input for SoundIn { fn into_value(self) -> Value { let channel_offest = NumOutputBuses::ir(); match self.bus.0 { VecTree::Leaf(_) => In::ar() .bus(channel_offest.add(self.bus)) .number_of_channels(1) .into_value(), VecTree::Branch(ref buses) => { let number_of_channels = buses.len(); let is_consecutive = buses .iter() .map(|bus| match bus { VecTree::Leaf(Scalar::Const(x)) => Some(*x), _ => None, }) .collect::<Option<Vec<f32>>>() .and_then(|bus_numbers| { let start = *bus_numbers.first()? as usize; // replace with SuperCollider's probably more space efficient implementation let is_consecutive = bus_numbers == (start..(start + bus_numbers.len())) .into_iter() .map(|x| x as f32) .collect::<Vec<_>>(); Some(is_consecutive) }) .unwrap_or(false); let first_bus = Value( buses .first() .expect("TODO: we check for the head twice, we could probably do better") .clone(), ); if is_consecutive { In::ar() .bus(channel_offest.add(first_bus)) .number_of_channels(number_of_channels) .into_value() } else { In::ar() .bus(channel_offest.add(self.bus)) .number_of_channels(1) .into_value() } } } } } /// Continuously play a longer sound file from disk. /// /// This requires a buffer to be preloaded with one buffer size of sound. #[derive(Debug, Clone, PartialEq, PartialOrd)] pub struct DiskIn { number_of_channels: usize, buffer_number: Value, loop_buffer: Value, } impl DiskIn { /// Create a UGen that calculates samples at audio rate. /// /// # Arguments /// /// * `number_of_channels` - The number of channels. This must match the number of channels in /// the buffer. /// * `buffer_number` - The number of the buffer to use when playing the file. pub fn ar(number_of_channels: usize, buffer_number: impl Input) -> Self { Self { number_of_channels, buffer_number: buffer_number.into_value(), loop_buffer: 0.into_value(), } } value_setter! { /// Set to `1` to loop the sound file. loop_buffer } } impl Input for DiskIn { fn into_value(self) -> Value { UGenSpec::new("DiskIn", Rate::Audio) .inputs(vec![ UGenInput::Simple(self.buffer_number), UGenInput::Simple(self.loop_buffer), ]) .outputs(vec![Rate::Audio; self.number_of_channels]) .into_value() } }