PipeWire 1.6.8

Loading...
Searching...
No Matches
format.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_PARAM_FORMAT_H
6#define SPA_PARAM_FORMAT_H
7
8#include <spa/param/param.h>
9
10#ifdef __cplusplus
11 extern "C" {
12#endif
13
18
20 enum spa_media_type {
21 SPA_MEDIA_TYPE_unknown,
22 SPA_MEDIA_TYPE_audio,
23 SPA_MEDIA_TYPE_video,
24 SPA_MEDIA_TYPE_image,
25 SPA_MEDIA_TYPE_binary,
26 SPA_MEDIA_TYPE_stream,
27 SPA_MEDIA_TYPE_application,
28};
29
31 enum spa_media_subtype {
32 SPA_MEDIA_SUBTYPE_unknown,
33 SPA_MEDIA_SUBTYPE_raw,
34 SPA_MEDIA_SUBTYPE_dsp,
35 SPA_MEDIA_SUBTYPE_iec958,
36 SPA_MEDIA_SUBTYPE_dsd,
37
38 SPA_MEDIA_SUBTYPE_START_Audio = 0x10000,
39 SPA_MEDIA_SUBTYPE_mp3,
40 SPA_MEDIA_SUBTYPE_aac,
41 SPA_MEDIA_SUBTYPE_vorbis,
42 SPA_MEDIA_SUBTYPE_wma,
43 SPA_MEDIA_SUBTYPE_ra,
44 SPA_MEDIA_SUBTYPE_sbc,
45 SPA_MEDIA_SUBTYPE_adpcm,
46 SPA_MEDIA_SUBTYPE_g723,
47 SPA_MEDIA_SUBTYPE_g726,
48 SPA_MEDIA_SUBTYPE_g729,
49 SPA_MEDIA_SUBTYPE_amr,
50 SPA_MEDIA_SUBTYPE_gsm,
51 SPA_MEDIA_SUBTYPE_alac,
52 SPA_MEDIA_SUBTYPE_flac,
53 SPA_MEDIA_SUBTYPE_ape,
54 SPA_MEDIA_SUBTYPE_opus,
55 SPA_MEDIA_SUBTYPE_ac3,
56 SPA_MEDIA_SUBTYPE_eac3,
57 SPA_MEDIA_SUBTYPE_truehd,
58 SPA_MEDIA_SUBTYPE_dts,
59 SPA_MEDIA_SUBTYPE_mpegh,
60
61 SPA_MEDIA_SUBTYPE_START_Video = 0x20000,
62 SPA_MEDIA_SUBTYPE_h264,
63 SPA_MEDIA_SUBTYPE_mjpg,
64 SPA_MEDIA_SUBTYPE_dv,
65 SPA_MEDIA_SUBTYPE_mpegts,
66 SPA_MEDIA_SUBTYPE_h263,
67 SPA_MEDIA_SUBTYPE_mpeg1,
68 SPA_MEDIA_SUBTYPE_mpeg2,
69 SPA_MEDIA_SUBTYPE_mpeg4,
70 SPA_MEDIA_SUBTYPE_xvid,
71 SPA_MEDIA_SUBTYPE_vc1,
72 SPA_MEDIA_SUBTYPE_vp8,
73 SPA_MEDIA_SUBTYPE_vp9,
74 SPA_MEDIA_SUBTYPE_bayer,
75 SPA_MEDIA_SUBTYPE_h265,
76
77 SPA_MEDIA_SUBTYPE_START_Image = 0x30000,
78 SPA_MEDIA_SUBTYPE_jpeg,
79
80 SPA_MEDIA_SUBTYPE_START_Binary = 0x40000,
81
82 SPA_MEDIA_SUBTYPE_START_Stream = 0x50000,
83 SPA_MEDIA_SUBTYPE_midi,
84
85 SPA_MEDIA_SUBTYPE_START_Application = 0x60000,
86 SPA_MEDIA_SUBTYPE_control,
88};
89
91 enum spa_format {
92 SPA_FORMAT_START,
93
94 SPA_FORMAT_mediaType,
95 SPA_FORMAT_mediaSubtype,
96
97 /* Audio format keys */
98 SPA_FORMAT_START_Audio = 0x10000,
99 SPA_FORMAT_AUDIO_format,
100 SPA_FORMAT_AUDIO_flags,
101 SPA_FORMAT_AUDIO_rate,
102 SPA_FORMAT_AUDIO_channels,
103 SPA_FORMAT_AUDIO_position,
104
105 SPA_FORMAT_AUDIO_iec958Codec,
106
107 SPA_FORMAT_AUDIO_bitorder,
108 SPA_FORMAT_AUDIO_interleave,
109 SPA_FORMAT_AUDIO_bitrate,
110 SPA_FORMAT_AUDIO_blockAlign,
111
112 SPA_FORMAT_AUDIO_AAC_streamFormat,
113
114 SPA_FORMAT_AUDIO_WMA_profile,
115
116 SPA_FORMAT_AUDIO_AMR_bandMode,
117
118 SPA_FORMAT_AUDIO_MP3_channelMode,
119
120 SPA_FORMAT_AUDIO_DTS_extType,
121
122
123 /* Video Format keys */
124 SPA_FORMAT_START_Video = 0x20000,
125 SPA_FORMAT_VIDEO_format,
126 SPA_FORMAT_VIDEO_modifier,
128 SPA_FORMAT_VIDEO_size,
129 SPA_FORMAT_VIDEO_framerate,
130 SPA_FORMAT_VIDEO_maxFramerate,
131 SPA_FORMAT_VIDEO_views,
132 SPA_FORMAT_VIDEO_interlaceMode,
133 SPA_FORMAT_VIDEO_pixelAspectRatio,
134 SPA_FORMAT_VIDEO_multiviewMode,
135 SPA_FORMAT_VIDEO_multiviewFlags,
136 SPA_FORMAT_VIDEO_chromaSite,
137 SPA_FORMAT_VIDEO_colorRange,
138 SPA_FORMAT_VIDEO_colorMatrix,
139 SPA_FORMAT_VIDEO_transferFunction,
140 SPA_FORMAT_VIDEO_colorPrimaries,
141 SPA_FORMAT_VIDEO_profile,
142 SPA_FORMAT_VIDEO_level,
143 SPA_FORMAT_VIDEO_H264_streamFormat,
144 SPA_FORMAT_VIDEO_H264_alignment,
145 SPA_FORMAT_VIDEO_H265_streamFormat,
146 SPA_FORMAT_VIDEO_H265_alignment,
147 SPA_FORMAT_VIDEO_deviceId,
148
149 /* Image Format keys */
150 SPA_FORMAT_START_Image = 0x30000,
151 /* Binary Format keys */
152 SPA_FORMAT_START_Binary = 0x40000,
153 /* Stream Format keys */
154 SPA_FORMAT_START_Stream = 0x50000,
155 /* Application Format keys */
156 SPA_FORMAT_START_Application = 0x60000,
157 SPA_FORMAT_CONTROL_types,
159};
160
161#define SPA_KEY_FORMAT_DSP "format.dsp"
163
165
167
168#ifdef __cplusplus
169} /* extern "C" */
170#endif
171
172#endif /* SPA_PARAM_FORMAT_H */
spa_media_type
spa_media_type
media type for SPA_TYPE_OBJECT_Format
Definition format.h:25
spa_format
spa_format
properties for audio SPA_TYPE_OBJECT_Format
Definition format.h:96
spa_media_subtype
spa_media_subtype
media subtype for SPA_TYPE_OBJECT_Format
Definition format.h:36
SPA_MEDIA_TYPE_unknown
@ SPA_MEDIA_TYPE_unknown
Definition format.h:26
SPA_MEDIA_TYPE_application
@ SPA_MEDIA_TYPE_application
Definition format.h:32
SPA_MEDIA_TYPE_audio
@ SPA_MEDIA_TYPE_audio
Definition format.h:27
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition format.h:28
SPA_MEDIA_TYPE_binary
@ SPA_MEDIA_TYPE_binary
Definition format.h:30
SPA_MEDIA_TYPE_image
@ SPA_MEDIA_TYPE_image
Definition format.h:29
SPA_MEDIA_TYPE_stream
@ SPA_MEDIA_TYPE_stream
Definition format.h:31
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition format.h:134
SPA_FORMAT_AUDIO_iec958Codec
@ SPA_FORMAT_AUDIO_iec958Codec
codec used (IEC958) (Id enum spa_audio_iec958_codec)
Definition format.h:110
SPA_FORMAT_VIDEO_H264_streamFormat
@ SPA_FORMAT_VIDEO_H264_streamFormat
(Id enum spa_h264_stream_format)
Definition format.h:148
SPA_FORMAT_AUDIO_AAC_streamFormat
@ SPA_FORMAT_AUDIO_AAC_streamFormat
AAC stream format, (Id enum spa_audio_aac_stream_format).
Definition format.h:117
SPA_FORMAT_AUDIO_interleave
@ SPA_FORMAT_AUDIO_interleave
Interleave bytes (Int).
Definition format.h:113
SPA_FORMAT_CONTROL_types
@ SPA_FORMAT_CONTROL_types
possible control types (flags choice Int, mask of enum spa_control_type)
Definition format.h:162
SPA_FORMAT_AUDIO_blockAlign
@ SPA_FORMAT_AUDIO_blockAlign
audio data block alignment (Int)
Definition format.h:115
SPA_FORMAT_START_Audio
@ SPA_FORMAT_START_Audio
Definition format.h:103
SPA_FORMAT_AUDIO_AMR_bandMode
@ SPA_FORMAT_AUDIO_AMR_bandMode
AMR band mode (Id enum spa_audio_amr_band_mode).
Definition format.h:121
SPA_FORMAT_AUDIO_bitorder
@ SPA_FORMAT_AUDIO_bitorder
bit order (Id enum spa_param_bitorder)
Definition format.h:112
SPA_FORMAT_VIDEO_level
@ SPA_FORMAT_VIDEO_level
(Int)
Definition format.h:147
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:99
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition format.h:133
SPA_FORMAT_AUDIO_position
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition format.h:108
SPA_FORMAT_VIDEO_profile
@ SPA_FORMAT_VIDEO_profile
(Int)
Definition format.h:146
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:131
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition format.h:106
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition format.h:139
SPA_FORMAT_START_Stream
@ SPA_FORMAT_START_Stream
Definition format.h:159
SPA_FORMAT_VIDEO_deviceId
@ SPA_FORMAT_VIDEO_deviceId
dev_t identifier (Bytes)
Definition format.h:152
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition format.h:137
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition format.h:135
SPA_FORMAT_START_Image
@ SPA_FORMAT_START_Image
Definition format.h:155
SPA_FORMAT_AUDIO_flags
@ SPA_FORMAT_AUDIO_flags
optional flags (Int)
Definition format.h:105
SPA_FORMAT_START_Application
@ SPA_FORMAT_START_Application
Definition format.h:161
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition format.h:138
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition format.h:143
SPA_FORMAT_VIDEO_H265_alignment
@ SPA_FORMAT_VIDEO_H265_alignment
(Id enum spa_h265_alignment)
Definition format.h:151
SPA_FORMAT_AUDIO_bitrate
@ SPA_FORMAT_AUDIO_bitrate
bit rate (Int)
Definition format.h:114
SPA_FORMAT_AUDIO_WMA_profile
@ SPA_FORMAT_AUDIO_WMA_profile
WMA profile (Id enum spa_audio_wma_profile).
Definition format.h:119
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition format.h:130
SPA_FORMAT_AUDIO_MP3_channelMode
@ SPA_FORMAT_AUDIO_MP3_channelMode
MP3 channel mode, (Id enum spa_audio_mp3_channel_mode).
Definition format.h:123
SPA_FORMAT_START_Binary
@ SPA_FORMAT_START_Binary
Definition format.h:157
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:100
SPA_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition format.h:104
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition format.h:141
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition format.h:136
SPA_FORMAT_VIDEO_H265_streamFormat
@ SPA_FORMAT_VIDEO_H265_streamFormat
(Id enum spa_h265_stream_format)
Definition format.h:150
SPA_FORMAT_AUDIO_DTS_extType
@ SPA_FORMAT_AUDIO_DTS_extType
DTS extension type (Id enum spa_audio_dts_ext_type).
Definition format.h:125
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition format.h:145
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition format.h:144
SPA_FORMAT_VIDEO_H264_alignment
@ SPA_FORMAT_VIDEO_H264_alignment
(Id enum spa_h264_alignment)
Definition format.h:149
SPA_FORMAT_START_Video
@ SPA_FORMAT_START_Video
Definition format.h:129
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition format.h:142
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition format.h:107
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition format.h:140
SPA_FORMAT_START
@ SPA_FORMAT_START
Definition format.h:97
SPA_MEDIA_SUBTYPE_midi
@ SPA_MEDIA_SUBTYPE_midi
Definition format.h:88
SPA_MEDIA_SUBTYPE_h264
@ SPA_MEDIA_SUBTYPE_h264
Definition format.h:67
SPA_MEDIA_SUBTYPE_alac
@ SPA_MEDIA_SUBTYPE_alac
Definition format.h:56
SPA_MEDIA_SUBTYPE_ra
@ SPA_MEDIA_SUBTYPE_ra
Definition format.h:48
SPA_MEDIA_SUBTYPE_mpeg4
@ SPA_MEDIA_SUBTYPE_mpeg4
Definition format.h:74
SPA_MEDIA_SUBTYPE_START_Binary
@ SPA_MEDIA_SUBTYPE_START_Binary
Definition format.h:85
SPA_MEDIA_SUBTYPE_mp3
@ SPA_MEDIA_SUBTYPE_mp3
Definition format.h:44
SPA_MEDIA_SUBTYPE_ac3
@ SPA_MEDIA_SUBTYPE_ac3
since 0.3.68
Definition format.h:60
SPA_MEDIA_SUBTYPE_h265
@ SPA_MEDIA_SUBTYPE_h265
Definition format.h:80
SPA_MEDIA_SUBTYPE_aac
@ SPA_MEDIA_SUBTYPE_aac
Definition format.h:45
SPA_MEDIA_SUBTYPE_iec958
@ SPA_MEDIA_SUBTYPE_iec958
Definition format.h:40
SPA_MEDIA_SUBTYPE_START_Video
@ SPA_MEDIA_SUBTYPE_START_Video
since 1.5.1
Definition format.h:66
SPA_MEDIA_SUBTYPE_mpeg2
@ SPA_MEDIA_SUBTYPE_mpeg2
Definition format.h:73
SPA_MEDIA_SUBTYPE_sbc
@ SPA_MEDIA_SUBTYPE_sbc
Definition format.h:49
SPA_MEDIA_SUBTYPE_ape
@ SPA_MEDIA_SUBTYPE_ape
since 0.3.65
Definition format.h:58
SPA_MEDIA_SUBTYPE_wma
@ SPA_MEDIA_SUBTYPE_wma
Definition format.h:47
SPA_MEDIA_SUBTYPE_h263
@ SPA_MEDIA_SUBTYPE_h263
Definition format.h:71
SPA_MEDIA_SUBTYPE_g726
@ SPA_MEDIA_SUBTYPE_g726
Definition format.h:52
SPA_MEDIA_SUBTYPE_truehd
@ SPA_MEDIA_SUBTYPE_truehd
since 1.5.1
Definition format.h:62
SPA_MEDIA_SUBTYPE_amr
@ SPA_MEDIA_SUBTYPE_amr
Definition format.h:54
SPA_MEDIA_SUBTYPE_unknown
@ SPA_MEDIA_SUBTYPE_unknown
Definition format.h:37
SPA_MEDIA_SUBTYPE_mjpg
@ SPA_MEDIA_SUBTYPE_mjpg
Definition format.h:68
SPA_MEDIA_SUBTYPE_vp8
@ SPA_MEDIA_SUBTYPE_vp8
Definition format.h:77
SPA_MEDIA_SUBTYPE_START_Image
@ SPA_MEDIA_SUBTYPE_START_Image
Definition format.h:82
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition format.h:39
SPA_MEDIA_SUBTYPE_START_Audio
@ SPA_MEDIA_SUBTYPE_START_Audio
Definition format.h:43
SPA_MEDIA_SUBTYPE_vorbis
@ SPA_MEDIA_SUBTYPE_vorbis
Definition format.h:46
SPA_MEDIA_SUBTYPE_dv
@ SPA_MEDIA_SUBTYPE_dv
Definition format.h:69
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition format.h:38
SPA_MEDIA_SUBTYPE_mpegts
@ SPA_MEDIA_SUBTYPE_mpegts
Definition format.h:70
SPA_MEDIA_SUBTYPE_mpeg1
@ SPA_MEDIA_SUBTYPE_mpeg1
Definition format.h:72
SPA_MEDIA_SUBTYPE_vc1
@ SPA_MEDIA_SUBTYPE_vc1
Definition format.h:76
SPA_MEDIA_SUBTYPE_dts
@ SPA_MEDIA_SUBTYPE_dts
since 1.5.1
Definition format.h:63
SPA_MEDIA_SUBTYPE_eac3
@ SPA_MEDIA_SUBTYPE_eac3
since 1.5.1
Definition format.h:61
SPA_MEDIA_SUBTYPE_START_Stream
@ SPA_MEDIA_SUBTYPE_START_Stream
Definition format.h:87
SPA_MEDIA_SUBTYPE_mpegh
@ SPA_MEDIA_SUBTYPE_mpegh
since 1.5.1
Definition format.h:64
SPA_MEDIA_SUBTYPE_jpeg
@ SPA_MEDIA_SUBTYPE_jpeg
Definition format.h:83
SPA_MEDIA_SUBTYPE_xvid
@ SPA_MEDIA_SUBTYPE_xvid
Definition format.h:75
SPA_MEDIA_SUBTYPE_dsd
@ SPA_MEDIA_SUBTYPE_dsd
S/PDIF.
Definition format.h:41
SPA_MEDIA_SUBTYPE_adpcm
@ SPA_MEDIA_SUBTYPE_adpcm
Definition format.h:50
SPA_MEDIA_SUBTYPE_bayer
@ SPA_MEDIA_SUBTYPE_bayer
Definition format.h:79
SPA_MEDIA_SUBTYPE_g723
@ SPA_MEDIA_SUBTYPE_g723
Definition format.h:51
SPA_MEDIA_SUBTYPE_control
@ SPA_MEDIA_SUBTYPE_control
control stream, data contains spa_pod_sequence with control info.
Definition format.h:91
SPA_MEDIA_SUBTYPE_gsm
@ SPA_MEDIA_SUBTYPE_gsm
Definition format.h:55
SPA_MEDIA_SUBTYPE_opus
@ SPA_MEDIA_SUBTYPE_opus
since 0.3.65
Definition format.h:59
SPA_MEDIA_SUBTYPE_START_Application
@ SPA_MEDIA_SUBTYPE_START_Application
Definition format.h:90
SPA_MEDIA_SUBTYPE_g729
@ SPA_MEDIA_SUBTYPE_g729
Definition format.h:53
SPA_MEDIA_SUBTYPE_vp9
@ SPA_MEDIA_SUBTYPE_vp9
Definition format.h:78
SPA_MEDIA_SUBTYPE_flac
@ SPA_MEDIA_SUBTYPE_flac
since 0.3.65
Definition format.h:57
param.h
spa/param/param.h