AudioTimer.h

Go to the documentation of this file.

#pragma once
#include "AudioToolsConfig.h"
#if defined(USE_TIMER)
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerAVR.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerBase.h"
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerESP32.h"
#endif
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerESP32Legacy.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerESP8266.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerMBED.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerRP2040.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerRenesas.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerSTM32.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerDesktop.h"
#include "AudioTools/CoreAudio/AudioTimer/AudioTimerZephyr.h"
#include "AudioTools/CoreAudio/AudioLogger.h"
 
namespace audio_tools {
 
class AudioTimer {
 public:
  AudioTimer() = default;
  AudioTimer(AudioTimerDriverBase& timer) {
    setDriver(timer);
  };
  virtual ~AudioTimer() = default;
 
  bool begin(repeating_timer_callback_t callback_f, uint32_t time,
             TimeUnit unit = MS) {
    // stop timer if it is already active          
    if (is_active) end();
    // start timer
    is_active = p_timer->begin(callback_f, time, unit);
    return is_active;
  }
  bool end() {
    is_active = false;
    return p_timer->end();
  };
 
  void setCallbackParameter(void* obj) { p_timer->setCallbackParameter(obj); }
 
  void* callbackParameter() { return p_timer->callbackParameter(); }
 
  virtual void setTimer(int timer) { p_timer->setTimer(timer); }
 
  virtual void setTimerFunction(TimerFunction function = DirectTimerCallback) {
    p_timer->setTimerFunction(function);
  }
 
  void setIsSave(bool is_save) { p_timer->setIsSave(is_save); }
 
  operator bool() { return is_active; }
 
  AudioTimerDriverBase* driver() { return p_timer; }
  
  void setDriver(AudioTimerDriverBase& timer) {
    p_timer = &timer;
  }
 
 protected:
  void* object = nullptr;
  bool is_active = false;
  AudioTimerDriver timer;  // platform specific timer
  AudioTimerDriverBase* p_timer = &timer;
};
 
// Support for legacy name
using TimerAlarmRepeating = AudioTimer;
 
}  // namespace audio_tools
 
#endif