]> git.sesse.net Git - vlc/blobdiff - src/playlist/control.c
playlist: Don't allow pl_Release(p_playlist) and pl_Yield(p_playlist).
[vlc] / src / playlist / control.c
index a7e2ea241de249d01c32a09021277901c775dee1..89ac8fbd3dd15c17e06b3a3084f652014afaa0a9 100644 (file)
@@ -2,7 +2,7 @@
  * control.c : Handle control of the playlist & running through it
  *****************************************************************************
  * Copyright (C) 1999-2004 the VideoLAN team
- * $Id: /local/vlc/0.8.6-playlist-vlm/src/playlist/playlist.c 13741 2006-03-21T19:29:39.792444Z zorglub  $
+ * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *          ClĂ©ment Stenac <zorglub@videolan.org>
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
 #include "vlc_playlist.h"
 #include "playlist_internal.h"
 #include <assert.h>
@@ -37,15 +41,42 @@ static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
  * Playlist control
  *****************************************************************************/
 
-int playlist_Control( playlist_t * p_playlist, int i_query, vlc_bool_t b_locked, ... )
+playlist_t *__pl_Yield( vlc_object_t *p_this )
+{
+    playlist_t *pl;
+
+    barrier ();
+    pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
+
+    assert( pl != p_this /* This does not make sense to yield the playlist
+    using pl_Yield. use vlc_object_yield in this case */ );
+
+    if (pl)
+        vlc_object_yield (pl);
+    return pl;
+}
+
+void __pl_Release( vlc_object_t *p_this )
+{
+    playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
+    assert( pl != NULL );
+    
+    assert( pl != p_this /* The rule is that pl_Release() should act on
+    the same object than pl_Yield() */ );
+
+    vlc_object_release( pl );
+}
+
+int playlist_Control( playlist_t * p_playlist, int i_query,
+                      bool b_locked, ... )
 {
     va_list args;
     int i_result;
     va_start( args, b_locked );
-    if( !b_locked ) PL_LOCK;
+    PL_LOCK_IF( !b_locked );
     i_result = PlaylistVAControl( p_playlist, i_query, args );
     va_end( args );
-    if( !b_locked ) PL_UNLOCK;
+    PL_UNLOCK_IF( !b_locked );
 
     return i_result;
 }
@@ -55,6 +86,9 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
     playlist_item_t *p_item, *p_node;
     vlc_value_t val;
 
+    if( !vlc_object_alive( p_playlist ) )
+        return VLC_EGENERIC;
+
     if( playlist_IsEmpty( p_playlist ) )
         return VLC_EGENERIC;
 
@@ -62,7 +96,7 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
     {
     case PLAYLIST_STOP:
         p_playlist->request.i_status = PLAYLIST_STOPPED;
-        p_playlist->request.b_request = VLC_TRUE;
+        p_playlist->request.b_request = true;
         p_playlist->request.p_item = NULL;
         break;
 
@@ -78,11 +112,11 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
         }
         p_playlist->request.i_status = PLAYLIST_RUNNING;
         p_playlist->request.i_skip = 0;
-        p_playlist->request.b_request = VLC_TRUE;
+        p_playlist->request.b_request = true;
         p_playlist->request.p_node = p_node;
         p_playlist->request.p_item = p_item;
         if( p_item && var_GetBool( p_playlist, "random" ) )
-            p_playlist->b_reset_currently_playing = VLC_TRUE;
+            p_playlist->b_reset_currently_playing = true;
         break;
 
     case PLAYLIST_PLAY:
@@ -95,21 +129,13 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
         else
         {
             p_playlist->request.i_status = PLAYLIST_RUNNING;
-            p_playlist->request.b_request = VLC_TRUE;
-            p_playlist->request.p_node = p_playlist->status.p_node;
-            p_playlist->request.p_item = p_playlist->status.p_item;
+            p_playlist->request.b_request = true;
+            p_playlist->request.p_node = get_current_status_node( p_playlist );
+            p_playlist->request.p_item = get_current_status_item( p_playlist );
             p_playlist->request.i_skip = 0;
         }
         break;
 
-    case PLAYLIST_AUTOPLAY:
-        // AUTOPLAY is an ugly hack for initial status.
-        // Hopefully it will disappear
-        p_playlist->status.i_status = PLAYLIST_RUNNING;
-        p_playlist->request.p_node = p_playlist->status.p_node;
-        p_playlist->request.b_request = VLC_FALSE;
-        break;
-
     case PLAYLIST_PAUSE:
         val.i_int = 0;
         if( p_playlist->p_input )
@@ -136,13 +162,13 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
         break;
 
     case PLAYLIST_SKIP:
-        p_playlist->request.p_node = p_playlist->status.p_node;
-        p_playlist->request.p_item = p_playlist->status.p_item;
+        p_playlist->request.p_node = get_current_status_node( p_playlist );
+        p_playlist->request.p_item = get_current_status_item( p_playlist );
         p_playlist->request.i_skip = (int) va_arg( args, int );
         /* if already running, keep running */
         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
             p_playlist->request.i_status = p_playlist->status.i_status;
-        p_playlist->request.b_request = VLC_TRUE;
+        p_playlist->request.b_request = true;
         break;
 
     default:
@@ -150,7 +176,7 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
         return VLC_EBADVAR;
         break;
     }
-    vlc_cond_signal( &p_playlist->object_wait );
+    vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
 
     return VLC_SUCCESS;
 }
@@ -162,14 +188,19 @@ static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args
 int playlist_PreparseEnqueue( playlist_t *p_playlist,
                               input_item_t *p_item )
 {
-    vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
+    vlc_object_lock( p_playlist->p_preparse );
+    if( !vlc_object_alive( p_playlist->p_preparse ) )
+    {
+        vlc_object_unlock( p_playlist->p_preparse );
+        return VLC_EGENERIC;
+    }
     vlc_gc_incref( p_item );
     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
                  p_playlist->p_preparse->i_waiting,
                  p_playlist->p_preparse->i_waiting,
                  p_item );
-    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
-    vlc_cond_signal( &p_playlist->p_preparse->object_wait );
+    vlc_object_signal_unlocked( p_playlist->p_preparse );
+    vlc_object_unlock( p_playlist->p_preparse );
     return VLC_SUCCESS;
 }
 
@@ -178,32 +209,36 @@ int playlist_PreparseEnqueue( playlist_t *p_playlist,
 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
                                   playlist_item_t *p_item )
 {
-    vlc_mutex_lock( &p_playlist->object_lock );
-    vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
+    vlc_object_lock( p_playlist );
+    vlc_object_lock( p_playlist->p_preparse );
+    if( !vlc_object_alive( p_playlist->p_preparse ) )
+    {
+        vlc_object_unlock( p_playlist->p_preparse );
+        vlc_object_unlock( p_playlist );
+        return VLC_EGENERIC;
+    }
     PreparseEnqueueItemSub( p_playlist, p_item );
-    vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
-    vlc_mutex_unlock( &p_playlist->object_lock );
+    vlc_object_unlock( p_playlist->p_preparse );
+    vlc_object_unlock( p_playlist );
     return VLC_SUCCESS;
 }
 
 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
                                input_item_t *p_item )
 {
-    int i;
-    preparse_item_t p;
-    p.p_item = p_item;
-    p.b_fetch_art = VLC_TRUE;
-
-    vlc_mutex_lock( &p_playlist->p_fetcher->object_lock );
-    for( i = 0; i < p_playlist->p_fetcher->i_waiting &&
-         p_playlist->p_fetcher->p_waiting->b_fetch_art == VLC_TRUE;
-         i++ );
+    vlc_object_lock( p_playlist->p_fetcher );
+    if( !vlc_object_alive( p_playlist->p_fetcher ) )
+    {
+        vlc_object_unlock( p_playlist->p_fetcher );
+        return VLC_EGENERIC;
+    }
+
     vlc_gc_incref( p_item );
-    INSERT_ELEM( p_playlist->p_fetcher->p_waiting,
+    INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
                  p_playlist->p_fetcher->i_waiting,
-                 i, p );
-    vlc_mutex_unlock( &p_playlist->p_fetcher->object_lock );
-    vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
+                 p_playlist->p_fetcher->i_waiting, p_item );
+    vlc_object_signal_unlocked( p_playlist->p_fetcher );
+    vlc_object_unlock( p_playlist->p_fetcher );
     return VLC_SUCCESS;
 }
 
@@ -213,7 +248,7 @@ static void PreparseEnqueueItemSub( playlist_t *p_playlist,
     int i;
     if( p_item->i_children == -1 )
     {
-        vlc_gc_incref( p_item );
+        vlc_gc_incref( p_item->p_input );
         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
                      p_playlist->p_preparse->i_waiting,
                      p_playlist->p_preparse->i_waiting,
@@ -232,39 +267,47 @@ static void PreparseEnqueueItemSub( playlist_t *p_playlist,
  * Playback logic
  *****************************************************************************/
 
-static void ResyncCurrentIndex(playlist_t *p_playlist, playlist_item_t *p_cur )
+/**
+ * Synchronise the current index of the playlist
+ * to match the index of the current item.
+ *
+ * \param p_playlist the playlist structure
+ * \param p_cur the current playlist item
+ * \return nothing
+ */
+static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
 {
-     PL_DEBUG("resyncing on %s", PLI_NAME(p_cur) );
+     PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
      /* Simply resync index */
      int i;
      p_playlist->i_current_index = -1;
      for( i = 0 ; i< p_playlist->current.i_size; i++ )
      {
-          if( ARRAY_VAL(p_playlist->current, i) == p_cur )
+          if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
           {
               p_playlist->i_current_index = i;
               break;
           }
      }
-     PL_DEBUG("%s is at %i", PLI_NAME(p_cur), p_playlist->i_current_index );
+     PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
 }
 
-void ResetCurrentlyPlaying( playlist_t *p_playlist, vlc_bool_t b_random,
+void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
                             playlist_item_t *p_cur )
 {
     playlist_item_t *p_next = NULL;
     stats_TimerStart( p_playlist, "Items array build",
                       STATS_TIMER_PLAYLIST_BUILD );
-    PL_DEBUG("rebuilding array of current - root %s",
-              PLI_NAME(p_playlist->status.p_node) );
-    ARRAY_RESET(p_playlist->current);
+    PL_DEBUG( "rebuilding array of current - root %s",
+              PLI_NAME( p_playlist->status.p_node ) );
+    ARRAY_RESET( p_playlist->current );
     p_playlist->i_current_index = -1;
     while( 1 )
     {
         /** FIXME: this is *slow* */
         p_next = playlist_GetNextLeaf( p_playlist,
                                        p_playlist->status.p_node,
-                                       p_next, VLC_TRUE, VLC_FALSE );
+                                       p_next, true, false );
         if( p_next )
         {
             if( p_next == p_cur )
@@ -279,33 +322,37 @@ void ResetCurrentlyPlaying( playlist_t *p_playlist, vlc_bool_t b_random,
     {
         /* Shuffle the array */
         srand( (unsigned int)mdate() );
-        int swap = 0;
         int j;
         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
         {
-            swap++;
             int i = rand() % (j+1); /* between 0 and j */
             playlist_item_t *p_tmp;
+            /* swap the two items */
             p_tmp = ARRAY_VAL(p_playlist->current, i);
             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
             ARRAY_VAL(p_playlist->current,j) = p_tmp;
         }
     }
-    p_playlist->b_reset_currently_playing = VLC_FALSE;
+    p_playlist->b_reset_currently_playing = false;
     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
 }
 
-/** This function calculates the next playlist item, depending
- *  on the playlist course mode (forward, backward, random, view,...). */
+/**
+ * Compute the next playlist item depending on
+ * the playlist course mode (forward, backward, random, view,...).
+ *
+ * \param p_playlist the playlist object
+ * \return nothing
+ */
 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
 {
     playlist_item_t *p_new = NULL;
     int i_skip = 0, i;
 
-    vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
-    vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
-    vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
-    vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
+    bool b_loop = var_GetBool( p_playlist, "loop" );
+    bool b_random = var_GetBool( p_playlist, "random" );
+    bool b_repeat = var_GetBool( p_playlist, "repeat" );
+    bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 
     /* Handle quickly a few special cases */
     /* No items to play */
@@ -316,21 +363,22 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
     }
 
     /* Repeat and play/stop */
-    if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
-         p_playlist->status.p_item )
+    if( !p_playlist->request.b_request && b_repeat == true &&
+         get_current_status_item( p_playlist ) )
     {
         msg_Dbg( p_playlist,"repeating item" );
-        return p_playlist->status.p_item;
+        return get_current_status_item( p_playlist );
     }
-    if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
+    if( !p_playlist->request.b_request && b_playstop == true )
     {
-        msg_Dbg( p_playlist,"stopping (play and stop)");
+        msg_Dbg( p_playlist,"stopping (play and stop)" );
         return NULL;
     }
 
-    if( !p_playlist->request.b_request && p_playlist->status.p_item )
+    if( !p_playlist->request.b_request &&
+        get_current_status_item( p_playlist ) )
     {
-        playlist_item_t *p_parent = p_playlist->status.p_item;
+        playlist_item_t *p_parent = get_current_status_item( p_playlist );
         while( p_parent )
         {
             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
@@ -352,13 +400,15 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
                         PLI_NAME( p_playlist->request.p_node ), i_skip );
 
         if( p_playlist->request.p_node &&
-            p_playlist->request.p_node != p_playlist->status.p_node )
+            p_playlist->request.p_node != get_current_status_node( p_playlist ) )
         {
-            p_playlist->status.p_node = p_playlist->request.p_node;
-            p_playlist->b_reset_currently_playing = VLC_TRUE;
+
+            set_current_status_node( p_playlist, p_playlist->request.p_node );
+            p_playlist->request.p_node = NULL;
+            p_playlist->b_reset_currently_playing = true;
         }
 
-        /* If we are asked for a node, dont take it */
+        /* If we are asked for a node, don't take it */
         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
             i_skip++;
 
@@ -370,12 +420,14 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
         else
             p_playlist->i_current_index = -1;
 
-        if( p_playlist->current.i_size && i_skip > 0 )
+        if( p_playlist->current.i_size && (i_skip > 0) )
         {
+            if( p_playlist->i_current_index < -1 )
+                p_playlist->i_current_index = -1;
             for( i = i_skip; i > 0 ; i-- )
             {
                 p_playlist->i_current_index++;
-                if( p_playlist->i_current_index == p_playlist->current.i_size )
+                if( p_playlist->i_current_index >= p_playlist->current.i_size )
                 {
                     PL_DEBUG( "looping - restarting at beginning of node" );
                     p_playlist->i_current_index = 0;
@@ -384,12 +436,12 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
             p_new = ARRAY_VAL( p_playlist->current,
                                p_playlist->i_current_index );
         }
-        else if( p_playlist->current.i_size && i_skip < 0 )
+        else if( p_playlist->current.i_size && (i_skip < 0) )
         {
             for( i = i_skip; i < 0 ; i++ )
             {
                 p_playlist->i_current_index--;
-                if( p_playlist->i_current_index == -1 )
+                if( p_playlist->i_current_index <= -1 )
                 {
                     PL_DEBUG( "looping - restarting at end of node" );
                     p_playlist->i_current_index = p_playlist->current.i_size-1;
@@ -399,7 +451,7 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
                                p_playlist->i_current_index );
         }
         /* Clear the request */
-        p_playlist->request.b_request = VLC_FALSE;
+        p_playlist->request.b_request = false;
     }
     /* "Automatic" item change ( next ) */
     else
@@ -407,15 +459,16 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
         PL_DEBUG( "changing item without a request (current %i/%i)",
                   p_playlist->i_current_index, p_playlist->current.i_size );
         /* Cant go to next from current item */
-        if( p_playlist->status.p_item &&
-            p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
+        if( get_current_status_item( p_playlist ) &&
+            get_current_status_item( p_playlist )->i_flags & PLAYLIST_SKIP_FLAG )
             return NULL;
 
         if( p_playlist->b_reset_currently_playing )
             ResetCurrentlyPlaying( p_playlist, b_random,
-                                   p_playlist->status.p_item );
+                                   get_current_status_item( p_playlist ) );
 
         p_playlist->i_current_index++;
+        assert( p_playlist->i_current_index <= p_playlist->current.i_size );
         if( p_playlist->i_current_index == p_playlist->current.i_size )
         {
             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
@@ -432,41 +485,69 @@ playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
     return p_new;
 }
 
-/** Start the input for an item */
+/**
+ * Start the input for an item
+ *
+ * \param p_playlist the playlist objetc
+ * \param p_item the item to play
+ * \return nothing
+ */
 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 {
-    vlc_value_t val;
     input_item_t *p_input = p_item->p_input;
-    int i_activity = var_GetInteger( p_playlist, "activity") ;
+    sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
+    int i_activity = var_GetInteger( p_playlist, "activity" ) ;
 
     msg_Dbg( p_playlist, "creating new input thread" );
 
     p_input->i_nb_played++;
-    p_playlist->status.p_item = p_item;
+    set_current_status_item( p_playlist, p_item );
 
     p_playlist->status.i_status = PLAYLIST_RUNNING;
 
     var_SetInteger( p_playlist, "activity", i_activity +
                     DEFAULT_INPUT_ACTIVITY );
-    p_playlist->p_input = input_CreateThread( p_playlist, p_input );
 
-    if( p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
+    input_thread_t * p_input_thread =
+        input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
+    playlist_set_current_input( p_playlist, p_input_thread );
+    vlc_object_release( p_input_thread );
+
+    *pp_sout = NULL;
+
+    char *psz_uri = input_item_GetURI( p_item->p_input );
+    if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
+                     !strncmp( psz_uri, "vlc:", 4 ) ) )
+    {
+        free( psz_uri );
+        return VLC_SUCCESS;
+    }
+    free( psz_uri );
+
+    if( p_playlist->p_fetcher &&
+            p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
     {
-        if( p_input->p_meta && EMPTY_STR( p_input->p_meta->psz_arturl ) )
+        bool b_has_art;
+
+        char *psz_arturl, *psz_name;
+        psz_arturl = input_item_GetArtURL( p_input );
+        psz_name = input_item_GetName( p_input );
+
+        /* p_input->p_meta should not be null after a successfull CreateThread */
+        b_has_art = !EMPTY_STR( psz_arturl );
+
+        if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
         {
-            PL_DEBUG( "requesting art for %s", p_input->psz_name );
+            PL_DEBUG( "requesting art for %s", psz_name );
             playlist_AskForArtEnqueue( p_playlist, p_input );
         }
-        else if( !p_input->p_meta )
-        {
-            PL_DEBUG2( "unable to request art for %s, no meta", p_input->psz_name );
-        }
+        free( psz_arturl );
+        free( psz_name );
     }
 
-    val.i_int = p_input->i_id;
-    vlc_mutex_unlock( &p_playlist->object_lock);
-    var_Set( p_playlist, "playlist-current", val);
-    vlc_mutex_lock( &p_playlist->object_lock);
+    PL_UNLOCK;
+    var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
+    PL_LOCK;
 
     return VLC_SUCCESS;
 }