PipeWire: raw-utils.h Source File

PipeWire 0.3.66

Loading...
Searching...
No Matches
video/raw-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_VIDEO_RAW_UTILS_H
26#define SPA_VIDEO_RAW_UTILS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/pod/parser.h>
38#include <spa/pod/builder.h>
39#include <spa/param/video/raw.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 info->flags = SPA_VIDEO_FLAG_NONE;
46 if (spa_pod_find_prop (format, NULL, SPA_FORMAT_VIDEO_modifier)) {
47 info->flags |= SPA_VIDEO_FLAG_MODIFIER;
48 }
49
50 return spa_pod_parse_object(format,
51 SPA_TYPE_OBJECT_Format, NULL,
52 SPA_FORMAT_VIDEO_format, SPA_POD_OPT_Id(&info->format),
53 SPA_FORMAT_VIDEO_modifier, SPA_POD_OPT_Long(&info->modifier),
54 SPA_FORMAT_VIDEO_size, SPA_POD_OPT_Rectangle(&info->size),
55 SPA_FORMAT_VIDEO_framerate, SPA_POD_OPT_Fraction(&info->framerate),
56 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate),
57 SPA_FORMAT_VIDEO_views, SPA_POD_OPT_Int(&info->views),
58 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_OPT_Id(&info->interlace_mode),
59 SPA_FORMAT_VIDEO_pixelAspectRatio, SPA_POD_OPT_Fraction(&info->pixel_aspect_ratio),
60 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_OPT_Id(&info->multiview_mode),
61 SPA_FORMAT_VIDEO_multiviewFlags, SPA_POD_OPT_Id(&info->multiview_flags),
62 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_OPT_Id(&info->chroma_site),
63 SPA_FORMAT_VIDEO_colorRange, SPA_POD_OPT_Id(&info->color_range),
64 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_OPT_Id(&info->color_matrix),
65 SPA_FORMAT_VIDEO_transferFunction, SPA_POD_OPT_Id(&info->transfer_function),
66 SPA_FORMAT_VIDEO_colorPrimaries, SPA_POD_OPT_Id(&info->color_primaries));
67}
68
69static inline struct spa_pod *
70 spa_format_video_raw_build(struct spa_pod_builder *builder, uint32_t id,
71 struct spa_video_info_raw *info)
72{
73 struct spa_pod_frame f;
74 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
75 spa_pod_builder_add(builder,
76 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video),
77 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
78 0);
79 if (info->format != SPA_VIDEO_FORMAT_UNKNOWN)
80 spa_pod_builder_add(builder,
81 SPA_FORMAT_VIDEO_format, SPA_POD_Id(info->format), 0);
82 if (info->size.width != 0 && info->size.height != 0)
83 spa_pod_builder_add(builder,
84 SPA_FORMAT_VIDEO_size, SPA_POD_Rectangle(&info->size), 0);
85 if (info->framerate.denom != 0)
86 spa_pod_builder_add(builder,
87 SPA_FORMAT_VIDEO_framerate, SPA_POD_Fraction(&info->framerate), 0);
88 if (info->modifier != 0 || info->flags & SPA_VIDEO_FLAG_MODIFIER)
89 spa_pod_builder_add(builder,
90 SPA_FORMAT_VIDEO_modifier, SPA_POD_Long(info->modifier), 0);
91 if (info->max_framerate.denom != 0)
92 spa_pod_builder_add(builder,
93 SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_Fraction(info->max_framerate), 0);
94 if (info->views != 0)
95 spa_pod_builder_add(builder,
96 SPA_FORMAT_VIDEO_views, SPA_POD_Int(info->views), 0);
97 if (info->interlace_mode != 0)
98 spa_pod_builder_add(builder,
99 SPA_FORMAT_VIDEO_interlaceMode, SPA_POD_Id(info->interlace_mode), 0);
100 if (info->pixel_aspect_ratio.denom != 0)
101 spa_pod_builder_add(builder,
102 SPA_FORMAT_VIDEO_pixelAspectRatio,SPA_POD_Fraction(info->pixel_aspect_ratio), 0);
103 if (info->multiview_mode != 0)
104 spa_pod_builder_add(builder,
105 SPA_FORMAT_VIDEO_multiviewMode, SPA_POD_Id(info->multiview_mode), 0);
106 if (info->multiview_flags != 0)
107 spa_pod_builder_add(builder,
108 SPA_FORMAT_VIDEO_multiviewFlags,SPA_POD_Id(info->multiview_flags), 0);
109 if (info->chroma_site != 0)
110 spa_pod_builder_add(builder,
111 SPA_FORMAT_VIDEO_chromaSite, SPA_POD_Id(info->chroma_site), 0);
112 if (info->color_range != 0)
113 spa_pod_builder_add(builder,
114 SPA_FORMAT_VIDEO_colorRange, SPA_POD_Id(info->color_range), 0);
115 if (info->color_matrix != 0)
116 spa_pod_builder_add(builder,
117 SPA_FORMAT_VIDEO_colorMatrix, SPA_POD_Id(info->color_matrix), 0);
118 if (info->transfer_function != 0)
119 spa_pod_builder_add(builder,
120 SPA_FORMAT_VIDEO_transferFunction,SPA_POD_Id(info->transfer_function), 0);
121 if (info->color_primaries != 0)
122 spa_pod_builder_add(builder,
123 SPA_FORMAT_VIDEO_colorPrimaries,SPA_POD_Id(info->color_primaries), 0);
124 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
125}
126
131#ifdef __cplusplus
132} /* extern "C" */
133#endif
134
135#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:75
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:47
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition: param/format.h:48
SPA_VIDEO_FLAG_MODIFIER
@ SPA_VIDEO_FLAG_MODIFIER
use the format modifier
Definition: video/raw.h:168
SPA_VIDEO_FLAG_NONE
@ SPA_VIDEO_FLAG_NONE
no flags
Definition: video/raw.h:164
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: param/format.h:143
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: param/format.h:112
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: param/format.h:142
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:140
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition: param/format.h:148
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: param/format.h:146
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: param/format.h:144
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: param/format.h:147
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: param/format.h:152
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: param/format.h:139
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:113
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: param/format.h:150
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: param/format.h:145
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: param/format.h:154
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: param/format.h:153
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: param/format.h:151
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: param/format.h:149
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: param/format.h:58
SPA_VIDEO_FORMAT_UNKNOWN
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: video/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:556
SPA_POD_Long
#define SPA_POD_Long(val)
Definition: vararg.h:85
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:428
spa_pod_builder_add
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:667
SPA_POD_OPT_Fraction
#define SPA_POD_OPT_Fraction(val)
Definition: parser.h:558
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:188
SPA_POD_OPT_Int
#define SPA_POD_OPT_Int(val)
Definition: parser.h:542
SPA_POD_OPT_Id
#define SPA_POD_OPT_Id(val)
Definition: parser.h:540
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:455
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:596
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:544
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition: spa/include/spa/utils/type.h:96
parser.h
spa/pod/parser.h
spa_fraction::denom
uint32_t denom
Definition: defs.h:141
spa_pod_builder
Definition: builder.h:73
spa_pod_frame
Definition: iter.h:47
spa_pod
Definition: pod/pod.h:63
spa_rectangle::width
uint32_t width
Definition: defs.h:119
spa_rectangle::height
uint32_t height
Definition: defs.h:120
spa_video_info_raw
Definition: video/raw.h:195
spa_video_info_raw::color_primaries
enum spa_video_color_primaries color_primaries
color primaries.
Definition: video/raw.h:215
spa_video_info_raw::transfer_function
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: video/raw.h:214
spa_video_info_raw::interlace_mode
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: video/raw.h:205
spa_video_info_raw::size
struct spa_rectangle size
the frame size of the video
Definition: video/raw.h:200
spa_video_info_raw::color_range
enum spa_video_color_range color_range
the color range.
Definition: video/raw.h:210
spa_video_info_raw::pixel_aspect_ratio
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: video/raw.h:206
spa_video_info_raw::multiview_mode
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: video/raw.h:207
spa_video_info_raw::views
uint32_t views
the number of views in this video
Definition: video/raw.h:204
spa_video_info_raw::flags
uint32_t flags
extra video flags
Definition: video/raw.h:197
spa_video_info_raw::modifier
uint64_t modifier
format modifier only used with DMA-BUF
Definition: video/raw.h:198
spa_video_info_raw::framerate
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: video/raw.h:201
spa_video_info_raw::multiview_flags
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: video/raw.h:208
spa_video_info_raw::format
enum spa_video_format format
the format
Definition: video/raw.h:196
spa_video_info_raw::color_matrix
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: video/raw.h:212
spa_video_info_raw::max_framerate
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: video/raw.h:202
spa_video_info_raw::chroma_site
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: video/raw.h:209
raw.h
spa/param/video/raw.h