libs/ardour/ardour/smf_source.h

   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 #ifndef __ardour_smf_filesource_h__
  22 #define __ardour_smf_filesource_h__
  23
  24 #include <cstdio>
  25 #include <time.h>
  26
  27 #include <ardour/midi_source.h>
  28 #include <evoral/SMF.hpp>
  29
  30 namespace Evoral { template<typename T> class Event; }
  31
  32 namespace ARDOUR {
  33
  34 template<typename T> class MidiRingBuffer;
  35
  36 /** Standard Midi File (Type 0) Source */
  37 class SMFSource : public MidiSource, public Evoral::SMF {
  38   public:
  39         enum Flag {
  40                 Writable = 0x1,
  41                 CanRename = 0x2,
  42                 Broadcast = 0x4,
  43                 Removable = 0x8,
  44                 RemovableIfEmpty = 0x10,
  45                 RemoveAtDestroy = 0x20,
  46                 BuildPeaks = 0x40
  47         };
  48
  49         /** Constructor for existing external-to-session files */
  50         SMFSource (Session& session, std::string path, Flag flags = Flag(0));
  51
  52         /* Constructor for existing in-session files */
  53         SMFSource (Session& session, const XMLNode&);
  54
  55         virtual ~SMFSource ();
  56
  57         /* this block of methods do nothing for regular file sources, but are significant
  58            for files used in destructive recording.
  59         */
  60         // FIXME and thus are useless for MIDI.. but make MidiDiskstream compile easier! :)
  61
  62         virtual nframes_t last_capture_start_frame() const { return 0; }
  63         virtual void      mark_capture_start (nframes_t) {}
  64         virtual void      mark_capture_end () {}
  65         virtual void      clear_capture_marks() {}
  66
  67         bool set_name (const std::string& newname) { return (set_source_name(newname, false) == 0); }
  68         int set_source_name (string newname, bool destructive);
  69
  70         static bool safe_file_extension (const Glib::ustring& path);
  71
  72         Glib::ustring path() const { return _path; }
  73
  74         void set_allow_remove_if_empty (bool yn);
  75         void mark_for_remove();
  76
  77         void append_event_unlocked(EventTimeUnit unit, const Evoral::Event<double>& ev);
  78
  79         int move_to_trash (const string trash_dir_name);
  80
  81         void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
  82         void mark_streaming_write_completed ();
  83
  84         void   mark_take (string);
  85         string take_id() const { return _take_id; }
  86
  87         static void set_search_path (string);
  88         static void set_header_position_offset (nframes_t offset, bool negative);
  89
  90         XMLNode& get_state ();
  91         int set_state (const XMLNode&);
  92
  93         void load_model(bool lock=true, bool force_reload=false);
  94         void destroy_model();
  95
  96         double last_event_time() const { return _last_ev_time; }
  97
  98         void flush_midi();
  99
 100   private:
 101
 102         int init (string idstr, bool must_exist);
 103
 104         nframes_t read_unlocked (
 105                         MidiRingBuffer<nframes_t>& dst,
 106                         nframes_t start,
 107                         nframes_t cn,
 108                         nframes_t stamp_offset,
 109                         nframes_t negative_stamp_offset) const;
 110
 111         nframes_t write_unlocked (
 112                         MidiRingBuffer<nframes_t>& src,
 113                         nframes_t cnt);
 114
 115         bool find (std::string path, bool must_exist, bool& is_new);
 116         bool removable() const;
 117         bool writable() const { return _flags & Writable; }
 118
 119         void set_default_controls_interpolation();
 120
 121         Glib::ustring  _path;
 122         Flag           _flags;
 123         string         _take_id;
 124         bool           _allow_remove_if_empty;
 125         double         _last_ev_time;
 126
 127         static string _search_path;
 128 };
 129
 130 }; /* namespace ARDOUR */
 131
 132 #endif /* __ardour_smf_filesource_h__ */
 133