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)
68 _set_state (node, false);
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 return _set_state (node, true);
195 AudioTrack::_set_state (const XMLNode& node, bool call_base)
197 const XMLProperty *prop;
198 XMLNodeConstIterator iter;
201 if (Route::_set_state (node, call_base)) {
206 if ((prop = node.property (X_("mode"))) != 0) {
207 if (prop->value() == X_("normal")) {
209 } else if (prop->value() == X_("destructive")) {
212 warning << string_compose ("unknown audio track mode \"%1\" seen and ignored", prop->value()) << endmsg;
219 if ((prop = node.property ("diskstream-id")) == 0) {
221 /* some old sessions use the diskstream name rather than the ID */
223 if ((prop = node.property ("diskstream")) == 0) {
224 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
229 if (use_diskstream (prop->value())) {
235 PBD::ID id (prop->value());
237 if (use_diskstream (id)) {
244 XMLNodeConstIterator niter;
247 nlist = node.children();
248 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
251 if (child->name() == X_("remote_control")) {
252 if ((prop = child->property (X_("id"))) != 0) {
254 sscanf (prop->value().c_str(), "%d", &x);
255 set_remote_control_id (x);
258 } else if (child->name() == X_("recenable")) {
259 _rec_enable_control.set_state (*child);
260 _session.add_controllable (&_rec_enable_control);
264 pending_state = const_cast<XMLNode*> (&node);
266 _session.StateReady.connect (mem_fun (*this, &AudioTrack::set_state_part_two));
272 AudioTrack::state(bool full_state)
274 XMLNode& root (Route::state(full_state));
275 XMLNode* freeze_node;
278 if (_freeze_record.playlist) {
281 freeze_node = new XMLNode (X_("freeze-info"));
282 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
283 snprintf (buf, sizeof (buf), "%d", (int) _freeze_record.state);
284 freeze_node->add_property ("state", buf);
286 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
287 inode = new XMLNode (X_("insert"));
288 (*i)->id.print (buf, sizeof (buf));
289 inode->add_property (X_("id"), buf);
290 inode->add_child_copy ((*i)->state);
292 freeze_node->add_child_nocopy (*inode);
295 root.add_child_nocopy (*freeze_node);
298 /* Alignment: act as a proxy for the diskstream */
300 XMLNode* align_node = new XMLNode (X_("alignment"));
301 switch (_diskstream->alignment_style()) {
302 case ExistingMaterial:
303 snprintf (buf, sizeof (buf), X_("existing"));
306 snprintf (buf, sizeof (buf), X_("capture"));
309 align_node->add_property (X_("style"), buf);
310 root.add_child_nocopy (*align_node);
312 XMLNode* remote_control_node = new XMLNode (X_("remote_control"));
313 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
314 remote_control_node->add_property (X_("id"), buf);
315 root.add_child_nocopy (*remote_control_node);
319 root.add_property (X_("mode"), X_("normal"));
322 root.add_property (X_("mode"), X_("destructive"));
326 /* we don't return diskstream state because we don't
327 own the diskstream exclusively. control of the diskstream
328 state is ceded to the Session, even if we create the
332 _diskstream->id().print (buf, sizeof (buf));
333 root.add_property ("diskstream-id", buf);
335 root.add_child_nocopy (_rec_enable_control.get_state());
341 AudioTrack::set_state_part_two ()
345 LocaleGuard lg (X_("POSIX"));
347 /* This is called after all session state has been restored but before
348 have been made ports and connections are established.
351 if (pending_state == 0) {
355 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
358 _freeze_record.have_mementos = false;
359 _freeze_record.state = Frozen;
361 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
364 _freeze_record.insert_info.clear ();
366 if ((prop = fnode->property (X_("playlist"))) != 0) {
367 Playlist* pl = _session.playlist_by_name (prop->value());
369 _freeze_record.playlist = dynamic_cast<AudioPlaylist*> (pl);
371 _freeze_record.playlist = 0;
372 _freeze_record.state = NoFreeze;
377 if ((prop = fnode->property (X_("state"))) != 0) {
378 _freeze_record.state = (FreezeState) atoi (prop->value().c_str());
381 XMLNodeConstIterator citer;
382 XMLNodeList clist = fnode->children();
384 for (citer = clist.begin(); citer != clist.end(); ++citer) {
385 if ((*citer)->name() != X_("insert")) {
389 if ((prop = (*citer)->property (X_("id"))) == 0) {
393 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()),
394 boost::shared_ptr<Insert>());
395 frii->id = prop->value ();
396 _freeze_record.insert_info.push_back (frii);
400 /* Alignment: act as a proxy for the diskstream */
402 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
404 if ((prop = fnode->property (X_("style"))) != 0) {
405 if (prop->value() == "existing") {
406 _diskstream->set_persistent_align_style (ExistingMaterial);
407 } else if (prop->value() == "capture") {
408 _diskstream->set_persistent_align_style (CaptureTime);
416 AudioTrack::n_process_buffers ()
418 return max ((uint32_t) _diskstream->n_channels(), redirect_max_outs);
422 AudioTrack::passthru_silence (nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset, int declick, bool meter)
424 uint32_t nbufs = n_process_buffers ();
425 process_output_buffers (_session.get_silent_buffers (nbufs), nbufs, start_frame, end_frame, nframes, offset, true, declick, meter);
429 AudioTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
430 bool session_state_changing, bool can_record, bool rec_monitors_input)
432 if (n_outputs() == 0) {
437 silence (nframes, offset);
441 if (session_state_changing) {
443 /* XXX is this safe to do against transport state changes? */
445 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
449 audio_diskstream()->check_record_status (start_frame, nframes, can_record);
453 if (_have_internal_generator) {
454 /* since the instrument has no input streams,
455 there is no reason to send any signal
461 if (Config->get_auto_input()) {
462 if (Config->get_monitoring_model() == SoftwareMonitoring) {
463 send_silence = false;
468 if (_diskstream->record_enabled()) {
469 if (Config->get_monitoring_model() == SoftwareMonitoring) {
470 send_silence = false;
480 apply_gain_automation = false;
484 /* if we're sending silence, but we want the meters to show levels for the signal,
488 if (_have_internal_generator) {
489 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
491 if (_meter_point == MeterInput) {
492 just_meter_input (start_frame, end_frame, nframes, offset);
494 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
499 /* we're sending signal, but we may still want to meter the input.
502 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
509 AudioTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
510 bool can_record, bool rec_monitors_input)
515 nframes_t transport_frame;
516 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
519 Glib::RWLock::ReaderLock lm (redirect_lock, Glib::TRY_LOCK);
521 // automation snapshot can also be called from the non-rt context
522 // and it uses the redirect list, so we take the lock out here
523 automation_snapshot (start_frame);
528 if (n_outputs() == 0 && _redirects.empty()) {
533 silence (nframes, offset);
537 transport_frame = _session.transport_frame();
539 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
540 /* need to do this so that the diskstream sets its
541 playback distance to zero, thus causing diskstream::commit
544 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
548 apply_gain_automation = false;
550 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
552 silence (nframes, offset);
557 /* special condition applies */
559 if (_meter_point == MeterInput) {
560 just_meter_input (start_frame, end_frame, nframes, offset);
563 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
565 /* not actually recording, but we want to hear the input material anyway,
566 at least potentially (depending on monitoring options)
569 passthru (start_frame, end_frame, nframes, offset, 0, true);
571 } else if ((b = diskstream->playback_buffer(0)) != 0) {
574 XXX is it true that the earlier test on n_outputs()
575 means that we can avoid checking it again here? i think
576 so, because changing the i/o configuration of an IO
577 requires holding the AudioEngine lock, which we hold
578 while in the process() tree.
582 /* copy the diskstream data to all output buffers */
584 vector<Sample*>& bufs = _session.get_passthru_buffers ();
585 uint32_t limit = n_process_buffers ();
591 for (i = 0, n = 1; i < limit; ++i, ++n) {
592 memcpy (bufs[i], b, sizeof (Sample) * nframes);
593 if (n < diskstream->n_channels()) {
594 tmpb = diskstream->playback_buffer(n);
601 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
603 if (!diskstream->record_enabled() && _session.transport_rolling()) {
604 Glib::Mutex::Lock am (automation_lock, Glib::TRY_LOCK);
606 if (am.locked() && gain_automation_playback()) {
607 apply_gain_automation = _gain_automation_curve.rt_safe_get_vector (start_frame, end_frame, _session.gain_automation_buffer(), nframes);
611 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));
614 /* problem with the diskstream; just be quiet for a bit */
615 silence (nframes, offset);
622 AudioTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
623 bool can_record, bool rec_monitors_input)
625 if (n_outputs() == 0 && _redirects.empty()) {
630 silence (nframes, offset);
635 apply_gain_automation = false;
637 silence (nframes, offset);
639 return audio_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
643 AudioTrack::export_stuff (vector<Sample*>& buffers, uint32_t nbufs, nframes_t start, nframes_t nframes)
645 gain_t gain_automation[nframes];
646 gain_t gain_buffer[nframes];
647 float mix_buffer[nframes];
648 RedirectList::iterator i;
649 bool post_fader_work = false;
650 gain_t this_gain = _gain;
651 vector<Sample*>::iterator bi;
653 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
655 Glib::RWLock::ReaderLock rlock (redirect_lock);
658 AudioPlaylist* const apl = dynamic_cast<AudioPlaylist*>(diskstream->playlist());
661 if (apl->read (buffers[0], mix_buffer, gain_buffer, start, nframes) != nframes) {
666 bi = buffers.begin();
669 for (; bi != buffers.end(); ++bi, ++n) {
670 if (n < diskstream->n_channels()) {
671 if (apl->read ((*bi), mix_buffer, gain_buffer, start, nframes, n) != nframes) {
677 /* duplicate last across remaining buffers */
678 memcpy ((*bi), b, sizeof (Sample) * nframes);
683 /* note: only run inserts during export. other layers in the machinery
684 will already have checked that there are no external port inserts.
687 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
688 boost::shared_ptr<Insert> insert;
690 if ((insert = boost::dynamic_pointer_cast<Insert>(*i)) != 0) {
691 switch (insert->placement()) {
693 insert->run (buffers, nbufs, nframes, 0);
696 post_fader_work = true;
702 if (_gain_automation_curve.automation_state() == Play) {
704 _gain_automation_curve.get_vector (start, start + nframes, gain_automation, nframes);
706 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
708 for (nframes_t n = 0; n < nframes; ++n) {
709 b[n] *= gain_automation[n];
715 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
717 for (nframes_t n = 0; n < nframes; ++n) {
723 if (post_fader_work) {
725 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
726 boost::shared_ptr<PluginInsert> insert;
728 if ((insert = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
729 switch ((*i)->placement()) {
733 insert->run (buffers, nbufs, nframes, 0);
744 AudioTrack::bounce (InterThreadInfo& itt)
746 vector<boost::shared_ptr<AudioSource> > srcs;
747 _session.write_one_audio_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
752 AudioTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
754 vector<boost::shared_ptr<AudioSource> > srcs;
755 _session.write_one_audio_track (*this, start, end, false, srcs, itt);
759 AudioTrack::freeze (InterThreadInfo& itt)
761 vector<boost::shared_ptr<AudioSource> > srcs;
762 string new_playlist_name;
763 Playlist* new_playlist;
766 boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
768 if ((_freeze_record.playlist = dynamic_cast<AudioPlaylist*>(diskstream->playlist())) == 0) {
774 while (n < (UINT_MAX-1)) {
778 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
780 if (_session.playlist_by_name (candidate) == 0) {
781 new_playlist_name = candidate;
789 if (n == (UINT_MAX-1)) {
790 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
791 " to create another one"), _freeze_record.playlist->name())
796 if (_session.write_one_audio_track (*this, 0, _session.current_end_frame(), true, srcs, itt)) {
800 _freeze_record.insert_info.clear ();
801 _freeze_record.have_mementos = true;
804 Glib::RWLock::ReaderLock lm (redirect_lock);
806 for (RedirectList::iterator r = _redirects.begin(); r != _redirects.end(); ++r) {
808 boost::shared_ptr<Insert> insert;
810 if ((insert = boost::dynamic_pointer_cast<Insert>(*r)) != 0) {
812 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo ((*r)->get_state(), insert);
814 frii->id = insert->id();
816 #ifdef FIX_ME_TO_WORK_WITHOUT_STATE_MANAGER
817 frii->memento = (*r)->get_memento();
819 _freeze_record.insert_info.push_back (frii);
821 /* now deactivate the insert */
823 insert->set_active (false, this);
828 new_playlist = new AudioPlaylist (_session, new_playlist_name, false);
829 region_name = new_playlist_name;
831 /* create a new region from all filesources, keep it private */
833 boost::shared_ptr<Region> region (RegionFactory::create (srcs, 0, srcs[0]->length(),
835 (AudioRegion::Flag) (AudioRegion::WholeFile|AudioRegion::DefaultFlags),
838 new_playlist->set_orig_diskstream_id (diskstream->id());
839 new_playlist->add_region (region, 0);
840 new_playlist->set_frozen (true);
841 region->set_locked (true);
843 diskstream->use_playlist (dynamic_cast<AudioPlaylist*>(new_playlist));
844 diskstream->set_record_enabled (false);
846 _freeze_record.state = Frozen;
847 FreezeChange(); /* EMIT SIGNAL */
851 AudioTrack::unfreeze ()
853 if (_freeze_record.playlist) {
854 audio_diskstream()->use_playlist (_freeze_record.playlist);
856 if (_freeze_record.have_mementos) {
858 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
864 Glib::RWLock::ReaderLock lm (redirect_lock); // should this be a write lock? jlc
865 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
866 for (vector<FreezeRecordInsertInfo*>::iterator ii = _freeze_record.insert_info.begin(); ii != _freeze_record.insert_info.end(); ++ii) {
867 if ((*ii)->id == (*i)->id()) {
868 (*i)->set_state (((*ii)->state));
875 _freeze_record.playlist = 0;
878 _freeze_record.state = UnFrozen;
879 FreezeChange (); /* EMIT SIGNAL */