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 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include <vlc_common.h>
  30 #include <vlc_playlist.h>
  31 #include <vlc_url.h>
  32 #include <vlc_arrays.h>
  33 #include <vlc_modules.h>
  34
  35 #include "input_internal.h"
  36 #include "../playlist/art.h"
  37
  38 struct vlc_meta_t
  39 {
  40     char * ppsz_meta[VLC_META_TYPE_COUNT];
  41
  42     vlc_dictionary_t extra_tags;
  43
  44     int i_status;
  45 };
  46
  47 /* FIXME bad name convention */
  48 const char * vlc_meta_TypeToLocalizedString( vlc_meta_type_t meta_type )
  49 {
  50     switch( meta_type )
  51     {
  52     case vlc_meta_Title:        return _("Title");
  53     case vlc_meta_Artist:       return _("Artist");
  54     case vlc_meta_Genre:        return _("Genre");
  55     case vlc_meta_Copyright:    return _("Copyright");
  56     case vlc_meta_Album:        return _("Album");
  57     case vlc_meta_TrackNumber:  return _("Track number");
  58     case vlc_meta_Description:  return _("Description");
  59     case vlc_meta_Rating:       return _("Rating");
  60     case vlc_meta_Date:         return _("Date");
  61     case vlc_meta_Setting:      return _("Setting");
  62     case vlc_meta_URL:          return _("URL");
  63     case vlc_meta_Language:     return _("Language");
  64     case vlc_meta_NowPlaying:   return _("Now Playing");
  65     case vlc_meta_Publisher:    return _("Publisher");
  66     case vlc_meta_EncodedBy:    return _("Encoded by");
  67     case vlc_meta_ArtworkURL:   return _("Artwork URL");
  68     case vlc_meta_TrackID:      return _("Track ID");
  69
  70     default: abort();
  71     }
  72 };
  73
  74
  75 /**
  76  * vlc_meta contructor.
  77  * vlc_meta_Delete() will free the returned pointer.
  78  */
  79 vlc_meta_t *vlc_meta_New( void )
  80 {
  81     vlc_meta_t *m = (vlc_meta_t*)malloc( sizeof(*m) );
  82     if( !m )
  83         return NULL;
  84     memset( m->ppsz_meta, 0, sizeof(m->ppsz_meta) );
  85     m->i_status = 0;
  86     vlc_dictionary_init( &m->extra_tags, 0 );
  87     return m;
  88 }
  89
  90 /* Free a dictonary key allocated by strdup() in vlc_meta_AddExtra() */
  91 static void vlc_meta_FreeExtraKey( void *p_data, void *p_obj )
  92 {
  93     VLC_UNUSED( p_obj );
  94     free( p_data );
  95 }
  96
  97 void vlc_meta_Delete( vlc_meta_t *m )
  98 {
  99     int i;
 100     for( i = 0; i < VLC_META_TYPE_COUNT ; i++ )
 101         free( m->ppsz_meta[i] );
 102     vlc_dictionary_clear( &m->extra_tags, vlc_meta_FreeExtraKey, NULL );
 103     free( m );
 104 }
 105
 106 /**
 107  * vlc_meta has two kinds of meta, the one in a table, and the one in a
 108  * dictionary.
 109  * FIXME - Why don't we merge those two?
 110  */
 111
 112 void vlc_meta_Set( vlc_meta_t *p_meta, vlc_meta_type_t meta_type, const char *psz_val )
 113 {
 114     free( p_meta->ppsz_meta[meta_type] );
 115     p_meta->ppsz_meta[meta_type] = psz_val ? strdup( psz_val ) : NULL;
 116 }
 117
 118 const char *vlc_meta_Get( const vlc_meta_t *p_meta, vlc_meta_type_t meta_type )
 119 {
 120     return p_meta->ppsz_meta[meta_type];
 121 }
 122
 123 void vlc_meta_AddExtra( vlc_meta_t *m, const char *psz_name, const char *psz_value )
 124 {
 125     char *psz_oldvalue = (char *)vlc_dictionary_value_for_key( &m->extra_tags, psz_name );
 126     if( psz_oldvalue != kVLCDictionaryNotFound )
 127         vlc_dictionary_remove_value_for_key( &m->extra_tags, psz_name,
 128                                             vlc_meta_FreeExtraKey, NULL );
 129     vlc_dictionary_insert( &m->extra_tags, psz_name, strdup(psz_value) );
 130 }
 131
 132 const char * vlc_meta_GetExtra( const vlc_meta_t *m, const char *psz_name )
 133 {
 134     return (char *)vlc_dictionary_value_for_key(&m->extra_tags, psz_name);
 135 }
 136
 137 unsigned vlc_meta_GetExtraCount( const vlc_meta_t *m )
 138 {
 139     return vlc_dictionary_keys_count(&m->extra_tags);
 140 }
 141
 142 char** vlc_meta_CopyExtraNames( const vlc_meta_t *m )
 143 {
 144     return vlc_dictionary_all_keys(&m->extra_tags);
 145 }
 146
 147 /**
 148  * vlc_meta status (see vlc_meta_status_e)
 149  */
 150 int vlc_meta_GetStatus( vlc_meta_t *m )
 151 {
 152     return m->i_status;
 153 }
 154
 155 void vlc_meta_SetStatus( vlc_meta_t *m, int status )
 156 {
 157     m->i_status = status;
 158 }
 159
 160
 161 /**
 162  * Merging meta
 163  */
 164 void vlc_meta_Merge( vlc_meta_t *dst, const vlc_meta_t *src )
 165 {
 166     char **ppsz_all_keys;
 167     int i;
 168
 169     if( !dst || !src )
 170         return;
 171
 172     for( i = 0; i < VLC_META_TYPE_COUNT; i++ )
 173     {
 174         if( src->ppsz_meta[i] )
 175         {
 176             free( dst->ppsz_meta[i] );
 177             dst->ppsz_meta[i] = strdup( src->ppsz_meta[i] );
 178         }
 179     }
 180
 181     /* XXX: If speed up are needed, it is possible */
 182     ppsz_all_keys = vlc_dictionary_all_keys( &src->extra_tags );
 183     for( i = 0; ppsz_all_keys && ppsz_all_keys[i]; i++ )
 184     {
 185         /* Always try to remove the previous value */
 186         vlc_dictionary_remove_value_for_key( &dst->extra_tags, ppsz_all_keys[i], vlc_meta_FreeExtraKey, NULL );
 187
 188         void *p_value = vlc_dictionary_value_for_key( &src->extra_tags, ppsz_all_keys[i] );
 189         vlc_dictionary_insert( &dst->extra_tags, ppsz_all_keys[i], strdup( (const char*)p_value ) );
 190         free( ppsz_all_keys[i] );
 191     }
 192     free( ppsz_all_keys );
 193 }
 194
 195
 196 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input )
 197 {
 198     input_item_t *p_item = p_input->p->p_item;
 199
 200     /* */
 201     char *psz_arturl = input_item_GetArtURL( p_item );
 202     if( !psz_arturl || strncmp( psz_arturl, "attachment://", strlen("attachment://") ) )
 203     {
 204         msg_Err( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 205         free( psz_arturl );
 206         return;
 207     }
 208
 209     playlist_t *p_playlist = pl_Get( p_input );
 210
 211     if( input_item_IsArtFetched( p_item ) )
 212     {
 213         /* XXX Weird, we should not have end up with attachment:// art url unless there is a race
 214          * condition */
 215         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 216         playlist_FindArtInCache( p_item );
 217         goto exit;
 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         if( !strcmp( p_input->p->attachment[i_idx]->psz_name,
 227                      &psz_arturl[strlen("attachment://")] ) )
 228         {
 229             p_attachment = vlc_input_attachment_Duplicate( p_input->p->attachment[i_idx] );
 230             break;
 231         }
 232     }
 233     vlc_mutex_unlock( &p_item->lock );
 234
 235     if( !p_attachment || p_attachment->i_data <= 0 )
 236     {
 237         if( p_attachment )
 238             vlc_input_attachment_Delete( p_attachment );
 239         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 240         goto exit;
 241     }
 242
 243     /* */
 244     const char *psz_type = NULL;
 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
 250     /* */
 251     playlist_SaveArt( p_playlist, p_item,
 252                       p_attachment->p_data, p_attachment->i_data, psz_type );
 253
 254     vlc_input_attachment_Delete( p_attachment );
 255
 256 exit:
 257     free( psz_arturl );
 258 }
 259
 260 int input_item_WriteMeta( vlc_object_t *obj, input_item_t *p_item )
 261 {
 262     meta_export_t *p_export =
 263         vlc_custom_create( obj, sizeof( *p_export ), VLC_OBJECT_GENERIC,
 264                            "meta writer" );
 265     if( p_export == NULL )
 266         return VLC_ENOMEM;
 267     vlc_object_attach( p_export, obj );
 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 }