MacOSX/Framework/VLC.h: Import VLCLibrary.h and VLCVideoLayer.h by default.
[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
71 - (id)init
72 {
73     if (self = [super init])
74     {
75         // Create a new libvlc media list instance
76         libvlc_exception_t p_e;
77         libvlc_exception_init( &p_e );
78         p_mlist = libvlc_media_list_new( [VLCLibrary sharedInstance], &p_e );
79         catch_exception( &p_e );
80         
81         // Initialize internals to defaults
82         cachedMedia = [[NSMutableArray alloc] init];
83         delegate = flatAspect = hierarchicalAspect = hierarchicalNodeAspect = nil;
84         [self initInternalMediaList];
85     }
86     return self;
87 }
88
89 - (void)release
90 {
91     @synchronized(self)
92     {
93         if([self retainCount] <= 1)
94         {
95             /* We must make sure we won't receive new event after an upcoming dealloc
96              * We also may receive a -retain in some event callback that may occcur
97              * Before libvlc_event_detach. So this can't happen in dealloc */
98             libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist, NULL);
99             libvlc_event_detach(p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, NULL);
100             libvlc_event_detach(p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, NULL);
101         }
102         [super release];
103     }
104 }
105
106 - (void)dealloc
107 {
108     // Release allocated memory
109     delegate = nil;
110     
111     libvlc_media_list_release( p_mlist );
112     [cachedMedia release];
113     [flatAspect release];
114     [hierarchicalAspect release];
115     [hierarchicalNodeAspect release];
116     [super dealloc];
117 }
118
119 - (NSString *)description
120 {
121     NSMutableString * content = [NSMutableString string];
122     int i;
123     for( i = 0; i < [self count]; i++)
124     {
125         [content appendFormat:@"%@\n", [self mediaAtIndex: i]];
126     }
127     return [NSString stringWithFormat:@"<%@ %p> {\n%@}", [self className], self, content];
128 }
129
130 - (void)lock
131 {
132     libvlc_media_list_lock( p_mlist );
133 }
134
135 - (void)unlock
136 {
137     libvlc_media_list_unlock( p_mlist );
138 }
139
140 - (int)addMedia:(VLCMedia *)media
141 {
142     int index = [self count];
143     [self insertMedia:media atIndex:index];
144     return index;
145 }
146
147 - (void)insertMedia:(VLCMedia *)media atIndex: (int)index
148 {
149     [media retain];
150
151     // Add it to the libvlc's medialist
152     libvlc_exception_t p_e;
153     libvlc_exception_init( &p_e );
154     libvlc_media_list_insert_media_descriptor( p_mlist, [media libVLCMediaDescriptor], index, &p_e );
155     catch_exception( &p_e );
156 }
157
158 - (void)removeMediaAtIndex:(int)index
159 {
160     [[self mediaAtIndex:index] release];
161
162     // Remove it from the libvlc's medialist
163     libvlc_exception_t p_e;
164     libvlc_exception_init( &p_e );
165     libvlc_media_list_remove_index( p_mlist, index, &p_e );
166     catch_exception( &p_e );
167 }
168
169 - (VLCMedia *)mediaAtIndex:(int)index
170 {
171     return [cachedMedia objectAtIndex:index];
172 }
173
174 - (int)indexOfMedia:(VLCMedia *)media
175 {
176     libvlc_exception_t p_e;
177     libvlc_exception_init( &p_e );
178     int result = libvlc_media_list_index_of_item( p_mlist, [media libVLCMediaDescriptor], &p_e );
179     catch_exception( &p_e );
180     
181     return result;
182 }
183
184 /* KVC Compliance: For the @"media" key */
185 - (int)countOfMedia
186 {
187     return [self count];
188 }
189
190 - (id)objectInMediaAtIndex:(int)i
191 {
192     return [self mediaAtIndex:i];
193 }
194
195 - (int)count
196 {
197     return [cachedMedia count];
198 }
199
200 @synthesize delegate;
201
202 - (BOOL)isReadOnly
203 {
204     libvlc_exception_t p_e;
205     libvlc_exception_init( &p_e );
206     BOOL isReadOnly = libvlc_media_list_is_readonly( p_mlist );
207     catch_exception( &p_e );
208     
209     return isReadOnly;
210 }
211
212 /* Media list aspect */
213 - (VLCMediaListAspect *)hierarchicalAspect
214 {
215     if( hierarchicalAspect )
216         return hierarchicalAspect;
217     
218     libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_view( p_mlist, NULL );
219     hierarchicalAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
220     libvlc_media_list_view_release( p_mlv );
221     return hierarchicalAspect;
222 }
223
224 - (VLCMediaListAspect *)hierarchicalNodeAspect
225 {
226     if( hierarchicalNodeAspect )
227         return hierarchicalNodeAspect;
228     
229     libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_node_view( p_mlist, NULL );
230     hierarchicalNodeAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
231     libvlc_media_list_view_release( p_mlv );
232     return hierarchicalNodeAspect;
233 }
234
235 - (VLCMediaListAspect *)flatAspect
236 {
237     if( flatAspect )
238         return flatAspect;
239     
240     libvlc_media_list_view_t * p_mlv = libvlc_media_list_flat_view( p_mlist, NULL );
241     flatAspect = [[VLCMediaListAspect mediaListAspectWithLibVLCMediaListView:p_mlv andMediaList:self] retain];
242     libvlc_media_list_view_release( p_mlv );
243     return flatAspect;
244 }
245
246 @end
247
248 @implementation VLCMediaList (LibVLCBridging)
249 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
250 {
251     return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
252 }
253
254 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
255 {
256     if( self = [super init] )
257     {
258         p_mlist = p_new_mlist;
259         libvlc_media_list_retain( p_mlist );
260         libvlc_media_list_lock( p_mlist );
261         cachedMedia = [[NSMutableArray alloc] initWithCapacity:libvlc_media_list_count( p_mlist, NULL )];
262
263         int i, count = libvlc_media_list_count( p_mlist, NULL );
264         for( i = 0; i < count; i++ )
265         {
266             libvlc_media_descriptor_t * p_md = libvlc_media_list_item_at_index( p_mlist, i, NULL );
267             [cachedMedia addObject:[VLCMedia mediaWithLibVLCMediaDescriptor:p_md]];
268             libvlc_media_descriptor_release(p_md);
269         }
270         [self initInternalMediaList];
271         libvlc_media_list_unlock(p_mlist);
272     }
273     return self;
274 }
275
276 - (void *)libVLCMediaList
277 {
278     return p_mlist;
279 }
280 @end
281
282 @implementation VLCMediaList (Private)
283 - (void)initInternalMediaList
284 {
285     // Add event callbacks
286     libvlc_exception_t p_e;
287     libvlc_exception_init( &p_e );
288
289     libvlc_event_manager_t * p_em = libvlc_media_list_event_manager( p_mlist, &p_e );
290     libvlc_event_attach( p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, &p_e );
291     libvlc_event_attach( p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, &p_e );
292     
293     catch_exception( &p_e );
294 }
295
296 - (void)mediaListItemAdded:(NSArray *)arrayOfArgs
297 {
298     /* We hope to receive index in a nide range, that could change one day */
299     int start = [[[arrayOfArgs objectAtIndex: 0] objectForKey:@"index"] intValue];
300     int end = [[[arrayOfArgs objectAtIndex: [arrayOfArgs count]-1] objectForKey:@"index"] intValue];
301     NSRange range = NSMakeRange(start, end-start);
302     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
303     for( NSDictionary * args in arrayOfArgs )
304     {
305         int index = [[args objectForKey:@"index"] intValue];
306         VLCMedia * media = [args objectForKey:@"media"];
307         /* Sanity check */
308         if( index && index >= [cachedMedia count] )
309             index = [cachedMedia count] - 1;
310         [cachedMedia insertObject:media atIndex:index];
311     }
312     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
313
314     // Post the notification
315 //    [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemAdded
316 //                                                        object:self
317 //                                                      userInfo:args];
318
319     // Let the delegate know that the item was added
320   //  if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaAdded:atIndex:)])
321     //    [delegate mediaList:self mediaAdded:media atIndex:index];
322 }
323
324 - (void)mediaListItemRemoved:(NSNumber *)index
325 {
326     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
327     [cachedMedia removeObjectAtIndex:[index intValue]];
328     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
329
330     // Post the notification
331     [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemDeleted 
332                                                         object:self
333                                                       userInfo:[NSDictionary dictionaryWithObjectsAndKeys:
334                                                           index, @"index",
335                                                           nil]];
336
337     // Let the delegate know that the item is being removed
338     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
339         [delegate mediaList:self mediaRemovedAtIndex:[index intValue]];
340 }
341 @end