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 // #define SG_DEBUG SG_ALERT
  33
  34 FGAIMultiplayer::FGAIMultiplayer() : FGAIBase(otMultiplayer) {
  35    no_roll = false;
  36
  37    mTimeOffsetSet = false;
  38    mAllowExtrapolation = true;
  39    mLagAdjustSystemSpeed = 10;
  40 }
  41
  42
  43 FGAIMultiplayer::~FGAIMultiplayer() {
  44 }
  45
  46 bool FGAIMultiplayer::init() {
  47     //refuel_node = fgGetNode("systems/refuel/contact", true);
  48     isTanker = false; // do this until this property is
  49                       // passed over the net
  50
  51     string str1 = mCallSign;
  52     string str2 = "MOBIL";
  53
  54     unsigned int loc1= str1.find( str2, 0 );
  55     if ( (loc1 != string::npos && str2 != "") ){
  56         //         cout << " string found "     << str2 << " in " << str1 << endl;
  57         isTanker = true;
  58         //         cout << "isTanker " << isTanker << " " << mCallSign <<endl;
  59     }
  60    return FGAIBase::init();
  61 }
  62
  63 void FGAIMultiplayer::bind() {
  64     FGAIBase::bind();
  65
  66     props->tie("refuel/contact", SGRawValuePointer<bool>(&contact));
  67     props->setBoolValue("tanker",isTanker);
  68
  69 #define AIMPROProp(type, name) \
  70 SGRawValueMethods<FGAIMultiplayer, type>(*this, &FGAIMultiplayer::get##name)
  71
  72 #define AIMPRWProp(type, name) \
  73 SGRawValueMethods<FGAIMultiplayer, type>(*this, \
  74       &FGAIMultiplayer::get##name, &FGAIMultiplayer::set##name)
  75
  76     props->tie("callsign", AIMPROProp(const char *, CallSign));
  77
  78     props->tie("controls/allow-extrapolation",
  79                AIMPRWProp(bool, AllowExtrapolation));
  80     props->tie("controls/lag-adjust-system-speed",
  81                AIMPRWProp(double, LagAdjustSystemSpeed));
  82
  83
  84 #undef AIMPROProp
  85 #undef AIMPRWProp
  86 }
  87
  88 void FGAIMultiplayer::unbind() {
  89     FGAIBase::unbind();
  90
  91     props->untie("callsign");
  92     props->untie("controls/allow-extrapolation");
  93     props->untie("controls/lag-adjust-system-speed");
  94     props->untie("refuel/contact");
  95 }
  96
  97 void FGAIMultiplayer::update(double dt)
  98 {
  99   if (dt <= 0)
 100     return;
 101
 102   FGAIBase::update(dt);
 103
 104   // Check if we already got data
 105   if (mMotionInfo.empty())
 106     return;
 107
 108   // The current simulation time we need to update for,
 109   // note that the simulation time is updated before calling all the
 110   // update methods. Thus it contains the time intervals *end* time
 111   double curtime = globals->get_sim_time_sec();
 112
 113   // Get the last available time
 114   MotionInfo::reverse_iterator it = mMotionInfo.rbegin();
 115   double curentPkgTime = it->second.time;
 116
 117   // Dynamically optimize the time offset between the feeder and the client
 118   // Well, 'dynamically' means that the dynamic of that update must be very
 119   // slow. You would otherwise notice huge jumps in the multiplayer models.
 120   // The reason is that we want to avoid huge extrapolation times since
 121   // extrapolation is highly error prone. For that we need something
 122   // approaching the average latency of the packets. This first order lag
 123   // component will provide this. We just take the error of the currently
 124   // requested time to the most recent available packet. This is the
 125   // target we want to reach in average.
 126   double lag = it->second.lag;
 127   if (!mTimeOffsetSet) {
 128     mTimeOffsetSet = true;
 129     mTimeOffset = curentPkgTime - curtime - lag;
 130   } else {
 131     double offset = curentPkgTime - curtime - lag;
 132     if (!mAllowExtrapolation && offset + lag < mTimeOffset) {
 133       mTimeOffset = offset;
 134       SG_LOG(SG_GENERAL, SG_DEBUG, "Resetting time offset adjust system to "
 135              "avoid extrapolation: time offset = " << mTimeOffset);
 136     } else {
 137       // the error of the offset, respectively the negative error to avoid
 138       // a minus later ...
 139       double err = offset - mTimeOffset;
 140       // limit errors leading to shorter lag values somehow, that is late
 141       // arriving packets will pessimize the overall lag much more than
 142       // early packets will shorten the overall lag
 143       double sysSpeed;
 144       if (err < 0) {
 145         // Ok, we have some very late packets and nothing newer increase the
 146         // lag by the given speedadjust
 147         sysSpeed = mLagAdjustSystemSpeed*err;
 148       } else {
 149         // We have a too pessimistic display delay shorten that a small bit
 150         sysSpeed = SGMiscd::min(0.1*err*err, 0.5);
 151       }
 152
 153       // simple euler integration for that first order system including some
 154       // overshooting guard to prevent to aggressive system speeds
 155       // (stiff systems) to explode the systems state
 156       double systemIncrement = dt*sysSpeed;
 157       if (fabs(err) < fabs(systemIncrement))
 158         systemIncrement = err;
 159       mTimeOffset += systemIncrement;
 160
 161       SG_LOG(SG_GENERAL, SG_DEBUG, "Offset adjust system: time offset = "
 162              << mTimeOffset << ", expected longitudinal position error due to "
 163              " current adjustment of the offset: "
 164              << fabs(norm(it->second.linearVel)*systemIncrement));
 165     }
 166   }
 167
 168
 169   // Compute the time in the feeders time scale which fits the current time
 170   // we need to
 171   double tInterp = curtime + mTimeOffset;
 172
 173   SGVec3d ecPos;
 174   SGQuatf ecOrient;
 175   SGVec3f myVel;
 176
 177   if (tInterp <= curentPkgTime) {
 178     // Ok, we need a time prevous to the last available packet,
 179     // that is good ...
 180
 181     // Find the first packet before the target time
 182     MotionInfo::iterator nextIt = mMotionInfo.upper_bound(tInterp);
 183     if (nextIt == mMotionInfo.begin()) {
 184       SG_LOG(SG_GENERAL, SG_DEBUG, "Taking oldest packet!");
 185       // We have no packet before the target time, just use the first one
 186       MotionInfo::iterator firstIt = mMotionInfo.begin();
 187       ecPos = firstIt->second.position;
 188       ecOrient = firstIt->second.orientation;
 189       myVel = firstIt->second.linearVel;
 190
 191       std::vector<FGFloatPropertyData>::const_iterator firstPropIt;
 192       std::vector<FGFloatPropertyData>::const_iterator firstPropItEnd;
 193       firstPropIt = firstIt->second.properties.begin();
 194       firstPropItEnd = firstIt->second.properties.end();
 195       while (firstPropIt != firstPropItEnd) {
 196         float val = firstPropIt->value;
 197         PropertyMap::iterator pIt = mPropertyMap.find(firstPropIt->id);
 198         if (pIt != mPropertyMap.end())
 199           pIt->second->setFloatValue(val);
 200         ++firstPropIt;
 201       }
 202
 203     } else {
 204       // Ok, we have really found something where our target time is in between
 205       // do interpolation here
 206       MotionInfo::iterator prevIt = nextIt;
 207       --prevIt;
 208
 209       // Interpolation coefficient is between 0 and 1
 210       double intervalStart = prevIt->second.time;
 211       double intervalEnd = nextIt->second.time;
 212       double intervalLen = intervalEnd - intervalStart;
 213       double tau = (tInterp - intervalStart)/intervalLen;
 214
 215       SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer vehicle interpolation: ["
 216              << intervalStart << ", " << intervalEnd << "], intervalLen = "
 217              << intervalLen << ", interpolation parameter = " << tau);
 218
 219       // Here we do just linear interpolation on the position
 220       ecPos = ((1-tau)*prevIt->second.position + tau*nextIt->second.position);
 221       ecOrient = interpolate((float)tau, prevIt->second.orientation,
 222                              nextIt->second.orientation);
 223       myVel = ((1-tau)*prevIt->second.linearVel + tau*nextIt->second.linearVel);
 224
 225       if (prevIt->second.properties.size()
 226           == nextIt->second.properties.size()) {
 227         std::vector<FGFloatPropertyData>::const_iterator prevPropIt;
 228         std::vector<FGFloatPropertyData>::const_iterator prevPropItEnd;
 229         std::vector<FGFloatPropertyData>::const_iterator nextPropIt;
 230         std::vector<FGFloatPropertyData>::const_iterator nextPropItEnd;
 231         prevPropIt = prevIt->second.properties.begin();
 232         prevPropItEnd = prevIt->second.properties.end();
 233         nextPropIt = nextIt->second.properties.begin();
 234         nextPropItEnd = nextIt->second.properties.end();
 235         while (prevPropIt != prevPropItEnd) {
 236           float val = (1-tau)*prevPropIt->value + tau*nextPropIt->value;
 237           PropertyMap::iterator pIt = mPropertyMap.find(prevPropIt->id);
 238           if (pIt != mPropertyMap.end())
 239             pIt->second->setFloatValue(val);
 240           ++prevPropIt;
 241           ++nextPropIt;
 242         }
 243       }
 244
 245       // Now throw away too old data
 246       if (prevIt != mMotionInfo.begin()) {
 247         --prevIt;
 248         mMotionInfo.erase(mMotionInfo.begin(), prevIt);
 249       }
 250     }
 251   } else {
 252     // Ok, we need to predict the future, so, take the best data we can have
 253     // and do some eom computation to guess that for now.
 254     FGExternalMotionData motionInfo = it->second;
 255
 256     // The time to predict, limit to 5 seconds
 257     double t = tInterp - motionInfo.time;
 258     t = SGMisc<double>::min(t, 5);
 259
 260     SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer vehicle extrapolation: "
 261            "extrapolation time = " << t);
 262
 263     // Do a few explicit euler steps with the constant acceleration's
 264     // This must be sufficient ...
 265     ecPos = motionInfo.position;
 266     ecOrient = motionInfo.orientation;
 267     SGVec3f linearVel = motionInfo.linearVel;
 268     SGVec3f angularVel = motionInfo.angularVel;
 269     myVel = linearVel;
 270     while (0 < t) {
 271       double h = 1e-1;
 272       if (t < h)
 273         h = t;
 274
 275       SGVec3d ecVel = toVec3d(ecOrient.backTransform(linearVel));
 276       ecPos += h*ecVel;
 277       ecOrient += h*ecOrient.derivative(angularVel);
 278
 279       linearVel += h*(cross(linearVel, angularVel) + motionInfo.linearAccel);
 280       myVel = linearVel;
 281       angularVel += h*motionInfo.angularAccel;
 282
 283       t -= h;
 284     }
 285
 286     std::vector<FGFloatPropertyData>::const_iterator firstPropIt;
 287     std::vector<FGFloatPropertyData>::const_iterator firstPropItEnd;
 288     firstPropIt = it->second.properties.begin();
 289     firstPropItEnd = it->second.properties.end();
 290     while (firstPropIt != firstPropItEnd) {
 291       float val = firstPropIt->value;
 292       PropertyMap::iterator pIt = mPropertyMap.find(firstPropIt->id);
 293       if (pIt != mPropertyMap.end())
 294         pIt->second->setFloatValue(val);
 295       ++firstPropIt;
 296     }
 297   }
 298
 299   // extract the position
 300   pos = SGGeod::fromCart(ecPos);
 301   altitude_ft = pos.getElevationFt();
 302
 303   // estimate speed (we care only about magnitude not direction/frame
 304   // of reference here)
 305   double vel_ms = sqrt( myVel[0]*myVel[0] + myVel[1]*myVel[1]
 306                         + myVel[2]*myVel[2] );
 307   double vel_kts = vel_ms * SG_METER_TO_NM * 3600.0;
 308   speed = vel_kts;
 309
 310   // The quaternion rotating from the earth centered frame to the
 311   // horizontal local frame
 312   SGQuatf qEc2Hl = SGQuatf::fromLonLatRad((float)pos.getLongitudeRad(),
 313                                           (float)pos.getLatitudeRad());
 314   // The orientation wrt the horizontal local frame
 315   SGQuatf hlOr = conj(qEc2Hl)*ecOrient;
 316   float hDeg, pDeg, rDeg;
 317   hlOr.getEulerDeg(hDeg, pDeg, rDeg);
 318   hdg = hDeg;
 319   roll = rDeg;
 320   pitch = pDeg;
 321
 322   SG_LOG(SG_GENERAL, SG_DEBUG, "Multiplayer position and orientation: "
 323          << ecPos << ", " << hlOr);
 324
 325   //###########################//
 326   // do calculations for radar //
 327   //###########################//
 328     double range_ft2 = UpdateRadar(manager);
 329
 330     //************************************//
 331     // Tanker code                        //
 332     //************************************//
 333
 334
 335     if ( isTanker) {
 336         if ( (range_ft2 < 250.0 * 250.0) &&
 337             (y_shift > 0.0)    &&
 338             (elevation > 0.0) ){
 339                 // refuel_node->setBoolValue(true);
 340             contact = true;
 341         } else {
 342             // refuel_node->setBoolValue(false);
 343             contact = false;
 344         }
 345     } else {
 346         contact = false;
 347     }
 348
 349   Transform();
 350 }
 351
 352 void
 353 FGAIMultiplayer::addMotionInfo(const FGExternalMotionData& motionInfo,
 354                                long stamp)
 355 {
 356   mLastTimestamp = stamp;
 357   // Drop packets arriving out of order
 358   if (!mMotionInfo.empty() && motionInfo.time < mMotionInfo.rbegin()->first)
 359     return;
 360   mMotionInfo[motionInfo.time] = motionInfo;
 361 }
 362
 363 void
 364 FGAIMultiplayer::setDoubleProperty(const std::string& prop, double val)
 365 {
 366   SGPropertyNode* pNode = props->getChild(prop.c_str(), true);
 367   pNode->setDoubleValue(val);
 368 }
 369