PipeWire  1.2.5
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 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
17 #include <spa/param/param.h>
18 
20 enum spa_media_type {
28 };
29 
37 
70 
73 
75 
78 
82 };
83 
85 enum spa_format {
87 
91  /* Audio format keys */
92  SPA_FORMAT_START_Audio = 0x10000,
113  /* Video Format keys */
114  SPA_FORMAT_START_Video = 0x20000,
136  /* Image Format keys */
138  /* Binary Format keys */
140  /* Stream Format keys */
141  SPA_FORMAT_START_Stream = 0x50000,
142  /* Application Format keys */
144 };
145 
146 #define SPA_KEY_FORMAT_DSP "format.dsp"
153 #ifdef __cplusplus
154 } /* extern "C" */
155 #endif
156 
157 #endif /* SPA_PARAM_FORMAT_H */
SPA_MEDIA_TYPE_image
@ SPA_MEDIA_TYPE_image
Definition: format.h:29
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition: format.h:39
spa_media_type
spa_media_type
media type for SPA_TYPE_OBJECT_Format
Definition: format.h:25
SPA_FORMAT_START
@ SPA_FORMAT_START
Definition: format.h:91
SPA_MEDIA_SUBTYPE_vc1
@ SPA_MEDIA_SUBTYPE_vc1
Definition: format.h:71
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:93
SPA_FORMAT_AUDIO_flags
@ SPA_FORMAT_AUDIO_flags
optional flags (Int)
Definition: format.h:99
SPA_MEDIA_SUBTYPE_adpcm
@ SPA_MEDIA_SUBTYPE_adpcm
Definition: format.h:50
SPA_MEDIA_SUBTYPE_g723
@ SPA_MEDIA_SUBTYPE_g723
Definition: format.h:51
SPA_MEDIA_SUBTYPE_sbc
@ SPA_MEDIA_SUBTYPE_sbc
Definition: format.h:49
SPA_FORMAT_AUDIO_iec958Codec
@ SPA_FORMAT_AUDIO_iec958Codec
codec used (IEC958) (Id enum spa_audio_iec958_codec)
Definition: format.h:104
SPA_MEDIA_SUBTYPE_iec958
@ SPA_MEDIA_SUBTYPE_iec958
Definition: format.h:40
SPA_MEDIA_SUBTYPE_ape
@ SPA_MEDIA_SUBTYPE_ape
since 0.3.65
Definition: format.h:58
SPA_FORMAT_AUDIO_interleave
@ SPA_FORMAT_AUDIO_interleave
Interleave bytes (Int)
Definition: format.h:107
SPA_MEDIA_SUBTYPE_g726
@ SPA_MEDIA_SUBTYPE_g726
Definition: format.h:52
SPA_MEDIA_TYPE_unknown
@ SPA_MEDIA_TYPE_unknown
Definition: format.h:26
SPA_MEDIA_SUBTYPE_vp9
@ SPA_MEDIA_SUBTYPE_vp9
Definition: format.h:73
SPA_FORMAT_START_Image
@ SPA_FORMAT_START_Image
Definition: format.h:142
SPA_FORMAT_VIDEO_interlaceMode
@ SPA_FORMAT_VIDEO_interlaceMode
(Id enum spa_video_interlace_mode)
Definition: format.h:127
SPA_MEDIA_SUBTYPE_jpeg
@ SPA_MEDIA_SUBTYPE_jpeg
Definition: format.h:77
SPA_FORMAT_AUDIO_bitorder
@ SPA_FORMAT_AUDIO_bitorder
bit order (Id enum spa_param_bitorder)
Definition: format.h:106
SPA_MEDIA_SUBTYPE_opus
@ SPA_MEDIA_SUBTYPE_opus
since 0.3.65
Definition: format.h:59
SPA_MEDIA_SUBTYPE_START_Stream
@ SPA_MEDIA_SUBTYPE_START_Stream
Definition: format.h:81
SPA_FORMAT_VIDEO_colorMatrix
@ SPA_FORMAT_VIDEO_colorMatrix
/Id enum spa_video_color_matrix)
Definition: format.h:133
SPA_MEDIA_SUBTYPE_h263
@ SPA_MEDIA_SUBTYPE_h263
Definition: format.h:66
SPA_FORMAT_VIDEO_size
@ SPA_FORMAT_VIDEO_size
size (Rectangle)
Definition: format.h:123
SPA_MEDIA_TYPE_audio
@ SPA_MEDIA_TYPE_audio
Definition: format.h:27
SPA_FORMAT_VIDEO_colorRange
@ SPA_FORMAT_VIDEO_colorRange
/Id enum spa_video_color_range)
Definition: format.h:132
SPA_FORMAT_START_Binary
@ SPA_FORMAT_START_Binary
Definition: format.h:144
spa_media_subtype
spa_media_subtype
media subtype for SPA_TYPE_OBJECT_Format
Definition: format.h:36
SPA_MEDIA_TYPE_stream
@ SPA_MEDIA_TYPE_stream
Definition: format.h:31
SPA_FORMAT_VIDEO_transferFunction
@ SPA_FORMAT_VIDEO_transferFunction
/Id enum spa_video_transfer_function)
Definition: format.h:134
SPA_MEDIA_SUBTYPE_mp3
@ SPA_MEDIA_SUBTYPE_mp3
Definition: format.h:44
SPA_FORMAT_VIDEO_views
@ SPA_FORMAT_VIDEO_views
number of views (Int)
Definition: format.h:126
SPA_FORMAT_VIDEO_profile
@ SPA_FORMAT_VIDEO_profile
(Int)
Definition: format.h:136
SPA_MEDIA_SUBTYPE_START_Application
@ SPA_MEDIA_SUBTYPE_START_Application
Definition: format.h:84
SPA_FORMAT_AUDIO_AMR_bandMode
@ SPA_FORMAT_AUDIO_AMR_bandMode
AMR band mode (Id enum spa_audio_amr_band_mode)
Definition: format.h:115
SPA_FORMAT_AUDIO_AAC_streamFormat
@ SPA_FORMAT_AUDIO_AAC_streamFormat
AAC stream format, (Id enum spa_audio_aac_stream_format)
Definition: format.h:111
SPA_MEDIA_TYPE_binary
@ SPA_MEDIA_TYPE_binary
Definition: format.h:30
SPA_MEDIA_TYPE_application
@ SPA_MEDIA_TYPE_application
Definition: format.h:32
SPA_MEDIA_SUBTYPE_vorbis
@ SPA_MEDIA_SUBTYPE_vorbis
Definition: format.h:46
SPA_FORMAT_VIDEO_level
@ SPA_FORMAT_VIDEO_level
(Int)
Definition: format.h:137
SPA_FORMAT_START_Stream
@ SPA_FORMAT_START_Stream
Definition: format.h:146
SPA_MEDIA_SUBTYPE_wma
@ SPA_MEDIA_SUBTYPE_wma
Definition: format.h:47
SPA_MEDIA_SUBTYPE_mpeg4
@ SPA_MEDIA_SUBTYPE_mpeg4
Definition: format.h:69
param.h
spa/param/param.h
SPA_FORMAT_AUDIO_blockAlign
@ SPA_FORMAT_AUDIO_blockAlign
audio data block alignment (Int)
Definition: format.h:109
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition: format.h:100
SPA_FORMAT_START_Video
@ SPA_FORMAT_START_Video
Definition: format.h:119
SPA_MEDIA_TYPE_video
@ SPA_MEDIA_TYPE_video
Definition: format.h:28
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:94
SPA_MEDIA_SUBTYPE_midi
@ SPA_MEDIA_SUBTYPE_midi
Definition: format.h:82
SPA_MEDIA_SUBTYPE_vp8
@ SPA_MEDIA_SUBTYPE_vp8
Definition: format.h:72
SPA_FORMAT_VIDEO_framerate
@ SPA_FORMAT_VIDEO_framerate
frame rate (Fraction)
Definition: format.h:124
SPA_MEDIA_SUBTYPE_amr
@ SPA_MEDIA_SUBTYPE_amr
Definition: format.h:54
SPA_FORMAT_VIDEO_H264_alignment
@ SPA_FORMAT_VIDEO_H264_alignment
(Id enum spa_h264_alignment)
Definition: format.h:139
SPA_MEDIA_SUBTYPE_START_Binary
@ SPA_MEDIA_SUBTYPE_START_Binary
Definition: format.h:79
SPA_FORMAT_START_Application
@ SPA_FORMAT_START_Application
Definition: format.h:148
SPA_FORMAT_VIDEO_format
@ SPA_FORMAT_VIDEO_format
video format (Id enum spa_video_format)
Definition: format.h:120
SPA_FORMAT_VIDEO_H264_streamFormat
@ SPA_FORMAT_VIDEO_H264_streamFormat
(Id enum spa_h264_stream_format)
Definition: format.h:138
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_MEDIA_SUBTYPE_unknown
@ SPA_MEDIA_SUBTYPE_unknown
Definition: format.h:37
SPA_FORMAT_START_Audio
@ SPA_FORMAT_START_Audio
Definition: format.h:97
SPA_MEDIA_SUBTYPE_gsm
@ SPA_MEDIA_SUBTYPE_gsm
Definition: format.h:55
SPA_MEDIA_SUBTYPE_flac
@ SPA_MEDIA_SUBTYPE_flac
since 0.3.65
Definition: format.h:57
SPA_FORMAT_VIDEO_colorPrimaries
@ SPA_FORMAT_VIDEO_colorPrimaries
/Id enum spa_video_color_primaries)
Definition: format.h:135
SPA_MEDIA_SUBTYPE_mpeg1
@ SPA_MEDIA_SUBTYPE_mpeg1
Definition: format.h:67
SPA_MEDIA_SUBTYPE_control
@ SPA_MEDIA_SUBTYPE_control
control stream, data contains spa_pod_sequence with control info.
Definition: format.h:85
SPA_MEDIA_SUBTYPE_START_Video
@ SPA_MEDIA_SUBTYPE_START_Video
since 0.3.68
Definition: format.h:61
SPA_MEDIA_SUBTYPE_dv
@ SPA_MEDIA_SUBTYPE_dv
Definition: format.h:64
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition: format.h:101
SPA_MEDIA_SUBTYPE_alac
@ SPA_MEDIA_SUBTYPE_alac
Definition: format.h:56
SPA_MEDIA_SUBTYPE_START_Audio
@ SPA_MEDIA_SUBTYPE_START_Audio
Definition: format.h:43
SPA_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition: format.h:98
SPA_FORMAT_VIDEO_maxFramerate
@ SPA_FORMAT_VIDEO_maxFramerate
maximum frame rate (Fraction)
Definition: format.h:125
SPA_FORMAT_VIDEO_chromaSite
@ SPA_FORMAT_VIDEO_chromaSite
/Id enum spa_video_chroma_site)
Definition: format.h:131
SPA_FORMAT_AUDIO_position
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition: format.h:102
SPA_MEDIA_SUBTYPE_ra
@ SPA_MEDIA_SUBTYPE_ra
Definition: format.h:48
SPA_MEDIA_SUBTYPE_mjpg
@ SPA_MEDIA_SUBTYPE_mjpg
Definition: format.h:63
SPA_FORMAT_VIDEO_pixelAspectRatio
@ SPA_FORMAT_VIDEO_pixelAspectRatio
(Rectangle)
Definition: format.h:128
SPA_MEDIA_SUBTYPE_mpeg2
@ SPA_MEDIA_SUBTYPE_mpeg2
Definition: format.h:68
SPA_MEDIA_SUBTYPE_g729
@ SPA_MEDIA_SUBTYPE_g729
Definition: format.h:53
SPA_MEDIA_SUBTYPE_bayer
@ SPA_MEDIA_SUBTYPE_bayer
Definition: format.h:74
SPA_MEDIA_SUBTYPE_mpegts
@ SPA_MEDIA_SUBTYPE_mpegts
Definition: format.h:65
SPA_FORMAT_AUDIO_bitrate
@ SPA_FORMAT_AUDIO_bitrate
bit rate (Int)
Definition: format.h:108
SPA_FORMAT_VIDEO_multiviewMode
@ SPA_FORMAT_VIDEO_multiviewMode
(Id enum spa_video_multiview_mode)
Definition: format.h:129
SPA_MEDIA_SUBTYPE_dsd
@ SPA_MEDIA_SUBTYPE_dsd
S/PDIF.
Definition: format.h:41
SPA_FORMAT_AUDIO_WMA_profile
@ SPA_FORMAT_AUDIO_WMA_profile
WMA profile (Id enum spa_audio_wma_profile)
Definition: format.h:113
SPA_MEDIA_SUBTYPE_xvid
@ SPA_MEDIA_SUBTYPE_xvid
Definition: format.h:70
SPA_MEDIA_SUBTYPE_aac
@ SPA_MEDIA_SUBTYPE_aac
Definition: format.h:45
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:38
spa_format
spa_format
properties for audio SPA_TYPE_OBJECT_Format
Definition: format.h:90
SPA_MEDIA_SUBTYPE_START_Image
@ SPA_MEDIA_SUBTYPE_START_Image
Definition: format.h:76
SPA_FORMAT_VIDEO_multiviewFlags
@ SPA_FORMAT_VIDEO_multiviewFlags
(Id enum spa_video_multiview_flags)
Definition: format.h:130
SPA_MEDIA_SUBTYPE_h264
@ SPA_MEDIA_SUBTYPE_h264
Definition: format.h:62