automation_time_axis.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005 Karsten Wiese <fzuuzf@googlemail.com>
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
 * Copyright (C) 2006 Sampo Savolainen <v2@iki.fi>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2014-2015 Ben Loftis <ben@harrisonconsoles.com>
 * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <list>
#include <memory>
#include <string>
#include <utility>
 
#include "ardour/types.h"
#include "ardour/automatable.h"
#include "ardour/automation_list.h"
 
#include "canvas/rectangle.h"
 
#include "widgets/ardour_button.h"
#include "widgets/ardour_dropdown.h"
 
#include "line_merger.h"
#include "time_axis_view.h"
#include "automation_controller.h"
 
namespace ARDOUR {
        class Session;
        class Stripable;
        class AutomationControl;
}
 
class PublicEditor;
class TimeSelection;
class RegionSelection;
class PointSelection;
class AutomationLine;
class EditorAutomationLine;
class Selection;
class Selectable;
class AutomationStreamView;
class AutomationController;
class ItemCounts;
 
class AutomationTimeAxisView : public TimeAxisView, public LineMerger
{
public:
        AutomationTimeAxisView (ARDOUR::Session*,
                                std::shared_ptr<ARDOUR::Stripable>,
                                std::shared_ptr<ARDOUR::Automatable>,
                                std::shared_ptr<ARDOUR::AutomationControl>,
                                Evoral::Parameter,
                                PublicEditor&,
                                TimeAxisView& parent,
                                bool show_regions,
                                ArdourCanvas::Canvas& canvas,
                                const std::string & name = "", /* translatable */
                                const std::string & plug_name = "");
 
        ~AutomationTimeAxisView();
 
        virtual void set_height (uint32_t, TrackHeightMode m = OnlySelf, bool from_idle = false);
        void set_samples_per_pixel (double);
        std::string name() const { return _name; }
        Gdk::Color color () const;
        void update_name_from_param ();
 
        std::shared_ptr<ARDOUR::Stripable> stripable() const;
        ARDOUR::PresentationInfo const & presentation_info () const;
 
        void add_automation_event (GdkEvent *, Temporal::timepos_t const &, double, bool with_guard_points);
 
        void clear_lines ();
 
        std::shared_ptr<EditorAutomationLine> line() { return _line; }
 
        std::list<std::shared_ptr<AutomationLine> > lines () const;
 
        AutomationStreamView* automation_view() const { return _view; }
 
        void set_selected_points (PointSelection&);
        void _get_selectables (Temporal::timepos_t const &, Temporal::timepos_t const &, double top, double bot, std::list<Selectable *>&, bool within);
        void get_inverted_selectables (Selection&, std::list<Selectable*>& results);
 
        void show_timestretch (Temporal::timepos_t const &/*start*/, Temporal::timepos_t const & /*end*/, int /*layers*/, int /*layer*/) {}
        void hide_timestretch () {}
 
        /* editing operations */
 
        void cut_copy_clear (Selection&, Editing::CutCopyOp);
        bool paste (Temporal::timepos_t const &, const Selection&, PasteContext&);
 
        int  set_state (const XMLNode&, int version);
 
        std::string state_id() const;
        static bool parse_state_id (std::string const &, PBD::ID &, bool &, Evoral::Parameter &);
 
        std::shared_ptr<ARDOUR::AutomationControl> control() const   { return _control; }
        std::shared_ptr<AutomationController>      controller() const { return _controller; }
        Evoral::Parameter parameter () const {
                return _parameter;
        }
 
        ArdourCanvas::Rectangle& base_item () const {
                return *_base_rect;
        }
 
        bool has_automation () const;
 
        std::shared_ptr<ARDOUR::Stripable> parent_stripable () {
                return _stripable;
        }
 
        bool show_regions () const {
                return _show_regions;
        }
 
        void set_automation_state (ARDOUR::AutoState);
 
        enum VelocityMode {
                VelocityModeLollipops,
                VelocityModeLine
        };
 
        VelocityMode velocity_mode () const { return _velocity_mode; }
        void set_velocity_mode (VelocityMode, bool force = false);
 
        void set_selected_regionviews (RegionSelection&);
 
        MergeableLine* make_merger ();
 
protected:
        /* Note that for MIDI controller "automation" (in regions), all of these
         * may be set.  In this case, _automatable is likely _route so the
         * controller will send immediate events out the route's MIDI port. */
 
        std::shared_ptr<ARDOUR::Stripable> _stripable;
        std::shared_ptr<ARDOUR::AutomationControl> _control;
        std::shared_ptr<ARDOUR::Automatable> _automatable;
        std::shared_ptr<AutomationController> _controller;
        Evoral::Parameter _parameter;
 
        ArdourCanvas::Rectangle* _base_rect;
        std::shared_ptr<EditorAutomationLine> _line;
 
        std::string _name;
 
        AutomationStreamView* _view;
 
        bool    first_call_to_set_height;
 
        ArdourWidgets::ArdourButton   hide_button;
        ArdourWidgets::ArdourDropdown auto_dropdown;
        Gtk::Label*        plugname;
        bool               plugname_packed;
 
        Gtk::CheckMenuItem*     auto_off_item;
        Gtk::CheckMenuItem*     auto_play_item;
        Gtk::CheckMenuItem*     auto_touch_item;
        Gtk::CheckMenuItem*     auto_write_item;
        Gtk::CheckMenuItem*     auto_latch_item;
 
        Gtk::CheckMenuItem* mode_discrete_item;
        Gtk::CheckMenuItem* mode_line_item;
        Gtk::CheckMenuItem* mode_log_item;
        Gtk::CheckMenuItem* mode_exp_item;
 
        bool _show_regions;
 
        void add_line (std::shared_ptr<EditorAutomationLine>);
 
        void clear_clicked ();
        void hide_clicked ();
 
        virtual bool can_edit_name() const {return false;}
 
        void build_display_menu ();
 
        void cut_copy_clear_one (AutomationLine&, Selection&, Editing::CutCopyOp);
        bool paste_one (Temporal::timepos_t const &, unsigned, float times, const Selection&, ItemCounts& counts, bool greedy=false);
        void route_going_away ();
 
        bool ignore_state_request;
        bool ignore_mode_request;
 
        bool propagate_time_selection () const;
 
        void automation_state_changed ();
 
        void set_interpolation (ARDOUR::AutomationList::InterpolationStyle);
 
        void interpolation_changed (ARDOUR::AutomationList::InterpolationStyle);
 
        PBD::ScopedConnectionList _list_connections;
        PBD::ScopedConnectionList _stripable_connections;
 
        void entered ();
        void exited ();
 
        //void set_colors ();
        void color_handler ();
 
        static Pango::FontDescription name_font;
        static bool have_name_font;
 
        std::string automation_state_off_string () const;
 
        virtual void add_contents (bool show_regions);
 
        VelocityMode _velocity_mode;
 
        bool show_automation_controls () const;
 
private:
        int set_state_2X (const XMLNode &, int);
};