source file of the GNU LilyPond music typesetter
- (c) 2002--2003 Juergen Reuter <reuter@ipd.uka.de>
+ (c) 2002--2006 Juergen Reuter <reuter@ipd.uka.de>
*/
+#include "ambitus.hh"
+
#include "staff-symbol-referencer.hh"
#include "pitch.hh"
-#include "ambitus.hh"
-#include "molecule.hh"
#include "note-head.hh"
#include "item.hh"
#include "font-interface.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
#include "lookup.hh"
+#include "pointer-group-interface.hh"
-/*
- * TODO: note-head collision handling
- *
- * TODO: accidentals collision handling
- *
- * TODO: alternative representation: adding the ambitus as text script
- * to the instrument name (e.g. "Soprano (c^1 - f^2)").
- *
- * FIXME: Accidentals are too close at the note heads (it seems that
- * the extent of the ledger lines is ignored).
- *
- * TODO: If (depending on breakAlignOrder) ambitus is put behind
- * key-signature, then do not repeat accidentals that already appear
- * in the key signature.
- *
- * FIXME: A staff containing more than a single context will result in
- * multiple ambitus grobs per staff. This is basically ok, but there is
- * currently no proper collision handling for this case.
- *
- * TODO: make ignore_octave and force_accidental of function
- * number_accidentals accessible via grob properties.
- */
-
-/**
- Given a pitch and a key_signature, decide what accidentals to show.
-
- Possible return values:
-
- 0: do not show any accidental
- 1: show pitch->alteration_ only
- 2: show pitch->get_alteration, preceded by a natural sign
-
- UGH: code duplication! See accidental-engraver.
-
- */
-static int
-number_accidentals (SCM key_signature, Pitch *pitch,
- bool ignore_octave_b, bool force_accidental)
-{
- int notename = pitch->get_notename ();
- int octave = pitch->get_octave();
- int alteration = pitch->get_alteration();
-
- if (force_accidental) // ignore key signature
- return 1;
-
-
-#if DEBUG_AMBITUS
- scm_display (key_signature, scm_current_output_port ());
-#endif
-
- SCM prev;
- if (ignore_octave_b)
- prev = ly_assoc_cdr (scm_int2num (notename), key_signature);
- else
- prev = scm_assoc (gh_cons (scm_int2num (octave), scm_int2num (notename)),
- key_signature);
-
- /* should really be true unless prev == SCM_BOOL_F */
- if (gh_pair_p (prev) && gh_pair_p (ly_cdr (prev)))
- {
- prev = gh_cons (ly_car (prev), ly_cadr (prev));
- }
-
- /* If an accidental was not found */
- if (prev == SCM_BOOL_F)
- prev = scm_assoc (scm_int2num (notename), key_signature);
-
- SCM prev_acc = (prev == SCM_BOOL_F) ? scm_int2num (0) : ly_cdr (prev);
- int sig_alteration = gh_number_p (prev_acc) ? gh_scm2int (prev_acc) : 0;
-
- if (alteration == sig_alteration) // no accidental at all needed
- return 0;
-
- if ((alteration == 0) && (sig_alteration != 0)) // need ordinary natural
- return 2;
-
- if (sig_alteration == 0) // use pitch's alteration
- return 1;
-
- return 2;
-}
-
-void
-add_accidentals (Item *me, Molecule *head, int num_acc,
- Pitch *pitch, String accidentals_style, Real yoffs)
-{
- if (!num_acc)
- return;
- if (pitch->get_alteration())
- {
- Molecule accidental (Font_interface::get_default_font (me)->
- find_by_name (String ("accidentals-") +
- accidentals_style +
- to_string (pitch->get_alteration ())));
- accidental.translate_axis (yoffs, Y_AXIS);
- head->add_at_edge (X_AXIS, LEFT, accidental, 0.1, 0);
- }
- if (num_acc == 2)
- {
- Molecule natural (Font_interface::get_default_font (me)->
- find_by_name (String ("accidentals-") +
- accidentals_style +
- to_string ("0")));
- natural.translate_axis (yoffs, Y_AXIS);
- head->add_at_edge (X_AXIS, LEFT, natural, 0.1, 0);
- }
-}
-
-MAKE_SCHEME_CALLBACK (Ambitus,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Ambitus, print, 1);
SCM
-Ambitus::brew_molecule (SCM smob)
+Ambitus::print (SCM smob)
{
- Item *me = (Item *)unsmob_grob (smob);
- Molecule molecule = Molecule ();
-
- SCM scm_note_head_style = me->get_grob_property ("note-head-style");
- String note_head_style;
- if (gh_symbol_p (scm_note_head_style))
- {
- String note_head_style =
- ly_symbol2string (scm_note_head_style);
- }
- else
- {
- note_head_style = String ("noteheads-2");
- }
- if (Font_interface::get_default_font (me)->find_by_name (note_head_style).is_empty ())
- {
- String message = "Ambitus: no such note head: `" + note_head_style + "'";
- me->warning (_ (message.to_str0 ()));
- return SCM_EOL;
- }
+ Item *me = (Item *) unsmob_grob (smob);
+ Stencil stencil;
- /*
- FIXME: Use positions.
- */
- int p_min, p_max;
- Pitch *pitch_min = unsmob_pitch (me->get_grob_property ("pitch-min"));
- if (!pitch_min)
- {
- me->programming_error("Ambitus: pitch_min undefined; assuming 0");
- p_min = 0;
- }
- else
+ // FIXME : should be Ambitus_line join heads
+ extract_grob_set (me, "note-heads", heads);
+ if (to_boolean (me->get_property ("join-heads"))
+ && heads.size () > 1)
{
- p_min = pitch_min->steps ();
- }
- Pitch *pitch_max = unsmob_pitch (me->get_grob_property ("pitch-max"));
- if (!pitch_max)
- {
- me->programming_error("Ambitus: pitch_max undefined; assuming 0");
- p_max = 0;
- }
- else
- {
- p_max = pitch_max->steps ();
- }
- if (p_min > p_max)
- {
- me->programming_error ("Ambitus: reverse range");
+ Grob *common
+ = common_refpoint_of_array (vector<Grob*> (heads.begin (),
+ heads.begin () + 2),
+ me, Y_AXIS);
+
+ Grob *minh = heads[0];
+ Grob *maxh = heads[1];
+
+ if (minh->relative_coordinate (common, Y_AXIS)
+ > maxh->relative_coordinate (common, Y_AXIS))
+ {
+ Grob *t = maxh;
+ maxh = minh;
+ minh = t;
+ }
+
+ Real pad = 0.35;
+ Real pmax = maxh->extent (common, Y_AXIS)[DOWN] - pad;
+ Real pmin = minh->extent (common, Y_AXIS)[UP] + pad;
+
+ if (pmin < pmax)
+ {
+ Real linethickness = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"))
+ * robust_scm2double (me->get_property ("thickness"), 1.0);
+ Real blotdiameter = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+ Interval x_extent = 0.5 * linethickness * Interval (-1, 1);
+ Interval y_extent = Interval (pmin, pmax);
+ Box line_box (x_extent, y_extent);
+
+ Stencil line = Lookup::round_filled_box (line_box, blotdiameter);
+ line.translate_axis (- me->relative_coordinate (common, Y_AXIS),
+ Y_AXIS);
+ return line.smobbed_copy ();
+ }
}
- SCM c0 = me->get_grob_property ("c0-position");
- if (gh_number_p (c0))
- {
- p_min += gh_scm2int (c0);
- p_max += gh_scm2int (c0);
- }
-
- // create heads
- Molecule head_min =
- Font_interface::get_default_font (me)->find_by_name (note_head_style);
- head_min.translate_axis (0.5*p_min, Y_AXIS);
- Molecule head_max =
- Font_interface::get_default_font (me)->find_by_name (note_head_style);
- head_max.translate_axis (0.5*p_max, Y_AXIS);
-
- // join heads
- if (to_boolean (me->get_grob_property ("join-heads")) &&
- ((p_max - p_min) >= 3))
- {
- Real linethickness = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
- Real blotdiameter = me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
- Interval x_extent = 0.5 * Interval (-linethickness, +linethickness);
- Interval y_extent = 0.5 * Interval (p_min + 1.35, p_max - 1.35);
- Box line_box (x_extent, y_extent);
- Molecule line = Lookup::round_filled_box (line_box, blotdiameter);
- line.translate_axis (0.5 * head_min.extent (X_AXIS).length (), X_AXIS);
- molecule.add_molecule (line);
- }
-
- // add ledger lines
- Interval hd = head_min.extent (X_AXIS);
- Real left_ledger_protusion = hd.length () / 4;
- Real right_ledger_protusion = left_ledger_protusion;
- Interval l_extents = Interval (hd[LEFT] - left_ledger_protusion,
- hd[RIGHT] + right_ledger_protusion);
- Molecule ledger_lines;
- int interspaces = Staff_symbol_referencer::line_count (me) - 1;
- ledger_lines =
- Note_head::brew_ledger_lines (me, p_min, interspaces, l_extents, 0,true);
- ledger_lines.translate_axis (0.5 * p_min, Y_AXIS);
- molecule.add_molecule (ledger_lines);
- ledger_lines =
- Note_head::brew_ledger_lines (me, p_max, interspaces, l_extents, 0, true);
- ledger_lines.translate_axis (0.5 * p_max, Y_AXIS);
- molecule.add_molecule (ledger_lines);
-
- // add accidentals
- SCM key_signature = me->get_grob_property ("key-signature");
- SCM scm_accidentals_style = me->get_grob_property ("accidentals-style");
- String accidentals_style;
- if (gh_symbol_p (scm_accidentals_style))
- {
- accidentals_style =
- ly_symbol2string (scm_accidentals_style);
- }
- else
- {
- accidentals_style = String ("");
- }
- int num_acc;
- num_acc = number_accidentals (key_signature, pitch_min, true, false);
- add_accidentals (me, &head_min, num_acc, pitch_min,
- accidentals_style, 0.5 * p_min);
- num_acc = number_accidentals (key_signature, pitch_max, true, false);
- add_accidentals (me, &head_max, num_acc, pitch_max,
- accidentals_style, 0.5 * p_max);
-
- // add heads
- molecule.add_molecule (head_min);
- molecule.add_molecule (head_max);
-
- return molecule.smobbed_copy ();
+ return SCM_EOL;
}
-ADD_INTERFACE (Ambitus, "ambitus-interface",
- "An ambitus represents the pitch range of a voice.",
- "c0-position pitch-min pitch-max accidentals note-head-style join-heads");
+ADD_INTERFACE (Ambitus ,
+ "The line between note heads for a pitch range.",
+
+ /* props */
+ "join-heads "
+ "note-heads "
+ "thickness "
+ );