de.sciss.fscape.graph.Metro.scala Maven / Gradle / Ivy

Go to download
/*
 *  Metro.scala
 *  (FScape)
 *
 *  Copyright (c) 2001-2016 Hanns Holger Rutz. All rights reserved.
 *
 *  This software is published under the GNU General Public License v2+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.fscape
package graph

import de.sciss.fscape.stream.{StreamIn, StreamOut}

import scala.collection.immutable.{IndexedSeq => Vec}

/** Metronome (repeated dirac) generator.
  * For a single impulse that is never repeated,
  * use a period of zero. Unlike `Impulse` which
  * uses a frequency and generates fractional phases
  * prone to floating point noise, this is UGen is
  * useful for exact sample frame spacing. Unlike `Impulse`,
  * the phase cannot be modulated.
  *
  * @param period number of frames between impulses. Zero is short-hand
  *               for `Long.MaxValue`
  * @param phase  phase offset in frames. Initialization time only!
  */
final case class Metro(period: GE, phase: GE = 0L) extends UGenSource.SingleOut {
  protected def makeUGens(implicit b: UGenGraph.Builder): UGenInLike =
    unwrap(Vector(period.expand, phase.expand))

  protected def makeUGen(args: Vec[UGenIn])(implicit b: UGenGraph.Builder): UGenInLike =
    UGen.SingleOut(this, args)

  private[fscape] def makeStream(args: Vec[StreamIn])(implicit b: stream.Builder): StreamOut = {
    val Vec(period, phase) = args
    stream.Metro(period = period.toLong, phase = phase.toLong)
  }
}