time_info_box.cc

Go to the documentation of this file.

/*
    Copyright (C) 2011 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <algorithm>
#include "pbd/compose.h"

#include "gtkmm2ext/cairocell.h"
#include "gtkmm2ext/gui_thread.h"
#include "gtkmm2ext/utils.h"
#include "gtkmm2ext/stateful_button.h"
#include "gtkmm2ext/actions.h"

#include "ardour/location.h"
#include "ardour/profile.h"
#include "ardour/session.h"

#include "time_info_box.h"
#include "audio_clock.h"
#include "editor.h"
#include "control_point.h"
#include "automation_line.h"

#include "i18n.h"

using namespace Gtk;
using namespace ARDOUR;
using std::min;
using std::max;

TimeInfoBox::TimeInfoBox ()
        : left (2, 4)
        , right (2, 4)
        , syncing_selection (false)
        , syncing_punch (false)
{
        set_name (X_("TimeInfoBox"));

        selection_start = new AudioClock ("selection-start", false, "selection", false, false, false, false);
        selection_end = new AudioClock ("selection-end", false, "selection", false, false, false, false);
        selection_length = new AudioClock ("selection-length", false, "selection", false, false, true, false);

        punch_start = new AudioClock ("punch-start", false, "punch", false, false, false, false);
        punch_end = new AudioClock ("punch-end", false, "punch", false, false, false, false);

        selection_start->set_draw_background (false);
        selection_end->set_draw_background (false);
        selection_length->set_draw_background (false);
        punch_start->set_draw_background (false);
        punch_end->set_draw_background (false);

        selection_title.set_text (_("Selection"));
        punch_title.set_text (_("Punch"));

        set_homogeneous (false);
        set_spacing (0);
        set_border_width (2);

        pack_start (left, true, true);
        if (!ARDOUR::Profile->get_trx()) {
                pack_start (right, true, true);
        }

        left.set_homogeneous (false);
        left.set_spacings (0);
        left.set_border_width (2);
        left.set_col_spacings (2);

        right.set_homogeneous (false);
        right.set_spacings (0);
        right.set_border_width (2);
        right.set_col_spacings (2);

        Gtk::Label* l;

        selection_title.set_name ("TimeInfoSelectionTitle");
        left.attach (selection_title, 1, 2, 0, 1);
        l = manage (new Label);
        l->set_text (_("Start"));
        l->set_alignment (1.0, 0.5);
        l->set_name (X_("TimeInfoSelectionLabel"));
        left.attach (*l, 0, 1, 1, 2, FILL);
        left.attach (*selection_start, 1, 2, 1, 2);

        l = manage (new Label);
        l->set_text (_("End"));
        l->set_alignment (1.0, 0.5);
        l->set_name (X_("TimeInfoSelectionLabel"));
        left.attach (*l, 0, 1, 2, 3, FILL);
        left.attach (*selection_end, 1, 2, 2, 3);

        l = manage (new Label);
        l->set_text (_("Length"));
        l->set_alignment (1.0, 0.5);
        l->set_name (X_("TimeInfoSelectionLabel"));
        left.attach (*l, 0, 1, 3, 4, FILL);
        left.attach (*selection_length, 1, 2, 3, 4);

        punch_in_button.set_name ("punch button");
        punch_out_button.set_name ("punch button");
        punch_in_button.set_text (_("In"));
        punch_out_button.set_text (_("Out"));

        Glib::RefPtr<Action> act = ActionManager::get_action ("Transport", "TogglePunchIn");
        punch_in_button.set_related_action (act);
        act = ActionManager::get_action ("Transport", "TogglePunchOut");
        punch_out_button.set_related_action (act);

        Gtkmm2ext::UI::instance()->set_tip (punch_in_button, _("Start recording at auto-punch start"));
        Gtkmm2ext::UI::instance()->set_tip (punch_out_button, _("Stop recording at auto-punch end"));

        punch_title.set_name ("TimeInfoSelectionTitle");
        right.attach (punch_title, 3, 4, 0, 1);
        right.attach (punch_in_button, 2, 3, 1, 2, FILL, SHRINK);
        right.attach (*punch_start, 3, 4, 1, 2);
        right.attach (punch_out_button, 2, 3, 2, 3, FILL, SHRINK);
        right.attach (*punch_end, 3, 4, 2, 3);

        show_all ();

        selection_start->mode_changed.connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::sync_selection_mode), selection_start));
        selection_end->mode_changed.connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::sync_selection_mode), selection_end));
        selection_length->mode_changed.connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::sync_selection_mode), selection_length));

        punch_start->mode_changed.connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::sync_punch_mode), punch_start));
        punch_end->mode_changed.connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::sync_punch_mode), punch_end));

        selection_start->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::clock_button_release_event), selection_start), true);
        selection_end->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::clock_button_release_event), selection_end), true);

        punch_start->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::clock_button_release_event), punch_start), true);
        punch_end->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &TimeInfoBox::clock_button_release_event), punch_end), true);

        Editor::instance().get_selection().TimeChanged.connect (sigc::mem_fun (*this, &TimeInfoBox::selection_changed));
        Editor::instance().get_selection().RegionsChanged.connect (sigc::mem_fun (*this, &TimeInfoBox::selection_changed));

        Region::RegionPropertyChanged.connect (region_property_connections, invalidator (*this), boost::bind (&TimeInfoBox::region_property_change, this, _1, _2), gui_context());
        Editor::instance().MouseModeChanged.connect (editor_connections, invalidator(*this), boost::bind (&TimeInfoBox::track_mouse_mode, this), gui_context());
}

TimeInfoBox::~TimeInfoBox ()
{
        delete selection_length;
        delete selection_end;
        delete selection_start;
        
        delete punch_start;
        delete punch_end;
}

void
TimeInfoBox::track_mouse_mode ()
{
        selection_changed ();
}

void
TimeInfoBox::region_property_change (boost::shared_ptr<ARDOUR::Region> /* r */, const PBD::PropertyChange& what_changed)
{
        Selection& selection (Editor::instance().get_selection());

        if (selection.regions.empty()) {
                return;
        }

        PBD::PropertyChange our_interests;

        our_interests.add (ARDOUR::Properties::position);
        our_interests.add (ARDOUR::Properties::length);
        our_interests.add (ARDOUR::Properties::start);

        if (!what_changed.contains (our_interests)) {
                return;
        }

        /* TODO: check if RegionSelection includes the given region.
         * This is not straight foward because RegionSelection is done by
         * RegionView (not Region itself).
         */

        selection_changed ();
}

bool
TimeInfoBox::clock_button_release_event (GdkEventButton* ev, AudioClock* src)
{
        if (!_session) {
                return false;
        }

        if (ev->button == 1) {
                if (!src->off()) {
                        _session->request_locate (src->current_time ());
                }
                return true;
        }

        return false;
}

void
TimeInfoBox::sync_selection_mode (AudioClock* src)
{
        if (!syncing_selection) {
                syncing_selection = true;
                selection_start->set_mode (src->mode());
                selection_end->set_mode (src->mode());
                selection_length->set_mode (src->mode());
                syncing_selection = false;
        }
}

void
TimeInfoBox::sync_punch_mode (AudioClock* src)
{
        if (!syncing_punch) {
                syncing_punch = true;
                punch_start->set_mode (src->mode());
                punch_end->set_mode (src->mode());
                syncing_punch = false;
        }
}
        

void
TimeInfoBox::set_session (Session* s)
{
        SessionHandlePtr::set_session (s);

        selection_start->set_session (s);
        selection_end->set_session (s);
        selection_length->set_session (s);

        punch_start->set_session (s);
        punch_end->set_session (s);

        if (s) {
                Location* punch = s->locations()->auto_punch_location ();
                
                if (punch) {
                        watch_punch (punch);
                }
                
                punch_changed (punch);

                _session->auto_punch_location_changed.connect (_session_connections, MISSING_INVALIDATOR, 
                                                               boost::bind (&TimeInfoBox::punch_location_changed, this, _1), gui_context());
        }
}

void
TimeInfoBox::selection_changed ()
{
        framepos_t s, e;
        Selection& selection (Editor::instance().get_selection());

        switch (Editor::instance().current_mouse_mode()) {

        case Editing::MouseContent:
                /* displaying MIDI note selection is tricky */
                selection_start->set_off (true);
                selection_end->set_off (true);
                selection_length->set_off (true);
                break;

        case Editing::MouseObject:
                if (selection.regions.empty()) {
                        if (selection.points.empty()) {
                                Glib::RefPtr<Action> act = ActionManager::get_action ("MouseMode", "set-mouse-mode-object-range");
                                Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);

                                if (tact && tact->get_active() && !selection.time.empty()) {
                                        /* show selected range */
                                        selection_start->set_off (false);
                                        selection_end->set_off (false);
                                        selection_length->set_off (false);
                                        selection_start->set (selection.time.start());
                                        selection_end->set (selection.time.end_frame());
                                        selection_length->set (selection.time.length());
                                } else {
                                        selection_start->set_off (true);
                                        selection_end->set_off (true);
                                        selection_length->set_off (true);
                                }
                        } else {
                                s = max_framepos;
                                e = 0;
                                for (PointSelection::iterator i = selection.points.begin(); i != selection.points.end(); ++i) {
                                        framepos_t const p = (*i)->line().session_position ((*i)->model ());
                                        s = min (s, p);
                                        e = max (e, p);
                                }
                                selection_start->set_off (false);
                                selection_end->set_off (false);
                                selection_length->set_off (false);
                                selection_start->set (s);
                                selection_end->set (e);
                                selection_length->set (e - s + 1);
                        }
                } else {
                        s = selection.regions.start();
                        e = selection.regions.end_frame();
                        selection_start->set_off (false);
                        selection_end->set_off (false);
                        selection_length->set_off (false);
                        selection_start->set (s);
                        selection_end->set (e);
                        selection_length->set (e - s + 1);
                }
                break;

        case Editing::MouseRange:
                if (selection.time.empty()) {
                        Glib::RefPtr<Action> act = ActionManager::get_action ("MouseMode", "set-mouse-mode-object-range");
                        Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);

                        if (tact && tact->get_active() &&  !selection.regions.empty()) {        
                                /* show selected regions */
                                s = selection.regions.start();
                                e = selection.regions.end_frame();
                                selection_start->set_off (false);
                                selection_end->set_off (false);
                                selection_length->set_off (false);
                                selection_start->set (s);
                                selection_end->set (e);
                                selection_length->set (e - s + 1);
                        } else {
                                selection_start->set_off (true);
                                selection_end->set_off (true);
                                selection_length->set_off (true);
                        }
                } else {
                        selection_start->set_off (false);
                        selection_end->set_off (false);
                        selection_length->set_off (false);
                        selection_start->set (selection.time.start());
                        selection_end->set (selection.time.end_frame());
                        selection_length->set (selection.time.length());
                }
                break;

        default:
                selection_start->set_off (true);
                selection_end->set_off (true);
                selection_length->set_off (true);       
                break;
        }
}

void
TimeInfoBox::punch_location_changed (Location* loc)
{
        if (loc) {
                watch_punch (loc);
        } 
}

void
TimeInfoBox::watch_punch (Location* punch)
{
        punch_connections.drop_connections ();

        punch->start_changed.connect (punch_connections, MISSING_INVALIDATOR, boost::bind (&TimeInfoBox::punch_changed, this, _1), gui_context());
        punch->end_changed.connect (punch_connections, MISSING_INVALIDATOR, boost::bind (&TimeInfoBox::punch_changed, this, _1), gui_context());

        punch_changed (punch);
}

void
TimeInfoBox::punch_changed (Location* loc)
{
        if (!loc) {
                punch_start->set_off (true);
                punch_end->set_off (true);
                return;
        }

        punch_start->set_off (false);
        punch_end->set_off (false);

        punch_start->set (loc->start());
        punch_end->set (loc->end());
}