]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/beam.hh
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / include / beam.hh
index 2310752807e88100c5da759bbe9b3a356dabf963..e505cd670926a193e10fb57dbd1e7452ddb4d135 100644 (file)
 /*
   beam.hh -- part of GNU LilyPond
 
-  (c) 1996--2000 Han-Wen Nienhuys
+  source file of the LilyPond music typesetter
+
+  (c) 1996--2007 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"
-
-
-/** a beam connects multiple stems.
-
-  Beam adjusts the stems its owns to make sure that they reach the
-  beam and that point in the correct direction (urg?)
-
-   elt_properties:
-   
-   y-position -- real  (position of left edge)
+#include "stem-info.hh"
 
-   height -- real  (dy)
-
-   damping -- amount of beam slope damping. (int)
-   should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams 
-
-
-   molecule-callback --
+/*
+  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);
+};
 
-   beam-thickness -- weight of beams, in staffspace
+struct Beam_segment
+{
+  int vertical_count_;
+  Interval horizontal_; 
+  Beam_segment ();
+};
 
-   beam-space-function -- function of type multiplicity -> real (in staffspace)
+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_;
+  
+};
 
-   default-neutral-direction -- which direction to choose if we're in
-     the middle of the staff
-   
-   after-line-breaking-callback --
 
-   damping -- damping factor (real).
+bool operator <(Beam_stem_segment const &a, Beam_stem_segment const &b);
 
-   
-*/
 class Beam
 {
 public:
-  static int visible_stem_count (Score_element*);
-  static  Item* first_visible_stem (Score_element*);
-  static  Item* last_visible_stem (Score_element*);
-  static bool has_interface (Score_element*);
-  static void set_interface (Score_element*);  
-  static Real rest_collision_callback (Score_element *,Axis);
-  Beam (SCM);
-  static void add_stem (Score_element*,Score_element*);
-  static void set_beaming (Score_element*,Beaming_info_list *);
-  static void set_stemlens (Score_element*);
-  static int get_multiplicity (Score_element*me);
-  static SCM brew_molecule (SCM);
-  static SCM before_line_breaking (SCM);
-  static SCM after_line_breaking (SCM);
-  static Molecule stem_beams (Score_element*,Item *here, Item *next, Item *prev);
-
+  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); 
+  
+  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 (cross_staff, (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 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 (Score_element*);
-  static  void set_stem_directions (Score_element*);
-  static  void auto_knees (Score_element*);
-  static  bool auto_knee (Score_element*,String gap_str, bool interstaff_b);
-  static void set_stem_shorten (Score_element*);
-  static  void calc_default_position_and_height (Score_element*,Real* y, Real* dy);
-  static  bool suspect_slope_b (Score_element*, Real y, Real dy);
-  static  Real calc_slope_damping_f (Score_element*, Real dy);
-  static  Real calc_stem_y_f (Score_element*, Item* s, Real y, Real dy);
-  static  Real check_stem_length_f (Score_element*, Real y, Real dy);
-  static  void set_stem_length (Score_element*, Real y, Real dy);
-  static   Real quantise_dy_f (Score_element*, Real dy);
-  static  Real quantise_y_f (Score_element*, Real y, Real dy, int quant_dir);
-  static int forced_stem_count (Score_element*);
+  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,
+                          Drul_array<Real> pos, bool french);
+  static int forced_stem_count (Grob *);
 };
 
-#endif // BEAM_HH
+
+#endif /* BEAM_HH */