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