lily/include/beam.hh

   1 /*
   2   beam.hh -- part of GNU LilyPond
   3
   4   source file of the LilyPond music typesetter
   5
   6   (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7   Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 #ifndef BEAM_HH
  11 #define BEAM_HH
  12
  13 #include "std-vector.hh"
  14 #include "lily-proto.hh"
  15 #include "lily-guile.hh"
  16 #include "stem-info.hh"
  17
  18 /*
  19   TODO: move quanting in separate file.
  20 */
  21 struct Beam_quant_parameters
  22 {
  23   Real INTER_QUANT_PENALTY;
  24   Real SECONDARY_BEAM_DEMERIT;
  25   Real STEM_LENGTH_DEMERIT_FACTOR;
  26   Real REGION_SIZE;
  27
  28   /*
  29     threshold to combat rounding errors.
  30   */
  31   Real BEAM_EPS;
  32
  33   // possibly ridiculous, but too short stems just won't do
  34   Real STEM_LENGTH_LIMIT_PENALTY;
  35   Real DAMPING_DIRECTION_PENALTY;
  36   Real MUSICAL_DIRECTION_FACTOR;
  37   Real IDEAL_SLOPE_FACTOR;
  38   Real ROUND_TO_ZERO_SLOPE;
  39
  40   void fill (Grob *him);
  41 };
  42
  43 class Beam
  44 {
  45 public:
  46   static int visible_stem_count (Grob *);
  47   static Grob *first_visible_stem (Grob *);
  48   static Grob *last_visible_stem (Grob *);
  49   static bool has_interface (Grob *);
  50   static void add_stem (Grob *, Grob *);
  51   static bool is_knee (Grob *);
  52   static void set_beaming (Grob *, Beaming_info_list const *);
  53   static void set_stemlens (Grob *);
  54   static int get_beam_count (Grob *me);
  55   static Real get_beam_translation (Grob *me);
  56   static Real get_thickness (Grob *me);
  57   static void connect_beams (Grob *me);
  58
  59   DECLARE_SCHEME_CALLBACK (rest_collision_callback, (SCM element, SCM prev_off));
  60   DECLARE_SCHEME_CALLBACK (print, (SCM));
  61   DECLARE_SCHEME_CALLBACK (calc_beaming, (SCM));
  62   DECLARE_SCHEME_CALLBACK (calc_stem_shorten, (SCM));
  63   DECLARE_SCHEME_CALLBACK (calc_direction, (SCM));
  64   DECLARE_SCHEME_CALLBACK (calc_positions, (SCM));
  65   DECLARE_SCHEME_CALLBACK (calc_least_squares_positions, (SCM, SCM));
  66   DECLARE_SCHEME_CALLBACK (calc_concaveness, (SCM));
  67   DECLARE_SCHEME_CALLBACK (set_stem_lengths, (SCM));
  68
  69   /* position callbacks */
  70   DECLARE_SCHEME_CALLBACK (shift_region_to_valid, (SCM, SCM));
  71   DECLARE_SCHEME_CALLBACK (slope_damping, (SCM, SCM));
  72   DECLARE_SCHEME_CALLBACK (quanting, (SCM, SCM));
  73
  74 static Real score_slopes_dy (Real, Real, Real, Real, Real, bool, Beam_quant_parameters const *);
  75
  76   static Real score_stem_lengths (vector<Grob*> const &stems,
  77                                   vector<Stem_info> const &stem_infos,
  78                                   vector<Real> const &base_stem_ys,
  79                                   vector<Real> const &stem_xs,
  80                                   Real xl, Real xr,
  81                                   bool knee,
  82                                   Real yl, Real yr, Beam_quant_parameters const *);
  83   static Real score_forbidden_quants (Real, Real,
  84                                       Real, Real, Real, Real,
  85                                       Drul_array<int>, Direction, Direction,
  86                                       Beam_quant_parameters const *);
  87
  88   static int get_direction_beam_count (Grob *me, Direction d);
  89 private:
  90   static Direction get_default_dir (Grob *);
  91   static void set_stem_directions (Grob *, Direction);
  92   static void consider_auto_knees (Grob *);
  93   static void set_stem_shorten (Grob *);
  94   static Real calc_stem_y (Grob *, Grob *s, Grob **c,
  95                            Real, Real,
  96                            Drul_array<Real> pos, bool french);
  97   static int forced_stem_count (Grob *);
  98 };
  99
 100 #ifndef NDEBUG
 101 #define DEBUG_QUANTING 1
 102 #endif
 103
 104 #endif /* BEAM_HH */
 105