lily/mensural-ligature.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2002--2011 Juergen Reuter <reuter@ipd.uka.de>,
   5   Pal Benko <benkop@freestart.hu>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "mensural-ligature.hh"
  22
  23 #include "directional-element-interface.hh"
  24 #include "font-interface.hh"
  25 #include "international.hh"
  26 #include "item.hh"
  27 #include "lookup.hh"
  28 #include "note-head.hh"
  29 #include "output-def.hh"
  30 #include "staff-symbol-referencer.hh"
  31 #include "warn.hh"
  32
  33 /*
  34   draws one half a flexa, i.e. a portion corresponding to a single note.
  35   this way coloration of the two notes building up the flexa can be
  36   handled independently.
  37
  38  * TODO: divide this function into mensural and neo-mensural style.
  39  *
  40  * TODO: move this function to class Lookup?
  41  */
  42 Stencil
  43 brew_flexa (Grob *me,
  44             bool solid,
  45             Real width,
  46             Real thickness,
  47             bool begin)
  48 {
  49   Real staff_space = Staff_symbol_referencer::staff_space (me);
  50
  51   /*
  52     The thickness of the horizontal lines of the flexa shape
  53     should be equal to that of the horizontal lines of the
  54     neomensural brevis note head (see mf/parmesan-heads.mf).
  55   */
  56   Real const horizontal_line_thickness = staff_space * 0.35;
  57
  58   // URGH!  vertical_line_thickness is adjustable (via thickness
  59   // property), while horizontal_line_thickness is constant.
  60   // Maybe both should be adjustable independently?
  61
  62   Real height = staff_space - horizontal_line_thickness;
  63   Stencil stencil;
  64   Real const interval
  65     = robust_scm2double (me->get_property ("flexa-interval"), 0.0);
  66   Real slope = (interval / 2.0 * staff_space) / width;
  67
  68   // Compensate optical illusion regarding vertical position of left
  69   // and right endings due to slope.
  70   Real ypos_correction = -0.1 * staff_space * sign (slope);
  71   Real slope_correction = 0.2 * staff_space * sign (slope);
  72   Real corrected_slope = slope + slope_correction / width;
  73
  74   if (solid) // colorated flexae
  75     {
  76       stencil = Lookup::beam (corrected_slope, width * 0.5, staff_space, 0.0);
  77     }
  78   else // outline
  79     {
  80       stencil = Lookup::beam (corrected_slope, thickness, height, 0.0);
  81       if (!begin)
  82         {
  83           stencil.translate_axis (width * 0.5 - thickness, X_AXIS);
  84           stencil.translate_axis (corrected_slope * (width * 0.5 - thickness),
  85                                   Y_AXIS);
  86         }
  87
  88       Stencil bottom_edge
  89         = Lookup::beam (corrected_slope, width * 0.5, horizontal_line_thickness,
  90                         0.0);
  91       bottom_edge.translate_axis (-0.5 * height, Y_AXIS);
  92       stencil.add_stencil (bottom_edge);
  93
  94       Stencil top_edge
  95         = Lookup::beam (corrected_slope, width * 0.5, horizontal_line_thickness,
  96                         0.0);
  97       top_edge.translate_axis (+0.5 * height, Y_AXIS);
  98       stencil.add_stencil (top_edge);
  99     }
 100
 101   if (begin)
 102     stencil.translate_axis (ypos_correction, Y_AXIS);
 103   else
 104     {
 105       stencil.translate_axis (0.5 * thickness, X_AXIS);
 106
 107       stencil.translate_axis (interval / -4.0 * staff_space, Y_AXIS);
 108     }
 109
 110   return stencil;
 111 }
 112
 113 Stencil
 114 internal_brew_primitive (Grob *me)
 115 {
 116   SCM primitive_scm = me->get_property ("primitive");
 117   if (primitive_scm == SCM_EOL)
 118     {
 119       programming_error ("Mensural_ligature:"
 120                          " undefined primitive -> ignoring grob");
 121       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
 122     }
 123   int primitive = scm_to_int (primitive_scm);
 124
 125   Real thickness = 0.0;
 126   Real width = 0.0;
 127   Real flexa_width = 0.0;
 128   Real staff_space = Staff_symbol_referencer::staff_space (me);
 129
 130   SCM style = me->get_property ("style");
 131   bool const black
 132     = scm_is_eq (style, ly_symbol2scm ("blackpetrucci"));
 133   bool const semi
 134     = scm_is_eq (style, ly_symbol2scm ("semipetrucci"));
 135
 136   if (primitive & MLP_ANY)
 137     {
 138       thickness = robust_scm2double (me->get_property ("thickness"), .13);
 139       width = robust_scm2double (me->get_property ("head-width"), staff_space);
 140     }
 141   if (primitive & MLP_FLEXA)
 142     flexa_width = robust_scm2double (me->get_property ("flexa-width"), 2.0)
 143                   * staff_space;
 144
 145   Stencil out;
 146   int const note_shape = primitive & MLP_ANY;
 147   int duration_log = 0;
 148   Font_metric *fm = Font_interface::get_default_font (me);
 149   string prefix = "noteheads.";
 150   string index;
 151   string suffix;
 152   string color = "";
 153   if (black)
 154     color = "black";
 155   if (semi)
 156     color = "semi";
 157
 158   switch (note_shape)
 159     {
 160     case MLP_NONE:
 161       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
 162     case MLP_MAXIMA:
 163       duration_log--;
 164     case MLP_LONGA:
 165       duration_log--;
 166     case MLP_BREVIS:
 167       duration_log--;
 168       suffix = to_string (duration_log) + color
 169                       + (duration_log == -3 ? "lig" : "") + "mensural";
 170       index = prefix + "s";
 171       out = fm->find_by_name (index + suffix);
 172       if (out.is_empty ())
 173         index = prefix + "d";
 174       out = fm->find_by_name (index + "r" + suffix);
 175       if (!out.is_empty ()
 176           && !Staff_symbol_referencer::on_line
 177               (me,
 178                robust_scm2int (me->get_property ("staff-position"), 0)))
 179         index += "r";
 180       out = fm->find_by_name (index + suffix);
 181       break;
 182     case MLP_FLEXA_BEGIN:
 183     case MLP_FLEXA_END:
 184       out = brew_flexa (me, black, flexa_width, thickness,
 185                         note_shape == MLP_FLEXA_BEGIN);
 186       break;
 187     default:
 188       programming_error ("Mensural_ligature:"
 189                          " unexpected case fall-through");
 190       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
 191     }
 192
 193   Real blotdiameter
 194     = (me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")));
 195
 196   if (primitive & MLP_STEM)
 197     {
 198       // assume MLP_UP
 199       Real y_bottom = 0.5 * staff_space, y_top = 2.5 * staff_space;
 200
 201       if (primitive & MLP_DOWN)
 202         {
 203           y_bottom = -y_top;
 204           y_top = -0.5 * staff_space;
 205         }
 206
 207       Interval x_extent (0, thickness);
 208       Interval y_extent (y_bottom, y_top);
 209       Box join_box (x_extent, y_extent);
 210
 211       Stencil join = Lookup::round_filled_box (join_box, blotdiameter);
 212       out.add_stencil (join);
 213     }
 214
 215   if (to_boolean (me->get_property ("add-join")))
 216     {
 217       int join_right = scm_to_int (me->get_property ("delta-position"));
 218       if (join_right)
 219         {
 220           Real y_top = join_right * 0.5 * staff_space;
 221           Real y_bottom = 0.0;
 222
 223           if (y_top < 0.0)
 224             {
 225               y_bottom = y_top;
 226               y_top = 0.0;
 227
 228               /*
 229                 if the previous note is longa-shaped,
 230                 the joining line may hide the stem, so made it longer
 231                 to serve as stem as well
 232               */
 233               if (primitive & MLP_LONGA)
 234                 /*
 235                   instead of 3.0 the length of a longa stem should be used
 236                   Font_interface::get_default_font (???)->find_by_name
 237                   ("noteheads.s-2mensural").extent (Y_AXIS).length () * 0.5
 238                 */
 239                 y_bottom -= 2.5 * staff_space;
 240             }
 241
 242           Interval x_extent (width - thickness, width);
 243           Interval y_extent (y_bottom, y_top);
 244           Box join_box (x_extent, y_extent);
 245           Stencil join = Lookup::round_filled_box (join_box, blotdiameter);
 246
 247           out.add_stencil (join);
 248         }
 249       else
 250         programming_error ("Mensural_ligature: (join_right == 0)");
 251     }
 252
 253 #if 0 /* what happend with the ledger lines? */
 254   int pos = Staff_symbol_referencer::get_rounded_position (me);
 255   if (primitive & MLP_FLEXA)
 256     {
 257       pos += delta_pitch;
 258       add_ledger_lines (me, &out, pos, 0.5 * delta_pitch, ledger_take_space);
 259     }
 260 #endif
 261
 262   return out;
 263 }
 264
 265 MAKE_SCHEME_CALLBACK (Mensural_ligature, brew_ligature_primitive, 1);
 266 SCM
 267 Mensural_ligature::brew_ligature_primitive (SCM smob)
 268 {
 269   Grob *me = unsmob_grob (smob);
 270   return internal_brew_primitive (me).smobbed_copy ();
 271 }
 272
 273 MAKE_SCHEME_CALLBACK (Mensural_ligature, print, 1);
 274 SCM
 275 Mensural_ligature::print (SCM)
 276 {
 277   return SCM_EOL;
 278 }
 279
 280 ADD_INTERFACE (Mensural_ligature,
 281                "A mensural ligature.",
 282
 283                /* properties */
 284                "delta-position "
 285                "ligature-flexa "
 286                "head-width "
 287                "add-join "
 288                "flexa-interval "
 289                "primitive "
 290                "thickness "
 291               );