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.
31 #include "pbd/error.h"
32 #include "pbd/xml++.h"
33 #include "pbd/memento_command.h"
34 #include "pbd/enumwriter.h"
35 #include "pbd/stateful_diff_command.h"
37 #include "ardour/analyser.h"
38 #include "ardour/audio_buffer.h"
39 #include "ardour/audio_diskstream.h"
40 #include "ardour/audio_port.h"
41 #include "ardour/audioengine.h"
42 #include "ardour/audiofilesource.h"
43 #include "ardour/audioplaylist.h"
44 #include "ardour/audioregion.h"
45 #include "ardour/butler.h"
46 #include "ardour/debug.h"
47 #include "ardour/io.h"
48 #include "ardour/playlist_factory.h"
49 #include "ardour/profile.h"
50 #include "ardour/region_factory.h"
51 #include "ardour/session.h"
52 #include "ardour/session_playlists.h"
53 #include "ardour/sndfile_helpers.h"
54 #include "ardour/source_factory.h"
55 #include "ardour/track.h"
56 #include "ardour/types.h"
57 #include "ardour/utils.h"
63 using namespace ARDOUR;
66 Sample* AudioDiskstream::_mixdown_buffer = 0;
67 gain_t* AudioDiskstream::_gain_buffer = 0;
69 AudioDiskstream::AudioDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
70 : Diskstream(sess, name, flag)
71 , channels (new ChannelList)
73 /* prevent any write sources from being created */
79 if (flag & Destructive) {
80 use_destructive_playlist ();
84 AudioDiskstream::AudioDiskstream (Session& sess, const XMLNode& node)
85 : Diskstream(sess, node)
86 , channels (new ChannelList)
91 if (set_state (node, Stateful::loading_state_version)) {
93 throw failed_constructor();
99 use_destructive_playlist ();
104 AudioDiskstream::init ()
106 /* there are no channels at this point, so these
107 two calls just get speed_buffer_size and wrap_buffer
108 size setup without duplicating their code.
111 set_block_size (_session.get_block_size());
112 allocate_temporary_buffers ();
115 AudioDiskstream::~AudioDiskstream ()
117 DEBUG_TRACE (DEBUG::Destruction, string_compose ("Audio Diskstream %1 destructor\n", _name));
120 RCUWriter<ChannelList> writer (channels);
121 boost::shared_ptr<ChannelList> c = writer.get_copy();
123 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
134 AudioDiskstream::allocate_working_buffers()
136 /* with varifill buffer refilling, we compute the read size in bytes (to optimize
137 for disk i/o bandwidth) and then convert back into samples. These buffers
138 need to reflect the maximum size we could use, which is 4MB reads, or 2M samples
139 using 16 bit samples.
141 _mixdown_buffer = new Sample[2*1048576];
142 _gain_buffer = new gain_t[2*1048576];
146 AudioDiskstream::free_working_buffers()
148 delete [] _mixdown_buffer;
149 delete [] _gain_buffer;
155 AudioDiskstream::non_realtime_input_change ()
157 bool need_write_sources = false;
160 Glib::Threads::Mutex::Lock lm (state_lock);
162 if (input_change_pending.type == IOChange::NoChange) {
166 boost::shared_ptr<ChannelList> cr = channels.reader();
167 if (!cr->empty() && !cr->front()->write_source) {
168 need_write_sources = true;
171 if (input_change_pending.type == IOChange::ConfigurationChanged) {
172 RCUWriter<ChannelList> writer (channels);
173 boost::shared_ptr<ChannelList> c = writer.get_copy();
175 _n_channels.set(DataType::AUDIO, c->size());
177 if (_io->n_ports().n_audio() > _n_channels.n_audio()) {
178 add_channel_to (c, _io->n_ports().n_audio() - _n_channels.n_audio());
179 } else if (_io->n_ports().n_audio() < _n_channels.n_audio()) {
180 remove_channel_from (c, _n_channels.n_audio() - _io->n_ports().n_audio());
183 need_write_sources = true;
186 if (input_change_pending.type & IOChange::ConnectionsChanged) {
187 get_input_sources ();
188 set_capture_offset ();
189 set_align_style_from_io ();
192 input_change_pending = IOChange::NoChange;
194 /* implicit unlock */
197 if (need_write_sources) {
198 reset_write_sources (false);
201 /* now refill channel buffers */
203 if (speed() != 1.0f || speed() != -1.0f) {
204 seek ((framepos_t) (_session.transport_frame() * (double) speed()));
206 seek (_session.transport_frame());
211 AudioDiskstream::non_realtime_locate (framepos_t location)
213 /* now refill channel buffers */
215 if (speed() != 1.0f || speed() != -1.0f) {
216 seek ((framepos_t) (location * (double) speed()), true);
218 seek (location, true);
223 AudioDiskstream::get_input_sources ()
225 boost::shared_ptr<ChannelList> c = channels.reader();
228 ChannelList::iterator chan;
229 uint32_t ni = _io->n_ports().n_audio();
230 vector<string> connections;
232 for (n = 0, chan = c->begin(); chan != c->end() && n < ni; ++chan, ++n) {
234 connections.clear ();
236 if ((_io->nth (n).get()) && (_io->nth (n)->get_connections (connections) == 0)) {
237 if (!(*chan)->source.name.empty()) {
238 // _source->disable_metering ();
240 (*chan)->source.name = string();
242 (*chan)->source.name = connections[0];
248 AudioDiskstream::find_and_use_playlist (const string& name)
250 boost::shared_ptr<AudioPlaylist> playlist;
252 if ((playlist = boost::dynamic_pointer_cast<AudioPlaylist> (_session.playlists->by_name (name))) == 0) {
253 playlist = boost::dynamic_pointer_cast<AudioPlaylist> (PlaylistFactory::create (DataType::AUDIO, _session, name));
257 error << string_compose(_("AudioDiskstream: Playlist \"%1\" isn't an audio playlist"), name) << endmsg;
261 return use_playlist (playlist);
265 AudioDiskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
267 assert(boost::dynamic_pointer_cast<AudioPlaylist>(playlist));
269 Diskstream::use_playlist(playlist);
275 AudioDiskstream::use_new_playlist ()
278 boost::shared_ptr<AudioPlaylist> playlist;
280 if (!in_set_state && destructive()) {
285 newname = Playlist::bump_name (_playlist->name(), _session);
287 newname = Playlist::bump_name (_name, _session);
290 if ((playlist = boost::dynamic_pointer_cast<AudioPlaylist> (PlaylistFactory::create (DataType::AUDIO, _session, newname, hidden()))) != 0) {
292 return use_playlist (playlist);
300 AudioDiskstream::use_copy_playlist ()
302 assert(audio_playlist());
308 if (_playlist == 0) {
309 error << string_compose(_("AudioDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
314 boost::shared_ptr<AudioPlaylist> playlist;
316 newname = Playlist::bump_name (_playlist->name(), _session);
318 if ((playlist = boost::dynamic_pointer_cast<AudioPlaylist>(PlaylistFactory::create (audio_playlist(), newname))) != 0) {
319 return use_playlist (playlist);
326 AudioDiskstream::setup_destructive_playlist ()
329 boost::shared_ptr<ChannelList> c = channels.reader();
331 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
332 srcs.push_back ((*chan)->write_source);
335 /* a single full-sized region */
337 assert (!srcs.empty ());
340 plist.add (Properties::name, _name.val());
341 plist.add (Properties::start, 0);
342 plist.add (Properties::length, max_framepos - srcs.front()->natural_position());
344 boost::shared_ptr<Region> region (RegionFactory::create (srcs, plist));
345 _playlist->add_region (region, srcs.front()->natural_position());
347 /* apply region properties and update write sources */
348 use_destructive_playlist();
352 AudioDiskstream::use_destructive_playlist ()
354 /* this is called from the XML-based constructor or ::set_destructive. when called,
355 we already have a playlist and a region, but we need to
356 set up our sources for write. we use the sources associated
357 with the (presumed single, full-extent) region.
360 boost::shared_ptr<Region> rp;
362 const RegionList& rl (_playlist->region_list().rlist());
364 assert((rl.size() == 1));
370 reset_write_sources (false, true);
374 boost::shared_ptr<AudioRegion> region = boost::dynamic_pointer_cast<AudioRegion> (rp);
377 throw failed_constructor();
380 /* be sure to stretch the region out to the maximum length */
382 region->set_length (max_framepos - region->position());
385 ChannelList::iterator chan;
386 boost::shared_ptr<ChannelList> c = channels.reader();
388 for (n = 0, chan = c->begin(); chan != c->end(); ++chan, ++n) {
389 (*chan)->write_source = boost::dynamic_pointer_cast<AudioFileSource>(region->source (n));
390 assert((*chan)->write_source);
391 (*chan)->write_source->set_allow_remove_if_empty (false);
393 /* this might be false if we switched modes, so force it */
395 (*chan)->write_source->set_destructive (true);
398 /* the source list will never be reset for a destructive track */
402 AudioDiskstream::prepare_record_status(framepos_t capture_start_frame)
404 if (recordable() && destructive()) {
405 boost::shared_ptr<ChannelList> c = channels.reader();
406 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
408 RingBufferNPT<CaptureTransition>::rw_vector transitions;
409 (*chan)->capture_transition_buf->get_write_vector (&transitions);
411 if (transitions.len[0] > 0) {
412 transitions.buf[0]->type = CaptureStart;
413 transitions.buf[0]->capture_val = capture_start_frame;
414 (*chan)->capture_transition_buf->increment_write_ptr(1);
417 fatal << X_("programming error: capture_transition_buf is full on rec start! inconceivable!")
425 /** Do some record stuff [not described in this comment!]
428 * - Setup playback_distance with the nframes, or nframes adjusted
429 * for current varispeed, if appropriate.
430 * - Setup current_playback_buffer in each ChannelInfo to point to data
431 * that someone can read playback_distance worth of data from.
434 AudioDiskstream::process (BufferSet& bufs, framepos_t transport_frame, pframes_t nframes, framecnt_t& playback_distance, bool need_disk_signal)
437 boost::shared_ptr<ChannelList> c = channels.reader();
438 ChannelList::iterator chan;
439 framecnt_t rec_offset = 0;
440 framecnt_t rec_nframes = 0;
441 bool collect_playback = false;
442 bool can_record = _session.actively_recording ();
444 playback_distance = 0;
446 if (!_io || !_io->active()) {
450 check_record_status (transport_frame, can_record);
456 Glib::Threads::Mutex::Lock sm (state_lock, Glib::Threads::TRY_LOCK);
462 adjust_capture_position = 0;
464 for (chan = c->begin(); chan != c->end(); ++chan) {
465 (*chan)->current_capture_buffer = 0;
466 (*chan)->current_playback_buffer = 0;
469 // Safeguard against situations where process() goes haywire when autopunching
470 // and last_recordable_frame < first_recordable_frame
472 if (last_recordable_frame < first_recordable_frame) {
473 last_recordable_frame = max_framepos;
476 if (record_enabled()) {
478 Evoral::OverlapType ot = Evoral::coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
479 // XXX should this be transport_frame + nframes - 1 ? coverage() expects its parameter ranges to include their end points
480 // XXX also, first_recordable_frame & last_recordable_frame may both be == max_framepos: coverage() will return OverlapNone in that case. Is thak OK?
481 calculate_record_range (ot, transport_frame, nframes, rec_nframes, rec_offset);
483 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: this time record %2 of %3 frames, offset %4\n", _name, rec_nframes, nframes, rec_offset));
485 if (rec_nframes && !was_recording) {
486 capture_captured = 0;
487 was_recording = true;
491 if (can_record && !_last_capture_sources.empty()) {
492 _last_capture_sources.clear ();
497 uint32_t limit = _io->n_ports ().n_audio();
499 /* one or more ports could already have been removed from _io, but our
500 channel setup hasn't yet been updated. prevent us from trying to
501 use channels that correspond to missing ports. note that the
502 process callback (from which this is called) is always atomic
503 with respect to port removal/addition.
506 for (n = 0, chan = c->begin(); chan != c->end() && n < limit; ++chan, ++n) {
508 ChannelInfo* chaninfo (*chan);
510 chaninfo->capture_buf->get_write_vector (&chaninfo->capture_vector);
512 if (rec_nframes <= (framecnt_t) chaninfo->capture_vector.len[0]) {
514 chaninfo->current_capture_buffer = chaninfo->capture_vector.buf[0];
516 /* note: grab the entire port buffer, but only copy what we were supposed to
517 for recording, and use rec_offset
520 boost::shared_ptr<AudioPort> const ap = _io->audio (n);
522 assert(rec_nframes <= (framecnt_t) ap->get_audio_buffer(nframes).capacity());
524 Sample *buf = bufs.get_audio (n).data(rec_offset);
525 memcpy (chaninfo->current_capture_buffer, buf, sizeof (Sample) * rec_nframes);
529 framecnt_t total = chaninfo->capture_vector.len[0] + chaninfo->capture_vector.len[1];
531 if (rec_nframes > total) {
532 DEBUG_TRACE (DEBUG::Butler, string_compose ("%1 overrun in %2, rec_nframes = %3 total space = %4\n",
533 DEBUG_THREAD_SELF, name(), rec_nframes, total));
538 boost::shared_ptr<AudioPort> const ap = _io->audio (n);
541 Sample *buf = bufs.get_audio (n).data(rec_offset);
542 framecnt_t first = chaninfo->capture_vector.len[0];
544 memcpy (chaninfo->capture_wrap_buffer, buf, sizeof (Sample) * first);
545 memcpy (chaninfo->capture_vector.buf[0], buf, sizeof (Sample) * first);
546 memcpy (chaninfo->capture_wrap_buffer+first, buf + first, sizeof (Sample) * (rec_nframes - first));
547 memcpy (chaninfo->capture_vector.buf[1], buf + first, sizeof (Sample) * (rec_nframes - first));
549 chaninfo->current_capture_buffer = chaninfo->capture_wrap_buffer;
563 /* data will be written to disk */
565 if (rec_nframes == nframes && rec_offset == 0) {
567 for (chan = c->begin(); chan != c->end(); ++chan) {
568 (*chan)->current_playback_buffer = (*chan)->current_capture_buffer;
571 playback_distance = nframes;
576 /* we can't use the capture buffer as the playback buffer, because
577 we recorded only a part of the current process' cycle data
581 collect_playback = true;
584 adjust_capture_position = rec_nframes;
586 } else if (can_record && record_enabled()) {
588 /* can't do actual capture yet - waiting for latency effects to finish before we start*/
590 for (chan = c->begin(); chan != c->end(); ++chan) {
591 (*chan)->current_playback_buffer = (*chan)->current_capture_buffer;
594 playback_distance = nframes;
598 collect_playback = true;
601 if ((_track->monitoring_state () & MonitoringDisk) || collect_playback) {
603 /* we're doing playback */
605 framecnt_t necessary_samples;
607 /* no varispeed playback if we're recording, because the output .... TBD */
609 if (rec_nframes == 0 && _actual_speed != 1.0) {
610 necessary_samples = (framecnt_t) ceil ((nframes * fabs (_actual_speed))) + 2;
612 necessary_samples = nframes;
615 for (chan = c->begin(); chan != c->end(); ++chan) {
616 (*chan)->playback_buf->get_read_vector (&(*chan)->playback_vector);
621 /* Setup current_playback_buffer in each ChannelInfo to point to data that someone
622 can read necessary_samples (== nframes at a transport speed of 1) worth of data
626 for (chan = c->begin(); chan != c->end(); ++chan, ++n) {
628 ChannelInfo* chaninfo (*chan);
630 if (necessary_samples <= (framecnt_t) chaninfo->playback_vector.len[0]) {
631 /* There are enough samples in the first part of the ringbuffer */
632 chaninfo->current_playback_buffer = chaninfo->playback_vector.buf[0];
635 framecnt_t total = chaninfo->playback_vector.len[0] + chaninfo->playback_vector.len[1];
637 if (necessary_samples > total) {
638 cerr << _name << " Need " << necessary_samples << " total = " << total << endl;
639 cerr << "underrun for " << _name << endl;
640 DEBUG_TRACE (DEBUG::Butler, string_compose ("%1 underrun in %2, rec_nframes = %3 total space = %4\n",
641 DEBUG_THREAD_SELF, name(), rec_nframes, total));
647 /* We have enough samples, but not in one lump. Coalesce the two parts
648 into one in playback_wrap_buffer in our ChannelInfo, and specify that
649 as our current_playback_buffer.
652 assert(wrap_buffer_size >= necessary_samples);
654 /* Copy buf[0] from playback_buf */
655 memcpy ((char *) chaninfo->playback_wrap_buffer,
656 chaninfo->playback_vector.buf[0],
657 chaninfo->playback_vector.len[0] * sizeof (Sample));
659 /* Copy buf[1] from playback_buf */
660 memcpy (chaninfo->playback_wrap_buffer + chaninfo->playback_vector.len[0],
661 chaninfo->playback_vector.buf[1],
662 (necessary_samples - chaninfo->playback_vector.len[0])
665 chaninfo->current_playback_buffer = chaninfo->playback_wrap_buffer;
670 if (rec_nframes == 0 && _actual_speed != 1.0f && _actual_speed != -1.0f) {
672 interpolation.set_speed (_target_speed);
675 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan, ++channel) {
676 ChannelInfo* chaninfo (*chan);
678 playback_distance = interpolation.interpolate (
679 channel, nframes, chaninfo->current_playback_buffer, chaninfo->speed_buffer);
681 chaninfo->current_playback_buffer = chaninfo->speed_buffer;
685 playback_distance = nframes;
688 _speed = _target_speed;
691 if (need_disk_signal) {
693 /* copy data over to buffer set */
695 size_t n_buffers = bufs.count().n_audio();
696 size_t n_chans = c->size();
697 gain_t scaling = 1.0f;
699 if (n_chans > n_buffers) {
700 scaling = ((float) n_buffers)/n_chans;
703 for (n = 0, chan = c->begin(); chan != c->end(); ++chan, ++n) {
705 AudioBuffer& buf (bufs.get_audio (n%n_buffers));
706 ChannelInfo* chaninfo (*chan);
709 if (scaling != 1.0f) {
710 buf.read_from_with_gain (chaninfo->current_playback_buffer, nframes, scaling);
712 buf.read_from (chaninfo->current_playback_buffer, nframes);
715 if (scaling != 1.0f) {
716 buf.accumulate_with_gain_from (chaninfo->current_playback_buffer, nframes, scaling);
718 buf.accumulate_from (chaninfo->current_playback_buffer, nframes);
723 /* leave the MIDI count alone */
724 ChanCount cnt (DataType::AUDIO, n_chans);
725 cnt.set (DataType::MIDI, bufs.count().n_midi());
726 bufs.set_count (cnt);
728 /* extra buffers will already be silent, so leave them alone */
735 AudioDiskstream::calculate_playback_distance (pframes_t nframes)
737 frameoffset_t playback_distance = nframes;
739 if (record_enabled()) {
740 playback_distance = nframes;
741 } else if (_actual_speed != 1.0f && _actual_speed != -1.0f) {
742 interpolation.set_speed (_target_speed);
743 boost::shared_ptr<ChannelList> c = channels.reader();
745 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan, ++channel) {
746 playback_distance = interpolation.interpolate (channel, nframes, NULL, NULL);
749 playback_distance = nframes;
752 if (_actual_speed < 0.0) {
753 return -playback_distance;
755 return playback_distance;
759 /** Update various things including playback_sample, read pointer on each channel's playback_buf
760 * and write pointer on each channel's capture_buf. Also wout whether the butler is needed.
761 * @return true if the butler is required.
764 AudioDiskstream::commit (framecnt_t playback_distance)
766 bool need_butler = false;
768 if (!_io || !_io->active()) {
772 if (_actual_speed < 0.0) {
773 playback_sample -= playback_distance;
775 playback_sample += playback_distance;
778 boost::shared_ptr<ChannelList> c = channels.reader();
779 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
781 (*chan)->playback_buf->increment_read_ptr (playback_distance);
783 if (adjust_capture_position) {
784 (*chan)->capture_buf->increment_write_ptr (adjust_capture_position);
788 if (adjust_capture_position != 0) {
789 capture_captured += adjust_capture_position;
790 adjust_capture_position = 0;
798 if (_io && _io->active()) {
799 need_butler = c->front()->playback_buf->write_space() >= c->front()->playback_buf->bufsize() / 2;
804 if (_io && _io->active()) {
805 need_butler = ((framecnt_t) c->front()->playback_buf->write_space() >= disk_read_chunk_frames)
806 || ((framecnt_t) c->front()->capture_buf->read_space() >= disk_write_chunk_frames);
808 need_butler = ((framecnt_t) c->front()->capture_buf->read_space() >= disk_write_chunk_frames);
816 AudioDiskstream::set_pending_overwrite (bool yn)
818 /* called from audio thread, so we can use the read ptr and playback sample as we wish */
820 _pending_overwrite = yn;
822 overwrite_frame = playback_sample;
824 boost::shared_ptr<ChannelList> c = channels.reader ();
826 overwrite_offset = c->front()->playback_buf->get_read_ptr();
831 AudioDiskstream::overwrite_existing_buffers ()
833 boost::shared_ptr<ChannelList> c = channels.reader();
835 _pending_overwrite = false;
839 Sample* mixdown_buffer;
842 bool reversed = (_visible_speed * _session.transport_speed()) < 0.0f;
844 overwrite_queued = false;
846 /* assume all are the same size */
847 framecnt_t size = c->front()->playback_buf->bufsize();
849 mixdown_buffer = new Sample[size];
850 gain_buffer = new float[size];
852 /* reduce size so that we can fill the buffer correctly (ringbuffers
853 can only handle size-1, otherwise they appear to be empty)
860 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan, ++n) {
862 start = overwrite_frame;
863 framecnt_t cnt = size;
865 /* to fill the buffer without resetting the playback sample, we need to
866 do it one or two chunks (normally two).
868 |----------------------------------------------------------------------|
872 |<- second chunk->||<----------------- first chunk ------------------>|
876 framecnt_t to_read = size - overwrite_offset;
878 if (read ((*chan)->playback_buf->buffer() + overwrite_offset, mixdown_buffer, gain_buffer, start, to_read, n, reversed)) {
879 error << string_compose(_("AudioDiskstream %1: when refilling, cannot read %2 from playlist at frame %3"),
880 id(), size, playback_sample) << endmsg;
888 if (read ((*chan)->playback_buf->buffer(), mixdown_buffer, gain_buffer, start, cnt, n, reversed)) {
889 error << string_compose(_("AudioDiskstream %1: when refilling, cannot read %2 from playlist at frame %3"),
890 id(), size, playback_sample) << endmsg;
899 _pending_overwrite = false;
900 delete [] gain_buffer;
901 delete [] mixdown_buffer;
906 AudioDiskstream::seek (framepos_t frame, bool complete_refill)
910 ChannelList::iterator chan;
911 boost::shared_ptr<ChannelList> c = channels.reader();
913 Glib::Threads::Mutex::Lock lm (state_lock);
915 for (n = 0, chan = c->begin(); chan != c->end(); ++chan, ++n) {
916 (*chan)->playback_buf->reset ();
917 (*chan)->capture_buf->reset ();
920 /* can't rec-enable in destructive mode if transport is before start */
922 if (destructive() && record_enabled() && frame < _session.current_start_frame()) {
923 disengage_record_enable ();
926 playback_sample = frame;
929 if (complete_refill) {
930 /* call _do_refill() to refill the entire buffer, using
931 the largest reads possible.
933 while ((ret = do_refill_with_alloc (false)) > 0) ;
935 /* call _do_refill() to refill just one chunk, and then
938 ret = do_refill_with_alloc (true);
945 AudioDiskstream::can_internal_playback_seek (framecnt_t distance)
947 ChannelList::iterator chan;
948 boost::shared_ptr<ChannelList> c = channels.reader();
950 for (chan = c->begin(); chan != c->end(); ++chan) {
951 if ((*chan)->playback_buf->read_space() < (size_t) distance) {
959 AudioDiskstream::internal_playback_seek (framecnt_t distance)
961 ChannelList::iterator chan;
962 boost::shared_ptr<ChannelList> c = channels.reader();
964 for (chan = c->begin(); chan != c->end(); ++chan) {
965 (*chan)->playback_buf->increment_read_ptr (::llabs(distance));
968 if (first_recordable_frame < max_framepos) {
969 first_recordable_frame += distance;
971 playback_sample += distance;
976 /** Read some data for 1 channel from our playlist into a buffer.
977 * @param buf Buffer to write to.
978 * @param start Session frame to start reading from; updated to where we end up
980 * @param cnt Count of samples to read.
981 * @param reversed true if we are running backwards, otherwise false.
984 AudioDiskstream::read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
985 framepos_t& start, framecnt_t cnt,
986 int channel, bool reversed)
988 framecnt_t this_read = 0;
990 framepos_t loop_end = 0;
991 framepos_t loop_start = 0;
992 framecnt_t offset = 0;
995 /* XXX we don't currently play loops in reverse. not sure why */
999 framecnt_t loop_length = 0;
1001 /* Make the use of a Location atomic for this read operation.
1003 Note: Locations don't get deleted, so all we care about
1004 when I say "atomic" is that we are always pointing to
1005 the same one and using a start/length values obtained
1009 if ((loc = loop_location) != 0) {
1010 loop_start = loc->start();
1011 loop_end = loc->end();
1012 loop_length = loop_end - loop_start;
1015 /* if we are looping, ensure that the first frame we read is at the correct
1016 position within the loop.
1019 if (loc && start >= loop_end) {
1020 start = loop_start + ((start - loop_start) % loop_length);
1029 /* We need this while loop in case we hit a loop boundary, in which case our read from
1030 the playlist must be split into more than one section.
1035 /* take any loop into account. we can't read past the end of the loop. */
1037 if (loc && (loop_end - start < cnt)) {
1038 this_read = loop_end - start;
1045 if (this_read == 0) {
1049 this_read = min(cnt,this_read);
1051 if (audio_playlist()->read (buf+offset, mixdown_buffer, gain_buffer, start, this_read, channel) != this_read) {
1052 error << string_compose(_("AudioDiskstream %1: cannot read %2 from playlist at frame %3"), id(), this_read,
1059 swap_by_ptr (buf, buf + this_read - 1);
1063 /* if we read to the end of the loop, go back to the beginning */
1073 offset += this_read;
1080 AudioDiskstream::_do_refill_with_alloc (bool partial_fill)
1082 /* We limit disk reads to at most 4MB chunks, which with floating point
1083 samples would be 1M samples. But we might use 16 or 14 bit samples,
1084 in which case 4MB is more samples than that. Therefore size this for
1085 the smallest sample value .. 4MB = 2M samples (16 bit).
1088 Sample* mix_buf = new Sample[2*1048576];
1089 float* gain_buf = new float[2*1048576];
1091 int ret = _do_refill (mix_buf, gain_buf, (partial_fill ? disk_read_chunk_frames : 0));
1099 /** Get some more data from disk and put it in our channels' playback_bufs,
1100 * if there is suitable space in them.
1102 * If fill_level is non-zero, then we will refill the buffer so that there is
1103 * still at least fill_level samples of space left to be filled. This is used
1104 * after locates so that we do not need to wait to fill the entire buffer.
1109 AudioDiskstream::_do_refill (Sample* mixdown_buffer, float* gain_buffer, framecnt_t fill_level)
1113 RingBufferNPT<Sample>::rw_vector vector;
1114 bool const reversed = (_visible_speed * _session.transport_speed()) < 0.0f;
1115 framecnt_t total_space;
1116 framecnt_t zero_fill;
1118 ChannelList::iterator i;
1119 boost::shared_ptr<ChannelList> c = channels.reader();
1122 /* do not read from disk while session is marked as Loading, to avoid
1123 useless redundant I/O.
1126 if (_session.state_of_the_state() & Session::Loading) {
1134 assert(mixdown_buffer);
1135 assert(gain_buffer);
1142 c->front()->playback_buf->get_write_vector (&vector);
1144 if ((total_space = vector.len[0] + vector.len[1]) == 0) {
1145 /* nowhere to write to */
1150 if (fill_level < total_space) {
1151 total_space -= fill_level;
1153 /* we can't do anything with it */
1158 /* if we're running close to normal speed and there isn't enough
1159 space to do disk_read_chunk_frames of I/O, then don't bother.
1161 at higher speeds, just do it because the sync between butler
1162 and audio thread may not be good enough.
1164 Note: it is a design assumption that disk_read_chunk_frames is smaller
1165 than the playback buffer size, so this check should never trip when
1166 the playback buffer is empty.
1169 if ((total_space < disk_read_chunk_frames) && fabs (_actual_speed) < 2.0f) {
1173 /* when slaved, don't try to get too close to the read pointer. this
1174 leaves space for the buffer reversal to have something useful to
1178 if (_slaved && total_space < (framecnt_t) (c->front()->playback_buf->bufsize() / 2)) {
1184 if (file_frame == 0) {
1186 /* at start: nothing to do but fill with silence */
1188 for (chan_n = 0, i = c->begin(); i != c->end(); ++i, ++chan_n) {
1190 ChannelInfo* chan (*i);
1191 chan->playback_buf->get_write_vector (&vector);
1192 memset (vector.buf[0], 0, sizeof(Sample) * vector.len[0]);
1193 if (vector.len[1]) {
1194 memset (vector.buf[1], 0, sizeof(Sample) * vector.len[1]);
1196 chan->playback_buf->increment_write_ptr (vector.len[0] + vector.len[1]);
1201 if (file_frame < total_space) {
1203 /* too close to the start: read what we can,
1204 and then zero fill the rest
1207 zero_fill = total_space - file_frame;
1208 total_space = file_frame;
1217 if (file_frame == max_framepos) {
1219 /* at end: nothing to do but fill with silence */
1221 for (chan_n = 0, i = c->begin(); i != c->end(); ++i, ++chan_n) {
1223 ChannelInfo* chan (*i);
1224 chan->playback_buf->get_write_vector (&vector);
1225 memset (vector.buf[0], 0, sizeof(Sample) * vector.len[0]);
1226 if (vector.len[1]) {
1227 memset (vector.buf[1], 0, sizeof(Sample) * vector.len[1]);
1229 chan->playback_buf->increment_write_ptr (vector.len[0] + vector.len[1]);
1234 if (file_frame > max_framepos - total_space) {
1236 /* to close to the end: read what we can, and zero fill the rest */
1238 zero_fill = total_space - (max_framepos - file_frame);
1239 total_space = max_framepos - file_frame;
1246 framepos_t file_frame_tmp = 0;
1248 /* total_space is in samples. We want to optimize read sizes in various sizes using bytes */
1250 const size_t bits_per_sample = format_data_width (_session.config.get_native_file_data_format());
1251 size_t total_bytes = total_space * bits_per_sample / 8;
1253 /* chunk size range is 256kB to 4MB. Bigger is faster in terms of MB/sec, but bigger chunk size always takes longer
1255 size_t byte_size_for_read = max ((size_t) (256 * 1024), min ((size_t) (4 * 1048576), total_bytes));
1257 /* find nearest (lower) multiple of 16384 */
1259 byte_size_for_read = (byte_size_for_read / 16384) * 16384;
1261 /* now back to samples */
1263 framecnt_t samples_to_read = byte_size_for_read / (bits_per_sample / 8);
1265 //cerr << name() << " will read " << byte_size_for_read << " out of total bytes " << total_bytes << " in buffer of "
1266 // << c->front()->playback_buf->bufsize() * bits_per_sample / 8 << " bps = " << bits_per_sample << endl;
1267 // cerr << name () << " read samples = " << samples_to_read << " out of total space " << total_space << " in buffer of " << c->front()->playback_buf->bufsize() << " samples\n";
1269 // uint64_t before = g_get_monotonic_time ();
1270 // uint64_t elapsed;
1272 for (chan_n = 0, i = c->begin(); i != c->end(); ++i, ++chan_n) {
1274 ChannelInfo* chan (*i);
1277 framecnt_t len1, len2;
1279 chan->playback_buf->get_write_vector (&vector);
1281 if ((framecnt_t) vector.len[0] > samples_to_read) {
1283 /* we're not going to fill the first chunk, so certainly do not bother with the
1284 other part. it won't be connected with the part we do fill, as in:
1286 .... => writable space
1287 ++++ => readable space
1288 ^^^^ => 1 x disk_read_chunk_frames that would be filled
1290 |......|+++++++++++++|...............................|
1295 So, just pretend that the buf1 part isn't there.
1305 file_frame_tmp = file_frame;
1307 buf1 = vector.buf[0];
1308 len1 = vector.len[0];
1309 buf2 = vector.buf[1];
1310 len2 = vector.len[1];
1312 to_read = min (ts, len1);
1313 to_read = min (to_read, (framecnt_t) samples_to_read);
1315 assert (to_read >= 0);
1319 if (read (buf1, mixdown_buffer, gain_buffer, file_frame_tmp, to_read, chan_n, reversed)) {
1324 chan->playback_buf->increment_write_ptr (to_read);
1328 to_read = min (ts, len2);
1332 /* we read all of vector.len[0], but it wasn't the
1333 entire samples_to_read of data, so read some or
1334 all of vector.len[1] as well.
1337 if (read (buf2, mixdown_buffer, gain_buffer, file_frame_tmp, to_read, chan_n, reversed)) {
1342 chan->playback_buf->increment_write_ptr (to_read);
1346 /* XXX: do something */
1351 // elapsed = g_get_monotonic_time () - before;
1352 // cerr << "\tbandwidth = " << (byte_size_for_read / 1048576.0) / (elapsed/1000000.0) << "MB/sec\n";
1354 file_frame = file_frame_tmp;
1355 assert (file_frame >= 0);
1357 ret = ((total_space - samples_to_read) > disk_read_chunk_frames);
1359 c->front()->playback_buf->get_write_vector (&vector);
1365 /** Flush pending data to disk.
1367 * Important note: this function will write *AT MOST* disk_write_chunk_frames
1368 * of data to disk. it will never write more than that. If it writes that
1369 * much and there is more than that waiting to be written, it will return 1,
1370 * otherwise 0 on success or -1 on failure.
1372 * If there is less than disk_write_chunk_frames to be written, no data will be
1373 * written at all unless @a force_flush is true.
1376 AudioDiskstream::do_flush (RunContext /*context*/, bool force_flush)
1380 RingBufferNPT<Sample>::rw_vector vector;
1381 RingBufferNPT<CaptureTransition>::rw_vector transvec;
1384 transvec.buf[0] = 0;
1385 transvec.buf[1] = 0;
1389 boost::shared_ptr<ChannelList> c = channels.reader();
1390 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1392 (*chan)->capture_buf->get_read_vector (&vector);
1394 total = vector.len[0] + vector.len[1];
1396 if (total == 0 || (total < disk_write_chunk_frames && !force_flush && was_recording)) {
1400 /* if there are 2+ chunks of disk i/o possible for
1401 this track, let the caller know so that it can arrange
1402 for us to be called again, ASAP.
1404 if we are forcing a flush, then if there is* any* extra
1405 work, let the caller know.
1407 if we are no longer recording and there is any extra work,
1408 let the caller know too.
1411 if (total >= 2 * disk_write_chunk_frames || ((force_flush || !was_recording) && total > disk_write_chunk_frames)) {
1415 to_write = min (disk_write_chunk_frames, (framecnt_t) vector.len[0]);
1417 // check the transition buffer when recording destructive
1418 // important that we get this after the capture buf
1420 if (destructive()) {
1421 (*chan)->capture_transition_buf->get_read_vector(&transvec);
1422 size_t transcount = transvec.len[0] + transvec.len[1];
1425 for (ti=0; ti < transcount; ++ti) {
1426 CaptureTransition & captrans = (ti < transvec.len[0]) ? transvec.buf[0][ti] : transvec.buf[1][ti-transvec.len[0]];
1428 if (captrans.type == CaptureStart) {
1429 // by definition, the first data we got above represents the given capture pos
1431 (*chan)->write_source->mark_capture_start (captrans.capture_val);
1432 (*chan)->curr_capture_cnt = 0;
1434 } else if (captrans.type == CaptureEnd) {
1436 // capture end, the capture_val represents total frames in capture
1438 if (captrans.capture_val <= (*chan)->curr_capture_cnt + to_write) {
1440 // shorten to make the write a perfect fit
1441 uint32_t nto_write = (captrans.capture_val - (*chan)->curr_capture_cnt);
1443 if (nto_write < to_write) {
1444 ret = 1; // should we?
1446 to_write = nto_write;
1448 (*chan)->write_source->mark_capture_end ();
1450 // increment past this transition, but go no further
1455 // actually ends just beyond this chunk, so force more work
1463 (*chan)->capture_transition_buf->increment_read_ptr(ti);
1467 if ((!(*chan)->write_source) || (*chan)->write_source->write (vector.buf[0], to_write) != to_write) {
1468 error << string_compose(_("AudioDiskstream %1: cannot write to disk"), id()) << endmsg;
1472 (*chan)->capture_buf->increment_read_ptr (to_write);
1473 (*chan)->curr_capture_cnt += to_write;
1475 if ((to_write == vector.len[0]) && (total > to_write) && (to_write < disk_write_chunk_frames) && !destructive()) {
1477 /* we wrote all of vector.len[0] but it wasn't an entire
1478 disk_write_chunk_frames of data, so arrange for some part
1479 of vector.len[1] to be flushed to disk as well.
1482 to_write = min ((framecnt_t)(disk_write_chunk_frames - to_write), (framecnt_t) vector.len[1]);
1484 DEBUG_TRACE (DEBUG::Butler, string_compose ("%1 additional write of %2\n", name(), to_write));
1486 if ((*chan)->write_source->write (vector.buf[1], to_write) != to_write) {
1487 error << string_compose(_("AudioDiskstream %1: cannot write to disk"), id()) << endmsg;
1491 (*chan)->capture_buf->increment_read_ptr (to_write);
1492 (*chan)->curr_capture_cnt += to_write;
1501 AudioDiskstream::transport_stopped_wallclock (struct tm& when, time_t twhen, bool abort_capture)
1503 uint32_t buffer_position;
1504 bool more_work = true;
1506 boost::shared_ptr<AudioRegion> region;
1507 framecnt_t total_capture;
1509 SourceList::iterator src;
1510 ChannelList::iterator chan;
1511 vector<CaptureInfo*>::iterator ci;
1512 boost::shared_ptr<ChannelList> c = channels.reader();
1514 bool mark_write_completed = false;
1518 /* butler is already stopped, but there may be work to do
1519 to flush remaining data to disk.
1522 while (more_work && !err) {
1523 switch (do_flush (TransportContext, true)) {
1530 error << string_compose(_("AudioDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
1535 /* XXX is there anything we can do if err != 0 ? */
1536 Glib::Threads::Mutex::Lock lm (capture_info_lock);
1538 if (capture_info.empty()) {
1542 if (abort_capture) {
1544 if (destructive()) {
1548 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1550 if ((*chan)->write_source) {
1552 (*chan)->write_source->mark_for_remove ();
1553 (*chan)->write_source->drop_references ();
1554 (*chan)->write_source.reset ();
1557 /* new source set up in "out" below */
1563 for (total_capture = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1564 total_capture += (*ci)->frames;
1567 /* figure out the name for this take */
1569 for (n = 0, chan = c->begin(); chan != c->end(); ++chan, ++n) {
1571 boost::shared_ptr<AudioFileSource> s = (*chan)->write_source;
1575 s->update_header (capture_info.front()->start, when, twhen);
1576 s->set_captured_for (_name.val());
1577 s->mark_immutable ();
1579 if (Config->get_auto_analyse_audio()) {
1580 Analyser::queue_source_for_analysis (s, true);
1585 /* destructive tracks have a single, never changing region */
1587 if (destructive()) {
1589 /* send a signal that any UI can pick up to do the right thing. there is
1590 a small problem here in that a UI may need the peak data to be ready
1591 for the data that was recorded and this isn't interlocked with that
1592 process. this problem is deferred to the UI.
1595 _playlist->LayeringChanged(); // XXX this may not get the UI to do the right thing
1599 string whole_file_region_name;
1600 whole_file_region_name = region_name_from_path (c->front()->write_source->name(), true);
1602 /* Register a new region with the Session that
1603 describes the entire source. Do this first
1604 so that any sub-regions will obviously be
1605 children of this one (later!)
1611 plist.add (Properties::start, c->front()->write_source->last_capture_start_frame());
1612 plist.add (Properties::length, total_capture);
1613 plist.add (Properties::name, whole_file_region_name);
1614 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1615 rx->set_automatic (true);
1616 rx->set_whole_file (true);
1618 region = boost::dynamic_pointer_cast<AudioRegion> (rx);
1619 region->special_set_position (capture_info.front()->start);
1623 catch (failed_constructor& err) {
1624 error << string_compose(_("%1: could not create region for complete audio file"), _name) << endmsg;
1628 _last_capture_sources.insert (_last_capture_sources.end(), srcs.begin(), srcs.end());
1630 _playlist->clear_changes ();
1631 _playlist->set_capture_insertion_in_progress (true);
1632 _playlist->freeze ();
1634 for (buffer_position = c->front()->write_source->last_capture_start_frame(), ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1638 RegionFactory::region_name (region_name, whole_file_region_name, false);
1640 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1 capture start @ %2 length %3 add new region %4\n",
1641 _name, (*ci)->start, (*ci)->frames, region_name));
1647 plist.add (Properties::start, buffer_position);
1648 plist.add (Properties::length, (*ci)->frames);
1649 plist.add (Properties::name, region_name);
1651 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1652 region = boost::dynamic_pointer_cast<AudioRegion> (rx);
1655 catch (failed_constructor& err) {
1656 error << _("AudioDiskstream: could not create region for captured audio!") << endmsg;
1657 continue; /* XXX is this OK? */
1660 i_am_the_modifier++;
1662 _playlist->add_region (region, (*ci)->start, 1, non_layered());
1663 _playlist->set_layer (region, DBL_MAX);
1664 i_am_the_modifier--;
1666 buffer_position += (*ci)->frames;
1670 _playlist->set_capture_insertion_in_progress (false);
1671 _session.add_command (new StatefulDiffCommand (_playlist));
1674 mark_write_completed = true;
1677 reset_write_sources (mark_write_completed);
1681 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1685 capture_info.clear ();
1686 capture_start_frame = 0;
1690 AudioDiskstream::transport_looped (framepos_t transport_frame)
1692 if (was_recording) {
1693 // all we need to do is finish this capture, with modified capture length
1694 boost::shared_ptr<ChannelList> c = channels.reader();
1698 // the next region will start recording via the normal mechanism
1699 // we'll set the start position to the current transport pos
1700 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1701 capture_start_frame = transport_frame;
1702 first_recordable_frame = transport_frame; // mild lie
1703 last_recordable_frame = max_framepos;
1704 was_recording = true;
1706 if (recordable() && destructive()) {
1707 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1709 RingBufferNPT<CaptureTransition>::rw_vector transvec;
1710 (*chan)->capture_transition_buf->get_write_vector(&transvec);
1712 if (transvec.len[0] > 0) {
1713 transvec.buf[0]->type = CaptureStart;
1714 transvec.buf[0]->capture_val = capture_start_frame;
1715 (*chan)->capture_transition_buf->increment_write_ptr(1);
1719 fatal << X_("programming error: capture_transition_buf is full on rec loop! inconceivable!")
1729 AudioDiskstream::finish_capture (boost::shared_ptr<ChannelList> c)
1731 was_recording = false;
1732 first_recordable_frame = max_framepos;
1733 last_recordable_frame = max_framepos;
1735 if (capture_captured == 0) {
1739 if (recordable() && destructive()) {
1740 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1742 RingBufferNPT<CaptureTransition>::rw_vector transvec;
1743 (*chan)->capture_transition_buf->get_write_vector(&transvec);
1745 if (transvec.len[0] > 0) {
1746 transvec.buf[0]->type = CaptureEnd;
1747 transvec.buf[0]->capture_val = capture_captured;
1748 (*chan)->capture_transition_buf->increment_write_ptr(1);
1752 fatal << string_compose (_("programmer error: %1"), X_("capture_transition_buf is full when stopping record! inconceivable!")) << endmsg;
1758 CaptureInfo* ci = new CaptureInfo;
1760 ci->start = capture_start_frame;
1761 ci->frames = capture_captured;
1763 /* XXX theoretical race condition here. Need atomic exchange ?
1764 However, the circumstances when this is called right
1765 now (either on record-disable or transport_stopped)
1766 mean that no actual race exists. I think ...
1767 We now have a capture_info_lock, but it is only to be used
1768 to synchronize in the transport_stop and the capture info
1769 accessors, so that invalidation will not occur (both non-realtime).
1772 DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("Finish capture, add new CI, %1 + %2\n", ci->start, ci->frames));
1774 capture_info.push_back (ci);
1775 capture_captured = 0;
1777 /* now we've finished a capture, reset first_recordable_frame for next time */
1778 first_recordable_frame = max_framepos;
1782 AudioDiskstream::set_record_enabled (bool yn)
1784 if (!recordable() || !_session.record_enabling_legal() || _io->n_ports().n_audio() == 0 || record_safe ()) {
1788 /* can't rec-enable in destructive mode if transport is before start */
1790 if (destructive() && yn && _session.transport_frame() < _session.current_start_frame()) {
1794 /* yes, i know that this not proof against race conditions, but its
1795 good enough. i think.
1798 if (record_enabled() != yn) {
1800 engage_record_enable ();
1802 disengage_record_enable ();
1805 RecordEnableChanged (); /* EMIT SIGNAL */
1810 AudioDiskstream::set_record_safe (bool yn)
1812 if (!recordable() || !_session.record_enabling_legal() || _io->n_ports().n_audio() == 0) {
1816 /* can't rec-safe in destructive mode if transport is before start ????
1819 if (destructive() && yn && _session.transport_frame() < _session.current_start_frame()) {
1823 /* yes, i know that this not proof against race conditions, but its
1824 good enough. i think.
1827 if (record_safe () != yn) {
1829 engage_record_safe ();
1831 disengage_record_safe ();
1834 RecordSafeChanged (); /* EMIT SIGNAL */
1839 AudioDiskstream::prep_record_enable ()
1841 if (!recordable() || !_session.record_enabling_legal() || _io->n_ports().n_audio() == 0 || record_safe ()) { // REQUIRES REVIEW "|| record_safe ()"
1845 /* can't rec-enable in destructive mode if transport is before start */
1847 if (destructive() && _session.transport_frame() < _session.current_start_frame()) {
1851 bool rolling = _session.transport_speed() != 0.0f;
1852 boost::shared_ptr<ChannelList> c = channels.reader();
1854 capturing_sources.clear ();
1856 if (Config->get_monitoring_model() == HardwareMonitoring) {
1858 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1859 (*chan)->source.request_input_monitoring (!(_session.config.get_auto_input() && rolling));
1860 capturing_sources.push_back ((*chan)->write_source);
1861 Source::Lock lock((*chan)->write_source->mutex());
1862 (*chan)->write_source->mark_streaming_write_started (lock);
1866 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1867 capturing_sources.push_back ((*chan)->write_source);
1868 Source::Lock lock((*chan)->write_source->mutex());
1869 (*chan)->write_source->mark_streaming_write_started (lock);
1877 AudioDiskstream::prep_record_disable ()
1879 boost::shared_ptr<ChannelList> c = channels.reader();
1880 if (Config->get_monitoring_model() == HardwareMonitoring) {
1881 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
1882 (*chan)->source.request_input_monitoring (false);
1885 capturing_sources.clear ();
1891 AudioDiskstream::get_state ()
1893 XMLNode& node (Diskstream::get_state());
1895 LocaleGuard lg (X_("C"));
1897 boost::shared_ptr<ChannelList> c = channels.reader();
1898 snprintf (buf, sizeof(buf), "%u", (unsigned int) c->size());
1899 node.add_property ("channels", buf);
1901 if (!capturing_sources.empty() && _session.get_record_enabled()) {
1903 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1904 XMLNode* cs_grandchild;
1906 for (vector<boost::shared_ptr<AudioFileSource> >::iterator i = capturing_sources.begin(); i != capturing_sources.end(); ++i) {
1907 cs_grandchild = new XMLNode (X_("file"));
1908 cs_grandchild->add_property (X_("path"), (*i)->path());
1909 cs_child->add_child_nocopy (*cs_grandchild);
1912 /* store the location where capture will start */
1916 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1917 snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1919 snprintf (buf, sizeof (buf), "%" PRId64, _session.transport_frame());
1922 cs_child->add_property (X_("at"), buf);
1923 node.add_child_nocopy (*cs_child);
1930 AudioDiskstream::set_state (const XMLNode& node, int version)
1932 const XMLProperty* prop;
1933 XMLNodeList nlist = node.children();
1934 XMLNodeIterator niter;
1935 uint32_t nchans = 1;
1936 XMLNode* capture_pending_node = 0;
1937 LocaleGuard lg (X_("C"));
1939 /* prevent write sources from being created */
1941 in_set_state = true;
1943 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1944 if ((*niter)->name() == IO::state_node_name) {
1945 deprecated_io_node = new XMLNode (**niter);
1948 if ((*niter)->name() == X_("CapturingSources")) {
1949 capture_pending_node = *niter;
1953 if (Diskstream::set_state (node, version)) {
1957 if ((prop = node.property ("channels")) != 0) {
1958 nchans = atoi (prop->value().c_str());
1961 // create necessary extra channels
1962 // we are always constructed with one and we always need one
1964 _n_channels.set(DataType::AUDIO, channels.reader()->size());
1966 if (nchans > _n_channels.n_audio()) {
1968 add_channel (nchans - _n_channels.n_audio());
1969 IO::PortCountChanged(_n_channels);
1971 } else if (nchans < _n_channels.n_audio()) {
1973 remove_channel (_n_channels.n_audio() - nchans);
1978 if (!destructive() && capture_pending_node) {
1979 /* destructive streams have one and only one source per channel,
1980 and so they never end up in pending capture in any useful
1983 use_pending_capture_data (*capture_pending_node);
1986 in_set_state = false;
1988 /* make sure this is clear before we do anything else */
1990 capturing_sources.clear ();
1992 /* write sources are handled when we handle the input set
1993 up of the IO that owns this DS (::non_realtime_input_change())
2000 AudioDiskstream::use_new_write_source (uint32_t n)
2002 boost::shared_ptr<ChannelList> c = channels.reader();
2004 if (!recordable()) {
2008 if (n >= c->size()) {
2009 error << string_compose (_("AudioDiskstream: channel %1 out of range"), n) << endmsg;
2013 ChannelInfo* chan = (*c)[n];
2016 if ((chan->write_source = _session.create_audio_source_for_session (
2017 n_channels().n_audio(), write_source_name(), n, destructive())) == 0) {
2018 throw failed_constructor();
2022 catch (failed_constructor &err) {
2023 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
2024 chan->write_source.reset ();
2028 /* do not remove destructive files even if they are empty */
2030 chan->write_source->set_allow_remove_if_empty (!destructive());
2036 AudioDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
2038 ChannelList::iterator chan;
2039 boost::shared_ptr<ChannelList> c = channels.reader();
2042 if (!_session.writable() || !recordable()) {
2046 capturing_sources.clear ();
2048 for (chan = c->begin(), n = 0; chan != c->end(); ++chan, ++n) {
2050 if (!destructive()) {
2052 if ((*chan)->write_source) {
2054 if (mark_write_complete) {
2055 Source::Lock lock((*chan)->write_source->mutex());
2056 (*chan)->write_source->mark_streaming_write_completed (lock);
2057 (*chan)->write_source->done_with_peakfile_writes ();
2060 if ((*chan)->write_source->removable()) {
2061 (*chan)->write_source->mark_for_remove ();
2062 (*chan)->write_source->drop_references ();
2065 (*chan)->write_source.reset ();
2068 use_new_write_source (n);
2070 if (record_enabled()) {
2071 capturing_sources.push_back ((*chan)->write_source);
2076 if ((*chan)->write_source == 0) {
2077 use_new_write_source (n);
2082 if (destructive() && !c->empty ()) {
2084 /* we now have all our write sources set up, so create the
2085 playlist's single region.
2088 if (_playlist->empty()) {
2089 setup_destructive_playlist ();
2095 AudioDiskstream::set_block_size (pframes_t /*nframes*/)
2097 if (_session.get_block_size() > speed_buffer_size) {
2098 speed_buffer_size = _session.get_block_size();
2099 boost::shared_ptr<ChannelList> c = channels.reader();
2101 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2102 if ((*chan)->speed_buffer)
2103 delete [] (*chan)->speed_buffer;
2104 (*chan)->speed_buffer = new Sample[speed_buffer_size];
2107 allocate_temporary_buffers ();
2111 AudioDiskstream::allocate_temporary_buffers ()
2113 /* make sure the wrap buffer is at least large enough to deal
2114 with the speeds up to 1.2, to allow for micro-variation
2115 when slaving to MTC, Timecode etc.
2118 double const sp = max (fabs (_actual_speed), 1.2);
2119 framecnt_t required_wrap_size = (framecnt_t) ceil (_session.get_block_size() * sp) + 2;
2121 if (required_wrap_size > wrap_buffer_size) {
2123 boost::shared_ptr<ChannelList> c = channels.reader();
2125 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2126 if ((*chan)->playback_wrap_buffer) {
2127 delete [] (*chan)->playback_wrap_buffer;
2129 (*chan)->playback_wrap_buffer = new Sample[required_wrap_size];
2130 if ((*chan)->capture_wrap_buffer) {
2131 delete [] (*chan)->capture_wrap_buffer;
2133 (*chan)->capture_wrap_buffer = new Sample[required_wrap_size];
2136 wrap_buffer_size = required_wrap_size;
2141 AudioDiskstream::request_input_monitoring (bool yn)
2143 boost::shared_ptr<ChannelList> c = channels.reader();
2145 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2146 (*chan)->source.request_input_monitoring (yn);
2151 AudioDiskstream::set_align_style_from_io ()
2153 bool have_physical = false;
2155 if (_alignment_choice != Automatic) {
2163 get_input_sources ();
2165 boost::shared_ptr<ChannelList> c = channels.reader();
2167 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2168 if ((*chan)->source.is_physical ()) {
2169 have_physical = true;
2174 if (have_physical) {
2175 set_align_style (ExistingMaterial);
2177 set_align_style (CaptureTime);
2182 AudioDiskstream::add_channel_to (boost::shared_ptr<ChannelList> c, uint32_t how_many)
2184 while (how_many--) {
2185 c->push_back (new ChannelInfo(
2186 _session.butler()->audio_diskstream_playback_buffer_size(),
2187 _session.butler()->audio_diskstream_capture_buffer_size(),
2188 speed_buffer_size, wrap_buffer_size));
2189 interpolation.add_channel_to (
2190 _session.butler()->audio_diskstream_playback_buffer_size(),
2194 _n_channels.set(DataType::AUDIO, c->size());
2200 AudioDiskstream::add_channel (uint32_t how_many)
2202 RCUWriter<ChannelList> writer (channels);
2203 boost::shared_ptr<ChannelList> c = writer.get_copy();
2205 return add_channel_to (c, how_many);
2209 AudioDiskstream::remove_channel_from (boost::shared_ptr<ChannelList> c, uint32_t how_many)
2211 while (how_many-- && !c->empty()) {
2214 interpolation.remove_channel_from ();
2217 _n_channels.set(DataType::AUDIO, c->size());
2223 AudioDiskstream::remove_channel (uint32_t how_many)
2225 RCUWriter<ChannelList> writer (channels);
2226 boost::shared_ptr<ChannelList> c = writer.get_copy();
2228 return remove_channel_from (c, how_many);
2232 AudioDiskstream::playback_buffer_load () const
2234 boost::shared_ptr<ChannelList> c = channels.reader();
2240 return (float) ((double) c->front()->playback_buf->read_space()/
2241 (double) c->front()->playback_buf->bufsize());
2245 AudioDiskstream::capture_buffer_load () const
2247 boost::shared_ptr<ChannelList> c = channels.reader();
2253 return (float) ((double) c->front()->capture_buf->write_space()/
2254 (double) c->front()->capture_buf->bufsize());
2258 AudioDiskstream::use_pending_capture_data (XMLNode& node)
2260 const XMLProperty* prop;
2261 XMLNodeList nlist = node.children();
2262 XMLNodeIterator niter;
2263 boost::shared_ptr<AudioFileSource> fs;
2264 boost::shared_ptr<AudioFileSource> first_fs;
2265 SourceList pending_sources;
2266 framepos_t position;
2268 if ((prop = node.property (X_("at"))) == 0) {
2272 if (sscanf (prop->value().c_str(), "%" PRIu64, &position) != 1) {
2276 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2277 if ((*niter)->name() == X_("file")) {
2279 if ((prop = (*niter)->property (X_("path"))) == 0) {
2283 // This protects sessions from errant CapturingSources in stored sessions
2285 if (stat (prop->value().c_str(), &sbuf)) {
2289 /* XXX as of June 2014, we always record to mono
2290 files. Since this Source is being created as part of
2291 crash recovery, we know that we need the first
2292 channel (the final argument to the SourceFactory
2293 call below). If we ever support non-mono files for
2294 capture, this will need rethinking.
2298 fs = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createForRecovery (DataType::AUDIO, _session, prop->value(), 0));
2301 catch (failed_constructor& err) {
2302 error << string_compose (_("%1: cannot restore pending capture source file %2"),
2303 _name, prop->value())
2308 pending_sources.push_back (fs);
2310 if (first_fs == 0) {
2314 fs->set_captured_for (_name.val());
2318 if (pending_sources.size() == 0) {
2319 /* nothing can be done */
2323 if (pending_sources.size() != _n_channels.n_audio()) {
2324 error << string_compose (_("%1: incorrect number of pending sources listed - ignoring them all"), _name)
2331 boost::shared_ptr<AudioRegion> wf_region;
2332 boost::shared_ptr<AudioRegion> region;
2334 /* First create the whole file region */
2338 plist.add (Properties::start, 0);
2339 plist.add (Properties::length, first_fs->length (first_fs->timeline_position()));
2340 plist.add (Properties::name, region_name_from_path (first_fs->name(), true));
2342 wf_region = boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (pending_sources, plist));
2344 wf_region->set_automatic (true);
2345 wf_region->set_whole_file (true);
2346 wf_region->special_set_position (position);
2348 /* Now create a region that isn't the whole file for adding to
2351 region = boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (pending_sources, plist));
2353 _playlist->add_region (region, position);
2356 catch (failed_constructor& err) {
2357 error << string_compose (
2358 _("%1: cannot create whole-file region from pending capture sources"),
2369 AudioDiskstream::set_non_layered (bool yn)
2371 if (yn != non_layered()) {
2374 _flags = Flag (_flags | NonLayered);
2376 _flags = Flag (_flags & ~NonLayered);
2384 AudioDiskstream::set_destructive (bool yn)
2386 if (yn != destructive()) {
2389 bool bounce_ignored;
2390 /* requestor should already have checked this and
2391 bounced if necessary and desired
2393 if (!can_become_destructive (bounce_ignored)) {
2396 _flags = Flag (_flags | Destructive);
2397 use_destructive_playlist ();
2399 _flags = Flag (_flags & ~Destructive);
2400 reset_write_sources (true, true);
2408 AudioDiskstream::can_become_destructive (bool& requires_bounce) const
2410 if (Profile->get_trx()) {
2415 requires_bounce = false;
2419 /* if no regions are present: easy */
2421 if (_playlist->n_regions() == 0) {
2422 requires_bounce = false;
2426 /* is there only one region ? */
2428 if (_playlist->n_regions() != 1) {
2429 requires_bounce = true;
2433 boost::shared_ptr<Region> first;
2435 const RegionList& rl (_playlist->region_list().rlist());
2436 assert((rl.size() == 1));
2442 requires_bounce = false;
2446 /* do the source(s) for the region cover the session start position ? */
2448 if (first->position() != _session.current_start_frame()) {
2449 // what is the idea here? why start() ??
2450 if (first->start() > _session.current_start_frame()) {
2451 requires_bounce = true;
2456 /* currently RouteTimeAxisView::set_track_mode does not
2457 * implement bounce. Existing regions cannot be converted.
2459 * so let's make sure this region is already set up
2460 * as tape-track (spanning the complete range)
2462 if (first->length() != max_framepos - first->position()) {
2463 requires_bounce = true;
2467 /* is the source used by only 1 playlist ? */
2469 boost::shared_ptr<AudioRegion> afirst = boost::dynamic_pointer_cast<AudioRegion> (first);
2473 if (_session.playlists->source_use_count (afirst->source()) > 1) {
2474 requires_bounce = true;
2478 requires_bounce = false;
2483 AudioDiskstream::adjust_playback_buffering ()
2485 boost::shared_ptr<ChannelList> c = channels.reader();
2487 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2488 (*chan)->resize_playback (_session.butler()->audio_diskstream_playback_buffer_size());
2493 AudioDiskstream::adjust_capture_buffering ()
2495 boost::shared_ptr<ChannelList> c = channels.reader();
2497 for (ChannelList::iterator chan = c->begin(); chan != c->end(); ++chan) {
2498 (*chan)->resize_capture (_session.butler()->audio_diskstream_capture_buffer_size());
2503 AudioDiskstream::ChannelSource::is_physical () const
2509 return AudioEngine::instance()->port_is_physical (name);
2513 AudioDiskstream::ChannelSource::request_input_monitoring (bool yn) const
2519 return AudioEngine::instance()->request_input_monitoring (name, yn);
2522 AudioDiskstream::ChannelInfo::ChannelInfo (framecnt_t playback_bufsize, framecnt_t capture_bufsize, framecnt_t speed_size, framecnt_t wrap_size)
2524 current_capture_buffer = 0;
2525 current_playback_buffer = 0;
2526 curr_capture_cnt = 0;
2528 speed_buffer = new Sample[speed_size];
2529 playback_wrap_buffer = new Sample[wrap_size];
2530 capture_wrap_buffer = new Sample[wrap_size];
2532 playback_buf = new RingBufferNPT<Sample> (playback_bufsize);
2533 capture_buf = new RingBufferNPT<Sample> (capture_bufsize);
2534 capture_transition_buf = new RingBufferNPT<CaptureTransition> (256);
2536 /* touch the ringbuffer buffers, which will cause
2537 them to be mapped into locked physical RAM if
2538 we're running with mlockall(). this doesn't do
2542 memset (playback_buf->buffer(), 0, sizeof (Sample) * playback_buf->bufsize());
2543 memset (capture_buf->buffer(), 0, sizeof (Sample) * capture_buf->bufsize());
2544 memset (capture_transition_buf->buffer(), 0, sizeof (CaptureTransition) * capture_transition_buf->bufsize());
2548 AudioDiskstream::ChannelInfo::resize_playback (framecnt_t playback_bufsize)
2550 delete playback_buf;
2551 playback_buf = new RingBufferNPT<Sample> (playback_bufsize);
2552 memset (playback_buf->buffer(), 0, sizeof (Sample) * playback_buf->bufsize());
2556 AudioDiskstream::ChannelInfo::resize_capture (framecnt_t capture_bufsize)
2560 capture_buf = new RingBufferNPT<Sample> (capture_bufsize);
2561 memset (capture_buf->buffer(), 0, sizeof (Sample) * capture_buf->bufsize());
2564 AudioDiskstream::ChannelInfo::~ChannelInfo ()
2567 if (write_source->removable()) {
2568 /* this is a "stub" write source which exists in the
2569 Session source list, but is removable. We must emit
2570 a drop references call because it should not
2571 continue to exist. If we do not do this, then the
2572 Session retains a reference to it, it is not
2573 deleted, and later attempts to create a new source
2574 file will use wierd naming because it already
2577 XXX longer term TO-DO: do not add to session source
2578 list until we write to the source.
2580 write_source->drop_references ();
2584 write_source.reset ();
2586 delete [] speed_buffer;
2589 delete [] playback_wrap_buffer;
2590 playback_wrap_buffer = 0;
2592 delete [] capture_wrap_buffer;
2593 capture_wrap_buffer = 0;
2595 delete playback_buf;
2601 delete capture_transition_buf;
2602 capture_transition_buf = 0;
2607 AudioDiskstream::set_name (string const & name)
2609 if (_name == name) {
2612 Diskstream::set_name (name);
2614 /* get a new write source so that its name reflects the new diskstream name */
2616 boost::shared_ptr<ChannelList> c = channels.reader();
2617 ChannelList::iterator i;
2620 for (n = 0, i = c->begin(); i != c->end(); ++i, ++n) {
2621 use_new_write_source (n);
2628 AudioDiskstream::set_write_source_name (const std::string& str) {
2629 if (_write_source_name == str) {
2633 Diskstream::set_write_source_name (str);
2635 if (_write_source_name == name()) {
2638 boost::shared_ptr<ChannelList> c = channels.reader();
2639 ChannelList::iterator i;
2642 for (n = 0, i = c->begin(); i != c->end(); ++i, ++n) {
2643 use_new_write_source (n);