libs/evoral/src/SMF.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  * Author: Hans Baier
   5  *
   6  * Evoral is free software; you can redistribute it and/or modify it under the
   7  * terms of the GNU General Public License as published by the Free Software
   8  * Foundation; either version 2 of the License, or (at your option) any later
   9  * version.
  10  *
  11  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #include <algorithm>
  21 #include <cassert>
  22 #include <cmath>
  23 #include <iostream>
  24 #include <stdint.h>
  25 #include "libsmf/smf.h"
  26 #include "evoral/Event.hpp"
  27 #include "evoral/SMF.hpp"
  28 #include "evoral/midi_util.h"
  29
  30 #ifdef COMPILER_MSVC
  31 extern double round(double x);
  32 #endif
  33
  34 using namespace std;
  35
  36 namespace Evoral {
  37
  38 SMF::~SMF()
  39 {
  40         close ();
  41 }
  42
  43 uint16_t
  44 SMF::num_tracks() const
  45 {
  46         Glib::Threads::Mutex::Lock lm (_smf_lock);
  47         return _smf ? _smf->number_of_tracks : 0;
  48 }
  49
  50 uint16_t
  51 SMF::ppqn() const
  52 {
  53         Glib::Threads::Mutex::Lock lm (_smf_lock);
  54         return _smf->ppqn;
  55 }
  56
  57 /** Seek to the specified track (1-based indexing)
  58  * \return 0 on success
  59  */
  60 int
  61 SMF::seek_to_track(int track)
  62 {
  63         Glib::Threads::Mutex::Lock lm (_smf_lock);
  64         _smf_track = smf_get_track_by_number(_smf, track);
  65         if (_smf_track != NULL) {
  66                 _smf_track->next_event_number = (_smf_track->number_of_events == 0) ? 0 : 1;
  67                 return 0;
  68         } else {
  69                 return -1;
  70         }
  71 }
  72
  73 /** Attempt to open the SMF file just to see if it is valid.
  74  *
  75  * \return  true on success
  76  *          false on failure
  77  */
  78 bool
  79 SMF::test(const std::string& path)
  80 {
  81         FILE* f = fopen (path.c_str(), "r");
  82         if (f == 0) {
  83                 return false;
  84         }
  85
  86         smf_t* test_smf;
  87         if ((test_smf = smf_load (f)) == NULL) {
  88                 return false;
  89         }
  90         smf_delete (test_smf);
  91         return true;
  92 }
  93
  94 /** Attempt to open the SMF file for reading and/or writing.
  95  *
  96  * \return  0 on success
  97  *         -1 if the file can not be opened or created
  98  *         -2 if the file exists but specified track does not exist
  99  */
 100 int
 101 SMF::open(const std::string& path, int track) THROW_FILE_ERROR
 102 {
 103         Glib::Threads::Mutex::Lock lm (_smf_lock);
 104
 105         assert(track >= 1);
 106         if (_smf) {
 107                 smf_delete(_smf);
 108         }
 109
 110         _file_path = path;
 111
 112         FILE* f = fopen (_file_path.c_str(), "r");
 113         if (f == 0) {
 114                 return -1;
 115         }
 116
 117         if ((_smf = smf_load (f)) == 0) {
 118                 return -1;
 119         }
 120
 121         if ((_smf_track = smf_get_track_by_number(_smf, track)) == 0) {
 122                 return -2;
 123         }
 124
 125         //cerr << "Track " << track << " # events: " << _smf_track->number_of_events << endl;
 126         if (_smf_track->number_of_events == 0) {
 127                 _smf_track->next_event_number = 0;
 128                 _empty = true;
 129         } else {
 130                 _smf_track->next_event_number = 1;
 131                 _empty = false;
 132         }
 133
 134         return 0;
 135 }
 136
 137
 138 /** Attempt to create a new SMF file for reading and/or writing.
 139  *
 140  * \return  0 on success
 141  *         -1 if the file can not be created
 142  *         -2 if the track can not be created
 143  */
 144 int
 145 SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
 146 {
 147         Glib::Threads::Mutex::Lock lm (_smf_lock);
 148
 149         assert(track >= 1);
 150         if (_smf) {
 151                 smf_delete(_smf);
 152         }
 153
 154         _file_path = path;
 155
 156         _smf = smf_new();
 157
 158         if (_smf == NULL) {
 159                 return -1;
 160         }
 161
 162         if (smf_set_ppqn(_smf, ppqn) != 0) {
 163                 return -1;
 164         }
 165
 166         for (int i = 0; i < track; ++i) {
 167                 _smf_track = smf_track_new();
 168                 if (!_smf_track) {
 169                         return -2;
 170                 }
 171                 smf_add_track(_smf, _smf_track);
 172         }
 173
 174         _smf_track = smf_get_track_by_number(_smf, track);
 175         if (!_smf_track)
 176                 return -2;
 177
 178         _smf_track->next_event_number = 0;
 179
 180         {
 181                 /* put a stub file on disk */
 182
 183                 FILE* f = fopen (_file_path.c_str(), "w+");
 184                 if (f == 0) {
 185                         return -1;
 186                 }
 187
 188                 if (smf_save (_smf, f)) {
 189                         return -1;
 190                 }
 191         }
 192
 193         _empty = true;
 194
 195         return 0;
 196 }
 197
 198 void
 199 SMF::close() THROW_FILE_ERROR
 200 {
 201         Glib::Threads::Mutex::Lock lm (_smf_lock);
 202
 203         if (_smf) {
 204                 smf_delete(_smf);
 205                 _smf = 0;
 206                 _smf_track = 0;
 207         }
 208 }
 209
 210 void
 211 SMF::seek_to_start() const
 212 {
 213         Glib::Threads::Mutex::Lock lm (_smf_lock);
 214         if (_smf_track) {
 215                 _smf_track->next_event_number = std::min(_smf_track->number_of_events, 1);
 216         } else {
 217                 cerr << "WARNING: SMF seek_to_start() with no track" << endl;
 218         }
 219 }
 220
 221 /** Read an event from the current position in file.
 222  *
 223  * File position MUST be at the beginning of a delta time, or this will die very messily.
 224  * ev.buffer must be of size ev.size, and large enough for the event.  The returned event
 225  * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
 226  * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
 227  *
 228  * \a buf must be a pointer to a buffer allocated with malloc, or a pointer to NULL.
 229  * \a size must be the capacity of \a buf.  If it is not large enough, \a buf will
 230  * be reallocated and *size will be set to the new size of buf.
 231  *
 232  * if the event is a meta-event and is an Evoral Note ID, then \a note_id will be set
 233  * to the value of the NoteID; otherwise, meta-events will set \a note_id to -1.
 234  *
 235  * \return event length (including status byte) on success, 0 if event was
 236  * a meta event, or -1 on EOF (or end of track).
 237  */
 238 int
 239 SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* note_id) const
 240 {
 241         Glib::Threads::Mutex::Lock lm (_smf_lock);
 242
 243         smf_event_t* event;
 244
 245         assert(delta_t);
 246         assert(size);
 247         assert(buf);
 248         assert(note_id);
 249
 250         if ((event = smf_track_get_next_event(_smf_track)) != NULL) {
 251
 252                 *delta_t = event->delta_time_pulses;
 253
 254                 if (smf_event_is_metadata(event)) {
 255                         *note_id = -1; // "no note id in this meta-event */
 256
 257                         if (event->midi_buffer[1] == 0x7f) { // Sequencer-specific
 258
 259                                 uint32_t evsize;
 260                                 uint32_t lenlen;
 261
 262                                 if (smf_extract_vlq (&event->midi_buffer[2], event->midi_buffer_length-2, &evsize, &lenlen) == 0) {
 263
 264                                         if (event->midi_buffer[2+lenlen] == 0x99 &&  // Evoral
 265                                             event->midi_buffer[3+lenlen] == 0x1) { // Evoral Note ID
 266
 267                                                 uint32_t id;
 268                                                 uint32_t idlen;
 269
 270                                                 if (smf_extract_vlq (&event->midi_buffer[4+lenlen], event->midi_buffer_length-(4+lenlen), &id, &idlen) == 0) {
 271                                                         *note_id = id;
 272                                                 }
 273                                         }
 274                                 }
 275                         }
 276                         return 0; /* this is a meta-event */
 277                 }
 278
 279                 int event_size = event->midi_buffer_length;
 280                 assert(event_size > 0);
 281
 282                 // Make sure we have enough scratch buffer
 283                 if (*size < (unsigned)event_size) {
 284                         *buf = (uint8_t*)realloc(*buf, event_size);
 285                 }
 286                 memcpy(*buf, event->midi_buffer, size_t(event_size));
 287                 *size = event_size;
 288
 289                 assert(midi_event_is_valid(*buf, *size));
 290
 291                 /* printf("SMF::read_event @ %u: ", *delta_t);
 292                    for (size_t i = 0; i < *size; ++i) {
 293                    printf("%X ", (*buf)[i]);
 294                    } printf("\n") */
 295
 296                 return event_size;
 297         } else {
 298                 return -1;
 299         }
 300 }
 301
 302 void
 303 SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id)
 304 {
 305         Glib::Threads::Mutex::Lock lm (_smf_lock);
 306
 307         if (size == 0) {
 308                 return;
 309         }
 310
 311         /* printf("SMF::append_event_delta @ %u:", delta_t);
 312            for (size_t i = 0; i < size; ++i) {
 313            printf("%X ", buf[i]);
 314            } printf("\n"); */
 315
 316         if (!midi_event_is_valid(buf, size)) {
 317                 cerr << "WARNING: SMF ignoring illegal MIDI event" << endl;
 318                 return;
 319         }
 320
 321         smf_event_t* event;
 322
 323         /* XXX july 2010: currently only store event ID's for notes, program changes and bank changes
 324          */
 325
 326         uint8_t const c = buf[0] & 0xf0;
 327         bool const store_id = (
 328                 c == MIDI_CMD_NOTE_ON ||
 329                 c == MIDI_CMD_NOTE_OFF ||
 330                 c == MIDI_CMD_PGM_CHANGE ||
 331                 (c == MIDI_CMD_CONTROL && (buf[1] == MIDI_CTL_MSB_BANK || buf[1] == MIDI_CTL_LSB_BANK))
 332                                );
 333
 334         if (store_id && note_id >= 0) {
 335                 int idlen;
 336                 int lenlen;
 337                 uint8_t idbuf[16];
 338                 uint8_t lenbuf[16];
 339
 340                 event = smf_event_new ();
 341                 assert(event != NULL);
 342
 343                 /* generate VLQ representation of note ID */
 344                 idlen = smf_format_vlq (idbuf, sizeof(idbuf), note_id);
 345
 346                 /* generate VLQ representation of meta event length,
 347                    which is the idlen + 2 bytes (Evoral type ID plus Note ID type)
 348                 */
 349
 350                 lenlen = smf_format_vlq (lenbuf, sizeof(lenbuf), idlen+2);
 351
 352                 event->midi_buffer_length = 2 + lenlen + 2 + idlen;
 353                 /* this should be allocated by malloc(3) because libsmf will
 354                    call free(3) on it
 355                 */
 356                 event->midi_buffer = (uint8_t*) malloc (sizeof(uint8_t) * event->midi_buffer_length);
 357
 358                 event->midi_buffer[0] = 0xff; // Meta-event
 359                 event->midi_buffer[1] = 0x7f; // Sequencer-specific
 360                 memcpy (&event->midi_buffer[2], lenbuf, lenlen);
 361                 event->midi_buffer[2+lenlen] = 0x99; // Evoral type ID
 362                 event->midi_buffer[3+lenlen] = 0x1;  // Evoral type Note ID
 363                 memcpy (&event->midi_buffer[4+lenlen], idbuf, idlen);
 364
 365                 assert(_smf_track);
 366                 smf_track_add_event_delta_pulses(_smf_track, event, 0);
 367         }
 368
 369         event = smf_event_new_from_pointer(buf, size);
 370         assert(event != NULL);
 371
 372         assert(_smf_track);
 373         smf_track_add_event_delta_pulses(_smf_track, event, delta_t);
 374         _empty = false;
 375 }
 376
 377 void
 378 SMF::begin_write()
 379 {
 380         Glib::Threads::Mutex::Lock lm (_smf_lock);
 381
 382         assert(_smf_track);
 383         smf_track_delete(_smf_track);
 384
 385         _smf_track = smf_track_new();
 386         assert(_smf_track);
 387
 388         smf_add_track(_smf, _smf_track);
 389         assert(_smf->number_of_tracks == 1);
 390 }
 391
 392 void
 393 SMF::end_write() THROW_FILE_ERROR
 394 {
 395         Glib::Threads::Mutex::Lock lm (_smf_lock);
 396         FILE* f = fopen (_file_path.c_str(), "w+");
 397         if (f == 0) {
 398                 throw FileError (_file_path);
 399         }
 400
 401         if (smf_save(_smf, f) != 0) {
 402                 throw FileError (_file_path);
 403         }
 404 }
 405
 406 double
 407 SMF::round_to_file_precision (double val) const
 408 {
 409         double div = ppqn();
 410
 411         return round (val * div) / div;
 412 }
 413
 414 void
 415 SMF::set_path (const std::string& p)
 416 {
 417         _file_path = p;
 418 }
 419
 420 } // namespace Evoral