there is no remote model choice anymore - ordering is determined by the GUI
[ardour.git] / libs / ardour / ardour / smf_source.h
index 3217c8e3e8c141a8e30eb699800c95f39ae3fdc3..8f58fda2fea7b0cf0c83fa0facaedca0d216b661 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2006 Paul Davis
-       Written by Dave Robillard, 2006
+    Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#ifndef __ardour_smf_filesource_h__ 
-#define __ardour_smf_filesource_h__
+#ifndef __ardour_smf_source_h__
+#define __ardour_smf_source_h__
 
 #include <cstdio>
 #include <time.h>
+#include "evoral/SMF.hpp"
+#include "ardour/midi_source.h"
+#include "ardour/file_source.h"
 
-#include <ardour/midi_source.h>
-
-namespace Evoral { class Event; }
+namespace Evoral { template<typename T> class Event; }
 
 namespace ARDOUR {
 
-class MidiRingBuffer;
+template<typename T> class MidiRingBuffer;
 
 /** Standard Midi File (Type 0) Source */
-class SMFSource : public MidiSource {
-  public:
-       enum Flag {
-               Writable = 0x1,
-               CanRename = 0x2,
-               Broadcast = 0x4,
-               Removable = 0x8,
-               RemovableIfEmpty = 0x10,
-               RemoveAtDestroy = 0x20,
-               BuildPeaks = 0x40
-       };
-       
+class LIBARDOUR_API SMFSource : public MidiSource, public FileSource, public Evoral::SMF {
+public:
+       /** Constructor for new internal-to-session files */
+       SMFSource (Session& session, const std::string& path, Source::Flag flags);
+
        /** Constructor for existing external-to-session files */
-       SMFSource (Session& session, std::string path, Flag flags = Flag(0));
+       SMFSource (Session& session, const std::string& path);
 
-       /* Constructor for existing in-session files */
-       SMFSource (Session& session, const XMLNode&);
+       /** Constructor for existing in-session files */
+       SMFSource (Session& session, const XMLNode&, bool must_exist = false);
 
        virtual ~SMFSource ();
 
-       /* this block of methods do nothing for regular file sources, but are significant
-          for files used in destructive recording.
-       */
-       // FIXME and thus are useless for MIDI.. but make MidiDiskstream compile easier! :)
-
-       virtual nframes_t last_capture_start_frame() const { return 0; }
-       virtual void      mark_capture_start (nframes_t) {}
-       virtual void      mark_capture_end () {}
-       virtual void      clear_capture_marks() {}
-
-       bool set_name (const std::string& newname) { return (set_source_name(newname, false) == 0); }
-       int set_source_name (string newname, bool destructive);
-       
-       static bool safe_file_extension (const Glib::ustring& path);
-
-       Glib::ustring path() const { return _path; }
+       bool safe_file_extension (const std::string& path) const {
+               return safe_midi_file_extension(path);
+       }
 
-       void set_allow_remove_if_empty (bool yn);
-       void mark_for_remove();
+       void append_event_beats (const Lock& lock, const Evoral::Event<Evoral::Beats>& ev);
+       void append_event_frames (const Lock& lock, const Evoral::Event<framepos_t>& ev, framepos_t source_start);
 
-       void append_event_unlocked(EventTimeUnit unit, const Evoral::Event& ev);
+       void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
+       void mark_streaming_write_completed (const Lock& lock);
+       void mark_midi_streaming_write_completed (const Lock& lock,
+                                                 Evoral::Sequence<Evoral::Beats>::StuckNoteOption,
+                                                 Evoral::Beats when = Evoral::Beats());
 
-       int flush_header ();
-       int flush_footer ();
-       
-       int move_to_trash (const string trash_dir_name);
-
-       bool is_empty () const;
-       void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
-       void mark_streaming_write_completed ();
-
-       void   mark_take (string);
-       string take_id() const { return _take_id; }
+       XMLNode& get_state ();
+       int set_state (const XMLNode&, int version);
 
-       static void set_search_path (string);
-       static void set_header_position_offset (nframes_t offset, bool negative);
+       void load_model (const Glib::Threads::Mutex::Lock& lock, bool force_reload=false);
+       void destroy_model (const Glib::Threads::Mutex::Lock& lock);
 
-       XMLNode& get_state ();
-       int set_state (const XMLNode&);
+       static bool safe_midi_file_extension (const std::string& path);
+       static bool valid_midi_file (const std::string& path);
 
-       void seek_to(nframes_t time);
-       
-       void load_model(bool lock=true, bool force_reload=false);
-       void destroy_model();
+       void prevent_deletion ();
 
-       uint16_t ppqn() const { return _ppqn; }
+  protected:
+       void close ();
+       void set_path (const std::string& newpath);
+       void flush_midi (const Lock& lock);
 
   private:
+       bool _open;
+       Evoral::Beats       _last_ev_time_beats;
+       framepos_t          _last_ev_time_frames;
+       /** end time (start + duration) of last call to read_unlocked */
+       mutable framepos_t _smf_last_read_end;
+       /** time (in SMF ticks, 1 tick per _ppqn) of the last event read by read_unlocked */
+       mutable framepos_t _smf_last_read_time;
+
+       int open_for_write ();
+
+       void ensure_disk_file (const Lock& lock);
+
+       framecnt_t read_unlocked (const Lock&                    lock,
+                                 Evoral::EventSink<framepos_t>& dst,
+                                 framepos_t                     position,
+                                 framepos_t                     start,
+                                 framecnt_t                     cnt,
+                                 MidiStateTracker*              tracker,
+                                 MidiChannelFilter*             filter) const;
+
+       framecnt_t write_unlocked (const Lock&                 lock,
+                                  MidiRingBuffer<framepos_t>& src,
+                                  framepos_t                  position,
+                                  framecnt_t                  cnt);
 
-       int init (string idstr, bool must_exist);
-
-       nframes_t read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cn, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
-       nframes_t write_unlocked (MidiRingBuffer& dst, nframes_t cnt);
-
-       bool find (std::string path, bool must_exist, bool& is_new);
-       bool removable() const;
-       bool writable() const { return _flags & Writable; }
-
-       int  open();
-       void close();
-       
-       /**
-        * This method is only used by flush_footer() to find the right seek position 
-        * for the footer (at the end after recording or -4 offset ro SEEK_END
-        * if a footer is already present)
-        */
-       void seek_to_footer_position();
-       
-       /**
-        * write the track footer at the current seek position
-        */
-       void write_footer();
-
-       void     write_chunk_header(const char id[4], uint32_t length);
-       void     write_chunk(const char id[4], uint32_t length, void* data);
-       size_t   write_var_len(uint32_t val);
-       uint32_t read_var_len() const;
-       int      read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const;
-
-       static const uint16_t _ppqn = 19200;
-
-       Glib::ustring  _path;
-       Flag           _flags;
-       string         _take_id;
-       bool           _allow_remove_if_empty;
-       FILE*          _fd;
-       double         _last_ev_time; ///< last frame time written, relative to source start
-       uint32_t       _track_size;
-       uint32_t       _header_size; ///< size of SMF header, including MTrk chunk header
-       bool           _empty; ///< true iff file contains (non-empty) events
-
-       static string _search_path;
 };
 
 }; /* namespace ARDOUR */
 
-#endif /* __ardour_smf_filesource_h__ */
+#endif /* __ardour_smf_source_h__ */