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-2006 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 - (IBAction)togglePlaylistInfoPanel:(id)sender
 115 {
 116     if( [o_info_window isVisible] )
 117     {
 118         [self windowShouldClose: nil];
 119         [o_info_window orderOut: sender];
 120     }
 121     else
 122     {
 123         p_item = [[[VLCMain sharedInstance] getPlaylist] selectedPlaylistItem];
 124         [self initPanel:sender];
 125     }
 126 }
 127
 128 - (IBAction)toggleInfoPanel:(id)sender
 129 {
 130     if( [o_info_window isVisible] )
 131     {
 132         [self windowShouldClose: nil];
 133         [o_info_window orderOut: sender];
 134     }
 135     else
 136     {
 137         intf_thread_t * p_intf = VLCIntf;
 138         playlist_t * p_playlist = pl_Yield( p_intf );
 139
 140         p_item = p_playlist->status.p_item;
 141         vlc_object_release( p_playlist );
 142
 143         [self initPanel:sender];
 144     }
 145 }
 146
 147 - (void)initPanel:(id)sender
 148 {
 149     BOOL b_stats = config_GetInt(VLCIntf, "stats");
 150     if( b_stats )
 151     {
 152         o_statUpdateTimer = [NSTimer scheduledTimerWithTimeInterval: 1
 153             target: self selector: @selector(updateStatistics:)
 154             userInfo: nil repeats: YES];
 155         [o_statUpdateTimer fire];
 156         [o_statUpdateTimer retain];
 157     }
 158     else
 159     {
 160         if( [o_tab_view numberOfTabViewItems] > 2 )
 161             [o_tab_view removeTabViewItem: [o_tab_view tabViewItemAtIndex: 2]];
 162     }
 163
 164     [self updatePanel];
 165     [o_info_window makeKeyAndOrderFront: sender];
 166 }
 167
 168 - (void)updatePanel
 169 {
 170     /* make sure that we got the current item and not an outdated one */
 171     intf_thread_t * p_intf = VLCIntf;
 172         playlist_t * p_playlist = pl_Yield( p_intf );
 173
 174     p_item = p_playlist->status.p_item;
 175     vlc_object_release( p_playlist );
 176
 177     /* check whether our item is valid, because we would crash if not */
 178     if(! [self isItemInPlaylist: p_item] ) return;
 179
 180     vlc_mutex_lock( &p_item->p_input->lock );
 181
 182     /* fill uri info */
 183     if( p_item->p_input->psz_uri )
 184     {
 185         [o_uri_txt setStringValue:
 186             ([NSString stringWithUTF8String:p_item->p_input->psz_uri] == nil ) ?
 187             [NSString stringWithCString:p_item->p_input->psz_uri] :
 188             [NSString stringWithUTF8String:p_item->p_input->psz_uri]];
 189     }
 190
 191     /* fill the other fields */
 192 #define p_m p_item->p_input->p_meta
 193     [self setMeta: p_m->psz_title forLabel: o_title_txt];
 194     [self setMeta: p_m->psz_artist forLabel: o_author_txt];
 195     [self setMeta: p_m->psz_album forLabel: o_collection_txt];
 196     [self setMeta: p_m->psz_tracknum forLabel: o_seqNum_txt];
 197     [self setMeta: p_m->psz_genre forLabel: o_genre_txt];
 198     [self setMeta: p_m->psz_copyright forLabel: o_copyright_txt];
 199     [self setMeta: p_m->psz_rating forLabel: o_rating_txt];
 200     [self setMeta: p_m->psz_publisher forLabel: o_publisher_txt];
 201     [self setMeta: p_m->psz_nowplaying forLabel: o_nowPlaying_txt];
 202     [self setMeta: p_m->psz_language forLabel: o_language_txt];
 203     [self setMeta: p_m->psz_date forLabel: o_date_txt];
 204 #undef p_m
 205     vlc_mutex_unlock( &p_item->p_input->lock );
 206
 207     /* reload the advanced table */
 208     [[VLCInfoTreeItem rootItem] refresh];
 209     [o_outline_view reloadData];
 210
 211     /* update the stats once to display p_item change faster */
 212     [self updateStatistics: nil];
 213 }
 214
 215 - (void)setMeta: (char *)psz_meta forLabel: (id)theItem
 216 {
 217     if( psz_meta != NULL && *psz_meta)
 218         [theItem setStringValue:
 219             ([NSString stringWithUTF8String:psz_meta] == nil ) ?
 220             [NSString stringWithCString:psz_meta] :
 221             [NSString stringWithUTF8String:psz_meta]];
 222     else
 223         [theItem setStringValue: @"-"];
 224 }
 225
 226 - (void)updateStatistics:(NSTimer*)theTimer
 227 {
 228     if( [self isItemInPlaylist: p_item] )
 229     {
 230         /* we can only do that if there's a valid input around */
 231
 232         vlc_mutex_lock( &p_item->p_input->p_stats->lock );
 233
 234         /* input */
 235         [o_read_bytes_txt setStringValue: [NSString stringWithFormat:
 236             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_read_bytes)/1000]];
 237         [o_input_bitrate_txt setStringValue: [NSString stringWithFormat:
 238             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_input_bitrate)*8000]];
 239         [o_demux_bytes_txt setStringValue: [NSString stringWithFormat:
 240             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_demux_read_bytes)/1000]];
 241         [o_demux_bitrate_txt setStringValue: [NSString stringWithFormat:
 242             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_demux_bitrate)*8000]];
 243
 244         /* Video */
 245         [o_video_decoded_txt setStringValue: [NSString stringWithFormat: @"%5i",
 246             p_item->p_input->p_stats->i_decoded_video]];
 247         [o_displayed_txt setStringValue: [NSString stringWithFormat: @"%5i",
 248             p_item->p_input->p_stats->i_displayed_pictures]];
 249         [o_lost_frames_txt setStringValue: [NSString stringWithFormat: @"%5i",
 250             p_item->p_input->p_stats->i_lost_pictures]];
 251
 252         /* Sout */
 253         [o_sent_packets_txt setStringValue: [NSString stringWithFormat: @"%5i",
 254             p_item->p_input->p_stats->i_sent_packets]];
 255         [o_sent_bytes_txt setStringValue: [NSString stringWithFormat: @"%8.0f kB",
 256             (float)(p_item->p_input->p_stats->i_sent_bytes)/1000]];
 257         [o_sent_bitrate_txt setStringValue: [NSString stringWithFormat:
 258             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_send_bitrate*8)*1000]];
 259
 260         /* Audio */
 261         [o_audio_decoded_txt setStringValue: [NSString stringWithFormat: @"%5i",
 262             p_item->p_input->p_stats->i_decoded_audio]];
 263         [o_played_abuffers_txt setStringValue: [NSString stringWithFormat: @"%5i",
 264             p_item->p_input->p_stats->i_played_abuffers]];
 265         [o_lost_abuffers_txt setStringValue: [NSString stringWithFormat: @"%5i",
 266             p_item->p_input->p_stats->i_lost_abuffers]];
 267
 268         vlc_mutex_unlock( &p_item->p_input->p_stats->lock );
 269     }
 270 }
 271
 272 - (IBAction)infoCancel:(id)sender
 273 {
 274     [self windowShouldClose: nil];
 275     [o_info_window orderOut: self];
 276 }
 277
 278
 279 - (IBAction)infoOk:(id)sender
 280 {
 281     intf_thread_t * p_intf = VLCIntf;
 282     playlist_t * p_playlist = pl_Yield( p_intf );
 283     vlc_value_t val;
 284
 285     if( [self isItemInPlaylist: p_item] )
 286     {
 287         vlc_mutex_lock( &p_item->p_input->lock );
 288
 289         p_item->p_input->psz_uri = strdup( [[o_uri_txt stringValue] UTF8String] );
 290         p_item->p_input->psz_name = strdup( [[o_title_txt stringValue] UTF8String] );
 291         vlc_meta_SetArtist( p_item->p_input->p_meta, [[o_author_txt stringValue] UTF8String] )
 292         vlc_mutex_unlock( &p_item->p_input->lock );
 293
 294         val.b_bool = VLC_TRUE;
 295         var_Set( p_playlist, "intf-change", val );
 296     }
 297     vlc_object_release( p_playlist );
 298     [self windowShouldClose: nil];
 299     [o_info_window orderOut: self];
 300 }
 301
 302 - (playlist_item_t *)getItem
 303 {
 304     return p_item;
 305 }
 306
 307 - (BOOL)isItemInPlaylist:(playlist_item_t *)p_local_item
 308 {
 309     intf_thread_t * p_intf = VLCIntf;
 310     playlist_t * p_playlist = pl_Yield( p_intf );
 311     int i;
 312
 313     for( i = 0 ; i < p_playlist->all_items.i_size ; i++ )
 314     {
 315         if( ARRAY_VAL( p_playlist->all_items, i ) == p_local_item )
 316         {
 317             vlc_object_release( p_playlist );
 318             return YES;
 319         }
 320     }
 321     vlc_object_release( p_playlist );
 322     return NO;
 323 }
 324
 325 - (BOOL)windowShouldClose:(id)sender
 326 {
 327     if( [o_statUpdateTimer isValid] )
 328         [o_statUpdateTimer invalidate];
 329
 330     if( o_statUpdateTimer )
 331         [o_statUpdateTimer release];
 332
 333     return YES;
 334 }
 335
 336 @end
 337
 338 @implementation VLCInfo (NSMenuValidation)
 339
 340 - (BOOL)validateMenuItem:(NSMenuItem *)o_mi
 341 {
 342     BOOL bEnabled = TRUE;
 343
 344     intf_thread_t * p_intf = VLCIntf;
 345     input_thread_t * p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 346                                                        FIND_ANYWHERE );
 347
 348     if( [[o_mi title] isEqualToString: _NS("Information")] )
 349     {
 350         if( p_input == NULL )
 351         {
 352             bEnabled = FALSE;
 353         }
 354     }
 355     if( p_input ) vlc_object_release( p_input );
 356
 357     return( bEnabled );
 358 }
 359
 360 @end
 361
 362 @implementation VLCInfo (NSTableDataSource)
 363
 364 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
 365 {
 366     return (item == nil) ? [[VLCInfoTreeItem rootItem] numberOfChildren] : [item numberOfChildren];
 367 }
 368
 369 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item {
 370     return ([item numberOfChildren] > 0);
 371 }
 372
 373 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item
 374 {
 375     return (item == nil) ? [[VLCInfoTreeItem rootItem] childAtIndex:index] : (id)[item childAtIndex:index];
 376 }
 377
 378 - (id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
 379 {
 380     if ([[tableColumn identifier] isEqualToString:@"0"])
 381     {
 382         return (item == nil) ? @"" : (id)[item getName];
 383     }
 384     else
 385     {
 386         return (item == nil) ? @"" : (id)[item getValue];
 387     }
 388 }
 389
 390
 391 @end
 392
 393 @implementation VLCInfoTreeItem
 394
 395 static VLCInfoTreeItem *o_root_item = nil;
 396
 397 #define IsALeafNode ((id)-1)
 398
 399 - (id)initWithName: (NSString *)o_item_name value: (NSString *)o_item_value ID: (int)i_id parent:(VLCInfoTreeItem *)o_parent_item
 400 {
 401     self = [super init];
 402
 403     if( self != nil )
 404     {
 405         o_name = [o_item_name copy];
 406         o_value = [o_item_value copy];
 407         i_object_id = i_id;
 408         o_parent = o_parent_item;
 409         if( [[VLCMain sharedInstance] getInfo] != nil )
 410             p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 411         else
 412             p_item = NULL;
 413     }
 414     return( self );
 415 }
 416
 417 + (VLCInfoTreeItem *)rootItem {
 418     if( o_root_item == nil )
 419         o_root_item = [[VLCInfoTreeItem alloc] initWithName:@"main" value: @"" ID: 0 parent:nil];
 420     return o_root_item;
 421 }
 422
 423 - (void)dealloc
 424 {
 425     if( o_children != IsALeafNode ) [o_children release];
 426     [o_name release];
 427     [super dealloc];
 428 }
 429
 430 /* Creates and returns the array of children
 431  * Loads children incrementally */
 432 - (NSArray *)children
 433 {
 434     if (o_children == NULL)
 435     {
 436         int i;
 437
 438         if( [[[VLCMain sharedInstance] getInfo] isItemInPlaylist: p_item] )
 439         {
 440             if( self == o_root_item )
 441             {
 442                 vlc_mutex_lock( &p_item->p_input->lock );
 443                 o_children = [[NSMutableArray alloc] initWithCapacity:
 444                                                 p_item->p_input->i_categories];
 445                 for (i = 0 ; i < p_item->p_input->i_categories ; i++)
 446                 {
 447                     [o_children addObject:[[VLCInfoTreeItem alloc]
 448                         initWithName: [NSString stringWithUTF8String:
 449                             p_item->p_input->pp_categories[i]->psz_name]
 450                         value: @""
 451                         ID: i
 452                         parent: self]];
 453                 }
 454                 vlc_mutex_unlock( &p_item->p_input->lock );
 455             }
 456             else if( o_parent == o_root_item )
 457             {
 458                 vlc_mutex_lock( &p_item->p_input->lock );
 459                 o_children = [[NSMutableArray alloc] initWithCapacity:
 460                     p_item->p_input->pp_categories[i_object_id]->i_infos];
 461
 462                 for (i = 0 ; i < p_item->p_input->pp_categories[i_object_id]->i_infos ; i++)
 463                 {
 464                     [o_children addObject:[[VLCInfoTreeItem alloc]
 465                     initWithName: [NSString stringWithUTF8String:
 466                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_name]
 467                         value: [NSString stringWithUTF8String:
 468                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_value]
 469                         ID: i
 470                         parent: self]];
 471                 }
 472                 vlc_mutex_unlock( &p_item->p_input->lock );
 473             }
 474             else
 475             {
 476                 o_children = IsALeafNode;
 477             }
 478         }
 479     }
 480     return o_children;
 481 }
 482
 483 - (NSString *)getName
 484 {
 485     return o_name;
 486 }
 487
 488 - (NSString *)getValue
 489 {
 490     return o_value;
 491 }
 492
 493 - (VLCInfoTreeItem *)childAtIndex:(int)i_index {
 494     return [[self children] objectAtIndex:i_index];
 495 }
 496
 497 - (int)numberOfChildren {
 498     id i_tmp = [self children];
 499     return ( i_tmp == IsALeafNode ) ? (-1) : (int)[i_tmp count];
 500 }
 501
 502 /*- (int)selectedPlaylistItem
 503 {
 504     return i_item;
 505 }
 506 */
 507 - (void)refresh
 508 {
 509     p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 510     if( o_children != NULL )
 511     {
 512         [o_children release];
 513         o_children = NULL;
 514     }
 515 }
 516
 517 @end
 518