git.sesse.net Git - vlc/blob - src/playlist/preparser.c

   1 /*****************************************************************************
   2  * preparse.c: Preparser thread.
   3  *****************************************************************************
   4  * Copyright © 1999-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include <vlc_playlist.h>
  30
  31 #include "art.h"
  32 #include "fetcher.h"
  33 #include "preparser.h"
  34 #include "../input/input_interface.h"
  35
  36
  37 /*****************************************************************************
  38  * Structures/definitions
  39  *****************************************************************************/
  40 struct playlist_preparser_t
  41 {
  42     playlist_t          *p_playlist;
  43     playlist_fetcher_t  *p_fetcher;
  44
  45     vlc_thread_t    thread;
  46     vlc_mutex_t     lock;
  47     vlc_cond_t      wait;
  48     input_item_t  **pp_waiting;
  49     int             i_waiting;
  50
  51     int             i_art_policy;
  52 };
  53
  54 static void *Thread( void * );
  55
  56 /*****************************************************************************
  57  * Public functions
  58  *****************************************************************************/
  59 playlist_preparser_t *playlist_preparser_New( playlist_t *p_playlist, playlist_fetcher_t *p_fetcher )
  60 {
  61     playlist_preparser_t *p_preparser = malloc( sizeof(*p_preparser) );
  62     if( !p_preparser )
  63         return NULL;
  64
  65     p_preparser->p_playlist = p_playlist;
  66     p_preparser->p_fetcher = p_fetcher;
  67     vlc_mutex_init( &p_preparser->lock );
  68     vlc_cond_init( &p_preparser->wait );
  69     p_preparser->i_art_policy = var_GetInteger( p_playlist, "album-art" );
  70     p_preparser->i_waiting = 0;
  71     p_preparser->pp_waiting = NULL;
  72
  73     if( vlc_clone( &p_preparser->thread, Thread, p_preparser,
  74                    VLC_THREAD_PRIORITY_LOW ) )
  75     {
  76         msg_Err( p_playlist, "cannot spawn preparse thread" );
  77         free( p_preparser );
  78         return NULL;
  79     }
  80     return p_preparser;
  81 }
  82
  83 void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item )
  84 {
  85     vlc_gc_incref( p_item );
  86
  87     vlc_mutex_lock( &p_preparser->lock );
  88     INSERT_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting,
  89                  p_preparser->i_waiting, p_item );
  90     vlc_cond_signal( &p_preparser->wait );
  91     vlc_mutex_unlock( &p_preparser->lock );
  92 }
  93
  94 void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
  95 {
  96     /* Destroy the item preparser */
  97     vlc_cancel( p_preparser->thread );
  98     vlc_join( p_preparser->thread, NULL );
  99
 100     while( p_preparser->i_waiting > 0 )
 101     {   /* Any left-over unparsed item? */
 102         vlc_gc_decref( p_preparser->pp_waiting[0] );
 103         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 104     }
 105     vlc_cond_destroy( &p_preparser->wait );
 106     vlc_mutex_destroy( &p_preparser->lock );
 107     free( p_preparser );
 108 }
 109
 110 /*****************************************************************************
 111  * Privates functions
 112  *****************************************************************************/
 113 /**
 114  * This function preparses an item when needed.
 115  */
 116 static void Preparse( playlist_t *p_playlist, input_item_t *p_item )
 117 {
 118     vlc_mutex_lock( &p_item->lock );
 119     int i_type = p_item->i_type;
 120     vlc_mutex_unlock( &p_item->lock );
 121
 122     if( i_type != ITEM_TYPE_FILE )
 123         return;
 124
 125     stats_TimerStart( p_playlist, "Preparse run", STATS_TIMER_PREPARSE );
 126
 127     /* Do not preparse if it is already done (like by playing it) */
 128     if( !input_item_IsPreparsed( p_item ) )
 129     {
 130         input_Preparse( VLC_OBJECT(p_playlist), p_item );
 131         input_item_SetPreparsed( p_item, true );
 132
 133         var_SetAddress( p_playlist, "item-change", p_item );
 134     }
 135
 136     stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
 137 }
 138
 139 /**
 140  * This function ask the fetcher object to fetch the art when needed
 141  */
 142 static void Art( playlist_preparser_t *p_preparser, input_item_t *p_item )
 143 {
 144     playlist_t *p_playlist = p_preparser->p_playlist;
 145     playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
 146
 147     bool b_fetch = false;
 148     /* If we haven't retrieved enough meta, add to secondary queue
 149      * which will run the "meta fetchers".
 150      * This only checks for meta, not for art
 151      * \todo don't do this for things we won't get meta for, like vids
 152      */
 153
 154     vlc_mutex_lock( &p_item->lock );
 155     if( p_item->p_meta )
 156     {
 157         const char *psz_arturl = vlc_meta_Get( p_item->p_meta, vlc_meta_ArtworkURL );
 158         const char *psz_name = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
 159
 160         if( p_preparser->i_art_policy == ALBUM_ART_ALL &&
 161             ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
 162         {
 163             msg_Dbg( p_playlist, "meta ok for %s, need to fetch art", psz_name );
 164             b_fetch = true;
 165         }
 166         else
 167         {
 168             msg_Dbg( p_playlist, "no fetch required for %s (art currently %s)",
 169                      psz_name, psz_arturl );
 170         }
 171     }
 172     vlc_mutex_unlock( &p_item->lock );
 173
 174     if( b_fetch && p_fetcher )
 175         playlist_fetcher_Push( p_fetcher, p_item );
 176 }
 177
 178 /**
 179  * This function does the preparsing and issues the art fetching requests
 180  */
 181 static void *Thread( void *data )
 182 {
 183     playlist_preparser_t *p_preparser = data;
 184     playlist_t *p_playlist = p_preparser->p_playlist;
 185
 186     for( ;; )
 187     {
 188         input_item_t *p_current;
 189
 190         /* Be sure to be cancellable before our queue is empty */
 191         vlc_testcancel();
 192
 193         /* */
 194         vlc_mutex_lock( &p_preparser->lock );
 195         mutex_cleanup_push( &p_preparser->lock );
 196
 197         while( p_preparser->i_waiting == 0 )
 198             vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
 199
 200         p_current = p_preparser->pp_waiting[0];
 201         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 202         vlc_cleanup_run( );
 203
 204         if( !p_current )
 205             continue;
 206
 207         int canc = vlc_savecancel();
 208
 209         Preparse( p_playlist, p_current );
 210
 211         Art( p_preparser, p_current );
 212
 213         vlc_restorecancel( canc );
 214
 215         /* */
 216         int i_activity = var_GetInteger( p_playlist, "activity" );
 217         if( i_activity < 0 )
 218             i_activity = 0;
 219
 220         /* Sleep at least 1ms */
 221         msleep( (i_activity+1) * 1000 );
 222     }
 223     return NULL;
 224 }
 225