mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-29 13:11:06 +00:00
Code Issues 1 Projects Releases Wiki Activity

dsd: Fix documentation parameters

Browse source 
There were some inconsistencies between documentation and function signatures

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5002>
This commit is contained in:
Edward Hervey 2023-07-10 14:44:58 +02:00 committed by GStreamer Marge Bot
parent e84e7df950
commit 654609ef15
4 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
girs/GstAudio-1.0.gir
View file

@ -9723,7 +9723,7 @@ in a more readable fashion.</doc>
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h">32 DSD bits in 4 bytes, native endianness</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h">32 DSD bits in 4 bytes, native endianness</doc>
</member> </member>
<function name="from_string" c:identifier="gst_dsd_format_from_string" version="1.24"> <function name="from_string" c:identifier="gst_dsd_format_from_string" version="1.24">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">Convert the @format string to its #GstDsdFormat.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">Convert the DSD format string @str to its #GstDsdFormat.</doc>
<source-position filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h"/> <source-position filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the
@ -9732,6 +9732,7 @@ string is not a known format.</doc>
</return-value> </return-value>
<parameters> <parameters>
<parameter name="str" transfer-ownership="none"> <parameter name="str" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">a DSD format string</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
</parameter> </parameter>
</parameters> </parameters>
@ -9947,8 +9948,11 @@ Note: This initializes @info first, no values are preserved.</doc>
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">the number of channels</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">the number of channels</doc>
<type name="gint" c:type="gint"/> <type name="gint" c:type="gint"/>
</parameter> </parameter>
<parameter name="positions" transfer-ownership="none"> <parameter name="positions" transfer-ownership="none" nullable="1" allow-none="1">
<type name="AudioChannelPosition" c:type="const GstAudioChannelPosition*"/> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">the channel positions</doc>
<array zero-terminated="0" c:type="const GstAudioChannelPosition*" fixed-size="64">
<type name="AudioChannelPosition" c:type="GstAudioChannelPosition"/>
</array>
</parameter> </parameter>
</parameters> </parameters>
</method> </method>
@ -11580,13 +11584,14 @@ are ignored.</doc>
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">Number of channels (must be at least 1)</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">Number of channels (must be at least 1)</doc>
<type name="gint" c:type="gint"/> <type name="gint" c:type="gint"/>
</parameter> </parameter>
<parameter name="reverse_bytes" transfer-ownership="none"> <parameter name="reverse_byte_bits" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c">If TRUE, reverse the bits in each DSD byte</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
</parameter> </parameter>
</parameters> </parameters>
</function> </function>
<function name="dsd_format_from_string" c:identifier="gst_dsd_format_from_string" moved-to="DsdFormat.from_string" version="1.24"> <function name="dsd_format_from_string" c:identifier="gst_dsd_format_from_string" moved-to="DsdFormat.from_string" version="1.24">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">Convert the @format string to its #GstDsdFormat.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">Convert the DSD format string @str to its #GstDsdFormat.</doc>
<source-position filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h"/> <source-position filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the <doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the
@ -11595,6 +11600,7 @@ string is not a known format.</doc>
</return-value> </return-value>
<parameters> <parameters>
<parameter name="str" transfer-ownership="none"> <parameter name="str" transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c">a DSD format string</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
</parameter> </parameter>
</parameters> </parameters>

2
subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.c
View file

@ -345,7 +345,7 @@ gst_dsd_info_init (GstDsdInfo * info)
* @format: the format * @format: the format
* @rate: the DSD rate * @rate: the DSD rate
* @channels: the number of channels * @channels: the number of channels
* @position: (array fixed-size=64) (nullable): the channel positions * @positions: (array fixed-size=64) (nullable): the channel positions
* *
* Set the default info for the DSD info of @format and @rate and @channels. * Set the default info for the DSD info of @format and @rate and @channels.
* *

2
subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsd.h
View file

@ -311,7 +311,7 @@ void gst_dsd_convert (const guint8 *input_data,
const gsize *output_plane_offsets, const gsize *output_plane_offsets,
gsize num_dsd_bytes, gsize num_dsd_bytes,
gint num_channels, gint num_channels,
gboolean reverse_bytes); gboolean reverse_byte_bits);
/** /**
* gst_dsd_format_is_le: * gst_dsd_format_is_le:

4
subprojects/gst-plugins-base/gst-libs/gst/audio/gstdsdformat.c
View file

@ -25,9 +25,9 @@
/** /**
* gst_dsd_format_from_string: * gst_dsd_format_from_string:
* @format: a format string * @str: a DSD format string
* *
* Convert the @format string to its #GstDsdFormat. * Convert the DSD format string @str to its #GstDsdFormat.
* *
* Returns: the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the * Returns: the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the
* string is not a known format. * string is not a known format.