9d92899864bc444dbe5d24e21b55c85c1205d425
[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:(NSDictionary *)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     int index = event->u.media_list_item_added.index;
52     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:index] forKey:@"Media"];
53     [[VLCEventManager sharedManager] callOnMainThreadObject:self 
54                                                  withMethod:@selector(mediaListItemAdded:) 
55                                        withArgumentAsObject:[NSDictionary dictionaryWithObjectsAndKeys:
56                                                           [VLCMedia mediaWithLibVLCMediaDescriptor:event->u.media_list_item_added.item], @"media",
57                                                           [NSNumber numberWithInt:event->u.media_list_item_added.index], @"index",
58                                                           nil]];
59     [pool release];
60 }
61 static void HandleMediaListWillAddItem(const libvlc_event_t *event, void *user_data)
62 {
63     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
64     id self = user_data;
65     int index = event->u.media_list_will_add_item.index;
66     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:index] forKey:@"Media"];
67     [pool release];
68 }
69
70
71 static void HandleMediaListItemDeleted( const libvlc_event_t * event, void * user_data)
72 {
73     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
74     id self = user_data;
75     int index = event->u.media_list_will_add_item.index;
76     [self didChange:NSKeyValueChangeRemoval valuesAtIndexes:[NSIndexSet indexSetWithIndex:index] forKey:@"Media"];
77     // Check to see if the last item deleted is this item we're trying delete now.
78     // If no, then delete the item from the local list, otherwise, the item has already 
79     // been deleted
80     [[VLCEventManager sharedManager] callOnMainThreadObject:self 
81                                                  withMethod:@selector(mediaListItemRemoved:) 
82                                        withArgumentAsObject:[NSNumber numberWithInt:event->u.media_list_item_deleted.index]];
83     [pool release];
84 }
85
86 static void HandleMediaListWillDeleteItem(const libvlc_event_t *event, void *user_data)
87 {
88     NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
89     id self = user_data;
90     int index = event->u.media_list_will_add_item.index;
91     [self willChange:NSKeyValueChangeRemoval valuesAtIndexes:[NSIndexSet indexSetWithIndex:index] forKey:@"Media"];
92     [pool release];
93 }
94
95 @implementation VLCMediaList (KeyValueCodingCompliance)
96 /* For the @"Media" key */
97 - (int) countOfMedia
98 {
99     return [self count];
100 }
101
102 - (id) objectInMediaAtIndex:(int)i
103 {
104     return [self mediaAtIndex:i];
105 }
106 @end
107
108 @implementation VLCMediaList
109 - (id)init
110 {
111     if (self = [super init])
112     {
113         // Create a new libvlc media list instance
114         libvlc_exception_t p_e;
115         libvlc_exception_init(&p_e);
116         p_mlist = libvlc_media_list_new([VLCLibrary sharedInstance], &p_e);
117         quit_on_exception(&p_e);
118         
119         // Initialize internals to defaults
120         delegate = nil;
121         [self initInternalMediaList];
122     }
123     return self;
124 }
125
126 - (void)release
127 {
128     @synchronized(self)
129     {
130         if([self retainCount] <= 1)
131         {
132             /* We must make sure we won't receive new event after an upcoming dealloc
133              * We also may receive a -retain in some event callback that may occcur
134              * Before libvlc_event_detach. So this can't happen in dealloc */
135             libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist, NULL);
136             libvlc_event_detach(p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, NULL);
137             libvlc_event_detach(p_em, libvlc_MediaListWillDeleteItem, HandleMediaListWillDeleteItem, self, NULL);
138             libvlc_event_detach(p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, NULL);
139             libvlc_event_detach(p_em, libvlc_MediaListWillAddItem, HandleMediaListWillAddItem, self, NULL);
140         }
141         [super release];
142     }
143 }
144
145 - (void)dealloc
146 {
147     // Release allocated memory
148     libvlc_media_list_release(p_mlist);
149     
150     [super dealloc];
151 }
152
153 - (void)setDelegate:(id)value
154 {
155     delegate = value;
156 }
157
158 - (id)delegate
159 {
160     return delegate;
161 }
162
163 - (void)lock
164 {
165     libvlc_media_list_lock( p_mlist );
166 }
167
168 - (void)unlock
169 {
170     libvlc_media_list_unlock( p_mlist );
171 }
172
173 - (int)addMedia:(VLCMedia *)media
174 {
175     int index = [self count];
176     [self insertMedia:media atIndex:index];
177     return index;
178 }
179
180 - (void)insertMedia:(VLCMedia *)media atIndex: (int)index
181 {
182     [media retain];
183     
184     // Add it to the libvlc's medialist
185     libvlc_exception_t p_e;
186     libvlc_exception_init( &p_e );
187     libvlc_media_list_insert_media_descriptor( p_mlist, [media libVLCMediaDescriptor], index, &p_e );
188     quit_on_exception( &p_e );
189 }
190
191 - (void)removeMediaAtIndex:(int)index
192 {
193     [[self mediaAtIndex:index] release];
194
195     // Remove it from the libvlc's medialist
196     libvlc_exception_t p_e;
197     libvlc_exception_init( &p_e );
198     libvlc_media_list_remove_index( p_mlist, index, &p_e );
199     quit_on_exception( &p_e );
200 }
201
202 - (VLCMedia *)mediaAtIndex:(int)index
203 {
204     libvlc_exception_t p_e;
205     libvlc_exception_init( &p_e );
206     libvlc_media_descriptor_t *p_md = libvlc_media_list_item_at_index( p_mlist, index, &p_e );
207     quit_on_exception( &p_e );
208     
209     // Returns local object for media descriptor, searchs for user data first.  If not found it creates a 
210     // new cocoa object representation of the media descriptor.
211     return [VLCMedia mediaWithLibVLCMediaDescriptor:p_md];
212 }
213
214 - (int)count
215 {
216     libvlc_exception_t p_e;
217     libvlc_exception_init( &p_e );
218     int result = libvlc_media_list_count( p_mlist, &p_e );
219     quit_on_exception( &p_e );
220
221     return result;
222 }
223
224 - (int)indexOfMedia:(VLCMedia *)media
225 {
226     libvlc_exception_t p_e;
227     libvlc_exception_init( &p_e );
228     int result = libvlc_media_list_index_of_item( p_mlist, [media libVLCMediaDescriptor], &p_e );
229     quit_on_exception( &p_e );
230     
231     return result;
232 }
233
234 /* Media list aspect */
235 - (VLCMediaListAspect *)hierarchicalAspect
236 {
237     VLCMediaListAspect * hierarchicalAspect;
238     libvlc_media_list_view_t * p_mlv = libvlc_media_list_hierarchical_view( p_mlist, NULL );
239     hierarchicalAspect = [VLCMediaListAspect mediaListAspectWithLibVLCMediaListView: p_mlv];
240     libvlc_media_list_view_release( p_mlv );
241     return hierarchicalAspect;
242 }
243
244 - (VLCMediaListAspect *)flatAspect
245 {
246     VLCMediaListAspect * flatAspect;
247     libvlc_media_list_view_t * p_mlv = libvlc_media_list_flat_view( p_mlist, NULL );
248     flatAspect = [VLCMediaListAspect mediaListAspectWithLibVLCMediaListView: p_mlv];
249     libvlc_media_list_view_release( p_mlv );
250     return flatAspect;
251 }
252
253 @end
254
255 @implementation VLCMediaList (LibVLCBridging)
256 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
257 {
258     return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
259 }
260
261 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
262 {
263     if( self = [super init] )
264     {
265         p_mlist = p_new_mlist;
266         libvlc_media_list_retain(p_mlist);
267         [self initInternalMediaList];
268     }
269     return self;
270 }
271
272 - (void *)libVLCMediaList
273 {
274     return p_mlist;
275 }
276 @end
277
278 @implementation VLCMediaList (Private)
279 - (void)initInternalMediaList
280 {
281     // Add event callbacks
282     [self lock];
283     libvlc_exception_t p_e;
284     libvlc_exception_init(&p_e);
285
286     libvlc_event_manager_t *p_em = libvlc_media_list_event_manager( p_mlist, &p_e );
287     libvlc_event_attach( p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self, &p_e );
288     libvlc_event_attach( p_em, libvlc_MediaListWillAddItem, HandleMediaListWillAddItem, self, &p_e );
289     libvlc_event_attach( p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self, &p_e );
290     libvlc_event_attach( p_em, libvlc_MediaListWillDeleteItem, HandleMediaListWillDeleteItem, self, &p_e );
291     [self unlock];
292     
293     quit_on_exception( &p_e );
294 }
295
296 - (void)mediaListItemAdded:(NSDictionary *)args
297 {    
298     // Post the notification
299     [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemAdded
300                                                         object:self
301                                                       userInfo:args];
302     
303     // Let the delegate know that the item was added
304     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaAdded:atIndex:)])
305         [delegate mediaList:self mediaAdded:[args objectForKey:@"media"] atIndex:[[args objectForKey:@"index"] intValue]];
306 }
307
308 - (void)mediaListItemRemoved:(NSNumber *)index
309 {
310     // Post the notification
311     [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemDeleted 
312                                                         object:self
313                                                       userInfo:[NSDictionary dictionaryWithObjectsAndKeys:
314                                                           index, @"index",
315                                                           nil]];
316     
317     // Let the delegate know that the item is being removed
318     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
319         [delegate mediaList:self mediaRemovedAtIndex:[index intValue]];
320 }
321 @end
322