PipeWire: format-utils.h Source File

PipeWire 0.3.34

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
29 extern "C" {
30 #endif
31
37 #include <spa/pod/parser.h>
38 #include <spa/pod/builder.h>
39 #include <spa/param/audio/format.h>
40 #include <spa/param/format-utils.h>
41
42 /* static */ inline int
43 spa_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,
49 SPA_TYPE_OBJECT_Format, NULL,
50 SPA_FORMAT_AUDIO_format, SPA_POD_Id(&info->format),
51 SPA_FORMAT_AUDIO_rate, SPA_POD_Int(&info->rate),
52 SPA_FORMAT_AUDIO_channels, SPA_POD_Int(&info->channels),
53 SPA_FORMAT_AUDIO_position, SPA_POD_OPT_Pod(&position));
54 if (position == NULL ||
55 !spa_pod_copy_array(position, SPA_TYPE_Id, info->position, SPA_AUDIO_MAX_CHANNELS))
56 SPA_FLAG_SET(info->flags, SPA_AUDIO_FLAG_UNPOSITIONED);
57
58 return res;
59 }
60
61 /* static */ inline int
62 spa_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,
66 SPA_TYPE_OBJECT_Format, NULL,
67 SPA_FORMAT_AUDIO_format, SPA_POD_Id(&info->format));
68 return res;
69 }
70
71 /* static */ inline int
72 spa_format_audio_iec958_parse(const struct spa_pod *format, struct spa_audio_info_iec958 *info)
73 {
74 int res;
75 res = spa_pod_parse_object(format,
76 SPA_TYPE_OBJECT_Format, NULL,
77 SPA_FORMAT_AUDIO_iec958Codec, SPA_POD_Id(&info->codec),
78 SPA_FORMAT_AUDIO_rate, SPA_POD_Int(&info->rate));
79 return res;
80 }
81
82 /* static */ inline struct spa_pod *
83 spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_raw *info)
84 {
85 struct spa_pod_frame f;
86 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
87 spa_pod_builder_add(builder,
88 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_audio),
89 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw),
90 0);
91 if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
92 spa_pod_builder_add(builder,
93 SPA_FORMAT_AUDIO_format, SPA_POD_Id(info->format), 0);
94 if (info->rate != 0)
95 spa_pod_builder_add(builder,
96 SPA_FORMAT_AUDIO_rate, SPA_POD_Int(info->rate), 0);
97 if (info->channels != 0) {
98 spa_pod_builder_add(builder,
99 SPA_FORMAT_AUDIO_channels, SPA_POD_Int(info->channels), 0);
100 if (!SPA_FLAG_IS_SET(info->flags, SPA_AUDIO_FLAG_UNPOSITIONED)) {
101 spa_pod_builder_add(builder, SPA_FORMAT_AUDIO_position,
102 SPA_POD_Array(sizeof(uint32_t), SPA_TYPE_Id,
103 info->channels, info->position), 0);
104 }
105 }
106 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
107 }
108
109 /* static */ inline struct spa_pod *
110 spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsp *info)
111 {
112 struct spa_pod_frame f;
113 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
114 spa_pod_builder_add(builder,
115 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_audio),
116 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_dsp),
117 0);
118 if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
119 spa_pod_builder_add(builder,
120 SPA_FORMAT_AUDIO_format, SPA_POD_Id(info->format), 0);
121 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
122 }
123
124
125 /* static */ inline struct spa_pod *
126 spa_format_audio_iec958_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_iec958 *info)
127 {
128 struct spa_pod_frame f;
129 spa_pod_builder_push_object(builder, &f, SPA_TYPE_OBJECT_Format, id);
130 spa_pod_builder_add(builder,
131 SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_audio),
132 SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_iec958),
133 0);
134 if (info->codec != SPA_AUDIO_IEC958_CODEC_UNKNOWN)
135 spa_pod_builder_add(builder,
136 SPA_FORMAT_AUDIO_iec958Codec, SPA_POD_Id(info->codec), 0);
137 if (info->rate != 0)
138 spa_pod_builder_add(builder,
139 SPA_FORMAT_AUDIO_rate, SPA_POD_Int(info->rate), 0);
140 return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
141 }
146 #ifdef __cplusplus
147 } /* extern "C" */
148 #endif
149
150 #endif /* SPA_PARAM_AUDIO_FORMAT_UTILS_H */
builder.h
format-utils.h
spa_format_audio_dsp_build
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:110
SPA_AUDIO_FLAG_UNPOSITIONED
#define SPA_AUDIO_FLAG_UNPOSITIONED
Definition: audio/raw.h:286
spa_format_audio_raw_parse
int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition: audio/format-utils.h:43
spa_format_audio_dsp_parse
int spa_format_audio_dsp_parse(const struct spa_pod *format, struct spa_audio_info_dsp *info)
Definition: audio/format-utils.h:62
spa_format_audio_iec958_parse
int spa_format_audio_iec958_parse(const struct spa_pod *format, struct spa_audio_info_iec958 *info)
Definition: audio/format-utils.h:72
spa_format_audio_iec958_build
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:126
SPA_AUDIO_MAX_CHANNELS
#define SPA_AUDIO_MAX_CHANNELS
Definition: audio/raw.h:43
spa_format_audio_raw_build
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:83
SPA_MEDIA_TYPE_audio
@ SPA_MEDIA_TYPE_audio
Definition: param/format.h:42
SPA_AUDIO_IEC958_CODEC_UNKNOWN
@ SPA_AUDIO_IEC958_CODEC_UNKNOWN
Definition: iec958.h:39
SPA_FORMAT_AUDIO_iec958Codec
@ SPA_FORMAT_AUDIO_iec958Codec
codec used (IEC958) (Id enum spa_audio_iec958_codec)
Definition: param/format.h:114
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: param/format.h:103
SPA_FORMAT_AUDIO_position
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition: param/format.h:112
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition: param/format.h:110
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:104
SPA_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition: param/format.h:108
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition: param/format.h:111
SPA_MEDIA_SUBTYPE_iec958
@ SPA_MEDIA_SUBTYPE_iec958
Definition: param/format.h:55
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition: param/format.h:54
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: param/format.h:53
SPA_AUDIO_FORMAT_UNKNOWN
@ SPA_AUDIO_FORMAT_UNKNOWN
Definition: audio/raw.h:46
spa_pod_builder_push_object
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
SPA_POD_Array
#define SPA_POD_Array(csize, ctype, n_vals, vals)
Definition: vararg.h:96
spa_pod_builder_add
int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:638
spa_pod_builder_pop
void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:175
SPA_POD_Id
#define SPA_POD_Id(val)
Definition: vararg.h:56
spa_pod_copy_array
uint32_t spa_pod_copy_array(const struct spa_pod *pod, uint32_t type, void *values, uint32_t max_values)
Definition: iter.h:344
SPA_POD_OPT_Pod
#define SPA_POD_OPT_Pod(val)
Definition: parser.h:533
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
SPA_POD_Int
#define SPA_POD_Int(val)
Definition: vararg.h:59
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition: build/doc/spa/utils/type.h:47
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition: build/doc/spa/utils/type.h:90
SPA_FLAG_SET
#define SPA_FLAG_SET(field, flag)
Definition: defs.h:74
SPA_FLAG_IS_SET
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:73
format.h
parser.h
spa_audio_info_dsp
Definition: audio/raw.h:307
spa_audio_info_dsp::format
enum spa_audio_format format
Definition: audio/raw.h:308
spa_audio_info_iec958
Definition: iec958.h:53
spa_audio_info_iec958::codec
enum spa_audio_iec958_codec codec
Definition: iec958.h:54
spa_audio_info_iec958::rate
uint32_t rate
Definition: iec958.h:56
spa_audio_info_raw
Audio information description.
Definition: audio/raw.h:288
spa_audio_info_raw::format
enum spa_audio_format format
Definition: audio/raw.h:289
spa_audio_info_raw::channels
uint32_t channels
Definition: audio/raw.h:292
spa_audio_info_raw::flags
uint32_t flags
Definition: audio/raw.h:290
spa_audio_info_raw::position
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: audio/raw.h:293
spa_audio_info_raw::rate
uint32_t rate
Definition: audio/raw.h:291
spa_pod_builder
Definition: builder.h:63
spa_pod_frame
Definition: iter.h:42
spa_pod
Definition: pod/pod.h:50