]> git.sesse.net Git - vlc/blobdiff - src/playlist/engine.c
playlist-tree has only 2 meaningful values now
[vlc] / src / playlist / engine.c
index a9327891194d24ba7aec4a71488e89ff8bbf181f..70e156012285562607cff4c516de46e278abef33 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
 #include <vlc/vlc.h>
 #include <vlc_vout.h>
 #include <vlc_sout.h>
  * Local prototypes
  *****************************************************************************/
 static void VariablesInit( playlist_t *p_playlist );
+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 )
 {
     (void)psz_cmd; (void)oldval; (void)newval; (void)a;
 
-    ((playlist_t*)p_this)->b_reset_currently_playing = VLC_TRUE;
+    ((playlist_t*)p_this)->b_reset_currently_playing = true;
     playlist_Signal( ((playlist_t*)p_this) );
     return VLC_SUCCESS;
 }
@@ -54,12 +59,13 @@ static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
  */
 playlist_t * playlist_Create( vlc_object_t *p_parent )
 {
+    static const char playlist_name[] = "playlist";
     playlist_t *p_playlist;
-    vlc_bool_t b_save;
-    int i_tree;
+    bool b_save;
 
     /* Allocate structure */
-    p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
+    p_playlist = vlc_custom_create( p_parent, sizeof( *p_playlist ),
+                                    VLC_OBJECT_PLAYLIST, playlist_name );
     if( !p_playlist )
     {
         msg_Err( p_parent, "out of memory" );
@@ -75,29 +81,25 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     /* Initialise data structures */
     vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
     p_playlist->i_last_playlist_id = 0;
-    p_playlist->i_last_input_id = 0;
     p_playlist->p_input = NULL;
 
     p_playlist->gc_date = 0;
-    p_playlist->b_cant_sleep = VLC_FALSE;
+    p_playlist->b_cant_sleep = false;
 
     ARRAY_INIT( p_playlist->items );
     ARRAY_INIT( p_playlist->all_items );
-    ARRAY_INIT( p_playlist->input_items );
     ARRAY_INIT( p_playlist->current );
 
     p_playlist->i_current_index = 0;
-    p_playlist->b_reset_currently_playing = VLC_TRUE;
+    p_playlist->b_reset_currently_playing = true;
     p_playlist->last_rebuild_date = 0;
 
-    i_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
-    p_playlist->b_always_tree = (i_tree == 1);
-    p_playlist->b_never_tree = (i_tree == 2);
+    p_playlist->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
 
-    p_playlist->b_doing_ml = VLC_FALSE;
+    p_playlist->b_doing_ml = false;
 
     p_playlist->b_auto_preparse =
-                        var_CreateGetBool( p_playlist, "auto-preparse") ;
+                        var_CreateGetBool( p_playlist, "auto-preparse" ) ;
 
     p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
                                     0, NULL );
@@ -110,7 +112,7 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     /* Create playlist and media library */
     playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
                             &p_playlist->p_local_category,
-                            &p_playlist->p_local_onelevel, VLC_FALSE );
+                            &p_playlist->p_local_onelevel, false );
 
     p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
     p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;
@@ -124,7 +126,7 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     {
         playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
                             &p_playlist->p_ml_category,
-                            &p_playlist->p_ml_onelevel, VLC_FALSE );
+                            &p_playlist->p_ml_onelevel, false );
 
         if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
             return NULL;
@@ -140,25 +142,37 @@ playlist_t * playlist_Create( vlc_object_t *p_parent )
     /* Initial status */
     p_playlist->status.p_item = NULL;
     p_playlist->status.p_node = p_playlist->p_local_onelevel;
-    p_playlist->request.b_request = VLC_FALSE;
+    p_playlist->request.b_request = false;
     p_playlist->status.i_status = PLAYLIST_STOPPED;
 
     p_playlist->i_sort = SORT_ID;
     p_playlist->i_order = ORDER_NORMAL;
 
+
     b_save = p_playlist->b_auto_preparse;
-    p_playlist->b_auto_preparse = VLC_FALSE;
+    p_playlist->b_auto_preparse = false;
     playlist_MLLoad( p_playlist );
-    p_playlist->b_auto_preparse = VLC_TRUE;
+    p_playlist->b_auto_preparse = true;
+
+    vlc_object_set_destructor( p_playlist, playlist_Destructor );
+
     return p_playlist;
 }
 
+/**
+ * Destroy playlist
+ *
+ * Destroy a playlist structure.
+ * \param p_playlist the playlist object
+ * \return nothing
+ */
 void playlist_Destroy( playlist_t *p_playlist )
 {
+    /* XXX: should go in the playlist destructor */
     var_Destroy( p_playlist, "intf-change" );
     var_Destroy( p_playlist, "item-change" );
     var_Destroy( p_playlist, "playlist-current" );
-    var_Destroy( p_playlist, "intf-popmenu" );
+    var_Destroy( p_playlist, "intf-popupmenu" );
     var_Destroy( p_playlist, "intf-show" );
     var_Destroy( p_playlist, "play-and-stop" );
     var_Destroy( p_playlist, "play-and-exit" );
@@ -167,13 +181,28 @@ void playlist_Destroy( playlist_t *p_playlist )
     var_Destroy( p_playlist, "loop" );
     var_Destroy( p_playlist, "activity" );
 
-    vlc_mutex_destroy( &p_playlist->gc_lock );
-    vlc_object_detach( p_playlist );
-    vlc_object_destroy( p_playlist );
+    vlc_object_release( p_playlist );
+}
+
+static void playlist_Destructor( vlc_object_t * p_this )
+{
+    playlist_t * p_playlist = (playlist_t *)p_this;
+
+    // Kill preparser
+    if( p_playlist->p_preparse )
+    {
+        vlc_object_release( p_playlist->p_preparse );
+    }
+
+    // Kill meta fetcher
+    if( p_playlist->p_fetcher )
+    {
+        vlc_object_release( p_playlist->p_fetcher );
+    }
 }
 
 /* Destroy remaining objects */
-static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
+static void ObjectGarbageCollector( playlist_t *p_playlist, bool b_force )
 {
     vlc_object_t *p_obj;
 
@@ -181,7 +210,7 @@ static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
     {
         if( mdate() - p_playlist->gc_date < 1000000 )
         {
-            p_playlist->b_cant_sleep = VLC_TRUE;
+            p_playlist->b_cant_sleep = true;
             return;
         }
         else if( p_playlist->gc_date == 0 )
@@ -189,10 +218,10 @@ static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
     }
 
     vlc_mutex_lock( &p_playlist->gc_lock );
-    while( ( p_obj = vlc_object_find( p_playlist, VLC_OBJECT_VOUT,
+    while( ( p_obj = vlc_object_find( p_playlist->p_libvlc, VLC_OBJECT_VOUT,
                                                   FIND_CHILD ) ) )
     {
-        if( p_obj->p_parent != VLC_OBJECT(p_playlist) )
+        if( p_obj->p_parent != VLC_OBJECT(p_playlist->p_libvlc) )
         {
             vlc_object_release( p_obj );
             break;
@@ -215,21 +244,27 @@ static void ObjectGarbageCollector( playlist_t *p_playlist, vlc_bool_t b_force )
         vlc_object_release( p_obj );
         sout_DeleteInstance( (sout_instance_t*)p_obj );
     }
-    p_playlist->b_cant_sleep = VLC_FALSE;
+    p_playlist->b_cant_sleep = false;
     vlc_mutex_unlock( &p_playlist->gc_lock );
 }
 
-/** Main loop for the playlist */
+/**
+ * Main loop
+ *
+ * Main loop for the playlist
+ * \param p_playlist the playlist object
+ * \return nothing
+ */
 void playlist_MainLoop( playlist_t *p_playlist )
 {
     playlist_item_t *p_item = NULL;
-    vlc_bool_t b_playexit = var_GetBool( p_playlist, "play-and-exit" );
+    bool b_playexit = var_GetBool( p_playlist, "play-and-exit" );
     PL_LOCK;
 
     if( p_playlist->b_reset_currently_playing &&
         mdate() - p_playlist->last_rebuild_date > 30000 ) // 30 ms
     {
-        ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random"),
+        ResetCurrentlyPlaying( p_playlist, var_GetBool( p_playlist, "random" ),
                              p_playlist->status.p_item );
         p_playlist->last_rebuild_date = mdate();
     }
@@ -255,16 +290,16 @@ check_input:
             p_playlist->p_input = NULL;
 
             /* Release the playlist lock, because we may get stuck
-             * in input_DestroyThread() for some time. */
+             * in vlc_object_release() for some time. */
             PL_UNLOCK;
 
             /* Destroy input */
-            input_DestroyThread( p_input );
+            vlc_object_release( p_input );
 
             PL_LOCK;
 
             p_playlist->gc_date = mdate();
-            p_playlist->b_cant_sleep = VLC_TRUE;
+            p_playlist->b_cant_sleep = true;
 
             if( p_playlist->status.p_item->i_flags
                 & PLAYLIST_REMOVE_FLAG )
@@ -277,7 +312,7 @@ check_input:
                  p_playlist->status.p_item = NULL;
             }
 
-            i_activity= var_GetInteger( p_playlist, "activity";
+            i_activity= var_GetInteger( p_playlist, "activity" );
             var_SetInteger( p_playlist, "activity", i_activity -
                             DEFAULT_INPUT_ACTIVITY );
             goto check_input;
@@ -303,7 +338,7 @@ check_input:
         else if( p_playlist->p_input->i_state != INIT_S )
         {
             PL_UNLOCK;
-            ObjectGarbageCollector( p_playlist, VLC_FALSE );
+            ObjectGarbageCollector( p_playlist, false );
             PL_LOCK;
         }
     }
@@ -314,34 +349,31 @@ check_input:
          *  - No request, stopped status -> collect garbage
          *  - Request, running requested -> start new item
          *  - Request, stopped requested -> collect garbage
-         */
-         if( (!p_playlist->request.b_request &&
-              p_playlist->status.i_status != PLAYLIST_STOPPED) ||
-              ( p_playlist->request.b_request &&
-                p_playlist->request.i_status != PLAYLIST_STOPPED ) )
-         {
-             msg_Dbg( p_playlist, "starting new item" );
-             p_item = playlist_NextItem( p_playlist );
+        */
+        if( p_playlist->request.i_status != PLAYLIST_STOPPED )
+        {
+            msg_Dbg( p_playlist, "starting new item" );
+            p_item = playlist_NextItem( p_playlist );
 
-             if( p_item == NULL )
-             {
+            if( p_item == NULL )
+            {
                 msg_Dbg( p_playlist, "nothing to play" );
                 p_playlist->status.i_status = PLAYLIST_STOPPED;
                 PL_UNLOCK;
 
-                if( b_playexit == VLC_TRUE )
+                if( b_playexit == true )
                 {
                     msg_Info( p_playlist, "end of playlist, exiting" );
                     vlc_object_kill( p_playlist->p_libvlc );
                 }
-                ObjectGarbageCollector( p_playlist, VLC_TRUE );
+                ObjectGarbageCollector( p_playlist, true );
                 return;
              }
              playlist_PlayItem( p_playlist, p_item );
          }
          else
          {
-            const vlc_bool_t b_gc_forced = p_playlist->status.i_status != PLAYLIST_STOPPED;
+            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 &&
@@ -361,7 +393,13 @@ check_input:
     PL_UNLOCK;
 }
 
-/** Playlist dying last loop */
+/**
+ * Last loop
+ *
+ * The playlist is dying so do the last loop
+ * \param p_playlist the playlist object
+ * \return nothing
+*/
 void playlist_LastLoop( playlist_t *p_playlist )
 {
     vlc_object_t *p_obj;
@@ -386,7 +424,7 @@ void playlist_LastLoop( playlist_t *p_playlist )
             PL_UNLOCK;
 
             /* Destroy input */
-            input_DestroyThread( p_input );
+            vlc_object_release( p_input );
             continue;
         }
         else if( p_playlist->p_input->b_die )
@@ -436,28 +474,26 @@ void playlist_LastLoop( playlist_t *p_playlist )
     playlist_MLDump( p_playlist );
 
     PL_LOCK;
-    /* Go through all items, and simply free everything without caring
-     * about the tree structure. Do not decref, it will be done by doing
-     * the same thing on the input items array */
     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( input_item_t *p_del, p_playlist->input_items )
-        input_ItemClean( p_del );
-        free( p_del );
-    FOREACH_END();
-    ARRAY_RESET( p_playlist->input_items );
-
     ARRAY_RESET( p_playlist->items );
     ARRAY_RESET( p_playlist->current );
 
     PL_UNLOCK;
 }
 
-/** Main loop for preparser queue */
+/**
+ * Preparse loop
+ *
+ * Main loop for preparser queue
+ * \param p_obj items to preparse
+ * \return nothing
+ */
 void playlist_PreparseLoop( playlist_preparse_t *p_obj )
 {
     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
@@ -467,20 +503,19 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
 
     while( !p_playlist->b_die )
     {
-        vlc_mutex_lock( &p_obj->object_lock );
+        vlc_object_lock( p_obj );
         while( p_obj->i_waiting == 0 )
         {
-            vlc_cond_wait( &p_obj->object_wait, &p_obj->object_lock );
-            if( p_playlist->b_die )
+            if( vlc_object_wait( p_obj ) || p_playlist->b_die )
             {
-                vlc_mutex_unlock( &p_obj->object_lock );
+                vlc_object_unlock( p_obj );
                 return;
             }
         }
 
         p_current = p_obj->pp_waiting[0];
         REMOVE_ELEM( p_obj->pp_waiting, p_obj->i_waiting, 0 );
-        vlc_mutex_unlock( &p_obj->object_lock );
+        vlc_object_unlock( p_obj );
 
         PL_LOCK;
         if( p_current )
@@ -498,7 +533,7 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
                 }
                 stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
                 PL_UNLOCK;
-                input_item_SetPreparsed( p_current, VLC_TRUE );
+                input_item_SetPreparsed( p_current, true );
                 var_SetInteger( p_playlist, "item-change", p_current->i_id );
                 PL_LOCK;
             }
@@ -512,15 +547,15 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
             if( !input_MetaSatisfied( p_playlist, p_current, &i_m, &i_o ) )
             {
                 preparse_item_t p;
-                PL_DEBUG("need to fetch meta for %s", p_current->psz_name );
+                PL_DEBUG( "need to fetch meta for %s", p_current->psz_name );
                 p.p_item = p_current;
-                p.b_fetch_art = VLC_FALSE;
-                vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
+                p.b_fetch_art = false;
+                vlc_object_lock( p_playlist->p_fetcher );
                 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
                              p_playlist->p_fetcher->i_waiting,
                              p_playlist->p_fetcher->i_waiting, p);
-                vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
-                vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
+                vlc_object_signal_unlocked( p_playlist->p_fetcher );
+                vlc_object_unlock( p_playlist->p_fetcher );
             }
             /* We already have all needed meta, but we need art right now */
             else if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_ALL &&
@@ -529,13 +564,13 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
                 preparse_item_t p;
                 PL_DEBUG("meta ok for %s, need to fetch art", psz_name );
                 p.p_item = p_current;
-                p.b_fetch_art = VLC_TRUE;
-                vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
+                p.b_fetch_art = true;
+                vlc_object_lock( p_playlist->p_fetcher );
                 INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
                              p_playlist->p_fetcher->i_waiting,
                              p_playlist->p_fetcher->i_waiting, p);
-                vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
-                vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
+                vlc_object_signal_unlocked( p_playlist->p_fetcher );
+                vlc_object_unlock( p_playlist->p_fetcher );
             }
             else
             {
@@ -550,20 +585,26 @@ void playlist_PreparseLoop( playlist_preparse_t *p_obj )
         else
             PL_UNLOCK;
 
-        vlc_mutex_lock( &p_obj->object_lock );
+        vlc_object_lock( p_obj );
         i_activity = var_GetInteger( p_playlist, "activity" );
         if( i_activity < 0 ) i_activity = 0;
-        vlc_mutex_unlock( &p_obj->object_lock );
+        vlc_object_unlock( p_obj );
         /* Sleep at least 1ms */
         msleep( (i_activity+1) * 1000 );
     }
 }
 
-/** Main loop for secondary preparser queue */
+/**
+ * Fetcher loop
+ *
+ * Main loop for secondary preparser queue
+ * \param p_obj items to preparse
+ * \return nothing
+ */
 void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
 {
     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
-    vlc_bool_t b_fetch_art;
+    bool b_fetch_art;
     input_item_t *p_item;
     int i_activity;
 
@@ -588,7 +629,7 @@ void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
         {
             if( !b_fetch_art )
             {
-                /* If the user doesn't want us to fetch meta automatically 
+                /* If the user doesn't want us to fetch meta automatically
                  * abort here. */
                 if( p_playlist->p_fetcher->b_fetch_meta )
                 {
@@ -602,11 +643,11 @@ void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
                     vlc_mutex_lock( &p_obj->object_lock );
                     preparse_item_t p;
                     p.p_item = p_item;
-                    p.b_fetch_art = VLC_TRUE;
+                    p.b_fetch_art = true;
                     INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
                                  p_playlist->p_fetcher->i_waiting,
                                  0, p );
-                    PL_DEBUG("meta fetched for %s, get art", p_item->psz_name);
+                    PL_DEBUG( "meta fetched for %s, get art", p_item->psz_name );
                     vlc_mutex_unlock( &p_obj->object_lock );
                     continue;
                 }
@@ -622,7 +663,7 @@ void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
                  * FIXME this doesn't work if we need to fetch meta before art ... */
                 for( i_ret = 0; i_ret < 10 && !input_item_IsPreparsed( p_item ); i_ret++ )
                 {
-                    vlc_bool_t b_break;
+                    bool b_break;
                     PL_LOCK;
                     b_break = ( !p_playlist->p_input || input_GetItem(p_playlist->p_input) != p_item  ||
                                 p_playlist->p_input->b_die || p_playlist->p_input->b_eof || p_playlist->p_input->b_error );
@@ -635,33 +676,33 @@ void playlist_FetcherLoop( playlist_fetcher_t *p_obj )
                 i_ret = input_ArtFind( p_playlist, p_item );
                 if( i_ret == 1 )
                 {
-                    PL_DEBUG("downloading art for %s", p_item->psz_name );
+                    PL_DEBUG( "downloading art for %s", p_item->psz_name );
                     if( input_DownloadAndCacheArt( p_playlist, p_item ) )
-                        input_item_SetArtNotFound( p_item, VLC_TRUE );
+                        input_item_SetArtNotFound( p_item, true );
                     else {
-                        input_item_SetArtFetched( p_item, VLC_TRUE );
+                        input_item_SetArtFetched( p_item, true );
                         var_SetInteger( p_playlist, "item-change",
                                         p_item->i_id );
                     }
                 }
                 else if( i_ret == 0 ) /* Was in cache */
                 {
-                    PL_DEBUG("found art for %s in cache", p_item->psz_name );
-                    input_item_SetArtFetched( p_item, VLC_TRUE );
+                    PL_DEBUG( "found art for %s in cache", p_item->psz_name );
+                    input_item_SetArtFetched( p_item, true );
                     var_SetInteger( p_playlist, "item-change", p_item->i_id );
                 }
                 else
                 {
-                    PL_DEBUG("art not found for %s", p_item->psz_name );
-                    input_item_SetArtNotFound( p_item, VLC_TRUE );
+                    PL_DEBUG( "art not found for %s", p_item->psz_name );
+                    input_item_SetArtNotFound( p_item, true );
                 }
                 vlc_gc_decref( p_item );
            }
         }
-        vlc_mutex_lock( &p_obj->object_lock );
+        vlc_object_lock( p_obj );
         i_activity = var_GetInteger( p_playlist, "activity" );
         if( i_activity < 0 ) i_activity = 0;
-        vlc_mutex_unlock( &p_obj->object_lock );
+        vlc_object_unlock( p_obj );
         /* Sleep at least 1ms */
         msleep( (i_activity+1) * 1000 );
     }
@@ -672,7 +713,7 @@ static void VariablesInit( playlist_t *p_playlist )
     vlc_value_t val;
     /* These variables control updates */
     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
-    val.b_bool = VLC_TRUE;
+    val.b_bool = true;
     var_Set( p_playlist, "intf-change", val );
 
     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
@@ -692,7 +733,7 @@ static void VariablesInit( playlist_t *p_playlist )
     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
 
     var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
-    val.b_bool = VLC_TRUE;
+    val.b_bool = true;
     var_Set( p_playlist, "intf-show", val );
 
     var_Create( p_playlist, "activity", VLC_VAR_INTEGER );