libs/ardour/session_export.cc

   1 /*
   2     Copyright (C) 1999-2008 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
  21 #include "pbd/error.h"
  22 #include <glibmm/threads.h>
  23
  24 #include <midi++/manager.h>
  25 #include <midi++/mmc.h>
  26
  27 #include "ardour/audioengine.h"
  28 #include "ardour/butler.h"
  29 #include "ardour/export_handler.h"
  30 #include "ardour/export_status.h"
  31 #include "ardour/process_thread.h"
  32 #include "ardour/session.h"
  33 #include "ardour/track.h"
  34
  35 #include "i18n.h"
  36
  37 using namespace std;
  38 using namespace ARDOUR;
  39 using namespace PBD;
  40
  41 boost::shared_ptr<ExportHandler>
  42 Session::get_export_handler ()
  43 {
  44         if (!export_handler) {
  45                 export_handler.reset (new ExportHandler (*this));
  46         }
  47
  48         return export_handler;
  49 }
  50
  51 boost::shared_ptr<ExportStatus>
  52 Session::get_export_status ()
  53 {
  54         if (!export_status) {
  55                 export_status.reset (new ExportStatus ());
  56         }
  57
  58         return export_status;
  59 }
  60
  61
  62 int
  63 Session::pre_export ()
  64 {
  65         get_export_status (); // Init export_status
  66
  67         /* take everyone out of awrite to avoid disasters */
  68
  69         {
  70                 boost::shared_ptr<RouteList> r = routes.reader ();
  71
  72                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
  73                         (*i)->protect_automation ();
  74                 }
  75         }
  76
  77         /* make sure we are actually rolling */
  78
  79         if (get_record_enabled()) {
  80                 disable_record (false);
  81         }
  82
  83         /* no slaving */
  84
  85         post_export_sync = config.get_external_sync ();
  86         post_export_position = _transport_frame;
  87
  88         config.set_external_sync (false);
  89
  90         _exporting = true;
  91         export_status->running = true;
  92         export_status->Finished.connect_same_thread (*this, boost::bind (&Session::finalize_audio_export, this));
  93
  94         /* disable MMC output early */
  95
  96         _pre_export_mmc_enabled = MIDI::Manager::instance()->mmc()->send_enabled ();
  97         MIDI::Manager::instance()->mmc()->enable_send (false);
  98
  99         return 0;
 100 }
 101
 102 /** Called for each range that is being exported */
 103 int
 104 Session::start_audio_export (framepos_t position)
 105 {
 106         if (!_exporting) {
 107                 pre_export ();
 108                 _export_started = false;
 109         }
 110
 111         /* We're about to call Track::seek, so the butler must have finished everything
 112            up otherwise it could be doing do_refill in its thread while we are doing
 113            it here.
 114         */
 115
 116         _butler->wait_until_finished ();
 117
 118         /* get everyone to the right position */
 119
 120         {
 121                 boost::shared_ptr<RouteList> rl = routes.reader();
 122
 123                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 124                         boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 125                         if (tr && tr->seek (position, true)) {
 126                                 error << string_compose (_("%1: cannot seek to %2 for export"),
 127                                                   (*i)->name(), position)
 128                                       << endmsg;
 129                                 return -1;
 130                         }
 131                 }
 132         }
 133
 134         /* we just did the core part of a locate() call above, but
 135            for the sake of any GUI, put the _transport_frame in
 136            the right place too.
 137         */
 138
 139         _transport_frame = position;
 140         export_status->stop = false;
 141
 142         /* get transport ready. note how this is calling butler functions
 143            from a non-butler thread. we waited for the butler to stop
 144            what it was doing earlier in Session::pre_export() and nothing
 145            since then has re-awakened it.
 146          */
 147
 148         /* we are ready to go ... */
 149
 150         if (!_engine.connected()) {
 151                 return -1;
 152         }
 153
 154         _engine.Freewheel.connect_same_thread (export_freewheel_connection, boost::bind (&Session::process_export_fw, this, _1));
 155         _export_rolling = true;
 156         return _engine.freewheel (true);
 157 }
 158
 159 int
 160 Session::process_export (pframes_t nframes)
 161 {
 162         if (_export_rolling && export_status->stop) {
 163                 stop_audio_export ();
 164         }
 165
 166         if (_export_rolling) {
 167                 /* make sure we've caught up with disk i/o, since
 168                 we're running faster than realtime c/o JACK.
 169                 */
 170                 _butler->wait_until_finished ();
 171
 172                 /* do the usual stuff */
 173
 174                 process_without_events (nframes);
 175         }
 176
 177         try {
 178                 /* handle export - XXX what about error handling? */
 179
 180                 ProcessExport (nframes);
 181
 182         } catch (std::exception & e) {
 183                 error << string_compose (_("Export ended unexpectedly: %1"), e.what()) << endmsg;
 184                 export_status->abort (true);
 185                 return -1;
 186         }
 187
 188         return 0;
 189 }
 190
 191 int
 192 Session::process_export_fw (pframes_t nframes)
 193 {
 194         if (!_export_started) {
 195                 _export_started = true;
 196                 set_transport_speed (1.0, false);
 197                 butler_transport_work ();
 198                 g_atomic_int_set (&_butler->should_do_transport_work, 0);
 199                 post_transport ();
 200                 return 0;
 201         }
 202
 203         _engine.main_thread()->get_buffers ();
 204         process_export (nframes);
 205         _engine.main_thread()->drop_buffers ();
 206
 207         return 0;
 208 }
 209
 210 int
 211 Session::stop_audio_export ()
 212 {
 213         /* can't use stop_transport() here because we need
 214            an immediate halt and don't require all the declick
 215            stuff that stop_transport() implements.
 216         */
 217
 218         realtime_stop (true, true);
 219         _export_rolling = false;
 220         _butler->schedule_transport_work ();
 221
 222         return 0;
 223 }
 224
 225 void
 226 Session::finalize_audio_export ()
 227 {
 228         _exporting = false;
 229
 230         if (_export_rolling) {
 231                 stop_audio_export ();
 232         }
 233
 234         /* Clean up */
 235
 236         _engine.freewheel (false);
 237
 238         export_freewheel_connection.disconnect();
 239
 240         MIDI::Manager::instance()->mmc()->enable_send (_pre_export_mmc_enabled);
 241
 242         /* maybe write CUE/TOC */
 243
 244         export_handler.reset();
 245         export_status.reset();
 246
 247         /* restart slaving */
 248
 249         if (post_export_sync) {
 250                 config.set_external_sync (true);
 251         } else {
 252                 locate (post_export_position, false, false, false, false, false);
 253         }
 254 }