PipeWire 0.3.34
video/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>
40
41/* static */ inline int
43 struct spa_video_info_raw *info)
44{
45 return spa_pod_parse_object(format,
62}
63
64/* static */ inline int
66 struct spa_video_info_dsp *info)
67{
68 return spa_pod_parse_object(format,
72}
73
74/* static */ inline struct spa_pod *
75spa_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;
80 spa_pod_builder_add(builder,
83 0);
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 *
133spa_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;
138 spa_pod_builder_add(builder,
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
153 struct spa_video_info_h264 *info)
154{
155 return spa_pod_parse_object(format,
162}
163
164/* static */ inline int
166 struct spa_video_info_mjpg *info)
167{
168 return spa_pod_parse_object(format,
173}
174
179#ifdef __cplusplus
180} /* extern "C" */
181#endif
182
183#endif /* SPA_PARAM_VIDEO_FORMAT_UTILS_H */
struct spa_pod * spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_raw *info)
Definition: video/format-utils.h:75
int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition: video/format-utils.h:42
int spa_format_video_h264_parse(const struct spa_pod *format, struct spa_video_info_h264 *info)
Definition: video/format-utils.h:152
int spa_format_video_mjpg_parse(const struct spa_pod *format, struct spa_video_info_mjpg *info)
Definition: video/format-utils.h:165
int spa_format_video_dsp_parse(const struct spa_pod *format, struct spa_video_info_dsp *info)
Definition: video/format-utils.h:65
struct spa_pod * spa_format_video_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_video_info_dsp *info)
Definition: video/format-utils.h:133
@ SPA_MEDIA_TYPE_video
Definition: param/format.h:43
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: param/format.h:121
@ SPA_FORMAT_VIDEO_H264_streamFormat
(Id enum spa_h264_stream_format)
Definition: param/format.h:135
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: param/format.h:103
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: param/format.h:120
@ SPA_FORMAT_VIDEO_modifier
format modifier (Long)
Definition: param/format.h:119
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition: param/format.h:126
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: param/format.h:124
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: param/format.h:122
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: param/format.h:125
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: param/format.h:130
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: param/format.h:118
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:104
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: param/format.h:128
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: param/format.h:123
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: param/format.h:132
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: param/format.h:131
@ SPA_FORMAT_VIDEO_H264_alignment
(Id enum spa_h264_alignment)
Definition: param/format.h:136
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: param/format.h:129
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: param/format.h:127
@ SPA_MEDIA_SUBTYPE_dsp
Definition: param/format.h:54
@ SPA_MEDIA_SUBTYPE_raw
Definition: param/format.h:53
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: video/raw.h:57
#define SPA_POD_Fraction(val)
Definition: vararg.h:91
#define SPA_POD_OPT_Rectangle(val)
Definition: parser.h:528
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:426
#define SPA_POD_Long(val)
Definition: vararg.h:65
int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:638
#define SPA_POD_OPT_Fraction(val)
Definition: parser.h:529
void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:175
#define SPA_POD_Id(val)
Definition: vararg.h:56
#define SPA_POD_OPT_Int(val)
Definition: parser.h:521
#define SPA_POD_OPT_Id(val)
Definition: parser.h:520
#define SPA_POD_Rectangle(val)
Definition: vararg.h:86
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
#define SPA_POD_Int(val)
Definition: vararg.h:59
#define SPA_POD_OPT_Long(val)
Definition: parser.h:522
@ SPA_TYPE_OBJECT_Format
Definition: redhat-linux-build/doc/spa/utils/type.h:90
uint32_t denom
Definition: defs.h:106
Definition: builder.h:63
Definition: iter.h:42
Definition: pod/pod.h:50
uint32_t width
Definition: defs.h:87
uint32_t height
Definition: defs.h:88
Definition: video/raw.h:201
int64_t modifier
Definition: video/raw.h:203
enum spa_video_format format
Definition: video/raw.h:202
Definition: encoded.h:52
enum spa_h264_alignment alignment
Definition: encoded.h:57
struct spa_rectangle size
Definition: encoded.h:53
struct spa_fraction framerate
Definition: encoded.h:54
enum spa_h264_stream_format stream_format
Definition: encoded.h:56
struct spa_fraction max_framerate
Definition: encoded.h:55
Definition: encoded.h:60
struct spa_fraction max_framerate
Definition: encoded.h:63
struct spa_fraction framerate
Definition: encoded.h:62
struct spa_rectangle size
Definition: encoded.h:61
Definition: video/raw.h:178
enum spa_video_color_primaries color_primaries
color primaries.
Definition: video/raw.h:196
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: video/raw.h:195
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: video/raw.h:186
struct spa_rectangle size
the frame size of the video
Definition: video/raw.h:181
enum spa_video_color_range color_range
the color range.
Definition: video/raw.h:191
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: video/raw.h:187
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: video/raw.h:188
uint32_t views
the number of views in this video
Definition: video/raw.h:185
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: video/raw.h:182
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: video/raw.h:189
int64_t modifier
format modifier
Definition: video/raw.h:180
enum spa_video_format format
the format
Definition: video/raw.h:179
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: video/raw.h:193
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: video/raw.h:183
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: video/raw.h:190