denigma 4.0.0
Loading...
Searching...
No Matches
lyrics.h
1/*
2 * Copyright (C) 2026, Robert Patterson
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22#pragma once
23
24#include "musx/musx.h"
25
26namespace denigma {
27namespace classify {
28
29namespace lyric {
30
34enum class WordExtensionKind {
35 None,
36 Smart,
37 Legacy
38};
39
40} // namespace lyric
41
45{
46 lyric::WordExtensionKind kind{lyric::WordExtensionKind::None};
49 musx::dom::EntryInfoPtr endEntry;
50
52 explicit operator bool() const noexcept { return kind != lyric::WordExtensionKind::None; }
53};
54
59LyricWordExtension classifyLyricWordExtension(const musx::dom::MusxInstance<musx::dom::details::LyricAssign>& assignment);
60
61} // namespace classify
62} // namespace denigma
LyricWordExtension classifyLyricWordExtension(const musx::dom::MusxInstance< musx::dom::details::LyricAssign > &assignment)
Classifies the word extension of one lyric syllable assignment.
Core public API for the Denigma conversion libraries.
Definition articulations.h:33
Result returned by lyric word-extension classification.
Definition lyrics.h:45
musx::dom::EntryInfoPtr endEntry
The entry the extension ends on, which may be the syllable's own entry.
Definition lyrics.h:49