mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-18 12:15:19 +00:00
Code Issues 1 Projects Releases Wiki Activity

sdp: Add/fix various annotations

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
This commit is contained in:
Sebastian Dröge 2022-10-17 14:43:42 +03:00
parent 4617b63b5f
commit 2650bba844
2 changed files with 30 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
subprojects/gst-plugins-base/gst-libs/gst/sdp/gstmikey.c
View file

@ -177,7 +177,7 @@ gst_mikey_payload_kemac_get_n_sub (const GstMIKEYPayload * payload)
* Get the sub payload of @payload at @idx. @payload should be of type * Get the sub payload of @payload at @idx. @payload should be of type
* %GST_MIKEY_PT_KEMAC. * %GST_MIKEY_PT_KEMAC.
* *
* Returns: (transfer none): the #GstMIKEYPayload at @idx. * Returns: (transfer none) (nullable): the #GstMIKEYPayload at @idx.
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -458,7 +458,7 @@ gst_mikey_payload_sp_get_n_params (const GstMIKEYPayload * payload)
* Get the Security Policy parameter in a %GST_MIKEY_PT_SP @payload * Get the Security Policy parameter in a %GST_MIKEY_PT_SP @payload
* at @idx. * at @idx.
* *
* Returns: the #GstMIKEYPayloadSPParam at @idx in @payload * Returns: (transfer none) (nullable): the #GstMIKEYPayloadSPParam at @idx in @payload
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -763,7 +763,7 @@ mikey_payload_free (GstMIKEYPayload * payload)
* *
* Make a new #GstMIKEYPayload with @type. * Make a new #GstMIKEYPayload with @type.
* *
* Returns: (nullable): a new #GstMIKEYPayload or %NULL on failure. * Returns: (transfer full) (nullable): a new #GstMIKEYPayload or %NULL on failure.
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -870,7 +870,7 @@ mikey_message_free (GstMIKEYMessage * msg)
* *
* Make a new MIKEY message. * Make a new MIKEY message.
* *
* Returns: a new #GstMIKEYMessage on success * Returns: (transfer full): a new #GstMIKEYMessage on success
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -895,11 +895,11 @@ gst_mikey_message_new (void)
* gst_mikey_message_new_from_bytes: * gst_mikey_message_new_from_bytes:
* @bytes: a #GBytes * @bytes: a #GBytes
* @info: a #GstMIKEYDecryptInfo * @info: a #GstMIKEYDecryptInfo
* @error: a #GError * @error: (optional): a #GError
* *
* Make a new #GstMIKEYMessage from @bytes. * Make a new #GstMIKEYMessage from @bytes.
* *
* Returns: a new #GstMIKEYMessage * Returns: (transfer full): a new #GstMIKEYMessage
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -974,7 +974,7 @@ gst_mikey_message_get_n_cs (const GstMIKEYMessage * msg)
* *
* Get the policy information of @msg at @idx. * Get the policy information of @msg at @idx.
* *
* Returns: a #GstMIKEYMapSRTP * Returns: (transfer none) (nullable): a #GstMIKEYMapSRTP
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -1125,7 +1125,7 @@ gst_mikey_message_get_n_payloads (const GstMIKEYMessage * msg)
* *
* Get the #GstMIKEYPayload at @idx in @msg * Get the #GstMIKEYPayload at @idx in @msg
* *
* Returns: (transfer none): the #GstMIKEYPayload at @idx. The payload * Returns: (transfer none) (nullable): the #GstMIKEYPayload at @idx. The payload
* remains valid for as long as it is part of @msg. * remains valid for as long as it is part of @msg.
* *
* Since: 1.4 * Since: 1.4
@ -1149,7 +1149,7 @@ gst_mikey_message_get_payload (const GstMIKEYMessage * msg, guint idx)
* *
* Find the @nth occurrence of the payload with @type in @msg. * Find the @nth occurrence of the payload with @type in @msg.
* *
* Returns: the @nth #GstMIKEYPayload of @type. * Returns: (transfer none) (nullable): the @nth #GstMIKEYPayload of @type.
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -1667,7 +1667,7 @@ payloads_to_bytes (GArray * payloads, GByteArray * arr, guint8 ** ptr,
* *
* Convert @msg to a #GBytes. * Convert @msg to a #GBytes.
* *
* Returns: a new #GBytes for @msg. * Returns: (transfer full): a new #GBytes for @msg.
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -2048,12 +2048,12 @@ invalid_data:
* @data: (array length=size) (element-type guint8): bytes to read * @data: (array length=size) (element-type guint8): bytes to read
* @size: length of @data * @size: length of @data
* @info: #GstMIKEYDecryptInfo * @info: #GstMIKEYDecryptInfo
* @error: a #GError * @error: (optional): a #GError
* *
* Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the * Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the
* parameters to decrypt and verify the data. * parameters to decrypt and verify the data.
* *
* Returns: a #GstMIKEYMessage on success or %NULL when parsing failed and * Returns: (transfer full): a #GstMIKEYMessage on success or %NULL when parsing failed and
* @error will be set. * @error will be set.
* *
* Since: 1.4 * Since: 1.4
@ -2238,7 +2238,7 @@ auth_key_length_from_auth_cipher_name (const gchar * auth, const gchar * cipher,
* - Key Data Transport Payload * - Key Data Transport Payload
* - Key Data Sub-Payload * - Key Data Sub-Payload
* *
* Returns: (transfer full): a #GstMIKEYMessage, * Returns: (transfer full) (nullable): a #GstMIKEYMessage,
* or %NULL if there is no srtp information in the caps. * or %NULL if there is no srtp information in the caps.
* *
* Since: 1.8 * Since: 1.8

42
subprojects/gst-plugins-base/gst-libs/gst/sdp/gstsdpmessage.c
View file

@ -263,7 +263,7 @@ gst_sdp_message_new_from_text (const gchar * text, GstSDPMessage ** msg)
/** /**
* gst_sdp_message_init: * gst_sdp_message_init:
* @msg: a #GstSDPMessage * @msg: (out caller-allocates): a #GstSDPMessage
* *
* Initialize @msg so that its contents are as if it was freshly allocated * Initialize @msg so that its contents are as if it was freshly allocated
* with gst_sdp_message_new(). This function is mostly used to initialize a message * with gst_sdp_message_new(). This function is mostly used to initialize a message
@ -340,16 +340,12 @@ gst_sdp_message_uninit (GstSDPMessage * msg)
GstSDPResult GstSDPResult
gst_sdp_message_copy (const GstSDPMessage * msg, GstSDPMessage ** copy) gst_sdp_message_copy (const GstSDPMessage * msg, GstSDPMessage ** copy)
{ {
GstSDPResult ret;
GstSDPMessage *cp; GstSDPMessage *cp;
guint i, len; guint i, len;
if (msg == NULL) g_return_val_if_fail (msg != NULL, GST_SDP_EINVAL);
return GST_SDP_EINVAL;
ret = gst_sdp_message_new (copy); gst_sdp_message_new (copy);
if (ret != GST_SDP_OK)
return ret;
cp = *copy; cp = *copy;
@ -489,7 +485,7 @@ gst_sdp_address_is_multicast (const gchar * nettype, const gchar * addrtype,
* *
* Convert the contents of @msg to a text string. * Convert the contents of @msg to a text string.
* *
* Returns: A dynamically allocated string representing the SDP description. * Returns: (transfer full): A dynamically allocated string representing the SDP description.
*/ */
gchar * gchar *
gst_sdp_message_as_text (const GstSDPMessage * msg) gst_sdp_message_as_text (const GstSDPMessage * msg)
@ -624,7 +620,7 @@ hex_to_int (gchar c)
/** /**
* gst_sdp_message_parse_uri: * gst_sdp_message_parse_uri:
* @uri: the start of the uri * @uri: the start of the uri
* @msg: the result #GstSDPMessage * @msg: (out caller-allocates): the result #GstSDPMessage
* *
* Parse the null-terminated @uri and store the result in @msg. * Parse the null-terminated @uri and store the result in @msg.
* *
@ -736,7 +732,7 @@ static const gchar hex[16] = "0123456789ABCDEF";
* *
* Where each value is url encoded. * Where each value is url encoded.
* *
* Returns: a uri for @msg. * Returns: (transfer full): a uri for @msg.
*/ */
gchar * gchar *
gst_sdp_message_as_uri (const gchar * scheme, const GstSDPMessage * msg) gst_sdp_message_as_uri (const gchar * scheme, const GstSDPMessage * msg)
@ -1631,7 +1627,7 @@ DEFINE_ARRAY_GETTER (attribute, attributes, GstSDPAttribute);
* *
* Get the @nth attribute with key @key in @msg. * Get the @nth attribute with key @key in @msg.
* *
* Returns: the attribute value of the @nth attribute with @key. * Returns: (nullable): the attribute value of the @nth attribute with @key.
*/ */
const gchar * const gchar *
gst_sdp_message_get_attribute_val_n (const GstSDPMessage * msg, gst_sdp_message_get_attribute_val_n (const GstSDPMessage * msg,
@ -1663,7 +1659,7 @@ gst_sdp_message_get_attribute_val_n (const GstSDPMessage * msg,
* *
* Get the first attribute with key @key in @msg. * Get the first attribute with key @key in @msg.
* *
* Returns: the attribute value of the first attribute with @key. * Returns: (nullable): the attribute value of the first attribute with @key.
*/ */
const gchar * const gchar *
gst_sdp_message_get_attribute_val (const GstSDPMessage * msg, const gchar * key) gst_sdp_message_get_attribute_val (const GstSDPMessage * msg, const gchar * key)
@ -1820,7 +1816,7 @@ gst_sdp_media_new (GstSDPMedia ** media)
/** /**
* gst_sdp_media_init: * gst_sdp_media_init:
* @media: a #GstSDPMedia * @media: (out caller-allocates): a #GstSDPMedia
* *
* Initialize @media so that its contents are as if it was freshly allocated * Initialize @media so that its contents are as if it was freshly allocated
* with gst_sdp_media_new(). This function is mostly used to initialize a media * with gst_sdp_media_new(). This function is mostly used to initialize a media
@ -1910,16 +1906,12 @@ gst_sdp_media_free (GstSDPMedia * media)
GstSDPResult GstSDPResult
gst_sdp_media_copy (const GstSDPMedia * media, GstSDPMedia ** copy) gst_sdp_media_copy (const GstSDPMedia * media, GstSDPMedia ** copy)
{ {
GstSDPResult ret;
GstSDPMedia *cp; GstSDPMedia *cp;
guint i, len; guint i, len;
if (media == NULL) g_return_val_if_fail (media != NULL, GST_SDP_EINVAL);
return GST_SDP_EINVAL;
ret = gst_sdp_media_new (copy); gst_sdp_media_new (copy);
if (ret != GST_SDP_OK)
return ret;
cp = *copy; cp = *copy;
@ -1966,7 +1958,7 @@ gst_sdp_media_copy (const GstSDPMedia * media, GstSDPMedia ** copy)
* *
* Convert the contents of @media to a text string. * Convert the contents of @media to a text string.
* *
* Returns: A dynamically allocated string representing the media. * Returns: (transfer full): A dynamically allocated string representing the media.
*/ */
gchar * gchar *
gst_sdp_media_as_text (const GstSDPMedia * media) gst_sdp_media_as_text (const GstSDPMedia * media)
@ -2803,7 +2795,7 @@ gst_sdp_media_get_attribute (const GstSDPMedia * media, guint idx)
* *
* Get the @nth attribute value for @key in @media. * Get the @nth attribute value for @key in @media.
* *
* Returns: the @nth attribute value. * Returns: (nullable): the @nth attribute value.
*/ */
const gchar * const gchar *
gst_sdp_media_get_attribute_val_n (const GstSDPMedia * media, const gchar * key, gst_sdp_media_get_attribute_val_n (const GstSDPMedia * media, const gchar * key,
@ -2835,7 +2827,7 @@ gst_sdp_media_get_attribute_val_n (const GstSDPMedia * media, const gchar * key,
* *
* Get the first attribute value for @key in @media. * Get the first attribute value for @key in @media.
* *
* Returns: the first attribute value for @key. * Returns: (nullable): the first attribute value for @key.
*/ */
const gchar * const gchar *
gst_sdp_media_get_attribute_val (const GstSDPMedia * media, const gchar * key) gst_sdp_media_get_attribute_val (const GstSDPMedia * media, const gchar * key)
@ -3129,7 +3121,7 @@ gst_sdp_parse_line (SDPContext * c, gchar type, gchar * buffer)
* gst_sdp_message_parse_buffer: * gst_sdp_message_parse_buffer:
* @data: (array length=size): the start of the buffer * @data: (array length=size): the start of the buffer
* @size: the size of the buffer * @size: the size of the buffer
* @msg: the result #GstSDPMessage * @msg: (out caller-allocates): the result #GstSDPMessage
* *
* Parse the contents of @size bytes pointed to by @data and store the result in * Parse the contents of @size bytes pointed to by @data and store the result in
* @msg. * @msg.
@ -3585,7 +3577,7 @@ gst_sdp_media_caps_adjust_h264 (GstCaps * caps)
* *
* Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attributes_to_caps(). * Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attributes_to_caps().
* *
* Returns: a #GstCaps, or %NULL if an error happened * Returns: (transfer full) (nullable): a #GstCaps, or %NULL if an error happened
* *
* Since: 1.8 * Since: 1.8
*/ */
@ -3774,7 +3766,7 @@ no_rate:
/** /**
* gst_sdp_media_set_media_from_caps: * gst_sdp_media_set_media_from_caps:
* @caps: a #GstCaps * @caps: a #GstCaps
* @media: a #GstSDPMedia * @media: (out caller-allocates): a #GstSDPMedia
* *
* Mapping of caps to SDP fields: * Mapping of caps to SDP fields:
* *