gtk2_ardour/marker_time_axis_view.cc

   1 /*
   2     Copyright (C) 2003 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18     $Id$
  19 */
  20
  21 #include <algorithm>
  22
  23 #include <gtkmm.h>
  24 #include <gtkmm2ext/gtk_ui.h>
  25
  26 #include "marker_time_axis_view.h"
  27 #include "marker_time_axis.h"
  28 #include "marker_view.h"
  29 #include "imageframe_view.h"
  30 #include "imageframe_time_axis.h"
  31 #include "canvas-simplerect.h"
  32 #include "public_editor.h"
  33 #include "rgb_macros.h"
  34 #include "gui_thread.h"
  35
  36 #include "i18n.h"
  37
  38 using namespace ARDOUR ;
  39 using namespace Editing;
  40
  41 //---------------------------------------------------------------------------------------//
  42 // Constructor / Desctructor
  43
  44 /**
  45  * Construct a new MarkerTimeAxisView helper time axis helper
  46  *
  47  * @param mta the TimeAxsiView that this objbect is the helper for
  48  */
  49 MarkerTimeAxisView::MarkerTimeAxisView(MarkerTimeAxis& tv)
  50         : _trackview (tv)
  51 {
  52         region_color = _trackview.color();
  53         stream_base_color = color_map[cMarkerTrackBase];
  54
  55         //GTK2FIX -- how to get the group? is the canvas display really a group?
  56         //canvas_group = gnome_canvas_item_new (GNOME_CANVAS_GROUP(_trackview.canvas_display), gnome_canvas_group_get_type (), 0);
  57         canvas_group = new ArdourCanvas::Group (*_trackview.canvas_display);
  58
  59         canvas_rect =  new ArdourCanvas::SimpleRect (*canvas_group);
  60         canvas_rect->property_x1() = 0.0;
  61         canvas_rect->property_y1() = 0.0;
  62         canvas_rect->property_x2() = 1000000.0;
  63         canvas_rect->property_y2() = (double)20;
  64         canvas_rect->property_outline_color_rgba() = color_map[cMarkerTrackOutline];
  65         canvas_rect->property_fill_color_rgba() = stream_base_color;
  66
  67         canvas_rect->signal_event().connect (bind (mem_fun (_trackview.editor, &PublicEditor::canvas_marker_time_axis_view_event), canvas_rect, &_trackview));
  68
  69         _samples_per_unit = _trackview.editor.get_current_zoom() ;
  70
  71         _trackview.editor.ZoomChanged.connect (mem_fun(*this, &MarkerTimeAxisView::reset_samples_per_unit));
  72 }
  73
  74 /**
  75  * Destructor
  76  * Reposinsibly for destroying all marker items that may have been added to this time axis view
  77  *
  78  */
  79 MarkerTimeAxisView::~MarkerTimeAxisView()
  80 {
  81         // destroy everything upon this view
  82         for(MarkerViewList::iterator iter = marker_view_list.begin(); iter != marker_view_list.end(); ++iter)
  83         {
  84                 MarkerView* mv = (*iter) ;
  85
  86                 MarkerViewList::iterator next = iter ;
  87                 next++ ;
  88                 marker_view_list.erase(iter) ;
  89
  90                 delete mv ;
  91                 mv = 0 ;
  92
  93                 iter = next ;
  94         }
  95
  96         if(canvas_rect)
  97         {
  98                 gtk_object_destroy(GTK_OBJECT(canvas_rect)) ;
  99                 canvas_rect = 0 ;
 100         }
 101
 102         if(canvas_group)
 103         {
 104                 gtk_object_destroy(GTK_OBJECT(canvas_group)) ;
 105                 canvas_group = 0 ;
 106         }
 107 }
 108
 109
 110 //---------------------------------------------------------------------------------------//
 111 // ui methods & data
 112
 113 /**
 114  * Sets the height of the time axis view and the item upon it
 115  *
 116  * @param height the new height
 117  */
 118 int
 119 MarkerTimeAxisView::set_height(gdouble h)
 120 {
 121         if (h < 10.0 || h > 1000.0)
 122         {
 123                 return -1 ;
 124         }
 125
 126         gtk_object_set (GTK_OBJECT(canvas_rect), "y2", h, NULL);
 127
 128         for (MarkerViewList::iterator i = marker_view_list.begin(); i != marker_view_list.end(); ++i)
 129         {
 130                 (*i)->set_height(h) ;
 131         }
 132
 133         return 0;
 134 }
 135
 136 /**
 137  * Sets the position of this view helper on the canvas
 138  *
 139  * @param x the x position upon the canvas
 140  * @param y the y position upon the canvas
 141  */
 142 int
 143 MarkerTimeAxisView::set_position(gdouble x, gdouble y)
 144 {
 145         canvas_group->property_x() = x;
 146         canvas_group->property_y() = y;
 147         return 0;
 148 }
 149
 150 /**
 151  * Sets the current samples per unit.
 152  * this method tells each item upon the time axis of the change
 153  *
 154  * @param spu the new samples per canvas unit value
 155  */
 156 int
 157 MarkerTimeAxisView::set_samples_per_unit(gdouble spp)
 158 {
 159         if(spp < 1.0) {
 160                 return -1 ;
 161         }
 162
 163         _samples_per_unit = spp ;
 164
 165         for(MarkerViewList::iterator i = marker_view_list.begin(); i != marker_view_list.end(); ++i)
 166         {
 167                 (*i)->set_samples_per_unit(spp) ;
 168         }
 169         return(0) ;
 170 }
 171
 172 /**
 173  * Sets the color of the items contained upon this view helper
 174  *
 175  * @param color the new base color
 176  */
 177 void
 178 MarkerTimeAxisView::apply_color(Gdk::Color& color)
 179 {
 180         region_color = color;
 181
 182         for (MarkerViewList::iterator i = marker_view_list.begin(); i != marker_view_list.end(); i++)
 183         {
 184                 (*i)->set_color (region_color) ;
 185         }
 186 }
 187
 188
 189 //---------------------------------------------------------------------------------------//
 190 // Child MarkerView Accessors/Mutators
 191
 192 /**
 193  * Adds a marker view to the list of items upon this time axis view helper
 194  * the new MarkerView is returned
 195  *
 196  * @param ifv the ImageFrameView that the new item is marking up
 197  * @param mark_text the text to be displayed uopn the new marker item
 198  * @param mark_id the unique id of the new item
 199  * @param start the position the new item should be placed upon the time line
 200  * @param duration the duration the new item should be placed upon the timeline
 201  * @param src the identity of the object that initiated the change
 202  */
 203 MarkerView*
 204 MarkerTimeAxisView::add_marker_view(ImageFrameView* ifv, std::string mark_type, std::string mark_id, jack_nframes_t start, jack_nframes_t dur, void* src)
 205 {
 206         if(ifv->has_marker_view_item(mark_id))
 207         {
 208                 return(0) ;
 209         }
 210
 211         MarkerView* mv = new MarkerView(canvas_group,
 212                  &_trackview,
 213                  ifv,
 214                  _trackview.editor.get_current_zoom(),
 215                  region_color,
 216                  mark_type,
 217                  mark_id,
 218                  start,
 219                  dur) ;
 220
 221         ifv->add_marker_view_item(mv, src) ;
 222         marker_view_list.push_front(mv) ;
 223
 224         mv->GoingAway.connect(bind (mem_fun(*this,&MarkerTimeAxisView::remove_marker_view), (void*)this)) ;
 225
 226          MarkerViewAdded(mv,src) ; /* EMIT_SIGNAL */
 227
 228         return(mv) ;
 229 }
 230
 231 /**
 232  * Returns the named MarkerView or 0 if the named marker does not exist
 233  *
 234  * @param item_id the unique id of the item to search for
 235  * @return the named MarkerView, or 0 if it is not held upon this view
 236  */
 237 MarkerView*
 238 MarkerTimeAxisView::get_named_marker_view(std::string item_id)
 239 {
 240         MarkerView* mv =  0 ;
 241
 242         for(MarkerViewList::iterator i = marker_view_list.begin(); i != marker_view_list.end(); ++i)
 243         {
 244                 if(((MarkerView*)*i)->get_item_name() == item_id)
 245                 {
 246                         mv = ((MarkerView*)*i) ;
 247                         break ;
 248                 }
 249         }
 250         return(mv) ;
 251 }
 252
 253 /**
 254  * Removes the currently selected MarverView
 255  * Note that this method actually destroys the MarkerView too.
 256  * We assume that since we own the object, we are allowed to do this
 257  *
 258  * @param src the identity of the object that initiated the change
 259  * @see add_marker_view
 260  */
 261 void
 262 MarkerTimeAxisView::remove_selected_marker_view(void* src)
 263 {
 264         std::string removed ;
 265
 266         if (selected_time_axis_item)
 267         {
 268                 MarkerViewList::iterator i ;
 269                 if((i = find (marker_view_list.begin(), marker_view_list.end(), selected_time_axis_item)) != marker_view_list.end())
 270                 {
 271                         marker_view_list.erase(i) ;
 272
 273                          MarkerViewRemoved(selected_time_axis_item->get_item_name(),src) ; /* EMIT_SIGNAL */
 274
 275                         delete(selected_time_axis_item) ;
 276                         selected_time_axis_item = 0 ;
 277                 }
 278         }
 279         else
 280         {
 281                 //No selected marker view
 282         }
 283 }
 284
 285 /**
 286  * Removes and returns the named MarkerView from the list of MarkerView held by this view helper
 287  *
 288  * @param item_id the MarkerView unique id to remove
 289  * @param src the identity of the object that initiated the change
 290  * @see add_marker_view
 291  */
 292 MarkerView*
 293 MarkerTimeAxisView::remove_named_marker_view(std::string item_id, void* src)
 294 {
 295         MarkerView* mv = 0 ;
 296
 297         MarkerViewList::iterator i = marker_view_list.begin() ;
 298
 299         for(MarkerViewList::iterator iter = marker_view_list.begin(); iter != marker_view_list.end(); ++iter)
 300         {
 301                 if(((MarkerView*)*i)->get_item_name() == item_id)
 302                 {
 303                         mv = ((MarkerView*)*i) ;
 304                         marker_view_list.erase(i) ;
 305
 306                          MarkerViewRemoved(mv->get_item_name(), src) ; /* EMIT_SIGNAL */
 307
 308                         // break from the for loop
 309                         break;
 310                 }
 311                 i++ ;
 312         }
 313
 314         return(mv) ;
 315 }
 316
 317 /**
 318  * Removes mv from the list of MarkerView upon this TimeAxis
 319  *
 320  * @param mv the MarkerView to remove
 321  * @param src the identity of the object that initiated the change
 322  */
 323 void
 324 MarkerTimeAxisView::remove_marker_view(MarkerView* mv, void* src)
 325 {
 326         ENSURE_GUI_THREAD(bind (mem_fun(*this, &MarkerTimeAxisView::remove_marker_view), mv, src));
 327
 328         MarkerViewList::iterator i;
 329
 330         if((i = find (marker_view_list.begin(), marker_view_list.end(), mv)) != marker_view_list.end()) {
 331                 marker_view_list.erase(i) ;
 332
 333                 // Assume this remove happened locally, else use remove_named_marker_time_axis
 334                 // let listeners know that the named MarkerTimeAxis has been removed
 335                  MarkerViewRemoved(mv->get_item_name(), src) ; /* EMIT_SIGNAL */
 336         }
 337 }
 338
 339
 340 /**
 341  * Sets the duration of the selected MarkerView to the specified number of seconds
 342  *
 343  * @param sec the duration to set the MArkerView to, in seconds
 344  */
 345 void
 346 MarkerTimeAxisView::set_marker_duration_sec(double sec)
 347 {
 348   if(get_selected_time_axis_item() != 0)
 349   {
 350           get_selected_time_axis_item()->set_duration((jack_nframes_t) (sec * _trackview.editor.current_session()->frame_rate()), this) ;
 351   }
 352 }
 353
 354
 355 //---------------------------------------------------------------------------------------//
 356 // Selected item methods
 357
 358 /**
 359  * Sets the currently selected item upon this time axis
 360  *
 361  * @param mv the item to set selected
 362  */
 363 void
 364 MarkerTimeAxisView::set_selected_time_axis_item(MarkerView* mv)
 365 {
 366         selected_time_axis_item = mv ;
 367 }
 368
 369 /**
 370  * Clears any selected item upon this time axis
 371  *
 372  */
 373 void
 374 MarkerTimeAxisView::clear_selected_time_axis_item()
 375 {
 376         selected_time_axis_item = 0 ;
 377 }
 378
 379 /**
 380  * Returnsthe currently selected item upon this time axis
 381  *
 382  * @return the currently selected item pon this time axis
 383  */
 384 MarkerView*
 385 MarkerTimeAxisView::get_selected_time_axis_item()
 386 {
 387         return(selected_time_axis_item) ;
 388 }
 389
 390
 391
 392
 393 /**
 394  * convenience method to re-get the samples per unit and tell items upon this view
 395  *
 396  */
 397 void
 398 MarkerTimeAxisView::reset_samples_per_unit ()
 399 {
 400         set_samples_per_unit(_trackview.editor.get_current_zoom()) ;
 401 }