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 <sigc++/retype.h>
21 #include <sigc++/retype_return.h>
22 #include <sigc++/bind.h>
24 #include <pbd/error.h>
25 #include <pbd/enumwriter.h>
27 #include <ardour/audio_track.h>
28 #include <ardour/audio_diskstream.h>
29 #include <ardour/session.h>
30 #include <ardour/redirect.h>
31 #include <ardour/audioregion.h>
32 #include <ardour/audiosource.h>
33 #include <ardour/region_factory.h>
34 #include <ardour/route_group_specialized.h>
35 #include <ardour/insert.h>
36 #include <ardour/audioplaylist.h>
37 #include <ardour/playlist_factory.h>
38 #include <ardour/panner.h>
39 #include <ardour/utils.h>
40 #include <ardour/buffer_set.h>
44 using namespace ARDOUR;
47 AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
48 : Track (sess, name, flag, mode)
50 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (0);
52 if (_flags & Hidden) {
53 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Hidden);
55 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Recordable);
58 if (mode == Destructive) {
59 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
62 boost::shared_ptr<AudioDiskstream> ds (new AudioDiskstream (_session, name, dflags));
64 _session.add_diskstream (ds);
66 set_diskstream (boost::dynamic_pointer_cast<AudioDiskstream> (ds), this);
69 AudioTrack::AudioTrack (Session& sess, const XMLNode& node)
72 _set_state (node, false);
75 AudioTrack::~AudioTrack ()
80 AudioTrack::set_mode (TrackMode m)
84 if (_diskstream->set_destructive (m == Destructive)) {
90 TrackModeChanged (); /* EMIT SIGNAL */
97 AudioTrack::can_use_mode (TrackMode m, bool& bounce_required)
101 bounce_required = false;
106 return _diskstream->can_become_destructive (bounce_required);
111 AudioTrack::deprecated_use_diskstream_connections ()
113 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
115 if (diskstream->deprecated_io_node == 0) {
119 const XMLProperty* prop;
120 XMLNode& node (*diskstream->deprecated_io_node);
122 /* don't do this more than once. */
124 diskstream->deprecated_io_node = 0;
126 set_input_minimum (ChanCount::ZERO);
127 set_input_maximum (ChanCount::INFINITE);
128 set_output_minimum (ChanCount::ZERO);
129 set_output_maximum (ChanCount::INFINITE);
131 if ((prop = node.property ("gain")) != 0) {
132 set_gain (atof (prop->value().c_str()), this);
133 _gain = _desired_gain;
136 if ((prop = node.property ("input-connection")) != 0) {
137 Connection* c = _session.connection_by_name (prop->value());
140 error << string_compose(_("Unknown connection \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
142 if ((c = _session.connection_by_name (_("in 1"))) == 0) {
143 error << _("No input connections available as a replacement")
147 info << string_compose (_("Connection %1 was not available - \"in 1\" used instead"), prop->value())
152 use_input_connection (*c, this);
154 } else if ((prop = node.property ("inputs")) != 0) {
155 if (set_inputs (prop->value())) {
156 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
165 AudioTrack::set_diskstream (boost::shared_ptr<AudioDiskstream> ds, void *src)
168 _diskstream->set_io (*this);
169 _diskstream->set_destructive (_mode == Destructive);
171 if (audio_diskstream()->deprecated_io_node) {
173 if (!connecting_legal) {
174 ConnectingLegal.connect (mem_fun (*this, &AudioTrack::deprecated_use_diskstream_connections));
176 deprecated_use_diskstream_connections ();
180 _diskstream->set_record_enabled (false);
181 _diskstream->monitor_input (false);
183 ic_connection.disconnect();
184 ic_connection = input_changed.connect (mem_fun (*_diskstream, &Diskstream::handle_input_change));
186 DiskstreamChanged (); /* EMIT SIGNAL */
192 AudioTrack::use_diskstream (string name)
194 boost::shared_ptr<AudioDiskstream> dstream;
196 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream>(_session.diskstream_by_name (name))) == 0) {
197 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), name) << endmsg;
201 return set_diskstream (dstream, this);
205 AudioTrack::use_diskstream (const PBD::ID& id)
207 boost::shared_ptr<AudioDiskstream> dstream;
209 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream> (_session.diskstream_by_id (id))) == 0) {
210 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), id) << endmsg;
214 return set_diskstream (dstream, this);
217 boost::shared_ptr<AudioDiskstream>
218 AudioTrack::audio_diskstream() const
220 return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
224 AudioTrack::set_state (const XMLNode& node)
226 return _set_state (node, true);
230 AudioTrack::_set_state (const XMLNode& node, bool call_base)
232 const XMLProperty *prop;
233 XMLNodeConstIterator iter;
236 if (Route::_set_state (node, call_base)) {
241 if ((prop = node.property (X_("mode"))) != 0) {
242 _mode = TrackMode (string_2_enum (prop->value(), _mode));
247 if ((prop = node.property ("diskstream-id")) == 0) {
249 /* some old sessions use the diskstream name rather than the ID */
251 if ((prop = node.property ("diskstream")) == 0) {
252 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
257 if (use_diskstream (prop->value())) {
263 PBD::ID id (prop->value());
265 if (use_diskstream (id)) {
272 XMLNodeConstIterator niter;
275 nlist = node.children();
276 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
279 if (child->name() == X_("recenable")) {
280 _rec_enable_control.set_state (*child);
281 _session.add_controllable (&_rec_enable_control);
285 pending_state = const_cast<XMLNode*> (&node);
287 _session.StateReady.connect (mem_fun (*this, &AudioTrack::set_state_part_two));
293 AudioTrack::state(bool full_state)
295 XMLNode& root (Route::state(full_state));
296 XMLNode* freeze_node;
299 if (_freeze_record.playlist) {
302 freeze_node = new XMLNode (X_("freeze-info"));
303 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
304 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
306 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
307 inode = new XMLNode (X_("insert"));
308 (*i)->id.print (buf, sizeof (buf));
309 inode->add_property (X_("id"), buf);
310 inode->add_child_copy ((*i)->state);
312 freeze_node->add_child_nocopy (*inode);
315 root.add_child_nocopy (*freeze_node);
318 /* Alignment: act as a proxy for the diskstream */
320 XMLNode* align_node = new XMLNode (X_("alignment"));
321 AlignStyle as = _diskstream->alignment_style ();
322 align_node->add_property (X_("style"), enum_2_string (as));
323 root.add_child_nocopy (*align_node);
325 root.add_property (X_("mode"), enum_2_string (_mode));
327 /* we don't return diskstream state because we don't
328 own the diskstream exclusively. control of the diskstream
329 state is ceded to the Session, even if we create the
333 _diskstream->id().print (buf, sizeof (buf));
334 root.add_property ("diskstream-id", buf);
336 root.add_child_nocopy (_rec_enable_control.get_state());
342 AudioTrack::set_state_part_two ()
346 LocaleGuard lg (X_("POSIX"));
348 /* This is called after all session state has been restored but before
349 have been made ports and connections are established.
352 if (pending_state == 0) {
356 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
359 _freeze_record.have_mementos = false;
360 _freeze_record.state = Frozen;
362 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
365 _freeze_record.insert_info.clear ();
367 if ((prop = fnode->property (X_("playlist"))) != 0) {
368 boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
370 _freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
372 _freeze_record.playlist.reset ();
373 _freeze_record.state = NoFreeze;
378 if ((prop = fnode->property (X_("state"))) != 0) {
379 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
382 XMLNodeConstIterator citer;
383 XMLNodeList clist = fnode->children();
385 for (citer = clist.begin(); citer != clist.end(); ++citer) {
386 if ((*citer)->name() != X_("insert")) {
390 if ((prop = (*citer)->property (X_("id"))) == 0) {
394 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()),
395 boost::shared_ptr<Insert>());
396 frii->id = prop->value ();
397 _freeze_record.insert_info.push_back (frii);
401 /* Alignment: act as a proxy for the diskstream */
403 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
405 if ((prop = fnode->property (X_("style"))) != 0) {
407 /* fix for older sessions from before EnumWriter */
411 if (prop->value() == "capture") {
412 pstr = "CaptureTime";
413 } else if (prop->value() == "existing") {
414 pstr = "ExistingMaterial";
416 pstr = prop->value();
419 AlignStyle as = AlignStyle (string_2_enum (pstr, as));
420 _diskstream->set_persistent_align_style (as);
427 AudioTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
428 bool session_state_changing, bool can_record, bool rec_monitors_input)
430 if (n_outputs().get_total() == 0) {
435 silence (nframes, offset);
439 if (session_state_changing) {
441 /* XXX is this safe to do against transport state changes? */
443 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
447 audio_diskstream()->check_record_status (start_frame, nframes, can_record);
451 if (_have_internal_generator) {
452 /* since the instrument has no input streams,
453 there is no reason to send any signal
459 if (Config->get_auto_input()) {
460 if (Config->get_monitoring_model() == SoftwareMonitoring) {
461 send_silence = false;
466 if (_diskstream->record_enabled()) {
467 if (Config->get_monitoring_model() == SoftwareMonitoring) {
468 send_silence = false;
478 apply_gain_automation = false;
482 /* if we're sending silence, but we want the meters to show levels for the signal,
486 if (_have_internal_generator) {
487 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
489 if (_meter_point == MeterInput) {
490 just_meter_input (start_frame, end_frame, nframes, offset);
492 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
497 /* we're sending signal, but we may still want to meter the input.
500 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
507 AudioTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
508 bool can_record, bool rec_monitors_input)
513 nframes_t transport_frame;
514 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
517 Glib::RWLock::ReaderLock lm (redirect_lock, Glib::TRY_LOCK);
519 // automation snapshot can also be called from the non-rt context
520 // and it uses the redirect list, so we take the lock out here
521 automation_snapshot (start_frame);
526 if (n_outputs().get_total() == 0 && _redirects.empty()) {
531 silence (nframes, offset);
535 transport_frame = _session.transport_frame();
537 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
538 /* need to do this so that the diskstream sets its
539 playback distance to zero, thus causing diskstream::commit
542 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
546 apply_gain_automation = false;
548 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
550 silence (nframes, offset);
555 /* special condition applies */
557 if (_meter_point == MeterInput) {
558 just_meter_input (start_frame, end_frame, nframes, offset);
561 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
563 /* not actually recording, but we want to hear the input material anyway,
564 at least potentially (depending on monitoring options)
567 passthru (start_frame, end_frame, nframes, offset, 0, true);
569 } else if ((b = diskstream->playback_buffer(0)) != 0) {
572 XXX is it true that the earlier test on n_outputs()
573 means that we can avoid checking it again here? i think
574 so, because changing the i/o configuration of an IO
575 requires holding the AudioEngine lock, which we hold
576 while in the process() tree.
580 /* copy the diskstream data to all output buffers */
582 const size_t limit = n_process_buffers().get(DataType::AUDIO);
583 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
588 for (i = 0, n = 1; i < limit; ++i, ++n) {
589 memcpy (bufs.get_audio(i).data(nframes), b, sizeof (Sample) * nframes);
590 if (n < diskstream->n_channels().get(DataType::AUDIO)) {
591 tmpb = diskstream->playback_buffer(n);
598 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
600 if (!diskstream->record_enabled() && _session.transport_rolling()) {
601 Glib::Mutex::Lock am (automation_lock, Glib::TRY_LOCK);
603 if (am.locked() && gain_automation_playback()) {
604 apply_gain_automation = _gain_automation_curve.rt_safe_get_vector (start_frame, end_frame, _session.gain_automation_buffer(), nframes);
608 process_output_buffers (bufs, start_frame, end_frame, nframes, offset, (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
611 /* problem with the diskstream; just be quiet for a bit */
612 silence (nframes, offset);
619 AudioTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
620 bool can_record, bool rec_monitors_input)
622 if (n_outputs().get_total() == 0 && _redirects.empty()) {
627 silence (nframes, offset);
632 apply_gain_automation = false;
634 silence (nframes, offset);
636 return audio_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
640 AudioTrack::export_stuff (BufferSet& buffers, nframes_t start, nframes_t nframes)
642 gain_t gain_automation[nframes];
643 gain_t gain_buffer[nframes];
644 float mix_buffer[nframes];
645 RedirectList::iterator i;
646 bool post_fader_work = false;
647 gain_t this_gain = _gain;
648 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
650 Glib::RWLock::ReaderLock rlock (redirect_lock);
652 boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist());
655 if (apl->read (buffers.get_audio(nframes).data(nframes),
656 mix_buffer, gain_buffer, start, nframes) != nframes) {
660 assert(buffers.count().get(DataType::AUDIO) >= 1);
662 Sample* b = buffers.get_audio(0).data(nframes);
663 BufferSet::audio_iterator bi = buffers.audio_begin();
665 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
666 if (n < diskstream->n_channels().get(DataType::AUDIO)) {
667 if (apl->read (bi->data(nframes), mix_buffer, gain_buffer, start, nframes, n) != nframes) {
670 b = bi->data(nframes);
673 /* duplicate last across remaining buffers */
674 memcpy (bi->data(nframes), b, sizeof (Sample) * nframes);
679 /* note: only run inserts during export. other layers in the machinery
680 will already have checked that there are no external port inserts.
683 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
684 boost::shared_ptr<Insert> insert;
686 if ((insert = boost::dynamic_pointer_cast<Insert>(*i)) != 0) {
687 switch (insert->placement()) {
689 insert->run (buffers, start, start+nframes, nframes, 0);
692 post_fader_work = true;
698 if (_gain_automation_curve.automation_state() == Play) {
700 _gain_automation_curve.get_vector (start, start + nframes, gain_automation, nframes);
702 for (BufferSet::audio_iterator bi = buffers.audio_begin(); bi != buffers.audio_end(); ++bi) {
703 Sample *b = bi->data(nframes);
704 for (nframes_t n = 0; n < nframes; ++n) {
705 b[n] *= gain_automation[n];
711 for (BufferSet::audio_iterator bi = buffers.audio_begin(); bi != buffers.audio_end(); ++bi) {
712 Sample *b = bi->data(nframes);
713 for (nframes_t n = 0; n < nframes; ++n) {
719 if (post_fader_work) {
721 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
722 boost::shared_ptr<PluginInsert> insert;
724 if ((insert = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
725 switch ((*i)->placement()) {
729 insert->run (buffers, start, start+nframes, nframes, 0);
740 AudioTrack::bounce (InterThreadInfo& itt)
742 vector<boost::shared_ptr<Source> > srcs;
743 _session.write_one_audio_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
748 AudioTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
750 vector<boost::shared_ptr<Source> > srcs;
751 _session.write_one_audio_track (*this, start, end, false, srcs, itt);
755 AudioTrack::freeze (InterThreadInfo& itt)
757 vector<boost::shared_ptr<Source> > srcs;
758 string new_playlist_name;
759 boost::shared_ptr<Playlist> new_playlist;
762 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
764 if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist())) == 0) {
770 while (n < (UINT_MAX-1)) {
774 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
776 if (_session.playlist_by_name (candidate) == 0) {
777 new_playlist_name = candidate;
785 if (n == (UINT_MAX-1)) {
786 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
787 " to create another one"), _freeze_record.playlist->name())
792 if (_session.write_one_audio_track (*this, _session.current_start_frame(), _session.current_end_frame(), true, srcs, itt)) {
796 _freeze_record.insert_info.clear ();
797 _freeze_record.have_mementos = true;
800 Glib::RWLock::ReaderLock lm (redirect_lock);
802 for (RedirectList::iterator r = _redirects.begin(); r != _redirects.end(); ++r) {
804 boost::shared_ptr<Insert> insert;
806 if ((insert = boost::dynamic_pointer_cast<Insert>(*r)) != 0) {
808 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo ((*r)->get_state(), insert);
810 frii->id = insert->id();
812 _freeze_record.insert_info.push_back (frii);
814 /* now deactivate the insert */
816 insert->set_active (false, this);
821 new_playlist = PlaylistFactory::create (_session, new_playlist_name, false);
822 region_name = new_playlist_name;
824 /* create a new region from all filesources, keep it private */
826 boost::shared_ptr<Region> region (RegionFactory::create (srcs, 0, srcs[0]->length(),
828 (Region::Flag) (Region::WholeFile|Region::DefaultFlags),
831 new_playlist->set_orig_diskstream_id (diskstream->id());
832 new_playlist->add_region (region, _session.current_start_frame());
833 new_playlist->set_frozen (true);
834 region->set_locked (true);
836 diskstream->use_playlist (boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
837 diskstream->set_record_enabled (false);
839 _freeze_record.state = Frozen;
840 FreezeChange(); /* EMIT SIGNAL */
844 AudioTrack::unfreeze ()
846 if (_freeze_record.playlist) {
847 audio_diskstream()->use_playlist (_freeze_record.playlist);
849 if (_freeze_record.have_mementos) {
851 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
857 Glib::RWLock::ReaderLock lm (redirect_lock); // should this be a write lock? jlc
858 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
859 for (vector<FreezeRecordInsertInfo*>::iterator ii = _freeze_record.insert_info.begin(); ii != _freeze_record.insert_info.end(); ++ii) {
860 if ((*ii)->id == (*i)->id()) {
861 (*i)->set_state (((*ii)->state));
868 _freeze_record.playlist.reset ();
871 _freeze_record.state = UnFrozen;
872 FreezeChange (); /* EMIT SIGNAL */