2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2010 Jan Nieuwenhuizen <janneke@gnu.org>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "bar-line.hh"
21 #include "beaming-pattern.hh"
24 #include "duration.hh"
25 #include "engraver.hh"
29 #include "stream-event.hh"
33 #include "translator.icc"
35 class Auto_beam_engraver
: public Engraver
37 TRANSLATOR_DECLARATIONS (Auto_beam_engraver
);
40 void stop_translation_timestep ();
41 void process_music ();
42 virtual void finalize ();
43 virtual void derived_mark () const;
45 DECLARE_ACKNOWLEDGER (rest
);
46 DECLARE_ACKNOWLEDGER (beam
);
47 DECLARE_ACKNOWLEDGER (bar_line
);
48 DECLARE_ACKNOWLEDGER (breathing_sign
);
49 DECLARE_ACKNOWLEDGER (stem
);
50 DECLARE_TRANSLATOR_LISTENER (beam_forbid
);
52 void process_acknowledged ();
55 bool test_moment (Direction
, Moment
, Moment
);
56 void consider_begin (Moment
, Moment
);
57 void consider_end (Moment
, Moment
);
58 Spanner
*create_beam ();
62 bool is_same_grace_state (Grob
*e
);
65 vector
<Item
*> *remove_end_stems (vsize
);
67 Stream_event
*forbid_
;
69 shortest_mom_ is the shortest note in the beam.
72 Spanner
*finished_beam_
;
73 vector
<Item
*> *stems_
;
75 int process_acknowledged_count_
;
78 Projected ending of the beam we're working on.
81 Moment beam_start_moment_
;
82 Moment beam_start_location_
;
84 // We act as if beam were created, and start a grouping anyway.
85 Beaming_pattern
*grouping_
;
88 Beaming_pattern
*finished_grouping_
;
91 Beaming_options beaming_options_
;
92 Beaming_options finished_beaming_options_
;
95 void check_bar_property ();
99 Auto_beam_engraver::derived_mark () const
101 scm_gc_mark (beam_settings_
);
105 Auto_beam_engraver::check_bar_property ()
107 /* Duplicated from process_music (), since
108 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
110 Moment now
= now_mom ();
111 if (scm_is_string (get_property ("whichBar"))
112 && beam_start_moment_
< now
)
114 consider_end (measure_position (context ()), shortest_mom_
);
120 Auto_beam_engraver::process_music ()
122 Moment now
= now_mom ();
124 don't beam over skips
128 if (extend_mom_
< now
)
132 if (scm_is_string (get_property ("whichBar")))
134 consider_end (measure_position (context ()), shortest_mom_
);
140 consider_end (measure_position (context ()), shortest_mom_
);
145 Auto_beam_engraver::Auto_beam_engraver ()
148 process_acknowledged_count_
= 0;
150 shortest_mom_
= Moment (Rational (1, 8));
152 finished_grouping_
= 0;
154 beam_settings_
= SCM_EOL
;
157 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver
, beam_forbid
);
159 Auto_beam_engraver::listen_beam_forbid (Stream_event
*ev
)
161 ASSIGN_EVENT_ONCE (forbid_
, ev
);
165 Auto_beam_engraver::test_moment (Direction dir
, Moment test_mom
, Moment dur
)
167 return scm_call_4 (get_property ("autoBeamCheck"),
168 context ()->self_scm (),
170 test_mom
.smobbed_copy(),
176 Auto_beam_engraver::consider_begin (Moment test_mom
, Moment dur
)
178 bool on
= to_boolean (get_property ("autoBeaming"));
182 bool b
= test_moment (START
, test_mom
, dur
);
189 Auto_beam_engraver::consider_end (Moment test_mom
, Moment dur
)
193 /* Allow already started autobeam to end:
194 don't check for autoBeaming */
195 bool b
= test_moment (STOP
, test_mom
, dur
);
202 Auto_beam_engraver::create_beam ()
204 if (to_boolean (get_property ("skipTypesetting")))
207 for (vsize i
= 0; i
< stems_
->size (); i
++)
208 if (Stem::get_beam ((*stems_
)[i
]))
212 Can't use make_spanner () because we have to use
215 Spanner
*beam
= new Spanner (beam_settings_
);
217 for (vsize i
= 0; i
< stems_
->size (); i
++)
218 Beam::add_stem (beam
, (*stems_
)[i
]);
220 announce_grob (beam
, (*stems_
)[0]->self_scm ());
226 Auto_beam_engraver::begin_beam ()
228 if (stems_
|| grouping_
)
230 programming_error ("already have autobeam");
234 stems_
= new vector
<Item
*>;
235 grouping_
= new Beaming_pattern ();
236 beaming_options_
.from_context (context ());
237 beam_settings_
= updated_grob_properties (context (), ly_symbol2scm ("Beam"));
239 beam_start_moment_
= now_mom ();
241 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
245 Auto_beam_engraver::junk_beam ()
254 beam_settings_
= SCM_EOL
;
256 shortest_mom_
= Moment (Rational (1, 8));
260 Auto_beam_engraver::end_beam ()
262 if (stems_
->size () < 2)
266 finished_beam_
= create_beam ();
270 announce_end_grob (finished_beam_
, SCM_EOL
);
271 finished_grouping_
= grouping_
;
272 finished_beaming_options_
= beaming_options_
;
277 beam_settings_
= SCM_EOL
;
280 shortest_mom_
= Moment (Rational (1, 8));
284 Auto_beam_engraver::typeset_beam ()
288 if (!finished_beam_
->get_bound (RIGHT
))
289 finished_beam_
->set_bound (RIGHT
, finished_beam_
->get_bound (LEFT
));
291 finished_grouping_
->beamify (finished_beaming_options_
);
292 Beam::set_beaming (finished_beam_
, finished_grouping_
);
295 delete finished_grouping_
;
296 finished_grouping_
= 0;
301 Auto_beam_engraver::stop_translation_timestep ()
304 process_acknowledged_count_
= 0;
309 Auto_beam_engraver::finalize ()
311 /* finished beams may be typeset */
313 /* but unfinished may need another announce/acknowledge pass */
320 Auto_beam_engraver::acknowledge_beam (Grob_info
/* info */)
322 check_bar_property ();
328 Auto_beam_engraver::acknowledge_bar_line (Grob_info
/* info */)
330 check_bar_property ();
336 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info
/* info */)
338 check_bar_property ();
344 Auto_beam_engraver::acknowledge_rest (Grob_info
/* info */)
346 check_bar_property ();
352 Auto_beam_engraver::acknowledge_stem (Grob_info info
)
354 check_bar_property ();
355 Item
*stem
= dynamic_cast<Item
*> (info
.grob ());
356 Stream_event
*ev
= info
.ultimate_event_cause ();
357 if (!ev
->in_event_class ("rhythmic-event"))
359 programming_error ("stem must have rhythmic structure");
364 Don't (start) auto-beam over empty stems; skips or rests
366 if (!Stem::head_count (stem
))
373 if (Stem::get_beam (stem
))
380 int durlog
= unsmob_duration (ev
->get_property ("duration"))->duration_log ();
392 Moment now
= now_mom ();
393 if (bool (beam_start_location_
.grace_part_
) != bool (now
.grace_part_
))
396 Moment ev_dur
= unsmob_duration (ev
->get_property ("duration"))->get_length ();
397 Moment dur
= Rational (1, ev_dur
.den ());
398 Moment measure_now
= measure_position (context ());
399 bool recheck_needed
= false;
401 if (dur
< shortest_mom_
)
403 /* new shortest moment, so store it and set recheck_needed */
405 recheck_needed
= true;
408 /* end should be based on shortest_mom_, begin should be
409 based on current duration */
410 consider_end (measure_now
, shortest_mom_
);
411 consider_begin (measure_now
, dur
);
416 grouping_
->add_stem (now
- beam_start_moment_
+ beam_start_location_
,
418 Stem::is_invisible (stem
));
419 stems_
->push_back (stem
);
421 extend_mom_
= max (extend_mom_
, now
) + get_event_length (ev
, now
);
427 Auto_beam_engraver::recheck_beam ()
430 Recheck the beam after the shortest duration has changed
431 If shorter duration has created a new break, typeset the
432 first part of the beam and reset the current beam to just
433 the last part of the beam
435 Beaming_pattern
*new_grouping_
= 0;
436 vector
<Item
*> *new_stems_
= 0;
437 Moment temporary_shortest_mom
;
438 SCM temporary_beam_settings
;
443 for (vsize i
= 0; i
< stems_
->size () - 1;)
445 found_end
= test_moment (STOP
,
446 grouping_
->end_moment (i
),
453 Save the current beam settings and shortest_mom_
454 Necessary because end_beam destroys them
456 temporary_shortest_mom
= shortest_mom_
;
457 temporary_beam_settings
= beam_settings_
;
459 /* Eliminate (and save) the items no longer part of the first beam */
461 new_grouping_
= grouping_
->split_pattern (i
);
462 new_stems_
= remove_end_stems (i
);
467 /* now recreate the unbeamed data structures */
469 grouping_
= new_grouping_
;
470 shortest_mom_
= temporary_shortest_mom
;
471 beam_settings_
= temporary_beam_settings
;
481 Remove all stems with an index greater than split_index
482 from stems_, and return a vector containing all of the
486 Auto_beam_engraver::remove_end_stems (vsize split_index
)
488 vector
<Item
*> *removed_stems
= 0;
489 removed_stems
= new vector
<Item
*>;
491 for (vsize j
= split_index
+ 1; j
< stems_
->size (); j
++)
492 removed_stems
->push_back ((*stems_
).at (j
));
493 for (vsize j
= split_index
+ 1; j
< stems_
->size ();)
495 return removed_stems
;
499 Auto_beam_engraver::process_acknowledged ()
501 Moment now
= now_mom();
502 if (extend_mom_
> now
)
505 if (!process_acknowledged_count_
)
507 Moment measure_now
= measure_position (context ());
508 consider_end (measure_now
, shortest_mom_
);
509 consider_begin (measure_now
, shortest_mom_
);
511 else if (process_acknowledged_count_
> 1)
515 if ((extend_mom_
< now
)
516 || ((extend_mom_
== now
) && (last_add_mom_
!= now
)))
518 else if (!stems_
->size ())
523 process_acknowledged_count_
++;
526 ADD_ACKNOWLEDGER (Auto_beam_engraver
, stem
);
527 ADD_ACKNOWLEDGER (Auto_beam_engraver
, bar_line
);
528 ADD_ACKNOWLEDGER (Auto_beam_engraver
, beam
);
529 ADD_ACKNOWLEDGER (Auto_beam_engraver
, breathing_sign
);
530 ADD_ACKNOWLEDGER (Auto_beam_engraver
, rest
);
531 ADD_TRANSLATOR (Auto_beam_engraver
,
533 "Generate beams based on measure characteristics and observed"
534 " Stems. Uses @code{beatLength}, @code{measureLength}, and"
535 " @code{measurePosition} to decide when to start and stop a"
536 " beam. Overriding beaming is done through"
537 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
538 " @code{stemRightBeamCount}.",