mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-06 13:30:01 -05:00
spi: implement processing
Implement processing with writing to provided buffer or in-place Fix types. Add more PortInfo flags Remove release-id, we now use a callback, which is more practical and still allows deallocation out of the rt-threads if needed as well as recycling the buffers into an atomic pool Add more comments Allow NULL in set_params to reset params
This commit is contained in:
Wim Taymans
parent
b44d2d86b6
commit
03046301bf
5 changed files with 333 additions and 109 deletions
186
pinos/spi/node.h
186
pinos/spi/node.h
|
|
@ -36,11 +36,20 @@ typedef struct _SpiEvent SpiEvent;
|
|||
* @SPI_PORT_INFO_FLAG_NONE: no flags
|
||||
* @SPI_PORT_INFO_FLAG_REMOVABLE: port can be removed
|
||||
* @SPI_PORT_INFO_FLAG_OPTIONAL: processing on port is optional
|
||||
* @SPI_PORT_INFO_FLAG_CAN_GIVE_BUFFER: the port can give a buffer
|
||||
* @SPI_PORT_INFO_FLAG_CAN_USE_BUFFER: the port can use a provided buffer
|
||||
* @SPI_PORT_INFO_FLAG_IN_PLACE: the port can process data in-place and will need
|
||||
* a writable input buffer when no output buffer is specified.
|
||||
* @SPI_PORT_INFO_FLAG_NO_REF: the port does not keep a ref on the buffer
|
||||
*/
|
||||
typedef enum {
|
||||
SPI_PORT_INFO_FLAG_NONE = 0,
|
||||
SPI_PORT_INFO_FLAG_REMOVABLE = 1 << 0,
|
||||
SPI_PORT_INFO_FLAG_OPTIONAL = 1 << 1,
|
||||
SPI_PORT_INFO_FLAG_CAN_GIVE_BUFFER = 1 << 2,
|
||||
SPI_PORT_INFO_FLAG_CAN_USE_BUFFER = 1 << 3,
|
||||
SPI_PORT_INFO_FLAG_IN_PLACE = 1 << 4,
|
||||
SPI_PORT_INFO_FLAG_NO_REF = 1 << 5,
|
||||
} SpiPortInfoFlags;
|
||||
|
||||
/**
|
||||
|
|
@ -50,16 +59,16 @@ typedef enum {
|
|||
* @align: required alignment of the data
|
||||
* @maxbuffering: the maximum amount of bytes that the element will keep
|
||||
* around internally
|
||||
* @latency: latency on this port
|
||||
* @latency: latency on this port in nanoseconds
|
||||
* @features: NULL terminated array of extra port features
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
SpiPortInfoFlags flags;
|
||||
int minsize;
|
||||
int align;
|
||||
int maxbuffering;
|
||||
int latency;
|
||||
size_t minsize;
|
||||
uint32_t align;
|
||||
unsigned int maxbuffering;
|
||||
uint64_t latency;
|
||||
const char **features;
|
||||
} SpiPortInfo;
|
||||
|
||||
|
|
@ -67,12 +76,12 @@ typedef struct {
|
|||
* SpiPortStatusFlags:
|
||||
* @SPI_PORT_STATUS_FLAG_NONE: no status flags
|
||||
* @SPI_PORT_STATUS_FLAG_HAVE_OUTPUT: port has output
|
||||
* @SPI_PORT_STATUS_FLAG_ACCEPT_INPUT: port accepts input
|
||||
* @SPI_PORT_STATUS_FLAG_NEED_INPUT: port needs input
|
||||
*/
|
||||
typedef enum {
|
||||
SPI_PORT_STATUS_FLAG_NONE = 0,
|
||||
SPI_PORT_STATUS_FLAG_HAVE_OUTPUT = 1 << 0,
|
||||
SPI_PORT_STATUS_FLAG_ACCEPT_INPUT = 1 << 1,
|
||||
SPI_PORT_STATUS_FLAG_NEED_INPUT = 1 << 1,
|
||||
} SpiPortStatusFlags;
|
||||
|
||||
typedef struct {
|
||||
|
|
@ -86,31 +95,36 @@ typedef enum {
|
|||
SPI_EVENT_TYPE_HAVE_OUTPUT,
|
||||
SPI_EVENT_TYPE_NEED_INPUT,
|
||||
SPI_EVENT_TYPE_REQUEST_DATA,
|
||||
SPI_EVENT_TYPE_RELEASE_ID,
|
||||
SPI_EVENT_TYPE_DRAINED,
|
||||
SPI_EVENT_TYPE_MARKER,
|
||||
SPI_EVENT_TYPE_ERROR,
|
||||
} SpiEventType;
|
||||
|
||||
typedef struct {
|
||||
int n_ids;
|
||||
void **ids;
|
||||
} SpiEventReleaseID;
|
||||
|
||||
struct _SpiEvent {
|
||||
const void *id;
|
||||
volatile int refcount;
|
||||
SpiNotify notify;
|
||||
SpiEventType type;
|
||||
int port_id;
|
||||
uint32_t port_id;
|
||||
void *data;
|
||||
size_t size;
|
||||
};
|
||||
|
||||
/**
|
||||
* SpiDataFlags:
|
||||
* @SPI_DATA_FLAG_NONE: no flag
|
||||
* @SPI_DATA_FLAG_DISCARD: the buffer can be discarded
|
||||
* @SPI_DATA_FLAG_FORMAT_CHANGED: the format of this port changed
|
||||
* @SPI_DATA_FLAG_PROPERTIES_CHANGED: properties of this port changed
|
||||
* @SPI_DATA_FLAG_REMOVED: this port is removed
|
||||
* @SPI_DATA_FLAG_NO_BUFFER: no buffer was produced
|
||||
*/
|
||||
typedef enum {
|
||||
SPI_DATA_FLAG_NONE = 0,
|
||||
SPI_DATA_FLAG_FORMAT_CHANGED = (1 << 0),
|
||||
SPI_DATA_FLAG_PROPERTIES_CHANGED = (1 << 1),
|
||||
SPI_DATA_FLAG_EOS = (1 << 2),
|
||||
SPI_DATA_FLAG_NO_BUFFER = (1 << 3),
|
||||
SPI_DATA_FLAG_DISCARD = (1 << 0),
|
||||
SPI_DATA_FLAG_FORMAT_CHANGED = (1 << 1),
|
||||
SPI_DATA_FLAG_PROPERTIES_CHANGED = (1 << 2),
|
||||
SPI_DATA_FLAG_REMOVED = (1 << 3),
|
||||
SPI_DATA_FLAG_NO_BUFFER = (1 << 4),
|
||||
} SpiDataFlags;
|
||||
|
||||
/**
|
||||
|
|
@ -121,7 +135,7 @@ typedef enum {
|
|||
* @event: an event
|
||||
*/
|
||||
typedef struct {
|
||||
int port_id;
|
||||
uint32_t port_id;
|
||||
SpiDataFlags flags;
|
||||
SpiBuffer *buffer;
|
||||
SpiEvent *event;
|
||||
|
|
@ -139,8 +153,10 @@ typedef enum {
|
|||
} SpiCommandType;
|
||||
|
||||
typedef struct {
|
||||
int port_id;
|
||||
volatile int refcount;
|
||||
SpiNotify notify;
|
||||
SpiCommandType type;
|
||||
uint32_t port_id;
|
||||
void *data;
|
||||
size_t size;
|
||||
} SpiCommand;
|
||||
|
|
@ -156,19 +172,72 @@ typedef void (*SpiEventCallback) (SpiNode *node,
|
|||
void *user_data);
|
||||
|
||||
/**
|
||||
* SpiNodeInterface:
|
||||
* SpiNode:
|
||||
*
|
||||
* Spi node interface.
|
||||
* The main processing nodes.
|
||||
*/
|
||||
struct _SpiNode {
|
||||
/* user_data that can be set by the application */
|
||||
void * user_data;
|
||||
int size;
|
||||
|
||||
/* the total size of this node. This can be used to expand this
|
||||
* structure in the future */
|
||||
size_t size;
|
||||
|
||||
/**
|
||||
* SpiNode::get_params:
|
||||
* @Node: a #SpiNode
|
||||
* @props: a location for a #SpiParams pointer
|
||||
*
|
||||
* Get the configurable parameters of @node.
|
||||
*
|
||||
* The returned @props is a snapshot of the current configuration and
|
||||
* can be modified. The modifications will take effect after a call
|
||||
* to SpiNode::set_params.
|
||||
*
|
||||
* Returns: #SPI_RESULT_OK on success
|
||||
* #SPI_RESULT_INVALID_ARGUMENTS when node or props are %NULL
|
||||
* #SPI_RESULT_NOT_IMPLEMENTED when there are no properties
|
||||
* implemented on @node
|
||||
*/
|
||||
SpiResult (*get_params) (SpiNode *node,
|
||||
SpiParams **props);
|
||||
/**
|
||||
* SpiNode::set_params:
|
||||
* @Node: a #SpiNode
|
||||
* @props: a #SpiParams
|
||||
*
|
||||
* Set the configurable parameters in @node.
|
||||
*
|
||||
* Usually, @props will be obtained from SpiNode::get_params and then
|
||||
* modified but it is also possible to set another #SpiParams object
|
||||
* as long as its keys and types match those of SpiParams::get_params.
|
||||
*
|
||||
* Properties with keys that are not known are ignored.
|
||||
*
|
||||
* If @props is NULL, all the parameters are reset to their defaults.
|
||||
*
|
||||
* Returns: #SPI_RESULT_OK on success
|
||||
* #SPI_RESULT_INVALID_ARGUMENTS when node is %NULL
|
||||
* #SPI_RESULT_NOT_IMPLEMENTED when no properties can be
|
||||
* modified on @node.
|
||||
* #SPI_RESULT_WRONG_PARAM_TYPE when a property has the wrong
|
||||
* type.
|
||||
*/
|
||||
SpiResult (*set_params) (SpiNode *node,
|
||||
const SpiParams *props);
|
||||
|
||||
/**
|
||||
* SpiNode::send_command:
|
||||
* @Node: a #SpiNode
|
||||
* @command: a #SpiCommand
|
||||
*
|
||||
* Send a command to @node.
|
||||
*
|
||||
* Returns: #SPI_RESULT_OK on success
|
||||
* #SPI_RESULT_INVALID_ARGUMENTS when node or command is %NULL
|
||||
* #SPI_RESULT_NOT_IMPLEMENTED when this node can't process commands
|
||||
* #SPI_RESULT_INVALID_COMMAND @command is an invalid command
|
||||
*/
|
||||
SpiResult (*send_command) (SpiNode *node,
|
||||
SpiCommand *command);
|
||||
SpiResult (*get_event) (SpiNode *node,
|
||||
|
|
@ -176,55 +245,82 @@ struct _SpiNode {
|
|||
SpiResult (*set_event_callback) (SpiNode *node,
|
||||
SpiEventCallback callback,
|
||||
void *user_data);
|
||||
|
||||
/**
|
||||
* SpiNode::get_n_ports:
|
||||
* @Node: a #SpiNode
|
||||
* @n_input_ports: location to hold the number of input ports or %NULL
|
||||
* @max_input_ports: location to hold the maximum number of input ports or %NULL
|
||||
* @n_output_ports: location to hold the number of output ports or %NULL
|
||||
* @max_output_ports: location to hold the maximum number of output ports or %NULL
|
||||
*
|
||||
* Get the current number of input and output ports and also the maximum
|
||||
* number of ports.
|
||||
*
|
||||
* Returns: #SPI_RESULT_OK on success
|
||||
* #SPI_RESULT_INVALID_ARGUMENTS when node is %NULL
|
||||
*/
|
||||
SpiResult (*get_n_ports) (SpiNode *node,
|
||||
int *n_input_ports,
|
||||
int *max_input_ports,
|
||||
int *n_output_ports,
|
||||
int *max_output_ports);
|
||||
unsigned int *n_input_ports,
|
||||
unsigned int *max_input_ports,
|
||||
unsigned int *n_output_ports,
|
||||
unsigned int *max_output_ports);
|
||||
/**
|
||||
* SpiNode::get_port_ids:
|
||||
* @Node: a #SpiNode
|
||||
* @n_input_ports: size of the @input_ids array
|
||||
* @input_ids: array to store the input stream ids
|
||||
* @n_output_ports: size of the @output_ids array
|
||||
* @output_ids: array to store the output stream ids
|
||||
*
|
||||
* Get the current number of input and output ports and also the maximum
|
||||
* number of ports.
|
||||
*
|
||||
* Returns: #SPI_RESULT_OK on success
|
||||
* #SPI_RESULT_INVALID_ARGUMENTS when node is %NULL
|
||||
*/
|
||||
SpiResult (*get_port_ids) (SpiNode *node,
|
||||
int n_input_ports,
|
||||
int *input_ids,
|
||||
int n_output_ports,
|
||||
int *output_ids);
|
||||
unsigned int n_input_ports,
|
||||
uint32_t *input_ids,
|
||||
unsigned int n_output_ports,
|
||||
uint32_t *output_ids);
|
||||
|
||||
SpiResult (*add_port) (SpiNode *node,
|
||||
SpiDirection direction,
|
||||
int *port_id);
|
||||
uint32_t *port_id);
|
||||
SpiResult (*remove_port) (SpiNode *node,
|
||||
int port_id);
|
||||
uint32_t port_id);
|
||||
|
||||
SpiResult (*get_port_formats) (SpiNode *node,
|
||||
int port_id,
|
||||
int format_idx,
|
||||
uint32_t port_id,
|
||||
unsigned int format_idx,
|
||||
SpiParams **format);
|
||||
SpiResult (*set_port_format) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
int test_only,
|
||||
const SpiParams *format);
|
||||
SpiResult (*get_port_format) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
const SpiParams **format);
|
||||
|
||||
SpiResult (*get_port_info) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
SpiPortInfo *info);
|
||||
|
||||
SpiResult (*get_port_params) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
SpiParams **params);
|
||||
SpiResult (*set_port_params) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
const SpiParams *params);
|
||||
|
||||
SpiResult (*get_port_status) (SpiNode *node,
|
||||
int port_id,
|
||||
uint32_t port_id,
|
||||
SpiPortStatus *status);
|
||||
|
||||
SpiResult (*send_port_data) (SpiNode *node,
|
||||
SpiDataInfo *data);
|
||||
SpiResult (*receive_port_data) (SpiNode *node,
|
||||
int n_data,
|
||||
unsigned int n_data,
|
||||
SpiDataInfo *data);
|
||||
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue