Merge branch 'Next'

Author: TwinFan

CMakeLists.txt

@@ -2,7 +2,7 @@
 #
 
 cmake_minimum_required(VERSION 3.9)
-project(LiveTraffic VERSION 1.15 DESCRIPTION "LiveTraffic X-Plane plugin")
+project(LiveTraffic VERSION 1.20 DESCRIPTION "LiveTraffic X-Plane plugin")
 
 # By default, use optimized release configuration.
 if (NOT CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
@@ -15,6 +15,7 @@ set(CMAKE_CXX_STANDARD 17)
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Src")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Include")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/xplanemp")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/Lib/LTAPI")
 include_directories("${CMAKE_SOURCE_DIR}/Lib/XPSDK301/CHeaders/Widgets")
 include_directories("${CMAKE_SOURCE_DIR}/Lib/XPSDK301/CHeaders/Wrappers")
 include_directories("${CMAKE_SOURCE_DIR}/Lib/XPSDK301/CHeaders/XPLM")

Include/Constants.h

@@ -30,7 +30,7 @@
 //
 // MARK: Version Information (CHANGE VERSION HERE)
 //
-constexpr float VERSION_NR = 1.15f;
+constexpr float VERSION_NR = 1.20f;
 constexpr bool VERSION_BETA = false;
 extern float verXPlaneOrg;          // version on X-Plane.org
 extern int verDateXPlaneOrg;        // and its date
@@ -97,6 +97,12 @@ constexpr float  MDL_EXT_FAST_DEG =       5.0f;
 constexpr float  MDL_EXT_STEP_FACTOR =    1.025f; // step factor with one zoom command
 constexpr float  MDL_EXT_FAST_FACTOR =    1.1f;
 #define MDL_LABEL_COLOR         "LABEL_COLOR"
+constexpr double MDL_REVERSERS_TIME = 2.0;  ///< [s] to open/close reversers
+constexpr double MDL_SPOILERS_TIME  = 0.5;  ///< [s] to extend/retract spoilers
+constexpr double MDL_TIRE_SLOW_TIME = 5.0;  ///< [s] time till tires stop rotating after take-off
+constexpr double MDL_TIRE_MAX_RPM = 2000;   ///< [rpm] max tire rotation speed
+constexpr double MDL_TIRE_CF_M      = 3.2;  ///< [m] tire circumfence (3.2m for a 40-inch tire)
+constexpr double MDL_GEAR_DEFL_TIME = 0.5;  ///< [s] time for gear deflection (one direction...up down is twice this value)
 
 constexpr int COLOR_YELLOW      = 0xFFFF00;
 constexpr int COLOR_RED         = 0xFF0000;
@@ -110,7 +116,7 @@ extern char HTTP_USER_AGENT[];          // like "LiveTraffic/1.0"
 extern time_t LT_BETA_VER_LIMIT;        // BETA versions are limited
 extern char LT_BETA_VER_LIMIT_TXT[];
 #define BETA_LIMITED_VERSION    "BETA limited to %s"
-#define BETA_LIMITED_EXPIRED    "BETA-Version limited to %s has EXPIRED -> SHUTTING DOWN!"
+#define BETA_LIMITED_EXPIRED    "BETA-Version limited to %s has EXPIRED -> SHUTTING DOWN! Get an up-to-date version from X-Plane.org."
 constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 
 //MARK: Text Constants
@@ -119,7 +125,7 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define LT_CFG_VERSION          "1.1"        // current version of config file format
 #define LT_FM_VERSION           "1.1"        // version of flight model file format
 #define PLUGIN_SIGNATURE        "TwinFan.plugin.LiveTraffic"
-#define PLUGIN_DESCRIPTION      "Create Multiplayer Aircrafts based on live traffic."
+#define PLUGIN_DESCRIPTION      "Create Multiplayer Aircraft based on live traffic."
 #define LT_DOWNLOAD_URL         "https://forums.x-plane.org/index.php?/files/file/49749-livetraffic/"
 #define LT_DOWNLOAD_CH          "X-Plane.org"
 #define MSG_DISABLED            "Disabled"
@@ -130,20 +136,21 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define MSG_LT_NEW_VER_AVAIL    "The new version %01.2f of LiveTraffic is available at X-Plane.com!"
 #define MSG_REQUESTING_LIVE_FD  "Requesting live flight data online..."
 #define MSG_READING_HIST_FD     "Reading historic flight data..."
-#define MSG_NUM_AC_INIT         "Initially created %d aircrafts"
-#define MSG_NUM_AC_ZERO         "No more aircrafts displayed"
-#define MSG_BUF_FILL_COUNTDOWN  "Filling buffer: seeing %d aircrafts, displaying %d, still %d seconds to buffer"
+#define MSG_NUM_AC_INIT         "Initially created %d aircraft"
+#define MSG_NUM_AC_ZERO         "No more aircraft displayed"
+#define MSG_BUF_FILL_COUNTDOWN  "Filling buffer: seeing %d aircraft, displaying %d, still %d seconds to buffer"
 #define MSG_HIST_WITH_SYS_TIME  "When using historic data you cannot run X-Plane with 'always track system time',\ninstead, choose the historic date in X-Plane's date/time settings."
+#define MSG_ADSBEX_LIMITE       "%ld / %ld requests left"
 #define INFO_AC_ADDED           "Added aircraft %s, operator '%s', a/c model '%s', flight model [%s], bearing %.0f, distance %.1fkm"
 #define INFO_AC_MDL_CHANGED     "Changed CSL model for aircraft %s, operator '%s': a/c model now '%s'"
 #define INFO_AC_REMOVED         "Removed aircraft %s"
-#define INFO_AC_ALL_REMOVED     "Removed all aircrafts"
+#define INFO_AC_ALL_REMOVED     "Removed all aircraft"
 #define INFO_WND_AUTO_AC        "AUTO"
 #define INFO_AC_HIDDEN          "A/c %s hidden"
 #define INFO_AC_HIDDEN_AUTO     "A/c %s automatically hidden"
 #define INFO_AC_SHOWN           "A/c %s visible"
 #define INFO_AC_SHOWN_AUTO      "A/c %s automatically visible"
-#define MSG_TOO_MANY_AC         "Reached limit of %d aircrafts, will create new ones only after removing outdated ones."
+#define MSG_TOO_MANY_AC         "Reached limit of %d aircraft, will create new ones only after removing outdated ones."
 #define MSG_CSL_PACKAGE_LOADED  "Successfully loaded CSL package %s"
 #define MSG_MDL_FORCED          "Settings > Debug: Model matching forced to '%s'/'%s'/'%s'"
 #define MSG_MDL_NOT_FORCED      "Settings > Debug: Model matching no longer forced"
@@ -167,8 +174,8 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define MENU_AC_INFO_WND_POPOUT "Aircraft Info... (Popped out)"
 #define MENU_AC_INFO_WND_SHOWN  "Aircraft Info shown"
 #define MENU_AC_INFO_WND_CLOSEALL "Close All Windows"
-#define MENU_TOGGLE_AIRCRAFTS   "Aircrafts displayed"
-#define MENU_TOGGLE_AC_NUM      "Aircrafts displayed (%d shown)"
+#define MENU_TOGGLE_AIRCRAFTS   "Aircraft displayed"
+#define MENU_TOGGLE_AC_NUM      "Aircraft displayed (%d shown)"
 #define MENU_HAVE_TCAS          "TCAS controlled"
 #define MENU_TOGGLE_LABELS      "Labels shown"
 #define MENU_SETTINGS_UI        "Settings..."
@@ -214,8 +221,11 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 //MARK: Error Texsts
 constexpr long HTTP_OK =            200;
 constexpr long HTTP_BAD_REQUEST =   400;
+constexpr long HTTP_UNAUTHORIZED =  401;
+constexpr long HTTP_FORBIDDEN =     403;
 constexpr long HTTP_NOT_FOUND =     404;
 constexpr long HTTP_NOT_AVAIL =     503;        // "Service not available"
+constexpr long CURL_TIMEOUT =        30;        ///< [s] network timeout, see CURLOPT_TIMEOUT
 constexpr int CH_MAC_ERR_CNT =      5;          // max number of tolerated errors, afterwards invalid channel
 constexpr int SERR_LEN = 100;                   // size of buffer for IO error texts (strerror_s)
 #define ERR_XPLANE_ONLY         "LiveTraffic works in X-Plane only, version 10 or higher"
@@ -231,8 +241,10 @@ constexpr int SERR_LEN = 100;                   // size of buffer for IO error t
 #define ERR_CURL_PERFORM        "%s: Could not get network data: %d - %s"
 #define ERR_CURL_NOVERCHECK     "Could not browse X-Plane.org for version info: %d - %s"
 #define ERR_CURL_HTTP_RESP      "%s: HTTP response is not OK but %ld"
-#define ERR_CURL_REVOKE_MSG     "revocation"                // appears in error text if querying revocation list fails
+#define ERR_CURL_REVOKE_MSG     {"revocation","80092012","80092013"}  // appear in error text if querying revocation list fails
 #define ERR_CURL_DISABLE_REV_QU "%s: Querying revocation list failed - have set CURLSSLOPT_NO_REVOKE and am trying again"
+#define ERR_HTTP_NOT_OK         "HTTP response was not HTTP_OK"
+#define ERR_FOUND_NO_VER_INFO   "Found no version info in response"
 #define ERR_CH_NONE_ACTIVE      "No enabled active channel for tracking data! Check Basic Settings and enable channels."
 #define ERR_CH_UNKNOWN_NAME     "(unknown channel)"
 #define ERR_CH_INVALID          "%s: Channel invalid and disabled"
@@ -244,7 +256,7 @@ constexpr int SERR_LEN = 100;                   // size of buffer for IO error t
 #define ERR_DIR_CONTENT         "Could not retrieve directory content for %s"
 #define ERR_JSON_PARSE          "Parsing flight data as JSON failed"
 #define ERR_JSON_MAIN_OBJECT    "JSON: Getting main object failed"
-#define ERR_JSON_ACLIST         "JSON: List of aircrafts (%s) not found"
+#define ERR_JSON_ACLIST         "JSON: List of aircraft (%s) not found"
 #define ERR_JSON_AC             "JSON: Could not get %d. aircraft in '%s'"
 #define ERR_NEW_OBJECT          "Could not create new object (memory?): %s"
 #define ERR_LOCK_ERROR          "Could not acquire lock for '%s': %s"
@@ -256,7 +268,7 @@ constexpr int SERR_LEN = 100;                   // size of buffer for IO error t
 #define ERR_POS_UNNORMAL        "A/c %s reached invalid pos: %s"
 #define ERR_IGNORE_POS          "A/c %s: Ignoring data leading to sharp turn or invalid speed: %s"
 #define ERR_INV_TRANP_ICAO      "Ignoring data for invalid transponder code '%s'"
-#define ERR_TIME_NONLINEAR      "Time moved non-linear/jumped by %.1f seconds, will re-init aircrafts."
+#define ERR_TIME_NONLINEAR      "Time moved non-linear/jumped by %.1f seconds, will re-init aircraft."
 #define ERR_TOP_LEVEL_EXCEPTION "Caught top-level exception! %s"
 #define ERR_WIDGET_CREATE       "Could not create widget required for settings UI"
 #define ERR_CFG_FILE_OPEN_OUT   "Could not create config file '%s': %s"

Include/DataRefs.h

@@ -68,6 +68,12 @@ class Doc8643 {
     // return the string for FlightModel matching
     operator std::string() const;
 
+    // Helicopter or Gyrocopter with big rotor?
+    inline bool hasRotor () const
+    { return classification.size() >= 1 ?
+        (classification[0] == 'H' || classification[0] == 'G') : false;
+    }
+    
     // static functions for reading the doc8643.txt file
     // and returning information from it
 public:
@@ -199,6 +205,9 @@ enum dataRefsLT {
     DR_AC_BEARING,
     DR_AC_DIST,                         // last of a/c info
 
+    DR_AC_BULK_QUICK,               // bulk a/c primarily for communication with LTAPI
+    DR_AC_BULK_EXPENSIVE,           // similar, but for expensive data, should be called less often
+    
     DR_SIM_DATE,
     DR_SIM_TIME,
 
@@ -224,6 +233,7 @@ enum dataRefsLT {
     DR_CFG_LND_LIGHTS_TAXI,
     DR_CFG_HIDE_BELOW_AGL,
     DR_CFG_HIDE_TAXIING,
+    DR_CFG_DR_LIBXPLANEMP,
     DR_CFG_LAST_CHECK_NEW_VER,
 
     // debug options
@@ -282,6 +292,7 @@ class DataRefs
         XPLMSetDatai_f ifWrite      = NULL;
         XPLMGetDataf_f ffRead       = NULL;
         XPLMSetDataf_f ffWrite      = NULL;
+        XPLMGetDatab_f bfRead       = NULL;
         void* refCon                = NULL;
         bool bCfgFile               = false;
 
@@ -304,6 +315,15 @@ class DataRefs
         ffRead(_ffRead), ffWrite(_ffWrite),
         refCon(_refCon), bCfgFile(_bCfg) {}
 
+        // constructor for xplmType_Data
+        dataRefDefinitionT (const char* name,
+                            XPLMGetDatab_f _bfRead, XPLMSetDataf_f /*_bfWrite*/ = NULL,
+                            void* _refCon = NULL,
+                            bool _bCfg = false) :
+        dataName(name), dataType(xplmType_Data),
+        bfRead(_bfRead), 
+        refCon(_refCon), bCfgFile(_bCfg) {}
+        
         // allows using the object in string context -> dataName
         inline const std::string getDataNameStr() const { return dataName; }
         inline const char* getDataName() const { return dataName.c_str(); }
@@ -317,7 +337,8 @@ class DataRefs
         inline XPLMSetDatai_f setDatai_f () const { return ifWrite; }
         inline XPLMGetDataf_f getDataf_f () const { return ffRead; }
         inline XPLMSetDataf_f setDataf_f () const { return ffWrite; }
-        
+        inline XPLMGetDatab_f getDatab_f () const { return bfRead; }
+
         inline XPLMDataTypeID getDataType() const { return dataType; }
         inline void* getRefCon() const { return refCon; }
         inline void setRefCon (void* _refCon) { refCon = _refCon; }
@@ -386,6 +407,7 @@ class DataRefs
         inline bool empty() const   { return path.empty(); }
         inline bool enabled() const { return bEnabled && !empty(); }
         inline bool operator== (const CSLPathCfgTy& o) const { return path == o.path; }
+        inline bool operator== (const std::string& s) const { return path == s; }
     };
     typedef std::vector<CSLPathCfgTy> vecCSLPaths;
 
@@ -442,6 +464,7 @@ class DataRefs
     int bLndLightsTaxi = false;         // keep landing lights on while taxiing? (to be able to see the a/c as there is no taxi light functionality)
     int hideBelowAGL    = 0;            // if positive: a/c visible only above this height AGL
     int hideTaxiing     = 0;            // hide a/c while taxiing?
+    int drLibXplaneMP   = 1;            // CSL models: register original 'libxplanemp' dataRefs?
 
     // channel config options
     int rtListenPort    = 10747;        // port opened for RT to connect
@@ -471,6 +494,8 @@ class DataRefs
     std::string cslFixOpIcao;           // ...newly created aircrafts for...
     std::string cslFixLivery;           // ...CSL model package testing
     RealTrafficConnection *pRTConn = nullptr;   // ptr to RealTraffic connection object
+    long ADSBExRLimit = 0;              // ADSBEx: Limit on RapidAPI
+    long ADSBExRRemain = 0;             // ADSBEx: Remaining Requests on RapidAPI
 
 //MARK: Constructor
 public:
@@ -517,6 +542,10 @@ class DataRefs
     static int   LTGetInt(void* p);
     static float LTGetFloat(void* p);
     static void  LTSetBool(void* p, int i);
+    
+    // Bulk data access to transfer a lot of a/c info to LTAPI
+    static int LTGetBulkAc (void* inRefcon, void * outValue,
+                            int inStartIdx, int inNumAc);
 
 protected:
     // a/c info
@@ -586,7 +615,10 @@ class DataRefs
     inline int GetHideBelowAGL() const { return hideBelowAGL; }
     inline bool GetHideTaxiing() const { return hideTaxiing != 0; }
     inline bool IsAutoHidingActive() const { return hideBelowAGL > 0 || hideTaxiing != 0; }
-    
+
+    inline bool GetDrLibXplaneMP() const { return drLibXplaneMP != 0; }
+    inline void SetDrLibXplaneMP(int i) { drLibXplaneMP = i; }
+
     bool NeedNewVerCheck () const;
     void SetLastCheckedNewVerNow ();
 

Include/LTADSBEx.h

@@ -34,6 +34,14 @@
 #define ADSBEX_NAME             "ADS-B Exchange Online"
 #define ADSBEX_URL              "https://adsbexchange.com/api/aircraft/json/lat/%f/lon/%f/dist/%d/"
 #define ADSBEX_API_AUTH         "api-auth:"     // additional HTTP header
+
+#define ADSBEX_RAPIDAPI_25_URL  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/%f/lon/%f/dist/25/"
+#define ADSBEX_RAPIDAPI_HOST    "X-RapidAPI-Host:adsbx-flight-sim-traffic.p.rapidapi.com"
+#define ADSBEX_RAPIDAPI_KEY     "X-RapidAPI-Key:"
+#define ADSBEX_RAPIDAPI_RLIMIT  "X-RateLimit-Requests-Limit:"
+#define ADSBEX_RAPIDAPI_RREMAIN "X-RateLimit-Requests-Remaining:"
+
+#define ADSBEX_TOTAL            "total"
 #define ADSBEX_TIME             "ctime"
 #define ADSBEX_AIRCRAFT_ARR     "ac"
 #define ADSBEX_TRANSP_ICAO      "icao"          // Key data
@@ -77,6 +85,11 @@
 #define ADSBEX_VERIFY_KEY_URL   "https://adsbexchange.com/api/aircraft/icao/000000"
 #define ADSBEX_ERR              "ERR"
 #define ADSBEX_NO_API_KEY       "NO API KEY"
+
+#define ADSBEX_VERIFY_RAPIDAPI  "https://adsbx-flight-sim-traffic.p.rapidapi.com/api/aircraft/json/lat/0.0/lon/0.0/dist/25/"
+#define ADSBEX_RAPID_ERR        "message"
+#define ADSBEX_NO_RAPIDAPI_KEY  "Key doesn't exists"
+
 #define ERR_ADSBEX_KEY_TECH     "ADSBEx: Technical problem while testing key: %d - %s"
 #define MSG_ADSBEX_KEY_SUCCESS  "ADS-B Exchange: API Key tested SUCCESSFULLY"
 #define ERR_ADSBEX_KEY_FAILED   "ADS-B Exchange: API Key INVALID"
@@ -92,8 +105,12 @@ constexpr double ADSBEX_SMOOTH_GROUND   = 35.0; // smooth 35s of ground data
 //
 class ADSBExchangeConnection : public LTOnlineChannel, LTFlightDataChannel
 {
+public:
+    enum keyTypeE { ADSBEX_KEY_NONE=0, ADSBEX_KEY_EXCHANGE, ADSBEX_KEY_RAPIDAPI };
+    
 protected:
     std::string apiKey;
+    keyTypeE keyTy = ADSBEX_KEY_NONE;
     struct curl_slist* slistKey = NULL;
 public:
     ADSBExchangeConnection () :
@@ -114,8 +131,13 @@ class ADSBExchangeConnection : public LTOnlineChannel, LTFlightDataChannel
     // need to add/cleanup API key
     virtual bool InitCurl ();
     virtual void CleanupCurl ();
+    // make list of HTTP header fields
+    static struct curl_slist* MakeCurlSList (keyTypeE keyTy, const std::string theKey);
+    // read header and parse for request limit/remaining
+    static size_t ReceiveHeader(char *buffer, size_t size, size_t nitems, void *userdata);
 
 public:
+    static keyTypeE GetKeyType (const std::string theKey);
     // Just quickly sends one simple request to ADSBEx and checks if the response is not "NO KEY"
     // Does a SHOW_MSG about the result and saves the key to dataRefs on success.
     static void TestADSBExAPIKey (const std::string newKey);