Run `make grand-replace'.

[lilypond.git] / lily / include / beam.hh

diff --git a/lily/include/beam.hh b/lily/include/beam.hh
index c1eb843b1a261a9703600b7ef50d289bccc16ec0..a9b30b678668e1020b9b9e2f1a0aea2d8b552656 100644 (file)
--- a/lily/include/beam.hh
+++ b/lily/include/beam.hh
@@ -1,58 +1,133 @@
 /*
   beam.hh -- part of GNU LilyPond
 
-  (c) 1996--2000 Han-Wen Nienhuys
+  source file of the LilyPond music typesetter
+
+  (c) 1996--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
 #ifndef BEAM_HH
 #define BEAM_HH
 
+#include "grob-interface.hh"
+#include "std-vector.hh"
 #include "lily-proto.hh"
-#include "lily-guile.hh"
+#include "stem-info.hh"
+
+/*
+  TODO: move quanting in separate file.
+*/
+struct Beam_quant_parameters
+{
+  Real INTER_QUANT_PENALTY;
+  Real SECONDARY_BEAM_DEMERIT;
+  Real STEM_LENGTH_DEMERIT_FACTOR;
+  Real REGION_SIZE;
 
+  /*
+    threshold to combat rounding errors.
+  */
+  Real BEAM_EPS;
+
+  // possibly ridiculous, but too short stems just won't do
+  Real STEM_LENGTH_LIMIT_PENALTY;
+  Real DAMPING_DIRECTION_PENALTY;
+  Real MUSICAL_DIRECTION_FACTOR;
+  Real HINT_DIRECTION_PENALTY;
+  Real IDEAL_SLOPE_FACTOR;
+  Real ROUND_TO_ZERO_SLOPE;
 
+  void fill (Grob *him);
+};
+
+struct Beam_segment
+{
+  int vertical_count_;
+  Interval horizontal_; 
+  Beam_segment ();
+};
+
+struct Beam_stem_segment 
+{
+  Beam_stem_segment ();
+
+  Grob *stem_;
+  Real width_;
+  Real stem_x_;
+  int rank_;
+  vsize stem_index_;
+  bool gapped_;
+  Direction dir_;
+  int max_connect_;
+  
+};
+
+
+bool operator <(Beam_stem_segment const &a, Beam_stem_segment const &b);
 
 class Beam
 {
 public:
-  static int visible_stem_count (Grob*);
-  static Item* first_visible_stem (Grob*);
-  static Item* last_visible_stem (Grob*);
-  static bool has_interface (Grob*);
-  static void set_interface (Grob*);  
-  DECLARE_SCHEME_CALLBACK(rest_collision_callback, (SCM element, SCM axis));
-  Beam (SCM);
-  static void add_stem (Grob*,Grob*);
-  static void set_beaming (Grob*,Beaming_info_list *);
-  static void set_stemlens (Grob*);
-  static int get_multiplicity (Grob*me);
-  DECLARE_SCHEME_CALLBACK(brew_molecule, (SCM ));
-  DECLARE_SCHEME_CALLBACK(before_line_breaking, (SCM ));
-  DECLARE_SCHEME_CALLBACK(after_line_breaking, (SCM ));
+  static int normal_stem_count (Grob *);
+  static Grob *first_normal_stem (Grob *);
+  static Grob *last_normal_stem (Grob *);
+  DECLARE_GROB_INTERFACE();
+  static void add_stem (Grob *, Grob *);
+  static bool is_cross_staff (Grob *);
+  static bool is_knee (Grob *);
+  static void set_beaming (Grob *, Beaming_pattern const *);
+  static void set_stemlens (Grob *);
+  static int get_beam_count (Grob *me);
+  static Real get_beam_translation (Grob *me);
+  static Real get_thickness (Grob *me);
+  static void connect_beams (Grob *me);
+  static vector<Beam_segment> get_beam_segments (Grob *me_grob, Grob **common); 
+  static Interval no_visible_stem_positions (Grob *me, Interval default_value);
+  
+  DECLARE_SCHEME_CALLBACK (rest_collision_callback, (SCM element, SCM prev_off));
+  DECLARE_SCHEME_CALLBACK (print, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_beaming, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_stem_shorten, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_direction, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_positions, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_least_squares_positions, (SCM, SCM));
+  DECLARE_SCHEME_CALLBACK (calc_normal_stems, (SCM));  
+  DECLARE_SCHEME_CALLBACK (calc_concaveness, (SCM));
+  DECLARE_SCHEME_CALLBACK (set_stem_lengths, (SCM));
+  DECLARE_SCHEME_CALLBACK (calc_cross_staff, (SCM));
 
-  /*
-    y-dy callbacks
-   */
-  DECLARE_SCHEME_CALLBACK (least_squares, (SCM));
-  DECLARE_SCHEME_CALLBACK (cancel_suspect_slope, (SCM));
-  DECLARE_SCHEME_CALLBACK (slope_damping, (SCM));
-  DECLARE_SCHEME_CALLBACK (quantise_dy, (SCM));
-  DECLARE_SCHEME_CALLBACK (user_override, (SCM));
-  DECLARE_SCHEME_CALLBACK (do_quantise_y, (SCM));
+  /* position callbacks */
+  DECLARE_SCHEME_CALLBACK (shift_region_to_valid, (SCM, SCM));
+  DECLARE_SCHEME_CALLBACK (slope_damping, (SCM, SCM));
+  DECLARE_SCHEME_CALLBACK (quanting, (SCM, SCM));
+  
+static Real score_slopes_dy (Real, Real, Real, Real, Real, bool, Beam_quant_parameters const *);
 
-  static Molecule stem_beams (Grob*,Item *here, Item *next, Item *prev);
+  static Real score_stem_lengths (vector<Grob*> const &stems,
+                                 vector<Stem_info> const &stem_infos,
+                                 vector<Real> const &base_stem_ys,
+                                 vector<Real> const &stem_xs,
+                                 Real xl, Real xr,
+                                 bool knee,
+                                 Real yl, Real yr, Beam_quant_parameters const *);
+  static Real score_forbidden_quants (Real, Real,
+                                     Real, Real, Real, Real,
+                                     Drul_array<int>, Direction, Direction,
+                                     Beam_quant_parameters const *);
 
+  static int get_direction_beam_count (Grob *me, Direction d);
 private:
-  static Direction get_default_dir (Grob*);
-  static void set_stem_directions (Grob*);
-  static void consider_auto_knees (Grob*);
-  static void set_stem_shorten (Grob*);
-  static Real calc_stem_y_f (Grob*, Item* s, Real y, Real dy);
-  static Real check_stem_length_f (Grob*, Real y, Real dy);
-  static void set_stem_lengths (Grob*);
-  static Real quantise_y_f (Grob*, Real y, Real dy, int quant_dir);
-  static int forced_stem_count (Grob*);
+  static Direction get_default_dir (Grob *);
+  static void set_stem_directions (Grob *, Direction);
+  static void consider_auto_knees (Grob *);
+  static void set_stem_shorten (Grob *);
+  static Real calc_stem_y (Grob *, Grob *s, Grob **c,
+                          Real, Real, Direction,
+                          Drul_array<Real> pos, bool french);
+  static int forced_stem_count (Grob *);
 };
 
+
 #endif /* BEAM_HH */