mpipe_pad.h File Reference

Pad: the point where two elements meet. More...

#include <stdbool.h>
#include <stdint.h>
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/util.h>
#include <zephyr/kernel.h>
#include <zephyr/mpipe/mpipe_buffer.h>
#include <zephyr/mpipe/mpipe_structure.h>
#include <zephyr/mpipe/mpipe_object.h>

Go to the source code of this file.

Data Structures
struct	mpipe_pad
	Pad structure. More...

Enumerations
enum	mpipe_pad_direction { MPIPE_PAD_UNKNOWN , MPIPE_PAD_SRC , MPIPE_PAD_SINK }
	The direction of a pad. More...
enum	mpipe_pad_mode { MPIPE_PAD_MODE_NONE , MPIPE_PAD_MODE_PUSH , MPIPE_PAD_MODE_PULL }
	The operating mode of a Pad. More...
enum	mpipe_pad_presence { MPIPE_PAD_ALWAYS , MPIPE_PAD_SOMETIMES , MPIPE_PAD_REQUEST }
	The presence of a pad. More...

Functions
int	mpipe_pad_enum_caps (struct mpipe_pad *pad, uint32_t index, const struct mpipe_structure *filter, struct mpipe_structure *out)
	Produce one of the pad's supported caps.
int	mpipe_pad_enum_first (struct mpipe_pad *pad, const struct mpipe_structure *filter, struct mpipe_structure *out)
	Produce the pad's first supported capability that a filter accepts.
int	mpipe_pad_answer_caps_query (struct mpipe_pad *pad, struct mpipe_dispatch *query)
	Answer a caps query with the first capability its filter accepts.
int	mpipe_pad_enum_filter (const struct mpipe_structure *candidate, const struct mpipe_structure *filter, struct mpipe_structure *out)
	Narrow one enumerated capability by an enumeration filter.
void	mpipe_pad_init (struct mpipe_pad *pad, uint8_t id, enum mpipe_pad_direction direction, enum mpipe_pad_presence presence)
	Initialize a pad.
int	mpipe_pad_set_caps (struct mpipe_pad *pad, const struct mpipe_structure *caps)
	Set the pad's capability.
int	mpipe_pad_link (struct mpipe_pad *src_pad, struct mpipe_pad *sink_pad)
	Link two pads together.
int	mpipe_pad_send_event (struct mpipe_pad *pad, struct mpipe_dispatch *event)
	Send an event to a pad.
int	mpipe_pad_send_event_default (struct mpipe_pad *pad, struct mpipe_dispatch *event)
	Default event handler for pads.
int	mpipe_pad_query (struct mpipe_pad *pad, struct mpipe_dispatch *query)
	Send a query to a pad.

Detailed Description

Pad: the point where two elements meet.