ardour/libs/ardour/ardour/graph.h

148 lines
4.0 KiB
C++

/*
* Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2009-2014 David Robillard <d@drobilla.net>
* Copyright (C) 2010-2012 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2013 Tim Mayberry <mojofunk@gmail.com>
* Copyright (C) 2015-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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __ardour_graph_h__
#define __ardour_graph_h__
#include <list>
#include <set>
#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>
#include "pbd/mpmc_queue.h"
#include "pbd/semutils.h"
#include "pbd/g_atomic_compat.h"
#include "ardour/audio_backend.h"
#include "ardour/libardour_visibility.h"
#include "ardour/session_handle.h"
#include "ardour/types.h"
namespace ARDOUR
{
class GraphNode;
class Graph;
class Route;
class Session;
class GraphEdges;
typedef boost::shared_ptr<GraphNode> node_ptr_t;
typedef std::list<node_ptr_t> node_list_t;
typedef std::set<node_ptr_t> node_set_t;
class LIBARDOUR_API Graph : public SessionHandleRef
{
public:
Graph (Session& session);
void trigger (GraphNode* n);
void rechain (boost::shared_ptr<RouteList>, GraphEdges const&);
bool plot (std::string const& file_name) const;
void plot (int chain);
void reached_terminal_node ();
void helper_thread ();
int process_routes (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool& need_butler);
int routes_no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample, bool non_rt_pending);
void process_one_route (Route* route);
void clear_other_chain ();
void swap_process_chain ();
bool in_process_thread () const;
protected:
virtual void session_going_away ();
private:
void reset_thread_list ();
void drop_threads ();
void run_one ();
void main_thread ();
void prep ();
void dump (int chain) const;
node_list_t _nodes_rt[2];
node_list_t _init_trigger_list[2];
PBD::MPMCQueue<GraphNode*> _trigger_queue; ///< nodes that can be processed
GATOMIC_QUAL guint _trigger_queue_size; ///< number of entries in trigger-queue
/** Start worker threads */
PBD::Semaphore _execution_sem;
/** The number of processing threads that are asleep */
GATOMIC_QUAL guint _idle_thread_cnt;
/** Signalled to start a run of the graph for a process callback */
PBD::Semaphore _callback_start_sem;
PBD::Semaphore _callback_done_sem;
/** The number of unprocessed nodes that do not feed any other node; updated during processing */
GATOMIC_QUAL guint _terminal_refcnt;
/** The initial number of nodes that do not feed any other node (for each chain) */
guint _n_terminal_nodes[2];
bool _graph_empty;
/* number of background worker threads >= 0 */
GATOMIC_QUAL guint _n_workers;
/* flag to terminate background threads */
GATOMIC_QUAL gint _terminate;
/* chain swapping */
Glib::Threads::Cond _cleanup_cond;
mutable Glib::Threads::Mutex _swap_mutex;
GATOMIC_QUAL gint _current_chain;
GATOMIC_QUAL gint _pending_chain;
GATOMIC_QUAL gint _setup_chain;
/* parameter caches */
pframes_t _process_nframes;
samplepos_t _process_start_sample;
samplepos_t _process_end_sample;
bool _process_can_record;
bool _process_non_rt_pending;
bool _process_noroll;
int _process_retval;
bool _process_need_butler;
/* engine / thread connection */
PBD::ScopedConnectionList engine_connections;
void engine_stopped ();
};
} // namespace
#endif /* __ardour_graph_h__ */