router.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/>.
 *
 * ---
 */
 
#ifndef __AUDIO_ROUTING_H__
#define __AUDIO_ROUTING_H__
 
#include "zrythm-config.h"
 
#ifdef HAVE_C11_THREADS
#  include <threads.h>
#endif
 
#include "dsp/engine.h"
#include "dsp/graph.h"
#include "dsp/graph_thread.h"
#include "utils/types.h"
 
#include <gtk/gtk.h>
 
#include "zix/ring.h"
#include "zix/sem.h"
#include <pthread.h>
 
typedef struct GraphNode             GraphNode;
typedef struct Graph                 Graph;
typedef struct PassthroughProcessor  PassthroughProcessor;
typedef struct MPMCQueue             MPMCQueue;
typedef struct Port                  Port;
typedef struct Fader                 Fader;
typedef struct Track                 Track;
typedef struct Plugin                Plugin;
typedef struct Position              Position;
typedef struct ControlPortChange     ControlPortChange;
typedef struct EngineProcessTimeInfo EngineProcessTimeInfo;
 
#ifdef HAVE_JACK
#  include "weak_libjack.h"
#endif
 
#define ROUTER (AUDIO_ENGINE->router)
 
typedef struct Router
{
  Graph * graph;
 
  int graph_setup_in_progress;
 
  EngineProcessTimeInfo time_nfo;
 
  nframes_t max_route_playback_latency;
 
  nframes_t global_offset;
 
  ZixSem graph_access;
 
  bool callback_in_progress;
 
  GThread * process_kickoff_thread;
 
  ZixRing * ctrl_port_change_queue;
 
} Router;
 
Router *
router_new (void);
 
void
router_recalc_graph (Router * self, bool soft);
 
void
router_start_cycle (Router * self, EngineProcessTimeInfo time_nfo);
 
nframes_t
router_get_max_route_playback_latency (Router * router);
 
WARN_UNUSED_RESULT HOT NONNULL
  ACCESS_READ_ONLY (1) static inline bool router_is_processing_kickoff_thread (
    const Router * const self)
{
  return g_thread_self () == self->process_kickoff_thread;
}
 
WARN_UNUSED_RESULT HOT NONNULL ACCESS_READ_ONLY (
  1) static inline bool router_is_processing_thread (const Router * const self)
{
#ifdef HAVE_C11_THREADS
  /* this is called too often so use this optimization */
  static thread_local bool have_result = false;
  static thread_local bool is_processing_thread = false;
#else
  bool have_result = false;
  bool is_processing_thread = false;
#endif
 
  if (G_LIKELY (have_result))
    {
      return is_processing_thread;
    }
 
  if (G_UNLIKELY (!self->graph))
    {
      have_result = false;
      is_processing_thread = false;
      return false;
    }
 
  for (int j = 0; j < self->graph->num_threads; j++)
    {
      if (pthread_equal (pthread_self (), self->graph->threads[j]->pthread))
        {
          is_processing_thread = true;
          have_result = true;
          return true;
        }
    }
 
  if (
    self->graph->main_thread
    && pthread_equal (pthread_self (), self->graph->main_thread->pthread))
    {
      is_processing_thread = true;
      have_result = true;
      return true;
    }
 
  have_result = true;
  is_processing_thread = false;
  return false;
}
 
NONNULL void
router_queue_control_port_change (
  Router *                  self,
  const ControlPortChange * change);
 
void
router_free (Router * self);
 
#endif