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/route_group_specialized.h>
32 #include <ardour/insert.h>
33 #include <ardour/audioplaylist.h>
34 #include <ardour/panner.h>
35 #include <ardour/utils.h>
40 using namespace ARDOUR;
43 AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
44 : Track (sess, name, flag, mode)
46 AudioDiskstream::Flag dflags = AudioDiskstream::Flag (0);
48 if (_flags & Hidden) {
49 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Hidden);
51 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Recordable);
54 if (mode == Destructive) {
55 dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
58 AudioDiskstream* ds = new AudioDiskstream (_session, name, dflags);
61 _freeze_record.state = NoFreeze;
62 _saved_meter_point = _meter_point;
65 set_diskstream (*ds, this);
68 AudioTrack::AudioTrack (Session& sess, const XMLNode& node)
71 _freeze_record.state = NoFreeze;
74 _saved_meter_point = _meter_point;
77 AudioTrack::~AudioTrack ()
85 AudioTrack::deprecated_use_diskstream_connections ()
87 AudioDiskstream& diskstream = audio_diskstream();
89 if (diskstream.deprecated_io_node == 0) {
93 const XMLProperty* prop;
94 XMLNode& node (*diskstream.deprecated_io_node);
96 /* don't do this more than once. */
98 diskstream.deprecated_io_node = 0;
100 set_input_minimum (-1);
101 set_input_maximum (-1);
102 set_output_minimum (-1);
103 set_output_maximum (-1);
105 if ((prop = node.property ("gain")) != 0) {
106 set_gain (atof (prop->value().c_str()), this);
107 _gain = _desired_gain;
110 if ((prop = node.property ("input-connection")) != 0) {
111 Connection* c = _session.connection_by_name (prop->value());
114 error << string_compose(_("Unknown connection \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
116 if ((c = _session.connection_by_name (_("in 1"))) == 0) {
117 error << _("No input connections available as a replacement")
121 info << string_compose (_("Connection %1 was not available - \"in 1\" used instead"), prop->value())
126 use_input_connection (*c, this);
128 } else if ((prop = node.property ("inputs")) != 0) {
129 if (set_inputs (prop->value())) {
130 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
139 AudioTrack::set_diskstream (AudioDiskstream& ds, void *src)
142 _diskstream->unref();
145 _diskstream = &ds.ref();
146 _diskstream->set_io (*this);
147 _diskstream->set_destructive (_mode == Destructive);
149 if (audio_diskstream().deprecated_io_node) {
151 if (!connecting_legal) {
152 ConnectingLegal.connect (mem_fun (*this, &AudioTrack::deprecated_use_diskstream_connections));
154 deprecated_use_diskstream_connections ();
158 _diskstream->set_record_enabled (false, this);
159 _diskstream->monitor_input (false);
161 ic_connection.disconnect();
162 ic_connection = input_changed.connect (mem_fun (*_diskstream, &Diskstream::handle_input_change));
164 DiskstreamChanged (src); /* EMIT SIGNAL */
170 AudioTrack::use_diskstream (string name)
172 AudioDiskstream *dstream;
174 if ((dstream = dynamic_cast<AudioDiskstream*>(_session.diskstream_by_name (name))) == 0) {
175 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), name) << endmsg;
179 return set_diskstream (*dstream, this);
183 AudioTrack::use_diskstream (const PBD::ID& id)
185 AudioDiskstream *dstream;
187 if ((dstream = dynamic_cast<AudioDiskstream*>(_session.diskstream_by_id (id))) == 0) {
188 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), id) << endmsg;
192 return set_diskstream (*dstream, this);
196 AudioTrack::record_enabled () const
198 return _diskstream->record_enabled ();
202 AudioTrack::set_record_enable (bool yn, void *src)
204 if (_freeze_record.state == Frozen) {
208 if (_mix_group && src != _mix_group && _mix_group->is_active()) {
209 _mix_group->apply (&AudioTrack::set_record_enable, yn, _mix_group);
213 /* keep track of the meter point as it was before we rec-enabled */
215 if (!_diskstream->record_enabled()) {
216 _saved_meter_point = _meter_point;
219 _diskstream->set_record_enabled (yn, src);
221 if (_diskstream->record_enabled()) {
222 set_meter_point (MeterInput, this);
224 set_meter_point (_saved_meter_point, this);
227 _rec_enable_control.Changed ();
231 AudioTrack::audio_diskstream() const
233 return *dynamic_cast<AudioDiskstream*>(_diskstream);
237 AudioTrack::set_state (const XMLNode& node)
239 const XMLProperty *prop;
240 XMLNodeConstIterator iter;
242 if (Route::set_state (node)) {
246 if ((prop = node.property (X_("mode"))) != 0) {
247 if (prop->value() == X_("normal")) {
249 } else if (prop->value() == X_("destructive")) {
252 warning << string_compose ("unknown audio track mode \"%1\" seen and ignored", prop->value()) << endmsg;
259 if ((prop = node.property ("diskstream-id")) == 0) {
261 /* some old sessions use the diskstream name rather than the ID */
263 if ((prop = node.property ("diskstream")) == 0) {
264 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
269 if (use_diskstream (prop->value())) {
275 PBD::ID id (prop->value());
277 if (use_diskstream (id)) {
284 XMLNodeConstIterator niter;
287 nlist = node.children();
288 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
291 if (child->name() == X_("remote_control")) {
292 if ((prop = child->property (X_("id"))) != 0) {
294 sscanf (prop->value().c_str(), "%d", &x);
295 set_remote_control_id (x);
300 pending_state = const_cast<XMLNode*> (&node);
302 _session.StateReady.connect (mem_fun (*this, &AudioTrack::set_state_part_two));
308 AudioTrack::state(bool full_state)
310 XMLNode& root (Route::state(full_state));
311 XMLNode* freeze_node;
314 if (_freeze_record.playlist) {
317 freeze_node = new XMLNode (X_("freeze-info"));
318 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
319 snprintf (buf, sizeof (buf), "%d", (int) _freeze_record.state);
320 freeze_node->add_property ("state", buf);
322 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
323 inode = new XMLNode (X_("insert"));
324 (*i)->id.print (buf);
325 inode->add_property (X_("id"), buf);
326 inode->add_child_copy ((*i)->state);
328 freeze_node->add_child_nocopy (*inode);
331 root.add_child_nocopy (*freeze_node);
334 /* Alignment: act as a proxy for the diskstream */
336 XMLNode* align_node = new XMLNode (X_("alignment"));
337 switch (_diskstream->alignment_style()) {
338 case ExistingMaterial:
339 snprintf (buf, sizeof (buf), X_("existing"));
342 snprintf (buf, sizeof (buf), X_("capture"));
345 align_node->add_property (X_("style"), buf);
346 root.add_child_nocopy (*align_node);
348 XMLNode* remote_control_node = new XMLNode (X_("remote_control"));
349 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
350 remote_control_node->add_property (X_("id"), buf);
351 root.add_child_nocopy (*remote_control_node);
355 root.add_property (X_("mode"), X_("normal"));
358 root.add_property (X_("mode"), X_("destructive"));
362 /* we don't return diskstream state because we don't
363 own the diskstream exclusively. control of the diskstream
364 state is ceded to the Session, even if we create the
368 _diskstream->id().print (buf);
369 root.add_property ("diskstream-id", buf);
375 AudioTrack::set_state_part_two ()
379 LocaleGuard lg (X_("POSIX"));
381 /* This is called after all session state has been restored but before
382 have been made ports and connections are established.
385 if (pending_state == 0) {
389 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
392 _freeze_record.have_mementos = false;
393 _freeze_record.state = Frozen;
395 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
398 _freeze_record.insert_info.clear ();
400 if ((prop = fnode->property (X_("playlist"))) != 0) {
401 Playlist* pl = _session.playlist_by_name (prop->value());
403 _freeze_record.playlist = dynamic_cast<AudioPlaylist*> (pl);
405 _freeze_record.playlist = 0;
406 _freeze_record.state = NoFreeze;
411 if ((prop = fnode->property (X_("state"))) != 0) {
412 _freeze_record.state = (FreezeState) atoi (prop->value().c_str());
415 XMLNodeConstIterator citer;
416 XMLNodeList clist = fnode->children();
418 for (citer = clist.begin(); citer != clist.end(); ++citer) {
419 if ((*citer)->name() != X_("insert")) {
423 if ((prop = (*citer)->property (X_("id"))) == 0) {
427 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()));
429 frii->id = prop->value ();
430 _freeze_record.insert_info.push_back (frii);
434 /* Alignment: act as a proxy for the diskstream */
436 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
438 if ((prop = fnode->property (X_("style"))) != 0) {
439 if (prop->value() == "existing") {
440 _diskstream->set_persistent_align_style (ExistingMaterial);
441 } else if (prop->value() == "capture") {
442 _diskstream->set_persistent_align_style (CaptureTime);
450 AudioTrack::n_process_buffers ()
452 return max ((uint32_t) _diskstream->n_channels(), redirect_max_outs);
456 AudioTrack::passthru_silence (jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t nframes, jack_nframes_t offset, int declick, bool meter)
458 uint32_t nbufs = n_process_buffers ();
459 process_output_buffers (_session.get_silent_buffers (nbufs), nbufs, start_frame, end_frame, nframes, offset, true, declick, meter);
463 AudioTrack::no_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset,
464 bool session_state_changing, bool can_record, bool rec_monitors_input)
466 if (n_outputs() == 0) {
471 silence (nframes, offset);
475 if (session_state_changing) {
477 /* XXX is this safe to do against transport state changes? */
479 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
483 audio_diskstream().check_record_status (start_frame, nframes, can_record);
487 if (_have_internal_generator) {
488 /* since the instrument has no input streams,
489 there is no reason to send any signal
495 if (_session.get_auto_input()) {
496 if (Config->get_use_sw_monitoring()) {
497 send_silence = false;
502 if (_diskstream->record_enabled()) {
503 if (Config->get_use_sw_monitoring()) {
504 send_silence = false;
514 apply_gain_automation = false;
518 /* if we're sending silence, but we want the meters to show levels for the signal,
522 if (_have_internal_generator) {
523 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
525 if (_meter_point == MeterInput) {
526 just_meter_input (start_frame, end_frame, nframes, offset);
528 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
533 /* we're sending signal, but we may still want to meter the input.
536 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
543 AudioTrack::roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset, int declick,
544 bool can_record, bool rec_monitors_input)
549 jack_nframes_t transport_frame;
550 AudioDiskstream& diskstream = audio_diskstream();
553 Glib::RWLock::ReaderLock lm (redirect_lock, Glib::TRY_LOCK);
555 // automation snapshot can also be called from the non-rt context
556 // and it uses the redirect list, so we take the lock out here
557 automation_snapshot (start_frame);
561 if (n_outputs() == 0 && _redirects.empty()) {
566 silence (nframes, offset);
570 transport_frame = _session.transport_frame();
572 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
573 /* need to do this so that the diskstream sets its
574 playback distance to zero, thus causing diskstream::commit
577 return diskstream.process (transport_frame, 0, 0, can_record, rec_monitors_input);
581 apply_gain_automation = false;
583 if ((dret = diskstream.process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
585 silence (nframes, offset);
590 /* special condition applies */
592 if (_meter_point == MeterInput) {
593 just_meter_input (start_frame, end_frame, nframes, offset);
596 if (diskstream.record_enabled() && !can_record && !_session.get_auto_input()) {
598 /* not actually recording, but we want to hear the input material anyway,
599 at least potentially (depending on monitoring options)
602 passthru (start_frame, end_frame, nframes, offset, 0, true);
604 } else if ((b = diskstream.playback_buffer(0)) != 0) {
607 XXX is it true that the earlier test on n_outputs()
608 means that we can avoid checking it again here? i think
609 so, because changing the i/o configuration of an IO
610 requires holding the AudioEngine lock, which we hold
611 while in the process() tree.
615 /* copy the diskstream data to all output buffers */
617 vector<Sample*>& bufs = _session.get_passthru_buffers ();
618 uint32_t limit = n_process_buffers ();
624 for (i = 0, n = 1; i < limit; ++i, ++n) {
625 memcpy (bufs[i], b, sizeof (Sample) * nframes);
626 if (n < diskstream.n_channels()) {
627 tmpb = diskstream.playback_buffer(n);
634 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
636 if (!diskstream.record_enabled() && _session.transport_rolling()) {
637 Glib::Mutex::Lock am (automation_lock, Glib::TRY_LOCK);
639 if (am.locked() && gain_automation_playback()) {
640 apply_gain_automation = _gain_automation_curve.rt_safe_get_vector (start_frame, end_frame, _session.gain_automation_buffer(), nframes);
644 process_output_buffers (bufs, limit, start_frame, end_frame, nframes, offset, (!_session.get_record_enabled() || !_session.get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
647 /* problem with the diskstream; just be quiet for a bit */
648 silence (nframes, offset);
655 AudioTrack::silent_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset,
656 bool can_record, bool rec_monitors_input)
658 if (n_outputs() == 0 && _redirects.empty()) {
663 silence (nframes, offset);
668 apply_gain_automation = false;
670 silence (nframes, offset);
672 return audio_diskstream().process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
676 AudioTrack::set_name (string str, void *src)
680 if (record_enabled() && _session.actively_recording()) {
681 /* this messes things up if done while recording */
685 if (audio_diskstream().set_name (str, src)) {
689 /* save state so that the statefile fully reflects any filename changes */
691 if ((ret = IO::set_name (str, src)) == 0) {
692 _session.save_state ("");
698 AudioTrack::export_stuff (vector<Sample*>& buffers, char * workbuf, uint32_t nbufs, jack_nframes_t start, jack_nframes_t nframes)
700 gain_t gain_automation[nframes];
701 gain_t gain_buffer[nframes];
702 float mix_buffer[nframes];
703 RedirectList::iterator i;
704 bool post_fader_work = false;
705 gain_t this_gain = _gain;
706 vector<Sample*>::iterator bi;
708 AudioDiskstream& diskstream = audio_diskstream();
710 Glib::RWLock::ReaderLock rlock (redirect_lock);
713 AudioPlaylist* const apl = dynamic_cast<AudioPlaylist*>(diskstream.playlist());
716 if (apl->read (buffers[0], mix_buffer, gain_buffer, workbuf, start, nframes) != nframes) {
721 bi = buffers.begin();
724 for (; bi != buffers.end(); ++bi, ++n) {
725 if (n < diskstream.n_channels()) {
726 if (apl->read ((*bi), mix_buffer, gain_buffer, workbuf, start, nframes, n) != nframes) {
732 /* duplicate last across remaining buffers */
733 memcpy ((*bi), b, sizeof (Sample) * nframes);
738 /* note: only run inserts during export. other layers in the machinery
739 will already have checked that there are no external port inserts.
742 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
745 if ((insert = dynamic_cast<Insert*>(*i)) != 0) {
746 switch (insert->placement()) {
748 insert->run (buffers, nbufs, nframes, 0);
751 post_fader_work = true;
757 if (_gain_automation_curve.automation_state() == Play) {
759 _gain_automation_curve.get_vector (start, start + nframes, gain_automation, nframes);
761 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
763 for (jack_nframes_t n = 0; n < nframes; ++n) {
764 b[n] *= gain_automation[n];
770 for (bi = buffers.begin(); bi != buffers.end(); ++bi) {
772 for (jack_nframes_t n = 0; n < nframes; ++n) {
778 if (post_fader_work) {
780 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
781 PluginInsert *insert;
783 if ((insert = dynamic_cast<PluginInsert*>(*i)) != 0) {
784 switch ((*i)->placement()) {
788 insert->run (buffers, nbufs, nframes, 0);
799 AudioTrack::set_latency_delay (jack_nframes_t longest_session_latency)
801 Route::set_latency_delay (longest_session_latency);
802 audio_diskstream().set_roll_delay (_roll_delay);
806 AudioTrack::bounce (InterThreadInfo& itt)
808 vector<AudioSource*> srcs;
809 _session.write_one_audio_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
814 AudioTrack::bounce_range (jack_nframes_t start, jack_nframes_t end, InterThreadInfo& itt)
816 vector<AudioSource*> srcs;
817 _session.write_one_audio_track (*this, start, end, false, srcs, itt);
821 AudioTrack::freeze (InterThreadInfo& itt)
824 vector<AudioSource*> srcs;
825 string new_playlist_name;
826 Playlist* new_playlist;
830 AudioDiskstream& diskstream = audio_diskstream();
832 if ((_freeze_record.playlist = dynamic_cast<AudioPlaylist*>(diskstream.playlist())) == 0) {
838 while (n < (UINT_MAX-1)) {
842 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
844 if (_session.playlist_by_name (candidate) == 0) {
845 new_playlist_name = candidate;
853 if (n == (UINT_MAX-1)) {
854 error << string_compose (X_("There Are too many frozen versions of playlist \"%1\""
855 " to create another one"), _freeze_record.playlist->name())
860 if (_session.write_one_audio_track (*this, 0, _session.current_end_frame(), true, srcs, itt)) {
864 _freeze_record.insert_info.clear ();
865 _freeze_record.have_mementos = true;
868 Glib::RWLock::ReaderLock lm (redirect_lock);
870 for (RedirectList::iterator r = _redirects.begin(); r != _redirects.end(); ++r) {
872 if ((insert = dynamic_cast<Insert*>(*r)) != 0) {
874 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo ((*r)->get_state());
876 frii->insert = insert;
877 frii->id = insert->id();
878 frii->memento = (*r)->get_memento();
880 _freeze_record.insert_info.push_back (frii);
882 /* now deactivate the insert */
884 insert->set_active (false, this);
889 new_playlist = new AudioPlaylist (_session, new_playlist_name, false);
890 region_name = new_playlist_name;
892 /* create a new region from all filesources, keep it private */
894 region = new AudioRegion (srcs, 0, srcs[0]->length(),
896 (AudioRegion::Flag) (AudioRegion::WholeFile|AudioRegion::DefaultFlags),
899 new_playlist->set_orig_diskstream_id (diskstream.id());
900 new_playlist->add_region (*region, 0);
901 new_playlist->set_frozen (true);
902 region->set_locked (true);
904 diskstream.use_playlist (dynamic_cast<AudioPlaylist*>(new_playlist));
905 diskstream.set_record_enabled (false, this);
907 _freeze_record.state = Frozen;
908 FreezeChange(); /* EMIT SIGNAL */
912 AudioTrack::unfreeze ()
914 if (_freeze_record.playlist) {
915 audio_diskstream().use_playlist (_freeze_record.playlist);
917 if (_freeze_record.have_mementos) {
919 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
925 Glib::RWLock::ReaderLock lm (redirect_lock); // should this be a write lock? jlc
926 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
927 for (vector<FreezeRecordInsertInfo*>::iterator ii = _freeze_record.insert_info.begin(); ii != _freeze_record.insert_info.end(); ++ii) {
928 if ((*ii)->id == (*i)->id()) {
929 (*i)->set_state (((*ii)->state));
936 _freeze_record.playlist = 0;
939 _freeze_record.state = UnFrozen;
940 FreezeChange (); /* EMIT SIGNAL */
944 AudioTrack::set_mode (TrackMode m)
949 audio_diskstream().set_destructive (m == Destructive);