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
  52 static void *Thread( void * );
  53
  54 /*****************************************************************************
  55  * Public functions
  56  *****************************************************************************/
  57 playlist_preparser_t *playlist_preparser_New( playlist_t *p_playlist, playlist_fetcher_t *p_fetcher )
  58 {
  59     playlist_preparser_t *p_preparser = malloc( sizeof(*p_preparser) );
  60     if( !p_preparser )
  61         return NULL;
  62
  63     p_preparser->p_playlist = p_playlist;
  64     p_preparser->p_fetcher = p_fetcher;
  65     vlc_mutex_init( &p_preparser->lock );
  66     vlc_cond_init( &p_preparser->wait );
  67     p_preparser->i_waiting = 0;
  68     p_preparser->pp_waiting = NULL;
  69
  70     if( vlc_clone( &p_preparser->thread, Thread, p_preparser,
  71                    VLC_THREAD_PRIORITY_LOW ) )
  72     {
  73         msg_Err( p_playlist, "cannot spawn preparse thread" );
  74         free( p_preparser );
  75         return NULL;
  76     }
  77     return p_preparser;
  78 }
  79
  80 void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item )
  81 {
  82     vlc_gc_incref( p_item );
  83
  84     vlc_mutex_lock( &p_preparser->lock );
  85     INSERT_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting,
  86                  p_preparser->i_waiting, p_item );
  87     vlc_cond_signal( &p_preparser->wait );
  88     vlc_mutex_unlock( &p_preparser->lock );
  89 }
  90
  91 void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
  92 {
  93     /* Destroy the item preparser */
  94     vlc_cancel( p_preparser->thread );
  95     vlc_join( p_preparser->thread, NULL );
  96
  97     while( p_preparser->i_waiting > 0 )
  98     {   /* Any left-over unparsed item? */
  99         vlc_gc_decref( p_preparser->pp_waiting[0] );
 100         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 101     }
 102     vlc_cond_destroy( &p_preparser->wait );
 103     vlc_mutex_destroy( &p_preparser->lock );
 104     free( p_preparser );
 105 }
 106
 107 /*****************************************************************************
 108  * Privates functions
 109  *****************************************************************************/
 110 /**
 111  * This function preparses an item when needed.
 112  */
 113 static void Preparse( playlist_t *p_playlist, input_item_t *p_item )
 114 {
 115     vlc_mutex_lock( &p_item->lock );
 116     int i_type = p_item->i_type;
 117     vlc_mutex_unlock( &p_item->lock );
 118
 119     if( i_type != ITEM_TYPE_FILE )
 120         return;
 121
 122     stats_TimerStart( p_playlist, "Preparse run", STATS_TIMER_PREPARSE );
 123
 124     /* Do not preparse if it is already done (like by playing it) */
 125     if( !input_item_IsPreparsed( p_item ) )
 126     {
 127         input_Preparse( p_playlist, p_item );
 128         input_item_SetPreparsed( p_item, true );
 129
 130         var_SetInteger( p_playlist, "item-change", p_item->i_id );
 131     }
 132
 133     stats_TimerStop( p_playlist, STATS_TIMER_PREPARSE );
 134 }
 135
 136 /**
 137  * This function ask the fetcher object to fetch the art when needed
 138  */
 139 static void Art( playlist_preparser_t *p_preparser, input_item_t *p_item )
 140 {
 141     playlist_t *p_playlist = p_preparser->p_playlist;
 142     playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
 143
 144     bool b_fetch = false;
 145     /* If we haven't retrieved enough meta, add to secondary queue
 146      * which will run the "meta fetchers".
 147      * This only checks for meta, not for art
 148      * \todo don't do this for things we won't get meta for, like vids
 149      */
 150
 151     vlc_mutex_lock( &p_item->lock );
 152     if( p_item->p_meta )
 153     {
 154         const char *psz_arturl = vlc_meta_Get( p_item->p_meta, vlc_meta_ArtworkURL );
 155         const char *psz_name = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
 156
 157         if( p_fetcher && p_fetcher->i_art_policy == ALBUM_ART_ALL &&
 158             ( !psz_arturl || strncmp( psz_arturl, "file://", 7 ) ) )
 159         {
 160             msg_Dbg( p_playlist, "meta ok for %s, need to fetch art", psz_name );
 161             b_fetch = true;
 162         }
 163         else
 164         {
 165             msg_Dbg( p_playlist, "no fetch required for %s (art currently %s)",
 166                      psz_name, psz_arturl );
 167         }
 168     }
 169     vlc_mutex_unlock( &p_item->lock );
 170
 171     if( b_fetch )
 172         playlist_fetcher_Push( p_fetcher, p_item );
 173 }
 174
 175 /**
 176  * This function does the preparsing and issues the art fetching requests
 177  */
 178 static void *Thread( void *data )
 179 {
 180     playlist_preparser_t *p_preparser = data;
 181     playlist_t *p_playlist = p_preparser->p_playlist;
 182
 183     for( ;; )
 184     {
 185         input_item_t *p_current;
 186
 187         /* */
 188         vlc_mutex_lock( &p_preparser->lock );
 189         mutex_cleanup_push( &p_preparser->lock );
 190
 191         while( p_preparser->i_waiting == 0 )
 192             vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
 193
 194         p_current = p_preparser->pp_waiting[0];
 195         REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
 196         vlc_cleanup_run( );
 197
 198         if( !p_current )
 199             continue;
 200
 201         int canc = vlc_savecancel();
 202
 203         Preparse( p_playlist, p_current );
 204
 205         Art( p_preparser, p_current );
 206
 207         vlc_restorecancel( canc );
 208
 209         /* */
 210         int i_activity = var_GetInteger( p_playlist, "activity" );
 211         if( i_activity < 0 )
 212             i_activity = 0;
 213
 214         /* Sleep at least 1ms */
 215         msleep( (i_activity+1) * 1000 );
 216     }
 217     return NULL;
 218 }
 219