2 Copyright (C) 2006 Paul Davis
3 Written by Dave Robillard, 2006
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.
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.
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.
28 #include <pbd/mountpoint.h>
29 #include <pbd/pathscanner.h>
30 #include <pbd/stl_delete.h>
31 #include <pbd/strsplit.h>
33 #include <glibmm/miscutils.h>
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>
44 using namespace ARDOUR;
46 string SMFSource::_search_path;
48 /*sigc::signal<void,struct tm*, time_t> SMFSource::HeaderPositionOffsetChanged;
49 bool SMFSource::header_position_negative;
50 uint64_t SMFSource::header_position_offset;
53 SMFSource::SMFSource (Session& s, std::string path, Flag flags)
54 : MidiSource (s, region_name_from_path(path, false))
56 , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
57 , _allow_remove_if_empty(true)
58 , _timeline_position (0)
61 , _track_size(4) // 4 bytes for the ever-present EOT event
64 /* constructor used for new internal-to-session files. file cannot exist */
66 if (init (path, false)) {
67 throw failed_constructor ();
71 throw failed_constructor ();
74 assert(_name.find("/") == string::npos);
77 SMFSource::SMFSource (Session& s, const XMLNode& node)
78 : MidiSource (s, node)
80 , _flags (Flag (Writable|CanRename))
81 , _allow_remove_if_empty(true)
82 , _timeline_position (0)
85 , _track_size(4) // 4 bytes for the ever-present EOT event
88 /* constructor used for existing internal-to-session files. file must exist */
90 if (set_state (node)) {
91 throw failed_constructor ();
94 if (init (_name, true)) {
95 throw failed_constructor ();
99 throw failed_constructor ();
102 assert(_name.find("/") == string::npos);
105 SMFSource::~SMFSource ()
108 unlink (_path.c_str());
113 SMFSource::removable () const
115 return (_flags & Removable) && ((_flags & RemoveAtDestroy) ||
116 ((_flags & RemovableIfEmpty) && is_empty (_path)));
120 SMFSource::init (string pathstr, bool must_exist)
124 if (!find (pathstr, must_exist, is_new)) {
125 cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
129 if (is_new && must_exist) {
133 assert(_name.find("/") == string::npos);
140 //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
142 assert(writable()); // FIXME;
144 _fd = fopen(path().c_str(), "r+");
146 // File already exists
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;
154 // We're making a new file
156 _fd = fopen(path().c_str(), "w+");
159 // write a tentative header just to pad things out so writing happens in the right spot
161 // FIXME: write the footer here too so it's a valid SMF (screw up writing ATM though)
164 return (_fd == 0) ? -1 : 0;
168 SMFSource::update_header (nframes_t when, struct tm&, time_t)
170 _timeline_position = when;
171 return flush_header();
175 SMFSource::flush_header ()
177 // FIXME: write timeline position somehow?
179 //cerr << "SMF Flushing header\n";
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
188 memcpy(data, &type, 2);
189 memcpy(data+2, &ntracks, 2);
190 memcpy(data+4, &division, 2);
192 _fd = freopen(path().c_str(), "r+", _fd);
195 write_chunk("MThd", 6, data);
196 //if (_track_size > 0) {
197 write_chunk_header("MTrk", _track_size);
206 SMFSource::flush_footer()
208 //cerr << "SMF - Writing EOT\n";
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);
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.
221 * Returns -1 if not found.
225 SMFSource::find_first_event_after(nframes_t start)
227 // FIXME: obviously this is slooow
229 fseek(_fd, _header_size, 0);
231 while ( ! feof(_fd) ) {
232 const uint32_t delta_time = read_var_len();
234 if (delta_time > start)
242 /** Read an event from the current position in file.
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).
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).
253 SMFSource::read_event(jack_midi_event_t& ev) const
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) {
261 uint32_t delta_time = read_var_len();
263 int status = fgetc(_fd);
264 assert(status != EOF); // FIXME die gracefully
265 if (status == 0xFF) {
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...
273 ev.time = delta_time; // this is needed regardless
278 size_t event_size = midi_event_size((unsigned char)status) + 1;
280 // Make sure we have enough scratch buffer
281 if (ev.size < event_size)
282 ev.buffer = (Byte*)realloc(ev.buffer, event_size);
284 ev.time = delta_time;
285 ev.size = event_size;
287 /*if (ev.buffer == NULL)
288 ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);*/
290 ev.buffer[0] = (unsigned char)status;
291 fread(ev.buffer+1, 1, ev.size - 1, _fd);
293 /*printf("SMF - read event, delta = %u, size = %zu, data = ",
294 delta_time, ev.size);
295 for (size_t i=0; i < ev.size; ++i) {
296 printf("%X ", ev.buffer[i]);
303 /** All stamps in audio frames */
305 SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
307 //cerr << "SMF - read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
309 // 64 bits ought to be enough for anybody
310 uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
312 _read_data_count = 0;
314 jack_midi_event_t ev; // time in SMF ticks
317 ev.buffer = NULL; // read_event will allocate scratch as needed
319 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
321 // FIXME: don't seek to start every read
322 fseek(_fd, _header_size, 0);
324 // FIXME: assumes tempo never changes after start
325 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
326 _session.engine().frame_rate());
328 uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
331 int ret = read_event(ev);
332 if (ret == -1) { // EOF
333 //cerr << "SMF - EOF\n";
337 if (ret == 0) { // meta-event (skipped)
338 //cerr << "SMF - META\n";
339 time += ev.time; // just accumulate delta time and ignore event
343 time += ev.time; // accumulate delta time
344 ev.time = time; // set ev.time to actual time (relative to source start)
346 if (ev.time >= start_ticks) {
347 if (ev.time < start_ticks + (cnt / frames_per_beat)) {
350 ev.time = (nframes_t)(((ev.time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
351 // write event time in absolute frames
352 dst.write(ev.time, ev.size, ev.buffer);
356 _read_data_count += ev.size;
358 if (ev.size > scratch_size)
359 scratch_size = ev.size;
361 ev.size = scratch_size;
367 /** All stamps in audio frames */
369 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
371 _write_data_count = 0;
373 boost::shared_ptr<MidiBuffer> buf_ptr(new MidiBuffer(1024)); // FIXME: size?
374 MidiBuffer& buf = *buf_ptr.get();
375 src.read(buf, /*_length*/0, _length + cnt); // FIXME?
377 fseek(_fd, 0, SEEK_END);
379 // FIXME: assumes tempo never changes after start
380 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
381 _session.engine().frame_rate());
383 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
385 assert(ev.time() >= _timeline_position);
386 ev.time() -= _timeline_position;
387 assert(ev.time() >= _last_ev_time);
388 const uint32_t delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
390 /*printf("SMF - writing event, delta = %u, size = %zu, data = ",
391 delta_time, ev.size);
392 for (size_t i=0; i < ev.size; ++i) {
393 printf("%X ", ev.buffer[i]);
397 size_t stamp_size = write_var_len(delta_time);
398 fwrite(ev.buffer(), 1, ev.size(), _fd);
400 _track_size += stamp_size + ev.size();
401 _write_data_count += ev.size();
403 _last_ev_time = ev.time();
408 const nframes_t oldlen = _length;
409 update_length(oldlen, cnt);
412 if ( ! _model->currently_writing()) {
413 _model->start_write();
418 ViewDataRangeReady (buf_ptr, oldlen, cnt); /* EMIT SIGNAL */
424 SMFSource::get_state ()
426 XMLNode& root (MidiSource::get_state());
428 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
429 root.add_property ("flags", buf);
434 SMFSource::set_state (const XMLNode& node)
436 const XMLProperty* prop;
438 if (MidiSource::set_state (node)) {
442 if ((prop = node.property (X_("flags"))) != 0) {
445 sscanf (prop->value().c_str(), "0x%x", &ival);
446 _flags = Flag (ival);
454 assert(_name.find("/") == string::npos);
460 SMFSource::mark_for_remove ()
465 _flags = Flag (_flags | RemoveAtDestroy);
469 SMFSource::mark_streaming_write_completed ()
471 MidiSource::mark_streaming_write_completed();
480 Glib::Mutex::Lock lm (_lock);
483 next_peak_clear_should_notify = true;
485 if (_peaks_built || pending_peak_builds.empty()) {
487 PeaksReady (); /* EMIT SIGNAL */
493 SMFSource::mark_take (string id)
501 SMFSource::move_to_trash (const string trash_dir_name)
509 /* don't move the file across filesystems, just
510 stick it in the 'trash_dir_name' directory
511 on whichever filesystem it was already on.
514 newpath = Glib::path_get_dirname (_path);
515 newpath = Glib::path_get_dirname (newpath);
518 newpath += trash_dir_name;
520 newpath += Glib::path_get_basename (_path);
522 if (access (newpath.c_str(), F_OK) == 0) {
524 /* the new path already exists, try versioning */
526 char buf[PATH_MAX+1];
530 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
533 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
534 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
538 if (version == 999) {
539 PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
548 /* it doesn't exist, or we can't read it or something */
552 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
553 PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
554 _path, newpath, strerror (errno))
559 if (::unlink (peakpath.c_str()) != 0) {
560 PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
561 peakpath, _path, strerror (errno))
563 /* try to back out */
564 rename (newpath.c_str(), _path.c_str());
571 /* file can not be removed twice, since the operation is not idempotent */
573 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
578 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
580 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
582 string::size_type pos;
587 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
589 if ((pos = pathstr.find_last_of (':')) == string::npos) {
592 pathstr = pathstr.substr (0, pos);
595 if (pathstr[0] != '/') {
597 /* non-absolute pathname: find pathstr in search path */
604 if (_search_path.length() == 0) {
605 PBD::error << _("FileSource: search path not set") << endmsg;
609 split (_search_path, dirs, ':');
613 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
616 if (fullpath[fullpath.length()-1] != '/') {
621 if (access (fullpath.c_str(), R_OK) == 0) {
629 PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
632 } else if (cnt == 0) {
635 PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
648 /* external files and/or very very old style sessions include full paths */
651 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
653 if (access (_path.c_str(), R_OK) != 0) {
655 /* file does not exist or we cannot read it */
658 PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
662 if (errno != ENOENT) {
663 PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
685 SMFSource::set_search_path (string p)
692 SMFSource::set_allow_remove_if_empty (bool yn)
695 _allow_remove_if_empty = yn;
700 SMFSource::set_source_name (string newname, bool destructive)
702 //Glib::Mutex::Lock lm (_lock); FIXME
703 string oldpath = _path;
704 string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
706 if (newpath.empty()) {
707 PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
711 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
712 PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
716 _name = Glib::path_get_basename (newpath);
719 return 0;//rename_peakfile (peak_path (_path));
723 SMFSource::is_empty (string path)
732 SMFSource::write_chunk_header(char id[4], uint32_t length)
734 const uint32_t length_be = GUINT32_TO_BE(length);
736 fwrite(id, 1, 4, _fd);
737 fwrite(&length_be, 4, 1, _fd);
741 SMFSource::write_chunk(char id[4], uint32_t length, void* data)
743 write_chunk_header(id, length);
745 fwrite(data, 1, length, _fd);
748 /** Returns the size (in bytes) of the value written. */
750 SMFSource::write_var_len(uint32_t value)
754 uint32_t buffer = value & 0x7F;
756 while ( (value >>= 7) ) {
758 buffer |= ((value & 0x7F) | 0x80);
762 //printf("Writing var len byte %X\n", (unsigned char)buffer);
775 SMFSource::read_var_len() const
779 //int offset = ftell(_fd);
780 //cerr << "SMF - reading var len at " << offset << endl;
785 if ( (value = getc(_fd)) & 0x80 ) {
789 value = (value << 7) + ((c = getc(_fd)) & 0x7F);
797 SMFSource::load_model(bool lock, bool force_reload)
803 Glib::Mutex::Lock lm (_lock);
805 if (_model && _model_loaded && ! force_reload) {
811 _model = boost::shared_ptr<MidiModel>(new MidiModel(_session));
813 cerr << "SMFSource: Reloading model." << endl;
817 _model->start_write();
819 fseek(_fd, _header_size, 0);
821 uint64_t time = 0; /* in SMF ticks */
822 jack_midi_event_t ev;
827 size_t scratch_size = 0; // keep track of scratch and minimize reallocs
829 // FIXME: assumes tempo never changes after start
830 const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
831 _session.engine().frame_rate());
834 while ((ret = read_event(ev)) >= 0) {
838 const double ev_time = (double)(time * frames_per_beat / (double)_ppqn); // in frames
840 if (ret > 0) { // didn't skip (meta) event
841 _model->append(ev_time, ev.size, ev.buffer);
844 if (ev.size > scratch_size)
845 scratch_size = ev.size;
847 ev.size = scratch_size;
850 _model->end_write(false); /* FIXME: delete stuck notes iff percussion? */
854 _model_loaded = true;
859 SMFSource::destroy_model()