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::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()->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)) {
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 (ARDOUR_UI::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 * Set the position of this item on the timeline.
292 * @param pos the new position
293 * @param src the identity of the object that initiated the change
294 * @return true on success
298 TimeAxisViewItem::set_position(framepos_t pos, void* src, double* delta)
300 if (position_locked) {
304 frame_position = pos;
306 double new_unit_pos = trackview.editor().sample_to_pixel (pos);
309 (*delta) = new_unit_pos - group->position().x;
314 if (new_unit_pos == group->position().x) {
319 group->set_x_position (new_unit_pos);
321 PositionChanged (frame_position, src); /* EMIT_SIGNAL */
326 /** @return position of this item on the timeline */
328 TimeAxisViewItem::get_position() const
330 return frame_position;
334 * Set the duration of this item.
336 * @param dur the new duration of this item
337 * @param src the identity of the object that initiated the change
338 * @return true on success
342 TimeAxisViewItem::set_duration (framecnt_t dur, void* src)
344 if ((dur > max_item_duration) || (dur < min_item_duration)) {
345 warning << string_compose (
346 P_("new duration %1 frame is out of bounds for %2", "new duration of %1 frames is out of bounds for %2", dur),
347 get_item_name(), dur)
358 reset_width_dependent_items (trackview.editor().sample_to_pixel (dur));
360 DurationChanged (dur, src); /* EMIT_SIGNAL */
364 /** @return duration of this item */
366 TimeAxisViewItem::get_duration() const
368 return item_duration;
372 * Set the maximum duration that this item can have.
374 * @param dur the new maximum duration
375 * @param src the identity of the object that initiated the change
378 TimeAxisViewItem::set_max_duration(framecnt_t dur, void* src)
380 max_item_duration = dur;
381 MaxDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
384 /** @return the maximum duration that this item may have */
386 TimeAxisViewItem::get_max_duration() const
388 return max_item_duration;
392 * Set the minimum duration that this item may have.
394 * @param the minimum duration that this item may be set to
395 * @param src the identity of the object that initiated the change
398 TimeAxisViewItem::set_min_duration(framecnt_t dur, void* src)
400 min_item_duration = dur;
401 MinDurationChanged(max_item_duration, src); /* EMIT_SIGNAL */
404 /** @return the minimum duration that this item mey have */
406 TimeAxisViewItem::get_min_duration() const
408 return min_item_duration;
412 * Set whether this item is locked to its current position.
413 * Locked items cannot be moved until the item is unlocked again.
415 * @param yn true to lock this item to its current position
416 * @param src the identity of the object that initiated the change
419 TimeAxisViewItem::set_position_locked(bool yn, void* src)
421 position_locked = yn;
422 set_trim_handle_colors();
423 PositionLockChanged (position_locked, src); /* EMIT_SIGNAL */
426 /** @return true if this item is locked to its current position */
428 TimeAxisViewItem::get_position_locked() const
430 return position_locked;
434 * Set whether the maximum duration constraint is active.
436 * @param active set true to enforce the max duration constraint
437 * @param src the identity of the object that initiated the change
440 TimeAxisViewItem::set_max_duration_active (bool active, void* /*src*/)
442 max_duration_active = active;
445 /** @return true if the maximum duration constraint is active */
447 TimeAxisViewItem::get_max_duration_active() const
449 return max_duration_active;
453 * Set whether the minimum duration constraint is active.
455 * @param active set true to enforce the min duration constraint
456 * @param src the identity of the object that initiated the change
460 TimeAxisViewItem::set_min_duration_active (bool active, void* /*src*/)
462 min_duration_active = active;
465 /** @return true if the maximum duration constraint is active */
467 TimeAxisViewItem::get_min_duration_active() const
469 return min_duration_active;
473 * Set the name of this item.
475 * @param new_name the new name of this item
476 * @param src the identity of the object that initiated the change
480 TimeAxisViewItem::set_item_name(std::string new_name, void* src)
482 if (new_name != item_name) {
483 std::string temp_name = item_name;
484 item_name = new_name;
485 NameChanged (item_name, temp_name, src); /* EMIT_SIGNAL */
489 /** @return the name of this item */
491 TimeAxisViewItem::get_item_name() const
497 * Set selection status.
499 * @param yn true if this item is currently selected
502 TimeAxisViewItem::set_selected(bool yn)
504 if (_selected == yn) {
508 Selectable::set_selected (yn);
510 set_name_text_color ();
512 if (_selected && frame) {
513 if (!selection_frame) {
514 selection_frame = new ArdourCanvas::TimeRectangle (group);
515 selection_frame->set_fill (false);
516 selection_frame->set_outline_color (ARDOUR_UI::config()->color ("selected time axis frame"));
517 selection_frame->set_ignore_events (true);
519 selection_frame->set (frame->get().shrink (1.0));
520 selection_frame->show ();
522 if (selection_frame) {
523 selection_frame->hide ();
528 /** @return the TimeAxisView that this item is on */
530 TimeAxisViewItem::get_time_axis_view () const
536 * Set the displayed item text.
537 * This item is the visual text name displayed on the canvas item, this can be different to the name of the item.
539 * @param new_name the new name text to display
543 TimeAxisViewItem::set_name_text(const string& new_name)
549 name_text_width = pixel_width (new_name, NAME_FONT) + 2;
550 name_text->set (new_name);
555 * Set the height of this item.
557 * @param h new height
560 TimeAxisViewItem::set_height (double height)
564 manage_name_highlight ();
566 if (visibility & ShowNameText) {
567 if (ARDOUR_UI::config()->get_show_name_highlight()) {
568 name_text->set_y_position (height - NAME_Y_OFFSET);
570 name_text->set_y_position (NAME_Y_OFFSET);
577 frame->set_y1 (height);
579 if (frame_handle_start) {
580 frame_handle_start->set_y1 (height);
581 frame_handle_end->set_y1 (height);
584 if (selection_frame) {
585 selection_frame->set (frame->get().shrink (1.0));
589 if (vestigial_frame) {
590 vestigial_frame->set_y0 (1.0);
591 vestigial_frame->set_y1 (height);
598 TimeAxisViewItem::manage_name_highlight ()
600 if (!name_highlight) {
604 if (_height < NAME_HIGHLIGHT_THRESH) {
605 high_enough_for_name = false;
607 high_enough_for_name = true;
611 wide_enough_for_name = false;
613 wide_enough_for_name = true;
616 if (name_highlight && wide_enough_for_name && high_enough_for_name) {
618 name_highlight->show();
619 name_highlight->set (ArdourCanvas::Rect (1.0, (double) _height - NAME_HIGHLIGHT_SIZE, _width, (double) _height - 1.0));
622 name_highlight->hide();
629 TimeAxisViewItem::set_color (uint32_t base_color)
631 fill_color = base_color;
636 TimeAxisViewItem::get_canvas_frame()
642 TimeAxisViewItem::get_canvas_group()
648 TimeAxisViewItem::get_name_highlight()
650 return name_highlight;
654 * Convenience method to set the various canvas item colors
657 TimeAxisViewItem::set_colors()
661 if (name_highlight) {
662 name_highlight->set_fill_color (fill_color);
665 set_name_text_color ();
666 set_trim_handle_colors();
670 TimeAxisViewItem::set_name_text_color ()
679 if (ARDOUR_UI::config()->get_show_name_highlight()) {
680 /* name text will always be on top of name highlight, which
681 will always use our fill color.
685 /* name text will be on top of the item, whose color
686 may vary depending on various conditions.
688 f = get_fill_color ();
691 name_text->set_color (ArdourCanvas::contrasting_text_color (f));
695 TimeAxisViewItem::get_fill_color () const
697 const std::string mod_name = (_dragging ? "dragging region" : fill_color_name);
700 return ARDOUR_UI::config()->color_mod ("selected region base", mod_name);
701 } else if (_recregion) {
702 return ARDOUR_UI::config()->color ("recording rect");
703 } else if ((!ARDOUR_UI::config()->get_show_name_highlight() || high_enough_for_name) &&
704 !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
705 return ARDOUR_UI::config()->color_mod (fill_color_name, mod_name);
707 return ARDOUR_UI::config()->color_mod (fill_color, mod_name);
711 * Sets the frame color depending on whether this item is selected
714 TimeAxisViewItem::set_frame_color()
720 frame->set_fill_color (get_fill_color());
721 set_frame_gradient ();
724 frame->set_outline_color (ARDOUR_UI::config()->color ("time axis frame"));
729 TimeAxisViewItem::set_frame_gradient ()
731 if (ARDOUR_UI::config()->get_timeline_item_gradient_depth() == 0.0) {
732 frame->set_gradient (ArdourCanvas::Fill::StopList (), 0);
736 ArdourCanvas::Fill::StopList stops;
739 ArdourCanvas::Color f (get_fill_color());
741 /* need to get alpha value */
742 ArdourCanvas::color_to_rgba (f, r, g, b, a);
744 stops.push_back (std::make_pair (0.0, f));
746 /* now a darker version */
748 ArdourCanvas::color_to_hsv (f, h, s, v);
750 v = min (1.0, v * (1.0 - ARDOUR_UI::config()->get_timeline_item_gradient_depth()));
752 ArdourCanvas::Color darker = ArdourCanvas::hsva_to_color (h, s, v, a);
753 stops.push_back (std::make_pair (1.0, darker));
755 frame->set_gradient (stops, true);
759 * Set the colors of the start and end trim handle depending on object state
762 TimeAxisViewItem::set_trim_handle_colors()
765 /* Leave them transparent for now */
766 if (frame_handle_start) {
767 frame_handle_start->set_fill_color (0x00000000);
768 frame_handle_end->set_fill_color (0x00000000);
771 if (frame_handle_start) {
772 if (position_locked) {
773 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_TrimHandleLocked());
774 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_TrimHandleLocked());
776 frame_handle_start->set_fill_color (ARDOUR_UI::config()->get_TrimHandle());
777 frame_handle_end->set_fill_color (ARDOUR_UI::config()->get_TrimHandle());
784 TimeAxisViewItem::frame_handle_crossing (GdkEvent* ev, ArdourCanvas::Rectangle* item)
787 case GDK_LEAVE_NOTIFY:
788 /* always hide the handle whenever we leave, no matter what mode */
789 item->set_fill (false);
791 case GDK_ENTER_NOTIFY:
792 if (trackview.editor().effective_mouse_mode() == Editing::MouseObject) {
793 /* Never set this to be visible in other modes. Note, however,
794 that we do need to undo visibility (LEAVE_NOTIFY case above) no
795 matter what the mode is. */
796 item->set_fill (true);
805 /** @return the frames per pixel */
807 TimeAxisViewItem::get_samples_per_pixel () const
809 return samples_per_pixel;
812 /** Set the frames per pixel of this item.
813 * This item is used to determine the relative visual size and position of this item
814 * based upon its duration and start value.
816 * @param fpp the new frames per pixel
819 TimeAxisViewItem::set_samples_per_pixel (double fpp)
821 samples_per_pixel = fpp;
822 set_position (this->get_position(), this);
823 reset_width_dependent_items ((double) get_duration() / samples_per_pixel);
827 TimeAxisViewItem::reset_width_dependent_items (double pixel_width)
829 _width = pixel_width;
831 manage_name_highlight ();
834 if (pixel_width < 2.0) {
836 if (show_vestigial) {
838 if (!vestigial_frame) {
839 vestigial_frame = new ArdourCanvas::TimeRectangle (group, ArdourCanvas::Rect (0.0, 0.0, 2.0, trackview.current_height()));
840 CANVAS_DEBUG_NAME (vestigial_frame, string_compose ("vestigial frame for %1", get_item_name()));
841 vestigial_frame->set_outline_color (ARDOUR_UI::config()->color ("vestigial frame"));
842 vestigial_frame->set_fill_color (ARDOUR_UI::config()->color ("vestigial frame"));
843 vestigial_frame->set_outline_what (ArdourCanvas::Rectangle::What (ArdourCanvas::Rectangle::LEFT|ArdourCanvas::Rectangle::RIGHT));
846 vestigial_frame->show();
853 if (frame_handle_start) {
854 frame_handle_start->hide();
855 frame_handle_end->hide();
859 if (vestigial_frame) {
860 vestigial_frame->hide();
865 frame->set_x1 (pixel_width);
867 if (selection_frame) {
868 selection_frame->set (frame->get().shrink (1.0));
872 if (frame_handle_start) {
873 if (pixel_width < (3 * TimeAxisViewItem::GRAB_HANDLE_WIDTH)) {
875 * there's less than GRAB_HANDLE_WIDTH of the region between
876 * the right-hand end of frame_handle_start and the left-hand
877 * end of frame_handle_end, so disable the handles
880 frame_handle_start->hide();
881 frame_handle_end->hide();
883 frame_handle_start->show();
884 frame_handle_end->set_x0 (pixel_width - (TimeAxisViewItem::GRAB_HANDLE_WIDTH));
885 frame_handle_end->set_x1 (pixel_width);
886 frame_handle_end->show();
893 TimeAxisViewItem::manage_name_text ()
895 int visible_name_width;
901 if (!wide_enough_for_name || !high_enough_for_name) {
906 if (name_text->text().empty()) {
910 visible_name_width = name_text_width;
912 if (visible_name_width > _width - NAME_X_OFFSET) {
913 visible_name_width = _width - NAME_X_OFFSET;
916 if (visible_name_width < 1) {
919 name_text->clamp_width (visible_name_width);
925 * Callback used to remove this time axis item during the gtk idle loop.
926 * This is used to avoid deleting the obejct while inside the remove_this_item
929 * @param item the TimeAxisViewItem to remove.
930 * @param src the identity of the object that initiated the change.
933 TimeAxisViewItem::idle_remove_this_item(TimeAxisViewItem* item, void* src)
935 item->ItemRemoved (item->get_item_name(), src); /* EMIT_SIGNAL */
942 TimeAxisViewItem::set_y (double y)
944 group->set_y_position (y);
948 TimeAxisViewItem::parameter_changed (string p)
950 if (p == "color-regions-using-track-color") {
952 } else if (p == "timeline-item-gradient-depth") {
953 set_frame_gradient ();
958 TimeAxisViewItem::drag_start ()
965 TimeAxisViewItem::drag_end ()