git.sesse.net Git - vlc/blob - modules/gui/macosx/playlist.m

   1 /*****************************************************************************
   2  * playlist.m: MacOS X interface module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2004 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
   8  *          Derk-Jan Hartman <hartman at videolan dot org>
   9  *          Benjamin Pracht <bigben at videolab dot org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /* TODO
  27  * connect delegates, actions and outlets in IB
  28  * implement play by double click
  29  * implement delete by backspace
  30  * implement playlist item rightclick menu
  31  * implement sorting
  32  * reconnect menu items etc
  33  * add 'icons' for different types of nodes?
  34  * create a new 'playlist toggle' that hides the playlist and in effect give you the old controller
  35  * create a new search field build with pictures from the 'regular' search field, so it can be emulated on 10.2
  36  * create toggle buttons for the shuffle, repeat one, repeat all functions.
  37  * implement drag and drop and item reordering.
  38  * reimplement enable/disable item
  39  * create a new 'tool' button (see the gear button in the Finder window) for 'actions'
  40    (adding service discovery, other views, new node/playlist, save node/playlist) stuff like that
  41  */
  42
  43
  44
  45 /*****************************************************************************
  46  * Preamble
  47  *****************************************************************************/
  48 #include <stdlib.h>                                      /* malloc(), free() */
  49 #include <sys/param.h>                                    /* for MAXPATHLEN */
  50 #include <string.h>
  51 #include <math.h>
  52 #include <sys/mount.h>
  53 #include <vlc_keys.h>
  54
  55 #include "intf.h"
  56 #include "playlist.h"
  57 #include "controls.h"
  58 #include <OSD.h>
  59
  60 /*****************************************************************************
  61  * VLCPlaylistView implementation
  62  *****************************************************************************/
  63 @implementation VLCPlaylistView
  64
  65 - (NSMenu *)menuForEvent:(NSEvent *)o_event
  66 {
  67     return( [[self delegate] menuForEvent: o_event] );
  68 }
  69
  70 - (void)keyDown:(NSEvent *)o_event
  71 {
  72     unichar key = 0;
  73     int i, c, i_row;
  74     NSMutableArray *o_to_delete;
  75     NSNumber *o_number;
  76
  77     playlist_t * p_playlist;
  78     intf_thread_t * p_intf = VLCIntf;
  79
  80     if( [[o_event characters] length] )
  81     {
  82         key = [[o_event characters] characterAtIndex: 0];
  83     }
  84
  85     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
  86                                           FIND_ANYWHERE );
  87
  88     if ( p_playlist == NULL )
  89     {
  90         return;
  91     }
  92
  93     switch( key )
  94     {
  95         case NSDeleteCharacter:
  96         case NSDeleteFunctionKey:
  97         case NSDeleteCharFunctionKey:
  98         case NSBackspaceCharacter:
  99             o_to_delete = [NSMutableArray arrayWithArray:[[self selectedRowEnumerator] allObjects]];
 100             c = [o_to_delete count];
 101
 102             for( i = 0; i < c; i++ ) {
 103                 o_number = [o_to_delete lastObject];
 104                 i_row = [o_number intValue];
 105
 106                 if( p_playlist->i_index == i_row && p_playlist->status.i_status )
 107                 {
 108                     playlist_Stop( p_playlist );
 109                 }
 110                 [o_to_delete removeObject: o_number];
 111                 [self deselectRow: i_row];
 112                 playlist_Delete( p_playlist, i_row );
 113             }
 114             [self reloadData];
 115             break;
 116
 117         default:
 118             [super keyDown: o_event];
 119             break;
 120     }
 121
 122     if( p_playlist != NULL )
 123     {
 124         vlc_object_release( p_playlist );
 125     }
 126 }
 127
 128
 129 @end
 130
 131 /*****************************************************************************
 132  * VLCPlaylist implementation
 133  *****************************************************************************/
 134 @implementation VLCPlaylist
 135
 136 - (id)init
 137 {
 138     self = [super init];
 139     if ( self !=nil )
 140     {
 141         i_moveRow = -1;
 142     }
 143     return self;
 144 }
 145
 146 - (void)awakeFromNib
 147 {
 148     [o_outline_view setTarget: self];
 149     [o_outline_view setDelegate: self];
 150     [o_outline_view setDataSource: self];
 151
 152     //[o_outline_view setDoubleAction: @selector(playItem:)];
 153
 154     [o_outline_view registerForDraggedTypes:
 155         [NSArray arrayWithObjects: NSFilenamesPboardType, nil]];
 156     [o_outline_view setIntercellSpacing: NSMakeSize (0.0, 1.0)];
 157
 158 /* We need to check whether _defaultTableHeaderSortImage exists, since it
 159 belongs to an Apple hidden private API, and then can "disapear" at any time*/
 160
 161     if( [[NSTableView class] respondsToSelector:@selector(_defaultTableHeaderSortImage)] )
 162     {
 163         o_ascendingSortingImage = [[NSTableView class] _defaultTableHeaderSortImage];
 164     }
 165     else
 166     {
 167         o_ascendingSortingImage = nil;
 168     }
 169
 170     if( [[NSTableView class] respondsToSelector:@selector(_defaultTableHeaderReverseSortImage)] )
 171     {
 172         o_descendingSortingImage = [[NSTableView class] _defaultTableHeaderReverseSortImage];
 173     }
 174     else
 175     {
 176         o_descendingSortingImage = nil;
 177     }
 178
 179     [self initStrings];
 180     [self playlistUpdated];
 181 }
 182
 183 - (void)initStrings
 184 {
 185 #if 0
 186     [o_window setTitle: _NS("Playlist")];
 187     [o_mi_save_playlist setTitle: _NS("Save Playlist...")];
 188     [o_mi_play setTitle: _NS("Play")];
 189     [o_mi_delete setTitle: _NS("Delete")];
 190     [o_mi_selectall setTitle: _NS("Select All")];
 191     [o_mi_toggleItemsEnabled setTitle: _NS("Item Enabled")];
 192     [o_mi_enableGroup setTitle: _NS("Enable all group items")];
 193     [o_mi_disableGroup setTitle: _NS("Disable all group items")];
 194     [o_mi_info setTitle: _NS("Properties")];
 195
 196     [[o_tc_name headerCell] setStringValue:_NS("Name")];
 197     [[o_tc_author headerCell] setStringValue:_NS("Author")];
 198     [[o_tc_duration headerCell] setStringValue:_NS("Duration")];
 199     [o_random_ckb setTitle: _NS("Random")];
 200     [o_search_button setTitle: _NS("Search")];
 201     [o_btn_playlist setToolTip: _NS("Playlist")];
 202     [[o_loop_popup itemAtIndex:0] setTitle: _NS("Standard Play")];
 203     [[o_loop_popup itemAtIndex:1] setTitle: _NS("Repeat One")];
 204     [[o_loop_popup itemAtIndex:2] setTitle: _NS("Repeat All")];
 205 #endif
 206 }
 207
 208
 209
 210 - (void)appendArray:(NSArray*)o_array atPos:(int)i_position enqueue:(BOOL)b_enqueue
 211 {
 212     int i_item;
 213     intf_thread_t * p_intf = VLCIntf;
 214     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 215                                                        FIND_ANYWHERE );
 216
 217     if( p_playlist == NULL )
 218     {
 219         return;
 220     }
 221
 222     for ( i_item = 0; i_item < (int)[o_array count]; i_item++ )
 223     {
 224         /* One item */
 225         NSDictionary *o_one_item;
 226         int j, i_total_options = 0, i_new_id = -1;
 227         int i_mode = PLAYLIST_INSERT;
 228         BOOL b_rem = FALSE, b_dir = FALSE;
 229         NSString *o_uri, *o_name;
 230         NSArray *o_options;
 231         NSURL *o_true_file;
 232         char **ppsz_options = NULL;
 233
 234         /* Get the item */
 235         o_one_item = [o_array objectAtIndex: i_item];
 236         o_uri = (NSString *)[o_one_item objectForKey: @"ITEM_URL"];
 237         o_name = (NSString *)[o_one_item objectForKey: @"ITEM_NAME"];
 238         o_options = (NSArray *)[o_one_item objectForKey: @"ITEM_OPTIONS"];
 239
 240         /* If no name, then make a guess */
 241         if( !o_name) o_name = [[NSFileManager defaultManager] displayNameAtPath: o_uri];
 242
 243         if( [[NSFileManager defaultManager] fileExistsAtPath:o_uri isDirectory:&b_dir] && b_dir &&
 244             [[NSWorkspace sharedWorkspace] getFileSystemInfoForPath: o_uri isRemovable: &b_rem
 245                     isWritable:NULL isUnmountable:NULL description:NULL type:NULL] && b_rem   )
 246         {
 247             /* All of this is to make sure CD's play when you D&D them on VLC */
 248             /* Converts mountpoint to a /dev file */
 249             struct statfs *buf;
 250             char *psz_dev;
 251             buf = (struct statfs *) malloc (sizeof(struct statfs));
 252             statfs( [o_uri fileSystemRepresentation], buf );
 253             psz_dev = strdup(buf->f_mntfromname);
 254             o_uri = [NSString stringWithCString: psz_dev ];
 255         }
 256
 257         if( o_options && [o_options count] > 0 )
 258         {
 259             /* Count the input options */
 260             i_total_options = [o_options count];
 261
 262             /* Allocate ppsz_options */
 263             for( j = 0; j < i_total_options; j++ )
 264             {
 265                 if( !ppsz_options )
 266                     ppsz_options = (char **)malloc( sizeof(char *) * i_total_options );
 267
 268                 ppsz_options[j] = strdup([[o_options objectAtIndex:j] UTF8String]);
 269             }
 270         }
 271
 272         /* Add the item */
 273         i_new_id = playlist_AddExt( p_playlist, [o_uri fileSystemRepresentation],
 274                       [o_name UTF8String], i_mode,
 275                       i_position == -1 ? PLAYLIST_END : i_position + i_item,
 276                       0, (ppsz_options != NULL ) ? (const char **)ppsz_options : 0, i_total_options );
 277
 278         /* clean up
 279         for( j = 0; j < i_total_options; j++ )
 280             free( ppsz_options[j] );
 281         if( ppsz_options ) free( ppsz_options ); */
 282
 283         /* Recent documents menu */
 284         o_true_file = [NSURL fileURLWithPath: o_uri];
 285         if( o_true_file != nil )
 286         {
 287             [[NSDocumentController sharedDocumentController]
 288                 noteNewRecentDocumentURL: o_true_file];
 289         }
 290
 291         if( i_item == 0 && !b_enqueue )
 292         {
 293             playlist_Goto( p_playlist, playlist_GetPositionById( p_playlist, i_new_id ) );
 294             playlist_Play( p_playlist );
 295         }
 296     }
 297
 298     vlc_object_release( p_playlist );
 299 }
 300
 301 @end
 302
 303 @implementation VLCPlaylist (NSOutlineViewDataSource)
 304
 305 /* return the number of children for Obj-C pointer item */ /* DONE */
 306 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
 307 {
 308     int i_return = 0;
 309     playlist_t * p_playlist = vlc_object_find( VLCIntf, VLC_OBJECT_PLAYLIST,
 310                                                        FIND_ANYWHERE );
 311     if( p_playlist == NULL )
 312         return 0;
 313
 314     if( item == nil )
 315     {
 316         /* root object */
 317         playlist_view_t *p_view;
 318         p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
 319         if( p_view && p_view->p_root )
 320             i_return = p_view->p_root->i_children;
 321     }
 322     else
 323     {
 324         playlist_item_t *p_item = (playlist_item_t *)[item pointerValue];
 325         if( p_item )
 326             i_return = p_item->i_children;
 327     }
 328     vlc_object_release( p_playlist );
 329     if( i_return == -1 ) i_return = 0;
 330     return i_return;
 331 }
 332
 333 /* return the child at index for the Obj-C pointer item */ /* DONE */
 334 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item
 335 {
 336     playlist_item *p_return = NULL;
 337     playlist_t * p_playlist = vlc_object_find( VLCIntf, VLC_OBJECT_PLAYLIST,
 338                                                        FIND_ANYWHERE );
 339     if( p_playlist == NULL )
 340         return 0;
 341
 342     if( item == nil )
 343     {
 344         /* root object */
 345         playlist_view_t *p_view;
 346         p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
 347         if( p_view && index < p_view->p_root->i_children )
 348             p_return = p_view->p_root->pp_children[index];
 349     }
 350     else
 351     {
 352         playlist_item_t *p_item = (playlist_item_t *)[item pointerValue];
 353         if( p_item && index < p_item->i_children )
 354         {
 355             p_return = p_item->pp_children[index];
 356         }
 357     }
 358
 359     vlc_object_release( p_playlist );
 360     return [NSValue valueWithPointer: p_return];
 361 }
 362
 363 /* is the item expandable */
 364 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item
 365 {
 366     int i_return = 0;
 367     playlist_t * p_playlist = vlc_object_find( VLCIntf, VLC_OBJECT_PLAYLIST,
 368                                                        FIND_ANYWHERE );
 369     if( p_playlist == NULL )
 370         return 0;
 371
 372     if( item == nil )
 373     {
 374         /* root object */
 375         playlist_view_t *p_view;
 376         p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
 377         if( p_view && p_view->p_root )
 378             i_return = p_view->p_root->i_children;
 379     }
 380     else
 381     {
 382         playlist_item_t *p_item = (playlist_item_t *)[item pointerValue];
 383         if( p_item )
 384             i_return = p_item->i_children;
 385     }
 386     vlc_object_release( p_playlist );
 387
 388     if( i_return == -1 )
 389         return NO;
 390     else
 391         return YES;
 392 }
 393
 394 /* retrieve the string values for the cells */
 395 - (id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
 396 {
 397     id o_value = nil;
 398     intf_thread_t * p_intf = VLCIntf;
 399     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 400                                                FIND_ANYWHERE );
 401     playlist_item_t * p_item = [item pointerValue];
 402
 403     if( p_playlist == NULL || p_item == NULL )
 404     {
 405         return( nil );
 406     }
 407
 408     if( [[o_tc identifier] isEqualToString:@"1"] )
 409     {
 410         o_value = [NSString stringWithUTF8String:
 411             p_item->input.psz_name];
 412         if( o_value == NULL )
 413             o_value = [NSString stringWithCString:
 414                 p_item->input.psz_name];
 415     }
 416     else if( [[o_tc identifier] isEqualToString:@"2"] )
 417     {
 418         char *psz_temp;
 419         psz_temp = playlist_GetInfo( p_item ,_("Meta-information"),_("Artist") );
 420
 421         if( psz_temp == NULL )
 422             o_value = @"";
 423         else
 424         {
 425             o_value = [NSString stringWithUTF8String: psz_temp];
 426             if( o_value == NULL )
 427             {
 428                 o_value = [NSString stringWithCString: psz_temp];
 429             }
 430             free( psz_temp );
 431         }
 432     }
 433     else if( [[o_tc identifier] isEqualToString:@"3"] )
 434     {
 435         char psz_duration[MSTRTIME_MAX_SIZE];
 436         mtime_t dur = p_item->input.i_duration;
 437         if( dur != -1 )
 438         {
 439             secstotimestr( psz_duration, dur/1000000 );
 440             o_value = [NSString stringWithUTF8String: psz_duration];
 441         }
 442         else
 443         {
 444             o_value = @"-:--:--";
 445         }
 446     }
 447
 448     vlc_object_release( p_playlist );
 449
 450     return( o_value );
 451 }
 452
 453 /* Required for drag & drop and reordering */
 454 - (BOOL)outlineView:(NSOutlineView *)outlineView writeItems:(NSArray *)items toPasteboard:(NSPasteboard *)pboard
 455 {
 456     return NO;
 457 }
 458
 459 - (NSDragOperation)outlineView:(NSOutlineView *)outlineView validateDrop:(id <NSDraggingInfo>)info proposedItem:(id)item proposedChildIndex:(int)index
 460 {
 461     return NSDragOperationNone;
 462 }
 463
 464 /* Delegate method of NSWindow */
 465 - (void)windowWillClose:(NSNotification *)aNotification
 466 {
 467     [o_btn_playlist setState: NSOffState];
 468 }
 469
 470 @end
 471
 472