/* 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 OSCRECEIVER_H
#define OSCRECEIVER_H

#include "config.h"
#include <string>
#include <lo/lo.h>
#include "QueuedEngineInterface.h"
#include "OSCResponder.h"
using std::string;

namespace Om {

class JackDriver;
class NodeFactory;
class Patch;


/* Some boilerplate killing macros... */
#define LO_HANDLER_ARGS const char* path, const char* types, lo_arg** argv, int argc, lo_message msg

/* Defines a static handler to be passed to lo_add_method, which is a trivial
 * wrapper around a non-static method that does the real work.  Makes a whoole
 * lot of ugly boiler plate go away */
#define LO_HANDLER(name) \
int m_##name##_cb (LO_HANDLER_ARGS);\
inline static int name##_cb(LO_HANDLER_ARGS, void* osc_receiver)\
{ return ((OSCReceiver*)osc_receiver)->m_##name##_cb(path, types, argv, argc, msg); }



/** Receives OSC messages from liblo.
 *
 * This inherits from QueuedEngineInterface and calls it's own functions
 * via OSC.  It's not actually a directly callable EngineInterface (it's
 * callable via OSC...) so it is-implemented-as-a (privately inherits)
 * QueuedEngineInterface.
 *
 * \ingroup engine
 */
class OSCReceiver : private QueuedEngineInterface
{
public:
	OSCReceiver(size_t queue_size, const char* const port);
	~OSCReceiver();

	void start();
	void stop();

private:
	// Prevent copies (undefined)
	OSCReceiver(const OSCReceiver&);
	OSCReceiver& operator=(const OSCReceiver&);
	
	static void error_cb(int num, const char* msg, const char* path);	
	static int  set_response_address_cb(LO_HANDLER_ARGS, void* osc_receiver);
	static int  generic_cb(LO_HANDLER_ARGS, void* osc_receiver);
	static int  unknown_cb(LO_HANDLER_ARGS, void* osc_receiver);

	LO_HANDLER(quit);
	LO_HANDLER(ping);
	LO_HANDLER(ping_slow);
	LO_HANDLER(register_client);
	LO_HANDLER(unregister_client);
	LO_HANDLER(load_plugins);
	LO_HANDLER(engine_activate);
	LO_HANDLER(engine_deactivate);
	LO_HANDLER(create_patch);
	LO_HANDLER(rename);
	LO_HANDLER(create_node);
	LO_HANDLER(create_node_by_uri);
	LO_HANDLER(enable_patch);
	LO_HANDLER(disable_patch);
	LO_HANDLER(clear_patch);
	LO_HANDLER(destroy);
	LO_HANDLER(connect);
	LO_HANDLER(disconnect);
	LO_HANDLER(disconnect_all);
	LO_HANDLER(set_port_value);
	LO_HANDLER(set_port_value_voice);
	LO_HANDLER(set_port_value_slow);
	LO_HANDLER(note_on);
	LO_HANDLER(note_off);
	LO_HANDLER(all_notes_off);
	LO_HANDLER(midi_learn);
	LO_HANDLER(metadata_get);
	LO_HANDLER(metadata_set);
	LO_HANDLER(request_plugins);
	LO_HANDLER(request_all_objects);
	LO_HANDLER(request_port_value);
#ifdef HAVE_DSSI
	LO_HANDLER(dssi);
#endif
#ifdef HAVE_LASH
	LO_HANDLER(lash_restore_done);
#endif	

	const char* const _port;
	bool              _is_activated;
	lo_server_thread  _st;

	/** Cached OSC responder (for most recent incoming message) */
	CountedPtr<OSCResponder> _osc_responder;
};


} // namespace Om

#endif // OSCRECEIVER_H