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