event_manager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2022, 2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense

#ifndef __GUI_BACKEND_EVENT_MANAGER_H__
#define __GUI_BACKEND_EVENT_MANAGER_H__
 
#include "common/utils/backtrace.h"
#include "common/utils/mpmc_queue.h"
#include "common/utils/object_pool.h"
#include "gui/backend/backend/event.h"

 
constexpr int EVENT_MANAGER_MAX_EVENTS = 4000;

class EventManager
{
public:
  EventManager ();
 
  ~EventManager () { stop_events (); }

  void start_events ();

  void stop_events ();

  void process_event (ZEvent &ev);

  bool process_events ();

  void process_now ();
 
private:
  void clean_duplicate_events_and_copy ();

  bool soft_recalc_graph_when_paused ();
 
public:
  MPMCQueue<ZEvent *> mqueue_;

  ObjectPool<ZEvent> obj_pool_;

  sigc::scoped_connection process_source_id_;

  bool pending_soft_recalc_ = false;
 
private:
  std::vector<ZEvent *> events_arr_;
};
 
#define EVENT_MANAGER (gZrythm->event_manager_)

#define EVENT_QUEUE (EVENT_MANAGER->mqueue_)
 
// temp
#define EVENTS_PUSH(et, _arg)
#define EVENTS_PUSH_NOW(et, _arg)
 
#if 0
#  define EVENTS_PUSH(et, _arg) \
    if ( \
      ZRYTHM_HAVE_UI \
      && (!PROJECT || !AUDIO_ENGINE || !AUDIO_ENGINE->exporting_) \
      && EVENT_MANAGER->process_source_id_.connected ()) \
      { \
        ZEvent * _ev = EVENT_MANAGER->obj_pool_.acquire (); \
        _ev->file_ = __FILE__; \
        _ev->func_ = __func__; \
        _ev->lineno_ = __LINE__; \
        _ev->type_ = (et); \
        _ev->arg_ = (void *) (_arg); \
        if ( \
          zrythm_app->gtk_thread_id_ == current_thread_id.get () /* skip \
                                                                 backtrace for \
                                                                 now */ \
          && false) \
          { \
            _ev->backtrace_ = Backtrace ().get_backtrace ("", 40, false); \
          } \
        /* don't print events that are called \
         * continuously */ \
        if ( \
          (et) != EventType::ET_PLAYHEAD_POS_CHANGED \
          && zrythm_app->gtk_thread_id_ == current_thread_id.get ()) \
          { \
            z_debug ("pushing UI event " #et " ({}:{})", __func__, __LINE__); \
          } \
        EVENT_QUEUE.push_back (_ev); \
      }
 
/* runs the event logic now */
#  define EVENTS_PUSH_NOW(et, _arg) \
    if ( \
      ZRYTHM_HAVE_UI && EVENT_MANAGER \
      && zrythm_app->gtk_thread_id_ == current_thread_id.get () \
      && (!PROJECT || !AUDIO_ENGINE || !AUDIO_ENGINE->exporting_) \
      && EVENT_MANAGER->process_source_id_.connected ()) \
      { \
        ZEvent * _ev = EVENT_MANAGER->obj_pool_.acquire (); \
        _ev->file_ = __FILE__; \
        _ev->func_ = __func__; \
        _ev->lineno_ = __LINE__; \
        _ev->type_ = et; \
        _ev->arg_ = (void *) _arg; \
        if (/* skip backtrace for now */ \
            false) \
          { \
            _ev->backtrace_ = Backtrace ().get_backtrace ("", 40, false); \
          } \
        /* don't print events that are called continuously */ \
        if (et != EventType::ET_PLAYHEAD_POS_CHANGED) \
          { \
            z_debug ( \
              "processing UI event now " #et " ({}:{})", __func__, __LINE__); \
          } \
        EVENT_MANAGER->process_event (*_ev); \
        EVENT_MANAGER->obj_pool_.release (_ev); \
      }
#endif

 
#endif