add canvas-based Meter object
[ardour.git] / gtk2_ardour / editor.cc
index 029a4649ec7e429d80ffe41ae6ceabbc61027be9..ccb839ccc18a7cc8ef3555d52562454b73d7d4c0 100644 (file)
 #include "ardour/lmath.h"
 #include "ardour/location.h"
 #include "ardour/profile.h"
+#include "ardour/route.h"
 #include "ardour/route_group.h"
 #include "ardour/session_playlists.h"
 #include "ardour/tempo.h"
 #include "ardour/utils.h"
 #include "ardour/vca_manager.h"
+#include "ardour/vca.h"
 
 #include "canvas/debug.h"
 #include "canvas/text.h"
 #include "region_layering_order_editor.h"
 #include "rgb_macros.h"
 #include "rhythm_ferret.h"
+#include "route_sorter.h"
 #include "selection.h"
 #include "simple_progress_dialog.h"
 #include "sfdb_ui.h"
 #include "vca_time_axis.h"
 #include "verbose_cursor.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -569,7 +572,7 @@ Editor::Editor ()
 
        initialize_canvas ();
 
-       CairoWidget::set_focus_handler (sigc::mem_fun (*this, &Editor::reset_focus));
+       CairoWidget::set_focus_handler (sigc::mem_fun (ARDOUR_UI::instance(), &ARDOUR_UI::reset_focus));
 
        _summary = new EditorSummary (this);
 
@@ -671,6 +674,7 @@ Editor::Editor ()
                _notebook_shrunk = string_is_affirmative (prop->value ());
        }
 
+       editor_summary_pane.set_check_divider_position (true);
        editor_summary_pane.add (edit_packer);
 
        Button* summary_arrows_left_left = manage (new Button);
@@ -715,6 +719,7 @@ Editor::Editor ()
                editor_summary_pane.add (_summary_hbox);
        }
 
+       edit_pane.set_check_divider_position (true);
        edit_pane.add (editor_summary_pane);
        if (!ARDOUR::Profile->get_trx()) {
                edit_pane.add (_the_notebook);
@@ -724,19 +729,25 @@ Editor::Editor ()
        edit_pane.set_child_minsize (_the_notebook, 30); /* rough guess at width of notebook tabs */
        editor_summary_pane.set_drag_cursor (*_cursors->expand_up_down);
 
-       if (!settings || (prop = settings->property ("edit-horizontal-pane-pos")) == 0) {
-               /* initial allocation is 90% to canvas, 10% to notebook */
-               edit_pane.set_divider (0, 0.90);
-       } else {
-               edit_pane.set_divider (0, atof (prop->value()));
-       }
+       float fract;
 
-       if (!settings || (prop = settings->property ("edit-vertical-pane-pos")) == 0) {
-               /* initial allocation is 90% to canvas, 10% to summary */
-               editor_summary_pane.set_divider (0, 0.90);
-       } else {
+       {
+               LocaleGuard lg;
 
-               editor_summary_pane.set_divider (0, atof (prop->value()));
+               if (!settings || ((prop = settings->property ("edit-horizontal-pane-pos")) == 0) || ((fract = atof (prop->value())) > 1.0)) {
+                       /* initial allocation is 90% to canvas, 10% to notebook */
+                       edit_pane.set_divider (0, 0.90);
+               } else {
+                       edit_pane.set_divider (0, fract);
+               }
+
+               if (!settings || ((prop = settings->property ("edit-vertical-pane-pos")) == 0) || ((fract = atof (prop->value())) > 1.0)) {
+                       /* initial allocation is 90% to canvas, 10% to summary */
+                       editor_summary_pane.set_divider (0, 0.90);
+               } else {
+
+                       editor_summary_pane.set_divider (0, fract);
+               }
        }
 
        top_hbox.pack_start (toolbar_frame);
@@ -850,12 +861,13 @@ Editor::Editor ()
 
 Editor::~Editor()
 {
-        delete button_bindings;
+       delete button_bindings;
        delete _routes;
        delete _route_groups;
        delete _track_canvas_viewport;
        delete _drags;
        delete nudge_clock;
+       delete _verbose_cursor;
        delete quantize_dialog;
        delete _summary;
        delete _group_tabs;
@@ -1002,42 +1014,9 @@ Editor::control_unselect ()
 }
 
 void
-Editor::control_select (PresentationInfo::global_order_t global_order, Selection::Operation op)
+Editor::control_select (boost::shared_ptr<Stripable> s, Selection::Operation op)
 {
-       /* handles the (static) signal from the ControlProtocol class that
-        * requests setting the selected track to a given RID
-        */
-
-       if (!_session) {
-               return;
-       }
-
-       PresentationInfo::Flag select_flags;
-
-       if (global_order & ~0xffffffff) {
-               /* some flags are set, so the PresentationInfo constructor
-                * will use them
-                */
-               select_flags = PresentationInfo::Flag (0);
-       } else {
-               /* no type flags set in the global order ID, so assume caller
-                * wants to select a Route
-                */
-               select_flags = PresentationInfo::Route;
-       }
-
-       PresentationInfo pi (global_order, select_flags);
-       boost::shared_ptr<Stripable> s = _session->get_remote_nth_stripable (pi.group_order(), pi.flags());
-
-       /* selected object may not be a Route */
-
-       boost::shared_ptr<Route> r = boost::dynamic_pointer_cast<Route> (s);
-
-       if (!r) {
-               return;
-       }
-
-       TimeAxisView* tav = axis_view_from_route (r);
+       TimeAxisView* tav = axis_view_from_stripable (s);
 
        if (tav) {
                switch (op) {
@@ -1203,7 +1182,7 @@ Editor::generic_event_handler (GdkEvent* ev)
                        /* leaving window, so reset focus, thus ending any and
                           all text entry operations.
                        */
-                       reset_focus (&contents());
+                       ARDOUR_UI::instance()->reset_focus (&contents());
                        break;
                }
                break;
@@ -2343,6 +2322,7 @@ Editor::set_state (const XMLNode& node, int version)
        XMLProperty const * prop;
        set_id (node);
        PBD::Unwinder<bool> nsi (no_save_instant, true);
+       LocaleGuard lg;
 
        Tabbable::set_state (node, version);
 
@@ -2365,6 +2345,8 @@ Editor::set_state (const XMLNode& node, int version)
 
        if ((prop = node.property ("zoom-focus"))) {
                zoom_focus_selection_done ((ZoomFocus) string_2_enum (prop->value(), zoom_focus));
+       } else {
+               zoom_focus_selection_done (zoom_focus);
        }
 
        if ((prop = node.property ("zoom"))) {
@@ -2382,6 +2364,8 @@ Editor::set_state (const XMLNode& node, int version)
        if ((prop = node.property ("snap-to"))) {
                snap_type_selection_done ((SnapType) string_2_enum (prop->value(), _snap_type));
                set_snap_to ((SnapType) string_2_enum (prop->value(), _snap_type));
+       } else {
+               set_snap_to (_snap_type);
        }
 
        if ((prop = node.property ("snap-mode"))) {
@@ -2391,6 +2375,8 @@ Editor::set_state (const XMLNode& node, int version)
                 * which does not trigger set_text().
                 */
                set_snap_mode ((SnapMode) string_2_enum (prop->value(), _snap_mode));
+       } else {
+               set_snap_mode (_snap_mode);
        }
 
        if ((prop = node.property ("internal-snap-to"))) {
@@ -2443,6 +2429,8 @@ Editor::set_state (const XMLNode& node, int version)
 
        if ((prop = node.property ("edit-point"))) {
                set_edit_point_preference ((EditPoint) string_2_enum (prop->value(), _edit_point), true);
+       } else {
+               set_edit_point_preference (_edit_point);
        }
 
        if ((prop = node.property ("show-measures"))) {
@@ -2577,6 +2565,7 @@ Editor::get_state ()
 {
        XMLNode* node = new XMLNode (X_("Editor"));
        char buf[32];
+       LocaleGuard lg;
 
        id().print (buf, sizeof (buf));
        node->add_property ("id", buf);
@@ -2845,55 +2834,55 @@ Editor::snap_to_internal (framepos_t& start, RoundMode direction, bool for_mark,
                break;
 
        case SnapToBeatDiv128:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 128, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 128, direction);
                break;
        case SnapToBeatDiv64:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 64, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 64, direction);
                break;
        case SnapToBeatDiv32:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 32, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 32, direction);
                break;
        case SnapToBeatDiv28:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 28, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 28, direction);
                break;
        case SnapToBeatDiv24:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 24, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 24, direction);
                break;
        case SnapToBeatDiv20:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 20, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 20, direction);
                break;
        case SnapToBeatDiv16:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 16, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 16, direction);
                break;
        case SnapToBeatDiv14:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 14, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 14, direction);
                break;
        case SnapToBeatDiv12:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 12, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 12, direction);
                break;
        case SnapToBeatDiv10:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 10, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 10, direction);
                break;
        case SnapToBeatDiv8:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 8, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 8, direction);
                break;
        case SnapToBeatDiv7:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 7, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 7, direction);
                break;
        case SnapToBeatDiv6:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 6, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 6, direction);
                break;
        case SnapToBeatDiv5:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 5, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 5, direction);
                break;
        case SnapToBeatDiv4:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 4, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 4, direction);
                break;
        case SnapToBeatDiv3:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 3, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 3, direction);
                break;
        case SnapToBeatDiv2:
-               start = _session->tempo_map().round_to_beat_subdivision (start, 2, direction);
+               start = _session->tempo_map().round_to_quarter_note_subdivision (start, 2, direction);
                break;
 
        case SnapToMark:
@@ -4044,6 +4033,47 @@ Editor::get_grid_beat_divisions(framepos_t position)
        return 0;
 }
 
+/** returns the current musical grid divisiions using the supplied modifier mask from a GtkEvent.
+    if the grid is non-musical, returns 0.
+    if the grid is snapped to bars, returns -1.
+    @param event_state the current keyboard modifier mask.
+*/
+unsigned
+Editor::get_grid_music_divisions (uint32_t event_state)
+{
+       if (snap_mode() == Editing::SnapOff && !ArdourKeyboard::indicates_snap (event_state)) {
+               return 0;
+       }
+
+       if (snap_mode() != Editing::SnapOff && ArdourKeyboard::indicates_snap (event_state)) {
+               return 0;
+       }
+
+       switch (_snap_type) {
+       case SnapToBeatDiv128: return 128;
+       case SnapToBeatDiv64:  return 64;
+       case SnapToBeatDiv32:  return 32;
+       case SnapToBeatDiv28:  return 28;
+       case SnapToBeatDiv24:  return 24;
+       case SnapToBeatDiv20:  return 20;
+       case SnapToBeatDiv16:  return 16;
+       case SnapToBeatDiv14:  return 14;
+       case SnapToBeatDiv12:  return 12;
+       case SnapToBeatDiv10:  return 10;
+       case SnapToBeatDiv8:   return 8;
+       case SnapToBeatDiv7:   return 7;
+       case SnapToBeatDiv6:   return 6;
+       case SnapToBeatDiv5:   return 5;
+       case SnapToBeatDiv4:   return 4;
+       case SnapToBeatDiv3:   return 3;
+       case SnapToBeatDiv2:   return 2;
+       case SnapToBeat:       return 1;
+       case SnapToBar :       return -1;
+       default:               return 0;
+       }
+       return 0;
+}
+
 Evoral::Beats
 Editor::get_grid_type_as_beats (bool& success, framepos_t position)
 {
@@ -4056,10 +4086,11 @@ Editor::get_grid_type_as_beats (bool& success, framepos_t position)
 
        switch (_snap_type) {
        case SnapToBeat:
-               return Evoral::Beats(1.0);
+               return Evoral::Beats(4.0 / _session->tempo_map().meter_at_frame (position).note_divisor());
        case SnapToBar:
                if (_session) {
-                       return Evoral::Beats(_session->tempo_map().meter_at_frame (position).divisions_per_bar());
+                       const Meter& m = _session->tempo_map().meter_at_frame (position);
+                       return Evoral::Beats((4.0 * m.divisions_per_bar()) / m.note_divisor());
                }
                break;
        default:
@@ -4244,7 +4275,7 @@ Editor::new_playlists (TimeAxisView* v)
        begin_reversible_command (_("new playlists"));
        vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
        _session->playlists->get (playlists);
-       mapover_tracks (sigc::bind (sigc::mem_fun (*this, &Editor::mapped_use_new_playlist), playlists), v, ARDOUR::Properties::select.property_id);
+       mapover_tracks (sigc::bind (sigc::mem_fun (*this, &Editor::mapped_use_new_playlist), playlists), v, ARDOUR::Properties::group_select.property_id);
        commit_reversible_command ();
 }
 
@@ -4260,7 +4291,7 @@ Editor::copy_playlists (TimeAxisView* v)
        begin_reversible_command (_("copy playlists"));
        vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
        _session->playlists->get (playlists);
-       mapover_tracks (sigc::bind (sigc::mem_fun (*this, &Editor::mapped_use_copy_playlist), playlists), v, ARDOUR::Properties::select.property_id);
+       mapover_tracks (sigc::bind (sigc::mem_fun (*this, &Editor::mapped_use_copy_playlist), playlists), v, ARDOUR::Properties::group_select.property_id);
        commit_reversible_command ();
 }
 
@@ -4275,7 +4306,7 @@ Editor::clear_playlists (TimeAxisView* v)
        begin_reversible_command (_("clear playlists"));
        vector<boost::shared_ptr<ARDOUR::Playlist> > playlists;
        _session->playlists->get (playlists);
-       mapover_tracks (sigc::mem_fun (*this, &Editor::mapped_clear_playlist), v, ARDOUR::Properties::select.property_id);
+       mapover_tracks (sigc::mem_fun (*this, &Editor::mapped_clear_playlist), v, ARDOUR::Properties::group_select.property_id);
        commit_reversible_command ();
 }
 
@@ -4365,7 +4396,7 @@ Editor::current_visual_state (bool with_tracks)
        vs->zoom_focus = zoom_focus;
 
        if (with_tracks) {
-               *vs->gui_state = *ARDOUR_UI::instance()->gui_object_state;
+               vs->gui_state->set_state (ARDOUR_UI::instance()->gui_object_state->get_state());
        }
 
        return vs;
@@ -4430,7 +4461,7 @@ Editor::use_visual_state (VisualState& vs)
        reposition_and_zoom (vs.leftmost_frame, vs.samples_per_pixel);
 
        if (vs.gui_state) {
-               *ARDOUR_UI::instance()->gui_object_state = *vs.gui_state;
+               ARDOUR_UI::instance()->gui_object_state->set_state (vs.gui_state->get_state());
 
                for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
                        (*i)->clear_property_cache();
@@ -5001,7 +5032,7 @@ Editor::first_idle ()
                        true
                        );
                dialog->present ();
-               ARDOUR_UI::instance()->flush_pending ();
+               ARDOUR_UI::instance()->flush_pending (60);
        }
 
        for (TrackViewList::iterator t = track_views.begin(); t != track_views.end(); ++t) {
@@ -5137,16 +5168,13 @@ Editor::region_view_removed ()
        _summary->set_background_dirty ();
 }
 
-RouteTimeAxisView*
-Editor::axis_view_from_route (boost::shared_ptr<Route> r) const
+TimeAxisView*
+Editor::axis_view_from_stripable (boost::shared_ptr<Stripable> s) const
 {
-       TrackViewList::const_iterator j = track_views.begin ();
-       while (j != track_views.end()) {
-               RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (*j);
-               if (rtv && rtv->route() == r) {
-                       return rtv;
+       for (TrackViewList::const_iterator j = track_views.begin (); j != track_views.end(); ++j) {
+               if ((*j)->stripable() == s) {
+                       return *j;
                }
-               ++j;
        }
 
        return 0;
@@ -5159,7 +5187,7 @@ Editor::axis_views_from_routes (boost::shared_ptr<RouteList> r) const
        TrackViewList t;
 
        for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
-               TimeAxisView* tv = axis_view_from_route (*i);
+               TimeAxisView* tv = axis_view_from_stripable (*i);
                if (tv) {
                        t.push_back (tv);
                }
@@ -5186,73 +5214,94 @@ Editor::resume_route_redisplay ()
 }
 
 void
-Editor::add_vcas (VCAList& vcas)
+Editor::add_vcas (VCAList& vlist)
 {
-       VCATimeAxisView* vtv;
-       list<VCATimeAxisView*> new_views;
+       StripableList sl;
 
-       for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
-               vtv = new VCATimeAxisView (*this, _session, *_track_canvas);
-               vtv->set_vca (*v);
-               new_views.push_back (vtv);
+       for (VCAList::iterator v = vlist.begin(); v != vlist.end(); ++v) {
+               sl.push_back (boost::dynamic_pointer_cast<Stripable> (*v));
        }
 
-       if (new_views.size() > 0) {
-               _routes->vcas_added (new_views);
-       }
+       add_stripables (sl);
 }
 
 void
-Editor::add_routes (RouteList& routes)
+Editor::add_routes (RouteList& rlist)
 {
-       ENSURE_GUI_THREAD (*this, &Editor::handle_new_route, routes)
+       StripableList sl;
+
+       for (RouteList::iterator r = rlist.begin(); r != rlist.end(); ++r) {
+               sl.push_back (*r);
+       }
 
-       RouteTimeAxisView *rtv;
-       list<RouteTimeAxisView*> new_views;
+       add_stripables (sl);
+}
+
+void
+Editor::add_stripables (StripableList& sl)
+{
+       list<TimeAxisView*> new_views;
+       boost::shared_ptr<VCA> v;
+       boost::shared_ptr<Route> r;
        TrackViewList new_selection;
        bool from_scratch = (track_views.size() == 0);
 
-       for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
-               boost::shared_ptr<Route> route = (*x);
+       sl.sort (StripablePresentationInfoSorter());
 
-               if (route->is_auditioner() || route->is_monitor()) {
-                       continue;
-               }
+       for (StripableList::iterator s = sl.begin(); s != sl.end(); ++s) {
 
-               DataType dt = route->input()->default_type();
+               if ((v = boost::dynamic_pointer_cast<VCA> (*s)) != 0) {
 
-               if (dt == ARDOUR::DataType::AUDIO) {
-                       rtv = new AudioTimeAxisView (*this, _session, *_track_canvas);
-                       rtv->set_route (route);
-               } else if (dt == ARDOUR::DataType::MIDI) {
-                       rtv = new MidiTimeAxisView (*this, _session, *_track_canvas);
-                       rtv->set_route (route);
-               } else {
-                       throw unknown_type();
-               }
+                       VCATimeAxisView* vtv = new VCATimeAxisView (*this, _session, *_track_canvas);
+                       vtv->set_vca (v);
+                       new_views.push_back (vtv);
 
-               new_views.push_back (rtv);
-               track_views.push_back (rtv);
-               new_selection.push_back (rtv);
+               } else if ((r = boost::dynamic_pointer_cast<Route> (*s)) != 0) {
 
-               rtv->effective_gain_display ();
+                       if (r->is_auditioner() || r->is_monitor()) {
+                               continue;
+                       }
+
+                       RouteTimeAxisView* rtv;
+                       DataType dt = r->input()->default_type();
+
+                       if (dt == ARDOUR::DataType::AUDIO) {
+                               rtv = new AudioTimeAxisView (*this, _session, *_track_canvas);
+                               rtv->set_route (r);
+                       } else if (dt == ARDOUR::DataType::MIDI) {
+                               rtv = new MidiTimeAxisView (*this, _session, *_track_canvas);
+                               rtv->set_route (r);
+                       } else {
+                               throw unknown_type();
+                       }
 
-               rtv->view()->RegionViewAdded.connect (sigc::mem_fun (*this, &Editor::region_view_added));
-               rtv->view()->RegionViewRemoved.connect (sigc::mem_fun (*this, &Editor::region_view_removed));
+                       new_views.push_back (rtv);
+                       track_views.push_back (rtv);
+                       new_selection.push_back (rtv);
+
+                       rtv->effective_gain_display ();
+
+                       rtv->view()->RegionViewAdded.connect (sigc::mem_fun (*this, &Editor::region_view_added));
+                       rtv->view()->RegionViewRemoved.connect (sigc::mem_fun (*this, &Editor::region_view_removed));
+               }
        }
 
        if (new_views.size() > 0) {
-               _routes->routes_added (new_views);
-               _summary->routes_added (new_views);
+               _routes->time_axis_views_added (new_views);
+               //_summary->routes_added (new_selection); /* XXX requires RouteTimeAxisViewList */
        }
 
-       if (!from_scratch) {
+       /* note: !new_selection.empty() means that we got some routes rather
+        * than just VCAs
+        */
+
+       if (!from_scratch && !new_selection.empty()) {
                selection->tracks.clear();
                selection->add (new_selection);
                begin_selection_op_history();
        }
 
-       if (show_editor_mixer_when_tracks_arrive) {
+       if (show_editor_mixer_when_tracks_arrive && !new_selection.empty()) {
                show_editor_mixer (true);
        }