Graph (Pipes Graph 2.0.0-beta-1 API)

java.lang.Object
- org.jaudiolibs.pipes.graph.Graph

```
public abstract class Graph
extends Object
```
A base audio graph class that replicates the audio API and UGen support inside PraxisLIVE's audio nodes.#
Unless specifically noted, methods in this class are not thread-safe, and should only be called on the audio thread.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Graph.Dependent` An interface for types that can be attached to a Graph and will be called before every new buffer is processed.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Graph()` Base Graph constructor for graph with default 2 channels of audio input and output.
`protected`	`Graph(int inputCount, int outputCount)` Base Graph constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Add`	`add()` Create an `Add` Pipe.
`protected Add`	`add(Pipe... ugens)` Create an `Add` Pipe, and add the provided Pipes as inputs to it.
`protected void`	`addDependent(Graph.Dependent dependent)` Add a `Graph.Dependent` to the graph.
`int`	`blockSize()` Query the audio block size / size of each processed buffer.
`protected Fn`	`fn(DoubleUnaryOperator function)` Create a `Fn` Pipe that applies the given operation to every sample.
`protected Pipe`	`in(int index)` Access the Pipe for the specified input channel.
`protected abstract void`	`init()` Method called to initialize the audio graph.
`void`	`invokeLater(Runnable task)` Add a task to be run on the audio thread before the next buffer is processed.
`protected Pipe`	`link(Pipe... ugens)` Link the provided list of units (Pipes) together.
`protected double`	`midiToFrequency(int midi)` Convert the given MIDI note number into its frequency in Hz.
`long`	`millis()` Query the time in milliseconds, based on the sample playback clock.
`protected Mod`	`mod()` Create a `Mod` pipe.
`protected Mod`	`mod(Pipe... ugens)` Create a `Mod` pipe, and add the provided Pipes as inputs to it.
`protected Mod`	`modFn(DoubleBinaryOperator function)` Create a `Mod` pipe that combines its inputs by applying the provided function to each sample.
`protected Mod`	`modFn(Pipe pipe, DoubleBinaryOperator function)` Create a `Mod` pipe that combines its inputs by applying the provided function to each sample.
`long`	`nanos()` Query the time in nanoseconds, based on the sample playback clock.
`protected double`	`noteToFrequency(String note)` Convert the given note expressed as a String (eg.
`protected int`	`noteToMidi(String note)` Convert the given note expressed as a String (eg.
`protected Pipe`	`out(int index)` Access the Pipe for the specified output channel.
`long`	`position()` Query the position in samples.
`protected void`	`removeDependent(Graph.Dependent dependent)` Remove a `Graph.Dependent` from the graph.
`double`	`sampleRate()` Query the sample rate in Hz.
`ScheduledExecutorService`	`scheduler()` Get a `ScheduledExecutorService` for running tasks on the audio thread.
`protected double`	`tabread(AudioTable table, double position)` Read from the first channel of the given `AudioTable` using a normalized position (0 ..
`protected Tee`	`tee()` Create a `Tee` pipe that can split its input to multiple outputs.
`protected void`	`update()` Optional update hook called before every buffer is processed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Graph
```
protected Graph()
```
    Base Graph constructor for graph with default 2 channels of audio input and output.
  - Graph
```
protected Graph(int inputCount,
                int outputCount)
```
    Base Graph constructor.
    
    Parameters:
    
    inputCount - number of input channels (can be zero)
    
    outputCount - number of output channels
- Method Detail
  - init
```
protected abstract void init()
```
    Method called to initialize the audio graph.
  - update
```
protected void update()
```
    Optional update hook called before every buffer is processed.
  - position
```
public long position()
```
    Query the position in samples.
    
    Returns:
    
    position in samples
  - blockSize
```
public int blockSize()
```
    Query the audio block size / size of each processed buffer.
    
    Returns:
    
    block size
  - sampleRate
```
public double sampleRate()
```
    Query the sample rate in Hz.
    
    Returns:
    
    sample rate
  - millis
```
public long millis()
```
    Query the time in milliseconds, based on the sample playback clock.
    
    Returns:
    
    time in milliseconds
  - nanos
```
public long nanos()
```
    Query the time in nanoseconds, based on the sample playback clock.
    
    Returns:
    
    time in nanoseconds
  - invokeLater
```
public void invokeLater(Runnable task)
```
    Add a task to be run on the audio thread before the next buffer is processed. This method is safe to call from another thread.
    
    Parameters:
    
    task - task to run
  - scheduler
```
public ScheduledExecutorService scheduler()
```
    Get a ScheduledExecutorService for running tasks on the audio thread. This method is safe to call from another thread. The scheduler cannot be terminated and will throw an exception if attempting to shutdown or await termination.
    
    Returns:
    
    executor service
  - addDependent
```
protected void addDependent(Graph.Dependent dependent)
```
    Add a Graph.Dependent to the graph.
    
    Parameters:
    
    dependent - dependent to add
  - removeDependent
```
protected void removeDependent(Graph.Dependent dependent)
```
    Remove a Graph.Dependent from the graph.
    
    Parameters:
    
    dependent - dependent to remove
  - in
```
protected final Pipe in(int index)
```
    Access the Pipe for the specified input channel.
    
    Parameters:
    
    index - input channel
    
    Returns:
    
    input Pipe
  - out
```
protected final Pipe out(int index)
```
    Access the Pipe for the specified output channel.
    
    Parameters:
    
    index - output channel
    
    Returns:
    
    output Pipe
  - link
```
protected final Pipe link(Pipe... ugens)
```
    Link the provided list of units (Pipes) together. The last provided Pipe is returned.
    
    Parameters:
    
    ugens - list of Pipes to connect
    
    Returns:
    
    last Pipe
  - add
```
protected final Add add()
```
    Create an Add Pipe. This unit type can add together multiple inputs.
    
    Returns:
    
    add pipe
  - add
```
protected final Add add(Pipe... ugens)
```
    Create an Add Pipe, and add the provided Pipes as inputs to it. This unit type can add together multiple inputs. Additional inputs may be added later.
    
    Parameters:
    
    ugens - list of Pipes to add
    
    Returns:
    
    add pipe
  - mod
```
protected final Mod mod()
```
    Create a Mod pipe. The Mod pipe accepts multiple inputs and an optional function to combine them. The default function is to multiply samples together.
    
    Returns:
    
    mod pipe
  - mod
```
protected final Mod mod(Pipe... ugens)
```
    Create a Mod pipe, and add the provided Pipes as inputs to it. The Mod pipe accepts multiple inputs and an optional function to combine them. The default function is to multiply samples together.
    
    Returns:
    
    mod pipe
  - modFn
```
protected final Mod modFn(DoubleBinaryOperator function)
```
    Create a Mod pipe that combines its inputs by applying the provided function to each sample.
    
    Parameters:
    
    function - operation to apply to each sample
    
    Returns:
    
    mod pipe
  - modFn
```
protected final Mod modFn(Pipe pipe,
                          DoubleBinaryOperator function)
```
    Create a Mod pipe that combines its inputs by applying the provided function to each sample. The provided Pipe will be added as the first input.
    
    Parameters:
    
    pipe - input pipe
    
    function - operation to apply to each sample
    
    Returns:
    
    mod pipe
  - tee
```
protected final Tee tee()
```
    Create a Tee pipe that can split its input to multiple outputs. The input data is buffered, so the Tee may be connected to pipes that feed into its input. This will create a delay of one block size.
    
    Returns:
    
    tee pipe
  - fn
```
protected final Fn fn(DoubleUnaryOperator function)
```
    Create a Fn Pipe that applies the given operation to every sample.
    
    Parameters:
    
    function - operation to apply to each sample
    
    Returns:
    
    Fn pipe
  - noteToFrequency
```
protected final double noteToFrequency(String note)
```
    Convert the given note expressed as a String (eg. "a3", "C#5") into its frequency. An invalid note will return 0 (useful for eg. "X" for note off)
    
    Parameters:
    
    note - String representation of a note
    
    Returns:
    
    frequency in Hz
  - noteToMidi
```
protected final int noteToMidi(String note)
```
    Convert the given note expressed as a String (eg. "a3", "C#5") into its equivalent MIDI note. An invalid note will return -1 (useful for eg. "X" for note off)
    
    Parameters:
    
    note - String representation of a note
    
    Returns:
    
    MIDI note number
  - midiToFrequency
```
protected final double midiToFrequency(int midi)
```
    Convert the given MIDI note number into its frequency in Hz.
    
    Parameters:
    
    midi - note number
    
    Returns:
    
    frequency in Hz
  - tabread
```
protected double tabread(AudioTable table,
                         double position)
```
    Read from the first channel of the given AudioTable using a normalized position (0 .. 1). Out of range values or a null table will return silence. The returned sample is interpolated where required when the position is between sample points.
    
    Parameters:
    
    table - audio data to read from
    
    position - position normalized 0 .. 1
    
    Returns:
    
    sample from table

Class Graph

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Graph

Graph

Method Detail

init

update

position

blockSize

sampleRate

millis

nanos

invokeLater

scheduler

addDependent

removeDependent

in

out

link

add

add

mod

mod

modFn

modFn

tee

fn

noteToFrequency

noteToMidi

midiToFrequency

tabread