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