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/boost_debug.h"
23
#include "pbd/enumwriter.h"
24
#include "pbd/error.h"
26
#include "evoral/Curve.hpp"
28
#include "ardour/amp.h"
29
#include "ardour/audio_buffer.h"
30
#include "ardour/audio_diskstream.h"
31
#include "ardour/audio_track.h"
32
#include "ardour/audioplaylist.h"
33
#include "ardour/buffer_set.h"
34
#include "ardour/delivery.h"
35
#include "ardour/meter.h"
36
#include "ardour/playlist_factory.h"
37
#include "ardour/processor.h"
38
#include "ardour/region.h"
39
#include "ardour/region_factory.h"
40
#include "ardour/session.h"
41
#include "ardour/session_playlists.h"
42
#include "ardour/source.h"
43
#include "ardour/utils.h"
48
using namespace ARDOUR;
51
AudioTrack::AudioTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
52
: Track (sess, name, flag, mode)
56
AudioTrack::~AudioTrack ()
60
boost::shared_ptr<Diskstream>
61
AudioTrack::create_diskstream ()
63
AudioDiskstream::Flag dflags = AudioDiskstream::Flag (0);
65
if (_flags & Auditioner) {
66
dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Hidden);
68
dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Recordable);
71
if (_mode == Destructive) {
72
dflags = AudioDiskstream::Flag (dflags | AudioDiskstream::Destructive);
73
} else if (_mode == NonLayered){
74
dflags = AudioDiskstream::Flag(dflags | AudioDiskstream::NonLayered);
77
return boost::shared_ptr<AudioDiskstream> (new AudioDiskstream (_session, name(), dflags));
81
AudioTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
83
Track::set_diskstream (ds);
85
_diskstream->set_track (this);
86
_diskstream->set_destructive (_mode == Destructive);
87
_diskstream->set_non_layered (_mode == NonLayered);
89
if (audio_diskstream()->deprecated_io_node) {
91
if (!IO::connecting_legal) {
92
IO::ConnectingLegal.connect_same_thread (*this, boost::bind (&AudioTrack::deprecated_use_diskstream_connections, this));
94
deprecated_use_diskstream_connections ();
98
_diskstream->set_record_enabled (false);
99
_diskstream->request_jack_monitors_input (false);
101
DiskstreamChanged (); /* EMIT SIGNAL */
104
boost::shared_ptr<AudioDiskstream>
105
AudioTrack::audio_diskstream() const
107
return boost::dynamic_pointer_cast<AudioDiskstream>(_diskstream);
111
AudioTrack::set_mode (TrackMode m)
115
if (_diskstream->set_destructive (m == Destructive)) {
119
_diskstream->set_non_layered (m == NonLayered);
122
TrackModeChanged (); /* EMIT SIGNAL */
129
AudioTrack::can_use_mode (TrackMode m, bool& bounce_required)
134
bounce_required = false;
139
return _diskstream->can_become_destructive (bounce_required);
144
AudioTrack::deprecated_use_diskstream_connections ()
146
boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
148
if (diskstream->deprecated_io_node == 0) {
152
const XMLProperty* prop;
153
XMLNode& node (*diskstream->deprecated_io_node);
155
/* don't do this more than once. */
157
diskstream->deprecated_io_node = 0;
159
if ((prop = node.property ("gain")) != 0) {
160
_amp->set_gain (atof (prop->value().c_str()), this);
163
if ((prop = node.property ("input-connection")) != 0) {
164
boost::shared_ptr<Bundle> c = _session.bundle_by_name (prop->value());
167
error << string_compose(_("Unknown bundle \"%1\" listed for input of %2"), prop->value(), _name) << endmsg;
169
if ((c = _session.bundle_by_name (_("in 1"))) == 0) {
170
error << _("No input bundles available as a replacement")
174
info << string_compose (_("Bundle %1 was not available - \"in 1\" used instead"), prop->value())
179
_input->connect_ports_to_bundle (c, true, this);
181
} else if ((prop = node.property ("inputs")) != 0) {
182
if (_input->set_ports (prop->value())) {
183
error << string_compose(_("improper input channel list in XML node (%1)"), prop->value()) << endmsg;
192
AudioTrack::set_state (const XMLNode& node, int version)
194
const XMLProperty *prop;
196
if (Track::set_state (node, version)) {
200
if ((prop = node.property (X_("mode"))) != 0) {
201
_mode = TrackMode (string_2_enum (prop->value(), _mode));
206
pending_state = const_cast<XMLNode*> (&node);
208
if (_session.state_of_the_state() & Session::Loading) {
209
_session.StateReady.connect_same_thread (*this, boost::bind (&AudioTrack::set_state_part_two, this));
211
set_state_part_two ();
218
AudioTrack::state (bool full_state)
220
XMLNode& root (Track::state(full_state));
221
XMLNode* freeze_node;
224
if (_freeze_record.playlist) {
227
freeze_node = new XMLNode (X_("freeze-info"));
228
freeze_node->add_property ("playlist", _freeze_record.playlist->name());
229
freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
231
for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
232
inode = new XMLNode (X_("processor"));
233
(*i)->id.print (buf, sizeof (buf));
234
inode->add_property (X_("id"), buf);
235
inode->add_child_copy ((*i)->state);
237
freeze_node->add_child_nocopy (*inode);
240
root.add_child_nocopy (*freeze_node);
243
root.add_property (X_("mode"), enum_2_string (_mode));
249
AudioTrack::set_state_part_two ()
253
LocaleGuard lg (X_("POSIX"));
255
/* This is called after all session state has been restored but before
256
have been made ports and connections are established.
259
if (pending_state == 0) {
263
if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
265
_freeze_record.state = Frozen;
267
for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
270
_freeze_record.processor_info.clear ();
272
if ((prop = fnode->property (X_("playlist"))) != 0) {
273
boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
275
_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist> (pl);
277
_freeze_record.playlist.reset ();
278
_freeze_record.state = NoFreeze;
283
if ((prop = fnode->property (X_("state"))) != 0) {
284
_freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
287
XMLNodeConstIterator citer;
288
XMLNodeList clist = fnode->children();
290
for (citer = clist.begin(); citer != clist.end(); ++citer) {
291
if ((*citer)->name() != X_("processor")) {
295
if ((prop = (*citer)->property (X_("id"))) == 0) {
299
FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
300
boost::shared_ptr<Processor>());
301
frii->id = prop->value ();
302
_freeze_record.processor_info.push_back (frii);
307
/** @param need_butler to be set to true if this track now needs the butler, otherwise it can be left alone
311
AudioTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler)
313
Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
316
boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
317
framecnt_t playback_distance = diskstream->calculate_playback_distance(nframes);
318
if (can_internal_playback_seek(std::llabs(playback_distance))) {
319
/* TODO should declick */
320
internal_playback_seek(playback_distance);
325
framepos_t transport_frame;
326
boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
328
if (n_outputs().n_total() == 0 && _processors.empty()) {
334
if (_meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled())) {
340
transport_frame = _session.transport_frame();
343
framecnt_t playback_distance;
345
if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
347
/* need to do this so that the diskstream sets its
348
playback distance to zero, thus causing diskstream::commit
352
BufferSet bufs; /* empty set, no matter - nothing will happen */
354
dret = diskstream->process (bufs, transport_frame, 0, playback_distance, false);
355
need_butler = diskstream->commit (playback_distance);
360
_amp->apply_gain_automation(false);
362
BufferSet& bufs = _session.get_route_buffers (n_process_buffers ());
364
fill_buffers_with_input (bufs, _input, nframes);
366
if (_meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled())) {
367
_meter->run (bufs, start_frame, end_frame, nframes, true);
370
if ((dret = diskstream->process (bufs, transport_frame, nframes, playback_distance, (monitoring_state() == MonitoringDisk))) != 0) {
371
need_butler = diskstream->commit (playback_distance);
376
process_output_buffers (bufs, start_frame, end_frame, nframes, declick, (!diskstream->record_enabled() && _session.transport_rolling()));
378
need_butler = diskstream->commit (playback_distance);
384
AudioTrack::export_stuff (BufferSet& buffers, framepos_t start, framecnt_t nframes,
385
boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export)
387
boost::scoped_array<gain_t> gain_buffer (new gain_t[nframes]);
388
boost::scoped_array<Sample> mix_buffer (new Sample[nframes]);
389
boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
391
Glib::Threads::RWLock::ReaderLock rlock (_processor_lock);
393
boost::shared_ptr<AudioPlaylist> apl = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist());
396
assert(buffers.count().n_audio() >= 1);
397
assert ((framecnt_t) buffers.get_audio(0).capacity() >= nframes);
399
if (apl->read (buffers.get_audio(0).data(), mix_buffer.get(), gain_buffer.get(), start, nframes) != nframes) {
404
Sample* b = buffers.get_audio(0).data();
405
BufferSet::audio_iterator bi = buffers.audio_begin();
407
for ( ; bi != buffers.audio_end(); ++bi, ++n) {
408
if (n < diskstream->n_channels().n_audio()) {
409
if (apl->read (bi->data(), mix_buffer.get(), gain_buffer.get(), start, nframes, n) != nframes) {
414
/* duplicate last across remaining buffers */
415
memcpy (bi->data(), b, sizeof (Sample) * nframes);
419
// If no processing is required, there's no need to go any further.
421
if (!endpoint && !include_endpoint) {
425
for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
427
if (!include_endpoint && (*i) == endpoint) {
431
/* if we're not exporting, stop processing if we come across a routing processor.
434
if (!for_export && (*i)->does_routing()) {
438
/* even for export, don't run any processor that does routing.
440
oh, and don't bother with the peak meter either.
443
if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
444
(*i)->run (buffers, start, start+nframes, nframes, true);
447
if ((*i) == endpoint) {
456
AudioTrack::bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const
458
if (!endpoint && !include_endpoint) {
459
/* no processing - just read from the playlist and create new
460
files: always possible.
465
Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
466
uint32_t naudio = n_inputs().n_audio();
468
for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
470
/* if we're not including the endpoint, potentially stop
471
right here before we test matching i/o valences.
474
if (!include_endpoint && (*r) == endpoint) {
478
/* ignore any processors that do routing, because we will not
479
* use them during a bounce/freeze/export operation.
482
if ((*r)->does_routing()) {
486
/* does the output from the last considered processor match the
490
if (naudio != (*r)->input_streams().n_audio()) {
494
/* we're including the endpoint - if we just hit it,
498
if ((*r) == endpoint) {
502
/* save outputs of this processor to test against inputs
506
naudio = (*r)->output_streams().n_audio();
512
boost::shared_ptr<Region>
513
AudioTrack::bounce (InterThreadInfo& itt)
515
return bounce_range (_session.current_start_frame(), _session.current_end_frame(), itt, main_outs(), false);
518
boost::shared_ptr<Region>
519
AudioTrack::bounce_range (framepos_t start, framepos_t end, InterThreadInfo& itt,
520
boost::shared_ptr<Processor> endpoint, bool include_endpoint)
522
vector<boost::shared_ptr<Source> > srcs;
523
return _session.write_one_track (*this, start, end, false, srcs, itt, endpoint, include_endpoint, false);
527
AudioTrack::freeze_me (InterThreadInfo& itt)
529
vector<boost::shared_ptr<Source> > srcs;
530
string new_playlist_name;
531
boost::shared_ptr<Playlist> new_playlist;
534
boost::shared_ptr<AudioDiskstream> diskstream = audio_diskstream();
536
if ((_freeze_record.playlist = boost::dynamic_pointer_cast<AudioPlaylist>(diskstream->playlist())) == 0) {
542
while (n < (UINT_MAX-1)) {
546
candidate = string_compose ("<F%2>%1", _freeze_record.playlist->name(), n);
548
if (_session.playlists->by_name (candidate) == 0) {
549
new_playlist_name = candidate;
557
if (n == (UINT_MAX-1)) {
558
error << string_compose (X_("There are too many frozen versions of playlist \"%1\""
559
" to create another one"), _freeze_record.playlist->name())
564
boost::shared_ptr<Region> res;
566
if ((res = _session.write_one_track (*this, _session.current_start_frame(), _session.current_end_frame(), true, srcs, itt,
567
main_outs(), false, false)) == 0) {
571
_freeze_record.processor_info.clear ();
574
Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
576
for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
578
if (!(*r)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*r)) {
580
FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo ((*r)->get_state(), (*r));
582
frii->id = (*r)->id();
584
_freeze_record.processor_info.push_back (frii);
586
/* now deactivate the processor */
591
_session.set_dirty ();
595
new_playlist = PlaylistFactory::create (DataType::AUDIO, _session, new_playlist_name, false);
597
/* XXX need main outs automation state _freeze_record.pan_automation_state = _mainpanner->automation_state(); */
599
region_name = new_playlist_name;
601
/* create a new region from all filesources, keep it private */
605
plist.add (Properties::start, 0);
606
plist.add (Properties::length, srcs[0]->length(srcs[0]->timeline_position()));
607
plist.add (Properties::name, region_name);
608
plist.add (Properties::whole_file, true);
610
boost::shared_ptr<Region> region (RegionFactory::create (srcs, plist, false));
612
new_playlist->set_orig_track_id (id());
613
new_playlist->add_region (region, _session.current_start_frame());
614
new_playlist->set_frozen (true);
615
region->set_locked (true);
617
diskstream->use_playlist (boost::dynamic_pointer_cast<AudioPlaylist>(new_playlist));
618
diskstream->set_record_enabled (false);
620
/* reset stuff that has already been accounted for in the freeze process */
622
set_gain (1.0, this);
623
_amp->gain_control()->set_automation_state (Off);
624
/* XXX need to use _main_outs _panner->set_automation_state (Off); */
626
_freeze_record.state = Frozen;
627
FreezeChange(); /* EMIT SIGNAL */
631
AudioTrack::unfreeze ()
633
if (_freeze_record.playlist) {
634
audio_diskstream()->use_playlist (_freeze_record.playlist);
637
Glib::Threads::RWLock::ReaderLock lm (_processor_lock); // should this be a write lock? jlc
638
for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
639
for (vector<FreezeRecordProcessorInfo*>::iterator ii = _freeze_record.processor_info.begin(); ii != _freeze_record.processor_info.end(); ++ii) {
640
if ((*ii)->id == (*i)->id()) {
641
(*i)->set_state (((*ii)->state), Stateful::current_state_version);
648
_freeze_record.playlist.reset ();
649
/* XXX need to use _main_outs _panner->set_automation_state (_freeze_record.pan_automation_state); */
652
_freeze_record.state = UnFrozen;
653
FreezeChange (); /* EMIT SIGNAL */
656
boost::shared_ptr<AudioFileSource>
657
AudioTrack::write_source (uint32_t n)
659
boost::shared_ptr<AudioDiskstream> ds = boost::dynamic_pointer_cast<AudioDiskstream> (_diskstream);
661
return ds->write_source (n);
664
boost::shared_ptr<Diskstream>
665
AudioTrack::diskstream_factory (XMLNode const & node)
667
return boost::shared_ptr<Diskstream> (new AudioDiskstream (_session, node));