event_manager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __GUI_BACKEND_EVENT_MANAGER_H__
#define __GUI_BACKEND_EVENT_MANAGER_H__
 
#include "utils/backtrace.h"
#include "utils/mpmc_queue.h"
#include "utils/object_pool.h"
 
#include <glib.h>
 
class Zrythm;
typedef struct ZEvent ZEvent;
 
typedef struct EventManager
{
  MPMCQueue * mqueue;
 
  ObjectPool * obj_pool;
 
  guint process_source_id;
 
  bool pending_soft_recalc;
 
  GPtrArray * events_arr;
} EventManager;
 
#define EVENT_MANAGER (gZrythm->event_manager)
 
#define EVENT_QUEUE (EVENT_MANAGER->mqueue)
 
#define EVENT_MANAGER_MAX_EVENTS 4000
 
#define event_queue_push_back_event(q, x) mpmc_queue_push_back (q, (void *) x)
 
#define event_queue_dequeue_event(q, x) mpmc_queue_dequeue (q, (void **) x)
 
#define EVENTS_PUSH(et, _arg) \
  if ( \
    ZRYTHM_HAVE_UI && EVENT_MANAGER && EVENT_QUEUE \
    && (!PROJECT || !AUDIO_ENGINE || !AUDIO_ENGINE->exporting) \
    && EVENT_MANAGER->process_source_id) \
    { \
      ZEvent * _ev = (ZEvent *) object_pool_get (EVENT_MANAGER->obj_pool); \
      _ev->file = __FILE__; \
      _ev->func = __func__; \
      _ev->lineno = __LINE__; \
      _ev->type = (et); \
      _ev->arg = (void *) (_arg); \
      if ( \
        zrythm_app->gtk_thread == g_thread_self () /* skip backtrace for now */ \
        && false) \
        { \
          _ev->backtrace = backtrace_get ("", 40, false); \
        } \
      /* don't print events that are called \
       * continuously */ \
      if ( \
        (et) != EventType::ET_PLAYHEAD_POS_CHANGED \
        && g_thread_self () == zrythm_app->gtk_thread) \
        { \
          g_debug ("pushing UI event " #et " (%s:%d)", __func__, __LINE__); \
        } \
      event_queue_push_back_event (EVENT_QUEUE, _ev); \
    }
 
/* runs the event logic now */
#define EVENTS_PUSH_NOW(et, _arg) \
  if ( \
    ZRYTHM_HAVE_UI && EVENT_MANAGER && EVENT_QUEUE \
    && zrythm_app->gtk_thread == g_thread_self () \
    && (!PROJECT || !AUDIO_ENGINE || !AUDIO_ENGINE->exporting) \
    && EVENT_MANAGER->process_source_id) \
    { \
      ZEvent * _ev = (ZEvent *) object_pool_get (EVENT_MANAGER->obj_pool); \
      _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 ("", 40, false); \
        } \
      /* don't print events that are called \
       * continuously */ \
      if (et != EventType::ET_PLAYHEAD_POS_CHANGED) \
        { \
          g_debug ( \
            "processing UI event now " #et " (%s:%d)", __func__, __LINE__); \
        } \
      event_manager_process_event (EVENT_MANAGER, _ev); \
      object_pool_return (EVENT_MANAGER->obj_pool, _ev); \
    }
 
EventManager *
event_manager_new (void);
 
void
event_manager_start_events (EventManager * self);
 
void
event_manager_stop_events (EventManager * self);
 
void
event_manager_process_event (EventManager * self, ZEvent * ev);
 
void
event_manager_process_now (EventManager * self);
 
void
event_manager_remove_events_for_obj (EventManager * self, void * obj);
 
void
event_manager_free (EventManager * self);
 
#endif