snap_grid.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/runtime/result.hpp>
#include <pulp/timebase/compiled_meter_map.hpp>
#include <pulp/timebase/quantize.hpp>
 
#include <cstdint>
 
namespace pulp::timeline_editor {


enum class SnapDirection : std::uint8_t {
    AtOrBefore,
    Nearest,
    AtOrAfter,
};
 
enum class SnapGridError : std::uint8_t {
    InvalidInterval,
    InvalidSwingRatio,
};

class SnapGrid {
  public:
    static runtime::Result<SnapGrid, SnapGridError>
    create(timebase::TickDuration interval,
           timebase::SwingRatio swing = timebase::kStraightSwing) noexcept;

    timebase::TickPosition snap(const timebase::CompiledMeterMap& meter_map,
                                timebase::TickPosition position,
                                SnapDirection direction = SnapDirection::Nearest) const noexcept;
 
    timebase::TickDuration interval() const noexcept {
        return interval_;
    }
    timebase::SwingRatio swing() const noexcept {
        return swing_;
    }
 
  private:
    SnapGrid(timebase::TickDuration interval, timebase::SwingRatio swing) noexcept
        : interval_(interval), swing_(swing) {}
 
    timebase::TickDuration interval_;
    timebase::SwingRatio swing_;
};

 
} // namespace pulp::timeline_editor