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,
155 libvlc_exception_t * p_e )
157 libvlc_media_list_t * p_mlist;
159 p_mlist = malloc(sizeof(libvlc_media_list_t));
163 p_mlist->p_libvlc_instance = p_inst;
164 p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst, p_e );
166 /* Code for that one should be handled in flat_media_list.c */
167 p_mlist->p_flat_mlist = NULL;
168 p_mlist->b_read_only = false;
170 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
171 libvlc_MediaListItemAdded, p_e );
172 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
173 libvlc_MediaListWillAddItem, p_e );
174 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
175 libvlc_MediaListItemDeleted, p_e );
176 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
177 libvlc_MediaListWillDeleteItem, p_e );
179 if( libvlc_exception_raised( p_e ) )
181 libvlc_event_manager_release( p_mlist->p_event_manager );
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(
269 p_mlist->p_libvlc_instance,
274 vlc_gc_decref( p_input_item );
278 libvlc_media_list_add_media( p_mlist, p_md, p_e );
279 if( libvlc_exception_raised( p_e ) )
282 input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item, true );
287 /**************************************************************************
289 **************************************************************************/
290 void libvlc_media_list_set_media( libvlc_media_list_t * p_mlist,
291 libvlc_media_t * p_md,
292 libvlc_exception_t * p_e)
296 vlc_mutex_lock( &p_mlist->object_lock );
297 libvlc_media_release( p_mlist->p_md );
298 libvlc_media_retain( p_md );
299 p_mlist->p_md = p_md;
300 vlc_mutex_unlock( &p_mlist->object_lock );
303 /**************************************************************************
306 * If this media_list comes is a media's subitems,
307 * This holds the corresponding media.
308 * This md is also seen as the information holder for the media_list.
309 * Indeed a media_list can have meta information through this
311 **************************************************************************/
313 libvlc_media_list_media( libvlc_media_list_t * p_mlist,
314 libvlc_exception_t * p_e)
316 libvlc_media_t *p_md;
319 vlc_mutex_lock( &p_mlist->object_lock );
320 p_md = p_mlist->p_md;
322 libvlc_media_retain( p_md );
323 vlc_mutex_unlock( &p_mlist->object_lock );
328 /**************************************************************************
329 * libvlc_media_list_count (Public)
331 * Lock should be hold when entering.
332 **************************************************************************/
333 int libvlc_media_list_count( libvlc_media_list_t * p_mlist,
334 libvlc_exception_t * p_e )
337 return vlc_array_count( &p_mlist->items );
340 /**************************************************************************
341 * libvlc_media_list_add_media (Public)
343 * Lock should be held when entering.
344 **************************************************************************/
345 void libvlc_media_list_add_media(
346 libvlc_media_list_t * p_mlist,
347 libvlc_media_t * p_md,
348 libvlc_exception_t * p_e )
350 if( mlist_is_writable(p_mlist,p_e) )
351 _libvlc_media_list_add_media( p_mlist, p_md, p_e );
354 /* LibVLC internal version */
355 void _libvlc_media_list_add_media(
356 libvlc_media_list_t * p_mlist,
357 libvlc_media_t * p_md,
358 libvlc_exception_t * p_e )
361 libvlc_media_retain( p_md );
363 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ),
365 vlc_array_append( &p_mlist->items, p_md );
366 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1,
370 /**************************************************************************
371 * libvlc_media_list_insert_media (Public)
373 * Lock should be hold when entering.
374 **************************************************************************/
375 void libvlc_media_list_insert_media(
376 libvlc_media_list_t * p_mlist,
377 libvlc_media_t * p_md,
379 libvlc_exception_t * p_e )
381 if( mlist_is_writable(p_mlist,p_e) )
382 _libvlc_media_list_insert_media( p_mlist, p_md, index, p_e );
385 /* LibVLC internal version */
386 void _libvlc_media_list_insert_media(
387 libvlc_media_list_t * p_mlist,
388 libvlc_media_t * p_md,
390 libvlc_exception_t * p_e )
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 void libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
407 libvlc_exception_t * p_e )
409 if( mlist_is_writable(p_mlist,p_e) )
410 _libvlc_media_list_remove_index( p_mlist, index, p_e );
413 /* LibVLC internal version */
414 void _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
416 libvlc_exception_t * p_e )
418 libvlc_media_t * p_md;
420 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
422 libvlc_exception_raise( p_e );
423 libvlc_printerr( "Index out of bounds" );
427 p_md = vlc_array_item_at_index( &p_mlist->items, index );
429 notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
430 vlc_array_remove( &p_mlist->items, index );
431 notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
433 libvlc_media_release( p_md );
436 /**************************************************************************
437 * libvlc_media_list_item_at_index (Public)
439 * Lock should be held when entering.
440 **************************************************************************/
442 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
444 libvlc_exception_t * p_e )
446 libvlc_media_t * p_md;
448 if( index < 0 || index >= vlc_array_count( &p_mlist->items ))
450 libvlc_exception_raise( p_e );
451 libvlc_printerr( "Index out of bounds" );
455 p_md = vlc_array_item_at_index( &p_mlist->items, index );
456 libvlc_media_retain( p_md );
460 /**************************************************************************
461 * libvlc_media_list_index_of_item (Public)
463 * Lock should be held when entering.
464 * Warning: this function returns the first matching item.
465 **************************************************************************/
466 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
467 libvlc_media_t * p_searched_md,
468 libvlc_exception_t * p_e )
472 libvlc_media_t * p_md;
474 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
476 p_md = vlc_array_item_at_index( &p_mlist->items, i );
477 if( p_searched_md == p_md )
483 /**************************************************************************
484 * libvlc_media_list_is_readonly (Public)
486 * This indicates if this media list is read-only from a user point of view
487 **************************************************************************/
488 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
490 return p_mlist->b_read_only;
493 /**************************************************************************
494 * libvlc_media_list_lock (Public)
496 * The lock must be held in access operations. It is never used in the
498 **************************************************************************/
499 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
501 vlc_mutex_lock( &p_mlist->object_lock );
505 /**************************************************************************
506 * libvlc_media_list_unlock (Public)
508 * The lock must be held in access operations
509 **************************************************************************/
510 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
512 vlc_mutex_unlock( &p_mlist->object_lock );
516 /**************************************************************************
517 * libvlc_media_list_p_event_manager (Public)
519 * The p_event_manager is immutable, so you don't have to hold the lock
520 **************************************************************************/
521 libvlc_event_manager_t *
522 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist,
523 libvlc_exception_t * p_e )
526 return p_mlist->p_event_manager;