Some more meta changes (mostly cleanup and check the i_mandatory flags)
[vlc.git] / src / input / meta.c
1 /*****************************************************************************
2  * meta.c : Metadata handling
3  *****************************************************************************
4  * Copyright (C) 1998-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea@videolan.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
25 #include <vlc/vlc.h>
26 #include <vlc/input.h>
27 #include <vlc_meta.h>
28 #include "vlc_playlist.h"
29 #include "charset.h"
30
31 #ifdef HAVE_SYS_STAT_H
32 #   include <sys/stat.h>
33 #endif
34
35 int input_FindArt( vlc_object_t *p_parent, input_item_t *p_item );
36
37 int __input_MetaFetch( vlc_object_t *p_parent, input_item_t *p_item )
38 {
39     struct meta_engine_t *p_me;
40     uint32_t i_mandatory = 0, i_optional = 0, i_meta;
41     int i_policy;
42
43     if( !p_item->p_meta ) return VLC_EGENERIC;
44
45     i_policy = var_CreateGetInteger( p_parent, "album-art" );
46
47     i_mandatory =   VLC_META_ENGINE_TITLE
48                   | VLC_META_ENGINE_ARTIST;
49     if( i_policy == ALBUM_ART_ALL )
50     {
51         i_mandatory |= VLC_META_ENGINE_ART_URL;
52     }
53     else
54     {
55         i_optional |= VLC_META_ENGINE_ART_URL;
56     }
57
58     input_FindArt( p_parent, p_item );
59
60     i_meta = input_GetMetaEngineFlags( p_item->p_meta );
61     i_mandatory &= ~i_meta;
62     i_optional &= ~i_meta;
63
64     if( !i_mandatory ) return VLC_SUCCESS;
65
66     p_me = vlc_object_create( p_parent, VLC_OBJECT_META_ENGINE );
67     p_me->i_flags |= OBJECT_FLAGS_NOINTERACT;
68     p_me->i_mandatory = i_mandatory;
69     p_me->i_optional = i_optional;
70
71     p_me->p_item = p_item;
72     p_me->p_module = module_Need( p_me, "meta fetcher", 0, VLC_FALSE );
73     vlc_object_attach( p_me, p_parent );
74     if( !p_me->p_module )
75     {
76         msg_Err( p_parent, "no suitable meta fetcher module" );
77         vlc_object_detach( p_me );
78         vlc_object_destroy( p_me );
79         return VLC_EGENERIC;
80     }
81
82     module_Unneed( p_me, p_me->p_module );
83
84     vlc_object_detach( p_me );
85     vlc_object_destroy( p_me );
86
87     return VLC_SUCCESS;
88 }
89
90 #ifndef MAX_PATH
91 #   define MAX_PATH 250
92 #endif
93 int input_FindArt( vlc_object_t *p_parent, input_item_t *p_item )
94 {
95     char *psz_artist;
96     char *psz_album;
97     char *psz_type;
98     char psz_filename[MAX_PATH];
99     int i;
100     struct stat a;
101     const char ppsz_type[] = { ".jpg", ".png", ".gif", ".bmp", "" };
102
103     if( !p_item->p_meta ) return VLC_EGENERIC;
104
105     psz_artist = p_item->p_meta->psz_artist;
106     psz_album = p_item->p_meta->psz_album;
107
108     for( i = 0; i < 5; i++ )
109     {
110         snprintf( psz_filename, MAX_PATH,
111                   "file://%s" DIR_SEP CONFIG_DIR DIR_SEP "art"
112                   DIR_SEP "%s" DIR_SEP "%s" DIR_SEP "art%s",
113                   p_parent->p_libvlc->psz_homedir,
114                   psz_artist, psz_album, psz_type );
115
116         /* Check if file exists */
117         if( utf8_stat( psz_filename+7, &a ) == 0 )
118         {
119             msg_Dbg( p_parent, "album art %s already exists in cache"
120                              , psz_filename );
121             return VLC_SUCCESS;
122         }
123     }
124
125     /* Use a art finder module to find the URL */
126     return VLC_EGENERIC;
127 }
128
129 /**
130  * Download the art using the URL or an art downloaded
131  * This function should be called only if data is not already in cache
132  */
133 int input_DownloadAndCacheArt( vlc_object_t *p_parent, input_item_t *p_item )
134 {
135     int i_status = VLC_EGENERIC;
136     stream_t *p_stream;
137     char psz_filename[MAX_PATH], psz_dir[MAX_PATH];
138     char *psz_artist;
139     char *psz_album;
140     char *psz_type;
141     psz_artist = p_item->p_meta->psz_artist;
142     psz_album = p_item->p_meta->psz_album;
143
144     /* You dummy ! How am I supposed to download NULL ? */
145     if( !p_item->p_meta || !p_item->p_meta->psz_arturl
146                         || !*p_item->p_meta->psz_arturl )
147         return VLC_EGENERIC;
148
149     psz_type = strrchr( p_item->p_meta->psz_arturl, '.' );
150
151     /* Todo: get a helper to do this */
152     snprintf( psz_filename, MAX_PATH,
153               "file://%s" DIR_SEP CONFIG_DIR DIR_SEP "art"
154               DIR_SEP "%s" DIR_SEP "%s" DIR_SEP "art%s",
155               p_parent->p_libvlc->psz_homedir,
156               psz_artist, psz_album, psz_type );
157
158     snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR,
159               p_parent->p_libvlc->psz_homedir );
160     utf8_mkdir( psz_dir );
161     snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP "art",
162               p_parent->p_libvlc->psz_homedir );
163     utf8_mkdir( psz_dir );
164     snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
165               "art" DIR_SEP "%s",
166                  p_parent->p_libvlc->psz_homedir, psz_artist );
167     utf8_mkdir( psz_dir );
168     snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
169               "art" DIR_SEP "%s" DIR_SEP "%s",
170                       p_parent->p_libvlc->psz_homedir,
171                       psz_artist, psz_album );
172     utf8_mkdir( psz_dir );
173
174     /* Todo: check for stuff that needs a downloader module */
175     p_stream = stream_UrlNew( p_parent, p_item->p_meta->psz_arturl );
176
177     if( p_stream )
178     {
179         void *p_buffer = malloc( 1<<16 );
180         long int l_read;
181         FILE *p_file = utf8_fopen( psz_filename+7, "w" );
182         while( ( l_read = stream_Read( p_stream, p_buffer, 1<<16 ) ) )
183         {
184             fwrite( p_buffer, l_read, 1, p_file );
185         }
186         free( p_buffer );
187         fclose( p_file );
188         stream_Delete( p_stream );
189         msg_Dbg( p_parent, "Album art saved to %s\n", psz_filename );
190         free( p_item->p_meta->psz_arturl );
191         p_item->p_meta->psz_arturl = strdup( psz_filename );
192         i_status = VLC_SUCCESS;
193     }
194     return i_status;
195 }
196
197 uint32_t input_GetMetaEngineFlags( vlc_meta_t *p_meta )
198 {
199     uint32_t i_meta = 0;
200
201 #define CHECK( a, b ) \
202     if( p_meta->psz_ ## a && *p_meta->psz_ ## a ) \
203         i_meta |= VLC_META_ENGINE_ ## b;
204
205     CHECK( title, TITLE )
206     CHECK( author, AUTHOR )
207     CHECK( artist, ARTIST )
208     CHECK( genre, GENRE )
209     CHECK( copyright, COPYRIGHT )
210     CHECK( album, COLLECTION )
211     CHECK( tracknum, SEQ_NUM )
212     CHECK( description, DESCRIPTION )
213     CHECK( rating, RATING )
214     CHECK( date, DATE )
215     CHECK( url, URL )
216     CHECK( language, LANGUAGE )
217     CHECK( arturl, ART_URL )
218
219     return i_meta;
220 }