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 "public_editor.h"
40 #include "time_axis_view_item.h"
41 #include "time_axis_view.h"
42 #include "ui_config.h"
44 #include "rgb_macros.h"
49 using namespace Editing;
52 using namespace ARDOUR;
53 using namespace ARDOUR_UI_UTILS;
54 using namespace Gtkmm2ext;
56 Pango::FontDescription TimeAxisViewItem::NAME_FONT;
57 const double TimeAxisViewItem::NAME_X_OFFSET = 15.0;
58 const double TimeAxisViewItem::GRAB_HANDLE_TOP = 0.0;
59 const double TimeAxisViewItem::GRAB_HANDLE_WIDTH = 10.0;
61 int TimeAxisViewItem::NAME_HEIGHT;
62 double TimeAxisViewItem::NAME_Y_OFFSET;
63 double TimeAxisViewItem::NAME_HIGHLIGHT_SIZE;
64 double TimeAxisViewItem::NAME_HIGHLIGHT_THRESH;
67 TimeAxisViewItem::set_constant_heights ()
69 NAME_FONT = Pango::FontDescription (UIConfiguration::instance().get_SmallFont());
75 Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout (X_("Hg")); /* ascender + descender */
79 layout->set_font_description (NAME_FONT);
80 get_pixel_size (layout, width, height);
82 layout = foo.create_pango_layout (X_("H")); /* just the ascender */
86 /* Config->get_show_name_highlight) == true:
87 Y_OFFSET is measured from bottom of the time axis view item.
88 Config->get_show_name_highlight) == false:
89 Y_OFFSET is measured from the top of the time axis view item.
92 if (UIConfiguration::instance().get_show_name_highlight()) {
93 NAME_Y_OFFSET = height + 1;
94 NAME_HIGHLIGHT_SIZE = height + 2;
97 NAME_HIGHLIGHT_SIZE = 0;
99 NAME_HIGHLIGHT_THRESH = NAME_HIGHLIGHT_SIZE * 3;
103 * Construct a new TimeAxisViewItem.
105 * @param it_name the unique name of this item
106 * @param parent the parent canvas group
107 * @param tv the TimeAxisView we are going to be added to
108 * @param spu samples per unit
110 * @param start the start point of this item
111 * @param duration the duration of this item
112 * @param recording true if this is a recording region view
113 * @param automation true if this is an automation region view
115 TimeAxisViewItem::TimeAxisViewItem(
116 const string & it_name, ArdourCanvas::Item& parent, TimeAxisView& tv, double spu, uint32_t base_color,
117 framepos_t start, framecnt_t duration, bool recording, bool automation, Visibility vis
120 , frame_position (-1)
121 , item_name (it_name)
122 , selection_frame (0)
124 , _recregion (recording)
125 , _automation (automation)
129 init (&parent, spu, base_color, start, duration, vis, true, true);
132 TimeAxisViewItem::TimeAxisViewItem (const TimeAxisViewItem& other)
135 , PBD::ScopedConnectionList()
136 , trackview (other.trackview)
137 , frame_position (-1)
138 , item_name (other.item_name)
139 , selection_frame (0)
141 , _recregion (other._recregion)
142 , _automation (other._automation)
143 , _dragging (other._dragging)
146 /* share the other's parent, but still create a new group */
148 ArdourCanvas::Item* parent = other.group->parent();
150 _selected = other._selected;
152 init (parent, other.samples_per_pixel, other.fill_color, other.frame_position,
153 other.item_duration, other.visibility, other.wide_enough_for_name, other.high_enough_for_name);
157 TimeAxisViewItem::init (ArdourCanvas::Item* parent, double fpp, uint32_t base_color,
158 framepos_t start, framepos_t duration, Visibility vis,
159 bool wide, bool high)
161 group = new ArdourCanvas::Container (parent);
162 CANVAS_DEBUG_NAME (group, string_compose ("TAVI group for %1", get_item_name()));
163 group->Event.connect (sigc::mem_fun (*this, &TimeAxisViewItem::canvas_group_event));
165 fill_color = base_color;
166 fill_color_name = "time axis view item base";
167 samples_per_pixel = fpp;
168 frame_position = start;
169 item_duration = duration;
170 name_connected = false;
171 position_locked = false;
172 max_item_duration = ARDOUR::max_framepos;
173 min_item_duration = 0;
174 show_vestigial = true;
179 wide_enough_for_name = wide;
180 high_enough_for_name = high;
184 warning << "Time Axis Item Duration == 0" << endl;
187 if (visibility & ShowFrame) {
188 frame = new ArdourCanvas::Rectangle (group,
189 ArdourCanvas::Rect (0.0, 0.0,
190 trackview.editor().sample_to_pixel(duration),
191 trackview.current_height()));
193 frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
195 CANVAS_DEBUG_NAME (frame, string_compose ("frame for %1", get_item_name()));
198 frame->set_outline_color (UIConfiguration::instance().color ("recording rect"));
200 frame->set_outline_color (UIConfiguration::instance().color ("time axis frame"));
204 if (UIConfiguration::instance().get_show_name_highlight() && (visibility & ShowNameHighlight)) {
206 /* rectangle size will be set in ::manage_name_highlight() */
207 name_highlight = new ArdourCanvas::Rectangle (group);
208 CANVAS_DEBUG_NAME (name_highlight, string_compose ("name highlight for %1", get_item_name()));
209 name_highlight->set_data ("timeaxisviewitem", this);
210 name_highlight->set_outline_what (ArdourCanvas::Rectangle::TOP);
211 name_highlight->set_outline_color (RGBA_TO_UINT (0,0,0,255)); // this should use a theme color
217 if (visibility & ShowNameText) {
218 name_text = new ArdourCanvas::Text (group);
219 CANVAS_DEBUG_NAME (name_text, string_compose ("name text for %1", get_item_name()));
220 if (UIConfiguration::instance().get_show_name_highlight()) {
221 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, trackview.current_height() - NAME_Y_OFFSET));
223 name_text->set_position (ArdourCanvas::Duple (NAME_X_OFFSET, NAME_Y_OFFSET));
225 name_text->set_font_description (NAME_FONT);
226 name_text->set_ignore_events (true);
231 /* create our grab handles used for trimming/duration etc */
232 if (!_recregion && !_automation) {
233 double top = TimeAxisViewItem::GRAB_HANDLE_TOP;
234 double width = TimeAxisViewItem::GRAB_HANDLE_WIDTH;
236 frame_handle_start = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
237 CANVAS_DEBUG_NAME (frame_handle_start, "TAVI frame handle start");
238 frame_handle_start->set_outline (false);
239 frame_handle_start->set_fill (false);
240 frame_handle_start->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_start));
242 frame_handle_end = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, top, width, trackview.current_height()));
243 CANVAS_DEBUG_NAME (frame_handle_end, "TAVI frame handle end");
244 frame_handle_end->set_outline (false);
245 frame_handle_end->set_fill (false);
246 frame_handle_end->Event.connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisViewItem::frame_handle_crossing), frame_handle_end));
248 frame_handle_start = frame_handle_end = 0;
251 set_color (base_color);
253 set_duration (item_duration, this);
254 set_position (start, this);
256 Config->ParameterChanged.connect (*this, invalidator (*this), boost::bind (&TimeAxisViewItem::parameter_changed, this, _1), gui_context ());
257 UIConfiguration::instance().ParameterChanged.connect (sigc::mem_fun (*this, &TimeAxisViewItem::parameter_changed));
260 TimeAxisViewItem::~TimeAxisViewItem()
266 TimeAxisViewItem::canvas_group_event (GdkEvent* /*ev*/)
272 * Set the position of this item on the timeline.
274 * @param pos the new position
275 * @param src the identity of the object that initiated the change
276 * @return true on success
280 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
282 if (position_locked) {
286 frame_position = pos;
288 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
291 (*delta) = new_unit_pos - group->position().x;
296 if (new_unit_pos == group->position().x) {
301 group->set_x_position (new_unit_pos);
302 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
307 /** @return position of this item on the timeline */
309 TimeAxisViewItem::get_position() const
311 return frame_position;
315 * Set the duration of this item.
317 * @param dur the new duration of this item
318 * @param src the identity of the object that initiated the change
319 * @return true on success
323 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
325 if ((dur > max_item_duration) || (dur < min_item_duration)) {
326 warning << string_compose (
327 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
328 get_item_name(), dur)
339 double end_pixel = trackview.editor().sample_to_pixel (frame_position + dur);
340 double first_pixel = trackview.editor().sample_to_pixel (frame_position);
342 reset_width_dependent_items (end_pixel - first_pixel);
344 DurationChanged (dur, src); /* EMIT_SIGNAL */
348 /** @return duration of this item */
350 TimeAxisViewItem::get_duration() const
352 return item_duration;
356 * Set the maximum duration that this item can have.
358 * @param dur the new maximum duration
359 * @param src the identity of the object that initiated the change
362 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
364 max_item_duration = dur;
365 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
368 /** @return the maximum duration that this item may have */
370 TimeAxisViewItem::get_max_duration() const
372 return max_item_duration;
376 * Set the minimum duration that this item may have.
378 * @param the minimum duration that this item may be set to
379 * @param src the identity of the object that initiated the change
382 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
384 min_item_duration = dur;
385 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
388 /** @return the minimum duration that this item mey have */
390 TimeAxisViewItem::get_min_duration() const
392 return min_item_duration;
396 * Set whether this item is locked to its current position.
397 * Locked items cannot be moved until the item is unlocked again.
399 * @param yn true to lock this item to its current position
400 * @param src the identity of the object that initiated the change
403 TimeAxisViewItem::set_position_locked(bool yn, void* src)
405 position_locked = yn;
406 set_trim_handle_colors();
407 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
410 /** @return true if this item is locked to its current position */
412 TimeAxisViewItem::get_position_locked() const
414 return position_locked;
418 * Set whether the maximum duration constraint is active.
420 * @param active set true to enforce the max duration constraint
421 * @param src the identity of the object that initiated the change
424 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
426 max_duration_active = active;
429 /** @return true if the maximum duration constraint is active */
431 TimeAxisViewItem::get_max_duration_active() const
433 return max_duration_active;
437 * Set whether the minimum duration constraint is active.
439 * @param active set true to enforce the min duration constraint
440 * @param src the identity of the object that initiated the change
444 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
446 min_duration_active = active;
449 /** @return true if the maximum duration constraint is active */
451 TimeAxisViewItem::get_min_duration_active() const
453 return min_duration_active;
457 * Set the name of this item.
459 * @param new_name the new name of this item
460 * @param src the identity of the object that initiated the change
464 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
466 if (new_name != item_name) {
467 std::string temp_name = item_name;
468 item_name = new_name;
469 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
473 /** @return the name of this item */
475 TimeAxisViewItem::get_item_name() const
481 * Set selection status.
483 * @param yn true if this item is currently selected
486 TimeAxisViewItem::set_selected(bool yn)
488 if (_selected == yn) {
492 Selectable::set_selected (yn);
494 set_name_text_color ();
496 if (_selected && frame) {
497 if (!selection_frame) {
498 selection_frame = new ArdourCanvas::Rectangle (group);
499 selection_frame->set_fill (false);
500 selection_frame->set_outline_color (UIConfiguration::instance().color ("selected time axis frame"));
501 selection_frame->set_ignore_events (true);
503 selection_frame->set (frame->get().shrink (1.0));
504 selection_frame->show ();
506 if (selection_frame) {
507 selection_frame->hide ();
512 /** @return the TimeAxisView that this item is on */
514 TimeAxisViewItem::get_time_axis_view () const
520 * Set the displayed item text.
521 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
523 * @param new_name the new name text to display
527 TimeAxisViewItem::set_name_text(const string& new_name)
533 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
534 name_text->set (new_name);
540 * Set the height of this item.
542 * @param h new height
545 TimeAxisViewItem::set_height (double height)
549 manage_name_highlight ();
551 if (visibility & ShowNameText) {
552 if (UIConfiguration::instance().get_show_name_highlight()) {
553 name_text->set_y_position (height - NAME_Y_OFFSET);
555 name_text->set_y_position (NAME_Y_OFFSET);
562 frame->set_y1 (height);
564 if (frame_handle_start) {
565 frame_handle_start->set_y1 (height);
566 frame_handle_end->set_y1 (height);
569 if (selection_frame) {
570 selection_frame->set (frame->get().shrink (1.0));
574 if (vestigial_frame) {
575 vestigial_frame->set_y0 (0.0);
576 vestigial_frame->set_y1 (height);
583 TimeAxisViewItem::manage_name_highlight ()
585 if (!name_highlight) {
589 if (_height < NAME_HIGHLIGHT_THRESH) {
590 high_enough_for_name = false;
592 high_enough_for_name = true;
596 wide_enough_for_name = false;
598 wide_enough_for_name = true;
601 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
603 name_highlight->show();
604 // name_highlight->set_x_position (1.0);
605 name_highlight->set (ArdourCanvas::Rect (0.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width - 2.0, _height));
608 name_highlight->hide();
615 TimeAxisViewItem::set_color (uint32_t base_color)
617 fill_color = base_color;
622 TimeAxisViewItem::get_canvas_frame()
628 TimeAxisViewItem::get_canvas_group()
634 TimeAxisViewItem::get_name_highlight()
636 return name_highlight;
640 * Convenience method to set the various canvas item colors
643 TimeAxisViewItem::set_colors()
647 if (name_highlight) {
648 name_highlight->set_fill_color (fill_color);
651 set_name_text_color ();
652 set_trim_handle_colors();
656 TimeAxisViewItem::set_name_text_color ()
665 if (UIConfiguration::instance().get_show_name_highlight()) {
666 /* name text will always be on top of name highlight, which
667 will always use our fill color.
671 /* name text will be on top of the item, whose color
672 may vary depending on various conditions.
674 f = get_fill_color ();
677 name_text->set_color (ArdourCanvas::contrasting_text_color (f));
681 TimeAxisViewItem::get_fill_color () const
683 const std::string mod_name = (_dragging ? "dragging region" : fill_color_name);
686 return UIConfiguration::instance().color_mod ("selected region base", mod_name);
687 } else if (_recregion) {
688 return UIConfiguration::instance().color ("recording rect");
689 } else if ((!UIConfiguration::instance().get_show_name_highlight() || high_enough_for_name) &&
690 !UIConfiguration::instance().get_color_regions_using_track_color()) {
691 return UIConfiguration::instance().color_mod (fill_color_name, mod_name);
693 return UIConfiguration::instance().color_mod (fill_color, mod_name);
697 * Sets the frame color depending on whether this item is selected
700 TimeAxisViewItem::set_frame_color()
706 frame->set_fill_color (get_fill_color());
707 set_frame_gradient ();
710 frame->set_outline_color (UIConfiguration::instance().color ("time axis frame"));
715 TimeAxisViewItem::set_frame_gradient ()
717 if (UIConfiguration::instance().get_timeline_item_gradient_depth() == 0.0) {
718 frame->set_gradient (ArdourCanvas::Fill::StopList (), 0);
722 ArdourCanvas::Fill::StopList stops;
725 ArdourCanvas::Color f (get_fill_color());
727 /* need to get alpha value */
728 ArdourCanvas::color_to_rgba (f, r, g, b, a);
730 stops.push_back (std::make_pair (0.0, f));
732 /* now a darker version */
734 ArdourCanvas::color_to_hsv (f, h, s, v);
736 v = min (1.0, v * (1.0 - UIConfiguration::instance().get_timeline_item_gradient_depth()));
738 ArdourCanvas::Color darker = ArdourCanvas::hsva_to_color (h, s, v, a);
739 stops.push_back (std::make_pair (1.0, darker));
741 frame->set_gradient (stops, true);
745 * Set the colors of the start and end trim handle depending on object state
748 TimeAxisViewItem::set_trim_handle_colors()
751 /* Leave them transparent for now */
752 if (frame_handle_start) {
753 frame_handle_start->set_fill_color (0x00000000);
754 frame_handle_end->set_fill_color (0x00000000);
757 if (frame_handle_start) {
758 if (position_locked) {
759 frame_handle_start->set_fill_color (UIConfiguration::instance().get_TrimHandleLocked());
760 frame_handle_end->set_fill_color (UIConfiguration::instance().get_TrimHandleLocked());
762 frame_handle_start->set_fill_color (UIConfiguration::instance().get_TrimHandle());
763 frame_handle_end->set_fill_color (UIConfiguration::instance().get_TrimHandle());
770 TimeAxisViewItem::frame_handle_crossing (GdkEvent* ev, ArdourCanvas::Rectangle* item)
773 case GDK_LEAVE_NOTIFY:
774 /* always hide the handle whenever we leave, no matter what mode */
775 item->set_fill (false);
777 case GDK_ENTER_NOTIFY:
778 if (trackview.editor().effective_mouse_mode() == Editing::MouseObject) {
779 /* Never set this to be visible in other modes. Note, however,
780 that we do need to undo visibility (LEAVE_NOTIFY case above) no
781 matter what the mode is. */
782 item->set_fill (true);
791 /** @return the frames per pixel */
793 TimeAxisViewItem::get_samples_per_pixel () const
795 return samples_per_pixel;
798 /** Set the frames per pixel of this item.
799 * This item is used to determine the relative visual size and position of this item
800 * based upon its duration and start value.
802 * @param fpp the new frames per pixel
805 TimeAxisViewItem::set_samples_per_pixel (double fpp)
807 samples_per_pixel = fpp;
808 set_position (this->get_position(), this);
810 double end_pixel = trackview.editor().sample_to_pixel (frame_position + get_duration());
811 double first_pixel = trackview.editor().sample_to_pixel (frame_position);
813 reset_width_dependent_items (end_pixel - first_pixel);
817 TimeAxisViewItem::reset_width_dependent_items (double pixel_width)
819 _width = pixel_width;
821 manage_name_highlight ();
824 if (pixel_width < 2.0) {
826 if (show_vestigial) {
828 if (!vestigial_frame) {
829 vestigial_frame = new ArdourCanvas::Rectangle (group, ArdourCanvas::Rect (0.0, 0.0, 2.0, trackview.current_height()));
830 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
831 vestigial_frame->set_outline_color (UIConfiguration::instance().color ("vestigial frame"));
832 vestigial_frame->set_fill_color (UIConfiguration::instance().color ("vestigial frame"));
833 vestigial_frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
836 vestigial_frame->show();
843 if (frame_handle_start) {
844 frame_handle_start->hide();
845 frame_handle_end->hide();
849 if (vestigial_frame) {
850 vestigial_frame->hide();
855 /* Note: x0 is always zero - the position is defined by
856 * the position of the group, not the frame.
858 frame->set_x1 (pixel_width);
860 if (selection_frame) {
861 selection_frame->set (frame->get().shrink (1.0));
865 if (frame_handle_start) {
866 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
868 * there's less than GRAB_HANDLE_WIDTH of the region between
869 * the right-hand end of frame_handle_start and the left-hand
870 * end of frame_handle_end, so disable the handles
873 frame_handle_start->hide();
874 frame_handle_end->hide();
876 frame_handle_start->show();
877 frame_handle_end->set_x0 (pixel_width - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
878 frame_handle_end->set_x1 (pixel_width);
879 frame_handle_end->show();
886 TimeAxisViewItem::manage_name_text ()
888 int visible_name_width;
894 if (!wide_enough_for_name || !high_enough_for_name) {
899 if (name_text->text().empty()) {
903 visible_name_width = name_text_width;
905 if (visible_name_width > _width - NAME_X_OFFSET) {
906 visible_name_width = _width - NAME_X_OFFSET;
909 if (visible_name_width < 1) {
912 name_text->clamp_width (visible_name_width);
918 * Callback used to remove this time axis item during the gtk idle loop.
919 * This is used to avoid deleting the obejct while inside the remove_this_item
922 * @param item the TimeAxisViewItem to remove.
923 * @param src the identity of the object that initiated the change.
926 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
928 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
935 TimeAxisViewItem::set_y (double y)
937 group->set_y_position (y);
941 TimeAxisViewItem::parameter_changed (string p)
943 if (p == "color-regions-using-track-color") {
945 } else if (p == "timeline-item-gradient-depth") {
946 set_frame_gradient ();
951 TimeAxisViewItem::drag_start ()
958 TimeAxisViewItem::drag_end ()