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 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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 drain];
  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 drain];
  72 }
  73
  74 @implementation VLCMediaList
  75 - (id)init
  76 {
  77     if (self = [super init])
  78     {
  79         // Create a new libvlc media list instance
  80         p_mlist = libvlc_media_list_new([VLCLibrary sharedInstance]);
  81
  82         // Initialize internals to defaults
  83         cachedMedia = [[NSMutableArray alloc] init];
  84         [self initInternalMediaList];
  85     }
  86     return self;
  87 }
  88
  89 - (void)dealloc
  90 {
  91     libvlc_event_manager_t *em = libvlc_media_list_event_manager(p_mlist);
  92     libvlc_event_detach(em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self);
  93     libvlc_event_detach(em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self);
  94     [[VLCEventManager sharedManager] cancelCallToObject:self];
  95
  96     // Release allocated memory
  97     delegate = nil;
  98
  99     libvlc_media_list_release( p_mlist );
 100     [cachedMedia release];
 101     [super dealloc];
 102 }
 103
 104 - (NSString *)description
 105 {
 106     NSMutableString * content = [NSMutableString string];
 107     int i;
 108     for( i = 0; i < [self count]; i++)
 109     {
 110         [content appendFormat:@"%@\n", [self mediaAtIndex: i]];
 111     }
 112     return [NSString stringWithFormat:@"<%@ %p> {\n%@}", [self class], self, content];
 113 }
 114
 115 - (void)lock
 116 {
 117     libvlc_media_list_lock( p_mlist );
 118 }
 119
 120 - (void)unlock
 121 {
 122     libvlc_media_list_unlock( p_mlist );
 123 }
 124
 125 - (NSInteger)addMedia:(VLCMedia *)media
 126 {
 127     int index = [self count];
 128     [self insertMedia:media atIndex:index];
 129     return index;
 130 }
 131
 132 - (void)insertMedia:(VLCMedia *)media atIndex: (NSInteger)index
 133 {
 134     [media retain];
 135
 136     // Add it to the libvlc's medialist
 137     libvlc_media_list_insert_media(p_mlist, [media libVLCMediaDescriptor], index);
 138 }
 139
 140 - (void)removeMediaAtIndex:(NSInteger)index
 141 {
 142     [[self mediaAtIndex:index] release];
 143
 144     // Remove it from the libvlc's medialist
 145     libvlc_media_list_remove_index(p_mlist, index);
 146 }
 147
 148 - (VLCMedia *)mediaAtIndex:(NSInteger)index
 149 {
 150     return [cachedMedia objectAtIndex:index];
 151 }
 152
 153 - (NSInteger)indexOfMedia:(VLCMedia *)media
 154 {
 155     NSInteger result = libvlc_media_list_index_of_item(p_mlist, [media libVLCMediaDescriptor]);
 156     return result;
 157 }
 158
 159 /* KVC Compliance: For the @"media" key */
 160 - (NSInteger)countOfMedia
 161 {
 162     return [self count];
 163 }
 164
 165 - (id)objectInMediaAtIndex:(NSUInteger)i
 166 {
 167     return [self mediaAtIndex:i];
 168 }
 169
 170 - (NSInteger)count
 171 {
 172     return [cachedMedia count];
 173 }
 174
 175 - (void)insertObject:(id)object inMediaAtIndex:(NSUInteger)i
 176 {
 177     [self insertMedia:object atIndex:i];
 178 }
 179
 180 - (void)removeObjectFromMediaAtIndex:(NSUInteger)i
 181 {
 182     [self removeMediaAtIndex:i];
 183 }
 184
 185 @synthesize delegate;
 186
 187 - (BOOL)isReadOnly
 188 {
 189     return libvlc_media_list_is_readonly( p_mlist );
 190 }
 191
 192 @end
 193
 194 @implementation VLCMediaList (LibVLCBridging)
 195 + (id)mediaListWithLibVLCMediaList:(void *)p_new_mlist;
 196 {
 197     return [[[VLCMediaList alloc] initWithLibVLCMediaList:p_new_mlist] autorelease];
 198 }
 199
 200 - (id)initWithLibVLCMediaList:(void *)p_new_mlist;
 201 {
 202     if( self = [super init] )
 203     {
 204         p_mlist = p_new_mlist;
 205         libvlc_media_list_retain( p_mlist );
 206         libvlc_media_list_lock( p_mlist );
 207         cachedMedia = [[NSMutableArray alloc] initWithCapacity:libvlc_media_list_count(p_mlist)];
 208
 209         NSUInteger i, count = libvlc_media_list_count(p_mlist);
 210         for( i = 0; i < count; i++ )
 211         {
 212             libvlc_media_t * p_md = libvlc_media_list_item_at_index(p_mlist, i);
 213             [cachedMedia addObject:[VLCMedia mediaWithLibVLCMediaDescriptor:p_md]];
 214             libvlc_media_release(p_md);
 215         }
 216         [self initInternalMediaList];
 217         libvlc_media_list_unlock(p_mlist);
 218     }
 219     return self;
 220 }
 221
 222 - (void *)libVLCMediaList
 223 {
 224     return p_mlist;
 225 }
 226 @end
 227
 228 @implementation VLCMediaList (Private)
 229 - (void)initInternalMediaList
 230 {
 231     // Add event callbacks
 232     libvlc_event_manager_t * p_em = libvlc_media_list_event_manager(p_mlist);
 233     libvlc_event_attach( p_em, libvlc_MediaListItemAdded,   HandleMediaListItemAdded,   self);
 234     libvlc_event_attach( p_em, libvlc_MediaListItemDeleted, HandleMediaListItemDeleted, self);
 235 }
 236
 237 - (void)mediaListItemAdded:(NSArray *)arrayOfArgs
 238 {
 239     /* We hope to receive index in a nide range, that could change one day */
 240     NSInteger start = [[[arrayOfArgs objectAtIndex: 0] objectForKey:@"index"] intValue];
 241     NSInteger end = [[[arrayOfArgs objectAtIndex: [arrayOfArgs count]-1] objectForKey:@"index"] intValue];
 242     NSRange range = NSMakeRange(start, end-start);
 243
 244     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
 245     for( NSDictionary * args in arrayOfArgs )
 246     {
 247         NSInteger index = [[args objectForKey:@"index"] intValue];
 248         VLCMedia * media = [args objectForKey:@"media"];
 249         /* Sanity check */
 250         if( index && index > [cachedMedia count] )
 251             index = [cachedMedia count];
 252         [cachedMedia insertObject:media atIndex:index];
 253     }
 254     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndexesInRange:range] forKey:@"media"];
 255
 256     // Post the notification
 257 //    [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemAdded
 258 //                                                        object:self
 259 //                                                      userInfo:args];
 260
 261     // Let the delegate know that the item was added
 262   //  if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaAdded:atIndex:)])
 263     //    [delegate mediaList:self mediaAdded:media atIndex:index];
 264 }
 265
 266 - (void)mediaListItemRemoved:(NSNumber *)index
 267 {
 268     [self willChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
 269     [cachedMedia removeObjectAtIndex:[index intValue]];
 270     [self didChange:NSKeyValueChangeInsertion valuesAtIndexes:[NSIndexSet indexSetWithIndex:[index intValue]] forKey:@"media"];
 271
 272     // Post the notification
 273     [[NSNotificationCenter defaultCenter] postNotificationName:VLCMediaListItemDeleted
 274                                                         object:self
 275                                                       userInfo:[NSDictionary dictionaryWithObjectsAndKeys:
 276                                                           index, @"index",
 277                                                           nil]];
 278
 279     // Let the delegate know that the item is being removed
 280     if (delegate && [delegate respondsToSelector:@selector(mediaList:mediaRemovedAtIndex:)])
 281         [delegate mediaList:self mediaRemovedAtIndex:[index intValue]];
 282 }
 283 @end