lily/include/beaming-pattern.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1999--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef BEAMING_PATTERN_HH
  21 #define BEAMING_PATTERN_HH
  22
  23 #include "std-vector.hh"
  24 #include "moment.hh"
  25 #include "lily-proto.hh"
  26
  27 struct Beaming_options
  28 {
  29   SCM grouping_;
  30   bool subdivide_beams_;
  31   bool strict_beat_beaming_;
  32   Moment base_moment_;
  33   Moment measure_length_;
  34
  35   Beaming_options ();
  36   void from_context (Context *);
  37 };
  38
  39 struct Beam_rhythmic_element
  40 {
  41   Moment start_moment_;
  42   Drul_array<int> beam_count_drul_;
  43
  44   int rhythmic_importance_;
  45   bool invisible_;
  46
  47   Rational factor_;
  48
  49   Beam_rhythmic_element (Moment, int, bool, Rational);
  50   Beam_rhythmic_element ();
  51
  52   int count (Direction d) const;
  53   void de_grace ();
  54 };
  55
  56 /*
  57   Generate beaming given durations of notes. Beam uses this to
  58   set_beaming () for each of its stems.
  59 */
  60 class Beaming_pattern
  61 {
  62 public:
  63   Beaming_pattern ();
  64
  65   void beamify (Beaming_options const &);
  66   void de_grace ();
  67   void add_stem (Moment d, int beams, bool invisible, Rational factor);
  68   int beamlet_count (int idx, Direction d) const;
  69   bool invisibility (int idx) const;
  70   Rational factor (int idx) const;
  71   Moment start_moment (int idx) const;
  72   Moment end_moment (int idx) const;
  73   Beaming_pattern *split_pattern (int idx);
  74
  75 private:
  76   vector<Beam_rhythmic_element> infos_;
  77   Direction flag_direction (Beaming_options const &, vsize) const;
  78   void find_rhythmic_importance (Beaming_options const &);
  79   void unbeam_invisible_stems ();
  80 };
  81
  82 #endif /* BEAMING_PATTERN_HH */