mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-22 06:59:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa: group the spa headers into doxygen modules

Browse source 
Subdirectories buffer, control, debug, monitor, pod, support and utils, others
are still missing. Headers are grouped either per subdirectory (e.g. buffer/
gets added to group spa_buffer) or per-file (e.g. spa_json is a separate
group), whatever seemed like the most sensible approach.
This commit is contained in:
Peter Hutterer 2021-05-21 14:03:07 +10:00 • committed by Wim Taymans
parent d0aff793b7
commit 07533cb708
72 changed files with 700 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

8
spa/include/spa/param/audio/format-utils.h
View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/pod/parser.h>
#include <spa/pod/builder.h>
@ -106,6 +110,10 @@ spa_format_audio_dsp_build(struct spa_pod_builder *builder, uint32_t id, struct
return (struct spa_pod*)spa_pod_builder_pop(builder, &f);
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/audio/format.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/format.h>
#include <spa/param/audio/raw.h>
@ -41,6 +46,10 @@ struct spa_audio_info {
} info;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

8
spa/include/spa/param/audio/layout.h
View file

@ -33,6 +33,10 @@ extern "C" {
#include <endian.h>
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/audio/raw.h>
struct spa_audio_layout_info {
@ -177,6 +181,10 @@ struct spa_audio_layout_info {
SPA_AUDIO_CHANNEL_RL, SPA_AUDIO_CHANNEL_RR, \
SPA_AUDIO_CHANNEL_FLC, SPA_AUDIO_CHANNEL_FRC, }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/audio/raw.h
View file

@ -35,6 +35,11 @@ extern "C" {
#include <endian.h>
#endif
/**
* \addtogroup spa_param
* \{
*/
#define SPA_AUDIO_MAX_CHANNELS 64u
enum spa_audio_format {
@ -235,6 +240,10 @@ struct spa_audio_info_dsp {
#define SPA_AUDIO_INFO_DSP_INIT(...) (struct spa_audio_info_dsp) { __VA_ARGS__ }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/audio/type-info.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/audio/raw.h>
#define SPA_TYPE_INFO_AudioFormat SPA_TYPE_INFO_ENUM_BASE "AudioFormat"
@ -193,6 +198,10 @@ static const struct spa_type_info spa_type_audio_channel[] = {
{ 0, 0, NULL, NULL },
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

8
spa/include/spa/param/bluetooth/audio.h
View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
enum spa_bluetooth_audio_codec {
SPA_BLUETOOTH_AUDIO_CODEC_START,
@ -46,6 +50,10 @@ enum spa_bluetooth_audio_codec {
SPA_BLUETOOTH_AUDIO_CODEC_MSBC,
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/bluetooth/type-info.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/bluetooth/audio.h>
#define SPA_TYPE_INFO_BluetoothAudioCodec SPA_TYPE_INFO_ENUM_BASE "BluetoothAudioCodec"
@ -50,6 +55,10 @@ static const struct spa_type_info spa_type_bluetooth_audio_codec[] = {
{ 0, 0, NULL, NULL },
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/format-utils.h
View file

@ -30,6 +30,11 @@ extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/pod/parser.h>
#include <spa/param/format.h>
@ -42,6 +47,10 @@ spa_format_parse(const struct spa_pod *format, uint32_t *media_type, uint32_t *m
SPA_FORMAT_mediaSubtype, SPA_POD_Id(media_subtype));
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/format.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/param.h>
/** media type for SPA_TYPE_OBJECT_Format */
@ -140,6 +145,10 @@ enum spa_format {
#define SPA_KEY_FORMAT_DSP "format.dsp" /**< a predefined DSP format,
* Ex. "32 bit float mono audio" */
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

12
spa/include/spa/param/param.h
View file

@ -29,6 +29,14 @@
extern "C" {
#endif
/** \defgroup spa_param SPA Parameters
*/
/**
* \addtogroup spa_param
* \{
*/
#include <spa/utils/defs.h>
/** different parameter types that can be queried */
@ -164,6 +172,10 @@ enum spa_param_route {
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/profiler.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/param.h>
/** properties for SPA_TYPE_OBJECT_Profiler */
@ -81,6 +86,10 @@ enum spa_profiler {
SPA_PROFILER_START_CUSTOM = 0x1000000,
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/props.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/param.h>
/** properties of SPA_TYPE_OBJECT_PropInfo */
@ -111,6 +116,10 @@ enum spa_prop {
SPA_PROP_START_CUSTOM = 0x1000000,
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/type-info.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/utils/defs.h>
#include <spa/param/props.h>
#include <spa/param/format.h>
@ -379,6 +384,10 @@ static const struct spa_type_info spa_type_profiler[] = {
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/chroma.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/** Various Chroma settings.
*/
enum spa_video_chroma_site {
@ -48,6 +53,10 @@ enum spa_video_chroma_site {
SPA_VIDEO_CHROMA_SITE_DV = (SPA_VIDEO_CHROMA_SITE_COSITED | SPA_VIDEO_CHROMA_SITE_ALT_LINE),
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/color.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/**
* Possible color range values. These constants are defined for 8 bit color
* values and can be scaled for other bit depths.
@ -109,6 +114,10 @@ struct spa_video_colorimetry {
* and CIE XYZ */
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/encoded.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/format.h>
enum spa_h264_stream_format {
@ -58,6 +63,10 @@ struct spa_video_info_mjpg {
struct spa_fraction max_framerate;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

8
spa/include/spa/param/video/format-utils.h
View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/pod/parser.h>
#include <spa/pod/builder.h>
#include <spa/param/video/format.h>
@ -168,6 +172,10 @@ spa_format_video_mjpg_parse(const struct spa_pod *format,
SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_OPT_Fraction(&info->max_framerate));
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/format.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/video/raw.h>
#include <spa/param/video/encoded.h>
@ -43,6 +48,10 @@ struct spa_video_info {
} info;
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/multiview.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
/**
* All possible stereoscopic 3D and multiview representations.
* In conjunction with \ref spa_video_multiview_flags, describes how
@ -118,6 +123,10 @@ enum spa_video_multiview_flags {
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

9
spa/include/spa/param/video/raw.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/utils/defs.h>
#include <spa/param/video/chroma.h>
#include <spa/param/video/color.h>
@ -189,6 +194,10 @@ struct spa_video_info_dsp {
#define SPA_VIDEO_INFO_DSP_INIT(...) (struct spa_video_info_dsp) { __VA_ARGS__ }
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif

8
spa/include/spa/param/video/type-info.h
View file

@ -29,6 +29,10 @@
extern "C" {
#endif
/**
* \addtogroup spa_param
* \{
*/
#include <spa/param/video/raw.h>
#define SPA_TYPE_INFO_VideoFormat SPA_TYPE_INFO_ENUM_BASE "VideoFormat"
@ -117,6 +121,10 @@ static const struct spa_type_info spa_type_video_format[] = {
{ 0, 0, NULL, NULL },
};
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */
#endif