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
  29 namespace ARDOUR {
  30
  31 class MidiRingBuffer;
  32
  33 /** Standard Midi File (Type 0) Source */
  34 class SMFSource : public MidiSource {
  35   public:
  36         enum Flag {
  37                 Writable = 0x1,
  38                 CanRename = 0x2,
  39                 Broadcast = 0x4,
  40                 Removable = 0x8,
  41                 RemovableIfEmpty = 0x10,
  42                 RemoveAtDestroy = 0x20,
  43                 BuildPeaks = 0x40
  44         };
  45
  46         /** Constructor for existing external-to-session files */
  47         SMFSource (Session& session, std::string path, Flag flags = Flag(0));
  48
  49         /* Constructor for existing in-session files */
  50         SMFSource (Session& session, const XMLNode&);
  51
  52         virtual ~SMFSource ();
  53
  54         /* this block of methods do nothing for regular file sources, but are significant
  55            for files used in destructive recording.
  56         */
  57         // FIXME and thus are useless for MIDI.. but make MidiDiskstream compile easier! :)
  58
  59         virtual nframes_t last_capture_start_frame() const { return 0; }
  60         virtual void           mark_capture_start (nframes_t) {}
  61         virtual void           mark_capture_end () {}
  62         virtual void           clear_capture_marks() {}
  63
  64         bool set_name (const std::string& newname) { return (set_source_name(newname, false) == 0); }
  65         int set_source_name (string newname, bool destructive);
  66
  67         string path() const { return _path; }
  68
  69         void set_allow_remove_if_empty (bool yn);
  70         void mark_for_remove();
  71
  72         int update_header (nframes_t when, struct tm&, time_t);
  73         int flush_header ();
  74         int flush_footer ();
  75
  76         int move_to_trash (const string trash_dir_name);
  77
  78         static bool is_empty (string path);
  79         void mark_streaming_write_completed ();
  80
  81         void   mark_take (string);
  82         string take_id() const { return _take_id; }
  83
  84         static void set_search_path (string);
  85         static void set_header_position_offset (nframes_t offset, bool negative);
  86
  87         XMLNode& get_state ();
  88         int set_state (const XMLNode&);
  89
  90         void seek_to(nframes_t time);
  91
  92         void load_model(bool lock=true);
  93         void destroy_model();
  94
  95         uint16_t ppqn() const { return _ppqn; }
  96
  97   private:
  98
  99         int init (string idstr, bool must_exist);
 100
 101         nframes_t read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cn, nframes_t stamp_offset) const;
 102         nframes_t write_unlocked (MidiRingBuffer& dst, nframes_t cnt);
 103
 104         bool find (std::string path, bool must_exist, bool& is_new);
 105         bool removable() const;
 106         bool writable() const { return _flags & Writable; }
 107
 108         int open();
 109
 110         void     write_chunk_header(char id[4], uint32_t length);
 111         void     write_chunk(char id[4], uint32_t length, void* data);
 112         size_t   write_var_len(uint32_t val);
 113         uint32_t read_var_len() const;
 114         int      read_event(jack_midi_event_t& ev) const;
 115
 116         static const uint16_t _ppqn = 19200;
 117
 118         uint16_t       _channel;
 119         string         _path;
 120         Flag           _flags;
 121         string         _take_id;
 122         bool           _allow_remove_if_empty;
 123         uint64_t       _timeline_position;
 124         FILE*          _fd;
 125         double         _last_ev_time; // last frame time written, relative to source start
 126         uint32_t       _track_size;
 127         uint32_t       _header_size; // size of SMF header, including MTrk chunk header
 128
 129         static string _search_path;
 130 };
 131
 132 }; /* namespace ARDOUR */
 133
 134 #endif /* __ardour_smf_filesource_h__ */
 135