libs/evoral/src/SMF.cpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include <sys/stat.h>
  20 #include <unistd.h>
  21 #include <errno.h>
  22 #include <string.h>
  23 #include <cassert>
  24 #include <iostream>
  25 #include <glibmm/miscutils.h>
  26 #include "evoral/midi_util.h"
  27 #include "evoral/SMF.hpp"
  28 #include "evoral/SMFReader.hpp"
  29 #include "evoral/Event.hpp"
  30
  31 using namespace std;
  32
  33 namespace Evoral {
  34
  35 template<typename T>
  36 SMF<T>::SMF()
  37         : _fd(0)
  38         , _last_ev_time(0)
  39         , _track_size(4) // 4 bytes for the ever-present EOT event
  40         , _header_size(22)
  41         , _empty(true)
  42 {
  43 }
  44
  45 template<typename T>
  46 SMF<T>::~SMF()
  47 {
  48 }
  49
  50 /** Attempt to open the SMF file for reading and writing.
  51  *
  52  * Currently SMF is always read/write.
  53  *
  54  * \return  0 on success
  55  *         -1 if the file can not be opened for reading,
  56  *         -2 if the file can not be opened for writing
  57  */
  58 template<typename T>
  59 int
  60 SMF<T>::open(const std::string& path)
  61 {
  62         //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
  63         _fd = fopen(path.c_str(), "r+");
  64
  65         // File already exists
  66         if (_fd) {
  67                 fseek(_fd, _header_size - 4, 0);
  68                 uint32_t track_size_be = 0;
  69                 fread(&track_size_be, 4, 1, _fd);
  70                 _track_size = GUINT32_FROM_BE(track_size_be);
  71                 _empty = _track_size > 4;
  72                 //cerr << "SMF - read track size " << _track_size << endl;
  73
  74         // We're making a new file
  75         } else {
  76                 _fd = fopen(path.c_str(), "w+");
  77                 if (_fd == NULL) {
  78                         cerr << "ERROR: Can not open SMF file " << path << " for writing: " <<
  79                                 strerror(errno) << endl;
  80                         return -2;
  81                 }
  82                 _track_size = 4;
  83                 _empty = true;
  84
  85                 // Write a tentative header just to pad things out so writing happens in the right spot
  86                 flush_header();
  87                 flush_footer();
  88         }
  89
  90         return (_fd == 0) ? -1 : 0;
  91 }
  92
  93 template<typename T>
  94 void
  95 SMF<T>::close()
  96 {
  97         if (_fd) {
  98                 flush_header();
  99                 flush_footer();
 100                 fclose(_fd);
 101                 _fd = NULL;
 102         }
 103 }
 104
 105 template<typename T>
 106 void
 107 SMF<T>::seek_to_start() const
 108 {
 109         fseek(_fd, _header_size, SEEK_SET);
 110 }
 111
 112 template<typename T>
 113 void
 114 SMF<T>::seek_to_footer_position()
 115 {
 116         uint8_t buffer[4];
 117
 118         // Check if there is a track end marker at the end of the data
 119         fseek(_fd, -4, SEEK_END);
 120         size_t read_bytes = fread(buffer, sizeof(uint8_t), 4, _fd);
 121
 122         if ((read_bytes == 4)
 123                         && buffer[0] == 0x00
 124                         && buffer[1] == 0xFF
 125                         && buffer[2] == 0x2F
 126                         && buffer[3] == 0x00) {
 127                 // there is one, so overwrite it
 128                 fseek(_fd, -4, SEEK_END);
 129         } else {
 130                 // there is none, so append
 131                 fseek(_fd, 0, SEEK_END);
 132         }
 133 }
 134
 135 template<typename T>
 136 void
 137 SMF<T>::flush()
 138 {
 139         fflush(_fd);
 140 }
 141
 142 template<typename T>
 143 int
 144 SMF<T>::flush_header()
 145 {
 146         // FIXME: write timeline position somehow?
 147
 148         //cerr << path() << " SMF Flushing header\n";
 149
 150         assert(_fd);
 151
 152         const uint16_t type     = GUINT16_TO_BE(0);     // SMF Type 0 (single track)
 153         const uint16_t ntracks  = GUINT16_TO_BE(1);     // Number of tracks (always 1 for Type 0)
 154         const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
 155
 156         char data[6];
 157         memcpy(data, &type, 2);
 158         memcpy(data+2, &ntracks, 2);
 159         memcpy(data+4, &division, 2);
 160
 161         //_fd = freopen(path().c_str(), "r+", _fd);
 162         //assert(_fd);
 163         fseek(_fd, 0, SEEK_SET);
 164         write_chunk("MThd", 6, data);
 165         write_chunk_header("MTrk", _track_size);
 166
 167         fflush(_fd);
 168
 169         return 0;
 170 }
 171
 172 template<typename T>
 173 int
 174 SMF<T>::flush_footer()
 175 {
 176         //cerr << path() << " SMF Flushing footer\n";
 177         seek_to_footer_position();
 178         write_footer();
 179         seek_to_footer_position();
 180
 181         return 0;
 182 }
 183
 184 template<typename T>
 185 void
 186 SMF<T>::write_footer()
 187 {
 188         write_var_len(0);
 189         char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
 190         fwrite(eot, 1, 3, _fd);
 191         fflush(_fd);
 192 }
 193
 194
 195 /** Read an event from the current position in file.
 196  *
 197  * File position MUST be at the beginning of a delta time, or this will die very messily.
 198  * ev.buffer must be of size ev.size, and large enough for the event.  The returned event
 199  * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
 200  * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
 201  *
 202  * \a size should be the capacity of \a buf.  If it is not large enough, \a buf will
 203  * be freed and a new buffer allocated in its place, the size of which will be placed
 204  * in size.
 205  *
 206  * Returns event length (including status byte) on success, 0 if event was
 207  * skipped (eg a meta event), or -1 on EOF (or end of track).
 208  */
 209 template<typename T>
 210 int
 211 SMF<T>::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
 212 {
 213         if (feof(_fd)) {
 214                 return -1;
 215         }
 216
 217         assert(delta_t);
 218         assert(size);
 219         assert(buf);
 220
 221         try {
 222                 *delta_t = SMFReader::read_var_len(_fd);
 223         } catch (...) {
 224                 return -1; // Premature EOF
 225         }
 226
 227         if (feof(_fd)) {
 228                 return -1; // Premature EOF
 229         }
 230
 231         const int status = fgetc(_fd);
 232
 233         if (status == EOF) {
 234                 return -1; // Premature EOF
 235         }
 236
 237         //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
 238
 239         if (status == 0xFF) {
 240                 if (feof(_fd)) {
 241                         return -1; // Premature EOF
 242                 }
 243                 const int type = fgetc(_fd);
 244                 if ((unsigned char)type == 0x2F) {
 245                         return -1; // hit end of track
 246                 } else {
 247                         *size = 0;
 248                         return 0;
 249                 }
 250         }
 251
 252         int event_size = midi_event_size((unsigned char)status);
 253         if (event_size <= 0) {
 254                 // if sysex, determine the size of the event
 255                 if ((status & 0xF0) == MIDI_CMD_COMMON_SYSEX) {
 256                         fpos_t after_sysex_status_byte_position;
 257                         int success = fgetpos(_fd, &after_sysex_status_byte_position);
 258                         assert(success == 0);
 259                         event_size = 1;
 260
 261                         while(true) {
 262                                 int byte = fgetc(_fd);
 263                                 if (byte == EOF) {
 264                                         // premature end
 265                                         return -1;
 266                                 }
 267                                 ++event_size;
 268                                 if ((byte & 0xff) == MIDI_CMD_COMMON_SYSEX_END) {
 269                                         break;
 270                                 }
 271                         }
 272
 273                         success = fsetpos(_fd, &after_sysex_status_byte_position);
 274                         assert(success == 0);
 275                 } else {
 276                         *size = 0;
 277                         return 0;
 278                 }
 279         }
 280
 281         // Make sure we have enough scratch buffer
 282         if (*size < (unsigned)event_size)
 283                 *buf = (uint8_t*)realloc(*buf, event_size);
 284
 285         *size = event_size;
 286
 287         (*buf)[0] = (unsigned char)status;
 288         if (event_size > 1)
 289                 fread((*buf) + 1, 1, *size - 1, _fd);
 290
 291         printf("SMF read event: delta = %u, size = %u, data = ",  *delta_t, *size);
 292         for (size_t i=0; i < *size; ++i) {
 293                 printf("%X ", (*buf)[i]);
 294         }
 295         printf("\n");
 296
 297         return (int)*size;
 298 }
 299
 300 template<typename T>
 301 void
 302 SMF<T>::append_event_unlocked(uint32_t delta_t, const Event<T>& ev)
 303 {
 304         if (ev.size() == 0)
 305                 return;
 306
 307         const size_t stamp_size = write_var_len(delta_t);
 308         fwrite(ev.buffer(), 1, ev.size(), _fd);
 309
 310         _track_size += stamp_size + ev.size();
 311         _last_ev_time = ev.time();
 312
 313         if (ev.size() > 0)
 314                 _empty = false;
 315 }
 316
 317 template<typename T>
 318 void
 319 SMF<T>::begin_write(FrameTime start_frame)
 320 {
 321         _last_ev_time = 0;
 322         fseek(_fd, _header_size, SEEK_SET);
 323 }
 324
 325 template<typename T>
 326 void
 327 SMF<T>::end_write()
 328 {
 329         flush_header();
 330         flush_footer();
 331 }
 332
 333 template<typename T>
 334 void
 335 SMF<T>::write_chunk_header(const char id[4], uint32_t length)
 336 {
 337         const uint32_t length_be = GUINT32_TO_BE(length);
 338
 339         fwrite(id, 1, 4, _fd);
 340         fwrite(&length_be, 4, 1, _fd);
 341 }
 342
 343 template<typename T>
 344 void
 345 SMF<T>::write_chunk(const char id[4], uint32_t length, void* data)
 346 {
 347         write_chunk_header(id, length);
 348
 349         fwrite(data, 1, length, _fd);
 350 }
 351
 352 /** Returns the size (in bytes) of the value written. */
 353 template<typename T>
 354 size_t
 355 SMF<T>::write_var_len(uint32_t value)
 356 {
 357         size_t ret = 0;
 358
 359         uint32_t buffer = value & 0x7F;
 360
 361         while ( (value >>= 7) ) {
 362                 buffer <<= 8;
 363                 buffer |= ((value & 0x7F) | 0x80);
 364         }
 365
 366         while (true) {
 367                 //printf("Writing var len byte %X\n", (unsigned char)buffer);
 368                 ++ret;
 369                 fputc(buffer, _fd);
 370                 if (buffer & 0x80)
 371                         buffer >>= 8;
 372                 else
 373                         break;
 374         }
 375
 376         return ret;
 377 }
 378
 379 template class SMF<double>;
 380
 381 } // namespace Evoral