#include <Fabricator.h>

Public Types
enum class	ControlMode { Auto , Macro , Taxonomy }

Public Member Functions
virtual	~Fabricator ()=default

	Fabricator (ContentEntityStore contentEntityStore, SegmentEntityStore segmentEntityStore, const SegmentRetrospective *segmentRetrospective, int segmentId, std::optional< Segment::Type > overrideSegmentType)

virtual void	addMessage (SegmentMessage::Type messageType, std::string body)

virtual void	addErrorMessage (std::string body)

virtual void	addWarningMessage (std::string body)

virtual void	addInfoMessage (std::string body)

virtual void	deletePick (const UUID &id)

virtual std::set< const SegmentChoiceArrangement * >	getArrangements ()

virtual std::set< const SegmentChoiceArrangement * >	getArrangements (std::set< const SegmentChoice * > &choices)

virtual Chain *	getChain ()

virtual TemplateConfig	getTemplateConfig ()

virtual std::set< const SegmentChoice * >	getChoices () const

virtual std::optional< const SegmentChoice * >	getChoiceIfContinued (const ProgramVoice *voice)

virtual std::set< const SegmentChoice * >	getChoicesIfContinued (const Program::Type programType)

virtual std::optional< const SegmentChoice * >	getChoiceIfContinued (Instrument::Type instrumentType)

virtual std::optional< const SegmentChoice * >	getChoiceIfContinued (Instrument::Type instrumentType, Instrument::Mode instrumentMode)

virtual std::optional< const SegmentChord * >	getChordAt (float position)

virtual std::optional< const SegmentChoice * >	getCurrentMainChoice ()

virtual std::optional< const ProgramSequence * >	getCurrentMainSequence ()

virtual std::set< const SegmentChoice * >	getCurrentDetailChoices ()

virtual std::optional< const SegmentChoice * >	getCurrentBeatChoice ()

virtual std::set< Instrument::Type >	getDistinctChordVoicingTypes ()

virtual long	getElapsedMicros ()

virtual Chord	getKeyForChoice (const SegmentChoice *choice)

virtual std::optional< const SegmentChoice * >	getMacroChoiceOfPreviousSegment ()

virtual std::optional< const SegmentChoice * >	getPreviousMainChoice ()

virtual ProgramConfig	getCurrentMainProgramConfig ()

virtual std::optional< const ProgramSequence * >	getPreviousMainSequence ()

virtual MemeIsometry	getMemeIsometryOfNextSequenceInPreviousMacro ()

virtual MemeIsometry	getMemeIsometryOfSegment ()

virtual int	getNextSequenceBindingOffset (const SegmentChoice *choice)

virtual std::set< const SegmentChoiceArrangementPick * >	getPicks ()

virtual std::vector< const SegmentChoiceArrangementPick * >	getPicks (const SegmentChoice *choice)

virtual std::optional< const InstrumentAudio * >	getPreferredAudio (const std::string &parentIdent, const std::string &ident)

virtual std::optional< const Program * >	getProgram (const SegmentChoice *choice)

virtual std::vector< const ProgramSequenceChord * >	getProgramSequenceChords (const ProgramSequence *programSequence)

virtual NoteRange	getProgramRange (const UUID &programId, Instrument::Type instrumentType)

virtual int	getProgramRangeShiftOctaves (Instrument::Type instrumentType, NoteRange sourceRange, NoteRange targetRange)

virtual std::optional< const ProgramSequence * >	getProgramSequence (const SegmentChoice *choice)

virtual int	getProgramTargetShift (Instrument::Type instrumentType, const Chord fromChord, const Chord toChord)

virtual Program::Type	getProgramType (const ProgramVoice *voice)

virtual Instrument::Type	getProgramVoiceType (const ProgramSequenceChordVoicing *voicing)

virtual NoteRange	getProgramVoicingNoteRange (Instrument::Type instrumentType)

virtual std::optional< const ProgramSequence * >	getRandomlySelectedSequence (const Program *program)

virtual std::optional< const ProgramSequencePattern * >	getRandomlySelectedPatternOfSequenceByVoiceAndType (const SegmentChoice *choice)

virtual std::optional< const ProgramSequenceBinding * >	getRandomlySelectedSequenceBindingAtOffset (const Program *program, int offset)

virtual std::optional< Note >	getRootNoteMidRange (const std::string &voicingNotes, const Chord *chord)

virtual long	getSegmentMicrosAtPosition (float tempo, float position)

virtual long	getTotalSegmentMicros ()

virtual const Segment *	getSegment ()

virtual std::vector< const SegmentChord * >	getSegmentChords ()

virtual std::set< const SegmentChordVoicing * >	getChordVoicings ()

virtual std::set< const SegmentMeme * >	getSegmentMemes ()

virtual std::optional< const ProgramSequence * >	getSequence (const SegmentChoice *choice)

virtual int	getSequenceBindingOffsetForChoice (const SegmentChoice *choice)

virtual void	putStickyBun (StickyBun bun)

virtual std::optional< const StickyBun >	getStickyBun (const UUID &eventId)

virtual std::string	getTrackName (const ProgramSequencePatternEvent *event)

virtual Segment::Type	getType ()

virtual std::optional< const SegmentChordVoicing * >	chooseVoicing (const SegmentChord *chord, Instrument::Type instrumentType)

virtual bool	hasMoreSequenceBindingOffsets (const SegmentChoice *choice, int N)

virtual bool	hasOneMoreSequenceBindingOffset (const SegmentChoice *choice)

virtual bool	hasTwoMoreSequenceBindingOffsets (const SegmentChoice *choice)

virtual bool	isContinuationOfMacroProgram ()

virtual bool	isDirectlyBound (const Instrument *instrument)

virtual bool	isDirectlyBound (const InstrumentAudio *instrumentAudio)

virtual bool	isDirectlyBound (const Program *program)

virtual bool	isOneShot (const Instrument *instrument, const std::string &trackName)

virtual bool	isOneShot (const Instrument *instrument)

virtual bool	isOneShotCutoffEnabled (const Instrument *instrument)

virtual bool	isInitialSegment ()

virtual std::optional< const SegmentChoice * >	put (const SegmentChoice &entity, const bool force)

virtual const SegmentChoiceArrangement *	put (const SegmentChoiceArrangement &entity)

virtual const SegmentChoiceArrangementPick *	put (const SegmentChoiceArrangementPick &entity)

virtual const SegmentChord *	put (const SegmentChord &entity)

virtual const SegmentChordVoicing *	put (const SegmentChordVoicing &entity)

virtual std::optional< const SegmentMeme * >	put (const SegmentMeme &entity, bool force)

virtual const SegmentMessage *	put (const SegmentMessage &entity)

virtual const SegmentMeta *	put (const SegmentMeta &entity)

virtual void	putPreferredAudio (const std::string &parentIdent, const std::string &ident, const InstrumentAudio *instrumentAudio)

virtual const Segment *	updateSegment (Segment segment)

virtual const SegmentRetrospective *	getRetrospective ()

virtual ContentEntityStore *	getSourceMaterial ()

virtual double	getMicrosPerBeat (float tempo)

virtual int	getSecondMacroSequenceBindingOffset (const Program *macroProgram)

virtual double	getTempo ()

virtual MemeTaxonomy	getMemeTaxonomy () const

Static Public Member Functions
static std::vector< std::string >	getNotes (const SegmentChordVoicing *voicing)

static int	getSegmentId (const SegmentChoice *segmentChoice)

static int	getSegmentId (const SegmentChoiceArrangement *segmentChoiceArrangement)

static int	getSegmentId (const SegmentChoiceArrangementPick *segmentChoiceArrangementPick)

static int	getSegmentId (const SegmentChord *segmentChord)

static int	getSegmentId (const SegmentChordVoicing *segmentChordVoicing)

static int	getSegmentId (const SegmentMeme *segmentMeme)

static int	getSegmentId (const SegmentMessage *segmentMessage)

static int	getSegmentId (const SegmentMeta *segmentMeta)

static std::string	toString (ControlMode controlMode)

static ControlMode	parseControlMode (const char *str)

Member Enumeration Documentation

◆ ControlMode

enum XJ::Fabricator::ControlMode

strong

Fabrication control mode

Enumerator
Auto
Macro
Taxonomy

Constructor & Destructor Documentation

◆ ~Fabricator()

virtual XJ::Fabricator::~Fabricator ( )

virtualdefault

◆ Fabricator()

Fabricator::Fabricator	(	ContentEntityStore *	contentEntityStore,
		SegmentEntityStore *	segmentEntityStore,
		const SegmentRetrospective *	segmentRetrospective,
		int	segmentId,
		std::optional< Segment::Type >	overrideSegmentType
	)

explicit

Construct new fabricator with the given segment retrospective

Parameters

segmentEntityStore	to use for segment entities
segmentRetrospective	to use for segment retrospective
contentEntityStore	contentEntityStore from which to fabricate
segmentId	current segment to fabricate
overrideSegmentType	override segment type

Member Function Documentation

◆ addErrorMessage()

void Fabricator::addErrorMessage ( std::string body )

virtual

Add an error message to the segment, with the given body

Parameters

body	to include in message

◆ addInfoMessage()

void Fabricator::addInfoMessage ( std::string body )

virtual

Add an info message to the segment, with the given body

Parameters

body	to include in message

◆ addMessage()

void Fabricator::addMessage	(	SegmentMessage::Type	messageType,
		std::string	body
	)

virtual

Add a message of the given type to the segment, with the given body

Parameters

messageType	of message to add
body	to include in message

◆ addWarningMessage()

void Fabricator::addWarningMessage ( std::string body )

virtual

Add a warning message to the segment, with the given body

Parameters

body	to include in message

◆ chooseVoicing()

std::optional< const SegmentChordVoicing * > Fabricator::chooseVoicing	(	const SegmentChord *	chord,
		Instrument::Type	instrumentType
	)

virtual

Get segment chord voicing for a given chord

Parameters

chord	to get voicing for
instrumentType	for which to get voicing

Returns: chord voicing for chord

◆ deletePick()

void Fabricator::deletePick ( const UUID & id )

virtual

Delete a pick from the current segment specified by Segment id and id

Parameters

id to delete

◆ getArrangements() [1/2]

std::set< const SegmentChoiceArrangement * > Fabricator::getArrangements ( )

virtual

Get arrangements for segment

Returns: arrangements for segment

◆ getArrangements() [2/2]

std::set< const SegmentChoiceArrangement * > Fabricator::getArrangements ( std::set< const SegmentChoice * > & choices )

virtual

Get segment arrangements for a given choice

Parameters

choices to get segment arrangements for

Returns: segments arrangements for the given segment choice

◆ getChain()

Chain * Fabricator::getChain ( )

virtual

Get the Chain

Returns: Chain

◆ getChoiceIfContinued() [1/3]

std::optional< const SegmentChoice * > Fabricator::getChoiceIfContinued ( const ProgramVoice * voice )

virtual

Determine if a choice has been previously crafted in one of the previous segments of the current main sequence

Beat and Detail choices are kept for an entire Main Program https://github.com/xjmusic/xjmusic/issues/265

Returns: choice if previously made, or null if none is found

◆ getChoiceIfContinued() [2/3]

std::optional< const SegmentChoice * > Fabricator::getChoiceIfContinued ( Instrument::Type instrumentType )

virtual

Determine if a choice has been previously crafted in one of the previous segments of the current main sequence

Returns: choice if previously made, or null if none is found

◆ getChoiceIfContinued() [3/3]

std::optional< const SegmentChoice * > Fabricator::getChoiceIfContinued	(	Instrument::Type	instrumentType,
		Instrument::Mode	instrumentMode
	)

virtual

Determine if a choice has been previously crafted in one of the previous segments of the current main sequence

Returns: choice if previously made, or null if none is found

◆ getChoices()

std::set< const SegmentChoice * > Fabricator::getChoices ( ) const

virtual

Get choices for segment

Returns: choices for segment

◆ getChoicesIfContinued()

std::set< const SegmentChoice * > Fabricator::getChoicesIfContinued ( const Program::Type programType )

virtual

Determine if a choice has been previously crafted in one of the previous segments of the current main sequence

Returns: choice if previously made, or null if none is found

◆ getChordAt()

std::optional< const SegmentChord * > Fabricator::getChordAt ( float position )

virtual

Get current ChordEntity for any position in Segment. Defaults to returning a chord based on the segment key, if nothing else is found

Parameters

position in segment

Returns: ChordEntity

◆ getChordVoicings()

std::set< const SegmentChordVoicing * > Fabricator::getChordVoicings ( )

virtual

Get all segment chord voicings

Returns: segment chord voicings

◆ getCurrentBeatChoice()

std::optional< const SegmentChoice * > Fabricator::getCurrentBeatChoice ( )

virtual

Get the beat-type choice for the current segment in the chain

Returns: beat-type segment choice

◆ getCurrentDetailChoices()

std::set< const SegmentChoice * > Fabricator::getCurrentDetailChoices ( )

virtual

Get the detail-type choice for the current segment in the chain

Returns: detail-type segment choice

◆ getCurrentMainChoice()

std::optional< const SegmentChoice * > Fabricator::getCurrentMainChoice ( )

virtual

Get the main-type choice for the current segment in the chain

Returns: main-type segment choice

◆ getCurrentMainProgramConfig()

ProgramConfig Fabricator::getCurrentMainProgramConfig ( )

virtual

Get the configuration of the current main program

Returns: main-program configuration @ on failure

◆ getCurrentMainSequence()

std::optional< const ProgramSequence * > Fabricator::getCurrentMainSequence ( )

virtual

Get the sequence targeted by the current main choice

Returns: current main sequence

◆ getDistinctChordVoicingTypes()

std::set< Instrument::Type > Fabricator::getDistinctChordVoicingTypes ( )

virtual

Get a list of unique voicing (instrument) types present in the voicings of the current main program's chords.

Returns: set of voicing (instrument) types

◆ getElapsedMicros()

long Fabricator::getElapsedMicros ( )

virtual

Returns: Seconds elapsed since fabricator was instantiated

◆ getKeyForChoice()

Chord Fabricator::getKeyForChoice ( const SegmentChoice * choice )

virtual

Get the Key for any given Choice, preferring its Sequence Key (bound), defaulting to the Program Key.

If Sequence has no key/tempo/intensity inherit from Program https://github.com/xjmusic/xjmusic/issues/246

Parameters

choice to get key for

Returns: key of specified sequence/program via choice @ if unable to determine key of choice

◆ getMacroChoiceOfPreviousSegment()

std::optional< const SegmentChoice * > Fabricator::getMacroChoiceOfPreviousSegment ( )

virtual

Get the macro-type choice for the previous segment in the chain

Returns: macro-type segment choice, null if none found

◆ getMemeIsometryOfNextSequenceInPreviousMacro()

MemeIsometry Fabricator::getMemeIsometryOfNextSequenceInPreviousMacro ( )

virtual

Get meme isometry for the next offset in the previous segment's macro-choice

Returns: MemeIsometry for previous macro-choice

◆ getMemeIsometryOfSegment()

MemeIsometry Fabricator::getMemeIsometryOfSegment ( )

virtual

Get meme isometry for the current segment

Returns: MemeIsometry for current segment

◆ getMemeTaxonomy()

MemeTaxonomy Fabricator::getMemeTaxonomy ( ) const

virtual

Returns: the meme taxonomy for the source material

◆ getMicrosPerBeat()

double Fabricator::getMicrosPerBeat ( float tempo )

virtual

Get the number of micros per beat for the current segment

Returns: micros per beat @ on failure

◆ getNextSequenceBindingOffset()

int Fabricator::getNextSequenceBindingOffset ( const SegmentChoice * choice )

virtual

Given a Choice having a SequenceBinding, determine the next available SequenceBinding offset of the chosen sequence, or loop back to zero (if past the end of the available SequenceBinding offsets)

Parameters

choice having a SequenceBinding

Returns: next available SequenceBinding offset of the chosen sequence, or zero (if past the end of the available SequenceBinding offsets)

◆ getNotes()

std::vector< std::string > Fabricator::getNotes ( const SegmentChordVoicing * voicing )

static

Get the Notes from a Voicing

Parameters

voicing to get notes of

Returns: notes from voicing @ on failure

◆ getPicks() [1/2]

std::set< const SegmentChoiceArrangementPick * > Fabricator::getPicks ( )

virtual

Get arrangement picks for segment

Returns: arrangement picks for segment

◆ getPicks() [2/2]

std::vector< const SegmentChoiceArrangementPick * > Fabricator::getPicks ( const SegmentChoice * choice )

virtual

Get the picks for a given choice, in order of position ascending from beginning of segment

Parameters

choice for which to get picks

Returns: picks

◆ getPreferredAudio()

std::optional< const InstrumentAudio * > Fabricator::getPreferredAudio	(	const std::string &	parentIdent,
		const std::string &	ident
	)

virtual

Get preferred (previously chosen) instrument audios

Returns: preferred audios

◆ getPreviousMainChoice()

std::optional< const SegmentChoice * > Fabricator::getPreviousMainChoice ( )

virtual

Get the main-type choice for the previous segment in the chain

Returns: main-type segment choice, null if none found

◆ getPreviousMainSequence()

std::optional< const ProgramSequence * > Fabricator::getPreviousMainSequence ( )

virtual

Get the sequence targeted by the previous main choice

Returns: previous main sequence

◆ getProgram()

std::optional< const Program * > Fabricator::getProgram ( const SegmentChoice * choice )

virtual

Get Program for any given choice

Parameters

choice to get program for

Returns: Program for the specified choice

◆ getProgramRange()

NoteRange Fabricator::getProgramRange	(	const UUID &	programId,
		Instrument::Type	instrumentType
	)

virtual

Get the note range for an arrangement based on all the events in its program

Parameters

programId	to get range of
instrumentType	to get range of

Returns: Note range of arrangement @ on failure

◆ getProgramRangeShiftOctaves()

int Fabricator::getProgramRangeShiftOctaves	(	Instrument::Type	instrumentType,
		NoteRange *	sourceRange,
		NoteRange *	targetRange
	)

virtual

Detail craft shifts source program events into the target range https://github.com/xjmusic/xjmusic/issues/221

via average of delta from source low to target low, and from source high to target high, rounded to octave

Parameters

instrumentType	of instrument
sourceRange	to compute from
targetRange	to compute required # of octaves to shift into

Returns: +/- octaves required to shift from source to target range @ on failure

◆ getProgramSequence()

std::optional< const ProgramSequence * > Fabricator::getProgramSequence ( const SegmentChoice * choice )

virtual

Get the sequence for a given choice

Parameters

choice for which to get sequence

Returns: sequence of choice

◆ getProgramSequenceChords()

std::vector< const ProgramSequenceChord * > Fabricator::getProgramSequenceChords ( const ProgramSequence * programSequence )

virtual

Get the complete set of program sequence chords, ignoring ghost chords* REF by choosing the voicings with largest # of notes at that position https://github.com/xjmusic/xjmusic/issues/248 (caches results)

Parameters

programSequence for which to get complete do-ghosted set of chords

Returns: get complete do-ghosted set of chords for program sequence

◆ getProgramTargetShift()

int Fabricator::getProgramTargetShift	(	Instrument::Type	instrumentType,
		const Chord *	fromChord,
		const Chord *	toChord
	)

virtual

Compute the target shift from a key toward a chord

Parameters

instrumentType	to switch behavior
fromChord	to compute shift from
toChord	to compute shift toward

Returns: computed target shift

◆ getProgramType()

Program::Type Fabricator::getProgramType ( const ProgramVoice * voice )

virtual

Get the program type of given voice

Parameters

voice for which to get program type

Returns: program type @ on failure

◆ getProgramVoiceType()

Instrument::Type Fabricator::getProgramVoiceType ( const ProgramSequenceChordVoicing * voicing )

virtual

Get the voice type for the given voicing

Programs persist main chord/voicing structure sensibly https://github.com/xjmusic/xjmusic/issues/266

Parameters

voicing for which to get voice type

Returns: type of voice for voicing @ on failure

◆ getProgramVoicingNoteRange()

NoteRange Fabricator::getProgramVoicingNoteRange ( Instrument::Type instrumentType )

virtual

Get the lowest note present in any voicing of all the segment chord voicings for this segment and instrument instrumentType

Parameters

instrumentType to get voicing threshold low of

Returns: low voicing threshold @ on failure

◆ getRandomlySelectedPatternOfSequenceByVoiceAndType()

std::optional< const ProgramSequencePattern * > Fabricator::getRandomlySelectedPatternOfSequenceByVoiceAndType ( const SegmentChoice * choice )

virtual

Selects one (at random) of all available patterns of a given type within a sequence. https://github.com/xjmusic/xjmusic/issues/204

Caches the selection, so it will always return the same output for any given input.

Beat fabrication composited of layered Patterns https://github.com/xjmusic/xjmusic/issues/267

Returns: Pattern model, or null if no pattern of this type is found @ on failure

◆ getRandomlySelectedSequence()

std::optional< const ProgramSequence * > Fabricator::getRandomlySelectedSequence ( const Program * program )

virtual

Randomly select any sequence

Returns: randomly selected sequence

◆ getRandomlySelectedSequenceBindingAtOffset()

std::optional< const ProgramSequenceBinding * > Fabricator::getRandomlySelectedSequenceBindingAtOffset	(	const Program *	program,
		int	offset
	)

virtual

Randomly select any sequence binding at the given offset

Parameters

program	from which to get sequence binding
offset	to get sequence binding at

Returns: randomly selected sequence binding

◆ getRetrospective()

const SegmentRetrospective * Fabricator::getRetrospective ( )

virtual

Get the Segment Retrospective

Returns: retrospective

◆ getRootNoteMidRange()

std::optional< Note > Fabricator::getRootNoteMidRange	(	const std::string &	voicingNotes,
		const Chord *	chord
	)

virtual

Get the root note from an available set of voicings and a given chord

Parameters

voicingNotes	available voicing notes
chord	for which to seek root note among available voicings

Returns: root note

◆ getSecondMacroSequenceBindingOffset()

int Fabricator::getSecondMacroSequenceBindingOffset ( const Program * macroProgram )

virtual

Get the second macro sequence binding offset of a given macro program

Parameters

macroProgram for which to get second macro sequence binding offset

Returns: second macro sequence binding offset

◆ getSegment()

const Segment * Fabricator::getSegment ( )

virtual

The segment being fabricated

Returns: Segment

◆ getSegmentChords()

std::vector< const SegmentChord * > Fabricator::getSegmentChords ( )

virtual

Get all segment chords, guaranteed to be in order of position ascending

Returns: segment chords

◆ getSegmentId() [1/8]

int Fabricator::getSegmentId ( const SegmentChoice * segmentChoice )

static

Get Segment ID of Segment Choice

Parameters

segmentChoice

Returns

◆ getSegmentId() [2/8]

int Fabricator::getSegmentId ( const SegmentChoiceArrangement * segmentChoiceArrangement )

static

Get Segment ID of Segment Choice Arrangement

◆ getSegmentId() [3/8]

int Fabricator::getSegmentId ( const SegmentChoiceArrangementPick * segmentChoiceArrangementPick )

static

Get Segment ID of Segment Choice Arrangement Pick

◆ getSegmentId() [4/8]

int Fabricator::getSegmentId ( const SegmentChord * segmentChord )

static

Get Segment ID of Segment Chord

◆ getSegmentId() [5/8]

int Fabricator::getSegmentId ( const SegmentChordVoicing * segmentChordVoicing )

static

Get Segment ID of Segment Chord Voicing

◆ getSegmentId() [6/8]

int Fabricator::getSegmentId ( const SegmentMeme * segmentMeme )

static

Get Segment ID of Segment Meme

◆ getSegmentId() [7/8]

int Fabricator::getSegmentId ( const SegmentMessage * segmentMessage )

static

Get Segment ID of Segment Message

◆ getSegmentId() [8/8]

int Fabricator::getSegmentId ( const SegmentMeta * segmentMeta )

static

Get Segment ID of Segment Meta

◆ getSegmentMemes()

std::set< const SegmentMeme * > Fabricator::getSegmentMemes ( )

virtual

Get all segment memes

Returns: segment memes

◆ getSegmentMicrosAtPosition()

long Fabricator::getSegmentMicrosAtPosition	(	float	tempo,
		float	position
	)

virtual

Compute using an integral the seconds of start for any given position in beats Velocity of Segment meter (beats per minute) increases linearly of the beginning of the Segment (at the previous Segment's tempo) to the end of the Segment (arriving at the current Segment's tempo, only at its end)

Segment should never be fabricated longer than its loop beats. https://github.com/xjmusic/xjmusic/issues/268 Segment wherein tempo changes expect perfectly smooth sound of previous segment through to following segment https://github.com/xjmusic/xjmusic/issues/269

Parameters

tempo	in beats per minute
position	in beats

Returns: seconds of start

◆ getSequence()

std::optional< const ProgramSequence * > Fabricator::getSequence ( const SegmentChoice * choice )

virtual

Get the sequence for a Choice either directly (beat- and detail-type sequences), or by sequence-pattern (macro- or main-type sequences) https://github.com/xjmusic/xjmusic/issues/204

Beat and Detail programs are allowed to have only one (default) sequence.

Parameters

choice to get sequence for

Returns: Sequence for choice @ on failure

◆ getSequenceBindingOffsetForChoice()

int Fabricator::getSequenceBindingOffsetForChoice ( const SegmentChoice * choice )

virtual

Get the sequence pattern offset of a given Choice

Parameters

choice having a SequenceBinding

Returns: sequence pattern offset

◆ getSourceMaterial()

ContentEntityStore * Fabricator::getSourceMaterial ( )

virtual

Get the ingested source material for fabrication

Returns: source material

◆ getStickyBun()

std::optional< const StickyBun > Fabricator::getStickyBun ( const UUID & eventId )

virtual

Segment has metadata for XJ to persist "notes in the margin" of the composition for itself to read https://github.com/xjmusic/xjmusic/issues/222

Sticky bun is a simple coded key-value in segment meta — key by pattern ID — value is a comma-separated list of integers, one integer for each note in the pattern, where --— tonal note is coded as a 0 value --— atonal note has a random integer value generated ranging from -50 to 50
Rendering a pattern X voicing considers the sticky bun values — the random seed for rendering the pattern will always come from the associated sticky bun

Sticky buns v2 persisted for each randomly selected note in the series for any given pattern https://github.com/xjmusic/xjmusic/issues/231

key on program-sequence-pattern-event id, persisting only the first value seen for any given event
super-key on program-sequence-pattern id, measuring delta from the first event seen in that pattern

TemplateConfig parameter stickyBunEnabled https://github.com/xjmusic/xjmusic/issues/251

Parameters

eventId for super-key

Returns: sticky bun if present

◆ getTemplateConfig()

TemplateConfig Fabricator::getTemplateConfig ( )

virtual

Chain configuration, by type If no chain config is found for this type, a default config is returned.

Returns: chain configuration

◆ getTempo()

double Fabricator::getTempo ( )

virtual

Returns: the tempo of the current main program @ on failure

◆ getTotalSegmentMicros()

long Fabricator::getTotalSegmentMicros ( )

virtual

Returns: the total number of seconds in the segment

◆ getTrackName()

std::string Fabricator::getTrackName ( const ProgramSequencePatternEvent * event )

virtual

Get the track name for a give program sequence pattern event

Parameters

event for which to get track name

Returns: Track name @ on failure

◆ getType()

Segment::Type Fabricator::getType ( )

virtual

Determine type of content, e.g. initial segment in chain, or next macro-sequence

Returns: macro-craft type @ on failure

◆ hasMoreSequenceBindingOffsets()

bool Fabricator::hasMoreSequenceBindingOffsets	(	const SegmentChoice *	choice,
		int	N
	)

virtual

Does the program of the specified Choice have at least N more sequence binding offsets available?

Parameters

choice	of which to check the program for next available sequence binding offsets
N	more sequence offsets to check for

Returns: true if N more sequence binding offsets are available

◆ hasOneMoreSequenceBindingOffset()

bool Fabricator::hasOneMoreSequenceBindingOffset ( const SegmentChoice * choice )

virtual

Whether the current Segment Choice has one or more sequence pattern offsets with a higher pattern offset than the current one

Parameters

choice for which to check

Returns: true if it has at least one more sequence pattern offset

◆ hasTwoMoreSequenceBindingOffsets()

bool Fabricator::hasTwoMoreSequenceBindingOffsets ( const SegmentChoice * choice )

virtual

Whether the current Segment Choice has two or more sequence pattern offsets with a higher pattern offset than the current two

Parameters

choice for which to check

Returns: true if it has at least two more sequence pattern offsets

◆ isContinuationOfMacroProgram()

bool Fabricator::isContinuationOfMacroProgram ( )

virtual

Whether this type of segment continues the same macro-program from the previous segment

Returns: true if this segment continues the same macro-program @ on failure

◆ isDirectlyBound() [1/3]

bool Fabricator::isDirectlyBound ( const Instrument * instrument )

virtual

Whether a given Instrument is directly bound to the Chain, where "directly" means a level more specific than Library, e.g. Program or Instrument

Parameters

instrument to test for direct binding

Returns: true if Instrument is directly bound to chain

◆ isDirectlyBound() [2/3]

bool Fabricator::isDirectlyBound ( const InstrumentAudio * instrumentAudio )

virtual

Whether a given InstrumentAudio is directly bound to the Chain, where "directly" means a level more specific than Library, e.g. Program or InstrumentAudio

Parameters

instrumentAudio to test for direct binding

Returns: true if InstrumentAudio is directly bound to chain

◆ isDirectlyBound() [3/3]

bool Fabricator::isDirectlyBound ( const Program * program )

virtual

Whether a given Program is directly bound to the Chain, where "directly" means a level more specific than Library, e.g. Program or Instrument

Parameters

program to test for direct binding

Returns: true if Program is directly bound to chain

◆ isInitialSegment()

bool Fabricator::isInitialSegment ( )

virtual

is initial segment?

Returns: whether this is the initial segment in a chain

◆ isOneShot() [1/2]

bool Fabricator::isOneShot ( const Instrument * instrument )

virtual

Test if a given instrument is one-shot

Parameters

instrument to test

Returns: true if this is a one-shot instrument @ on failure

◆ isOneShot() [2/2]

bool Fabricator::isOneShot	(	const Instrument *	instrument,
		const std::string &	trackName
	)

virtual

Test if a given instrument and track name is a one-shot sample hit

Parameters

instrument	to test
trackName	to test

Returns: true if this is a one-shot instrument and track name @ on failure

◆ isOneShotCutoffEnabled()

bool Fabricator::isOneShotCutoffEnabled ( const Instrument * instrument )

virtual

Test if a given one-shot instrument has its cutoffs enable

Parameters

instrument to test

Returns: true if a given one-shot instrument has its cutoffs enable @ on failure

◆ parseControlMode()

Fabricator::ControlMode Fabricator::parseControlMode ( const char * str )

static

Parse the control mode from a string

Parameters

str to parse

Returns: control mode

◆ put() [1/8]

std::optional< const SegmentChoice * > Fabricator::put	(	const SegmentChoice &	entity,
		const bool	force
	)

virtual

Put a SegmentChoice in the store

Should add memes from ALL program and instrument types! https://github.com/xjmusic/xjmusic/issues/210

Add memes of choices to segment in order to affect further choices.
Add all memes of this choice, from target program, program sequence binding, or instrument if present
Enhances: Straightforward meme logic https://github.com/xjmusic/xjmusic/issues/270
Enhances: XJ should not add memes to Segment for program/instrument that was not successfully chosen https://github.com/xjmusic/xjmusic/issues/216

Parameters

entity Choice to put

Returns: choice if successfully put @ on failure

◆ put() [2/8]

const SegmentChoiceArrangement * Fabricator::put ( const SegmentChoiceArrangement & entity )

virtual

Put a SegmentChoiceArrangement in the store

Parameters

entity Arrangement to put

Returns: Arrangement successfully put @ on failure

◆ put() [3/8]

const SegmentChoiceArrangementPick * Fabricator::put ( const SegmentChoiceArrangementPick & entity )

virtual

Put a SegmentChoiceArrangementPick in the store

Parameters

entity ChoiceArrangementPick to put

Returns: ChoiceArrangementPick successfully put @ on failure

◆ put() [4/8]

const SegmentChord * Fabricator::put ( const SegmentChord & entity )

virtual

Put a SegmentChord in the store

Parameters

entity Chord to put

Returns: Chord successfully put @ on failure

◆ put() [5/8]

const SegmentChordVoicing * Fabricator::put ( const SegmentChordVoicing & entity )

virtual

Put a SegmentChordVoicing in the store

Parameters

entity ChordVoicing to put

Returns: ChordVoicing successfully put @ on failure

◆ put() [6/8]

std::optional< const SegmentMeme * > Fabricator::put	(	const SegmentMeme &	entity,
		bool	force
	)

virtual

Put a SegmentMeme in the store

Parameters

entity	Meme to put
force	whether to force meme addition without valid theorem checks

Returns: Meme successfully put @ on failure

◆ put() [7/8]

const SegmentMessage * Fabricator::put ( const SegmentMessage & entity )

virtual

Put a SegmentMessage in the store

Parameters

entity Message to put

Returns: Message successfully put @ on failure

◆ put() [8/8]

const SegmentMeta * Fabricator::put ( const SegmentMeta & entity )

virtual

Put a SegmentMeta in the store

Parameters

entity Meta to put

Returns: Meta successfully put @ on failure

◆ putPreferredAudio()

void Fabricator::putPreferredAudio	(	const std::string &	parentIdent,
		const std::string &	ident,
		const InstrumentAudio *	instrumentAudio
	)

virtual

Set the preferred audio for a key

Parameters

parentIdent	for which to set
ident	for which to set
instrumentAudio	value to set

◆ putStickyBun()

void Fabricator::putStickyBun ( StickyBun bun )

virtual

Store a sticky bun in the fabricator

Parameters

bun to store

Exceptions

JsonProcessingException on failure @ on failure

◆ toString()

std::string Fabricator::toString ( ControlMode controlMode )

static

Get the string representation of the control mode

Parameters

controlMode

◆ updateSegment()

const Segment * Fabricator::updateSegment ( Segment segment )

virtual

Set the Segment. Any modifications to the Segment must be re-written to here because protobuf instances are immutable

Parameters

segment to set @ on failure

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

/home/runner/work/xjmusic/xjmusic/engine/include/xjmusic/fabricator/Fabricator.h
/home/runner/work/xjmusic/xjmusic/engine/src/fabricator/Fabricator.cpp

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

◆ ControlMode

Constructor & Destructor Documentation

◆ ~Fabricator()

◆ Fabricator()

Member Function Documentation

◆ addErrorMessage()

◆ addInfoMessage()

◆ addMessage()

◆ addWarningMessage()

◆ chooseVoicing()

◆ deletePick()

◆ getArrangements() [1/2]

◆ getArrangements() [2/2]

◆ getChain()

◆ getChoiceIfContinued() [1/3]

◆ getChoiceIfContinued() [2/3]

◆ getChoiceIfContinued() [3/3]

◆ getChoices()

◆ getChoicesIfContinued()

◆ getChordAt()

◆ getChordVoicings()

◆ getCurrentBeatChoice()

◆ getCurrentDetailChoices()

◆ getCurrentMainChoice()

◆ getCurrentMainProgramConfig()

◆ getCurrentMainSequence()

◆ getDistinctChordVoicingTypes()

◆ getElapsedMicros()

◆ getKeyForChoice()

◆ getMacroChoiceOfPreviousSegment()

◆ getMemeIsometryOfNextSequenceInPreviousMacro()

◆ getMemeIsometryOfSegment()

◆ getMemeTaxonomy()

◆ getMicrosPerBeat()

◆ getNextSequenceBindingOffset()

◆ getNotes()

◆ getPicks() [1/2]

◆ getPicks() [2/2]

◆ getPreferredAudio()

◆ getPreviousMainChoice()

◆ getPreviousMainSequence()

◆ getProgram()

◆ getProgramRange()

◆ getProgramRangeShiftOctaves()

◆ getProgramSequence()

◆ getProgramSequenceChords()

◆ getProgramTargetShift()

◆ getProgramType()

◆ getProgramVoiceType()

◆ getProgramVoicingNoteRange()

◆ getRandomlySelectedPatternOfSequenceByVoiceAndType()

◆ getRandomlySelectedSequence()

◆ getRandomlySelectedSequenceBindingAtOffset()

◆ getRetrospective()

◆ getRootNoteMidRange()

◆ getSecondMacroSequenceBindingOffset()

◆ getSegment()

◆ getSegmentChords()

◆ getSegmentId() [1/8]

◆ getSegmentId() [2/8]

◆ getSegmentId() [3/8]

◆ getSegmentId() [4/8]

◆ getSegmentId() [5/8]

◆ getSegmentId() [6/8]

◆ getSegmentId() [7/8]

◆ getSegmentId() [8/8]

◆ getSegmentMemes()

◆ getSegmentMicrosAtPosition()

◆ getSequence()

◆ getSequenceBindingOffsetForChoice()

◆ getSourceMaterial()

◆ getStickyBun()

◆ getTemplateConfig()

◆ getTempo()

◆ getTotalSegmentMicros()

◆ getTrackName()