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

   1 /*****************************************************************************
   2  * playlist.m: MacOS X interface plugin
   3  *****************************************************************************
   4  * Copyright (C) 2002-2003 VideoLAN
   5  * $Id: playlist.m,v 1.47 2003/12/10 12:57:12 bigben Exp $
   6  *
   7  * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
   8  *          Derk-Jan Hartman <thedj@users.sourceforge.net>
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>                                      /* malloc(), free() */
  29 #include <sys/param.h>                                    /* for MAXPATHLEN */
  30 #include <string.h>
  31 #include <math.h>
  32 #include <sys/mount.h>
  33 #include <vlc_keys.h>
  34
  35 #include "intf.h"
  36 #include "playlist.h"
  37 #include "controls.h"
  38
  39 /*****************************************************************************
  40  * VLCPlaylistView implementation
  41  *****************************************************************************/
  42 @implementation VLCPlaylistView
  43
  44 - (NSMenu *)menuForEvent:(NSEvent *)o_event
  45 {
  46     return( [[self delegate] menuForEvent: o_event] );
  47 }
  48
  49 - (void)keyDown:(NSEvent *)o_event
  50 {
  51     unichar key = 0;
  52     int i, c, i_row;
  53     NSMutableArray *o_to_delete;
  54     NSNumber *o_number;
  55
  56     playlist_t * p_playlist;
  57     intf_thread_t * p_intf = [NSApp getIntf];
  58
  59     if( [[o_event characters] length] )
  60     {
  61         key = [[o_event characters] characterAtIndex: 0];
  62     }
  63
  64     p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
  65                                           FIND_ANYWHERE );
  66
  67     if ( p_playlist == NULL )
  68     {
  69         return;
  70     }
  71
  72     switch( key )
  73     {
  74         case NSDeleteCharacter:
  75         case NSDeleteFunctionKey:
  76         case NSDeleteCharFunctionKey:
  77         case NSBackspaceCharacter:
  78             o_to_delete = [NSMutableArray arrayWithArray:[[self selectedRowEnumerator] allObjects]];
  79             c = [o_to_delete count];
  80
  81             for( i = 0; i < c; i++ ) {
  82                 o_number = [o_to_delete lastObject];
  83                 i_row = [o_number intValue];
  84
  85                 if( p_playlist->i_index == i_row && p_playlist->i_status )
  86                 {
  87                     playlist_Stop( p_playlist );
  88                 }
  89                 [o_to_delete removeObject: o_number];
  90                 [self deselectRow: i_row];
  91                 playlist_Delete( p_playlist, i_row );
  92             }
  93             [self reloadData];
  94             break;
  95
  96         default:
  97             [super keyDown: o_event];
  98             break;
  99     }
 100
 101     if( p_playlist != NULL )
 102     {
 103         vlc_object_release( p_playlist );
 104     }
 105 }
 106
 107 @end
 108
 109 /*****************************************************************************
 110  * VLCPlaylist implementation
 111  *****************************************************************************/
 112 @implementation VLCPlaylist
 113
 114 - (id)init
 115 {
 116     self = [super init];
 117     if ( self !=nil )
 118     {
 119         i_moveRow = -1;
 120     }
 121     return self;
 122 }
 123
 124 - (void)awakeFromNib
 125 {
 126     [o_table_view setTarget: self];
 127     [o_table_view setDelegate: self];
 128     [o_table_view setDataSource: self];
 129
 130     [o_table_view setDoubleAction: @selector(playItem:)];
 131
 132     [o_table_view registerForDraggedTypes:
 133         [NSArray arrayWithObjects: NSFilenamesPboardType, nil]];
 134
 135     [o_window setExcludedFromWindowsMenu: TRUE];
 136
 137     [o_window setTitle: _NS("Playlist")];
 138     [o_mi_save_playlist setTitle: _NS("Save Playlist...")];
 139     [o_mi_play setTitle: _NS("Play")];
 140     [o_mi_delete setTitle: _NS("Delete")];
 141     [o_mi_selectall setTitle: _NS("Select All")];
 142     [[o_tc_name headerCell] setStringValue:_NS("Name")];
 143     [[o_tc_author headerCell] setStringValue:_NS("Author")];
 144     [o_random_ckb setTitle: _NS("Shuffle")];
 145     [o_loop_ckb setTitle: _NS("Repeat Playlist")];
 146     [o_repeat_ckb setTitle: _NS("Repeat Item")];
 147     [o_search_button setTitle: _NS("Search")];
 148 }
 149
 150 - (BOOL)tableView:(NSTableView *)o_tv
 151                   shouldEditTableColumn:(NSTableColumn *)o_tc
 152                   row:(int)i_row
 153 {
 154     return( NO );
 155 }
 156
 157 - (NSMenu *)menuForEvent:(NSEvent *)o_event
 158 {
 159     NSPoint pt;
 160     vlc_bool_t b_rows;
 161     vlc_bool_t b_item_sel;
 162
 163     pt = [o_table_view convertPoint: [o_event locationInWindow]
 164                                                  fromView: nil];
 165     b_item_sel = ( [o_table_view rowAtPoint: pt] != -1 &&
 166                    [o_table_view selectedRow] != -1 );
 167     b_rows = [o_table_view numberOfRows] != 0;
 168
 169     [o_mi_play setEnabled: b_item_sel];
 170     [o_mi_delete setEnabled: b_item_sel];
 171     [o_mi_selectall setEnabled: b_rows];
 172
 173     return( o_ctx_menu );
 174 }
 175
 176 - (IBAction)toggleWindow:(id)sender
 177 {
 178     if( [o_window isVisible] )
 179     {
 180         [o_window orderOut:sender];
 181     }
 182     else
 183     {
 184         [o_window makeKeyAndOrderFront:sender];
 185     }
 186 }
 187
 188 - (IBAction)savePlaylist:(id)sender
 189 {
 190     intf_thread_t * p_intf = [NSApp getIntf];
 191     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 192                                                        FIND_ANYWHERE );
 193
 194     NSSavePanel *o_save_panel = [NSSavePanel savePanel];
 195     NSString * o_name = [NSString stringWithFormat: @"%@.m3u", _NS("Untitled")];
 196     [o_save_panel setTitle: _NS("Save Playlist")];
 197     [o_save_panel setPrompt: _NS("Save")];
 198
 199     if( [o_save_panel runModalForDirectory: nil
 200             file: o_name] == NSOKButton )
 201     {
 202         playlist_SaveFile( p_playlist, [[o_save_panel filename] fileSystemRepresentation] );
 203     }
 204
 205 }
 206
 207 - (IBAction)playItem:(id)sender
 208 {
 209     intf_thread_t * p_intf = [NSApp getIntf];
 210     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 211                                                        FIND_ANYWHERE );
 212
 213     if( p_playlist != NULL )
 214     {
 215         playlist_Goto( p_playlist, [o_table_view selectedRow] );
 216         vlc_object_release( p_playlist );
 217     }
 218 }
 219
 220 - (IBAction)deleteItems:(id)sender
 221 {
 222     int i, c, i_row;
 223     NSMutableArray *o_to_delete;
 224     NSNumber *o_number;
 225
 226     intf_thread_t * p_intf = [NSApp getIntf];
 227     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 228                                                        FIND_ANYWHERE );
 229
 230     if( p_playlist == NULL )
 231     {
 232         return;
 233     }
 234
 235     o_to_delete = [NSMutableArray arrayWithArray:[[o_table_view selectedRowEnumerator] allObjects]];
 236     c = (int)[o_to_delete count];
 237
 238     for( i = 0; i < c; i++ ) {
 239         o_number = [o_to_delete lastObject];
 240         i_row = [o_number intValue];
 241
 242         if( p_playlist->i_index == i_row && p_playlist->i_status )
 243         {
 244             playlist_Stop( p_playlist );
 245         }
 246         [o_to_delete removeObject: o_number];
 247         [o_table_view deselectRow: i_row];
 248         playlist_Delete( p_playlist, i_row );
 249     }
 250
 251     vlc_object_release( p_playlist );
 252
 253     /* this is actually duplicity, because the intf.m manage also updates the view
 254      * when the playlist changes. we do this on purpose, because else there is a
 255      * delay of .5 sec or so when we delete an item */
 256     [self playlistUpdated];
 257     [self updateRowSelection];
 258 }
 259
 260 - (IBAction)selectAll:(id)sender
 261 {
 262     [o_table_view selectAll: nil];
 263 }
 264
 265
 266 - (IBAction)searchItem:(id)sender
 267 {
 268     int i_current = -1;
 269     NSString *o_current_name;
 270     NSString *o_current_author;
 271
 272     intf_thread_t * p_intf = [NSApp getIntf];
 273     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 274                                                FIND_ANYWHERE );
 275
 276     if( p_playlist == NULL )
 277     {
 278         return;
 279     }
 280
 281     if ([o_table_view selectedRow] == [o_table_view numberOfRows]-1 )
 282     {
 283         i_current =-1;
 284     }
 285     else
 286     {
 287         i_current = [o_table_view selectedRow];
 288     }
 289
 290     do
 291     {
 292         i_current++;
 293
 294         vlc_mutex_lock( &p_playlist->object_lock );
 295         o_current_name = [NSString stringWithUTF8String:
 296             p_playlist->pp_items[i_current]->psz_name];
 297         o_current_author = [NSString stringWithUTF8String:
 298             p_playlist->pp_items[i_current]->psz_author];
 299         vlc_mutex_unlock( &p_playlist->object_lock );
 300
 301
 302         if( [o_current_name rangeOfString:[o_search_keyword stringValue] options:NSCaseInsensitiveSearch ].length ||
 303              [o_current_author rangeOfString:[o_search_keyword stringValue] options:NSCaseInsensitiveSearch ].length )
 304         {
 305              [o_table_view selectRow: i_current byExtendingSelection: NO];
 306              [o_table_view scrollRowToVisible: i_current];
 307              break;
 308         }
 309     if ( i_current == [o_table_view numberOfRows] - 1 )
 310         {
 311              i_current = -1;
 312         }
 313     }
 314     while (i_current != [o_table_view selectedRow]);
 315     vlc_object_release( p_playlist );
 316 }
 317
 318 - (void)appendArray:(NSArray*)o_array atPos:(int)i_position enqueue:(BOOL)b_enqueue
 319 {
 320     int i_item;
 321     intf_thread_t * p_intf = [NSApp getIntf];
 322     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 323                                                        FIND_ANYWHERE );
 324
 325     if( p_playlist == NULL )
 326     {
 327         return;
 328     }
 329
 330     for ( i_item = 0; i_item < (int)[o_array count]; i_item++ )
 331     {
 332         /* One item */
 333         NSDictionary *o_one_item;
 334         int j;
 335         int i_total_options = 0;
 336         int i_mode = PLAYLIST_INSERT;
 337         BOOL b_rem = FALSE, b_dir = FALSE;
 338         NSString *o_url, *o_name;
 339         NSArray *o_options;
 340         char **ppsz_options = NULL;
 341
 342         /* Get the item */
 343         o_one_item = [o_array objectAtIndex: i_item];
 344         o_url = (NSString *)[o_one_item objectForKey: @"ITEM_URL"];
 345         o_name = (NSString *)[o_one_item objectForKey: @"ITEM_NAME"];
 346         o_options = (NSArray *)[o_one_item objectForKey: @"ITEM_OPTIONS"];
 347
 348         /* If no name, then make a guess */
 349         if( !o_name) o_name = [[NSFileManager defaultManager] displayNameAtPath: o_url];
 350
 351         if( [[NSFileManager defaultManager] fileExistsAtPath:o_url isDirectory:&b_dir] && b_dir &&
 352             [[NSWorkspace sharedWorkspace] getFileSystemInfoForPath: o_url isRemovable: &b_rem
 353                     isWritable:NULL isUnmountable:NULL description:NULL type:NULL] && b_rem   )
 354         {
 355             /* All of this is to make sure CD's play when you D&D them on VLC */
 356             /* Converts mountpoint to a /dev file */
 357             struct statfs *buf;
 358             char *psz_dev, *temp;
 359             buf = (struct statfs *) malloc (sizeof(struct statfs));
 360             statfs( [o_url fileSystemRepresentation], buf );
 361             psz_dev = strdup(buf->f_mntfromname);
 362             free( buf );
 363             temp = strrchr( psz_dev , 's' );
 364             psz_dev[temp - psz_dev] = '\0';
 365             o_url = [NSString stringWithCString: psz_dev ];
 366         }
 367
 368         if (i_item == 0 && !b_enqueue)
 369             i_mode |= PLAYLIST_GO;
 370
 371         if( o_options && [o_options count] > 0 )
 372         {
 373             /* Count the input options */
 374             i_total_options = [o_options count];
 375
 376             /* Allocate ppsz_options */
 377             for( j = 0; j < i_total_options; j++ )
 378             {
 379                 if( !ppsz_options )
 380                     ppsz_options = (char **)malloc( sizeof(char *) * i_total_options );
 381
 382                 ppsz_options[j] = strdup([[o_options objectAtIndex:j] UTF8String]);
 383             }
 384         }
 385
 386         playlist_AddExt( p_playlist, [o_url fileSystemRepresentation], [o_name UTF8String], -1,
 387             (ppsz_options != NULL ) ? (const char **)ppsz_options : 0, i_total_options,
 388             i_mode, i_position == -1 ? PLAYLIST_END : i_position + i_item);
 389
 390         /* clean up */
 391         for( j = 0; j < i_total_options; j++ )
 392             free( ppsz_options[j] );
 393         if( ppsz_options ) free( ppsz_options );
 394
 395         /* Recent documents menu */
 396         NSURL *o_true_url = [NSURL fileURLWithPath: o_url];
 397         if( o_true_url != nil )
 398         {
 399             [[NSDocumentController sharedDocumentController]
 400                 noteNewRecentDocumentURL: o_true_url];
 401         }
 402     }
 403
 404     vlc_object_release( p_playlist );
 405 }
 406
 407 - (void)playlistUpdated
 408 {
 409     vlc_value_t val;
 410     intf_thread_t * p_intf = [NSApp getIntf];
 411     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 412                                                        FIND_ANYWHERE );
 413     if( p_playlist != NULL )
 414     {
 415         var_Get( p_playlist, "random", &val );
 416         [o_random_ckb setState: val.b_bool];
 417
 418         var_Get( p_playlist, "loop", &val );
 419         [o_loop_ckb setState: val.b_bool];
 420
 421         var_Get( p_playlist, "repeat", &val );
 422         [o_repeat_ckb setState: val.b_bool];
 423
 424         vlc_object_release( p_playlist );
 425     }
 426     [o_table_view reloadData];
 427 }
 428
 429 - (void)updateRowSelection
 430 {
 431     int i_row;
 432
 433     intf_thread_t * p_intf = [NSApp getIntf];
 434     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 435                                                        FIND_ANYWHERE );
 436
 437     if( p_playlist == NULL )
 438     {
 439         return;
 440     }
 441
 442     i_row = p_playlist->i_index;
 443     vlc_object_release( p_playlist );
 444
 445     [o_table_view selectRow: i_row byExtendingSelection: NO];
 446     [o_table_view scrollRowToVisible: i_row];
 447 }
 448
 449
 450 @end
 451
 452 @implementation VLCPlaylist (NSTableDataSource)
 453
 454 - (int)numberOfRowsInTableView:(NSTableView *)o_tv
 455 {
 456     int i_count = 0;
 457     intf_thread_t * p_intf = [NSApp getIntf];
 458     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 459                                                        FIND_ANYWHERE );
 460
 461     if( p_playlist != NULL )
 462     {
 463         vlc_mutex_lock( &p_playlist->object_lock );
 464         i_count = p_playlist->i_size;
 465         vlc_mutex_unlock( &p_playlist->object_lock );
 466         vlc_object_release( p_playlist );
 467     }
 468     [o_status_field setStringValue: [NSString stringWithFormat:_NS("%i items in playlist"), i_count]];
 469     return( i_count );
 470 }
 471
 472 - (id)tableView:(NSTableView *)o_tv
 473                 objectValueForTableColumn:(NSTableColumn *)o_tc
 474                 row:(int)i_row
 475 {
 476     id o_value = nil;
 477     intf_thread_t * p_intf = [NSApp getIntf];
 478     playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 479                                                FIND_ANYWHERE );
 480
 481     if( p_playlist == NULL )
 482     {
 483         return( nil );
 484     }
 485
 486     if( [[o_tc identifier] isEqualToString:@"0"] )
 487     {
 488         o_value = [NSString stringWithFormat:@"%i", i_row + 1];
 489     }
 490     else if( [[o_tc identifier] isEqualToString:@"1"] )
 491     {
 492         vlc_mutex_lock( &p_playlist->object_lock );
 493         o_value = [[NSString stringWithUTF8String:
 494             p_playlist->pp_items[i_row]->psz_name] lastPathComponent];
 495         vlc_mutex_unlock( &p_playlist->object_lock );
 496     }
 497     else if( [[o_tc identifier] isEqualToString:@"2"] )
 498     {
 499         vlc_mutex_lock( &p_playlist->object_lock );
 500         o_value = [NSString stringWithUTF8String:
 501             p_playlist->pp_items[i_row]->psz_author];
 502         vlc_mutex_unlock( &p_playlist->object_lock );
 503     }
 504
 505     vlc_object_release( p_playlist );
 506
 507     return( o_value );
 508 }
 509
 510 - (BOOL)tableView:(NSTableView *)o_tv
 511                     writeRows:(NSArray*)o_rows
 512                     toPasteboard:(NSPasteboard*)o_pasteboard
 513 {
 514     int i_rows = [o_rows count];
 515     NSArray *o_filenames = [NSArray array];
 516
 517     [o_pasteboard declareTypes:[NSArray arrayWithObject:NSFilenamesPboardType] owner:self];
 518     [o_pasteboard setPropertyList:o_filenames forType:NSFilenamesPboardType];
 519     if ( i_rows == 1 )
 520     {
 521         i_moveRow = [[o_rows objectAtIndex:0]intValue];
 522         return YES;
 523     }
 524     return NO;
 525 }
 526
 527 - (NSDragOperation)tableView:(NSTableView*)o_tv
 528                     validateDrop:(id <NSDraggingInfo>)o_info
 529                     proposedRow:(int)i_row
 530                     proposedDropOperation:(NSTableViewDropOperation)o_operation
 531 {
 532     if ( o_operation == NSTableViewDropAbove )
 533     {
 534         if ( i_moveRow >= 0 )
 535         {
 536             if ( i_row != i_moveRow )
 537             {
 538                 return NSDragOperationMove;
 539             }
 540             /* what if in the previous run, the row wasn't actually moved?
 541                then we can't drop new files on this location */
 542             return NSDragOperationNone;
 543         }
 544         return NSDragOperationGeneric;
 545     }
 546     return NSDragOperationNone;
 547 }
 548
 549 - (BOOL)tableView:(NSTableView*)o_tv
 550                     acceptDrop:(id <NSDraggingInfo>)o_info
 551                     row:(int)i_proposed_row
 552                     dropOperation:(NSTableViewDropOperation)o_operation
 553 {
 554     if (  i_moveRow >= 0 )
 555     {
 556         if (i_moveRow != -1 && i_proposed_row != -1)
 557         {
 558             intf_thread_t * p_intf = [NSApp getIntf];
 559             playlist_t * p_playlist = vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST,
 560                                                             FIND_ANYWHERE );
 561
 562             if( p_playlist == NULL )
 563             {
 564                 i_moveRow = -1;
 565                 return NO;
 566             }
 567
 568             playlist_Move( p_playlist, i_moveRow, i_proposed_row );
 569
 570             vlc_object_release( p_playlist );
 571         }
 572         [self playlistUpdated];
 573         i_moveRow = -1;
 574         return YES;
 575     }
 576     else
 577     {
 578         NSPasteboard * o_pasteboard;
 579         o_pasteboard = [o_info draggingPasteboard];
 580
 581         if( [[o_pasteboard types] containsObject: NSFilenamesPboardType] )
 582         {
 583             int i;
 584             NSArray *o_array = [NSArray array];
 585             NSArray *o_values = [[o_pasteboard propertyListForType: NSFilenamesPboardType]
 586                         sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
 587
 588             for( i = 0; i < (int)[o_values count]; i++)
 589             {
 590                 NSDictionary *o_dic;
 591                 o_dic = [NSDictionary dictionaryWithObject:[o_values objectAtIndex:i] forKey:@"ITEM_URL"];
 592                 o_array = [o_array arrayByAddingObject: o_dic];
 593             }
 594             [self appendArray: o_array atPos: i_proposed_row enqueue:YES];
 595             return YES;
 596         }
 597         return NO;
 598     }
 599     [self updateRowSelection];
 600 }
 601
 602 @end
 603