2 Copyright (C) 2003 Paul Davis
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.
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.
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.
22 #include "pbd/error.h"
23 #include "pbd/stacktrace.h"
25 #include "ardour/types.h"
26 #include "ardour/ardour.h"
28 #include "gtkmm2ext/utils.h"
29 #include "gtkmm2ext/gui_thread.h"
31 #include "canvas/container.h"
32 #include "canvas/rectangle.h"
33 #include "canvas/debug.h"
34 #include "canvas/text.h"
35 #include "canvas/utils.h"
37 #include "ardour/profile.h"
39 #include "ardour_ui.h"
41 * ardour_ui.h was moved up in the include list
42 * due to a conflicting definition of 'Rect' between
43 * Apple's MacTypes.h file and GTK
46 #include "public_editor.h"
47 #include "time_axis_view_item.h"
48 #include "time_axis_view.h"
50 #include "rgb_macros.h"
55 using namespace Editing;
58 using namespace ARDOUR;
59 using namespace ARDOUR_UI_UTILS;
60 using namespace Gtkmm2ext;
62 Pango::FontDescription TimeAxisViewItem::NAME_FONT;
63 const double TimeAxisViewItem::NAME_X_OFFSET = 15.0;
64 const double TimeAxisViewItem::GRAB_HANDLE_TOP = 0.0;
65 const double TimeAxisViewItem::GRAB_HANDLE_WIDTH = 10.0;
66 const double TimeAxisViewItem::RIGHT_EDGE_SHIFT = 1.0;
68 int TimeAxisViewItem::NAME_HEIGHT;
69 double TimeAxisViewItem::NAME_Y_OFFSET;
70 double TimeAxisViewItem::NAME_HIGHLIGHT_SIZE;
71 double TimeAxisViewItem::NAME_HIGHLIGHT_THRESH;
74 TimeAxisViewItem::set_constant_heights ()
76 NAME_FONT = Pango::FontDescription (ARDOUR_UI::config()->get_canvasvar_SmallFont());
82 Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout (X_("Hg")); /* ascender + descender */
86 layout->set_font_description (NAME_FONT);
87 get_pixel_size (layout, width, height);
89 layout = foo.create_pango_layout (X_("H")); /* just the ascender */
93 /* Config->get_show_name_highlight) == true:
94 Y_OFFSET is measured from bottom of the time axis view item.
95 Config->get_show_name_highlight) == false:
96 Y_OFFSET is measured from the top of the time axis view item.
99 if (Config->get_show_name_highlight()) {
100 NAME_Y_OFFSET = height + 1;
101 NAME_HIGHLIGHT_SIZE = height + 2;
104 NAME_HIGHLIGHT_SIZE = 0;
106 NAME_HIGHLIGHT_THRESH = NAME_HIGHLIGHT_SIZE * 3;
110 * Construct a new TimeAxisViewItem.
112 * @param it_name the unique name of this item
113 * @param parent the parent canvas group
114 * @param tv the TimeAxisView we are going to be added to
115 * @param spu samples per unit
117 * @param start the start point of this item
118 * @param duration the duration of this item
119 * @param recording true if this is a recording region view
120 * @param automation true if this is an automation region view
122 TimeAxisViewItem::TimeAxisViewItem(
123 const string & it_name, ArdourCanvas::Item& parent, TimeAxisView& tv, double spu, uint32_t base_color,
124 framepos_t start, framecnt_t duration, bool recording, bool automation, Visibility vis
127 , frame_position (-1)
128 , item_name (it_name)
130 , _recregion (recording)
131 , _automation (automation)
135 init (&parent, spu, base_color, start, duration, vis, true, true);
138 TimeAxisViewItem::TimeAxisViewItem (const TimeAxisViewItem& other)
141 , PBD::ScopedConnectionList()
142 , trackview (other.trackview)
143 , frame_position (-1)
144 , item_name (other.item_name)
146 , _recregion (other._recregion)
147 , _automation (other._automation)
148 , _dragging (other._dragging)
151 /* share the other's parent, but still create a new group */
153 ArdourCanvas::Item* parent = other.group->parent();
155 _selected = other._selected;
157 init (parent, other.samples_per_pixel, other.fill_color, other.frame_position,
158 other.item_duration, other.visibility, other.wide_enough_for_name, other.high_enough_for_name);
162 TimeAxisViewItem::init (ArdourCanvas::Item* parent, double fpp, uint32_t base_color,
163 framepos_t start, framepos_t duration, Visibility vis,
164 bool wide, bool high)
166 group = new ArdourCanvas::Container (parent);
167 CANVAS_DEBUG_NAME (group, string_compose ("TAVI group for %1", get_item_name()));
168 group->Event.connect (sigc::mem_fun (*this, &TimeAxisViewItem::canvas_group_event));
170 fill_color = base_color;
171 samples_per_pixel = fpp;
172 frame_position = start;
173 item_duration = duration;
174 name_connected = false;
175 position_locked = false;
176 max_item_duration = ARDOUR::max_framepos;
177 min_item_duration = 0;
178 show_vestigial = true;
183 wide_enough_for_name = wide;
184 high_enough_for_name = high;
188 warning << "Time Axis Item Duration == 0" << endl;
191 vestigial_frame = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, 1.0, 2.0, trackview.current_height()));
192 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
193 vestigial_frame->hide ();
194 vestigial_frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_VestigialFrame());
195 vestigial_frame->set_fill_color (ARDOUR_UI::config()->get_canvasvar_VestigialFrame());
197 if (visibility & ShowFrame) {
198 frame = new ArdourCanvas::Rectangle (group,
199 ArdourCanvas::Rect (0.0, 0.0,
200 trackview.editor().sample_to_pixel(duration) + RIGHT_EDGE_SHIFT,
201 trackview.current_height() - 1.0));
203 CANVAS_DEBUG_NAME (frame, string_compose ("frame for %1", get_item_name()));
205 if (Config->get_show_name_highlight()) {
206 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
208 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT|ArdourCanvas::Rectangle::BOTTOM));
212 frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_RecordingRect());
214 frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_TimeAxisFrame());
222 if (Config->get_show_name_highlight() && (visibility & ShowNameHighlight)) {
227 if (visibility & FullWidthNameHighlight) {
229 width = trackview.editor().sample_to_pixel(item_duration) + RIGHT_EDGE_SHIFT;
232 width = trackview.editor().sample_to_pixel(item_duration) - 2.0 + RIGHT_EDGE_SHIFT;
235 name_highlight = new ArdourCanvas::Rectangle (group,
236 ArdourCanvas::Rect (start,
237 trackview.current_height() - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE,
238 width - 2.0 + RIGHT_EDGE_SHIFT,
239 trackview.current_height() - 1.0));
240 CANVAS_DEBUG_NAME (name_highlight, string_compose ("name highlight for %1", get_item_name()));
241 name_highlight->set_data ("timeaxisviewitem", this);
242 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
243 name_highlight->set_outline_color (RGBA_TO_UINT (0,0,0,255));
249 if (visibility & ShowNameText) {
250 name_text = new ArdourCanvas::Text (group);
251 CANVAS_DEBUG_NAME (name_text, string_compose ("name text for %1", get_item_name()));
252 if (Config->get_show_name_highlight()) {
253 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, trackview.current_height() - NAME_Y_OFFSET));
255 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, NAME_Y_OFFSET));
257 name_text->set_font_description (NAME_FONT);
262 /* create our grab handles used for trimming/duration etc */
263 if (!_recregion && !_automation) {
264 double top = TimeAxisViewItem::GRAB_HANDLE_TOP;
265 double width = TimeAxisViewItem::GRAB_HANDLE_WIDTH;
267 frame_handle_start = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
268 CANVAS_DEBUG_NAME (frame_handle_start, "TAVI frame handle start");
269 frame_handle_start->set_outline (false);
270 frame_handle_start->set_fill (false);
271 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_start));
273 frame_handle_end = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
274 CANVAS_DEBUG_NAME (frame_handle_end, "TAVI frame handle end");
275 frame_handle_end->set_outline (false);
276 frame_handle_end->set_fill (false);
277 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_end));
279 frame_handle_start = frame_handle_end = 0;
282 set_color (base_color);
284 set_duration (item_duration, this);
285 set_position (start, this);
287 Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&TimeAxisViewItem::parameter_changed, this, _1), gui_context ());
288 ARDOUR_UI::config()->ParameterChanged.connect (sigc::mem_fun (*this, &TimeAxisViewItem::parameter_changed));
291 TimeAxisViewItem::~TimeAxisViewItem()
297 TimeAxisViewItem::canvas_group_event (GdkEvent* /*ev*/)
303 TimeAxisViewItem::hide_rect ()
305 rect_visible = false;
308 if (name_highlight) {
309 name_highlight->set_outline_what (ArdourCanvas::Rectangle::What (0));
310 name_highlight->set_fill_color (UINT_RGBA_CHANGE_A (fill_color, 64));
315 TimeAxisViewItem::show_rect ()
320 if (name_highlight) {
321 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
322 name_highlight->set_fill_color (fill_color);
327 * Set the position of this item on the timeline.
329 * @param pos the new position
330 * @param src the identity of the object that initiated the change
331 * @return true on success
335 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
337 if (position_locked) {
341 frame_position = pos;
343 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
346 (*delta) = new_unit_pos - group->position().x;
351 if (new_unit_pos == group->position().x) {
356 group->set_x_position (new_unit_pos);
358 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
363 /** @return position of this item on the timeline */
365 TimeAxisViewItem::get_position() const
367 return frame_position;
371 * Set the duration of this item.
373 * @param dur the new duration of this item
374 * @param src the identity of the object that initiated the change
375 * @return true on success
379 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
381 if ((dur > max_item_duration) || (dur < min_item_duration)) {
382 warning << string_compose (
383 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
384 get_item_name(), dur)
395 reset_width_dependent_items (trackview.editor().sample_to_pixel (dur));
397 DurationChanged (dur, src); /* EMIT_SIGNAL */
401 /** @return duration of this item */
403 TimeAxisViewItem::get_duration() const
405 return item_duration;
409 * Set the maximum duration that this item can have.
411 * @param dur the new maximum duration
412 * @param src the identity of the object that initiated the change
415 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
417 max_item_duration = dur;
418 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
421 /** @return the maximum duration that this item may have */
423 TimeAxisViewItem::get_max_duration() const
425 return max_item_duration;
429 * Set the minimum duration that this item may have.
431 * @param the minimum duration that this item may be set to
432 * @param src the identity of the object that initiated the change
435 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
437 min_item_duration = dur;
438 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
441 /** @return the minimum duration that this item mey have */
443 TimeAxisViewItem::get_min_duration() const
445 return min_item_duration;
449 * Set whether this item is locked to its current position.
450 * Locked items cannot be moved until the item is unlocked again.
452 * @param yn true to lock this item to its current position
453 * @param src the identity of the object that initiated the change
456 TimeAxisViewItem::set_position_locked(bool yn, void* src)
458 position_locked = yn;
459 set_trim_handle_colors();
460 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
463 /** @return true if this item is locked to its current position */
465 TimeAxisViewItem::get_position_locked() const
467 return position_locked;
471 * Set whether the maximum duration constraint is active.
473 * @param active set true to enforce the max duration constraint
474 * @param src the identity of the object that initiated the change
477 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
479 max_duration_active = active;
482 /** @return true if the maximum duration constraint is active */
484 TimeAxisViewItem::get_max_duration_active() const
486 return max_duration_active;
490 * Set whether the minimum duration constraint is active.
492 * @param active set true to enforce the min duration constraint
493 * @param src the identity of the object that initiated the change
497 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
499 min_duration_active = active;
502 /** @return true if the maximum duration constraint is active */
504 TimeAxisViewItem::get_min_duration_active() const
506 return min_duration_active;
510 * Set the name of this item.
512 * @param new_name the new name of this item
513 * @param src the identity of the object that initiated the change
517 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
519 if (new_name != item_name) {
520 std::string temp_name = item_name;
521 item_name = new_name;
522 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
526 /** @return the name of this item */
528 TimeAxisViewItem::get_item_name() const
534 * Set selection status.
536 * @param yn true if this item is currently selected
539 TimeAxisViewItem::set_selected(bool yn)
541 if (_selected != yn) {
542 Selectable::set_selected (yn);
544 set_name_text_color ();
548 /** @return the TimeAxisView that this item is on */
550 TimeAxisViewItem::get_time_axis_view () const
556 * Set the displayed item text.
557 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
559 * @param new_name the new name text to display
563 TimeAxisViewItem::set_name_text(const string& new_name)
569 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
570 name_text->set (new_name);
575 * Set the height of this item.
577 * @param h new height
580 TimeAxisViewItem::set_height (double height)
584 manage_name_highlight ();
586 if (visibility & ShowNameText) {
587 if (Config->get_show_name_highlight()) {
588 name_text->set_y_position (height - NAME_Y_OFFSET);
590 name_text->set_y_position (NAME_Y_OFFSET);
595 frame->set_y1 (height);
596 if (frame_handle_start) {
597 frame_handle_start->set_y1 (height);
598 frame_handle_end->set_y1 (height);
602 vestigial_frame->set_y1 (height - 1.0);
608 TimeAxisViewItem::manage_name_highlight ()
610 if (!name_highlight) {
614 if (_height < NAME_HIGHLIGHT_THRESH) {
615 high_enough_for_name = false;
617 high_enough_for_name = true;
621 wide_enough_for_name = false;
623 wide_enough_for_name = true;
626 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
628 name_highlight->show();
629 name_highlight->set (ArdourCanvas::Rect (0.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width+RIGHT_EDGE_SHIFT, (double) _height - 1.0));
632 name_highlight->hide();
639 TimeAxisViewItem::set_color (uint32_t base_color)
641 fill_color = base_color;
646 TimeAxisViewItem::get_canvas_frame()
652 TimeAxisViewItem::get_canvas_group()
658 TimeAxisViewItem::get_name_highlight()
660 return name_highlight;
664 * Convenience method to set the various canvas item colors
667 TimeAxisViewItem::set_colors()
671 if (name_highlight) {
672 name_highlight->set_fill_color (fill_color);
675 set_name_text_color ();
676 set_trim_handle_colors();
680 TimeAxisViewItem::set_name_text_color ()
689 if (Config->get_show_name_highlight()) {
690 /* name text will always be on top of name highlight, which
691 will always use our fill color.
695 /* name text will be on top of the item, whose color
696 may vary depending on various conditions.
698 f = get_fill_color ();
701 name_text->set_color (contrasting_text_color (f));
705 TimeAxisViewItem::fill_opacity () const
708 /* if the frame/rect is marked as invisible, then the
709 * fill should be transparent. simplest: set
711 * alpha/opacity to zero.
720 uint32_t col = ARDOUR_UI::config()->get_canvasvar_FrameBase();
721 return UINT_RGBA_A (col);
725 TimeAxisViewItem::get_fill_color () const
734 f = ARDOUR_UI::config()->get_canvasvar_SelectedFrameBase();
737 /* some condition of this item has set fill opacity to
738 * zero, but it has been selected, so use a mid-way
739 * alpha value to make it reasonably visible.
747 f = ARDOUR_UI::config()->get_canvasvar_RecordingRect();
749 if ((!Config->get_show_name_highlight() || high_enough_for_name) && !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
750 f = ARDOUR_UI::config()->get_canvasvar_FrameBase();
757 return UINT_RGBA_CHANGE_A (f, o);
761 * Sets the frame color depending on whether this item is selected
764 TimeAxisViewItem::set_frame_color()
770 frame->set_fill_color (get_fill_color());
771 set_frame_gradient ();
777 f = ARDOUR_UI::config()->get_canvasvar_SelectedTimeAxisFrame();
779 f = ARDOUR_UI::config()->get_canvasvar_TimeAxisFrame();
783 /* make the frame outline be visible but rather transparent */
784 f = UINT_RGBA_CHANGE_A (f, 64);
787 frame->set_outline_color (f);
792 TimeAxisViewItem::set_frame_gradient ()
794 if (ARDOUR_UI::config()->get_timeline_item_gradient_depth() == 0.0) {
795 frame->set_gradient (ArdourCanvas::Fill::StopList (), 0);
799 ArdourCanvas::Fill::StopList stops;
802 ArdourCanvas::Color f (get_fill_color());
804 /* need to get alpha value */
805 ArdourCanvas::color_to_rgba (f, r, g, b, a);
807 stops.push_back (std::make_pair (0.0, f));
809 /* now a darker version */
811 ArdourCanvas::color_to_hsv (f, h, s, v);
813 v = min (1.0, v * (1.0 - ARDOUR_UI::config()->get_timeline_item_gradient_depth()));
815 ArdourCanvas::Color darker = ArdourCanvas::hsv_to_color (h, s, v, a);
816 stops.push_back (std::make_pair (1.0, darker));
818 frame->set_gradient (stops, true);
822 * Set the colors of the start and end trim handle depending on object state
825 TimeAxisViewItem::set_trim_handle_colors()
828 /* Leave them transparent for now */
829 if (frame_handle_start) {
830 frame_handle_start->set_fill_color (0x00000000);
831 frame_handle_end->set_fill_color (0x00000000);
834 if (frame_handle_start) {
835 if (position_locked) {
836 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandleLocked());
837 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandleLocked());
839 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandle());
840 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandle());
847 TimeAxisViewItem::frame_handle_crossing (GdkEvent* ev, ArdourCanvas::Rectangle* item)
850 case GDK_LEAVE_NOTIFY:
851 /* always hide the handle whenever we leave, no matter what mode */
852 item->set_fill (false);
854 case GDK_ENTER_NOTIFY:
855 if (trackview.editor().effective_mouse_mode() == Editing::MouseObject &&
856 !trackview.editor().internal_editing()) {
857 /* never set this to be visible in internal
858 edit mode. Note, however, that we do need to
859 undo visibility (LEAVE_NOTIFY case above) no
860 matter what the mode is.
862 item->set_fill (true);
871 /** @return the frames per pixel */
873 TimeAxisViewItem::get_samples_per_pixel () const
875 return samples_per_pixel;
878 /** Set the frames per pixel of this item.
879 * This item is used to determine the relative visual size and position of this item
880 * based upon its duration and start value.
882 * @param fpp the new frames per pixel
885 TimeAxisViewItem::set_samples_per_pixel (double fpp)
887 samples_per_pixel = fpp;
888 set_position (this->get_position(), this);
889 reset_width_dependent_items ((double) get_duration() / samples_per_pixel);
893 TimeAxisViewItem::reset_width_dependent_items (double pixel_width)
895 _width = pixel_width;
897 manage_name_highlight ();
900 if (pixel_width < 2.0) {
902 if (show_vestigial) {
903 vestigial_frame->show();
910 if (frame_handle_start) {
911 frame_handle_start->hide();
912 frame_handle_end->hide();
916 vestigial_frame->hide();
920 frame->set_x1 (pixel_width + RIGHT_EDGE_SHIFT);
923 if (frame_handle_start) {
924 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
926 * there's less than GRAB_HANDLE_WIDTH of the region between
927 * the right-hand end of frame_handle_start and the left-hand
928 * end of frame_handle_end, so disable the handles
931 frame_handle_start->hide();
932 frame_handle_end->hide();
934 frame_handle_start->show();
935 frame_handle_end->set_x0 (pixel_width + RIGHT_EDGE_SHIFT - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
936 frame_handle_end->set_x1 (pixel_width + RIGHT_EDGE_SHIFT);
937 frame_handle_end->show();
944 TimeAxisViewItem::manage_name_text ()
946 int visible_name_width;
952 if (!wide_enough_for_name || !high_enough_for_name) {
957 if (name_text->text().empty()) {
961 visible_name_width = name_text_width;
963 if (visible_name_width > _width - NAME_X_OFFSET) {
964 visible_name_width = _width - NAME_X_OFFSET;
967 if (visible_name_width < 1) {
970 name_text->clamp_width (visible_name_width);
976 * Callback used to remove this time axis item during the gtk idle loop.
977 * This is used to avoid deleting the obejct while inside the remove_this_item
980 * @param item the TimeAxisViewItem to remove.
981 * @param src the identity of the object that initiated the change.
984 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
986 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
993 TimeAxisViewItem::set_y (double y)
995 group->set_y_position (y);
999 TimeAxisViewItem::parameter_changed (string p)
1001 if (p == "color-regions-using-track-color") {
1003 } else if (p == "timeline-item-gradient-depth") {
1004 set_frame_gradient ();
1009 TimeAxisViewItem::drag_start ()
1016 TimeAxisViewItem::drag_end ()