graph_node.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2021 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
/*
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * ---
 *
 * Copyright (C) 2017, 2019 Robin Gareus <robin@gareus.org>
 *
 * 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 2 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/>.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * ---
 */
 
#ifndef __AUDIO_GRAPH_NODE_H__
#define __AUDIO_GRAPH_NODE_H__
 
#include "utils/types.h"
 
#include "gtk_wrapper.h"
 
TYPEDEF_STRUCT (GraphNode);
TYPEDEF_STRUCT (Graph);
TYPEDEF_STRUCT (PassthroughProcessor);
TYPEDEF_STRUCT (Port);
TYPEDEF_STRUCT (Fader);
TYPEDEF_STRUCT (Track);
TYPEDEF_STRUCT (SampleProcessor);
TYPEDEF_STRUCT (Plugin);
TYPEDEF_STRUCT (HardwareProcessor);
TYPEDEF_STRUCT (ModulatorMacroProcessor);
TYPEDEF_STRUCT (EngineProcessTimeInfo);
TYPEDEF_STRUCT (ChannelSend);
 
enum class GraphNodeType
{
  ROUTE_NODE_TYPE_PORT,
  ROUTE_NODE_TYPE_PLUGIN,
  ROUTE_NODE_TYPE_TRACK,
  ROUTE_NODE_TYPE_FADER,
  ROUTE_NODE_TYPE_MONITOR_FADER,
  ROUTE_NODE_TYPE_PREFADER,
  ROUTE_NODE_TYPE_SAMPLE_PROCESSOR,
 
  ROUTE_NODE_TYPE_INITIAL_PROCESSOR,
 
  ROUTE_NODE_TYPE_HW_PROCESSOR,
 
  ROUTE_NODE_TYPE_MODULATOR_MACRO_PROCESOR,
 
  ROUTE_NODE_TYPE_CHANNEL_SEND,
};
 
typedef struct GraphNode
{
  int id;
  Graph * graph;
 
  GraphNode ** childnodes;
  int          n_childnodes;
 
  gint refcount;
 
  gint init_refcount;
 
  GraphNode ** parentnodes;
 
  Port * port;
 
  Plugin * pl;
 
  Fader * fader;
 
  Track * track;
 
  Fader * prefader;
 
  SampleProcessor * sample_processor;
 
  HardwareProcessor * hw_processor;
 
  ModulatorMacroProcessor * modulator_macro_processor;
 
  ChannelSend * send;
 
  bool terminal;
  bool initial;
 
  nframes_t playback_latency;
 
  nframes_t route_playback_latency;
 
  GraphNodeType type;
} GraphNode;
 
char *
graph_node_get_name (GraphNode * node);
 
void *
graph_node_get_pointer (GraphNode * self);
 
void
graph_node_print_to_str (GraphNode * node, char * buf, size_t buf_sz);
 
void
graph_node_print (GraphNode * node);
 
HOT void
graph_node_process (GraphNode * node, EngineProcessTimeInfo time_nfo);
 
HOT nframes_t
graph_node_get_single_playback_latency (GraphNode * node);
 
void
graph_node_set_route_playback_latency (GraphNode * node, nframes_t dest_latency);
 
HOT void
graph_node_trigger (GraphNode * self);
 
void
graph_node_connect (GraphNode * from, GraphNode * to);
 
GraphNode *
graph_node_new (Graph * graph, GraphNodeType type, void * data);
 
void
graph_node_free (GraphNode * node);
 
#endif