PipeWire  0.3.48
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,
54  if (position == NULL ||
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,
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,
79  return res;
80 }
81 
82 static inline int
83 spa_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 *
103 spa_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 *
130 spa_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 *
146 spa_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 *
164 spa_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 */
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition: format.h:59
spa_pod_copy_array
static uint32_t spa_pod_copy_array(const struct spa_pod *pod, uint32_t type, void *values, uint32_t max_values)
Definition: iter.h:349
spa_audio_info_raw
Audio information description.
Definition: raw.h:298
spa_audio_info_raw::rate
uint32_t rate
Definition: raw.h:301
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: format.h:109
format.h
SPA_POD_Array
#define SPA_POD_Array(csize, ctype, n_vals, vals)
Definition: vararg.h:140
SPA_POD_Int
#define SPA_POD_Int(val)
Definition: vararg.h:74
SPA_PARAM_BITORDER_unknown
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition: param.h:209
SPA_FORMAT_AUDIO_iec958Codec
@ SPA_FORMAT_AUDIO_iec958Codec
codec used (IEC958) (Id enum spa_audio_iec958_codec)
Definition: format.h:120
spa_format_audio_raw_parse
static int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition: format-utils.h:48
spa_format_audio_dsp_parse
static int spa_format_audio_dsp_parse(const struct spa_pod *format, struct spa_audio_info_dsp *info)
Definition: format-utils.h:67
SPA_MEDIA_SUBTYPE_iec958
@ SPA_MEDIA_SUBTYPE_iec958
Definition: format.h:60
SPA_FORMAT_AUDIO_interleave
@ SPA_FORMAT_AUDIO_interleave
Interleave bytes (Int)
Definition: format.h:123
spa_pod_builder_add
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:665
spa_format_audio_dsp_build
static struct spa_pod * spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsp *info)
Definition: format-utils.h:135
SPA_FORMAT_AUDIO_bitorder
@ SPA_FORMAT_AUDIO_bitorder
bit order (Id enum spa_param_bitorder)
Definition: format.h:122
format-utils.h
spa_audio_info_iec958
Definition: iec958.h:58
SPA_MEDIA_TYPE_audio
@ SPA_MEDIA_TYPE_audio
Definition: format.h:47
spa_audio_info_raw::format
enum spa_audio_format format
Definition: raw.h:299
spa_audio_info_raw::channels
uint32_t channels
Definition: raw.h:302
SPA_FLAG_SET
#define SPA_FLAG_SET(field, flag)
Definition: defs.h:84
spa_pod
Definition: pod.h:63
spa_pod_builder_pop
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:186
SPA_AUDIO_MAX_CHANNELS
#define SPA_AUDIO_MAX_CHANNELS
Definition: raw.h:49
SPA_AUDIO_FORMAT_UNKNOWN
@ SPA_AUDIO_FORMAT_UNKNOWN
Definition: raw.h:52
spa_audio_info_dsd
Definition: dsd.h:68
spa_audio_info_iec958::rate
uint32_t rate
Definition: iec958.h:61
SPA_AUDIO_IEC958_CODEC_UNKNOWN
@ SPA_AUDIO_IEC958_CODEC_UNKNOWN
Definition: iec958.h:44
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition: format.h:116
spa_audio_info_raw::flags
uint32_t flags
Definition: raw.h:300
spa_audio_info_dsp::format
enum spa_audio_format format
Definition: raw.h:327
spa_audio_info_dsd::interleave
int32_t interleave
Definition: dsd.h:71
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: format.h:110
spa_audio_info_dsd::channels
uint32_t channels
Definition: dsd.h:73
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition: type.h:53
spa_audio_info_dsd::rate
uint32_t rate
Definition: dsd.h:72
spa_audio_info_iec958::codec
enum spa_audio_iec958_codec codec
Definition: iec958.h:59
spa_audio_info_dsp
Definition: raw.h:326
SPA_FLAG_IS_SET
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:82
spa_audio_info_dsd::bitorder
enum spa_param_bitorder bitorder
Definition: dsd.h:69
spa_pod_frame
Definition: iter.h:47
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:585
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition: type.h:96
spa_format_audio_iec958_parse
static int spa_format_audio_iec958_parse(const struct spa_pod *format, struct spa_audio_info_iec958 *info)
Definition: format-utils.h:77
spa_audio_info_dsd::position
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: dsd.h:74
spa_format_audio_dsd_parse
static int spa_format_audio_dsd_parse(const struct spa_pod *format, struct spa_audio_info_dsd *info)
Definition: format-utils.h:88
spa_audio_info_raw::position
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: raw.h:303
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition: format.h:117
parser.h
spa_pod_builder_push_object
static 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:453
SPA_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition: format.h:114
spa_format_audio_raw_build
static struct spa_pod * spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_raw *info)
Definition: format-utils.h:108
SPA_FORMAT_AUDIO_position
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition: format.h:118
SPA_AUDIO_FLAG_UNPOSITIONED
#define SPA_AUDIO_FLAG_UNPOSITIONED
Definition: raw.h:296
SPA_POD_OPT_Pod
#define SPA_POD_OPT_Pod(val)
Definition: parser.h:555
SPA_POD_Id
#define SPA_POD_Id(val)
Definition: vararg.h:69
spa_audio_info_dsd::flags
uint32_t flags
Definition: dsd.h:70
spa_pod_builder
Definition: builder.h:73
SPA_MEDIA_SUBTYPE_dsd
@ SPA_MEDIA_SUBTYPE_dsd
S/PDIF.
Definition: format.h:61
spa_format_audio_iec958_build
static struct spa_pod * spa_format_audio_iec958_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_iec958 *info)
Definition: format-utils.h:151
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: format.h:58
spa_format_audio_dsd_build
static struct spa_pod * spa_format_audio_dsd_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsd *info)
Definition: format-utils.h:169
builder.h