/* This file is part of Om.  Copyright (C) 2006 Dave Robillard.
 * 
 * Om 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.
 * 
 * Om 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 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.,
 * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef MIDIDRIVER_H
#define MIDIDRIVER_H

#include "Driver.h"
#include <iostream>
using std::cout; using std::endl;

namespace Om {

class MidiMessage;


/** Midi driver abstract base class.
 *
 * \ingroup engine
 */
class MidiDriver : public Driver<MidiMessage>
{
public:
	/** Prepare events (however neccessary) for the specified block (realtime safe) */
	virtual void prepare_block(const samplecount block_start, const samplecount block_end) = 0;
};



/** Dummy MIDIDriver.
 *
 * Not abstract, all functions are dummies.  One of these will be allocated and
 * "used" if no working MIDI driver is loaded.  (Doing it this way as opposed to
 * just making MidiDriver have dummy functions makes sure any existing MidiDriver
 * derived class actually implements the required functions).
 *
 * \ingroup engine
 */
class DummyMidiDriver : public MidiDriver
{
public:
	DummyMidiDriver() {
		cout << "[DummyMidiDriver] Started Dummy MIDI driver." << endl;
	}
	
	~DummyMidiDriver() {}

	void activate()   {}
	void deactivate() {}
	
	bool is_activated() const { return false; }
	bool is_enabled()   const { return false; }
	
	void enable()  {}
	void disable() {}
	
	DriverPort* create_port(DuplexPort<MidiMessage>* patch_port) { return NULL; }
	
	void prepare_block(const samplecount block_start, const samplecount block_end) {}
};



} // namespace Om

#endif // MIDIDRIVER_H