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/thread.h>
  23
  24 #include "ardour/audio_diskstream.h"
  25 #include "ardour/audioengine.h"
  26 #include "ardour/butler.h"
  27 #include "ardour/export_failed.h"
  28 #include "ardour/export_handler.h"
  29 #include "ardour/export_status.h"
  30 #include "ardour/route.h"
  31 #include "ardour/session.h"
  32
  33 #include "i18n.h"
  34
  35 using namespace std;
  36 using namespace ARDOUR;
  37 using namespace PBD;
  38
  39 boost::shared_ptr<ExportHandler>
  40 Session::get_export_handler ()
  41 {
  42         if (!export_handler) {
  43                 export_handler.reset (new ExportHandler (*this));
  44         }
  45
  46         return export_handler;
  47 }
  48
  49 boost::shared_ptr<ExportStatus>
  50 Session::get_export_status ()
  51 {
  52         if (!export_status) {
  53                 export_status.reset (new ExportStatus ());
  54         }
  55
  56         return export_status;
  57 }
  58
  59
  60 int
  61 Session::pre_export ()
  62 {
  63         get_export_status (); // Init export_status
  64
  65         _butler->wait_until_finished ();
  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->Aborting.connect_same_thread (*this, boost::bind (&Session::stop_audio_export, this));
  93         export_status->Finished.connect_same_thread (*this, boost::bind (&Session::finalize_audio_export, this));
  94
  95         return 0;
  96 }
  97
  98 int
  99 Session::start_audio_export (nframes_t position, bool realtime)
 100 {
 101         if (!_exporting) {
 102                 pre_export ();
 103         }
 104
 105         /* get everyone to the right position */
 106
 107         {
 108                 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
 109
 110                 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
 111                         if ((*i)-> seek (position, true)) {
 112                                 error << string_compose (_("%1: cannot seek to %2 for export"),
 113                                                   (*i)->name(), position)
 114                                       << endmsg;
 115                                 return -1;
 116                         }
 117                 }
 118         }
 119
 120         /* we just did the core part of a locate() call above, but
 121            for the sake of any GUI, put the _transport_frame in
 122            the right place too.
 123         */
 124
 125         _transport_frame = position;
 126
 127         _exporting_realtime = realtime;
 128         export_status->stop = false;
 129
 130         /* get transport ready. note how this is calling butler functions
 131            from a non-butler thread. we waited for the butler to stop
 132            what it was doing earlier in Session::pre_export() and nothing
 133            since then has re-awakened it.
 134          */
 135
 136         set_transport_speed (1.0, false);
 137         butler_transport_work ();
 138         g_atomic_int_set (&_butler->should_do_transport_work, 0);
 139         post_transport ();
 140
 141         /* we are ready to go ... */
 142
 143         if (!_engine.connected()) {
 144                 return -1;
 145         }
 146
 147         if (realtime) {
 148                 last_process_function = process_function;
 149                 process_function = &Session::process_export;
 150         } else {
 151                 _engine.Freewheel.connect_same_thread (export_freewheel_connection, boost::bind (&Session::process_export_fw, this, _1));
 152                 return _engine.freewheel (true);
 153         }
 154
 155         return 0;
 156 }
 157
 158 void
 159 Session::process_export (nframes_t nframes)
 160 {
 161         try {
 162
 163                 if (export_status->stop) {
 164                         stop_audio_export ();
 165                         return;
 166                 }
 167
 168                 if (!_exporting_realtime) {
 169                         /* make sure we've caught up with disk i/o, since
 170                         we're running faster than realtime c/o JACK.
 171                         */
 172
 173                         _butler->wait_until_finished ();
 174                 }
 175
 176                 /* do the usual stuff */
 177
 178                 process_without_events (nframes);
 179
 180                 /* handle export - XXX what about error handling? */
 181
 182                 ProcessExport (nframes);
 183
 184         } catch (std::exception & e) {
 185                 std::cout << e.what() << std::endl;
 186                 export_status->abort (true);
 187         }
 188 }
 189
 190 int
 191 Session::process_export_fw (nframes_t nframes)
 192 {
 193         process_export (nframes);
 194         return 0;
 195 }
 196
 197 int
 198 Session::stop_audio_export ()
 199 {
 200         if (_exporting_realtime) {
 201                 process_function = last_process_function;
 202         } else {
 203                 export_freewheel_connection.disconnect();
 204         }
 205
 206         /* can't use stop_transport() here because we need
 207            an immediate halt and don't require all the declick
 208            stuff that stop_transport() implements.
 209         */
 210
 211         realtime_stop (true, true);
 212         _butler->schedule_transport_work ();
 213
 214         if (!export_status->aborted()) {
 215                 ExportReadFinished ();
 216         } else {
 217                 finalize_audio_export ();
 218         }
 219
 220         return 0;
 221
 222 }
 223
 224 void
 225 Session::finalize_audio_export ()
 226 {
 227         _exporting = false;
 228         export_status->running = false;
 229
 230         if (!_exporting_realtime) {
 231                 _engine.freewheel (false);
 232                 _exporting_realtime = false;
 233         }
 234
 235         /* Clean up */
 236
 237         /* BOOST SIGNAL are these necessary?
 238            ProcessExport.clear();
 239            ExportReadFinished.clear();
 240         */
 241
 242         export_freewheel_connection.disconnect();
 243         export_handler.reset();
 244         export_status.reset();
 245
 246         /* restart slaving */
 247
 248         if (post_export_sync) {
 249                 config.set_external_sync (true);
 250         } else {
 251                 locate (post_export_position, false, false, false);
 252         }
 253 }