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>
36 #include <ardour/buffer_set.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);
60 set_diskstream (*ds, this);
63 AudioTrack::AudioTrack (Session& sess, const XMLNode& node)
69 AudioTrack::~AudioTrack ()
74 AudioTrack::deprecated_use_diskstream_connections ()
76 AudioDiskstream& diskstream = audio_diskstream();
78 if (diskstream.deprecated_io_node == 0) {
82 const XMLProperty* prop;
83 XMLNode& node (*diskstream.deprecated_io_node);
85 /* don't do this more than once. */
87 diskstream.deprecated_io_node = 0;
89 set_input_minimum (-1);
90 set_input_maximum (-1);
91 set_output_minimum (-1);
92 set_output_maximum (-1);
94 if ((prop = node.property ("gain")) != 0) {
95 set_gain (atof (prop->value().c_str()), this);
96 _gain = _desired_gain;
99 if ((prop = node.property ("input-connection")) != 0) {
100 Connection* c = _session.connection_by_name (prop->value());
103 error << string_compose(_("Unknown connection \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
105 if ((c = _session.connection_by_name (_("in 1"))) == 0) {
106 error << _("No input connections available as a replacement")
110 info << string_compose (_("Connection %1 was not available - \"in 1\" used instead"), prop->value())
115 use_input_connection (*c, this);
117 } else if ((prop = node.property ("inputs")) != 0) {
118 if (set_inputs (prop->value())) {
119 error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
128 AudioTrack::set_diskstream (AudioDiskstream& ds, void *src)
131 _diskstream->unref();
134 _diskstream = &ds.ref();
135 _diskstream->set_io (*this);
136 _diskstream->set_destructive (_mode == Destructive);
138 if (audio_diskstream().deprecated_io_node) {
140 if (!connecting_legal) {
141 ConnectingLegal.connect (mem_fun (*this, &AudioTrack::deprecated_use_diskstream_connections));
143 deprecated_use_diskstream_connections ();
147 _diskstream->set_record_enabled (false);
148 _diskstream->monitor_input (false);
150 ic_connection.disconnect();
151 ic_connection = input_changed.connect (mem_fun (*_diskstream, &Diskstream::handle_input_change));
153 DiskstreamChanged (); /* EMIT SIGNAL */
159 AudioTrack::use_diskstream (string name)
161 AudioDiskstream *dstream;
163 if ((dstream = dynamic_cast<AudioDiskstream*>(_session.diskstream_by_name (name))) == 0) {
164 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), name) << endmsg;
168 return set_diskstream (*dstream, this);
172 AudioTrack::use_diskstream (const PBD::ID& id)
174 AudioDiskstream *dstream;
176 if ((dstream = dynamic_cast<AudioDiskstream*>(_session.diskstream_by_id (id))) == 0) {
177 error << string_compose(_("AudioTrack: audio diskstream \"%1\" not known by session"), id) << endmsg;
181 return set_diskstream (*dstream, this);
185 AudioTrack::audio_diskstream() const
187 return *dynamic_cast<AudioDiskstream*>(_diskstream);
191 AudioTrack::set_state (const XMLNode& node)
193 const XMLProperty *prop;
194 XMLNodeConstIterator iter;
196 if (Route::set_state (node)) {
200 if ((prop = node.property (X_("mode"))) != 0) {
201 if (prop->value() == X_("normal")) {
203 } else if (prop->value() == X_("destructive")) {
206 warning << string_compose ("unknown audio track mode \"%1\" seen and ignored", prop->value()) << endmsg;
213 if ((prop = node.property ("diskstream-id")) == 0) {
215 /* some old sessions use the diskstream name rather than the ID */
217 if ((prop = node.property ("diskstream")) == 0) {
218 fatal << _("programming error: AudioTrack given state without diskstream!") << endmsg;
223 if (use_diskstream (prop->value())) {
229 PBD::ID id (prop->value());
231 if (use_diskstream (id)) {
238 XMLNodeConstIterator niter;
241 nlist = node.children();
242 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
245 if (child->name() == X_("remote_control")) {
246 if ((prop = child->property (X_("id"))) != 0) {
248 sscanf (prop->value().c_str(), "%d", &x);
249 set_remote_control_id (x);
254 pending_state = const_cast<XMLNode*> (&node);
256 _session.StateReady.connect (mem_fun (*this, &AudioTrack::set_state_part_two));
262 AudioTrack::state(bool full_state)
264 XMLNode& root (Route::state(full_state));
265 XMLNode* freeze_node;
268 if (_freeze_record.playlist) {
271 freeze_node = new XMLNode (X_("freeze-info"));
272 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
273 snprintf (buf, sizeof (buf), "%d", (int) _freeze_record.state);
274 freeze_node->add_property ("state", buf);
276 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
277 inode = new XMLNode (X_("insert"));
278 (*i)->id.print (buf);
279 inode->add_property (X_("id"), buf);
280 inode->add_child_copy ((*i)->state);
282 freeze_node->add_child_nocopy (*inode);
285 root.add_child_nocopy (*freeze_node);
288 /* Alignment: act as a proxy for the diskstream */
290 XMLNode* align_node = new XMLNode (X_("alignment"));
291 switch (_diskstream->alignment_style()) {
292 case ExistingMaterial:
293 snprintf (buf, sizeof (buf), X_("existing"));
296 snprintf (buf, sizeof (buf), X_("capture"));
299 align_node->add_property (X_("style"), buf);
300 root.add_child_nocopy (*align_node);
302 XMLNode* remote_control_node = new XMLNode (X_("remote_control"));
303 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
304 remote_control_node->add_property (X_("id"), buf);
305 root.add_child_nocopy (*remote_control_node);
309 root.add_property (X_("mode"), X_("normal"));
312 root.add_property (X_("mode"), X_("destructive"));
316 /* we don't return diskstream state because we don't
317 own the diskstream exclusively. control of the diskstream
318 state is ceded to the Session, even if we create the
322 _diskstream->id().print (buf);
323 root.add_property ("diskstream-id", buf);
329 AudioTrack::set_state_part_two ()
333 LocaleGuard lg (X_("POSIX"));
335 /* This is called after all session state has been restored but before
336 have been made ports and connections are established.
339 if (pending_state == 0) {
343 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
346 _freeze_record.have_mementos = false;
347 _freeze_record.state = Frozen;
349 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
352 _freeze_record.insert_info.clear ();
354 if ((prop = fnode->property (X_("playlist"))) != 0) {
355 Playlist* pl = _session.playlist_by_name (prop->value());
357 _freeze_record.playlist = dynamic_cast<AudioPlaylist*> (pl);
359 _freeze_record.playlist = 0;
360 _freeze_record.state = NoFreeze;
365 if ((prop = fnode->property (X_("state"))) != 0) {
366 _freeze_record.state = (FreezeState) atoi (prop->value().c_str());
369 XMLNodeConstIterator citer;
370 XMLNodeList clist = fnode->children();
372 for (citer = clist.begin(); citer != clist.end(); ++citer) {
373 if ((*citer)->name() != X_("insert")) {
377 if ((prop = (*citer)->property (X_("id"))) == 0) {
381 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo (*((*citer)->children().front()),
382 boost::shared_ptr<Insert>());
383 frii->id = prop->value ();
384 _freeze_record.insert_info.push_back (frii);
388 /* Alignment: act as a proxy for the diskstream */
390 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
392 if ((prop = fnode->property (X_("style"))) != 0) {
393 if (prop->value() == "existing") {
394 _diskstream->set_persistent_align_style (ExistingMaterial);
395 } else if (prop->value() == "capture") {
396 _diskstream->set_persistent_align_style (CaptureTime);
404 AudioTrack::n_process_buffers ()
406 return max (_diskstream->n_channels(), redirect_max_outs);
410 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)
412 process_output_buffers (_session.get_silent_buffers (n_process_buffers()), start_frame, end_frame, nframes, offset, true, declick, meter);
416 AudioTrack::no_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset,
417 bool session_state_changing, bool can_record, bool rec_monitors_input)
419 if (n_outputs().get_total() == 0) {
424 silence (nframes, offset);
428 if (session_state_changing) {
430 /* XXX is this safe to do against transport state changes? */
432 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
436 audio_diskstream().check_record_status (start_frame, nframes, can_record);
440 if (_have_internal_generator) {
441 /* since the instrument has no input streams,
442 there is no reason to send any signal
448 if (_session.get_auto_input()) {
449 if (Config->get_use_sw_monitoring()) {
450 send_silence = false;
455 if (_diskstream->record_enabled()) {
456 if (Config->get_use_sw_monitoring()) {
457 send_silence = false;
467 apply_gain_automation = false;
471 /* if we're sending silence, but we want the meters to show levels for the signal,
475 if (_have_internal_generator) {
476 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
478 if (_meter_point == MeterInput) {
479 just_meter_input (start_frame, end_frame, nframes, offset);
481 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
486 /* we're sending signal, but we may still want to meter the input.
489 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
496 AudioTrack::roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset, int declick,
497 bool can_record, bool rec_monitors_input)
502 jack_nframes_t transport_frame;
503 AudioDiskstream& diskstream = audio_diskstream();
506 Glib::RWLock::ReaderLock lm (redirect_lock, Glib::TRY_LOCK);
508 // automation snapshot can also be called from the non-rt context
509 // and it uses the redirect list, so we take the lock out here
510 automation_snapshot (start_frame);
514 if (n_outputs().get_total() == 0 && _redirects.empty()) {
519 silence (nframes, offset);
523 transport_frame = _session.transport_frame();
525 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
526 /* need to do this so that the diskstream sets its
527 playback distance to zero, thus causing diskstream::commit
530 return diskstream.process (transport_frame, 0, 0, can_record, rec_monitors_input);
534 apply_gain_automation = false;
536 if ((dret = diskstream.process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
538 silence (nframes, offset);
543 /* special condition applies */
545 if (_meter_point == MeterInput) {
546 just_meter_input (start_frame, end_frame, nframes, offset);
549 if (diskstream.record_enabled() && !can_record && !_session.get_auto_input()) {
551 /* not actually recording, but we want to hear the input material anyway,
552 at least potentially (depending on monitoring options)
555 passthru (start_frame, end_frame, nframes, offset, 0, true);
557 } else if ((b = diskstream.playback_buffer(0)) != 0) {
560 XXX is it true that the earlier test on n_outputs()
561 means that we can avoid checking it again here? i think
562 so, because changing the i/o configuration of an IO
563 requires holding the AudioEngine lock, which we hold
564 while in the process() tree.
568 /* copy the diskstream data to all output buffers */
570 const size_t limit = n_process_buffers().get(DataType::AUDIO);
571 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
576 for (i = 0, n = 1; i < limit; ++i, ++n) {
577 memcpy (bufs.get_audio(i).data(nframes), b, sizeof (Sample) * nframes);
578 if (n < diskstream.n_channels().get(DataType::AUDIO)) {
579 tmpb = diskstream.playback_buffer(n);
586 /* don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
588 if (!diskstream.record_enabled() && _session.transport_rolling()) {
589 Glib::Mutex::Lock am (automation_lock, Glib::TRY_LOCK);
591 if (am.locked() && gain_automation_playback()) {
592 apply_gain_automation = _gain_automation_curve.rt_safe_get_vector (start_frame, end_frame, _session.gain_automation_buffer(), nframes);
596 process_output_buffers (bufs, start_frame, end_frame, nframes, offset, (!_session.get_record_enabled() || !_session.get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
599 /* problem with the diskstream; just be quiet for a bit */
600 silence (nframes, offset);
607 AudioTrack::silent_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t offset,
608 bool can_record, bool rec_monitors_input)
610 if (n_outputs().get_total() == 0 && _redirects.empty()) {
615 silence (nframes, offset);
620 apply_gain_automation = false;
622 silence (nframes, offset);
624 return audio_diskstream().process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
628 AudioTrack::export_stuff (BufferSet& buffers, jack_nframes_t start, jack_nframes_t nframes)
630 gain_t gain_automation[nframes];
631 gain_t gain_buffer[nframes];
632 float mix_buffer[nframes];
633 RedirectList::iterator i;
634 bool post_fader_work = false;
635 gain_t this_gain = _gain;
636 AudioDiskstream& diskstream = audio_diskstream();
638 Glib::RWLock::ReaderLock rlock (redirect_lock);
641 AudioPlaylist* const apl = dynamic_cast<AudioPlaylist*>(diskstream.playlist());
644 if (apl->read (buffers.get_audio(nframes).data(nframes),
645 mix_buffer, gain_buffer, start, nframes) != nframes) {
649 assert(buffers.count().get(DataType::AUDIO) >= 1);
651 Sample* b = buffers.get_audio(0).data(nframes);
652 BufferSet::audio_iterator bi = buffers.audio_begin();
654 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
655 if (n < diskstream.n_channels().get(DataType::AUDIO)) {
656 if (apl->read (bi->data(nframes), mix_buffer, gain_buffer, start, nframes, n) != nframes) {
659 b = bi->data(nframes);
662 /* duplicate last across remaining buffers */
663 memcpy (bi->data(nframes), b, sizeof (Sample) * nframes);
668 /* note: only run inserts during export. other layers in the machinery
669 will already have checked that there are no external port inserts.
672 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
673 boost::shared_ptr<Insert> insert;
675 if ((insert = boost::dynamic_pointer_cast<Insert>(*i)) != 0) {
676 switch (insert->placement()) {
678 insert->run (buffers, start, start+nframes, nframes, 0);
681 post_fader_work = true;
687 if (_gain_automation_curve.automation_state() == Play) {
689 _gain_automation_curve.get_vector (start, start + nframes, gain_automation, nframes);
691 for (BufferSet::audio_iterator bi = buffers.audio_begin(); bi != buffers.audio_end(); ++bi) {
692 Sample *b = bi->data(nframes);
693 for (jack_nframes_t n = 0; n < nframes; ++n) {
694 b[n] *= gain_automation[n];
700 for (BufferSet::audio_iterator bi = buffers.audio_begin(); bi != buffers.audio_end(); ++bi) {
701 Sample *b = bi->data(nframes);
702 for (jack_nframes_t n = 0; n < nframes; ++n) {
708 if (post_fader_work) {
710 for (i = _redirects.begin(); i != _redirects.end(); ++i) {
711 boost::shared_ptr<PluginInsert> insert;
713 if ((insert = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
714 switch ((*i)->placement()) {
718 insert->run (buffers, start, start+nframes, nframes, 0);
729 AudioTrack::bounce (InterThreadInfo& itt)
731 vector<Source*> srcs;
732 _session.write_one_audio_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
737 AudioTrack::bounce_range (jack_nframes_t start, jack_nframes_t end, InterThreadInfo& itt)
739 vector<Source*> srcs;
740 _session.write_one_audio_track (*this, start, end, false, srcs, itt);
744 AudioTrack::freeze (InterThreadInfo& itt)
746 vector<Source*> srcs;
747 string new_playlist_name;
748 Playlist* new_playlist;
752 AudioDiskstream& diskstream = audio_diskstream();
754 if ((_freeze_record.playlist = dynamic_cast<AudioPlaylist*>(diskstream.playlist())) == 0) {
760 while (n < (UINT_MAX-1)) {
764 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
766 if (_session.playlist_by_name (candidate) == 0) {
767 new_playlist_name = candidate;
775 if (n == (UINT_MAX-1)) {
776 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
777 " to create another one"), _freeze_record.playlist->name())
782 if (_session.write_one_audio_track (*this, 0, _session.current_end_frame(), true, srcs, itt)) {
786 _freeze_record.insert_info.clear ();
787 _freeze_record.have_mementos = true;
790 Glib::RWLock::ReaderLock lm (redirect_lock);
792 for (RedirectList::iterator r = _redirects.begin(); r != _redirects.end(); ++r) {
794 boost::shared_ptr<Insert> insert;
796 if ((insert = boost::dynamic_pointer_cast<Insert>(*r)) != 0) {
798 FreezeRecordInsertInfo* frii = new FreezeRecordInsertInfo ((*r)->get_state(), insert);
800 frii->id = insert->id();
801 frii->memento = (*r)->get_memento();
803 _freeze_record.insert_info.push_back (frii);
805 /* now deactivate the insert */
807 insert->set_active (false, this);
812 new_playlist = new AudioPlaylist (_session, new_playlist_name, false);
813 region_name = new_playlist_name;
815 /* create a new region from all filesources, keep it private */
817 region = new AudioRegion (srcs, 0, srcs[0]->length(),
819 (AudioRegion::Flag) (AudioRegion::WholeFile|AudioRegion::DefaultFlags),
822 new_playlist->set_orig_diskstream_id (diskstream.id());
823 new_playlist->add_region (*region, 0);
824 new_playlist->set_frozen (true);
825 region->set_locked (true);
827 diskstream.use_playlist (dynamic_cast<AudioPlaylist*>(new_playlist));
828 diskstream.set_record_enabled (false);
830 _freeze_record.state = Frozen;
831 FreezeChange(); /* EMIT SIGNAL */
835 AudioTrack::unfreeze ()
837 if (_freeze_record.playlist) {
838 audio_diskstream().use_playlist (_freeze_record.playlist);
840 if (_freeze_record.have_mementos) {
842 for (vector<FreezeRecordInsertInfo*>::iterator i = _freeze_record.insert_info.begin(); i != _freeze_record.insert_info.end(); ++i) {
848 Glib::RWLock::ReaderLock lm (redirect_lock); // should this be a write lock? jlc
849 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
850 for (vector<FreezeRecordInsertInfo*>::iterator ii = _freeze_record.insert_info.begin(); ii != _freeze_record.insert_info.end(); ++ii) {
851 if ((*ii)->id == (*i)->id()) {
852 (*i)->set_state (((*ii)->state));
859 _freeze_record.playlist = 0;
862 _freeze_record.state = UnFrozen;
863 FreezeChange (); /* EMIT SIGNAL */