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 <boost/scoped_array.hpp>
22 #include "pbd/enumwriter.h"
23 #include "pbd/error.h"
25 #include "evoral/Curve.hpp"
27 #include "ardour/amp.h"
28 #include "ardour/audio_buffer.h"
29 #include "ardour/audio_track.h"
30 #include "ardour/audioplaylist.h"
31 #include "ardour/boost_debug.h"
32 #include "ardour/buffer_set.h"
33 #include "ardour/delivery.h"
34 #include "ardour/disk_reader.h"
35 #include "ardour/disk_writer.h"
36 #include "ardour/meter.h"
37 #include "ardour/monitor_control.h"
38 #include "ardour/playlist_factory.h"
39 #include "ardour/processor.h"
40 #include "ardour/profile.h"
41 #include "ardour/region.h"
42 #include "ardour/region_factory.h"
43 #include "ardour/session.h"
44 #include "ardour/session_playlists.h"
45 #include "ardour/source.h"
46 #include "ardour/types_convert.h"
47 #include "ardour/utils.h"
52 using namespace ARDOUR;
55 AudioTrack::AudioTrack (Session& sess, string name, TrackMode mode)
56 : Track (sess, name, PresentationInfo::AudioTrack, mode)
60 AudioTrack::~AudioTrack ()
62 if (_freeze_record.playlist && !_session.deletion_in_progress()) {
63 _freeze_record.playlist->release();
68 AudioTrack::get_auto_monitoring_state () const
70 /* This is an implementation of the truth table in doc/monitor_modes.pdf;
71 I don't think it's ever going to be too pretty too look at.
74 bool const roll = _session.transport_rolling ();
75 bool const track_rec = _disk_writer->record_enabled ();
76 bool const auto_input = _session.config.get_auto_input ();
77 bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
78 bool const tape_machine_mode = Config->get_tape_machine_mode ();
81 /* I suspect that just use actively_recording() is good enough all the
82 * time, but just to keep the semantics the same as they were before
83 * sept 26th 2012, we differentiate between the cases where punch is
84 * enabled and those where it is not.
86 * rg: sept 30 2017: Above is not the case: punch-in/out location is
87 * global session playhead position.
88 * When this method is called from process_output_buffers() we need
89 * to use delay-compensated route's process-position.
91 * NB. Disk reader/writer may also be offset by a same amount of time.
93 * Also keep in mind that _session.transport_rolling() is false during
94 * pre-roll but the disk already produces output.
99 if (_session.config.get_punch_in() || _session.config.get_punch_out()) {
100 session_rec = _session.actively_recording ();
102 session_rec = _session.get_record_enabled();
107 if (!session_rec && roll && auto_input) {
108 return MonitoringDisk;
110 return software_monitor ? MonitoringInput : MonitoringSilence;
115 if (tape_machine_mode) {
117 return MonitoringDisk;
121 if (!roll && auto_input) {
122 return software_monitor ? MonitoringInput : MonitoringSilence;
124 return MonitoringDisk;
130 abort(); /* NOTREACHED */
131 return MonitoringSilence;
135 AudioTrack::set_state (const XMLNode& node, int version)
137 if (!node.get_property (X_("mode"), _mode)) {
141 if (Profile->get_trx() && _mode == Destructive) {
142 /* Tracks does not support destructive tracks and trying to
143 handle it as a normal track would be wrong.
145 error << string_compose (_("%1: this session uses destructive tracks, which are not supported"), PROGRAM_NAME) << endmsg;
149 if (Track::set_state (node, version)) {
153 pending_state = const_cast<XMLNode*> (&node);
155 if (_session.state_of_the_state() & Session::Loading) {
156 _session.StateReady.connect_same_thread (*this, boost::bind (&AudioTrack::set_state_part_two, this));
158 set_state_part_two ();
165 AudioTrack::state (bool save_template)
167 XMLNode& root (Track::state (save_template));
168 XMLNode* freeze_node;
170 if (_freeze_record.playlist) {
173 freeze_node = new XMLNode (X_("freeze-info"));
174 freeze_node->set_property ("playlist", _freeze_record.playlist->name());
175 freeze_node->set_property ("state", _freeze_record.state);
177 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
178 inode = new XMLNode (X_("processor"));
179 inode->set_property (X_ ("id"), (*i)->id.to_s ());
180 inode->add_child_copy ((*i)->state);
182 freeze_node->add_child_nocopy (*inode);
185 root.add_child_nocopy (*freeze_node);
188 root.set_property (X_("mode"), _mode);
194 AudioTrack::set_state_part_two ()
197 XMLProperty const * prop;
199 /* This is called after all session state has been restored but before
200 have been made ports and connections are established.
203 if (pending_state == 0) {
207 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
209 _freeze_record.state = Frozen;
211 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
214 _freeze_record.processor_info.clear ();
216 if ((prop = fnode->property (X_("playlist"))) != 0) {
217 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
219 _freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
220 _freeze_record.playlist->use();
222 _freeze_record.playlist.reset ();
223 _freeze_record.state = NoFreeze;
228 fnode->get_property (X_("state"), _freeze_record.state);
230 XMLNodeConstIterator citer;
231 XMLNodeList clist = fnode->children();
233 for (citer = clist.begin(); citer != clist.end(); ++citer) {
234 if ((*citer)->name() != X_("processor")) {
238 if ((prop = (*citer)->property (X_("id"))) == 0) {
242 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
243 boost::shared_ptr<Processor>());
244 frii->id = prop->value ();
245 _freeze_record.processor_info.push_back (frii);
251 AudioTrack::export_stuff (BufferSet& buffers, samplepos_t start, samplecnt_t nframes,
252 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze)
254 boost::scoped_array<gain_t> gain_buffer (new gain_t[nframes]);
255 boost::scoped_array<Sample> mix_buffer (new Sample[nframes]);
257 Glib::Threads::RWLock::ReaderLock rlock (_processor_lock);
259 boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(playlist());
262 assert(buffers.count().n_audio() >= 1);
263 assert ((samplecnt_t) buffers.get_audio(0).capacity() >= nframes);
265 if (apl->read (buffers.get_audio(0).data(), mix_buffer.get(), gain_buffer.get(), start, nframes) != nframes) {
270 Sample* b = buffers.get_audio(0).data();
271 BufferSet::audio_iterator bi = buffers.audio_begin();
273 for ( ; bi != buffers.audio_end(); ++bi, ++n) {
274 if (n < _disk_reader->output_streams().n_audio()) {
275 if (apl->read (bi->data(), mix_buffer.get(), gain_buffer.get(), start, nframes, n) != nframes) {
280 /* duplicate last across remaining buffers */
281 memcpy (bi->data(), b, sizeof (Sample) * nframes);
285 bounce_process (buffers, start, nframes, endpoint, include_endpoint, for_export, for_freeze);
291 AudioTrack::bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const
293 if (!endpoint && !include_endpoint) {
294 /* no processing - just read from the playlist and create new
295 files: always possible.
300 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
301 uint32_t naudio = n_inputs().n_audio();
303 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
305 /* if we're not including the endpoint, potentially stop
306 right here before we test matching i/o valences.
309 if (!include_endpoint && (*r) == endpoint) {
313 /* ignore any processors that do routing, because we will not
314 * use them during a bounce/freeze/export operation.
317 if ((*r)->does_routing()) {
321 /* does the output from the last considered processor match the
325 if (naudio != (*r)->input_streams().n_audio()) {
329 /* we're including the endpoint - if we just hit it,
333 if ((*r) == endpoint) {
337 /* save outputs of this processor to test against inputs
341 naudio = (*r)->output_streams().n_audio();
347 boost::shared_ptr<Region>
348 AudioTrack::bounce (InterThreadInfo& itt)
350 return bounce_range (_session.current_start_sample(), _session.current_end_sample(), itt, main_outs(), false);
353 boost::shared_ptr<Region>
354 AudioTrack::bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo& itt,
355 boost::shared_ptr<Processor> endpoint, bool include_endpoint)
357 vector<boost::shared_ptr<Source> > srcs;
358 return _session.write_one_track (*this, start, end, false, srcs, itt, endpoint, include_endpoint, false, false);
362 AudioTrack::freeze_me (InterThreadInfo& itt)
364 vector<boost::shared_ptr<Source> > srcs;
365 string new_playlist_name;
366 boost::shared_ptr<Playlist> new_playlist;
370 if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(playlist())) == 0) {
376 while (n < (UINT_MAX-1)) {
380 candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
382 if (_session.playlists->by_name (candidate) == 0) {
383 new_playlist_name = candidate;
391 if (n == (UINT_MAX-1)) {
392 error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
393 " to create another one"), _freeze_record.playlist->name())
398 boost::shared_ptr<Region> res;
400 if ((res = _session.write_one_track (*this, _session.current_start_sample(), _session.current_end_sample(),
401 true, srcs, itt, main_outs(), false, false, true)) == 0) {
405 _freeze_record.processor_info.clear ();
408 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
410 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
412 if ((*r)->does_routing() && (*r)->active()) {
415 if (!boost::dynamic_pointer_cast<PeakMeter>(*r)) {
417 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo ((*r)->get_state(), (*r));
419 frii->id = (*r)->id();
421 _freeze_record.processor_info.push_back (frii);
423 /* now deactivate the processor, */
424 if (!boost::dynamic_pointer_cast<Amp>(*r)) {
429 _session.set_dirty ();
433 new_playlist = PlaylistFactory::create (DataType::AUDIO, _session, new_playlist_name, false);
435 /* XXX need main outs automation state _freeze_record.pan_automation_state = _mainpanner->automation_state(); */
437 region_name = new_playlist_name;
439 /* create a new region from all filesources, keep it private */
443 plist.add (Properties::start, 0);
444 plist.add (Properties::length, srcs[0]->length(srcs[0]->timeline_position()));
445 plist.add (Properties::name, region_name);
446 plist.add (Properties::whole_file, true);
448 boost::shared_ptr<Region> region (RegionFactory::create (srcs, plist, false));
450 new_playlist->set_orig_track_id (id());
451 new_playlist->add_region (region, _session.current_start_sample());
452 new_playlist->set_frozen (true);
453 region->set_locked (true);
455 use_playlist (DataType::AUDIO, boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
456 _disk_writer->set_record_enabled (false);
458 _freeze_record.playlist->use(); // prevent deletion
460 /* reset stuff that has already been accounted for in the freeze process */
462 gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
463 gain_control()->set_automation_state (Off);
465 /* XXX need to use _main_outs _panner->set_automation_state (Off); */
467 _freeze_record.state = Frozen;
468 FreezeChange(); /* EMIT SIGNAL */
472 AudioTrack::unfreeze ()
474 if (_freeze_record.playlist) {
475 _freeze_record.playlist->release();
476 use_playlist (DataType::AUDIO, _freeze_record.playlist);
479 Glib::Threads::RWLock::ReaderLock lm (_processor_lock); // should this be a write lock? jlc
480 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
481 for (vector<FreezeRecordProcessorInfo*>::iterator ii = _freeze_record.processor_info.begin(); ii != _freeze_record.processor_info.end(); ++ii) {
482 if ((*ii)->id == (*i)->id()) {
483 (*i)->set_state (((*ii)->state), Stateful::current_state_version);
490 _freeze_record.playlist.reset ();
491 /* XXX need to use _main_outs _panner->set_automation_state (_freeze_record.pan_automation_state); */
494 _freeze_record.state = UnFrozen;
495 FreezeChange (); /* EMIT SIGNAL */
498 boost::shared_ptr<AudioFileSource>
499 AudioTrack::write_source (uint32_t n)
501 assert (_disk_writer);
502 return _disk_writer->audio_write_source (n);