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 *****************************************************************************/
24 #include "libvlc_internal.h"
25 #include <vlc/libvlc.h>
27 #include "vlc_arrays.h"
29 typedef enum EventPlaceInTime {
34 //#define DEBUG_MEDIA_LIST
36 #ifdef DEBUG_MEDIA_LIST
37 # define trace( fmt, ... ) printf( "%s(): " fmt, __FUNCTION__, ##__VA_ARGS__ )
48 /**************************************************************************
49 * notify_item_addition (private)
51 * Do the appropriate action when an item is deleted.
52 **************************************************************************/
54 notify_item_addition( libvlc_media_list_t * p_mlist,
55 libvlc_media_descriptor_t * p_md,
57 EventPlaceInTime event_status )
61 /* Construct the event */
62 if( event_status == EventDidHappen )
64 trace("item was added at index %d\n", index);
65 event.type = libvlc_MediaListItemAdded;
66 event.u.media_list_item_added.item = p_md;
67 event.u.media_list_item_added.index = index;
69 else /* if( event_status == EventWillHappen ) */
71 event.type = libvlc_MediaListWillAddItem;
72 event.u.media_list_will_add_item.item = p_md;
73 event.u.media_list_will_add_item.index = index;
77 libvlc_event_send( p_mlist->p_event_manager, &event );
80 /**************************************************************************
81 * notify_item_deletion (private)
83 * Do the appropriate action when an item is added.
84 **************************************************************************/
86 notify_item_deletion( libvlc_media_list_t * p_mlist,
87 libvlc_media_descriptor_t * p_md,
89 EventPlaceInTime event_status )
93 /* Construct the event */
94 if( event_status == EventDidHappen )
96 trace("item at index %d was deleted\n", index);
97 event.type = libvlc_MediaListItemDeleted;
98 event.u.media_list_item_deleted.item = p_md;
99 event.u.media_list_item_deleted.index = index;
101 else /* if( event_status == EventWillHappen ) */
103 event.type = libvlc_MediaListWillDeleteItem;
104 event.u.media_list_will_delete_item.item = p_md;
105 event.u.media_list_will_delete_item.index = index;
109 libvlc_event_send( p_mlist->p_event_manager, &event );
113 * Public libvlc functions
116 /**************************************************************************
117 * libvlc_media_list_new (Public)
120 **************************************************************************/
121 libvlc_media_list_t *
122 libvlc_media_list_new( libvlc_instance_t * p_inst,
123 libvlc_exception_t * p_e )
125 libvlc_media_list_t * p_mlist;
127 p_mlist = malloc(sizeof(libvlc_media_list_t));
132 p_mlist->p_libvlc_instance = p_inst;
133 p_mlist->p_event_manager = libvlc_event_manager_new( p_mlist, p_inst, p_e );
135 /* Code for that one should be handled in flat_media_list.c */
136 p_mlist->p_flat_mlist = NULL;
137 p_mlist->b_read_only = VLC_FALSE;
139 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
140 libvlc_MediaListItemAdded, p_e );
141 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
142 libvlc_MediaListWillAddItem, p_e );
143 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
144 libvlc_MediaListItemDeleted, p_e );
145 libvlc_event_manager_register_event_type( p_mlist->p_event_manager,
146 libvlc_MediaListWillDeleteItem, p_e );
148 if( libvlc_exception_raised( p_e ) )
150 libvlc_event_manager_release( p_mlist->p_event_manager );
155 vlc_mutex_init( p_inst->p_libvlc_int, &p_mlist->object_lock );
157 vlc_array_init( &p_mlist->items );
158 p_mlist->i_refcount = 1;
159 p_mlist->p_md = NULL;
164 /**************************************************************************
165 * libvlc_media_list_release (Public)
168 **************************************************************************/
169 void libvlc_media_list_release( libvlc_media_list_t * p_mlist )
171 libvlc_media_descriptor_t * p_md;
174 vlc_mutex_lock( &p_mlist->object_lock );
175 p_mlist->i_refcount--;
176 if( p_mlist->i_refcount > 0 )
178 vlc_mutex_unlock( &p_mlist->object_lock );
181 vlc_mutex_unlock( &p_mlist->object_lock );
183 /* Refcount null, time to free */
185 libvlc_event_manager_release( p_mlist->p_event_manager );
188 libvlc_media_descriptor_release( p_mlist->p_md );
190 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
192 p_md = vlc_array_item_at_index( &p_mlist->items, i );
193 libvlc_media_descriptor_release( p_md );
196 vlc_mutex_destroy( &p_mlist->object_lock );
197 vlc_array_clear( &p_mlist->items );
202 /**************************************************************************
203 * libvlc_media_list_retain (Public)
205 * Increase an object refcount.
206 **************************************************************************/
207 void libvlc_media_list_retain( libvlc_media_list_t * p_mlist )
209 vlc_mutex_lock( &p_mlist->object_lock );
210 p_mlist->i_refcount++;
211 vlc_mutex_unlock( &p_mlist->object_lock );
215 /**************************************************************************
216 * add_file_content (Public)
217 **************************************************************************/
219 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
220 const char * psz_uri,
221 libvlc_exception_t * p_e )
223 input_item_t * p_input_item;
224 libvlc_media_descriptor_t * p_md;
226 p_input_item = input_ItemNewExt( p_mlist->p_libvlc_instance->p_libvlc_int, psz_uri,
227 _("Media Library"), 0, NULL, -1 );
231 libvlc_exception_raise( p_e, "Can't create an input item" );
235 p_md = libvlc_media_descriptor_new_from_input_item(
236 p_mlist->p_libvlc_instance,
241 vlc_gc_decref( p_input_item );
245 libvlc_media_list_add_media_descriptor( p_mlist, p_md, p_e );
246 if( libvlc_exception_raised( p_e ) )
249 input_Read( p_mlist->p_libvlc_instance->p_libvlc_int, p_input_item, VLC_TRUE );
254 /**************************************************************************
255 * set_media_descriptor (Public)
256 **************************************************************************/
257 void libvlc_media_list_set_media_descriptor( libvlc_media_list_t * p_mlist,
258 libvlc_media_descriptor_t * p_md,
259 libvlc_exception_t * p_e)
263 vlc_mutex_lock( &p_mlist->object_lock );
265 libvlc_media_descriptor_release( p_mlist->p_md );
266 libvlc_media_descriptor_retain( p_md );
267 p_mlist->p_md = p_md;
268 vlc_mutex_unlock( &p_mlist->object_lock );
271 /**************************************************************************
272 * media_descriptor (Public)
274 * If this media_list comes is a media_descriptor's subitems,
275 * This holds the corresponding media_descriptor.
276 * This md is also seen as the information holder for the media_list.
277 * Indeed a media_list can have meta information through this
279 **************************************************************************/
280 libvlc_media_descriptor_t *
281 libvlc_media_list_media_descriptor( libvlc_media_list_t * p_mlist,
282 libvlc_exception_t * p_e)
284 libvlc_media_descriptor_t *p_md;
287 vlc_mutex_lock( &p_mlist->object_lock );
288 p_md = p_mlist->p_md;
290 libvlc_media_descriptor_retain( p_md );
291 vlc_mutex_unlock( &p_mlist->object_lock );
296 /**************************************************************************
297 * libvlc_media_list_count (Public)
299 * Lock should be hold when entering.
300 **************************************************************************/
301 int libvlc_media_list_count( libvlc_media_list_t * p_mlist,
302 libvlc_exception_t * p_e )
305 return vlc_array_count( &p_mlist->items );
308 /**************************************************************************
309 * libvlc_media_list_add_media_descriptor (Public)
311 * Lock should be hold when entering.
312 **************************************************************************/
313 void libvlc_media_list_add_media_descriptor(
314 libvlc_media_list_t * p_mlist,
315 libvlc_media_descriptor_t * p_md,
316 libvlc_exception_t * p_e )
318 if( p_mlist->b_read_only )
320 /* We are read only from user side */
321 libvlc_exception_raise( p_e, "Trying to write into a read-only media list." );
325 _libvlc_media_list_add_media_descriptor( p_mlist, p_md, p_e );
328 /* LibVLC internal version */
329 void _libvlc_media_list_add_media_descriptor(
330 libvlc_media_list_t * p_mlist,
331 libvlc_media_descriptor_t * p_md,
332 libvlc_exception_t * p_e )
335 libvlc_media_descriptor_retain( p_md );
337 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items ), EventWillHappen );
338 vlc_array_append( &p_mlist->items, p_md );
339 notify_item_addition( p_mlist, p_md, vlc_array_count( &p_mlist->items )-1, EventDidHappen );
342 /**************************************************************************
343 * libvlc_media_list_insert_media_descriptor (Public)
345 * Lock should be hold when entering.
346 **************************************************************************/
347 void libvlc_media_list_insert_media_descriptor(
348 libvlc_media_list_t * p_mlist,
349 libvlc_media_descriptor_t * p_md,
351 libvlc_exception_t * p_e )
353 if( p_mlist->b_read_only )
355 /* We are read only from user side */
356 libvlc_exception_raise( p_e, "Trying to write into a read-only media list." );
359 _libvlc_media_list_insert_media_descriptor( p_mlist, p_md, index, p_e );
362 /* LibVLC internal version */
363 void _libvlc_media_list_insert_media_descriptor(
364 libvlc_media_list_t * p_mlist,
365 libvlc_media_descriptor_t * p_md,
367 libvlc_exception_t * p_e )
370 libvlc_media_descriptor_retain( p_md );
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 );
377 /**************************************************************************
378 * libvlc_media_list_remove_index (Public)
380 * Lock should be hold when entering.
381 **************************************************************************/
382 void libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
384 libvlc_exception_t * p_e )
386 if( p_mlist->b_read_only )
388 /* We are read only from user side */
389 libvlc_exception_raise( p_e, "Trying to write into a read-only media list." );
392 _libvlc_media_list_remove_index( p_mlist, index, p_e );
395 /* LibVLC internal version */
396 void _libvlc_media_list_remove_index( libvlc_media_list_t * p_mlist,
398 libvlc_exception_t * p_e )
402 libvlc_media_descriptor_t * p_md;
404 p_md = vlc_array_item_at_index( &p_mlist->items, index );
406 notify_item_deletion( p_mlist, p_md, index, EventWillHappen );
407 vlc_array_remove( &p_mlist->items, index );
408 notify_item_deletion( p_mlist, p_md, index, EventDidHappen );
410 libvlc_media_descriptor_release( p_md );
413 /**************************************************************************
414 * libvlc_media_list_item_at_index (Public)
416 * Lock should be hold when entering.
417 **************************************************************************/
418 libvlc_media_descriptor_t *
419 libvlc_media_list_item_at_index( libvlc_media_list_t * p_mlist,
421 libvlc_exception_t * p_e )
425 libvlc_media_descriptor_t * p_md;
426 p_md = vlc_array_item_at_index( &p_mlist->items, index );
427 libvlc_media_descriptor_retain( p_md );
431 /**************************************************************************
432 * libvlc_media_list_index_of_item (Public)
434 * Lock should be hold when entering.
435 * Warning: this function would return the first matching item
436 **************************************************************************/
437 int libvlc_media_list_index_of_item( libvlc_media_list_t * p_mlist,
438 libvlc_media_descriptor_t * p_searched_md,
439 libvlc_exception_t * p_e )
443 libvlc_media_descriptor_t * p_md;
445 for ( i = 0; i < vlc_array_count( &p_mlist->items ); i++ )
447 p_md = vlc_array_item_at_index( &p_mlist->items, i );
448 if( p_searched_md == p_md )
454 /**************************************************************************
455 * libvlc_media_list_is_readonly (Public)
457 * This indicates if this media list is read-only from a user point of view
458 **************************************************************************/
459 int libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist )
461 return p_mlist->b_read_only;
464 /**************************************************************************
465 * libvlc_media_list_lock (Public)
467 * The lock must be held in access operations. It is never used in the
469 **************************************************************************/
470 void libvlc_media_list_lock( libvlc_media_list_t * p_mlist )
472 vlc_mutex_lock( &p_mlist->object_lock );
476 /**************************************************************************
477 * libvlc_media_list_unlock (Public)
479 * The lock must be held in access operations
480 **************************************************************************/
481 void libvlc_media_list_unlock( libvlc_media_list_t * p_mlist )
483 vlc_mutex_unlock( &p_mlist->object_lock );
487 /**************************************************************************
488 * libvlc_media_list_p_event_manager (Public)
490 * The p_event_manager is immutable, so you don't have to hold the lock
491 **************************************************************************/
492 libvlc_event_manager_t *
493 libvlc_media_list_event_manager( libvlc_media_list_t * p_mlist,
494 libvlc_exception_t * p_e )
497 return p_mlist->p_event_manager;