2 stem.cc -- implement Stem
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
9 TODO: This is way too hairy
11 #include <math.h> // m_pi
14 #include "directional-element-interface.hh"
15 #include "note-head.hh"
18 #include "paper-def.hh"
19 #include "rhythmic-head.hh"
20 #include "font-interface.hh"
21 #include "molecule.hh"
22 #include "paper-column.hh"
26 #include "group-interface.hh"
27 #include "staff-symbol-referencer.hh"
32 Stem::set_beaming (Grob*me ,int i, Direction d )
34 SCM pair = me->get_grob_property ("beaming");
36 if (!gh_pair_p (pair))
38 pair = gh_cons (gh_int2scm (0),gh_int2scm (0));
39 me-> set_grob_property ("beaming", pair);
41 index_set_cell (pair, d, gh_int2scm (i));
45 Stem::beam_count (Grob*me,Direction d)
47 SCM p=me->get_grob_property ("beaming");
49 return gh_scm2int (index_cell (p,d));
55 Stem::head_positions (Grob*me)
63 Drul_array<Grob*> e (extremal_heads (me));
65 return Interval (Staff_symbol_referencer::position_f (e[DOWN]),
66 Staff_symbol_referencer::position_f ( e[UP]));
71 Stem::chord_start_f (Grob*me)
73 return head_positions(me)[get_direction (me)]
74 * Staff_symbol_referencer::staff_space (me)/2.0;
78 Stem::stem_end_position (Grob*me)
80 SCM p =me->get_grob_property ("stem-end-position");
85 pos = get_default_stem_end_position (me);
86 me->set_grob_property ("stem-end-position", gh_double2scm (pos));
89 pos = gh_scm2double (p);
95 Stem::get_direction (Grob*me)
97 Direction d = Directional_element_interface::get (me);
101 d = get_default_dir (me);
103 Directional_element_interface::set (me, d);
110 Stem::set_stemend (Grob*me, Real se)
113 Direction d= get_direction (me);
115 if (d && d * head_positions(me)[get_direction (me)] >= se*d)
116 warning (_ ("Weird stem size; check for narrow beams"));
118 me->set_grob_property ("stem-end-position", gh_double2scm (se));
122 Stem::type_i (Grob*me)
124 return first_head (me) ? Rhythmic_head::balltype_i (first_head (me)) : 2;
128 Note head that determines hshift for upstems
131 Stem::support_head (Grob*me)
133 SCM h = me->get_grob_property ("support-head");
134 Grob * nh = unsmob_grob (h);
137 else if (heads_i (me) == 1)
143 return unsmob_grob (gh_car (me->get_grob_property ("heads")));
146 return first_head (me);
151 Stem::heads_i (Grob*me)
153 return Pointer_group_interface::count (me, "heads");
157 The note head which forms one end of the stem.
160 Stem::first_head (Grob*me)
162 return extremal_heads (me)[-get_direction (me)];
166 START is part where stem reaches `last' head.
169 Stem::extremal_heads (Grob*me)
171 const int inf = 1000000;
172 Drul_array<int> extpos;
176 Drul_array<Grob *> exthead;
177 exthead[LEFT] = exthead[RIGHT] =0;
179 for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = gh_cdr (s))
181 Grob * n = unsmob_grob (gh_car (s));
184 int p = int(Staff_symbol_referencer::position_f (n));
188 if (d* p > d* extpos[d])
193 } while (flip (&d) != DOWN);
200 Stem::add_head (Grob*me, Grob *n)
202 n->set_grob_property ("stem", me->self_scm ());
203 n->add_dependency (me);
205 if (Note_head::has_interface (n))
207 Pointer_group_interface::add_element (me, "heads",n);
211 n->set_grob_property ("rest", n->self_scm ());
216 Stem::invisible_b (Grob*me)
218 return !(heads_i (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1);
222 Stem::get_center_distance (Grob*me, Direction d)
224 int staff_center = 0;
225 int distance = (int) (d*(head_positions(me)[d] - staff_center));
226 return distance >? 0;
230 Stem::get_default_dir (Grob*me)
232 int du = get_center_distance (me,UP);
233 int dd = get_center_distance (me,DOWN);
236 return Direction (sign (dd -du));
238 return to_dir (me->get_grob_property ("default-neutral-direction"));
242 Stem::get_default_stem_end_position (Grob*me)
244 bool grace_b = to_boolean (me->get_grob_property ("grace"));
249 SCM scm_len = me->get_grob_property("length");
250 if (gh_number_p (scm_len))
252 length_f = gh_scm2double (scm_len);
256 s = me->get_grob_property("lengths");
257 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
258 a.push (gh_scm2double (gh_car (q)));
260 // stem uses half-spaces
261 length_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
266 s = me->get_grob_property ("stem-shorten");
267 for (SCM q = s; gh_pair_p (q); q = gh_cdr (q))
268 a.push (gh_scm2double (gh_car (q)));
271 // stem uses half-spaces
273 // fixme: use gh_list_ref () iso. array[]
274 Real shorten_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
277 'set-default-stemlen' sets direction too
279 Direction dir = get_direction (me);
282 dir = get_default_dir (me);
283 Directional_element_interface::set (me, dir);
287 stems in unnatural (forced) direction should be shortened,
288 according to [Roush & Gourlay]
290 if (((int)chord_start_f (me))
291 && (get_direction (me) != get_default_dir (me)))
292 length_f -= shorten_f;
295 Real st = head_positions(me)[dir] + dir * length_f;
297 bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
298 if (!grace_b && !no_extend_b && dir * st < 0) // junkme?
305 Number of hooks on the flag, ie. the log of the duration.
308 Stem::flag_i (Grob*me)
310 SCM s = me->get_grob_property ("duration-log");
311 return (gh_number_p (s)) ? gh_scm2int (s) : 2;
315 Stem::position_noteheads (Grob*me)
320 Link_array<Grob> heads =
321 Pointer_group_interface__extract_elements (me, (Grob*)0, "heads");
323 heads.sort (compare_position);
324 Direction dir =get_direction (me);
330 Grob *hed = support_head (me);
331 Real w = hed->extent (hed, X_AXIS)[dir];
332 for (int i=0; i < heads.size (); i++)
334 heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir], X_AXIS);
337 bool parity= true; // todo: make me settable.
338 int lastpos = int (Staff_symbol_referencer::position_f (heads[0]));
339 for (int i=1; i < heads.size (); i ++)
341 Real p = Staff_symbol_referencer::position_f (heads[i]);
342 int dy =abs (lastpos- (int)p);
348 Real l = heads[i]->extent (heads[i], X_AXIS).length ();
349 heads[i]->translate_axis (l * get_direction (me), X_AXIS);
360 MAKE_SCHEME_CALLBACK(Stem,before_line_breaking,1);
362 Stem::before_line_breaking (SCM smob)
364 Grob*me = unsmob_grob (smob);
365 stem_end_position (me); // ugh. Trigger direction calc.
366 position_noteheads (me);
368 if (invisible_b (me))
370 me->remove_grob_property ("molecule-callback");
374 set_spacing_hints (me);
375 return SCM_UNSPECIFIED;
381 When in a beam with tuplet brackets, brew_mol is called early,
382 caching a wrong value.
384 MAKE_SCHEME_CALLBACK (Stem, height, 2);
386 Stem::height (SCM smob, SCM ax)
388 Axis a = (Axis)gh_scm2int (ax);
389 Grob * me = unsmob_grob (smob);
390 assert ( a == Y_AXIS);
392 SCM mol = me->get_uncached_molecule ();
395 iv = unsmob_molecule (mol)->extent (a);
396 return ly_interval2scm (iv);
401 set stem directions for hinting the optical spacing correction.
403 Modifies DIR_LIST property of the Stem's Paper_column
405 TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
408 Stem::set_spacing_hints (Grob*me)
410 if (!invisible_b (me))
412 SCM scmdir = gh_int2scm (get_direction (me));
414 Item* item = dynamic_cast<Item*> (me);
415 Item * col = item->column_l ();
416 SCM dirlist =col->get_grob_property ("dir-list");
417 if (scm_sloppy_memq (scmdir, dirlist) == SCM_BOOL_F)
419 dirlist = gh_cons (scmdir, dirlist);
420 col->set_grob_property ("dir-list", dirlist);
429 SCM st = me->get_grob_property ("flag-style");
430 if ( gh_string_p (st))
432 style = ly_scm2string (st);
435 char c = (get_direction (me) == UP) ? 'u' : 'd';
436 Molecule m = Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) +
437 to_str (flag_i (me)));
438 if (!style.empty_b ())
439 m.add_molecule(Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + style));
443 MAKE_SCHEME_CALLBACK(Stem,dim_callback,2);
445 Stem::dim_callback (SCM e, SCM ax)
447 Axis a = (Axis) gh_scm2int (ax);
448 assert (a == X_AXIS);
449 Grob *se = unsmob_grob (e);
451 if (unsmob_grob (se->get_grob_property ("beam")) || abs (flag_i (se)) <= 2)
455 r = flag (se).extent (X_AXIS);
457 return ly_interval2scm ( r);
462 MAKE_SCHEME_CALLBACK(Stem,brew_molecule,1);
465 Stem::brew_molecule (SCM smob)
467 Grob*me = unsmob_grob (smob);
469 Direction d = get_direction (me);
472 Real y1 = Staff_symbol_referencer::position_f (first_head (me));
473 Real y2 = stem_end_position (me);
475 Interval stem_y(y1,y2);
476 stem_y.unite (Interval (y2,y1));
478 Real dy = Staff_symbol_referencer::staff_space (me)/2.0;
482 if (Grob *hed = support_head (me))
484 head_wid = hed->extent (hed,X_AXIS).length ();
486 angle = gh_scm2double (hed->get_grob_property ("attachment-angle"));
488 stem_y[Direction(-d)] += d * head_wid * tan(angle)/(2*dy);
490 if (!invisible_b (me))
492 Real stem_width = gh_scm2double (me->get_grob_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
493 Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2),
494 Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
495 mol.add_molecule (ss);
498 if (!beam_l (me) && abs (flag_i (me)) > 2)
500 Molecule fl = flag (me);
501 fl.translate_axis(stem_y[d]*dy, Y_AXIS);
502 mol.add_molecule (fl);
505 return mol.smobbed_copy ();
509 move the stem to right of the notehead if it is up.
511 MAKE_SCHEME_CALLBACK(Stem,off_callback,2);
513 Stem::off_callback (SCM element_smob, SCM )
515 Grob *me = unsmob_grob (element_smob);
518 if (Grob * f = first_head (me))
520 Interval head_wid(0, f->extent (f,X_AXIS).length ());
522 if (to_boolean (me->get_grob_property ("stem-centered")))
523 return gh_double2scm ( head_wid.center ());
525 Real rule_thick = gh_scm2double (me->get_grob_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
526 Direction d = get_direction (me);
527 r = head_wid[d] - d * rule_thick * 0.5;
529 return gh_double2scm (r);
535 Stem::beam_l (Grob*me)
537 SCM b= me->get_grob_property ("beam");
538 return unsmob_grob (b);
542 // ugh still very long.
544 Stem::calc_stem_info (Grob*me)
546 Grob * beam = beam_l (me);
548 Direction beam_dir = Directional_element_interface::get (beam);
551 programming_error ("Beam dir not set.");
556 Real staff_space = Staff_symbol_referencer::staff_space (me);
557 Real half_space = staff_space / 2;
558 int multiplicity = Beam::get_multiplicity (beam);
561 SCM space_proc = beam->get_grob_property ("space-function");
562 SCM space = gh_call1 (space_proc, gh_int2scm (multiplicity));
563 Real interbeam_f = gh_scm2double (space) * staff_space;
565 Real thick = gh_scm2double (beam->get_grob_property ("thickness"));
567 info.idealy_f_ = chord_start_f (me);
569 // for simplicity, we calculate as if dir == UP
570 info.idealy_f_ *= beam_dir;
571 SCM grace_prop = me->get_grob_property ("grace");
573 bool grace_b = to_boolean (grace_prop);
578 s = me->get_grob_property("beamed-minimum-lengths");
580 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
581 a.push (gh_scm2double (gh_car (q)));
584 Real minimum_length = a[multiplicity <? (a.size () - 1)] * staff_space;
585 s = me->get_grob_property ("beamed-lengths");
588 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
589 a.push (gh_scm2double (gh_car (q)));
591 Real stem_length = a[multiplicity <? (a.size () - 1)] * staff_space;
593 if (!beam_dir || (beam_dir == Directional_element_interface::get (me)))
594 /* normal beamed stem */
598 info.idealy_f_ += thick + (multiplicity - 1) * interbeam_f;
600 info.miny_f_ = info.idealy_f_;
601 info.maxy_f_ = INT_MAX;
603 info.idealy_f_ += stem_length;
604 info.miny_f_ += minimum_length;
607 lowest beam of (UP) beam must never be lower than second staffline
609 Hmm, reference (Wanske?)
611 Although this (additional) rule is probably correct,
612 I expect that highest beam (UP) should also never be lower
613 than middle staffline, just as normal stems.
616 bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
617 if (!grace_b && !no_extend_b)
619 /* highest beam of (UP) beam must never be lower than middle
621 lowest beam of (UP) beam must never be lower than second staffline
625 >? (- 2 * half_space - thick
626 + (multiplicity > 0) * thick
627 + interbeam_f * (multiplicity - 1));
633 info.idealy_f_ -= thick;
634 info.maxy_f_ = info.idealy_f_;
635 info.miny_f_ = -INT_MAX;
637 info.idealy_f_ -= stem_length;
638 info.maxy_f_ -= minimum_length;
641 info.idealy_f_ = (info.maxy_f_ <? info.idealy_f_) >? info.miny_f_;
643 s = beam->get_grob_property ("shorten");
645 info.idealy_f_ -= gh_scm2double (s);
647 Grob *common = me->common_refpoint (beam, Y_AXIS);
648 Real interstaff_f = beam_dir *
649 (me->relative_coordinate (common, Y_AXIS)
650 - beam->relative_coordinate (common, Y_AXIS));
652 info.idealy_f_ += interstaff_f;
653 info.miny_f_ += interstaff_f;
654 info.maxy_f_ += interstaff_f ;
660 Stem::has_interface (Grob*m)
662 return m && m->has_interface (ly_symbol2scm ("stem-interface"));
666 Stem::set_interface (Grob*me)
668 me->set_interface (ly_symbol2scm ("stem-interface"));