noteheads.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 <optional>
#include <string>
 
#include "musx/musx.h"
 
namespace denigma {
namespace classify {
 
namespace notehead {
 
enum class Shape
{
    Unclassified,
    Other,
    Null,
    Regular,
    X,
    Diamond,
    SmallSlash,
    LargeSlash,
    Circled
};
 
enum class Fill
{
    Unspecified,
    Filled,
    Unfilled
};
 
} // namespace notehead
 
struct NoteheadClassification
{
    notehead::Shape shape{ notehead::Shape::Unclassified };
    notehead::Fill fill{ notehead::Fill::Unspecified };
    std::optional<std::string> glyphName;
    musx::dom::NoteInfoPtr::NoteheadInfo noteheadInfo;
 
    explicit operator bool() const noexcept
    { return shape != notehead::Shape::Unclassified; }
};
 
NoteheadClassification classifyNoteheadSymbol(
    const musx::dom::MusxInstance<musx::dom::FontInfo>& fontInfo, char32_t symbol);
 
NoteheadClassification classifyNotehead(const musx::dom::NoteInfoPtr& note);
 
} // namespace classify
} // namespace denigma