factory.h
Go to the documentation of this file.
/* PipeWire
*
* 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 PIPEWIRE_FACTORY_H
#define PIPEWIRE_FACTORY_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdarg.h>
#include <errno.h>
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
#include <pipewire/proxy.h>
#define PW_TYPE_INTERFACE_Factory PW_TYPE_INFO_INTERFACE_BASE "Factory"
#define PW_VERSION_FACTORY 3
struct pw_factory;
struct pw_factory_info {
uint32_t id;
const char *name;
const char *type;
uint32_t version;
#define PW_FACTORY_CHANGE_MASK_PROPS (1 << 0)
#define PW_FACTORY_CHANGE_MASK_ALL ((1 << 1)-1)
uint64_t change_mask;
struct spa_dict *props;
};
struct pw_factory_info *
pw_factory_info_update(struct pw_factory_info *info,
const struct pw_factory_info *update);
struct pw_factory_info *
pw_factory_info_merge(struct pw_factory_info *info,
const struct pw_factory_info *update, bool reset);
void
pw_factory_info_free(struct pw_factory_info *info);
#define PW_FACTORY_EVENT_INFO 0
#define PW_FACTORY_EVENT_NUM 1
struct pw_factory_events {
#define PW_VERSION_FACTORY_EVENTS 0
uint32_t version;
void (*info) (void *object, const struct pw_factory_info *info);
};
#define PW_FACTORY_METHOD_ADD_LISTENER 0
#define PW_FACTORY_METHOD_NUM 1
struct pw_factory_methods {
#define PW_VERSION_FACTORY_METHODS 0
uint32_t version;
int (*add_listener) (void *object,
struct spa_hook *listener,
const struct pw_factory_events *events,
void *data);
};
#define pw_factory_method(o,method,version,...) \
({ \
int _res = -ENOTSUP; \
spa_interface_call_res((struct spa_interface*)o, \
struct pw_factory_methods, _res, \
method, version, ##__VA_ARGS__); \
_res; \
})
#define pw_factory_add_listener(c,...) pw_factory_method(c,add_listener,0,__VA_ARGS__)
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* PIPEWIRE_FACTORY_H */
defs.h
spa/utils/defs.h
pw_factory_info_merge
struct pw_factory_info * pw_factory_info_merge(struct pw_factory_info *info, const struct pw_factory_info *update, bool reset)
Definition: introspect.c:317
pw_factory_info_update
struct pw_factory_info * pw_factory_info_update(struct pw_factory_info *info, const struct pw_factory_info *update)
Definition: introspect.c:346
pw_factory_info_free
void pw_factory_info_free(struct pw_factory_info *info)
Definition: introspect.c:353
hook.h
spa/utils/hook.h
proxy.h
pipewire/proxy.h
pw_factory_events
Factory events.
Definition: factory.h:90
pw_factory_events::info
void(* info)(void *object, const struct pw_factory_info *info)
Notify factory info.
Definition: factory.h:99
pw_factory_events::version
uint32_t version
Definition: factory.h:93
pw_factory_info
The factory information.
Definition: factory.h:61
pw_factory_info::version
uint32_t version
version of the objects
Definition: factory.h:65
pw_factory_info::type
const char * type
type of the objects created by this factory
Definition: factory.h:64
pw_factory_info::id
uint32_t id
id of the global
Definition: factory.h:62
pw_factory_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: factory.h:70
pw_factory_methods
Factory methods.
Definition: factory.h:108
pw_factory_methods::version
uint32_t version
Definition: factory.h:111
pw_factory_methods::add_listener
int(* add_listener)(void *object, struct spa_hook *listener, const struct pw_factory_events *events, void *data)
Definition: factory.h:113
pw_factory
spa_dict
Definition: dict.h:59
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342