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/colors.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;
67 int TimeAxisViewItem::NAME_HEIGHT;
68 double TimeAxisViewItem::NAME_Y_OFFSET;
69 double TimeAxisViewItem::NAME_HIGHLIGHT_SIZE;
70 double TimeAxisViewItem::NAME_HIGHLIGHT_THRESH;
73 TimeAxisViewItem::set_constant_heights ()
75 NAME_FONT = Pango::FontDescription (ARDOUR_UI::config()->get_SmallFont());
81 Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout (X_("Hg")); /* ascender + descender */
85 layout->set_font_description (NAME_FONT);
86 get_pixel_size (layout, width, height);
88 layout = foo.create_pango_layout (X_("H")); /* just the ascender */
92 /* Config->get_show_name_highlight) == true:
93 Y_OFFSET is measured from bottom of the time axis view item.
94 Config->get_show_name_highlight) == false:
95 Y_OFFSET is measured from the top of the time axis view item.
98 if (Config->get_show_name_highlight()) {
99 NAME_Y_OFFSET = height + 1;
100 NAME_HIGHLIGHT_SIZE = height + 2;
103 NAME_HIGHLIGHT_SIZE = 0;
105 NAME_HIGHLIGHT_THRESH = NAME_HIGHLIGHT_SIZE * 3;
109 * Construct a new TimeAxisViewItem.
111 * @param it_name the unique name of this item
112 * @param parent the parent canvas group
113 * @param tv the TimeAxisView we are going to be added to
114 * @param spu samples per unit
116 * @param start the start point of this item
117 * @param duration the duration of this item
118 * @param recording true if this is a recording region view
119 * @param automation true if this is an automation region view
121 TimeAxisViewItem::TimeAxisViewItem(
122 const string & it_name, ArdourCanvas::Item& parent, TimeAxisView& tv, double spu, uint32_t base_color,
123 framepos_t start, framecnt_t duration, bool recording, bool automation, Visibility vis
126 , frame_position (-1)
127 , item_name (it_name)
128 , selection_frame (0)
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)
145 , selection_frame (0)
147 , _recregion (other._recregion)
148 , _automation (other._automation)
149 , _dragging (other._dragging)
152 /* share the other's parent, but still create a new group */
154 ArdourCanvas::Item* parent = other.group->parent();
156 _selected = other._selected;
158 init (parent, other.samples_per_pixel, other.fill_color, other.frame_position,
159 other.item_duration, other.visibility, other.wide_enough_for_name, other.high_enough_for_name);
163 TimeAxisViewItem::init (ArdourCanvas::Item* parent, double fpp, uint32_t base_color,
164 framepos_t start, framepos_t duration, Visibility vis,
165 bool wide, bool high)
167 group = new ArdourCanvas::Container (parent);
168 CANVAS_DEBUG_NAME (group, string_compose ("TAVI group for %1", get_item_name()));
169 group->Event.connect (sigc::mem_fun (*this, &TimeAxisViewItem::canvas_group_event));
171 fill_color = base_color;
172 samples_per_pixel = fpp;
173 frame_position = start;
174 item_duration = duration;
175 name_connected = false;
176 position_locked = false;
177 max_item_duration = ARDOUR::max_framepos;
178 min_item_duration = 0;
179 show_vestigial = true;
184 wide_enough_for_name = wide;
185 high_enough_for_name = high;
190 warning << "Time Axis Item Duration == 0" << endl;
193 if (visibility & ShowFrame) {
194 frame = new ArdourCanvas::TimeRectangle (group,
195 ArdourCanvas::Rect (0.0, 0.0,
196 trackview.editor().sample_to_pixel(duration),
197 trackview.current_height()));
199 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
201 CANVAS_DEBUG_NAME (frame, string_compose ("frame for %1", get_item_name()));
204 frame->set_outline_color (ARDOUR_UI::config()->get_RecordingRect());
206 frame->set_outline_color (ARDOUR_UI::config()->get_TimeAxisFrame());
210 if (Config->get_show_name_highlight() && (visibility & ShowNameHighlight)) {
215 if (visibility & FullWidthNameHighlight) {
216 width = trackview.editor().sample_to_pixel(item_duration);
218 width = trackview.editor().sample_to_pixel(item_duration) - 2.0;
221 name_highlight = new ArdourCanvas::Rectangle (group,
222 ArdourCanvas::Rect (start,
223 trackview.current_height() - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE,
225 trackview.current_height() - 1.0));
226 CANVAS_DEBUG_NAME (name_highlight, string_compose ("name highlight for %1", get_item_name()));
227 name_highlight->set_data ("timeaxisviewitem", this);
228 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
229 name_highlight->set_outline_color (RGBA_TO_UINT (0,0,0,255));
235 if (visibility & ShowNameText) {
236 name_text = new ArdourCanvas::Text (group);
237 CANVAS_DEBUG_NAME (name_text, string_compose ("name text for %1", get_item_name()));
238 if (Config->get_show_name_highlight()) {
239 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, trackview.current_height() - NAME_Y_OFFSET));
241 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, NAME_Y_OFFSET));
243 name_text->set_font_description (NAME_FONT);
244 name_text->set_ignore_events (true);
249 /* create our grab handles used for trimming/duration etc */
250 if (!_recregion && !_automation) {
251 double top = TimeAxisViewItem::GRAB_HANDLE_TOP;
252 double width = TimeAxisViewItem::GRAB_HANDLE_WIDTH;
254 frame_handle_start = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
255 CANVAS_DEBUG_NAME (frame_handle_start, "TAVI frame handle start");
256 frame_handle_start->set_outline (false);
257 frame_handle_start->set_fill (false);
258 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_start));
260 frame_handle_end = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
261 CANVAS_DEBUG_NAME (frame_handle_end, "TAVI frame handle end");
262 frame_handle_end->set_outline (false);
263 frame_handle_end->set_fill (false);
264 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_end));
266 frame_handle_start = frame_handle_end = 0;
269 set_color (base_color);
271 set_duration (item_duration, this);
272 set_position (start, this);
274 Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&TimeAxisViewItem::parameter_changed, this, _1), gui_context ());
275 ARDOUR_UI::config()->ParameterChanged.connect (sigc::mem_fun (*this, &TimeAxisViewItem::parameter_changed));
278 TimeAxisViewItem::~TimeAxisViewItem()
284 TimeAxisViewItem::canvas_group_event (GdkEvent* /*ev*/)
290 TimeAxisViewItem::hide_rect ()
292 rect_visible = false;
295 if (name_highlight) {
296 name_highlight->set_outline_what (ArdourCanvas::Rectangle::What (0));
297 name_highlight->set_fill_color (UINT_RGBA_CHANGE_A (fill_color, 64));
302 TimeAxisViewItem::show_rect ()
307 if (name_highlight) {
308 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
309 name_highlight->set_fill_color (fill_color);
314 * Set the position of this item on the timeline.
316 * @param pos the new position
317 * @param src the identity of the object that initiated the change
318 * @return true on success
322 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
324 if (position_locked) {
328 frame_position = pos;
330 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
333 (*delta) = new_unit_pos - group->position().x;
338 if (new_unit_pos == group->position().x) {
343 group->set_x_position (new_unit_pos);
345 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
350 /** @return position of this item on the timeline */
352 TimeAxisViewItem::get_position() const
354 return frame_position;
358 * Set the duration of this item.
360 * @param dur the new duration of this item
361 * @param src the identity of the object that initiated the change
362 * @return true on success
366 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
368 if ((dur > max_item_duration) || (dur < min_item_duration)) {
369 warning << string_compose (
370 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
371 get_item_name(), dur)
382 reset_width_dependent_items (trackview.editor().sample_to_pixel (dur));
384 DurationChanged (dur, src); /* EMIT_SIGNAL */
388 /** @return duration of this item */
390 TimeAxisViewItem::get_duration() const
392 return item_duration;
396 * Set the maximum duration that this item can have.
398 * @param dur the new maximum duration
399 * @param src the identity of the object that initiated the change
402 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
404 max_item_duration = dur;
405 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
408 /** @return the maximum duration that this item may have */
410 TimeAxisViewItem::get_max_duration() const
412 return max_item_duration;
416 * Set the minimum duration that this item may have.
418 * @param the minimum duration that this item may be set to
419 * @param src the identity of the object that initiated the change
422 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
424 min_item_duration = dur;
425 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
428 /** @return the minimum duration that this item mey have */
430 TimeAxisViewItem::get_min_duration() const
432 return min_item_duration;
436 * Set whether this item is locked to its current position.
437 * Locked items cannot be moved until the item is unlocked again.
439 * @param yn true to lock this item to its current position
440 * @param src the identity of the object that initiated the change
443 TimeAxisViewItem::set_position_locked(bool yn, void* src)
445 position_locked = yn;
446 set_trim_handle_colors();
447 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
450 /** @return true if this item is locked to its current position */
452 TimeAxisViewItem::get_position_locked() const
454 return position_locked;
458 * Set whether the maximum duration constraint is active.
460 * @param active set true to enforce the max duration constraint
461 * @param src the identity of the object that initiated the change
464 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
466 max_duration_active = active;
469 /** @return true if the maximum duration constraint is active */
471 TimeAxisViewItem::get_max_duration_active() const
473 return max_duration_active;
477 * Set whether the minimum duration constraint is active.
479 * @param active set true to enforce the min duration constraint
480 * @param src the identity of the object that initiated the change
484 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
486 min_duration_active = active;
489 /** @return true if the maximum duration constraint is active */
491 TimeAxisViewItem::get_min_duration_active() const
493 return min_duration_active;
497 * Set the name of this item.
499 * @param new_name the new name of this item
500 * @param src the identity of the object that initiated the change
504 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
506 if (new_name != item_name) {
507 std::string temp_name = item_name;
508 item_name = new_name;
509 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
513 /** @return the name of this item */
515 TimeAxisViewItem::get_item_name() const
521 * Set selection status.
523 * @param yn true if this item is currently selected
526 TimeAxisViewItem::set_selected(bool yn)
528 if (_selected == yn) {
532 Selectable::set_selected (yn);
534 set_name_text_color ();
536 if (_selected && frame) {
537 if (!selection_frame) {
538 selection_frame = new ArdourCanvas::TimeRectangle (group);
539 selection_frame->set_fill (false);
540 selection_frame->set_outline_color (ARDOUR_UI::config()->get_SelectedTimeAxisFrame());
541 selection_frame->set_ignore_events (true);
543 selection_frame->set (frame->get().shrink (1.0));
544 selection_frame->show ();
546 if (selection_frame) {
547 selection_frame->hide ();
552 /** @return the TimeAxisView that this item is on */
554 TimeAxisViewItem::get_time_axis_view () const
560 * Set the displayed item text.
561 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
563 * @param new_name the new name text to display
567 TimeAxisViewItem::set_name_text(const string& new_name)
573 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
574 name_text->set (new_name);
579 * Set the height of this item.
581 * @param h new height
584 TimeAxisViewItem::set_height (double height)
588 manage_name_highlight ();
590 if (visibility & ShowNameText) {
591 if (Config->get_show_name_highlight()) {
592 name_text->set_y_position (height - NAME_Y_OFFSET);
594 name_text->set_y_position (NAME_Y_OFFSET);
601 frame->set_y1 (height);
603 if (frame_handle_start) {
604 frame_handle_start->set_y1 (height);
605 frame_handle_end->set_y1 (height);
608 if (selection_frame) {
609 selection_frame->set (frame->get().shrink (1.0));
613 if (vestigial_frame) {
614 vestigial_frame->set_y0 (1.0);
615 vestigial_frame->set_y1 (height);
622 TimeAxisViewItem::manage_name_highlight ()
624 if (!name_highlight) {
628 if (_height < NAME_HIGHLIGHT_THRESH) {
629 high_enough_for_name = false;
631 high_enough_for_name = true;
635 wide_enough_for_name = false;
637 wide_enough_for_name = true;
640 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
642 name_highlight->show();
643 name_highlight->set (ArdourCanvas::Rect (1.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width, (double) _height - 1.0));
646 name_highlight->hide();
653 TimeAxisViewItem::set_color (uint32_t base_color)
655 fill_color = base_color;
660 TimeAxisViewItem::get_canvas_frame()
666 TimeAxisViewItem::get_canvas_group()
672 TimeAxisViewItem::get_name_highlight()
674 return name_highlight;
678 * Convenience method to set the various canvas item colors
681 TimeAxisViewItem::set_colors()
685 if (name_highlight) {
686 name_highlight->set_fill_color (fill_color);
689 set_name_text_color ();
690 set_trim_handle_colors();
694 TimeAxisViewItem::set_name_text_color ()
703 if (Config->get_show_name_highlight()) {
704 /* name text will always be on top of name highlight, which
705 will always use our fill color.
709 /* name text will be on top of the item, whose color
710 may vary depending on various conditions.
712 f = get_fill_color ();
715 name_text->set_color (ArdourCanvas::contrasting_text_color (f));
719 TimeAxisViewItem::fill_opacity () const
722 /* if the frame/rect is marked as "invisible", then the
723 fill should be translucent.parent.
732 uint32_t col = ARDOUR_UI::config()->get_FrameBase();
733 return UINT_RGBA_A (col);
737 TimeAxisViewItem::get_fill_color () const
746 f = ARDOUR_UI::config()->get_SelectedFrameBase();
749 /* some condition of this item has set fill opacity to
750 * zero, but it has been selected, so use a mid-way
751 * alpha value to make it reasonably visible.
759 f = ARDOUR_UI::config()->get_RecordingRect();
761 if ((!Config->get_show_name_highlight() || high_enough_for_name) && !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
762 f = ARDOUR_UI::config()->get_FrameBase();
769 return UINT_RGBA_CHANGE_A (f, o);
773 * Sets the frame color depending on whether this item is selected
776 TimeAxisViewItem::set_frame_color()
782 frame->set_fill_color (get_fill_color());
783 set_frame_gradient ();
786 uint32_t f = ARDOUR_UI::config()->get_TimeAxisFrame();
789 /* make the frame outline be visible but rather transparent */
790 f = UINT_RGBA_CHANGE_A (f, 64);
793 frame->set_outline_color (f);
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_TrimHandleLocked());
843 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_TrimHandleLocked());
845 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_TrimHandle());
846 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_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) {
910 if (!vestigial_frame) {
911 vestigial_frame = new ArdourCanvas::TimeRectangle (group, ArdourCanvas::Rect (0.0, 0.0, 2.0, trackview.current_height()));
912 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
913 vestigial_frame->set_outline_color (ARDOUR_UI::config()->get_VestigialFrame());
914 vestigial_frame->set_fill_color (ARDOUR_UI::config()->get_VestigialFrame());
915 vestigial_frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
918 vestigial_frame->show();
925 if (frame_handle_start) {
926 frame_handle_start->hide();
927 frame_handle_end->hide();
931 if (vestigial_frame) {
932 vestigial_frame->hide();
937 frame->set_x1 (pixel_width);
939 if (selection_frame) {
940 selection_frame->set (frame->get().shrink (1.0));
944 if (frame_handle_start) {
945 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
947 * there's less than GRAB_HANDLE_WIDTH of the region between
948 * the right-hand end of frame_handle_start and the left-hand
949 * end of frame_handle_end, so disable the handles
952 frame_handle_start->hide();
953 frame_handle_end->hide();
955 frame_handle_start->show();
956 frame_handle_end->set_x0 (pixel_width - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
957 frame_handle_end->set_x1 (pixel_width);
958 frame_handle_end->show();
965 TimeAxisViewItem::manage_name_text ()
967 int visible_name_width;
973 if (!wide_enough_for_name || !high_enough_for_name) {
978 if (name_text->text().empty()) {
982 visible_name_width = name_text_width;
984 if (visible_name_width > _width - NAME_X_OFFSET) {
985 visible_name_width = _width - NAME_X_OFFSET;
988 if (visible_name_width < 1) {
991 name_text->clamp_width (visible_name_width);
997 * Callback used to remove this time axis item during the gtk idle loop.
998 * This is used to avoid deleting the obejct while inside the remove_this_item
1001 * @param item the TimeAxisViewItem to remove.
1002 * @param src the identity of the object that initiated the change.
1005 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
1007 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
1014 TimeAxisViewItem::set_y (double y)
1016 group->set_y_position (y);
1020 TimeAxisViewItem::parameter_changed (string p)
1022 if (p == "color-regions-using-track-color") {
1024 } else if (p == "timeline-item-gradient-depth") {
1025 set_frame_gradient ();
1030 TimeAxisViewItem::drag_start ()
1037 TimeAxisViewItem::drag_end ()