src/Input/FGJoystickInput.cxx

   1 // FGJoystickInput.cxx -- handle user input from joystick devices
   2 //
   3 // Written by Torsten Dreyer, started August 2009
   4 // Based on work from David Megginson, started May 2001.
   5 //
   6 // Copyright (C) 2009 Torsten Dreyer, Torsten (at) t3r _dot_ de
   7 // Copyright (C) 2001 David Megginson, david@megginson.com
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 // $Id$
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include "config.h"
  27 #endif
  28
  29 #include "FGJoystickInput.hxx"
  30
  31 #include <simgear/props/props_io.hxx>
  32 #include "FGDeviceConfigurationMap.hxx"
  33 #include <Main/fg_props.hxx>
  34 #include <Scripting/NasalSys.hxx>
  35 #include <boost/foreach.hpp>
  36
  37 using simgear::PropertyList;
  38
  39 FGJoystickInput::axis::axis ()
  40   : last_value(9999999),
  41     tolerance(0.002),
  42     low_threshold(-0.9),
  43     high_threshold(0.9),
  44     interval_sec(0),
  45     last_dt(0)
  46 {
  47 }
  48
  49 FGJoystickInput::axis::~axis ()
  50 {
  51 }
  52
  53 FGJoystickInput::joystick::joystick ()
  54   : jsnum(0),
  55     js(0),
  56     naxes(0),
  57     nbuttons(0),
  58     axes(0),
  59     buttons(0),
  60     predefined(true)
  61 {
  62 }
  63
  64 FGJoystickInput::joystick::~joystick ()
  65 {
  66   //  delete js? no, since js == this - and we're in the destructor already.
  67   delete[] axes;
  68   delete[] buttons;
  69   jsnum = 0;
  70   js = NULL;
  71   naxes = 0;
  72   nbuttons = 0;
  73   axes = NULL;
  74   buttons = NULL;
  75 }
  76
  77
  78 FGJoystickInput::FGJoystickInput()
  79 {
  80 }
  81
  82 FGJoystickInput::~FGJoystickInput()
  83 {
  84     _remove(true);
  85 }
  86
  87 void FGJoystickInput::_remove(bool all)
  88 {
  89     SGPropertyNode * js_nodes = fgGetNode("/input/joysticks", true);
  90
  91     for (int i = 0; i < MAX_JOYSTICKS; i++)
  92     {
  93         // do not remove predefined joysticks info on reinit
  94         if ((all)||(!bindings[i].predefined))
  95             js_nodes->removeChild("js", i, false);
  96         if (bindings[i].js)
  97             delete bindings[i].js;
  98         bindings[i].js = NULL;
  99     }
 100 }
 101
 102 void FGJoystickInput::init()
 103 {
 104   jsInit();
 105   SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick bindings");
 106   SGPropertyNode_ptr js_nodes = fgGetNode("/input/joysticks", true);
 107
 108   FGDeviceConfigurationMap configMap("Input/Joysticks", js_nodes, "js-named");
 109
 110   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 111     jsJoystick * js = new jsJoystick(i);
 112     bindings[i].js = js;
 113
 114     if (js->notWorking()) {
 115       SG_LOG(SG_INPUT, SG_DEBUG, "Joystick " << i << " not found");
 116       continue;
 117     }
 118
 119     const char * name = js->getName();
 120     SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
 121
 122     if (js_node) {
 123       SG_LOG(SG_INPUT, SG_INFO, "Using existing bindings for joystick " << i);
 124
 125     } else {
 126       bindings[i].predefined = false;
 127       SG_LOG(SG_INPUT, SG_INFO, "Looking for bindings for joystick \"" << name << '"');
 128       SGPropertyNode_ptr named;
 129
 130       if ((named = configMap[name])) {
 131         string source = named->getStringValue("source", "user defined");
 132         SG_LOG(SG_INPUT, SG_INFO, "... found joystick: " << source);
 133
 134       } else if ((named = configMap["default"])) {
 135         string source = named->getStringValue("source", "user defined");
 136         SG_LOG(SG_INPUT, SG_INFO, "No config found for joystick \"" << name
 137             << "\"\nUsing default: \"" << source << '"');
 138
 139       } else {
 140         SG_LOG(SG_INPUT, SG_WARN, "No joystick configuration file with <name>" << name << "</name> entry found!");
 141       }
 142
 143       js_node = js_nodes->getChild("js", i, true);
 144       copyProperties(named, js_node);
 145       js_node->setStringValue("id", name);
 146     }
 147   }
 148 }
 149
 150 void FGJoystickInput::reinit() {
 151   SG_LOG(SG_INPUT, SG_DEBUG, "Re-Initializing joystick bindings");
 152   _remove(false);
 153   FGJoystickInput::init();
 154   FGJoystickInput::postinit();
 155 }
 156
 157 void FGJoystickInput::postinit()
 158 {
 159   FGNasalSys *nasalsys = (FGNasalSys *)globals->get_subsystem("nasal");
 160   SGPropertyNode_ptr js_nodes = fgGetNode("/input/joysticks");
 161
 162   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 163     SGPropertyNode_ptr js_node = js_nodes->getChild("js", i);
 164     jsJoystick *js = bindings[i].js;
 165     if (!js_node || js->notWorking())
 166       continue;
 167
 168 #ifdef WIN32
 169     JOYCAPS jsCaps ;
 170     joyGetDevCaps( i, &jsCaps, sizeof(jsCaps) );
 171     unsigned int nbuttons = jsCaps.wNumButtons;
 172     if (nbuttons > MAX_JOYSTICK_BUTTONS) nbuttons = MAX_JOYSTICK_BUTTONS;
 173 #else
 174     unsigned int nbuttons = MAX_JOYSTICK_BUTTONS;
 175 #endif
 176
 177     int naxes = js->getNumAxes();
 178     if (naxes > MAX_JOYSTICK_AXES) naxes = MAX_JOYSTICK_AXES;
 179     bindings[i].naxes = naxes;
 180     bindings[i].nbuttons = nbuttons;
 181
 182     SG_LOG(SG_INPUT, SG_DEBUG, "Initializing joystick " << i);
 183
 184                                 // Set up range arrays
 185     float minRange[MAX_JOYSTICK_AXES];
 186     float maxRange[MAX_JOYSTICK_AXES];
 187     float center[MAX_JOYSTICK_AXES];
 188
 189                                 // Initialize with default values
 190     js->getMinRange(minRange);
 191     js->getMaxRange(maxRange);
 192     js->getCenter(center);
 193
 194                                 // Allocate axes and buttons
 195     bindings[i].axes = new axis[naxes];
 196     bindings[i].buttons = new FGButton[nbuttons];
 197
 198     //
 199     // Initialize nasal groups.
 200     //
 201     std::ostringstream str;
 202     str << "__js" << i;
 203     string module = str.str();
 204     nasalsys->createModule(module.c_str(), module.c_str(), "", 0);
 205
 206     PropertyList nasal = js_node->getChildren("nasal");
 207     unsigned int j;
 208     for (j = 0; j < nasal.size(); j++) {
 209       nasal[j]->setStringValue("module", module.c_str());
 210       nasalsys->handleCommand(nasal[j]);
 211     }
 212
 213     //
 214     // Initialize the axes.
 215     //
 216     PropertyList axes = js_node->getChildren("axis");
 217     size_t nb_axes = axes.size();
 218     for (j = 0; j < nb_axes; j++ ) {
 219       const SGPropertyNode * axis_node = axes[j];
 220       const SGPropertyNode * num_node = axis_node->getChild("number");
 221       int n_axis = axis_node->getIndex();
 222       if (num_node != 0) {
 223           n_axis = num_node->getIntValue(TGT_PLATFORM, -1);
 224
 225         #ifdef SG_MAC
 226           // Mac falls back to Unix by default - avoids specifying many
 227           // duplicate <mac> entries in joystick config files
 228           if (n_axis < 0) {
 229               n_axis = num_node->getIntValue("unix", -1);
 230           }
 231         #endif
 232
 233           // Silently ignore platforms that are not specified within the
 234           // <number></number> section
 235           if (n_axis < 0) {
 236               continue;
 237           }
 238       }
 239
 240       if (n_axis >= naxes) {
 241           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for axis " << n_axis);
 242           continue;
 243       }
 244       axis &a = bindings[i].axes[n_axis];
 245
 246       js->setDeadBand(n_axis, axis_node->getDoubleValue("dead-band", 0.0));
 247
 248       a.tolerance = axis_node->getDoubleValue("tolerance", 0.002);
 249       minRange[n_axis] = axis_node->getDoubleValue("min-range", minRange[n_axis]);
 250       maxRange[n_axis] = axis_node->getDoubleValue("max-range", maxRange[n_axis]);
 251       center[n_axis] = axis_node->getDoubleValue("center", center[n_axis]);
 252
 253       read_bindings(axis_node, a.bindings, KEYMOD_NONE, module );
 254
 255       // Initialize the virtual axis buttons.
 256       a.low.init(axis_node->getChild("low"), "low", module );
 257       a.low_threshold = axis_node->getDoubleValue("low-threshold", -0.9);
 258
 259       a.high.init(axis_node->getChild("high"), "high", module );
 260       a.high_threshold = axis_node->getDoubleValue("high-threshold", 0.9);
 261       a.interval_sec = axis_node->getDoubleValue("interval-sec",0.0);
 262       a.last_dt = 0.0;
 263     }
 264
 265     //
 266     // Initialize the buttons.
 267     //
 268     PropertyList buttons = js_node->getChildren("button");
 269     BOOST_FOREACH( SGPropertyNode * button_node, buttons ) {
 270       size_t n_but = button_node->getIndex();
 271
 272       const SGPropertyNode * num_node = button_node->getChild("number");
 273       if (NULL != num_node)
 274           n_but = num_node->getIntValue(TGT_PLATFORM,n_but);
 275
 276       if (n_but >= nbuttons) {
 277           SG_LOG(SG_INPUT, SG_DEBUG, "Dropping bindings for button " << n_but);
 278           continue;
 279       }
 280
 281       std::ostringstream buf;
 282       buf << (unsigned)n_but;
 283
 284       SG_LOG(SG_INPUT, SG_DEBUG, "Initializing button " << buf.str());
 285       FGButton &b = bindings[i].buttons[n_but];
 286       b.init(button_node, buf.str(), module );
 287       // get interval-sec property
 288       b.interval_sec = button_node->getDoubleValue("interval-sec",0.0);
 289       b.last_dt = 0.0;
 290     }
 291
 292     js->setMinRange(minRange);
 293     js->setMaxRange(maxRange);
 294     js->setCenter(center);
 295   }
 296 }
 297
 298 void FGJoystickInput::update( double dt )
 299 {
 300   float axis_values[MAX_JOYSTICK_AXES];
 301   int modifiers = fgGetKeyModifiers();
 302   int buttons;
 303
 304   for (int i = 0; i < MAX_JOYSTICKS; i++) {
 305
 306     jsJoystick * js = bindings[i].js;
 307     if (js == 0 || js->notWorking())
 308       continue;
 309
 310     js->read(&buttons, axis_values);
 311     if (js->notWorking()) // If js is disconnected
 312       continue;
 313
 314                                 // Fire bindings for the axes.
 315     for (int j = 0; j < bindings[i].naxes; j++) {
 316       axis &a = bindings[i].axes[j];
 317
 318                                 // Do nothing if the axis position
 319                                 // is unchanged; only a change in
 320                                 // position fires the bindings.
 321                                 // But only if there are bindings
 322       if (fabs(axis_values[j] - a.last_value) > a.tolerance
 323          && a.bindings[KEYMOD_NONE].size() > 0 ) {
 324         a.last_value = axis_values[j];
 325         for (unsigned int k = 0; k < a.bindings[KEYMOD_NONE].size(); k++)
 326           a.bindings[KEYMOD_NONE][k]->fire(axis_values[j]);
 327       }
 328
 329                                 // do we have to emulate axis buttons?
 330       a.last_dt += dt;
 331       if(a.last_dt >= a.interval_sec) {
 332         if (a.low.bindings[modifiers].size())
 333           bindings[i].axes[j].low.update( modifiers, axis_values[j] < a.low_threshold );
 334
 335         if (a.high.bindings[modifiers].size())
 336           bindings[i].axes[j].high.update( modifiers, axis_values[j] > a.high_threshold );
 337
 338         a.last_dt -= a.interval_sec;
 339       }
 340     }
 341
 342                                 // Fire bindings for the buttons.
 343     for (int j = 0; j < bindings[i].nbuttons; j++) {
 344       FGButton &b = bindings[i].buttons[j];
 345       b.last_dt += dt;
 346       if(b.last_dt >= b.interval_sec) {
 347         bindings[i].buttons[j].update( modifiers, (buttons & (1u << j)) > 0 );
 348         b.last_dt -= b.interval_sec;
 349       }
 350     }
 351   }
 352 }
 353