]> git.sesse.net Git - vlc/blobdiff - src/playlist/engine.c
Playlist: put private data after public data
[vlc] / src / playlist / engine.c
index 93b3bcd4c70ea4d1062b5828b7f03870bfb53cbd..7e0493528422642d15edb5f4f8ccc0e461260fa6 100644 (file)
@@ -25,6 +25,7 @@
 # include "config.h"
 #endif
 
+#include <stddef.h>
 #include <assert.h>
 #include <vlc_common.h>
 #include <vlc_sout.h>
@@ -38,7 +39,6 @@
  *****************************************************************************/
 static void VariablesInit( playlist_t *p_playlist );
 static void playlist_Destructor( vlc_object_t * p_this );
-static void playlist_Destructor( vlc_object_t * p_this );
 
 static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
                            vlc_value_t oldval, vlc_value_t newval, void *a )
@@ -61,14 +61,17 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
 {
     static const char playlist_name[] = "playlist";
     playlist_t *p_playlist;
+    playlist_private_t *p;
     bool b_save;
 
     /* Allocate structure */
-    p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
-                                    VLC_OBJECT_GENERIC, playlist_name );
-    if( !p_playlist )
+    p = vlc_custom_create( p_parent, sizeof( *p ),
+                           VLC_OBJECT_GENERIC, playlist_name );
+    if( !p )
         return NULL;
 
+    assert( offsetof( playlist_private_t, public_data ) == 0 );
+    p_playlist = &p->public_data;
     TAB_INIT( p_playlist->i_sds, p_playlist->pp_sds );
 
     libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
@@ -76,7 +79,6 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     VariablesInit( p_playlist );
 
     /* Initialise data structures */
-    vlc_mutex_init( &p_playlist->gc_lock );
     p_playlist->i_last_playlist_id = 0;
     p_playlist->p_input = NULL;
 
@@ -85,6 +87,7 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
 
     ARRAY_INIT( p_playlist->items );
     ARRAY_INIT( p_playlist->all_items );
+    ARRAY_INIT( p_playlist->items_to_delete );
     ARRAY_INIT( p_playlist->current );
 
     p_playlist->i_current_index = 0;
@@ -98,18 +101,22 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     p_playlist->b_auto_preparse =
                         var_CreateGetBool( p_playlist, "auto-preparse" ) ;
 
+    PL_LOCK; /* playlist_NodeCreate will check for it */
     p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
                                     0, NULL );
     p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
                                     0, p_playlist->p_root_category->p_input );
+    PL_UNLOCK;
 
     if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
         return NULL;
 
     /* Create playlist and media library */
+    PL_LOCK; /* playlist_NodesPairCreate will check for it */
     playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
                             &p_playlist->p_local_category,
                             &p_playlist->p_local_onelevel, false );
+    PL_UNLOCK;
 
     p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
     p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
@@ -121,9 +128,11 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
 
     if( config_GetInt( p_playlist, "media-library") )
     {
+        PL_LOCK; /* playlist_NodesPairCreate will check for it */
         playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
                             &p_playlist->p_ml_category,
                             &p_playlist->p_ml_onelevel, false );
+        PL_UNLOCK;
 
         if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
             return NULL;
@@ -167,15 +176,28 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
 static void playlist_Destructor( vlc_object_t * p_this )
 {
     playlist_t * p_playlist = (playlist_t *)p_this;
+    playlist_preparse_t *p_preparse = &pl_priv(p_playlist)->preparse;
 
-    if( p_playlist->p_preparse )
-        vlc_object_release( p_playlist->p_preparse );
+    /* Destroy the item preparser */
+    if (p_preparse->up)
+    {
+        vlc_cancel (p_preparse->thread);
+        vlc_join (p_preparse->thread, NULL);
+    }
+    while (p_preparse->i_waiting > 0)
+    {   /* Any left-over unparsed item? */
+        vlc_gc_decref (p_preparse->pp_waiting[0]);
+        REMOVE_ELEM (p_preparse->pp_waiting, p_preparse->i_waiting, 0);
+    }
+    vlc_cond_destroy (&p_preparse->wait);
+    vlc_mutex_destroy (&p_preparse->lock);
 
-    if( p_playlist->p_fetcher )
-        vlc_object_release( p_playlist->p_fetcher );
-#ifndef NDEBUG
-    libvlc_priv (p_this->p_libvlc)->p_playlist = NULL; /* pl_Yield() will fail */
-#endif
+    /* Destroy the item meta-infos fetcher */
+    if( pl_priv(p_playlist)->p_fetcher )
+    {
+        vlc_object_release( pl_priv(p_playlist)->p_fetcher );
+    }
+    msg_Dbg( p_this, "Destroyed" );
 }
 
 /* Destroy remaining objects */
@@ -192,9 +214,7 @@ static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
             return;
     }
 
-    vlc_mutex_lock( &p_playlist->gc_lock );
     p_playlist->b_cant_sleep = false;
-    vlc_mutex_unlock( &p_playlist->gc_lock );
 }
 
 /* Input Callback */
@@ -219,7 +239,7 @@ static void input_selected_stream_changed( const vlc_event_t * event, void * dat
 /* Internals */
 void playlist_release_current_input( playlist_t * p_playlist )
 {
-    vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
+    PL_ASSERT_LOCKED;
 
     if( !p_playlist->p_input ) return;
 
@@ -235,6 +255,7 @@ void playlist_release_current_input( playlist_t * p_playlist )
     /* Release the playlist lock, because we may get stuck
      * in vlc_object_release() for some time. */
     PL_UNLOCK;
+    vlc_thread_join( p_input );
     vlc_object_release( p_input );
     PL_LOCK;
 }
@@ -242,7 +263,7 @@ void playlist_release_current_input( playlist_t * p_playlist )
 void playlist_set_current_input(
     playlist_t * p_playlist, input_thread_t * p_input )
 {
-    vlc_assert_locked( &(vlc_internals(p_playlist)->lock) );
+    PL_ASSERT_LOCKED;
 
     playlist_release_current_input( p_playlist );
 
@@ -258,15 +279,73 @@ void playlist_set_current_input(
     }
 }
 
+/** Get current playing input.
+ */
+input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
+{
+    input_thread_t * p_input;
+    PL_LOCK;
+    p_input = p_playlist->p_input;
+    if( p_input ) vlc_object_yield( p_input );
+    PL_UNLOCK;
+    return p_input;
+}
 
 /**
  * @}
  */
 
+/** Accessor for status item and status nodes.
+ */
+playlist_item_t * get_current_status_item( playlist_t * p_playlist )
+{
+    PL_ASSERT_LOCKED;
+
+    return p_playlist->status.p_item;
+}
+
+playlist_item_t * get_current_status_node( playlist_t * p_playlist )
+{
+    PL_ASSERT_LOCKED;
+
+    return p_playlist->status.p_node;
+}
+
+void set_current_status_item( playlist_t * p_playlist,
+    playlist_item_t * p_item )
+{
+    PL_ASSERT_LOCKED;
+
+    if( p_playlist->status.p_item &&
+        p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
+        p_playlist->status.p_item != p_item )
+    {
+        /* It's unsafe given current design to delete a playlist item :(
+        playlist_ItemDelete( p_playlist->status.p_item ); */
+    }
+    p_playlist->status.p_item = p_item;
+}
+
+void set_current_status_node( playlist_t * p_playlist,
+    playlist_item_t * p_node )
+{
+    PL_ASSERT_LOCKED;
+
+    if( p_playlist->status.p_node &&
+        p_playlist->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
+        p_playlist->status.p_node != p_node )
+    {
+        /* It's unsafe given current design to delete a playlist item :(
+        playlist_ItemDelete( p_playlist->status.p_node ); */
+    }
+    p_playlist->status.p_node = p_node;
+}
+
 /**
  * Main loop
  *
- * Main loop for the playlist
+ * Main loop for the playlist. It should be entered with the
+ * playlist lock (otherwise input event may be lost)
  * \param p_playlist the playlist object
  * \return nothing
  */
@@ -274,13 +353,14 @@ void playlist_MainLoop( playlist_t *p_playlist )
 {
     playlist_item_t *p_item = NULL;
     bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
-    PL_LOCK;
+
+    PL_ASSERT_LOCKED;
 
     if( p_playlist->b_reset_currently_playing &&
         mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
     {
         ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
-                             p_playlist->status.p_item );
+                               get_current_status_item( p_playlist ) );
         p_playlist->last_rebuild_date = mdate();
     }
 
@@ -299,8 +379,7 @@ check_input:
         {
             int i_activity;
             input_thread_t *p_input;
-            sout_instance_t **pp_sout =
-                &libvlc_priv(p_playlist->p_libvlc)->p_sout;
+            sout_instance_t **pp_sout = &pl_priv(p_playlist)->p_sout;
 
             PL_DEBUG( "dead input" );
 
@@ -316,17 +395,6 @@ check_input:
             p_playlist->gc_date = mdate();
             p_playlist->b_cant_sleep = true;
 
-            if( p_playlist->status.p_item->i_flags
-                & PLAYLIST_REMOVE_FLAG )
-            {
-                 PL_DEBUG( "%s was marked for deletion, deleting",
-                                 PLI_NAME( p_playlist->status.p_item  ) );
-                 playlist_ItemDelete( p_playlist->status.p_item );
-                 if( p_playlist->request.p_item == p_playlist->status.p_item )
-                     p_playlist->request.p_item = NULL;
-                 p_playlist->status.p_item = NULL;
-            }
-
             i_activity= var_GetInteger( p_playlist, "activity" );
             var_SetInteger( p_playlist, "activity", i_activity -
                             DEFAULT_INPUT_ACTIVITY );
@@ -353,9 +421,7 @@ check_input:
         }
         else if( p_playlist->p_input->i_state != INIT_S )
         {
-            PL_UNLOCK;
             ObjectGarbageCollector( p_playlist, false );
-            PL_LOCK;
         }
     }
     else
@@ -377,7 +443,6 @@ check_input:
             {
                 msg_Dbg( p_playlist, "nothing to play" );
                 p_playlist->status.i_status = PLAYLIST_STOPPED;
-                PL_UNLOCK;
 
                 if( b_playexit == true )
                 {
@@ -386,29 +451,21 @@ check_input:
                 }
                 ObjectGarbageCollector( p_playlist, true );
                 return;
-             }
-             playlist_PlayItem( p_playlist, p_item );
-         }
-         else
-         {
+            }
+            playlist_PlayItem( p_playlist, p_item );
+            /* playlist_PlayItem loose input event, we need to recheck */
+            goto check_input;
+        }
+        else
+        {
             const bool b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
 
             p_playlist->status.i_status = PLAYLIST_STOPPED;
-            if( p_playlist->status.p_item &&
-                p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
-            {
-                PL_DEBUG( "deleting item marked for deletion" );
-                playlist_ItemDelete( p_playlist->status.p_item );
-                p_playlist->status.p_item = NULL;
-            }
 
             /* Collect garbage */
-            PL_UNLOCK;
             ObjectGarbageCollector( p_playlist, b_gc_forced );
-            PL_LOCK;
         }
     }
-    PL_UNLOCK;
 }
 
 /**
@@ -463,7 +520,7 @@ void playlist_LastLoop( playlist_t *p_playlist )
 
 #ifdef ENABLE_SOUT
     /* close the remaining sout-keep (if there was no input atm) */
-    sout_instance_t *p_sout = libvlc_priv (p_playlist->p_libvlc)->p_sout;
+    sout_instance_t *p_sout = pl_priv(p_playlist)->p_sout;
     if (p_sout)
         sout_DeleteInstance( p_sout );
 #endif
@@ -473,13 +530,29 @@ void playlist_LastLoop( playlist_t *p_playlist )
     playlist_ServicesDiscoveryKillAll( p_playlist );
     playlist_MLDump( p_playlist );
 
+    vlc_object_kill( pl_priv(p_playlist)->p_fetcher );
+    vlc_thread_join( pl_priv(p_playlist)->p_fetcher );
+
     PL_LOCK;
+
+    /* Release the current node */
+    set_current_status_node( p_playlist, NULL );
+
+    /* Release the current item */
+    set_current_status_item( p_playlist, NULL );
+
     FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
         free( p_del->pp_children );
         vlc_gc_decref( p_del->p_input );
         free( p_del );
     FOREACH_END();
     ARRAY_RESET( p_playlist->all_items );
+    FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->items_to_delete )
+        free( p_del->pp_children );
+        vlc_gc_decref( p_del->p_input );
+        free( p_del );
+    FOREACH_END();
+    ARRAY_RESET( p_playlist->items_to_delete );
 
     ARRAY_RESET( p_playlist->items );
     ARRAY_RESET( p_playlist->current );
@@ -488,35 +561,36 @@ void playlist_LastLoop( playlist_t *p_playlist )
 }
 
 /**
- * Preparse loop
+ * Preparse queue loop
  *
- * Main loop for preparser queue
- * \param p_obj items to preparse
- * \return nothing
+ * @param p_obj preparse structure
+ * @return never
  */
-void playlist_PreparseLoop( playlist_preparse_t *p_obj )
+void *playlist_PreparseLoop( void *data )
 {
-    playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
-    input_item_t *p_current;
+    playlist_preparse_t *p_preparse = data;
+    playlist_t *p_playlist = &((playlist_private_t *)(((char *)p_preparse)
+             - offsetof(playlist_private_t, preparse)))->public_data;
     int i_activity;
 
-    vlc_object_lock( p_obj );
-
-    while( vlc_object_alive( p_obj ) )
+    for( ;; )
     {
-        if( p_obj->i_waiting == 0 )
-        {
-            vlc_object_wait( p_obj );
-            continue;
-        }
+        input_item_t *p_current;
 
-        p_current = p_obj->pp_waiting[0];
-        REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
-        vlc_object_unlock( p_obj );
+        vlc_mutex_lock( &p_preparse->lock );
+        mutex_cleanup_push( &p_preparse->lock );
+
+        while( p_preparse->i_waiting == 0 )
+            vlc_cond_wait( &p_preparse->wait, &p_preparse->lock );
+
+        p_current = p_preparse->pp_waiting[0];
+        REMOVE_ELEM( p_preparse->pp_waiting, p_preparse->i_waiting, 0 );
+        vlc_cleanup_run( );
 
-        PL_LOCK;
         if( p_current )
         {
+            int canc = vlc_savecancel ();
+            PL_LOCK;
             if( p_current->i_type == ITEM_TYPE_FILE )
             {
                 stats_TimerStart( p_playlist, "Preparse run",
@@ -541,16 +615,21 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
              */
             char *psz_arturl = input_item_GetArtURL( p_current );
             char *psz_name = input_item_GetName( p_current );
-            if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
-                        ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
+            playlist_fetcher_t *p_fetcher = pl_priv(p_playlist)->p_fetcher;
+            if( p_fetcher->i_art_policy == ALBUM_ART_ALL &&
+                ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
             {
                 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
-                vlc_object_lock( p_playlist->p_fetcher );
-                INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
-                             p_playlist->p_fetcher->i_waiting,
-                             p_playlist->p_fetcher->i_waiting, p_current);
-                vlc_object_signal_unlocked( p_playlist->p_fetcher );
-                vlc_object_unlock( p_playlist->p_fetcher );
+                vlc_object_lock( p_fetcher );
+                if( vlc_object_alive( p_fetcher ) )
+                {
+                    INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
+                                 p_fetcher->i_waiting, p_current);
+                    vlc_object_signal_unlocked( p_fetcher );
+                }
+                else
+                    vlc_gc_decref( p_current );
+                vlc_object_unlock( p_fetcher );
             }
             else
             {
@@ -560,20 +639,18 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
             }
             free( psz_name );
             free( psz_arturl );
-            PL_UNLOCK;
+           PL_UNLOCK;
+            vlc_restorecancel( canc );
         }
-        else
-            PL_UNLOCK;
 
-        vlc_object_lock( p_obj );
         i_activity = var_GetInteger( p_playlist, "activity" );
         if( i_activity < 0 ) i_activity = 0;
-        vlc_object_unlock( p_obj );
         /* Sleep at least 1ms */
         msleep( (i_activity+1) * 1000 );
-        vlc_object_lock( p_obj );
     }
-    vlc_object_unlock( p_obj );
+
+    assert( 0 );
+    return NULL;
 }
 
 /**
@@ -654,6 +731,13 @@ void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
         msleep( (i_activity+1) * 1000 );
         vlc_object_lock( p_obj );
     }
+
+    while( p_obj->i_waiting > 0 )
+    {
+        vlc_gc_decref( p_obj->pp_waiting[0] );
+        REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
+    }
+
     vlc_object_unlock( p_obj );
 }