]> git.sesse.net Git - vlc/blobdiff - src/playlist/preparser.c
preparser: pass meta request options to Preparse
[vlc] / src / playlist / preparser.c
index 55e20e0937c497d7b9bb95aa1bae32eb4374b52c..96171e3a83fdd0c18177d9ff321eaacb3c4bea46 100644 (file)
 /*****************************************************************************
- * preparse.c: Preparser thread.
+ * preparser.c: Preparser thread.
  *****************************************************************************
- * Copyright © 1999-2009 the VideoLAN team
+ * Copyright © 1999-2009 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *          Clément Stenac <zorglub@videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
 
 #include <vlc_common.h>
-#include <vlc_playlist.h>
 
-#include "art.h"
 #include "fetcher.h"
 #include "preparser.h"
-#include "../input/input_interface.h"
+#include "input/input_interface.h"
+
+/*****************************************************************************
+ * Structures/definitions
+ *****************************************************************************/
+typedef struct preparser_entry_t preparser_entry_t;
+
+struct preparser_entry_t
+{
+    input_item_t    *p_item;
+    input_item_meta_request_option_t i_options;
+};
+
+struct playlist_preparser_t
+{
+    vlc_object_t        *object;
+    playlist_fetcher_t  *p_fetcher;
+
+    vlc_mutex_t     lock;
+    vlc_cond_t      wait;
+    bool            b_live;
+    preparser_entry_t  **pp_waiting;
+    int             i_waiting;
+};
 
 static void *Thread( void * );
 
-playlist_preparser_t *playlist_preparser_New( playlist_t *p_playlist, playlist_fetcher_t *p_fetcher )
+/*****************************************************************************
+ * Public functions
+ *****************************************************************************/
+playlist_preparser_t *playlist_preparser_New( vlc_object_t *parent )
 {
     playlist_preparser_t *p_preparser = malloc( sizeof(*p_preparser) );
     if( !p_preparser )
         return NULL;
 
-    p_preparser->p_playlist = p_playlist;
-    p_preparser->p_fetcher = p_fetcher;
+    p_preparser->object = parent;
+    p_preparser->p_fetcher = playlist_fetcher_New( parent );
+    if( unlikely(p_preparser->p_fetcher == NULL) )
+        msg_Err( parent, "cannot create fetcher" );
+
     vlc_mutex_init( &p_preparser->lock );
     vlc_cond_init( &p_preparser->wait );
+    p_preparser->b_live = false;
     p_preparser->i_waiting = 0;
     p_preparser->pp_waiting = NULL;
 
-    if( vlc_clone( &p_preparser->thread, Thread, p_preparser,
-                   VLC_THREAD_PRIORITY_LOW ) )
-    {
-        msg_Err( p_playlist, "cannot spawn preparse thread" );
-        free( p_preparser );
-        return NULL;
-    }
     return p_preparser;
 }
 
-void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item )
+void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item,
+                              input_item_meta_request_option_t i_options )
 {
-    vlc_gc_incref( p_item );
+    preparser_entry_t *p_entry = malloc( sizeof(preparser_entry_t) );
+
+    if ( !p_entry )
+        return;
+    p_entry->p_item = p_item;
+    p_entry->i_options = i_options;
+    vlc_gc_incref( p_entry->p_item );
 
     vlc_mutex_lock( &p_preparser->lock );
     INSERT_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting,
-                 p_preparser->i_waiting, p_item );
-    vlc_cond_signal( &p_preparser->wait );
+                 p_preparser->i_waiting, p_entry );
+    if( !p_preparser->b_live )
+    {
+        if( vlc_clone_detach( NULL, Thread, p_preparser,
+                              VLC_THREAD_PRIORITY_LOW ) )
+            msg_Warn( p_preparser->object, "cannot spawn pre-parser thread" );
+        else
+            p_preparser->b_live = true;
+    }
     vlc_mutex_unlock( &p_preparser->lock );
 }
 
-void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
+void playlist_preparser_fetcher_Push( playlist_preparser_t *p_preparser,
+             input_item_t *p_item, input_item_meta_request_option_t i_options )
 {
-    /* Destroy the item preparser */
-    vlc_cancel( p_preparser->thread );
-    vlc_join( p_preparser->thread, NULL );
+    if( p_preparser->p_fetcher != NULL )
+        playlist_fetcher_Push( p_preparser->p_fetcher, p_item, i_options );
+}
 
+void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
+{
+    vlc_mutex_lock( &p_preparser->lock );
+    /* Remove pending item to speed up preparser thread exit */
     while( p_preparser->i_waiting > 0 )
-    {   /* Any left-over unparsed item? */
-        vlc_gc_decref( p_preparser->pp_waiting[0] );
+    {
+        preparser_entry_t *p_entry = p_preparser->pp_waiting[0];
+        vlc_gc_decref( p_entry->p_item );
+        free( p_entry );
         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
     }
+
+    while( p_preparser->b_live )
+        vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
+    vlc_mutex_unlock( &p_preparser->lock );
+
+    /* Destroy the item preparser */
     vlc_cond_destroy( &p_preparser->wait );
     vlc_mutex_destroy( &p_preparser->lock );
+
+    if( p_preparser->p_fetcher != NULL )
+        playlist_fetcher_Delete( p_preparser->p_fetcher );
+    free( p_preparser );
+}
+
+/*****************************************************************************
+ * Privates functions
+ *****************************************************************************/
+/**
+ * This function preparses an item when needed.
+ */
+static void Preparse( vlc_object_t *obj, input_item_t *p_item,
+                      input_item_meta_request_option_t i_options )
+{
+    vlc_mutex_lock( &p_item->lock );
+    int i_type = p_item->i_type;
+    vlc_mutex_unlock( &p_item->lock );
+
+    bool b_preparse = false;
+    switch (i_type) {
+    case ITEM_TYPE_FILE:
+    case ITEM_TYPE_DIRECTORY:
+    case ITEM_TYPE_PLAYLIST:
+    case ITEM_TYPE_NODE:
+        b_preparse = true;
+        break;
+    case ITEM_TYPE_NET:
+        if (i_options & META_REQUEST_OPTION_SCOPE_NETWORK)
+            b_preparse = true;
+        break;
+    }
+    if( !b_preparse )
+    {
+        input_item_SetPreparsed( p_item, true );
+        return;
+    }
+
+    /* Do not preparse if it is already done (like by playing it) */
+    if( !input_item_IsPreparsed( p_item ) )
+    {
+        input_Preparse( obj, p_item );
+        input_item_SetPreparsed( p_item, true );
+
+        var_SetAddress( obj, "item-change", p_item );
+    }
 }
 
+/**
+ * This function ask the fetcher object to fetch the art when needed
+ */
+static void Art( playlist_preparser_t *p_preparser, input_item_t *p_item )
+{
+    vlc_object_t *obj = p_preparser->object;
+    playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
+
+    bool b_fetch = false;
+    /* If we haven't retrieved enough meta, add to secondary queue
+     * which will run the "meta fetchers".
+     * This only checks for meta, not for art
+     * \todo don't do this for things we won't get meta for, like vids
+     */
+
+    vlc_mutex_lock( &p_item->lock );
+    if( p_item->p_meta )
+    {
+        const char *psz_arturl = vlc_meta_Get( p_item->p_meta, vlc_meta_ArtworkURL );
+        const char *psz_name = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
+
+        if( !psz_arturl || ( strncmp( psz_arturl, "file://", 7 ) &&
+                             strncmp( psz_arturl, "attachment://", 13 ) ) )
+        {
+            msg_Dbg( obj, "meta ok for %s, need to fetch art",
+                     psz_name ? psz_name : "(null)" );
+            b_fetch = true;
+        }
+        else
+        {
+            msg_Dbg( obj, "no fetch required for %s (art currently %s)",
+                     psz_name ? psz_name : "(null)",
+                     psz_arturl ? psz_arturl : "(null)" );
+        }
+    }
+    vlc_mutex_unlock( &p_item->lock );
+
+    if( b_fetch && p_fetcher )
+        playlist_fetcher_Push( p_fetcher, p_item, 0 );
+}
+
+/**
+ * This function does the preparsing and issues the art fetching requests
+ */
 static void *Thread( void *data )
 {
     playlist_preparser_t *p_preparser = data;
-    playlist_t *p_playlist = p_preparser->p_playlist;
-    playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
+    vlc_object_t *obj = p_preparser->object;
 
     for( ;; )
     {
         input_item_t *p_current;
+        input_item_meta_request_option_t i_options;
 
         /* */
         vlc_mutex_lock( &p_preparser->lock );
-        mutex_cleanup_push( &p_preparser->lock );
-
-        while( p_preparser->i_waiting == 0 )
-            vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
-
-        p_current = p_preparser->pp_waiting[0];
-        REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
-        vlc_cleanup_run( );
+        if( p_preparser->i_waiting > 0 )
+        {
+            preparser_entry_t *p_entry = p_preparser->pp_waiting[0];
+            p_current = p_entry->p_item;
+            i_options = p_entry->i_options;
+            free( p_entry );
+            REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
+        }
+        else
+        {
+            p_current = NULL;
+            p_preparser->b_live = false;
+            vlc_cond_signal( &p_preparser->wait );
+        }
+        vlc_mutex_unlock( &p_preparser->lock );
 
         if( !p_current )
-            continue;
+            break;
 
-        int canc = vlc_savecancel ();
-        {
-            PL_LOCK;
-            if( p_current->i_type == ITEM_TYPE_FILE )
-            {
-                stats_TimerStart( p_playlist, "Preparse run",
-                                  STATS_TIMER_PREPARSE );
-                /* Do not preparse if it is already done (like by playing it) */
-                if( !input_item_IsPreparsed( p_current ) )
-                {
-                    PL_UNLOCK;
-                    input_Preparse( p_playlist, p_current );
-                    PL_LOCK;
-                }
-                stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
-                PL_UNLOCK;
-                input_item_SetPreparsed( p_current, true );
-                var_SetInteger( p_playlist, "item-change", p_current->i_id );
-                PL_LOCK;
-            }
-            /* If we haven't retrieved enough meta, add to secondary queue
-             * which will run the "meta fetchers".
-             * This only checks for meta, not for art
-             * \todo don't do this for things we won't get meta for, like vids
-             */
-            char *psz_arturl = input_item_GetArtURL( p_current );
-            char *psz_name = input_item_GetName( p_current );
-            if( p_fetcher && p_fetcher->i_art_policy == ALBUM_ART_ALL &&
-                ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
-            {
-                msg_Dbg( p_playlist, "meta ok for %s, need to fetch art", psz_name );
-                playlist_fetcher_Push( p_fetcher, p_current );
-            }
-            else
-            {
-                msg_Dbg( p_playlist, "no fetch required for %s (art currently %s)",
-                         psz_name, psz_arturl );
-            }
-            vlc_gc_decref( p_current );
-            free( psz_name );
-            free( psz_arturl );
-           PL_UNLOCK;
-        }
-        vlc_restorecancel( canc );
+        Preparse( obj, p_current, i_options );
 
-        int i_activity = var_GetInteger( p_playlist, "activity" );
-        if( i_activity < 0 ) i_activity = 0;
-        /* Sleep at least 1ms */
-        msleep( (i_activity+1) * 1000 );
+        Art( p_preparser, p_current );
+        vlc_gc_decref(p_current);
     }
     return NULL;
 }