midi_port.h

Go to the documentation of this file.

/*
    Copyright (C) 2002 Paul Davis

    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.

    $Id: port.h 712 2006-07-28 01:08:57Z drobilla $
*/

#ifndef __ardour_midi_port_h__
#define __ardour_midi_port_h__

#include "midi++/parser.h"

#include "ardour/port.h"

namespace ARDOUR {

class MidiBuffer;
class MidiEngine;

class LIBARDOUR_API MidiPort : public Port {
   public:
        ~MidiPort();

        DataType type () const {
                return DataType::MIDI;
        }

        void cycle_start (pframes_t nframes);
        void cycle_end (pframes_t nframes);
        void cycle_split ();

        void flush_buffers (pframes_t nframes);
        void transport_stopped ();
        void realtime_locate ();
        void reset ();
        void require_resolve ();

        bool input_active() const { return _input_active; }
        void set_input_active (bool yn);

        Buffer& get_buffer (pframes_t nframes);

        MidiBuffer& get_midi_buffer (pframes_t nframes);

        void set_always_parse (bool yn);
        void set_trace_on (bool yn);
        
        MIDI::Parser& self_parser() { return _self_parser; }

  protected:
        friend class PortManager;

        MidiPort (const std::string& name, PortFlags);

  private:
        MidiBuffer* _buffer;
        bool        _has_been_mixed_down;
        bool        _resolve_required;
        bool        _input_active;
        bool        _always_parse;
        bool        _trace_on;
        
    /* Naming this is tricky. AsyncMIDIPort inherits (for now, aug 2013) from
     * both MIDI::Port, which has _parser, and this (ARDOUR::MidiPort). We
     * need parsing support in this object, independently of what the
     * MIDI::Port/AsyncMIDIPort stuff does. Rather than risk errors coming
     * from not explicitly naming which _parser we want, we will call this
     * _self_parser for now.
     *
     * Ultimately, MIDI::Port should probably go away or be fully integrated
     * into this object, somehow.
     */

        MIDI::Parser _self_parser;

        void resolve_notes (void* buffer, framepos_t when);
};

} // namespace ARDOUR

#endif /* __ardour_midi_port_h__ */