1 /*****************************************************************************
2 * preparser.c: Preparser thread.
3 *****************************************************************************
4 * Copyright © 1999-2009 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
28 #include <vlc_common.h>
31 #include "preparser.h"
32 #include "input/input_interface.h"
34 /*****************************************************************************
35 * Structures/definitions
36 *****************************************************************************/
37 typedef struct preparser_entry_t preparser_entry_t;
39 struct preparser_entry_t
42 input_item_meta_request_option_t i_options;
45 struct playlist_preparser_t
48 playlist_fetcher_t *p_fetcher;
53 preparser_entry_t **pp_waiting;
57 static void *Thread( void * );
59 /*****************************************************************************
61 *****************************************************************************/
62 playlist_preparser_t *playlist_preparser_New( vlc_object_t *parent )
64 playlist_preparser_t *p_preparser = malloc( sizeof(*p_preparser) );
68 p_preparser->object = parent;
69 p_preparser->p_fetcher = playlist_fetcher_New( parent );
70 if( unlikely(p_preparser->p_fetcher == NULL) )
71 msg_Err( parent, "cannot create fetcher" );
73 vlc_mutex_init( &p_preparser->lock );
74 vlc_cond_init( &p_preparser->wait );
75 p_preparser->b_live = false;
76 p_preparser->i_waiting = 0;
77 p_preparser->pp_waiting = NULL;
82 void playlist_preparser_Push( playlist_preparser_t *p_preparser, input_item_t *p_item,
83 input_item_meta_request_option_t i_options )
85 preparser_entry_t *p_entry = malloc( sizeof(preparser_entry_t) );
89 p_entry->p_item = p_item;
90 p_entry->i_options = i_options;
91 vlc_gc_incref( p_entry->p_item );
93 vlc_mutex_lock( &p_preparser->lock );
94 INSERT_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting,
95 p_preparser->i_waiting, p_entry );
96 if( !p_preparser->b_live )
98 if( vlc_clone_detach( NULL, Thread, p_preparser,
99 VLC_THREAD_PRIORITY_LOW ) )
100 msg_Warn( p_preparser->object, "cannot spawn pre-parser thread" );
102 p_preparser->b_live = true;
104 vlc_mutex_unlock( &p_preparser->lock );
107 void playlist_preparser_fetcher_Push( playlist_preparser_t *p_preparser,
108 input_item_t *p_item, input_item_meta_request_option_t i_options )
110 if( p_preparser->p_fetcher != NULL )
111 playlist_fetcher_Push( p_preparser->p_fetcher, p_item, i_options );
114 void playlist_preparser_Delete( playlist_preparser_t *p_preparser )
116 vlc_mutex_lock( &p_preparser->lock );
117 /* Remove pending item to speed up preparser thread exit */
118 while( p_preparser->i_waiting > 0 )
120 preparser_entry_t *p_entry = p_preparser->pp_waiting[0];
121 vlc_gc_decref( p_entry->p_item );
123 REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
126 while( p_preparser->b_live )
127 vlc_cond_wait( &p_preparser->wait, &p_preparser->lock );
128 vlc_mutex_unlock( &p_preparser->lock );
130 /* Destroy the item preparser */
131 vlc_cond_destroy( &p_preparser->wait );
132 vlc_mutex_destroy( &p_preparser->lock );
134 if( p_preparser->p_fetcher != NULL )
135 playlist_fetcher_Delete( p_preparser->p_fetcher );
139 /*****************************************************************************
141 *****************************************************************************/
143 * This function preparses an item when needed.
145 static void Preparse( vlc_object_t *obj, input_item_t *p_item,
146 input_item_meta_request_option_t i_options )
148 vlc_mutex_lock( &p_item->lock );
149 int i_type = p_item->i_type;
150 vlc_mutex_unlock( &p_item->lock );
152 bool b_preparse = false;
155 case ITEM_TYPE_DIRECTORY:
156 case ITEM_TYPE_PLAYLIST:
160 case ITEM_TYPE_STREAM:
161 if (i_options & META_REQUEST_OPTION_SCOPE_NETWORK)
167 input_item_SetPreparsed( p_item, true );
168 input_item_SignalPreparseEnded( p_item );
172 /* Do not preparse if it is already done (like by playing it) */
173 if( !input_item_IsPreparsed( p_item ) )
175 input_Preparse( obj, p_item );
176 input_item_SetPreparsed( p_item, true );
178 var_SetAddress( obj, "item-change", p_item );
180 input_item_SignalPreparseEnded( p_item );
184 * This function ask the fetcher object to fetch the art when needed
186 static void Art( playlist_preparser_t *p_preparser, input_item_t *p_item )
188 vlc_object_t *obj = p_preparser->object;
189 playlist_fetcher_t *p_fetcher = p_preparser->p_fetcher;
191 bool b_fetch = false;
192 /* If we haven't retrieved enough meta, add to secondary queue
193 * which will run the "meta fetchers".
194 * This only checks for meta, not for art
195 * \todo don't do this for things we won't get meta for, like vids
198 vlc_mutex_lock( &p_item->lock );
201 const char *psz_arturl = vlc_meta_Get( p_item->p_meta, vlc_meta_ArtworkURL );
202 const char *psz_name = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
204 if( !psz_arturl || ( strncmp( psz_arturl, "file://", 7 ) &&
205 strncmp( psz_arturl, "attachment://", 13 ) ) )
207 msg_Dbg( obj, "meta ok for %s, need to fetch art",
208 psz_name ? psz_name : "(null)" );
213 msg_Dbg( obj, "no fetch required for %s (art currently %s)",
214 psz_name ? psz_name : "(null)",
215 psz_arturl ? psz_arturl : "(null)" );
218 vlc_mutex_unlock( &p_item->lock );
220 if( b_fetch && p_fetcher )
221 playlist_fetcher_Push( p_fetcher, p_item, 0 );
225 * This function does the preparsing and issues the art fetching requests
227 static void *Thread( void *data )
229 playlist_preparser_t *p_preparser = data;
230 vlc_object_t *obj = p_preparser->object;
234 input_item_t *p_current;
235 input_item_meta_request_option_t i_options;
238 vlc_mutex_lock( &p_preparser->lock );
239 if( p_preparser->i_waiting > 0 )
241 preparser_entry_t *p_entry = p_preparser->pp_waiting[0];
242 p_current = p_entry->p_item;
243 i_options = p_entry->i_options;
245 REMOVE_ELEM( p_preparser->pp_waiting, p_preparser->i_waiting, 0 );
250 p_preparser->b_live = false;
251 vlc_cond_signal( &p_preparser->wait );
253 vlc_mutex_unlock( &p_preparser->lock );
258 Preparse( obj, p_current, i_options );
260 Art( p_preparser, p_current );
261 vlc_gc_decref(p_current);