(full commit): fix MIDI playback by not writing into the playback buffer from MidiDis...
[ardour.git] / libs / ardour / midi_diskstream.cc
1 /*
2     Copyright (C) 2000-2003 Paul Davis 
3
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.
8
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.
13
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.
17 */
18
19 #include <fstream>
20 #include <cstdio>
21 #include <unistd.h>
22 #include <cmath>
23 #include <cerrno>
24 #include <string>
25 #include <climits>
26 #include <fcntl.h>
27 #include <cstdlib>
28 #include <ctime>
29 #include <sys/stat.h>
30 #include <sys/mman.h>
31
32 #include "pbd/error.h"
33 #include "pbd/basename.h"
34 #include <glibmm/thread.h>
35 #include "pbd/xml++.h"
36 #include "pbd/memento_command.h"
37 #include "pbd/enumwriter.h"
38
39 #include "ardour/ardour.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/configuration.h"
42 #include "ardour/cycle_timer.h"
43 #include "ardour/io.h"
44 #include "ardour/midi_diskstream.h"
45 #include "ardour/midi_playlist.h"
46 #include "ardour/midi_port.h"
47 #include "ardour/midi_region.h"
48 #include "ardour/playlist_factory.h"
49 #include "ardour/region_factory.h"
50 #include "ardour/send.h"
51 #include "ardour/session.h"
52 #include "ardour/smf_source.h"
53 #include "ardour/utils.h"
54
55 #include "midi++/types.h"
56
57 #include "i18n.h"
58 #include <locale.h>
59
60 using namespace std;
61 using namespace ARDOUR;
62 using namespace PBD;
63
64 nframes_t MidiDiskstream::midi_readahead = 4096;
65
66 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
67         : Diskstream(sess, name, flag)
68         , _playback_buf(0)
69         , _capture_buf(0)
70         , _source_port(0)
71         , _last_flush_frame(0)
72         , _note_mode(Sustained)
73         , _frames_written_to_ringbuffer(0)
74         , _frames_read_from_ringbuffer(0)
75 {
76         /* prevent any write sources from being created */
77
78         in_set_state = true;
79
80         init(flag);
81         use_new_playlist ();
82
83         in_set_state = false;
84
85         assert(!destructive());
86 }
87         
88 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
89         : Diskstream(sess, node)
90         , _playback_buf(0)
91         , _capture_buf(0)
92         , _source_port(0)
93         , _last_flush_frame(0)
94         , _note_mode(Sustained)
95         , _frames_written_to_ringbuffer(0)
96         , _frames_read_from_ringbuffer(0)
97 {
98         in_set_state = true;
99         init (Recordable);
100
101         if (set_state (node)) {
102                 in_set_state = false;
103                 throw failed_constructor();
104         }
105
106         in_set_state = false;
107
108         if (destructive()) {
109                 use_destructive_playlist ();
110         }
111 }
112
113 void
114 MidiDiskstream::init (Diskstream::Flag f)
115 {
116         Diskstream::init(f);
117
118         /* there are no channels at this point, so these
119            two calls just get speed_buffer_size and wrap_buffer
120            size setup without duplicating their code.
121         */
122
123         set_block_size (_session.get_block_size());
124         allocate_temporary_buffers ();
125
126         const size_t size = _session.midi_diskstream_buffer_size();
127         _playback_buf = new MidiRingBuffer<nframes_t>(size);
128         _capture_buf = new MidiRingBuffer<nframes_t>(size);
129         
130         _n_channels = ChanCount(DataType::MIDI, 1);
131
132         assert(recordable());
133 }
134
135 MidiDiskstream::~MidiDiskstream ()
136 {
137         Glib::Mutex::Lock lm (state_lock);
138 }
139
140         
141 void
142 MidiDiskstream::non_realtime_locate (nframes_t position)
143 {
144         if (_write_source) {
145                 _write_source->set_timeline_position (position);
146         }
147         seek(position, false);
148 }
149
150
151 void
152 MidiDiskstream::non_realtime_input_change ()
153 {
154         { 
155                 Glib::Mutex::Lock lm (state_lock);
156
157                 if (input_change_pending == NoChange) {
158                         return;
159                 }
160
161                 if (input_change_pending & ConfigurationChanged) {
162                         if (_io->n_ports().n_midi() != _n_channels.n_midi()) {
163                                 error << "Can not feed IO " << _io->n_ports()
164                                         << " with diskstream " << _n_channels << endl;
165                         }
166                 } 
167
168                 get_input_sources ();
169                 set_capture_offset ();
170
171                 if (first_input_change) {
172                         set_align_style (_persistent_alignment_style);
173                         first_input_change = false;
174                 } else {
175                         set_align_style_from_io ();
176                 }
177
178                 input_change_pending = NoChange;
179                 
180                 /* implicit unlock */
181         }
182
183         /* reset capture files */
184
185         reset_write_sources (false);
186
187         /* now refill channel buffers */
188
189         if (speed() != 1.0f || speed() != -1.0f) {
190                 seek ((nframes_t) (_session.transport_frame() * (double) speed()));
191         }
192         else {
193                 seek (_session.transport_frame());
194         }
195
196         _last_flush_frame = _session.transport_frame();
197 }
198
199 void
200 MidiDiskstream::get_input_sources ()
201 {
202         uint32_t ni = _io->n_ports().n_midi();
203
204         if (ni == 0) {
205                 return;
206         }
207
208         // This is all we do for now at least
209         assert(ni == 1);
210
211         _source_port = _io->midi(0);
212
213         // do... stuff?
214 }               
215
216 int
217 MidiDiskstream::find_and_use_playlist (const string& name)
218 {
219         boost::shared_ptr<MidiPlaylist> playlist;
220                 
221         if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (_session.playlist_by_name (name))) == 0) {
222                 playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (DataType::MIDI, _session, name));
223         }
224
225         if (!playlist) {
226                 error << string_compose(_("MidiDiskstream: Playlist \"%1\" isn't an midi playlist"), name) << endmsg;
227                 return -1;
228         }
229
230         return use_playlist (playlist);
231 }
232
233 int
234 MidiDiskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
235 {       
236         assert(boost::dynamic_pointer_cast<MidiPlaylist>(playlist));
237
238         Diskstream::use_playlist(playlist);
239
240         return 0;
241 }
242
243 int
244 MidiDiskstream::use_new_playlist ()
245 {       
246         string newname;
247         boost::shared_ptr<MidiPlaylist> playlist;
248
249         if (!in_set_state && destructive()) {
250                 return 0;
251         }
252
253         if (_playlist) {
254                 newname = Playlist::bump_name (_playlist->name(), _session);
255         } else {
256                 newname = Playlist::bump_name (_name, _session);
257         }
258
259         if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (
260                         DataType::MIDI, _session, newname, hidden()))) != 0) {
261                 
262                 playlist->set_orig_diskstream_id (id());
263                 return use_playlist (playlist);
264
265         } else { 
266                 return -1;
267         }
268 }
269
270 int
271 MidiDiskstream::use_copy_playlist ()
272 {
273         assert(midi_playlist());
274
275         if (destructive()) {
276                 return 0;
277         }
278
279         if (_playlist == 0) {
280                 error << string_compose(_("MidiDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
281                 return -1;
282         }
283
284         string newname;
285         boost::shared_ptr<MidiPlaylist> playlist;
286
287         newname = Playlist::bump_name (_playlist->name(), _session);
288         
289         if ((playlist  = boost::dynamic_pointer_cast<MidiPlaylist>(PlaylistFactory::create (midi_playlist(), newname))) != 0) {
290                 playlist->set_orig_diskstream_id (id());
291                 return use_playlist (playlist);
292         } else { 
293                 return -1;
294         }
295 }
296
297 /** Overloaded from parent to die horribly
298  */
299 int
300 MidiDiskstream::set_destructive (bool yn)
301 {
302         assert( ! destructive());
303         assert( ! yn);
304         return -1;
305 }
306         
307 void
308 MidiDiskstream::set_note_mode (NoteMode m)
309 {
310         _note_mode = m;
311         midi_playlist()->set_note_mode(m);
312         if (_write_source && _write_source->model())
313                 _write_source->model()->set_note_mode(m);
314 }
315
316 void
317 MidiDiskstream::check_record_status (nframes_t transport_frame, nframes_t /*nframes*/, bool can_record)
318 {
319         // FIXME: waaay too much code to duplicate (AudioDiskstream)
320         
321         int possibly_recording;
322         int rolling;
323         int change;
324         const int transport_rolling = 0x4;
325         const int track_rec_enabled = 0x2;
326         const int global_rec_enabled = 0x1;
327
328         /* merge together the 3 factors that affect record status, and compute
329            what has changed.
330         */
331
332         rolling = _session.transport_speed() != 0.0f;
333         possibly_recording = (rolling << 2) | (record_enabled() << 1) | can_record;
334         change = possibly_recording ^ last_possibly_recording;
335
336         if (possibly_recording == last_possibly_recording) {
337                 return;
338         }
339
340         /* change state */
341
342         /* if per-track or global rec-enable turned on while the other was already on, we've started recording */
343
344         if (((change & track_rec_enabled) && record_enabled() && (!(change & global_rec_enabled) && can_record)) || 
345             ((change & global_rec_enabled) && can_record && (!(change & track_rec_enabled) && record_enabled()))) {
346                 
347                 /* starting to record: compute first+last frames */
348
349                 first_recordable_frame = transport_frame + _capture_offset;
350                 last_recordable_frame = max_frames;
351                 capture_start_frame = transport_frame;
352
353                 if (!(last_possibly_recording & transport_rolling) && (possibly_recording & transport_rolling)) {
354
355                         /* was stopped, now rolling (and recording) */
356
357                         if (_alignment_style == ExistingMaterial) {
358                                 first_recordable_frame += _session.worst_output_latency();
359                         } else {
360                                 first_recordable_frame += _roll_delay;
361                         }
362                 
363                 } else {
364
365                         /* was rolling, but record state changed */
366
367                         if (_alignment_style == ExistingMaterial) {
368
369
370                                 if (!_session.config.get_punch_in()) {
371
372                                         /* manual punch in happens at the correct transport frame
373                                            because the user hit a button. but to get alignment correct 
374                                            we have to back up the position of the new region to the 
375                                            appropriate spot given the roll delay.
376                                         */
377
378                                         capture_start_frame -= _roll_delay;
379
380                                         /* XXX paul notes (august 2005): i don't know why
381                                            this is needed.
382                                         */
383
384                                         first_recordable_frame += _capture_offset;
385
386                                 } else {
387
388                                         /* autopunch toggles recording at the precise
389                                            transport frame, and then the DS waits
390                                            to start recording for a time that depends
391                                            on the output latency.
392                                         */
393
394                                         first_recordable_frame += _session.worst_output_latency();
395                                 }
396
397                         } else {
398
399                                 if (_session.config.get_punch_in()) {
400                                         first_recordable_frame += _roll_delay;
401                                 } else {
402                                         capture_start_frame -= _roll_delay;
403                                 }
404                         }
405                         
406                 }
407
408         } else if (!record_enabled() || !can_record) {
409                 
410                 /* stop recording */
411
412                 last_recordable_frame = transport_frame + _capture_offset;
413                 
414                 if (_alignment_style == ExistingMaterial) {
415                         last_recordable_frame += _session.worst_output_latency();
416                 } else {
417                         last_recordable_frame += _roll_delay;
418                 }
419         }
420
421         last_possibly_recording = possibly_recording;
422 }
423
424 #if 0
425 static void
426 trace_midi (ostream& o, MIDI::byte *msg, size_t len)
427 {
428         using namespace MIDI;
429         eventType type;
430         const char trace_prefix = ':';
431         
432         type = (eventType) (msg[0]&0xF0);
433
434         switch (type) {
435         case off:
436                 o << trace_prefix
437                    << "Channel "
438                    << (msg[0]&0xF)+1
439                    << " NoteOff NoteNum "
440                    << (int) msg[1]
441                    << " Vel "
442                    << (int) msg[2]
443                    << endl;
444                 break;
445                 
446         case on:
447                 o << trace_prefix
448                    << "Channel "
449                    << (msg[0]&0xF)+1
450                    << " NoteOn NoteNum "
451                    << (int) msg[1]
452                    << " Vel "
453                    << (int) msg[2]
454                    << endl;
455                 break;
456             
457         case polypress:
458                 o << trace_prefix
459                    << "Channel "
460                    << (msg[0]&0xF)+1
461                    << " PolyPressure"
462                    << (int) msg[1]
463                    << endl;
464                 break;
465             
466         case MIDI::controller:
467                 o << trace_prefix
468                    << "Channel "
469                    << (msg[0]&0xF)+1
470                    << " Controller "
471                    << (int) msg[1]
472                    << " Value "
473                    << (int) msg[2]
474                    << endl;
475                 break;
476                 
477         case program:
478                 o << trace_prefix 
479                    << "Channel "
480                    << (msg[0]&0xF)+1
481                    <<  " Program Change ProgNum "
482                    << (int) msg[1]
483                    << endl;
484                 break;
485                 
486         case chanpress:
487                 o << trace_prefix 
488                    << "Channel "
489                    << (msg[0]&0xF)+1
490                    << " Channel Pressure "
491                    << (int) msg[1]
492                    << endl;
493                 break;
494             
495         case MIDI::pitchbend:
496                 o << trace_prefix
497                    << "Channel "
498                    << (msg[0]&0xF)+1
499                    << " Pitch Bend "
500                    << ((msg[2]<<7)|msg[1])
501                    << endl;
502                 break;
503             
504         case MIDI::sysex:
505                 if (len == 1) {
506                         switch (msg[0]) {
507                         case 0xf8:
508                                 o << trace_prefix
509                                    << "Clock"
510                                    << endl;
511                                 break;
512                         case 0xfa:
513                                 o << trace_prefix
514                                    << "Start"
515                                    << endl;
516                                 break;
517                         case 0xfb:
518                                 o << trace_prefix
519                                    << "Continue"
520                                    << endl;
521                                 break;
522                         case 0xfc:
523                                 o << trace_prefix
524                                    << "Stop"
525                                    << endl;
526                                 break;
527                         case 0xfe:
528                                 o << trace_prefix
529                                    << "Active Sense"
530                                    << endl;
531                                 break;
532                         case 0xff:
533                                 o << trace_prefix
534                                    << "System Reset"
535                                    << endl;
536                                 break;
537                         default:
538                                 o << trace_prefix
539                                    << "System Exclusive (1 byte : " << hex << (int) *msg << dec << ')'
540                                    << endl;             
541                                 break;
542                         } 
543                 } else {
544                         o << trace_prefix
545                            << "System Exclusive (" << len << ") = [ " << hex;
546                         for (unsigned int i = 0; i < len; ++i) {
547                                 o << (int) msg[i] << ' ';
548                         }
549                         o << dec << ']' << endl;
550                         
551                 }
552                 break;
553             
554         case MIDI::song:
555                 o << trace_prefix << "Song" << endl;
556                 break;
557             
558         case MIDI::tune:
559                 o << trace_prefix << "Tune" << endl;
560                 break;
561             
562         case MIDI::eox:
563                 o << trace_prefix << "End-of-System Exclusive" << endl;
564                 break;
565             
566         case MIDI::timing:
567                 o << trace_prefix << "Timing" << endl;
568                 break;
569             
570         case MIDI::start:
571                 o << trace_prefix << "Start" << endl;
572                 break;
573             
574         case MIDI::stop:
575                 o << trace_prefix << "Stop" << endl;
576                 break;
577             
578         case MIDI::contineu:
579                 o << trace_prefix << "Continue" << endl;
580                 break;
581             
582         case active:
583                 o << trace_prefix << "Active Sense" << endl;
584                 break;
585             
586         default:
587                 o << trace_prefix << "Unrecognized MIDI message" << endl;
588                 break;
589         }
590 }
591 #endif
592
593 int
594 MidiDiskstream::process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input)
595 {
596         // FIXME: waay too much code to duplicate (AudioDiskstream::process)
597         int       ret = -1;
598         nframes_t rec_offset = 0;
599         nframes_t rec_nframes = 0;
600         bool      nominally_recording;
601         bool      re = record_enabled ();
602
603         /* if we've already processed the frames corresponding to this call,
604            just return. this allows multiple routes that are taking input
605            from this diskstream to call our ::process() method, but have
606            this stuff only happen once. more commonly, it allows both
607            the AudioTrack that is using this AudioDiskstream *and* the Session
608            to call process() without problems.
609            */
610
611         if (_processed) {
612                 return 0;
613         }
614         
615         commit_should_unlock = false;
616
617         check_record_status (transport_frame, nframes, can_record);
618
619         nominally_recording = (can_record && re);
620
621         if (nframes == 0) {
622                 _processed = true;
623                 return 0;
624         }
625
626         /* This lock is held until the end of ::commit, so these two functions
627            must always be called as a pair. The only exception is if this function
628            returns a non-zero value, in which case, ::commit should not be called.
629            */
630
631         // If we can't take the state lock return.
632         if (!state_lock.trylock()) {
633                 return 1;
634         }
635         commit_should_unlock = true;
636         adjust_capture_position = 0;
637
638         if (nominally_recording || (_session.get_record_enabled() && _session.config.get_punch_in())) {
639                 OverlapType ot;
640
641                 ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
642
643                 switch (ot) {
644                         case OverlapNone:
645                                 rec_nframes = 0;
646                                 break;
647
648                         case OverlapInternal:
649                                 /*     ----------    recrange
650                                            |---|       transrange
651                                            */
652                                 rec_nframes = nframes;
653                                 rec_offset = 0;
654                                 break;
655
656                         case OverlapStart:
657                                 /*    |--------|    recrange
658                                           -----|          transrange
659                                           */
660                                 rec_nframes = transport_frame + nframes - first_recordable_frame;
661                                 if (rec_nframes) {
662                                         rec_offset = first_recordable_frame - transport_frame;
663                                 }
664                                 break;
665
666                         case OverlapEnd:
667                                 /*    |--------|    recrange
668                                           |--------  transrange
669                                           */
670                                 rec_nframes = last_recordable_frame - transport_frame;
671                                 rec_offset = 0;
672                                 break;
673
674                         case OverlapExternal:
675                                 /*    |--------|    recrange
676                                           --------------  transrange
677                                           */
678                                 rec_nframes = last_recordable_frame - last_recordable_frame;
679                                 rec_offset = first_recordable_frame - transport_frame;
680                                 break;
681                 }
682
683                 if (rec_nframes && !was_recording) {
684                         capture_captured = 0;
685                         was_recording = true;
686                 }
687         }
688
689
690         if (can_record && !_last_capture_regions.empty()) {
691                 _last_capture_regions.clear ();
692         }
693
694         if (nominally_recording || rec_nframes) {
695
696                 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
697                 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
698                 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
699                         const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
700                         assert(ev.buffer());
701                         _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
702
703                         /* put it in the playback buffer as well, so that we can monitor */
704
705                         _playback_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
706                 }
707         
708         } else {
709
710                 if (was_recording) {
711                         finish_capture (rec_monitors_input);
712                 }
713
714         }
715
716         if (rec_nframes) {
717
718                 /* data will be written to disk */
719
720                 if (rec_nframes == nframes && rec_offset == 0) {
721                         playback_distance = nframes;
722                 }
723
724                 adjust_capture_position = rec_nframes;
725
726         } else if (nominally_recording) {
727
728                 /* XXXX do this for MIDI !!!
729                    can't do actual capture yet - waiting for latency effects to finish before we start
730                 */
731
732                 playback_distance = nframes;
733
734         }
735
736         ret = 0;
737
738         _processed = true;
739
740         if (ret) {
741
742                 /* we're exiting with failure, so ::commit will not
743                    be called. unlock the state lock.
744                    */
745
746                 commit_should_unlock = false;
747                 state_lock.unlock();
748         } 
749
750         return ret;
751 }
752
753 bool
754 MidiDiskstream::commit (nframes_t nframes)
755 {
756         bool need_butler = false;
757
758         if (_actual_speed < 0.0) {
759                 playback_sample -= playback_distance;
760         } else {
761                 playback_sample += playback_distance;
762         }
763
764         if (adjust_capture_position != 0) {
765                 capture_captured += adjust_capture_position;
766                 adjust_capture_position = 0;
767         }
768
769         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
770         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
771         if ((frames_written - frames_read) + nframes < midi_readahead) {
772                 need_butler = true;
773         }
774
775         /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
776                 " = " << frames_written - frames_read
777                 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
778         
779         if (commit_should_unlock) {
780                 state_lock.unlock();
781         }
782
783         _processed = false;
784
785         return need_butler;
786 }
787
788 void
789 MidiDiskstream::set_pending_overwrite (bool yn)
790 {
791         /* called from audio thread, so we can use the read ptr and playback sample as we wish */
792         
793         pending_overwrite = yn;
794         
795         overwrite_frame = playback_sample;
796 }
797
798 int
799 MidiDiskstream::overwrite_existing_buffers ()
800 {
801         //read(overwrite_frame, disk_io_chunk_frames, false);
802         overwrite_queued = false;
803         pending_overwrite = false;
804
805         return 0;
806 }
807
808 int
809 MidiDiskstream::seek (nframes_t frame, bool complete_refill)
810 {
811         Glib::Mutex::Lock lm (state_lock);
812         int ret = -1;
813         
814         _playback_buf->reset();
815         _capture_buf->reset();
816         g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
817         g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
818
819         playback_sample = frame;
820         file_frame = frame;
821
822         if (complete_refill) {
823                 while ((ret = do_refill_with_alloc ()) > 0) ;
824         } else {
825                 ret = do_refill_with_alloc ();
826         }
827
828         return ret;
829 }
830
831 int
832 MidiDiskstream::can_internal_playback_seek (nframes_t distance)
833 {
834         uint32_t frames_read    = g_atomic_int_get(&_frames_read_from_ringbuffer);
835         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
836         return ((frames_written - frames_read) < distance);
837 }
838
839 int
840 MidiDiskstream::internal_playback_seek (nframes_t distance)
841 {
842         first_recordable_frame += distance;
843         playback_sample += distance;
844
845         return 0;
846 }
847
848 /** @a start is set to the new frame position (TIME) read up to */
849 int
850 MidiDiskstream::read (nframes_t& start, nframes_t dur, bool reversed)
851 {       
852         nframes_t this_read = 0;
853         bool reloop = false;
854         nframes_t loop_end = 0;
855         nframes_t loop_start = 0;
856         nframes_t loop_length = 0;
857         Location *loc = 0;
858
859         if (!reversed) {
860                 /* Make the use of a Location atomic for this read operation.
861                    
862                    Note: Locations don't get deleted, so all we care about
863                    when I say "atomic" is that we are always pointing to
864                    the same one and using a start/length values obtained
865                    just once.
866                 */
867                 
868                 if ((loc = loop_location) != 0) {
869                         loop_start = loc->start();
870                         loop_end = loc->end();
871                         loop_length = loop_end - loop_start;
872                 }
873                 
874                 /* if we are looping, ensure that the first frame we read is at the correct
875                    position within the loop.
876                 */
877                 
878                 if (loc && (start >= loop_end)) {
879                         //cerr << "start adjusted from " << start;
880                         start = loop_start + ((start - loop_start) % loop_length);
881                         //cerr << "to " << start << endl;
882                 }
883                 //cerr << "start is " << start << "  loopstart: " << loop_start << "  loopend: " << loop_end << endl;
884         }
885
886         while (dur) {
887
888                 /* take any loop into account. we can't read past the end of the loop. */
889
890                 if (loc && (loop_end - start < dur)) {
891                         this_read = loop_end - start;
892                         //cerr << "reloop true: thisread: " << this_read << "  dur: " << dur << endl;
893                         reloop = true;
894                 } else {
895                         reloop = false;
896                         this_read = dur;
897                 }
898
899                 if (this_read == 0) {
900                         break;
901                 }
902
903                 this_read = min(dur,this_read);
904
905                 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
906                         error << string_compose(
907                                         _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
908                                         _id, this_read, start) << endmsg;
909                         return -1;
910                 }
911
912                 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
913
914                 _read_data_count = _playlist->read_data_count();
915                 
916                 if (reversed) {
917
918                         // Swap note ons with note offs here.  etc?
919                         // Fully reversing MIDI requires look-ahead (well, behind) to find previous
920                         // CC values etc.  hard.
921
922                 } else {
923                         
924                         /* if we read to the end of the loop, go back to the beginning */
925                         
926                         if (reloop) {
927                                 // Synthesize LoopEvent here, because the next events
928                                 // written will have non-monotonic timestamps.
929                                 _playback_buf->write(loop_end - 1, LoopEventType, 0, 0);
930                                 cout << "Pushing LoopEvent ts=" << loop_end-1 
931                                      << " start+this_read " << start+this_read << endl;
932
933                                 start = loop_start;
934                         } else {
935                                 start += this_read;
936                         }
937                 } 
938
939                 dur -= this_read;
940                 //offset += this_read;
941         }
942
943         return 0;
944 }
945
946 int
947 MidiDiskstream::do_refill_with_alloc ()
948 {
949         return do_refill();
950 }
951
952 int
953 MidiDiskstream::do_refill ()
954 {
955         int     ret         = 0;
956         size_t  write_space = _playback_buf->write_space();
957         bool    reversed    = (_visible_speed * _session.transport_speed()) < 0.0f;
958
959         if (write_space == 0) {
960                 return 0;
961         }
962         
963         if (reversed) {
964                 return 0;
965         }
966
967         /* at end: nothing to do */
968         if (file_frame == max_frames) {
969                 return 0;
970         }
971
972         // At this point we...
973         assert(_playback_buf->write_space() > 0); // ... have something to write to, and
974         assert(file_frame <= max_frames); // ... something to write
975
976         // now calculate how much time is in the ringbuffer.
977         // and lets write as much as we need to get this to be midi_readahead;
978         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
979         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
980         if ((frames_written - frames_read) >= midi_readahead) {
981                 //cout << "MDS Nothing to do. all fine" << endl;
982                 return 0;
983         }
984
985         nframes_t to_read = midi_readahead - (frames_written - frames_read);
986
987         //cout << "MDS read for midi_readahead " << to_read << "  rb_contains: "
988         //      << frames_written - frames_read << endl;
989
990         to_read = min(to_read, (max_frames - file_frame));
991         
992         if (read (file_frame, to_read, reversed)) {
993                 ret = -1;
994         }
995                 
996         return ret;
997 }
998
999 /** Flush pending data to disk.
1000  *
1001  * Important note: this function will write *AT MOST* disk_io_chunk_frames
1002  * of data to disk. it will never write more than that.  If it writes that
1003  * much and there is more than that waiting to be written, it will return 1,
1004  * otherwise 0 on success or -1 on failure.
1005  * 
1006  * If there is less than disk_io_chunk_frames to be written, no data will be
1007  * written at all unless @a force_flush is true.
1008  */
1009 int
1010 MidiDiskstream::do_flush (RunContext /*context*/, bool force_flush)
1011 {
1012         uint32_t to_write;
1013         int32_t ret = 0;
1014         nframes_t total;
1015
1016         _write_data_count = 0;
1017
1018         total = _session.transport_frame() - _last_flush_frame;
1019         
1020         if (_last_flush_frame > _session.transport_frame()
1021                         || _last_flush_frame < capture_start_frame) {
1022                 _last_flush_frame = _session.transport_frame();
1023         }
1024
1025         if (total == 0 || _capture_buf->read_space() == 0
1026                         || (!force_flush && (total < disk_io_chunk_frames && was_recording))) {
1027                 goto out;
1028         }
1029
1030         /* if there are 2+ chunks of disk i/o possible for
1031            this track, let the caller know so that it can arrange
1032            for us to be called again, ASAP.
1033
1034            if we are forcing a flush, then if there is* any* extra
1035            work, let the caller know.
1036
1037            if we are no longer recording and there is any extra work,
1038            let the caller know too.
1039            */
1040
1041         if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
1042                 ret = 1;
1043         } 
1044
1045         to_write = disk_io_chunk_frames;
1046
1047         assert(!destructive());
1048
1049         if (record_enabled()
1050                         && (   (_session.transport_frame() - _last_flush_frame > disk_io_chunk_frames)
1051                                 || force_flush)) {
1052                 if ((!_write_source) || _write_source->midi_write (*_capture_buf, capture_start_frame, to_write) != to_write) {
1053                         error << string_compose(_("MidiDiskstream %1: cannot write to disk"), _id) << endmsg;
1054                         return -1;
1055                 } else {
1056                         _last_flush_frame = _session.transport_frame();
1057                 }
1058         }
1059
1060 out:
1061         return ret;
1062 }
1063
1064 void
1065 MidiDiskstream::transport_stopped (struct tm& /*when*/, time_t /*twhen*/, bool abort_capture)
1066 {
1067         uint32_t buffer_position;
1068         bool more_work = true;
1069         int err = 0;
1070         boost::shared_ptr<MidiRegion> region;
1071         nframes_t total_capture;
1072         MidiRegion::SourceList srcs;
1073         MidiRegion::SourceList::iterator src;
1074         vector<CaptureInfo*>::iterator ci;
1075         bool mark_write_completed = false;
1076
1077         finish_capture (true);
1078
1079         /* butler is already stopped, but there may be work to do 
1080            to flush remaining data to disk.
1081            */
1082
1083         while (more_work && !err) {
1084                 switch (do_flush (TransportContext, true)) {
1085                         case 0:
1086                                 more_work = false;
1087                                 break;
1088                         case 1:
1089                                 break;
1090                         case -1:
1091                                 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
1092                                 err++;
1093                 }
1094         }
1095
1096         /* XXX is there anything we can do if err != 0 ? */
1097         Glib::Mutex::Lock lm (capture_info_lock);
1098
1099         if (capture_info.empty()) {
1100                 return;
1101         }
1102
1103         if (abort_capture) {
1104
1105                 if (_write_source) {
1106
1107                         _write_source->mark_for_remove ();
1108                         _write_source->drop_references ();
1109                         _write_source.reset();
1110                 }
1111
1112                 /* new source set up in "out" below */
1113
1114         } else {
1115
1116                 assert(_write_source);
1117
1118                 for (total_capture = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1119                         total_capture += (*ci)->frames;
1120                 }
1121
1122                 /* figure out the name for this take */
1123         
1124                 srcs.push_back (_write_source);
1125                 _write_source->set_timeline_position (capture_info.front()->start);
1126                 _write_source->set_captured_for (_name);
1127
1128                 string whole_file_region_name;
1129                 whole_file_region_name = region_name_from_path (_write_source->name(), true);
1130
1131                 /* Register a new region with the Session that
1132                    describes the entire source. Do this first
1133                    so that any sub-regions will obviously be
1134                    children of this one (later!)
1135                    */
1136
1137                 try {
1138                         boost::shared_ptr<Region> rx (RegionFactory::create (srcs, 0,
1139                                         total_capture, whole_file_region_name, 0,
1140                                         Region::Flag (Region::DefaultFlags|Region::Automatic|Region::WholeFile)));
1141
1142                         region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1143                         region->special_set_position (capture_info.front()->start);
1144                 }
1145
1146
1147                 catch (failed_constructor& err) {
1148                         error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
1149                         /* XXX what now? */
1150                 }
1151
1152                 _last_capture_regions.push_back (region);
1153
1154                 // cerr << _name << ": there are " << capture_info.size() << " capture_info records\n";
1155
1156                 XMLNode &before = _playlist->get_state();
1157                 _playlist->freeze ();
1158
1159                 for (buffer_position = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1160
1161                         string region_name;
1162
1163                         _session.region_name (region_name, _write_source->name(), false);
1164
1165                         // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
1166
1167                         try {
1168                                 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, buffer_position, (*ci)->frames, region_name));
1169                                 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1170                         }
1171
1172                         catch (failed_constructor& err) {
1173                                 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1174                                 continue; /* XXX is this OK? */
1175                         }
1176                         
1177                         region->GoingAway.connect (bind (mem_fun (*this, &Diskstream::remove_region_from_last_capture), boost::weak_ptr<Region>(region)));
1178
1179                         _last_capture_regions.push_back (region);
1180
1181                         // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1182
1183                         i_am_the_modifier++;
1184                         _playlist->add_region (region, (*ci)->start);
1185                         i_am_the_modifier--;
1186
1187                         buffer_position += (*ci)->frames;
1188                 }
1189
1190                 _playlist->thaw ();
1191                 XMLNode &after = _playlist->get_state();
1192                 _session.add_command (new MementoCommand<Playlist>(*_playlist, &before, &after));
1193
1194         }
1195
1196         mark_write_completed = true;
1197
1198         reset_write_sources (mark_write_completed);
1199
1200         for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1201                 delete *ci;
1202         }
1203
1204         capture_info.clear ();
1205         capture_start_frame = 0;
1206 }
1207
1208 void
1209 MidiDiskstream::transport_looped (nframes_t transport_frame)
1210 {
1211         if (was_recording) {
1212
1213                 // adjust the capture length knowing that the data will be recorded to disk
1214                 // only necessary after the first loop where we're recording
1215                 if (capture_info.size() == 0) {
1216                         capture_captured += _capture_offset;
1217
1218                         if (_alignment_style == ExistingMaterial) {
1219                                 capture_captured += _session.worst_output_latency();
1220                         } else {
1221                                 capture_captured += _roll_delay;
1222                         }
1223                 }
1224
1225                 finish_capture (true);
1226
1227                 // the next region will start recording via the normal mechanism
1228                 // we'll set the start position to the current transport pos
1229                 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1230                 capture_start_frame = transport_frame;
1231                 first_recordable_frame = transport_frame; // mild lie
1232                 last_recordable_frame = max_frames;
1233                 was_recording = true;
1234         }
1235 }
1236
1237 void
1238 MidiDiskstream::finish_capture (bool /*rec_monitors_input*/)
1239 {
1240         was_recording = false;
1241         
1242         if (capture_captured == 0) {
1243                 return;
1244         }
1245
1246         // Why must we destroy?
1247         assert(!destructive());
1248
1249         CaptureInfo* ci = new CaptureInfo;
1250         
1251         ci->start  = capture_start_frame;
1252         ci->frames = capture_captured;
1253         
1254         /* XXX theoretical race condition here. Need atomic exchange ? 
1255            However, the circumstances when this is called right 
1256            now (either on record-disable or transport_stopped)
1257            mean that no actual race exists. I think ...
1258            We now have a capture_info_lock, but it is only to be used
1259            to synchronize in the transport_stop and the capture info
1260            accessors, so that invalidation will not occur (both non-realtime).
1261         */
1262
1263         // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1264
1265         capture_info.push_back (ci);
1266         capture_captured = 0;
1267 }
1268
1269 void
1270 MidiDiskstream::set_record_enabled (bool yn)
1271 {
1272         if (!recordable() || !_session.record_enabling_legal()) {
1273                 return;
1274         }
1275
1276         assert(!destructive());
1277         
1278         if (yn && _source_port == 0) {
1279
1280                 /* pick up connections not initiated *from* the IO object
1281                    we're associated with.
1282                 */
1283
1284                 get_input_sources ();
1285         }
1286
1287         /* yes, i know that this not proof against race conditions, but its
1288            good enough. i think.
1289         */
1290
1291         if (record_enabled() != yn) {
1292                 if (yn) {
1293                         engage_record_enable ();
1294                 } else {
1295                         disengage_record_enable ();
1296                 }
1297         }
1298 }
1299
1300 void
1301 MidiDiskstream::engage_record_enable ()
1302 {
1303     bool rolling = _session.transport_speed() != 0.0f;
1304
1305         g_atomic_int_set (&_record_enabled, 1);
1306         
1307         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1308                 _source_port->request_monitor_input (!(_session.config.get_auto_input() && rolling));
1309         }
1310
1311         // FIXME: Why is this necessary?  Isn't needed for AudioDiskstream...
1312         if (!_write_source)
1313                 use_new_write_source();
1314
1315         _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1316
1317         RecordEnableChanged (); /* EMIT SIGNAL */
1318 }
1319
1320 void
1321 MidiDiskstream::disengage_record_enable ()
1322 {
1323         g_atomic_int_set (&_record_enabled, 0);
1324         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1325                 if (_source_port) {
1326                         _source_port->request_monitor_input (false);
1327                 }
1328         }
1329
1330         RecordEnableChanged (); /* EMIT SIGNAL */
1331 }
1332
1333 XMLNode&
1334 MidiDiskstream::get_state ()
1335 {
1336         XMLNode* node = new XMLNode ("MidiDiskstream");
1337         char buf[64];
1338         LocaleGuard lg (X_("POSIX"));
1339
1340         snprintf (buf, sizeof(buf), "0x%x", _flags);
1341         node->add_property ("flags", buf);
1342
1343         node->add_property("channel-mode", enum_2_string(get_channel_mode()));
1344         
1345         snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1346         node->add_property("channel-mask", buf);
1347         
1348         node->add_property ("playlist", _playlist->name());
1349         
1350         snprintf (buf, sizeof(buf), "%f", _visible_speed);
1351         node->add_property ("speed", buf);
1352
1353         node->add_property("name", _name);
1354         id().print(buf, sizeof(buf));
1355         node->add_property("id", buf);
1356
1357         if (_write_source && _session.get_record_enabled()) {
1358
1359                 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1360                 XMLNode* cs_grandchild;
1361
1362                 cs_grandchild = new XMLNode (X_("file"));
1363                 cs_grandchild->add_property (X_("path"), _write_source->path());
1364                 cs_child->add_child_nocopy (*cs_grandchild);
1365
1366                 /* store the location where capture will start */
1367
1368                 Location* pi;
1369
1370                 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1371                         snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1372                 } else {
1373                         snprintf (buf, sizeof (buf), "%" PRIu32, _session.transport_frame());
1374                 }
1375
1376                 cs_child->add_property (X_("at"), buf);
1377                 node->add_child_nocopy (*cs_child);
1378         }
1379
1380         if (_extra_xml) {
1381                 node->add_child_copy (*_extra_xml);
1382         }
1383
1384         return* node;
1385 }
1386
1387 int
1388 MidiDiskstream::set_state (const XMLNode& node)
1389 {
1390         const XMLProperty* prop;
1391         XMLNodeList nlist = node.children();
1392         XMLNodeIterator niter;
1393         uint32_t nchans = 1;
1394         XMLNode* capture_pending_node = 0;
1395         LocaleGuard lg (X_("POSIX"));
1396
1397         in_set_state = true;
1398
1399         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1400                 /*if ((*niter)->name() == IO::state_node_name) {
1401                         deprecated_io_node = new XMLNode (**niter);
1402                 }*/
1403                 assert ((*niter)->name() != IO::state_node_name);
1404
1405                 if ((*niter)->name() == X_("CapturingSources")) {
1406                         capture_pending_node = *niter;
1407                 }
1408         }
1409
1410         /* prevent write sources from being created */
1411         
1412         in_set_state = true;
1413         
1414         if ((prop = node.property ("name")) != 0) {
1415                 _name = prop->value();
1416         } 
1417
1418         if ((prop = node.property ("id")) != 0) {
1419                 _id = prop->value ();
1420         }
1421
1422         if ((prop = node.property ("flags")) != 0) {
1423                 _flags = Flag (string_2_enum (prop->value(), _flags));
1424         }
1425
1426         ChannelMode channel_mode = AllChannels;
1427         if ((prop = node.property ("channel-mode")) != 0) {
1428                 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1429         }
1430         
1431         unsigned int channel_mask = 0xFFFF;
1432         if ((prop = node.property ("channel-mask")) != 0) {
1433                 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1434                 if (channel_mask & (~0xFFFF)) {
1435                         warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1436                 }
1437         }
1438
1439         set_channel_mode(channel_mode, channel_mask);
1440         
1441         if ((prop = node.property ("channels")) != 0) {
1442                 nchans = atoi (prop->value().c_str());
1443         }
1444         
1445         if ((prop = node.property ("playlist")) == 0) {
1446                 return -1;
1447         }
1448
1449         {
1450                 bool had_playlist = (_playlist != 0);
1451         
1452                 if (find_and_use_playlist (prop->value())) {
1453                         return -1;
1454                 }
1455
1456                 if (!had_playlist) {
1457                         _playlist->set_orig_diskstream_id (_id);
1458                 }
1459                 
1460                 if (capture_pending_node) {
1461                         use_pending_capture_data (*capture_pending_node);
1462                 }
1463
1464         }
1465
1466         if ((prop = node.property ("speed")) != 0) {
1467                 double sp = atof (prop->value().c_str());
1468
1469                 if (realtime_set_speed (sp, false)) {
1470                         non_realtime_set_speed ();
1471                 }
1472         }
1473
1474         in_set_state = false;
1475
1476         /* make sure this is clear before we do anything else */
1477
1478         // FIXME?
1479         //_capturing_source = 0;
1480
1481         /* write sources are handled when we handle the input set 
1482            up of the IO that owns this DS (::non_realtime_input_change())
1483         */
1484                 
1485         in_set_state = false;
1486
1487         return 0;
1488 }
1489
1490 int
1491 MidiDiskstream::use_new_write_source (uint32_t n)
1492 {
1493         if (!recordable()) {
1494                 return 1;
1495         }
1496
1497         assert(n == 0);
1498
1499         if (_write_source) {
1500
1501                 if (_write_source->is_empty ()) {
1502                         _write_source->mark_for_remove ();
1503                         _write_source.reset();
1504                 } else {
1505                         _write_source.reset();
1506                 }
1507         }
1508
1509         try {
1510                 _write_source = boost::dynamic_pointer_cast<SMFSource>(_session.create_midi_source_for_session (*this));
1511                 if (!_write_source) {
1512                         throw failed_constructor();
1513                 }
1514         } 
1515
1516         catch (failed_constructor &err) {
1517                 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1518                 _write_source.reset();
1519                 return -1;
1520         }
1521
1522         _write_source->set_allow_remove_if_empty (true);
1523
1524         return 0;
1525 }
1526
1527 void
1528 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
1529 {
1530         if (!recordable()) {
1531                 return;
1532         }
1533
1534         if (_write_source && mark_write_complete) {
1535                 _write_source->mark_streaming_write_completed ();
1536         }
1537
1538         use_new_write_source (0);
1539                         
1540         if (record_enabled()) {
1541                 //_capturing_sources.push_back (_write_source);
1542         }
1543 }
1544
1545 int
1546 MidiDiskstream::rename_write_sources ()
1547 {
1548         if (_write_source != 0) {
1549                 _write_source->set_source_name (_name, destructive());
1550                 /* XXX what to do if this fails ? */
1551         }
1552         return 0;
1553 }
1554
1555 void
1556 MidiDiskstream::set_block_size (nframes_t /*nframes*/)
1557 {
1558 }
1559
1560 void
1561 MidiDiskstream::allocate_temporary_buffers ()
1562 {
1563 }
1564
1565 void
1566 MidiDiskstream::monitor_input (bool yn)
1567 {
1568         if (_source_port)
1569                 _source_port->ensure_monitor_input (yn);
1570 }
1571
1572 void
1573 MidiDiskstream::set_align_style_from_io ()
1574 {
1575         bool have_physical = false;
1576
1577         if (_io == 0) {
1578                 return;
1579         }
1580
1581         get_input_sources ();
1582         
1583         if (_source_port && _source_port->flags() & JackPortIsPhysical) {
1584                 have_physical = true;
1585         }
1586
1587         if (have_physical) {
1588                 set_align_style (ExistingMaterial);
1589         } else {
1590                 set_align_style (CaptureTime);
1591         }
1592 }
1593
1594
1595 float
1596 MidiDiskstream::playback_buffer_load () const
1597 {
1598         return (float) ((double) _playback_buf->read_space()/
1599                         (double) _playback_buf->capacity());
1600 }
1601
1602 float
1603 MidiDiskstream::capture_buffer_load () const
1604 {
1605         return (float) ((double) _capture_buf->write_space()/
1606                         (double) _capture_buf->capacity());
1607 }
1608
1609 int
1610 MidiDiskstream::use_pending_capture_data (XMLNode& /*node*/)
1611 {
1612         return 0;
1613 }
1614
1615 /** Writes playback events in the given range to \a dst, translating time stamps
1616  * so that an event at \a start has time = 0
1617  */
1618 void
1619 MidiDiskstream::get_playback (MidiBuffer& dst, nframes_t start, nframes_t end)
1620 {
1621         dst.clear();
1622         assert(dst.size() == 0);
1623         
1624         // Reverse.  ... We just don't do reverse, ok?  Back off.
1625         if (end <= start) {
1626                 return;
1627         }
1628
1629         // Translates stamps to be relative to start
1630
1631         _playback_buf->read(dst, start, end);
1632
1633 #if 0
1634         const size_t events_read = _playback_buf->read(dst, start, end);
1635         cout << _name << ": MDS events read = " << events_read
1636              << " start = " << start << " end = " << end
1637              << " readspace " << _playback_buf->read_space()
1638              << " writespace " << _playback_buf->write_space() << endl;
1639 #endif
1640         
1641         gint32 frames_read = end - start;
1642         g_atomic_int_add(&_frames_read_from_ringbuffer, frames_read);
1643 }
1644