lib/media_list.c

   1 /*****************************************************************************
   2  * media_list.c: libvlc new API media list functions
   3  *****************************************************************************
   4  * Copyright (C) 2007 VLC authors and VideoLAN
   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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <assert.h>
  29
  30 #include <vlc/libvlc.h>
  31 #include <vlc/libvlc_media.h>
  32 #include <vlc/libvlc_media_list.h>
  33 #include <vlc/libvlc_events.h>
  34
  35 #include <vlc_common.h>
  36 #include <vlc_input.h>
  37
  38 #include "libvlc_internal.h"
  39 #include "media_internal.h" // libvlc_media_new_from_input_item()
  40 #include "media_list_internal.h"
  41
  42 typedef enum EventPlaceInTime {
  43     EventWillHappen,
  44     EventDidHappen
  45 } EventPlaceInTime;
  46
  47 //#define DEBUG_MEDIA_LIST
  48
  49 #ifdef DEBUG_MEDIA_LIST
  50 # define trace( fmt, ... ) printf( "%s(): " fmt, __FUNCTION__, ##__VA_ARGS__ )
  51 #else
  52 # define trace( ... )
  53 #endif
  54
  55 /*
  56  * Private functions
  57  */
  58
  59
  60
  61 /**************************************************************************
  62  *       notify_item_addition (private)
  63  *
  64  * Do the appropriate action when an item is deleted.
  65  **************************************************************************/
  66 static void
  67 notify_item_addition( libvlc_media_list_t * p_mlist,
  68                       libvlc_media_t * p_md,
  69                       int index,
  70                       EventPlaceInTime event_status )
  71 {
  72     libvlc_event_t event;
  73
  74     /* Construct the event */
  75     if( event_status == EventDidHappen )
  76     {
  77         trace("item was added at index %d\n", index);
  78         event.type = libvlc_MediaListItemAdded;
  79         event.u.media_list_item_added.item = p_md;
  80         event.u.media_list_item_added.index = index;
  81     }
  82     else /* if( event_status == EventWillHappen ) */
  83     {
  84         event.type = libvlc_MediaListWillAddItem;
  85         event.u.media_list_will_add_item.item = p_md;
  86         event.u.media_list_will_add_item.index = index;
  87     }
  88
  89     /* Send the event */
  90     libvlc_event_send( p_mlist->p_event_manager, &event );
  91 }
  92
  93 /**************************************************************************
  94  *       notify_item_deletion (private)
  95  *
  96  * Do the appropriate action when an item is added.
  97  **************************************************************************/
  98 static void
  99 notify_item_deletion( libvlc_media_list_t * p_mlist,
 100                       libvlc_media_t * p_md,
 101                       int index,
 102                       EventPlaceInTime event_status )
 103 {
 104     libvlc_event_t event;
 105
 106     /* Construct the event */
 107     if( event_status == EventDidHappen )
 108     {
 109         trace("item at index %d was deleted\n", index);
 110         event.type = libvlc_MediaListItemDeleted;
 111         event.u.media_list_item_deleted.item = p_md;
 112         event.u.media_list_item_deleted.index = index;
 113     }
 114     else /* if( event_status == EventWillHappen ) */
 115     {
 116         event.type = libvlc_MediaListWillDeleteItem;
 117         event.u.media_list_will_delete_item.item = p_md;
 118         event.u.media_list_will_delete_item.index = index;
 119     }
 120
 121     /* Send the event */
 122     libvlc_event_send( p_mlist->p_event_manager, &event );
 123 }
 124
 125 /**************************************************************************
 126  *       static mlist_is_writable (private)
 127  **************************************************************************/
 128 static inline
 129 bool mlist_is_writable( libvlc_media_list_t *p_mlist )
 130 {
 131     if( !p_mlist||p_mlist->b_read_only )
 132     {
 133         /* We are read-only from user side */
 134         libvlc_printerr( "Attempt to write a read-only media list" );
 135         return false;
 136     }
 137     return true;
 138 }
 139
 140 /*
 141  * Public libvlc functions
 142  */
 143
 144 /**************************************************************************
 145  *       libvlc_media_list_new (Public)
 146  *
 147  * Init an object.
 148  **************************************************************************/
 149 libvlc_media_list_t *
 150 libvlc_media_list_new( libvlc_instance_t * p_inst )
 151 {
 152     libvlc_media_list_t * p_mlist;
 153
 154     p_mlist = malloc(sizeof(libvlc_media_list_t));
 155     if( unlikely(p_mlist == NULL) )
 156     {
 157         libvlc_printerr( "Not enough memory" );
 158         return NULL;
 159     }
 160
 161     p_mlist->p_libvlc_instance = p_inst;
 162     p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst );
 163     if( unlikely(p_mlist->p_event_manager == NULL) )
 164     {
 165         free(p_mlist);
 166         return NULL;
 167     }
 168
 169     /* Code for that one should be handled in flat_media_list.c */
 170     p_mlist->p_flat_mlist = NULL;
 171     p_mlist->b_read_only = false;
 172
 173     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 174             libvlc_MediaListItemAdded );
 175     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 176             libvlc_MediaListWillAddItem );
 177     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 178             libvlc_MediaListItemDeleted );
 179     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 180             libvlc_MediaListWillDeleteItem );
 181
 182     vlc_mutex_init( &p_mlist->object_lock );
 183     vlc_mutex_init( &p_mlist->refcount_lock ); // FIXME: spinlock?
 184
 185     vlc_array_init( &p_mlist->items );
 186     assert( p_mlist->items.i_count == 0 );
 187     p_mlist->i_refcount = 1;
 188     p_mlist->p_md = NULL;
 189
 190     return p_mlist;
 191 }
 192
 193 /**************************************************************************
 194  *       libvlc_media_list_release (Public)
 195  *
 196  * Release an object.
 197  **************************************************************************/
 198 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
 199 {
 200     libvlc_media_t * p_md;
 201     int i;
 202
 203     vlc_mutex_lock( &p_mlist->refcount_lock );
 204     p_mlist->i_refcount--;
 205     if( p_mlist->i_refcount > 0 )
 206     {
 207         vlc_mutex_unlock( &p_mlist->refcount_lock );
 208         return;
 209     }
 210     vlc_mutex_unlock( &p_mlist->refcount_lock );
 211
 212     /* Refcount null, time to free */
 213
 214     libvlc_event_manager_release( p_mlist->p_event_manager );
 215
 216     libvlc_media_release( p_mlist->p_md );
 217
 218     for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
 219     {
 220         p_md = vlc_array_item_at_index( &p_mlist->items, i );
 221         libvlc_media_release( p_md );
 222     }
 223
 224     vlc_mutex_destroy( &p_mlist->object_lock );
 225     vlc_array_clear( &p_mlist->items );
 226
 227     free( p_mlist );
 228 }
 229
 230 /**************************************************************************
 231  *       libvlc_media_list_retain (Public)
 232  *
 233  * Increase an object refcount.
 234  **************************************************************************/
 235 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
 236 {
 237     vlc_mutex_lock( &p_mlist->refcount_lock );
 238     p_mlist->i_refcount++;
 239     vlc_mutex_unlock( &p_mlist->refcount_lock );
 240 }
 241
 242
 243 /**************************************************************************
 244  *       add_file_content (Public)
 245  **************************************************************************/
 246 int
 247 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
 248                                     const char * psz_uri )
 249 {
 250     input_item_t * p_input_item;
 251     libvlc_media_t * p_md;
 252
 253     p_input_item = input_item_NewExt( psz_uri,
 254                                          _("Media Library"), 0, NULL, 0, -1 );
 255
 256     if( !p_input_item )
 257     {
 258         libvlc_printerr( "Not enough memory" );
 259         return -1;
 260     }
 261
 262     p_md = libvlc_media_new_from_input_item( p_mlist->p_libvlc_instance,
 263                                              p_input_item );
 264     if( !p_md )
 265     {
 266         vlc_gc_decref( p_input_item );
 267         return -1;
 268     }
 269
 270     if( libvlc_media_list_add_media( p_mlist, p_md ) )
 271     {
 272 #warning Missing error handling!
 273         /* printerr and leaks */
 274         return -1;
 275     }
 276
 277     input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item );
 278     return 0;
 279 }
 280
 281 /**************************************************************************
 282  *       set_media (Public)
 283  **************************************************************************/
 284 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
 285                                   libvlc_media_t * p_md )
 286
 287 {
 288     vlc_mutex_lock( &p_mlist->object_lock );
 289     libvlc_media_release( p_mlist->p_md );
 290     libvlc_media_retain( p_md );
 291     p_mlist->p_md = p_md;
 292     vlc_mutex_unlock( &p_mlist->object_lock );
 293 }
 294
 295 /**************************************************************************
 296  *       media (Public)
 297  *
 298  * If this media_list comes is a media's subitems,
 299  * This holds the corresponding media.
 300  * This md is also seen as the information holder for the media_list.
 301  * Indeed a media_list can have meta information through this
 302  * media.
 303  **************************************************************************/
 304 libvlc_media_t *
 305 libvlc_media_list_media( libvlc_media_list_t * p_mlist )
 306 {
 307     libvlc_media_t *p_md;
 308
 309     vlc_mutex_lock( &p_mlist->object_lock );
 310     p_md = p_mlist->p_md;
 311     if( p_md )
 312         libvlc_media_retain( p_md );
 313     vlc_mutex_unlock( &p_mlist->object_lock );
 314
 315     return p_md;
 316 }
 317
 318 /**************************************************************************
 319  *       libvlc_media_list_count (Public)
 320  *
 321  * Lock should be held when entering.
 322  **************************************************************************/
 323 int libvlc_media_list_count( libvlc_media_list_t * p_mlist )
 324 {
 325     return vlc_array_count( &p_mlist->items );
 326 }
 327
 328 /**************************************************************************
 329  *       libvlc_media_list_add_media (Public)
 330  *
 331  * Lock should be held when entering.
 332  **************************************************************************/
 333 int libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 334                                  libvlc_media_t * p_md )
 335 {
 336     if( !mlist_is_writable(p_mlist) )
 337         return -1;
 338     _libvlc_media_list_add_media( p_mlist, p_md );
 339     return 0;
 340 }
 341
 342 /* LibVLC internal version */
 343 void _libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 344                                    libvlc_media_t * p_md )
 345 {
 346     libvlc_media_retain( p_md );
 347
 348     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
 349                           EventWillHappen );
 350     vlc_array_append( &p_mlist->items, p_md );
 351     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
 352                           EventDidHappen );
 353 }
 354
 355 /**************************************************************************
 356  *       libvlc_media_list_insert_media (Public)
 357  *
 358  * Lock should be hold when entering.
 359  **************************************************************************/
 360 int libvlc_media_list_insert_media( libvlc_media_list_t * p_mlist,
 361                                     libvlc_media_t * p_md,
 362                                     int index )
 363 {
 364     if( !mlist_is_writable(p_mlist) )
 365         return -1;
 366     _libvlc_media_list_insert_media( p_mlist, p_md, index );
 367     return 0;
 368 }
 369
 370 /* LibVLC internal version */
 371 void _libvlc_media_list_insert_media(
 372                                    libvlc_media_list_t * p_mlist,
 373                                    libvlc_media_t * p_md,
 374                                    int index )
 375 {
 376     libvlc_media_retain( p_md );
 377
 378     notify_item_addition( p_mlist, p_md, index, EventWillHappen );
 379     vlc_array_insert( &p_mlist->items, p_md, index );
 380     notify_item_addition( p_mlist, p_md, index, EventDidHappen );
 381 }
 382
 383 /**************************************************************************
 384  *       libvlc_media_list_remove_index (Public)
 385  *
 386  * Lock should be held when entering.
 387  **************************************************************************/
 388 int libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 389                                      int index )
 390 {
 391     if( !mlist_is_writable(p_mlist) )
 392         return -1;
 393     return _libvlc_media_list_remove_index( p_mlist, index );
 394 }
 395
 396 /* LibVLC internal version */
 397 int _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 398                                      int index )
 399 {
 400     libvlc_media_t * p_md;
 401
 402     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 403     {
 404         libvlc_printerr( "Index out of bounds" );
 405         return -1;
 406     }
 407
 408     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 409
 410     notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
 411     vlc_array_remove( &p_mlist->items, index );
 412     notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
 413
 414     libvlc_media_release( p_md );
 415     return 0;
 416 }
 417
 418 /**************************************************************************
 419  *       libvlc_media_list_item_at_index (Public)
 420  *
 421  * Lock should be held when entering.
 422  **************************************************************************/
 423 libvlc_media_t *
 424 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
 425                                  int index )
 426 {
 427     libvlc_media_t * p_md;
 428
 429     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 430     {
 431         libvlc_printerr( "Index out of bounds" );
 432         return NULL;
 433     }
 434
 435     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 436     libvlc_media_retain( p_md );
 437     return p_md;
 438 }
 439
 440 /**************************************************************************
 441  *       libvlc_media_list_index_of_item (Public)
 442  *
 443  * Lock should be held when entering.
 444  * Warning: this function returns the first matching item.
 445  **************************************************************************/
 446 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
 447                                      libvlc_media_t * p_searched_md )
 448 {
 449     libvlc_media_t * p_md;
 450     int i;
 451     for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
 452     {
 453         p_md = vlc_array_item_at_index( &p_mlist->items, i );
 454         if( p_searched_md == p_md )
 455             return i;
 456     }
 457     libvlc_printerr( "Media not found" );
 458     return -1;
 459 }
 460
 461 /**************************************************************************
 462  *       libvlc_media_list_is_readonly (Public)
 463  *
 464  * This indicates if this media list is read-only from a user point of view
 465  **************************************************************************/
 466 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
 467 {
 468     return p_mlist->b_read_only;
 469 }
 470
 471 /**************************************************************************
 472  *       libvlc_media_list_lock (Public)
 473  *
 474  * The lock must be held in access operations. It is never used in the
 475  * Public method.
 476  **************************************************************************/
 477 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
 478 {
 479     vlc_mutex_lock( &p_mlist->object_lock );
 480 }
 481
 482
 483 /**************************************************************************
 484  *       libvlc_media_list_unlock (Public)
 485  *
 486  * The lock must be held in access operations
 487  **************************************************************************/
 488 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
 489 {
 490     vlc_mutex_unlock( &p_mlist->object_lock );
 491 }
 492
 493
 494 /**************************************************************************
 495  *       libvlc_media_list_p_event_manager (Public)
 496  *
 497  * The p_event_manager is immutable, so you don't have to hold the lock
 498  **************************************************************************/
 499 libvlc_event_manager_t *
 500 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist )
 501 {
 502     return p_mlist->p_event_manager;
 503 }