Support for old 2.x code by backwards compatible decode(decode_results *aResults) function. Removed USE_OLD_DECODE macro and added NO_LEGACY_COMPATIBILITY macro

Author: ArminJo

README.md

@@ -42,18 +42,23 @@ If you use a core that does not use the `-flto` flag for compile, you can activa
 - Since the decoded values are now in `IrReceiver.decodedIRData` and not in `results` any more, remove the line `decode_results results` or similar.
 - Like for the Serial object, call [`IrReceiver.begin(IR_RECEIVE_PIN, ENABE_ED_FEEDBACK);`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L38) or `IrReceiver.begin(IR_RECEIVE_PIN, DISABLE_LED_FEEDBACK);` instead of the `IrReceiver.enableIRIn();` or `irrecv.enableIRIn();` in setup().
 - Old `decode(decode_results *aResults)` function is replaced by simple `decode()`. So if you have a statement `if(irrecv.decode(&results))` replace it with `if (IrReceiver.decode())`.
-- The decoded result is now in in `IrReceiver.decodedIRData` and not in `results` any more, therefore replace any occurrences of `results.value`  and / or `results.decode_type` (and similar) to `IrReceiver.decodedIRData.decodedRawData` and / or `IrReceiver.decodedIRData.decodedRawData`.
+- The decoded result is now in in `IrReceiver.decodedIRData` and not in `results` any more, therefore replace any occurrences of `results.value` and `results.decode_type` (and similar) to `IrReceiver.decodedIRData.decodedRawData` and `IrReceiver.decodedIRData.protocol`.
 - Overflow, Repeat and other flags are now in [`IrReceiver.receivedIRData.flags`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L126).
 - Seldom used: `results.rawbuf` and `results.rawlen` must be replaced by `IrReceiver.decodedIRData.rawDataPtr->rawbuf` and `IrReceiver.decodedIRData.rawDataPtr->rawlen`.
-- For **NEC, Panasonic, Sony, Samsung and JVC** the `IrReceiver.decodedIRData.decodedRawData` is now LSB-first, as the definition of these protocols suggests! To use your **old MSB-first 32 bit IR data codes**, you must activate the line `#define USE_OLD_DECODE` in IRremoteInt.h.<br/>
- To convert one into the other, you must reverse the byte positions and then reverse all bit positions of each byte or write it as one binary string and reverse/mirror it.
+
+# Running your 2.x program with the 3.x library version
+- The `results.value` is not set by the new decoders and for **NEC, Panasonic, Sony, Samsung and JVC** the `IrReceiver.decodedIRData.decodedRawData` is now LSB-first, as the definition of these protocols suggests!<br/>
+ To use your **old MSB-first 32 bit IR data codes**, you must have `decode_results results` and call `decode(&results)` as in most old sources.
+- The old functions `sendNEC()` and `sendJVC()` are deprecated and renamed to `sendNECMSB()` and `sendJVCMSB()` to make it clearer that they send data with MSB first, which is not the standard for NEC and JVC. Use them to send your **old MSB-first 32 bit IR data codes**.
+In the new version you will send NEC commands not by 32 bit codes but by a (constant) 8 bit address and an 8 bit command.
+
+# Convert old MSB first 32 bit IR data codes to new LSB first 32 bit IR data codes
+ To convert one into the other, you must reverse the byte positions and then reverse all bit positions of each byte or write it as one binary string and reverse/mirror it.<br/>
  Example:<br/>
  0xCB340102 byte reverse -> 02 01 34 CB bit reverse-> 40 80 2C D3.<br/>
  0xCB340102 is binary 11001011001101000000000100000010.<br/>
  0x40802CD3 is binary 01000000100000000010110011010011.<br/>
  If you read the first binary sequence backwards (right to left), you get the second sequence.
-- The old functions `sendNEC()` and `sendJVC()` are deprecated and renamed to `sendNECMSB()` and `sendJVCMSB()` to make it clearer that they send data with MSB first, which is not the standard for NEC and JVC. Use them to send your **old MSB-first 32 bit IR data codes**.
-In the new version you will send NEC commands not by 32 bit codes but by a (constant) 8 bit address and an 8 bit command.
 
 # FAQ
 - IR does not work right when I use Neopixels (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 us).<br/>
@@ -126,7 +131,7 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
 |-|-|-|-|
 | `SEND_PWM_BY_TIMER` | Before `#include <IRremote.h>` | disabled | Disable carrier PWM generation in software and use (restricted) hardware PWM ecxept for ESP32 where both modes are using the flexible `hw_timer_t`. |
 | `USE_NO_SEND_PWM` | Before `#include <IRremote.h>` | disabled | Use no carrier PWM, just simulate an active low receiver signal. Overrides `SEND_PWM_BY_TIMER` definition. |
-| `USE_OLD_DECODE` | IRremoteInt.h | disabled | Enables the old decoder in order to be version 2.x compatible, where all protocols -especially NEC, Panasonic, Sony, Samsung and JVC- were MSB first. |
+| `NO_LEGACY_COMPATIBILITY` | IRremoteInt.h | disabled | Disables the old decoder for version 2.x compatibility, where all protocols -especially NEC, Panasonic, Sony, Samsung and JVC- were MSB first. Saves around 60 bytes program space and 14 bytes RAM. |
 | `EXCLUDE_EXOTIC_PROTOCOLS` | Before `#include <IRremote.h>` | disabled | If activated, BOSEWAVE, MAGIQUEST,WHYNTER and LEGO_PF are excluded in `decode()` and in sending with `IrSender.write()`. Saves up to 900 bytes program space. |
 | `MARK_EXCESS_MICROS` | Before `#include <IRremote.h>` | 20 | MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, to compensate for the signal forming of different IR receiver modules. |
 | `FEEDBACK_LED_IS_ACTIVE_LOW` | Before `#include <IRremote.h>` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |

changelog.md

@@ -4,6 +4,8 @@ The latest version may not be released!
 ## 3.1.1
 - Fix for ESP32 send Error, removed `USE_SOFT_SEND_PWM` macro.
 - Added Onkyo protocol.
+- Support for old 2.x code by backwards compatible `decode(decode_results *aResults)` function.
+- Removed USE_OLD_DECODE macro and added NO_LEGACY_COMPATIBILITY macro.
 
 ## 3.1.0
 - Generation of PWM by software is active by default.

examples/IRremoteInfo/IRremoteInfo.ino

@@ -275,13 +275,6 @@ void dumpProtocols() {
  Serial.println(F("Disabled"));
 #endif
 
- Serial.print(F("SHARP: "));
-#if defined(DECODE_SHARP)
- Serial.println(F("Enabled"));
-#else
- Serial.println(F("Disabled"));
-#endif
-
  Serial.print(F("DENON: "));
 #if defined(DECODE_DENON)
  Serial.println(F("Enabled"));

examples/SimpleReceiver/SimpleReceiver.ino

@@ -15,13 +15,12 @@
  * Specify which protocol(s) should be used for decoding.
  * If no protocol is defined, all protocols are active.
  */
-//#define DECODE_DENON
-//#define DECODE_SHARP // the same as DECODE_DENON
+//#define DECODE_DENON // Includes Sharp
 //#define DECODE_JVC
 //#define DECODE_KASEIKYO
 //#define DECODE_PANASONIC // the same as DECODE_KASEIKYO
 //#define DECODE_LG
-#define DECODE_NEC
+#define DECODE_NEC // Includes Apple and Onkyo
 //#define DECODE_SAMSUNG
 //#define DECODE_SONY
 //#define DECODE_RC5

src/IRReceive.cpp.h

@@ -246,13 +246,6 @@ bool IRrecv::decode() {
  return false;
  }
 
-#if defined(USE_OLD_DECODE)
- // Copy 3 values from irparams for legacy compatibility
- results.rawbuf = irparams.rawbuf;
- results.rawlen = irparams.rawlen;
- results.overflow = irparams.OverflowFlag;
-#endif
-
  initDecodedIRData(); // sets IRDATA_FLAGS_WAS_OVERFLOW
 
  if (decodedIRData.flags & IRDATA_FLAGS_WAS_OVERFLOW) {
@@ -270,20 +263,13 @@ bool IRrecv::decode() {
  }
 #endif
 
-#if defined(DECODE_PANASONIC)
+#if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO)
  TRACE_PRINTLN("Attempting Panasonic/Kaseikyo decode");
  if (decodeKaseikyo()) {
  return true;
  }
 #endif
 
-#if defined(DECODE_KASEIKYO) && defined(USE_OLD_DECODE) // if not USE_OLD_DECODE enabled, decodeKaseikyo() is already called by decodePanasonic()
- TRACE_PRINTLN("Attempting Panasonic/Kaseikyo decode");
- if (decodeKaseikyo()) {
- return true;
- }
-#endif
-
 #if defined(DECODE_DENON)
  TRACE_PRINTLN("Attempting Denon/Sharp decode");
  if (decodeDenon()) {
@@ -298,13 +284,6 @@ bool IRrecv::decode() {
  }
 #endif
 
-#if defined(DECODE_SHARP) && ! defined(DECODE_DENON)
- TRACE_PRINTLN("Attempting Denon/Sharp decode");
- if (decodeSharp()) {
- return true;
- }
-#endif
-
 #if defined(DECODE_RC5)
  TRACE_PRINTLN("Attempting RC5 decode");
  if (decodeRC5()) {
@@ -335,15 +314,9 @@ bool IRrecv::decode() {
 
 #if defined(DECODE_SAMSUNG)
  TRACE_PRINTLN("Attempting Samsung decode");
-#if !defined(USE_OLD_DECODE)
  if (decodeSamsung()) {
  return true;
  }
-#else
- if (decodeSAMSUNG()) {
- return true;
- }
-#endif
 #endif
  /*
  * Start of the exotic protocols
@@ -696,7 +669,6 @@ uint8_t IRrecv::compare(unsigned int oldval, unsigned int newval) {
  *
  * see: http://arcfn.com/2010/01/using-arbitrary-remotes-with-arduino.html
  */
-# if !defined(USE_OLD_DECODE)
 bool IRrecv::decodeHash() {
  long hash = FNV_BASIS_32;
 
@@ -717,29 +689,30 @@ bool IRrecv::decodeHash() {
 
  return true;
 }
-# else
 
-bool IRrecv::decodeHash() {
+# if !defined(NO_LEGACY_COMPATIBILITY)
+bool IRrecv::decodeHashOld(decode_results *aResults) {
  long hash = FNV_BASIS_32;
 
 // Require at least 6 samples to prevent triggering on noise
- if (results.rawlen < 6) {
+ if (aResults->rawlen < 6) {
  return false;
  }
 
- for (unsigned int i = 1; (i + 2) < results.rawlen; i++) {
- uint8_t value = compare(results.rawbuf[i], results.rawbuf[i + 2]);
+ for (unsigned int i = 1; (i + 2) < aResults->rawlen; i++) {
+ uint8_t value = compare(aResults->rawbuf[i], aResults->rawbuf[i + 2]);
  // Add value into the hash
  hash = (hash * FNV_PRIME_32) ^ value;
  }
 
- results.value = hash;
- results.bits = 32;
+ aResults->value = hash;
+ aResults->bits = 32;
+ aResults->decode_type = UNKNOWN;
  decodedIRData.protocol = UNKNOWN;
 
  return true;
 }
-# endif // !defined(USE_OLD_DECODE)
+# endif
 #endif // DECODE_HASH
 
 /**********************************************************************************************************************
@@ -916,15 +889,11 @@ void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, uint16_t aLeadingSpa
  aSerial->print(aIRDataPtr->numberOfBits, DEC);
  aSerial->print(F(" bits"));
 
-#if !defined(USE_OLD_DECODE)
  if (aIRDataPtr->flags & IRDATA_FLAGS_IS_MSB_FIRST) {
  aSerial->println(F(" MSB first"));
  } else {
  aSerial->println(F(" LSB first"));
  }
-#else
- aSerial->println();
-#endif
 
  } else {
  aSerial->println();
@@ -1090,6 +1059,8 @@ void IRrecv::compensateAndPrintIRResultAsCArray(Print *aSerial, bool aOutputMicr
 }
 
 /**
+ * Store the decodedIRData to be used for sendRaw().
+ *
  * Compensate received values by MARK_EXCESS_MICROS, like it is done for decoding and store it in an array provided.
  *
  * Maximum for uint8_t is 255*50 microseconds = 12750 microseconds = 12.75 ms, which hardly ever occurs inside an IR sequence.
@@ -1115,12 +1086,7 @@ void IRrecv::compensateAndStoreIRResultInArray(uint8_t *aArrayPtr) {
 }
 
 /**
- * Store the decode_results structure to be used for sendRaw().
- *
- * Compensate received values by MARK_EXCESS_MICROS, like it is done for decoding!
- * Maximum for uint8_t is 255*50 microseconds = 12750 microseconds = 12.75 ms, which hardly ever occurs inside an IR sequence.
- * Recording of IRremote anyway stops at a gap of RECORD_GAP_MICROS (5 ms).
- *
+ * Print results as C variables to be used for sendXXX()
  * @param aSerial The Print object on which to write, for Arduino you can use &Serial.
  */
 void IRrecv::printIRResultAsCVariables(Print *aSerial) {
@@ -1351,14 +1317,131 @@ ISR () // for functions definitions which are called by separate (board specific
 #endif
 }
 
+#if !defined(NO_LEGACY_COMPATIBILITY)
 /**********************************************************************************************************************
  * The DEPRECATED decode function with parameter aResults for backwards compatibility
  **********************************************************************************************************************/
 bool IRrecv::decode(decode_results *aResults) {
- Serial.println(
- "The function decode(&results)) is deprecated and may not work as expected! Just use decode() - without any parameter.");
- (void) aResults;
- return decode();
+ static bool sDeprecationMessageSent = false;
+
+ if (irparams.StateForISR != IR_REC_STATE_STOP) {
+ return false;
+ }
+
+ if (!sDeprecationMessageSent) {
+ Serial.println(
+ "The function decode(&results)) is deprecated and may not work as expected! Just use decode() without a parameter and IrReceiver.decodedIRData.<fieldname> .");
+ sDeprecationMessageSent = true;
+ }
+
+ // copy for usage by legacy programs
+ aResults->rawbuf = irparams.rawbuf;
+ aResults->rawlen = irparams.rawlen;
+ if (irparams.OverflowFlag) {
+ // Copy overflow flag to decodedIRData.flags
+ irparams.OverflowFlag = false;
+ irparams.rawlen = 0; // otherwise we have OverflowFlag again at next ISR call
+ DBG_PRINTLN("Overflow happened");
+ }
+ aResults->overflow = irparams.OverflowFlag;
+ aResults->value = 0;
+
+ decodedIRData.rawDataPtr = &irparams; // for decodePulseDistanceData() etc.
+ decodedIRData.flags = IRDATA_FLAGS_IS_MSB_FIRST; // for print
+
+#if defined(DECODE_NEC)
+ DBG_PRINTLN("Attempting old NEC decode");
+ if (decodeNECMSB(aResults)) {
+ return true ;
+ }
+#endif
+
+#if defined(DECODE_SONY)
+ DBG_PRINTLN("Attempting old Sony decode");
+ if (decodeSonyMSB(aResults)) {
+ return true ;
+ }
+#endif
+
+//#if defined(DECODE_MITSUBISHI)
+// DBG_PRINTLN("Attempting Mitsubishi decode");
+// if (decodeMitsubishi(results)) return true ;
+//#endif
+
+#if defined(DECODE_RC5)
+ DBG_PRINTLN("Attempting RC5 decode");
+ if (decodeRC5()) {
+ aResults->bits = decodedIRData.numberOfBits;
+ aResults->value = decodedIRData.decodedRawData;
+ aResults->decode_type = RC5;
+
+ return true ;
+ }
+#endif
+
+#if defined(DECODE_RC6)
+ DBG_PRINTLN("Attempting RC6 decode");
+ if (decodeRC6()) {
+ aResults->bits = decodedIRData.numberOfBits;
+ aResults->value = decodedIRData.decodedRawData;
+ aResults->decode_type = RC6;
+ return true ;
+ }
+#endif
+
+#if defined( DECODE_PANASONIC)
+ DBG_PRINTLN("Attempting old Panasonic decode");
+ if (decodePanasonicMSB(aResults)) {
+ return true ;
+ }
+#endif
+
+#if defined(DECODE_LG)
+ DBG_PRINTLN("Attempting old LG decode");
+ if (decodeLGMSB(aResults)) { return true ;}
+#endif
+
+#if defined(DECODE_JVC)
+ DBG_PRINTLN("Attempting old JVC decode");
+ if (decodeJVCMSB(aResults)) {
+ return true ;
+ }
+#endif
+
+#if defined(DECODE_SAMSUNG)
+ DBG_PRINTLN("Attempting old SAMSUNG decode");
+ if (decodeSAMSUNG(aResults)) {
+ return true ;
+ }
+#endif
+
+//#if defined(DECODE_WHYNTER)
+// DBG_PRINTLN("Attempting Whynter decode");
+// if (decodeWhynter(results)) return true ;
+//#endif
+
+#if defined(DECODE_DENON)
+ DBG_PRINTLN("Attempting old Denon decode");
+ if (decodeDenonOld(aResults)) {
+ return true ;
+ }
+#endif
+
+//#if defined(DECODE_LEGO_PF)
+// DBG_PRINTLN("Attempting Lego Power Functions");
+// if (decodeLegoPowerFunctions(results)) return true ;
+//#endif
+
+ // decodeHash returns a hash on any input.
+ // Thus, it needs to be last in the list.
+ // If you add any decodes, add them before this.
+ if (decodeHashOld(aResults)) {
+ return true;
+ }
+ // Throw away and start over
+ resume();
+ return false;
 }
+#endif
 
 /** @}*/

src/IRremote.h

@@ -63,17 +63,16 @@
  * Each protocol you include costs memory and, during decode, costs time
  * Disable (deactivate the line by adding a trailing comment "//") all the protocols you do not need/want!
  */
-#if (!(defined(DECODE_DENON) || defined(DECODE_SHARP) || defined(DECODE_JVC) || defined(DECODE_KASEIKYO) \
+#if (!(defined(DECODE_DENON) || defined(DECODE_JVC) || defined(DECODE_KASEIKYO) \
 || defined(DECODE_PANASONIC) || defined(DECODE_LG) || defined(DECODE_NEC) || defined(DECODE_SAMSUNG) \
 || defined(DECODE_SONY) || defined(DECODE_RC5) || defined(DECODE_RC6) || defined(DECODE_HASH) \
 || defined(DECODE_BOSEWAVE) || defined(DECODE_LEGO_PF) || defined(DECODE_MAGIQUEST) || defined(DECODE_WHYNTER)))
-#define DECODE_DENON
-#define DECODE_SHARP // the same as DECODE_DENON
+#define DECODE_DENON // Includes Sharp
 #define DECODE_JVC
 #define DECODE_KASEIKYO
 #define DECODE_PANASONIC // the same as DECODE_KASEIKYO
 #define DECODE_LG
-#define DECODE_NEC
+#define DECODE_NEC // Includes Apple and Onkyo
 #define DECODE_SAMSUNG
 #define DECODE_SONY
 #define DECODE_RC5