PipeWire 0.3.38
audio/format-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_PARAM_AUDIO_FORMAT_UTILS_H
26#define SPA_PARAM_AUDIO_FORMAT_UTILS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/pod/parser.h>
38#include <spa/pod/builder.h>
41
42/* static */ inline int
43spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
44{
45 struct spa_pod *position = NULL;
46 int res;
47 info->flags = 0;
48 res = spa_pod_parse_object(format,
54 if (position == NULL ||
57
58 return res;
59}
60
61/* static */ inline int
62spa_format_audio_dsp_parse(const struct spa_pod *format, struct spa_audio_info_dsp *info)
63{
64 int res;
65 res = spa_pod_parse_object(format,
68 return res;
69}
70
71/* static */ inline int
73{
74 int res;
75 res = spa_pod_parse_object(format,
79 return res;
80}
81
82/* static */ inline int
83spa_format_audio_dsd_parse(const struct spa_pod *format, struct spa_audio_info_dsd *info)
84{
85 struct spa_pod *position = NULL;
86 int res;
87 info->flags = 0;
88 res = spa_pod_parse_object(format,
95 if (position == NULL ||
98
99 return res;
100}
101
102/* static */ inline struct spa_pod *
103spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_raw *info)
104{
105 struct spa_pod_frame f;
107 spa_pod_builder_add(builder,
110 0);
111 if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
112 spa_pod_builder_add(builder,
114 if (info->rate != 0)
115 spa_pod_builder_add(builder,
117 if (info->channels != 0) {
118 spa_pod_builder_add(builder,
122 SPA_POD_Array(sizeof(uint32_t), SPA_TYPE_Id,
123 info->channels, info->position), 0);
124 }
125 }
126 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
127}
128
129/* static */ inline struct spa_pod *
130spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsp *info)
131{
132 struct spa_pod_frame f;
134 spa_pod_builder_add(builder,
137 0);
138 if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
139 spa_pod_builder_add(builder,
141 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
142}
143
144
145/* static */ inline struct spa_pod *
146spa_format_audio_iec958_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_iec958 *info)
147{
148 struct spa_pod_frame f;
150 spa_pod_builder_add(builder,
153 0);
155 spa_pod_builder_add(builder,
157 if (info->rate != 0)
158 spa_pod_builder_add(builder,
160 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
161}
162
163/* static */ inline struct spa_pod *
164spa_format_audio_dsd_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsd *info)
165{
166 struct spa_pod_frame f;
168 spa_pod_builder_add(builder,
171 0);
173 spa_pod_builder_add(builder,
175 if (info->interleave != 0)
176 spa_pod_builder_add(builder,
178 if (info->rate != 0)
179 spa_pod_builder_add(builder,
181 if (info->channels != 0) {
182 spa_pod_builder_add(builder,
186 SPA_POD_Array(sizeof(uint32_t), SPA_TYPE_Id,
187 info->channels, info->position), 0);
188 }
189 }
190 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
191}
192
197#ifdef __cplusplus
198} /* extern "C" */
199#endif
200
201#endif /* SPA_PARAM_AUDIO_FORMAT_UTILS_H */
struct spa_pod * spa_format_audio_iec958_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_iec958 *info)
Definition: audio/format-utils.h:146
#define SPA_AUDIO_FLAG_UNPOSITIONED
Definition: audio/raw.h:286
struct spa_pod * spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsp *info)
Definition: audio/format-utils.h:130
struct spa_pod * spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_raw *info)
Definition: audio/format-utils.h:103
int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition: audio/format-utils.h:43
int spa_format_audio_dsd_parse(const struct spa_pod *format, struct spa_audio_info_dsd *info)
Definition: audio/format-utils.h:83
int spa_format_audio_dsp_parse(const struct spa_pod *format, struct spa_audio_info_dsp *info)
Definition: audio/format-utils.h:62
struct spa_pod * spa_format_audio_dsd_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsd *info)
Definition: audio/format-utils.h:164
int spa_format_audio_iec958_parse(const struct spa_pod *format, struct spa_audio_info_iec958 *info)
Definition: audio/format-utils.h:72
#define SPA_AUDIO_MAX_CHANNELS
Definition: audio/raw.h:43
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition: param.h:198
@ SPA_MEDIA_TYPE_audio
Definition: param/format.h:42
@ SPA_AUDIO_IEC958_CODEC_UNKNOWN
Definition: iec958.h:39
@ SPA_FORMAT_AUDIO_iec958Codec
codec used (IEC958) (Id enum spa_audio_iec958_codec)
Definition: param/format.h:115
@ SPA_FORMAT_AUDIO_interleave
Interleave bytes (Int)
Definition: param/format.h:118
@ SPA_FORMAT_AUDIO_bitorder
bit order (Id enum spa_param_bitorder)
Definition: param/format.h:117
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: param/format.h:104
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition: param/format.h:113
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition: param/format.h:111
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:105
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition: param/format.h:109
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition: param/format.h:112
@ SPA_MEDIA_SUBTYPE_iec958
Definition: param/format.h:55
@ SPA_MEDIA_SUBTYPE_dsp
Definition: param/format.h:54
@ SPA_MEDIA_SUBTYPE_raw
Definition: param/format.h:53
@ SPA_MEDIA_SUBTYPE_dsd
S/PDIF.
Definition: param/format.h:56
@ SPA_AUDIO_FORMAT_UNKNOWN
Definition: audio/raw.h:46
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:426
#define SPA_POD_Array(csize, ctype, n_vals, vals)
Definition: vararg.h:96
int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:638
void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:175
#define SPA_POD_Id(val)
Definition: vararg.h:56
uint32_t spa_pod_copy_array(const struct spa_pod *pod, uint32_t type, void *values, uint32_t max_values)
Definition: iter.h:344
#define SPA_POD_OPT_Pod(val)
Definition: parser.h:533
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
#define SPA_POD_Int(val)
Definition: vararg.h:59
@ SPA_TYPE_Id
Definition: x86_64-openEuler-linux-gnu/doc/spa/utils/type.h:47
@ SPA_TYPE_OBJECT_Format
Definition: x86_64-openEuler-linux-gnu/doc/spa/utils/type.h:90
#define SPA_FLAG_SET(field, flag)
Definition: defs.h:74
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:73
Definition: dsd.h:62
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: dsd.h:68
uint32_t channels
Definition: dsd.h:67
enum spa_param_bitorder bitorder
Definition: dsd.h:63
uint32_t rate
Definition: dsd.h:66
int32_t interleave
Definition: dsd.h:65
uint32_t flags
Definition: dsd.h:64
Definition: audio/raw.h:307
enum spa_audio_format format
Definition: audio/raw.h:308
Definition: iec958.h:53
enum spa_audio_iec958_codec codec
Definition: iec958.h:54
uint32_t rate
Definition: iec958.h:56
Audio information description.
Definition: audio/raw.h:288
enum spa_audio_format format
Definition: audio/raw.h:289
uint32_t channels
Definition: audio/raw.h:292
uint32_t flags
Definition: audio/raw.h:290
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: audio/raw.h:293
uint32_t rate
Definition: audio/raw.h:291
Definition: builder.h:63
Definition: iter.h:42
Definition: pod/pod.h:50