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 "pbd/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_sample;
  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 (samplepos_t position, bool realtime, bool region_export)
 108 {
 109         if (!_exporting) {
 110                 pre_export ();
 111         }
 112
 113         _realtime_export = realtime;
 114         _region_export = region_export;
 115
 116         if (region_export) {
 117                 _export_preroll = 0;
 118         }
 119         else if (realtime) {
 120                 _export_preroll = nominal_sample_rate ();
 121         } else {
 122                 _export_preroll = Config->get_export_preroll() * nominal_sample_rate ();
 123         }
 124
 125         if (_export_preroll == 0) {
 126                 // must be > 0 so that transport is started in sync.
 127                 _export_preroll = 1;
 128         }
 129
 130         /* We're about to call Track::seek, so the butler must have finished everything
 131            up otherwise it could be doing do_refill in its thread while we are doing
 132            it here.
 133         */
 134
 135         _butler->wait_until_finished ();
 136
 137         /* get everyone to the right position */
 138
 139         {
 140                 boost::shared_ptr<RouteList> rl = routes.reader();
 141
 142                 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
 143                         boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
 144                         if (tr && tr->seek (position, true)) {
 145                                 error << string_compose (_("%1: cannot seek to %2 for export"),
 146                                                   (*i)->name(), position)
 147                                       << endmsg;
 148                                 return -1;
 149                         }
 150                 }
 151         }
 152
 153         /* we just did the core part of a locate() call above, but
 154            for the sake of any GUI, put the _transport_sample in
 155            the right place too.
 156         */
 157
 158         _transport_sample = position;
 159
 160         if (!region_export) {
 161                 _remaining_latency_preroll = worst_latency_preroll ();
 162         } else {
 163                 _remaining_latency_preroll = 0;
 164         }
 165         export_status->stop = false;
 166
 167         /* get transport ready. note how this is calling butler functions
 168            from a non-butler thread. we waited for the butler to stop
 169            what it was doing earlier in Session::pre_export() and nothing
 170            since then has re-awakened it.
 171          */
 172
 173         /* we are ready to go ... */
 174
 175         if (!_engine.connected()) {
 176                 return -1;
 177         }
 178
 179         _engine.Freewheel.connect_same_thread (export_freewheel_connection, boost::bind (&Session::process_export_fw, this, _1));
 180
 181         if (_realtime_export) {
 182                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 183                 _export_rolling = true;
 184                 process_function = &Session::process_export_fw;
 185                 return 0;
 186         } else {
 187                 _export_rolling = true;
 188                 return _engine.freewheel (true);
 189         }
 190 }
 191
 192 void
 193 Session::process_export (pframes_t nframes)
 194 {
 195         if (_export_rolling && export_status->stop) {
 196                 stop_audio_export ();
 197         }
 198
 199         /* for Region Raw or Fades, we can skip this
 200          * RegionExportChannelFactory::update_buffers() does not care
 201          * about anything done here
 202          */
 203         if (!_region_export) {
 204                 if (_export_rolling) {
 205                         if (!_realtime_export)  {
 206                                 /* make sure we've caught up with disk i/o, since
 207                                  * we're running faster than realtime c/o JACK.
 208                                  */
 209                                 _butler->wait_until_finished ();
 210                         }
 211
 212                         /* do the usual stuff */
 213
 214                         process_without_events (nframes);
 215
 216                 } else if (_realtime_export) {
 217                         fail_roll (nframes); // somehow we need to silence _ALL_ output buffers
 218                 }
 219         }
 220
 221         try {
 222                 /* handle export - XXX what about error handling? */
 223
 224                 ProcessExport (nframes);
 225
 226         } catch (std::exception & e) {
 227                 error << string_compose (_("Export ended unexpectedly: %1"), e.what()) << endmsg;
 228                 export_status->abort (true);
 229         }
 230 }
 231
 232 void
 233 Session::process_export_fw (pframes_t nframes)
 234 {
 235         const bool need_buffers = _engine.freewheeling ();
 236         if (_export_preroll > 0) {
 237
 238                 if (need_buffers) {
 239                         _engine.main_thread()->get_buffers ();
 240                 }
 241                 fail_roll (nframes);
 242                 if (need_buffers) {
 243                         _engine.main_thread()->drop_buffers ();
 244                 }
 245
 246                 _export_preroll -= std::min ((samplepos_t)nframes, _export_preroll);
 247
 248                 if (_export_preroll > 0) {
 249                         // clear out buffers (reverb tails etc).
 250                         return;
 251                 }
 252
 253                 set_transport_speed (1.0, 0, false);
 254                 butler_transport_work ();
 255                 g_atomic_int_set (&_butler->should_do_transport_work, 0);
 256                 post_transport ();
 257
 258                 return;
 259         }
 260
 261         if (_remaining_latency_preroll > 0) {
 262                 samplepos_t remain = std::min ((samplepos_t)nframes, _remaining_latency_preroll);
 263
 264                 if (need_buffers) {
 265                         _engine.main_thread()->get_buffers ();
 266                 }
 267
 268                 process_without_events (remain);
 269
 270                 if (need_buffers) {
 271                         _engine.main_thread()->drop_buffers ();
 272                 }
 273
 274                 _remaining_latency_preroll -= remain;
 275                 _transport_sample -= remain;
 276                 nframes -= remain;
 277
 278                 if (nframes == 0) {
 279                         return;
 280                 }
 281                 _engine.split_cycle (remain);
 282         }
 283
 284         if (need_buffers) {
 285                 _engine.main_thread()->get_buffers ();
 286         }
 287         process_export (nframes);
 288         if (need_buffers) {
 289                 _engine.main_thread()->drop_buffers ();
 290         }
 291
 292         return;
 293 }
 294
 295 int
 296 Session::stop_audio_export ()
 297 {
 298         /* can't use stop_transport() here because we need
 299            an immediate halt and don't require all the declick
 300            stuff that stop_transport() implements.
 301         */
 302
 303         realtime_stop (true, true);
 304         _export_rolling = false;
 305         _butler->schedule_transport_work ();
 306
 307         return 0;
 308 }
 309
 310 void
 311 Session::finalize_audio_export ()
 312 {
 313         _exporting = false;
 314
 315         if (_export_rolling) {
 316                 stop_audio_export ();
 317         }
 318
 319         /* Clean up */
 320
 321         if (_realtime_export) {
 322                 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 323                 process_function = &Session::process_with_events;
 324         }
 325         _engine.freewheel (false);
 326         export_freewheel_connection.disconnect();
 327
 328         _mmc->enable_send (_pre_export_mmc_enabled);
 329
 330         /* maybe write CUE/TOC */
 331
 332         export_handler.reset();
 333         export_status.reset();
 334
 335         /* restart slaving */
 336
 337         if (post_export_sync) {
 338                 config.set_external_sync (true);
 339         } else {
 340                 locate (post_export_position, false, false, false, false, false);
 341         }
 342 }