2 Copyright (C) 2002 Paul Davis
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.
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.
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.
20 #include <boost/scoped_array.hpp>
22 #include "pbd/enumwriter.h"
23 #include "pbd/error.h"
25 #include "evoral/Curve.hpp"
27 #include "ardour/amp.h"
28 #include "ardour/audio_buffer.h"
29 #include "ardour/audio_diskstream.h"
30 #include "ardour/audio_track.h"
31 #include "ardour/audioplaylist.h"
32 #include "ardour/boost_debug.h"
33 #include "ardour/buffer_set.h"
34 #include "ardour/delivery.h"
35 #include "ardour/meter.h"
36 #include "ardour/monitor_control.h"
37 #include "ardour/playlist_factory.h"
38 #include "ardour/processor.h"
39 #include "ardour/profile.h"
40 #include "ardour/region.h"
41 #include "ardour/region_factory.h"
42 #include "ardour/session.h"
43 #include "ardour/session_playlists.h"
44 #include "ardour/source.h"
45 #include "ardour/utils.h"
50 using namespace ARDOUR;
53 AudioTrack::AudioTrack (Session& sess, string name, TrackMode mode)
54 : Track (sess, name, PresentationInfo::AudioTrack, mode)
58 AudioTrack::~AudioTrack ()
60 if (_freeze_record.playlist && !_session.deletion_in_progress()) {
61 _freeze_record.playlist->release();
65 boost::shared_ptr<Diskstream>
66 AudioTrack::create_diskstream ()
68 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (AudioDiskstream::Recordable);
70 if (_mode == Destructive && !Profile->get_trx()) {
71 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
72 } else if (_mode == NonLayered){
73 dflags = AudioDiskstream::Flag(dflags | AudioDiskstream::NonLayered);
76 return boost::shared_ptr<AudioDiskstream> (new AudioDiskstream (_session, name(), dflags));
80 AudioTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
82 Track::set_diskstream (ds);
84 _diskstream->set_track (this);
85 #ifdef XXX_OLD_DESTRUCTIVE_API_XXX
86 if (Profile->get_trx()) {
87 _diskstream->set_destructive (false);
89 _diskstream->set_destructive (_mode == Destructive);
91 _diskstream->set_non_layered (_mode == NonLayered);
94 if (audio_diskstream()->deprecated_io_node) {
96 if (!IO::connecting_legal) {
97 IO::ConnectingLegal.connect_same_thread (*this, boost::bind (&AudioTrack::deprecated_use_diskstream_connections, this));
99 deprecated_use_diskstream_connections ();
103 _diskstream->set_record_enabled (false);
104 _diskstream->request_input_monitoring (false);
106 DiskstreamChanged (); /* EMIT SIGNAL */
109 boost::shared_ptr<AudioDiskstream>
110 AudioTrack::audio_diskstream() const
112 return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
115 #ifdef XXX_OLD_DESTRUCTIVE_API_XXX
117 AudioTrack::set_mode (TrackMode m)
121 if (!Profile->get_trx() && _diskstream->set_destructive (m == Destructive)) {
125 _diskstream->set_non_layered (m == NonLayered);
128 TrackModeChanged (); /* EMIT SIGNAL */
135 AudioTrack::can_use_mode (TrackMode m, bool& bounce_required)
140 bounce_required = false;
144 if (Profile->get_trx()) {
147 return _diskstream->can_become_destructive (bounce_required);
158 AudioTrack::deprecated_use_diskstream_connections ()
160 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
162 if (diskstream->deprecated_io_node == 0) {
166 XMLProperty const * prop;
167 XMLNode& node (*diskstream->deprecated_io_node);
169 /* don't do this more than once. */
171 diskstream->deprecated_io_node = 0;
173 if ((prop = node.property ("gain")) != 0) {
174 _amp->gain_control()->set_value (atof (prop->value().c_str()), PBD::Controllable::NoGroup);
177 if ((prop = node.property ("input-connection")) != 0) {
178 boost::shared_ptr<Bundle> c = _session.bundle_by_name (prop->value());
181 error << string_compose(_("Unknown bundle \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
183 if ((c = _session.bundle_by_name (_("in 1"))) == 0) {
184 error << _("No input bundles available as a replacement")
188 info << string_compose (_("Bundle %1 was not available - \"in 1\" used instead"), prop->value())
193 _input->connect_ports_to_bundle (c, true, this);
195 } else if ((prop = node.property ("inputs")) != 0) {
196 if (_input->set_ports (prop->value())) {
197 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
206 AudioTrack::set_state (const XMLNode& node, int version)
208 XMLProperty const * prop;
210 if ((prop = node.property (X_("mode"))) != 0) {
211 _mode = TrackMode (string_2_enum (prop->value(), _mode));
216 if (Profile->get_trx() && _mode == Destructive) {
217 /* Tracks does not support destructive tracks and trying to
218 handle it as a normal track would be wrong.
220 error << string_compose (_("%1: this session uses destructive tracks, which are not supported"), PROGRAM_NAME) << endmsg;
224 if (Track::set_state (node, version)) {
228 pending_state = const_cast<XMLNode*> (&node);
230 if (_session.state_of_the_state() & Session::Loading) {
231 _session.StateReady.connect_same_thread (*this, boost::bind (&AudioTrack::set_state_part_two, this));
233 set_state_part_two ();
240 AudioTrack::state (bool full_state)
242 XMLNode& root (Track::state(full_state));
243 XMLNode* freeze_node;
246 if (_freeze_record.playlist) {
249 freeze_node = new XMLNode (X_("freeze-info"));
250 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
251 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
253 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
254 inode = new XMLNode (X_("processor"));
255 (*i)->id.print (buf, sizeof (buf));
256 inode->add_property (X_("id"), buf);
257 inode->add_child_copy ((*i)->state);
259 freeze_node->add_child_nocopy (*inode);
262 root.add_child_nocopy (*freeze_node);
265 root.add_property (X_("mode"), enum_2_string (_mode));
271 AudioTrack::set_state_part_two ()
274 XMLProperty const * prop;
277 /* This is called after all session state has been restored but before
278 have been made ports and connections are established.
281 if (pending_state == 0) {
285 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
287 _freeze_record.state = Frozen;
289 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
292 _freeze_record.processor_info.clear ();
294 if ((prop = fnode->property (X_("playlist"))) != 0) {
295 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
297 _freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
298 _freeze_record.playlist->use();
300 _freeze_record.playlist.reset ();
301 _freeze_record.state = NoFreeze;
306 if ((prop = fnode->property (X_("state"))) != 0) {
307 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
310 XMLNodeConstIterator citer;
311 XMLNodeList clist = fnode->children();
313 for (citer = clist.begin(); citer != clist.end(); ++citer) {
314 if ((*citer)->name() != X_("processor")) {
318 if ((prop = (*citer)->property (X_("id"))) == 0) {
322 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
323 boost::shared_ptr<Processor>());
324 frii->id = prop->value ();
325 _freeze_record.processor_info.push_back (frii);
330 /** @param need_butler to be set to true if this track now needs the butler, otherwise it can be left alone
334 AudioTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
336 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
339 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
340 framecnt_t playback_distance = diskstream->calculate_playback_distance(nframes);
341 if (can_internal_playback_seek(::llabs(playback_distance))) {
342 /* TODO should declick */
343 internal_playback_seek(playback_distance);
348 framepos_t transport_frame;
349 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
351 if (n_outputs().n_total() == 0 && _processors.empty()) {
357 if (_meter_point == MeterInput && ((_monitoring_control->monitoring_choice() & MonitorInput) || _diskstream->record_enabled())) {
363 transport_frame = _session.transport_frame();
366 framecnt_t playback_distance;
368 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
370 /* need to do this so that the diskstream sets its
371 playback distance to zero, thus causing diskstream::commit
375 BufferSet bufs; /* empty set, no matter - nothing will happen */
377 dret = diskstream->process (bufs, transport_frame, 0, playback_distance, false);
378 need_butler = diskstream->commit (playback_distance);
383 _amp->apply_gain_automation(false);
385 BufferSet& bufs = _session.get_route_buffers (n_process_buffers ());
387 fill_buffers_with_input (bufs, _input, nframes);
389 if (_meter_point == MeterInput && ((_monitoring_control->monitoring_choice() & MonitorInput) || _diskstream->record_enabled())) {
390 _meter->run (bufs, start_frame, end_frame, 1.0 /*speed()*/, nframes, true);
393 if ((dret = diskstream->process (bufs, transport_frame, nframes, playback_distance, (monitoring_state() == MonitoringDisk))) != 0) {
394 need_butler = diskstream->commit (playback_distance);
399 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, (!diskstream->record_enabled() && _session.transport_rolling()));
401 flush_processor_buffers_locked (nframes);
403 need_butler = diskstream->commit (playback_distance);
409 AudioTrack::export_stuff (BufferSet& buffers, framepos_t start, framecnt_t nframes,
410 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze)
412 boost::scoped_array<gain_t> gain_buffer (new gain_t[nframes]);
413 boost::scoped_array<Sample> mix_buffer (new Sample[nframes]);
414 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
416 Glib::Threads::RWLock::ReaderLock rlock (_processor_lock);
418 boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist());
421 assert(buffers.count().n_audio() >= 1);
422 assert ((framecnt_t) buffers.get_audio(0).capacity() >= nframes);
424 if (apl->read (buffers.get_audio(0).data(), mix_buffer.get(), gain_buffer.get(), start, nframes) != nframes) {
429 Sample* b = buffers.get_audio(0).data();
430 BufferSet::audio_iterator bi = buffers.audio_begin();
432 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
433 if (n < diskstream->n_channels().n_audio()) {
434 if (apl->read (bi->data(), mix_buffer.get(), gain_buffer.get(), start, nframes, n) != nframes) {
439 /* duplicate last across remaining buffers */
440 memcpy (bi->data(), b, sizeof (Sample) * nframes);
444 bounce_process (buffers, start, nframes, endpoint, include_endpoint, for_export, for_freeze);
450 AudioTrack::bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const
452 if (!endpoint && !include_endpoint) {
453 /* no processing - just read from the playlist and create new
454 files: always possible.
459 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
460 uint32_t naudio = n_inputs().n_audio();
462 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
464 /* if we're not including the endpoint, potentially stop
465 right here before we test matching i/o valences.
468 if (!include_endpoint && (*r) == endpoint) {
472 /* ignore any processors that do routing, because we will not
473 * use them during a bounce/freeze/export operation.
476 if ((*r)->does_routing()) {
480 /* does the output from the last considered processor match the
484 if (naudio != (*r)->input_streams().n_audio()) {
488 /* we're including the endpoint - if we just hit it,
492 if ((*r) == endpoint) {
496 /* save outputs of this processor to test against inputs
500 naudio = (*r)->output_streams().n_audio();
506 boost::shared_ptr<Region>
507 AudioTrack::bounce (InterThreadInfo& itt)
509 return bounce_range (_session.current_start_frame(), _session.current_end_frame(), itt, main_outs(), false);
512 boost::shared_ptr<Region>
513 AudioTrack::bounce_range (framepos_t start, framepos_t end, InterThreadInfo& itt,
514 boost::shared_ptr<Processor> endpoint, bool include_endpoint)
516 vector<boost::shared_ptr<Source> > srcs;
517 return _session.write_one_track (*this, start, end, false, srcs, itt, endpoint, include_endpoint, false, false);
521 AudioTrack::freeze_me (InterThreadInfo& itt)
523 vector<boost::shared_ptr<Source> > srcs;
524 string new_playlist_name;
525 boost::shared_ptr<Playlist> new_playlist;
528 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
530 if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist())) == 0) {
536 while (n < (UINT_MAX-1)) {
540 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
542 if (_session.playlists->by_name (candidate) == 0) {
543 new_playlist_name = candidate;
551 if (n == (UINT_MAX-1)) {
552 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
553 " to create another one"), _freeze_record.playlist->name())
558 boost::shared_ptr<Region> res;
560 if ((res = _session.write_one_track (*this, _session.current_start_frame(), _session.current_end_frame(),
561 true, srcs, itt, main_outs(), false, false, true)) == 0) {
565 _freeze_record.processor_info.clear ();
568 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
570 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
572 if ((*r)->does_routing() && (*r)->active()) {
575 if (!boost::dynamic_pointer_cast<PeakMeter>(*r)) {
577 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo ((*r)->get_state(), (*r));
579 frii->id = (*r)->id();
581 _freeze_record.processor_info.push_back (frii);
583 /* now deactivate the processor, */
584 if (!boost::dynamic_pointer_cast<Amp>(*r)) {
589 _session.set_dirty ();
593 new_playlist = PlaylistFactory::create (DataType::AUDIO, _session, new_playlist_name, false);
595 /* XXX need main outs automation state _freeze_record.pan_automation_state = _mainpanner->automation_state(); */
597 region_name = new_playlist_name;
599 /* create a new region from all filesources, keep it private */
603 plist.add (Properties::start, 0);
604 plist.add (Properties::length, srcs[0]->length(srcs[0]->timeline_position()));
605 plist.add (Properties::name, region_name);
606 plist.add (Properties::whole_file, true);
608 boost::shared_ptr<Region> region (RegionFactory::create (srcs, plist, false));
610 new_playlist->set_orig_track_id (id());
611 new_playlist->add_region (region, _session.current_start_frame());
612 new_playlist->set_frozen (true);
613 region->set_locked (true);
615 diskstream->use_playlist (boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
616 diskstream->set_record_enabled (false);
618 _freeze_record.playlist->use(); // prevent deletion
620 /* reset stuff that has already been accounted for in the freeze process */
622 gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
623 gain_control()->set_automation_state (Off);
625 /* XXX need to use _main_outs _panner->set_automation_state (Off); */
627 _freeze_record.state = Frozen;
628 FreezeChange(); /* EMIT SIGNAL */
632 AudioTrack::unfreeze ()
634 if (_freeze_record.playlist) {
635 _freeze_record.playlist->release();
636 audio_diskstream()->use_playlist (_freeze_record.playlist);
639 Glib::Threads::RWLock::ReaderLock lm (_processor_lock); // should this be a write lock? jlc
640 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
641 for (vector<FreezeRecordProcessorInfo*>::iterator ii = _freeze_record.processor_info.begin(); ii != _freeze_record.processor_info.end(); ++ii) {
642 if ((*ii)->id == (*i)->id()) {
643 (*i)->set_state (((*ii)->state), Stateful::current_state_version);
650 _freeze_record.playlist.reset ();
651 /* XXX need to use _main_outs _panner->set_automation_state (_freeze_record.pan_automation_state); */
654 _freeze_record.state = UnFrozen;
655 FreezeChange (); /* EMIT SIGNAL */
658 boost::shared_ptr<AudioFileSource>
659 AudioTrack::write_source (uint32_t n)
661 boost::shared_ptr<AudioDiskstream> ds = boost::dynamic_pointer_cast<AudioDiskstream> (_diskstream);
663 return ds->write_source (n);
666 boost::shared_ptr<Diskstream>
667 AudioTrack::diskstream_factory (XMLNode const & node)
669 return boost::shared_ptr<Diskstream> (new AudioDiskstream (_session, node));