git.sesse.net Git - vlc/blob - projects/macosx/framework/Sources/VLCMediaList.m

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