src/input/meta.c

   1 /*****************************************************************************
   2  * meta.c : Metadata handling
   3  *****************************************************************************
   4  * Copyright (C) 1998-2004 VLC authors and VideoLAN
   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 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
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include <assert.h>
  30
  31 #include <vlc_common.h>
  32 #include <vlc_playlist.h>
  33 #include <vlc_url.h>
  34 #include <vlc_arrays.h>
  35 #include <vlc_modules.h>
  36 #include <vlc_charset.h>
  37
  38 #include "input_internal.h"
  39 #include "../playlist/art.h"
  40
  41 struct vlc_meta_t
  42 {
  43     char * ppsz_meta[VLC_META_TYPE_COUNT];
  44
  45     vlc_dictionary_t extra_tags;
  46
  47     int i_status;
  48 };
  49
  50 /* FIXME bad name convention */
  51 const char * vlc_meta_TypeToLocalizedString( vlc_meta_type_t meta_type )
  52 {
  53     static const char posix_names[][18] =
  54     {
  55         [vlc_meta_Title]       = N_("Title"),
  56         [vlc_meta_Artist]      = N_("Artist"),
  57         [vlc_meta_Genre]       = N_("Genre"),
  58         [vlc_meta_Copyright]   = N_("Copyright"),
  59         [vlc_meta_Album]       = N_("Album"),
  60         [vlc_meta_TrackNumber] = N_("Track number"),
  61         [vlc_meta_Description] = N_("Description"),
  62         [vlc_meta_Rating]      = N_("Rating"),
  63         [vlc_meta_Date]        = N_("Date"),
  64         [vlc_meta_Setting]     = N_("Setting"),
  65         [vlc_meta_URL]         = N_("URL"),
  66         [vlc_meta_Language]    = N_("Language"),
  67         [vlc_meta_ESNowPlaying]= N_("Now Playing"),
  68         [vlc_meta_NowPlaying]  = N_("Now Playing"),
  69         [vlc_meta_Publisher]   = N_("Publisher"),
  70         [vlc_meta_EncodedBy]   = N_("Encoded by"),
  71         [vlc_meta_ArtworkURL]  = N_("Artwork URL"),
  72         [vlc_meta_TrackID]     = N_("Track ID"),
  73         [vlc_meta_TrackTotal]  = N_("Number of Tracks"),
  74         [vlc_meta_Director]    = N_("Director"),
  75         [vlc_meta_Season]      = N_("Season"),
  76         [vlc_meta_Episode]     = N_("Episode"),
  77         [vlc_meta_ShowName]    = N_("Show Name"),
  78         [vlc_meta_Actors]      = N_("Actors"),
  79         [vlc_meta_AlbumArtist] = N_("Album Artist"),
  80         [vlc_meta_DiscNumber]  = N_("Disc number")
  81     };
  82
  83     assert (meta_type < (sizeof(posix_names) / sizeof(posix_names[0])));
  84     return vlc_gettext (posix_names[meta_type]);
  85 };
  86
  87
  88 /**
  89  * vlc_meta contructor.
  90  * vlc_meta_Delete() will free the returned pointer.
  91  */
  92 vlc_meta_t *vlc_meta_New( void )
  93 {
  94     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof(*m) );
  95     if( !m )
  96         return NULL;
  97     memset( m->ppsz_meta, 0, sizeof(m->ppsz_meta) );
  98     m->i_status = 0;
  99     vlc_dictionary_init( &m->extra_tags, 0 );
 100     return m;
 101 }
 102
 103 /* Free a dictonary key allocated by strdup() in vlc_meta_AddExtra() */
 104 static void vlc_meta_FreeExtraKey( void *p_data, void *p_obj )
 105 {
 106     VLC_UNUSED( p_obj );
 107     free( p_data );
 108 }
 109
 110 void vlc_meta_Delete( vlc_meta_t *m )
 111 {
 112     for( int i = 0; i < VLC_META_TYPE_COUNT ; i++ )
 113         free( m->ppsz_meta[i] );
 114     vlc_dictionary_clear( &m->extra_tags, vlc_meta_FreeExtraKey, NULL );
 115     free( m );
 116 }
 117
 118 /**
 119  * vlc_meta has two kinds of meta, the one in a table, and the one in a
 120  * dictionary.
 121  * FIXME - Why don't we merge those two?
 122  */
 123
 124 void vlc_meta_Set( vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val )
 125 {
 126     free( p_meta->ppsz_meta[meta_type] );
 127     assert( psz_val == NULL || IsUTF8( psz_val ) );
 128     p_meta->ppsz_meta[meta_type] = psz_val ? strdup( psz_val ) : NULL;
 129 }
 130
 131 const char *vlc_meta_Get( const vlc_meta_t *p_meta, vlc_meta_type_t meta_type )
 132 {
 133     return p_meta->ppsz_meta[meta_type];
 134 }
 135
 136 void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
 137 {
 138     char *psz_oldvalue = (char *)vlc_dictionary_value_for_key( &m->extra_tags, psz_name );
 139     if( psz_oldvalue != kVLCDictionaryNotFound )
 140         vlc_dictionary_remove_value_for_key( &m->extra_tags, psz_name,
 141                                             vlc_meta_FreeExtraKey, NULL );
 142     vlc_dictionary_insert( &m->extra_tags, psz_name, strdup(psz_value) );
 143 }
 144
 145 const char * vlc_meta_GetExtra( const vlc_meta_t *m, const char *psz_name )
 146 {
 147     return (char *)vlc_dictionary_value_for_key(&m->extra_tags, psz_name);
 148 }
 149
 150 unsigned vlc_meta_GetExtraCount( const vlc_meta_t *m )
 151 {
 152     return vlc_dictionary_keys_count(&m->extra_tags);
 153 }
 154
 155 char** vlc_meta_CopyExtraNames( const vlc_meta_t *m )
 156 {
 157     return vlc_dictionary_all_keys(&m->extra_tags);
 158 }
 159
 160 /**
 161  * vlc_meta status (see vlc_meta_status_e)
 162  */
 163 int vlc_meta_GetStatus( vlc_meta_t *m )
 164 {
 165     return m->i_status;
 166 }
 167
 168 void vlc_meta_SetStatus( vlc_meta_t *m, int status )
 169 {
 170     m->i_status = status;
 171 }
 172
 173
 174 /**
 175  * Merging meta
 176  */
 177 void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 178 {
 179     if( !dst || !src )
 180         return;
 181
 182     for( int i = 0; i < VLC_META_TYPE_COUNT; i++ )
 183     {
 184         if( src->ppsz_meta[i] )
 185         {
 186             free( dst->ppsz_meta[i] );
 187             dst->ppsz_meta[i] = strdup( src->ppsz_meta[i] );
 188         }
 189     }
 190
 191     /* XXX: If speed up are needed, it is possible */
 192     char **ppsz_all_keys = vlc_dictionary_all_keys( &src->extra_tags );
 193     for( int i = 0; ppsz_all_keys && ppsz_all_keys[i]; i++ )
 194     {
 195         /* Always try to remove the previous value */
 196         vlc_dictionary_remove_value_for_key( &dst->extra_tags, ppsz_all_keys[i], vlc_meta_FreeExtraKey, NULL );
 197
 198         void *p_value = vlc_dictionary_value_for_key( &src->extra_tags, ppsz_all_keys[i] );
 199         vlc_dictionary_insert( &dst->extra_tags, ppsz_all_keys[i], strdup( (const char*)p_value ) );
 200         free( ppsz_all_keys[i] );
 201     }
 202     free( ppsz_all_keys );
 203 }
 204
 205
 206 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input,
 207                                          const char *name )
 208 {
 209     input_item_t *p_item = input_priv(p_input)->p_item;
 210
 211     if( input_item_IsArtFetched( p_item ) )
 212     {   /* XXX Weird, we should not end up with attachment:// art URL
 213          * unless there is a race condition */
 214         msg_Warn( p_input, "art already fetched" );
 215         if( likely(playlist_FindArtInCache( p_item ) == VLC_SUCCESS) )
 216             return;
 217     }
 218
 219     /* */
 220     input_attachment_t *p_attachment = NULL;
 221
 222     vlc_mutex_lock( &p_item->lock );
 223     for( int i_idx = 0; i_idx < input_priv(p_input)->i_attachment; i_idx++ )
 224     {
 225         input_attachment_t *a = input_priv(p_input)->attachment[i_idx];
 226
 227         if( !strcmp( a->psz_name, name ) )
 228         {
 229             p_attachment = vlc_input_attachment_Duplicate( a );
 230             break;
 231         }
 232     }
 233     vlc_mutex_unlock( &p_item->lock );
 234
 235     if( p_attachment == NULL )
 236     {
 237         msg_Warn( p_input, "art attachment %s not found", name );
 238         return;
 239     }
 240
 241     /* */
 242     const char *psz_type = NULL;
 243
 244     if( !strcmp( p_attachment->psz_mime, "image/jpeg" ) )
 245         psz_type = ".jpg";
 246     else if( !strcmp( p_attachment->psz_mime, "image/png" ) )
 247         psz_type = ".png";
 248     else if( !strcmp( p_attachment->psz_mime, "image/x-pict" ) )
 249         psz_type = ".pct";
 250
 251     playlist_SaveArt( VLC_OBJECT(p_input), p_item,
 252                       p_attachment->p_data, p_attachment->i_data, psz_type );
 253     vlc_input_attachment_Delete( p_attachment );
 254 }
 255
 256 int input_item_WriteMeta( vlc_object_t *obj, input_item_t *p_item )
 257 {
 258     meta_export_t *p_export =
 259         vlc_custom_create( obj, sizeof( *p_export ), "meta writer" );
 260     if( p_export == NULL )
 261         return VLC_ENOMEM;
 262     p_export->p_item = p_item;
 263
 264     int type;
 265     vlc_mutex_lock( &p_item->lock );
 266     type = p_item->i_type;
 267     vlc_mutex_unlock( &p_item->lock );
 268     if( type != ITEM_TYPE_FILE )
 269         goto error;
 270
 271     char *psz_uri = input_item_GetURI( p_item );
 272     p_export->psz_file = vlc_uri2path( psz_uri );
 273     if( p_export->psz_file == NULL )
 274         msg_Err( p_export, "cannot write meta to remote media %s", psz_uri );
 275     free( psz_uri );
 276     if( p_export->psz_file == NULL )
 277         goto error;
 278
 279     module_t *p_mod = module_need( p_export, "meta writer", NULL, false );
 280     if( p_mod )
 281         module_unneed( p_export, p_mod );
 282     vlc_object_release( p_export );
 283     return VLC_SUCCESS;
 284
 285 error:
 286     vlc_object_release( p_export );
 287     return VLC_EGENERIC;
 288 }
 289
 290 void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 291                                           const vlc_meta_t *p_meta )
 292 {
 293     const char * psz_value;
 294
 295     if( !p_meta )
 296         return;
 297
 298     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) ||
 299         (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) )
 300     {
 301         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
 302         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = us_atof( psz_value );
 303     }
 304
 305     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) ||
 306              (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) )
 307     {
 308         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
 309         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = us_atof( psz_value );
 310     }
 311
 312     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) ||
 313              (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) )
 314     {
 315         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
 316         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = us_atof( psz_value );
 317     }
 318
 319     if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) )
 320     {
 321         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
 322         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = us_atof( psz_value );
 323     }
 324 }