src/AIModel/AIMultiplayer.cxx

   1 // FGAIMultiplayer - FGAIBase-derived class creates an AI multiplayer aircraft
   2 //
   3 // Based on FGAIAircraft
   4 // Written by David Culp, started October 2003.
   5 // Also by Gregor Richards, started December 2005.
   6 //
   7 // Copyright (C) 2003  David P. Culp - davidculp2@comcast.net
   8 // Copyright (C) 2005  Gregor Richards
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <string>
  29
  30 #include "AIMultiplayer.hxx"
  31
  32 #include <simgear/scene/util/SGNodeMasks.hxx>
  33
  34 // #define SG_DEBUG SG_ALERT
  35
  36 FGAIMultiplayer::FGAIMultiplayer() : FGAIBase(otMultiplayer) {
  37    no_roll = false;
  38
  39    mTimeOffsetSet = false;
  40    mAllowExtrapolation = true;
  41    mLagAdjustSystemSpeed = 10;
  42
  43    aip.getSceneGraph()->setNodeMask(~SG_NODEMASK_TERRAIN_BIT);
  44
  45 }
  46
  47
  48 FGAIMultiplayer::~FGAIMultiplayer() {
  49 }
  50
  51 bool FGAIMultiplayer::init(bool search_in_AI_path) {
  52     props->setStringValue("sim/model/path", model_path.c_str());
  53     //refuel_node = fgGetNode("systems/refuel/contact", true);
  54     isTanker = false; // do this until this property is
  55                       // passed over the net
  56
  57     string str1 = _getCallsign();
  58     string str2 = "MOBIL";
  59
  60     string::size_type loc1= str1.find( str2, 0 );
  61     if ( (loc1 != string::npos && str2 != "") ){
  62         //         cout << " string found "     << str2 << " in " << str1 << endl;
  63         isTanker = true;
  64         //         cout << "isTanker " << isTanker << " " << mCallSign <<endl;
  65     }
  66    return FGAIBase::init(search_in_AI_path);
  67 }
  68
  69 void FGAIMultiplayer::bind() {
  70     FGAIBase::bind();
  71
  72     props->tie("refuel/contact", SGRawValuePointer<bool>(&contact));
  73     props->setBoolValue("tanker",isTanker);
  74
  75 #define AIMPROProp(type, name) \
  76 SGRawValueMethods<FGAIMultiplayer, type>(*this, &FGAIMultiplayer::get##name)
  77
  78 #define AIMPRWProp(type, name) \
  79 SGRawValueMethods<FGAIMultiplayer, type>(*this, \
  80       &FGAIMultiplayer::get##name, &FGAIMultiplayer::set##name)
  81
  82     //props->tie("callsign", AIMPROProp(const char *, CallSign));
  83
  84     props->tie("controls/allow-extrapolation",
  85                AIMPRWProp(bool, AllowExtrapolation));
  86     props->tie("controls/lag-adjust-system-speed",
  87                AIMPRWProp(double, LagAdjustSystemSpeed));
  88
  89
  90 #undef AIMPROProp
  91 #undef AIMPRWProp
  92 }
  93
  94 void FGAIMultiplayer::unbind() {
  95     FGAIBase::unbind();
  96
  97     //props->untie("callsign");
  98     props->untie("controls/allow-extrapolation");
  99     props->untie("controls/lag-adjust-system-speed");
 100     props->untie("refuel/contact");
 101 }
 102
 103 void FGAIMultiplayer::update(double dt)
 104 {
 105   using namespace simgear;
 106
 107   if (dt <= 0)
 108     return;
 109
 110   FGAIBase::update(dt);
 111
 112   // Check if we already got data
 113   if (mMotionInfo.empty())
 114     return;
 115
 116   // The current simulation time we need to update for,
 117   // note that the simulation time is updated before calling all the
 118   // update methods. Thus it contains the time intervals *end* time
 119   double curtime = globals->get_sim_time_sec();
 120
 121   // Get the last available time
 122   MotionInfo::reverse_iterator it = mMotionInfo.rbegin();
 123   double curentPkgTime = it->second.time;
 124
 125   // Dynamically optimize the time offset between the feeder and the client
 126   // Well, 'dynamically' means that the dynamic of that update must be very
 127   // slow. You would otherwise notice huge jumps in the multiplayer models.
 128   // The reason is that we want to avoid huge extrapolation times since
 129   // extrapolation is highly error prone. For that we need something
 130   // approaching the average latency of the packets. This first order lag
 131   // component will provide this. We just take the error of the currently
 132   // requested time to the most recent available packet. This is the
 133   // target we want to reach in average.
 134   double lag = it->second.lag;
 135   if (!mTimeOffsetSet) {
 136     mTimeOffsetSet = true;
 137     mTimeOffset = curentPkgTime - curtime - lag;
 138   } else {
 139     double offset = curentPkgTime - curtime - lag;
 140     if ((!mAllowExtrapolation && offset + lag < mTimeOffset)
 141         || (offset - 10 > mTimeOffset)) {
 142       mTimeOffset = offset;
 143       SG_LOG(SG_GENERAL, SG_DEBUG, "Resetting time offset adjust system to "
 144              "avoid extrapolation: time offset = " << mTimeOffset);
 145     } else {
 146       // the error of the offset, respectively the negative error to avoid
 147       // a minus later ...
 148       double err = offset - mTimeOffset;
 149       // limit errors leading to shorter lag values somehow, that is late
 150       // arriving packets will pessimize the overall lag much more than
 151       // early packets will shorten the overall lag
 152       double sysSpeed;
 153       if (err < 0) {
 154         // Ok, we have some very late packets and nothing newer increase the
 155         // lag by the given speedadjust
 156         sysSpeed = mLagAdjustSystemSpeed*err;
 157       } else {
 158         // We have a too pessimistic display delay shorten that a small bit
 159         sysSpeed = SGMiscd::min(0.1*err*err, 0.5);
 160       }
 161
 162       // simple euler integration for that first order system including some
 163       // overshooting guard to prevent to aggressive system speeds
 164       // (stiff systems) to explode the systems state
 165       double systemIncrement = dt*sysSpeed;
 166       if (fabs(err) < fabs(systemIncrement))
 167         systemIncrement = err;
 168       mTimeOffset += systemIncrement;
 169
 170       SG_LOG(SG_GENERAL, SG_DEBUG, "Offset adjust system: time offset = "
 171              << mTimeOffset << ", expected longitudinal position error due to "
 172              " current adjustment of the offset: "
 173              << fabs(norm(it->second.linearVel)*systemIncrement));
 174     }
 175   }
 176
 177
 178   // Compute the time in the feeders time scale which fits the current time
 179   // we need to
 180   double tInterp = curtime + mTimeOffset;
 181
 182   SGVec3d ecPos;
 183   SGQuatf ecOrient;
 184
 185   if (tInterp <= curentPkgTime) {
 186     // Ok, we need a time prevous to the last available packet,
 187     // that is good ...
 188
 189     // Find the first packet before the target time
 190     MotionInfo::iterator nextIt = mMotionInfo.upper_bound(tInterp);
 191     if (nextIt == mMotionInfo.begin()) {
 192       SG_LOG(SG_GENERAL, SG_DEBUG, "Taking oldest packet!");
 193       // We have no packet before the target time, just use the first one
 194       MotionInfo::iterator firstIt = mMotionInfo.begin();
 195       ecPos = firstIt->second.position;
 196       ecOrient = firstIt->second.orientation;
 197       speed = norm(firstIt->second.linearVel) * SG_METER_TO_NM * 3600.0;
 198
 199       std::vector<FGPropertyData*>::const_iterator firstPropIt;
 200       std::vector<FGPropertyData*>::const_iterator firstPropItEnd;
 201       firstPropIt = firstIt->second.properties.begin();
 202       firstPropItEnd = firstIt->second.properties.end();
 203       while (firstPropIt != firstPropItEnd) {
 204         //cout << " Setting property..." << (*firstPropIt)->id;
 205         PropertyMap::iterator pIt = mPropertyMap.find((*firstPropIt)->id);
 206         if (pIt != mPropertyMap.end())
 207         {
 208           //cout << "Found " << pIt->second->getPath() << ":";
 209           switch ((*firstPropIt)->type) {
 210             case props::INT:
 211             case props::BOOL:
 212             case props::LONG:
 213               pIt->second->setIntValue((*firstPropIt)->int_value);
 214               //cout << "Int: " << (*firstPropIt)->int_value << "\n";
 215               break;
 216             case props::FLOAT:
 217             case props::DOUBLE:
 218               pIt->second->setFloatValue((*firstPropIt)->float_value);
 219               //cout << "Flo: " << (*firstPropIt)->float_value << "\n";
 220               break;
 221             case props::STRING:
 222             case props::UNSPECIFIED:
 223               pIt->second->setStringValue((*firstPropIt)->string_value);
 224               //cout << "Str: " << (*firstPropIt)->string_value << "\n";
 225               break;
 226             default:
 227               // FIXME - currently defaults to float values
 228               pIt->second->setFloatValue((*firstPropIt)->float_value);
 229               //cout << "Unknown: " << (*firstPropIt)->float_value << "\n";
 230               break;
 231           }
 232         }
 233         else
 234         {
 235           SG_LOG(SG_GENERAL, SG_DEBUG, "Unable to find property: " << (*firstPropIt)->id << "\n");
 236         }
 237         ++firstPropIt;
 238       }
 239
 240     } else {
 241       // Ok, we have really found something where our target time is in between
 242       // do interpolation here
 243       MotionInfo::iterator prevIt = nextIt;
 244       --prevIt;
 245
 246       // Interpolation coefficient is between 0 and 1
 247       double intervalStart = prevIt->second.time;
 248       double intervalEnd = nextIt->second.time;
 249       double intervalLen = intervalEnd - intervalStart;
 250       double tau = (tInterp - intervalStart)/intervalLen;
 251
 252       SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer vehicle interpolation: ["
 253              << intervalStart << ", " << intervalEnd << "], intervalLen = "
 254              << intervalLen << ", interpolation parameter = " << tau);
 255
 256       // Here we do just linear interpolation on the position
 257       ecPos = ((1-tau)*prevIt->second.position + tau*nextIt->second.position);
 258       ecOrient = interpolate((float)tau, prevIt->second.orientation,
 259                              nextIt->second.orientation);
 260       speed = norm((1-tau)*prevIt->second.linearVel
 261                    + tau*nextIt->second.linearVel) * SG_METER_TO_NM * 3600.0;
 262
 263       if (prevIt->second.properties.size()
 264           == nextIt->second.properties.size()) {
 265         std::vector<FGPropertyData*>::const_iterator prevPropIt;
 266         std::vector<FGPropertyData*>::const_iterator prevPropItEnd;
 267         std::vector<FGPropertyData*>::const_iterator nextPropIt;
 268         std::vector<FGPropertyData*>::const_iterator nextPropItEnd;
 269         prevPropIt = prevIt->second.properties.begin();
 270         prevPropItEnd = prevIt->second.properties.end();
 271         nextPropIt = nextIt->second.properties.begin();
 272         nextPropItEnd = nextIt->second.properties.end();
 273         while (prevPropIt != prevPropItEnd) {
 274           PropertyMap::iterator pIt = mPropertyMap.find((*prevPropIt)->id);
 275           //cout << " Setting property..." << (*prevPropIt)->id;
 276
 277           if (pIt != mPropertyMap.end())
 278           {
 279             //cout << "Found " << pIt->second->getPath() << ":";
 280
 281             int ival;
 282             float val;
 283             switch ((*prevPropIt)->type) {
 284               case props::INT:
 285               case props::BOOL:
 286               case props::LONG:
 287                 ival = (int) (0.5+(1-tau)*((double) (*prevPropIt)->int_value) +
 288                   tau*((double) (*nextPropIt)->int_value));
 289                 pIt->second->setIntValue(ival);
 290                 //cout << "Int: " << ival << "\n";
 291                 break;
 292               case props::FLOAT:
 293               case props::DOUBLE:
 294                 val = (1-tau)*(*prevPropIt)->float_value +
 295                   tau*(*nextPropIt)->float_value;
 296                 //cout << "Flo: " << val << "\n";
 297                 pIt->second->setFloatValue(val);
 298                 break;
 299               case props::STRING:
 300               case props::UNSPECIFIED:
 301                 //cout << "Str: " << (*nextPropIt)->string_value << "\n";
 302                 pIt->second->setStringValue((*nextPropIt)->string_value);
 303                 break;
 304               default:
 305                 // FIXME - currently defaults to float values
 306                 val = (1-tau)*(*prevPropIt)->float_value +
 307                   tau*(*nextPropIt)->float_value;
 308                 //cout << "Unk: " << val << "\n";
 309                 pIt->second->setFloatValue(val);
 310                 break;
 311             }
 312           }
 313           else
 314           {
 315             SG_LOG(SG_GENERAL, SG_DEBUG, "Unable to find property: " << (*prevPropIt)->id << "\n");
 316           }
 317
 318           ++prevPropIt;
 319           ++nextPropIt;
 320         }
 321       }
 322
 323       // Now throw away too old data
 324       if (prevIt != mMotionInfo.begin())
 325       {
 326         --prevIt;
 327
 328         MotionInfo::iterator delIt;
 329         delIt = mMotionInfo.begin();
 330
 331         while (delIt != prevIt)
 332         {
 333           std::vector<FGPropertyData*>::const_iterator propIt;
 334           std::vector<FGPropertyData*>::const_iterator propItEnd;
 335           propIt = delIt->second.properties.begin();
 336           propItEnd = delIt->second.properties.end();
 337
 338           //cout << "Deleting data\n";
 339
 340           while (propIt != propItEnd)
 341           {
 342             delete *propIt;
 343             propIt++;
 344           }
 345
 346           delIt++;
 347         }
 348
 349         mMotionInfo.erase(mMotionInfo.begin(), prevIt);
 350       }
 351     }
 352   } else {
 353     // Ok, we need to predict the future, so, take the best data we can have
 354     // and do some eom computation to guess that for now.
 355     FGExternalMotionData motionInfo = it->second;
 356
 357     // The time to predict, limit to 5 seconds
 358     double t = tInterp - motionInfo.time;
 359     t = SGMisc<double>::min(t, 5);
 360
 361     SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer vehicle extrapolation: "
 362            "extrapolation time = " << t);
 363
 364     // Do a few explicit euler steps with the constant acceleration's
 365     // This must be sufficient ...
 366     ecPos = motionInfo.position;
 367     ecOrient = motionInfo.orientation;
 368     SGVec3f linearVel = motionInfo.linearVel;
 369     SGVec3f angularVel = motionInfo.angularVel;
 370     while (0 < t) {
 371       double h = 1e-1;
 372       if (t < h)
 373         h = t;
 374
 375       SGVec3d ecVel = toVec3d(ecOrient.backTransform(linearVel));
 376       ecPos += h*ecVel;
 377       ecOrient += h*ecOrient.derivative(angularVel);
 378
 379       linearVel += h*(cross(linearVel, angularVel) + motionInfo.linearAccel);
 380       angularVel += h*motionInfo.angularAccel;
 381
 382       t -= h;
 383     }
 384
 385     std::vector<FGPropertyData*>::const_iterator firstPropIt;
 386     std::vector<FGPropertyData*>::const_iterator firstPropItEnd;
 387     speed = norm(linearVel) * SG_METER_TO_NM * 3600.0;
 388     firstPropIt = it->second.properties.begin();
 389     firstPropItEnd = it->second.properties.end();
 390     while (firstPropIt != firstPropItEnd) {
 391       PropertyMap::iterator pIt = mPropertyMap.find((*firstPropIt)->id);
 392       //cout << " Setting property..." << (*firstPropIt)->id;
 393
 394       if (pIt != mPropertyMap.end())
 395       {
 396         switch ((*firstPropIt)->type) {
 397           case props::INT:
 398           case props::BOOL:
 399           case props::LONG:
 400             pIt->second->setIntValue((*firstPropIt)->int_value);
 401             //cout << "Int: " << (*firstPropIt)->int_value << "\n";
 402             break;
 403           case props::FLOAT:
 404           case props::DOUBLE:
 405             pIt->second->setFloatValue((*firstPropIt)->float_value);
 406             //cout << "Flo: " << (*firstPropIt)->float_value << "\n";
 407             break;
 408           case props::STRING:
 409           case props::UNSPECIFIED:
 410             pIt->second->setStringValue((*firstPropIt)->string_value);
 411             //cout << "Str: " << (*firstPropIt)->string_value << "\n";
 412             break;
 413           default:
 414             // FIXME - currently defaults to float values
 415             pIt->second->setFloatValue((*firstPropIt)->float_value);
 416             //cout << "Unk: " << (*firstPropIt)->float_value << "\n";
 417             break;
 418         }
 419       }
 420       else
 421       {
 422         SG_LOG(SG_GENERAL, SG_DEBUG, "Unable to find property: " << (*firstPropIt)->id << "\n");
 423       }
 424
 425       ++firstPropIt;
 426     }
 427   }
 428
 429   // extract the position
 430   pos = SGGeod::fromCart(ecPos);
 431   altitude_ft = pos.getElevationFt();
 432
 433   // The quaternion rotating from the earth centered frame to the
 434   // horizontal local frame
 435   SGQuatf qEc2Hl = SGQuatf::fromLonLatRad((float)pos.getLongitudeRad(),
 436                                           (float)pos.getLatitudeRad());
 437   // The orientation wrt the horizontal local frame
 438   SGQuatf hlOr = conj(qEc2Hl)*ecOrient;
 439   float hDeg, pDeg, rDeg;
 440   hlOr.getEulerDeg(hDeg, pDeg, rDeg);
 441   hdg = hDeg;
 442   roll = rDeg;
 443   pitch = pDeg;
 444
 445   SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer position and orientation: "
 446          << ecPos << ", " << hlOr);
 447
 448   //###########################//
 449   // do calculations for radar //
 450   //###########################//
 451     double range_ft2 = UpdateRadar(manager);
 452
 453     //************************************//
 454     // Tanker code                        //
 455     //************************************//
 456
 457
 458     if ( isTanker) {
 459         if ( (range_ft2 < 250.0 * 250.0) &&
 460             (y_shift > 0.0)    &&
 461             (elevation > 0.0) ){
 462                 // refuel_node->setBoolValue(true);
 463             contact = true;
 464         } else {
 465             // refuel_node->setBoolValue(false);
 466             contact = false;
 467         }
 468     } else {
 469         contact = false;
 470     }
 471
 472   Transform();
 473 }
 474
 475 void
 476 FGAIMultiplayer::addMotionInfo(const FGExternalMotionData& motionInfo,
 477                                long stamp)
 478 {
 479   mLastTimestamp = stamp;
 480
 481   if (!mMotionInfo.empty()) {
 482     double diff = motionInfo.time - mMotionInfo.rbegin()->first;
 483
 484     // packet is very old -- MP has probably reset (incl. his timebase)
 485     if (diff < -10.0)
 486       mMotionInfo.clear();
 487
 488     // drop packets arriving out of order
 489     else if (diff < 0.0)
 490       return;
 491   }
 492   mMotionInfo[motionInfo.time] = motionInfo;
 493 }
 494
 495 void
 496 FGAIMultiplayer::setDoubleProperty(const std::string& prop, double val)
 497 {
 498   SGPropertyNode* pNode = props->getChild(prop.c_str(), true);
 499   pNode->setDoubleValue(val);
 500 }