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/playlist_factory.h"
37 #include "ardour/processor.h"
38 #include "ardour/profile.h"
39 #include "ardour/region.h"
40 #include "ardour/region_factory.h"
41 #include "ardour/session.h"
42 #include "ardour/session_playlists.h"
43 #include "ardour/source.h"
44 #include "ardour/utils.h"
49 using namespace ARDOUR;
52 AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
53 : Track (sess, name, flag, mode)
57 AudioTrack::~AudioTrack ()
59 if (_freeze_record.playlist && !_session.deletion_in_progress()) {
60 _freeze_record.playlist->release();
64 boost::shared_ptr<Diskstream>
65 AudioTrack::create_diskstream ()
67 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (AudioDiskstream::Recordable);
69 if (_mode == Destructive && !Profile->get_trx()) {
70 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
71 } else if (_mode == NonLayered){
72 dflags = AudioDiskstream::Flag(dflags | AudioDiskstream::NonLayered);
75 return boost::shared_ptr<AudioDiskstream> (new AudioDiskstream (_session, name(), dflags));
79 AudioTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
81 Track::set_diskstream (ds);
83 _diskstream->set_track (this);
84 if (Profile->get_trx()) {
85 _diskstream->set_destructive (false);
87 _diskstream->set_destructive (_mode == Destructive);
89 _diskstream->set_non_layered (_mode == NonLayered);
91 if (audio_diskstream()->deprecated_io_node) {
93 if (!IO::connecting_legal) {
94 IO::ConnectingLegal.connect_same_thread (*this, boost::bind (&AudioTrack::deprecated_use_diskstream_connections, this));
96 deprecated_use_diskstream_connections ();
100 _diskstream->set_record_enabled (false);
101 _diskstream->request_input_monitoring (false);
103 DiskstreamChanged (); /* EMIT SIGNAL */
106 boost::shared_ptr<AudioDiskstream>
107 AudioTrack::audio_diskstream() const
109 return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
113 AudioTrack::set_mode (TrackMode m)
117 if (!Profile->get_trx() && _diskstream->set_destructive (m == Destructive)) {
121 _diskstream->set_non_layered (m == NonLayered);
124 TrackModeChanged (); /* EMIT SIGNAL */
131 AudioTrack::can_use_mode (TrackMode m, bool& bounce_required)
136 bounce_required = false;
140 if (Profile->get_trx()) {
143 return _diskstream->can_become_destructive (bounce_required);
153 AudioTrack::deprecated_use_diskstream_connections ()
155 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
157 if (diskstream->deprecated_io_node == 0) {
161 XMLProperty const * prop;
162 XMLNode& node (*diskstream->deprecated_io_node);
164 /* don't do this more than once. */
166 diskstream->deprecated_io_node = 0;
168 if ((prop = node.property ("gain")) != 0) {
169 _amp->gain_control()->set_value (atof (prop->value().c_str()), PBD::Controllable::NoGroup);
172 if ((prop = node.property ("input-connection")) != 0) {
173 boost::shared_ptr<Bundle> c = _session.bundle_by_name (prop->value());
176 error << string_compose(_("Unknown bundle \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
178 if ((c = _session.bundle_by_name (_("in 1"))) == 0) {
179 error << _("No input bundles available as a replacement")
183 info << string_compose (_("Bundle %1 was not available - \"in 1\" used instead"), prop->value())
188 _input->connect_ports_to_bundle (c, true, this);
190 } else if ((prop = node.property ("inputs")) != 0) {
191 if (_input->set_ports (prop->value())) {
192 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
201 AudioTrack::set_state (const XMLNode& node, int version)
203 XMLProperty const * prop;
205 if ((prop = node.property (X_("mode"))) != 0) {
206 _mode = TrackMode (string_2_enum (prop->value(), _mode));
211 if (Profile->get_trx() && _mode == Destructive) {
212 /* Tracks does not support destructive tracks and trying to
213 handle it as a normal track would be wrong.
215 error << string_compose (_("%1: this session uses destructive tracks, which are not supported"), PROGRAM_NAME) << endmsg;
219 if (Track::set_state (node, version)) {
223 pending_state = const_cast<XMLNode*> (&node);
225 if (_session.state_of_the_state() & Session::Loading) {
226 _session.StateReady.connect_same_thread (*this, boost::bind (&AudioTrack::set_state_part_two, this));
228 set_state_part_two ();
235 AudioTrack::state (bool full_state)
237 XMLNode& root (Track::state(full_state));
238 XMLNode* freeze_node;
241 if (_freeze_record.playlist) {
244 freeze_node = new XMLNode (X_("freeze-info"));
245 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
246 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
248 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
249 inode = new XMLNode (X_("processor"));
250 (*i)->id.print (buf, sizeof (buf));
251 inode->add_property (X_("id"), buf);
252 inode->add_child_copy ((*i)->state);
254 freeze_node->add_child_nocopy (*inode);
257 root.add_child_nocopy (*freeze_node);
260 root.add_property (X_("mode"), enum_2_string (_mode));
266 AudioTrack::set_state_part_two ()
269 XMLProperty const * prop;
272 /* This is called after all session state has been restored but before
273 have been made ports and connections are established.
276 if (pending_state == 0) {
280 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
282 _freeze_record.state = Frozen;
284 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
287 _freeze_record.processor_info.clear ();
289 if ((prop = fnode->property (X_("playlist"))) != 0) {
290 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
292 _freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
293 _freeze_record.playlist->use();
295 _freeze_record.playlist.reset ();
296 _freeze_record.state = NoFreeze;
301 if ((prop = fnode->property (X_("state"))) != 0) {
302 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
305 XMLNodeConstIterator citer;
306 XMLNodeList clist = fnode->children();
308 for (citer = clist.begin(); citer != clist.end(); ++citer) {
309 if ((*citer)->name() != X_("processor")) {
313 if ((prop = (*citer)->property (X_("id"))) == 0) {
317 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
318 boost::shared_ptr<Processor>());
319 frii->id = prop->value ();
320 _freeze_record.processor_info.push_back (frii);
325 /** @param need_butler to be set to true if this track now needs the butler, otherwise it can be left alone
329 AudioTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
331 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
334 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
335 framecnt_t playback_distance = diskstream->calculate_playback_distance(nframes);
336 if (can_internal_playback_seek(::llabs(playback_distance))) {
337 /* TODO should declick */
338 internal_playback_seek(playback_distance);
343 framepos_t transport_frame;
344 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
346 if (n_outputs().n_total() == 0 && _processors.empty()) {
352 if (_meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled())) {
358 transport_frame = _session.transport_frame();
361 framecnt_t playback_distance;
363 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
365 /* need to do this so that the diskstream sets its
366 playback distance to zero, thus causing diskstream::commit
370 BufferSet bufs; /* empty set, no matter - nothing will happen */
372 dret = diskstream->process (bufs, transport_frame, 0, playback_distance, false);
373 need_butler = diskstream->commit (playback_distance);
377 if (_mute_control->list() && _mute_control->automation_playback()) {
379 const float mute = _mute_control->list()->rt_safe_eval(transport_frame, valid);
380 if (mute >= 0.5 && !muted()) {
381 _mute_control->set_value_unchecked(1.0); // mute
382 } else if (mute < 0.5 && muted()) {
383 _mute_control->set_value_unchecked(0.0); // unmute
388 _amp->apply_gain_automation(false);
390 BufferSet& bufs = _session.get_route_buffers (n_process_buffers ());
392 fill_buffers_with_input (bufs, _input, nframes);
394 if (_meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled())) {
395 _meter->run (bufs, start_frame, end_frame, nframes, true);
398 if ((dret = diskstream->process (bufs, transport_frame, nframes, playback_distance, (monitoring_state() == MonitoringDisk))) != 0) {
399 need_butler = diskstream->commit (playback_distance);
404 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, (!diskstream->record_enabled() && _session.transport_rolling()));
406 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
407 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
409 d->flush_buffers (nframes);
413 need_butler = diskstream->commit (playback_distance);
419 AudioTrack::export_stuff (BufferSet& buffers, framepos_t start, framecnt_t nframes,
420 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze)
422 boost::scoped_array<gain_t> gain_buffer (new gain_t[nframes]);
423 boost::scoped_array<Sample> mix_buffer (new Sample[nframes]);
424 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
426 Glib::Threads::RWLock::ReaderLock rlock (_processor_lock);
428 boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist());
431 assert(buffers.count().n_audio() >= 1);
432 assert ((framecnt_t) buffers.get_audio(0).capacity() >= nframes);
434 if (apl->read (buffers.get_audio(0).data(), mix_buffer.get(), gain_buffer.get(), start, nframes) != nframes) {
439 Sample* b = buffers.get_audio(0).data();
440 BufferSet::audio_iterator bi = buffers.audio_begin();
442 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
443 if (n < diskstream->n_channels().n_audio()) {
444 if (apl->read (bi->data(), mix_buffer.get(), gain_buffer.get(), start, nframes, n) != nframes) {
449 /* duplicate last across remaining buffers */
450 memcpy (bi->data(), b, sizeof (Sample) * nframes);
454 bounce_process (buffers, start, nframes, endpoint, include_endpoint, for_export, for_freeze);
460 AudioTrack::bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const
462 if (!endpoint && !include_endpoint) {
463 /* no processing - just read from the playlist and create new
464 files: always possible.
469 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
470 uint32_t naudio = n_inputs().n_audio();
472 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
474 /* if we're not including the endpoint, potentially stop
475 right here before we test matching i/o valences.
478 if (!include_endpoint && (*r) == endpoint) {
482 /* ignore any processors that do routing, because we will not
483 * use them during a bounce/freeze/export operation.
486 if ((*r)->does_routing()) {
490 /* does the output from the last considered processor match the
494 if (naudio != (*r)->input_streams().n_audio()) {
498 /* we're including the endpoint - if we just hit it,
502 if ((*r) == endpoint) {
506 /* save outputs of this processor to test against inputs
510 naudio = (*r)->output_streams().n_audio();
516 boost::shared_ptr<Region>
517 AudioTrack::bounce (InterThreadInfo& itt)
519 return bounce_range (_session.current_start_frame(), _session.current_end_frame(), itt, main_outs(), false);
522 boost::shared_ptr<Region>
523 AudioTrack::bounce_range (framepos_t start, framepos_t end, InterThreadInfo& itt,
524 boost::shared_ptr<Processor> endpoint, bool include_endpoint)
526 vector<boost::shared_ptr<Source> > srcs;
527 return _session.write_one_track (*this, start, end, false, srcs, itt, endpoint, include_endpoint, false, false);
531 AudioTrack::freeze_me (InterThreadInfo& itt)
533 vector<boost::shared_ptr<Source> > srcs;
534 string new_playlist_name;
535 boost::shared_ptr<Playlist> new_playlist;
538 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
540 if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist())) == 0) {
546 while (n < (UINT_MAX-1)) {
550 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
552 if (_session.playlists->by_name (candidate) == 0) {
553 new_playlist_name = candidate;
561 if (n == (UINT_MAX-1)) {
562 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
563 " to create another one"), _freeze_record.playlist->name())
568 boost::shared_ptr<Region> res;
570 if ((res = _session.write_one_track (*this, _session.current_start_frame(), _session.current_end_frame(),
571 true, srcs, itt, main_outs(), false, false, true)) == 0) {
575 _freeze_record.processor_info.clear ();
578 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
580 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
582 if ((*r)->does_routing() && (*r)->active()) {
585 if (!boost::dynamic_pointer_cast<PeakMeter>(*r)) {
587 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo ((*r)->get_state(), (*r));
589 frii->id = (*r)->id();
591 _freeze_record.processor_info.push_back (frii);
593 /* now deactivate the processor, */
594 if (!boost::dynamic_pointer_cast<Amp>(*r)) {
599 _session.set_dirty ();
603 new_playlist = PlaylistFactory::create (DataType::AUDIO, _session, new_playlist_name, false);
605 /* XXX need main outs automation state _freeze_record.pan_automation_state = _mainpanner->automation_state(); */
607 region_name = new_playlist_name;
609 /* create a new region from all filesources, keep it private */
613 plist.add (Properties::start, 0);
614 plist.add (Properties::length, srcs[0]->length(srcs[0]->timeline_position()));
615 plist.add (Properties::name, region_name);
616 plist.add (Properties::whole_file, true);
618 boost::shared_ptr<Region> region (RegionFactory::create (srcs, plist, false));
620 new_playlist->set_orig_track_id (id());
621 new_playlist->add_region (region, _session.current_start_frame());
622 new_playlist->set_frozen (true);
623 region->set_locked (true);
625 diskstream->use_playlist (boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
626 diskstream->set_record_enabled (false);
628 _freeze_record.playlist->use(); // prevent deletion
630 /* reset stuff that has already been accounted for in the freeze process */
632 set_gain (GAIN_COEFF_UNITY, Controllable::NoGroup);
633 _amp->gain_control()->set_automation_state (Off);
634 /* XXX need to use _main_outs _panner->set_automation_state (Off); */
636 _freeze_record.state = Frozen;
637 FreezeChange(); /* EMIT SIGNAL */
641 AudioTrack::unfreeze ()
643 if (_freeze_record.playlist) {
644 _freeze_record.playlist->release();
645 audio_diskstream()->use_playlist (_freeze_record.playlist);
648 Glib::Threads::RWLock::ReaderLock lm (_processor_lock); // should this be a write lock? jlc
649 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
650 for (vector<FreezeRecordProcessorInfo*>::iterator ii = _freeze_record.processor_info.begin(); ii != _freeze_record.processor_info.end(); ++ii) {
651 if ((*ii)->id == (*i)->id()) {
652 (*i)->set_state (((*ii)->state), Stateful::current_state_version);
659 _freeze_record.playlist.reset ();
660 /* XXX need to use _main_outs _panner->set_automation_state (_freeze_record.pan_automation_state); */
663 _freeze_record.state = UnFrozen;
664 FreezeChange (); /* EMIT SIGNAL */
667 boost::shared_ptr<AudioFileSource>
668 AudioTrack::write_source (uint32_t n)
670 boost::shared_ptr<AudioDiskstream> ds = boost::dynamic_pointer_cast<AudioDiskstream> (_diskstream);
672 return ds->write_source (n);
675 boost::shared_ptr<Diskstream>
676 AudioTrack::diskstream_factory (XMLNode const & node)
678 return boost::shared_ptr<Diskstream> (new AudioDiskstream (_session, node));