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 );
138 libvlc_printerr( "Attempt to write a read-only media list" );
145 * Public libvlc functions
148 /**************************************************************************
149 * libvlc_media_list_new (Public)
152 **************************************************************************/
153 libvlc_media_list_t *
154 libvlc_media_list_new( libvlc_instance_t * p_inst )
156 libvlc_media_list_t * p_mlist;
158 p_mlist = malloc(sizeof(libvlc_media_list_t));
159 if( unlikely(p_mlist == NULL) )
161 libvlc_printerr( "Not enough memory" );
165 p_mlist->p_libvlc_instance = p_inst;
166 p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst );
167 if( unlikely(p_mlist->p_event_manager == NULL) )
173 /* Code for that one should be handled in flat_media_list.c */
174 p_mlist->p_flat_mlist = NULL;
175 p_mlist->b_read_only = false;
177 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
178 libvlc_MediaListItemAdded );
179 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
180 libvlc_MediaListWillAddItem );
181 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
182 libvlc_MediaListItemDeleted );
183 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
184 libvlc_MediaListWillDeleteItem );
186 vlc_mutex_init( &p_mlist->object_lock );
187 vlc_mutex_init( &p_mlist->refcount_lock ); // FIXME: spinlock?
189 vlc_array_init( &p_mlist->items );
190 p_mlist->i_refcount = 1;
191 p_mlist->p_md = NULL;
196 /**************************************************************************
197 * libvlc_media_list_release (Public)
200 **************************************************************************/
201 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
203 libvlc_media_t * p_md;
206 vlc_mutex_lock( &p_mlist->refcount_lock );
207 p_mlist->i_refcount--;
208 if( p_mlist->i_refcount > 0 )
210 vlc_mutex_unlock( &p_mlist->refcount_lock );
213 vlc_mutex_unlock( &p_mlist->refcount_lock );
215 /* Refcount null, time to free */
217 libvlc_event_manager_release( p_mlist->p_event_manager );
219 libvlc_media_release( p_mlist->p_md );
221 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
223 p_md = vlc_array_item_at_index( &p_mlist->items, i );
224 libvlc_media_release( p_md );
227 vlc_mutex_destroy( &p_mlist->object_lock );
228 vlc_array_clear( &p_mlist->items );
233 /**************************************************************************
234 * libvlc_media_list_retain (Public)
236 * Increase an object refcount.
237 **************************************************************************/
238 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
240 vlc_mutex_lock( &p_mlist->refcount_lock );
241 p_mlist->i_refcount++;
242 vlc_mutex_unlock( &p_mlist->refcount_lock );
246 /**************************************************************************
247 * add_file_content (Public)
248 **************************************************************************/
250 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
251 const char * psz_uri,
252 libvlc_exception_t * p_e )
254 input_item_t * p_input_item;
255 libvlc_media_t * p_md;
257 p_input_item = input_item_NewExt(
258 p_mlist->p_libvlc_instance->p_libvlc_int, psz_uri,
259 _("Media Library"), 0, NULL, 0, -1 );
263 libvlc_exception_raise( p_e );
264 libvlc_printerr( "Not enough memory" );
268 p_md = libvlc_media_new_from_input_item( 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 );
285 /**************************************************************************
287 **************************************************************************/
288 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
289 libvlc_media_t * p_md )
292 vlc_mutex_lock( &p_mlist->object_lock );
293 libvlc_media_release( p_mlist->p_md );
294 libvlc_media_retain( p_md );
295 p_mlist->p_md = p_md;
296 vlc_mutex_unlock( &p_mlist->object_lock );
299 /**************************************************************************
302 * If this media_list comes is a media's subitems,
303 * This holds the corresponding media.
304 * This md is also seen as the information holder for the media_list.
305 * Indeed a media_list can have meta information through this
307 **************************************************************************/
309 libvlc_media_list_media( libvlc_media_list_t * p_mlist )
311 libvlc_media_t *p_md;
313 vlc_mutex_lock( &p_mlist->object_lock );
314 p_md = p_mlist->p_md;
316 libvlc_media_retain( p_md );
317 vlc_mutex_unlock( &p_mlist->object_lock );
322 /**************************************************************************
323 * libvlc_media_list_count (Public)
325 * Lock should be held when entering.
326 **************************************************************************/
327 int libvlc_media_list_count( libvlc_media_list_t * p_mlist )
329 return vlc_array_count( &p_mlist->items );
332 /**************************************************************************
333 * libvlc_media_list_add_media (Public)
335 * Lock should be held when entering.
336 **************************************************************************/
337 void libvlc_media_list_add_media(
338 libvlc_media_list_t * p_mlist,
339 libvlc_media_t * p_md,
340 libvlc_exception_t * p_e )
342 if( mlist_is_writable(p_mlist,p_e) )
343 _libvlc_media_list_add_media( p_mlist, p_md );
346 /* LibVLC internal version */
347 void _libvlc_media_list_add_media( libvlc_media_list_t * p_mlist,
348 libvlc_media_t * p_md )
350 libvlc_media_retain( p_md );
352 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
354 vlc_array_append( &p_mlist->items, p_md );
355 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
359 /**************************************************************************
360 * libvlc_media_list_insert_media (Public)
362 * Lock should be hold when entering.
363 **************************************************************************/
364 void libvlc_media_list_insert_media(
365 libvlc_media_list_t * p_mlist,
366 libvlc_media_t * p_md,
368 libvlc_exception_t * p_e )
370 if( mlist_is_writable(p_mlist,p_e) )
371 _libvlc_media_list_insert_media( p_mlist, p_md, index );
374 /* LibVLC internal version */
375 void _libvlc_media_list_insert_media(
376 libvlc_media_list_t * p_mlist,
377 libvlc_media_t * p_md,
380 libvlc_media_retain( p_md );
382 notify_item_addition( p_mlist, p_md, index, EventWillHappen );
383 vlc_array_insert( &p_mlist->items, p_md, index );
384 notify_item_addition( p_mlist, p_md, index, EventDidHappen );
387 /**************************************************************************
388 * libvlc_media_list_remove_index (Public)
390 * Lock should be held when entering.
391 **************************************************************************/
392 void libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
394 libvlc_exception_t * p_e )
396 if( mlist_is_writable(p_mlist,p_e) )
397 _libvlc_media_list_remove_index( p_mlist, index, p_e );
400 /* LibVLC internal version */
401 void _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
403 libvlc_exception_t * p_e )
405 libvlc_media_t * p_md;
407 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
409 libvlc_exception_raise( p_e );
410 libvlc_printerr( "Index out of bounds" );
414 p_md = vlc_array_item_at_index( &p_mlist->items, index );
416 notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
417 vlc_array_remove( &p_mlist->items, index );
418 notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
420 libvlc_media_release( p_md );
423 /**************************************************************************
424 * libvlc_media_list_item_at_index (Public)
426 * Lock should be held when entering.
427 **************************************************************************/
429 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
431 libvlc_exception_t * p_e )
433 libvlc_media_t * p_md;
435 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
437 libvlc_exception_raise( p_e );
438 libvlc_printerr( "Index out of bounds" );
442 p_md = vlc_array_item_at_index( &p_mlist->items, index );
443 libvlc_media_retain( p_md );
447 /**************************************************************************
448 * libvlc_media_list_index_of_item (Public)
450 * Lock should be held when entering.
451 * Warning: this function returns the first matching item.
452 **************************************************************************/
453 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
454 libvlc_media_t * p_searched_md )
456 libvlc_media_t * p_md;
458 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
460 p_md = vlc_array_item_at_index( &p_mlist->items, i );
461 if( p_searched_md == p_md )
467 /**************************************************************************
468 * libvlc_media_list_is_readonly (Public)
470 * This indicates if this media list is read-only from a user point of view
471 **************************************************************************/
472 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
474 return p_mlist->b_read_only;
477 /**************************************************************************
478 * libvlc_media_list_lock (Public)
480 * The lock must be held in access operations. It is never used in the
482 **************************************************************************/
483 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
485 vlc_mutex_lock( &p_mlist->object_lock );
489 /**************************************************************************
490 * libvlc_media_list_unlock (Public)
492 * The lock must be held in access operations
493 **************************************************************************/
494 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
496 vlc_mutex_unlock( &p_mlist->object_lock );
500 /**************************************************************************
501 * libvlc_media_list_p_event_manager (Public)
503 * The p_event_manager is immutable, so you don't have to hold the lock
504 **************************************************************************/
505 libvlc_event_manager_t *
506 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist )
508 return p_mlist->p_event_manager;