PipeWire  0.3.33
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 */
SPA_MEDIA_SUBTYPE_dsp
@ SPA_MEDIA_SUBTYPE_dsp
Definition: param/format.h:54
spa_audio_info_raw
Audio information description.
Definition: audio/raw.h:285
spa_audio_info_raw::rate
uint32_t rate
Definition: audio/raw.h:288
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition: param/format.h:102
format.h
SPA_POD_Array
#define SPA_POD_Array(csize, ctype, n_vals, vals)
Definition: vararg.h:96
SPA_POD_Int
#define SPA_POD_Int(val)
Definition: vararg.h:59
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition: build-12775836/doc/spa/utils/type.h:90
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition: build-12775836/doc/spa/utils/type.h:47
spa_pod_builder_add
int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition: builder.h:638
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:72
format-utils.h
SPA_MEDIA_TYPE_audio
@ SPA_MEDIA_TYPE_audio
Definition: param/format.h:42
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_audio_info_raw::format
enum spa_audio_format format
Definition: audio/raw.h:286
spa_audio_info_raw::channels
uint32_t channels
Definition: audio/raw.h:289
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
Definition: pod/pod.h:50
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_FLAG_SET
#define SPA_FLAG_SET(field, flag)
Definition: defs.h:74
SPA_AUDIO_MAX_CHANNELS
#define SPA_AUDIO_MAX_CHANNELS
Definition: audio/raw.h:43
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_AUDIO_FORMAT_UNKNOWN
@ SPA_AUDIO_FORMAT_UNKNOWN
Definition: audio/raw.h:46
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:99
SPA_FORMAT_AUDIO_rate
@ SPA_FORMAT_AUDIO_rate
sample rate (Int)
Definition: param/format.h:109
spa_audio_info_raw::flags
uint32_t flags
Definition: audio/raw.h:287
spa_audio_info_dsp::format
enum spa_audio_format format
Definition: audio/raw.h:305
SPA_FLAG_IS_SET
#define SPA_FLAG_IS_SET(field, flag)
Definition: defs.h:73
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition: param/format.h:103
spa_audio_info_dsp
Definition: audio/raw.h:304
spa_pod_frame
Definition: iter.h:42
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
spa_audio_info_raw::position
uint32_t position[SPA_AUDIO_MAX_CHANNELS]
Definition: audio/raw.h:290
SPA_FORMAT_AUDIO_channels
@ SPA_FORMAT_AUDIO_channels
number of audio channels (Int)
Definition: param/format.h:110
parser.h
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_FORMAT_AUDIO_format
@ SPA_FORMAT_AUDIO_format
audio format, (Id enum spa_audio_format)
Definition: param/format.h:107
SPA_FORMAT_AUDIO_position
@ SPA_FORMAT_AUDIO_position
channel positions (Id enum spa_audio_position)
Definition: param/format.h:111
SPA_AUDIO_FLAG_UNPOSITIONED
#define SPA_AUDIO_FLAG_UNPOSITIONED
Definition: audio/raw.h:283
SPA_POD_OPT_Pod
#define SPA_POD_OPT_Pod(val)
Definition: parser.h:533
SPA_POD_Id
#define SPA_POD_Id(val)
Definition: vararg.h:56
spa_pod_builder
Definition: builder.h:63
SPA_MEDIA_SUBTYPE_raw
@ SPA_MEDIA_SUBTYPE_raw
Definition: param/format.h:53
builder.h