PipeWire: spa/param/video/format-utils.h Source File

PipeWire 0.3.51

format-utils.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef SPA_PARAM_VIDEO_FORMAT_UTILS_H
26#define SPA_PARAM_VIDEO_FORMAT_UTILS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
36#include <spa/pod/parser.h>
37#include <spa/pod/builder.h>
38#include <spa/param/video/format.h>
39#include <spa/param/format-utils.h>
40
41static inline int
42 spa_format_video_raw_parse(const struct spa_pod *format,
43 struct spa_video_info_raw *info)
44{
45 return spa_pod_parse_object(format,
46 SPA_TYPE_OBJECT_Format, NULL,
47 SPA_FORMAT_VIDEO_format, SPA_POD_Id(&info->format),
48 SPA_FORMAT_VIDEO_modifier, SPA_POD_OPT_Long(&info->modifier),
49 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size),
50 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate),
51 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate),
52 SPA_FORMAT_VIDEO_views, SPA_POD_OPT_Int(&info->views),
53 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_OPT_Id(&info->interlace_mode),
54 SPA_FORMAT_VIDEO_pixelAspectRatio, SPA_POD_OPT_Fraction(&info->pixel_aspect_ratio),
55 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_OPT_Id(&info->multiview_mode),
56 SPA_FORMAT_VIDEO_multiviewFlags, SPA_POD_OPT_Id(&info->multiview_flags),
57 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_OPT_Id(&info->chroma_site),
58 SPA_FORMAT_VIDEO_colorRange, SPA_POD_OPT_Id(&info->color_range),
59 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_OPT_Id(&info->color_matrix),
60 SPA_FORMAT_VIDEO_transferFunction, SPA_POD_OPT_Id(&info->transfer_function),
61 SPA_FORMAT_VIDEO_colorPrimaries, SPA_POD_OPT_Id(&info->color_primaries));
62}
63
64static inline int
65 spa_format_video_dsp_parse(const struct spa_pod *format,
66 struct spa_video_info_dsp *info)
67{
68 return spa_pod_parse_object(format,
69 SPA_TYPE_OBJECT_Format, NULL,
70 SPA_FORMAT_VIDEO_format, SPA_POD_Id(&info->format),
71 SPA_FORMAT_VIDEO_modifier, SPA_POD_OPT_Long(&info->modifier));
72}
73
74static inline struct spa_pod *
75 spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id,
76 struct spa_video_info_raw *info)
77{
78 struct spa_pod_frame f;
79 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
80 spa_pod_builder_add(builder,
81 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
82 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
83 0);
84 if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
85 spa_pod_builder_add(builder,
86 SPA_FORMAT_VIDEO_format, SPA_POD_Id(info->format), 0);
87 if (info->size.width != 0 && info->size.height != 0)
88 spa_pod_builder_add(builder,
89 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
90 if (info->framerate.denom != 0)
91 spa_pod_builder_add(builder,
92 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
93 if (info->modifier != 0)
94 spa_pod_builder_add(builder,
95 SPA_FORMAT_VIDEO_modifier, SPA_POD_Long(info->modifier), 0);
96 if (info->max_framerate.denom != 0)
97 spa_pod_builder_add(builder,
98 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(info->max_framerate), 0);
99 if (info->views != 0)
100 spa_pod_builder_add(builder,
101 SPA_FORMAT_VIDEO_views, SPA_POD_Int(info->views), 0);
102 if (info->interlace_mode != 0)
103 spa_pod_builder_add(builder,
104 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_Id(info->interlace_mode), 0);
105 if (info->pixel_aspect_ratio.denom != 0)
106 spa_pod_builder_add(builder,
107 SPA_FORMAT_VIDEO_pixelAspectRatio,SPA_POD_Fraction(info->pixel_aspect_ratio), 0);
108 if (info->multiview_mode != 0)
109 spa_pod_builder_add(builder,
110 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_Id(info->multiview_mode), 0);
111 if (info->multiview_flags != 0)
112 spa_pod_builder_add(builder,
113 SPA_FORMAT_VIDEO_multiviewFlags,SPA_POD_Id(info->multiview_flags), 0);
114 if (info->chroma_site != 0)
115 spa_pod_builder_add(builder,
116 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_Id(info->chroma_site), 0);
117 if (info->color_range != 0)
118 spa_pod_builder_add(builder,
119 SPA_FORMAT_VIDEO_colorRange, SPA_POD_Id(info->color_range), 0);
120 if (info->color_matrix != 0)
121 spa_pod_builder_add(builder,
122 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_Id(info->color_matrix), 0);
123 if (info->transfer_function != 0)
124 spa_pod_builder_add(builder,
125 SPA_FORMAT_VIDEO_transferFunction,SPA_POD_Id(info->transfer_function), 0);
126 if (info->color_primaries != 0)
127 spa_pod_builder_add(builder,
128 SPA_FORMAT_VIDEO_colorPrimaries,SPA_POD_Id(info->color_primaries), 0);
129 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
130}
131
132static inline struct spa_pod *
133 spa_format_video_dsp_build(struct spa_pod_builder *builder, uint32_t id,
134 struct spa_video_info_dsp *info)
135{
136 struct spa_pod_frame f;
137 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
138 spa_pod_builder_add(builder,
139 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
140 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_dsp),
141 0);
142 if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
143 spa_pod_builder_add(builder,
144 SPA_FORMAT_VIDEO_format, SPA_POD_Id(info->format), 0);
145 if (info->modifier)
146 spa_pod_builder_add(builder,
147 SPA_FORMAT_VIDEO_modifier, SPA_POD_Long(info->modifier), 0);
148 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
149}
150
151static inline int
152 spa_format_video_h264_parse(const struct spa_pod *format,
153 struct spa_video_info_h264 *info)
154{
155 return spa_pod_parse_object(format,
156 SPA_TYPE_OBJECT_Format, NULL,
157 SPA_FORMAT_VIDEO_size, SPA_POD_OPT_Rectangle(&info->size),
158 SPA_FORMAT_VIDEO_framerate, SPA_POD_OPT_Fraction(&info->framerate),
159 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate),
160 SPA_FORMAT_VIDEO_H264_streamFormat, SPA_POD_OPT_Id(&info->stream_format),
161 SPA_FORMAT_VIDEO_H264_alignment, SPA_POD_OPT_Id(&info->alignment));
162}
163
164static inline struct spa_pod *
165 spa_format_video_h264_build(struct spa_pod_builder *builder, uint32_t id,
166 struct spa_video_info_h264 *info)
167{
168 struct spa_pod_frame f;
169 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
170 spa_pod_builder_add(builder,
171 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
172 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_h264),
173 0);
174 if (info->size.width != 0 && info->size.height != 0)
175 spa_pod_builder_add(builder,
176 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
177 if (info->framerate.denom != 0)
178 spa_pod_builder_add(builder,
179 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
180 if (info->max_framerate.denom != 0)
181 spa_pod_builder_add(builder,
182 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(info->max_framerate), 0);
183 if (info->stream_format != 0)
184 spa_pod_builder_add(builder,
185 SPA_FORMAT_VIDEO_H264_streamFormat, SPA_POD_Id(info->stream_format), 0);
186 if (info->alignment != 0)
187 spa_pod_builder_add(builder,
188 SPA_FORMAT_VIDEO_H264_alignment, SPA_POD_Id(info->alignment), 0);
189 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
190}
191
192static inline int
193 spa_format_video_mjpg_parse(const struct spa_pod *format,
194 struct spa_video_info_mjpg *info)
195{
196 return spa_pod_parse_object(format,
197 SPA_TYPE_OBJECT_Format, NULL,
198 SPA_FORMAT_VIDEO_size, SPA_POD_OPT_Rectangle(&info->size),
199 SPA_FORMAT_VIDEO_framerate, SPA_POD_OPT_Fraction(&info->framerate),
200 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate));
201}
202
203static inline struct spa_pod *
204 spa_format_video_mjpg_build(struct spa_pod_builder *builder, uint32_t id,
205 struct spa_video_info_mjpg *info)
206{
207 struct spa_pod_frame f;
208 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
209 spa_pod_builder_add(builder,
210 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
211 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_mjpg),
212 0);
213 if (info->size.width != 0 && info->size.height != 0)
214 spa_pod_builder_add(builder,
215 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
216 if (info->framerate.denom != 0)
217 spa_pod_builder_add(builder,
218 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
219 if (info->max_framerate.denom != 0)
220 spa_pod_builder_add(builder,
221 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(info->max_framerate), 0);
222 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
223}
224
229#ifdef __cplusplus
230} /* extern "C" */
231#endif
232
233#endif /* SPA_PARAM_VIDEO_FORMAT_UTILS_H */
builder.h
spa/pod/builder.h
format-utils.h
spa_format_video_h264_build
static struct spa_pod * spa_format_video_h264_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_h264 *info)
Definition: format-utils.h:170
spa_format_video_dsp_build
static struct spa_pod * spa_format_video_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_dsp *info)
Definition: format-utils.h:138
spa_format_video_dsp_parse
static int spa_format_video_dsp_parse(const struct spa_pod *format, struct spa_video_info_dsp *info)
Definition: format-utils.h:70
spa_format_video_raw_build
static struct spa_pod * spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_raw *info)
Definition: format-utils.h:80
spa_format_video_raw_parse
static int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: format-utils.h:47
spa_format_video_mjpg_build
static struct spa_pod * spa_format_video_mjpg_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_mjpg *info)
Definition: format-utils.h:209
spa_format_video_h264_parse
static int spa_format_video_h264_parse(const struct spa_pod *format, struct spa_video_info_h264 *info)
Definition: format-utils.h:157
spa_format_video_mjpg_parse
static int spa_format_video_mjpg_parse(const struct spa_pod *format, struct spa_video_info_mjpg *info)
Definition: format-utils.h:198
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition: format.h:48
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: format.h:131
SPA_FORMAT_VIDEO_H264_streamFormat
@ SPA_FORMAT_VIDEO_H264_streamFormat
(Id enum spa_h264_stream_format)
Definition: format.h:145
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:109
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: format.h:130
SPA_FORMAT_VIDEO_modifier
@ SPA_FORMAT_VIDEO_modifier
format modifier (Long) use only with DMA-BUF and omit for other buffer types
Definition: format.h:128
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition: format.h:136
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: format.h:134
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: format.h:132
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: format.h:135
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: format.h:140
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: format.h:127
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:110
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: format.h:138
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: format.h:133
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: format.h:142
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: format.h:141
SPA_FORMAT_VIDEO_H264_alignment
@ SPA_FORMAT_VIDEO_H264_alignment
(Id enum spa_h264_alignment)
Definition: format.h:146
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: format.h:139
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: format.h:137
SPA_MEDIA_SUBTYPE_h264
@ SPA_MEDIA_SUBTYPE_h264
Definition: format.h:78
SPA_MEDIA_SUBTYPE_mjpg
@ SPA_MEDIA_SUBTYPE_mjpg
Definition: format.h:79
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition: format.h:59
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:58
SPA_VIDEO_FORMAT_UNKNOWN
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: raw.h:64
SPA_POD_Fraction
#define SPA_POD_Fraction(val)
Definition: vararg.h:131
SPA_POD_OPT_Rectangle
#define SPA_POD_OPT_Rectangle(val)
Definition: parser.h:545
SPA_POD_Long
#define SPA_POD_Long(val)
Definition: vararg.h:85
spa_pod_builder_add
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:665
SPA_POD_OPT_Fraction
#define SPA_POD_OPT_Fraction(val)
Definition: parser.h:547
SPA_POD_Id
#define SPA_POD_Id(val)
Definition: vararg.h:69
spa_pod_builder_pop
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:186
SPA_POD_OPT_Int
#define SPA_POD_OPT_Int(val)
Definition: parser.h:531
SPA_POD_OPT_Id
#define SPA_POD_OPT_Id(val)
Definition: parser.h:529
spa_pod_builder_push_object
static 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:453
SPA_POD_Rectangle
#define SPA_POD_Rectangle(val)
Definition: vararg.h:122
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:585
SPA_POD_Int
#define SPA_POD_Int(val)
Definition: vararg.h:74
SPA_POD_OPT_Long
#define SPA_POD_OPT_Long(val)
Definition: parser.h:533
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition: type.h:96
format.h
spa/param/video/format.h
parser.h
spa/pod/parser.h
spa_fraction::denom
uint32_t denom
Definition: defs.h:123
spa_pod_builder
Definition: builder.h:73
spa_pod_frame
Definition: iter.h:47
spa_pod
Definition: pod.h:63
spa_rectangle::width
uint32_t width
Definition: defs.h:101
spa_rectangle::height
uint32_t height
Definition: defs.h:102
spa_video_info_dsp
Definition: raw.h:219
spa_video_info_dsp::modifier
int64_t modifier
Definition: raw.h:221
spa_video_info_dsp::format
enum spa_video_format format
Definition: raw.h:220
spa_video_info_h264
Definition: encoded.h:57
spa_video_info_h264::alignment
enum spa_h264_alignment alignment
Definition: encoded.h:62
spa_video_info_h264::size
struct spa_rectangle size
Definition: encoded.h:58
spa_video_info_h264::framerate
struct spa_fraction framerate
Definition: encoded.h:59
spa_video_info_h264::stream_format
enum spa_h264_stream_format stream_format
Definition: encoded.h:61
spa_video_info_h264::max_framerate
struct spa_fraction max_framerate
Definition: encoded.h:60
spa_video_info_mjpg
Definition: encoded.h:65
spa_video_info_mjpg::max_framerate
struct spa_fraction max_framerate
Definition: encoded.h:68
spa_video_info_mjpg::framerate
struct spa_fraction framerate
Definition: encoded.h:67
spa_video_info_mjpg::size
struct spa_rectangle size
Definition: encoded.h:66
spa_video_info_raw
Definition: raw.h:194
spa_video_info_raw::color_primaries
enum spa_video_color_primaries color_primaries
color primaries.
Definition: raw.h:213
spa_video_info_raw::transfer_function
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: raw.h:212
spa_video_info_raw::interlace_mode
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: raw.h:203
spa_video_info_raw::size
struct spa_rectangle size
the frame size of the video
Definition: raw.h:198
spa_video_info_raw::color_range
enum spa_video_color_range color_range
the color range.
Definition: raw.h:208
spa_video_info_raw::pixel_aspect_ratio
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: raw.h:204
spa_video_info_raw::multiview_mode
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: raw.h:205
spa_video_info_raw::views
uint32_t views
the number of views in this video
Definition: raw.h:202
spa_video_info_raw::framerate
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: raw.h:199
spa_video_info_raw::multiview_flags
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: raw.h:206
spa_video_info_raw::modifier
int64_t modifier
format modifier only used with DMA-BUF
Definition: raw.h:196
spa_video_info_raw::format
enum spa_video_format format
the format
Definition: raw.h:195
spa_video_info_raw::color_matrix
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: raw.h:210
spa_video_info_raw::max_framerate
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: raw.h:200
spa_video_info_raw::chroma_site
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: raw.h:207