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 "pbd/error.h"
36 #include "pbd/basename.h"
37 #include <glibmm/thread.h>
38 #include "pbd/xml++.h"
39 #include "pbd/memento_command.h"
41 #include "ardour/ardour.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/debug.h"
44 #include "ardour/diskstream.h"
45 #include "ardour/utils.h"
46 #include "ardour/configuration.h"
47 #include "ardour/audiofilesource.h"
48 #include "ardour/send.h"
49 #include "ardour/playlist.h"
50 #include "ardour/cycle_timer.h"
51 #include "ardour/region.h"
52 #include "ardour/panner.h"
53 #include "ardour/session.h"
54 #include "ardour/io.h"
55 #include "ardour/route.h"
61 using namespace ARDOUR;
64 /* XXX This goes uninitialized when there is no ~/.ardour3 directory.
65 * I can't figure out why, so this will do for now (just stole the
66 * default from configuration_vars.h). 0 is not a good value for
67 * allocating buffer sizes..
69 ARDOUR::nframes_t Diskstream::disk_io_chunk_frames = 1024 * 256;
71 boost::signals2::signal<void()> Diskstream::DiskOverrun;
72 boost::signals2::signal<void()> Diskstream::DiskUnderrun;
74 Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
75 : SessionObject(sess, name)
80 Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
81 : SessionObject(sess, "unnamed diskstream")
87 Diskstream::init (Flag f)
91 _alignment_style = ExistingMaterial;
92 _persistent_alignment_style = ExistingMaterial;
93 first_input_change = true;
94 i_am_the_modifier = 0;
95 g_atomic_int_set (&_record_enabled, 0);
96 was_recording = false;
97 capture_start_frame = 0;
99 _visible_speed = 1.0f;
100 _actual_speed = 1.0f;
101 _buffer_reallocation_required = false;
102 _seek_required = false;
103 first_recordable_frame = max_frames;
104 last_recordable_frame = max_frames;
109 adjust_capture_position = 0;
110 last_possibly_recording = 0;
112 wrap_buffer_size = 0;
113 speed_buffer_size = 0;
115 _target_speed = _speed;
118 playback_distance = 0;
119 _read_data_count = 0;
120 _write_data_count = 0;
121 commit_should_unlock = false;
123 pending_overwrite = false;
125 overwrite_queued = false;
126 input_change_pending = NoChange;
129 Diskstream::~Diskstream ()
131 DEBUG_TRACE (DEBUG::Destruction, string_compose ("Diskstream %1 deleted\n", _name));
134 _playlist->release ();
139 Diskstream::set_route (Route& r)
142 _io = _route->input();
144 ic_connection.disconnect();
145 ic_connection = _io->changed.connect (boost::bind (&Diskstream::handle_input_change, this, _1, _2));
147 input_change_pending = ConfigurationChanged;
148 non_realtime_input_change ();
149 set_align_style_from_io ();
151 scoped_connect (_route->GoingAway, boost::bind (&Diskstream::route_going_away, this));
155 Diskstream::handle_input_change (IOChange change, void * /*src*/)
157 Glib::Mutex::Lock lm (state_lock);
159 if (!(input_change_pending & change)) {
160 input_change_pending = IOChange (input_change_pending|change);
161 _session.request_input_change_handling ();
166 Diskstream::non_realtime_set_speed ()
168 if (_buffer_reallocation_required)
170 Glib::Mutex::Lock lm (state_lock);
171 allocate_temporary_buffers ();
173 _buffer_reallocation_required = false;
176 if (_seek_required) {
177 if (speed() != 1.0f || speed() != -1.0f) {
178 seek ((nframes_t) (_session.transport_frame() * (double) speed()), true);
181 seek (_session.transport_frame(), true);
184 _seek_required = false;
189 Diskstream::realtime_set_speed (double sp, bool global)
191 bool changed = false;
192 double new_speed = sp * _session.transport_speed();
194 if (_visible_speed != sp) {
199 if (new_speed != _actual_speed) {
201 nframes_t required_wrap_size = (nframes_t) floor (_session.get_block_size() *
202 fabs (new_speed)) + 1;
204 if (required_wrap_size > wrap_buffer_size) {
205 _buffer_reallocation_required = true;
208 _actual_speed = new_speed;
209 _target_speed = fabs(_actual_speed);
214 _seek_required = true;
216 SpeedChanged (); /* EMIT SIGNAL */
219 return _buffer_reallocation_required || _seek_required;
223 Diskstream::prepare ()
226 playback_distance = 0;
230 Diskstream::recover ()
232 if (commit_should_unlock) {
239 Diskstream::set_capture_offset ()
242 /* can't capture, so forget it */
246 _capture_offset = _io->latency();
250 Diskstream::set_align_style (AlignStyle a)
252 if (record_enabled() && _session.actively_recording()) {
256 if (a != _alignment_style) {
257 _alignment_style = a;
258 AlignmentStyleChanged ();
263 Diskstream::set_loop (Location *location)
266 if (location->start() >= location->end()) {
267 error << string_compose(_("Location \"%1\" not valid for track loop (start >= end)"), location->name()) << endl;
272 loop_location = location;
274 LoopSet (location); /* EMIT SIGNAL */
279 Diskstream::get_capture_start_frame (uint32_t n)
281 Glib::Mutex::Lock lm (capture_info_lock);
283 if (capture_info.size() > n) {
284 return capture_info[n]->start;
287 return capture_start_frame;
292 Diskstream::get_captured_frames (uint32_t n)
294 Glib::Mutex::Lock lm (capture_info_lock);
296 if (capture_info.size() > n) {
297 return capture_info[n]->frames;
300 return capture_captured;
305 Diskstream::set_roll_delay (ARDOUR::nframes_t nframes)
307 _roll_delay = nframes;
311 Diskstream::set_speed (double sp)
313 _session.request_diskstream_speed (*this, sp);
315 /* to force a rebuffering at the right place */
320 Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
323 Glib::Mutex::Lock lm (state_lock);
325 if (playlist == _playlist) {
329 playlist_connections.drop_connections ();
332 _playlist->release();
335 _playlist = playlist;
338 if (!in_set_state && recordable()) {
339 reset_write_sources (false);
342 playlist_connections.add_connection (_playlist->Modified.connect (boost::bind (&Diskstream::playlist_modified, this)));
343 playlist_connections.add_connection (_playlist->GoingAway.connect (boost::bind (&Diskstream::playlist_deleted, this, boost::weak_ptr<Playlist>(_playlist))));
344 playlist_connections.add_connection (_playlist->RangesMoved.connect (boost::bind (&Diskstream::playlist_ranges_moved, this, _1)));
347 /* don't do this if we've already asked for it *or* if we are setting up
348 the diskstream for the very first time - the input changed handling will
349 take care of the buffer refill.
352 if (!overwrite_queued && !(_session.state_of_the_state() & Session::CannotSave)) {
353 _session.request_overwrite_buffer (this);
354 overwrite_queued = true;
357 PlaylistChanged (); /* EMIT SIGNAL */
358 _session.set_dirty ();
364 Diskstream::playlist_changed (Change)
366 playlist_modified ();
370 Diskstream::playlist_modified ()
372 if (!i_am_the_modifier && !overwrite_queued) {
373 _session.request_overwrite_buffer (this);
374 overwrite_queued = true;
379 Diskstream::playlist_deleted (boost::weak_ptr<Playlist> wpl)
381 boost::shared_ptr<Playlist> pl (wpl.lock());
383 if (pl == _playlist) {
385 /* this catches an ordering issue with session destruction. playlists
386 are destroyed before diskstreams. we have to invalidate any handles
387 we have to the playlist.
397 Diskstream::set_name (const string& str)
401 playlist()->set_name (str);
403 SessionObject::set_name(str);
405 if (!in_set_state && recordable()) {
406 /* rename existing capture files so that they have the correct name */
407 return rename_write_sources ();
417 Diskstream::remove_region_from_last_capture (boost::weak_ptr<Region> wregion)
419 boost::shared_ptr<Region> region (wregion.lock());
425 _last_capture_regions.remove (region);
429 Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<nframes_t> > const & movements_frames)
431 if (!_route || Config->get_automation_follows_regions () == false) {
435 list< Evoral::RangeMove<double> > movements;
437 for (list< Evoral::RangeMove<nframes_t> >::const_iterator i = movements_frames.begin();
438 i != movements_frames.end();
441 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
444 /* move panner automation */
445 boost::shared_ptr<Panner> p = _route->main_outs()->panner ();
447 for (uint32_t i = 0; i < p->npanners (); ++i) {
448 boost::shared_ptr<AutomationList> pan_alist = p->streampanner(i).pan_control()->alist();
449 XMLNode & before = pan_alist->get_state ();
450 pan_alist->move_ranges (movements);
451 _session.add_command (new MementoCommand<AutomationList> (
452 *pan_alist.get(), &before, &pan_alist->get_state ()));
456 /* move processor automation */
457 _route->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
461 Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evoral::RangeMove<nframes_t> > const & movements_frames)
463 boost::shared_ptr<Processor> processor (p.lock ());
468 list< Evoral::RangeMove<double> > movements;
469 for (list< Evoral::RangeMove<nframes_t> >::const_iterator i = movements_frames.begin();
470 i != movements_frames.end(); ++i) {
471 movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
474 set<Evoral::Parameter> const a = processor->what_can_be_automated ();
476 for (set<Evoral::Parameter>::iterator i = a.begin (); i != a.end (); ++i) {
477 boost::shared_ptr<AutomationList> al = processor->automation_control(*i)->alist();
478 XMLNode & before = al->get_state ();
479 al->move_ranges (movements);
480 _session.add_command (
481 new MementoCommand<AutomationList> (
482 *al.get(), &before, &al->get_state ()
489 Diskstream::check_record_status (nframes_t transport_frame, nframes_t /*nframes*/, bool can_record)
491 int possibly_recording;
494 const int transport_rolling = 0x4;
495 const int track_rec_enabled = 0x2;
496 const int global_rec_enabled = 0x1;
498 /* merge together the 3 factors that affect record status, and compute
502 rolling = _session.transport_speed() != 0.0f;
503 possibly_recording = (rolling << 2) | (record_enabled() << 1) | can_record;
504 change = possibly_recording ^ last_possibly_recording;
506 if (possibly_recording == last_possibly_recording) {
512 /* if per-track or global rec-enable turned on while the other was already on, we've started recording */
514 if (((change & track_rec_enabled) && record_enabled() && (!(change & global_rec_enabled) && can_record)) ||
515 ((change & global_rec_enabled) && can_record && (!(change & track_rec_enabled) && record_enabled()))) {
517 /* starting to record: compute first+last frames */
519 first_recordable_frame = transport_frame + _capture_offset;
520 last_recordable_frame = max_frames;
521 capture_start_frame = transport_frame;
523 if (!(last_possibly_recording & transport_rolling) && (possibly_recording & transport_rolling)) {
525 /* was stopped, now rolling (and recording) */
527 if (_alignment_style == ExistingMaterial) {
528 first_recordable_frame += _session.worst_output_latency();
530 first_recordable_frame += _roll_delay;
535 /* was rolling, but record state changed */
537 if (_alignment_style == ExistingMaterial) {
540 if (!_session.config.get_punch_in()) {
542 /* manual punch in happens at the correct transport frame
543 because the user hit a button. but to get alignment correct
544 we have to back up the position of the new region to the
545 appropriate spot given the roll delay.
548 capture_start_frame -= _roll_delay;
550 /* XXX paul notes (august 2005): i don't know why
554 first_recordable_frame += _capture_offset;
558 /* autopunch toggles recording at the precise
559 transport frame, and then the DS waits
560 to start recording for a time that depends
561 on the output latency.
564 first_recordable_frame += _session.worst_output_latency();
569 if (_session.config.get_punch_in()) {
570 first_recordable_frame += _roll_delay;
572 capture_start_frame -= _roll_delay;
578 prepare_record_status(capture_start_frame);
580 } else if (!record_enabled() || !can_record) {
584 last_recordable_frame = transport_frame + _capture_offset;
586 if (_alignment_style == ExistingMaterial) {
587 last_recordable_frame += _session.worst_output_latency();
589 last_recordable_frame += _roll_delay;
592 first_recordable_frame = max_frames;
595 last_possibly_recording = possibly_recording;
599 Diskstream::route_going_away ()
605 Diskstream::calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
606 nframes_t& rec_nframes, nframes_t& rec_offset)
613 case OverlapInternal:
614 /* ---------- recrange
617 rec_nframes = nframes;
622 /* |--------| recrange
625 rec_nframes = transport_frame + nframes - first_recordable_frame;
627 rec_offset = first_recordable_frame - transport_frame;
632 /* |--------| recrange
635 rec_nframes = last_recordable_frame - transport_frame;
639 case OverlapExternal:
640 /* |--------| recrange
641 -------------- transrange
643 rec_nframes = last_recordable_frame - first_recordable_frame;
644 rec_offset = first_recordable_frame - transport_frame;