mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-10 13:30:05 -05:00
caaeaff223
Reorganise the SPA includes to make it more extensible later Simplify the naming of the buffer and meta params
95 lines
2.7 KiB
C
95 lines
2.7 KiB
C
/* PipeWire
|
|
* Copyright (C) 2016 Axis Communications <dev-gstreamer@axis.com>
|
|
* @author Linus Svensson <linus.svensson@axis.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __PIPEWIRE_MODULE_H__
|
|
#define __PIPEWIRE_MODULE_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <spa/utils/hook.h>
|
|
|
|
#include <pipewire/core.h>
|
|
|
|
#define PW_TYPE__Module PW_TYPE_OBJECT_BASE "Module"
|
|
#define PW_TYPE_MODULE_BASE PW_TYPE__Module ":"
|
|
|
|
#define PIPEWIRE_SYMBOL_MODULE_INIT "pipewire__module_init"
|
|
|
|
/** \class pw_module
|
|
*
|
|
* A dynamically loadable module
|
|
*/
|
|
struct pw_module;
|
|
|
|
/** Module init function signature
|
|
*
|
|
* \param module A \ref pw_module
|
|
* \param args Arguments to the module
|
|
* \return true on success, false otherwise
|
|
*
|
|
* A module should provide an init function with this signature. This function
|
|
* will be called when a module is loaded.
|
|
*
|
|
* \memberof pw_module
|
|
*/
|
|
typedef bool (*pw_module_init_func_t) (struct pw_module *module, const char *args);
|
|
|
|
/** Module events added with \ref pw_module_add_listener */
|
|
struct pw_module_events {
|
|
#define PW_VERSION_MODULE_EVENTS 0
|
|
uint32_t version;
|
|
|
|
/** The module id destroyed */
|
|
void (*destroy) (void *data);
|
|
};
|
|
|
|
/** Load a module by name and arguments and register it */
|
|
struct pw_module *
|
|
pw_module_load(struct pw_core *core, const char *name, const char *args);
|
|
|
|
/** Get the core of a module */
|
|
struct pw_core * pw_module_get_core(struct pw_module *module);
|
|
|
|
/** Get the global of a module */
|
|
struct pw_global * pw_module_get_global(struct pw_module *module);
|
|
|
|
/** Get the module info */
|
|
const struct pw_module_info *pw_module_get_info(struct pw_module *module);
|
|
|
|
/** Add an event listener to a module */
|
|
void pw_module_add_listener(struct pw_module *module,
|
|
struct spa_hook *listener,
|
|
const struct pw_module_events *events,
|
|
void *data);
|
|
|
|
/** Destroy a module */
|
|
void pw_module_destroy(struct pw_module *module);
|
|
|
|
/** Find a module by filename */
|
|
struct pw_module *
|
|
pw_core_find_module(struct pw_core *core, const char *filename);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PIPEWIRE_MODULE_H__ */
|