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 (ARDOUR_UI::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 fill_color_name = "time axis view item base";
173 samples_per_pixel = fpp;
174 frame_position = start;
175 item_duration = duration;
176 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 if (visibility & ShowFrame) {
194 frame = new ArdourCanvas::Rectangle (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()->color ("recording rect"));
206 frame->set_outline_color (ARDOUR_UI::config()->color ("time axis frame"));
210 if (ARDOUR_UI::config()->get_show_name_highlight() && (visibility & ShowNameHighlight)) {
212 /* rectangle size will be set in ::manage_name_highlight() */
213 name_highlight = new ArdourCanvas::Rectangle (group);
214 CANVAS_DEBUG_NAME (name_highlight, string_compose ("name highlight for %1", get_item_name()));
215 name_highlight->set_data ("timeaxisviewitem", this);
216 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
217 name_highlight->set_outline_color (RGBA_TO_UINT (0,0,0,255)); // this should use a theme color
223 if (visibility & ShowNameText) {
224 name_text = new ArdourCanvas::Text (group);
225 CANVAS_DEBUG_NAME (name_text, string_compose ("name text for %1", get_item_name()));
226 if (ARDOUR_UI::config()->get_show_name_highlight()) {
227 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, trackview.current_height() - NAME_Y_OFFSET));
229 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, NAME_Y_OFFSET));
231 name_text->set_font_description (NAME_FONT);
232 name_text->set_ignore_events (true);
237 /* create our grab handles used for trimming/duration etc */
238 if (!_recregion && !_automation) {
239 double top = TimeAxisViewItem::GRAB_HANDLE_TOP;
240 double width = TimeAxisViewItem::GRAB_HANDLE_WIDTH;
242 frame_handle_start = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
243 CANVAS_DEBUG_NAME (frame_handle_start, "TAVI frame handle start");
244 frame_handle_start->set_outline (false);
245 frame_handle_start->set_fill (false);
246 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_start));
248 frame_handle_end = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
249 CANVAS_DEBUG_NAME (frame_handle_end, "TAVI frame handle end");
250 frame_handle_end->set_outline (false);
251 frame_handle_end->set_fill (false);
252 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_end));
254 frame_handle_start = frame_handle_end = 0;
257 set_color (base_color);
259 set_duration (item_duration, this);
260 set_position (start, this);
262 Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&TimeAxisViewItem::parameter_changed, this, _1), gui_context ());
263 ARDOUR_UI::config()->ParameterChanged.connect (sigc::mem_fun (*this, &TimeAxisViewItem::parameter_changed));
266 TimeAxisViewItem::~TimeAxisViewItem()
272 TimeAxisViewItem::canvas_group_event (GdkEvent* /*ev*/)
278 * Set the position of this item on the timeline.
280 * @param pos the new position
281 * @param src the identity of the object that initiated the change
282 * @return true on success
286 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
288 if (position_locked) {
292 frame_position = pos;
294 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
297 (*delta) = new_unit_pos - group->position().x;
302 if (new_unit_pos == group->position().x) {
307 group->set_x_position (new_unit_pos);
308 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
313 /** @return position of this item on the timeline */
315 TimeAxisViewItem::get_position() const
317 return frame_position;
321 * Set the duration of this item.
323 * @param dur the new duration of this item
324 * @param src the identity of the object that initiated the change
325 * @return true on success
329 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
331 if ((dur > max_item_duration) || (dur < min_item_duration)) {
332 warning << string_compose (
333 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
334 get_item_name(), dur)
345 double end_pixel = trackview.editor().sample_to_pixel (frame_position + dur);
346 double first_pixel = trackview.editor().sample_to_pixel (frame_position);
348 reset_width_dependent_items (end_pixel - first_pixel);
350 DurationChanged (dur, src); /* EMIT_SIGNAL */
354 /** @return duration of this item */
356 TimeAxisViewItem::get_duration() const
358 return item_duration;
362 * Set the maximum duration that this item can have.
364 * @param dur the new maximum duration
365 * @param src the identity of the object that initiated the change
368 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
370 max_item_duration = dur;
371 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
374 /** @return the maximum duration that this item may have */
376 TimeAxisViewItem::get_max_duration() const
378 return max_item_duration;
382 * Set the minimum duration that this item may have.
384 * @param the minimum duration that this item may be set to
385 * @param src the identity of the object that initiated the change
388 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
390 min_item_duration = dur;
391 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
394 /** @return the minimum duration that this item mey have */
396 TimeAxisViewItem::get_min_duration() const
398 return min_item_duration;
402 * Set whether this item is locked to its current position.
403 * Locked items cannot be moved until the item is unlocked again.
405 * @param yn true to lock this item to its current position
406 * @param src the identity of the object that initiated the change
409 TimeAxisViewItem::set_position_locked(bool yn, void* src)
411 position_locked = yn;
412 set_trim_handle_colors();
413 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
416 /** @return true if this item is locked to its current position */
418 TimeAxisViewItem::get_position_locked() const
420 return position_locked;
424 * Set whether the maximum duration constraint is active.
426 * @param active set true to enforce the max duration constraint
427 * @param src the identity of the object that initiated the change
430 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
432 max_duration_active = active;
435 /** @return true if the maximum duration constraint is active */
437 TimeAxisViewItem::get_max_duration_active() const
439 return max_duration_active;
443 * Set whether the minimum duration constraint is active.
445 * @param active set true to enforce the min duration constraint
446 * @param src the identity of the object that initiated the change
450 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
452 min_duration_active = active;
455 /** @return true if the maximum duration constraint is active */
457 TimeAxisViewItem::get_min_duration_active() const
459 return min_duration_active;
463 * Set the name of this item.
465 * @param new_name the new name of this item
466 * @param src the identity of the object that initiated the change
470 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
472 if (new_name != item_name) {
473 std::string temp_name = item_name;
474 item_name = new_name;
475 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
479 /** @return the name of this item */
481 TimeAxisViewItem::get_item_name() const
487 * Set selection status.
489 * @param yn true if this item is currently selected
492 TimeAxisViewItem::set_selected(bool yn)
494 if (_selected == yn) {
498 Selectable::set_selected (yn);
500 set_name_text_color ();
502 if (_selected && frame) {
503 if (!selection_frame) {
504 selection_frame = new ArdourCanvas::Rectangle (group);
505 selection_frame->set_fill (false);
506 selection_frame->set_outline_color (ARDOUR_UI::config()->color ("selected time axis frame"));
507 selection_frame->set_ignore_events (true);
509 selection_frame->set (frame->get().shrink (1.0));
510 selection_frame->show ();
512 if (selection_frame) {
513 selection_frame->hide ();
518 /** @return the TimeAxisView that this item is on */
520 TimeAxisViewItem::get_time_axis_view () const
526 * Set the displayed item text.
527 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
529 * @param new_name the new name text to display
533 TimeAxisViewItem::set_name_text(const string& new_name)
539 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
540 name_text->set (new_name);
546 * Set the height of this item.
548 * @param h new height
551 TimeAxisViewItem::set_height (double height)
555 manage_name_highlight ();
557 if (visibility & ShowNameText) {
558 if (ARDOUR_UI::config()->get_show_name_highlight()) {
559 name_text->set_y_position (height - NAME_Y_OFFSET);
561 name_text->set_y_position (NAME_Y_OFFSET);
568 frame->set_y1 (height);
570 if (frame_handle_start) {
571 frame_handle_start->set_y1 (height);
572 frame_handle_end->set_y1 (height);
575 if (selection_frame) {
576 selection_frame->set (frame->get().shrink (1.0));
580 if (vestigial_frame) {
581 vestigial_frame->set_y0 (0.0);
582 vestigial_frame->set_y1 (height);
589 TimeAxisViewItem::manage_name_highlight ()
591 if (!name_highlight) {
595 if (_height < NAME_HIGHLIGHT_THRESH) {
596 high_enough_for_name = false;
598 high_enough_for_name = true;
602 wide_enough_for_name = false;
604 wide_enough_for_name = true;
607 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
609 name_highlight->show();
610 // name_highlight->set_x_position (1.0);
611 name_highlight->set (ArdourCanvas::Rect (0.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width - 2.0, _height));
614 name_highlight->hide();
621 TimeAxisViewItem::set_color (uint32_t base_color)
623 fill_color = base_color;
628 TimeAxisViewItem::get_canvas_frame()
634 TimeAxisViewItem::get_canvas_group()
640 TimeAxisViewItem::get_name_highlight()
642 return name_highlight;
646 * Convenience method to set the various canvas item colors
649 TimeAxisViewItem::set_colors()
653 if (name_highlight) {
654 name_highlight->set_fill_color (fill_color);
657 set_name_text_color ();
658 set_trim_handle_colors();
662 TimeAxisViewItem::set_name_text_color ()
671 if (ARDOUR_UI::config()->get_show_name_highlight()) {
672 /* name text will always be on top of name highlight, which
673 will always use our fill color.
677 /* name text will be on top of the item, whose color
678 may vary depending on various conditions.
680 f = get_fill_color ();
683 name_text->set_color (ArdourCanvas::contrasting_text_color (f));
687 TimeAxisViewItem::get_fill_color () const
689 const std::string mod_name = (_dragging ? "dragging region" : fill_color_name);
692 return ARDOUR_UI::config()->color_mod ("selected region base", mod_name);
693 } else if (_recregion) {
694 return ARDOUR_UI::config()->color ("recording rect");
695 } else if ((!ARDOUR_UI::config()->get_show_name_highlight() || high_enough_for_name) &&
696 !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
697 return ARDOUR_UI::config()->color_mod (fill_color_name, mod_name);
699 return ARDOUR_UI::config()->color_mod (fill_color, mod_name);
703 * Sets the frame color depending on whether this item is selected
706 TimeAxisViewItem::set_frame_color()
712 frame->set_fill_color (get_fill_color());
713 set_frame_gradient ();
716 frame->set_outline_color (ARDOUR_UI::config()->color ("time axis frame"));
721 TimeAxisViewItem::set_frame_gradient ()
723 if (ARDOUR_UI::config()->get_timeline_item_gradient_depth() == 0.0) {
724 frame->set_gradient (ArdourCanvas::Fill::StopList (), 0);
728 ArdourCanvas::Fill::StopList stops;
731 ArdourCanvas::Color f (get_fill_color());
733 /* need to get alpha value */
734 ArdourCanvas::color_to_rgba (f, r, g, b, a);
736 stops.push_back (std::make_pair (0.0, f));
738 /* now a darker version */
740 ArdourCanvas::color_to_hsv (f, h, s, v);
742 v = min (1.0, v * (1.0 - ARDOUR_UI::config()->get_timeline_item_gradient_depth()));
744 ArdourCanvas::Color darker = ArdourCanvas::hsva_to_color (h, s, v, a);
745 stops.push_back (std::make_pair (1.0, darker));
747 frame->set_gradient (stops, true);
751 * Set the colors of the start and end trim handle depending on object state
754 TimeAxisViewItem::set_trim_handle_colors()
757 /* Leave them transparent for now */
758 if (frame_handle_start) {
759 frame_handle_start->set_fill_color (0x00000000);
760 frame_handle_end->set_fill_color (0x00000000);
763 if (frame_handle_start) {
764 if (position_locked) {
765 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_TrimHandleLocked());
766 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_TrimHandleLocked());
768 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_TrimHandle());
769 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_TrimHandle());
776 TimeAxisViewItem::frame_handle_crossing (GdkEvent* ev, ArdourCanvas::Rectangle* item)
779 case GDK_LEAVE_NOTIFY:
780 /* always hide the handle whenever we leave, no matter what mode */
781 item->set_fill (false);
783 case GDK_ENTER_NOTIFY:
784 if (trackview.editor().effective_mouse_mode() == Editing::MouseObject) {
785 /* Never set this to be visible in other modes. Note, however,
786 that we do need to undo visibility (LEAVE_NOTIFY case above) no
787 matter what the mode is. */
788 item->set_fill (true);
797 /** @return the frames per pixel */
799 TimeAxisViewItem::get_samples_per_pixel () const
801 return samples_per_pixel;
804 /** Set the frames per pixel of this item.
805 * This item is used to determine the relative visual size and position of this item
806 * based upon its duration and start value.
808 * @param fpp the new frames per pixel
811 TimeAxisViewItem::set_samples_per_pixel (double fpp)
813 samples_per_pixel = fpp;
814 set_position (this->get_position(), this);
816 double end_pixel = trackview.editor().sample_to_pixel (frame_position + get_duration());
817 double first_pixel = trackview.editor().sample_to_pixel (frame_position);
819 reset_width_dependent_items (end_pixel - first_pixel);
823 TimeAxisViewItem::reset_width_dependent_items (double pixel_width)
825 _width = pixel_width;
827 manage_name_highlight ();
830 if (pixel_width < 2.0) {
832 if (show_vestigial) {
834 if (!vestigial_frame) {
835 vestigial_frame = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, 0.0, 2.0, trackview.current_height()));
836 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
837 vestigial_frame->set_outline_color (ARDOUR_UI::config()->color ("vestigial frame"));
838 vestigial_frame->set_fill_color (ARDOUR_UI::config()->color ("vestigial frame"));
839 vestigial_frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
842 vestigial_frame->show();
849 if (frame_handle_start) {
850 frame_handle_start->hide();
851 frame_handle_end->hide();
855 if (vestigial_frame) {
856 vestigial_frame->hide();
861 /* Note: x0 is always zero - the position is defined by
862 * the position of the group, not the frame.
864 frame->set_x1 (pixel_width);
866 if (selection_frame) {
867 selection_frame->set (frame->get().shrink (1.0));
871 if (frame_handle_start) {
872 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
874 * there's less than GRAB_HANDLE_WIDTH of the region between
875 * the right-hand end of frame_handle_start and the left-hand
876 * end of frame_handle_end, so disable the handles
879 frame_handle_start->hide();
880 frame_handle_end->hide();
882 frame_handle_start->show();
883 frame_handle_end->set_x0 (pixel_width - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
884 frame_handle_end->set_x1 (pixel_width);
885 frame_handle_end->show();
892 TimeAxisViewItem::manage_name_text ()
894 int visible_name_width;
900 if (!wide_enough_for_name || !high_enough_for_name) {
905 if (name_text->text().empty()) {
909 visible_name_width = name_text_width;
911 if (visible_name_width > _width - NAME_X_OFFSET) {
912 visible_name_width = _width - NAME_X_OFFSET;
915 if (visible_name_width < 1) {
918 name_text->clamp_width (visible_name_width);
924 * Callback used to remove this time axis item during the gtk idle loop.
925 * This is used to avoid deleting the obejct while inside the remove_this_item
928 * @param item the TimeAxisViewItem to remove.
929 * @param src the identity of the object that initiated the change.
932 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
934 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
941 TimeAxisViewItem::set_y (double y)
943 group->set_y_position (y);
947 TimeAxisViewItem::parameter_changed (string p)
949 if (p == "color-regions-using-track-color") {
951 } else if (p == "timeline-item-gradient-depth") {
952 set_frame_gradient ();
957 TimeAxisViewItem::drag_start ()
964 TimeAxisViewItem::drag_end ()