midi_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_midi_source_h__
#define __ardour_midi_source_h__

#include <string>
#include <time.h>
#include <glibmm/threads.h>
#include <boost/enable_shared_from_this.hpp>
#include "pbd/stateful.h"
#include "pbd/xml++.h"
#include "evoral/Sequence.hpp"
#include "ardour/ardour.h"
#include "ardour/buffer.h"
#include "ardour/source.h"
#include "ardour/beats_frames_converter.h"

namespace ARDOUR {

class MidiChannelFilter;
class MidiStateTracker;
class MidiModel;

template<typename T> class MidiRingBuffer;

class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
{
  public:
        typedef Evoral::Beats TimeType;

        MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
        MidiSource (Session& session, const XMLNode&);
        virtual ~MidiSource ();

        int write_to (const Lock&                   lock,
                      boost::shared_ptr<MidiSource> newsrc,
                      Evoral::Beats                 begin = Evoral::MinBeats,
                      Evoral::Beats                 end   = Evoral::MaxBeats);

        virtual framecnt_t midi_read (const Lock&                        lock,
                                      Evoral::EventSink<framepos_t>&     dst,
                                      framepos_t                         source_start,
                                      framepos_t                         start,
                                      framecnt_t                         cnt,
                                      MidiStateTracker*                  tracker,
                                      MidiChannelFilter*                 filter,
                                      const std::set<Evoral::Parameter>& filtered) const;

        virtual framecnt_t midi_write (const Lock&                 lock,
                                       MidiRingBuffer<framepos_t>& src,
                                       framepos_t                  source_start,
                                       framecnt_t                  cnt);

        virtual void append_event_beats(const Lock&                         lock,
                                        const Evoral::Event<Evoral::Beats>& ev) = 0;

        virtual void append_event_frames(const Lock&                      lock,
                                         const Evoral::Event<framepos_t>& ev,
                                         framepos_t                       source_start) = 0;

        virtual bool       empty () const;
        virtual framecnt_t length (framepos_t pos) const;
        virtual void       update_length (framecnt_t);

        virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
        virtual void mark_streaming_write_started (const Lock& lock);
        virtual void mark_streaming_write_completed (const Lock& lock);

        void mark_write_starting_now (framecnt_t position,
                                      framecnt_t capture_length,
                                      framecnt_t loop_length);

        /* like ::mark_streaming_write_completed() but with more arguments to
         * allow control over MIDI-specific behaviour. Expected to be used only
         * when recording actual MIDI input, rather then when importing files
         * etc.
         */
        virtual void mark_midi_streaming_write_completed (
                const Lock&                                      lock,
                Evoral::Sequence<Evoral::Beats>::StuckNoteOption stuck_option,
                Evoral::Beats                                    when = Evoral::Beats());

        virtual void session_saved();

        std::string captured_for() const               { return _captured_for; }
        void        set_captured_for (std::string str) { _captured_for = str; }

        static PBD::Signal1<void,MidiSource*> MidiSourceCreated;

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

        bool length_mutable() const { return true; }

        void     set_length_beats(TimeType l) { _length_beats = l; }
        TimeType length_beats() const         { return _length_beats; }

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

        void invalidate(const Glib::Threads::Mutex::Lock&                       lock,
                        std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes=NULL);

        void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);

        boost::shared_ptr<MidiModel> model() { return _model; }
        void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
        void drop_model(const Glib::Threads::Mutex::Lock& lock);

        Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
        void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
        void copy_interpolation_from (boost::shared_ptr<MidiSource>);
        void copy_interpolation_from (MidiSource *);

        AutoState automation_state_of (Evoral::Parameter) const;
        void set_automation_state_of (Evoral::Parameter, AutoState);
        void copy_automation_state_from (boost::shared_ptr<MidiSource>);
        void copy_automation_state_from (MidiSource *);

        PBD::Signal0<void> ModelChanged;
        PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
        PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;

  protected:
        virtual void flush_midi(const Lock& lock) = 0;

        virtual 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 = 0;

        virtual framecnt_t write_unlocked (const Lock&                 lock,
                                           MidiRingBuffer<framepos_t>& source,
                                           framepos_t                  position,
                                           framecnt_t                  cnt) = 0;

        std::string _captured_for;

        boost::shared_ptr<MidiModel> _model;
        bool                         _writing;

        mutable Evoral::Sequence<Evoral::Beats>::const_iterator _model_iter;
        mutable bool                                            _model_iter_valid;

        mutable Evoral::Beats _length_beats;
        mutable framepos_t    _last_read_end;

        framepos_t _capture_length;

        framepos_t _capture_loop_length;

        typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
        InterpolationStyleMap _interpolation_style;

        typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
        AutomationStateMap  _automation_state;
};

}

#endif /* __ardour_midi_source_h__ */