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