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     p_mlist->b_read_only = false;
 170
 171     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 172             libvlc_MediaListItemAdded );
 173     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 174             libvlc_MediaListWillAddItem );
 175     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 176             libvlc_MediaListItemDeleted );
 177     libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
 178             libvlc_MediaListWillDeleteItem );
 179
 180     vlc_mutex_init( &p_mlist->object_lock );
 181     vlc_mutex_init( &p_mlist->refcount_lock ); // FIXME: spinlock?
 182
 183     vlc_array_init( &p_mlist->items );
 184     assert( p_mlist->items.i_count == 0 );
 185     p_mlist->i_refcount = 1;
 186     p_mlist->p_md = NULL;
 187
 188     return p_mlist;
 189 }
 190
 191 /**************************************************************************
 192  *       libvlc_media_list_release (Public)
 193  *
 194  * Release an object.
 195  **************************************************************************/
 196 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
 197 {
 198     libvlc_media_t * p_md;
 199     int i;
 200
 201     vlc_mutex_lock( &p_mlist->refcount_lock );
 202     p_mlist->i_refcount--;
 203     if( p_mlist->i_refcount > 0 )
 204     {
 205         vlc_mutex_unlock( &p_mlist->refcount_lock );
 206         return;
 207     }
 208     vlc_mutex_unlock( &p_mlist->refcount_lock );
 209
 210     /* Refcount null, time to free */
 211
 212     libvlc_event_manager_release( p_mlist->p_event_manager );
 213
 214     libvlc_media_release( p_mlist->p_md );
 215
 216     for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
 217     {
 218         p_md = vlc_array_item_at_index( &p_mlist->items, i );
 219         libvlc_media_release( p_md );
 220     }
 221
 222     vlc_mutex_destroy( &p_mlist->object_lock );
 223     vlc_array_clear( &p_mlist->items );
 224
 225     free( p_mlist );
 226 }
 227
 228 /**************************************************************************
 229  *       libvlc_media_list_retain (Public)
 230  *
 231  * Increase an object refcount.
 232  **************************************************************************/
 233 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
 234 {
 235     vlc_mutex_lock( &p_mlist->refcount_lock );
 236     p_mlist->i_refcount++;
 237     vlc_mutex_unlock( &p_mlist->refcount_lock );
 238 }
 239
 240
 241 /**************************************************************************
 242  *       add_file_content (Public)
 243  **************************************************************************/
 244 int
 245 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
 246                                     const char * psz_uri )
 247 {
 248     input_item_t * p_input_item;
 249     libvlc_media_t * p_md;
 250
 251     p_input_item = input_item_NewExt( psz_uri,
 252                                          _("Media Library"), 0, NULL, 0, -1 );
 253
 254     if( !p_input_item )
 255     {
 256         libvlc_printerr( "Not enough memory" );
 257         return -1;
 258     }
 259
 260     p_md = libvlc_media_new_from_input_item( p_mlist->p_libvlc_instance,
 261                                              p_input_item );
 262     if( !p_md )
 263     {
 264         vlc_gc_decref( p_input_item );
 265         return -1;
 266     }
 267
 268     if( libvlc_media_list_add_media( p_mlist, p_md ) )
 269     {
 270 #warning Missing error handling!
 271         /* printerr and leaks */
 272         return -1;
 273     }
 274
 275     input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item );
 276     return 0;
 277 }
 278
 279 /**************************************************************************
 280  *       set_media (Public)
 281  **************************************************************************/
 282 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
 283                                   libvlc_media_t * p_md )
 284
 285 {
 286     vlc_mutex_lock( &p_mlist->object_lock );
 287     libvlc_media_release( p_mlist->p_md );
 288     libvlc_media_retain( p_md );
 289     p_mlist->p_md = p_md;
 290     vlc_mutex_unlock( &p_mlist->object_lock );
 291 }
 292
 293 /**************************************************************************
 294  *       media (Public)
 295  *
 296  * If this media_list comes is a media's subitems,
 297  * This holds the corresponding media.
 298  * This md is also seen as the information holder for the media_list.
 299  * Indeed a media_list can have meta information through this
 300  * media.
 301  **************************************************************************/
 302 libvlc_media_t *
 303 libvlc_media_list_media( libvlc_media_list_t * p_mlist )
 304 {
 305     libvlc_media_t *p_md;
 306
 307     vlc_mutex_lock( &p_mlist->object_lock );
 308     p_md = p_mlist->p_md;
 309     if( p_md )
 310         libvlc_media_retain( p_md );
 311     vlc_mutex_unlock( &p_mlist->object_lock );
 312
 313     return p_md;
 314 }
 315
 316 /**************************************************************************
 317  *       libvlc_media_list_count (Public)
 318  *
 319  * Lock should be held when entering.
 320  **************************************************************************/
 321 int libvlc_media_list_count( libvlc_media_list_t * p_mlist )
 322 {
 323     return vlc_array_count( &p_mlist->items );
 324 }
 325
 326 /**************************************************************************
 327  *       libvlc_media_list_add_media (Public)
 328  *
 329  * Lock should be held when entering.
 330  **************************************************************************/
 331 int libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 332                                  libvlc_media_t * p_md )
 333 {
 334     if( !mlist_is_writable(p_mlist) )
 335         return -1;
 336     _libvlc_media_list_add_media( p_mlist, p_md );
 337     return 0;
 338 }
 339
 340 /* LibVLC internal version */
 341 void _libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 342                                    libvlc_media_t * p_md )
 343 {
 344     libvlc_media_retain( p_md );
 345
 346     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
 347                           EventWillHappen );
 348     vlc_array_append( &p_mlist->items, p_md );
 349     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
 350                           EventDidHappen );
 351 }
 352
 353 /**************************************************************************
 354  *       libvlc_media_list_insert_media (Public)
 355  *
 356  * Lock should be hold when entering.
 357  **************************************************************************/
 358 int libvlc_media_list_insert_media( libvlc_media_list_t * p_mlist,
 359                                     libvlc_media_t * p_md,
 360                                     int index )
 361 {
 362     if( !mlist_is_writable(p_mlist) )
 363         return -1;
 364     _libvlc_media_list_insert_media( p_mlist, p_md, index );
 365     return 0;
 366 }
 367
 368 /* LibVLC internal version */
 369 void _libvlc_media_list_insert_media(
 370                                    libvlc_media_list_t * p_mlist,
 371                                    libvlc_media_t * p_md,
 372                                    int index )
 373 {
 374     libvlc_media_retain( p_md );
 375
 376     notify_item_addition( p_mlist, p_md, index, EventWillHappen );
 377     vlc_array_insert( &p_mlist->items, p_md, index );
 378     notify_item_addition( p_mlist, p_md, index, EventDidHappen );
 379 }
 380
 381 /**************************************************************************
 382  *       libvlc_media_list_remove_index (Public)
 383  *
 384  * Lock should be held when entering.
 385  **************************************************************************/
 386 int libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 387                                      int index )
 388 {
 389     if( !mlist_is_writable(p_mlist) )
 390         return -1;
 391     return _libvlc_media_list_remove_index( p_mlist, index );
 392 }
 393
 394 /* LibVLC internal version */
 395 int _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 396                                      int index )
 397 {
 398     libvlc_media_t * p_md;
 399
 400     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 401     {
 402         libvlc_printerr( "Index out of bounds" );
 403         return -1;
 404     }
 405
 406     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 407
 408     notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
 409     vlc_array_remove( &p_mlist->items, index );
 410     notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
 411
 412     libvlc_media_release( p_md );
 413     return 0;
 414 }
 415
 416 /**************************************************************************
 417  *       libvlc_media_list_item_at_index (Public)
 418  *
 419  * Lock should be held when entering.
 420  **************************************************************************/
 421 libvlc_media_t *
 422 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
 423                                  int index )
 424 {
 425     libvlc_media_t * p_md;
 426
 427     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 428     {
 429         libvlc_printerr( "Index out of bounds" );
 430         return NULL;
 431     }
 432
 433     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 434     libvlc_media_retain( p_md );
 435     return p_md;
 436 }
 437
 438 /**************************************************************************
 439  *       libvlc_media_list_index_of_item (Public)
 440  *
 441  * Lock should be held when entering.
 442  * Warning: this function returns the first matching item.
 443  **************************************************************************/
 444 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
 445                                      libvlc_media_t * p_searched_md )
 446 {
 447     libvlc_media_t * p_md;
 448     int i;
 449     for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
 450     {
 451         p_md = vlc_array_item_at_index( &p_mlist->items, i );
 452         if( p_searched_md == p_md )
 453             return i;
 454     }
 455     libvlc_printerr( "Media not found" );
 456     return -1;
 457 }
 458
 459 /**************************************************************************
 460  *       libvlc_media_list_is_readonly (Public)
 461  *
 462  * This indicates if this media list is read-only from a user point of view
 463  **************************************************************************/
 464 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
 465 {
 466     return p_mlist->b_read_only;
 467 }
 468
 469 /**************************************************************************
 470  *       libvlc_media_list_lock (Public)
 471  *
 472  * The lock must be held in access operations. It is never used in the
 473  * Public method.
 474  **************************************************************************/
 475 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
 476 {
 477     vlc_mutex_lock( &p_mlist->object_lock );
 478 }
 479
 480
 481 /**************************************************************************
 482  *       libvlc_media_list_unlock (Public)
 483  *
 484  * The lock must be held in access operations
 485  **************************************************************************/
 486 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
 487 {
 488     vlc_mutex_unlock( &p_mlist->object_lock );
 489 }
 490
 491
 492 /**************************************************************************
 493  *       libvlc_media_list_p_event_manager (Public)
 494  *
 495  * The p_event_manager is immutable, so you don't have to hold the lock
 496  **************************************************************************/
 497 libvlc_event_manager_t *
 498 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist )
 499 {
 500     return p_mlist->p_event_manager;
 501 }