mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/spa/include/spa/defs.h

185 lines
6.5 KiB
C
Raw Normal View History

more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
/* Simple Plugin API
* Copyright (C) 2016 Wim Taymans <wim.taymans@gmail.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 __SPA_DEFS_H__
#define __SPA_DEFS_H__
#ifdef __cplusplus
extern "C" {
#else
#include <stdbool.h>
#endif
#include <inttypes.h>
#include <stdlib.h>
Work on event loop Make a new epoll based event loop and use it for the data tranport. Simplify the spa event api a little and rename to SpaLoop
2016-11-18 17:46:01 +01:00
#include <string.h>
Make buffer structure sharable Use stucture offsets instead of pointers so that we can share the buffer structure between client and server. We can then pass an fd wrapping the memory of the buffer to the client. Add beginnings of a memory pool
2016-08-03 15:59:17 +02:00
#include <stddef.h>
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
enum {
Add support for async results Add an async result code and an event to signal the completion. Use async return values to signal completion of a method and potential state change. Add selected format to port update message. Make it possible to parse into a custom copy of the command memory. Remove state change events from the elements, we now just update the state. Implement async results in the proxy element Add support for removing buffers in the client. Fix up pinossink Deal with async return in the links.
2016-09-22 08:55:30 +02:00
SPA_RESULT_ASYNC = (1 << 30),
Work on async cleanup Track all async changes and only perform free of resources when all previous async operations completed.
2016-11-25 13:06:23 +01:00
SPA_RESULT_WAIT_SYNC = 2,
Add support for async results Add an async result code and an event to signal the completion. Use async return values to signal completion of a method and potential state change. Add selected format to port update message. Make it possible to parse into a custom copy of the command memory. Remove state change events from the elements, we now just update the state. Implement async results in the proxy element Add support for removing buffers in the client. Fix up pinossink Deal with async return in the links.
2016-09-22 08:55:30 +02:00
SPA_RESULT_MODIFIED = 1,
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
SPA_RESULT_OK = 0,
SPA_RESULT_ERROR = -1,
WIP change object model
2016-11-14 12:42:00 +01:00
SPA_RESULT_ERRNO = -2,
SPA_RESULT_INACTIVE = -3,
SPA_RESULT_NO_FORMAT = -4,
SPA_RESULT_INVALID_COMMAND = -5,
SPA_RESULT_INVALID_PORT = -6,
Rename buffer status to make it more symetrical Only try to pull once in a timeout. We can reuse the last returned state as our internal state in audiomixer.
2017-04-28 11:49:13 +02:00
SPA_RESULT_HAVE_BUFFER = -7,
SPA_RESULT_NEED_BUFFER = -8,
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
SPA_RESULT_PORTS_CHANGED = -9,
SPA_RESULT_FORMAT_CHANGED = -10,
SPA_RESULT_PROPERTIES_CHANGED = -11,
SPA_RESULT_NOT_IMPLEMENTED = -12,
SPA_RESULT_INVALID_PROPERTY_INDEX = -13,
SPA_RESULT_PROPERTY_UNSET = -14,
SPA_RESULT_ENUM_END = -15,
SPA_RESULT_WRONG_PROPERTY_TYPE = -16,
SPA_RESULT_WRONG_PROPERTY_SIZE = -17,
SPA_RESULT_INVALID_MEDIA_TYPE = -18,
SPA_RESULT_INVALID_FORMAT_PROPERTIES = -19,
SPA_RESULT_FORMAT_INCOMPLETE = -20,
SPA_RESULT_INVALID_ARGUMENTS = -21,
SPA_RESULT_UNKNOWN_INTERFACE = -22,
SPA_RESULT_INVALID_DIRECTION = -23,
SPA_RESULT_TOO_MANY_PORTS = -24,
SPA_RESULT_INVALID_PROPERTY_ACCESS = -25,
v4l2: continue work on the capture device Remove activate and deactivate commands. Add STEP property range type for v4l2 frame sizes later v4l2: implement negotiation and data capture
2016-07-06 19:43:37 +02:00
SPA_RESULT_UNEXPECTED = -26,
More work on implementing remote protocol Rework things so that we negotiate buffer pools beforehand and only pass buffer ids around We can then remove the refcount of buffers, events and commands. More work on buffer reuse Use the node state changes to trigger the next step in the configuration sequence. Move most of the client-node to a plugin Do buffer allocation in the port link.
2016-08-02 16:34:44 +02:00
SPA_RESULT_NO_BUFFERS = -27,
SPA_RESULT_INVALID_BUFFER_ID = -28,
Improve state handling Improve the state handling in v4l2 Send buffers in one message Update design doc
2016-08-25 17:07:40 +02:00
SPA_RESULT_WRONG_STATE = -29,
Add support for async results Add an async result code and an event to signal the completion. Use async return values to signal completion of a method and potential state change. Add selected format to port update message. Make it possible to parse into a custom copy of the command memory. Remove state change events from the elements, we now just update the state. Implement async results in the proxy element Add support for removing buffers in the client. Fix up pinossink Deal with async return in the links.
2016-09-22 08:55:30 +02:00
SPA_RESULT_ASYNC_BUSY = -30,
Work on introspection
2016-12-02 13:38:43 +01:00
SPA_RESULT_INVALID_OBJECT_ID = -31,
Implement subscription with a signal Use a signal for subscription events Work on handling OOM errors and other errors.
2016-12-22 16:50:01 +01:00
SPA_RESULT_NO_MEMORY = -32,
Implement access control Move send and dispatch functions to the implementation. This makes it possible to place an access check before sending and dispatching. Add module-access that allows to bind and notify on globals owned by the client.
2017-01-10 17:12:53 +01:00
SPA_RESULT_NO_PERMISSION = -33,
SPA_RESULT_SKIPPED = -34,
cleanups Update some docs Remove special structs for some events Remove some unused flags Update some plugins
2017-01-19 18:10:00 +01:00
SPA_RESULT_OUT_OF_BUFFERS = -35,
Make AllocParams into POD objects Make allocparams into pod objects. This makes it easy to serialize, copy, create and intersect them. Add convenience macros for properties Add helper function to collect object properties.
2017-03-17 11:58:09 +01:00
SPA_RESULT_INCOMPATIBLE_PROPS = -36,
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
};
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
pass the client object around Pass the client object around, it's easier to deal with than the sender id. Fix the ASYNC return check Don't overwrite the fds of a pollitem, instead keep an index of their position in the global fd array.
2016-09-27 16:59:45 +02:00
#define SPA_ASYNC_MASK (3 << 30)
#define SPA_ASYNC_SEQ_MASK (SPA_RESULT_ASYNC - 1)
Add support for async results Add an async result code and an event to signal the completion. Use async return values to signal completion of a method and potential state change. Add selected format to port update message. Make it possible to parse into a custom copy of the command memory. Remove state change events from the elements, we now just update the state. Implement async results in the proxy element Add support for removing buffers in the client. Fix up pinossink Deal with async return in the links.
2016-09-22 08:55:30 +02:00
#define SPA_RESULT_IS_OK(res) ((res) >= 0)
#define SPA_RESULT_IS_ERROR(res) ((res) < 0)
pass the client object around Pass the client object around, it's easier to deal with than the sender id. Fix the ASYNC return check Don't overwrite the fds of a pollitem, instead keep an index of their position in the global fd array.
2016-09-27 16:59:45 +02:00
#define SPA_RESULT_IS_ASYNC(res) (((res) & SPA_ASYNC_MASK) == SPA_RESULT_ASYNC)
Add support for async results Add an async result code and an event to signal the completion. Use async return values to signal completion of a method and potential state change. Add selected format to port update message. Make it possible to parse into a custom copy of the command memory. Remove state change events from the elements, we now just update the state. Implement async results in the proxy element Add support for removing buffers in the client. Fix up pinossink Deal with async return in the links.
2016-09-22 08:55:30 +02:00
#define SPA_RESULT_ASYNC_SEQ(res) ((res) & SPA_ASYNC_SEQ_MASK)
#define SPA_RESULT_RETURN_ASYNC(seq) (SPA_RESULT_ASYNC | ((seq) & SPA_ASYNC_SEQ_MASK))
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
enum spa_direction {
defs: remove invalid direction Anything not in the enum is invalid
2017-05-16 09:06:37 +02:00
SPA_DIRECTION_INPUT = 0,
SPA_DIRECTION_OUTPUT = 1,
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
};
Add port direction again simplify port numbering again by using 0->max_ports for bot input ports and output ports. This means we need to tall what direction the port is. Add port_info serialize functions Copy metadata and data when we are not sharing buffers. Make pinossink work again.
2016-10-03 19:43:42 +02:00
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
struct spa_rectangle {
Add POD helper objects POD (plain old data) objects are similar to LV2 Atoms and allows storage and construction of datastructures in memory or on the stack. They can be copied with a simple memcpy. The idea is to use this to construct the network messages and to replace the structures used for describing formats and properties.
2017-02-22 13:12:32 +01:00
uint32_t width;
uint32_t height;
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
};
Add POD helper objects POD (plain old data) objects are similar to LV2 Atoms and allows storage and construction of datastructures in memory or on the stack. They can be copied with a simple memcpy. The idea is to use this to construct the network messages and to replace the structures used for describing formats and properties.
2017-02-22 13:12:32 +01:00
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
struct spa_fraction {
Add POD helper objects POD (plain old data) objects are similar to LV2 Atoms and allows storage and construction of datastructures in memory or on the stack. They can be copied with a simple memcpy. The idea is to use this to construct the network messages and to replace the structures used for describing formats and properties.
2017-02-22 13:12:32 +01:00
uint32_t num;
uint32_t denom;
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
};
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
#define SPA_N_ELEMENTS(arr) (sizeof (arr) / sizeof ((arr)[0]))
Work on memory allocation We now only allow per port preallocated buffers. We exchange the index into the array instead of passing the buffers around. We still use the refcount to track when a buffer can be reused. Improve API a little, allow passing the node as the first argument of the interface call. Implement alloc_buffer in v4l2 and improve the test.
2016-07-30 20:35:34 +02:00
#define SPA_MIN(a,b) ((a)<(b) ? (a) : (b))
#define SPA_MAX(a,b) ((a)>(b) ? (a) : (b))
pod: handle NULL
2017-03-23 16:08:50 +01:00
#define SPA_ABS(a) ((a)>0 ? (a) : -(a))
More work on memory Add explicit DMABUF memory because we can't use it like an fd in v4l2. mmap random fd memory and use userptr in v4l2 to use it. Allocate buffer data memory in memfd when no node can allocate. Improve debug some more
2016-10-04 15:56:33 +02:00
#define SPA_CLAMP(v,a,b) ((v)>(b) ? (b) : ((v) < (a) ? (a) : (v)))
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
Make buffer structure sharable Use stucture offsets instead of pointers so that we can share the buffer structure between client and server. We can then pass an fd wrapping the memory of the buffer to the client. Add beginnings of a memory pool
2016-08-03 15:59:17 +02:00
#define SPA_MEMBER(b,o,t) ((t*)((uint8_t*)(b) + (o)))
Add poll interface and remove poll events Use an interface to change items in a poll loop.
2016-10-07 17:10:46 +02:00
#define SPA_CONTAINER_OF(p,t,m) (t*)((uint8_t*)p - offsetof (t,m))
implement set_format Serialize the formats Use SpaMemoryRef where we can Add more debug
2016-08-04 17:33:49 +02:00
#define SPA_PTRDIFF(p1,p2) ((uint8_t*)(p1) - (uint8_t*)(p2))
Make buffer structure sharable Use stucture offsets instead of pointers so that we can share the buffer structure between client and server. We can then pass an fd wrapping the memory of the buffer to the client. Add beginnings of a memory pool
2016-08-03 15:59:17 +02:00
#define SPA_PTR_TO_INT(p) ((int) ((intptr_t) (p)))
#define SPA_INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
#define SPA_PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
#define SPA_UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
Cleanups
2016-09-20 11:20:43 +02:00
#define SPA_TIME_INVALID ((int64_t)INT64_MIN)
v4l2: implement enum_formats with filter Use the filter to query the device and return a filtered result.
2016-09-07 13:43:14 +02:00
#define SPA_IDX_INVALID ((unsigned int)-1)
More work on implementing remote protocol Rework things so that we negotiate buffer pools beforehand and only pass buffer ids around We can then remove the refcount of buffers, events and commands. More work on buffer reuse Use the node state changes to trigger the next step in the configuration sequence. Move most of the client-node to a plugin Do buffer allocation in the port link.
2016-08-02 16:34:44 +02:00
#define SPA_ID_INVALID ((uint32_t)0xffffffff)
flatpak: add flatpak module Pass LoopUtils to callbacks to make it easier to reschedule timeouts.
2017-04-17 16:32:25 +02:00
#define SPA_NSEC_PER_SEC (1000000000ll)
#define SPA_NSEC_PER_MSEC (1000000ll)
#define SPA_NSEC_PER_USEC (1000ll)
#define SPA_USEC_PER_SEC (1000000ll)
#define SPA_USEC_PER_MSEC (1000ll)
#define SPA_MSEC_PER_SEC (1000ll)
Cleanups
2016-09-20 11:20:43 +02:00
#define SPA_TIMESPEC_TO_TIME(ts) ((ts)->tv_sec * SPA_NSEC_PER_SEC + (ts)->tv_nsec)
#define SPA_TIMEVAL_TO_TIME(tv) ((tv)->tv_sec * SPA_NSEC_PER_SEC + (tv)->tv_usec * 1000ll)
add printf checking
2016-10-05 18:34:36 +02:00
#ifdef __GNUC__
# define SPA_PRINTF_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
spa: make events and commands as objects So we can serialize and introspect them more easily
2017-03-15 16:21:05 +01:00
# define SPA_ALIGNED(align) __attribute__ ((aligned (align)))
add printf checking
2016-10-05 18:34:36 +02:00
#else
# define SPA_PRINTF_FUNC(fmt, arg1)
spa: make events and commands as objects So we can serialize and introspect them more easily
2017-03-15 16:21:05 +01:00
# define SPA_ALIGNED(align)
add printf checking
2016-10-05 18:34:36 +02:00
#endif
More hacking Add connection message for PORT_COMMAND Add rtkit support to ask for realtime priority work on stream states and improve negotiation Rework of port linking works, keep separate state for realtime threads and use message passing to update the state. Don't try to link nodes that are removed. Open the device in the ALSA monitor to detect source or sink Implement send_command as async methods on the plugins, use async replies to sync start and stop. Work on alsa sink. Implement async PAUSE/START on v4l2 src. move the STREAMON/OFF calls to the mainloop because they have high latency, add the poll descriptors from the data loop.
2016-10-28 16:56:33 +02:00
#define SPA_ROUND_UP_N(num,align) ((((num) + ((align) - 1)) & ~((align) - 1)))
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
#ifndef SPA_LIKELY
#ifdef __GNUC__
#define SPA_LIKELY(x) (__builtin_expect(!!(x),1))
#define SPA_UNLIKELY(x) (__builtin_expect(!!(x),0))
#else
#define SPA_LIKELY(x) (x)
#define SPA_UNLIKELY(x) (x)
#endif
#endif
improve asserts
2016-10-12 17:38:02 +02:00
#define spa_return_if_fail(expr) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
do { \
improve asserts
2016-10-12 17:38:02 +02:00
if (SPA_UNLIKELY (!(expr))) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
return; \
} while(false)
improve asserts
2016-10-12 17:38:02 +02:00
#define spa_return_val_if_fail(expr, val) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
do { \
improve asserts
2016-10-12 17:38:02 +02:00
if (SPA_UNLIKELY(!(expr))) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
return (val); \
} while(false)
/* spa_assert_se() is an assert which guarantees side effects of x,
* i.e. is never optimized away, regardless of NDEBUG or FASTPATH. */
improve asserts
2016-10-12 17:38:02 +02:00
#define spa_assert_se(expr) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
do { \
improve asserts
2016-10-12 17:38:02 +02:00
if (SPA_UNLIKELY(!(expr))) \
avoid deref We can avoid a deref when we use container_of to get from the interface to the handle.
2016-10-12 17:27:29 +02:00
abort(); \
} while (false)
/* Does exactly nothing */
#define spa_nop() do {} while (false)
More hacking Add connection message for PORT_COMMAND Add rtkit support to ask for realtime priority work on stream states and improve negotiation Rework of port linking works, keep separate state for realtime threads and use message passing to update the state. Don't try to link nodes that are removed. Open the device in the ALSA monitor to detect source or sink Implement send_command as async methods on the plugins, use async replies to sync start and stop. Work on alsa sink. Implement async PAUSE/START on v4l2 src. move the STREAMON/OFF calls to the mainloop because they have high latency, add the poll descriptors from the data loop.
2016-10-28 16:56:33 +02:00
#define spa_memzero(x,l) (memset((x), 0, (l)))
#define spa_zero(x) (spa_memzero(&(x), sizeof(x)))
More work on implementing remote protocol Rework things so that we negotiate buffer pools beforehand and only pass buffer ids around We can then remove the refcount of buffers, events and commands. More work on buffer reuse Use the node state changes to trigger the next step in the configuration sequence. Move most of the client-node to a plugin Do buffer allocation in the port link.
2016-08-02 16:34:44 +02:00
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* __SPA_DEFS_H__ */
Reference in a new issue Copy permalink