PipeWire  0.3.29
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,
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 struct spa_pod *
72 spa_format_audio_raw_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_raw *info)
73 {
74  struct spa_pod_frame f;
76  spa_pod_builder_add(builder,
79  0);
80  if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
81  spa_pod_builder_add(builder,
83  if (info->rate != 0)
84  spa_pod_builder_add(builder,
86  if (info->channels != 0) {
87  spa_pod_builder_add(builder,
91  SPA_POD_Array(sizeof(uint32_t), SPA_TYPE_Id,
92  info->channels, info->position), 0);
93  }
94  }
95  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
96 }
97 
98 /* static */ inline struct spa_pod *
99 spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct spa_audio_info_dsp *info)
100 {
101  struct spa_pod_frame f;
103  spa_pod_builder_add(builder,
106  0);
107  if (info->format != SPA_AUDIO_FORMAT_UNKNOWN)
108  spa_pod_builder_add(builder,
110  return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
111 }
112 
117 #ifdef __cplusplus
118 } /* extern "C" */
119 #endif
120 
121 #endif /* SPA_PARAM_AUDIO_FORMAT_UTILS_H */
#define SPA_POD_Int(val)
Definition: vararg.h:59
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:72
Definition: param/format.h:54
media type (Id enum spa_media_type)
Definition: param/format.h:102
int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:638
Definition: x86_64-redhat-linux-gnu/doc/spa/utils/type.h:47
Audio information description.
Definition: audio/raw.h:218
uint32_t rate
Definition: audio/raw.h:221
enum spa_audio_format format
Definition: audio/raw.h:219
Definition: iter.h:42
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:72
static uint32_t int int res
Definition: core.h:328
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_AUDIO_MAX_CHANNELS
Definition: audio/raw.h:43
void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition: builder.h:175
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:103
uint32_t flags
Definition: audio/raw.h:220
Definition: param/format.h:42
Definition: pod/pod.h:50
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
int spa_format_audio_raw_parse(const struct spa_pod *format, struct spa_audio_info_raw *info)
Definition: audio/format-utils.h:43
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: audio/raw.h:223
Definition: audio/raw.h:46
channel positions (Id enum spa_audio_position)
Definition: param/format.h:111
uint32_t spa_pod_copy_array(const struct spa_pod *pod, uint32_t type, void *values, uint32_t max_values)
Definition: iter.h:344
enum spa_audio_format format
Definition: audio/raw.h:241
sample rate (Int)
Definition: param/format.h:109
number of audio channels (Int)
Definition: param/format.h:110
Definition: builder.h:63
audio format, (Id enum spa_audio_format)
Definition: param/format.h:107
#define SPA_FLAG_SET(field, flag)
Definition: defs.h:73
int spa_format_audio_dsp_parse(const struct spa_pod *format, struct spa_audio_info_dsp *info)
Definition: audio/format-utils.h:62
Definition: audio/raw.h:240
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:99
Definition: x86_64-redhat-linux-gnu/doc/spa/utils/type.h:90
#define SPA_AUDIO_FLAG_UNPOSITIONED
Definition: audio/raw.h:215
#define SPA_POD_Id(val)
Definition: vararg.h:56
#define SPA_POD_OPT_Pod(val)
Definition: parser.h:533
Definition: param/format.h:53
uint32_t channels
Definition: audio/raw.h:222
#define SPA_POD_Array(csize, ctype, n_vals, vals)
Definition: vararg.h:96