SegmentUtils.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_FABRICATOR_SEGMENT_UTILS_H
#define XJMUSIC_FABRICATOR_SEGMENT_UTILS_H
 
#include <optional>
#include <set>
#include <string>
#include <vector>
 
#include "xjmusic/segment/Segment.h"
#include "xjmusic/segment/SegmentChoice.h"
#include "xjmusic/segment/SegmentChoiceArrangement.h"
#include "xjmusic/segment/SegmentChordVoicing.h"
 
 
namespace XJ {
 
  class SegmentUtils {
 
  public:
 
    static std::optional<const SegmentChoice *>
    findFirstOfType(const std::set<const SegmentChoice *> &segmentChoices, Program::Type type);
 
    static std::optional<const SegmentChoice *>
    findFirstOfType(const std::set<const SegmentChoice *> &segmentChoices, Instrument::Type type);
 
    static std::string getIdentifier(const Segment *segment);
 
    static std::optional<const Segment *> getLastCrafted(const std::vector<const Segment *> &segments);
 
    static std::optional<const Segment *> getLast(const std::vector<const Segment *> &segments);
 
    static std::vector<const Segment *> getCrafted(const std::vector<const Segment *> &segments);
 
    static bool containsAnyValidNotes(const SegmentChordVoicing *voicing);
 
    static bool isSpanning(const Segment *segment,
                           unsigned long long fromChainMicros,
                           unsigned long long toChainMicros);
 
    static bool isIntersecting(const Segment *segment,
                               unsigned long long atChainMicros,
                               unsigned long long thresholdMicros);
 
    static std::string getStorageFilename(const Segment *segment, const std::string &extension);
 
    static std::string getStorageFilename(const Segment *segment);
 
    static std::string describe(const SegmentChoice &choice);
 
    static long getEndAtChainMicros(const Segment *segment);
 
    static bool isSameButUpdated(const Segment *s1, const Segment *s2);
 
    static long getDurationMinMicros(std::vector<Segment> &segments);
 
  };
 
} // namespace XJ
 
#endif //XJMUSIC_FABRICATOR_SEGMENT_UTILS_H