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