2 Copyright (C) 2000-2006 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.
32 #include <glibmm/threads.h>
34 #include "pbd/error.h"
35 #include "pbd/basename.h"
36 #include "pbd/memento_command.h"
37 #include "pbd/xml++.h"
38 #include "pbd/stacktrace.h"
39 #include "pbd/enum_convert.h"
40 #include "pbd/types_convert.h"
42 #include "ardour/debug.h"
43 #include "ardour/diskstream.h"
44 #include "ardour/io.h"
45 #include "ardour/pannable.h"
46 #include "ardour/profile.h"
47 #include "ardour/playlist.h"
48 #include "ardour/session.h"
49 #include "ardour/track.h"
50 #include "ardour/types_convert.h"
56 using namespace ARDOUR;
60 DEFINE_ENUM_CONVERT(Diskstream::Flag);
63 ARDOUR::framecnt_t Diskstream::disk_read_chunk_frames = default_disk_read_chunk_frames ();
64 ARDOUR::framecnt_t Diskstream::disk_write_chunk_frames = default_disk_write_chunk_frames ();
66 PBD::Signal0<void> Diskstream::DiskOverrun;
67 PBD::Signal0<void> Diskstream::DiskUnderrun;
69 Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
70 : SessionObject(sess, name)
71 , i_am_the_modifier (0)
75 , _visible_speed (1.0f)
76 , _actual_speed (1.0f)
77 , _buffer_reallocation_required (false)
78 , _seek_required (false)
79 , capture_start_frame (0)
80 , capture_captured (0)
81 , was_recording (false)
82 , adjust_capture_position (0)
85 , first_recordable_frame (max_framepos)
86 , last_recordable_frame (max_framepos)
87 , last_possibly_recording (0)
88 , _alignment_style (ExistingMaterial)
89 , _alignment_choice (Automatic)
93 , overwrite_offset (0)
94 , _pending_overwrite (false)
95 , overwrite_queued (false)
96 , wrap_buffer_size (0)
97 , speed_buffer_size (0)
99 , _target_speed (_speed)
101 , playback_sample (0)
102 , in_set_state (false)
104 , deprecated_io_node (0)
108 Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
109 : SessionObject(sess, "unnamed diskstream")
110 , i_am_the_modifier (0)
112 , _record_enabled (0)
114 , _visible_speed (1.0f)
115 , _actual_speed (1.0f)
116 , _buffer_reallocation_required (false)
117 , _seek_required (false)
118 , capture_start_frame (0)
119 , capture_captured (0)
120 , was_recording (false)
121 , adjust_capture_position (0)
122 , _capture_offset (0)
124 , first_recordable_frame (max_framepos)
125 , last_recordable_frame (max_framepos)
126 , last_possibly_recording (0)
127 , _alignment_style (ExistingMaterial)
128 , _alignment_choice (Automatic)
131 , overwrite_frame (0)
132 , overwrite_offset (0)
133 , _pending_overwrite (false)
134 , overwrite_queued (false)
135 , wrap_buffer_size (0)
136 , speed_buffer_size (0)
138 , _target_speed (_speed)
140 , playback_sample (0)
141 , in_set_state (false)
142 , _flags (Recordable)
143 , deprecated_io_node (0)
147 Diskstream::~Diskstream ()
149 DEBUG_TRACE (DEBUG::Destruction, string_compose ("Diskstream %1 deleted\n", _name));
152 _playlist->release ();
155 delete deprecated_io_node;
159 Diskstream::non_layered () const
161 return _session.config.get_layered_record_mode();
165 Diskstream::set_track (Track* t)
168 _io = _track->input();
170 ic_connection.disconnect();
171 _io->changed.connect_same_thread (ic_connection, boost::bind (&Diskstream::handle_input_change, this, _1, _2));
173 if (_io->n_ports() != ChanCount::ZERO) {
174 input_change_pending.type = IOChange::Type (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged);
175 non_realtime_input_change ();
178 _track->Destroyed.connect_same_thread (*this, boost::bind (&Diskstream::route_going_away, this));
182 Diskstream::handle_input_change (IOChange change, void * /*src*/)
184 Glib::Threads::Mutex::Lock lm (state_lock);
186 if (change.type & (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged)) {
188 /* rather than handle this here on a DS-by-DS basis we defer to the
189 session transport/butler thread, and let it tackle
190 as many diskstreams as need it in one shot. this avoids many repeated
191 takings of the audioengine process lock.
194 if (!(input_change_pending.type & change.type)) {
195 input_change_pending.type = IOChange::Type (input_change_pending.type | change.type);
196 _session.request_input_change_handling ();
202 Diskstream::non_realtime_set_speed ()
204 if (_buffer_reallocation_required)
206 Glib::Threads::Mutex::Lock lm (state_lock);
207 allocate_temporary_buffers ();
209 _buffer_reallocation_required = false;
212 if (_seek_required) {
213 if (speed() != 1.0f || speed() != -1.0f) {
214 seek ((framepos_t) (_session.transport_frame() * (double) speed()), true);
217 seek (_session.transport_frame(), true);
220 _seek_required = false;
225 Diskstream::realtime_set_speed (double sp, bool global)
227 bool changed = false;
228 double new_speed = sp * _session.transport_speed();
230 if (_visible_speed != sp) {
235 if (new_speed != _actual_speed) {
237 framecnt_t required_wrap_size = (framecnt_t) ceil (_session.get_block_size() *
238 fabs (new_speed)) + 2;
240 if (required_wrap_size > wrap_buffer_size) {
241 _buffer_reallocation_required = true;
244 _actual_speed = new_speed;
245 _target_speed = fabs(_actual_speed);
250 _seek_required = true;
252 SpeedChanged (); /* EMIT SIGNAL */
255 return _buffer_reallocation_required || _seek_required;
259 Diskstream::set_capture_offset ()
262 /* can't capture, so forget it */
266 switch (_alignment_style) {
267 case ExistingMaterial:
268 _capture_offset = _io->latency();
277 framecnt_t port_offset;
278 if (_track->mixbus_internal_bounce (port_offset)) {
279 /* _capture_offset may become negative, but the sum
280 * _capture_offset + existing_material_offset
283 _capture_offset -= port_offset;
287 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: using IO latency, capture offset set to %2 with style = %3\n", name(), _capture_offset, enum_2_string (_alignment_style)));
292 Diskstream::set_align_style (AlignStyle a, bool force)
294 if (record_enabled() && _session.actively_recording()) {
298 if ((a != _alignment_style) || force) {
299 _alignment_style = a;
300 set_capture_offset ();
301 AlignmentStyleChanged ();
306 Diskstream::set_align_choice (AlignChoice a, bool force)
308 if (record_enabled() && _session.actively_recording()) {
312 if ((a != _alignment_choice) || force) {
313 _alignment_choice = a;
315 switch (_alignment_choice) {
317 set_align_style_from_io ();
319 case UseExistingMaterial:
320 set_align_style (ExistingMaterial);
323 set_align_style (CaptureTime);
330 Diskstream::set_loop (Location *location)
333 if (location->start() >= location->end()) {
334 error << string_compose(_("Location \"%1\" not valid for track loop (start >= end)"), location->name()) << endl;
339 loop_location = location;
341 LoopSet (location); /* EMIT SIGNAL */
345 /** Get the start position (in session frames) of the nth capture in the current pass */
347 Diskstream::get_capture_start_frame (uint32_t n) const
349 Glib::Threads::Mutex::Lock lm (capture_info_lock);
351 if (capture_info.size() > n) {
352 /* this is a completed capture */
353 return capture_info[n]->start;
355 /* this is the currently in-progress capture */
356 return capture_start_frame;
361 Diskstream::get_captured_frames (uint32_t n) const
363 Glib::Threads::Mutex::Lock lm (capture_info_lock);
365 if (capture_info.size() > n) {
366 /* this is a completed capture */
367 return capture_info[n]->frames;
369 /* this is the currently in-progress capture */
370 return capture_captured;
375 Diskstream::set_roll_delay (ARDOUR::framecnt_t nframes)
377 _roll_delay = nframes;
381 Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
387 bool prior_playlist = false;
390 Glib::Threads::Mutex::Lock lm (state_lock);
392 if (playlist == _playlist) {
396 playlist_connections.drop_connections ();
399 _playlist->release();
400 prior_playlist = true;
403 _playlist = playlist;
406 if (!in_set_state && destructive() && recordable()) {
407 reset_write_sources (false);
410 _playlist->ContentsChanged.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_modified, this));
411 _playlist->LayeringChanged.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_modified, this));
412 _playlist->DropReferences.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_deleted, this, boost::weak_ptr<Playlist>(_playlist)));
413 _playlist->RangesMoved.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_ranges_moved, this, _1, _2));
416 /* don't do this if we've already asked for it *or* if we are setting up
417 the diskstream for the very first time - the input changed handling will
418 take care of the buffer refill.
421 if (!overwrite_queued && prior_playlist) {
422 _session.request_overwrite_buffer (_track);
423 overwrite_queued = true;
426 PlaylistChanged (); /* EMIT SIGNAL */
427 _session.set_dirty ();
433 Diskstream::playlist_changed (const PropertyChange&)
435 playlist_modified ();
439 Diskstream::playlist_modified ()
441 if (!i_am_the_modifier && !overwrite_queued) {
442 _session.request_overwrite_buffer (_track);
443 overwrite_queued = true;
448 Diskstream::playlist_deleted (boost::weak_ptr<Playlist> wpl)
450 boost::shared_ptr<Playlist> pl (wpl.lock());
452 if (pl == _playlist) {
454 /* this catches an ordering issue with session destruction. playlists
455 are destroyed before diskstreams. we have to invalidate any handles
456 we have to the playlist.
466 Diskstream::set_name (const string& str)
470 playlist()->set_name (str);
471 SessionObject::set_name(str);
477 Diskstream::set_write_source_name (const std::string& str) {
478 _write_source_name = str;
483 Diskstream::get_state ()
485 XMLNode* node = new XMLNode ("Diskstream");
488 node->set_property ("flags", _flags);
489 node->set_property ("playlist", _playlist->name());
490 node->set_property ("name", name());
491 node->set_property ("id", id ());
492 node->set_property ("speed", _visible_speed);
493 node->set_property ("capture-alignment", _alignment_choice);
494 node->set_property ("record-safe", _record_safe);
497 node->add_child_copy (*_extra_xml);
503 Diskstream::set_state (const XMLNode& node, int /*version*/)
506 if (node.get_property ("name", name)) {
510 if (deprecated_io_node) {
511 set_id (*deprecated_io_node);
516 node.get_property ("flags", _flags);
518 if (Profile->get_trx() && (_flags & Destructive)) {
519 error << string_compose (_("%1: this session uses destructive tracks, which are not supported"), PROGRAM_NAME) << endmsg;
523 AlignChoice achoice = Automatic;
524 node.get_property (X_("capture-alignment"), achoice);
525 set_align_choice (achoice, true);
527 XMLProperty const * prop;
529 if ((prop = node.property ("playlist")) == 0) {
533 if (find_and_use_playlist (prop->value())) {
538 if (node.get_property ("speed", sp)) {
539 if (realtime_set_speed (sp, false)) {
540 non_realtime_set_speed ();
545 if (node.get_property ("record-safe", record_safe)) {
546 _record_safe = record_safe ? 1 : 0;
553 Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const & movements_frames, bool from_undo)
555 /* If we're coming from an undo, it will have handled
556 automation undo (it must, since automation-follows-regions
557 can lose automation data). Hence we can do nothing here.
564 if (!_track || Config->get_automation_follows_regions () == false) {
568 list< Evoral::RangeMove<double> > movements;
570 for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin();
571 i != movements_frames.end();
574 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
577 /* move panner automation */
578 boost::shared_ptr<Pannable> pannable = _track->pannable();
579 Evoral::ControlSet::Controls& c (pannable->controls());
581 for (Evoral::ControlSet::Controls::iterator ci = c.begin(); ci != c.end(); ++ci) {
582 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
586 boost::shared_ptr<AutomationList> alist = ac->alist();
587 if (!alist->size()) {
590 XMLNode & before = alist->get_state ();
591 bool const things_moved = alist->move_ranges (movements);
593 _session.add_command (new MementoCommand<AutomationList> (
594 *alist.get(), &before, &alist->get_state ()));
598 /* move processor automation */
599 _track->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
603 Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evoral::RangeMove<framepos_t> > const & movements_frames)
605 boost::shared_ptr<Processor> processor (p.lock ());
610 list< Evoral::RangeMove<double> > movements;
611 for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin(); i != movements_frames.end(); ++i) {
612 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
615 set<Evoral::Parameter> const a = processor->what_can_be_automated ();
617 for (set<Evoral::Parameter>::const_iterator i = a.begin (); i != a.end (); ++i) {
618 boost::shared_ptr<AutomationList> al = processor->automation_control(*i)->alist();
622 XMLNode & before = al->get_state ();
623 bool const things_moved = al->move_ranges (movements);
625 _session.add_command (
626 new MementoCommand<AutomationList> (
627 *al.get(), &before, &al->get_state ()
635 Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
637 int possibly_recording;
640 const int transport_rolling = 0x4;
641 const int track_rec_enabled = 0x2;
642 const int global_rec_enabled = 0x1;
643 const int fully_rec_enabled = (transport_rolling|track_rec_enabled|global_rec_enabled);
645 /* merge together the 3 factors that affect record status, and compute
649 rolling = _session.transport_speed() != 0.0f;
650 possibly_recording = (rolling << 2) | ((int)record_enabled() << 1) | (int)can_record;
651 change = possibly_recording ^ last_possibly_recording;
653 if (possibly_recording == last_possibly_recording) {
657 const framecnt_t existing_material_offset = _session.worst_playback_latency();
659 if (possibly_recording == fully_rec_enabled) {
661 if (last_possibly_recording == fully_rec_enabled) {
665 capture_start_frame = _session.transport_frame();
666 first_recordable_frame = capture_start_frame + _capture_offset;
667 last_recordable_frame = max_framepos;
669 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: @ %7 (%9) FRF = %2 CSF = %4 CO = %5, EMO = %6 RD = %8 WOL %10 WTL %11\n",
670 name(), first_recordable_frame, last_recordable_frame, capture_start_frame,
672 existing_material_offset,
675 _session.transport_frame(),
676 _session.worst_output_latency(),
677 _session.worst_track_latency()));
680 if (_alignment_style == ExistingMaterial) {
681 first_recordable_frame += existing_material_offset;
682 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tshift FRF by EMO %1\n",
683 first_recordable_frame));
686 prepare_record_status (capture_start_frame);
690 if (last_possibly_recording == fully_rec_enabled) {
692 /* we were recording last time */
694 if (change & transport_rolling) {
696 /* transport-change (stopped rolling): last_recordable_frame was set in ::prepare_to_stop(). We
697 * had to set it there because we likely rolled past the stopping point to declick out,
698 * and then backed up.
704 last_recordable_frame = _session.transport_frame() + _capture_offset;
706 if (_alignment_style == ExistingMaterial) {
707 last_recordable_frame += existing_material_offset;
713 last_possibly_recording = possibly_recording;
717 Diskstream::route_going_away ()
723 Diskstream::calculate_record_range (Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
724 framecnt_t & rec_nframes, framecnt_t & rec_offset)
727 case Evoral::OverlapNone:
731 case Evoral::OverlapInternal:
732 /* ---------- recrange
735 rec_nframes = nframes;
739 case Evoral::OverlapStart:
740 /* |--------| recrange
743 rec_nframes = transport_frame + nframes - first_recordable_frame;
745 rec_offset = first_recordable_frame - transport_frame;
749 case Evoral::OverlapEnd:
750 /* |--------| recrange
751 * |-------- transrange
753 rec_nframes = last_recordable_frame - transport_frame;
757 case Evoral::OverlapExternal:
758 /* |--------| recrange
759 * -------------- transrange
761 rec_nframes = last_recordable_frame - first_recordable_frame;
762 rec_offset = first_recordable_frame - transport_frame;
766 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1 rec? %2 @ %3 (for %4) FRF %5 LRF %6 : rf %7 @ %8\n",
767 _name, enum_2_string (ot), transport_frame, nframes,
768 first_recordable_frame, last_recordable_frame, rec_nframes, rec_offset));
772 Diskstream::prepare_to_stop (framepos_t transport_frame, framepos_t audible_frame)
774 switch (_alignment_style) {
775 case ExistingMaterial:
776 last_recordable_frame = transport_frame + _capture_offset;
777 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose("%1: prepare to stop sets last recordable frame to %2 + %3 = %4\n", _name, transport_frame, _capture_offset, last_recordable_frame));
781 last_recordable_frame = audible_frame; // note that capture_offset is zero
782 /* we may already have captured audio before the last_recordable_frame (audible frame),
785 if (last_recordable_frame > capture_start_frame) {
786 capture_captured = min (capture_captured, last_recordable_frame - capture_start_frame);
788 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose("%1: prepare to stop sets last recordable frame to audible frame @ %2\n", _name, audible_frame));
795 Diskstream::engage_record_enable ()
797 g_atomic_int_set (&_record_enabled, 1);
801 Diskstream::disengage_record_enable ()
803 g_atomic_int_set (&_record_enabled, 0);
807 Diskstream::engage_record_safe ()
809 g_atomic_int_set (&_record_safe, 1);
813 Diskstream::disengage_record_safe ()
815 g_atomic_int_set (&_record_safe, 0);
819 Diskstream::default_disk_read_chunk_frames()
825 Diskstream::default_disk_write_chunk_frames ()
831 Diskstream::set_buffering_parameters (BufferingPreset bp)
833 framecnt_t read_chunk_size;
834 framecnt_t read_buffer_size;
835 framecnt_t write_chunk_size;
836 framecnt_t write_buffer_size;
838 if (!get_buffering_presets (bp, read_chunk_size, read_buffer_size, write_chunk_size, write_buffer_size)) {
842 disk_read_chunk_frames = read_chunk_size;
843 disk_write_chunk_frames = write_chunk_size;
844 Config->set_audio_capture_buffer_seconds (write_buffer_size);
845 Config->set_audio_playback_buffer_seconds (read_buffer_size);
847 cerr << "Set buffering params to " << disk_read_chunk_frames << '|' << disk_write_chunk_frames << '|'
848 << Config->get_audio_playback_buffer_seconds() << '|'
849 << Config->get_audio_capture_buffer_seconds ()
854 Diskstream::get_buffering_presets (BufferingPreset bp,
855 framecnt_t& read_chunk_size,
856 framecnt_t& read_buffer_size,
857 framecnt_t& write_chunk_size,
858 framecnt_t& write_buffer_size)
862 read_chunk_size = 65536; /* samples */
863 write_chunk_size = 65536; /* samples */
864 read_buffer_size = 5; /* seconds */
865 write_buffer_size = 5; /* seconds */
869 read_chunk_size = 262144; /* samples */
870 write_chunk_size = 131072; /* samples */
871 read_buffer_size = 10; /* seconds */
872 write_buffer_size = 10; /* seconds */
876 read_chunk_size = 524288; /* samples */
877 write_chunk_size = 131072; /* samples */
878 read_buffer_size = 20; /* seconds */
879 write_buffer_size = 20; /* seconds */