]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/beam.hh
Run `make grand-replace'.
[lilypond.git] / lily / include / beam.hh
index e8458196eb96efb746346811e250d7dad438bdd2..a9b30b678668e1020b9b9e2f1a0aea2d8b552656 100644 (file)
 /*
   beam.hh -- part of GNU LilyPond
 
-  (c) 1996--1999 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 "directional-spanner.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);
+};
 
-/** 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
-
-elt property:
+struct Beam_segment
+{
+  int vertical_count_;
+  Interval horizontal_; 
+  Beam_segment ();
+};
 
-damping: amount of beam slope damping. (int)
+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_;
+  
+};
 
-should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams 
 
+bool operator <(Beam_stem_segment const &a, Beam_stem_segment const &b);
 
-*/
-class Beam : public Directional_spanner  {
+class Beam
+{
 public:
-  /** 
-    The beams should be prevented to conflict with the stafflines, 
-    especially at small slopes.
-    */
-  enum Quantisation { NONE, NORMAL, TRADITIONAL, TEST };
-  enum Dir_algorithm { /* DOWN=-1, UP=1, */ MAJORITY=2, MEAN, MEDIAN };
-
-  Link_array<Stem> stems_;
-  /**
-     the slope of the beam in (staffpositions) per (X-dimension, in PT).
-     UGH. standardise this for once and for all.
-   */
-  Real slope_f_;
-
-  /// position of leftmost end of beam  
-  Real left_y_;
-
-  /** should beam pos / slope be quantised? 0: no, 1: yes, 2: traditional
-      JUNKME.
-   */
-  Quantisation quantisation_;
+  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);
   
-  /// maximum number of beams (for opening-up of beam-spacing)
-  int multiple_i_;
-
-  Array<Stem_info> sinfo_;
-  
-  Beam();
-  void add_stem (Stem*);
-  Stem_info get_stem_info (Stem*);
-
-  void set_grouping (Rhythmic_grouping def, Rhythmic_grouping current);
-  void set_stemlens ();
-  VIRTUAL_COPY_CONS(Score_element);
-
-protected:
-  virtual Interval do_width () const;    
-  Offset center () const;
-  Direction get_default_dir () const;
-  void set_direction (Direction);
-  void set_steminfo ();
+  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));
+
+  /* position callbacks */
+  DECLARE_SCHEME_CALLBACK (shift_region_to_valid, (SCM, SCM));
+  DECLARE_SCHEME_CALLBACK (slope_damping, (SCM, SCM));
+  DECLARE_SCHEME_CALLBACK (quanting, (SCM, SCM));
   
-  virtual void do_pre_processing ();
-  virtual void do_post_processing ();
-  virtual void do_substitute_element_pointer (Score_element*, Score_element*);
-  virtual void do_print() const;
-  virtual void quantise_left_y (bool extend_b);
-  virtual Molecule stem_beams (Stem *here, Stem *next, Stem *prev) const;
-  virtual void calculate_slope ();
-  virtual Real check_stemlengths_f (bool set_b);
-  virtual void solve_slope ();
-  virtual void quantise_dy ();
-  virtual Molecule*do_brew_molecule_p () const;
+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 (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
+
+#endif /* BEAM_HH */