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 <pbd/error.h>
21 #include <sigc++/retype.h>
22 #include <sigc++/retype_return.h>
23 #include <sigc++/bind.h>
25 #include <ardour/audio_track.h>
26 #include <ardour/audio_diskstream.h>
27 #include <ardour/session.h>
28 #include <ardour/redirect.h>
29 #include <ardour/audioregion.h>
30 #include <ardour/audiosource.h>
31 #include <ardour/region_factory.h>
32 #include <ardour/route_group_specialized.h>
33 #include <ardour/insert.h>
34 #include <ardour/audioplaylist.h>
35 #include <ardour/panner.h>
36 #include <ardour/utils.h>
41 using namespace ARDOUR;
44 AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
45 : Track (sess, name, flag, mode)
47 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (0);
49 if (_flags & Hidden) {
50 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Hidden);
52 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Recordable);
55 if (mode == Destructive) {
56 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
59 boost::shared_ptr<AudioDiskstream> ds (new AudioDiskstream (_session, name, dflags));
60 _session.add_diskstream (ds);
62 set_diskstream (boost::dynamic_pointer_cast<AudioDiskstream> (ds), this);
65 AudioTrack::AudioTrack (Session& sess, const XMLNode& node)
71 AudioTrack::~AudioTrack ()
76 AudioTrack::deprecated_use_diskstream_connections ()
78 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
80 if (diskstream->deprecated_io_node == 0) {
84 const XMLProperty* prop;
85 XMLNode& node (*diskstream->deprecated_io_node);
87 /* don't do this more than once. */
89 diskstream->deprecated_io_node = 0;
91 set_input_minimum (-1);
92 set_input_maximum (-1);
93 set_output_minimum (-1);
94 set_output_maximum (-1);
96 if ((prop = node.property ("gain")) != 0) {
97 set_gain (atof (prop->value().c_str()), this);
98 _gain = _desired_gain;
101 if ((prop = node.property ("input-connection")) != 0) {
102 Connection* c = _session.connection_by_name (prop->value());
105 error << string_compose(_("Unknown connection \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
107 if ((c = _session.connection_by_name (_("in 1"))) == 0) {
108 error << _("No input connections available as a replacement")
112 info << string_compose (_("Connection %1 was not available - \"in 1\" used instead"), prop->value())
117 use_input_connection (*c, this);
119 } else if ((prop = node.property ("inputs")) != 0) {
120 if (set_inputs (prop->value())) {
121 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
130 AudioTrack::set_diskstream (boost::shared_ptr<AudioDiskstream> ds, void *src)
133 _diskstream->set_io (*this);
134 _diskstream->set_destructive (_mode == Destructive);
136 if (audio_diskstream()->deprecated_io_node) {
138 if (!connecting_legal) {
139 ConnectingLegal.connect (mem_fun (*this, &AudioTrack::deprecated_use_diskstream_connections));
141 deprecated_use_diskstream_connections ();
145 _diskstream->set_record_enabled (false);
146 _diskstream->monitor_input (false);
148 ic_connection.disconnect();
149 ic_connection = input_changed.connect (mem_fun (*_diskstream, &Diskstream::handle_input_change));
151 DiskstreamChanged (); /* EMIT SIGNAL */
157 AudioTrack::use_diskstream (string name)
159 boost::shared_ptr<AudioDiskstream> dstream;
161 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream>(_session.diskstream_by_name (name))) == 0) {
162 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), name) << endmsg;
166 return set_diskstream (dstream, this);
170 AudioTrack::use_diskstream (const PBD::ID& id)
172 boost::shared_ptr<AudioDiskstream> dstream;
174 if ((dstream = boost::dynamic_pointer_cast<AudioDiskstream> (_session.diskstream_by_id (id))) == 0) {
175 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), id) << endmsg;
179 return set_diskstream (dstream, this);
182 boost::shared_ptr<AudioDiskstream>
183 AudioTrack::audio_diskstream() const
185 return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
189 AudioTrack::set_state (const XMLNode& node)
191 const XMLProperty *prop;
192 XMLNodeConstIterator iter;
194 if (Route::set_state (node)) {
198 if ((prop = node.property (X_("mode"))) != 0) {
199 if (prop->value() == X_("normal")) {
201 } else if (prop->value() == X_("destructive")) {
204 warning << string_compose ("unknown audio track mode \"%1\" seen and ignored", prop->value()) << endmsg;
211 if ((prop = node.property ("diskstream-id")) == 0) {
213 /* some old sessions use the diskstream name rather than the ID */
215 if ((prop = node.property ("diskstream")) == 0) {
216 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
221 if (use_diskstream (prop->value())) {
227 PBD::ID id (prop->value());
229 if (use_diskstream (id)) {
236 XMLNodeConstIterator niter;
239 nlist = node.children();
240 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
243 if (child->name() == X_("remote_control")) {
244 if ((prop = child->property (X_("id"))) != 0) {
246 sscanf (prop->value().c_str(), "%d", &x);
247 set_remote_control_id (x);
250 } else if (child->name() == X_("recenable")) {
251 _rec_enable_control.set_state (*child);
252 _session.add_controllable (&_rec_enable_control);
256 pending_state = const_cast<XMLNode*> (&node);
258 _session.StateReady.connect (mem_fun (*this, &AudioTrack::set_state_part_two));
264 AudioTrack::state(bool full_state)
266 XMLNode& root (Route::state(full_state));
267 XMLNode* freeze_node;
270 if (_freeze_record.playlist) {
273 freeze_node = new XMLNode (X_("freeze-info"));
274 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
275 snprintf (buf, sizeof (buf), "%d", (int) _freeze_record.state);
276 freeze_node->add_property ("state", buf);
278 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
279 inode = new XMLNode (X_("insert"));
280 (*i)->id.print (buf, sizeof (buf));
281 inode->add_property (X_("id"), buf);
282 inode->add_child_copy ((*i)->state);
284 freeze_node->add_child_nocopy (*inode);
287 root.add_child_nocopy (*freeze_node);
290 /* Alignment: act as a proxy for the diskstream */
292 XMLNode* align_node = new XMLNode (X_("alignment"));
293 switch (_diskstream->alignment_style()) {
294 case ExistingMaterial:
295 snprintf (buf, sizeof (buf), X_("existing"));
298 snprintf (buf, sizeof (buf), X_("capture"));
301 align_node->add_property (X_("style"), buf);
302 root.add_child_nocopy (*align_node);
304 XMLNode* remote_control_node = new XMLNode (X_("remote_control"));
305 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
306 remote_control_node->add_property (X_("id"), buf);
307 root.add_child_nocopy (*remote_control_node);
311 root.add_property (X_("mode"), X_("normal"));
314 root.add_property (X_("mode"), X_("destructive"));
318 /* we don't return diskstream state because we don't
319 own the diskstream exclusively. control of the diskstream
320 state is ceded to the Session, even if we create the
324 _diskstream->id().print (buf, sizeof (buf));
325 root.add_property ("diskstream-id", buf);
327 root.add_child_nocopy (_rec_enable_control.get_state());
333 AudioTrack::set_state_part_two ()
337 LocaleGuard lg (X_("POSIX"));
339 /* This is called after all session state has been restored but before
340 have been made ports and connections are established.
343 if (pending_state == 0) {
347 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
350 _freeze_record.have_mementos = false;
351 _freeze_record.state = Frozen;
353 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
356 _freeze_record.insert_info.clear ();
358 if ((prop = fnode->property (X_("playlist"))) != 0) {
359 Playlist* pl = _session.playlist_by_name (prop->value());
361 _freeze_record.playlist = dynamic_cast<AudioPlaylist*> (pl);
363 _freeze_record.playlist = 0;
364 _freeze_record.state = NoFreeze;
369 if ((prop = fnode->property (X_("state"))) != 0) {
370 _freeze_record.state = (FreezeState) atoi (prop->value().c_str());
373 XMLNodeConstIterator citer;
374 XMLNodeList clist = fnode->children();
376 for (citer = clist.begin(); citer != clist.end(); ++citer) {
377 if ((*citer)->name() != X_("insert")) {
381 if ((prop = (*citer)->property (X_("id"))) == 0) {
385 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()),
386 boost::shared_ptr<Insert>());
387 frii->id = prop->value ();
388 _freeze_record.insert_info.push_back (frii);
392 /* Alignment: act as a proxy for the diskstream */
394 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
396 if ((prop = fnode->property (X_("style"))) != 0) {
397 if (prop->value() == "existing") {
398 _diskstream->set_persistent_align_style (ExistingMaterial);
399 } else if (prop->value() == "capture") {
400 _diskstream->set_persistent_align_style (CaptureTime);
408 AudioTrack::n_process_buffers ()
410 return max ((uint32_t) _diskstream->n_channels(), redirect_max_outs);
414 AudioTrack::passthru_silence (nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset, int declick, bool meter)
416 uint32_t nbufs = n_process_buffers ();
417 process_output_buffers (_session.get_silent_buffers (nbufs), nbufs, start_frame, end_frame, nframes, offset, true, declick, meter);
421 AudioTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
422 bool session_state_changing, bool can_record, bool rec_monitors_input)
424 if (n_outputs() == 0) {
429 silence (nframes, offset);
433 if (session_state_changing) {
435 /* XXX is this safe to do against transport state changes? */
437 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
441 audio_diskstream()->check_record_status (start_frame, nframes, can_record);
445 if (_have_internal_generator) {
446 /* since the instrument has no input streams,
447 there is no reason to send any signal
453 if (Config->get_auto_input()) {
454 if (Config->get_monitoring_model() == SoftwareMonitoring) {
455 send_silence = false;
460 if (_diskstream->record_enabled()) {
461 if (Config->get_monitoring_model() == SoftwareMonitoring) {
462 send_silence = false;
472 apply_gain_automation = false;
476 /* if we're sending silence, but we want the meters to show levels for the signal,
480 if (_have_internal_generator) {
481 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
483 if (_meter_point == MeterInput) {
484 just_meter_input (start_frame, end_frame, nframes, offset);
486 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
491 /* we're sending signal, but we may still want to meter the input.
494 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
501 AudioTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
502 bool can_record, bool rec_monitors_input)
507 nframes_t transport_frame;
508 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
511 Glib::RWLock::ReaderLock lm (redirect_lock, Glib::TRY_LOCK);
513 // automation snapshot can also be called from the non-rt context
514 // and it uses the redirect list, so we take the lock out here
515 automation_snapshot (start_frame);
519 if (n_outputs() == 0 && _redirects.empty()) {
524 silence (nframes, offset);
528 transport_frame = _session.transport_frame();
530 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
531 /* need to do this so that the diskstream sets its
532 playback distance to zero, thus causing diskstream::commit
535 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
539 apply_gain_automation = false;
541 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
543 silence (nframes, offset);
548 /* special condition applies */
550 if (_meter_point == MeterInput) {
551 just_meter_input (start_frame, end_frame, nframes, offset);
554 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
556 /* not actually recording, but we want to hear the input material anyway,
557 at least potentially (depending on monitoring options)
560 passthru (start_frame, end_frame, nframes, offset, 0, true);
562 } else if ((b = diskstream->playback_buffer(0)) != 0) {
565 XXX is it true that the earlier test on n_outputs()
566 means that we can avoid checking it again here? i think
567 so, because changing the i/o configuration of an IO
568 requires holding the AudioEngine lock, which we hold
569 while in the process() tree.
573 /* copy the diskstream data to all output buffers */
575 vector<Sample*>& bufs = _session.get_passthru_buffers ();
576 uint32_t limit = n_process_buffers ();
582 for (i = 0, n = 1; i < limit; ++i, ++n) {
583 memcpy (bufs[i], b, sizeof (Sample) * nframes);
584 if (n < diskstream->n_channels()) {
585 tmpb = diskstream->playback_buffer(n);
592 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
594 if (!diskstream->record_enabled() && _session.transport_rolling()) {
595 Glib::Mutex::Lock am (automation_lock, Glib::TRY_LOCK);
597 if (am.locked() && gain_automation_playback()) {
598 apply_gain_automation = _gain_automation_curve.rt_safe_get_vector (start_frame, end_frame, _session.gain_automation_buffer(), nframes);
602 process_output_buffers (bufs, limit, start_frame, end_frame, nframes, offset, (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
605 /* problem with the diskstream; just be quiet for a bit */
606 silence (nframes, offset);
613 AudioTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
614 bool can_record, bool rec_monitors_input)
616 if (n_outputs() == 0 && _redirects.empty()) {
621 silence (nframes, offset);
626 apply_gain_automation = false;
628 silence (nframes, offset);
630 return audio_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
634 AudioTrack::export_stuff (vector<Sample*>& buffers, uint32_t nbufs, nframes_t start, nframes_t nframes)
636 gain_t gain_automation[nframes];
637 gain_t gain_buffer[nframes];
638 float mix_buffer[nframes];
639 RedirectList::iterator i;
640 bool post_fader_work = false;
641 gain_t this_gain = _gain;
642 vector<Sample*>::iterator bi;
644 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
646 Glib::RWLock::ReaderLock rlock (redirect_lock);
649 AudioPlaylist* const apl = dynamic_cast<AudioPlaylist*>(diskstream->playlist());
652 if (apl->read (buffers[0], mix_buffer, gain_buffer, start, nframes) != nframes) {
657 bi = buffers.begin();
660 for (; bi != buffers.end(); ++bi, ++n) {
661 if (n < diskstream->n_channels()) {
662 if (apl->read ((*bi), mix_buffer, gain_buffer, start, nframes, n) != nframes) {
668 /* duplicate last across remaining buffers */
669 memcpy ((*bi), b, sizeof (Sample) * nframes);
674 /* note: only run inserts during export. other layers in the machinery
675 will already have checked that there are no external port inserts.
678 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
679 boost::shared_ptr<Insert> insert;
681 if ((insert = boost::dynamic_pointer_cast<Insert>(*i)) != 0) {
682 switch (insert->placement()) {
684 insert->run (buffers, nbufs, nframes, 0);
687 post_fader_work = true;
693 if (_gain_automation_curve.automation_state() == Play) {
695 _gain_automation_curve.get_vector (start, start + nframes, gain_automation, nframes);
697 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
699 for (nframes_t n = 0; n < nframes; ++n) {
700 b[n] *= gain_automation[n];
706 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
708 for (nframes_t n = 0; n < nframes; ++n) {
714 if (post_fader_work) {
716 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
717 boost::shared_ptr<PluginInsert> insert;
719 if ((insert = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
720 switch ((*i)->placement()) {
724 insert->run (buffers, nbufs, nframes, 0);
735 AudioTrack::bounce (InterThreadInfo& itt)
737 vector<boost::shared_ptr<AudioSource> > srcs;
738 _session.write_one_audio_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
743 AudioTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
745 vector<boost::shared_ptr<AudioSource> > srcs;
746 _session.write_one_audio_track (*this, start, end, false, srcs, itt);
750 AudioTrack::freeze (InterThreadInfo& itt)
752 vector<boost::shared_ptr<AudioSource> > srcs;
753 string new_playlist_name;
754 Playlist* new_playlist;
757 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
759 if ((_freeze_record.playlist = dynamic_cast<AudioPlaylist*>(diskstream->playlist())) == 0) {
765 while (n < (UINT_MAX-1)) {
769 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
771 if (_session.playlist_by_name (candidate) == 0) {
772 new_playlist_name = candidate;
780 if (n == (UINT_MAX-1)) {
781 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
782 " to create another one"), _freeze_record.playlist->name())
787 if (_session.write_one_audio_track (*this, 0, _session.current_end_frame(), true, srcs, itt)) {
791 _freeze_record.insert_info.clear ();
792 _freeze_record.have_mementos = true;
795 Glib::RWLock::ReaderLock lm (redirect_lock);
797 for (RedirectList::iterator r = _redirects.begin(); r != _redirects.end(); ++r) {
799 boost::shared_ptr<Insert> insert;
801 if ((insert = boost::dynamic_pointer_cast<Insert>(*r)) != 0) {
803 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo ((*r)->get_state(), insert);
805 frii->id = insert->id();
806 frii->memento = (*r)->get_memento();
808 _freeze_record.insert_info.push_back (frii);
810 /* now deactivate the insert */
812 insert->set_active (false, this);
817 new_playlist = new AudioPlaylist (_session, new_playlist_name, false);
818 region_name = new_playlist_name;
820 /* create a new region from all filesources, keep it private */
822 boost::shared_ptr<Region> region (RegionFactory::create (srcs, 0, srcs[0]->length(),
824 (AudioRegion::Flag) (AudioRegion::WholeFile|AudioRegion::DefaultFlags),
827 new_playlist->set_orig_diskstream_id (diskstream->id());
828 new_playlist->add_region (region, 0);
829 new_playlist->set_frozen (true);
830 region->set_locked (true);
832 diskstream->use_playlist (dynamic_cast<AudioPlaylist*>(new_playlist));
833 diskstream->set_record_enabled (false);
835 _freeze_record.state = Frozen;
836 FreezeChange(); /* EMIT SIGNAL */
840 AudioTrack::unfreeze ()
842 if (_freeze_record.playlist) {
843 audio_diskstream()->use_playlist (_freeze_record.playlist);
845 if (_freeze_record.have_mementos) {
847 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
853 Glib::RWLock::ReaderLock lm (redirect_lock); // should this be a write lock? jlc
854 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
855 for (vector<FreezeRecordInsertInfo*>::iterator ii = _freeze_record.insert_info.begin(); ii != _freeze_record.insert_info.end(); ++ii) {
856 if ((*ii)->id == (*i)->id()) {
857 (*i)->set_state (((*ii)->state));
864 _freeze_record.playlist = 0;
867 _freeze_record.state = UnFrozen;
868 FreezeChange (); /* EMIT SIGNAL */