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