gtk2_ardour/port_matrix.h

   1 /*
   2     Copyright (C) 2002-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 __gtk_ardour_port_matrix_h__
  21 #define __gtk_ardour_port_matrix_h__
  22
  23 #include <list>
  24 #include <gtkmm/box.h>
  25 #include <gtkmm/scrollbar.h>
  26 #include <gtkmm/table.h>
  27 #include <gtkmm/label.h>
  28 #include <gtkmm/checkbutton.h>
  29 #include <boost/shared_ptr.hpp>
  30 #include "ardour/bundle.h"
  31 #include "port_group.h"
  32
  33 /** The `port matrix' UI.  This is a widget which lets the user alter
  34  *  associations between one set of ports and another.  e.g. to connect
  35  *  things together.
  36  *
  37  *  It is made up of a body, PortMatrixBody, which is rendered using cairo,
  38  *  and some scrollbars and other stuff.  All of this is arranged inside the
  39  *  VBox that we inherit from.
  40  */
  41
  42 namespace ARDOUR {
  43         class Bundle;
  44 }
  45
  46 class PortMatrixBody;
  47
  48 class PortMatrix : public Gtk::VBox
  49 {
  50 public:
  51         PortMatrix (ARDOUR::Session&, ARDOUR::DataType);
  52         ~PortMatrix ();
  53
  54         void set_type (ARDOUR::DataType);
  55
  56         ARDOUR::DataType type () const {
  57                 return _type;
  58         }
  59
  60         void disassociate_all ();
  61         void setup_scrollbars ();
  62         void popup_channel_context_menu (int, uint32_t, uint32_t);
  63
  64         enum Arrangement {
  65                 TOP_TO_RIGHT,  ///< column labels on top, row labels to the right
  66                 LEFT_TO_BOTTOM ///< row labels to the left, column labels on the bottom
  67         };
  68
  69         /** @return Arrangement in use */
  70         Arrangement arrangement () const {
  71                 return _arrangement;
  72         }
  73
  74         PortGroupList const * columns () const;
  75
  76         /** @return index into the _ports array for the list which is displayed as columns */
  77         int column_index () const {
  78                 return _column_index;
  79         }
  80
  81         PortGroupList const * rows () const;
  82
  83         /** @return index into the _ports array for the list which is displayed as rows */
  84         int row_index () const {
  85                 return _row_index;
  86         }
  87
  88         PortGroupList const * ports (int d) const {
  89                 return &_ports[d];
  90         }
  91
  92         void setup ();
  93         virtual void setup_ports (int) = 0;
  94         void setup_all_ports ();
  95
  96         /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
  97          *  @param s New state.
  98          */
  99         virtual void set_state (ARDOUR::BundleChannel c[2], bool s) = 0;
 100
 101         enum State {
 102                 ASSOCIATED,     ///< the ports are associaed
 103                 NOT_ASSOCIATED, ///< the ports are not associated
 104                 UNKNOWN         ///< we don't know anything about these two ports' relationship
 105         };
 106
 107         /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
 108          *  @return state
 109          */
 110         virtual State get_state (ARDOUR::BundleChannel c[2]) const = 0;
 111         virtual bool list_is_global (int) const = 0;
 112
 113         virtual void add_channel (boost::shared_ptr<ARDOUR::Bundle>) = 0;
 114         virtual bool can_remove_channels (int) const = 0;
 115         virtual void remove_channel (ARDOUR::BundleChannel) = 0;
 116         virtual bool can_rename_channels (int) const = 0;
 117         virtual void rename_channel (ARDOUR::BundleChannel) {}
 118
 119         enum Result {
 120                 Cancelled,
 121                 Accepted
 122         };
 123
 124         sigc::signal<void, Result> Finished;
 125
 126 protected:
 127
 128         /** We have two port group lists.  One will be presented on the rows of the matrix,
 129             the other on the columns.  The PortMatrix chooses the arrangement based on which has
 130             more ports in it.  Subclasses must fill these two lists with the port groups that they
 131             wish to present.  The PortMatrix will arrange its layout such that signal flow is vaguely
 132             from left to right as you go from list 0 to list 1.  Hence subclasses which deal with
 133             inputs and outputs should put outputs in list 0 and inputs in list 1. */
 134         PortGroupList _ports[2];
 135         ARDOUR::Session& _session;
 136
 137 private:
 138
 139         void hscroll_changed ();
 140         void vscroll_changed ();
 141         void routes_changed ();
 142         void reconnect_to_routes ();
 143         void visibility_toggled (boost::weak_ptr<PortGroup>, Gtk::CheckButton *);
 144         void select_arrangement ();
 145         void remove_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
 146         void rename_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
 147         void disassociate_all_on_channel (boost::weak_ptr<ARDOUR::Bundle>, uint32_t, int);
 148         void setup_global_ports ();
 149
 150         /// port type that we are working with
 151         ARDOUR::DataType _type;
 152         std::vector<sigc::connection> _route_connections;
 153
 154         PortMatrixBody* _body;
 155         Gtk::HScrollbar _hscroll;
 156         Gtk::VScrollbar _vscroll;
 157         Gtk::HBox _main_hbox;
 158         Gtk::HBox _column_visibility_box;
 159         bool _column_visibility_box_added;
 160         Gtk::Label _column_visibility_label;
 161         std::vector<Gtk::CheckButton*> _column_visibility_buttons;
 162         Gtk::VBox _row_visibility_box;
 163         bool _row_visibility_box_added;
 164         Gtk::Label _row_visibility_label;
 165         std::vector<Gtk::CheckButton*> _row_visibility_buttons;
 166         Gtk::Table _scroller_table;
 167         Gtk::Menu* _menu;
 168         bool _setup_once;
 169         Arrangement _arrangement;
 170         int _row_index;
 171         int _column_index;
 172 };
 173
 174 #endif