smf_source.h

Go to the documentation of this file.

/*
    Copyright (C) 2006 Paul Davis
    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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#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"

namespace Evoral { template<typename T> class Event; }

namespace ARDOUR {

template<typename T> class MidiRingBuffer;

class LIBARDOUR_API SMFSource : public MidiSource, public FileSource, public Evoral::SMF {
public:
        SMFSource (Session& session, const std::string& path, Source::Flag flags);

        SMFSource (Session& session, const std::string& path);

        SMFSource (Session& session, const XMLNode&, bool must_exist = false);

        virtual ~SMFSource ();

        bool safe_file_extension (const std::string& path) const {
                return safe_midi_file_extension(path);
        }

        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 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());

        XMLNode& get_state ();
        int set_state (const XMLNode&, int version);

        void load_model (const Glib::Threads::Mutex::Lock& lock, bool force_reload=false);
        void destroy_model (const Glib::Threads::Mutex::Lock& lock);

        static bool safe_midi_file_extension (const std::string& path);
        static bool valid_midi_file (const std::string& path);

        void prevent_deletion ();

  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;
        mutable framepos_t _smf_last_read_end;
        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);

};

}; /* namespace ARDOUR */

#endif /* __ardour_smf_source_h__ */