mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-04 13:30:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/pinos/spi/node.h

279 lines
10 KiB
C
Raw Normal View History

pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
/* Simple Plugin Interface
* 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 __SPI_NODE_H__
#define __SPI_NODE_H__
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
#ifdef __cplusplus
extern "C" {
#endif
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
typedef struct _SpiNode SpiNode;
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
#include <spi/defs.h>
#include <spi/params.h>
#include <spi/port.h>
#include <spi/event.h>
#include <spi/buffer.h>
#include <spi/command.h>
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02: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
2016-06-02 16:40:20 +02:00
/**
* 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
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
typedef enum {
SPI_DATA_FLAG_NONE = 0,
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
2016-06-02 16:40:20 +02:00
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),
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
} SpiDataFlags;
/**
* SpiDataInfo:
* @port_id: the port id
* @flags: extra flags
* @buffer: a buffer
* @event: an event
*/
typedef struct {
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
2016-06-02 16:40:20 +02:00
uint32_t port_id;
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiDataFlags flags;
SpiBuffer *buffer;
SpiEvent *event;
} SpiDataInfo;
typedef void (*SpiEventCallback) (SpiNode *node,
SpiEvent *event,
void *user_data);
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
/**
* SpiInterfaceInfo:
* @interface_id: the id of the interface, can be used to get the interface
* @name: name of the interface
* @description: Human readable description of the interface.
*
* This structure lists the information about available interfaces on
* objects.
*/
typedef struct {
uint32_t interface_id;
const char *name;
const char *description;
} SpiInterfaceInfo;
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02: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
2016-06-02 16:40:20 +02:00
* SpiNode:
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02: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
2016-06-02 16:40:20 +02:00
* The main processing nodes.
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
*/
struct _SpiNode {
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
2016-06-02 16:40:20 +02:00
/* user_data that can be set by the application */
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
void * user_data;
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
2016-06-02 16:40:20 +02:00
/* 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
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*get_params) (SpiNode *node,
SpiParams **props);
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
2016-06-02 16:40:20 +02:00
/**
* 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.
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*set_params) (SpiNode *node,
const SpiParams *props);
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
2016-06-02 16:40:20 +02:00
/**
* 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
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*send_command) (SpiNode *node,
SpiCommand *command);
SpiResult (*get_event) (SpiNode *node,
SpiEvent **event);
SpiResult (*set_event_callback) (SpiNode *node,
SpiEventCallback callback,
void *user_data);
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
2016-06-02 16:40:20 +02:00
/**
* 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
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*get_n_ports) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
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
*/
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*get_port_ids) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
unsigned int n_input_ports,
uint32_t *input_ids,
unsigned int n_output_ports,
uint32_t *output_ids);
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*add_port) (SpiNode *node,
SpiDirection direction,
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
2016-06-02 16:40:20 +02:00
uint32_t *port_id);
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiResult (*remove_port) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id);
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
SpiResult (*enum_port_formats) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
unsigned int index,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiParams **format);
SpiResult (*set_port_format) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
int test_only,
const SpiParams *format);
SpiResult (*get_port_format) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
const SpiParams **format);
SpiResult (*get_port_info) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiPortInfo *info);
SpiResult (*get_port_params) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiParams **params);
SpiResult (*set_port_params) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
const SpiParams *params);
SpiResult (*get_port_status) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
uint32_t port_id,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiPortStatus *status);
SpiResult (*send_port_data) (SpiNode *node,
SpiDataInfo *data);
SpiResult (*receive_port_data) (SpiNode *node,
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
2016-06-02 16:40:20 +02:00
unsigned int n_data,
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
SpiDataInfo *data);
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
/**
* SpiNode::enum_interface_info:
* @node: a #SpiNode
* @index: the interface index
* @info: result to hold SpiInterfaceInfo.
*
* Get the interface provided by @node at @index.
*
* Returns: #SPI_RESULT_OK on success
* #SPI_RESULT_NOT_IMPLEMENTED when there are no extensions
* #SPI_RESULT_INVALID_ARGUMENTS when node or info is %NULL
* #SPI_RESULT_ENUM_END when there are no more infos
*/
SpiResult (*enum_interface_info) (SpiNode *node,
unsigned int index,
const SpiInterfaceInfo **info);
/**
* SpiNode::enum_interface_info:
* @node: a #SpiNode
* @index: the interface index
* @info: result to hold SpiInterfaceInfo.
*
* Get the interface provided by @node at @index.
*
* Returns: #SPI_RESULT_OK on success
* #SPI_RESULT_NOT_IMPLEMENTED when there are no extensions
* #SPI_RESULT_INVALID_ARGUMENTS when node or info is %NULL
* #SPI_RESULT_ENUM_END when there are no more infos
*/
SpiResult (*get_interface) (SpiNode *node,
uint32_t interface_id,
void **interface);
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
};
Split out header files Use separate header files Add pull-based alsasink Add audiotestsrc Implement negotiation and scheduling of audiotestsrc ! alsasink
2016-06-03 19:05:19 +02:00
#ifdef __cplusplus
} /* extern "C" */
#endif
pinos: add new plugin API Experiment with new plugin API that is designed for speed, minimal allocations and locking, for use with real-time scheduling.
2016-06-02 11:16:13 +02:00
#endif /* __SPI_NODE_H__ */
Reference in a new issue Copy permalink