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

   1 /*****************************************************************************
   2  r playlistinfo.m: MacOS X interface module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Benjamin Pracht <bigben at videolan dot org>
   8  *          Felix Kühne <fkuehne at videolan dot 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 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #include "intf.h"
  30 #include "playlistinfo.h"
  31 #include "playlist.h"
  32
  33 /*****************************************************************************
  34  * VLCPlaylistInfo Implementation
  35  *****************************************************************************/
  36
  37 @implementation VLCInfo
  38
  39 - (id)init
  40 {
  41     self = [super init];
  42
  43     if( self != nil )
  44     {
  45         p_item = NULL;
  46         o_statUpdateTimer = nil;
  47     }
  48     return( self );
  49 }
  50
  51 - (void)awakeFromNib
  52 {
  53     [o_info_window setExcludedFromWindowsMenu: TRUE];
  54
  55     [o_info_window setTitle: _NS("Information")];
  56     [o_uri_lbl setStringValue: _NS("URI")];
  57     [o_title_lbl setStringValue: _NS("Title")];
  58     [o_author_lbl setStringValue: _NS("Author")];
  59     [o_btn_ok setTitle: _NS("OK")];
  60     [o_btn_cancel setTitle: _NS("Cancel")];
  61
  62     [[o_tab_view tabViewItemAtIndex: 0] setLabel: _NS("General")];
  63     [[o_tab_view tabViewItemAtIndex: 1] setLabel: _NS("Advanced Information")];
  64     [[o_tab_view tabViewItemAtIndex: 2] setLabel: _NS("Statistics")];
  65     [o_tab_view selectTabViewItemAtIndex: 0];
  66
  67     /* constants defined in vlc_meta.h */
  68     [o_genre_lbl setStringValue: _NS(VLC_META_GENRE)];
  69     [o_copyright_lbl setStringValue: _NS(VLC_META_COPYRIGHT)];
  70     [o_collection_lbl setStringValue: _NS(VLC_META_COLLECTION)];
  71     [o_seqNum_lbl setStringValue: _NS(VLC_META_SEQ_NUM)];
  72     [o_description_lbl setStringValue: _NS(VLC_META_DESCRIPTION)];
  73     [o_rating_lbl setStringValue: _NS(VLC_META_RATING)];
  74     [o_date_lbl setStringValue: _NS(VLC_META_DATE)];
  75     [o_language_lbl setStringValue: _NS(VLC_META_LANGUAGE)];
  76     [o_nowPlaying_lbl setStringValue: _NS(VLC_META_NOW_PLAYING)];
  77     [o_publisher_lbl setStringValue: _NS(VLC_META_PUBLISHER)];
  78
  79     /* statistics */
  80     [o_input_box setTitle: _NS("Input")];
  81     [o_read_bytes_lbl setStringValue: _NS("Read at media")];
  82     [o_input_bitrate_lbl setStringValue: _NS("Input bitrate")];
  83     [o_demux_bytes_lbl setStringValue: _NS("Demuxed")];
  84     [o_demux_bitrate_lbl setStringValue: _NS("Stream bitrate")];
  85
  86     [o_video_box setTitle: _NS("Video")];
  87     [o_video_decoded_lbl setStringValue: _NS("Decoded blocks")];
  88     [o_displayed_lbl setStringValue: _NS("Displayed frames")];
  89     [o_lost_frames_lbl setStringValue: _NS("Lost frames")];
  90
  91     [o_sout_box setTitle: _NS("Streaming")];
  92     [o_sent_packets_lbl setStringValue: _NS("Sent packets")];
  93     [o_sent_bytes_lbl setStringValue: _NS("Sent bytes")];
  94     [o_sent_bitrate_lbl setStringValue: _NS("Send rate")];
  95
  96     [o_audio_box setTitle: _NS("Audio")];
  97     [o_audio_decoded_lbl setStringValue: _NS("Decoded blocks")];
  98     [o_played_abuffers_lbl setStringValue: _NS("Played buffers")];
  99     [o_lost_abuffers_lbl setStringValue: _NS("Lost buffers")];
 100 }
 101
 102 - (void)dealloc
 103 {
 104     /* make sure that the timer is released in any case */
 105     if( [o_statUpdateTimer isValid] )
 106         [o_statUpdateTimer invalidate];
 107
 108     if ( o_statUpdateTimer )
 109         [o_statUpdateTimer release];
 110
 111     [super dealloc];
 112 }
 113
 114 #if GC_ENABLED
 115 - (void)finalize
 116 {
 117     /* since dealloc isn't called with enabled GC on 10.5, we need this to prevent core crashes */
 118     if( [o_statUpdateTimer isValid] )
 119         [o_statUpdateTimer invalidate];
 120     [super finalize];
 121 }
 122 #endif
 123
 124 - (IBAction)togglePlaylistInfoPanel:(id)sender
 125 {
 126     if( [o_info_window isVisible] )
 127     {
 128         [self windowShouldClose: nil];
 129         [o_info_window orderOut: sender];
 130     }
 131     else
 132     {
 133         p_item = [[[VLCMain sharedInstance] getPlaylist] selectedPlaylistItem];
 134         [self initPanel:sender];
 135     }
 136 }
 137
 138 - (IBAction)toggleInfoPanel:(id)sender
 139 {
 140     if( [o_info_window isVisible] )
 141     {
 142         [self windowShouldClose: nil];
 143         [o_info_window orderOut: sender];
 144     }
 145     else
 146     {
 147         intf_thread_t * p_intf = VLCIntf;
 148         playlist_t * p_playlist = pl_Yield( p_intf );
 149
 150         p_item = p_playlist->status.p_item;
 151         vlc_object_release( p_playlist );
 152
 153         [self initPanel:sender];
 154     }
 155 }
 156
 157 - (void)initPanel:(id)sender
 158 {
 159     BOOL b_stats = config_GetInt(VLCIntf, "stats");
 160     if( b_stats )
 161     {
 162         o_statUpdateTimer = [NSTimer scheduledTimerWithTimeInterval: 1
 163             target: self selector: @selector(updateStatistics:)
 164             userInfo: nil repeats: YES];
 165         [o_statUpdateTimer fire];
 166         [o_statUpdateTimer retain];
 167     }
 168     else
 169     {
 170         if( [o_tab_view numberOfTabViewItems] > 2 )
 171             [o_tab_view removeTabViewItem: [o_tab_view tabViewItemAtIndex: 2]];
 172     }
 173
 174     [self updatePanel];
 175     [o_info_window makeKeyAndOrderFront: sender];
 176 }
 177
 178 - (void)updatePanel
 179 {
 180     /* make sure that we got the current item and not an outdated one */
 181     intf_thread_t * p_intf = VLCIntf;
 182         playlist_t * p_playlist = pl_Yield( p_intf );
 183
 184     p_item = p_playlist->status.p_item;
 185     vlc_object_release( p_playlist );
 186
 187     /* check whether our item is valid, because we would crash if not */
 188     if(! [self isItemInPlaylist: p_item] ) return;
 189
 190     vlc_mutex_lock( &p_item->p_input->lock );
 191
 192     /* fill uri info */
 193     if( p_item->p_input->psz_uri )
 194     {
 195         [o_uri_txt setStringValue:
 196             ([NSString stringWithUTF8String:p_item->p_input->psz_uri] == nil ) ?
 197             [NSString stringWithCString:p_item->p_input->psz_uri] :
 198             [NSString stringWithUTF8String:p_item->p_input->psz_uri]];
 199     }
 200
 201     /* fill the other fields */
 202 #define p_m p_item->p_input->p_meta
 203     [self setMeta: p_m->psz_title forLabel: o_title_txt];
 204     [self setMeta: p_m->psz_artist forLabel: o_author_txt];
 205     [self setMeta: p_m->psz_album forLabel: o_collection_txt];
 206     [self setMeta: p_m->psz_tracknum forLabel: o_seqNum_txt];
 207     [self setMeta: p_m->psz_genre forLabel: o_genre_txt];
 208     [self setMeta: p_m->psz_copyright forLabel: o_copyright_txt];
 209     [self setMeta: p_m->psz_rating forLabel: o_rating_txt];
 210     [self setMeta: p_m->psz_publisher forLabel: o_publisher_txt];
 211     [self setMeta: p_m->psz_nowplaying forLabel: o_nowPlaying_txt];
 212     [self setMeta: p_m->psz_language forLabel: o_language_txt];
 213     [self setMeta: p_m->psz_date forLabel: o_date_txt];
 214 #undef p_m
 215     vlc_mutex_unlock( &p_item->p_input->lock );
 216
 217     /* reload the advanced table */
 218     [[VLCInfoTreeItem rootItem] refresh];
 219     [o_outline_view reloadData];
 220
 221     /* update the stats once to display p_item change faster */
 222     [self updateStatistics: nil];
 223 }
 224
 225 - (void)setMeta: (char *)psz_meta forLabel: (id)theItem
 226 {
 227     if( psz_meta != NULL && *psz_meta)
 228         [theItem setStringValue:
 229             ([NSString stringWithUTF8String:psz_meta] == nil ) ?
 230             [NSString stringWithCString:psz_meta] :
 231             [NSString stringWithUTF8String:psz_meta]];
 232     else
 233         [theItem setStringValue: @"-"];
 234 }
 235
 236 - (void)updateStatistics:(NSTimer*)theTimer
 237 {
 238     if( [self isItemInPlaylist: p_item] )
 239     {
 240         /* we can only do that if there's a valid input around */
 241
 242         vlc_mutex_lock( &p_item->p_input->p_stats->lock );
 243
 244         /* input */
 245         [o_read_bytes_txt setStringValue: [NSString stringWithFormat:
 246             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_read_bytes)/1000]];
 247         [o_input_bitrate_txt setStringValue: [NSString stringWithFormat:
 248             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_input_bitrate)*8000]];
 249         [o_demux_bytes_txt setStringValue: [NSString stringWithFormat:
 250             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_demux_read_bytes)/1000]];
 251         [o_demux_bitrate_txt setStringValue: [NSString stringWithFormat:
 252             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_demux_bitrate)*8000]];
 253
 254         /* Video */
 255         [o_video_decoded_txt setStringValue: [NSString stringWithFormat: @"%5i",
 256             p_item->p_input->p_stats->i_decoded_video]];
 257         [o_displayed_txt setStringValue: [NSString stringWithFormat: @"%5i",
 258             p_item->p_input->p_stats->i_displayed_pictures]];
 259         [o_lost_frames_txt setStringValue: [NSString stringWithFormat: @"%5i",
 260             p_item->p_input->p_stats->i_lost_pictures]];
 261
 262         /* Sout */
 263         [o_sent_packets_txt setStringValue: [NSString stringWithFormat: @"%5i",
 264             p_item->p_input->p_stats->i_sent_packets]];
 265         [o_sent_bytes_txt setStringValue: [NSString stringWithFormat: @"%8.0f kB",
 266             (float)(p_item->p_input->p_stats->i_sent_bytes)/1000]];
 267         [o_sent_bitrate_txt setStringValue: [NSString stringWithFormat:
 268             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_send_bitrate*8)*1000]];
 269
 270         /* Audio */
 271         [o_audio_decoded_txt setStringValue: [NSString stringWithFormat: @"%5i",
 272             p_item->p_input->p_stats->i_decoded_audio]];
 273         [o_played_abuffers_txt setStringValue: [NSString stringWithFormat: @"%5i",
 274             p_item->p_input->p_stats->i_played_abuffers]];
 275         [o_lost_abuffers_txt setStringValue: [NSString stringWithFormat: @"%5i",
 276             p_item->p_input->p_stats->i_lost_abuffers]];
 277
 278         vlc_mutex_unlock( &p_item->p_input->p_stats->lock );
 279     }
 280 }
 281
 282 - (IBAction)infoCancel:(id)sender
 283 {
 284     [self windowShouldClose: nil];
 285     [o_info_window orderOut: self];
 286 }
 287
 288
 289 - (IBAction)infoOk:(id)sender
 290 {
 291     intf_thread_t * p_intf = VLCIntf;
 292     playlist_t * p_playlist = pl_Yield( p_intf );
 293     vlc_value_t val;
 294
 295     if( [self isItemInPlaylist: p_item] )
 296     {
 297         vlc_mutex_lock( &p_item->p_input->lock );
 298
 299         p_item->p_input->psz_uri = strdup( [[o_uri_txt stringValue] UTF8String] );
 300         p_item->p_input->psz_name = strdup( [[o_title_txt stringValue] UTF8String] );
 301         vlc_meta_SetArtist( p_item->p_input->p_meta, [[o_author_txt stringValue] UTF8String] );
 302         vlc_mutex_unlock( &p_item->p_input->lock );
 303
 304         val.b_bool = VLC_TRUE;
 305         var_Set( p_playlist, "intf-change", val );
 306     }
 307     vlc_object_release( p_playlist );
 308     [self windowShouldClose: nil];
 309     [o_info_window orderOut: self];
 310 }
 311
 312 - (playlist_item_t *)getItem
 313 {
 314     return p_item;
 315 }
 316
 317 - (BOOL)isItemInPlaylist:(playlist_item_t *)p_local_item
 318 {
 319     intf_thread_t * p_intf = VLCIntf;
 320     playlist_t * p_playlist = pl_Yield( p_intf );
 321     int i;
 322
 323     for( i = 0 ; i < p_playlist->all_items.i_size ; i++ )
 324     {
 325         if( ARRAY_VAL( p_playlist->all_items, i ) == p_local_item )
 326         {
 327             vlc_object_release( p_playlist );
 328             return YES;
 329         }
 330     }
 331     vlc_object_release( p_playlist );
 332     return NO;
 333 }
 334
 335 - (BOOL)windowShouldClose:(id)sender
 336 {
 337     if( [o_statUpdateTimer isValid] )
 338         [o_statUpdateTimer invalidate];
 339
 340     if( o_statUpdateTimer )
 341         [o_statUpdateTimer release];
 342
 343     return YES;
 344 }
 345
 346 @end
 347
 348 @implementation VLCInfo (NSMenuValidation)
 349
 350 - (BOOL)validateMenuItem:(NSMenuItem *)o_mi
 351 {
 352     BOOL bEnabled = TRUE;
 353
 354     intf_thread_t * p_intf = VLCIntf;
 355     input_thread_t * p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 356                                                        FIND_ANYWHERE );
 357
 358     if( [[o_mi title] isEqualToString: _NS("Information")] )
 359     {
 360         if( p_input == NULL )
 361         {
 362             bEnabled = FALSE;
 363         }
 364     }
 365     if( p_input ) vlc_object_release( p_input );
 366
 367     return( bEnabled );
 368 }
 369
 370 @end
 371
 372 @implementation VLCInfo (NSTableDataSource)
 373
 374 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
 375 {
 376     return (item == nil) ? [[VLCInfoTreeItem rootItem] numberOfChildren] : [item numberOfChildren];
 377 }
 378
 379 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item {
 380     return ([item numberOfChildren] > 0);
 381 }
 382
 383 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item
 384 {
 385     return (item == nil) ? [[VLCInfoTreeItem rootItem] childAtIndex:index] : (id)[item childAtIndex:index];
 386 }
 387
 388 - (id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
 389 {
 390     if ([[tableColumn identifier] isEqualToString:@"0"])
 391     {
 392         return (item == nil) ? @"" : (id)[item getName];
 393     }
 394     else
 395     {
 396         return (item == nil) ? @"" : (id)[item getValue];
 397     }
 398 }
 399
 400
 401 @end
 402
 403 @implementation VLCInfoTreeItem
 404
 405 static VLCInfoTreeItem *o_root_item = nil;
 406
 407 #define IsALeafNode ((id)-1)
 408
 409 - (id)initWithName: (NSString *)o_item_name value: (NSString *)o_item_value ID: (int)i_id parent:(VLCInfoTreeItem *)o_parent_item
 410 {
 411     self = [super init];
 412
 413     if( self != nil )
 414     {
 415         o_name = [o_item_name copy];
 416         o_value = [o_item_value copy];
 417         i_object_id = i_id;
 418         o_parent = o_parent_item;
 419         if( [[VLCMain sharedInstance] getInfo] != nil )
 420             p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 421         else
 422             p_item = NULL;
 423     }
 424     return( self );
 425 }
 426
 427 + (VLCInfoTreeItem *)rootItem {
 428     if( o_root_item == nil )
 429         o_root_item = [[VLCInfoTreeItem alloc] initWithName:@"main" value: @"" ID: 0 parent:nil];
 430     return o_root_item;
 431 }
 432
 433 - (void)dealloc
 434 {
 435     if( o_children != IsALeafNode ) [o_children release];
 436     [o_name release];
 437     [super dealloc];
 438 }
 439
 440 /* Creates and returns the array of children
 441  * Loads children incrementally */
 442 - (NSArray *)children
 443 {
 444     if (o_children == NULL)
 445     {
 446         int i;
 447
 448         if( [[[VLCMain sharedInstance] getInfo] isItemInPlaylist: p_item] )
 449         {
 450             if( self == o_root_item )
 451             {
 452                 vlc_mutex_lock( &p_item->p_input->lock );
 453                 o_children = [[NSMutableArray alloc] initWithCapacity:
 454                                                 p_item->p_input->i_categories];
 455                 for (i = 0 ; i < p_item->p_input->i_categories ; i++)
 456                 {
 457                     [o_children addObject:[[VLCInfoTreeItem alloc]
 458                         initWithName: [NSString stringWithUTF8String:
 459                             p_item->p_input->pp_categories[i]->psz_name]
 460                         value: @""
 461                         ID: i
 462                         parent: self]];
 463                 }
 464                 vlc_mutex_unlock( &p_item->p_input->lock );
 465             }
 466             else if( o_parent == o_root_item )
 467             {
 468                 vlc_mutex_lock( &p_item->p_input->lock );
 469                 o_children = [[NSMutableArray alloc] initWithCapacity:
 470                     p_item->p_input->pp_categories[i_object_id]->i_infos];
 471
 472                 for (i = 0 ; i < p_item->p_input->pp_categories[i_object_id]->i_infos ; i++)
 473                 {
 474                     [o_children addObject:[[VLCInfoTreeItem alloc]
 475                     initWithName: [NSString stringWithUTF8String:
 476                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_name]
 477                         value: [NSString stringWithUTF8String:
 478                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_value]
 479                         ID: i
 480                         parent: self]];
 481                 }
 482                 vlc_mutex_unlock( &p_item->p_input->lock );
 483             }
 484             else
 485             {
 486                 o_children = IsALeafNode;
 487             }
 488         }
 489     }
 490     return o_children;
 491 }
 492
 493 - (NSString *)getName
 494 {
 495     return o_name;
 496 }
 497
 498 - (NSString *)getValue
 499 {
 500     return o_value;
 501 }
 502
 503 - (VLCInfoTreeItem *)childAtIndex:(int)i_index {
 504     return [[self children] objectAtIndex:i_index];
 505 }
 506
 507 - (int)numberOfChildren {
 508     id i_tmp = [self children];
 509     return ( i_tmp == IsALeafNode ) ? (-1) : (int)[i_tmp count];
 510 }
 511
 512 /*- (int)selectedPlaylistItem
 513 {
 514     return i_item;
 515 }
 516 */
 517 - (void)refresh
 518 {
 519     p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 520     if( o_children != NULL )
 521     {
 522         [o_children release];
 523         o_children = NULL;
 524     }
 525 }
 526
 527 @end
 528