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