1 /*****************************************************************************
2 * meta.c : Metadata handling
3 *****************************************************************************
4 * Copyright (C) 1998-2004 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea@videolan.org>
8 * Clément Stenac <zorglub@videolan.org
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.
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.
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 *****************************************************************************/
26 #include <vlc/input.h>
28 #include "vlc_playlist.h"
30 #include "../playlist/playlist_internal.h"
32 #ifdef HAVE_SYS_STAT_H
33 # include <sys/stat.h>
36 int input_FindArtInCache( playlist_t *p_playlist, input_item_t *p_item );
38 vlc_bool_t input_MetaSatisfied( playlist_t *p_playlist, input_item_t *p_item,
39 uint32_t *pi_mandatory, uint32_t *pi_optional )
41 *pi_mandatory = VLC_META_ENGINE_TITLE | VLC_META_ENGINE_ARTIST;
42 assert( p_item->p_meta );
44 uint32_t i_meta = input_CurrentMetaFlags( p_item->p_meta );
45 *pi_mandatory &= ~i_meta;
46 *pi_optional = 0; /// Todo
47 return *pi_mandatory ? VLC_FALSE:VLC_TRUE;
50 int input_MetaFetch( playlist_t *p_playlist, input_item_t *p_item )
52 struct meta_engine_t *p_me;
53 uint32_t i_mandatory, i_optional;
55 assert( p_item->p_meta );
57 input_MetaSatisfied( p_playlist, p_item, &i_mandatory, &i_optional );
58 // Meta shouldn't magically appear
59 assert( i_mandatory );
61 /* FIXME: object creation is overkill, use p_private */
62 p_me = vlc_object_create( p_playlist, VLC_OBJECT_META_ENGINE );
63 p_me->i_flags |= OBJECT_FLAGS_NOINTERACT;
64 p_me->i_flags |= OBJECT_FLAGS_QUIET;
65 p_me->i_mandatory = i_mandatory;
66 p_me->i_optional = i_optional;
68 p_me->p_item = p_item;
69 p_me->p_module = module_Need( p_me, "meta fetcher", 0, VLC_FALSE );
72 vlc_object_destroy( p_me );
75 module_Unneed( p_me, p_me->p_module );
76 vlc_object_destroy( p_me );
82 * 1 : Art found, need to download
83 * -X : Error/not found
85 int input_ArtFind( playlist_t *p_playlist, input_item_t *p_item )
87 int i_ret = VLC_EGENERIC;
89 if( !p_item->p_meta || !p_item->p_meta->psz_album ||
90 !p_item->p_meta->psz_artist )
93 /* If we already checked this album in this session, skip */
94 FOREACH_ARRAY( playlist_album_t album, p_playlist->p_fetcher->albums )
95 if( !strcmp( album.psz_artist, p_item->p_meta->psz_artist ) &&
96 !strcmp( album.psz_album, p_item->p_meta->psz_album ) )
98 msg_Dbg( p_playlist, " %s - %s has already been searched",
99 p_item->p_meta->psz_artist, p_item->p_meta->psz_album );
102 /* Actually get URL from cache */
103 input_FindArtInCache( p_playlist, p_item );
111 input_FindArtInCache( p_playlist, p_item );
112 if( !EMPTY_STR( p_item->p_meta->psz_arturl ) )
116 p_playlist->p_private = p_item;
117 msg_Dbg( p_playlist, "searching art for %s - %s",
118 p_item->p_meta->psz_artist, p_item->p_meta->psz_album );
119 p_module = module_Need( p_playlist, "art finder", 0, VLC_FALSE );
124 msg_Dbg( p_playlist, "unable to find art" );
126 /* Record this album */
128 a.psz_artist = strdup( p_item->p_meta->psz_artist );
129 a.psz_album = strdup( p_item->p_meta->psz_album );
130 a.b_found = (i_ret == VLC_EGENERIC ? VLC_FALSE : VLC_TRUE );
131 ARRAY_APPEND( p_playlist->p_fetcher->albums, a );
134 module_Unneed( p_playlist, p_module );
135 p_playlist->p_private = NULL;
142 # define MAX_PATH 250
144 int input_FindArtInCache( playlist_t *p_playlist, input_item_t *p_item )
148 char psz_filename[MAX_PATH+1];
151 const char *ppsz_type[] = { ".jpg", ".png", ".gif", ".bmp", "" };
153 if( !p_item->p_meta ) return VLC_EGENERIC;
155 psz_artist = p_item->p_meta->psz_artist;
156 psz_album = p_item->p_meta->psz_album;
158 for( i = 0; i < 5; i++ )
160 snprintf( psz_filename, MAX_PATH,
161 "file://%s" DIR_SEP CONFIG_DIR DIR_SEP "art"
162 DIR_SEP "%s" DIR_SEP "%s" DIR_SEP "art%s",
163 p_playlist->p_libvlc->psz_homedir,
164 psz_artist, psz_album, ppsz_type[i] );
166 /* Check if file exists */
167 if( utf8_stat( psz_filename+7, &a ) == 0 )
169 vlc_meta_SetArtURL( p_item->p_meta, psz_filename );
177 * Download the art using the URL or an art downloaded
178 * This function should be called only if data is not already in cache
180 int input_DownloadAndCacheArt( playlist_t *p_playlist, input_item_t *p_item )
182 int i_status = VLC_EGENERIC;
184 char psz_filename[MAX_PATH+1], psz_dir[MAX_PATH+1];
188 psz_artist = p_item->p_meta->psz_artist;
189 psz_album = p_item->p_meta->psz_album;
191 assert( p_item->p_meta && !EMPTY_STR(p_item->p_meta->psz_arturl) );
193 /* FIXME: use an alternate saving filename scheme if we don't have
194 * the artist or album name */
195 if( !p_item->p_meta->psz_artist || !p_item->p_meta->psz_album )
198 psz_type = strrchr( p_item->p_meta->psz_arturl, '.' );
200 /* Todo: get a helper to do this */
201 snprintf( psz_filename, MAX_PATH,
202 "file://%s" DIR_SEP CONFIG_DIR DIR_SEP "art"
203 DIR_SEP "%s" DIR_SEP "%s" DIR_SEP "art%s",
204 p_playlist->p_libvlc->psz_homedir,
205 psz_artist, psz_album, psz_type );
207 snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR,
208 p_playlist->p_libvlc->psz_homedir );
209 utf8_mkdir( psz_dir );
210 snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP "art",
211 p_playlist->p_libvlc->psz_homedir );
212 utf8_mkdir( psz_dir );
213 snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
215 p_playlist->p_libvlc->psz_homedir, psz_artist );
216 utf8_mkdir( psz_dir );
217 snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
218 "art" DIR_SEP "%s" DIR_SEP "%s",
219 p_playlist->p_libvlc->psz_homedir,
220 psz_artist, psz_album );
221 utf8_mkdir( psz_dir );
223 if( !strncmp( p_item->p_meta->psz_arturl , "APIC", 4 ) )
225 msg_Warn( p_playlist, "APIC fetch not supported yet" );
229 p_stream = stream_UrlNew( p_playlist, p_item->p_meta->psz_arturl );
232 void *p_buffer = malloc( 1<<16 );
234 FILE *p_file = utf8_fopen( psz_filename+7, "w" );
235 while( ( l_read = stream_Read( p_stream, p_buffer, 1<<16 ) ) )
237 fwrite( p_buffer, l_read, 1, p_file );
241 stream_Delete( p_stream );
242 msg_Dbg( p_playlist, "album art saved to %s\n", psz_filename );
243 free( p_item->p_meta->psz_arturl );
244 p_item->p_meta->psz_arturl = strdup( psz_filename );
245 i_status = VLC_SUCCESS;
250 uint32_t input_CurrentMetaFlags( vlc_meta_t *p_meta )
254 #define CHECK( a, b ) \
255 if( p_meta->psz_ ## a && *p_meta->psz_ ## a ) \
256 i_meta |= VLC_META_ENGINE_ ## b;
258 CHECK( title, TITLE )
259 CHECK( artist, ARTIST )
260 CHECK( album, COLLECTION )
262 /* As this is not used at the moment, don't uselessly check for it.
263 * Re-enable this when it is used */
264 CHECK( genre, GENRE )
265 CHECK( copyright, COPYRIGHT )
266 CHECK( tracknum, SEQ_NUM )
267 CHECK( description, DESCRIPTION )
268 CHECK( rating, RATING )
271 CHECK( language, LANGUAGE )
273 CHECK( arturl, ART_URL )