ardour/gtk2_ardour/region_editor.h

/*
 * Copyright (C) 2005-2018 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2009-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2010 Carl Hetherington <carl@carlh.net>
 *
 * 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 <map>

#include <ytkmm/adjustment.h>
#include <ytkmm/arrow.h>
#include <ytkmm/box.h>
#include <ytkmm/button.h>
#include <ytkmm/entry.h>
#include <ytkmm/eventbox.h>
#include <ytkmm/frame.h>
#include <ytkmm/label.h>
#include <ytkmm/listviewtext.h>
#include <ytkmm/scrolledwindow.h>
#include <ytkmm/separator.h>
#include <ytkmm/spinbutton.h>
#include <ytkmm/table.h>
#include <ytkmm/togglebutton.h>

#include "gtkmm2ext/bindings.h"
#include "gtkmm2ext/dndtreeview.h"
#include "gtkmm2ext/dndvbox.h"

#include "widgets/frame.h"

#include "pbd/signals.h"

#include "audio_clock.h"
#include "plugin_interest.h"

namespace ARDOUR {
	class Region;
	class Session;
	class RegionFxPlugin;
}

class RegionView;
class ClockGroup;

class RegionEditor : public ArdourWidgets::Frame, public ARDOUR::SessionHandlePtr
{
public:
	RegionEditor (ARDOUR::Session*, std::shared_ptr<ARDOUR::Region>);
	virtual ~RegionEditor ();

	std::shared_ptr<ARDOUR::Region> region () const { return _region; }

	static void setup_actions_and_bindings ();

protected:
	virtual void region_changed (const PBD::PropertyChange&);
	virtual void region_fx_changed ();

	Gtk::Table _table_main;
	Gtk::Table _table_clocks;
	Gtk::Table _table_tempo;

private:
	class RegionFxEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
	{
	public:
		RegionFxEntry (std::shared_ptr<ARDOUR::RegionFxPlugin>, bool pre);

		Gtk::EventBox& action_widget () { return _fx_btn; }
		Gtk::Widget& widget () { return _box; }
		std::string drag_text () const { return name (); }
		bool is_selectable() const { return _selectable; }
		bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
		void set_visual_state (Gtkmm2ext::VisualState, bool);
		bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
		std::shared_ptr<ARDOUR::RegionFxPlugin> region_fx_plugin () const { return _rfx; }

	private:
		std::string name () const;

		Gtk::VBox                               _box;
		ArdourWidgets::ArdourButton             _fx_btn;
		std::shared_ptr<ARDOUR::RegionFxPlugin> _rfx;
		ARDOUR::PluginPresetPtr                 _plugin_preset_pointer;
		bool                                    _selectable;
	};

	class RegionFxBox : public Gtk::VBox, public PluginInterestedObject //, public ARDOUR::SessionHandlePtr
	{
	public:
		RegionFxBox (std::shared_ptr<ARDOUR::Region>);
		void redisplay_plugins ();

		static void register_actions ();

	private:
		static void load_bindings ();
		static void static_delete ();

		static Glib::RefPtr<Gtk::ActionGroup> rfx_box_actions;
		static Gtkmm2ext::Bindings*           bindings;
		static RegionFxBox*                   current_rfx_box;

		void add_fx_to_display (std::weak_ptr<ARDOUR::RegionFxPlugin>);
		void show_plugin_gui (std::weak_ptr<ARDOUR::RegionFxPlugin>, bool custom_ui = true);
		void queue_delete_region_fx (std::weak_ptr<ARDOUR::RegionFxPlugin>);
		bool idle_delete_region_fx (std::weak_ptr<ARDOUR::RegionFxPlugin>);
		void notify_plugin_load_fail (uint32_t cnt = 1);
		bool enter_notify (GdkEventCrossing*);
		bool leave_notify (GdkEventCrossing*);
		void clear_automation (std::weak_ptr<ARDOUR::RegionFxPlugin>);
		void update_controls ();
		void delete_selected ();

		/* PluginInterestedObject */
		bool use_plugins (SelectedPlugins const&);

		/* DNDVbox signal handlers */
		bool fxe_button_press_event (GdkEventButton*, RegionFxEntry*);
		bool fxe_button_release_event (GdkEventButton*, RegionFxEntry*);

		void reordered ();
		void plugin_drop (Gtk::SelectionData const&, RegionFxEntry*, Glib::RefPtr<Gdk::DragContext> const&);
		void object_drop (Gtkmm2ext::DnDVBox<RegionFxEntry>*, RegionFxEntry*, Glib::RefPtr<Gdk::DragContext> const&);
		void delete_dragged_plugins (std::list<std::shared_ptr<ARDOUR::RegionFxPlugin>> const&);
		bool drag_refuse (Gtkmm2ext::DnDVBox<RegionFxEntry>*, RegionFxEntry*);

		std::shared_ptr<ARDOUR::RegionFxPlugin> find_drop_position (RegionFxEntry*);

		std::shared_ptr<ARDOUR::Region>   _region;
		Gtkmm2ext::DnDVBox<RegionFxEntry> _display;
		Gtk::ScrolledWindow               _scroller;
		Gtk::EventBox                     _base;
		bool                              _no_redisplay;
		int                               _placement;

		sigc::connection screen_update_connection;
	};

	std::shared_ptr<ARDOUR::Region> _region;

	void connect_editor_events ();

	Gtk::Label _name_label;
	Gtk::Entry _name_entry;
	Gtk::Label _position_label;
	Gtk::Label _end_label;
	Gtk::Label _length_label;
	Gtk::Label _sync_relative_label;
	Gtk::Label _sync_absolute_label;
	Gtk::Label _start_label;
	Gtk::Label _region_fx_label;
	Gtk::Label _region_tempo_label;
	Gtk::Label _region_meter_label;

	Gtk::Entry _region_tempo_entry;
	Gtk::Entry _region_meter_entry;

	Gtk::ToggleButton _audition_button;

	ClockGroup* _clock_group;

	AudioClock _position_clock;
	AudioClock _end_clock;
	AudioClock _length_clock;
	AudioClock _sync_offset_relative_clock; ///< sync offset relative to the start of the region
	AudioClock _sync_offset_absolute_clock; ///< sync offset relative to the start of the timeline
	AudioClock _start_clock;

	RegionFxBox _region_fx_box;

	bool _spin_arrow_grab;

	Gtk::Label        _sources_label;
	Gtk::ListViewText _sources;

	PBD::ScopedConnection _state_connection;
	PBD::ScopedConnection _audition_connection;
	PBD::ScopedConnection _region_connection;

	void bounds_changed (const PBD::PropertyChange&);
	void tempo_changed (const PBD::PropertyChange&);
	void name_changed ();

	void audition_state_changed (bool);

	void activation ();

	void name_entry_changed ();
	void position_clock_changed ();
	void end_clock_changed ();
	void length_clock_changed ();
	void sync_offset_absolute_clock_changed ();
	void sync_offset_relative_clock_changed ();

	void audition_button_toggled ();

	gint bpressed (GdkEventButton* ev, Gtk::SpinButton* but, void (RegionEditor::*pmf) ());
	gint breleased (GdkEventButton* ev, Gtk::SpinButton* but, void (RegionEditor::*pmf) ());

	bool on_delete_event (GdkEventAny*);

	void set_clock_mode_from_primary ();

	bool tempo_entry_key (GdkEventKey*);
	bool meter_entry_key (GdkEventKey*);
	void filter_tempo_text (const Glib::ustring&, int*);
	void filter_meter_text (const Glib::ustring&, int*);
	bool tempo_entry_focused (GdkEventFocus*);
	bool meter_entry_focused (GdkEventFocus*);
};