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.
21 #include "pbd/error.h"
22 #include "pbd/enumwriter.h"
23 #include "pbd/boost_debug.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/audioregion.h"
33 #include "ardour/audiosource.h"
34 #include "ardour/buffer_set.h"
35 #include "ardour/io_processor.h"
36 #include "ardour/panner.h"
37 #include "ardour/meter.h"
38 #include "ardour/playlist_factory.h"
39 #include "ardour/plugin_insert.h"
40 #include "ardour/processor.h"
41 #include "ardour/region_factory.h"
42 #include "ardour/route_group_specialized.h"
43 #include "ardour/session.h"
44 #include "ardour/utils.h"
45 #include "ardour/session_playlists.h"
49 using namespace ARDOUR;
52 AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
53 : Track (sess, name, flag, mode)
55 use_new_diskstream ();
58 AudioTrack::AudioTrack (Session& sess, const XMLNode& node, int /*version*/)
61 _set_state (node, Stateful::loading_state_version, false);
64 AudioTrack::~AudioTrack ()
69 AudioTrack::use_new_diskstream ()
71 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (0);
73 if (_flags & Hidden) {
74 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Hidden);
76 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Recordable);
79 if (_mode == Destructive) {
80 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
81 } else if (_mode == NonLayered){
82 dflags = AudioDiskstream::Flag(dflags | AudioDiskstream::NonLayered);
85 AudioDiskstream* dsp (new AudioDiskstream (_session, name(), dflags));
86 boost::shared_ptr<AudioDiskstream> ds (dsp);
88 _session.add_diskstream (ds);
90 set_diskstream (boost::dynamic_pointer_cast<AudioDiskstream> (ds), this);
94 AudioTrack::set_mode (TrackMode m)
98 if (_diskstream->set_destructive (m == Destructive)) {
102 _diskstream->set_non_layered (m == NonLayered);
105 TrackModeChanged (); /* EMIT SIGNAL */
112 AudioTrack::can_use_mode (TrackMode m, bool& bounce_required)
117 bounce_required = false;
122 return _diskstream->can_become_destructive (bounce_required);
127 AudioTrack::deprecated_use_diskstream_connections ()
129 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
131 if (diskstream->deprecated_io_node == 0) {
135 const XMLProperty* prop;
136 XMLNode& node (*diskstream->deprecated_io_node);
138 /* don't do this more than once. */
140 diskstream->deprecated_io_node = 0;
142 if ((prop = node.property ("gain")) != 0) {
143 _amp->set_gain (atof (prop->value().c_str()), this);
146 if ((prop = node.property ("input-connection")) != 0) {
147 boost::shared_ptr<Bundle> c = _session.bundle_by_name (prop->value());
150 error << string_compose(_("Unknown bundle \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
152 if ((c = _session.bundle_by_name (_("in 1"))) == 0) {
153 error << _("No input bundles available as a replacement")
157 info << string_compose (_("Bundle %1 was not available - \"in 1\" used instead"), prop->value())
162 _input->connect_ports_to_bundle (c, this);
164 } else if ((prop = node.property ("inputs")) != 0) {
165 if (_input->set_ports (prop->value())) {
166 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
175 AudioTrack::set_diskstream (boost::shared_ptr<AudioDiskstream> ds, void * /*src*/)
178 _diskstream->set_route (*this);
179 _diskstream->set_destructive (_mode == Destructive);
180 _diskstream->set_non_layered (_mode == NonLayered);
182 if (audio_diskstream()->deprecated_io_node) {
184 if (!IO::connecting_legal) {
185 scoped_connect (IO::ConnectingLegal, boost::bind (&AudioTrack::deprecated_use_diskstream_connections, this));
187 deprecated_use_diskstream_connections ();
191 _diskstream->set_record_enabled (false);
192 _diskstream->monitor_input (false);
194 DiskstreamChanged (); /* EMIT SIGNAL */
200 AudioTrack::use_diskstream (string name)
202 boost::shared_ptr<AudioDiskstream> dstream;
204 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream>(_session.diskstream_by_name (name))) == 0) {
205 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), name) << endmsg;
209 return set_diskstream (dstream, this);
213 AudioTrack::use_diskstream (const PBD::ID& id)
215 boost::shared_ptr<AudioDiskstream> dstream;
217 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream> (_session.diskstream_by_id (id))) == 0) {
218 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), id) << endmsg;
222 return set_diskstream (dstream, this);
225 boost::shared_ptr<AudioDiskstream>
226 AudioTrack::audio_diskstream() const
228 return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
232 AudioTrack::set_state (const XMLNode& node, int version)
234 return _set_state (node, version, true);
238 AudioTrack::_set_state (const XMLNode& node, int version, bool call_base)
240 const XMLProperty *prop;
241 XMLNodeConstIterator iter;
244 if (Route::_set_state (node, version, call_base)) {
249 if ((prop = node.property (X_("mode"))) != 0) {
250 _mode = TrackMode (string_2_enum (prop->value(), _mode));
255 if ((prop = node.property ("diskstream-id")) == 0) {
257 /* some old sessions use the diskstream name rather than the ID */
259 if ((prop = node.property ("diskstream")) == 0) {
260 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
265 if (use_diskstream (prop->value())) {
271 PBD::ID id (prop->value());
274 /* this wierd hack is used when creating tracks from a template. there isn't
275 a particularly good time to interpose between setting the first part of
276 the track state (notably Route::set_state() and the track mode), and the
277 second part (diskstream stuff). So, we have a special ID for the diskstream
278 that means "you should create a new diskstream here, not look for
283 use_new_diskstream ();
284 } else if (use_diskstream (id)) {
291 XMLNodeConstIterator niter;
294 nlist = node.children();
295 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
298 if (child->name() == X_("recenable")) {
299 _rec_enable_control->set_state (*child, version);
300 _session.add_controllable (_rec_enable_control);
304 pending_state = const_cast<XMLNode*> (&node);
306 if (_session.state_of_the_state() & Session::Loading) {
307 scoped_connect (_session.StateReady, boost::bind (&AudioTrack::set_state_part_two, this));
309 set_state_part_two ();
316 AudioTrack::state(bool full_state)
318 XMLNode& root (Route::state(full_state));
319 XMLNode* freeze_node;
322 if (_freeze_record.playlist) {
325 freeze_node = new XMLNode (X_("freeze-info"));
326 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
327 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
329 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
330 inode = new XMLNode (X_("processor"));
331 (*i)->id.print (buf, sizeof (buf));
332 inode->add_property (X_("id"), buf);
333 inode->add_child_copy ((*i)->state);
335 freeze_node->add_child_nocopy (*inode);
338 root.add_child_nocopy (*freeze_node);
341 /* Alignment: act as a proxy for the diskstream */
343 XMLNode* align_node = new XMLNode (X_("Alignment"));
344 AlignStyle as = _diskstream->alignment_style ();
345 align_node->add_property (X_("style"), enum_2_string (as));
346 root.add_child_nocopy (*align_node);
348 root.add_property (X_("mode"), enum_2_string (_mode));
350 /* we don't return diskstream state because we don't
351 own the diskstream exclusively. control of the diskstream
352 state is ceded to the Session, even if we create the
356 _diskstream->id().print (buf, sizeof (buf));
357 root.add_property ("diskstream-id", buf);
359 root.add_child_nocopy (_rec_enable_control->get_state());
365 AudioTrack::set_state_part_two ()
369 LocaleGuard lg (X_("POSIX"));
371 /* This is called after all session state has been restored but before
372 have been made ports and connections are established.
375 if (pending_state == 0) {
379 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
381 _freeze_record.state = Frozen;
383 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
386 _freeze_record.processor_info.clear ();
388 if ((prop = fnode->property (X_("playlist"))) != 0) {
389 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
391 _freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
393 _freeze_record.playlist.reset ();
394 _freeze_record.state = NoFreeze;
399 if ((prop = fnode->property (X_("state"))) != 0) {
400 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
403 XMLNodeConstIterator citer;
404 XMLNodeList clist = fnode->children();
406 for (citer = clist.begin(); citer != clist.end(); ++citer) {
407 if ((*citer)->name() != X_("processor")) {
411 if ((prop = (*citer)->property (X_("id"))) == 0) {
415 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
416 boost::shared_ptr<Processor>());
417 frii->id = prop->value ();
418 _freeze_record.processor_info.push_back (frii);
422 /* Alignment: act as a proxy for the diskstream */
424 if ((fnode = find_named_node (*pending_state, X_("Alignment"))) != 0) {
426 if ((prop = fnode->property (X_("style"))) != 0) {
428 /* fix for older sessions from before EnumWriter */
432 if (prop->value() == "capture") {
433 pstr = "CaptureTime";
434 } else if (prop->value() == "existing") {
435 pstr = "ExistingMaterial";
437 pstr = prop->value();
440 AlignStyle as = AlignStyle (string_2_enum (pstr, as));
441 _diskstream->set_persistent_align_style (as);
448 AudioTrack::roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame, int declick,
449 bool can_record, bool rec_monitors_input)
454 nframes_t transport_frame;
455 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
458 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
460 // automation snapshot can also be called from the non-rt context
461 // and it uses the redirect list, so we take the lock out here
462 automation_snapshot (start_frame, false);
467 if (n_outputs().n_total() == 0 && _processors.empty()) {
476 transport_frame = _session.transport_frame();
478 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
480 /* need to do this so that the diskstream sets its
481 playback distance to zero, thus causing diskstream::commit
484 return diskstream->process (transport_frame, 0, can_record, rec_monitors_input);
488 _amp->apply_gain_automation(false);
490 if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input)) != 0) {
495 /* special condition applies */
497 if (_meter_point == MeterInput) {
498 _input->process_input (_meter, start_frame, end_frame, nframes);
501 if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
503 /* not actually recording, but we want to hear the input material anyway,
504 at least potentially (depending on monitoring options)
507 passthru (start_frame, end_frame, nframes, false);
509 } else if ((b = diskstream->playback_buffer(0)) != 0) {
512 XXX is it true that the earlier test on n_outputs()
513 means that we can avoid checking it again here? i think
514 so, because changing the i/o configuration of an IO
515 requires holding the AudioEngine lock, which we hold
516 while in the process() tree.
520 /* copy the diskstream data to all output buffers */
522 size_t limit = _input->n_ports().n_audio();
523 BufferSet& bufs = _session.get_scratch_buffers ();
524 const size_t blimit = bufs.count().n_audio();
529 if (limit > blimit) {
531 /* example case: auditioner configured for stereo output,
532 but loaded with an 8 channel file. there are only
533 2 passthrough buffers, but n_process_buffers() will
536 arbitrary decision: map all channels in the diskstream
537 to the outputs available.
540 float scaling = limit/blimit;
542 for (i = 0, n = 1; i < blimit; ++i, ++n) {
544 /* first time through just copy a channel into
548 Sample* bb = bufs.get_audio (i).data();
550 for (nframes_t xx = 0; xx < nframes; ++xx) {
551 bb[xx] = b[xx] * scaling;
554 if (n < diskstream->n_channels().n_audio()) {
555 tmpb = diskstream->playback_buffer(n);
562 for (;i < limit; ++i, ++n) {
564 /* for all remaining channels, sum with existing
565 data in the output buffers
568 bufs.get_audio (i%blimit).accumulate_with_gain_from (b, nframes, 0, scaling);
570 if (n < diskstream->n_channels().n_audio()) {
571 tmpb = diskstream->playback_buffer(n);
582 for (i = 0, n = 1; i < limit; ++i, ++n) {
583 memcpy (bufs.get_audio (i).data(), b, sizeof (Sample) * nframes);
584 if (n < diskstream->n_channels().n_audio()) {
585 tmpb = diskstream->playback_buffer(n);
592 /* try to leave any MIDI buffers alone */
595 chn.set_audio (limit);
596 chn.set_midi (_input->n_ports().n_midi());
597 bufs.set_count (chn);
600 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
602 if (!diskstream->record_enabled() && _session.transport_rolling()) {
603 #ifdef XXX_MOVE_THIS_TO_AMP
604 Glib::Mutex::Lock am (data().control_lock(), Glib::TRY_LOCK);
606 if (am.locked() && gain_control()->automation_playback()) {
607 _amp->apply_gain_automation(
608 gain_control()->list()->curve().rt_safe_get_vector (
609 start_frame, end_frame, _session.gain_automation_buffer(), nframes));
614 process_output_buffers (bufs, start_frame, end_frame, nframes, (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick);
617 /* problem with the diskstream; just be quiet for a bit */
625 AudioTrack::export_stuff (BufferSet& buffers, sframes_t start, nframes_t nframes, bool enable_processing)
627 gain_t gain_buffer[nframes];
628 float mix_buffer[nframes];
629 ProcessorList::iterator i;
630 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
632 Glib::RWLock::ReaderLock rlock (_processor_lock);
634 boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist());
637 assert(buffers.get_audio(0).capacity() >= nframes);
639 if (apl->read (buffers.get_audio(0).data(), mix_buffer, gain_buffer, start, nframes) != nframes) {
643 assert(buffers.count().n_audio() >= 1);
645 Sample* b = buffers.get_audio(0).data();
646 BufferSet::audio_iterator bi = buffers.audio_begin();
648 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
649 if (n < diskstream->n_channels().n_audio()) {
650 if (apl->read (bi->data(), mix_buffer, gain_buffer, start, nframes, n) != nframes) {
656 /* duplicate last across remaining buffers */
657 memcpy (bi->data(), b, sizeof (Sample) * nframes);
661 // If no processing is required, there's no need to go any further.
662 if (!enable_processing) {
666 /* note: only run processors during export. other layers in the machinery
667 will already have checked that there are no external port processors.
670 for (i = _processors.begin(); i != _processors.end(); ++i) {
671 boost::shared_ptr<Processor> processor;
672 if ((processor = boost::dynamic_pointer_cast<Processor>(*i)) != 0) {
673 processor->run (buffers, start, start+nframes, nframes, true);
680 boost::shared_ptr<Region>
681 AudioTrack::bounce (InterThreadInfo& itt)
683 vector<boost::shared_ptr<Source> > srcs;
684 return _session.write_one_track (*this, _session.current_start_frame(), _session.current_end_frame(), false, srcs, itt);
687 boost::shared_ptr<Region>
688 AudioTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt, bool enable_processing)
690 vector<boost::shared_ptr<Source> > srcs;
691 return _session.write_one_track (*this, start, end, false, srcs, itt, enable_processing);
695 AudioTrack::freeze (InterThreadInfo& itt)
697 vector<boost::shared_ptr<Source> > srcs;
698 string new_playlist_name;
699 boost::shared_ptr<Playlist> new_playlist;
702 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
704 if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist())) == 0) {
710 while (n < (UINT_MAX-1)) {
714 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
716 if (_session.playlists->by_name (candidate) == 0) {
717 new_playlist_name = candidate;
725 if (n == (UINT_MAX-1)) {
726 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
727 " to create another one"), _freeze_record.playlist->name())
732 boost::shared_ptr<Region> res;
734 if ((res = _session.write_one_track (*this, _session.current_start_frame(), _session.current_end_frame(), true, srcs, itt)) == 0) {
738 _freeze_record.processor_info.clear ();
741 Glib::RWLock::ReaderLock lm (_processor_lock);
743 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
745 boost::shared_ptr<Processor> processor;
747 if ((processor = boost::dynamic_pointer_cast<Processor>(*r)) != 0) {
749 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo ((*r)->get_state(), processor);
751 frii->id = processor->id();
753 _freeze_record.processor_info.push_back (frii);
755 /* now deactivate the processor */
757 processor->deactivate ();
758 _session.set_dirty ();
763 new_playlist = PlaylistFactory::create (DataType::AUDIO, _session, new_playlist_name, false);
765 _freeze_record.gain = _amp->gain();
766 _freeze_record.gain_automation_state = _amp->gain_control()->automation_state();
767 /* XXX need main outs automation state _freeze_record.pan_automation_state = _mainpanner->automation_state(); */
769 region_name = new_playlist_name;
771 /* create a new region from all filesources, keep it private */
773 boost::shared_ptr<Region> region (RegionFactory::create (srcs, 0,
774 srcs[0]->length(srcs[0]->timeline_position()),
776 (Region::Flag) (Region::WholeFile|Region::DefaultFlags),
779 new_playlist->set_orig_diskstream_id (diskstream->id());
780 new_playlist->add_region (region, _session.current_start_frame());
781 new_playlist->set_frozen (true);
782 region->set_locked (true);
784 diskstream->use_playlist (boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
785 diskstream->set_record_enabled (false);
787 /* reset stuff that has already been accounted for in the freeze process */
789 set_gain (1.0, this);
790 _amp->gain_control()->set_automation_state (Off);
791 /* XXX need to use _main_outs _panner->set_automation_state (Off); */
793 _freeze_record.state = Frozen;
794 FreezeChange(); /* EMIT SIGNAL */
798 AudioTrack::unfreeze ()
800 if (_freeze_record.playlist) {
801 audio_diskstream()->use_playlist (_freeze_record.playlist);
804 Glib::RWLock::ReaderLock lm (_processor_lock); // should this be a write lock? jlc
805 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
806 for (vector<FreezeRecordProcessorInfo*>::iterator ii = _freeze_record.processor_info.begin(); ii != _freeze_record.processor_info.end(); ++ii) {
807 if ((*ii)->id == (*i)->id()) {
808 (*i)->set_state (((*ii)->state), Stateful::current_state_version);
815 _freeze_record.playlist.reset ();
816 set_gain (_freeze_record.gain, this);
817 _amp->gain_control()->set_automation_state (_freeze_record.gain_automation_state);
818 /* XXX need to use _main_outs _panner->set_automation_state (_freeze_record.pan_automation_state); */
821 _freeze_record.state = UnFrozen;
822 FreezeChange (); /* EMIT SIGNAL */