tests: basesrc: unref gst_bus_timed_pop_filtered return
[platform/upstream/gstreamer.git] / gst / gsttocsetter.c
index 6ecde13..c746f23 100644 (file)
  *
  * 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.
  */
 
 /**
  * SECTION:gsttocsetter
+ * @title: GstTocSetter
  * @short_description: Element interface that allows setting and retrieval
  *                     of the TOC
  *
  *
  * Elements that support some kind of chapters or editions (or tracks like in
  * the FLAC cue sheet) will implement this interface.
- * 
+ *
  * If you just want to retrieve the TOC in your application then all you
  * need to do is watch for TOC messages on your pipeline's bus (or you can
  * perform TOC query). This interface is only for setting TOC data, not for
  * extracting it. To set TOC from the application, find proper tocsetter element
  * and set TOC using gst_toc_setter_set_toc().
- * 
+ *
  * Elements implementing the #GstTocSetter interface can extend existing TOC
  * by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it)
  * with any TOC entries received from downstream.
@@ -106,29 +107,18 @@ gst_toc_setter_get_data (GstTocSetter * setter)
 }
 
 /**
- * gst_toc_setter_reset_toc:
+ * gst_toc_setter_reset:
  * @setter: a #GstTocSetter.
  *
  * Reset the internal TOC. Elements should call this from within the
  * state-change handler.
- *
- * Since: 0.10.37
  */
 void
-gst_toc_setter_reset_toc (GstTocSetter * setter)
+gst_toc_setter_reset (GstTocSetter * setter)
 {
-  GstTocData *data;
-
   g_return_if_fail (GST_IS_TOC_SETTER (setter));
 
-  data = gst_toc_setter_get_data (setter);
-
-  g_mutex_lock (&data->lock);
-  if (data->toc) {
-    gst_toc_unref (data->toc);
-    data->toc = NULL;
-  }
-  g_mutex_unlock (&data->lock);
+  gst_toc_setter_set_toc (setter, NULL);
 }
 
 /**
@@ -136,39 +126,13 @@ gst_toc_setter_reset_toc (GstTocSetter * setter)
  * @setter: a #GstTocSetter.
  *
  * Return current TOC the setter uses. The TOC should not be
- * modified or freed.
- *
- * This function is not thread-safe. Use gst_toc_setter_get_toc_copy() instead.
+ * modified without making it writable first.
  *
- * Returns: a current snapshot of the TOC used in the setter
- *          or NULL if none is used.
- *
- * Since: 0.10.37
- */
-const GstToc *
-gst_toc_setter_get_toc (GstTocSetter * setter)
-{
-  g_return_val_if_fail (GST_IS_TOC_SETTER (setter), NULL);
-
-  return gst_toc_setter_get_data (setter)->toc;
-}
-
-/**
- * gst_toc_setter_get_toc_copy:
- * @setter: a #GstTocSetter.
- *
- * Return current TOC the setter uses. The difference between this
- * function and gst_toc_setter_get_toc() is that this function returns deep
- * copy of the TOC, so you can modify it in any way. This function is thread-safe.
- * Free it when done with gst_toc_unref().
- *
- * Returns: a copy of the current snapshot of the TOC used in the setter
- *          or NULL if none is used.
- *
- * Since: 0.10.37
+ * Returns: (transfer full) (nullable): TOC set, or %NULL. Unref with
+ *     gst_toc_unref() when no longer needed
  */
 GstToc *
-gst_toc_setter_get_toc_copy (GstTocSetter * setter)
+gst_toc_setter_get_toc (GstTocSetter * setter)
 {
   GstTocData *data;
   GstToc *ret = NULL;
@@ -179,7 +143,7 @@ gst_toc_setter_get_toc_copy (GstTocSetter * setter)
   g_mutex_lock (&data->lock);
 
   if (data->toc != NULL)
-    ret = gst_toc_copy (data->toc);
+    ret = gst_toc_ref (data->toc);
 
   g_mutex_unlock (&data->lock);
 
@@ -189,15 +153,13 @@ gst_toc_setter_get_toc_copy (GstTocSetter * setter)
 /**
  * gst_toc_setter_set_toc:
  * @setter: a #GstTocSetter.
- * @toc: a #GstToc to set.
- *
- * Set the given TOC on the setter. Previously setted TOC will be
- * freed before setting a new one.
+ * @toc: (allow-none): a #GstToc to set.
  *
- * Since: 0.10.37
+ * Set the given TOC on the setter. Previously set TOC will be
+ * unreffed before setting a new one.
  */
 void
-gst_toc_setter_set_toc (GstTocSetter * setter, const GstToc * toc)
+gst_toc_setter_set_toc (GstTocSetter * setter, GstToc * toc)
 {
   GstTocData *data;
 
@@ -206,131 +168,13 @@ gst_toc_setter_set_toc (GstTocSetter * setter, const GstToc * toc)
   data = gst_toc_setter_get_data (setter);
 
   g_mutex_lock (&data->lock);
-  if (data->toc)
-    gst_toc_unref (data->toc);
-
-  data->toc = gst_toc_copy (toc);
-
-  g_mutex_unlock (&data->lock);
-}
-
-/**
- * gst_toc_setter_get_toc_entry:
- * @setter: a #GstTocSetter.
- * @uid: UID to find entry with.
- *
- * Return #GstTocEntry (if any) with given @uid. Returned entry should
- * not be modified or freed.
- *
- * This function is not thread-safe. Use gst_toc_setter_get_toc_entry_copy() instead.
- *
- * Returns: a TOC entry with given @uid from the TOC in the setter
- *          or NULL if none entry with such @uid was found.
- *
- * Since: 0.10.37
- */
-const GstTocEntry *
-gst_toc_setter_get_toc_entry (GstTocSetter * setter, const gchar * uid)
-{
-  GstTocData *data;
-  const GstTocEntry *ret;
-
-  g_return_val_if_fail (GST_IS_TOC_SETTER (setter), NULL);
-  g_return_val_if_fail (uid != NULL, NULL);
-
-  data = gst_toc_setter_get_data (setter);
-
-  g_mutex_lock (&data->lock);
-
-  ret = gst_toc_find_entry (data->toc, uid);
-
-  g_mutex_unlock (&data->lock);
-
-  return ret;
-}
-
-/**
- * gst_toc_setter_get_toc_entry_copy:
- * @setter: a #GstTocSetter.
- * @uid: UID to find entry with.
- *
- * Return #GstTocEntry (if any) with given @uid. It perform a deep copying,
- * so you can modify returned value. Free it when done with gst_toc_entry_free().
- * This function is thread-safe.
- *
- * Returns: a TOC entry with given @uid from the TOC in the setter
- *          or NULL if none entry with such @uid was found.
- *
- * Since: 0.10.37
- */
-GstTocEntry *
-gst_toc_setter_get_toc_entry_copy (GstTocSetter * setter, const gchar * uid)
-{
-  GstTocData *data;
-  GstTocEntry *ret = NULL;
-  const GstTocEntry *search;
-
-  g_return_val_if_fail (GST_IS_TOC_SETTER (setter), NULL);
-  g_return_val_if_fail (uid != NULL, NULL);
-
-  data = gst_toc_setter_get_data (setter);
-
-  g_mutex_lock (&data->lock);
 
-  search = gst_toc_find_entry (data->toc, uid);
-  if (search != NULL)
-    ret = gst_toc_entry_copy (search);
+  if (data->toc != toc) {
+    if (data->toc)
+      gst_toc_unref (data->toc);
 
-  g_mutex_unlock (&data->lock);
-
-  return ret;
-}
-
-/**
- * gst_toc_setter_add_toc_entry:
- * @setter: a #GstTocSetter.
- * @parent_uid: UID of the parent entry to append given @entry. Use 0 for the TOC root level.
- * @entry: #GstTocEntry to append.
- *
- * Try to find entry with given @parent_uid and append an @entry to that #GstTocEntry.
- *
- * Returns: TRUE if entry with @parent_uid was found, FALSE otherwise.
- *
- * Since: 0.10.37
- */
-gboolean
-gst_toc_setter_add_toc_entry (GstTocSetter * setter, const gchar * parent_uid,
-    const GstTocEntry * entry)
-{
-  GstTocData *data;
-  GstTocEntry *parent;
-  GstTocEntry *copy_entry;
-  gboolean ret = FALSE;
-
-  g_return_val_if_fail (GST_IS_TOC_SETTER (setter), FALSE);
-  g_return_val_if_fail (parent_uid != NULL, FALSE);
-  g_return_val_if_fail (entry != NULL, FALSE);
-
-  data = gst_toc_setter_get_data (setter);
-
-  g_mutex_lock (&data->lock);
-
-  copy_entry = gst_toc_entry_copy (entry);
-
-  if (g_strcmp0 (parent_uid, "0") == 0) {
-    if (data->toc == NULL)
-      data->toc = gst_toc_new ();
-    data->toc->entries = g_list_append (data->toc->entries, copy_entry);
-  } else {
-    parent = gst_toc_find_entry (data->toc, parent_uid);
-
-    if (parent != NULL) {
-      parent->subentries = g_list_append (parent->subentries, copy_entry);
-      ret = TRUE;
-    }
+    data->toc = (toc) ? gst_toc_ref (toc) : NULL;
   }
 
   g_mutex_unlock (&data->lock);
-
-  return ret;
 }