CraftWork.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_WORK_CRAFT_WORK_H
#define XJMUSIC_WORK_CRAFT_WORK_H
 
#include <optional>
#include <set>
#include <string>
 
#include "xjmusic/content/ContentEntityStore.h"
#include "xjmusic/fabricator/Fabricator.h"
#include "xjmusic/segment/SegmentEntityStore.h"
 
namespace XJ
{
 
    class CraftWork final
    {
        SegmentEntityStore*           store;
        ContentEntityStore*           content;
        bool                          running = true;
        long                          craftAheadMicros = 0;
        long                          deadlineMicros = 0;
        long                          persistenceWindowMicros = 0;
        bool                          nextCycleRewrite = false;
        std::optional<const Program*> nextCycleOverrideMacroProgram = std::nullopt;
        std::set<std::string>         nextCycleOverrideMemes = {};
        bool                          didOverride = false;
 
    public:
        explicit CraftWork(
            SegmentEntityStore* store,
            ContentEntityStore* content,
            int                 persistenceWindowSeconds,
            int                 craftAheadSeconds,
            int                 deadlineSeconds);
 
        void start();
 
        void finish();
 
        bool isFinished() const;
 
        void runCycle(const unsigned long long int atChainMicros);
 
        TemplateConfig getTemplateConfig() const;
 
        std::vector<const Segment*> getSegmentsIfReady(unsigned long long fromChainMicros, unsigned long long toChainMicros) const;
 
        std::optional<const Segment*> getSegmentAtChainMicros(unsigned long long chainMicros) const;
 
        std::optional<const Segment*> getSegmentAtOffset(int offset) const;
 
        std::set<const SegmentChoiceArrangementPick*> getPicks(const std::vector<const Segment*>& segments) const;
 
        const Instrument* getInstrument(const InstrumentAudio* audio) const;
 
        const InstrumentAudio* getInstrumentAudio(const SegmentChoiceArrangementPick* pick) const;
 
        std::optional<const Program*> getMainProgram(const Segment* segment) const;
 
        std::optional<const Program*> getMacroProgram(const Segment& segment) const;
 
        ContentEntityStore* getSourceMaterial() const;
 
        bool isReady() const;
 
        void doOverrideMacro(const Program* macroProgram);
 
        void doOverrideMemes(std::set<std::string> memes);
 
        bool getAndResetDidOverride();
 
        std::set<const SegmentChoice*> getChoices(const Segment* segment) const;
 
        std::set<const SegmentChoiceArrangement*> getArrangements(const SegmentChoice* choice) const;
 
        std::set<const SegmentChoiceArrangementPick*> getPicks(const SegmentChoiceArrangement* arrangement) const;
 
    private:
        void didFailWhile(const std::string& msgWhile, const std::exception& e);
 
        static const Segment*
        updateSegmentState(Fabricator* fabricator, const Segment* inputSegment, const Segment::State fromState, const Segment::State toState);
 
        void doFabrication(const unsigned long long int craftToChainMicros);
 
        void doFabricationDefault(unsigned long long toChainMicros, std::optional<const Program*> overrideMacroProgram, const std::set<std::string>& overrideMemes);
 
        void doFabricationRewrite(unsigned long long toChainMicros, std::optional<const Program*> overrideMacroProgram, std::set<std::string> overrideMemes);
 
        void doCutoffLastSegment(const Segment* inputSegment, float cutoffAfterBeats) const;
 
        void doFabricationWork(const Segment* inputSegment, std::optional<Segment::Type> overrideSegmentType, const std::optional<const Program*> overrideMacroProgram, const std::set<std::string>& overrideMemes) const;
 
        void doSegmentCleanup(const unsigned long long int shippedToChainMicros) const;
 
        Segment buildSegmentInitial() const;
 
        Segment buildSegmentFollowing(const Segment* last) const;
 
        void doNextCycleRewriteUnlessInitialSegment();
    };
 
} // namespace XJ
 
#endif // XJMUSIC_WORK_CRAFT_WORK_H