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

   1 /*****************************************************************************
   2  * preparse.c: Preparser thread.
   3  *****************************************************************************
   4  * Copyright © 1999-2009 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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_mutex_t     lock;
  46     vlc_cond_t      wait;
  47     bool            b_live;
  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->b_live = false;
  70     p_preparser->i_art_policy = var_GetInteger( p_playlist, "album-art" );
  71     p_preparser->i_waiting = 0;
  72     p_preparser->pp_waiting = NULL;
  73
  74     return p_preparser;
  75 }
  76
  77 void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item )
  78 {
  79     vlc_gc_incref( p_item );
  80
  81     vlc_mutex_lock( &p_preparser->lock );
  82     INSERT_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting,
  83                  p_preparser->i_waiting, p_item );
  84     if( !p_preparser->b_live )
  85     {
  86         if( vlc_clone_detach( NULL, Thread, p_preparser,
  87                               VLC_THREAD_PRIORITY_LOW ) )
  88             msg_Warn( p_preparser->p_playlist,
  89                       "cannot spawn pre-parser thread" );
  90         else
  91             p_preparser->b_live = true;
  92     }
  93     vlc_mutex_unlock( &p_preparser->lock );
  94 }
  95
  96 void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
  97 {
  98     vlc_mutex_lock( &p_preparser->lock );
  99     /* Remove pending item to speed up preparser thread exit */
 100     while( p_preparser->i_waiting > 0 )
 101     {
 102         vlc_gc_decref( p_preparser->pp_waiting[0] );
 103         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 104     }
 105
 106     while( p_preparser->b_live )
 107         vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
 108     vlc_mutex_unlock( &p_preparser->lock );
 109
 110     /* Destroy the item preparser */
 111     vlc_cond_destroy( &p_preparser->wait );
 112     vlc_mutex_destroy( &p_preparser->lock );
 113     free( p_preparser );
 114 }
 115
 116 /*****************************************************************************
 117  * Privates functions
 118  *****************************************************************************/
 119 /**
 120  * This function preparses an item when needed.
 121  */
 122 static void Preparse( playlist_t *p_playlist, input_item_t *p_item )
 123 {
 124     vlc_mutex_lock( &p_item->lock );
 125     int i_type = p_item->i_type;
 126     vlc_mutex_unlock( &p_item->lock );
 127
 128     if( i_type != ITEM_TYPE_FILE )
 129     {
 130         input_item_SetPreparsed( p_item, true );
 131         return;
 132     }
 133
 134     stats_TimerStart( p_playlist, "Preparse run", STATS_TIMER_PREPARSE );
 135
 136     /* Do not preparse if it is already done (like by playing it) */
 137     if( !input_item_IsPreparsed( p_item ) )
 138     {
 139         input_Preparse( VLC_OBJECT(p_playlist), p_item );
 140         input_item_SetPreparsed( p_item, true );
 141
 142         var_SetAddress( p_playlist, "item-change", p_item );
 143     }
 144
 145     stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
 146 }
 147
 148 /**
 149  * This function ask the fetcher object to fetch the art when needed
 150  */
 151 static void Art( playlist_preparser_t *p_preparser, input_item_t *p_item )
 152 {
 153     playlist_t *p_playlist = p_preparser->p_playlist;
 154     playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
 155
 156     bool b_fetch = false;
 157     /* If we haven't retrieved enough meta, add to secondary queue
 158      * which will run the "meta fetchers".
 159      * This only checks for meta, not for art
 160      * \todo don't do this for things we won't get meta for, like vids
 161      */
 162
 163     vlc_mutex_lock( &p_item->lock );
 164     if( p_item->p_meta )
 165     {
 166         const char *psz_arturl = vlc_meta_Get( p_item->p_meta, vlc_meta_ArtworkURL );
 167         const char *psz_name = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
 168
 169         if( p_preparser->i_art_policy == ALBUM_ART_ALL &&
 170             ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
 171         {
 172             msg_Dbg( p_playlist, "meta ok for %s, need to fetch art",
 173                      psz_name ? psz_name : "(null)" );
 174             b_fetch = true;
 175         }
 176         else
 177         {
 178             msg_Dbg( p_playlist, "no fetch required for %s (art currently %s)",
 179                      psz_name ? psz_name : "(null)",
 180                      psz_arturl ? psz_arturl : "(null)" );
 181         }
 182     }
 183     vlc_mutex_unlock( &p_item->lock );
 184
 185     if( b_fetch && p_fetcher )
 186         playlist_fetcher_Push( p_fetcher, p_item );
 187 }
 188
 189 /**
 190  * This function does the preparsing and issues the art fetching requests
 191  */
 192 static void *Thread( void *data )
 193 {
 194     playlist_preparser_t *p_preparser = data;
 195     playlist_t *p_playlist = p_preparser->p_playlist;
 196
 197     for( ;; )
 198     {
 199         input_item_t *p_current;
 200
 201         /* */
 202         vlc_mutex_lock( &p_preparser->lock );
 203         if( p_preparser->i_waiting > 0 )
 204         {
 205             p_current = p_preparser->pp_waiting[0];
 206             REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 207         }
 208         else
 209         {
 210             p_current = NULL;
 211             p_preparser->b_live = false;
 212             vlc_cond_signal( &p_preparser->wait );
 213         }
 214         vlc_mutex_unlock( &p_preparser->lock );
 215
 216         if( !p_current )
 217             break;
 218
 219         Preparse( p_playlist, p_current );
 220
 221         Art( p_preparser, p_current );
 222         vlc_gc_decref(p_current);
 223     }
 224     return NULL;
 225 }
 226