PipeWire: raw-utils.h Source File

PipeWire 0.3.79

Loading...
Searching...
No Matches
video/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
17#include <spa/pod/parser.h>
18#include <spa/pod/builder.h>
19#include <spa/param/video/raw.h>
20
21static inline int
22 spa_format_video_raw_parse(const struct spa_pod *format,
23 struct spa_video_info_raw *info)
24{
25 info->flags = SPA_VIDEO_FLAG_NONE;
26 const struct spa_pod_prop *mod_prop;
27 if ((mod_prop = spa_pod_find_prop (format, NULL, SPA_FORMAT_VIDEO_modifier)) != NULL) {
28 info->flags |= SPA_VIDEO_FLAG_MODIFIER;
29 if ((mod_prop->flags & SPA_POD_PROP_FLAG_DONT_FIXATE) == SPA_POD_PROP_FLAG_DONT_FIXATE)
30 info->flags |= SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED;
31 }
32
33 return spa_pod_parse_object(format,
34 SPA_TYPE_OBJECT_Format, NULL,
35 SPA_FORMAT_VIDEO_format, SPA_POD_OPT_Id(&info->format),
36 SPA_FORMAT_VIDEO_modifier, SPA_POD_OPT_Long(&info->modifier),
37 SPA_FORMAT_VIDEO_size, SPA_POD_OPT_Rectangle(&info->size),
38 SPA_FORMAT_VIDEO_framerate, SPA_POD_OPT_Fraction(&info->framerate),
39 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate),
40 SPA_FORMAT_VIDEO_views, SPA_POD_OPT_Int(&info->views),
41 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_OPT_Id(&info->interlace_mode),
42 SPA_FORMAT_VIDEO_pixelAspectRatio, SPA_POD_OPT_Fraction(&info->pixel_aspect_ratio),
43 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_OPT_Id(&info->multiview_mode),
44 SPA_FORMAT_VIDEO_multiviewFlags, SPA_POD_OPT_Id(&info->multiview_flags),
45 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_OPT_Id(&info->chroma_site),
46 SPA_FORMAT_VIDEO_colorRange, SPA_POD_OPT_Id(&info->color_range),
47 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_OPT_Id(&info->color_matrix),
48 SPA_FORMAT_VIDEO_transferFunction, SPA_POD_OPT_Id(&info->transfer_function),
49 SPA_FORMAT_VIDEO_colorPrimaries, SPA_POD_OPT_Id(&info->color_primaries));
50}
51
52static inline struct spa_pod *
53 spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id,
54 struct spa_video_info_raw *info)
55{
56 struct spa_pod_frame f;
57 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
58 spa_pod_builder_add(builder,
59 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
60 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
61 0);
62 if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
63 spa_pod_builder_add(builder,
64 SPA_FORMAT_VIDEO_format, SPA_POD_Id(info->format), 0);
65 if (info->size.width != 0 && info->size.height != 0)
66 spa_pod_builder_add(builder,
67 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
68 if (info->framerate.denom != 0)
69 spa_pod_builder_add(builder,
70 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
71 if (info->modifier != 0 || info->flags & SPA_VIDEO_FLAG_MODIFIER) {
72 spa_pod_builder_prop(builder,
73 SPA_FORMAT_VIDEO_modifier, SPA_POD_PROP_FLAG_MANDATORY);
74 spa_pod_builder_long(builder, info->modifier);
75 }
76 if (info->max_framerate.denom != 0)
77 spa_pod_builder_add(builder,
78 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(info->max_framerate), 0);
79 if (info->views != 0)
80 spa_pod_builder_add(builder,
81 SPA_FORMAT_VIDEO_views, SPA_POD_Int(info->views), 0);
82 if (info->interlace_mode != 0)
83 spa_pod_builder_add(builder,
84 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_Id(info->interlace_mode), 0);
85 if (info->pixel_aspect_ratio.denom != 0)
86 spa_pod_builder_add(builder,
87 SPA_FORMAT_VIDEO_pixelAspectRatio,SPA_POD_Fraction(info->pixel_aspect_ratio), 0);
88 if (info->multiview_mode != 0)
89 spa_pod_builder_add(builder,
90 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_Id(info->multiview_mode), 0);
91 if (info->multiview_flags != 0)
92 spa_pod_builder_add(builder,
93 SPA_FORMAT_VIDEO_multiviewFlags,SPA_POD_Id(info->multiview_flags), 0);
94 if (info->chroma_site != 0)
95 spa_pod_builder_add(builder,
96 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_Id(info->chroma_site), 0);
97 if (info->color_range != 0)
98 spa_pod_builder_add(builder,
99 SPA_FORMAT_VIDEO_colorRange, SPA_POD_Id(info->color_range), 0);
100 if (info->color_matrix != 0)
101 spa_pod_builder_add(builder,
102 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_Id(info->color_matrix), 0);
103 if (info->transfer_function != 0)
104 spa_pod_builder_add(builder,
105 SPA_FORMAT_VIDEO_transferFunction,SPA_POD_Id(info->transfer_function), 0);
106 if (info->color_primaries != 0)
107 spa_pod_builder_add(builder,
108 SPA_FORMAT_VIDEO_colorPrimaries,SPA_POD_Id(info->color_primaries), 0);
109 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
110}
111
116#ifdef __cplusplus
117} /* extern "C" */
118#endif
119
120#endif /* SPA_VIDEO_RAW_UTILS_H */
builder.h
spa/pod/builder.h
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 video/raw-utils.h:58
spa_format_video_raw_parse
static int spa_format_video_raw_parse(const struct spa_pod *format, struct spa_video_info_raw *info)
Definition video/raw-utils.h:27
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition param/format.h:28
SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED
@ SPA_VIDEO_FLAG_MODIFIER_FIXATION_REQUIRED
format modifier was not fixated yet
Definition video/raw.h:149
SPA_VIDEO_FLAG_MODIFIER
@ SPA_VIDEO_FLAG_MODIFIER
use the format modifier
Definition video/raw.h:148
SPA_VIDEO_FLAG_NONE
@ SPA_VIDEO_FLAG_NONE
no flags
Definition video/raw.h:144
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition param/format.h:124
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition param/format.h:93
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition param/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 param/format.h:121
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition param/format.h:129
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition param/format.h:127
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition param/format.h:125
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition param/format.h:128
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition param/format.h:133
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition param/format.h:120
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition param/format.h:94
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition param/format.h:131
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition param/format.h:126
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition param/format.h:135
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition param/format.h:134
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition param/format.h:132
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition param/format.h:130
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition param/format.h:38
SPA_VIDEO_FORMAT_UNKNOWN
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition video/raw.h:44
spa_pod_builder_prop
static int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition builder.h:450
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:536
SPA_POD_PROP_FLAG_MANDATORY
#define SPA_POD_PROP_FLAG_MANDATORY
is mandatory
Definition pod/pod.h:222
spa_pod_find_prop
static 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:408
spa_pod_builder_add
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition builder.h:647
SPA_POD_OPT_Fraction
#define SPA_POD_OPT_Fraction(val)
Definition parser.h:538
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:49
spa_pod_builder_pop
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:168
SPA_POD_PROP_FLAG_DONT_FIXATE
#define SPA_POD_PROP_FLAG_DONT_FIXATE
choices need no fixation
Definition pod/pod.h:224
SPA_POD_OPT_Int
#define SPA_POD_OPT_Int(val)
Definition parser.h:522
SPA_POD_OPT_Id
#define SPA_POD_OPT_Id(val)
Definition parser.h:520
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:435
spa_pod_builder_long
static int spa_pod_builder_long(struct spa_pod_builder *builder, int64_t val)
Definition builder.h:256
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:576
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:524
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition spa/include/spa/utils/type.h:76
parser.h
spa/pod/parser.h
spa_fraction::denom
uint32_t denom
Definition defs.h:125
spa_pod_builder
Definition builder.h:53
spa_pod_frame
Definition iter.h:27
spa_pod_prop
Definition pod/pod.h:208
spa_pod_prop::flags
uint32_t flags
flags for property
Definition pod/pod.h:225
spa_pod
Definition pod/pod.h:43
spa_pod::type
uint32_t type
Definition pod/pod.h:45
spa_rectangle::width
uint32_t width
Definition defs.h:103
spa_rectangle::height
uint32_t height
Definition defs.h:104
spa_video_info_raw
Definition video/raw.h:176
spa_video_info_raw::color_primaries
enum spa_video_color_primaries color_primaries
color primaries.
Definition video/raw.h:196
spa_video_info_raw::transfer_function
enum spa_video_transfer_function transfer_function
the transfer function.
Definition video/raw.h:195
spa_video_info_raw::interlace_mode
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition video/raw.h:186
spa_video_info_raw::size
struct spa_rectangle size
the frame size of the video
Definition video/raw.h:181
spa_video_info_raw::color_range
enum spa_video_color_range color_range
the color range.
Definition video/raw.h:191
spa_video_info_raw::pixel_aspect_ratio
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition video/raw.h:187
spa_video_info_raw::multiview_mode
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition video/raw.h:188
spa_video_info_raw::views
uint32_t views
the number of views in this video
Definition video/raw.h:185
spa_video_info_raw::flags
uint32_t flags
extra video flags
Definition video/raw.h:178
spa_video_info_raw::modifier
uint64_t modifier
format modifier only used with DMA-BUF
Definition video/raw.h:179
spa_video_info_raw::framerate
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition video/raw.h:182
spa_video_info_raw::multiview_flags
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition video/raw.h:189
spa_video_info_raw::format
enum spa_video_format format
the format
Definition video/raw.h:177
spa_video_info_raw::color_matrix
enum spa_video_color_matrix color_matrix
the color matrix.
Definition video/raw.h:193
spa_video_info_raw::max_framerate
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition video/raw.h:183
spa_video_info_raw::chroma_site
enum spa_video_chroma_site chroma_site
the chroma siting
Definition video/raw.h:190
raw.h
spa/param/video/raw.h