1 /*****************************************************************************
2 * VLCMediaList.m: VLCKit.framework VLCMediaList implementation
3 *****************************************************************************
4 * Copyright (C) 2007 Pierre d'Herbemont
5 * Copyright (C) 2007 the VideoLAN team
8 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #import "VLCMediaList.h"
26 #import "VLCLibrary.h"
27 #import "VLCEventManager.h"
28 #import "VLCLibVLCBridging.h"
34 #include <vlc/libvlc.h>
36 /* Notification Messages */
37 NSString * VLCMediaListItemAdded = @"VLCMediaListItemAdded";
38 NSString * VLCMediaListItemDeleted = @"VLCMediaListItemDeleted";
40 // TODO: Documentation
41 @interface VLCMediaList (Private)
43 - (void)initInternalMediaList;
45 /* Libvlc event bridges */
46 - (void)mediaListItemAdded:(NSArray *)args;
47 - (void)mediaListItemRemoved:(NSNumber *)index;
50 /* libvlc event callback */
51 static void HandleMediaListItemAdded(const libvlc_event_t * event, void * user_data)
53 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
55 [[VLCEventManager sharedManager] callOnMainThreadObject:self
56 withMethod:@selector(mediaListItemAdded:)
57 withArgumentAsObject:[NSArray arrayWithObject:[NSDictionary dictionaryWithObjectsAndKeys:
58 [VLCMedia mediaWithLibVLCMediaDescriptor:event->u.media_list_item_added.item], @"media",
59 [NSNumber numberWithInt:event->u.media_list_item_added.index], @"index",
64 static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * user_data)
66 NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
68 [[VLCEventManager sharedManager] callOnMainThreadObject:self
69 withMethod:@selector(mediaListItemRemoved:)
70 withArgumentAsObject:[NSNumber numberWithInt:event->u.media_list_item_deleted.index]];
74 @implementation VLCMediaList
77 if (self = [super init])
79 // Create a new libvlc media list instance
80 p_mlist = libvlc_media_list_new([VLCLibrary sharedInstance]);
82 // Initialize internals to defaults
83 cachedMedia = [[NSMutableArray alloc] init];
84 delegate = flatAspect = hierarchicalAspect = hierarchicalNodeAspect = nil;
85 [self initInternalMediaList];
94 if([self retainCount] <= 1)
96 /* We must make sure we won't receive new event after an upcoming dealloc
97 * We also may receive a -retain in some event callback that may occcur
98 * Before libvlc_event_detach. So this can't happen in dealloc */
99 libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist);
100 libvlc_event_detach(p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self);
101 libvlc_event_detach(p_em, libvlc_MediaListItemAdded, HandleMediaListItemAdded, self);
109 // Release allocated memory
112 libvlc_media_list_release( p_mlist );
113 [cachedMedia release];
114 [flatAspect release];
115 [hierarchicalAspect release];
116 [hierarchicalNodeAspect release];
120 - (NSString *)description
122 NSMutableString * content = [NSMutableString string];
124 for( i = 0; i < [self count]; i++)
126 [content appendFormat:@"%@\n", [self mediaAtIndex: i]];
128 return [NSString stringWithFormat:@"<%@ %p> {\n%@}", [self className], self, content];
133 libvlc_media_list_lock( p_mlist );
138 libvlc_media_list_unlock( p_mlist );
141 - (NSInteger)addMedia:(VLCMedia *)media
143 int index = [self count];
144 [self insertMedia:media atIndex:index];
148 - (void)insertMedia:(VLCMedia *)media atIndex: (NSInteger)index
152 // Add it to the libvlc's medialist
153 libvlc_exception_t p_e;
154 libvlc_exception_init( &p_e );
155 libvlc_media_list_insert_media( p_mlist, [media libVLCMediaDescriptor], index, &p_e );
156 catch_exception( &p_e );
159 - (void)removeMediaAtIndex:(NSInteger)index
161 [[self mediaAtIndex:index] release];
163 // Remove it from the libvlc's medialist
164 libvlc_exception_t p_e;
165 libvlc_exception_init( &p_e );
166 libvlc_media_list_remove_index( p_mlist, index, &p_e );
167 catch_exception( &p_e );
170 - (VLCMedia *)mediaAtIndex:(NSInteger)index
172 return [cachedMedia objectAtIndex:index];
175 - (NSInteger)indexOfMedia:(VLCMedia *)media
177 NSInteger result = libvlc_media_list_index_of_item(p_mlist, [media libVLCMediaDescriptor]);
181 /* KVC Compliance: For the @"media" key */
182 - (NSInteger)countOfMedia
187 - (id)objectInMediaAtIndex:(NSUInteger)i
189 return [self mediaAtIndex:i];
194 return [cachedMedia count];
197 - (void)insertObject:(id)object inMediaAtIndex:(NSUInteger)i
199 [self insertMedia:object atIndex:i];
202 - (void)removeObjectFromMediaAtIndex:(NSUInteger)i
204 [self removeMediaAtIndex:i];
207 @synthesize delegate;
211 return libvlc_media_list_is_readonly( p_mlist );
214 /* Media list aspect */
215 - (VLCMediaListAspect *)hierarchicalAspect
217 if( hierarchicalAspect )
218 return hierarchicalAspect;
220 libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_view(p_mlist);
221 hierarchicalAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
222 libvlc_media_list_view_release( p_mlv );
223 return hierarchicalAspect;
226 - (VLCMediaListAspect *)hierarchicalNodeAspect
228 if( hierarchicalNodeAspect )
229 return hierarchicalNodeAspect;
231 libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_node_view(p_mlist);
232 hierarchicalNodeAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
233 libvlc_media_list_view_release( p_mlv );
234 return hierarchicalNodeAspect;
237 - (VLCMediaListAspect *)flatAspect
242 libvlc_media_list_view_t * p_mlv = libvlc_media_list_flat_view(p_mlist, NULL);
243 flatAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
244 libvlc_media_list_view_release( p_mlv );
250 @implementation VLCMediaList (LibVLCBridging)
251 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
253 return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
256 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
258 if( self = [super init] )
260 p_mlist = p_new_mlist;
261 libvlc_media_list_retain( p_mlist );
262 libvlc_media_list_lock( p_mlist );
263 cachedMedia = [[NSMutableArray alloc] initWithCapacity:libvlc_media_list_count(p_mlist)];
265 NSUInteger i, count = libvlc_media_list_count(p_mlist);
266 for( i = 0; i < count; i++ )
268 libvlc_media_t * p_md = libvlc_media_list_item_at_index( p_mlist, i, NULL );
269 [cachedMedia addObject:[VLCMedia mediaWithLibVLCMediaDescriptor:p_md]];
270 libvlc_media_release(p_md);
272 [self initInternalMediaList];
273 libvlc_media_list_unlock(p_mlist);
278 - (void *)libVLCMediaList
284 @implementation VLCMediaList (Private)
285 - (void)initInternalMediaList
287 // Add event callbacks
288 libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist);
289 libvlc_event_attach( p_em, libvlc_MediaListItemAdded, HandleMediaListItemAdded, self);
290 libvlc_event_attach( p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self);
293 - (void)mediaListItemAdded:(NSArray *)arrayOfArgs
295 /* We hope to receive index in a nide range, that could change one day */
296 NSInteger start = [[[arrayOfArgs objectAtIndex: 0] objectForKey:@"index"] intValue];
297 NSInteger end = [[[arrayOfArgs objectAtIndex: [arrayOfArgs count]-1] objectForKey:@"index"] intValue];
298 NSRange range = NSMakeRange(start, end-start);
300 [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
301 for( NSDictionary * args in arrayOfArgs )
303 NSInteger index = [[args objectForKey:@"index"] intValue];
304 VLCMedia * media = [args objectForKey:@"media"];
306 if( index && index > [cachedMedia count] )
307 index = [cachedMedia count];
308 [cachedMedia insertObject:media atIndex:index];
310 [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
312 // Post the notification
313 // [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemAdded
317 // Let the delegate know that the item was added
318 // if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaAdded:atIndex:)])
319 // [delegate mediaList:self mediaAdded:media atIndex:index];
322 - (void)mediaListItemRemoved:(NSNumber *)index
324 [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
325 [cachedMedia removeObjectAtIndex:[index intValue]];
326 [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
328 // Post the notification
329 [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemDeleted
331 userInfo:[NSDictionary dictionaryWithObjectsAndKeys:
335 // Let the delegate know that the item is being removed
336 if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
337 [delegate mediaList:self mediaRemovedAtIndex:[index intValue]];