entries.h

/*
 * Copyright (C) 2026, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <variant>
#include <vector>
 
#include "denigma/classify/noteheads.h"
#include "musx/musx.h"
 
namespace denigma {
namespace classify {
 
namespace entry {
 
struct ArtificialHarmonic
{
    enum class TouchInterval
    {
        Fourth,
        MajorThird,
        Fifth
    };
 
    musx::dom::NoteInfoPtr stoppedNote;
    musx::dom::NoteInfoPtr touchedNote;
    NoteheadClassification stoppedNotehead;
    NoteheadClassification touchedNotehead;
    TouchInterval interval{ TouchInterval::Fourth };
    musx::dom::NoteInfoPtr soundingNote;
};
 
struct ArtificialHarmonics
{
    std::vector<ArtificialHarmonic> harmonics;
};
 
using NoteheadValue = std::variant<std::monostate, ArtificialHarmonics>;
 
} // namespace entry
 
struct EntryNoteheadClassification
{
    entry::NoteheadValue value{};
 
    explicit operator bool() const noexcept
    { return !std::holds_alternative<std::monostate>(value); }
 
    template <typename T>
    const T* as() const noexcept
    { return std::get_if<T>(&value); }
 
    template <typename T>
    bool is() const noexcept
    { return std::holds_alternative<T>(value); }
};
 
EntryNoteheadClassification classifyEntryNoteheads(const musx::dom::EntryInfoPtr& entry);
 
} // namespace classify
} // namespace denigma