lua-scripts/src/note_ends.lua at master · finale-lua/lua-scripts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
functionplugindef()
finaleplugin.RequireSelection=true
finaleplugin.Author="Carl Vine"
finaleplugin.AuthorURL="http://carlvine.com/?cv=lua"
finaleplugin.Copyright="CC0 https://creativecommons.org/publicdomain/zero/1.0/"
finaleplugin.Version="v0.56"
finaleplugin.Date="2022/08/04"
finaleplugin.AdditionalMenuOptions=[[
 Note Ends Eighths
]]
finaleplugin.AdditionalUndoText=[[
 Note Ends Eighths
]]
finaleplugin.AdditionalPrefixes=[[
 eighth_notes = true
]]
finaleplugin.AdditionalDescriptions=[[
 Change smaller notes followed by rests into eighth notes
]]
finaleplugin.MinJWLuaVersion=0.62
finaleplugin.ScriptGroupName="Change note endings"
finaleplugin.ScriptGroupDescription="Align the ends of notes followed by a rest to selected duration boundaries"
finaleplugin.Notes=[[
 This plug-in aligns the ends of notes followed by a rest to a specific "duration boundary".
 It helps improve readability of music with lots of short notes and rests.
 It creates two menu items, `Note Ends Eighths` and `Note Ends Quarters`.
]]
return"Note Ends Quarters", "Note Ends Quarters", "Change smaller notes followed by rests into quarter notes"
end

-- default to quarter notes
eighth_notes=eighth_notesorfalse

functionis_valid_entry(entry, boundary_value, beat_duration)
-- (a) must be note followed by rest
ifentry:IsRest() ornotentry:Next() orentry:Next():IsNote() then
returnfalse
end
localnote_boundary=entry.MeasurePos% (boundary_value/2)
localis_compound_meter= (beat_duration%3==0)
localstart_beat=math.floor(entry.MeasurePos/beat_duration)
localposition_in_beat=entry.MeasurePos%beat_duration

-- (b) note too long, or not on half- or beat-boundary
if (entry.Duration>=boundary_value) or (note_boundary~=0) or (entry.Duration+entry:Next().Duration<boundary_value) then
returnfalse
end
-- (c) room for expanded endpoint / special case quarter note on odd beat
if (position_in_beat+boundary_value>beat_duration) and (is_compound_meteroreighth_notesor (start_beat%2) ~=0) then
returnfalse
end
returntrue
end

functionexpand_note_ends()
localshould_delete_next=false
localboundary_value=eighth_notesandfinale.NOTE_8THorfinale.NOTE_QUARTER-- [ 512 / 1024 ]
localbeat_duration=0
localmeasure_number=0

forentryineachentrysaved(finenv.Region()) do
ifmeasure_number~=entry.Measurethen-- calculate beat duration for new measure
measure_number=entry.Measure
localmeasure=finale.FCMeasure()
measure:Load(measure_number)
localtime_sig=measure:GetTimeSignature()
beat_duration=time_sig:CalcLargestBeatDuration()
end

ifshould_delete_nextthen-- last note was expanded
entry.Duration=0-- so delete this rest
should_delete_next=false-- and start over
elseifis_valid_entry(entry, boundary_value, beat_duration) then
localduration_with_rest=entry.Duration+entry:Next().Duration
entry.Duration=boundary_value-- expand target note

ifduration_with_rest==boundary_valuethen
should_delete_next=true-- just delete the following rest
elseifduration_with_rest>boundary_valuethen-- some duration left over
entry:Next().Duration=duration_with_rest-boundary_value-- make rest smaller
should_delete_next=false-- and don't delete it
end
end
end
end

expand_note_ends()