libs/ardour/ardour/mute_master.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_mute_master_h__
  21 #define __ardour_mute_master_h__
  22
  23 #include "evoral/Parameter.hpp"
  24 #include "pbd/signals.h"
  25 #include "pbd/stateful.h"
  26 #include <string>
  27
  28 namespace ARDOUR {
  29
  30 class Session;
  31
  32 class MuteMaster : public PBD::Stateful
  33 {
  34   public:
  35         enum MutePoint {
  36                 PreFader  = 0x1,
  37                 PostFader = 0x2,
  38                 Listen    = 0x4,
  39                 Main      = 0x8
  40         };
  41
  42         static const MutePoint AllPoints;
  43
  44         MuteMaster (Session& s, const std::string& name);
  45         ~MuteMaster() {}
  46
  47         bool self_muted() const { return _self_muted && (_mute_point != MutePoint (0)); }
  48         bool muted_by_others() const { return _muted_by_others && (_mute_point != MutePoint (0)); }
  49         bool muted() const { return (_self_muted || (_muted_by_others > 0)) && (_mute_point != MutePoint (0)); }
  50         bool muted_at (MutePoint mp) const { return (_self_muted || (_muted_by_others > 0)) && (_mute_point & mp); }
  51
  52         bool muted_pre_fader() const  { return muted_at (PreFader); }
  53         bool muted_post_fader() const { return muted_at (PostFader); }
  54         bool muted_listen() const     { return muted_at (Listen); }
  55         bool muted_main () const      { return muted_at (Main); }
  56
  57         gain_t mute_gain_at (MutePoint) const;
  58
  59         void set_self_muted (bool yn) { _self_muted = yn; }
  60         void mod_muted_by_others (int delta);
  61
  62         void clear_mute ();
  63         void mute_at (MutePoint);
  64         void unmute_at (MutePoint);
  65
  66         void set_mute_points (const std::string& mute_point);
  67         void set_mute_points (MutePoint);
  68         MutePoint mute_points() const { return _mute_point; }
  69
  70         PBD::Signal0<void> MutePointChanged;
  71
  72         XMLNode& get_state();
  73         int set_state(const XMLNode&, int version);
  74
  75   private:
  76         MutePoint _mute_point;
  77         bool      _self_muted;
  78         uint32_t  _muted_by_others;
  79 };
  80
  81 } // namespace ARDOUR
  82
  83 #endif /*__ardour_mute_master_h__ */