Port gtk-doc comments to their equivalent markdown syntax

[platform/upstream/gstreamer.git] / gst / gstsample.c

diff --git a/gst/gstsample.c b/gst/gstsample.c
index 9517af0..219db6b 100644 (file)
--- a/gst/gstsample.c
+++ b/gst/gstsample.c
@@ -21,13 +21,12 @@
 
 /**
  * SECTION:gstsample
+ * @title: GstSample
  * @short_description: A media sample
  * @see_also: #GstBuffer, #GstCaps, #GstSegment
  *
  * A #GstSample is a small object containing data, a type, timing and
  * extra arbitrary information.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
  */
 #include "gst_private.h"
 
@@ -44,6 +43,7 @@ struct _GstSample
   GstCaps *caps;
   GstSegment segment;
   GstStructure *info;
+  GstBufferList *buffer_list;
 };
 
 GType _gst_sample_type = 0;
@@ -66,6 +66,10 @@ _gst_sample_copy (GstSample * sample)
   copy = gst_sample_new (sample->buffer, sample->caps, &sample->segment,
       (sample->info) ? gst_structure_copy (sample->info) : NULL);
 
+  if (sample->buffer_list)
+    copy->buffer_list = (GstBufferList *)
+        gst_mini_object_ref (GST_MINI_OBJECT_CAST (sample->buffer_list));
+
   return copy;
 }
 
@@ -82,15 +86,18 @@ _gst_sample_free (GstSample * sample)
     gst_structure_set_parent_refcount (sample->info, NULL);
     gst_structure_free (sample->info);
   }
+  if (sample->buffer_list)
+    gst_mini_object_unref (GST_MINI_OBJECT_CAST (sample->buffer_list));
+
   g_slice_free1 (sizeof (GstSample), sample);
 }
 
 /**
  * gst_sample_new:
- * @buffer: (transfer none) (allow-none): a #GstBuffer, or NULL
- * @caps: (transfer none) (allow-none): a #GstCaps, or NULL
- * @segment: (transfer none) (allow-none): a #GstSegment, or NULL
- * @info: (transfer full) (allow-none): a #GstStructure, or NULL
+ * @buffer: (transfer none) (allow-none): a #GstBuffer, or %NULL
+ * @caps: (transfer none) (allow-none): a #GstCaps, or %NULL
+ * @segment: (transfer none) (allow-none): a #GstSegment, or %NULL
+ * @info: (transfer full) (allow-none): a #GstStructure, or %NULL
  *
  * Create a new #GstSample with the provided details.
  *
@@ -145,10 +152,10 @@ had_parent:
  *
  * Get the buffer associated with @sample
  *
- * Returns: (transfer none): the buffer of @sample or NULL when there
- *  is no buffer. The buffer remains valid as long as @sample is valid.
- *  If you need to hold on to it for longer than that, take a ref to
- *  the buffer with gst_buffer_ref().
+ * Returns: (transfer none) (nullable): the buffer of @sample or %NULL
+ *  when there is no buffer. The buffer remains valid as long as
+ *  @sample is valid.  If you need to hold on to it for longer than
+ *  that, take a ref to the buffer with gst_buffer_ref().
  */
 GstBuffer *
 gst_sample_get_buffer (GstSample * sample)
@@ -164,10 +171,10 @@ gst_sample_get_buffer (GstSample * sample)
  *
  * Get the caps associated with @sample
  *
- * Returns: (transfer none): the caps of @sample or NULL when there
- *  is no caps. The caps remain valid as long as @sample is valid.
- *  If you need to hold on to the caps for longer than that, take a ref to
- *  the caps with gst_caps_ref().
+ * Returns: (transfer none) (nullable): the caps of @sample or %NULL
+ *  when there is no caps. The caps remain valid as long as @sample is
+ *  valid.  If you need to hold on to the caps for longer than that,
+ *  take a ref to the caps with gst_caps_ref().
  */
 GstCaps *
 gst_sample_get_caps (GstSample * sample)
@@ -210,3 +217,46 @@ gst_sample_get_info (GstSample * sample)
 
   return sample->info;
 }
+
+/**
+ * gst_sample_get_buffer_list:
+ * @sample: a #GstSample
+ *
+ * Get the buffer list associated with @sample
+ *
+ * Returns: (transfer none) (nullable): the buffer list of @sample or %NULL
+ *  when there is no buffer list. The buffer list remains valid as long as
+ *  @sample is valid.  If you need to hold on to it for longer than
+ *  that, take a ref to the buffer list with gst_mini_object_ref ().
+ *
+ * Since: 1.6
+ */
+GstBufferList *
+gst_sample_get_buffer_list (GstSample * sample)
+{
+  g_return_val_if_fail (GST_IS_SAMPLE (sample), NULL);
+
+  return sample->buffer_list;
+}
+
+/**
+ * gst_sample_set_buffer_list:
+ * @sample: a #GstSample
+ * @buffer_list: a #GstBufferList
+ *
+ * Set the buffer list associated with @sample
+ *
+ * Since: 1.6
+ */
+void
+gst_sample_set_buffer_list (GstSample * sample, GstBufferList * buffer_list)
+{
+  GstBufferList *old = NULL;
+  g_return_if_fail (GST_IS_SAMPLE (sample));
+  old = sample->buffer_list;
+  sample->buffer_list = (GstBufferList *)
+      gst_mini_object_ref (GST_MINI_OBJECT_CAST (buffer_list));
+
+  if (old)
+    gst_mini_object_unref (GST_MINI_OBJECT_CAST (old));
+}