libs/evoral/src/OldSMF.cpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 David 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/OldSMF.hpp"
  28 #include "evoral/SMFReader.hpp"
  29 #include "evoral/Event.hpp"
  30
  31 using namespace std;
  32
  33 namespace Evoral {
  34
  35 template<typename Time>
  36 SMF<Time>::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 Time>
  46 SMF<Time>::~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 Time>
  59 int
  60 SMF<Time>::open(const std::string& path) THROW_FILE_ERROR
  61
  62 {
  63         //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
  64         _fd = fopen(path.c_str(), "r+");
  65
  66         // File already exists
  67         if (_fd) {
  68                 fseek(_fd, _header_size - 4, 0);
  69                 uint32_t track_size_be = 0;
  70                 fread(&track_size_be, 4, 1, _fd);
  71                 _track_size = GUINT32_FROM_BE(track_size_be);
  72                 _empty = _track_size > 4;
  73                 //cerr << "SMF - read track size " << _track_size << endl;
  74
  75         // We're making a new file
  76         } else {
  77                 _fd = fopen(path.c_str(), "w+");
  78                 if (_fd == NULL) {
  79                         cerr << "ERROR: Can not open SMF file " << path << " for writing: " <<
  80                                 strerror(errno) << endl;
  81                         return -2;
  82                 }
  83                 _track_size = 4;
  84                 _empty = true;
  85
  86                 // Write a tentative header just to pad things out so writing happens in the right spot
  87                 flush_header();
  88                 flush_footer();
  89         }
  90
  91         return (_fd == 0) ? -1 : 0;
  92 }
  93
  94 template<typename Time>
  95 void
  96 SMF<Time>::close() THROW_FILE_ERROR
  97 {
  98         if (_fd) {
  99                 flush_header();
 100                 flush_footer();
 101                 fclose(_fd);
 102                 _fd = NULL;
 103         }
 104 }
 105
 106 template<typename Time>
 107 void
 108 SMF<Time>::seek_to_start() const
 109 {
 110         fseek(_fd, _header_size, SEEK_SET);
 111 }
 112
 113 template<typename Time>
 114 void
 115 SMF<Time>::seek_to_footer_position()
 116 {
 117         uint8_t buffer[4];
 118
 119         // Check if there is a track end marker at the end of the data
 120         fseek(_fd, -4, SEEK_END);
 121         size_t read_bytes = fread(buffer, sizeof(uint8_t), 4, _fd);
 122
 123         if ((read_bytes == 4)
 124                         && buffer[0] == 0x00
 125                         && buffer[1] == 0xFF
 126                         && buffer[2] == 0x2F
 127                         && buffer[3] == 0x00) {
 128                 // there is one, so overwrite it
 129                 fseek(_fd, -4, SEEK_END);
 130         } else {
 131                 // there is none, so append
 132                 fseek(_fd, 0, SEEK_END);
 133         }
 134 }
 135
 136 template<typename Time>
 137 void
 138 SMF<Time>::flush()
 139 {
 140         fflush(_fd);
 141 }
 142
 143 template<typename Time>
 144 int
 145 SMF<Time>::flush_header()
 146 {
 147         // FIXME: write timeline position somehow?
 148
 149         //cerr << path() << " SMF Flushing header\n";
 150
 151         assert(_fd);
 152
 153         const uint16_t type     = GUINT16_TO_BE(0);     // SMF Type 0 (single track)
 154         const uint16_t ntracks  = GUINT16_TO_BE(1);     // Number of tracks (always 1 for Type 0)
 155         const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
 156
 157         char data[6];
 158         memcpy(data, &type, 2);
 159         memcpy(data+2, &ntracks, 2);
 160         memcpy(data+4, &division, 2);
 161
 162         //_fd = freopen(path().c_str(), "r+", _fd);
 163         //assert(_fd);
 164         fseek(_fd, 0, SEEK_SET);
 165         write_chunk("MThd", 6, data);
 166         write_chunk_header("MTrk", _track_size);
 167
 168         fflush(_fd);
 169
 170         return 0;
 171 }
 172
 173 template<typename Time>
 174 int
 175 SMF<Time>::flush_footer()
 176 {
 177         //cerr << path() << " SMF Flushing footer\n";
 178         seek_to_footer_position();
 179         write_footer();
 180         seek_to_footer_position();
 181
 182         return 0;
 183 }
 184
 185 template<typename Time>
 186 void
 187 SMF<Time>::write_footer()
 188 {
 189         write_var_len(0);
 190         char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
 191         fwrite(eot, 1, 3, _fd);
 192         fflush(_fd);
 193 }
 194
 195
 196 /** Read an event from the current position in file.
 197  *
 198  * File position MUST be at the beginning of a delta time, or this will die very messily.
 199  * ev.buffer must be of size ev.size, and large enough for the event.  The returned event
 200  * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
 201  * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
 202  *
 203  * \a size should be the capacity of \a buf.  If it is not large enough, \a buf will
 204  * be freed and a new buffer allocated in its place, the size of which will be placed
 205  * in size.
 206  *
 207  * Returns event length (including status byte) on success, 0 if event was
 208  * skipped (eg a meta event), or -1 on EOF (or end of track).
 209  */
 210 template<typename Time>
 211 int
 212 SMF<Time>::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
 213 {
 214         if (feof(_fd)) {
 215                 return -1;
 216         }
 217
 218         assert(delta_t);
 219         assert(size);
 220         assert(buf);
 221
 222         try {
 223                 *delta_t = SMFReader::read_var_len(_fd);
 224         } catch (...) {
 225                 return -1; // Premature EOF
 226         }
 227
 228         if (feof(_fd)) {
 229                 return -1; // Premature EOF
 230         }
 231
 232         const int status = fgetc(_fd);
 233
 234         if (status == EOF) {
 235                 return -1; // Premature EOF
 236         }
 237
 238         //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
 239
 240         if (status == 0xFF) {
 241                 if (feof(_fd)) {
 242                         return -1; // Premature EOF
 243                 }
 244                 const int type = fgetc(_fd);
 245                 if ((unsigned char)type == 0x2F) {
 246                         return -1; // hit end of track
 247                 } else {
 248                         *size = 0;
 249                         return 0;
 250                 }
 251         }
 252
 253         int event_size = midi_event_size((unsigned char)status);
 254         if (event_size <= 0) {
 255                 if ((status & 0xff) == MIDI_CMD_COMMON_SYSEX) {
 256                 event_size = SMFReader::read_var_len(_fd) + 1;
 257                 } else {
 258                         *size = 0;
 259                         return 0;
 260                 }
 261         }
 262
 263         // Make sure we have enough scratch buffer
 264         if (*size < (unsigned)event_size)
 265                 *buf = (uint8_t*)realloc(*buf, event_size);
 266
 267         *size = event_size;
 268
 269         (*buf)[0] = (unsigned char)status;
 270         if (event_size > 1)
 271                 fread((*buf) + 1, 1, *size - 1, _fd);
 272
 273         /*printf("SMF read event: delta = %u, size = %u, data = ",  *delta_t, *size);
 274         for (size_t i=0; i < *size; ++i) {
 275                 printf("%X ", (*buf)[i]);
 276         }
 277         printf("\n");*/
 278
 279         return (int)*size;
 280 }
 281
 282 template<typename Time>
 283 void
 284 SMF<Time>::append_event_delta(uint32_t delta_t, const Event<Time>& ev)
 285 {
 286         if (ev.size() == 0)
 287                 return;
 288
 289         size_t stamp_size = write_var_len(delta_t);
 290         if (ev.buffer()[0] == MIDI_CMD_COMMON_SYSEX) {
 291                 fputc(MIDI_CMD_COMMON_SYSEX, _fd);
 292                 stamp_size += write_var_len(ev.size() - 1);
 293                 fwrite(ev.buffer() + 1, 1, ev.size() - 1, _fd);
 294         } else {
 295                 fwrite(ev.buffer(), 1, ev.size(), _fd);
 296         }
 297
 298         _track_size += stamp_size + ev.size();
 299         _last_ev_time = ev.time();
 300
 301         if (ev.size() > 0)
 302                 _empty = false;
 303 }
 304
 305 template<typename Time>
 306 void
 307 SMF<Time>::begin_write()
 308 {
 309         _last_ev_time = 0;
 310         fseek(_fd, _header_size, SEEK_SET);
 311 }
 312
 313 template<typename Time>
 314 void
 315 SMF<Time>::end_write()
 316 {
 317         flush_header();
 318         flush_footer();
 319 }
 320
 321 template<typename Time>
 322 void
 323 SMF<Time>::write_chunk_header(const char id[4], uint32_t length)
 324 {
 325         const uint32_t length_be = GUINT32_TO_BE(length);
 326
 327         fwrite(id, 1, 4, _fd);
 328         fwrite(&length_be, 4, 1, _fd);
 329 }
 330
 331 template<typename Time>
 332 void
 333 SMF<Time>::write_chunk(const char id[4], uint32_t length, void* data)
 334 {
 335         write_chunk_header(id, length);
 336
 337         fwrite(data, 1, length, _fd);
 338 }
 339
 340 /** Returns the size (in bytes) of the value written. */
 341 template<typename Time>
 342 size_t
 343 SMF<Time>::write_var_len(uint32_t value)
 344 {
 345         size_t ret = 0;
 346
 347         uint32_t buffer = value & 0x7F;
 348
 349         while ( (value >>= 7) ) {
 350                 buffer <<= 8;
 351                 buffer |= ((value & 0x7F) | 0x80);
 352         }
 353
 354         while (true) {
 355                 //printf("Writing var len byte %X\n", (unsigned char)buffer);
 356                 ++ret;
 357                 fputc(buffer, _fd);
 358                 if (buffer & 0x80)
 359                         buffer >>= 8;
 360                 else
 361                         break;
 362         }
 363
 364         return ret;
 365 }
 366
 367 template class SMF<Evoral::Beats>;
 368
 369 } // namespace Evoral