JogShuttle Class Reference

Class to encapsulate an abstract JogShuttle device. More...

#include <jogshuttle.h>

Collaboration diagram for JogShuttle:

[legend]List of all members.

Public Member Functions
	~JogShuttle ()
	Destructor.
bool	start ()
	Start the GDK input handler if enabled.
void	stop ()
	Stop the GDK input handler.
void	registerCallback (void *user, JogShuttleCallback callback)
	Register callback.
void	deregisterCallback ()
	Deegister callback.
media_ctrl_key *	getKeyset ()
Static Public Member Functions
static JogShuttle &	getInstance ()
	Singleton getInstance method.
Protected Member Functions
void	inputCallback (gint source, GdkInputCondition condition)
	The GDK input callback function.
	JogShuttle ()
	Constructor.
Private Member Functions
void	jog (int dir)
	Handle movement on the jog dial.
void	shuttle (int angle)
	Handle movement of the shuttle ring.
void	button (struct media_ctrl_event *)
	Handle key press.
void	button_old (int code)
Private Attributes
JogShuttleCallback	_callback
	Placeholder for callbacks.
void *	_callbackdata
	Any client supplied callbackdata is here.
media_ctrl	_ctrl
int	input_
gint	monitorTag_
unsigned short	_modifier_code
media_ctrl_key *	_modifier
Static Private Attributes
static JogShuttle *	_instance = NULL
	Singleton pattern.
Friends
void	JogShuttle_inputCallback (gpointer data, gint source, GdkInputCondition condition)
	A C wrappper for the GDK input handler callback.

---

Detailed Description

Class to encapsulate an abstract JogShuttle device.

This class is used by the kino core to interact with a JogShuttle device. (Also used by the preference dialog for configuration). It depends on the GDK input system, and uses the libmediactrl stuff to translate different (more or less broken) devices events into something that resembles the linux event system. It also keeps track of modifier keys, that is, up to two keys pressed in succesion.

Definition at line 49 of file jogshuttle.h.

---

Constructor & Destructor Documentation

JogShuttle::JogShuttle (   )  [protected]

Constructor. Definition at line 126 of file jogshuttle.cc. References _ctrl, media_ctrl::device, and start(). Referenced by getInstance(). : _callback( NULL ), input_( -1 ), monitorTag_( -1 ), _modifier_code( 0 ) { _ctrl.device = NULL; start(); }

JogShuttle::~JogShuttle (   )

Destructor. Remove the callback function from the GDK input handler. Definition at line 140 of file jogshuttle.cc. References _ctrl, input_, media_ctrl_close(), and monitorTag_. { if ( input_ >= 0 ) { gdk_input_remove( monitorTag_ ); media_ctrl_close(&_ctrl); } }

---

Member Function Documentation

void JogShuttle::button (  struct media_ctrl_event *  ev  )  [private]

Handle key press. Parameters: ev  The key event Modifier keys - we maintain the state of the first key that is pressed down. This is a "poor man"s way of doing modifier keys. It means that we can press a single key, keep it down, and press a number of others. Any key can be used as a modifier key, although you would probably want to not assign an action to a modifier key when first pressed. There is no way to react to multiple modifier keys though. Definition at line 267 of file jogshuttle.cc. References _callback, _callbackdata, _modifier_code, media_ctrl_key::action, media_ctrl_event::code, Preferences::getInstance(), media_ctrl_event::index, KEY_RELEASE, processCommand(), and media_ctrl_event::value. Referenced by inputCallback(). { /* Figure out what codes to use */ unsigned short first; unsigned short second; /* Release may need to clear a modifier key */ if ( ev->value == KEY_RELEASE && _modifier_code != 0 ) { _modifier_code = 0; return; } /* Do a callback or action based command */ if ( _callback != NULL ) { /* This is a key press - if there are no modifier, make sure that this is saved */ if ( _modifier_code == 0 ) _modifier_code = ev->index + 1; if ( _modifier_code != ev->index + 1 ) { first = _modifier_code - 1; second = ev->index + 1; } else { first = ev->index; /* Same as modifier */ second = 0; } _callback( _callbackdata, first, second ); } else { /* This is a key press - if there are no modifier, make sure that this is saved */ if ( _modifier_code == 0 ) _modifier_code = ev->code; if ( _modifier_code != ev->code ) { first = _modifier_code; second = ev->code; } else { first = ev->code; /* Same as modifier */ second = 0; } /* Get the action from the prefs */ string action = Preferences::getInstance()._JogShuttleMappings[ make_pair( first, second ) ]._action; if ( "" != action ) { gdk_threads_enter(); processCommand( ( char * ) action.c_str() ); gdk_threads_leave(); } } return ; }

void JogShuttle::button_old (  int  code  )  [private]

void JogShuttle::deregisterCallback (   )

Deegister callback. Deregister an interest in getting notification when buttons are pressed Parameters: callback  Function to stop calling Definition at line 206 of file jogshuttle.cc. References _callback. { if ( _callback == NULL ) g_warning( "JogShuttle::deregisterCallback - not registered\n" ); _callback = NULL; }

JogShuttle & JogShuttle::getInstance (   )  [static]

Singleton getInstance method. Standard pattern. Non-threadsafe, but first instance gets called from the commands.cc which should be OK. Definition at line 117 of file jogshuttle.cc. References _instance, and JogShuttle(). Referenced by kinoInitialise(), on_checkbutton_jogshuttle_toggled(), on_optionmenu_jogshuttle_action_clicked(), on_optionmenu_jogshuttle_firstsecond_button_clicked(), on_preferences_activate(), on_preferences_dialog_cancel_button_clicked(), on_preferences_dialog_destroy_event(), on_preferences_dialog_ok_button_clicked(), and startJogShuttle(). { if ( _instance == NULL ) _instance = new JogShuttle(); return *_instance; }

struct media_ctrl_key * JogShuttle::getKeyset (   )

Definition at line 213 of file jogshuttle.cc. References _ctrl, media_ctrl::device, and media_ctrl_device::keys. { if ( _ctrl.device != NULL ) return _ctrl.device->keys; else return NULL; }

void JogShuttle::inputCallback (  gint  source, GdkInputCondition  condition )  [protected]

The GDK input callback function. GDK calls this whenever input is received. It is hooked into the system during object construction. Definition at line 344 of file jogshuttle.cc. References _ctrl, button(), media_ctrl_event::code, jog(), MEDIA_CTRL_EVENT_JOG, MEDIA_CTRL_EVENT_KEY, MEDIA_CTRL_EVENT_NONE, MEDIA_CTRL_EVENT_SHUTTLE, media_ctrl_read_event(), shuttle(), stop(), media_ctrl_event::type, and media_ctrl_event::value. Referenced by JogShuttle_inputCallback(). { g_return_if_fail( this != NULL ); // g_return_if_fail( input_ >= 0 ); // g_return_if_fail( input_ == source ); if ( condition != GDK_INPUT_READ ) stop(); g_return_if_fail( condition == GDK_INPUT_READ ); struct media_ctrl_event ev; ev.type = MEDIA_CTRL_EVENT_NONE; media_ctrl_read_event(&_ctrl, &ev); /* We can get four "kinds" of events: ev.type == MEDIA_CTRL_EVENT_NONE (0x00) An event that actually isnt one... Since we read every event from the input subsystem, we sometimes get double events (e.g. the shuttlepro reports its state approx. every second.) libmediactrl translates these events to none-events. ev.type == MEDIA_CTRL_EVENT_KEY (0x01) This is a button press. The whole event will be handled in the button method.. ev.type == MEDIA_CTRL_EVENT_JOG (0x02) This event is issued when ever the dial position changes. ev.value is the offset to the current jog position. - ev.code == EDIA_CTRL_EVENT_SHUTTLE (0x02) the outer wheel ev.value indicates the position, with positive values from 0x01 to 0x0f (inclusive) indicating clockwise twist, and negative values from -1 to -15 indicating counterclockwise twist. A 0 value is reported. */ if ( ev.type == MEDIA_CTRL_EVENT_NONE ) return; #if 0 printf( "JogShuttle: %02x %02x %02d\n", ev.type, ev.code, ev.value ); #endif if ( ev.type == MEDIA_CTRL_EVENT_JOG ) { this->jog( CLAMP( ev.value, -1, 1 ) ); } else if ( ev.type == MEDIA_CTRL_EVENT_SHUTTLE ) { this->shuttle( ev.value ); } else if ( ev.type == MEDIA_CTRL_EVENT_KEY ) { this->button( &ev ); } else { return; } }

void JogShuttle::jog (  int  offs  )  [private]

Handle movement on the jog dial. Parameters: dir  A number from -x to x to specify the offset from the current frame. A negative number moves backward. Typically, x is 1 to step frame-by-frame. Definition at line 229 of file jogshuttle.cc. References videoBackBy(), and videoForwardBy(). Referenced by inputCallback(). { gdk_threads_enter(); if ( offs < 0 ) videoBackBy(offs); else videoForwardBy(offs); gdk_threads_leave(); }

void JogShuttle::registerCallback (  void *  user, JogShuttleCallback  callback )

Register callback. Register an interest in getting notification when buttons are pressed Parameters: callback  Function to call Definition at line 192 of file jogshuttle.cc. References _callback, and _callbackdata. { if ( _callback ) g_warning( "JogShuttle::registerCallback - already registered\n" ); _callback = callback; _callbackdata = user; }

void JogShuttle::shuttle (  int  angle  )  [private]

Handle movement of the shuttle ring. Parameters: angle  A number from -8 to 8 that speccifies a direction and speed. Definition at line 243 of file jogshuttle.cc. References videoShuttle(). Referenced by inputCallback(). { /*if ( angle > 0 ) angle--; if ( angle < 0 ) angle++; */ gdk_threads_enter(); videoShuttle( angle ); gdk_threads_leave(); }

bool JogShuttle::start (   )

Start the GDK input handler if enabled. Returns: a boolean indicating if not started due to not enabled or device open failed. Definition at line 154 of file jogshuttle.cc. References _ctrl, media_ctrl::device, Preferences::enableJogShuttle, media_ctrl::fd, Preferences::getInstance(), JogShuttle_inputCallback, media_ctrl_open(), monitorTag_, and stop(). Referenced by JogShuttle(). { Preferences & prefs = Preferences::getInstance(); if ( prefs.enableJogShuttle ) { stop(); media_ctrl_open( &_ctrl ); if ( _ctrl.device ) { monitorTag_ = gdk_input_add( _ctrl.fd, GDK_INPUT_READ, JogShuttle_inputCallback, ( gpointer ) this ); return true; } } return false; }

void JogShuttle::stop (   )

Stop the GDK input handler. Definition at line 175 of file jogshuttle.cc. References _ctrl, media_ctrl::device, media_ctrl_close(), and monitorTag_. Referenced by inputCallback(), and start(). { if ( monitorTag_ != -1 ) { gdk_input_remove( monitorTag_ ); monitorTag_ = -1; } if ( _ctrl.device ) media_ctrl_close( &_ctrl ); }

---

Friends And Related Function Documentation

void JogShuttle_inputCallback (  gpointer  data, gint  source, GdkInputCondition  condition )  [friend]

A C wrappper for the GDK input handler callback. Definition at line 99 of file jogshuttle.cc. Referenced by start(). { JogShuttle * js = static_cast<JogShuttle *>( data ); g_return_if_fail( js != NULL ); js->inputCallback( source, condition ); }

---

Member Data Documentation

JogShuttleCallback JogShuttle::_callback [private]

Placeholder for callbacks. Definition at line 55 of file jogshuttle.h. Referenced by button(), deregisterCallback(), and registerCallback().

void* JogShuttle::_callbackdata [private]

Any client supplied callbackdata is here. Definition at line 57 of file jogshuttle.h. Referenced by button(), and registerCallback().

struct media_ctrl JogShuttle::_ctrl [private]

Definition at line 80 of file jogshuttle.h. Referenced by getKeyset(), inputCallback(), JogShuttle(), start(), stop(), and ~JogShuttle().

JogShuttle * JogShuttle::_instance = NULL [static, private]

Singleton pattern. It is accesible to other classes via the getInstance method. Definition at line 111 of file jogshuttle.cc. Referenced by getInstance().

media_ctrl_key* JogShuttle::_modifier [private]

Definition at line 87 of file jogshuttle.h.

unsigned short JogShuttle::_modifier_code [private]

Definition at line 86 of file jogshuttle.h. Referenced by button().

int JogShuttle::input_ [private]

Definition at line 81 of file jogshuttle.h. Referenced by ~JogShuttle().

gint JogShuttle::monitorTag_ [private]

Definition at line 82 of file jogshuttle.h. Referenced by start(), stop(), and ~JogShuttle().

---

The documentation for this class was generated from the following files:

• jogshuttle.h
• jogshuttle.cc

---