/*
 * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
 * Copyright (C) 2007-2011 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2007-2019 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2007 Doug McLain <doug@nostar.net>
 * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2016-2019 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.
 */

#ifndef __gtk_ardour_region_view_h__
#define __gtk_ardour_region_view_h__

#ifdef interface
#undef interface
#endif

#include <vector>

#include <sigc++/signal.h>
#include "ardour/region.h"

#include "canvas/fwd.h"

#include "time_axis_view_item.h"
#include "automation_line.h"
#include "enums.h"
#include "marker.h"

class TimeAxisView;
class RegionEditor;
class GhostRegion;
class AutomationTimeAxisView;
class AutomationRegionView;

namespace ArdourCanvas {
	class Polygon;
	class Text;
}

class RegionView : public TimeAxisViewItem
{
public:
	RegionView (ArdourCanvas::Container*          parent,
	            TimeAxisView&                     time_view,
	            const boost::shared_ptr<ARDOUR::Region>& region,
	            double                            samples_per_pixel,
	            uint32_t                          base_color,
	            bool                              automation = false);

	RegionView (const RegionView& other);
	RegionView (const RegionView& other, const boost::shared_ptr<ARDOUR::Region>& other_region);

	~RegionView ();

	void set_selected (bool yn);

	virtual void init (bool what_changed);

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

	bool is_valid() const    { return valid; }

	void set_valid (bool yn) { valid = yn; }

	virtual void set_height (double);
	virtual void set_samples_per_pixel (double);
	virtual bool set_duration (Temporal::timecnt_t const &, void*);

	void move (double xdelta, double ydelta);

	void raise_to_top ();
	void lower_to_bottom ();

	bool set_position(Temporal::timepos_t const & pos, void* src, double* delta = 0);

	virtual void show_region_editor ();
	void hide_region_editor ();

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

	virtual GhostRegion* add_ghost (TimeAxisView&) = 0;
	void remove_ghost_in (TimeAxisView&);
	void remove_ghost (GhostRegion*);

	virtual void entered () {}
	virtual void exited () {}

	bool display_enabled() const;
	void redisplay (bool view_only = true) {
		_redisplay (view_only);
	}

	virtual void tempo_map_changed () {
		_redisplay (true);
	}

	struct DisplaySuspender {
		DisplaySuspender (RegionView& rv, bool just_view = false) : region_view (rv), view_only (just_view) {
			region_view.disable_display ();
		}

		DisplaySuspender (DisplaySuspender const & other) : region_view (other.region_view), view_only (other.view_only) {
			region_view.disable_display ();
		}

		~DisplaySuspender () {
			region_view.enable_display (view_only);
		}
		RegionView& region_view;
		bool view_only;
	};

	virtual void update_coverage_frame (LayerDisplay);

	static PBD::Signal1<void,RegionView*> RegionViewGoingAway;

	/** Called when a front trim is about to begin */
	virtual void trim_front_starting () {}

	bool trim_front (Temporal::timepos_t const &, bool);

	/** Called when a start trim has finished */
	virtual void trim_front_ending () {}

	bool trim_end (Temporal::timepos_t const &, bool);
	void move_contents (Temporal::timecnt_t const &);
	virtual void thaw_after_trim ();

	void set_silent_frames (const ARDOUR::AudioIntervalResult&, double threshold);
	void drop_silent_frames ();
	void hide_silent_frames ();

	struct PositionOrder {
		bool operator()(const RegionView* a, const RegionView* b) {
			return a->region()->position() < b->region()->position();
		}
	};

	Temporal::timecnt_t snap_region_time_to_region_time (Temporal::timecnt_t const &, bool ensure_snap = false) const;

	void update_visibility ();

	ARDOUR::CueMarker find_model_cue_marker (ArdourMarker*);
	void drop_cue_marker (ArdourMarker*);

protected:

	/** Allows derived types to specify their visibility requirements
	 * to the TimeAxisViewItem parent class
	 */
	RegionView (ArdourCanvas::Container *,
	            TimeAxisView&,
	            const boost::shared_ptr<ARDOUR::Region>&,
	            double samples_per_pixel,
	            uint32_t basic_color,
	            bool recording,
	            TimeAxisViewItem::Visibility);

	bool canvas_group_event (GdkEvent*);

	virtual void region_resized (const PBD::PropertyChange&);
	virtual void region_muted ();
	void         region_locked ();
	void         region_opacity ();
	virtual void region_renamed ();
	void         region_sync_changed ();

	std::string make_name () const;

	static gint _lock_toggle (ArdourCanvas::Item*, GdkEvent*, void*);
	void        lock_toggle ();

	virtual void set_colors ();
	virtual void set_sync_mark_color ();
	virtual void reset_width_dependent_items (double pixel_width);

	virtual void color_handler () {}
	virtual void parameter_changed (std::string const&);

	void maybe_raise_cue_markers ();

	Temporal::timecnt_t region_relative_distance (Temporal::timecnt_t const &, Temporal::TimeDomain desired_time_domain);

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

	ArdourCanvas::Polygon* sync_mark; ///< polygon for sync position
	ArdourCanvas::Line* sync_line; ///< polygon for sync position

	RegionEditor* editor;

	std::vector<ControlPoint *> control_points;
	double current_visible_sync_position;

	bool      valid; ///< see StreamView::redisplay_diskstream()
	uint32_t _disable_display; ///< see StreamView::redisplay_diskstream()
	double   _pixel_width;
	bool      in_destructor;

	bool wait_for_data;

	std::vector<GhostRegion*> ghosts;

	/** a list of rectangles which are used in stacked display mode to colour
	 * different bits of regions according to whether or not they are the one
	 * that will be played at any given time.
	 */
	std::list<ArdourCanvas::Rectangle*> _coverage_frame;

	/** a list of rectangles used to show silent segments
	*/
	std::list<ArdourCanvas::Rectangle*> _silent_frames;
	/** a list of rectangles used to show the current silence threshold
	*/
	std::list<ArdourCanvas::Rectangle*> _silent_threshold_samples;
	/** a text item to display strip silence statistics */
	ArdourCanvas::Text* _silence_text;

private:
	void update_xrun_markers ();
	std::list<std::pair<samplepos_t, ArdourCanvas::Arrow*> > _xrun_markers;
	bool _xrun_markers_visible;

	void update_cue_markers ();

	struct ViewCueMarker {
		ArdourMarker* view_marker;
		ARDOUR::CueMarker     model_marker;

		ViewCueMarker (ArdourMarker* m, ARDOUR::CueMarker const & c) : view_marker (m), model_marker (c) {}
		~ViewCueMarker();
	};

	typedef std::list<ViewCueMarker*> ViewCueMarkers;
	ViewCueMarkers _cue_markers;
	bool _cue_markers_visible;
	virtual void _redisplay (bool) = 0;

  private:
	friend struct DisplaySuspender;
	void enable_display (bool view_only);
	void disable_display();

};

#endif /* __gtk_ardour_region_view_h__ */
