git.sesse.net Git - vlc/blob - src/control/media_descriptor.c

   1 /*****************************************************************************
   2  * media_descriptor.c: Libvlc API media descripor management
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include <vlc/libvlc.h>
  25 #include <vlc_input.h>
  26 #include <vlc_meta.h>
  27
  28 /* For the preparser */
  29 #include <vlc_playlist.h>
  30
  31 #include "libvlc_internal.h"
  32
  33 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
  34 {
  35     [libvlc_meta_Title]        = vlc_meta_Title,
  36     [libvlc_meta_Artist]       = vlc_meta_Artist,
  37     [libvlc_meta_Genre]        = vlc_meta_Genre,
  38     [libvlc_meta_Copyright]    = vlc_meta_Copyright,
  39     [libvlc_meta_Album]        = vlc_meta_Album,
  40     [libvlc_meta_TrackNumber]  = vlc_meta_TrackNumber,
  41     [libvlc_meta_Description]  = vlc_meta_Description,
  42     [libvlc_meta_Rating]       = vlc_meta_Rating,
  43     [libvlc_meta_Date]         = vlc_meta_Date,
  44     [libvlc_meta_Setting]      = vlc_meta_Setting,
  45     [libvlc_meta_URL]          = vlc_meta_URL,
  46     [libvlc_meta_Language]     = vlc_meta_Language,
  47     [libvlc_meta_NowPlaying]   = vlc_meta_NowPlaying,
  48     [libvlc_meta_Publisher]    = vlc_meta_Publisher,
  49     [libvlc_meta_EncodedBy]    = vlc_meta_EncodedBy,
  50     [libvlc_meta_ArtworkURL]   = vlc_meta_ArtworkURL,
  51     [libvlc_meta_TrackID]      = vlc_meta_TrackID
  52 };
  53
  54 static const libvlc_meta_t vlc_to_libvlc_meta[] =
  55 {
  56     [vlc_meta_Title]        = libvlc_meta_Title,
  57     [vlc_meta_Artist]       = libvlc_meta_Artist,
  58     [vlc_meta_Genre]        = libvlc_meta_Genre,
  59     [vlc_meta_Copyright]    = libvlc_meta_Copyright,
  60     [vlc_meta_Album]        = libvlc_meta_Album,
  61     [vlc_meta_TrackNumber]  = libvlc_meta_TrackNumber,
  62     [vlc_meta_Description]  = libvlc_meta_Description,
  63     [vlc_meta_Rating]       = libvlc_meta_Rating,
  64     [vlc_meta_Date]         = libvlc_meta_Date,
  65     [vlc_meta_Setting]      = libvlc_meta_Setting,
  66     [vlc_meta_URL]          = libvlc_meta_URL,
  67     [vlc_meta_Language]     = libvlc_meta_Language,
  68     [vlc_meta_NowPlaying]   = libvlc_meta_NowPlaying,
  69     [vlc_meta_Publisher]    = libvlc_meta_Publisher,
  70     [vlc_meta_EncodedBy]    = libvlc_meta_EncodedBy,
  71     [vlc_meta_ArtworkURL]   = libvlc_meta_ArtworkURL,
  72     [vlc_meta_TrackID]      = libvlc_meta_TrackID
  73 };
  74
  75 /**************************************************************************
  76  * input_item_subitem_added (Private) (vlc event Callback)
  77  **************************************************************************/
  78 static void input_item_subitem_added( const vlc_event_t *p_event,
  79                                        void * user_data )
  80 {
  81     libvlc_media_descriptor_t * p_md = user_data;
  82     libvlc_media_descriptor_t * p_md_child;
  83     libvlc_event_t event;
  84
  85     p_md_child = libvlc_media_descriptor_new_from_input_item(
  86                 p_md->p_libvlc_instance,
  87                 p_event->u.input_item_subitem_added.p_new_child, NULL );
  88
  89     /* Add this to our media list */
  90     if( !p_md->p_subitems )
  91         p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
  92     if( !p_md->p_subitems )
  93     {
  94         libvlc_media_list_add_media_descriptor( p_md->p_subitems, p_md_child, NULL );
  95     }
  96
  97     /* Construct the event */
  98     event.type = libvlc_MediaDescriptorSubItemAdded;
  99     event.u.media_descriptor_subitem_added.new_child = p_md_child;
 100
 101     /* Send the event */
 102     libvlc_event_send( p_md->p_event_manager, &event );
 103     libvlc_media_descriptor_release( p_md_child );
 104 }
 105
 106 /**************************************************************************
 107  * input_item_meta_changed (Private) (vlc event Callback)
 108  **************************************************************************/
 109 static void input_item_meta_changed( const vlc_event_t *p_event,
 110                                      void * user_data )
 111 {
 112     libvlc_media_descriptor_t * p_md = user_data;
 113     libvlc_event_t event;
 114
 115     /* Construct the event */
 116     event.type = libvlc_MediaDescriptorMetaChanged;
 117     event.u.media_descriptor_meta_changed.meta_type =
 118         vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
 119
 120     /* Send the event */
 121     libvlc_event_send( p_md->p_event_manager, &event );
 122 }
 123
 124
 125 /**************************************************************************
 126  * Install event handler (Private)
 127  **************************************************************************/
 128 static void install_input_item_observer( libvlc_media_descriptor_t *p_md )
 129 {
 130     vlc_event_attach( &p_md->p_input_item->event_manager,
 131                       vlc_InputItemSubItemAdded,
 132                       input_item_subitem_added,
 133                       p_md );
 134     vlc_event_attach( &p_md->p_input_item->event_manager,
 135                       vlc_InputItemMetaChanged,
 136                       input_item_meta_changed,
 137                       p_md );
 138 }
 139
 140 /**************************************************************************
 141  * Uninstall event handler (Private)
 142  **************************************************************************/
 143 static void uninstall_input_item_observer( libvlc_media_descriptor_t *p_md )
 144 {
 145     vlc_event_detach( &p_md->p_input_item->event_manager,
 146                       vlc_InputItemSubItemAdded,
 147                       input_item_subitem_added,
 148                       p_md );
 149     vlc_event_detach( &p_md->p_input_item->event_manager,
 150                       vlc_InputItemMetaChanged,
 151                       input_item_meta_changed,
 152                       p_md );
 153 }
 154
 155 /**************************************************************************
 156  * Preparse if not already done (Private)
 157  **************************************************************************/
 158 static void preparse_if_needed( libvlc_media_descriptor_t *p_md )
 159 {
 160     /* XXX: need some locking here */
 161     if (!p_md->b_preparsed)
 162     {
 163         playlist_PreparseEnqueue(
 164                 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
 165                 p_md->p_input_item );
 166         playlist_AskForArtEnqueue(
 167                 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
 168                 p_md->p_input_item );
 169
 170         p_md->b_preparsed = VLC_TRUE;
 171     }
 172 }
 173
 174 /**************************************************************************
 175  * Create a new media descriptor object from an input_item
 176  * (libvlc internal)
 177  * That's the generic constructor
 178  **************************************************************************/
 179 libvlc_media_descriptor_t * libvlc_media_descriptor_new_from_input_item(
 180                                    libvlc_instance_t *p_instance,
 181                                    input_item_t *p_input_item,
 182                                    libvlc_exception_t *p_e )
 183 {
 184     libvlc_media_descriptor_t * p_md;
 185
 186     if (!p_input_item)
 187     {
 188         libvlc_exception_raise( p_e, "No input item given" );
 189         return NULL;
 190     }
 191
 192     p_md = malloc( sizeof(libvlc_media_descriptor_t) );
 193     p_md->p_libvlc_instance = p_instance;
 194     p_md->p_input_item      = p_input_item;
 195     p_md->b_preparsed       = VLC_TRUE;
 196     p_md->i_refcount        = 1;
 197
 198     /* A media descriptor can be a playlist. When you open a playlist
 199      * It can give a bunch of item to read. */
 200     p_md->p_subitems        = NULL;
 201
 202     vlc_dictionary_init( &p_md->tags, 1 );
 203
 204     p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance, p_e );
 205     libvlc_event_manager_register_event_type( p_md->p_event_manager,
 206         libvlc_MediaDescriptorMetaChanged, p_e );
 207     libvlc_event_manager_register_event_type( p_md->p_event_manager,
 208         libvlc_MediaDescriptorSubItemAdded, p_e );
 209
 210     vlc_gc_incref( p_md->p_input_item );
 211
 212     install_input_item_observer( p_md );
 213
 214     return p_md;
 215 }
 216
 217 /**************************************************************************
 218  * Create a new media descriptor object
 219  **************************************************************************/
 220 libvlc_media_descriptor_t * libvlc_media_descriptor_new(
 221                                    libvlc_instance_t *p_instance,
 222                                    const char * psz_mrl,
 223                                    libvlc_exception_t *p_e )
 224 {
 225     input_item_t * p_input_item;
 226     libvlc_media_descriptor_t * p_md;
 227
 228     p_input_item = input_ItemNew( p_instance->p_libvlc_int, psz_mrl, NULL );
 229
 230     if (!p_input_item)
 231     {
 232         libvlc_exception_raise( p_e, "Can't create md's input_item" );
 233         return NULL;
 234     }
 235
 236     p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
 237                 p_input_item, p_e );
 238
 239     return p_md;
 240 }
 241
 242 /**************************************************************************
 243  * Delete a media descriptor object
 244  **************************************************************************/
 245 void libvlc_media_descriptor_release( libvlc_media_descriptor_t *p_md )
 246 {
 247     int i;
 248     if (!p_md)
 249         return;
 250
 251     p_md->i_refcount--;
 252
 253     if( p_md->i_refcount > 0 )
 254         return;
 255
 256     libvlc_media_list_release( p_md->p_subitems );
 257
 258     uninstall_input_item_observer( p_md );
 259     vlc_gc_decref( p_md->p_input_item );
 260
 261     char ** all_keys = vlc_dictionary_all_keys( &p_md->tags );
 262     for( i = 0; all_keys[i]; i++ )
 263     {
 264         int j;
 265         struct libvlc_tags_storage_t * p_ts = vlc_dictionary_value_for_key( &p_md->tags, all_keys[i] );
 266         for( j = 0; j < p_ts->i_count; j++ )
 267         {
 268             free( p_ts->ppsz_tags[j] );
 269             free( p_ts->ppsz_tags );
 270         }
 271         free( p_ts );
 272     }
 273     vlc_dictionary_clear( &p_md->tags );
 274     free( p_md );
 275 }
 276
 277 /**************************************************************************
 278  * Retain a media descriptor object
 279  **************************************************************************/
 280 void libvlc_media_descriptor_retain( libvlc_media_descriptor_t *p_md )
 281 {
 282     if (!p_md)
 283         return;
 284
 285     p_md->i_refcount++;
 286 }
 287
 288 /**************************************************************************
 289  * Duplicate a media descriptor object
 290  **************************************************************************/
 291 libvlc_media_descriptor_t *
 292 libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t *p_md_orig )
 293 {
 294     return libvlc_media_descriptor_new_from_input_item(
 295         p_md_orig->p_libvlc_instance, p_md_orig->p_input_item, NULL );
 296 }
 297
 298 /**************************************************************************
 299  * Retain a media descriptor object
 300  **************************************************************************/
 301 char *
 302 libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
 303                                  libvlc_exception_t * p_e )
 304 {
 305     (void)p_e;
 306     return input_item_GetURI( p_md->p_input_item );
 307 }
 308
 309 /**************************************************************************
 310  * Getter for meta information
 311  **************************************************************************/
 312
 313 char * libvlc_media_descriptor_get_meta( libvlc_media_descriptor_t *p_md,
 314                                          libvlc_meta_t e_meta,
 315                                          libvlc_exception_t *p_e )
 316 {
 317     char * psz_meta;
 318
 319     /* XXX: locking */
 320
 321     preparse_if_needed( p_md );
 322
 323     psz_meta = input_item_GetMeta( p_md->p_input_item,
 324                                    libvlc_to_vlc_meta[e_meta] );
 325
 326     /* Should be integrated in core */
 327     if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
 328     {
 329         free( psz_meta );
 330         return strdup( p_md->p_input_item->psz_name );
 331     }
 332
 333     return psz_meta;
 334 }
 335
 336 /**************************************************************************
 337  * Add a tag
 338  **************************************************************************/
 339 void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
 340                                       const char * key,
 341                                       const libvlc_tag_t tag,
 342                                       libvlc_exception_t *p_e )
 343 {
 344     struct libvlc_tags_storage_t * p_ts;
 345
 346     if( !tag || !key )
 347         return;
 348
 349     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 350
 351     if( !p_ts )
 352     {
 353         p_ts = malloc(sizeof(struct libvlc_tags_storage_t));
 354         memset( p_ts, 0, sizeof(struct libvlc_tags_storage_t) );
 355     }
 356     p_ts->i_count++;
 357
 358     if( !p_ts->ppsz_tags )
 359         p_ts->ppsz_tags = malloc(sizeof(char*)*(p_ts->i_count));
 360     else
 361         p_ts->ppsz_tags = realloc(p_ts->ppsz_tags, sizeof(char*)*(p_ts->i_count));
 362
 363     p_ts->ppsz_tags[p_ts->i_count-1] = strdup( tag );
 364 }
 365
 366
 367 /**************************************************************************
 368  * Remove a tag
 369  **************************************************************************/
 370 void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
 371                                          const char * key,
 372                                          const libvlc_tag_t tag,
 373                                          libvlc_exception_t *p_e )
 374 {
 375     struct libvlc_tags_storage_t * p_ts;
 376     int i;
 377
 378     if( !tag || !key )
 379         return;
 380
 381     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 382
 383     if( !p_ts )
 384         return;
 385
 386     for( i = 0; i < p_ts->i_count; i++ )
 387     {
 388         if( !strcmp( p_ts->ppsz_tags[i], tag ) )
 389         {
 390             free( p_ts->ppsz_tags[i] );
 391             memcpy( p_ts->ppsz_tags + i + 1, p_ts->ppsz_tags + i, (p_ts->i_count - i - 2)*sizeof(char*) );
 392             /* Don't dealloc, the memory will be regain if we add a new tag */
 393             p_ts->i_count--;
 394             return;
 395         }
 396     }
 397 }
 398
 399 /**************************************************************************
 400  * Get tags count
 401  **************************************************************************/
 402 int libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
 403                                                  const char * key,
 404                                                  libvlc_exception_t *p_e )
 405 {
 406     struct libvlc_tags_storage_t * p_ts;
 407
 408     if( !key )
 409         return 0;
 410
 411     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 412
 413     if( !p_ts )
 414         return 0;
 415     return p_ts->i_count;
 416 }
 417
 418 /**************************************************************************
 419  * Get a tag
 420  **************************************************************************/
 421 libvlc_tag_t
 422 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
 423                                               int i,
 424                                               const char * key,
 425                                               libvlc_exception_t *p_e )
 426 {
 427     struct libvlc_tags_storage_t * p_ts;
 428
 429     if( !key )
 430         return NULL;
 431
 432     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 433
 434     if( !p_ts )
 435         return NULL;
 436
 437     return strdup( p_ts->ppsz_tags[i] );
 438 }
 439