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
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 "cross-staff.hh"
28 #include "staff-symbol-referencer.hh"
33 Stem::set_beaming (Score_element*me ,int i, Direction d )
35 SCM pair = me->get_elt_property ("beaming");
37 if (!gh_pair_p (pair))
39 pair = gh_cons (gh_int2scm (0),gh_int2scm (0));
40 me-> set_elt_property ("beaming", pair);
42 index_set_cell (pair, d, gh_int2scm (i));
46 Stem::beam_count (Score_element*me,Direction d)
48 SCM p=me->get_elt_property ("beaming");
50 return gh_scm2int (index_cell (p,d));
56 Stem::head_positions (Score_element*me)
64 Drul_array<Score_element*> e (extremal_heads (me));
66 return Interval (Staff_symbol_referencer::position_f (e[DOWN]),
67 Staff_symbol_referencer::position_f ( e[UP]));
72 Stem::chord_start_f (Score_element*me)
74 return head_positions(me)[get_direction (me)]
75 * Staff_symbol_referencer::staff_space (me)/2.0;
79 Stem::stem_end_position (Score_element*me)
81 SCM p =me->get_elt_property ("stem-end-position");
86 pos = get_default_stem_end_position (me);
87 me->set_elt_property ("stem-end-position", gh_double2scm (pos));
90 pos = gh_scm2double (p);
96 Stem::get_direction (Score_element*me)
98 Direction d = Directional_element_interface::get (me);
102 d = get_default_dir (me);
104 Directional_element_interface::set (me, d);
111 Stem::set_stemend (Score_element*me, Real se)
114 Direction d= get_direction (me);
116 if (d && d * head_positions(me)[get_direction (me)] >= se*d)
117 warning (_ ("Weird stem size; check for narrow beams"));
119 me->set_elt_property ("stem-end-position", gh_double2scm (se));
123 Stem::type_i (Score_element*me)
125 return first_head (me) ? Rhythmic_head::balltype_i (first_head (me)) : 2;
129 Note head that determines hshift for upstems
132 Stem::support_head (Score_element*me)
134 SCM h = me->get_elt_property ("support-head");
135 Score_element * nh = unsmob_element (h);
138 else if (heads_i (me) == 1)
144 return unsmob_element (gh_car (me->get_elt_property ("heads")));
147 return first_head (me);
152 Stem::heads_i (Score_element*me)
154 return Pointer_group_interface::count (me, "heads");
158 The note head which forms one end of the stem.
161 Stem::first_head (Score_element*me)
163 return extremal_heads (me)[-get_direction (me)];
167 START is part where stem reaches `last' head.
169 Drul_array<Score_element*>
170 Stem::extremal_heads (Score_element*me)
172 const int inf = 1000000;
173 Drul_array<int> extpos;
177 Drul_array<Score_element *> exthead;
178 exthead[LEFT] = exthead[RIGHT] =0;
180 for (SCM s = me->get_elt_property ("heads"); gh_pair_p (s); s = gh_cdr (s))
182 Score_element * n = unsmob_element (gh_car (s));
185 int p = int(Staff_symbol_referencer::position_f (n));
189 if (d* p > d* extpos[d])
194 } while (flip (&d) != DOWN);
201 Stem::add_head (Score_element*me, Score_element *n)
203 n->set_elt_property ("stem", me->self_scm ());
204 n->add_dependency (me);
206 if (Note_head::has_interface (n))
208 Pointer_group_interface::add_element (me, "heads",n);
212 n->set_elt_property ("rest", n->self_scm ());
217 Stem::invisible_b (Score_element*me)
219 return !(heads_i (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1);
223 Stem::get_center_distance (Score_element*me, Direction d)
225 int staff_center = 0;
226 int distance = (int) (d*(head_positions(me)[d] - staff_center));
227 return distance >? 0;
231 Stem::get_default_dir (Score_element*me)
233 int du = get_center_distance (me,UP);
234 int dd = get_center_distance (me,DOWN);
237 return Direction (sign (dd -du));
239 return to_dir (me->get_elt_property ("default-neutral-direction"));
243 Stem::get_default_stem_end_position (Score_element*me)
245 bool grace_b = to_boolean (me->get_elt_property ("grace"));
250 SCM scm_len = me->get_elt_property("length");
251 if (gh_number_p (scm_len))
253 length_f = gh_scm2double (scm_len);
257 s = me->get_elt_property("lengths");
258 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
259 a.push (gh_scm2double (gh_car (q)));
261 // stem uses half-spaces
262 length_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
267 s = me->get_elt_property ("stem-shorten");
268 for (SCM q = s; gh_pair_p (q); q = gh_cdr (q))
269 a.push (gh_scm2double (gh_car (q)));
272 // stem uses half-spaces
274 // fixme: use gh_list_ref () iso. array[]
275 Real shorten_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
278 'set-default-stemlen' sets direction too
280 Direction dir = get_direction (me);
283 dir = get_default_dir (me);
284 Directional_element_interface::set (me, dir);
288 stems in unnatural (forced) direction should be shortened,
289 according to [Roush & Gourlay]
291 if (((int)chord_start_f (me))
292 && (get_direction (me) != get_default_dir (me)))
293 length_f -= shorten_f;
296 Real st = head_positions(me)[dir] + dir * length_f;
298 bool no_extend_b = to_boolean (me->get_elt_property ("no-stem-extend"));
299 if (!grace_b && !no_extend_b && dir * st < 0) // junkme?
306 Number of hooks on the flag, ie. the log of the duration.
309 Stem::flag_i (Score_element*me)
311 SCM s = me->get_elt_property ("duration-log");
312 return (gh_number_p (s)) ? gh_scm2int (s) : 2;
316 Stem::position_noteheads (Score_element*me)
321 Link_array<Score_element> heads =
322 Pointer_group_interface__extract_elements (me, (Score_element*)0, "heads");
324 heads.sort (compare_position);
325 Direction dir =get_direction (me);
331 Score_element *hed = support_head (me);
332 Real w = hed->extent (hed, X_AXIS)[dir];
333 for (int i=0; i < heads.size (); i++)
335 heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir], X_AXIS);
338 bool parity= true; // todo: make me settable.
339 int lastpos = int (Staff_symbol_referencer::position_f (heads[0]));
340 for (int i=1; i < heads.size (); i ++)
342 Real p = Staff_symbol_referencer::position_f (heads[i]);
343 int dy =abs (lastpos- (int)p);
349 Real l = heads[i]->extent (heads[i], X_AXIS).length ();
350 heads[i]->translate_axis (l * get_direction (me), X_AXIS);
361 MAKE_SCHEME_CALLBACK(Stem,before_line_breaking,1);
363 Stem::before_line_breaking (SCM smob)
365 Score_element*me = unsmob_element (smob);
366 stem_end_position (me); // ugh. Trigger direction calc.
367 position_noteheads (me);
369 if (invisible_b (me))
371 me->remove_elt_property ("molecule-callback");
375 set_spacing_hints (me);
376 return SCM_UNSPECIFIED;
382 set stem directions for hinting the optical spacing correction.
384 Modifies DIR_LIST property of the Stem's Paper_column
386 TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
389 Stem::set_spacing_hints (Score_element*me)
391 if (!invisible_b (me))
393 SCM scmdir = gh_int2scm (get_direction (me));
395 Item* item = dynamic_cast<Item*> (me);
396 Item * col = item->column_l ();
397 SCM dirlist =col->get_elt_property ("dir-list");
398 if (scm_sloppy_memq (scmdir, dirlist) == SCM_BOOL_F)
400 dirlist = gh_cons (scmdir, dirlist);
401 col->set_elt_property ("dir-list", dirlist);
407 Stem::flag (Score_element*me)
410 SCM st = me->get_elt_property ("flag-style");
411 if ( gh_string_p (st))
413 style = ly_scm2string (st);
416 char c = (get_direction (me) == UP) ? 'u' : 'd';
417 Molecule m = Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) +
418 to_str (flag_i (me)));
419 if (!style.empty_b ())
420 m.add_molecule(Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + style));
424 MAKE_SCHEME_CALLBACK(Stem,dim_callback,2);
426 Stem::dim_callback (SCM e, SCM ax)
428 Axis a = (Axis) gh_scm2int (ax);
429 assert (a == X_AXIS);
430 Score_element *se = unsmob_element (e);
432 if (unsmob_element (se->get_elt_property ("beam")) || abs (flag_i (se)) <= 2)
436 r = flag (se).extent (X_AXIS);
438 return ly_interval2scm ( r);
442 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh! Should be settable.
445 MAKE_SCHEME_CALLBACK(Stem,brew_molecule,1);
448 Stem::brew_molecule (SCM smob)
450 Score_element*me = unsmob_element (smob);
452 Direction d = get_direction (me);
455 Real y1 = Staff_symbol_referencer::position_f (first_head (me));
456 Real y2 = stem_end_position (me);
458 Interval stem_y(y1,y2);
459 stem_y.unite (Interval (y2,y1));
461 Real dy = Staff_symbol_referencer::staff_space (me)/2.0;
464 if (Score_element *hed = support_head (me))
465 head_wid = hed->extent (hed,X_AXIS).length ();
466 stem_y[Direction(-d)] += d * head_wid * tan(ANGLE)/(2*dy);
468 if (!invisible_b (me))
470 Real stem_width = gh_scm2double (me->get_elt_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
471 Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2),
472 Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
473 mol.add_molecule (ss);
476 if (!beam_l (me) && abs (flag_i (me)) > 2)
478 Molecule fl = flag (me);
479 fl.translate_axis(stem_y[d]*dy, Y_AXIS);
480 mol.add_molecule (fl);
483 return mol.smobbed_copy ();
486 MAKE_SCHEME_CALLBACK(Stem,off_callback,2);
488 Stem::off_callback (SCM element_smob, SCM )
490 Score_element *me = unsmob_element (element_smob);
493 if (Score_element * f = first_head (me))
495 Interval head_wid(0, f->extent (f,X_AXIS).length ());
497 if (to_boolean (me->get_elt_property ("stem-centered")))
498 return gh_double2scm ( head_wid.center ());
500 Real rule_thick = gh_scm2double (me->get_elt_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
501 Direction d = get_direction (me);
502 r = head_wid[d] - d * rule_thick ;
504 return gh_double2scm (r);
510 Stem::beam_l (Score_element*me)
512 SCM b= me->get_elt_property ("beam");
513 return unsmob_element (b);
517 // ugh still very long.
519 Stem::calc_stem_info (Score_element*me)
521 Score_element * beam = beam_l (me);
523 Direction beam_dir = Directional_element_interface::get (beam);
526 programming_error ("Beam dir not set.");
531 Real staff_space = Staff_symbol_referencer::staff_space (me);
532 Real half_space = staff_space / 2;
533 int multiplicity = Beam::get_multiplicity (beam);
536 SCM space_proc = beam->get_elt_property ("space-function");
537 SCM space = gh_call1 (space_proc, gh_int2scm (multiplicity));
538 Real interbeam_f = gh_scm2double (space) * staff_space;
540 Real thick = gh_scm2double (beam->get_elt_property ("thickness"));
542 info.idealy_f_ = chord_start_f (me);
544 // for simplicity, we calculate as if dir == UP
545 info.idealy_f_ *= beam_dir;
546 SCM grace_prop = me->get_elt_property ("grace");
548 bool grace_b = to_boolean (grace_prop);
553 s = me->get_elt_property("beamed-minimum-lengths");
555 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
556 a.push (gh_scm2double (gh_car (q)));
559 Real minimum_length = a[multiplicity <? (a.size () - 1)] * staff_space;
560 s = me->get_elt_property ("beamed-lengths");
563 for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
564 a.push (gh_scm2double (gh_car (q)));
566 Real stem_length = a[multiplicity <? (a.size () - 1)] * staff_space;
568 if (!beam_dir || (beam_dir == Directional_element_interface::get (me)))
569 /* normal beamed stem */
573 info.idealy_f_ += thick + (multiplicity - 1) * interbeam_f;
575 info.miny_f_ = info.idealy_f_;
576 info.maxy_f_ = INT_MAX;
578 info.idealy_f_ += stem_length;
579 info.miny_f_ += minimum_length;
582 lowest beam of (UP) beam must never be lower than second staffline
584 Hmm, reference (Wanske?)
586 Although this (additional) rule is probably correct,
587 I expect that highest beam (UP) should also never be lower
588 than middle staffline, just as normal stems.
591 bool no_extend_b = to_boolean (me->get_elt_property ("no-stem-extend"));
592 if (!grace_b && !no_extend_b)
594 /* highest beam of (UP) beam must never be lower than middle
596 lowest beam of (UP) beam must never be lower than second staffline
600 >? (- 2 * half_space - thick
601 + (multiplicity > 0) * thick
602 + interbeam_f * (multiplicity - 1));
608 info.idealy_f_ -= thick;
609 info.maxy_f_ = info.idealy_f_;
610 info.miny_f_ = -INT_MAX;
612 info.idealy_f_ -= stem_length;
613 info.maxy_f_ -= minimum_length;
616 info.idealy_f_ = (info.maxy_f_ <? info.idealy_f_) >? info.miny_f_;
618 s = beam->get_elt_property ("shorten");
620 info.idealy_f_ -= gh_scm2double (s);
622 Real interstaff_f = -beam_dir* calc_interstaff_dist (dynamic_cast<Item*> (me), dynamic_cast<Spanner*> (beam));
624 info.idealy_f_ += interstaff_f;
625 info.miny_f_ += interstaff_f;
626 info.maxy_f_ += interstaff_f ;
632 Stem::has_interface (Score_element*m)
634 return m && m->has_interface (ly_symbol2scm ("stem-interface"));
638 Stem::set_interface (Score_element*me)
640 me->set_interface (ly_symbol2scm ("stem-interface"));