mpipe_player.h

Go to the documentation of this file.

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

 
#ifndef ZEPHYR_INCLUDE_MPIPE_UTILS_MPIPE_PLAYER_H_
#define ZEPHYR_INCLUDE_MPIPE_UTILS_MPIPE_PLAYER_H_

 
#include <zephyr/kernel.h>
 
#include <zephyr/zbus/zbus.h>
 
#include <zephyr/mpipe/mpipe_message.h>
#include <zephyr/mpipe/mpipe_pipeline.h>

/*
 * One entry of the player command queue. run_id names the run the command was
 * posted from, so the worker can tell an end-of-run raised for the run in
 * progress from one describing a run that has already been torn down.
 */
struct mpipe_player_cmd_msg {
        uint8_t cmd;
        uint8_t run_id;
};

struct mpipe_player {
        struct mpipe *pipeline;
        struct k_msgq cmd_q;
        char cmd_buf[CONFIG_MPIPE_PLAYER_CMD_QUEUE_DEPTH * sizeof(struct mpipe_player_cmd_msg)];
        uint8_t run_id;
        struct mpipe_message last_error;
        struct k_thread worker;
        struct k_sem exited;
};

int mpipe_player_init(struct mpipe_player *player, struct mpipe *pipeline);

int mpipe_player_play(struct mpipe_player *player);

int mpipe_player_pause(struct mpipe_player *player);

int mpipe_player_toggle(struct mpipe_player *player);

int mpipe_player_stop(struct mpipe_player *player);

int mpipe_player_replay(struct mpipe_player *player);

int mpipe_player_quit(struct mpipe_player *player);

int mpipe_player_wait_quit(struct mpipe_player *player);

int mpipe_player_deinit(struct mpipe_player *player);

 
#endif /* ZEPHYR_INCLUDE_MPIPE_UTILS_MPIPE_PLAYER_H_ */