PipeWire  0.3.45
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
29 extern "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 
41 static 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,
62 }
63 
64 static 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,
72 }
73 
74 static 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;
83  0);
84  if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
85  spa_pod_builder_add(builder,
87  if (info->size.width != 0 && info->size.height != 0)
88  spa_pod_builder_add(builder,
90  if (info->framerate.denom != 0)
91  spa_pod_builder_add(builder,
93  if (info->modifier != 0)
94  spa_pod_builder_add(builder,
96  if (info->max_framerate.denom != 0)
97  spa_pod_builder_add(builder,
99  if (info->views != 0)
100  spa_pod_builder_add(builder,
102  if (info->interlace_mode != 0)
103  spa_pod_builder_add(builder,
105  if (info->pixel_aspect_ratio.denom != 0)
106  spa_pod_builder_add(builder,
108  if (info->multiview_mode != 0)
109  spa_pod_builder_add(builder,
111  if (info->multiview_flags != 0)
112  spa_pod_builder_add(builder,
114  if (info->chroma_site != 0)
115  spa_pod_builder_add(builder,
117  if (info->color_range != 0)
118  spa_pod_builder_add(builder,
120  if (info->color_matrix != 0)
121  spa_pod_builder_add(builder,
123  if (info->transfer_function != 0)
124  spa_pod_builder_add(builder,
126  if (info->color_primaries != 0)
127  spa_pod_builder_add(builder,
129  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
130 }
131 
132 static 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;
141  0);
142  if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
143  spa_pod_builder_add(builder,
145  if (info->modifier)
146  spa_pod_builder_add(builder,
148  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
149 }
150 
151 static 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,
162 }
163 
164 static 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;
173  0);
174  if (info->size.width != 0 && info->size.height != 0)
175  spa_pod_builder_add(builder,
177  if (info->framerate.denom != 0)
178  spa_pod_builder_add(builder,
180  if (info->max_framerate.denom != 0)
181  spa_pod_builder_add(builder,
183  if (info->stream_format != 0)
184  spa_pod_builder_add(builder,
186  if (info->alignment != 0)
187  spa_pod_builder_add(builder,
189  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
190 }
191 
192 static 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,
201 }
202 
203 static 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;
212  0);
213  if (info->size.width != 0 && info->size.height != 0)
214  spa_pod_builder_add(builder,
216  if (info->framerate.denom != 0)
217  spa_pod_builder_add(builder,
219  if (info->max_framerate.denom != 0)
220  spa_pod_builder_add(builder,
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 */
spa/pod/builder.h
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
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
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
static int spa_format_video_dsp_parse(const struct spa_pod *format, struct spa_video_info_dsp *info)
Definition: format-utils.h:70
static int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: format-utils.h:47
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
static int spa_format_video_h264_parse(const struct spa_pod *format, struct spa_video_info_h264 *info)
Definition: format-utils.h:157
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
Definition: format.h:48
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: format.h:131
@ SPA_FORMAT_VIDEO_H264_streamFormat
(Id enum spa_h264_stream_format)
Definition: format.h:145
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:109
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: format.h:130
@ 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
(Id enum spa_video_multiview_mode)
Definition: format.h:136
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: format.h:134
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: format.h:132
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: format.h:135
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: format.h:140
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: format.h:127
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:110
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: format.h:138
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: format.h:133
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: format.h:142
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: format.h:141
@ SPA_FORMAT_VIDEO_H264_alignment
(Id enum spa_h264_alignment)
Definition: format.h:146
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: format.h:139
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: format.h:137
@ SPA_MEDIA_SUBTYPE_h264
Definition: format.h:78
@ SPA_MEDIA_SUBTYPE_mjpg
Definition: format.h:79
@ SPA_MEDIA_SUBTYPE_dsp
Definition: format.h:59
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:58
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: raw.h:64
#define SPA_POD_Fraction(val)
Definition: vararg.h:131
#define SPA_POD_OPT_Rectangle(val)
Definition: parser.h:545
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:186
#define SPA_POD_Long(val)
Definition: vararg.h:85
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:665
#define SPA_POD_OPT_Fraction(val)
Definition: parser.h:547
#define SPA_POD_Id(val)
Definition: vararg.h:69
#define SPA_POD_OPT_Int(val)
Definition: parser.h:531
#define SPA_POD_OPT_Id(val)
Definition: parser.h:529
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
#define SPA_POD_Rectangle(val)
Definition: vararg.h:122
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:585
#define SPA_POD_Int(val)
Definition: vararg.h:74
#define SPA_POD_OPT_Long(val)
Definition: parser.h:533
@ SPA_TYPE_OBJECT_Format
Definition: type.h:96
spa/param/video/format.h
spa/pod/parser.h
uint32_t denom
Definition: defs.h:123
Definition: builder.h:73
Definition: iter.h:47
Definition: pod.h:63
uint32_t width
Definition: defs.h:101
uint32_t height
Definition: defs.h:102
Definition: raw.h:219
int64_t modifier
Definition: raw.h:221
enum spa_video_format format
Definition: raw.h:220
Definition: encoded.h:57
enum spa_h264_alignment alignment
Definition: encoded.h:62
struct spa_rectangle size
Definition: encoded.h:58
struct spa_fraction framerate
Definition: encoded.h:59
enum spa_h264_stream_format stream_format
Definition: encoded.h:61
struct spa_fraction max_framerate
Definition: encoded.h:60
Definition: encoded.h:65
struct spa_fraction max_framerate
Definition: encoded.h:68
struct spa_fraction framerate
Definition: encoded.h:67
struct spa_rectangle size
Definition: encoded.h:66
Definition: raw.h:194
enum spa_video_color_primaries color_primaries
color primaries.
Definition: raw.h:213
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: raw.h:212
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: raw.h:203
struct spa_rectangle size
the frame size of the video
Definition: raw.h:198
enum spa_video_color_range color_range
the color range.
Definition: raw.h:208
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: raw.h:204
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: raw.h:205
uint32_t views
the number of views in this video
Definition: raw.h:202
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: raw.h:199
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: raw.h:206
int64_t modifier
format modifier only used with DMA-BUF
Definition: raw.h:196
enum spa_video_format format
the format
Definition: raw.h:195
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: raw.h:210
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: raw.h:200
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: raw.h:207