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

   1 /*****************************************************************************
   2  * media_list.c: libvlc new API media list functions
   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 #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(
 254                            p_mlist->p_libvlc_instance->p_libvlc_int, psz_uri,
 255                                          _("Media Library"), 0, NULL, 0, -1 );
 256
 257     if( !p_input_item )
 258     {
 259         libvlc_printerr( "Not enough memory" );
 260         return -1;
 261     }
 262
 263     p_md = libvlc_media_new_from_input_item( p_mlist->p_libvlc_instance,
 264                                              p_input_item );
 265     if( !p_md )
 266     {
 267         vlc_gc_decref( p_input_item );
 268         return -1;
 269     }
 270
 271     if( libvlc_media_list_add_media( p_mlist, p_md ) )
 272     {
 273 #warning Missing error handling!
 274         /* printerr and leaks */
 275         return -1;
 276     }
 277
 278     input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item );
 279     return 0;
 280 }
 281
 282 /**************************************************************************
 283  *       set_media (Public)
 284  **************************************************************************/
 285 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
 286                                   libvlc_media_t * p_md )
 287
 288 {
 289     vlc_mutex_lock( &p_mlist->object_lock );
 290     libvlc_media_release( p_mlist->p_md );
 291     libvlc_media_retain( p_md );
 292     p_mlist->p_md = p_md;
 293     vlc_mutex_unlock( &p_mlist->object_lock );
 294 }
 295
 296 /**************************************************************************
 297  *       media (Public)
 298  *
 299  * If this media_list comes is a media's subitems,
 300  * This holds the corresponding media.
 301  * This md is also seen as the information holder for the media_list.
 302  * Indeed a media_list can have meta information through this
 303  * media.
 304  **************************************************************************/
 305 libvlc_media_t *
 306 libvlc_media_list_media( libvlc_media_list_t * p_mlist )
 307 {
 308     libvlc_media_t *p_md;
 309
 310     vlc_mutex_lock( &p_mlist->object_lock );
 311     p_md = p_mlist->p_md;
 312     if( p_md )
 313         libvlc_media_retain( p_md );
 314     vlc_mutex_unlock( &p_mlist->object_lock );
 315
 316     return p_md;
 317 }
 318
 319 /**************************************************************************
 320  *       libvlc_media_list_count (Public)
 321  *
 322  * Lock should be held when entering.
 323  **************************************************************************/
 324 int libvlc_media_list_count( libvlc_media_list_t * p_mlist )
 325 {
 326     return vlc_array_count( &p_mlist->items );
 327 }
 328
 329 /**************************************************************************
 330  *       libvlc_media_list_add_media (Public)
 331  *
 332  * Lock should be held when entering.
 333  **************************************************************************/
 334 int libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 335                                  libvlc_media_t * p_md )
 336 {
 337     if( !mlist_is_writable(p_mlist) )
 338         return -1;
 339     _libvlc_media_list_add_media( p_mlist, p_md );
 340     return 0;
 341 }
 342
 343 /* LibVLC internal version */
 344 void _libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
 345                                    libvlc_media_t * p_md )
 346 {
 347     libvlc_media_retain( p_md );
 348
 349     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
 350                           EventWillHappen );
 351     vlc_array_append( &p_mlist->items, p_md );
 352     notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
 353                           EventDidHappen );
 354 }
 355
 356 /**************************************************************************
 357  *       libvlc_media_list_insert_media (Public)
 358  *
 359  * Lock should be hold when entering.
 360  **************************************************************************/
 361 int libvlc_media_list_insert_media( libvlc_media_list_t * p_mlist,
 362                                     libvlc_media_t * p_md,
 363                                     int index )
 364 {
 365     if( !mlist_is_writable(p_mlist) )
 366         return -1;
 367     _libvlc_media_list_insert_media( p_mlist, p_md, index );
 368     return 0;
 369 }
 370
 371 /* LibVLC internal version */
 372 void _libvlc_media_list_insert_media(
 373                                    libvlc_media_list_t * p_mlist,
 374                                    libvlc_media_t * p_md,
 375                                    int index )
 376 {
 377     libvlc_media_retain( p_md );
 378
 379     notify_item_addition( p_mlist, p_md, index, EventWillHappen );
 380     vlc_array_insert( &p_mlist->items, p_md, index );
 381     notify_item_addition( p_mlist, p_md, index, EventDidHappen );
 382 }
 383
 384 /**************************************************************************
 385  *       libvlc_media_list_remove_index (Public)
 386  *
 387  * Lock should be held when entering.
 388  **************************************************************************/
 389 int libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 390                                      int index )
 391 {
 392     if( !mlist_is_writable(p_mlist) )
 393         return -1;
 394     return _libvlc_media_list_remove_index( p_mlist, index );
 395 }
 396
 397 /* LibVLC internal version */
 398 int _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
 399                                      int index )
 400 {
 401     libvlc_media_t * p_md;
 402
 403     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 404     {
 405         libvlc_printerr( "Index out of bounds" );
 406         return -1;
 407     }
 408
 409     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 410
 411     notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
 412     vlc_array_remove( &p_mlist->items, index );
 413     notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
 414
 415     libvlc_media_release( p_md );
 416     return 0;
 417 }
 418
 419 /**************************************************************************
 420  *       libvlc_media_list_item_at_index (Public)
 421  *
 422  * Lock should be held when entering.
 423  **************************************************************************/
 424 libvlc_media_t *
 425 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
 426                                  int index )
 427 {
 428     libvlc_media_t * p_md;
 429
 430     if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
 431     {
 432         libvlc_printerr( "Index out of bounds" );
 433         return NULL;
 434     }
 435
 436     p_md = vlc_array_item_at_index( &p_mlist->items, index );
 437     libvlc_media_retain( p_md );
 438     return p_md;
 439 }
 440
 441 /**************************************************************************
 442  *       libvlc_media_list_index_of_item (Public)
 443  *
 444  * Lock should be held when entering.
 445  * Warning: this function returns the first matching item.
 446  **************************************************************************/
 447 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
 448                                      libvlc_media_t * p_searched_md )
 449 {
 450     libvlc_media_t * p_md;
 451     int i;
 452     for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
 453     {
 454         p_md = vlc_array_item_at_index( &p_mlist->items, i );
 455         if( p_searched_md == p_md )
 456             return i;
 457     }
 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 }