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