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/group.h"
32 #include "canvas/rectangle.h"
33 #include "canvas/debug.h"
34 #include "canvas/drag_handle.h"
35 #include "canvas/text.h"
36 #include "canvas/utils.h"
38 #include "ardour/profile.h"
40 #include "ardour_ui.h"
42 * ardour_ui.h was moved up in the include list
43 * due to a conflicting definition of 'Rect' between
44 * Apple's MacTypes.h file and GTK
47 #include "public_editor.h"
48 #include "time_axis_view_item.h"
49 #include "time_axis_view.h"
51 #include "rgb_macros.h"
56 using namespace Editing;
59 using namespace ARDOUR;
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 = get_font_for_style (X_("TimeAxisViewItemName"));
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::Group& 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::Group* 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::Group* 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::Group (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 pre_drag_fill_color = base_color;
172 samples_per_pixel = fpp;
173 frame_position = start;
174 item_duration = duration;
175 name_connected = false;
177 position_locked = false;
178 max_item_duration = ARDOUR::max_framepos;
179 min_item_duration = 0;
180 show_vestigial = true;
185 wide_enough_for_name = wide;
186 high_enough_for_name = high;
190 warning << "Time Axis Item Duration == 0" << endl;
193 vestigial_frame = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, 1.0, 2.0, trackview.current_height()));
194 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
195 vestigial_frame->hide ();
196 vestigial_frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_VestigialFrame());
197 vestigial_frame->set_fill_color (ARDOUR_UI::config()->get_canvasvar_VestigialFrame());
199 if (visibility & ShowFrame) {
200 frame = new ArdourCanvas::Rectangle (group,
201 ArdourCanvas::Rect (0.0, 0.0,
202 trackview.editor().sample_to_pixel(duration) + RIGHT_EDGE_SHIFT,
203 trackview.current_height() - 1.0));
205 CANVAS_DEBUG_NAME (frame, string_compose ("frame for %1", get_item_name()));
207 if (Config->get_show_name_highlight()) {
208 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
210 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT|ArdourCanvas::Rectangle::BOTTOM));
214 frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_RecordingRect());
216 frame->set_outline_color (ARDOUR_UI::config()->get_canvasvar_TimeAxisFrame());
224 if (Config->get_show_name_highlight() && (visibility & ShowNameHighlight)) {
229 if (visibility & FullWidthNameHighlight) {
231 width = trackview.editor().sample_to_pixel(item_duration) + RIGHT_EDGE_SHIFT;
234 width = trackview.editor().sample_to_pixel(item_duration) - 2.0 + RIGHT_EDGE_SHIFT;
237 name_highlight = new ArdourCanvas::Rectangle (group,
238 ArdourCanvas::Rect (start,
239 trackview.current_height() - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE,
240 width - 2.0 + RIGHT_EDGE_SHIFT,
241 trackview.current_height() - 1.0));
242 CANVAS_DEBUG_NAME (name_highlight, string_compose ("name highlight for %1", get_item_name()));
243 name_highlight->set_data ("timeaxisviewitem", this);
244 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
245 name_highlight->set_outline_color (RGBA_TO_UINT (0,0,0,255));
251 if (visibility & ShowNameText) {
252 name_text = new ArdourCanvas::Text (group);
253 CANVAS_DEBUG_NAME (name_text, string_compose ("name text for %1", get_item_name()));
254 if (Config->get_show_name_highlight()) {
255 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, trackview.current_height() - NAME_Y_OFFSET));
257 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, NAME_Y_OFFSET));
259 name_text->set_font_description (NAME_FONT);
264 /* create our grab handles used for trimming/duration etc */
265 if (!_recregion && !_automation) {
266 double top = TimeAxisViewItem::GRAB_HANDLE_TOP;
267 double width = TimeAxisViewItem::GRAB_HANDLE_WIDTH;
269 frame_handle_start = new ArdourCanvas::DragHandle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()), true);
270 CANVAS_DEBUG_NAME (frame_handle_start, "TAVI frame handle start");
271 frame_handle_start->set_outline (false);
272 frame_handle_start->set_fill (false);
273 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_start));
275 frame_handle_end = new ArdourCanvas::DragHandle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()), false);
276 CANVAS_DEBUG_NAME (frame_handle_end, "TAVI frame handle end");
277 frame_handle_end->set_outline (false);
278 frame_handle_end->set_fill (false);
279 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_end));
281 frame_handle_start = frame_handle_end = 0;
284 set_color (base_color);
286 set_duration (item_duration, this);
287 set_position (start, this);
289 Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&TimeAxisViewItem::parameter_changed, this, _1), gui_context ());
290 ARDOUR_UI::config()->ParameterChanged.connect (sigc::mem_fun (*this, &TimeAxisViewItem::parameter_changed));
293 TimeAxisViewItem::~TimeAxisViewItem()
299 TimeAxisViewItem::canvas_group_event (GdkEvent* /*ev*/)
305 TimeAxisViewItem::hide_rect ()
307 rect_visible = false;
310 if (name_highlight) {
311 name_highlight->set_outline_what (ArdourCanvas::Rectangle::What (0));
312 name_highlight->set_fill_color (UINT_RGBA_CHANGE_A (fill_color, 64));
317 TimeAxisViewItem::show_rect ()
322 if (name_highlight) {
323 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
324 name_highlight->set_fill_color (fill_color);
329 * Set the position of this item on the timeline.
331 * @param pos the new position
332 * @param src the identity of the object that initiated the change
333 * @return true on success
337 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
339 if (position_locked) {
343 frame_position = pos;
345 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
348 (*delta) = new_unit_pos - group->position().x;
353 if (new_unit_pos == group->position().x) {
358 group->set_x_position (new_unit_pos);
360 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
365 /** @return position of this item on the timeline */
367 TimeAxisViewItem::get_position() const
369 return frame_position;
373 * Set the duration of this item.
375 * @param dur the new duration of this item
376 * @param src the identity of the object that initiated the change
377 * @return true on success
381 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
383 if ((dur > max_item_duration) || (dur < min_item_duration)) {
384 warning << string_compose (
385 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
386 get_item_name(), dur)
397 reset_width_dependent_items (trackview.editor().sample_to_pixel (dur));
399 DurationChanged (dur, src); /* EMIT_SIGNAL */
403 /** @return duration of this item */
405 TimeAxisViewItem::get_duration() const
407 return item_duration;
411 * Set the maximum duration that this item can have.
413 * @param dur the new maximum duration
414 * @param src the identity of the object that initiated the change
417 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
419 max_item_duration = dur;
420 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
423 /** @return the maximum duration that this item may have */
425 TimeAxisViewItem::get_max_duration() const
427 return max_item_duration;
431 * Set the minimum duration that this item may have.
433 * @param the minimum duration that this item may be set to
434 * @param src the identity of the object that initiated the change
437 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
439 min_item_duration = dur;
440 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
443 /** @return the minimum duration that this item mey have */
445 TimeAxisViewItem::get_min_duration() const
447 return min_item_duration;
451 * Set whether this item is locked to its current position.
452 * Locked items cannot be moved until the item is unlocked again.
454 * @param yn true to lock this item to its current position
455 * @param src the identity of the object that initiated the change
458 TimeAxisViewItem::set_position_locked(bool yn, void* src)
460 position_locked = yn;
461 set_trim_handle_colors();
462 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
465 /** @return true if this item is locked to its current position */
467 TimeAxisViewItem::get_position_locked() const
469 return position_locked;
473 * Set whether the maximum duration constraint is active.
475 * @param active set true to enforce the max duration constraint
476 * @param src the identity of the object that initiated the change
479 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
481 max_duration_active = active;
484 /** @return true if the maximum duration constraint is active */
486 TimeAxisViewItem::get_max_duration_active() const
488 return max_duration_active;
492 * Set whether the minimum duration constraint is active.
494 * @param active set true to enforce the min duration constraint
495 * @param src the identity of the object that initiated the change
499 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
501 min_duration_active = active;
504 /** @return true if the maximum duration constraint is active */
506 TimeAxisViewItem::get_min_duration_active() const
508 return min_duration_active;
512 * Set the name of this item.
514 * @param new_name the new name of this item
515 * @param src the identity of the object that initiated the change
519 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
521 if (new_name != item_name) {
522 std::string temp_name = item_name;
523 item_name = new_name;
524 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
528 /** @return the name of this item */
530 TimeAxisViewItem::get_item_name() const
536 * Set selection status.
538 * @param yn true if this item is currently selected
541 TimeAxisViewItem::set_selected(bool yn)
543 if (_selected != yn) {
544 Selectable::set_selected (yn);
549 /** @return the TimeAxisView that this item is on */
551 TimeAxisViewItem::get_time_axis_view () const
557 * Set the displayed item text.
558 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
560 * @param new_name the new name text to display
564 TimeAxisViewItem::set_name_text(const string& new_name)
570 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
571 name_text->set (new_name);
576 * Set the height of this item.
578 * @param h new height
581 TimeAxisViewItem::set_height (double height)
585 manage_name_highlight ();
587 if (visibility & ShowNameText) {
588 if (Config->get_show_name_highlight()) {
589 name_text->set_y_position (height - NAME_Y_OFFSET);
591 name_text->set_y_position (NAME_Y_OFFSET);
596 frame->set_y1 (height);
597 if (frame_handle_start) {
598 frame_handle_start->set_y1 (height);
599 frame_handle_end->set_y1 (height);
603 vestigial_frame->set_y1 (height - 1.0);
609 TimeAxisViewItem::manage_name_highlight ()
611 if (!name_highlight) {
615 if (_height < NAME_HIGHLIGHT_THRESH) {
616 high_enough_for_name = false;
618 high_enough_for_name = true;
622 wide_enough_for_name = false;
624 wide_enough_for_name = true;
627 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
629 name_highlight->show();
630 name_highlight->set (ArdourCanvas::Rect (0.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width+RIGHT_EDGE_SHIFT, (double) _height - 1.0));
633 name_highlight->hide();
640 TimeAxisViewItem::set_color (uint32_t base_color)
642 fill_color = base_color;
643 fill_opacity = UINT_RGBA_A (fill_color);
648 TimeAxisViewItem::get_canvas_frame()
654 TimeAxisViewItem::get_canvas_group()
660 TimeAxisViewItem::get_name_highlight()
662 return name_highlight;
666 * Convenience method to set the various canvas item colors
669 TimeAxisViewItem::set_colors()
673 if (name_highlight) {
674 name_highlight->set_fill_color (fill_color);
677 set_name_text_color ();
678 set_trim_handle_colors();
682 TimeAxisViewItem::set_name_text_color ()
691 if (Config->get_show_name_highlight()) {
692 /* name text will always be on top of name highlight, which
693 will always use our fill color.
697 /* name text will be on top of the item, whose color
698 may vary depending on various conditions.
700 f = get_fill_color ();
703 name_text->set_color (contrasting_text_color (f));
707 TimeAxisViewItem::get_fill_color () const
714 f = ARDOUR_UI::config()->get_canvasvar_SelectedFrameBase();
716 if (fill_opacity != 0) {
719 /* some condition of this item has set fill opacity to
720 * zero, but it has been selected, so use a mid-way
721 * alpha value to make it reasonably visible.
729 f = ARDOUR_UI::config()->get_canvasvar_RecordingRect();
731 if ((!Config->get_show_name_highlight() || high_enough_for_name) && !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
732 f = ARDOUR_UI::config()->get_canvasvar_FrameBase();
733 /* use the opacity as set for the FrameBase color */
744 /* if the frame/rect is marked as invisible, then the
745 * fill should be transparent. simplest: set
746 * alpha/opacity to zero.
752 return UINT_RGBA_CHANGE_A (f, o);
756 * Sets the frame color depending on whether this item is selected
759 TimeAxisViewItem::set_frame_color()
765 frame->set_fill_color (get_fill_color());
766 set_frame_gradient ();
772 f = ARDOUR_UI::config()->get_canvasvar_SelectedTimeAxisFrame();
774 f = ARDOUR_UI::config()->get_canvasvar_TimeAxisFrame();
778 /* make the frame outline be visible but rather transparent */
779 f = UINT_RGBA_CHANGE_A (f, 64);
782 frame->set_outline_color (f);
787 TimeAxisViewItem::set_opacity_for_drag (bool drag_starting)
792 fill_opacity = UINT_RGBA_A (fill_color);
798 TimeAxisViewItem::set_frame_gradient ()
800 if (ARDOUR_UI::config()->get_timeline_item_gradient_depth() == 0.0) {
801 frame->set_gradient (ArdourCanvas::Fill::StopList (), 0);
805 ArdourCanvas::Fill::StopList stops;
808 ArdourCanvas::Color f (get_fill_color());
810 /* need to get alpha value */
811 ArdourCanvas::color_to_rgba (f, r, g, b, a);
813 stops.push_back (std::make_pair (0.0, f));
815 /* now a darker version */
817 ArdourCanvas::color_to_hsv (f, h, s, v);
819 v = min (1.0, v * (1.0 - ARDOUR_UI::config()->get_timeline_item_gradient_depth()));
821 ArdourCanvas::Color darker = ArdourCanvas::hsv_to_color (h, s, v, a);
822 stops.push_back (std::make_pair (1.0, darker));
824 frame->set_gradient (stops, true);
828 * Set the colors of the start and end trim handle depending on object state
831 TimeAxisViewItem::set_trim_handle_colors()
834 /* Leave them transparent for now */
835 if (frame_handle_start) {
836 frame_handle_start->set_fill_color (0x00000000);
837 frame_handle_end->set_fill_color (0x00000000);
840 if (frame_handle_start) {
841 if (position_locked) {
842 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandleLocked());
843 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandleLocked());
845 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandle());
846 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_canvasvar_TrimHandle());
853 TimeAxisViewItem::frame_handle_crossing (GdkEvent* ev, ArdourCanvas::Rectangle* item)
856 case GDK_LEAVE_NOTIFY:
857 /* always hide the handle whenever we leave, no matter what mode */
858 item->set_fill (false);
860 case GDK_ENTER_NOTIFY:
861 if (trackview.editor().effective_mouse_mode() == Editing::MouseObject &&
862 !trackview.editor().internal_editing()) {
863 /* never set this to be visible in internal
864 edit mode. Note, however, that we do need to
865 undo visibility (LEAVE_NOTIFY case above) no
866 matter what the mode is.
868 item->set_fill (true);
877 /** @return the frames per pixel */
879 TimeAxisViewItem::get_samples_per_pixel () const
881 return samples_per_pixel;
884 /** Set the frames per pixel of this item.
885 * This item is used to determine the relative visual size and position of this item
886 * based upon its duration and start value.
888 * @param fpp the new frames per pixel
891 TimeAxisViewItem::set_samples_per_pixel (double fpp)
893 samples_per_pixel = fpp;
894 set_position (this->get_position(), this);
895 reset_width_dependent_items ((double) get_duration() / samples_per_pixel);
899 TimeAxisViewItem::reset_width_dependent_items (double pixel_width)
901 _width = pixel_width;
903 manage_name_highlight ();
906 if (pixel_width < 2.0) {
908 if (show_vestigial) {
909 vestigial_frame->show();
916 if (frame_handle_start) {
917 frame_handle_start->hide();
918 frame_handle_end->hide();
922 vestigial_frame->hide();
926 frame->set_x1 (pixel_width + RIGHT_EDGE_SHIFT);
929 if (frame_handle_start) {
930 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
932 * there's less than GRAB_HANDLE_WIDTH of the region between
933 * the right-hand end of frame_handle_start and the left-hand
934 * end of frame_handle_end, so disable the handles
937 frame_handle_start->hide();
938 frame_handle_end->hide();
940 frame_handle_start->show();
941 frame_handle_end->set_x0 (pixel_width + RIGHT_EDGE_SHIFT - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
942 frame_handle_end->set_x1 (pixel_width + RIGHT_EDGE_SHIFT);
943 frame_handle_end->show();
950 TimeAxisViewItem::manage_name_text ()
952 int visible_name_width;
958 if (!wide_enough_for_name || !high_enough_for_name) {
963 if (name_text->text().empty()) {
967 visible_name_width = name_text_width;
969 if (visible_name_width > _width - NAME_X_OFFSET) {
970 visible_name_width = _width - NAME_X_OFFSET;
973 if (visible_name_width < 1) {
976 name_text->clamp_width (visible_name_width);
982 * Callback used to remove this time axis item during the gtk idle loop.
983 * This is used to avoid deleting the obejct while inside the remove_this_item
986 * @param item the TimeAxisViewItem to remove.
987 * @param src the identity of the object that initiated the change.
990 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
992 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
999 TimeAxisViewItem::set_y (double y)
1001 group->set_y_position (y);
1005 TimeAxisViewItem::parameter_changed (string p)
1007 if (p == "color-regions-using-track-color") {
1009 } else if (p == "timeline-item-gradient-depth") {
1010 set_frame_gradient ();