VLCMediaList.m: Don't mess between node hierachical and hierarchical cached copy...
[vlc.git] / extras / MacOSX / Framework / Sources / VLCMediaList.m
1 /*****************************************************************************
2  * VLCMediaList.m: VLC.framework VLCMediaList implementation
3  *****************************************************************************
4  * Copyright (C) 2007 Pierre d'Herbemont
5  * Copyright (C) 2007 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #import "VLCMediaList.h"
26 #import "VLCLibrary.h"
27 #import "VLCEventManager.h"
28 #import "VLCLibVLCBridging.h"
29 #include <vlc/vlc.h>
30 #include <vlc/libvlc.h>
31
32 /* Notification Messages */
33 NSString *VLCMediaListItemAdded        = @"VLCMediaListItemAdded";
34 NSString *VLCMediaListItemDeleted      = @"VLCMediaListItemDeleted";
35
36 // TODO: Documentation
37 @interface VLCMediaList (Private)
38 /* Initializers */
39 - (void)initInternalMediaList;
40
41 /* Libvlc event bridges */
42 - (void)mediaListItemAdded:(NSArray *)args;
43 - (void)mediaListItemRemoved:(NSNumber *)index;
44 @end
45
46 /* libvlc event callback */
47 static void HandleMediaListItemAdded(const libvlc_event_t *event, void *user_data)
48 {
49     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
50     id self = user_data;
51     [[VLCEventManager sharedManager] callOnMainThreadObject:self 
52                                                  withMethod:@selector(mediaListItemAdded:) 
53                                        withArgumentAsObject:[NSArray arrayWithObject:[NSDictionary dictionaryWithObjectsAndKeys:
54                                                           [VLCMedia mediaWithLibVLCMediaDescriptor:event->u.media_list_item_added.item], @"media",
55                                                           [NSNumber numberWithInt:event->u.media_list_item_added.index], @"index",
56                                                           nil]]];
57     [pool release];
58 }
59
60 static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * user_data)
61 {
62     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
63     id self = user_data;
64     [[VLCEventManager sharedManager] callOnMainThreadObject:self 
65                                                  withMethod:@selector(mediaListItemRemoved:) 
66                                        withArgumentAsObject:[NSNumber numberWithInt:event->u.media_list_item_deleted.index]];
67     [pool release];
68 }
69
70 @implementation VLCMediaList (KeyValueCodingCompliance)
71 /* For the @"media" key */
72 - (int) countOfMedia
73 {
74     return [self count];
75 }
76
77 - (id) objectInMediaAtIndex:(int)i
78 {
79     return [self mediaAtIndex:i];
80 }
81 @end
82
83 @implementation VLCMediaList
84 - (id)init
85 {
86     if (self = [super init])
87     {
88         // Create a new libvlc media list instance
89         libvlc_exception_t p_e;
90         libvlc_exception_init(&p_e);
91         p_mlist = libvlc_media_list_new([VLCLibrary sharedInstance], &p_e);
92         quit_on_exception(&p_e);
93         
94         // Initialize internals to defaults
95         cachedMedia = [[NSMutableArray alloc] init];
96         delegate = flatAspect = hierarchicalAspect = hierarchicalNodeAspect = nil;
97         [self initInternalMediaList];
98     }
99     return self;
100 }
101
102 - (void)release
103 {
104     @synchronized(self)
105     {
106         if([self retainCount] <= 1)
107         {
108             /* We must make sure we won't receive new event after an upcoming dealloc
109              * We also may receive a -retain in some event callback that may occcur
110              * Before libvlc_event_detach. So this can't happen in dealloc */
111             libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist, NULL);
112             libvlc_event_detach(p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, NULL);
113             libvlc_event_detach(p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, NULL);
114         }
115         [super release];
116     }
117 }
118
119 - (void)dealloc
120 {
121     // Release allocated memory
122     libvlc_media_list_release(p_mlist);
123     [cachedMedia release];
124     [flatAspect release];
125     [hierarchicalAspect release];
126     [hierarchicalNodeAspect release];
127     [super dealloc];
128 }
129
130 - (NSString *)description
131 {
132     NSMutableString *content = [NSMutableString string];
133     int i;
134     for( i = 0; i < [self count]; i++)
135     {
136         [content appendFormat:@"%@\n", [self mediaAtIndex: i]];
137     }
138     return [NSString stringWithFormat:@"<%@ %p> {\n%@}", [self className], self, content];
139 }
140
141 - (void)setDelegate:(id)value
142 {
143     delegate = value;
144 }
145
146 - (id)delegate
147 {
148     return delegate;
149 }
150
151 - (void)lock
152 {
153     libvlc_media_list_lock( p_mlist );
154 }
155
156 - (void)unlock
157 {
158     libvlc_media_list_unlock( p_mlist );
159 }
160
161 - (int)addMedia:(VLCMedia *)media
162 {
163     int index = [self count];
164     [self insertMedia:media atIndex:index];
165     return index;
166 }
167
168 - (void)insertMedia:(VLCMedia *)media atIndex: (int)index
169 {
170     [media retain];
171
172     // Add it to the libvlc's medialist
173     libvlc_exception_t p_e;
174     libvlc_exception_init( &p_e );
175     libvlc_media_list_insert_media_descriptor( p_mlist, [media libVLCMediaDescriptor], index, &p_e );
176     quit_on_exception( &p_e );
177 }
178
179 - (void)removeMediaAtIndex:(int)index
180 {
181     [[self mediaAtIndex:index] release];
182
183     // Remove it from the libvlc's medialist
184     libvlc_exception_t p_e;
185     libvlc_exception_init( &p_e );
186     libvlc_media_list_remove_index( p_mlist, index, &p_e );
187     quit_on_exception( &p_e );
188 }
189
190 - (VLCMedia *)mediaAtIndex:(int)index
191 {
192     return [cachedMedia objectAtIndex:index];
193 }
194
195 - (int)count
196 {
197     return [cachedMedia count];
198 }
199
200 - (int)indexOfMedia:(VLCMedia *)media
201 {
202     libvlc_exception_t p_e;
203     libvlc_exception_init( &p_e );
204     int result = libvlc_media_list_index_of_item( p_mlist, [media libVLCMediaDescriptor], &p_e );
205     quit_on_exception( &p_e );
206     
207     return result;
208 }
209
210 - (BOOL)isReadOnly
211 {
212     libvlc_exception_t p_e;
213     libvlc_exception_init( &p_e );
214     BOOL isReadOnly = libvlc_media_list_is_readonly( p_mlist );
215     quit_on_exception( &p_e );
216     
217     return isReadOnly;
218 }
219
220 /* Media list aspect */
221 - (VLCMediaListAspect *)hierarchicalAspect
222 {
223     if( hierarchicalAspect )
224         return hierarchicalAspect;
225     libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_view( p_mlist, NULL );
226     hierarchicalAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView: p_mlv andMediaList:self] retain];
227     libvlc_media_list_view_release( p_mlv );
228     return hierarchicalAspect;
229 }
230
231 - (VLCMediaListAspect *)hierarchicalNodeAspect
232 {
233     if( hierarchicalNodeAspect )
234         return hierarchicalNodeAspect;
235     libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_node_view( p_mlist, NULL );
236     hierarchicalNodeAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView: p_mlv andMediaList:self] retain];
237     libvlc_media_list_view_release( p_mlv );
238     return hierarchicalNodeAspect;
239 }
240
241 - (VLCMediaListAspect *)flatAspect
242 {
243     if( flatAspect )
244         return flatAspect;
245     libvlc_media_list_view_t * p_mlv = libvlc_media_list_flat_view( p_mlist, NULL );
246     flatAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView: p_mlv andMediaList:self] retain];
247     libvlc_media_list_view_release( p_mlv );
248     return flatAspect;
249 }
250
251 @end
252
253 @implementation VLCMediaList (LibVLCBridging)
254 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
255 {
256     return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
257 }
258
259 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
260 {
261     if( self = [super init] )
262     {
263         p_mlist = p_new_mlist;
264         libvlc_media_list_retain(p_mlist);
265         libvlc_media_list_lock(p_mlist);
266         cachedMedia = [[NSMutableArray alloc] initWithCapacity:libvlc_media_list_count(p_mlist, NULL)];
267         int i, count = libvlc_media_list_count(p_mlist, NULL);
268         for( i = 0; i < count; i++ )
269         {
270             libvlc_media_descriptor_t * p_md = libvlc_media_list_item_at_index(p_mlist, i, NULL);
271             [cachedMedia addObject:[VLCMedia mediaWithLibVLCMediaDescriptor: p_md]];
272             libvlc_media_descriptor_release(p_md);
273         }
274         [self initInternalMediaList];
275         libvlc_media_list_unlock(p_mlist);
276     }
277     return self;
278 }
279
280 - (void *)libVLCMediaList
281 {
282     return p_mlist;
283 }
284 @end
285
286 @implementation VLCMediaList (Private)
287 - (void)initInternalMediaList
288 {
289     // Add event callbacks
290     libvlc_exception_t p_e;
291     libvlc_exception_init(&p_e);
292
293     libvlc_event_manager_t *p_em = libvlc_media_list_event_manager( p_mlist, &p_e );
294     libvlc_event_attach( p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, &p_e );
295     libvlc_event_attach( p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, &p_e );
296     
297     quit_on_exception( &p_e );
298 }
299
300 - (void)mediaListItemAdded:(NSArray *)arrayOfArgs
301 {
302     /* We hope to receive index in a nide range, that could change one day */
303     int start = [[[arrayOfArgs objectAtIndex: 0] objectForKey:@"index"] intValue];
304     int end = [[[arrayOfArgs objectAtIndex: [arrayOfArgs count]-1] objectForKey:@"index"] intValue];
305     NSRange range = NSMakeRange(start, end-start);
306     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
307     int i = [[[arrayOfArgs objectAtIndex: 0] objectForKey:@"index"] intValue];
308     [arrayOfArgs retain];
309     for( NSDictionary * args in arrayOfArgs )
310     {
311         int index = [[args objectForKey:@"index"] intValue];
312         VLCMedia * media = [args objectForKey:@"media"];
313         /* Sanity check */
314         NSAssert( i == index, @"Expects some troubles, inserted items are not in a range" ); i++;
315         if( index && index >= [cachedMedia count] )
316             index = [cachedMedia count] - 1;
317         [cachedMedia insertObject:media atIndex:index];
318     }
319     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
320
321     // Post the notification
322 //    [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemAdded
323 //                                                        object:self
324 //                                                      userInfo:args];
325
326     // Let the delegate know that the item was added
327   //  if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaAdded:atIndex:)])
328     //    [delegate mediaList:self mediaAdded:media atIndex:index];
329 }
330
331 - (void)mediaListItemRemoved:(NSNumber *)index
332 {
333     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
334     [cachedMedia removeObjectAtIndex:[index intValue]];
335     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
336
337     // Post the notification
338     [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemDeleted 
339                                                         object:self
340                                                       userInfo:[NSDictionary dictionaryWithObjectsAndKeys:
341                                                           index, @"index",
342                                                           nil]];
343
344     // Let the delegate know that the item is being removed
345     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
346         [delegate mediaList:self mediaRemovedAtIndex:[index intValue]];
347 }
348 @end