de.sciss.lucre.synth.Synth.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lucresynth_2.11 Show documentation
Transactional extension for ScalaCollider
There is a newer version: 3.30.0
/*
 *  Synth.scala
 *  (SoundProcesses)
 *
 *  Copyright (c) 2010-2019 Hanns Holger Rutz. All rights reserved.
 *
 *	This software is published under the GNU Lesser General Public License v2.1+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.lucre
package synth

import collection.immutable.{Seq => ISeq}
import de.sciss.synth.{Synth => SSynth, SynthDef => SSynthDef, UGenGraph, addToHead, AddAction, ControlSet, SynthGraph}
import impl.{SynthImpl => Impl}

object Synth {
  def apply(server: Server, graph: SynthGraph, nameHint: Option[String] = None)(implicit tx: Txn): Synth = {
    val ugenGraph = graph.expand(de.sciss.synth.impl.DefaultUGenGraphBuilderFactory)
    val df        = server.acquireSynthDef(ugenGraph, nameHint)
    val res       = create(df)
    // releaseDefOnEnd(res)
    res
  }

//  private def releaseDefOnEnd(x: Synth)(implicit tx: Txn): Unit =
//    x.onEndTxn { implicit tx =>
//      NodeGraph.releaseSynthDef(x.definition)
//    }

  def play(graph: SynthGraph, nameHint: Option[String] = None)
          (target: Node, args: ISeq[ControlSet] = Nil, addAction: AddAction = addToHead,
            dependencies: List[Resource] = Nil)(implicit tx: Txn): Synth = {
    val res = apply(target.server, graph, nameHint)
    res.play(target, args, addAction, dependencies)
    res
  }

  /** Like `play` but does not memoize synth def. */
  def playOnce(graph: SynthGraph, nameHint: Option[String] = None)
          (target: Node, args: ISeq[ControlSet] = Nil, addAction: AddAction = addToHead,
           dependencies: List[Resource] = Nil)(implicit tx: Txn): Synth = {

    // XXX TODO - DRY - NodeGraphImpl
    val server  = target.server
    val name    = server.mkSynthDefName(nameHint)
    val uGraph  = graph.expand(de.sciss.synth.impl.DefaultUGenGraphBuilderFactory)
    val peer    = SSynthDef(name, uGraph)
    val rd      = impl.SynthDefImpl(server, peer) // (bytes)
    rd.recv()

    val res = create(rd)
    res.play(target, args, addAction, dependencies)

    rd.dispose()  // free it immediately

    res
  }

  def expanded(server: Server, graph: UGenGraph, nameHint: Option[String] = None)(implicit tx: Txn): Synth = {
    val df = server.acquireSynthDef(graph, nameHint)
    val res = create(df)
    res
  }

  private def create(df: SynthDef)(implicit tx: Txn): Synth = {
    val server  = df.server
    val nodeId  = server.nextNodeId()
    Impl(SSynth(server.peer, nodeId), df)
  }
}

trait Synth extends Node {
  def peer: SSynth

  def definition: SynthDef
}