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-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Benjamin Pracht <bigben at videolan dot org>
   8  *          Felix Paul 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 static VLCInfo *_o_sharedInstance = nil;
  40
  41 + (VLCInfo *)sharedInstance
  42 {
  43     return _o_sharedInstance ? _o_sharedInstance : [[self alloc] init];
  44 }
  45
  46 - (id)init
  47 {
  48     if( _o_sharedInstance ) {
  49         [self dealloc];
  50     } else {
  51         _o_sharedInstance = [super init];
  52
  53         if( _o_sharedInstance != nil )
  54         {
  55             p_item = NULL;
  56             o_statUpdateTimer = nil;
  57         }
  58     }
  59
  60     return _o_sharedInstance;
  61 }
  62
  63 - (void)awakeFromNib
  64 {
  65     [o_info_window setExcludedFromWindowsMenu: TRUE];
  66
  67     [o_info_window setTitle: _NS("Media Information")];
  68     [o_uri_lbl setStringValue: _NS("Location")];
  69     [o_title_lbl setStringValue: _NS("Title")];
  70     [o_author_lbl setStringValue: _NS("Artist")];
  71     [o_saveMetaData_btn setStringValue: _NS("Save Metadata" )];
  72
  73     [[o_tab_view tabViewItemAtIndex: 0] setLabel: _NS("General")];
  74     [[o_tab_view tabViewItemAtIndex: 1] setLabel: _NS("Codec Details")];
  75     [[o_tab_view tabViewItemAtIndex: 2] setLabel: _NS("Statistics")];
  76     [o_tab_view selectTabViewItemAtIndex: 0];
  77
  78     /* constants defined in vlc_meta.h */
  79     [o_genre_lbl setStringValue: _NS(VLC_META_GENRE)];
  80     [o_copyright_lbl setStringValue: _NS(VLC_META_COPYRIGHT)];
  81     [o_collection_lbl setStringValue: _NS(VLC_META_COLLECTION)];
  82     [o_seqNum_lbl setStringValue: _NS(VLC_META_SEQ_NUM)];
  83     [o_description_lbl setStringValue: _NS(VLC_META_DESCRIPTION)];
  84     [o_date_lbl setStringValue: _NS(VLC_META_DATE)];
  85     [o_language_lbl setStringValue: _NS(VLC_META_LANGUAGE)];
  86     [o_nowPlaying_lbl setStringValue: _NS(VLC_META_NOW_PLAYING)];
  87     [o_publisher_lbl setStringValue: _NS(VLC_META_PUBLISHER)];
  88
  89     /* statistics */
  90     [o_input_box setTitle: _NS("Input")];
  91     [o_read_bytes_lbl setStringValue: _NS("Read at media")];
  92     [o_input_bitrate_lbl setStringValue: _NS("Input bitrate")];
  93     [o_demux_bytes_lbl setStringValue: _NS("Demuxed")];
  94     [o_demux_bitrate_lbl setStringValue: _NS("Stream bitrate")];
  95
  96     [o_video_box setTitle: _NS("Video")];
  97     [o_video_decoded_lbl setStringValue: _NS("Decoded blocks")];
  98     [o_displayed_lbl setStringValue: _NS("Displayed frames")];
  99     [o_lost_frames_lbl setStringValue: _NS("Lost frames")];
 100         [o_fps_lbl setStringValue: _NS("Frames per Second")];
 101
 102     [o_sout_box setTitle: _NS("Streaming")];
 103     [o_sent_packets_lbl setStringValue: _NS("Sent packets")];
 104     [o_sent_bytes_lbl setStringValue: _NS("Sent bytes")];
 105     [o_sent_bitrate_lbl setStringValue: _NS("Send rate")];
 106
 107     [o_audio_box setTitle: _NS("Audio")];
 108     [o_audio_decoded_lbl setStringValue: _NS("Decoded blocks")];
 109     [o_played_abuffers_lbl setStringValue: _NS("Played buffers")];
 110     [o_lost_abuffers_lbl setStringValue: _NS("Lost buffers")];
 111
 112     [o_info_window setInitialFirstResponder: o_uri_txt];
 113 }
 114
 115 - (void)dealloc
 116 {
 117     /* make sure that the timer is released in any case */
 118     if( [o_statUpdateTimer isValid] )
 119         [o_statUpdateTimer invalidate];
 120
 121     if ( o_statUpdateTimer )
 122         [o_statUpdateTimer release];
 123
 124     [super dealloc];
 125 }
 126
 127 - (void)initPanel
 128 {
 129     BOOL b_stats = config_GetInt(VLCIntf, "stats");
 130     [self initMediaPanelStats];
 131     if( b_stats )
 132     {
 133         o_statUpdateTimer = [NSTimer scheduledTimerWithTimeInterval: 1
 134             target: self selector: @selector(updateStatistics:)
 135             userInfo: nil repeats: YES];
 136         [o_statUpdateTimer fire];
 137         [o_statUpdateTimer retain];
 138     }
 139     else
 140     {
 141         if( [o_tab_view numberOfTabViewItems] > 2 )
 142             [o_tab_view removeTabViewItem: [o_tab_view tabViewItemAtIndex: 2]];
 143     }
 144
 145     [self updatePanel];
 146     [o_info_window makeKeyAndOrderFront: self];
 147 }
 148
 149 - (void)initMediaPanelStats
 150 {
 151     //Initializing Input Variables
 152     [o_read_bytes_txt setStringValue: [NSString stringWithFormat:@"%8.0f kB", (float)0]];
 153     [o_input_bitrate_txt setStringValue: [NSString stringWithFormat:@"%6.0f kb/s", (float)0]];
 154     [o_demux_bytes_txt setStringValue: [NSString stringWithFormat:@"%8.0f kB", (float)0]];
 155     [o_demux_bitrate_txt setStringValue: [NSString stringWithFormat:@"%6.0f kb/s", (float)0]];
 156
 157     //Initializing Video Variables
 158     [o_video_decoded_txt setIntValue:0];
 159     [o_displayed_txt setIntValue:0];
 160     [o_lost_frames_txt setIntValue:0];
 161     [o_fps_txt setFloatValue:0];
 162
 163     //Initializing Output Variables
 164     [o_sent_packets_txt setIntValue: 0];
 165     [o_sent_bytes_txt setStringValue: [NSString stringWithFormat:@"%8.0f kB", (float)0]];
 166     [o_sent_bitrate_txt setStringValue: [NSString stringWithFormat:@"%6.0f kb/s", (float)0]];
 167
 168     //Initializing Audio Variables
 169     [o_audio_decoded_txt setIntValue:0];
 170     [o_played_abuffers_txt setIntValue: 0];
 171     [o_lost_abuffers_txt setIntValue: 0];
 172
 173 }
 174
 175 - (void)updatePanel
 176 {
 177     /* make sure that we got the current item and not an outdated one */
 178     intf_thread_t * p_intf = VLCIntf;
 179         playlist_t * p_playlist = pl_Yield( p_intf );
 180
 181     p_item = p_playlist->status.p_item;
 182     vlc_object_release( p_playlist );
 183
 184     /* check whether our item is valid, because we would crash if not */
 185     if(! [self isItemInPlaylist: p_item] ) return;
 186
 187     /* fill uri info */
 188     if( input_item_GetURI( p_item->p_input ) != NULL )
 189     {
 190         [o_uri_txt setStringValue: [NSString stringWithUTF8String: input_item_GetURI( p_item->p_input ) ]];
 191     }
 192
 193 #define SET( foo, bar ) \
 194     char *psz_##foo = input_item_Get##bar ( p_item->p_input ); \
 195     [self setMeta: psz_##foo forLabel: o_##foo##_txt]; \
 196     FREENULL( psz_##foo );
 197
 198     /* fill the other fields */
 199     SET( title, Title );
 200     SET( author, Artist );
 201     SET( collection, Album );
 202     SET( seqNum, TrackNum );
 203     SET( genre, Genre );
 204     SET( copyright, Copyright );
 205     SET( publisher, Publisher );
 206     SET( nowPlaying, NowPlaying );
 207     SET( language, Language );
 208     SET( date, Date );
 209     SET( description, Description );
 210
 211 #undef SET
 212
 213     char *psz_meta;
 214     NSImage *o_image;
 215     psz_meta = input_item_GetArtURL( p_item->p_input );
 216     if( psz_meta && !strncmp( psz_meta, "file://", 7 ) )
 217         o_image = [[NSImage alloc] initWithContentsOfURL: [NSURL URLWithString: [NSString stringWithUTF8String: psz_meta]]];
 218     else
 219         o_image = [[NSImage imageNamed: @"noart.png"] retain];
 220     [o_image_well setImage: o_image];
 221     [o_image release];
 222     FREENULL( psz_meta );
 223
 224     /* reload the advanced table */
 225     [[VLCInfoTreeItem rootItem] refresh];
 226     [o_outline_view reloadData];
 227
 228     /* update the stats once to display p_item change faster */
 229     [self updateStatistics: nil];
 230 }
 231
 232 - (void)setMeta: (char *)psz_meta forLabel: (id)theItem
 233 {
 234     if( psz_meta != NULL && *psz_meta)
 235         [theItem setStringValue: [NSString stringWithUTF8String:psz_meta]];
 236     else
 237         [theItem setStringValue: @""];
 238 }
 239
 240 - (void)updateStatistics:(NSTimer*)theTimer
 241 {
 242     if( [self isItemInPlaylist: p_item] )
 243     {
 244         vlc_mutex_lock( &p_item->p_input->p_stats->lock );
 245
 246         /* input */
 247         [o_read_bytes_txt setStringValue: [NSString stringWithFormat:
 248             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_read_bytes)/1000]];
 249         [o_input_bitrate_txt setStringValue: [NSString stringWithFormat:
 250             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_input_bitrate)*8000]];
 251         [o_demux_bytes_txt setStringValue: [NSString stringWithFormat:
 252             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_demux_read_bytes)/1000]];
 253         [o_demux_bitrate_txt setStringValue: [NSString stringWithFormat:
 254             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_demux_bitrate)*8000]];
 255
 256         /* Video */
 257         [o_video_decoded_txt setIntValue: p_item->p_input->p_stats->i_decoded_video];
 258         [o_displayed_txt setIntValue: p_item->p_input->p_stats->i_displayed_pictures];
 259         [o_lost_frames_txt setIntValue: p_item->p_input->p_stats->i_lost_pictures];
 260         float f_fps = 0;
 261         /* FIXME: input_Control( p_item->p_input, INPUT_GET_VIDEO_FPS, &f_fps ); */
 262         [o_fps_txt setFloatValue: f_fps];
 263
 264         /* Sout */
 265         [o_sent_packets_txt setIntValue: p_item->p_input->p_stats->i_sent_packets];
 266         [o_sent_bytes_txt setStringValue: [NSString stringWithFormat: @"%8.0f kB",
 267             (float)(p_item->p_input->p_stats->i_sent_bytes)/1000]];
 268         [o_sent_bitrate_txt setStringValue: [NSString stringWithFormat:
 269             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_send_bitrate*8)*1000]];
 270
 271         /* Audio */
 272         [o_audio_decoded_txt setIntValue: p_item->p_input->p_stats->i_decoded_audio];
 273         [o_played_abuffers_txt setIntValue: p_item->p_input->p_stats->i_played_abuffers];
 274         [o_lost_abuffers_txt setIntValue: p_item->p_input->p_stats->i_lost_abuffers];
 275
 276         vlc_mutex_unlock( &p_item->p_input->p_stats->lock );
 277     }
 278 }
 279
 280 - (IBAction)metaFieldChanged:(id)sender
 281 {
 282     [o_saveMetaData_btn setEnabled: YES];
 283 }
 284
 285 - (IBAction)saveMetaData:(id)sender
 286 {
 287     intf_thread_t * p_intf = VLCIntf;
 288     playlist_t * p_playlist = pl_Yield( p_intf );
 289     vlc_value_t val;
 290
 291     if( [self isItemInPlaylist: p_item] )
 292     {
 293         meta_export_t p_export;
 294         p_export.p_item = p_item->p_input;
 295
 296         if( p_item->p_input == NULL )
 297             goto end;
 298
 299         /* we can write meta data only in a file */
 300         vlc_mutex_lock( &p_item->p_input->lock );
 301         int i_type = p_item->p_input->i_type;
 302         vlc_mutex_unlock( &p_item->p_input->lock );
 303         if( i_type == ITEM_TYPE_FILE )
 304         {
 305             char *psz_uri_orig = input_item_GetURI( p_item->p_input );
 306             char *psz_uri = psz_uri_orig;
 307             if( !strncmp( psz_uri, "file://", 7 ) )
 308                 psz_uri += 7; /* strlen("file://") = 7 */
 309
 310             p_export.psz_file = strndup( psz_uri, PATH_MAX );
 311             free( psz_uri_orig );
 312         }
 313         else
 314             goto end;
 315
 316         #define utf8( o_blub ) \
 317             [[o_blub stringValue] UTF8String]
 318
 319         input_item_SetName( p_item->p_input, utf8( o_title_txt ) );
 320         input_item_SetTitle( p_item->p_input, utf8( o_title_txt ) );
 321         input_item_SetArtist( p_item->p_input, utf8( o_author_txt ) );
 322         input_item_SetAlbum( p_item->p_input, utf8( o_collection_txt ) );
 323         input_item_SetGenre( p_item->p_input, utf8( o_genre_txt ) );
 324         input_item_SetTrackNum( p_item->p_input, utf8( o_seqNum_txt ) );
 325         input_item_SetDate( p_item->p_input, utf8( o_date_txt ) );
 326         input_item_SetCopyright( p_item->p_input, utf8( o_copyright_txt ) );
 327         input_item_SetPublisher( p_item->p_input, utf8( o_publisher_txt ) );
 328         input_item_SetDescription( p_item->p_input, utf8( o_description_txt ) );
 329         input_item_SetLanguage( p_item->p_input, utf8( o_language_txt ) );
 330
 331         PL_LOCK;
 332         p_playlist->p_private = &p_export;
 333
 334         module_t *p_mod = module_Need( p_playlist, "meta writer", NULL, 0 );
 335         if( p_mod )
 336             module_Unneed( p_playlist, p_mod );
 337         PL_UNLOCK;
 338
 339         val.b_bool = VLC_TRUE;
 340         var_Set( p_playlist, "intf-change", val );
 341         [self updatePanel];
 342     }
 343
 344     end:
 345     vlc_object_release( p_playlist );
 346     [o_saveMetaData_btn setEnabled: NO];
 347 }
 348
 349 - (playlist_item_t *)getItem
 350 {
 351     return p_item;
 352 }
 353
 354 - (BOOL)isItemInPlaylist:(playlist_item_t *)p_local_item
 355 {
 356     intf_thread_t * p_intf = VLCIntf;
 357     playlist_t * p_playlist = pl_Yield( p_intf );
 358     int i;
 359
 360     for( i = 0 ; i < p_playlist->all_items.i_size ; i++ )
 361     {
 362         if( ARRAY_VAL( p_playlist->all_items, i ) == p_local_item )
 363         {
 364             vlc_object_release( p_playlist );
 365             return YES;
 366         }
 367     }
 368     vlc_object_release( p_playlist );
 369     return NO;
 370 }
 371
 372 - (BOOL)windowShouldClose:(id)sender
 373 {
 374     if( [o_statUpdateTimer isValid] )
 375         [o_statUpdateTimer invalidate];
 376
 377     if( o_statUpdateTimer )
 378         [o_statUpdateTimer release];
 379
 380     return YES;
 381 }
 382
 383 @end
 384
 385 @implementation VLCInfo (NSMenuValidation)
 386
 387 - (BOOL)validateMenuItem:(NSMenuItem *)o_mi
 388 {
 389     BOOL bEnabled = TRUE;
 390
 391     intf_thread_t * p_intf = VLCIntf;
 392     input_thread_t * p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
 393                                                        FIND_ANYWHERE );
 394
 395     if( [[o_mi title] isEqualToString: _NS("Information")] )
 396     {
 397         if( p_input == NULL )
 398         {
 399             bEnabled = FALSE;
 400         }
 401     }
 402     if( p_input ) vlc_object_release( p_input );
 403
 404     return( bEnabled );
 405 }
 406
 407 @end
 408
 409 @implementation VLCInfo (NSTableDataSource)
 410
 411 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
 412 {
 413     return (item == nil) ? [[VLCInfoTreeItem rootItem] numberOfChildren] : [item numberOfChildren];
 414 }
 415
 416 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item {
 417     return ([item numberOfChildren] > 0);
 418 }
 419
 420 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item
 421 {
 422     return (item == nil) ? [[VLCInfoTreeItem rootItem] childAtIndex:index] : (id)[item childAtIndex:index];
 423 }
 424
 425 - (id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
 426 {
 427     if ([[tableColumn identifier] isEqualToString:@"0"])
 428     {
 429         return (item == nil) ? @"" : (id)[item getName];
 430     }
 431     else
 432     {
 433         return (item == nil) ? @"" : (id)[item getValue];
 434     }
 435 }
 436
 437
 438 @end
 439
 440 @implementation VLCInfoTreeItem
 441
 442 static VLCInfoTreeItem *o_root_item = nil;
 443
 444 #define IsALeafNode ((id)-1)
 445
 446 - (id)initWithName: (NSString *)o_item_name value: (NSString *)o_item_value ID: (int)i_id parent:(VLCInfoTreeItem *)o_parent_item
 447 {
 448     self = [super init];
 449
 450     if( self != nil )
 451     {
 452         o_name = [o_item_name copy];
 453         o_value = [o_item_value copy];
 454         i_object_id = i_id;
 455         o_parent = o_parent_item;
 456         if( [[VLCMain sharedInstance] getInfo] != nil )
 457             p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 458         else
 459             p_item = NULL;
 460     }
 461     return( self );
 462 }
 463
 464 + (VLCInfoTreeItem *)rootItem {
 465     if( o_root_item == nil )
 466         o_root_item = [[VLCInfoTreeItem alloc] initWithName:@"main" value: @"" ID: 0 parent:nil];
 467     return o_root_item;
 468 }
 469
 470 - (void)dealloc
 471 {
 472     if( o_children != IsALeafNode ) [o_children release];
 473     [o_name release];
 474     [super dealloc];
 475 }
 476
 477 /* Creates and returns the array of children
 478  * Loads children incrementally */
 479 - (NSArray *)children
 480 {
 481     if (o_children == NULL)
 482     {
 483         int i;
 484
 485         if( [[[VLCMain sharedInstance] getInfo] isItemInPlaylist: p_item] )
 486         {
 487             if( self == o_root_item )
 488             {
 489                 vlc_mutex_lock( &p_item->p_input->lock );
 490                 o_children = [[NSMutableArray alloc] initWithCapacity:
 491                                                 p_item->p_input->i_categories];
 492                 for (i = 0 ; i < p_item->p_input->i_categories ; i++)
 493                 {
 494                     [o_children addObject:[[VLCInfoTreeItem alloc]
 495                         initWithName: [NSString stringWithUTF8String:
 496                             p_item->p_input->pp_categories[i]->psz_name]
 497                         value: @""
 498                         ID: i
 499                         parent: self]];
 500                 }
 501                 vlc_mutex_unlock( &p_item->p_input->lock );
 502             }
 503             else if( o_parent == o_root_item )
 504             {
 505                 vlc_mutex_lock( &p_item->p_input->lock );
 506                 o_children = [[NSMutableArray alloc] initWithCapacity:
 507                     p_item->p_input->pp_categories[i_object_id]->i_infos];
 508
 509                 for (i = 0 ; i < p_item->p_input->pp_categories[i_object_id]->i_infos ; i++)
 510                 {
 511                     [o_children addObject:[[VLCInfoTreeItem alloc]
 512                     initWithName: [NSString stringWithUTF8String:
 513                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_name]
 514                         value: [NSString stringWithUTF8String:
 515                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_value ? : ""]
 516                         ID: i
 517                         parent: self]];
 518                 }
 519                 vlc_mutex_unlock( &p_item->p_input->lock );
 520             }
 521             else
 522             {
 523                 o_children = IsALeafNode;
 524             }
 525         }
 526     }
 527     return o_children;
 528 }
 529
 530 - (NSString *)getName
 531 {
 532     return o_name;
 533 }
 534
 535 - (NSString *)getValue
 536 {
 537     return o_value;
 538 }
 539
 540 - (VLCInfoTreeItem *)childAtIndex:(int)i_index {
 541     return [[self children] objectAtIndex:i_index];
 542 }
 543
 544 - (int)numberOfChildren {
 545     id i_tmp = [self children];
 546     return ( i_tmp == IsALeafNode ) ? (-1) : (int)[i_tmp count];
 547 }
 548
 549 - (void)refresh
 550 {
 551     p_item = [[[VLCMain sharedInstance] getInfo] getItem];
 552     if( o_children != NULL )
 553     {
 554         [o_children release];
 555         o_children = NULL;
 556     }
 557 }
 558
 559 @end
 560