PipeWire  0.3.48
raw.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_H
26 #define SPA_VIDEO_RAW_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
37 #include <spa/utils/defs.h>
38 #include <spa/param/video/chroma.h>
39 #include <spa/param/video/color.h>
41 
42 #define SPA_VIDEO_MAX_PLANES 4
43 #define SPA_VIDEO_MAX_COMPONENTS 4
44 
56 enum spa_video_format {
59 
136 
139 
149  /* Aliases */
151 };
152 
156 enum spa_video_flags {
158  SPA_VIDEO_FLAG_VARIABLE_FPS = (1 << 0),
161 };
162 
183 };
184 
187 struct spa_video_info_raw {
188  enum spa_video_format format;
189  int64_t modifier;
191  struct spa_rectangle size;
192  struct spa_fraction framerate;
193  struct spa_fraction max_framerate;
195  uint32_t views;
207 };
208 
209 #define SPA_VIDEO_INFO_RAW_INIT(...) (struct spa_video_info_raw) { __VA_ARGS__ }
210 
211 struct spa_video_info_dsp {
213  int64_t modifier;
214 };
215 
216 #define SPA_VIDEO_INFO_DSP_INIT(...) (struct spa_video_info_dsp) { __VA_ARGS__ }
217 
222 #ifdef __cplusplus
223 } /* extern "C" */
224 #endif
225 
226 #endif /* SPA_VIDEO_RAW_H */
SPA_VIDEO_FORMAT_v216
@ SPA_VIDEO_FORMAT_v216
Definition: raw.h:87
SPA_VIDEO_FORMAT_ENCODED
@ SPA_VIDEO_FORMAT_ENCODED
Definition: raw.h:65
SPA_VIDEO_FORMAT_YV12
@ SPA_VIDEO_FORMAT_YV12
Definition: raw.h:68
spa_video_color_range
spa_video_color_range
Possible color range values.
Definition: color.h:46
SPA_VIDEO_FORMAT_GBRA_12BE
@ SPA_VIDEO_FORMAT_GBRA_12BE
Definition: raw.h:135
SPA_VIDEO_FORMAT_DSP_F32
@ SPA_VIDEO_FORMAT_DSP_F32
Definition: raw.h:157
SPA_VIDEO_FORMAT_xRGB_210LE
@ SPA_VIDEO_FORMAT_xRGB_210LE
32-bit x:R:G:B 2:10:10:10 little endian
Definition: raw.h:147
SPA_VIDEO_FORMAT_BGRx
@ SPA_VIDEO_FORMAT_BGRx
Definition: raw.h:73
spa_video_info_raw::color_primaries
enum spa_video_color_primaries color_primaries
color primaries.
Definition: raw.h:213
SPA_VIDEO_FORMAT_BGR
@ SPA_VIDEO_FORMAT_BGR
Definition: raw.h:81
SPA_VIDEO_FORMAT_A444_10BE
@ SPA_VIDEO_FORMAT_A444_10BE
Definition: raw.h:123
SPA_VIDEO_FORMAT_GBRA_10BE
@ SPA_VIDEO_FORMAT_GBRA_10BE
Definition: raw.h:131
SPA_VIDEO_FORMAT_NV61
@ SPA_VIDEO_FORMAT_NV61
Definition: raw.h:125
SPA_VIDEO_FORMAT_GRAY16_LE
@ SPA_VIDEO_FORMAT_GRAY16_LE
Definition: raw.h:92
spa_video_transfer_function
spa_video_transfer_function
The video transfer function defines the formula for converting between non-linear RGB (R'G'B') and li...
Definition: color.h:71
SPA_VIDEO_INTERLACE_MODE_PROGRESSIVE
@ SPA_VIDEO_INTERLACE_MODE_PROGRESSIVE
all frames are progressive
Definition: raw.h:175
SPA_VIDEO_FORMAT_xBGR
@ SPA_VIDEO_FORMAT_xBGR
Definition: raw.h:75
SPA_VIDEO_FORMAT_GRAY16_BE
@ SPA_VIDEO_FORMAT_GRAY16_BE
Definition: raw.h:91
SPA_VIDEO_FORMAT_RGB16
@ SPA_VIDEO_FORMAT_RGB16
Definition: raw.h:94
spa_video_info_raw::size
struct spa_rectangle size
the frame size of the video
Definition: raw.h:198
spa_video_info_raw::views
uint32_t views
the number of views in this video
Definition: raw.h:202
SPA_VIDEO_FORMAT_BGRA
@ SPA_VIDEO_FORMAT_BGRA
Definition: raw.h:77
spa_video_chroma_site
spa_video_chroma_site
Various Chroma settings.
Definition: chroma.h:44
SPA_VIDEO_FORMAT_A420_10BE
@ SPA_VIDEO_FORMAT_A420_10BE
Definition: raw.h:119
SPA_VIDEO_FORMAT_I420_10BE
@ SPA_VIDEO_FORMAT_I420_10BE
Definition: raw.h:107
SPA_VIDEO_FLAG_PREMULTIPLIED_ALPHA
@ SPA_VIDEO_FLAG_PREMULTIPLIED_ALPHA
Each color has been scaled by the alpha value.
Definition: raw.h:167
spa_video_info_raw::modifier
int64_t modifier
format modifier only used with DMA-BUF
Definition: raw.h:196
spa_video_multiview_mode
spa_video_multiview_mode
All possible stereoscopic 3D and multiview representations.
Definition: multiview.h:47
SPA_VIDEO_FORMAT_GBR_10BE
@ SPA_VIDEO_FORMAT_GBR_10BE
Definition: raw.h:114
SPA_VIDEO_FORMAT_Y444
@ SPA_VIDEO_FORMAT_Y444
Definition: raw.h:85
SPA_VIDEO_FORMAT_YUY2
@ SPA_VIDEO_FORMAT_YUY2
Definition: raw.h:69
SPA_VIDEO_FORMAT_I422_12BE
@ SPA_VIDEO_FORMAT_I422_12BE
Definition: raw.h:139
spa_fraction
Definition: defs.h:121
SPA_VIDEO_FORMAT_GBR_10LE
@ SPA_VIDEO_FORMAT_GBR_10LE
Definition: raw.h:115
spa_video_color_primaries
spa_video_color_primaries
The color primaries define the how to transform linear RGB values to and from the CIE XYZ colorspace.
Definition: color.h:93
SPA_VIDEO_FORMAT_AYUV
@ SPA_VIDEO_FORMAT_AYUV
Definition: raw.h:71
SPA_VIDEO_FORMAT_Y41B
@ SPA_VIDEO_FORMAT_Y41B
Definition: raw.h:82
spa_video_info_raw::transfer_function
enum spa_video_transfer_function transfer_function
the transfer function.
Definition: raw.h:212
SPA_VIDEO_FORMAT_v308
@ SPA_VIDEO_FORMAT_v308
Definition: raw.h:93
SPA_VIDEO_FORMAT_RGBA_F16
@ SPA_VIDEO_FORMAT_RGBA_F16
Definition: raw.h:144
SPA_VIDEO_FORMAT_ARGB_210LE
@ SPA_VIDEO_FORMAT_ARGB_210LE
32-bit A:R:G:B 2:10:10:10 little endian
Definition: raw.h:151
SPA_VIDEO_FORMAT_I420_12BE
@ SPA_VIDEO_FORMAT_I420_12BE
Definition: raw.h:137
spa_video_info_raw::max_framerate
struct spa_fraction max_framerate
the maximum framerate of the video.
Definition: raw.h:200
spa_video_info_raw::color_matrix
enum spa_video_color_matrix color_matrix
the color matrix.
Definition: raw.h:210
SPA_VIDEO_FORMAT_RGB15
@ SPA_VIDEO_FORMAT_RGB15
Definition: raw.h:96
SPA_VIDEO_FORMAT_I420_10LE
@ SPA_VIDEO_FORMAT_I420_10LE
Definition: raw.h:108
SPA_VIDEO_FORMAT_GBR
@ SPA_VIDEO_FORMAT_GBR
Definition: raw.h:113
SPA_VIDEO_FORMAT_NV12
@ SPA_VIDEO_FORMAT_NV12
Definition: raw.h:88
SPA_VIDEO_FORMAT_RGB8P
@ SPA_VIDEO_FORMAT_RGB8P
Definition: raw.h:100
spa_video_info_raw::framerate
struct spa_fraction framerate
the framerate of the video, 0/1 means variable rate
Definition: raw.h:199
spa_video_info_dsp::format
enum spa_video_format format
Definition: raw.h:220
SPA_VIDEO_FORMAT_UYVP
@ SPA_VIDEO_FORMAT_UYVP
Definition: raw.h:98
SPA_VIDEO_FORMAT_GBRA
@ SPA_VIDEO_FORMAT_GBRA
Definition: raw.h:130
SPA_VIDEO_FORMAT_P010_10BE
@ SPA_VIDEO_FORMAT_P010_10BE
Definition: raw.h:126
SPA_VIDEO_FORMAT_RGBx
@ SPA_VIDEO_FORMAT_RGBx
Definition: raw.h:72
spa_video_multiview_flags
spa_video_multiview_flags
spa_video_multiview_flags are used to indicate extra properties of a stereo/multiview stream beyond t...
Definition: multiview.h:101
spa_rectangle
Definition: defs.h:100
SPA_VIDEO_FORMAT_ABGR
@ SPA_VIDEO_FORMAT_ABGR
Definition: raw.h:79
SPA_VIDEO_FORMAT_ABGR_210LE
@ SPA_VIDEO_FORMAT_ABGR_210LE
32-bit A:B:G:R 2:10:10:10 little endian
Definition: raw.h:152
spa_video_flags
spa_video_flags
Extra video flags.
Definition: raw.h:163
SPA_VIDEO_FORMAT_xRGB
@ SPA_VIDEO_FORMAT_xRGB
Definition: raw.h:74
SPA_VIDEO_FORMAT_BGR16
@ SPA_VIDEO_FORMAT_BGR16
Definition: raw.h:95
SPA_VIDEO_FORMAT_RGBA_F32
@ SPA_VIDEO_FORMAT_RGBA_F32
Definition: raw.h:145
SPA_VIDEO_FORMAT_r210
@ SPA_VIDEO_FORMAT_r210
Definition: raw.h:106
SPA_VIDEO_FORMAT_VYUY
@ SPA_VIDEO_FORMAT_VYUY
Definition: raw.h:129
chroma.h
spa_video_info_raw::multiview_mode
enum spa_video_multiview_mode multiview_mode
multiview mode
Definition: raw.h:205
SPA_VIDEO_FORMAT_ARGB64
@ SPA_VIDEO_FORMAT_ARGB64
Definition: raw.h:104
SPA_VIDEO_FORMAT_A422_10BE
@ SPA_VIDEO_FORMAT_A422_10BE
Definition: raw.h:121
SPA_VIDEO_FORMAT_xBGR_210LE
@ SPA_VIDEO_FORMAT_xBGR_210LE
32-bit x:B:G:R 2:10:10:10 little endian
Definition: raw.h:148
SPA_VIDEO_FORMAT_UYVY
@ SPA_VIDEO_FORMAT_UYVY
Definition: raw.h:70
SPA_VIDEO_FORMAT_NV16
@ SPA_VIDEO_FORMAT_NV16
Definition: raw.h:116
spa_video_info_raw
Definition: raw.h:194
spa_video_info_raw::format
enum spa_video_format format
the format
Definition: raw.h:195
spa_video_info_raw::interlace_mode
enum spa_video_interlace_mode interlace_mode
the interlace mode
Definition: raw.h:203
SPA_VIDEO_FORMAT_NV12_64Z32
@ SPA_VIDEO_FORMAT_NV12_64Z32
Definition: raw.h:118
SPA_VIDEO_FORMAT_AYUV64
@ SPA_VIDEO_FORMAT_AYUV64
Definition: raw.h:105
SPA_VIDEO_FORMAT_Y42B
@ SPA_VIDEO_FORMAT_Y42B
Definition: raw.h:83
spa_video_info_raw::color_range
enum spa_video_color_range color_range
the color range.
Definition: raw.h:208
SPA_VIDEO_FORMAT_RGBA
@ SPA_VIDEO_FORMAT_RGBA
Definition: raw.h:76
SPA_VIDEO_FORMAT_I422_12LE
@ SPA_VIDEO_FORMAT_I422_12LE
Definition: raw.h:140
SPA_VIDEO_FORMAT_GBR_12LE
@ SPA_VIDEO_FORMAT_GBR_12LE
Definition: raw.h:134
SPA_VIDEO_FORMAT_NV24
@ SPA_VIDEO_FORMAT_NV24
Definition: raw.h:117
SPA_VIDEO_FORMAT_GBRA_10LE
@ SPA_VIDEO_FORMAT_GBRA_10LE
Definition: raw.h:132
SPA_VIDEO_FORMAT_ARGB
@ SPA_VIDEO_FORMAT_ARGB
Definition: raw.h:78
spa_video_info_dsp
Definition: raw.h:219
SPA_VIDEO_FORMAT_Y444_12LE
@ SPA_VIDEO_FORMAT_Y444_12LE
Definition: raw.h:142
SPA_VIDEO_FORMAT_BGRx_102LE
@ SPA_VIDEO_FORMAT_BGRx_102LE
32-bit B:G:R:x 10:10:10:2 little endian
Definition: raw.h:150
spa_video_info_dsp::modifier
int64_t modifier
Definition: raw.h:221
SPA_VIDEO_FORMAT_YUV9
@ SPA_VIDEO_FORMAT_YUV9
Definition: raw.h:101
SPA_VIDEO_FORMAT_YVU9
@ SPA_VIDEO_FORMAT_YVU9
Definition: raw.h:102
SPA_VIDEO_FORMAT_RGB
@ SPA_VIDEO_FORMAT_RGB
Definition: raw.h:80
SPA_VIDEO_FLAG_NONE
@ SPA_VIDEO_FLAG_NONE
no flags
Definition: raw.h:164
SPA_VIDEO_FORMAT_RGBx_102LE
@ SPA_VIDEO_FORMAT_RGBx_102LE
32-bit R:G:B:x 10:10:10:2 little endian
Definition: raw.h:149
SPA_VIDEO_FORMAT_I422_10LE
@ SPA_VIDEO_FORMAT_I422_10LE
Definition: raw.h:110
SPA_VIDEO_FORMAT_IYU1
@ SPA_VIDEO_FORMAT_IYU1
Definition: raw.h:103
SPA_VIDEO_FORMAT_UNKNOWN
@ SPA_VIDEO_FORMAT_UNKNOWN
Definition: raw.h:64
SPA_VIDEO_INTERLACE_MODE_INTERLEAVED
@ SPA_VIDEO_INTERLACE_MODE_INTERLEAVED
2 fields are interleaved in one video frame.
Definition: raw.h:176
spa_video_info_raw::pixel_aspect_ratio
struct spa_fraction pixel_aspect_ratio
the pixel aspect ratio
Definition: raw.h:204
spa_video_format
spa_video_format
Video formats.
Definition: raw.h:63
SPA_VIDEO_FORMAT_NV21
@ SPA_VIDEO_FORMAT_NV21
Definition: raw.h:89
SPA_VIDEO_FORMAT_BGRA_102LE
@ SPA_VIDEO_FORMAT_BGRA_102LE
32-bit B:G:R:A 10:10:10:2 little endian
Definition: raw.h:154
SPA_VIDEO_INTERLACE_MODE_FIELDS
@ SPA_VIDEO_INTERLACE_MODE_FIELDS
2 fields are stored in one buffer, use the frame ID to get access to the required field.
Definition: raw.h:181
SPA_VIDEO_FORMAT_A420
@ SPA_VIDEO_FORMAT_A420
Definition: raw.h:99
color.h
defs.h
SPA_VIDEO_FORMAT_Y444_10LE
@ SPA_VIDEO_FORMAT_Y444_10LE
Definition: raw.h:112
SPA_VIDEO_FORMAT_Y444_12BE
@ SPA_VIDEO_FORMAT_Y444_12BE
Definition: raw.h:141
SPA_VIDEO_FORMAT_I420
@ SPA_VIDEO_FORMAT_I420
Definition: raw.h:67
spa_video_info_raw::multiview_flags
enum spa_video_multiview_flags multiview_flags
multiview flags
Definition: raw.h:206
SPA_VIDEO_FORMAT_BGR15
@ SPA_VIDEO_FORMAT_BGR15
Definition: raw.h:97
SPA_VIDEO_FORMAT_I420_12LE
@ SPA_VIDEO_FORMAT_I420_12LE
Definition: raw.h:138
spa_video_info_raw::chroma_site
enum spa_video_chroma_site chroma_site
the chroma siting
Definition: raw.h:207
spa_video_interlace_mode
spa_video_interlace_mode
The possible values of the spa_video_interlace_mode describing the interlace mode of the stream.
Definition: raw.h:174
SPA_VIDEO_FORMAT_P010_10LE
@ SPA_VIDEO_FORMAT_P010_10LE
Definition: raw.h:127
SPA_VIDEO_FORMAT_GBRA_12LE
@ SPA_VIDEO_FORMAT_GBRA_12LE
Definition: raw.h:136
SPA_VIDEO_FORMAT_Y444_10BE
@ SPA_VIDEO_FORMAT_Y444_10BE
Definition: raw.h:111
SPA_VIDEO_FORMAT_I422_10BE
@ SPA_VIDEO_FORMAT_I422_10BE
Definition: raw.h:109
SPA_VIDEO_FORMAT_RGBA_102LE
@ SPA_VIDEO_FORMAT_RGBA_102LE
32-bit R:G:B:A 10:10:10:2 little endian
Definition: raw.h:153
SPA_VIDEO_FORMAT_GRAY8
@ SPA_VIDEO_FORMAT_GRAY8
Definition: raw.h:90
SPA_VIDEO_FLAG_VARIABLE_FPS
@ SPA_VIDEO_FLAG_VARIABLE_FPS
a variable fps is selected, fps_n and fps_d denote the maximum fps of the video
Definition: raw.h:165
multiview.h
spa_video_color_matrix
spa_video_color_matrix
The color matrix is used to convert between Y'PbPr and non-linear RGB (R'G'B')
Definition: color.h:57
SPA_VIDEO_FORMAT_v210
@ SPA_VIDEO_FORMAT_v210
Definition: raw.h:86
SPA_VIDEO_FORMAT_IYU2
@ SPA_VIDEO_FORMAT_IYU2
Definition: raw.h:128
SPA_VIDEO_FORMAT_A420_10LE
@ SPA_VIDEO_FORMAT_A420_10LE
Definition: raw.h:120
SPA_VIDEO_FORMAT_GBR_12BE
@ SPA_VIDEO_FORMAT_GBR_12BE
Definition: raw.h:133
SPA_VIDEO_FORMAT_A444_10LE
@ SPA_VIDEO_FORMAT_A444_10LE
Definition: raw.h:124
SPA_VIDEO_INTERLACE_MODE_MIXED
@ SPA_VIDEO_INTERLACE_MODE_MIXED
frames contains both interlaced and progressive video, the buffer flags describe the frame and fields...
Definition: raw.h:178
SPA_VIDEO_FORMAT_YVYU
@ SPA_VIDEO_FORMAT_YVYU
Definition: raw.h:84
SPA_VIDEO_FORMAT_A422_10LE
@ SPA_VIDEO_FORMAT_A422_10LE
Definition: raw.h:122