3b75909ad1e87f4667c38e3748674179a630dc59
[ardour.git] / gtk2_ardour / editor_summary.h
1 /*
2     Copyright (C) 2009 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef __gtk_ardour_editor_summary_h__
21 #define __gtk_ardour_editor_summary_h__
22
23 #include "gtkmm2ext/cairo_widget.h"
24 #include "editor_component.h"
25
26 namespace ARDOUR {
27         class Session;
28 }
29
30 class Editor;
31
32 /** Class to provide a visual summary of the contents of an editor window; represents
33  *  the whole session as a set of lines, one per region view.
34  */
35 class EditorSummary : public CairoWidget, public EditorComponent, public ARDOUR::SessionHandlePtr, public PBD::ScopedConnectionList
36 {
37 public:
38         EditorSummary (Editor *);
39         ~EditorSummary ();
40
41         void set_session (ARDOUR::Session *);
42         void set_overlays_dirty ();
43         void set_background_dirty ();
44         void routes_added (std::list<RouteTimeAxisView*> const &);
45
46 private:
47         void parameter_changed (std::string);
48         void on_size_allocate (Gtk::Allocation& alloc);
49
50         enum Position {
51                 LEFT,
52                 RIGHT,
53                 BOTTOM,
54                 INSIDE,
55                 TO_LEFT_OR_RIGHT
56         };
57
58         void on_size_request (Gtk::Requisition *);
59         bool on_button_press_event (GdkEventButton *);
60         bool on_button_release_event (GdkEventButton *);
61         bool on_motion_notify_event (GdkEventMotion *);
62         bool on_scroll_event (GdkEventScroll *);
63         bool on_key_press_event (GdkEventKey*);
64         bool on_key_release_event (GdkEventKey*);
65         bool on_enter_notify_event (GdkEventCrossing*);
66         bool on_leave_notify_event (GdkEventCrossing*);
67
68         void centre_on_click (GdkEventButton *);
69         void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
70         void render_region (RegionView*, cairo_t*, double) const;
71         void get_editor (std::pair<double, double>* x, std::pair<double, double>* y = NULL) const;
72         void set_editor (double);
73         void set_editor (std::pair<double, double>);
74         void set_editor_x (double);
75         void set_editor_x (std::pair<double, double>);
76         void playhead_position_changed (framepos_t);
77         double editor_y_to_summary (double) const;
78         Position get_position (double, double) const;
79         void set_cursor (Position);
80         void route_gui_changed (PBD::PropertyChange const&);
81         bool suspending_editor_updates () const;
82         double playhead_frame_to_position (framepos_t) const;
83         framepos_t position_to_playhead_frame_to_position (double pos) const;
84         void set_overlays_dirty_rect (int, int, int, int);
85
86         void summary_zoom_step (  int steps );
87
88         framepos_t _start; ///< start frame of the overview
89         framepos_t _end; ///< end frame of the overview
90
91         framepos_t _leftmost; ///< the earliest frame we ever viewed
92         framepos_t _rightmost; ///< the latest frame we ever viewed
93
94         /** fraction of the session length by which the overview size should extend past the start and end markers */
95         double _overhang_fraction;
96
97         double _x_scale; ///< pixels per frame for the x axis of the pixmap
98         double _track_height;
99         double _last_playhead;
100
101         std::pair<double, double> _start_editor_x;
102         double _start_mouse_x;
103         double _start_mouse_y;
104
105         Position _start_position;
106
107         bool _move_dragging;
108
109         //used for zooming
110         int _last_mx;
111         int _last_my;
112         int _last_dx;
113         int _last_dy;
114         int _last_y_delta;
115
116         std::pair<double, double> _view_rectangle_x;
117         std::pair<double, double> _view_rectangle_y;
118
119         std::pair<double, double> _pending_editor_x;
120         std::pair<double, double> _pending_editor_y;
121         bool _pending_editor_changed;
122
123         bool _zoom_trim_dragging;
124         Position _zoom_trim_position;
125
126         bool _old_follow_playhead;
127         cairo_surface_t* _image;
128         void render_background_image ();
129         bool _background_dirty;
130
131         PBD::ScopedConnectionList position_connection;
132         PBD::ScopedConnection route_ctrl_id_connection;
133         PBD::ScopedConnectionList region_property_connection;
134 };
135
136 #endif