element: remove inactive pad g_warning in add_pad

[platform/upstream/gstreamer.git] / gst / gstbufferlist.h

diff --git a/gst/gstbufferlist.h b/gst/gstbufferlist.h
index 4b0dfeb..ce9fe11 100644 (file)
--- a/gst/gstbufferlist.h
+++ b/gst/gstbufferlist.h
@@ -16,8 +16,8 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 #ifndef __GST_BUFFER_LIST_H__
@@ -27,7 +27,7 @@
 
 G_BEGIN_DECLS
 
-GST_EXPORT GType _gst_buffer_list_type;
+GST_API GType _gst_buffer_list_type;
 
 #define GST_TYPE_BUFFER_LIST      (_gst_buffer_list_type)
 #define GST_IS_BUFFER_LIST(obj)   (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_BUFFER_LIST))
@@ -38,7 +38,7 @@ typedef struct _GstBufferList GstBufferList;
 
 /**
  * GstBufferListFunc:
- * @buffer: pointer the buffer
+ * @buffer: (out) (nullable): pointer the buffer
  * @idx: the index of @buffer
  * @user_data: user data passed to gst_buffer_list_foreach()
  *
@@ -48,7 +48,7 @@ typedef struct _GstBufferList GstBufferList;
  * When this function returns %TRUE, the next buffer will be
  * returned. When %FALSE is returned, gst_buffer_list_foreach() will return.
  *
- * When @buffer is set to NULL, the item will be removed from the bufferlist.
+ * When @buffer is set to %NULL, the item will be removed from the bufferlist.
  * When @buffer has been made writable, the new buffer reference can be assigned
  * to @buffer. This function is responsible for unreffing the old buffer when
  * removing or modifying.
@@ -66,19 +66,13 @@ typedef gboolean   (*GstBufferListFunc)   (GstBuffer **buffer, guint idx,
  *
  * Increases the refcount of the given buffer list by one.
  *
- * Note that the refcount affects the writeability of @list and its data, see
+ * Note that the refcount affects the writability of @list and its data, see
  * gst_buffer_list_make_writable(). It is important to note that keeping
  * additional references to GstBufferList instances can potentially increase
  * the number of memcpy operations in a pipeline.
  *
  * Returns: (transfer full): @list
- *
- * Since: 0.10.24
  */
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstBufferList * gst_buffer_list_ref (GstBufferList * list);
-#endif
-
 static inline GstBufferList *
 gst_buffer_list_ref (GstBufferList * list)
 {
@@ -92,13 +86,7 @@ gst_buffer_list_ref (GstBufferList * list)
  *
  * Decreases the refcount of the buffer list. If the refcount reaches 0, the
  * buffer list will be freed.
- *
- * Since: 0.10.24
  */
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC void gst_buffer_list_unref (GstBufferList * list);
-#endif
-
 static inline void
 gst_buffer_list_unref (GstBufferList * list)
 {
@@ -115,13 +103,7 @@ gst_buffer_list_unref (GstBufferList * list)
  * refcount of buffers pointed to will be increased by one.
  *
  * Returns: (transfer full): a new copy of @list.
- *
- * Since: 0.10.24
  */
-#ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstBufferList * gst_buffer_list_copy (const GstBufferList * list);
-#endif
-
 static inline GstBufferList *
 gst_buffer_list_copy (const GstBufferList * list)
 {
@@ -133,8 +115,6 @@ gst_buffer_list_copy (const GstBufferList * list)
  * @list: a #GstBufferList
  *
  * Tests if you can safely add buffers and groups into a buffer list.
- *
- * Since: 0.10.24
  */
 #define gst_buffer_list_is_writable(list) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (list))
 
@@ -148,29 +128,51 @@ gst_buffer_list_copy (const GstBufferList * list)
  *
  * Returns: (transfer full): a writable list, which may or may not be the
  *     same as @list
- *
- * Since: 0.10.24
  */
 #define gst_buffer_list_make_writable(list) GST_BUFFER_LIST_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (list)))
 
+GST_API
 GType                    gst_buffer_list_get_type              (void);
 
 /* allocation */
+
+GST_API
 GstBufferList *          gst_buffer_list_new                   (void) G_GNUC_MALLOC;
+
+GST_API
 GstBufferList *          gst_buffer_list_new_sized             (guint size) G_GNUC_MALLOC;
 
+GST_API
 guint                    gst_buffer_list_length                (GstBufferList *list);
 
+GST_API
 GstBuffer *              gst_buffer_list_get                   (GstBufferList *list, guint idx);
-void                     gst_buffer_list_insert                (GstBufferList *list, guint idx, GstBuffer *buffer);
+
+GST_API
+GstBuffer *              gst_buffer_list_get_writable          (GstBufferList *list, guint idx);
+
+GST_API
+void                     gst_buffer_list_insert                (GstBufferList *list, gint idx, GstBuffer *buffer);
+
+GST_API
 void                     gst_buffer_list_remove                (GstBufferList *list, guint idx, guint length);
 
-void                     gst_buffer_list_foreach               (GstBufferList *list,
+GST_API
+gboolean                 gst_buffer_list_foreach               (GstBufferList *list,
                                                                 GstBufferListFunc func,
                                                                gpointer user_data);
+GST_API
+GstBufferList *          gst_buffer_list_copy_deep             (const GstBufferList * list);
+
+GST_API
+gsize                    gst_buffer_list_calculate_size        (GstBufferList * list);
 
 #define gst_buffer_list_add(l,b) gst_buffer_list_insert((l),-1,(b));
 
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBufferList, gst_buffer_list_unref)
+#endif
+
 G_END_DECLS
 
 #endif /* __GST_BUFFER_LIST_H__ */