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.
35 #include <glibmm/thread.h>
37 #include "pbd/error.h"
38 #include "pbd/basename.h"
39 #include "pbd/memento_command.h"
40 #include "pbd/xml++.h"
41 #include "pbd/stacktrace.h"
43 #include "ardour/ardour.h"
44 #include "ardour/audioengine.h"
45 #include "ardour/debug.h"
46 #include "ardour/diskstream.h"
47 #include "ardour/utils.h"
48 #include "ardour/configuration.h"
49 #include "ardour/audiofilesource.h"
50 #include "ardour/send.h"
51 #include "ardour/pannable.h"
52 #include "ardour/panner_shell.h"
53 #include "ardour/playlist.h"
54 #include "ardour/cycle_timer.h"
55 #include "ardour/region.h"
56 #include "ardour/panner.h"
57 #include "ardour/session.h"
58 #include "ardour/io.h"
59 #include "ardour/track.h"
65 using namespace ARDOUR;
68 /* XXX This goes uninitialized when there is no ~/.config/ardour3 directory.
69 * I can't figure out why, so this will do for now (just stole the
70 * default from configuration_vars.h). 0 is not a good value for
71 * allocating buffer sizes..
73 ARDOUR::framecnt_t Diskstream::disk_io_chunk_frames = 1024 * 256 / sizeof (Sample);
75 PBD::Signal0<void> Diskstream::DiskOverrun;
76 PBD::Signal0<void> Diskstream::DiskUnderrun;
78 Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
79 : SessionObject(sess, name)
80 , i_am_the_modifier (0)
83 , _visible_speed (1.0f)
84 , _actual_speed (1.0f)
85 , _buffer_reallocation_required (false)
86 , _seek_required (false)
87 , capture_start_frame (0)
88 , capture_captured (0)
89 , was_recording (false)
90 , adjust_capture_position (0)
93 , first_recordable_frame (max_framepos)
94 , last_recordable_frame (max_framepos)
95 , last_possibly_recording (0)
96 , _alignment_style (ExistingMaterial)
97 , _alignment_choice (Automatic)
101 , overwrite_frame (0)
102 , overwrite_offset (0)
103 , _pending_overwrite (false)
104 , overwrite_queued (false)
105 , wrap_buffer_size (0)
106 , speed_buffer_size (0)
108 , _target_speed (_speed)
110 , playback_sample (0)
111 , in_set_state (false)
113 , deprecated_io_node (0)
117 Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
118 : SessionObject(sess, "unnamed diskstream")
119 , i_am_the_modifier (0)
121 , _record_enabled (0)
122 , _visible_speed (1.0f)
123 , _actual_speed (1.0f)
124 , _buffer_reallocation_required (false)
125 , _seek_required (false)
126 , capture_start_frame (0)
127 , capture_captured (0)
128 , was_recording (false)
129 , adjust_capture_position (0)
130 , _capture_offset (0)
132 , first_recordable_frame (max_framepos)
133 , last_recordable_frame (max_framepos)
134 , last_possibly_recording (0)
135 , _alignment_style (ExistingMaterial)
136 , _alignment_choice (Automatic)
140 , overwrite_frame (0)
141 , overwrite_offset (0)
142 , _pending_overwrite (false)
143 , overwrite_queued (false)
144 , wrap_buffer_size (0)
145 , speed_buffer_size (0)
147 , _target_speed (_speed)
149 , playback_sample (0)
150 , in_set_state (false)
151 , _flags (Recordable)
152 , deprecated_io_node (0)
156 Diskstream::~Diskstream ()
158 DEBUG_TRACE (DEBUG::Destruction, string_compose ("Diskstream %1 deleted\n", _name));
161 _playlist->release ();
164 delete deprecated_io_node;
168 Diskstream::set_track (Track* t)
171 _io = _track->input();
173 ic_connection.disconnect();
174 _io->changed.connect_same_thread (ic_connection, boost::bind (&Diskstream::handle_input_change, this, _1, _2));
176 if (_io->n_ports() != ChanCount::ZERO) {
177 input_change_pending.type = IOChange::Type (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged);
178 non_realtime_input_change ();
181 _track->Destroyed.connect_same_thread (*this, boost::bind (&Diskstream::route_going_away, this));
185 Diskstream::handle_input_change (IOChange change, void * /*src*/)
187 Glib::Mutex::Lock lm (state_lock);
189 if (change.type & (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged)) {
191 /* rather than handle this here on a DS-by-DS basis we defer to the
192 session transport/butler thread, and let it tackle
193 as many diskstreams as need it in one shot. this avoids many repeated
194 takings of the audioengine process lock.
197 if (!(input_change_pending.type & change.type)) {
198 input_change_pending.type = IOChange::Type (input_change_pending.type | change.type);
199 _session.request_input_change_handling ();
205 Diskstream::non_realtime_set_speed ()
207 if (_buffer_reallocation_required)
209 Glib::Mutex::Lock lm (state_lock);
210 allocate_temporary_buffers ();
212 _buffer_reallocation_required = false;
215 if (_seek_required) {
216 if (speed() != 1.0f || speed() != -1.0f) {
217 seek ((framepos_t) (_session.transport_frame() * (double) speed()), true);
220 seek (_session.transport_frame(), true);
223 _seek_required = false;
228 Diskstream::realtime_set_speed (double sp, bool global)
230 bool changed = false;
231 double new_speed = sp * _session.transport_speed();
233 if (_visible_speed != sp) {
238 if (new_speed != _actual_speed) {
240 framecnt_t required_wrap_size = (framecnt_t) floor (_session.get_block_size() *
241 fabs (new_speed)) + 1;
243 if (required_wrap_size > wrap_buffer_size) {
244 _buffer_reallocation_required = true;
247 _actual_speed = new_speed;
248 _target_speed = fabs(_actual_speed);
253 _seek_required = true;
255 SpeedChanged (); /* EMIT SIGNAL */
258 return _buffer_reallocation_required || _seek_required;
262 Diskstream::set_capture_offset ()
265 /* can't capture, so forget it */
269 _capture_offset = _io->latency();
270 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: using IO latency, capture offset set to %2\n", name(), _capture_offset));
275 Diskstream::set_align_style (AlignStyle a, bool force)
277 if (record_enabled() && _session.actively_recording()) {
281 if ((a != _alignment_style) || force) {
282 _alignment_style = a;
283 AlignmentStyleChanged ();
288 Diskstream::set_align_choice (AlignChoice a, bool force)
290 if (record_enabled() && _session.actively_recording()) {
294 if ((a != _alignment_choice) || force) {
295 _alignment_choice = a;
297 switch (_alignment_choice) {
299 set_align_style_from_io ();
301 case UseExistingMaterial:
302 set_align_style (ExistingMaterial);
305 set_align_style (CaptureTime);
312 Diskstream::set_loop (Location *location)
315 if (location->start() >= location->end()) {
316 error << string_compose(_("Location \"%1\" not valid for track loop (start >= end)"), location->name()) << endl;
321 loop_location = location;
323 LoopSet (location); /* EMIT SIGNAL */
327 /** Get the start position (in session frames) of the nth capture in the current pass */
329 Diskstream::get_capture_start_frame (uint32_t n) const
331 Glib::Mutex::Lock lm (capture_info_lock);
333 if (capture_info.size() > n) {
334 /* this is a completed capture */
335 return capture_info[n]->start;
337 /* this is the currently in-progress capture */
338 return capture_start_frame;
343 Diskstream::get_captured_frames (uint32_t n) const
345 Glib::Mutex::Lock lm (capture_info_lock);
347 if (capture_info.size() > n) {
348 /* this is a completed capture */
349 return capture_info[n]->frames;
351 /* this is the currently in-progress capture */
352 return capture_captured;
357 Diskstream::set_roll_delay (ARDOUR::framecnt_t nframes)
359 _roll_delay = nframes;
363 Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
369 bool prior_playlist = false;
372 Glib::Mutex::Lock lm (state_lock);
374 if (playlist == _playlist) {
378 playlist_connections.drop_connections ();
381 _playlist->release();
382 prior_playlist = true;
385 _playlist = playlist;
388 if (!in_set_state && recordable()) {
389 reset_write_sources (false);
392 _playlist->ContentsChanged.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_modified, this));
393 _playlist->DropReferences.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_deleted, this, boost::weak_ptr<Playlist>(_playlist)));
394 _playlist->RangesMoved.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_ranges_moved, this, _1, _2));
397 /* don't do this if we've already asked for it *or* if we are setting up
398 the diskstream for the very first time - the input changed handling will
399 take care of the buffer refill.
402 if (!overwrite_queued && prior_playlist) {
403 _session.request_overwrite_buffer (_track);
404 overwrite_queued = true;
407 PlaylistChanged (); /* EMIT SIGNAL */
408 _session.set_dirty ();
414 Diskstream::playlist_changed (const PropertyChange&)
416 playlist_modified ();
420 Diskstream::playlist_modified ()
422 if (!i_am_the_modifier && !overwrite_queued) {
423 _session.request_overwrite_buffer (_track);
424 overwrite_queued = true;
429 Diskstream::playlist_deleted (boost::weak_ptr<Playlist> wpl)
431 boost::shared_ptr<Playlist> pl (wpl.lock());
433 if (pl == _playlist) {
435 /* this catches an ordering issue with session destruction. playlists
436 are destroyed before diskstreams. we have to invalidate any handles
437 we have to the playlist.
447 Diskstream::set_name (const string& str)
451 playlist()->set_name (str);
452 SessionObject::set_name(str);
458 Diskstream::get_state ()
460 XMLNode* node = new XMLNode ("Diskstream");
462 LocaleGuard lg (X_("POSIX"));
464 node->add_property ("flags", enum_2_string (_flags));
465 node->add_property ("playlist", _playlist->name());
466 node->add_property("name", _name);
467 id().print (buf, sizeof (buf));
468 node->add_property("id", buf);
469 snprintf (buf, sizeof(buf), "%f", _visible_speed);
470 node->add_property ("speed", buf);
471 node->add_property ("capture-alignment", enum_2_string (_alignment_choice));
474 node->add_child_copy (*_extra_xml);
481 Diskstream::set_state (const XMLNode& node, int /*version*/)
483 const XMLProperty* prop;
485 if ((prop = node.property ("name")) != 0) {
486 _name = prop->value();
489 if (deprecated_io_node) {
490 set_id (*deprecated_io_node);
495 if ((prop = node.property ("flags")) != 0) {
496 _flags = Flag (string_2_enum (prop->value(), _flags));
499 if ((prop = node.property (X_("capture-alignment"))) != 0) {
500 set_align_choice (AlignChoice (string_2_enum (prop->value(), _alignment_choice)), true);
502 set_align_choice (Automatic, true);
505 if ((prop = node.property ("playlist")) == 0) {
510 bool had_playlist = (_playlist != 0);
512 if (find_and_use_playlist (prop->value())) {
517 _playlist->set_orig_diskstream_id (id());
521 if ((prop = node.property ("speed")) != 0) {
522 double sp = atof (prop->value().c_str());
524 if (realtime_set_speed (sp, false)) {
525 non_realtime_set_speed ();
533 Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const & movements_frames, bool from_undo)
535 /* If we're coming from an undo, it will have handled
536 automation undo (it must, since automation-follows-regions
537 can lose automation data). Hence we can do nothing here.
544 if (!_track || Config->get_automation_follows_regions () == false) {
548 list< Evoral::RangeMove<double> > movements;
550 for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin();
551 i != movements_frames.end();
554 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
557 /* move panner automation */
558 boost::shared_ptr<Pannable> pannable = _track->pannable();
559 Evoral::ControlSet::Controls& c (pannable->controls());
561 for (Evoral::ControlSet::Controls::iterator ci = c.begin(); ci != c.end(); ++ci) {
562 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
566 boost::shared_ptr<AutomationList> alist = ac->alist();
568 XMLNode & before = alist->get_state ();
569 bool const things_moved = alist->move_ranges (movements);
571 _session.add_command (new MementoCommand<AutomationList> (
572 *alist.get(), &before, &alist->get_state ()));
576 /* move processor automation */
577 _track->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
581 Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evoral::RangeMove<framepos_t> > const & movements_frames)
583 boost::shared_ptr<Processor> processor (p.lock ());
588 list< Evoral::RangeMove<double> > movements;
589 for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin(); i != movements_frames.end(); ++i) {
590 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
593 set<Evoral::Parameter> const a = processor->what_can_be_automated ();
595 for (set<Evoral::Parameter>::iterator i = a.begin (); i != a.end (); ++i) {
596 boost::shared_ptr<AutomationList> al = processor->automation_control(*i)->alist();
597 XMLNode & before = al->get_state ();
598 bool const things_moved = al->move_ranges (movements);
600 _session.add_command (
601 new MementoCommand<AutomationList> (
602 *al.get(), &before, &al->get_state ()
610 Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
612 int possibly_recording;
615 const int transport_rolling = 0x4;
616 const int track_rec_enabled = 0x2;
617 const int global_rec_enabled = 0x1;
618 const int fully_rec_enabled = (transport_rolling|track_rec_enabled|global_rec_enabled);
620 /* merge together the 3 factors that affect record status, and compute
624 rolling = _session.transport_speed() != 0.0f;
625 possibly_recording = (rolling << 2) | (record_enabled() << 1) | can_record;
626 change = possibly_recording ^ last_possibly_recording;
628 if (possibly_recording == last_possibly_recording) {
632 framecnt_t existing_material_offset = _session.worst_playback_latency();
634 if (possibly_recording == fully_rec_enabled) {
636 if (last_possibly_recording == fully_rec_enabled) {
640 capture_start_frame = _session.transport_frame();
641 first_recordable_frame = capture_start_frame + _capture_offset;
642 last_recordable_frame = max_framepos;
644 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: @ %7 (%9) FRF = %2 CSF = %4 CO = %5, EMO = %6 RD = %8 WOL %10 WTL %11\n",
645 name(), first_recordable_frame, last_recordable_frame, capture_start_frame,
647 existing_material_offset,
650 _session.transport_frame(),
651 _session.worst_output_latency(),
652 _session.worst_track_latency()));
655 if (_alignment_style == ExistingMaterial) {
656 first_recordable_frame += existing_material_offset;
657 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tshift FRF by EMO %1\n",
658 first_recordable_frame));
661 prepare_record_status (capture_start_frame);
665 if (last_possibly_recording == fully_rec_enabled) {
667 /* we were recording last time */
669 if (change & transport_rolling) {
671 /* transport-change (stopped rolling): last_recordable_frame was set in ::prepare_to_stop(). We
672 had to set it there because we likely rolled past the stopping point to declick out,
679 last_recordable_frame = _session.transport_frame() + _capture_offset;
681 if (_alignment_style == ExistingMaterial) {
682 last_recordable_frame += existing_material_offset;
688 last_possibly_recording = possibly_recording;
692 Diskstream::route_going_away ()
698 Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
699 framecnt_t & rec_nframes, framecnt_t & rec_offset)
706 case OverlapInternal:
707 /* ---------- recrange
710 rec_nframes = nframes;
715 /* |--------| recrange
718 rec_nframes = transport_frame + nframes - first_recordable_frame;
720 rec_offset = first_recordable_frame - transport_frame;
725 /* |--------| recrange
728 rec_nframes = last_recordable_frame - transport_frame;
732 case OverlapExternal:
733 /* |--------| recrange
734 -------------- transrange
736 rec_nframes = last_recordable_frame - first_recordable_frame;
737 rec_offset = first_recordable_frame - transport_frame;
741 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1 rec? %2 @ %3 (for %4) FRF %5 LRF %6 : rf %7 @ %8\n",
742 _name, enum_2_string (ot), transport_frame, nframes,
743 first_recordable_frame, last_recordable_frame, rec_nframes, rec_offset));
747 Diskstream::prepare_to_stop (framepos_t pos)
749 last_recordable_frame = pos + _capture_offset;