From 47e4110a1b0e28062212c85fd0337c753204167a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Sat, 15 Oct 2022 00:00:03 +0300 Subject: [PATCH] rtp: Add/fix various annotations Part-of: --- .../gst-libs/gst/rtp/gstrtcpbuffer.c | 2 +- .../gst-libs/gst/rtp/gstrtpbasedepayload.c | 6 +++--- .../gst-libs/gst/rtp/gstrtpbasepayload.c | 2 +- .../gst-libs/gst/rtp/gstrtpbuffer.c | 18 +++++++++--------- .../gst-libs/gst/rtp/gstrtphdrext.c | 2 +- .../gst-libs/gst/rtp/gstrtpmeta.c | 10 +++++----- .../gst-libs/gst/rtp/gstrtppayloads.c | 4 ++-- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtcpbuffer.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtcpbuffer.c index 884440f113..dea2a7933d 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtcpbuffer.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtcpbuffer.c @@ -1863,7 +1863,7 @@ gst_rtcp_packet_bye_get_reason_len (GstRTCPPacket * packet) * * Get the reason in @packet. * - * Returns: The reason for the BYE @packet or NULL if the packet did not contain + * Returns: (nullable): The reason for the BYE @packet or NULL if the packet did not contain * a reason string. The string must be freed with g_free() after usage. */ gchar * diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasedepayload.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasedepayload.c index 811d4e6071..1520581b4e 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasedepayload.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasedepayload.c @@ -305,7 +305,7 @@ gst_rtp_base_depayload_class_init (GstRTPBaseDepayloadClass * klass) * The returned @ext must be configured with the correct @ext_id and with the * necessary attributes as required by the extension implementation. * - * Returns: (transfer full): the #GstRTPHeaderExtension for @ext_id, or %NULL + * Returns: (transfer full) (nullable): the #GstRTPHeaderExtension for @ext_id, or %NULL * * Since: 1.20 */ @@ -1429,7 +1429,7 @@ gst_rtp_base_depayload_do_push (GstRTPBaseDepayload * filter, gboolean is_list, /** * gst_rtp_base_depayload_push: * @filter: a #GstRTPBaseDepayload - * @out_buf: a #GstBuffer + * @out_buf: (transfer full): a #GstBuffer * * Push @out_buf to the peer of @filter. This function takes ownership of * @out_buf. @@ -1455,7 +1455,7 @@ gst_rtp_base_depayload_push (GstRTPBaseDepayload * filter, GstBuffer * out_buf) /** * gst_rtp_base_depayload_push_list: * @filter: a #GstRTPBaseDepayload - * @out_list: a #GstBufferList + * @out_list: (transfer full): a #GstBufferList * * Push @out_list to the peer of @filter. This function takes ownership of * @out_list. diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasepayload.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasepayload.c index f7cd559315..02d0f51d23 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasepayload.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbasepayload.c @@ -467,7 +467,7 @@ gst_rtp_base_payload_class_init (GstRTPBasePayloadClass * klass) * The returned @ext must be configured with the correct @ext_id and with the * necessary attributes as required by the extension implementation. * - * Returns: (transfer full): the #GstRTPHeaderExtension for @ext_id, or %NULL + * Returns: (transfer full) (nullable): the #GstRTPHeaderExtension for @ext_id, or %NULL * * Since: 1.20 */ diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbuffer.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbuffer.c index 228abf4568..ec4b53bd7b 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbuffer.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpbuffer.c @@ -158,7 +158,7 @@ gst_rtp_buffer_allocate_data (GstBuffer * buffer, guint payload_len, * respectively. @data will be freed when the buffer is unreffed, so this * function transfers ownership of @data to the new buffer. * - * Returns: A newly allocated buffer with @data and of size @len. + * Returns: (transfer full): A newly allocated buffer with @data and of size @len. */ GstBuffer * gst_rtp_buffer_new_take_data (gpointer data, gsize len) @@ -179,7 +179,7 @@ gst_rtp_buffer_new_take_data (gpointer data, gsize len) * bytes of @data and the size to @len. The data will be freed when the buffer * is freed. * - * Returns: A newly allocated buffer with a copy of @data and of size @len. + * Returns: (transfer full): A newly allocated buffer with a copy of @data and of size @len. */ GstBuffer * gst_rtp_buffer_new_copy_data (gconstpointer data, gsize len) @@ -197,7 +197,7 @@ gst_rtp_buffer_new_copy_data (gconstpointer data, gsize len) * @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len. * All other RTP header fields will be set to 0/FALSE. * - * Returns: A newly allocated buffer that can hold an RTP packet with given + * Returns: (transfer full): A newly allocated buffer that can hold an RTP packet with given * parameters. */ GstBuffer * @@ -225,7 +225,7 @@ gst_rtp_buffer_new_allocate (guint payload_len, guint8 pad_len, * @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len(). * All RTP header fields will be set to 0/FALSE. * - * Returns: A newly allocated buffer that can hold an RTP packet of @packet_len. + * Returns: (transfer full): A newly allocated buffer that can hold an RTP packet of @packet_len. */ GstBuffer * gst_rtp_buffer_new_allocate_len (guint packet_len, guint8 pad_len, @@ -733,7 +733,7 @@ gst_rtp_buffer_get_extension_data (GstRTPBuffer * rtp, guint16 * bits, * @bits unchanged. If there is an extension header but no extension data then * an empty #GBytes will be returned. * - * Returns: (transfer full): A new #GBytes if an extension header was present + * Returns: (transfer full) (nullable): A new #GBytes if an extension header was present * and %NULL otherwise. * * Since: 1.2 @@ -1140,7 +1140,7 @@ gst_rtp_buffer_set_timestamp (GstRTPBuffer * rtp, guint32 timestamp) * are skipped in the payload and the subbuffer will be of size @len. * If @len is -1 the total payload starting from @offset is subbuffered. * - * Returns: A new buffer with the specified data of the payload. + * Returns: (transfer full): A new buffer with the specified data of the payload. */ GstBuffer * gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer * rtp, guint offset, @@ -1180,7 +1180,7 @@ wrong_offset: * will internally create a subbuffer of @buffer so that a memcpy can be * avoided. * - * Returns: A new buffer with the data of the payload. + * Returns: (transfer full): A new buffer with the data of the payload. */ GstBuffer * gst_rtp_buffer_get_payload_buffer (GstRTPBuffer * rtp) @@ -1210,7 +1210,7 @@ gst_rtp_buffer_get_payload_len (GstRTPBuffer * rtp) * Get a pointer to the payload data in @buffer. This pointer is valid as long * as a reference to @buffer is held. * - * Returns: (array) (element-type guint8) (transfer none): A pointer + * Returns: (array) (element-type guint8) (transfer none) (nullable): A pointer * to the payload data in @buffer. */ gpointer @@ -1233,7 +1233,7 @@ gst_rtp_buffer_get_payload (GstRTPBuffer * rtp) * bindings usage. The return value is a pointer to a #GBytes structure * containing the payload data in @rtp. * - * Returns: (transfer full): A new #GBytes containing the payload data in @rtp. + * Returns: (transfer full) (nullable): A new #GBytes containing the payload data in @rtp. * * Since: 1.2 */ diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtphdrext.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtphdrext.c index 48fdd83b29..fd683c5c6d 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtphdrext.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtphdrext.c @@ -205,7 +205,7 @@ gst_rtp_header_extension_init (GstRTPHeaderExtension * ext) * gst_rtp_header_extension_get_uri: * @ext: a #GstRTPHeaderExtension * - * Returns: the RTP extension URI for this object + * Returns: (nullable): the RTP extension URI for this object * * Since: 1.20 */ diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpmeta.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpmeta.c index 1968f49643..76941efd08 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpmeta.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtpmeta.c @@ -34,8 +34,8 @@ /** * gst_buffer_add_rtp_source_meta: * @buffer: a #GstBuffer - * @ssrc: (allow-none) (transfer none): pointer to the SSRC - * @csrc: (allow-none) (transfer none): pointer to the CSRCs + * @ssrc: (nullable) (transfer none): pointer to the SSRC + * @csrc: (nullable) (transfer none) (array length=csrc_count): pointer to the CSRCs * @csrc_count: number of elements in @csrc * * Attaches RTP source information to @buffer. @@ -81,7 +81,7 @@ gst_buffer_add_rtp_source_meta (GstBuffer * buffer, const guint32 * ssrc, * * Find the #GstRTPSourceMeta on @buffer. * - * Returns: (transfer none): the #GstRTPSourceMeta or %NULL when there + * Returns: (transfer none) (nullable): the #GstRTPSourceMeta or %NULL when there * is no such metadata on @buffer. * * Since: 1.16 @@ -137,7 +137,7 @@ gst_rtp_source_meta_get_source_count (const GstRTPSourceMeta * meta) /** * gst_rtp_source_meta_set_ssrc: * @meta: a #GstRTPSourceMeta - * @ssrc: (allow-none) (transfer none): pointer to the SSRC + * @ssrc: (nullable) (transfer none): pointer to the SSRC * * Sets @ssrc in @meta. If @ssrc is %NULL the ssrc of @meta will be unset. * @@ -161,7 +161,7 @@ gst_rtp_source_meta_set_ssrc (GstRTPSourceMeta * meta, guint32 * ssrc) /** * gst_rtp_source_meta_append_csrc: * @meta: a #GstRTPSourceMeta - * @csrc: the csrcs to append + * @csrc: (array length=csrc_count): the csrcs to append * @csrc_count: number of elements in @csrc * * Appends @csrc to the list of contributing sources in @meta. diff --git a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtppayloads.c b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtppayloads.c index 76ac069c63..1ab579d4d4 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtppayloads.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/rtp/gstrtppayloads.c @@ -185,7 +185,7 @@ static const GstRTPPayloadInfo info[] = { * mostly used to get the default clock-rate and bandwidth for static payload * types specified with @payload_type. * - * Returns: a #GstRTPPayloadInfo or NULL when no info could be found. + * Returns: (nullable): a #GstRTPPayloadInfo or NULL when no info could be found. */ const GstRTPPayloadInfo * gst_rtp_payload_info_for_pt (guint8 payload_type) @@ -213,7 +213,7 @@ gst_rtp_payload_info_for_pt (guint8 payload_type) * * The search for @encoding_name will be performed in a case insensitive way. * - * Returns: a #GstRTPPayloadInfo or NULL when no info could be found. + * Returns: (nullable): a #GstRTPPayloadInfo or NULL when no info could be found. */ const GstRTPPayloadInfo * gst_rtp_payload_info_for_name (const gchar * media, const gchar * encoding_name)