modulation.hpp File Reference

#include <pulp/timeline/item_id.hpp>
#include <pulp/timeline/parameter_target.hpp>
#include <cstddef>
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>

Go to the source code of this file.

Classes
struct	pulp::timeline::ModulationTargetCases< Fs >
	Overload set for visiting a ModulationTarget with no generic fallback. More...
struct	pulp::timeline::Modulator
	A track-owned generator of modulation signal. More...
struct	pulp::timeline::MacroControl
	A track-owned named control that a performer sets and that drives parameters through ordinary modulation routes. More...
struct	pulp::timeline::ModulationSourceRef
	Reference to the track-owned source a route reads. More...
struct	pulp::timeline::ModulationRoute
	One authored source-to-parameter connection. More...

Namespaces
namespace	pulp
namespace	pulp::timeline

Typedefs
using	pulp::timeline::ModulationTarget = ParameterTarget
	Exhaustive authored target set for a modulation route.

Enumerations
enum class	pulp::timeline::ModulatorKind : std::uint8_t { pulp::timeline::ModulatorKind::Lfo , pulp::timeline::ModulatorKind::Envelope , pulp::timeline::ModulatorKind::Random , pulp::timeline::ModulatorKind::StepSequence }
	The signal shape a modulator produces. More...
enum class	pulp::timeline::ModulationSourceKind : std::uint8_t { pulp::timeline::ModulationSourceKind::Modulator , pulp::timeline::ModulationSourceKind::Macro }
	Which track-owned entity a route draws its signal from. More...

Functions
template<class... Fs>
	pulp::timeline::ModulationTargetCases (Fs...) -> ModulationTargetCases< Fs... >
constexpr std::string_view	pulp::timeline::modulator_kind_name (ModulatorKind value) noexcept
	The canonical persisted spelling of a modulator kind, shared by the encoder, the decoder, and every interchange reader so no surface invents its own.
constexpr bool	pulp::timeline::known_modulator_kind (ModulatorKind value) noexcept
	Returns whether value names a declared modulator kind.
constexpr std::optional< ModulatorKind >	pulp::timeline::modulator_kind_from_name (std::string_view name) noexcept
	Parses the canonical persisted modulator-kind spelling.
constexpr std::string_view	pulp::timeline::modulation_source_kind_name (ModulationSourceKind value) noexcept
	The canonical persisted spelling of a modulation source kind.
constexpr std::optional< ModulationSourceKind >	pulp::timeline::modulation_source_kind_from_name (std::string_view name) noexcept
	Parses the canonical persisted modulation-source-kind spelling.

Variables
constexpr std::size_t	pulp::timeline::kModulationTargetAlternativeCount
	Number of alternatives a route target may take.
constexpr float	pulp::timeline::kMaximumModulationDepth = 1.0f
	Largest magnitude a route depth may carry.