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         static bool safe_file_extension (const Glib::ustring& path);
  68
  69         Glib::ustring path() const { return _path; }
  70
  71         void set_allow_remove_if_empty (bool yn);
  72         void mark_for_remove();
  73
  74         void append_event_unlocked(EventTimeUnit unit, const MIDI::Event& ev);
  75
  76         int flush_header ();
  77         int flush_footer ();
  78
  79         int move_to_trash (const string trash_dir_name);
  80
  81         bool is_empty () const;
  82         void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
  83         void mark_streaming_write_completed ();
  84
  85         void   mark_take (string);
  86         string take_id() const { return _take_id; }
  87
  88         static void set_search_path (string);
  89         static void set_header_position_offset (nframes_t offset, bool negative);
  90
  91         XMLNode& get_state ();
  92         int set_state (const XMLNode&);
  93
  94         void seek_to(nframes_t time);
  95
  96         void load_model(bool lock=true, bool force_reload=false);
  97         void destroy_model();
  98
  99         uint16_t ppqn() const { return _ppqn; }
 100
 101   private:
 102
 103         int init (string idstr, bool must_exist);
 104
 105         nframes_t read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cn, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
 106         nframes_t write_unlocked (MidiRingBuffer& dst, nframes_t cnt);
 107
 108         bool find (std::string path, bool must_exist, bool& is_new);
 109         bool removable() const;
 110         bool writable() const { return _flags & Writable; }
 111
 112         int  open();
 113         void close();
 114
 115         /**
 116          * This method is only used by flush_footer() to find the right seek position
 117          * for the footer (at the end after recording or -4 offset ro SEEK_END
 118          * if a footer is already present)
 119          */
 120         void seek_to_footer_position();
 121
 122         /**
 123          * write the track footer at the current seek position
 124          */
 125         void write_footer();
 126
 127         void     write_chunk_header(const char id[4], uint32_t length);
 128         void     write_chunk(const char id[4], uint32_t length, void* data);
 129         size_t   write_var_len(uint32_t val);
 130         uint32_t read_var_len() const;
 131         int      read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const;
 132
 133         static const uint16_t _ppqn = 19200;
 134
 135         Glib::ustring  _path;
 136         Flag           _flags;
 137         string         _take_id;
 138         bool           _allow_remove_if_empty;
 139         FILE*          _fd;
 140         double         _last_ev_time; ///< last frame time written, relative to source start
 141         uint32_t       _track_size;
 142         uint32_t       _header_size; ///< size of SMF header, including MTrk chunk header
 143         bool           _empty; ///< true iff file contains (non-empty) events
 144
 145         static string _search_path;
 146 };
 147
 148 }; /* namespace ARDOUR */
 149
 150 #endif /* __ardour_smf_filesource_h__ */
 151