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     {
  92         p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
  93         libvlc_media_list_set_media_descriptor( p_md->p_subitems, p_md, NULL );
  94     }
  95     if( p_md->p_subitems )
  96     {
  97         libvlc_media_list_add_media_descriptor( p_md->p_subitems, p_md_child, NULL );
  98     }
  99
 100     /* Construct the event */
 101     event.type = libvlc_MediaDescriptorSubItemAdded;
 102     event.u.media_descriptor_subitem_added.new_child = p_md_child;
 103
 104     /* Send the event */
 105     libvlc_event_send( p_md->p_event_manager, &event );
 106     libvlc_media_descriptor_release( p_md_child );
 107 }
 108
 109 /**************************************************************************
 110  * input_item_meta_changed (Private) (vlc event Callback)
 111  **************************************************************************/
 112 static void input_item_meta_changed( const vlc_event_t *p_event,
 113                                      void * user_data )
 114 {
 115     libvlc_media_descriptor_t * p_md = user_data;
 116     libvlc_event_t event;
 117
 118     /* Construct the event */
 119     event.type = libvlc_MediaDescriptorMetaChanged;
 120     event.u.media_descriptor_meta_changed.meta_type =
 121         vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
 122
 123     /* Send the event */
 124     libvlc_event_send( p_md->p_event_manager, &event );
 125 }
 126
 127 /**************************************************************************
 128  * input_item_duration_changed (Private) (vlc event Callback)
 129  **************************************************************************/
 130 static void input_item_duration_changed( const vlc_event_t *p_event,
 131                                          void * user_data )
 132 {
 133     libvlc_media_descriptor_t * p_md = user_data;
 134     libvlc_event_t event;
 135
 136     /* Construct the event */
 137     event.type = libvlc_MediaDescriptorDurationChanged;
 138     event.u.media_descriptor_duration_changed.new_duration =
 139         p_event->u.input_item_duration_changed.new_duration;
 140
 141     /* Send the event */
 142     libvlc_event_send( p_md->p_event_manager, &event );
 143 }
 144
 145 /**************************************************************************
 146  * input_item_preparsed_changed (Private) (vlc event Callback)
 147  **************************************************************************/
 148 static void input_item_preparsed_changed( const vlc_event_t *p_event,
 149                                           void * user_data )
 150 {
 151     libvlc_media_descriptor_t * p_md = user_data;
 152     libvlc_event_t event;
 153
 154     /* Construct the event */
 155     event.type = libvlc_MediaDescriptorPreparsedChanged;
 156     event.u.media_descriptor_preparsed_changed.new_status =
 157         p_event->u.input_item_preparsed_changed.new_status;
 158
 159     /* Send the event */
 160     libvlc_event_send( p_md->p_event_manager, &event );
 161 }
 162
 163 /**************************************************************************
 164  * Install event handler (Private)
 165  **************************************************************************/
 166 static void install_input_item_observer( libvlc_media_descriptor_t *p_md )
 167 {
 168     vlc_event_attach( &p_md->p_input_item->event_manager,
 169                       vlc_InputItemSubItemAdded,
 170                       input_item_subitem_added,
 171                       p_md );
 172     vlc_event_attach( &p_md->p_input_item->event_manager,
 173                       vlc_InputItemMetaChanged,
 174                       input_item_meta_changed,
 175                       p_md );
 176     vlc_event_attach( &p_md->p_input_item->event_manager,
 177                       vlc_InputItemDurationChanged,
 178                       input_item_duration_changed,
 179                       p_md );
 180     vlc_event_attach( &p_md->p_input_item->event_manager,
 181                       vlc_InputItemPreparsedChanged,
 182                       input_item_preparsed_changed,
 183                       p_md );
 184 }
 185
 186 /**************************************************************************
 187  * Uninstall event handler (Private)
 188  **************************************************************************/
 189 static void uninstall_input_item_observer( libvlc_media_descriptor_t *p_md )
 190 {
 191     vlc_event_detach( &p_md->p_input_item->event_manager,
 192                       vlc_InputItemSubItemAdded,
 193                       input_item_subitem_added,
 194                       p_md );
 195     vlc_event_detach( &p_md->p_input_item->event_manager,
 196                       vlc_InputItemMetaChanged,
 197                       input_item_meta_changed,
 198                       p_md );
 199     vlc_event_detach( &p_md->p_input_item->event_manager,
 200                       vlc_InputItemDurationChanged,
 201                       input_item_duration_changed,
 202                       p_md );
 203     vlc_event_detach( &p_md->p_input_item->event_manager,
 204                       vlc_InputItemPreparsedChanged,
 205                       input_item_preparsed_changed,
 206                       p_md );
 207 }
 208
 209 /**************************************************************************
 210  * Preparse if not already done (Private)
 211  **************************************************************************/
 212 static void preparse_if_needed( libvlc_media_descriptor_t *p_md )
 213 {
 214     /* XXX: need some locking here */
 215     if (!p_md->b_preparsed)
 216     {
 217         playlist_PreparseEnqueue(
 218                 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
 219                 p_md->p_input_item );
 220         playlist_AskForArtEnqueue(
 221                 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
 222                 p_md->p_input_item );
 223
 224         p_md->b_preparsed = VLC_TRUE;
 225     }
 226 }
 227
 228 /**************************************************************************
 229  * Create a new media descriptor object from an input_item
 230  * (libvlc internal)
 231  * That's the generic constructor
 232  **************************************************************************/
 233 libvlc_media_descriptor_t * libvlc_media_descriptor_new_from_input_item(
 234                                    libvlc_instance_t *p_instance,
 235                                    input_item_t *p_input_item,
 236                                    libvlc_exception_t *p_e )
 237 {
 238     libvlc_media_descriptor_t * p_md;
 239
 240     if (!p_input_item)
 241     {
 242         libvlc_exception_raise( p_e, "No input item given" );
 243         return NULL;
 244     }
 245
 246     p_md = malloc( sizeof(libvlc_media_descriptor_t) );
 247     p_md->p_libvlc_instance = p_instance;
 248     p_md->p_input_item      = p_input_item;
 249     p_md->b_preparsed       = VLC_FALSE;
 250     p_md->i_refcount        = 1;
 251     p_md->p_user_data       = NULL; // VLC.framework hook
 252
 253     /* A media descriptor can be a playlist. When you open a playlist
 254      * It can give a bunch of item to read. */
 255     p_md->p_subitems        = NULL;
 256
 257     vlc_dictionary_init( &p_md->tags, 1 );
 258
 259     p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance, p_e );
 260     libvlc_event_manager_register_event_type( p_md->p_event_manager,
 261         libvlc_MediaDescriptorMetaChanged, p_e );
 262     libvlc_event_manager_register_event_type( p_md->p_event_manager,
 263         libvlc_MediaDescriptorSubItemAdded, p_e );
 264     libvlc_event_manager_register_event_type( p_md->p_event_manager,
 265         libvlc_MediaDescriptorDurationChanged, p_e );
 266
 267     vlc_gc_incref( p_md->p_input_item );
 268
 269     install_input_item_observer( p_md );
 270
 271     return p_md;
 272 }
 273
 274 /**************************************************************************
 275  * Create a new media descriptor object
 276  **************************************************************************/
 277 libvlc_media_descriptor_t * libvlc_media_descriptor_new(
 278                                    libvlc_instance_t *p_instance,
 279                                    const char * psz_mrl,
 280                                    libvlc_exception_t *p_e )
 281 {
 282     input_item_t * p_input_item;
 283     libvlc_media_descriptor_t * p_md;
 284
 285     p_input_item = input_ItemNew( p_instance->p_libvlc_int, psz_mrl, NULL );
 286
 287     if (!p_input_item)
 288     {
 289         libvlc_exception_raise( p_e, "Can't create md's input_item" );
 290         return NULL;
 291     }
 292
 293     p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
 294                 p_input_item, p_e );
 295
 296     return p_md;
 297 }
 298
 299 /**************************************************************************
 300  * Delete a media descriptor object
 301  **************************************************************************/
 302 void libvlc_media_descriptor_release( libvlc_media_descriptor_t *p_md )
 303 {
 304     int i;
 305     if (!p_md)
 306         return;
 307
 308     p_md->i_refcount--;
 309
 310     if( p_md->i_refcount > 0 )
 311         return;
 312
 313     if( p_md->p_subitems )
 314         libvlc_media_list_release( p_md->p_subitems );
 315
 316     uninstall_input_item_observer( p_md );
 317     vlc_gc_decref( p_md->p_input_item );
 318
 319     char ** all_keys = vlc_dictionary_all_keys( &p_md->tags );
 320     for( i = 0; all_keys[i]; i++ )
 321     {
 322         int j;
 323         struct libvlc_tags_storage_t * p_ts = vlc_dictionary_value_for_key( &p_md->tags, all_keys[i] );
 324         for( j = 0; j < p_ts->i_count; j++ )
 325         {
 326             free( p_ts->ppsz_tags[j] );
 327             free( p_ts->ppsz_tags );
 328         }
 329         free( p_ts );
 330     }
 331     vlc_dictionary_clear( &p_md->tags );
 332     free( p_md );
 333 }
 334
 335 /**************************************************************************
 336  * Retain a media descriptor object
 337  **************************************************************************/
 338 void libvlc_media_descriptor_retain( libvlc_media_descriptor_t *p_md )
 339 {
 340     if (!p_md)
 341         return;
 342
 343     p_md->i_refcount++;
 344 }
 345
 346 /**************************************************************************
 347  * Duplicate a media descriptor object
 348  **************************************************************************/
 349 libvlc_media_descriptor_t *
 350 libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t *p_md_orig )
 351 {
 352     return libvlc_media_descriptor_new_from_input_item(
 353         p_md_orig->p_libvlc_instance, p_md_orig->p_input_item, NULL );
 354 }
 355
 356 /**************************************************************************
 357  * Retain a media descriptor object
 358  **************************************************************************/
 359 char *
 360 libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
 361                                  libvlc_exception_t * p_e )
 362 {
 363     (void)p_e;
 364     return input_item_GetURI( p_md->p_input_item );
 365 }
 366
 367 /**************************************************************************
 368  * Getter for meta information
 369  **************************************************************************/
 370
 371 char * libvlc_media_descriptor_get_meta( libvlc_media_descriptor_t *p_md,
 372                                          libvlc_meta_t e_meta,
 373                                          libvlc_exception_t *p_e )
 374 {
 375     char * psz_meta;
 376
 377     /* XXX: locking */
 378
 379     preparse_if_needed( p_md );
 380
 381     psz_meta = input_item_GetMeta( p_md->p_input_item,
 382                                    libvlc_to_vlc_meta[e_meta] );
 383
 384     /* Should be integrated in core */
 385     if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
 386     {
 387         free( psz_meta );
 388         return strdup( p_md->p_input_item->psz_name );
 389     }
 390
 391     return psz_meta;
 392 }
 393
 394 /**************************************************************************
 395  * Add a tag
 396  **************************************************************************/
 397 void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
 398                                       const char * key,
 399                                       const libvlc_tag_t tag,
 400                                       libvlc_exception_t *p_e )
 401 {
 402     struct libvlc_tags_storage_t * p_ts;
 403
 404     if( !tag || !key )
 405         return;
 406
 407     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 408
 409     if( !p_ts )
 410     {
 411         p_ts = malloc(sizeof(struct libvlc_tags_storage_t));
 412         memset( p_ts, 0, sizeof(struct libvlc_tags_storage_t) );
 413     }
 414     p_ts->i_count++;
 415
 416     if( !p_ts->ppsz_tags )
 417         p_ts->ppsz_tags = malloc(sizeof(char*)*(p_ts->i_count));
 418     else
 419         p_ts->ppsz_tags = realloc(p_ts->ppsz_tags, sizeof(char*)*(p_ts->i_count));
 420
 421     p_ts->ppsz_tags[p_ts->i_count-1] = strdup( tag );
 422 }
 423
 424
 425 /**************************************************************************
 426  * Remove a tag
 427  **************************************************************************/
 428 void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
 429                                          const char * key,
 430                                          const libvlc_tag_t tag,
 431                                          libvlc_exception_t *p_e )
 432 {
 433     struct libvlc_tags_storage_t * p_ts;
 434     int i;
 435
 436     if( !tag || !key )
 437         return;
 438
 439     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 440
 441     if( !p_ts )
 442         return;
 443
 444     for( i = 0; i < p_ts->i_count; i++ )
 445     {
 446         if( !strcmp( p_ts->ppsz_tags[i], tag ) )
 447         {
 448             free( p_ts->ppsz_tags[i] );
 449             memcpy( p_ts->ppsz_tags + i + 1, p_ts->ppsz_tags + i, (p_ts->i_count - i - 2)*sizeof(char*) );
 450             /* Don't dealloc, the memory will be regain if we add a new tag */
 451             p_ts->i_count--;
 452             return;
 453         }
 454     }
 455 }
 456
 457 /**************************************************************************
 458  * Get tags count
 459  **************************************************************************/
 460 int libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
 461                                                  const char * key,
 462                                                  libvlc_exception_t *p_e )
 463 {
 464     struct libvlc_tags_storage_t * p_ts;
 465
 466     if( !key )
 467         return 0;
 468
 469     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 470
 471     if( !p_ts )
 472         return 0;
 473     return p_ts->i_count;
 474 }
 475
 476 /**************************************************************************
 477  * Get a tag
 478  **************************************************************************/
 479 libvlc_tag_t
 480 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
 481                                               int i,
 482                                               const char * key,
 483                                               libvlc_exception_t *p_e )
 484 {
 485     struct libvlc_tags_storage_t * p_ts;
 486
 487     if( !key )
 488         return NULL;
 489
 490     p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
 491
 492     if( !p_ts )
 493         return NULL;
 494
 495     return strdup( p_ts->ppsz_tags[i] );
 496 }
 497
 498 /**************************************************************************
 499  * subitems
 500  **************************************************************************/
 501 libvlc_media_list_t *
 502 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t * p_md,
 503                                   libvlc_exception_t * p_e )
 504 {
 505     if( p_md->p_subitems )
 506         libvlc_media_list_retain( p_md->p_subitems );
 507     return p_md->p_subitems;
 508 }
 509
 510 /**************************************************************************
 511  * event_manager
 512  **************************************************************************/
 513 libvlc_event_manager_t *
 514 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
 515                                        libvlc_exception_t * p_e )
 516 {
 517     return p_md->p_event_manager;
 518 }
 519
 520 /**************************************************************************
 521  * Get duration of media_descriptor object.
 522  **************************************************************************/
 523 vlc_int64_t
 524 libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
 525                                       libvlc_exception_t * p_e )
 526 {
 527     if( p_md && p_md->p_input_item)
 528     {
 529         return input_item_GetDuration( p_md->p_input_item );
 530     }
 531     else
 532     {
 533         return -1;
 534     }
 535 }
 536
 537 /**************************************************************************
 538  * Get preparsed status for media_descriptor object.
 539  **************************************************************************/
 540 vlc_bool_t
 541 libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
 542                                        libvlc_exception_t * p_e )
 543 {
 544     if( p_md && p_md->p_input_item)
 545     {
 546         return input_item_IsPreparsed( p_md->p_input_item );
 547     }
 548     else
 549     {
 550         return VLC_FALSE;
 551     }
 552 }
 553
 554 /**************************************************************************
 555  * Sets media descriptor's user_data. user_data is specialized data
 556  * accessed by the host application, VLC.framework uses it as a pointer to
 557  * an native object that references a libvlc_media_descriptor_t pointer
 558  **************************************************************************/
 559 void
 560 libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
 561                                        void * p_new_user_data,
 562                                        libvlc_exception_t * p_e )
 563 {
 564     if( p_md )
 565     {
 566         p_md->p_user_data = p_new_user_data;
 567     }
 568 }
 569
 570 /**************************************************************************
 571  * Get media descriptor's user_data. user_data is specialized data
 572  * accessed by the host application, VLC.framework uses it as a pointer to
 573  * an native object that references a libvlc_media_descriptor_t pointer
 574  **************************************************************************/
 575 void *
 576 libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
 577                                        libvlc_exception_t * p_e )
 578 {
 579     if( p_md )
 580     {
 581         return p_md->p_user_data;
 582     }
 583     else
 584     {
 585         return NULL;
 586     }
 587 }