PipeWire  1.6.4
raw-utils.h
Go to the documentation of this file.
1 /* Simple Plugin API */
2 /* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3 /* SPDX-License-Identifier: MIT */
4 
5 #ifndef SPA_VIDEO_RAW_UTILS_H
6 #define SPA_VIDEO_RAW_UTILS_H
7 
8 #include <spa/pod/iter.h>
9 #include <spa/pod/parser.h>
10 #include <spa/pod/builder.h>
11 #include <spa/param/video/raw.h>
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
22 #ifndef SPA_API_VIDEO_RAW_UTILS
23  #ifdef SPA_API_IMPL
24  #define SPA_API_VIDEO_RAW_UTILS SPA_API_IMPL
25  #else
26  #define SPA_API_VIDEO_RAW_UTILS static inline
27  #endif
28 #endif
29 
31 spa_format_video_raw_parse(const struct spa_pod *format,
32  struct spa_video_info_raw *info)
33 {
34  info->flags = SPA_VIDEO_FLAG_NONE;
35  const struct spa_pod_prop *mod_prop;
36  if ((mod_prop = spa_pod_find_prop (format, NULL, SPA_FORMAT_VIDEO_modifier)) != NULL) {
40  }
41 
42  return spa_pod_parse_object(format,
59 }
60 
62 spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id,
63  const struct spa_video_info_raw *info)
64 {
65  struct spa_pod_frame f;
67  spa_pod_builder_add(builder,
70  0);
71  if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
72  spa_pod_builder_add(builder,
74  if (info->size.width != 0 && info->size.height != 0)
75  spa_pod_builder_add(builder,
77  if (info->framerate.denom != 0)
78  spa_pod_builder_add(builder,
80  if (info->modifier != 0 || info->flags & SPA_VIDEO_FLAG_MODIFIER) {
81  spa_pod_builder_prop(builder,
83  spa_pod_builder_long(builder, info->modifier);
84  }
85  if (info->max_framerate.denom != 0)
86  spa_pod_builder_add(builder,
88  if (info->views != 0)
89  spa_pod_builder_add(builder,
91  if (info->interlace_mode != 0)
92  spa_pod_builder_add(builder,
94  if (info->pixel_aspect_ratio.denom != 0)
95  spa_pod_builder_add(builder,
97  if (info->multiview_mode != 0)
98  spa_pod_builder_add(builder,
100  if (info->multiview_flags != 0)
101  spa_pod_builder_add(builder,
103  if (info->chroma_site != 0)
104  spa_pod_builder_add(builder,
106  if (info->color_range != 0)
107  spa_pod_builder_add(builder,
109  if (info->color_matrix != 0)
110  spa_pod_builder_add(builder,
112  if (info->transfer_function != 0)
113  spa_pod_builder_add(builder,
115  if (info->color_primaries != 0)
116  spa_pod_builder_add(builder,
118  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
119 }
120 
121 static inline bool
123 {
124  switch (format) {
165  return true;
166  default:
167  return false;
168  }
169 }
170 
175 #ifdef __cplusplus
176 } /* extern "C" */
177 #endif
178 
179 #endif /* SPA_VIDEO_RAW_UTILS_H */
spa/pod/builder.h
SPA_API_VIDEO_RAW_UTILS int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: raw-utils.h:38
SPA_API_VIDEO_RAW_UTILS struct spa_pod * spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_video_info_raw *info)
Definition: raw-utils.h:69
spa_video_format
Video formats.
Definition: raw.h:43
#define SPA_API_VIDEO_RAW_UTILS
Definition: raw-utils.h:33
static bool spa_format_video_is_rgb(enum spa_video_format format)
Definition: raw-utils.h:129
@ SPA_MEDIA_TYPE_video
Definition: format.h:28
@ SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED
format modifier was not fixated yet
Definition: raw.h:149
@ SPA_VIDEO_FLAG_MODIFIER
use the format modifier
Definition: raw.h:148
@ SPA_VIDEO_FLAG_NONE
no flags
Definition: raw.h:144
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: format.h:134
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:99
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: format.h:133
@ SPA_FORMAT_VIDEO_modifier
format modifier (Long) use only with DMA-BUF and omit for other buffer types
Definition: format.h:131
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition: format.h:139
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: format.h:137
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: format.h:135
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: format.h:138
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: format.h:143
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: format.h:130
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:100
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: format.h:141
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: format.h:136
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: format.h:145
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: format.h:144
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: format.h:142
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: format.h:140
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:38
@ SPA_VIDEO_FORMAT_RGBA_102LE
32-bit R:G:B:A 10:10:10:2 little endian
Definition: raw.h:133
@ SPA_VIDEO_FORMAT_GRAY8
Definition: raw.h:70
@ SPA_VIDEO_FORMAT_GBR_10LE
Definition: raw.h:95
@ SPA_VIDEO_FORMAT_GBRA_12LE
Definition: raw.h:116
@ SPA_VIDEO_FORMAT_ABGR_210LE
32-bit A:B:G:R 2:10:10:10 little endian
Definition: raw.h:132
@ SPA_VIDEO_FORMAT_xRGB
Definition: raw.h:54
@ SPA_VIDEO_FORMAT_GRAY16_LE
Definition: raw.h:72
@ SPA_VIDEO_FORMAT_GBR_10BE
Definition: raw.h:94
@ SPA_VIDEO_FORMAT_RGB16
Definition: raw.h:74
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: raw.h:44
@ SPA_VIDEO_FORMAT_ARGB
Definition: raw.h:58
@ SPA_VIDEO_FORMAT_RGB15
Definition: raw.h:76
@ SPA_VIDEO_FORMAT_RGBx_102LE
32-bit R:G:B:x 10:10:10:2 little endian
Definition: raw.h:129
@ SPA_VIDEO_FORMAT_RGBA
Definition: raw.h:56
@ SPA_VIDEO_FORMAT_ABGR
Definition: raw.h:59
@ SPA_VIDEO_FORMAT_BGR15
Definition: raw.h:77
@ SPA_VIDEO_FORMAT_RGBA_F16
Definition: raw.h:124
@ SPA_VIDEO_FORMAT_xBGR
Definition: raw.h:55
@ SPA_VIDEO_FORMAT_ARGB64
Definition: raw.h:84
@ SPA_VIDEO_FORMAT_BGR
Definition: raw.h:61
@ SPA_VIDEO_FORMAT_ARGB_210LE
32-bit A:R:G:B 2:10:10:10 little endian
Definition: raw.h:131
@ SPA_VIDEO_FORMAT_RGBx
Definition: raw.h:52
@ SPA_VIDEO_FORMAT_BGRx
Definition: raw.h:53
@ SPA_VIDEO_FORMAT_GBR_12BE
Definition: raw.h:113
@ SPA_VIDEO_FORMAT_GBRA_10LE
Definition: raw.h:112
@ SPA_VIDEO_FORMAT_GRAY16_BE
Definition: raw.h:71
@ SPA_VIDEO_FORMAT_BGR16
Definition: raw.h:75
@ SPA_VIDEO_FORMAT_BGRA_102LE
32-bit B:G:R:A 10:10:10:2 little endian
Definition: raw.h:134
@ SPA_VIDEO_FORMAT_GBR
Definition: raw.h:93
@ SPA_VIDEO_FORMAT_GBRA_12BE
Definition: raw.h:115
@ SPA_VIDEO_FORMAT_BGRx_102LE
32-bit B:G:R:x 10:10:10:2 little endian
Definition: raw.h:130
@ SPA_VIDEO_FORMAT_xRGB_210LE
32-bit x:R:G:B 2:10:10:10 little endian
Definition: raw.h:127
@ SPA_VIDEO_FORMAT_GBRA_10BE
Definition: raw.h:111
@ SPA_VIDEO_FORMAT_RGBA_F32
Definition: raw.h:125
@ SPA_VIDEO_FORMAT_BGRA
Definition: raw.h:57
@ SPA_VIDEO_FORMAT_RGB8P
Definition: raw.h:80
@ SPA_VIDEO_FORMAT_GBRA
Definition: raw.h:110
@ SPA_VIDEO_FORMAT_xBGR_210LE
32-bit x:B:G:R 2:10:10:10 little endian
Definition: raw.h:128
@ SPA_VIDEO_FORMAT_GBR_12LE
Definition: raw.h:114
@ SPA_VIDEO_FORMAT_r210
Definition: raw.h:86
@ SPA_VIDEO_FORMAT_RGB
Definition: raw.h:60
SPA_API_POD_BUILDER int spa_pod_builder_long(struct spa_pod_builder *builder, int64_t val)
Definition: builder.h:305
#define SPA_POD_Fraction(val)
Definition: vararg.h:119
#define SPA_POD_OPT_Rectangle(val)
Definition: parser.h:880
#define SPA_POD_PROP_FLAG_MANDATORY
is mandatory, when filtering, both sides need this property or filtering fails.
Definition: pod.h:241
#define SPA_POD_OPT_Fraction(val)
Definition: parser.h:882
SPA_API_POD_BUILDER int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:713
#define SPA_POD_Id(val)
Definition: vararg.h:53
SPA_API_POD_BUILDER int spa_pod_builder_push_object(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t type, uint32_t id)
Definition: builder.h:475
#define SPA_POD_PROP_FLAG_DONT_FIXATE
choices need no fixation
Definition: pod.h:244
#define SPA_POD_OPT_Int(val)
Definition: parser.h:866
#define SPA_POD_OPT_Id(val)
Definition: parser.h:864
SPA_API_POD_ITER const struct spa_pod_prop * spa_pod_find_prop(const struct spa_pod *pod, const struct spa_pod_prop *start, uint32_t key)
Definition: iter.h:274
#define SPA_POD_Rectangle(val)
Definition: vararg.h:110
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:935
#define SPA_POD_Int(val)
Definition: vararg.h:58
SPA_API_POD_BUILDER void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:213
#define SPA_POD_OPT_Long(val)
Definition: parser.h:868
SPA_API_POD_BUILDER int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition: builder.h:490
@ SPA_TYPE_OBJECT_Format
Definition: type.h:87
spa/pod/iter.h
spa/pod/parser.h
uint32_t denom
Definition: defs.h:139
Definition: builder.h:63
Definition: body.h:38
Definition: pod.h:227
uint32_t flags
flags for property
Definition: pod.h:248
Definition: pod.h:57
uint32_t width
Definition: defs.h:117
uint32_t height
Definition: defs.h:118
Definition: raw.h:176
enum spa_video_color_primaries color_primaries
color primaries.
Definition: raw.h:196
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: raw.h:195
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: raw.h:186
struct spa_rectangle size
the frame size of the video
Definition: raw.h:181
enum spa_video_color_range color_range
the color range.
Definition: raw.h:191
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: raw.h:187
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: raw.h:188
uint32_t views
the number of views in this video
Definition: raw.h:185
uint32_t flags
extra video flags
Definition: raw.h:178
uint64_t modifier
format modifier only used with DMA-BUF
Definition: raw.h:179
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: raw.h:182
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: raw.h:189
enum spa_video_format format
the format
Definition: raw.h:177
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: raw.h:193
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: raw.h:183
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: raw.h:190
spa/param/video/raw.h