libs/ardour/automation_watch.cc

   1 /*
   2     Copyright (C) 2012 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 <iostream>
  21
  22 #include <glibmm/timer.h>
  23
  24 #include "pbd/compose.h"
  25
  26 #include "ardour/automation_control.h"
  27 #include "ardour/automation_watch.h"
  28 #include "ardour/debug.h"
  29 #include "ardour/session.h"
  30
  31 using namespace ARDOUR;
  32 using namespace PBD;
  33
  34 AutomationWatch* AutomationWatch::_instance = 0;
  35
  36 AutomationWatch&
  37 AutomationWatch::instance ()
  38 {
  39         if (_instance == 0) {
  40                 _instance = new AutomationWatch;
  41         }
  42         return *_instance;
  43 }
  44
  45 AutomationWatch::AutomationWatch ()
  46         : _thread (0)
  47         , _run_thread (false)
  48 {
  49
  50 }
  51
  52 AutomationWatch::~AutomationWatch ()
  53 {
  54         if (_thread) {
  55                 _run_thread = false;
  56                 _thread->join ();
  57                 _thread = 0;
  58         }
  59
  60         Glib::Threads::Mutex::Lock lm (automation_watch_lock);
  61         automation_watches.clear ();
  62 }
  63
  64 void
  65 AutomationWatch::add_automation_watch (boost::shared_ptr<AutomationControl> ac)
  66 {
  67         Glib::Threads::Mutex::Lock lm (automation_watch_lock);
  68         DEBUG_TRACE (DEBUG::Automation, string_compose ("now watching control %1 for automation, astate = %2\n", ac->name(), enum_2_string (ac->automation_state())));
  69         automation_watches.insert (ac);
  70
  71         /* if an automation control is added here while the transport is
  72          * rolling, make sure that it knows that there is a write pass going
  73          * on, rather than waiting for the transport to start.
  74          */
  75
  76         if (_session && _session->transport_rolling() && ac->alist()->automation_write()) {
  77                 DEBUG_TRACE (DEBUG::Automation, string_compose ("\ttransport is rolling @ %1, audible = %2so enter write pass\n",
  78                                                                 _session->transport_speed(), _session->audible_frame()));
  79                 /* add a guard point since we are already moving */
  80                 ac->list()->set_in_write_pass (true, true, _session->audible_frame());
  81         }
  82
  83         /* we can't store shared_ptr<Destructible> in connections because it
  84          * creates reference cycles. we don't need to make the weak_ptr<>
  85          * explicit here, but it helps to remind us what is going on.
  86          */
  87
  88         boost::weak_ptr<AutomationControl> wac (ac);
  89         ac->DropReferences.connect_same_thread (*this, boost::bind (&AutomationWatch::remove_weak_automation_watch, this, wac));
  90 }
  91
  92 void
  93 AutomationWatch::remove_weak_automation_watch (boost::weak_ptr<AutomationControl> wac)
  94 {
  95         boost::shared_ptr<AutomationControl> ac = wac.lock();
  96
  97         if (!ac) {
  98                 return;
  99         }
 100
 101         remove_automation_watch (ac);
 102 }
 103
 104 void
 105 AutomationWatch::remove_automation_watch (boost::shared_ptr<AutomationControl> ac)
 106 {
 107         Glib::Threads::Mutex::Lock lm (automation_watch_lock);
 108         DEBUG_TRACE (DEBUG::Automation, string_compose ("remove control %1 from automation watch\n", ac->name()));
 109         automation_watches.erase (ac);
 110         ac->list()->set_in_write_pass (false);
 111 }
 112
 113 gint
 114 AutomationWatch::timer ()
 115 {
 116         if (!_session || !_session->transport_rolling()) {
 117                 return TRUE;
 118         }
 119
 120         {
 121                 Glib::Threads::Mutex::Lock lm (automation_watch_lock);
 122
 123                 framepos_t time = _session->audible_frame ();
 124
 125                 for (AutomationWatches::iterator aw = automation_watches.begin(); aw != automation_watches.end(); ++aw) {
 126                         if ((*aw)->alist()->automation_write()) {
 127                                 (*aw)->list()->add (time, (*aw)->user_double(), true);
 128                         }
 129                 }
 130         }
 131
 132         return TRUE;
 133 }
 134
 135 void
 136 AutomationWatch::thread ()
 137 {
 138         while (_run_thread) {
 139                 Glib::usleep ((gulong) floor (Config->get_automation_interval_msecs() * 1000));
 140                 timer ();
 141         }
 142 }
 143
 144 void
 145 AutomationWatch::set_session (Session* s)
 146 {
 147         transport_connection.disconnect ();
 148
 149         if (_thread) {
 150                 _run_thread = false;
 151                 _thread->join ();
 152                 _thread = 0;
 153         }
 154
 155         SessionHandlePtr::set_session (s);
 156
 157         if (_session) {
 158                 _run_thread = true;
 159                 _thread = Glib::Threads::Thread::create (boost::bind (&AutomationWatch::thread, this));
 160
 161                 _session->TransportStateChange.connect_same_thread (transport_connection, boost::bind (&AutomationWatch::transport_state_change, this));
 162         }
 163 }
 164
 165 void
 166 AutomationWatch::transport_state_change ()
 167 {
 168         if (!_session) {
 169                 return;
 170         }
 171
 172         bool rolling = _session->transport_rolling();
 173
 174         {
 175                 Glib::Threads::Mutex::Lock lm (automation_watch_lock);
 176
 177                 for (AutomationWatches::iterator aw = automation_watches.begin(); aw != automation_watches.end(); ++aw) {
 178                         DEBUG_TRACE (DEBUG::Automation, string_compose ("%1: transport state changed, speed %2, in write pass ? %3 writing ? %4\n",
 179                                                                         (*aw)->name(), _session->transport_speed(), rolling,
 180                                                                         (*aw)->alist()->automation_write()));
 181                         if (rolling && (*aw)->alist()->automation_write()) {
 182                                 (*aw)->list()->set_in_write_pass (true);
 183                         } else {
 184                                 (*aw)->list()->set_in_write_pass (false);
 185                         }
 186                 }
 187         }
 188 }