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

PipeWire 1.4.2 |

Loading...
Searching...
No Matches
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#ifdef __cplusplus
9extern "C" {
10#endif
11
16
17#include <spa/pod/parser.h>
18#include <spa/pod/builder.h>
19#include <spa/param/video/raw.h>
20
21#ifndef SPA_API_VIDEO_RAW_UTILS
22 #ifdef SPA_API_IMPL
23 #define SPA_API_VIDEO_RAW_UTILS SPA_API_IMPL
24 #else
25 #define SPA_API_VIDEO_RAW_UTILS static inline
26 #endif
27#endif
28
29 SPA_API_VIDEO_RAW_UTILS int
30 spa_format_video_raw_parse(const struct spa_pod *format,
31 struct spa_video_info_raw *info)
32{
33 info->flags = SPA_VIDEO_FLAG_NONE;
34 const struct spa_pod_prop *mod_prop;
35 if ((mod_prop = spa_pod_find_prop (format, NULL, SPA_FORMAT_VIDEO_modifier)) != NULL) {
36 info->flags |= SPA_VIDEO_FLAG_MODIFIER;
37 if ((mod_prop->flags & SPA_POD_PROP_FLAG_DONT_FIXATE) == SPA_POD_PROP_FLAG_DONT_FIXATE)
38 info->flags |= SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED;
39 }
40
41 return spa_pod_parse_object(format,
42 SPA_TYPE_OBJECT_Format, NULL,
43 SPA_FORMAT_VIDEO_format, SPA_POD_OPT_Id(&info->format),
44 SPA_FORMAT_VIDEO_modifier, SPA_POD_OPT_Long(&info->modifier),
45 SPA_FORMAT_VIDEO_size, SPA_POD_OPT_Rectangle(&info->size),
46 SPA_FORMAT_VIDEO_framerate, SPA_POD_OPT_Fraction(&info->framerate),
47 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate),
48 SPA_FORMAT_VIDEO_views, SPA_POD_OPT_Int(&info->views),
49 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_OPT_Id(&info->interlace_mode),
50 SPA_FORMAT_VIDEO_pixelAspectRatio, SPA_POD_OPT_Fraction(&info->pixel_aspect_ratio),
51 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_OPT_Id(&info->multiview_mode),
52 SPA_FORMAT_VIDEO_multiviewFlags, SPA_POD_OPT_Id(&info->multiview_flags),
53 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_OPT_Id(&info->chroma_site),
54 SPA_FORMAT_VIDEO_colorRange, SPA_POD_OPT_Id(&info->color_range),
55 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_OPT_Id(&info->color_matrix),
56 SPA_FORMAT_VIDEO_transferFunction, SPA_POD_OPT_Id(&info->transfer_function),
57 SPA_FORMAT_VIDEO_colorPrimaries, SPA_POD_OPT_Id(&info->color_primaries));
58}
59
60 SPA_API_VIDEO_RAW_UTILS struct spa_pod *
61 spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id,
62 const struct spa_video_info_raw *info)
63{
64 struct spa_pod_frame f;
65 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
66 spa_pod_builder_add(builder,
67 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
68 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
69 0);
70 if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
71 spa_pod_builder_add(builder,
72 SPA_FORMAT_VIDEO_format, SPA_POD_Id(info->format), 0);
73 if (info->size.width != 0 && info->size.height != 0)
74 spa_pod_builder_add(builder,
75 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
76 if (info->framerate.denom != 0)
77 spa_pod_builder_add(builder,
78 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
79 if (info->modifier != 0 || info->flags & SPA_VIDEO_FLAG_MODIFIER) {
80 spa_pod_builder_prop(builder,
81 SPA_FORMAT_VIDEO_modifier, SPA_POD_PROP_FLAG_MANDATORY);
82 spa_pod_builder_long(builder, info->modifier);
83 }
84 if (info->max_framerate.denom != 0)
85 spa_pod_builder_add(builder,
86 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(&info->max_framerate), 0);
87 if (info->views != 0)
88 spa_pod_builder_add(builder,
89 SPA_FORMAT_VIDEO_views, SPA_POD_Int(info->views), 0);
90 if (info->interlace_mode != 0)
91 spa_pod_builder_add(builder,
92 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_Id(info->interlace_mode), 0);
93 if (info->pixel_aspect_ratio.denom != 0)
94 spa_pod_builder_add(builder,
95 SPA_FORMAT_VIDEO_pixelAspectRatio, SPA_POD_Fraction(&info->pixel_aspect_ratio), 0);
96 if (info->multiview_mode != 0)
97 spa_pod_builder_add(builder,
98 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_Id(info->multiview_mode), 0);
99 if (info->multiview_flags != 0)
100 spa_pod_builder_add(builder,
101 SPA_FORMAT_VIDEO_multiviewFlags,SPA_POD_Id(info->multiview_flags), 0);
102 if (info->chroma_site != 0)
103 spa_pod_builder_add(builder,
104 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_Id(info->chroma_site), 0);
105 if (info->color_range != 0)
106 spa_pod_builder_add(builder,
107 SPA_FORMAT_VIDEO_colorRange, SPA_POD_Id(info->color_range), 0);
108 if (info->color_matrix != 0)
109 spa_pod_builder_add(builder,
110 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_Id(info->color_matrix), 0);
111 if (info->transfer_function != 0)
112 spa_pod_builder_add(builder,
113 SPA_FORMAT_VIDEO_transferFunction,SPA_POD_Id(info->transfer_function), 0);
114 if (info->color_primaries != 0)
115 spa_pod_builder_add(builder,
116 SPA_FORMAT_VIDEO_colorPrimaries,SPA_POD_Id(info->color_primaries), 0);
117 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
118}
119
123
124#ifdef __cplusplus
125} /* extern "C" */
126#endif
127
128#endif /* SPA_VIDEO_RAW_UTILS_H */
builder.h
spa/pod/builder.h
spa_format_video_raw_parse
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:37
spa_format_video_raw_build
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:68
SPA_API_VIDEO_RAW_UTILS
#define SPA_API_VIDEO_RAW_UTILS
Definition raw-utils.h:32
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition format.h:28
SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED
@ SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED
format modifier was not fixated yet
Definition raw.h:149
SPA_VIDEO_FLAG_MODIFIER
@ SPA_VIDEO_FLAG_MODIFIER
use the format modifier
Definition raw.h:148
SPA_VIDEO_FLAG_NONE
@ SPA_VIDEO_FLAG_NONE
no flags
Definition raw.h:144
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition format.h:124
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:93
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition format.h:123
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:121
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition format.h:129
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition format.h:127
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition format.h:125
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition format.h:128
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition format.h:133
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition format.h:120
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:94
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition format.h:131
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition format.h:126
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition format.h:135
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition format.h:134
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition format.h:132
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition format.h:130
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition format.h:38
SPA_VIDEO_FORMAT_UNKNOWN
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition raw.h:44
spa_pod_builder_pop
SPA_API_POD_BUILDER void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:187
spa_pod_builder_long
SPA_API_POD_BUILDER int spa_pod_builder_long(struct spa_pod_builder *builder, int64_t val)
Definition builder.h:275
SPA_POD_Fraction
#define SPA_POD_Fraction(val)
Definition vararg.h:111
SPA_POD_OPT_Rectangle
#define SPA_POD_OPT_Rectangle(val)
Definition parser.h:546
spa_pod_find_prop
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:424
SPA_POD_PROP_FLAG_MANDATORY
#define SPA_POD_PROP_FLAG_MANDATORY
is mandatory
Definition pod.h:222
SPA_POD_OPT_Fraction
#define SPA_POD_OPT_Fraction(val)
Definition parser.h:548
spa_pod_builder_add
SPA_API_POD_BUILDER int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition builder.h:666
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:49
spa_pod_builder_push_object
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:454
SPA_POD_PROP_FLAG_DONT_FIXATE
#define SPA_POD_PROP_FLAG_DONT_FIXATE
choices need no fixation
Definition pod.h:224
SPA_POD_OPT_Int
#define SPA_POD_OPT_Int(val)
Definition parser.h:532
SPA_POD_OPT_Id
#define SPA_POD_OPT_Id(val)
Definition parser.h:530
SPA_POD_Rectangle
#define SPA_POD_Rectangle(val)
Definition vararg.h:102
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition parser.h:586
SPA_POD_Int
#define SPA_POD_Int(val)
Definition vararg.h:54
SPA_POD_OPT_Long
#define SPA_POD_OPT_Long(val)
Definition parser.h:534
spa_pod_builder_prop
SPA_API_POD_BUILDER int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition builder.h:469
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition type.h:87
parser.h
spa/pod/parser.h
spa_pod_builder
Definition builder.h:63
spa_pod_frame
Definition iter.h:37
spa_pod_prop
Definition pod.h:208
spa_pod_prop::flags
uint32_t flags
flags for property
Definition pod.h:225
spa_pod
Definition pod.h:43
spa_video_info_raw
Definition raw.h:176
raw.h
spa/param/video/raw.h