Port connections manager. More...

#include <src/dsp/port_connections_manager.h>

Inheritance diagram for zrythm::dsp::PortConnectionsManager:

Collaboration diagram for zrythm::dsp::PortConnectionsManager:

Public Types
using	PortConnection = dsp::PortConnection
using	ConnectionsVector = std::vector<PortConnection *>

Public Member Functions
	PortConnectionsManager (QObject *parent=nullptr)
void	regenerate_hashtables ()
	Regenerates the hash tables.
int	get_sources_or_dests (ConnectionsVector *arr, const PortUuid &id, bool sources) const
	Adds the sources/destinations of id in the given array.
int	get_sources (ConnectionsVector *arr, const PortUuid &id) const
int	get_dests (ConnectionsVector *arr, const PortUuid &id) const
int	get_num_sources (const PortUuid &id) const
int	get_num_dests (const PortUuid &id) const
auto	get_connection_count () const noexcept
int	get_unlocked_sources_or_dests (ConnectionsVector *arr, const PortUuid &id, bool sources) const
	Adds the sources/destinations of id in the given array.
PortConnection *	get_source_or_dest (const PortUuid &id, bool sources) const
	Wrapper over get_sources_or_dests() that returns the first connection.
PortConnection *	get_connection (const PortUuid &src, const PortUuid &dest) const
bool	connection_exists (const PortUuid &src, const PortUuid &dest) const
bool	update_connection (const PortConnection &before, const PortConnection &after)
	Replaces the given `before` connection with `after`.
bool	update_connection (const PortUuid &src, const PortUuid &dest, float multiplier, bool locked, bool enabled)
const PortConnection *	add_connection (const PortUuid &src, const PortUuid &dest, float multiplier, bool locked, bool enabled)
	Stores the connection for the given ports if it doesn't exist, otherwise updates the existing connection.
const PortConnection *	add_default_connection (const PortUuid &src, const PortUuid &dest, bool locked)
	Overload for default settings (multiplier = 1.0, enabled = true).
const PortConnection *	add_connection (const PortConnection &conn)
bool	remove_connection (const PortUuid &src, const PortUuid &dest)
	Removes the connection for the given ports if it exists.
void	remove_all_connections (const PortUuid &pi)
	Disconnect all sources and dests of the given port identifier.
void	reset_connections_from_other (const PortConnectionsManager *other)
	Removes all connections from this.
bool	contains_connection (const PortConnection &conn) const
void	print_ht (const ConnectionHashTable &ht)
void	print () const
void	clear_all ()
auto &	get_connections () const

Friends
void	init_from (PortConnectionsManager &obj, const PortConnectionsManager &other, utils::ObjectCloneType clone_type)
void	to_json (nlohmann::json &j, const PortConnectionsManager &pcm)
void	from_json (const nlohmann::json &j, PortConnectionsManager &pcm)

Detailed Description

Port connections manager.

Definition at line 15 of file port_connections_manager.h.

Member Typedef Documentation

◆ ConnectionsVector

using zrythm::dsp::PortConnectionsManager::ConnectionsVector = std::vector<PortConnection *>

Definition at line 22 of file port_connections_manager.h.

◆ PortConnection

using zrythm::dsp::PortConnectionsManager::PortConnection = dsp::PortConnection

Definition at line 21 of file port_connections_manager.h.

Member Function Documentation

◆ add_connection() [1/2]

const PortConnection * zrythm::dsp::PortConnectionsManager::add_connection ( const PortConnection & conn )

inline

Definition at line 166 of file port_connections_manager.h.

◆ add_connection() [2/2]

const PortConnection * zrythm::dsp::PortConnectionsManager::add_connection	(	const PortUuid &	src,
		const PortUuid &	dest,
		float	multiplier,
		bool	locked,
		bool	enabled )

Stores the connection for the given ports if it doesn't exist, otherwise updates the existing connection.

Note: To be called from the main thread only.

Returns: The connection.

◆ add_default_connection()

const PortConnection * zrythm::dsp::PortConnectionsManager::add_default_connection	(	const PortUuid &	src,
		const PortUuid &	dest,
		bool	locked )

inline

Overload for default settings (multiplier = 1.0, enabled = true).

Definition at line 161 of file port_connections_manager.h.

◆ clear_all()

void zrythm::dsp::PortConnectionsManager::clear_all ( )

inline

Definition at line 207 of file port_connections_manager.h.

◆ connection_exists()

bool zrythm::dsp::PortConnectionsManager::connection_exists	(	const PortUuid &	src,
		const PortUuid &	dest ) const

inline

Definition at line 122 of file port_connections_manager.h.

◆ get_connection()

PortConnection * zrythm::dsp::PortConnectionsManager::get_connection	(	const PortUuid &	src,
		const PortUuid &	dest ) const

Parameters

src
dest

Returns: The connection, owned by this, or null.

◆ get_connection_count()

auto zrythm::dsp::PortConnectionsManager::get_connection_count ( ) const

inlinenoexcept

Definition at line 83 of file port_connections_manager.h.

◆ get_connections()

auto & zrythm::dsp::PortConnectionsManager::get_connections ( ) const

inline

Definition at line 213 of file port_connections_manager.h.

◆ get_dests()

int zrythm::dsp::PortConnectionsManager::get_dests	(	ConnectionsVector *	arr,
		const PortUuid &	id ) const

inline

Definition at line 69 of file port_connections_manager.h.

◆ get_num_dests()

int zrythm::dsp::PortConnectionsManager::get_num_dests ( const PortUuid & id ) const

inline

Definition at line 78 of file port_connections_manager.h.

◆ get_num_sources()

int zrythm::dsp::PortConnectionsManager::get_num_sources ( const PortUuid & id ) const

inline

Definition at line 74 of file port_connections_manager.h.

◆ get_source_or_dest()

PortConnection * zrythm::dsp::PortConnectionsManager::get_source_or_dest	(	const PortUuid &	id,
		bool	sources ) const

Wrapper over get_sources_or_dests() that returns the first connection.

It is a programming error to call this for ports that are not expected to have exactly 1 matching connection.

Returns: The connection, owned by this, or null.

◆ get_sources()

int zrythm::dsp::PortConnectionsManager::get_sources	(	ConnectionsVector *	arr,
		const PortUuid &	id ) const

inline

Definition at line 64 of file port_connections_manager.h.

◆ get_sources_or_dests()

int zrythm::dsp::PortConnectionsManager::get_sources_or_dests	(	ConnectionsVector *	arr,
		const PortUuid &	id,
		bool	sources ) const

Adds the sources/destinations of id in the given array.

The returned instances of PortConnection are owned by this and must not be free'd.

Parameters

id	The identifier of the port to look for.
arr	Optional array to fill.
sources	True to look for sources, false for destinations.

Returns: The number of ports found.

◆ get_unlocked_sources_or_dests()

int zrythm::dsp::PortConnectionsManager::get_unlocked_sources_or_dests	(	ConnectionsVector *	arr,
		const PortUuid &	id,
		bool	sources ) const

Adds the sources/destinations of id in the given array.

The returned instances of PortConnection are owned by this and must not be free'd.

Parameters

id	The identifier of the port to look for.
arr	Optional array to fill.
sources	True to look for sources, false for destinations.

Returns: The number of ports found.

◆ regenerate_hashtables()

void zrythm::dsp::PortConnectionsManager::regenerate_hashtables ( )

Regenerates the hash tables.

Must be called when a change is made in the connections.

◆ remove_all_connections()

void zrythm::dsp::PortConnectionsManager::remove_all_connections ( const PortUuid & pi )

Disconnect all sources and dests of the given port identifier.

Note: To be called from the main thread only.

◆ remove_connection()

bool zrythm::dsp::PortConnectionsManager::remove_connection	(	const PortUuid &	src,
		const PortUuid &	dest )

Removes the connection for the given ports if it exists.

Note: To be called from the main thread only.

Returns: Whether a connection was removed.

◆ reset_connections_from_other()

void zrythm::dsp::PortConnectionsManager::reset_connections_from_other ( const PortConnectionsManager * other )

Removes all connections from this.

Parameters

src	If non-nullptr, the connections are copied from this to this.

◆ update_connection()

bool zrythm::dsp::PortConnectionsManager::update_connection	(	const PortConnection &	before,
		const PortConnection &	after )

Replaces the given before connection with after.

Returns: Whether the connection was replaced.

◆ from_json

void from_json	(	const nlohmann::json &	j,
		PortConnectionsManager &	pcm )

friend

Definition at line 221 of file port_connections_manager.h.

◆ to_json

void to_json	(	nlohmann::json &	j,
		const PortConnectionsManager &	pcm )

friend

Definition at line 217 of file port_connections_manager.h.

The documentation for this class was generated from the following file:

src/dsp/port_connections_manager.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ ConnectionsVector

◆ PortConnection

Member Function Documentation

◆ add_connection() [1/2]

◆ add_connection() [2/2]

◆ add_default_connection()

◆ clear_all()

◆ connection_exists()

◆ get_connection()

◆ get_connection_count()

◆ get_connections()

◆ get_dests()

◆ get_num_dests()

◆ get_num_sources()

◆ get_source_or_dest()

◆ get_sources()

◆ get_sources_or_dests()

◆ get_unlocked_sources_or_dests()

◆ regenerate_hashtables()

◆ remove_all_connections()

◆ remove_connection()

◆ reset_connections_from_other()

◆ update_connection()

Friends And Related Symbol Documentation

◆ from_json

◆ to_json