spa/include/spa/support/loop.h

Go to the documentation of this file.

/* Simple Plugin API
 *
 * Copyright © 2018 Wim Taymans
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
#ifndef SPA_LOOP_H
#define SPA_LOOP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
#include <spa/support/system.h>
 
#define SPA_TYPE_INTERFACE_Loop         SPA_TYPE_INFO_INTERFACE_BASE "Loop"
#define SPA_TYPE_INTERFACE_DataLoop     SPA_TYPE_INFO_INTERFACE_BASE "DataLoop"
#define SPA_VERSION_LOOP                0
struct spa_loop { struct spa_interface iface; };
 
#define SPA_TYPE_INTERFACE_LoopControl  SPA_TYPE_INFO_INTERFACE_BASE "LoopControl"
#define SPA_VERSION_LOOP_CONTROL        0
struct spa_loop_control { struct spa_interface iface; };
 
#define SPA_TYPE_INTERFACE_LoopUtils    SPA_TYPE_INFO_INTERFACE_BASE "LoopUtils"
#define SPA_VERSION_LOOP_UTILS          0
struct spa_loop_utils { struct spa_interface iface; };
 
struct spa_source;
 
typedef void (*spa_source_func_t) (struct spa_source *source);
 
struct spa_source {
        struct spa_loop *loop;
        spa_source_func_t func;
        void *data;
        int fd;
        uint32_t mask;
        uint32_t rmask;
        /* private data for the loop implementer */
        void *priv;
};
 
typedef int (*spa_invoke_func_t) (struct spa_loop *loop,
                                  bool async,
                                  uint32_t seq,
                                  const void *data,
                                  size_t size,
                                  void *user_data);
 
struct spa_loop_methods {
        /* the version of this structure. This can be used to expand this
         * structure in the future */
#define SPA_VERSION_LOOP_METHODS        0
        uint32_t version;
 
        int (*add_source) (void *object,
                           struct spa_source *source);
 
        int (*update_source) (void *object,
                        struct spa_source *source);
 
        int (*remove_source) (void *object,
                        struct spa_source *source);
 
        int (*invoke) (void *object,
                       spa_invoke_func_t func,
                       uint32_t seq,
                       const void *data,
                       size_t size,
                       bool block,
                       void *user_data);
};
 
#define spa_loop_method(o,method,version,...)                           \
({                                                                      \
        int _res = -ENOTSUP;                                            \
        struct spa_loop *_o = o;                                        \
        spa_interface_call_res(&_o->iface,                              \
                        struct spa_loop_methods, _res,                  \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
 
#define spa_loop_add_source(l,...)      spa_loop_method(l,add_source,0,##__VA_ARGS__)
#define spa_loop_update_source(l,...)   spa_loop_method(l,update_source,0,##__VA_ARGS__)
#define spa_loop_remove_source(l,...)   spa_loop_method(l,remove_source,0,##__VA_ARGS__)
#define spa_loop_invoke(l,...)          spa_loop_method(l,invoke,0,##__VA_ARGS__)
 
 
struct spa_loop_control_hooks {
#define SPA_VERSION_LOOP_CONTROL_HOOKS  0
        uint32_t version;
        void (*before) (void *data);
        void (*after) (void *data);
};
 
#define spa_loop_control_hook_before(l)                                                 \
({                                                                                      \
        struct spa_hook_list *_l = l;                                                   \
        struct spa_hook *_h;                                                            \
        spa_list_for_each_reverse(_h, &_l->list, link)                                  \
                spa_callbacks_call(&_h->cb, struct spa_loop_control_hooks, before, 0);  \
})
 
#define spa_loop_control_hook_after(l)                                                  \
({                                                                                      \
        struct spa_hook_list *_l = l;                                                   \
        struct spa_hook *_h;                                                            \
        spa_list_for_each(_h, &_l->list, link)                                          \
                spa_callbacks_call(&_h->cb, struct spa_loop_control_hooks, after, 0);   \
})
 
struct spa_loop_control_methods {
        /* the version of this structure. This can be used to expand this
         * structure in the future */
#define SPA_VERSION_LOOP_CONTROL_METHODS        0
        uint32_t version;
 
        int (*get_fd) (void *object);
 
        void (*add_hook) (void *object,
                          struct spa_hook *hook,
                          const struct spa_loop_control_hooks *hooks,
                          void *data);
 
        void (*enter) (void *object);
        void (*leave) (void *object);
 
        int (*iterate) (void *object, int timeout);
};
 
#define spa_loop_control_method_v(o,method,version,...)                 \
({                                                                      \
        struct spa_loop_control *_o = o;                                \
        spa_interface_call(&_o->iface,                                  \
                        struct spa_loop_control_methods,                \
                        method, version, ##__VA_ARGS__);                \
})
 
#define spa_loop_control_method_r(o,method,version,...)                 \
({                                                                      \
        int _res = -ENOTSUP;                                            \
        struct spa_loop_control *_o = o;                                \
        spa_interface_call_res(&_o->iface,                              \
                        struct spa_loop_control_methods, _res,          \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
 
#define spa_loop_control_get_fd(l)              spa_loop_control_method_r(l,get_fd,0)
#define spa_loop_control_add_hook(l,...)        spa_loop_control_method_v(l,add_hook,0,__VA_ARGS__)
#define spa_loop_control_enter(l)               spa_loop_control_method_v(l,enter,0)
#define spa_loop_control_leave(l)               spa_loop_control_method_v(l,leave,0)
#define spa_loop_control_iterate(l,...)         spa_loop_control_method_r(l,iterate,0,__VA_ARGS__)
 
typedef void (*spa_source_io_func_t) (void *data, int fd, uint32_t mask);
typedef void (*spa_source_idle_func_t) (void *data);
typedef void (*spa_source_event_func_t) (void *data, uint64_t count);
typedef void (*spa_source_timer_func_t) (void *data, uint64_t expirations);
typedef void (*spa_source_signal_func_t) (void *data, int signal_number);
 
struct spa_loop_utils_methods {
        /* the version of this structure. This can be used to expand this
         * structure in the future */
#define SPA_VERSION_LOOP_UTILS_METHODS  0
        uint32_t version;
 
        struct spa_source *(*add_io) (void *object,
                                      int fd,
                                      uint32_t mask,
                                      bool close,
                                      spa_source_io_func_t func, void *data);
 
        int (*update_io) (void *object, struct spa_source *source, uint32_t mask);
 
        struct spa_source *(*add_idle) (void *object,
                                        bool enabled,
                                        spa_source_idle_func_t func, void *data);
        int (*enable_idle) (void *object, struct spa_source *source, bool enabled);
 
        struct spa_source *(*add_event) (void *object,
                                         spa_source_event_func_t func, void *data);
        int (*signal_event) (void *object, struct spa_source *source);
 
        struct spa_source *(*add_timer) (void *object,
                                         spa_source_timer_func_t func, void *data);
        int (*update_timer) (void *object,
                             struct spa_source *source,
                             struct timespec *value,
                             struct timespec *interval,
                             bool absolute);
        struct spa_source *(*add_signal) (void *object,
                                          int signal_number,
                                          spa_source_signal_func_t func, void *data);
 
        void (*destroy_source) (void *object, struct spa_source *source);
};
 
#define spa_loop_utils_method_v(o,method,version,...)                   \
({                                                                      \
        struct spa_loop_utils *_o = o;                                  \
        spa_interface_call(&_o->iface,                                  \
                        struct spa_loop_utils_methods,                  \
                        method, version, ##__VA_ARGS__);                \
})
 
#define spa_loop_utils_method_r(o,method,version,...)                   \
({                                                                      \
        int _res = -ENOTSUP;                                            \
        struct spa_loop_utils *_o = o;                                  \
        spa_interface_call_res(&_o->iface,                              \
                        struct spa_loop_utils_methods, _res,            \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
#define spa_loop_utils_method_s(o,method,version,...)                   \
({                                                                      \
        struct spa_source *_res = NULL;                                 \
        struct spa_loop_utils *_o = o;                                  \
        spa_interface_call_res(&_o->iface,                              \
                        struct spa_loop_utils_methods, _res,            \
                        method, version, ##__VA_ARGS__);                \
        _res;                                                           \
})
 
 
#define spa_loop_utils_add_io(l,...)            spa_loop_utils_method_s(l,add_io,0,__VA_ARGS__)
#define spa_loop_utils_update_io(l,...)         spa_loop_utils_method_r(l,update_io,0,__VA_ARGS__)
#define spa_loop_utils_add_idle(l,...)          spa_loop_utils_method_s(l,add_idle,0,__VA_ARGS__)
#define spa_loop_utils_enable_idle(l,...)       spa_loop_utils_method_r(l,enable_idle,0,__VA_ARGS__)
#define spa_loop_utils_add_event(l,...)         spa_loop_utils_method_s(l,add_event,0,__VA_ARGS__)
#define spa_loop_utils_signal_event(l,...)      spa_loop_utils_method_r(l,signal_event,0,__VA_ARGS__)
#define spa_loop_utils_add_timer(l,...)         spa_loop_utils_method_s(l,add_timer,0,__VA_ARGS__)
#define spa_loop_utils_update_timer(l,...)      spa_loop_utils_method_r(l,update_timer,0,__VA_ARGS__)
#define spa_loop_utils_add_signal(l,...)        spa_loop_utils_method_s(l,add_signal,0,__VA_ARGS__)
#define spa_loop_utils_destroy_source(l,...)    spa_loop_utils_method_v(l,destroy_source,0,__VA_ARGS__)
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* SPA_LOOP_H */