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