2 stem.cc -- implement Stem
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2000 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
13 #include "directional-element-interface.hh"
14 #include "note-head.hh"
17 #include "paper-def.hh"
18 #include "rhythmic-head.hh"
20 #include "molecule.hh"
21 #include "paper-column.hh"
25 #include "group-interface.hh"
26 #include "cross-staff.hh"
27 #include "staff-symbol-referencer.hh"
32 Stem::set_beaming (Score_element*me ,int i, Direction d )
34 SCM pair = me->get_elt_property ("beaming");
36 if (!gh_pair_p (pair))
38 pair = gh_cons (gh_int2scm (0),gh_int2scm (0));
39 me-> set_elt_property ("beaming", pair);
41 index_set_cell (pair, d, gh_int2scm (i));
45 Stem::beam_count (Score_element*me,Direction d)
47 SCM p=me->get_elt_property ("beaming");
49 return gh_scm2int (index_cell (p,d));
55 Stem::head_positions (Score_element*me)
63 Drul_array<Score_element*> 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 (Score_element*me)
73 return head_positions(me)[get_direction (me)]
74 * Staff_symbol_referencer::staff_space (me)/2.0;
78 Stem::stem_end_position (Score_element*me)
80 SCM p =me->get_elt_property ("stem-end-position");
85 pos = get_default_stem_end_position (me);
86 me->set_elt_property ("stem-end-position", gh_double2scm (pos));
89 pos = gh_scm2double (p);
95 Stem::get_direction (Score_element*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 (Score_element*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_elt_property ("stem-end-position", gh_double2scm (se));
122 Stem::type_i (Score_element*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 (Score_element*me)
133 SCM h = me->get_elt_property ("support-head");
134 Score_element * nh = unsmob_element (h);
137 else if (heads_i (me) == 1)
143 return unsmob_element (gh_car (me->get_elt_property ("heads")));
146 return first_head (me);
151 Stem::heads_i (Score_element*me)
153 return Pointer_group_interface::count (me, "heads");
157 The note head which forms one end of the stem.
160 Stem::first_head (Score_element*me)
162 return extremal_heads (me)[-get_direction (me)];
166 START is part where stem reaches `last' head.
168 Drul_array<Score_element*>
169 Stem::extremal_heads (Score_element*me)
171 const int inf = 1000000;
172 Drul_array<int> extpos;
176 Drul_array<Score_element *> exthead;
177 exthead[LEFT] = exthead[RIGHT] =0;
179 for (SCM s = me->get_elt_property ("heads"); gh_pair_p (s); s = gh_cdr (s))
181 Score_element * n = unsmob_element (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 (Score_element*me, Score_element *n)
202 n->set_elt_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_elt_property ("rest", n->self_scm ());
216 Stem::invisible_b (Score_element*me)
218 return !(heads_i (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1);
222 Stem::get_center_distance (Score_element*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 (Score_element*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_elt_property ("default-neutral-direction"));
242 Stem::get_default_stem_end_position (Score_element*me)
244 bool grace_b = to_boolean (me->get_elt_property ("grace"));
249 SCM scm_len = me->get_elt_property("length");
250 if (gh_number_p (scm_len))
252 length_f = gh_scm2double (scm_len);
256 s = me->get_elt_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_elt_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_elt_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 (Score_element*me)
310 SCM s = me->get_elt_property ("duration-log");
311 return (gh_number_p (s)) ? gh_scm2int (s) : 2;
315 Stem::position_noteheads (Score_element*me)
320 Link_array<Score_element> heads =
321 Pointer_group_interface__extract_elements (me, (Score_element*)0, "heads");
323 heads.sort (compare_position);
324 Direction dir =get_direction (me);
330 Score_element *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 Score_element*me = unsmob_element (smob);
365 stem_end_position (me); // ugh. Trigger direction calc.
366 position_noteheads (me);
368 if (invisible_b (me))
370 me->remove_elt_property ("molecule-callback");
374 set_spacing_hints (me);
375 return SCM_UNSPECIFIED;
381 set stem directions for hinting the optical spacing correction.
383 Modifies DIR_LIST property of the Stem's Paper_column
385 TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
388 Stem::set_spacing_hints (Score_element*me)
390 if (!invisible_b (me))
392 SCM scmdir = gh_int2scm (get_direction (me));
394 Item* item = dynamic_cast<Item*> (me);
395 Item * col = item->column_l ();
396 SCM dirlist =col->get_elt_property ("dir-list");
397 if (scm_sloppy_memq (scmdir, dirlist) == SCM_BOOL_F)
399 dirlist = gh_cons (scmdir, dirlist);
400 col->set_elt_property ("dir-list", dirlist);
406 Stem::flag (Score_element*me)
409 SCM st = me->get_elt_property ("flag-style");
410 if ( gh_string_p (st))
412 style = ly_scm2string (st);
415 char c = (get_direction (me) == UP) ? 'u' : 'd';
416 Molecule m = me->lookup_l ()->afm_find (String ("flags-") + to_str (c) +
417 to_str (flag_i (me)));
418 if (!style.empty_b ())
419 m.add_molecule(me->lookup_l ()->afm_find (String ("flags-") + to_str (c) + style));
423 MAKE_SCHEME_CALLBACK(Stem,dim_callback,2);
425 Stem::dim_callback (SCM e, SCM )
427 Score_element *se = unsmob_element (e);
429 if (unsmob_element (se->get_elt_property ("beam")) || abs (flag_i (se)) <= 2)
433 r = flag (se).extent (X_AXIS);
435 return ly_interval2scm ( r);
439 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh! Should be settable.
442 MAKE_SCHEME_CALLBACK(Stem,brew_molecule,1);
445 Stem::brew_molecule (SCM smob)
447 Score_element*me = unsmob_element (smob);
449 Direction d = get_direction (me);
452 Real y1 = Staff_symbol_referencer::position_f (first_head (me));
453 Real y2 = stem_end_position (me);
455 Interval stem_y(y1,y2);
456 stem_y.unite (Interval (y2,y1));
458 Real dy = Staff_symbol_referencer::staff_space (me)/2.0;
461 if (Score_element *hed = support_head (me))
462 head_wid = hed->extent (hed,X_AXIS).length ();
463 stem_y[Direction(-d)] += d * head_wid * tan(ANGLE)/(2*dy);
465 if (!invisible_b (me))
467 Real stem_width = gh_scm2double (me->get_elt_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
468 Molecule ss =me->lookup_l ()->filledbox (Box (Interval (-stem_width/2, stem_width/2),
469 Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
470 mol.add_molecule (ss);
473 if (!beam_l (me) && abs (flag_i (me)) > 2)
475 Molecule fl = flag (me);
476 fl.translate_axis(stem_y[d]*dy, Y_AXIS);
477 mol.add_molecule (fl);
480 return mol.create_scheme();
483 MAKE_SCHEME_CALLBACK(Stem,off_callback,2);
485 Stem::off_callback (SCM element_smob, SCM )
487 Score_element *me = unsmob_element (element_smob);
490 if (Score_element * f = first_head (me))
492 Interval head_wid(0, f->extent (f,X_AXIS).length ());
494 if (to_boolean (me->get_elt_property ("stem-centered")))
495 return gh_double2scm ( head_wid.center ());
497 Real rule_thick = gh_scm2double (me->get_elt_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
498 Direction d = get_direction (me);
499 r = head_wid[d] - d * rule_thick ;
501 return gh_double2scm (r);
507 Stem::beam_l (Score_element*me)
509 SCM b= me->get_elt_property ("beam");
510 return unsmob_element (b);
514 // ugh still very long.
516 Stem::calc_stem_info (Score_element*me)
518 Score_element * beam = beam_l (me);
520 Direction beam_dir = Directional_element_interface::get (beam);
523 programming_error ("Beam dir not set.");
528 Real staff_space = Staff_symbol_referencer::staff_space (me);
529 Real half_space = staff_space / 2;
530 int multiplicity = Beam::get_multiplicity (beam);
533 SCM space_proc = beam->get_elt_property ("space-function");
534 SCM space = gh_call1 (space_proc, gh_int2scm (multiplicity));
535 Real interbeam_f = gh_scm2double (space) * staff_space;
537 Real thick = gh_scm2double (beam->get_elt_property ("thickness"));
539 info.idealy_f_ = chord_start_f (me);
541 // for simplicity, we calculate as if dir == UP
542 info.idealy_f_ *= beam_dir;
543 SCM grace_prop = me->get_elt_property ("grace");
545 bool grace_b = to_boolean (grace_prop);
550 s = me->get_elt_property("beamed-minimum-lengths");
552 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
553 a.push (gh_scm2double (gh_car (q)));
556 Real minimum_length = a[multiplicity <? (a.size () - 1)] * staff_space;
557 s = me->get_elt_property ("beamed-lengths");
560 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
561 a.push (gh_scm2double (gh_car (q)));
563 Real stem_length = a[multiplicity <? (a.size () - 1)] * staff_space;
565 if (!beam_dir || (beam_dir == Directional_element_interface::get (me)))
566 /* normal beamed stem */
570 info.idealy_f_ += thick + (multiplicity - 1) * interbeam_f;
572 info.miny_f_ = info.idealy_f_;
573 info.maxy_f_ = INT_MAX;
575 info.idealy_f_ += stem_length;
576 info.miny_f_ += minimum_length;
579 lowest beam of (UP) beam must never be lower than second staffline
581 Hmm, reference (Wanske?)
583 Although this (additional) rule is probably correct,
584 I expect that highest beam (UP) should also never be lower
585 than middle staffline, just as normal stems.
588 bool no_extend_b = to_boolean (me->get_elt_property ("no-stem-extend"));
589 if (!grace_b && !no_extend_b)
591 /* highest beam of (UP) beam must never be lower than middle
593 lowest beam of (UP) beam must never be lower than second staffline
597 >? (- 2 * half_space - thick
598 + (multiplicity > 0) * thick
599 + interbeam_f * (multiplicity - 1));
605 info.idealy_f_ -= thick;
606 info.maxy_f_ = info.idealy_f_;
607 info.miny_f_ = -INT_MAX;
609 info.idealy_f_ -= stem_length;
610 info.maxy_f_ -= minimum_length;
613 info.idealy_f_ = (info.maxy_f_ <? info.idealy_f_) >? info.miny_f_;
615 s = beam->get_elt_property ("shorten");
617 info.idealy_f_ -= gh_scm2double (s);
619 Real interstaff_f = -beam_dir* calc_interstaff_dist (dynamic_cast<Item*> (me), dynamic_cast<Spanner*> (beam));
621 info.idealy_f_ += interstaff_f;
622 info.miny_f_ += interstaff_f;
623 info.maxy_f_ += interstaff_f ;
629 Stem::has_interface (Score_element*m)
631 return m && m->has_interface (ly_symbol2scm ("stem-interface"));
635 Stem::set_interface (Score_element*me)
637 me->set_interface (ly_symbol2scm ("stem-interface"));