1 /*****************************************************************************
2 * media_list.c: libvlc new API media list functions
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
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 *****************************************************************************/
30 #include <vlc/libvlc.h>
31 #include <vlc/libvlc_media.h>
32 #include <vlc/libvlc_media_list.h>
33 #include <vlc/libvlc_events.h>
35 #include <vlc_common.h>
36 #include <vlc_input.h>
38 #include "libvlc_internal.h"
39 #include "media_internal.h" // libvlc_media_new_from_input_item()
40 #include "media_list_internal.h"
42 typedef enum EventPlaceInTime {
47 //#define DEBUG_MEDIA_LIST
49 #ifdef DEBUG_MEDIA_LIST
50 # define trace( fmt, ... ) printf( "%s(): " fmt, __FUNCTION__, ##__VA_ARGS__ )
61 /**************************************************************************
62 * notify_item_addition (private)
64 * Do the appropriate action when an item is deleted.
65 **************************************************************************/
67 notify_item_addition( libvlc_media_list_t * p_mlist,
68 libvlc_media_t * p_md,
70 EventPlaceInTime event_status )
74 /* Construct the event */
75 if( event_status == EventDidHappen )
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;
82 else /* if( event_status == EventWillHappen ) */
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;
90 libvlc_event_send( p_mlist->p_event_manager, &event );
93 /**************************************************************************
94 * notify_item_deletion (private)
96 * Do the appropriate action when an item is added.
97 **************************************************************************/
99 notify_item_deletion( libvlc_media_list_t * p_mlist,
100 libvlc_media_t * p_md,
102 EventPlaceInTime event_status )
104 libvlc_event_t event;
106 /* Construct the event */
107 if( event_status == EventDidHappen )
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;
114 else /* if( event_status == EventWillHappen ) */
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;
122 libvlc_event_send( p_mlist->p_event_manager, &event );
125 /**************************************************************************
126 * static mlist_is_writable (private)
128 * Raise exception and return 0 when the media_list instance is read-only,
130 **************************************************************************/
132 int mlist_is_writable( libvlc_media_list_t *p_mlist, libvlc_exception_t *p_e )
134 if( !p_mlist||p_mlist->b_read_only )
136 /* We are read-only from user side */
137 libvlc_exception_raise( p_e, "Cannot write to read-only media list." );
144 * Public libvlc functions
147 /**************************************************************************
148 * libvlc_media_list_new (Public)
151 **************************************************************************/
152 libvlc_media_list_t *
153 libvlc_media_list_new( libvlc_instance_t * p_inst,
154 libvlc_exception_t * p_e )
156 libvlc_media_list_t * p_mlist;
158 p_mlist = malloc(sizeof(libvlc_media_list_t));
162 p_mlist->p_libvlc_instance = p_inst;
163 p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst, p_e );
165 /* Code for that one should be handled in flat_media_list.c */
166 p_mlist->p_flat_mlist = NULL;
167 p_mlist->b_read_only = false;
169 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
170 libvlc_MediaListItemAdded, p_e );
171 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
172 libvlc_MediaListWillAddItem, p_e );
173 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
174 libvlc_MediaListItemDeleted, p_e );
175 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
176 libvlc_MediaListWillDeleteItem, p_e );
178 if( libvlc_exception_raised( p_e ) )
180 libvlc_event_manager_release( p_mlist->p_event_manager );
185 vlc_mutex_init( &p_mlist->object_lock );
186 vlc_mutex_init( &p_mlist->refcount_lock ); // FIXME: spinlock?
188 vlc_array_init( &p_mlist->items );
189 p_mlist->i_refcount = 1;
190 p_mlist->p_md = NULL;
195 /**************************************************************************
196 * libvlc_media_list_release (Public)
199 **************************************************************************/
200 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
202 libvlc_media_t * p_md;
205 vlc_mutex_lock( &p_mlist->refcount_lock );
206 p_mlist->i_refcount--;
207 if( p_mlist->i_refcount > 0 )
209 vlc_mutex_unlock( &p_mlist->refcount_lock );
212 vlc_mutex_unlock( &p_mlist->refcount_lock );
214 /* Refcount null, time to free */
216 libvlc_event_manager_release( p_mlist->p_event_manager );
218 libvlc_media_release( p_mlist->p_md );
220 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
222 p_md = vlc_array_item_at_index( &p_mlist->items, i );
223 libvlc_media_release( p_md );
226 vlc_mutex_destroy( &p_mlist->object_lock );
227 vlc_array_clear( &p_mlist->items );
232 /**************************************************************************
233 * libvlc_media_list_retain (Public)
235 * Increase an object refcount.
236 **************************************************************************/
237 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
239 vlc_mutex_lock( &p_mlist->refcount_lock );
240 p_mlist->i_refcount++;
241 vlc_mutex_unlock( &p_mlist->refcount_lock );
245 /**************************************************************************
246 * add_file_content (Public)
247 **************************************************************************/
249 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
250 const char * psz_uri,
251 libvlc_exception_t * p_e )
253 input_item_t * p_input_item;
254 libvlc_media_t * p_md;
256 p_input_item = input_item_NewExt(
257 p_mlist->p_libvlc_instance->p_libvlc_int, psz_uri,
258 _("Media Library"), 0, NULL, 0, -1 );
262 libvlc_exception_raise( p_e, "Can't create an input item" );
266 p_md = libvlc_media_new_from_input_item(
267 p_mlist->p_libvlc_instance,
272 vlc_gc_decref( p_input_item );
276 libvlc_media_list_add_media( p_mlist, p_md, p_e );
277 if( libvlc_exception_raised( p_e ) )
280 input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item, true );
285 /**************************************************************************
287 **************************************************************************/
288 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
289 libvlc_media_t * p_md,
290 libvlc_exception_t * p_e)
294 vlc_mutex_lock( &p_mlist->object_lock );
295 libvlc_media_release( p_mlist->p_md );
296 libvlc_media_retain( p_md );
297 p_mlist->p_md = p_md;
298 vlc_mutex_unlock( &p_mlist->object_lock );
301 /**************************************************************************
304 * If this media_list comes is a media's subitems,
305 * This holds the corresponding media.
306 * This md is also seen as the information holder for the media_list.
307 * Indeed a media_list can have meta information through this
309 **************************************************************************/
311 libvlc_media_list_media( libvlc_media_list_t * p_mlist,
312 libvlc_exception_t * p_e)
314 libvlc_media_t *p_md;
317 vlc_mutex_lock( &p_mlist->object_lock );
318 p_md = p_mlist->p_md;
320 libvlc_media_retain( p_md );
321 vlc_mutex_unlock( &p_mlist->object_lock );
326 /**************************************************************************
327 * libvlc_media_list_count (Public)
329 * Lock should be hold when entering.
330 **************************************************************************/
331 int libvlc_media_list_count( libvlc_media_list_t * p_mlist,
332 libvlc_exception_t * p_e )
335 return vlc_array_count( &p_mlist->items );
338 /**************************************************************************
339 * libvlc_media_list_add_media (Public)
341 * Lock should be held when entering.
342 **************************************************************************/
343 void libvlc_media_list_add_media(
344 libvlc_media_list_t * p_mlist,
345 libvlc_media_t * p_md,
346 libvlc_exception_t * p_e )
348 if( mlist_is_writable(p_mlist,p_e) )
349 _libvlc_media_list_add_media( p_mlist, p_md, p_e );
352 /* LibVLC internal version */
353 void _libvlc_media_list_add_media(
354 libvlc_media_list_t * p_mlist,
355 libvlc_media_t * p_md,
356 libvlc_exception_t * p_e )
359 libvlc_media_retain( p_md );
361 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
363 vlc_array_append( &p_mlist->items, p_md );
364 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
368 /**************************************************************************
369 * libvlc_media_list_insert_media (Public)
371 * Lock should be hold when entering.
372 **************************************************************************/
373 void libvlc_media_list_insert_media(
374 libvlc_media_list_t * p_mlist,
375 libvlc_media_t * p_md,
377 libvlc_exception_t * p_e )
379 if( mlist_is_writable(p_mlist,p_e) )
380 _libvlc_media_list_insert_media( p_mlist, p_md, index, p_e );
383 /* LibVLC internal version */
384 void _libvlc_media_list_insert_media(
385 libvlc_media_list_t * p_mlist,
386 libvlc_media_t * p_md,
388 libvlc_exception_t * p_e )
391 libvlc_media_retain( p_md );
393 notify_item_addition( p_mlist, p_md, index, EventWillHappen );
394 vlc_array_insert( &p_mlist->items, p_md, index );
395 notify_item_addition( p_mlist, p_md, index, EventDidHappen );
398 /**************************************************************************
399 * libvlc_media_list_remove_index (Public)
401 * Lock should be held when entering.
402 **************************************************************************/
403 void libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
405 libvlc_exception_t * p_e )
407 if( mlist_is_writable(p_mlist,p_e) )
408 _libvlc_media_list_remove_index( p_mlist, index, p_e );
411 /* LibVLC internal version */
412 void _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
414 libvlc_exception_t * p_e )
416 libvlc_media_t * p_md;
418 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
420 libvlc_exception_raise( p_e, "Index out of bounds");
424 p_md = vlc_array_item_at_index( &p_mlist->items, index );
426 notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
427 vlc_array_remove( &p_mlist->items, index );
428 notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
430 libvlc_media_release( p_md );
433 /**************************************************************************
434 * libvlc_media_list_item_at_index (Public)
436 * Lock should be held when entering.
437 **************************************************************************/
439 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
441 libvlc_exception_t * p_e )
443 libvlc_media_t * p_md;
445 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
447 libvlc_exception_raise( p_e, "Index out of bounds");
451 p_md = vlc_array_item_at_index( &p_mlist->items, index );
452 libvlc_media_retain( p_md );
456 /**************************************************************************
457 * libvlc_media_list_index_of_item (Public)
459 * Lock should be held when entering.
460 * Warning: this function returns the first matching item.
461 **************************************************************************/
462 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
463 libvlc_media_t * p_searched_md,
464 libvlc_exception_t * p_e )
468 libvlc_media_t * p_md;
470 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
472 p_md = vlc_array_item_at_index( &p_mlist->items, i );
473 if( p_searched_md == p_md )
479 /**************************************************************************
480 * libvlc_media_list_is_readonly (Public)
482 * This indicates if this media list is read-only from a user point of view
483 **************************************************************************/
484 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
486 return p_mlist->b_read_only;
489 /**************************************************************************
490 * libvlc_media_list_lock (Public)
492 * The lock must be held in access operations. It is never used in the
494 **************************************************************************/
495 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
497 vlc_mutex_lock( &p_mlist->object_lock );
501 /**************************************************************************
502 * libvlc_media_list_unlock (Public)
504 * The lock must be held in access operations
505 **************************************************************************/
506 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
508 vlc_mutex_unlock( &p_mlist->object_lock );
512 /**************************************************************************
513 * libvlc_media_list_p_event_manager (Public)
515 * The p_event_manager is immutable, so you don't have to hold the lock
516 **************************************************************************/
517 libvlc_event_manager_t *
518 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist,
519 libvlc_exception_t * p_e )
522 return p_mlist->p_event_manager;