mpipe_structure.h

Go to the documentation of this file.

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

 
#ifndef ZEPHYR_INCLUDE_MPIPE_MPIPE_STRUCTURE_H_
#define ZEPHYR_INCLUDE_MPIPE_MPIPE_STRUCTURE_H_
 
#include <zephyr/sys/clock.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/util_macro.h>
#include <zephyr/toolchain.h>
 
#include <zephyr/mpipe/mpipe_value.h>


enum mpipe_media_type {
        MPIPE_MEDIA_UNKNOWN = 0,
        MPIPE_MEDIA_AUDIO_PCM,
        MPIPE_MEDIA_VIDEO,
        MPIPE_MEDIA_END,
};

enum mpipe_caps_field {
        MPIPE_CAPS_PIXEL_FORMAT = 0,
        MPIPE_CAPS_IMAGE_WIDTH,
        MPIPE_CAPS_IMAGE_HEIGHT,
        MPIPE_CAPS_SAMPLE_RATE,
        MPIPE_CAPS_BIT_WIDTH,
        MPIPE_CAPS_NUM_CHANNELS,
        MPIPE_CAPS_INTERLEAVED,
        MPIPE_CAPS_FRAME_INTERVAL,
        MPIPE_CAPS_END,
};

#define MPIPE_STRUCTURE_FLAG_ANY BIT(0)

#define MPIPE_FRAME_INTERVAL_FROM_FPS(fps) DIV_ROUND_CLOSEST(USEC_PER_SEC, (fps))

struct mpipe_structure {
        uint8_t media_type_id;
        uint8_t flags;
        uint8_t num_fields;
        uint8_t ids[CONFIG_MPIPE_STRUCTURE_MAX_FIELDS];
        struct mpipe_value values[CONFIG_MPIPE_STRUCTURE_MAX_FIELDS];
};

#define MPIPE_STRUCTURE_FIELD_COUNT(field_id, value) 1 +
#define MPIPE_STRUCTURE_FIELD_ID(field_id, value)    (field_id),
#define MPIPE_STRUCTURE_FIELD_VALUE(field_id, value) value,

#define MPIPE_STRUCTURE_DEFINE(name, media, fields)                                                \
        BUILD_ASSERT((fields(MPIPE_STRUCTURE_FIELD_COUNT) 0) <= CONFIG_MPIPE_STRUCTURE_MAX_FIELDS, \
                     #name " has more fields than CONFIG_MPIPE_STRUCTURE_MAX_FIELDS");             \
        static const struct mpipe_structure name = {                                               \
                .media_type_id = (media),                                                          \
                .flags = 0,                                                                        \
                .num_fields = fields(MPIPE_STRUCTURE_FIELD_COUNT) 0,                               \
                .ids = {fields(MPIPE_STRUCTURE_FIELD_ID)},                                         \
                .values = {fields(MPIPE_STRUCTURE_FIELD_VALUE)},                                   \
        }

int mpipe_structure_init(struct mpipe_structure *structure, uint8_t media_type_id);

int mpipe_structure_init_fields(struct mpipe_structure *structure, uint8_t media_type_id, ...);

int mpipe_structure_init_any(struct mpipe_structure *structure);

bool mpipe_structure_is_any(const struct mpipe_structure *structure);

bool mpipe_structure_is_empty(const struct mpipe_structure *structure);

int mpipe_structure_append_value(struct mpipe_structure *structure, uint8_t field_id,
                                 const struct mpipe_value *value);

int mpipe_structure_copy_field(const struct mpipe_structure *src, struct mpipe_structure *dst,
                               uint8_t field_id);

int mpipe_structure_clear(struct mpipe_structure *structure);

bool mpipe_structure_is_fixed(const struct mpipe_structure *structure);

const struct mpipe_value *mpipe_structure_get_value(const struct mpipe_structure *structure,
                                                    uint8_t field_id);

int mpipe_structure_remove_field(struct mpipe_structure *structure, uint8_t field_id);

int mpipe_structure_intersect(const struct mpipe_structure *struct1,
                              const struct mpipe_structure *struct2, struct mpipe_structure *out);

int mpipe_structure_fixate(const struct mpipe_structure *src, struct mpipe_structure *out);

void mpipe_structure_print(const struct mpipe_structure *structure);

 
#endif /*ZEPHYR_INCLUDE_MPIPE_MPIPE_STRUCTURE_H_*/