1 /*****************************************************************************
2 * media_list.c: libvlc new API media list functions
3 *****************************************************************************
4 * Copyright (C) 2007 VLC authors and VideoLAN
7 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
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 *****************************************************************************/
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 /* LibVLC internal */
126 void libvlc_media_list_internal_end_reached( libvlc_media_list_t * p_mlist )
128 libvlc_event_t event;
130 event.type = libvlc_MediaListEndReached;
133 libvlc_event_send( p_mlist->p_event_manager, &event );
136 /**************************************************************************
137 * static mlist_is_writable (private)
138 **************************************************************************/
140 bool mlist_is_writable( libvlc_media_list_t *p_mlist )
142 if( !p_mlist||p_mlist->b_read_only )
144 /* We are read-only from user side */
145 libvlc_printerr( "Attempt to write a read-only media list" );
152 * Public libvlc functions
155 /**************************************************************************
156 * libvlc_media_list_new (Public)
159 **************************************************************************/
160 libvlc_media_list_t *
161 libvlc_media_list_new( libvlc_instance_t * p_inst )
163 libvlc_media_list_t * p_mlist;
165 p_mlist = malloc(sizeof(libvlc_media_list_t));
166 if( unlikely(p_mlist == NULL) )
168 libvlc_printerr( "Not enough memory" );
172 p_mlist->p_libvlc_instance = p_inst;
173 p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst );
174 if( unlikely(p_mlist->p_event_manager == NULL) )
180 p_mlist->b_read_only = false;
182 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
183 libvlc_MediaListItemAdded );
184 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
185 libvlc_MediaListWillAddItem );
186 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
187 libvlc_MediaListItemDeleted );
188 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
189 libvlc_MediaListWillDeleteItem );
190 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
191 libvlc_MediaListEndReached );
193 vlc_mutex_init( &p_mlist->object_lock );
194 vlc_mutex_init( &p_mlist->refcount_lock ); // FIXME: spinlock?
196 vlc_array_init( &p_mlist->items );
197 assert( p_mlist->items.i_count == 0 );
198 p_mlist->i_refcount = 1;
199 p_mlist->p_md = NULL;
200 p_mlist->p_internal_md = NULL;
205 /**************************************************************************
206 * libvlc_media_list_release (Public)
209 **************************************************************************/
210 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
212 libvlc_media_t * p_md;
215 vlc_mutex_lock( &p_mlist->refcount_lock );
216 p_mlist->i_refcount--;
217 if( p_mlist->i_refcount > 0 )
219 vlc_mutex_unlock( &p_mlist->refcount_lock );
222 vlc_mutex_unlock( &p_mlist->refcount_lock );
224 /* Refcount null, time to free */
226 libvlc_event_manager_release( p_mlist->p_event_manager );
228 libvlc_media_release( p_mlist->p_md );
230 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
232 p_md = vlc_array_item_at_index( &p_mlist->items, i );
233 libvlc_media_release( p_md );
236 vlc_mutex_destroy( &p_mlist->object_lock );
237 vlc_mutex_destroy( &p_mlist->refcount_lock );
238 vlc_array_clear( &p_mlist->items );
243 /**************************************************************************
244 * libvlc_media_list_retain (Public)
246 * Increase an object refcount.
247 **************************************************************************/
248 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
250 vlc_mutex_lock( &p_mlist->refcount_lock );
251 p_mlist->i_refcount++;
252 vlc_mutex_unlock( &p_mlist->refcount_lock );
256 /**************************************************************************
257 * add_file_content (Public)
258 **************************************************************************/
260 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
261 const char * psz_uri )
263 input_item_t * p_input_item;
264 libvlc_media_t * p_md;
266 p_input_item = input_item_NewExt( psz_uri,
267 _("Media Library"), 0, NULL, 0, -1 );
271 libvlc_printerr( "Not enough memory" );
275 p_md = libvlc_media_new_from_input_item( p_mlist->p_libvlc_instance,
279 vlc_gc_decref( p_input_item );
283 if( libvlc_media_list_add_media( p_mlist, p_md ) )
285 #warning Missing error handling!
286 /* printerr and leaks */
290 input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item );
294 /**************************************************************************
296 **************************************************************************/
297 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
298 libvlc_media_t * p_md )
301 vlc_mutex_lock( &p_mlist->object_lock );
302 if( p_mlist->p_internal_md || !mlist_is_writable(p_mlist) )
304 vlc_mutex_unlock( &p_mlist->object_lock );
307 libvlc_media_release( p_mlist->p_md );
308 libvlc_media_retain( p_md );
309 p_mlist->p_md = p_md;
310 vlc_mutex_unlock( &p_mlist->object_lock );
313 /**************************************************************************
316 * If this media_list comes is a media's subitems,
317 * This holds the corresponding media.
318 * This md is also seen as the information holder for the media_list.
319 * Indeed a media_list can have meta information through this
321 **************************************************************************/
323 libvlc_media_list_media( libvlc_media_list_t * p_mlist )
325 libvlc_media_t *p_md;
327 vlc_mutex_lock( &p_mlist->object_lock );
328 p_md = p_mlist->p_internal_md ? p_mlist->p_internal_md : p_mlist->p_md;
330 libvlc_media_retain( p_md );
331 vlc_mutex_unlock( &p_mlist->object_lock );
336 /**************************************************************************
337 * libvlc_media_list_count (Public)
339 * Lock should be held when entering.
340 **************************************************************************/
341 int libvlc_media_list_count( libvlc_media_list_t * p_mlist )
343 return vlc_array_count( &p_mlist->items );
346 /**************************************************************************
347 * libvlc_media_list_add_media (Public)
349 * Lock should be held when entering.
350 **************************************************************************/
351 int libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
352 libvlc_media_t * p_md )
354 if( !mlist_is_writable(p_mlist) )
356 libvlc_media_list_internal_add_media( p_mlist, p_md );
360 /* LibVLC internal version */
361 void libvlc_media_list_internal_add_media( libvlc_media_list_t * p_mlist,
362 libvlc_media_t * p_md )
364 libvlc_media_retain( p_md );
366 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
368 vlc_array_append( &p_mlist->items, p_md );
369 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
373 /**************************************************************************
374 * libvlc_media_list_insert_media (Public)
376 * Lock should be hold when entering.
377 **************************************************************************/
378 int libvlc_media_list_insert_media( libvlc_media_list_t * p_mlist,
379 libvlc_media_t * p_md,
382 if( !mlist_is_writable(p_mlist) )
384 libvlc_media_list_internal_insert_media( p_mlist, p_md, index );
388 /* LibVLC internal version */
389 void libvlc_media_list_internal_insert_media( libvlc_media_list_t * p_mlist,
390 libvlc_media_t * p_md,
393 libvlc_media_retain( p_md );
395 notify_item_addition( p_mlist, p_md, index, EventWillHappen );
396 vlc_array_insert( &p_mlist->items, p_md, index );
397 notify_item_addition( p_mlist, p_md, index, EventDidHappen );
400 /**************************************************************************
401 * libvlc_media_list_remove_index (Public)
403 * Lock should be held when entering.
404 **************************************************************************/
405 int libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
408 if( !mlist_is_writable(p_mlist) )
410 return libvlc_media_list_internal_remove_index( p_mlist, index );
413 /* LibVLC internal version */
414 int libvlc_media_list_internal_remove_index( libvlc_media_list_t * p_mlist,
417 libvlc_media_t * p_md;
419 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
421 libvlc_printerr( "Index out of bounds" );
425 p_md = vlc_array_item_at_index( &p_mlist->items, index );
427 notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
428 vlc_array_remove( &p_mlist->items, index );
429 notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
431 libvlc_media_release( p_md );
435 /**************************************************************************
436 * libvlc_media_list_item_at_index (Public)
438 * Lock should be held when entering.
439 **************************************************************************/
441 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
444 libvlc_media_t * p_md;
446 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
448 libvlc_printerr( "Index out of bounds" );
452 p_md = vlc_array_item_at_index( &p_mlist->items, index );
453 libvlc_media_retain( p_md );
457 /**************************************************************************
458 * libvlc_media_list_index_of_item (Public)
460 * Lock should be held when entering.
461 * Warning: this function returns the first matching item.
462 **************************************************************************/
463 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
464 libvlc_media_t * p_searched_md )
466 libvlc_media_t * p_md;
468 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
470 p_md = vlc_array_item_at_index( &p_mlist->items, i );
471 if( p_searched_md == p_md )
474 libvlc_printerr( "Media not found" );
478 /**************************************************************************
479 * libvlc_media_list_is_readonly (Public)
481 * This indicates if this media list is read-only from a user point of view
482 **************************************************************************/
483 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
485 return p_mlist->b_read_only;
488 /**************************************************************************
489 * libvlc_media_list_lock (Public)
491 * The lock must be held in access operations. It is never used in the
493 **************************************************************************/
494 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
496 vlc_mutex_lock( &p_mlist->object_lock );
500 /**************************************************************************
501 * libvlc_media_list_unlock (Public)
503 * The lock must be held in access operations
504 **************************************************************************/
505 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
507 vlc_mutex_unlock( &p_mlist->object_lock );
511 /**************************************************************************
512 * libvlc_media_list_p_event_manager (Public)
514 * The p_event_manager is immutable, so you don't have to hold the lock
515 **************************************************************************/
516 libvlc_event_manager_t *
517 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist )
519 return p_mlist->p_event_manager;