when moving tempo and metric sections around (or adding new ones), prevent the existe...
[ardour.git] / gtk2_ardour / automation_time_axis.cc
index 9cf1598010ccb83e99997a60ec9a0526fdf88816..e172f40fc98f4afa1b038dd527fcdbf4b9a0698f 100644 (file)
 
 #include <utility>
 #include <gtkmm2ext/barcontroller.h>
+#include <gtkmm2ext/utils.h>
+#include <boost/algorithm/string.hpp>
+#include <boost/lexical_cast.hpp>
+
 #include "pbd/memento_command.h"
+#include "pbd/stacktrace.h"
+
 #include "ardour/automation_control.h"
 #include "ardour/event_type_map.h"
 #include "ardour/route.h"
@@ -49,9 +55,8 @@ using namespace Gtk;
 using namespace Gtkmm2ext;
 using namespace Editing;
 
-Pango::FontDescription* AutomationTimeAxisView::name_font = 0;
+Pango::FontDescription AutomationTimeAxisView::name_font;
 bool AutomationTimeAxisView::have_name_font = false;
-const string AutomationTimeAxisView::state_node_name = "AutomationChild";
 
 
 /** \a a the automatable object this time axis is to display data for.
@@ -82,6 +87,7 @@ AutomationTimeAxisView::AutomationTimeAxisView (
        , _view (show_regions ? new AutomationStreamView (*this) : 0)
        , _name (nom)
        , auto_button (X_("")) /* force addition of a label */
+       , _show_regions (show_regions)
 {
        if (!have_name_font) {
                name_font = get_font_for_style (X_("AutomationTrackName"));
@@ -139,68 +145,45 @@ AutomationTimeAxisView::AutomationTimeAxisView (
        ARDOUR_UI::instance()->set_tip(auto_button, _("automation state"));
        ARDOUR_UI::instance()->set_tip(hide_button, _("hide track"));
 
+       string str = gui_property ("height");
+       if (!str.empty()) {
+               set_height (atoi (str));
+       } else {
+               set_height (preset_height (HeightNormal));
+       }
+
        /* rearrange the name display */
 
+       controls_table.remove (name_hbox);
+       controls_table.attach (name_hbox, 1, 6, 0, 1,  Gtk::FILL|Gtk::EXPAND,  Gtk::FILL|Gtk::EXPAND, 3, 0);
+
        /* we never show these for automation tracks, so make
           life easier and remove them.
        */
 
        hide_name_entry();
 
-       /* move the name label over a bit */
-
-       string shortpname = _name;
-       bool shortened = false;
-
-       int ignore_width;
-       shortpname = fit_to_pixels (_name, 60, *name_font, ignore_width, true);
-
-       if (shortpname != _name ){
-               shortened = true;
-       }
-
-       name_label.set_text (shortpname);
+       name_label.set_text (_name);
        name_label.set_alignment (Gtk::ALIGN_CENTER, Gtk::ALIGN_CENTER);
         name_label.set_name (X_("TrackParameterName"));
+       name_label.set_ellipsize (Pango::ELLIPSIZE_END);
 
-       if (nomparent.length()) {
-
-               /* limit the plug name string */
-
-               string pname = fit_to_pixels (nomparent, 60, *name_font, ignore_width, true);
-               if (pname != nomparent) {
-                       shortened = true;
-               }
-
-               plugname = new Label (pname);
-               plugname->set_name (X_("TrackPlugName"));
-               plugname->show();
-               controls_table.remove (name_hbox);
-               controls_table.attach (*plugname, 1, 5, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-               plugname_packed = true;
-               controls_table.attach (name_hbox, 1, 5, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-       } else {
-               plugname = 0;
-               plugname_packed = false;
-       }
-
-       if (shortened) {
-               string tipname = nomparent;
-               if (!tipname.empty()) {
-                       tipname += ": ";
-               }
-               tipname += _name;
-               ARDOUR_UI::instance()->set_tip(controls_ebox, tipname);
+       string tipname = nomparent;
+       if (!tipname.empty()) {
+               tipname += ": ";
        }
+       tipname += _name;
+       ARDOUR_UI::instance()->set_tip(controls_ebox, tipname);
 
        /* add the buttons */
        controls_table.attach (hide_button, 0, 1, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-
-       controls_table.attach (auto_button, 5, 8, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
+       controls_table.attach (auto_button, 6, 8, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
 
        if (_controller) {
                /* add bar controller */
                controls_table.attach (*_controller.get(), 0, 8, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
+               /* note that this handler connects *before* the default handler */
+               _controller->event_widget().signal_scroll_event().connect (mem_fun (*this, &AutomationTimeAxisView::controls_ebox_scroll), false);
        }
 
        controls_table.show_all ();
@@ -212,12 +195,6 @@ AutomationTimeAxisView::AutomationTimeAxisView (
        controls_base_unselected_name = X_("AutomationTrackControlsBase");
        controls_ebox.set_name (controls_base_unselected_name);
 
-       XMLNode* xml_node = get_parent_with_state()->get_automation_child_xml_node (_parameter);
-
-       if (xml_node) {
-               set_state (*xml_node, Stateful::loading_state_version);
-       }
-
        /* ask for notifications of any new RegionViews */
        if (show_regions) {
 
@@ -226,7 +203,9 @@ AutomationTimeAxisView::AutomationTimeAxisView (
 
        } else {
                /* no regions, just a single line for the entire track (e.g. bus gain) */
-               
+
+               assert (_control);
+
                boost::shared_ptr<AutomationLine> line (
                        new AutomationLine (
                                ARDOUR::EventTypeMap::instance().to_symbol(_parameter),
@@ -253,6 +232,7 @@ AutomationTimeAxisView::AutomationTimeAxisView (
 
 AutomationTimeAxisView::~AutomationTimeAxisView ()
 {
+       delete _view;
 }
 
 void
@@ -260,7 +240,7 @@ AutomationTimeAxisView::route_going_away ()
 {
        _route.reset ();
 }
-       
+
 void
 AutomationTimeAxisView::auto_clicked ()
 {
@@ -271,7 +251,7 @@ AutomationTimeAxisView::auto_clicked ()
                automation_menu->set_name ("ArdourContextMenu");
                MenuList& items (automation_menu->items());
 
-               items.push_back (MenuElem (_("Manual"), sigc::bind (sigc::mem_fun(*this,
+               items.push_back (MenuElem (S_("Automation|Manual"), sigc::bind (sigc::mem_fun(*this,
                                &AutomationTimeAxisView::set_automation_state), (AutoState) Off)));
                items.push_back (MenuElem (_("Play"), sigc::bind (sigc::mem_fun(*this,
                                &AutomationTimeAxisView::set_automation_state), (AutoState) Play)));
@@ -294,18 +274,10 @@ AutomationTimeAxisView::set_automation_state (AutoState state)
        if (_automatable) {
                _automatable->set_parameter_automation_state (_parameter, state);
        }
-#if 0
-       if (_route == _automatable) { // This is a time axis for route (not region) automation
-               _route->set_parameter_automation_state (_parameter, state);
-       }
-       
-       if (_control->list()) {
-               _control->alist()->set_automation_state(state);
-       }
-#endif
+
        if (_view) {
                _view->set_automation_state (state);
-               
+
                /* AutomationStreamViews don't signal when their automation state changes, so handle
                   our updates `manually'.
                */
@@ -320,17 +292,18 @@ AutomationTimeAxisView::automation_state_changed ()
 
        /* update button label */
 
-       if (_line) {
-               state = _control->alist()->automation_state ();
-       } else if (_view) {
+       if (_view) {
                state = _view->automation_state ();
+       } else if (_line) {
+               assert (_control);
+               state = _control->alist()->automation_state ();
        } else {
                state = Off;
        }
 
        switch (state & (Off|Play|Touch|Write)) {
        case Off:
-               auto_button.set_label (_("Manual"));
+               auto_button.set_label (S_("Automation|Manual"));
                if (auto_off_item) {
                        ignore_state_request = true;
                        auto_off_item->set_active (true);
@@ -401,10 +374,11 @@ AutomationTimeAxisView::set_interpolation (AutomationList::InterpolationStyle st
        /* Tell our view's list, if we have one, otherwise tell our own.
         * Everything else will be signalled back from that.
         */
-       
+
        if (_view) {
                _view->set_interpolation (style);
        } else {
+               assert (_control);
                _control->list()->set_interpolation (style);
        }
 }
@@ -413,9 +387,9 @@ void
 AutomationTimeAxisView::clear_clicked ()
 {
        assert (_line || _view);
-       
+
        _session->begin_reversible_command (_("clear automation"));
-       
+
        if (_line) {
                _line->clear ();
        } else if (_view) {
@@ -433,11 +407,8 @@ AutomationTimeAxisView::set_height (uint32_t h)
        uint32_t const normal = preset_height (HeightNormal);
        bool const changed_between_small_and_normal = ( (height < normal && h >= normal) || (height >= normal || h < normal) );
 
-       TimeAxisView* state_parent = get_parent_with_state ();
-       assert(state_parent);
-       XMLNode* xml_node = state_parent->get_automation_child_xml_node (_parameter);
-
        TimeAxisView::set_height (h);
+
        _base_rect->property_y2() = h;
 
        if (_line) {
@@ -449,30 +420,11 @@ AutomationTimeAxisView::set_height (uint32_t h)
                _view->update_contents_height();
        }
 
-       char buf[32];
-       snprintf (buf, sizeof (buf), "%u", height);
-       if (xml_node) {
-               xml_node->add_property ("height", buf);
-       }
-
        if (changed_between_small_and_normal || first_call_to_set_height) {
 
                first_call_to_set_height = false;
 
                if (h >= preset_height (HeightNormal)) {
-                       controls_table.remove (name_hbox);
-
-                       if (plugname) {
-                               if (plugname_packed) {
-                                       controls_table.remove (*plugname);
-                                       plugname_packed = false;
-                               }
-                               controls_table.attach (*plugname, 1, 5, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-                               plugname_packed = true;
-                               controls_table.attach (name_hbox, 1, 5, 1, 2, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-                       } else {
-                               controls_table.attach (name_hbox, 1, 5, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
-                       }
                        hide_name_entry ();
                        show_name_label ();
                        name_hbox.show_all ();
@@ -481,14 +433,6 @@ AutomationTimeAxisView::set_height (uint32_t h)
                        hide_button.show_all();
 
                } else if (h >= preset_height (HeightSmall)) {
-                       controls_table.remove (name_hbox);
-                       if (plugname) {
-                               if (plugname_packed) {
-                                       controls_table.remove (*plugname);
-                                       plugname_packed = false;
-                               }
-                       }
-                       controls_table.attach (name_hbox, 1, 5, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND);
                        controls_table.hide_all ();
                        hide_name_entry ();
                        show_name_label ();
@@ -526,12 +470,12 @@ AutomationTimeAxisView::set_samples_per_unit (double spu)
 void
 AutomationTimeAxisView::hide_clicked ()
 {
-       // LAME fix for refreshing the hide button
        hide_button.set_sensitive(false);
-
        set_marked_for_display (false);
-       hide ();
-
+       RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(parent);
+       if (rtv) {
+               rtv->request_redraw ();
+       }
        hide_button.set_sensitive(true);
 }
 
@@ -559,7 +503,7 @@ AutomationTimeAxisView::build_display_menu ()
        auto_state_menu->set_name ("ArdourContextMenu");
        MenuList& as_items = auto_state_menu->items();
 
-       as_items.push_back (CheckMenuElem (_("Manual"), sigc::bind (
+       as_items.push_back (CheckMenuElem (S_("Automation|Manual"), sigc::bind (
                        sigc::mem_fun(*this, &AutomationTimeAxisView::set_automation_state),
                        (AutoState) Off)));
        auto_off_item = dynamic_cast<CheckMenuItem*>(&as_items.back());
@@ -616,7 +560,7 @@ AutomationTimeAxisView::build_display_menu ()
 }
 
 void
-AutomationTimeAxisView::add_automation_event (ArdourCanvas::Item* /*item*/, GdkEvent* /*event*/, framepos_t when, double y)
+AutomationTimeAxisView::add_automation_event (GdkEvent* event, framepos_t when, double y)
 {
        if (!_line) {
                return;
@@ -634,14 +578,17 @@ AutomationTimeAxisView::add_automation_event (ArdourCanvas::Item* /*item*/, GdkE
 
        _line->view_to_model_coord (x, y);
 
-       _session->begin_reversible_command (_("add automation event"));
-       XMLNode& before = _control->alist()->get_state();
+       boost::shared_ptr<AutomationList> list = _line->the_list ();
 
-       _control->alist()->add (when, y);
+       _editor.snap_to_with_modifier (when, event);
 
-       XMLNode& after = _control->alist()->get_state();
-       _session->commit_reversible_command (new MementoCommand<ARDOUR::AutomationList>(*_control->alist(), &before, &after));
+       _session->begin_reversible_command (_("add automation event"));
+       XMLNode& before = list->get_state();
 
+       list->add (when, y);
+
+       XMLNode& after = list->get_state();
+       _session->commit_reversible_command (new MementoCommand<ARDOUR::AutomationList> (*list, &before, &after));
        _session->set_dirty ();
 }
 
@@ -672,10 +619,16 @@ AutomationTimeAxisView::cut_copy_clear_one (AutomationLine& line, Selection& sel
        const Evoral::TimeConverter<double, ARDOUR::framepos_t>& tc = line.time_converter ();
        double const start = tc.from (selection.time.front().start - tc.origin_b ());
        double const end = tc.from (selection.time.front().end - tc.origin_b ());
-       
+
        switch (op) {
+       case Delete:
+               if (alist->cut (start, end) != 0) {
+                       _session->add_command(new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
+               }
+               break;
+
        case Cut:
-               
+
                if ((what_we_got = alist->cut (start, end)) != 0) {
                        _editor.get_cut_buffer().add (what_we_got);
                        _session->add_command(new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
@@ -767,6 +720,11 @@ AutomationTimeAxisView::cut_copy_clear_objects_one (AutomationLine& line, PointS
                }
 
                switch (op) {
+               case Delete:
+                       if (alist->cut ((*i).start, (*i).end) != 0) {
+                               _session->add_command (new MementoCommand<AutomationList>(*alist.get(), new XMLNode (before), &alist->get_state()));
+                       }
+                       break;
                case Cut:
                        if ((what_we_got = alist->cut ((*i).start, (*i).end)) != 0) {
                                _editor.get_cut_buffer().add (what_we_got);
@@ -810,7 +768,7 @@ bool
 AutomationTimeAxisView::paste (framepos_t pos, float times, Selection& selection, size_t nth)
 {
        boost::shared_ptr<AutomationLine> line;
-       
+
        if (_line) {
                line = _line;
        } else if (_view) {
@@ -820,7 +778,7 @@ AutomationTimeAxisView::paste (framepos_t pos, float times, Selection& selection
        if (!line) {
                return false;
        }
-       
+
        return paste_one (*line, pos, times, selection, nth);
 }
 
@@ -935,18 +893,19 @@ AutomationTimeAxisView::add_line (boost::shared_ptr<AutomationLine> line)
 {
        assert(line);
        assert(!_line);
-       assert(line->the_list() == _control->list());
-
-       _control->alist()->automation_state_changed.connect (
-               _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::automation_state_changed, this), gui_context()
-               );
-       
-       _control->alist()->InterpolationChanged.connect (
-               _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::interpolation_changed, this, _1), gui_context()
-               );
+       if (_control) {
+               assert(line->the_list() == _control->list());
+               
+               _control->alist()->automation_state_changed.connect (
+                       _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::automation_state_changed, this), gui_context()
+                       );
+               
+               _control->alist()->InterpolationChanged.connect (
+                       _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::interpolation_changed, this, _1), gui_context()
+                       );
+       }
 
        _line = line;
-       //_controller = AutomationController::create(_session, line->the_list(), _control);
 
        line->set_height (height);
 
@@ -981,98 +940,62 @@ AutomationTimeAxisView::color_handler ()
 }
 
 int
-AutomationTimeAxisView::set_state (const XMLNode& node, int version)
-{
-       TimeAxisView::set_state (node, version);
-
-       if (version < 3000) {
-               return set_state_2X (node, version);
-       }
-       
-       XMLProperty const * type = node.property ("automation-id");
-       if (type && type->value () == ARDOUR::EventTypeMap::instance().to_symbol (_parameter)) {
-               XMLProperty const * shown = node.property ("shown");
-               if (shown && shown->value () == "yes") {
-                       set_marked_for_display (true);
-                       _canvas_display->show (); /* FIXME: necessary? show_at? */
-               }
-       }
-
-       if (!_marked_for_display) {
-               hide();
-       }
-
-       return 0;
-}
-
-int
-
 AutomationTimeAxisView::set_state_2X (const XMLNode& node, int /*version*/)
 {
        if (node.name() == X_("gain") && _parameter == Evoral::Parameter (GainAutomation)) {
                XMLProperty const * shown = node.property (X_("shown"));
-               if (shown && string_is_affirmative (shown->value ())) {
-                       set_marked_for_display (true);
-                       _canvas_display->show (); /* FIXME: necessary? show_at? */
+               if (shown) {
+                       bool yn = string_is_affirmative (shown->value ());
+                       if (yn) {
+                               _canvas_display->show (); /* FIXME: necessary? show_at? */
+                       }
+                       set_gui_property ("visible", yn);
+               } else {
+                       set_gui_property ("visible", false);
                }
        }
 
-       if (!_marked_for_display) {
-               hide ();
-       }
-
        return 0;
 }
 
-XMLNode*
-AutomationTimeAxisView::get_state_node ()
-{
-       TimeAxisView* state_parent = get_parent_with_state ();
-
-       if (state_parent) {
-               return state_parent->get_automation_child_xml_node (_parameter);
-       } else {
-               return 0;
-       }
-}
-
-void
-AutomationTimeAxisView::update_extra_xml_shown (bool editor_shown)
-{
-       XMLNode* xml_node = get_state_node();
-       if (xml_node) {
-               xml_node->add_property ("shown", editor_shown ? "yes" : "no");
-       }
-}
-
-guint32
-AutomationTimeAxisView::show_at (double y, int& nth, Gtk::VBox *parent)
+int
+AutomationTimeAxisView::set_state (const XMLNode&, int /*version*/)
 {
-       update_extra_xml_shown (true);
-
-       return TimeAxisView::show_at (y, nth, parent);
+       return 0;
 }
 
 void
-AutomationTimeAxisView::hide ()
+AutomationTimeAxisView::what_has_visible_automation (const boost::shared_ptr<Automatable>& automatable, set<Evoral::Parameter>& visible)
 {
-       update_extra_xml_shown (false);
-
-       TimeAxisView::hide ();
-}
+       /* this keeps "knowledge" of how we store visibility information
+          in XML private to this class.
+       */
 
-bool
-AutomationTimeAxisView::set_visibility (bool yn)
-{
-       bool changed = TimeAxisView::set_visibility (yn);
+       assert (automatable);
 
-       if (changed) {
-               get_state_node()->add_property ("shown", yn ? X_("yes") : X_("no"));
+       Automatable::Controls& controls (automatable->controls());
+       
+       for (Automatable::Controls::iterator i = controls.begin(); i != controls.end(); ++i) {
+               
+               boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
+
+               if (ac) {
+                       
+                       const XMLNode* gui_node = ac->extra_xml ("GUI");
+                       
+                       if (gui_node) {
+                               const XMLProperty* prop = gui_node->property ("shown");
+                               if (prop) {
+                                       if (string_is_affirmative (prop->value())) {
+                                               visible.insert (i->first);
+                                       }
+                               }
+                       }
+               }
        }
-
-       return changed;
 }
 
+
 /** @return true if this view has any automation data to display */
 bool
 AutomationTimeAxisView::has_automation () const
@@ -1084,7 +1007,7 @@ list<boost::shared_ptr<AutomationLine> >
 AutomationTimeAxisView::lines () const
 {
        list<boost::shared_ptr<AutomationLine> > lines;
-       
+
        if (_line) {
                lines.push_back (_line);
        } else if (_view) {
@@ -1093,3 +1016,67 @@ AutomationTimeAxisView::lines () const
 
        return lines;
 }
+
+string
+AutomationTimeAxisView::state_id() const
+{
+       if (_control) {
+               return string_compose ("automation %1", _control->id().to_s());
+       } else {
+               assert (_parameter);
+               return string_compose ("automation %1 %2/%3/%4", 
+                                      _route->id(), 
+                                      _parameter.type(),
+                                      _parameter.id(),
+                                      (int) _parameter.channel());
+       }
+}
+
+/** Given a state id string, see if it is one generated by
+ *  this class.  If so, parse it into its components.
+ *  @param state_id State ID string to parse.
+ *  @param route_id Filled in with the route's ID if the state ID string is parsed.
+ *  @param has_parameter Filled in with true if the state ID has a parameter, otherwise false.
+ *  @param parameter Filled in with the state ID's parameter, if it has one.
+ *  @return true if this is a state ID generated by this class, otherwise false.
+ */
+
+bool
+AutomationTimeAxisView::parse_state_id (
+       string const & state_id,
+       PBD::ID & route_id,
+       bool & has_parameter,
+       Evoral::Parameter & parameter)
+{
+       stringstream s;
+       s << state_id;
+
+       string a, b, c;
+       s >> a >> b >> c;
+
+       if (a != X_("automation")) {
+               return false;
+       }
+
+       route_id = PBD::ID (b);
+
+       if (c.empty ()) {
+               has_parameter = false;
+               return true;
+       }
+
+       has_parameter = true;
+
+       vector<string> p;
+       boost::split (p, c, boost::is_any_of ("/"));
+
+       assert (p.size() == 3);
+
+       parameter = Evoral::Parameter (
+               boost::lexical_cast<int> (p[0]),
+               boost::lexical_cast<int> (p[2]),
+               boost::lexical_cast<int> (p[1])
+               );
+
+       return true;
+}