Fix time skew after MIDI recording (added missing conversion from delta time to audio...
[ardour.git] / libs / ardour / smf_source.cc
1 /*
2     Copyright (C) 2006 Paul Davis 
3         Written by Dave Robillard, 2006
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 */
20
21 #include <vector>
22
23 #include <sys/time.h>
24 #include <sys/stat.h>
25 #include <unistd.h>
26 #include <errno.h>
27
28 #include <pbd/mountpoint.h>
29 #include <pbd/pathscanner.h>
30 #include <pbd/stl_delete.h>
31 #include <pbd/strsplit.h>
32
33 #include <glibmm/miscutils.h>
34
35 #include <ardour/smf_source.h>
36 #include <ardour/session.h>
37 #include <ardour/midi_ring_buffer.h>
38 #include <ardour/midi_util.h>
39 #include <ardour/tempo.h>
40 #include <ardour/audioengine.h>
41
42 #include "i18n.h"
43
44 using namespace ARDOUR;
45
46 string SMFSource::_search_path;
47
48 /*sigc::signal<void,struct tm*, time_t> SMFSource::HeaderPositionOffsetChanged;
49 bool                                  SMFSource::header_position_negative;
50 uint64_t                              SMFSource::header_position_offset;
51 */
52
53 SMFSource::SMFSource (Session& s, std::string path, Flag flags)
54         : MidiSource (s, region_name_from_path(path, false))
55         , _channel(0)
56         , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
57         , _allow_remove_if_empty(true)
58         , _timeline_position (0)
59         , _fd (0)
60         , _last_ev_time(0)
61         , _track_size(4) // 4 bytes for the ever-present EOT event
62         , _header_size(22)
63 {
64         /* constructor used for new internal-to-session files. file cannot exist */
65
66         if (init (path, false)) {
67                 throw failed_constructor ();
68         }
69         
70         if (open()) {
71                 throw failed_constructor ();
72         }
73         
74         assert(_name.find("/") == string::npos);
75 }
76
77 SMFSource::SMFSource (Session& s, const XMLNode& node)
78         : MidiSource (s, node)
79         , _channel(0)
80         , _flags (Flag (Writable|CanRename))
81         , _allow_remove_if_empty(true)
82         , _timeline_position (0)
83         , _fd (0)
84         , _last_ev_time(0)
85         , _track_size(4) // 4 bytes for the ever-present EOT event
86         , _header_size(22)
87 {
88         /* constructor used for existing internal-to-session files. file must exist */
89
90         if (set_state (node)) {
91                 throw failed_constructor ();
92         }
93         
94         if (init (_name, true)) {
95                 throw failed_constructor ();
96         }
97         
98         if (open()) {
99                 throw failed_constructor ();
100         }
101         
102         assert(_name.find("/") == string::npos);
103 }
104
105 SMFSource::~SMFSource ()
106 {
107         if (removable()) {
108                 unlink (_path.c_str());
109         }
110 }
111
112 bool
113 SMFSource::removable () const
114 {
115         return (_flags & Removable) && ((_flags & RemoveAtDestroy) || 
116                                       ((_flags & RemovableIfEmpty) && is_empty (_path)));
117 }
118
119 int
120 SMFSource::init (string pathstr, bool must_exist)
121 {
122         bool is_new = false;
123
124         if (!find (pathstr, must_exist, is_new)) {
125                 cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
126                 return -1;
127         }
128
129         if (is_new && must_exist) {
130                 return -1;
131         }
132
133         assert(_name.find("/") == string::npos);
134         return 0;
135 }
136
137 int
138 SMFSource::open()
139 {
140         cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
141
142         assert(writable()); // FIXME;
143
144         _fd = fopen(path().c_str(), "r+");
145
146         // File already exists
147         if (_fd) {
148                 fseek(_fd, _header_size - 4, 0);
149                 uint32_t track_size_be = 0;
150                 fread(&track_size_be, 4, 1, _fd);
151                 _track_size = GUINT32_FROM_BE(track_size_be);
152                 cerr << "SMF - read track size " << _track_size << endl;
153
154         // We're making a new file
155         } else {
156                 _fd = fopen(path().c_str(), "w+");
157                 _track_size = 0;
158
159                 // write a tentative header just to pad things out so writing happens in the right spot
160                 flush_header();
161                 // FIXME: write the footer here too so it's a valid SMF (screw up writing ATM though)
162         }
163
164         return (_fd == 0) ? -1 : 0;
165 }
166
167 int
168 SMFSource::update_header (nframes_t when, struct tm&, time_t)
169 {
170         _timeline_position = when;
171         return flush_header();
172 }
173
174 int
175 SMFSource::flush_header ()
176 {
177         // FIXME: write timeline position somehow?
178         
179         cerr << "SMF Flushing header\n";
180
181         assert(_fd);
182
183         const uint16_t type     = GUINT16_TO_BE(0);     // SMF Type 0 (single track)
184         const uint16_t ntracks  = GUINT16_TO_BE(1);     // Number of tracks (always 1 for Type 0)
185         const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per beat
186
187         char data[6];
188         memcpy(data, &type, 2);
189         memcpy(data+2, &ntracks, 2);
190         memcpy(data+4, &division, 2);
191
192         _fd = freopen(path().c_str(), "r+", _fd);
193         assert(_fd);
194         fseek(_fd, 0, 0);
195         write_chunk("MThd", 6, data);
196         //if (_track_size > 0) {
197                 write_chunk_header("MTrk", _track_size); 
198         //}
199
200         fflush(_fd);
201
202         return 0;
203 }
204
205 int
206 SMFSource::flush_footer()
207 {
208         cerr << "SMF - Writing EOT\n";
209
210         fseek(_fd, 0, SEEK_END);
211         write_var_len(1); // whatever...
212         char eot[4] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
213         fwrite(eot, 1, 4, _fd);
214         fflush(_fd);
215         return 0;
216 }
217
218 /** Returns the offset of the first event in the file with a time past @a start,
219  * relative to the start of the source.
220  *
221  * Returns -1 if not found.
222  */
223 /*
224 long
225 SMFSource::find_first_event_after(nframes_t start)
226 {
227         // FIXME: obviously this is slooow
228         
229         fseek(_fd, _header_size, 0);
230
231         while ( ! feof(_fd) ) {
232                 const uint32_t delta_time = read_var_len();
233
234                 if (delta_time > start)
235                         return delta_time;
236         }
237
238         return -1;
239 }
240 */
241
242 /** Read an event from the current position in file.
243  *
244  * File position MUST be at the beginning of a delta time, or this will die very messily.
245  * ev.buffer must be of size ev.size, and large enough for the event.  The returned event
246  * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
247  * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
248  *
249  * Returns event length (including status byte) on success, 0 if event was
250  * skipped (eg a meta event), or -1 on EOF (or end of track).
251  */
252 int
253 SMFSource::read_event(MidiEvent& ev) const
254 {
255         // - 4 is for the EOT event, which we don't actually want to read
256         //if (feof(_fd) || ftell(_fd) >= _header_size + _track_size - 4) {
257         if (feof(_fd)) {
258                 return -1;
259         }
260
261         uint32_t delta_time = read_var_len();
262         assert(!feof(_fd));
263         int status = fgetc(_fd);
264         assert(status != EOF); // FIXME die gracefully
265         if (status == 0xFF) {
266                 assert(!feof(_fd));
267                 int type = fgetc(_fd);
268                 if ((unsigned char)type == 0x2F) {
269                         //cerr << "SMF - hit EOT" << endl;
270                         return -1; // we hit the logical EOF anyway...
271                 } else {
272                         ev.size = 0;
273                         ev.time = delta_time; // this is needed regardless
274                         return 0;
275                 }
276         }
277         
278         ev.time = delta_time;
279         ev.size = midi_event_size((unsigned char)status) + 1;
280
281         if (ev.buffer == NULL)
282                 ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);
283
284         ev.buffer[0] = (unsigned char)status;
285         fread(ev.buffer+1, 1, ev.size - 1, _fd);
286
287         /*printf("SMF - read event, delta = %u, size = %zu, data = ",
288                 delta_time, ev.size);
289         for (size_t i=0; i < ev.size; ++i) {
290                 printf("%X ", ev.buffer[i]);
291         }
292         printf("\n");*/
293         
294         return ev.size;
295 }
296
297 /** All stamps in audio frames */
298 nframes_t
299 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
300 {
301         //cerr << "SMF - read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
302
303         // 64 bits ought to be enough for anybody
304         uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
305
306         _read_data_count = 0;
307
308         // FIXME: ugh
309         unsigned char ev_buf[MidiBuffer::max_event_size()];
310         MidiEvent ev;
311         ev.time = 0;
312         ev.size = MidiBuffer::max_event_size();
313         ev.buffer = ev_buf;
314
315         // FIXME: it would be an impressive feat to actually make this any slower :)
316         
317         fseek(_fd, _header_size, 0);
318         
319         // FIXME: assumes tempo never changes after start
320         const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
321                         _session.engine().frame_rate());
322         
323         uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
324
325         while (!feof(_fd)) {
326                 int ret = read_event(ev);
327                 if (ret == -1) { // EOF
328                         //cerr << "SMF - EOF\n";
329                         break;
330                 }
331
332                 if (ret == 0) { // meta-event (skipped)
333                         //cerr << "SMF - META\n";
334                         time += ev.time; // just accumulate delta time and ignore event
335                         continue;
336                 }
337
338                 time += ev.time; // accumulate delta time
339                 ev.time = time; // set ev.time to actual time (relative to source start)
340
341                 if (ev.time >= start_ticks) {
342                         if (ev.time < start_ticks + (cnt / frames_per_beat)) {
343                                 break;
344                         } else {
345                                 ev.time = (nframes_t)(((ev.time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
346                                 // write event time in absolute frames
347                                 dst.write(ev.time, ev.size, ev.buffer);
348                         }
349                 }
350
351                 _read_data_count += ev.size;
352         }
353         
354         return cnt;
355 }
356
357 /** All stamps in audio frames */
358 nframes_t
359 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
360 {
361         _write_data_count = 0;
362
363         boost::shared_ptr<MidiBuffer> buf_ptr(new MidiBuffer(1024)); // FIXME: size?
364         MidiBuffer& buf = *buf_ptr.get();
365         src.read(buf, /*_length*/0, _length + cnt); // FIXME?
366
367         fseek(_fd, 0, SEEK_END);
368
369         // FIXME: assumes tempo never changes after start
370         const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
371                         _session.engine().frame_rate());
372         
373         for (size_t i=0; i < buf.size(); ++i) {
374                 MidiEvent& ev = buf[i];
375                 assert(ev.time >= _timeline_position);
376                 ev.time -= _timeline_position;
377                 assert(ev.time >= _last_ev_time);
378                 const uint32_t delta_time = (uint32_t)((ev.time - _last_ev_time) / frames_per_beat * _ppqn);
379                 
380                 /*printf("SMF - writing event, delta = %u, size = %zu, data = ",
381                         delta_time, ev.size);
382                 for (size_t i=0; i < ev.size; ++i) {
383                         printf("%X ", ev.buffer[i]);
384                 }
385                 printf("\n");
386                 */
387                 size_t stamp_size = write_var_len(delta_time);
388                 fwrite(ev.buffer, 1, ev.size, _fd);
389
390                 _track_size += stamp_size + ev.size;
391                 _write_data_count += ev.size;
392                 
393                 _last_ev_time = ev.time;
394         }
395
396         fflush(_fd);
397
398         const nframes_t oldlen = _length;
399         update_length(oldlen, cnt);
400
401         _model->append(buf);
402
403         ViewDataRangeReady (buf_ptr, oldlen, cnt); /* EMIT SIGNAL */
404         
405         return cnt;
406 }
407
408 XMLNode&
409 SMFSource::get_state ()
410 {
411         XMLNode& root (MidiSource::get_state());
412         char buf[16];
413         snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
414         root.add_property ("flags", buf);
415         return root;
416 }
417
418 int
419 SMFSource::set_state (const XMLNode& node)
420 {
421         const XMLProperty* prop;
422
423         if (MidiSource::set_state (node)) {
424                 return -1;
425         }
426
427         if ((prop = node.property (X_("flags"))) != 0) {
428
429                 int ival;
430                 sscanf (prop->value().c_str(), "0x%x", &ival);
431                 _flags = Flag (ival);
432
433         } else {
434
435                 _flags = Flag (0);
436
437         }
438
439         assert(_name.find("/") == string::npos);
440
441         return 0;
442 }
443
444 void
445 SMFSource::mark_for_remove ()
446 {
447         if (!writable()) {
448                 return;
449         }
450         _flags = Flag (_flags | RemoveAtDestroy);
451 }
452
453 void
454 SMFSource::mark_streaming_write_completed ()
455 {
456         if (!writable()) {
457                 return;
458         }
459         
460         flush_footer();
461
462 #if 0
463         Glib::Mutex::Lock lm (_lock);
464
465
466         next_peak_clear_should_notify = true;
467
468         if (_peaks_built || pending_peak_builds.empty()) {
469                 _peaks_built = true;
470                  PeaksReady (); /* EMIT SIGNAL */
471         }
472 #endif
473 }
474
475 void
476 SMFSource::mark_take (string id)
477 {
478         if (writable()) {
479                 _take_id = id;
480         }
481 }
482
483 int
484 SMFSource::move_to_trash (const string trash_dir_name)
485 {
486         string newpath;
487
488         if (!writable()) {
489                 return -1;
490         }
491
492         /* don't move the file across filesystems, just
493            stick it in the 'trash_dir_name' directory
494            on whichever filesystem it was already on.
495         */
496
497         newpath = Glib::path_get_dirname (_path);
498         newpath = Glib::path_get_dirname (newpath);
499
500         newpath += '/';
501         newpath += trash_dir_name;
502         newpath += '/';
503         newpath += Glib::path_get_basename (_path);
504
505         if (access (newpath.c_str(), F_OK) == 0) {
506
507                 /* the new path already exists, try versioning */
508                 
509                 char buf[PATH_MAX+1];
510                 int version = 1;
511                 string newpath_v;
512
513                 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
514                 newpath_v = buf;
515
516                 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
517                         snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
518                         newpath_v = buf;
519                 }
520                 
521                 if (version == 999) {
522                         PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
523                                           newpath)
524                               << endmsg;
525                 } else {
526                         newpath = newpath_v;
527                 }
528
529         } else {
530
531                 /* it doesn't exist, or we can't read it or something */
532
533         }
534
535         if (::rename (_path.c_str(), newpath.c_str()) != 0) {
536                 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
537                                   _path, newpath, strerror (errno))
538                       << endmsg;
539                 return -1;
540         }
541 #if 0
542         if (::unlink (peakpath.c_str()) != 0) {
543                 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
544                                   peakpath, _path, strerror (errno))
545                       << endmsg;
546                 /* try to back out */
547                 rename (newpath.c_str(), _path.c_str());
548                 return -1;
549         }
550             
551         _path = newpath;
552         peakpath = "";
553 #endif  
554         /* file can not be removed twice, since the operation is not idempotent */
555
556         _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
557
558         return 0;
559 }
560
561 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
562 bool
563 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
564 {
565         string::size_type pos;
566         bool ret = false;
567
568         isnew = false;
569
570         /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
571
572         if ((pos = pathstr.find_last_of (':')) == string::npos) {
573                 pathstr = pathstr;
574         } else {
575                 pathstr = pathstr.substr (0, pos);
576         }
577
578         if (pathstr[0] != '/') {
579
580                 /* non-absolute pathname: find pathstr in search path */
581
582                 vector<string> dirs;
583                 int cnt;
584                 string fullpath;
585                 string keeppath;
586
587                 if (_search_path.length() == 0) {
588                         PBD::error << _("FileSource: search path not set") << endmsg;
589                         goto out;
590                 }
591
592                 split (_search_path, dirs, ':');
593
594                 cnt = 0;
595                 
596                 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
597
598                         fullpath = *i;
599                         if (fullpath[fullpath.length()-1] != '/') {
600                                 fullpath += '/';
601                         }
602                         fullpath += pathstr;
603                         
604                         if (access (fullpath.c_str(), R_OK) == 0) {
605                                 keeppath = fullpath;
606                                 ++cnt;
607                         } 
608                 }
609
610                 if (cnt > 1) {
611
612                         PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
613                         goto out;
614
615                 } else if (cnt == 0) {
616
617                         if (must_exist) {
618                                 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
619                                 goto out;
620                         } else {
621                                 isnew = true;
622                         }
623                 }
624                 
625                 _name = pathstr;
626                 _path = keeppath;
627                 ret = true;
628
629         } else {
630                 
631                 /* external files and/or very very old style sessions include full paths */
632                 
633                 _path = pathstr;
634                 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
635                 
636                 if (access (_path.c_str(), R_OK) != 0) {
637
638                         /* file does not exist or we cannot read it */
639
640                         if (must_exist) {
641                                 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
642                                 goto out;
643                         }
644                         
645                         if (errno != ENOENT) {
646                                 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
647                                 goto out;
648                         }
649                         
650                         /* a new file */
651
652                         isnew = true;
653                         ret = true;
654
655                 } else {
656                         
657                         /* already exists */
658
659                         ret = true;
660                 }
661         }
662         
663   out:
664         return ret;
665 }
666
667 void
668 SMFSource::set_search_path (string p)
669 {
670         _search_path = p;
671 }
672
673
674 void
675 SMFSource::set_allow_remove_if_empty (bool yn)
676 {
677         if (writable()) {
678                 _allow_remove_if_empty = yn;
679         }
680 }
681
682 int
683 SMFSource::set_name (string newname, bool destructive)
684 {
685         //Glib::Mutex::Lock lm (_lock); FIXME
686         string oldpath = _path;
687         string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
688
689         if (newpath.empty()) {
690                 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
691                 return -1;
692         }
693
694         if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
695                 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
696                 return -1;
697         }
698
699         _name = Glib::path_get_basename (newpath);
700         _path = newpath;
701
702         return 0;//rename_peakfile (peak_path (_path));
703 }
704
705 bool
706 SMFSource::is_empty (string path)
707 {
708         /* XXX fix me */
709
710         return false;
711 }
712
713
714 void
715 SMFSource::write_chunk_header(char id[4], uint32_t length)
716 {
717         const uint32_t length_be = GUINT32_TO_BE(length);
718
719         fwrite(id, 1, 4, _fd);
720         fwrite(&length_be, 4, 1, _fd);
721 }
722
723 void
724 SMFSource::write_chunk(char id[4], uint32_t length, void* data)
725 {
726         write_chunk_header(id, length);
727         
728         fwrite(data, 1, length, _fd);
729 }
730
731 /** Returns the size (in bytes) of the value written. */
732 size_t
733 SMFSource::write_var_len(uint32_t value)
734 {
735         size_t ret = 0;
736
737         uint32_t buffer = value & 0x7F;
738
739         while ( (value >>= 7) ) {
740                 buffer <<= 8;
741                 buffer |= ((value & 0x7F) | 0x80);
742         }
743
744         while (true) {
745                 //printf("Writing var len byte %X\n", (unsigned char)buffer);
746                 ++ret;
747                 fputc(buffer, _fd);
748                 if (buffer & 0x80)
749                         buffer >>= 8;
750                 else
751                         break;
752         }
753
754         return ret;
755 }
756
757 uint32_t
758 SMFSource::read_var_len() const
759 {
760         assert(!feof(_fd));
761
762         //int offset = ftell(_fd);
763         //cerr << "SMF - reading var len at " << offset << endl;
764
765         uint32_t value;
766         unsigned char c;
767
768         if ( (value = getc(_fd)) & 0x80 ) {
769                 value &= 0x7F;
770                 do {
771                         assert(!feof(_fd));
772                         value = (value << 7) + ((c = getc(_fd)) & 0x7F);
773                 } while (c & 0x80);
774         }
775
776         return value;
777 }
778
779 void
780 SMFSource::load_model(bool lock)
781 {
782         if (lock)
783                 Glib::Mutex::Lock lm (_lock);
784
785         destroy_model();
786         _model = new MidiModel();
787
788         fseek(_fd, _header_size, 0);
789
790         nframes_t time = 0;
791         MidiEvent ev;
792         
793         // FIXME: assumes tempo never changes after start
794         const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
795                         _session.engine().frame_rate());
796         
797         int ret;
798         while ((ret = read_event(ev)) >= 0) {
799                 time += ev.time;
800                 ev.time = time;
801
802                 ev.time = (nframes_t)(ev.time * frames_per_beat / (double)_ppqn);
803
804                 if (ret > 0) { // didn't skip (meta) event
805                         //cerr << "ADDING EVENT TO MODEL: " << ev.time << endl;
806                         _model->append(ev);
807                 }
808         }
809 }
810
811
812 void
813 SMFSource::destroy_model()
814 {
815         delete _model;
816         _model = NULL;
817 }
818