lily/include/beam-scoring-problem.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   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 #ifndef BEAM_SCORING_PROBLEM_HH
  22 #define BEAM_SCORING_PROBLEM_HH
  23
  24 #include "interval.hh"
  25 #include "lily-proto.hh"
  26 #include "std-vector.hh"
  27 #include "stem-info.hh"
  28 #include "main.hh"  //  DEBUG_BEAM_SCORING
  29
  30 // Unused for now.
  31 enum Scorers {
  32   // Should be ordered by increasing expensiveness.
  33   ORIGINAL_DISTANCE,
  34   SLOPES,
  35   FORBIDDEN,
  36   STEM_LENGTHS,
  37   NUM_SCORERS,
  38 };
  39
  40 struct Beam_configuration
  41 {
  42   Interval y;
  43   Real demerits;
  44
  45 #if DEBUG_BEAM_SCORING
  46   string score_card_;
  47 #endif
  48
  49   int next_scorer_todo;
  50
  51   Beam_configuration ();
  52   bool done () const;
  53   void add (Real demerit, const string &reason);
  54   static Beam_configuration* new_config(Interval start,
  55                                         Interval offset);
  56 };
  57
  58 // Comparator for a queue of Beam_configuration*.
  59 class Beam_configuration_less
  60 {
  61   bool operator() (Beam_configuration* const& l, Beam_configuration* const& r)
  62   {
  63     return l->demerits < r->demerits;
  64   }
  65 };
  66
  67
  68 struct Beam_quant_parameters
  69 {
  70   Real SECONDARY_BEAM_DEMERIT;
  71   Real STEM_LENGTH_DEMERIT_FACTOR;
  72   Real REGION_SIZE;
  73
  74   /*
  75     threshold to combat rounding errors.
  76   */
  77   Real BEAM_EPS;
  78
  79   // possibly ridiculous, but too short stems just won't do
  80   Real STEM_LENGTH_LIMIT_PENALTY;
  81   Real DAMPING_DIRECTION_PENALTY;
  82   Real MUSICAL_DIRECTION_FACTOR;
  83   Real HINT_DIRECTION_PENALTY;
  84   Real IDEAL_SLOPE_FACTOR;
  85   Real ROUND_TO_ZERO_SLOPE;
  86
  87   void fill (Grob *him);
  88 };
  89
  90
  91
  92 /*
  93   Parameters for a single beam.  Precomputed to save time in
  94   scoring individual configurations.
  95
  96   TODO - use trailing _ on data members.
  97
  98   */
  99 class Beam_scoring_problem
 100 {
 101 public:
 102   Beam_scoring_problem (Grob *me, Drul_array<Real> ys);
 103   Drul_array<Real> solve() const;
 104
 105 private:
 106   Grob *beam;
 107
 108   Interval unquanted_y;
 109
 110   Real staff_space;
 111   Real beam_thickness;
 112   Real line_thickness;
 113   Real musical_dy;
 114
 115   Interval x_span;
 116
 117   vector<Stem_info> stem_infos;
 118
 119   /*
 120     Do stem computations.  These depend on YL and YR linearly, so we can
 121     precompute for every stem 2 factors.
 122
 123     We store some info to quickly interpolate.  The stemlengths are
 124     affine linear in YL and YR. If YL == YR == 0, then we might have
 125     stem_y != 0.0, when we're cross staff.
 126   */
 127   vector<Real> base_lengths;
 128   vector<Real> stem_xpositions;
 129
 130   Grob *common[2];
 131   bool is_xstaff;
 132   bool is_knee;
 133
 134   Beam_quant_parameters parameters;
 135
 136   Real staff_radius;
 137   Drul_array<int> edge_beam_counts;
 138   Drul_array<Direction> edge_dirs;
 139   Real beam_translation;
 140
 141   void init_stems ();
 142
 143   // Scoring functions:
 144   void score_forbidden_quants (Beam_configuration *config) const;
 145   void score_slopes_dy (Beam_configuration *config) const;
 146   void score_stem_lengths (Beam_configuration* config) const;
 147   void generate_quants(vector<Beam_configuration*>* scores) const;
 148 };
 149
 150 #endif /* BEAM_SCORING_PROBLEM_HH */