PipeWire  0.3.47
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_AUDIO_RAW_H
26 #define SPA_AUDIO_RAW_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <stdint.h>
33 
34 #ifndef __FreeBSD__
35 #include <endian.h>
36 #endif
37 
43 #define SPA_AUDIO_MAX_CHANNELS 64u
44 
45 enum spa_audio_format {
48 
49  /* interleaved formats */
81 
84 
85  /* planar formats */
95 
96  /* other formats start here */
98 
99  /* Aliases */
101  /* DSP formats */
105 
106  /* native endian */
107 #if __BYTE_ORDER == __BIG_ENDIAN
136 #elif __BYTE_ORDER == __LITTLE_ENDIAN
165 #endif
166 };
167 
168 #define SPA_AUDIO_FORMAT_IS_INTERLEAVED(fmt) ((fmt) > SPA_AUDIO_FORMAT_START_Interleaved && (fmt) < SPA_AUDIO_FORMAT_START_Planar)
169 #define SPA_AUDIO_FORMAT_IS_PLANAR(fmt) ((fmt) > SPA_AUDIO_FORMAT_START_Planar && (fmt) < SPA_AUDIO_FORMAT_START_Other)
170 
171 enum spa_audio_channel {
282 };
285 #define SPA_AUDIO_FLAG_NONE (0) /*< no valid flag */
286 #define SPA_AUDIO_FLAG_UNPOSITIONED (1 << 0) /*< the position array explicitly
287  * contains unpositioned channels. */
288 
290  enum spa_audio_format format; /*< format, one of enum spa_audio_format */
291  uint32_t flags; /*< extra flags */
292  uint32_t rate; /*< sample rate */
293  uint32_t channels; /*< number of channels */
294  uint32_t position[SPA_AUDIO_MAX_CHANNELS]; /*< channel position from enum spa_audio_channel */
295 };
297 #define SPA_AUDIO_INFO_RAW_INIT(...) (struct spa_audio_info_raw) { __VA_ARGS__ }
298 
299 #define SPA_KEY_AUDIO_FORMAT "audio.format"
301 #define SPA_KEY_AUDIO_CHANNEL "audio.channel"
303 #define SPA_KEY_AUDIO_CHANNELS "audio.channels"
304 #define SPA_KEY_AUDIO_RATE "audio.rate"
305 #define SPA_KEY_AUDIO_POSITION "audio.position"
307 #define SPA_KEY_AUDIO_ALLOWED_RATES "audio.allowed-rates"
310 struct spa_audio_info_dsp {
311  enum spa_audio_format format; /*< format, one of the DSP formats in enum spa_audio_format_dsp */
312 };
313 
314 #define SPA_AUDIO_INFO_DSP_INIT(...) (struct spa_audio_info_dsp) { __VA_ARGS__ }
320 #ifdef __cplusplus
321 } /* extern "C" */
322 #endif
324 #endif /* SPA_AUDIO_RAW_H */
Definition: raw.h:98
front left wide
Definition: raw.h:205
top front right
Definition: raw.h:199
Definition: raw.h:73
Definition: raw.h:279
front left high
Definition: raw.h:208
top rear left
Definition: raw.h:200
Definition: raw.h:257
Definition: raw.h:235
Definition: raw.h:135
Definition: raw.h:269
Definition: raw.h:124
Definition: raw.h:134
Definition: raw.h:81
Definition: raw.h:222
bottom center
Definition: raw.h:217
Definition: raw.h:282
Definition: raw.h:108
top front center
Definition: raw.h:198
top front left
Definition: raw.h:197
Definition: raw.h:80
Definition: raw.h:259
top center
Definition: raw.h:196
Definition: raw.h:123
Definition: raw.h:100
Audio information description.
Definition: raw.h:299
Definition: raw.h:141
Definition: raw.h:251
spa_audio_format
Definition: raw.h:51
Definition: raw.h:96
Definition: raw.h:138
uint32_t rate
Definition: raw.h:302
Definition: raw.h:246
Definition: raw.h:60
Definition: raw.h:260
top front right center
Definition: raw.h:212
Definition: raw.h:227
Definition: raw.h:226
enum spa_audio_format format
Definition: raw.h:300
front center high
Definition: raw.h:209
front right wide
Definition: raw.h:206
Definition: raw.h:275
Definition: raw.h:89
Definition: raw.h:270
Definition: raw.h:139
Definition: raw.h:68
Definition: raw.h:258
Definition: raw.h:69
Definition: raw.h:109
Definition: raw.h:103
Definition: raw.h:234
rear right
Definition: raw.h:195
mono stream
Definition: raw.h:183
Definition: raw.h:74
Definition: raw.h:239
LFE.
Definition: raw.h:188
Definition: raw.h:86
N/A, silent.
Definition: raw.h:181
left LFE
Definition: raw.h:215
Definition: raw.h:58
Definition: raw.h:64
Definition: raw.h:136
Definition: raw.h:249
Definition: raw.h:240
Definition: raw.h:242
Definition: raw.h:253
Definition: raw.h:262
#define SPA_AUDIO_MAX_CHANNELS
Definition: raw.h:49
Definition: raw.h:88
Definition: raw.h:232
Definition: raw.h:277
Definition: raw.h:53
Definition: raw.h:266
Definition: raw.h:83
Definition: raw.h:283
aux channels
Definition: raw.h:287
Definition: raw.h:115
spa_audio_channel
Definition: raw.h:179
uint32_t flags
Definition: raw.h:301
Definition: raw.h:130
Definition: raw.h:263
Definition: raw.h:66
Definition: raw.h:223
Definition: raw.h:133
Definition: raw.h:117
Definition: raw.h:120
Definition: raw.h:278
Definition: raw.h:72
top side left
Definition: raw.h:213
Definition: raw.h:67
rear right center
Definition: raw.h:204
Definition: raw.h:76
Definition: raw.h:238
Definition: raw.h:84
front left center
Definition: raw.h:191
Definition: raw.h:99
bottom left center
Definition: raw.h:218
Definition: raw.h:114
Definition: raw.h:62
Definition: raw.h:276
Definition: raw.h:250
Definition: raw.h:228
Definition: raw.h:264
Definition: raw.h:224
Definition: raw.h:61
Definition: raw.h:254
Definition: raw.h:116
Definition: raw.h:125
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: raw.h:304
Definition: raw.h:77
Definition: raw.h:52
rear left center
Definition: raw.h:203
Definition: raw.h:97
Definition: raw.h:85
Definition: raw.h:127
Definition: raw.h:92
Definition: raw.h:110
Definition: raw.h:230
LFE 2.
Definition: raw.h:207
rear center
Definition: raw.h:193
Definition: raw.h:272
top rear center
Definition: raw.h:201
front left
Definition: raw.h:185
Definition: raw.h:241
Definition: raw.h:126
Definition: raw.h:274
bottom right center
Definition: raw.h:219
Definition: raw.h:131
Definition: raw.h:289
Definition: raw.h:63
Definition: raw.h:57
Definition: raw.h:256
top side right
Definition: raw.h:214
Definition: raw.h:140
side right
Definition: raw.h:190
Definition: raw.h:285
Definition: raw.h:132
Definition: raw.h:229
unspecified
Definition: raw.h:180
Definition: raw.h:119
front right high
Definition: raw.h:210
front right center
Definition: raw.h:192
aux channels
Definition: raw.h:221
Definition: raw.h:70
rear left
Definition: raw.h:194
Definition: raw.h:284
Definition: raw.h:281
Definition: raw.h:65
Definition: raw.h:237
Definition: raw.h:233
Definition: raw.h:236
Definition: raw.h:231
Definition: raw.h:271
Definition: raw.h:244
Definition: raw.h:71
Definition: raw.h:268
Definition: raw.h:137
Definition: raw.h:243
Definition: raw.h:225
Definition: raw.h:128
Definition: raw.h:79
Definition: raw.h:75
Definition: raw.h:255
top front left center
Definition: raw.h:211
front center
Definition: raw.h:187
Definition: raw.h:265
front right
Definition: raw.h:186
Definition: raw.h:95
Definition: raw.h:129
Definition: raw.h:245
Definition: raw.h:261
top rear right
Definition: raw.h:202
Definition: raw.h:78
Definition: raw.h:122
Definition: raw.h:118
Definition: raw.h:247
Definition: raw.h:121
right LFE
Definition: raw.h:216
side left
Definition: raw.h:189
Definition: raw.h:94
Definition: raw.h:252
Definition: raw.h:93
Definition: raw.h:273
Definition: raw.h:267
uint32_t channels
Definition: raw.h:303
Definition: raw.h:82
Definition: raw.h:59
Definition: raw.h:280
Definition: raw.h:248