mpipe_element.h

Go to the documentation of this file.

/*
 * Copyright 2025-2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_MPIPE_MPIPE_ELEMENT_H_
#define ZEPHYR_INCLUDE_MPIPE_MPIPE_ELEMENT_H_

 
#include <stdbool.h>
#include <stdint.h>
 
#include <zephyr/sys/dlist.h>
#include <zephyr/sys/util.h>
 
#include <zephyr/mpipe/mpipe_object.h>
 
struct mpipe_dispatch;
struct zbus_channel;

#if defined(CONFIG_MPIPE_ELEMENT_NAME)
#define MPIPE_ELEMENT_SET_NAME(e, n) ((e)->name = (n))
#else
#define MPIPE_ELEMENT_SET_NAME(e, n) ((void)0)
#endif

#define MPIPE_STATE_GET_NEXT(cur, target)                                                          \
        ((enum mpipe_state)((int)cur + SYS_SIGN((int)target - (int)cur)))

#define MPIPE_STATE_TRANSITION(cur, next) (((cur) << 2) | (next))

#define MPIPE_STATE_TRANSITION_CURRENT(trans) ((enum mpipe_state)((trans) >> 2))

#define MPIPE_STATE_TRANSITION_NEXT(trans) ((enum mpipe_state)((trans) & 0x3))

enum mpipe_state {
        MPIPE_STATE_READY = 0,
        MPIPE_STATE_PAUSED = 1,
        MPIPE_STATE_PLAYING = 2,
};

enum mpipe_state_change {
        MPIPE_STATE_CHANGE_READY_TO_PAUSED =
                MPIPE_STATE_TRANSITION(MPIPE_STATE_READY, MPIPE_STATE_PAUSED),
        MPIPE_STATE_CHANGE_PAUSED_TO_PLAYING =
                MPIPE_STATE_TRANSITION(MPIPE_STATE_PAUSED, MPIPE_STATE_PLAYING),
        MPIPE_STATE_CHANGE_PLAYING_TO_PAUSED =
                MPIPE_STATE_TRANSITION(MPIPE_STATE_PLAYING, MPIPE_STATE_PAUSED),
        MPIPE_STATE_CHANGE_PAUSED_TO_READY =
                MPIPE_STATE_TRANSITION(MPIPE_STATE_PAUSED, MPIPE_STATE_READY),
};
 
struct mpipe_element;

struct mpipe_element {
        struct mpipe_object object;
 
#if defined(CONFIG_MPIPE_ELEMENT_NAME) || defined(__DOXYGEN__)
        const char *name;
#endif

        sys_dlist_t src_pads;
        sys_dlist_t sink_pads;

        enum mpipe_state current_state;

        int (*set_state)(struct mpipe_element *element, enum mpipe_state state);
        int (*change_state)(struct mpipe_element *element, enum mpipe_state_change transition);
};

int mpipe_element_init(struct mpipe_element *self, uint8_t id);

static inline void mpipe_element_set_name(struct mpipe_element *self, const char *name)
{
        ARG_UNUSED(self);
        ARG_UNUSED(name);
 
        MPIPE_ELEMENT_SET_NAME(self, name);
}
 
struct mpipe_pad;

void mpipe_element_reset_pad_caps(struct mpipe_element *element);

void mpipe_element_add_pad(struct mpipe_element *element, struct mpipe_pad *pad);

int mpipe_element_link(struct mpipe_element *element_1, struct mpipe_element *element_2, ...);

int mpipe_element_set_state(struct mpipe_element *element, enum mpipe_state state);

struct zbus_channel *mpipe_element_get_bus_chan(struct mpipe_element *element);

 
#endif /* ZEPHYR_INCLUDE_MPIPE_MPIPE_ELEMENT_H_ */