gtk2_ardour/imageframe_time_axis.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 */
  19
  20 #include <string>
  21 #include <algorithm>
  22
  23 #include "pbd/error.h"
  24
  25 #include <gtkmm/menu.h>
  26
  27 #include <gtkmm2ext/utils.h>
  28 #include <gtkmm2ext/gtk_ui.h>
  29
  30 #include "ardour/session.h"
  31 #include "ardour/utils.h"
  32
  33 #include "public_editor.h"
  34 #include "imageframe_time_axis.h"
  35 #include "simplerect.h"
  36 #include "enums.h"
  37 #include "imageframe_time_axis_view.h"
  38 #include "imageframe_time_axis_group.h"
  39 #include "marker_time_axis_view.h"
  40 #include "imageframe_view.h"
  41 #include "marker_time_axis.h"
  42 #include "marker_view.h"
  43 #include "gui_thread.h"
  44 #include "canvas_impl.h"
  45
  46 #include "i18n.h"
  47
  48 using namespace ARDOUR;
  49 using namespace PBD;
  50 using namespace Gtk;
  51
  52 /**
  53  * Constructs a new ImageFrameTimeAxis.
  54  *
  55  * @param track_id the track name/id
  56  * @param ed the PublicEditor
  57  * @param sess the current session
  58  * @param canvas the parent canvas item
  59  */
  60 ImageFrameTimeAxis::ImageFrameTimeAxis(const string & track_id, PublicEditor& ed, ARDOUR::Session* sess, ArdourCanvas::Canvas& canvas)
  61         : AxisView(sess),
  62           VisualTimeAxis(track_id, ed, sess, canvas)
  63 {
  64         _color = unique_random_color() ;
  65
  66         selection_group = new ArdourCanvas::Group (*canvas_display);
  67         selection_group->hide();
  68
  69         // intialize our data items
  70         y_position = -1 ;
  71
  72         /* create our new image frame view */
  73         view = new ImageFrameTimeAxisView(*this) ;
  74
  75         /* create the Image Frame Edit Menu */
  76         create_imageframe_menu() ;
  77
  78         // set the initial time axis text label
  79         label_view() ;
  80
  81         // set the initial height of this time axis
  82         set_height(hNormal) ;
  83
  84         TimeAxisView::CatchDeletion.connect (*this, boost::bind (&ImageFrameTimeAxis::remove_time_axis_view, this, _1), gui_context());
  85 }
  86
  87 /**
  88  * Destructor
  89  * Responsible for destroying any child image items that may have been added to thie time axis
  90  */
  91 ImageFrameTimeAxis::~ImageFrameTimeAxis ()
  92 {
  93         CatchDeletion (this);
  94
  95         // Destroy all the marker views we may have associaited with this TimeAxis
  96         for(MarkerTimeAxisList::iterator iter = marker_time_axis_list.begin(); iter != marker_time_axis_list.end(); ++iter)
  97         {
  98                 MarkerTimeAxis* mta = *iter ;
  99                 MarkerTimeAxisList::iterator next = iter ;
 100                 next++ ;
 101
 102                 marker_time_axis_list.erase(iter) ;
 103
 104                 delete mta ;
 105                 mta = 0 ;
 106
 107                 iter = next ;
 108         }
 109
 110         delete image_action_menu ;
 111         image_action_menu = 0 ;
 112
 113         delete selection_group;
 114         selection_group = 0 ;
 115
 116         // Destroy our Axis View helper
 117         delete view ;
 118         view = 0 ;
 119 }
 120
 121 //---------------------------------------------------------------------------------------//
 122 // ui methods & data
 123
 124 /**
 125  * Sets the height of this TrackView to one of ths TrackHeghts
 126  *
 127  * @param h
 128  */
 129 void
 130 ImageFrameTimeAxis::set_height (uint32_t h)
 131 {
 132         VisualTimeAxis::set_height(h) ;
 133
 134         // tell out view helper of the change too
 135         if(view != 0)
 136         {
 137                 view->set_height((double) height) ;
 138         }
 139
 140         // tell those interested that we have had our height changed
 141         gui_changed("track_height",(void*)0); /* EMIT_SIGNAL */
 142 }
 143
 144 /**
 145  * Sets the number of samples per unit that are used.
 146  * This is used to determine the siezes of items upon this time axis
 147  *
 148  * @param spu the number of samples per unit
 149  */
 150 void
 151 ImageFrameTimeAxis::set_samples_per_unit(double spu)
 152 {
 153         TimeAxisView::set_samples_per_unit (editor.get_current_zoom());
 154
 155         if(view) {
 156                 view->set_samples_per_unit(spu) ;
 157         }
 158 }
 159
 160
 161 /**
 162  * Returns the available height for images to be drawn onto
 163  *
 164  * @return the available height for an image item to be drawn onto
 165  */
 166 int
 167 ImageFrameTimeAxis::get_image_display_height()
 168 {
 169         return(height - (gint)TimeAxisViewItem::NAME_HIGHLIGHT_SIZE) ;
 170 }
 171
 172
 173 /**
 174  * Show the popup edit menu
 175  *
 176  * @param button the mouse button pressed
 177  * @param time when to show the popup
 178  * @param clicked_imageframe the ImageFrameItem that the event ocured upon, or 0 if none
 179  * @param with_item true if an item has been selected upon the time axis, used to set context menu
 180  */
 181 void
 182 ImageFrameTimeAxis::popup_imageframe_edit_menu(int button, int32_t time, ImageFrameView* clicked_imageframe, bool with_item)
 183 {
 184         if (!imageframe_menu)
 185         {
 186                 create_imageframe_menu() ;
 187         }
 188
 189         if(with_item)
 190         {
 191                 imageframe_item_menu->set_sensitive(true) ;
 192         }
 193         else
 194         {
 195                 imageframe_item_menu->set_sensitive(false) ;
 196         }
 197
 198         imageframe_menu->popup(button,time) ;
 199 }
 200
 201 /**
 202  * convenience method to select a new track color and apply it to the view and view items
 203  *
 204  */
 205 void
 206 ImageFrameTimeAxis::select_track_color()
 207 {
 208         if (choose_time_axis_color())
 209         {
 210                 if (view)
 211                 {
 212                         view->apply_color (_color) ;
 213                 }
 214         }
 215 }
 216
 217 /**
 218  * Handles the building of the popup menu
 219  */
 220 void
 221 ImageFrameTimeAxis::build_display_menu()
 222 {
 223         using namespace Menu_Helpers;
 224         using Gtk::Menu;
 225
 226         /* get the size menu ready */
 227
 228         build_size_menu();
 229
 230         /* prepare it */
 231
 232         TimeAxisView::build_display_menu () ;
 233
 234         /* now fill it with our stuff */
 235
 236         MenuList& items = display_menu->items();
 237
 238         items.push_back (MenuElem (_("Rename"), sigc::mem_fun(*this, &ImageFrameTimeAxis::start_time_axis_rename)));
 239
 240         image_action_menu = new Menu() ;
 241         image_action_menu->set_name ("ArdourContextMenu");
 242         MenuList image_items = image_action_menu->items() ;
 243
 244         items.push_back (SeparatorElem());
 245         items.push_back (MenuElem (_("Height"), *size_menu));
 246         items.push_back (MenuElem (_("Color"), sigc::mem_fun(*this, &ImageFrameTimeAxis::select_track_color)));
 247
 248         items.push_back (SeparatorElem());
 249         items.push_back (MenuElem (_("Remove"), sigc::bind(sigc::mem_fun(*this, &VisualTimeAxis::remove_this_time_axis), (void*)this))) ;
 250 }
 251
 252 /**
 253  * handles the building of the ImageFrameView sub menu
 254  */
 255 void
 256 ImageFrameTimeAxis::create_imageframe_menu()
 257 {
 258         using namespace Menu_Helpers;
 259         using Gtk::Menu;
 260
 261         imageframe_menu = manage(new Menu) ;
 262         imageframe_menu->set_name ("ArdourContextMenu");
 263         MenuList& items = imageframe_menu->items();
 264
 265         imageframe_item_menu = manage(new Menu) ;
 266         imageframe_item_menu->set_name ("ArdourContextMenu");
 267         MenuList& imageframe_sub_items = imageframe_item_menu->items() ;
 268
 269         /* duration menu */
 270         Menu* duration_menu = manage(new Menu) ;
 271         duration_menu->set_name ("ArdourContextMenu");
 272         MenuList& duration_items = duration_menu->items() ;
 273
 274         if(view)
 275         {
 276                 duration_items.push_back(MenuElem (_("0.5 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 0.5))) ;
 277                 duration_items.push_back(MenuElem (_("1 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 1.0))) ;
 278                 duration_items.push_back(MenuElem (_("1.5 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 1.5))) ;
 279                 duration_items.push_back(MenuElem (_("2 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 2.0))) ;
 280                 duration_items.push_back(MenuElem (_("2.5 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 2.5))) ;
 281                 duration_items.push_back(MenuElem (_("3 seconds"), sigc::bind (sigc::mem_fun (view, &ImageFrameTimeAxisView::set_imageframe_duration_sec), 3.0))) ;
 282                 //duration_items.push_back(SeparatorElem()) ;
 283                 //duration_items.push_back(MenuElem (_("custom"), sigc::mem_fun(*this, &ImageFrameTimeAxis::set_imageframe_duration_custom))) ;
 284         }
 285
 286         imageframe_sub_items.push_back(MenuElem(_("Duration (sec)"), *duration_menu)) ;
 287
 288         imageframe_sub_items.push_back(SeparatorElem()) ;
 289         if(view)
 290         {
 291                 imageframe_sub_items.push_back(MenuElem (_("Remove Frame"), sigc::bind(sigc::mem_fun (view, &ImageFrameTimeAxisView::remove_selected_imageframe_item), (void*)this))) ;
 292         }
 293
 294         items.push_back(MenuElem(_("Image Frame"), *imageframe_item_menu)) ;
 295         items.push_back(MenuElem (_("Rename Track"), sigc::mem_fun(*this,&ImageFrameTimeAxis::start_time_axis_rename))) ;
 296
 297         imageframe_menu->show_all() ;
 298 }
 299
 300
 301
 302
 303 //---------------------------------------------------------------------------------------//
 304 // Marker Time Axis Methods
 305
 306 /**
 307  * Add a MarkerTimeAxis to the ilst of MarkerTimeAxis' associated with this ImageFrameTimeAxis
 308  *
 309  * @param marker_track the MarkerTimeAxis to add
 310  * @param src the identity of the object that initiated the change
 311  * @return true if the addition was a success,
 312  *         false otherwise
 313  */
 314 bool
 315 ImageFrameTimeAxis::add_marker_time_axis(MarkerTimeAxis* marker_track, void* src)
 316 {
 317         bool ret = false ;
 318
 319         if(get_named_marker_time_axis(marker_track->name()) != 0)
 320         {
 321                 ret = false ;
 322         }
 323         else
 324         {
 325                 marker_time_axis_list.push_back(marker_track) ;
 326                  MarkerTimeAxisAdded(marker_track, src) ; /* EMIT_SIGNAL */
 327                 ret = true ;
 328         }
 329
 330         return(ret) ;
 331 }
 332
 333 /**
 334  * Returns the named MarkerTimeAxis associated with this ImageFrameTimeAxis
 335  *
 336  * @param track_id the track_id of the MarkerTimeAxis to search for
 337  * @return the named markerTimeAxis, or 0 if the named MarkerTimeAxis is not associated with this ImageFrameTimeAxis
 338  */
 339 MarkerTimeAxis*
 340 ImageFrameTimeAxis::get_named_marker_time_axis(const string & track_id)
 341 {
 342         MarkerTimeAxis* mta =  0 ;
 343
 344         for (MarkerTimeAxisList::iterator i = marker_time_axis_list.begin(); i != marker_time_axis_list.end(); ++i)
 345         {
 346                 if (((MarkerTimeAxis*)*i)->name() == track_id)
 347                 {
 348                         mta = ((MarkerTimeAxis*)*i) ;
 349                         break ;
 350                 }
 351         }
 352         return(mta) ;
 353 }
 354
 355 /**
 356  * Removes the named markerTimeAxis from those associated with this ImageFrameTimeAxis
 357  *
 358  * @param track_id the track id of the MarkerTimeAxis to remove
 359  * @param src the identity of the object that initiated the change
 360  * @return the removed MarkerTimeAxis
 361  */
 362 MarkerTimeAxis*
 363 ImageFrameTimeAxis::remove_named_marker_time_axis(const string & track_id, void* src)
 364 {
 365         MarkerTimeAxis* mta = 0 ;
 366
 367         for(MarkerTimeAxisList::iterator i = marker_time_axis_list.begin(); i != marker_time_axis_list.end(); ++i)
 368         {
 369                 if (((MarkerTimeAxis*)*i)->name() == track_id)
 370                 {
 371                         mta = ((MarkerTimeAxis*)*i) ;
 372
 373                         // the iterator is invalid after this call, so we can no longer use it as is.
 374                         marker_time_axis_list.erase(i) ;
 375
 376                          MarkerTimeAxisRemoved(mta->name(), src) ; /* EMIT_SIGNAL */
 377                         break ;
 378                 }
 379         }
 380
 381         return(mta) ;
 382 }
 383
 384 /**
 385  * Removes the specified MarkerTimeAxis from the list of MarkerTimaAxis associated with this ImageFrameTimeAxis
 386  * Note that the MarkerTimeAxis is not deleted, only removed from the list os associated tracks
 387  *
 388  * @param mta the TimeAxis to remove
 389  * @param src the identity of the object that initiated the change
 390  */
 391 void
 392 ImageFrameTimeAxis::remove_time_axis_view (TimeAxisView* tav)
 393 {
 394         MarkerTimeAxisView* mtav = dynamic_cast<MarkerTimeAxisView*> (tav);
 395
 396         if (!mtav) {
 397                 return;
 398         }
 399
 400         MarkerTimeAxisList::iterator i;
 401
 402         if ((i = find (marker_time_axis_list.begin(), marker_time_axis_list.end(), mta)) != marker_time_axis_list.end())  {
 403                 // note that we dont delete the object itself, we just remove it from our list
 404                 marker_time_axis_list.erase(i) ;
 405                 MarkerTimeAxisRemoved (mta->name(), src) ; /* EMIT_SIGNAL */
 406         }
 407 }
 408
 409
 410 //---------------------------------------------------------------------------------------//
 411 // Parent/Child helper object accessors
 412
 413 /**
 414  * Returns the view helper of this TimeAxis
 415  *
 416  * @return the view helper of this TimeAxis
 417  */
 418 ImageFrameTimeAxisView*
 419 ImageFrameTimeAxis::get_view()
 420 {
 421         return(view) ;
 422 }