]> git.sesse.net Git - vlc/blob - modules/gui/macosx/playlistinfo.m
Implementing meta tag writing and cleaned a bit up
[vlc] / 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     if( b_stats )
131     {
132         o_statUpdateTimer = [NSTimer scheduledTimerWithTimeInterval: 1
133             target: self selector: @selector(updateStatistics:)
134             userInfo: nil repeats: YES];
135         [o_statUpdateTimer fire];
136         [o_statUpdateTimer retain];
137     }
138     else
139     {
140         if( [o_tab_view numberOfTabViewItems] > 2 )
141             [o_tab_view removeTabViewItem: [o_tab_view tabViewItemAtIndex: 2]];
142     }
143
144     [self updatePanel];
145     [o_info_window makeKeyAndOrderFront: self];
146 }
147
148 - (void)updatePanel
149 {
150     /* make sure that we got the current item and not an outdated one */
151     intf_thread_t * p_intf = VLCIntf;
152         playlist_t * p_playlist = pl_Yield( p_intf );
153
154     p_item = p_playlist->status.p_item;
155     vlc_object_release( p_playlist );
156
157     /* check whether our item is valid, because we would crash if not */
158     if(! [self isItemInPlaylist: p_item] ) return;
159
160     /* fill uri info */
161     if( input_item_GetURI( p_item->p_input ) != NULL )
162     {
163         [o_uri_txt setStringValue: [NSString stringWithUTF8String: input_item_GetURI( p_item->p_input ) ]];
164     }
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     SET( description, Description );
183
184 #undef SET
185
186     char *psz_meta;
187     NSImage *o_image;
188     psz_meta = input_item_GetArtURL( p_item->p_input );
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     FREENULL( 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     else
210         [theItem setStringValue: @""];
211 }
212
213 - (void)updateStatistics:(NSTimer*)theTimer
214 {
215     if( [self isItemInPlaylist: p_item] )
216     {
217         vlc_mutex_lock( &p_item->p_input->p_stats->lock );
218
219         /* input */
220         [o_read_bytes_txt setStringValue: [NSString stringWithFormat:
221             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_read_bytes)/1000]];
222         [o_input_bitrate_txt setStringValue: [NSString stringWithFormat:
223             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_input_bitrate)*8000]];
224         [o_demux_bytes_txt setStringValue: [NSString stringWithFormat:
225             @"%8.0f kB", (float)(p_item->p_input->p_stats->i_demux_read_bytes)/1000]];
226         [o_demux_bitrate_txt setStringValue: [NSString stringWithFormat:
227             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_demux_bitrate)*8000]];
228
229         /* Video */
230         [o_video_decoded_txt setIntValue: p_item->p_input->p_stats->i_decoded_video];
231         [o_displayed_txt setIntValue: p_item->p_input->p_stats->i_displayed_pictures];
232         [o_lost_frames_txt setIntValue: p_item->p_input->p_stats->i_lost_pictures];
233         float f_fps = 0;
234         /* FIXME: input_Control( p_item->p_input, INPUT_GET_VIDEO_FPS, &f_fps ); */
235         [o_fps_txt setFloatValue: f_fps];
236
237         /* Sout */
238         [o_sent_packets_txt setIntValue: p_item->p_input->p_stats->i_sent_packets];
239         [o_sent_bytes_txt setStringValue: [NSString stringWithFormat: @"%8.0f kB",
240             (float)(p_item->p_input->p_stats->i_sent_bytes)/1000]];
241         [o_sent_bitrate_txt setStringValue: [NSString stringWithFormat:
242             @"%6.0f kb/s", (float)(p_item->p_input->p_stats->f_send_bitrate*8)*1000]];
243
244         /* Audio */
245         [o_audio_decoded_txt setIntValue: p_item->p_input->p_stats->i_decoded_audio];
246         [o_played_abuffers_txt setIntValue: p_item->p_input->p_stats->i_played_abuffers];
247         [o_lost_abuffers_txt setIntValue: p_item->p_input->p_stats->i_lost_abuffers];
248
249         vlc_mutex_unlock( &p_item->p_input->p_stats->lock );
250     }
251 }
252
253 - (IBAction)metaFieldChanged:(id)sender
254 {
255     [o_saveMetaData_btn setEnabled: YES];
256 }
257
258 - (IBAction)saveMetaData:(id)sender
259 {
260     intf_thread_t * p_intf = VLCIntf;
261     playlist_t * p_playlist = pl_Yield( p_intf );
262     vlc_value_t val;
263
264     if( [self isItemInPlaylist: p_item] )
265     {
266         meta_export_t p_export;
267         p_export.p_item = p_item->p_input;
268
269         if( p_item->p_input == NULL )
270             goto end;
271
272         /* we can write meta data only in a file */
273         vlc_mutex_lock( &p_item->p_input->lock );
274         int i_type = p_item->p_input->i_type;
275         vlc_mutex_unlock( &p_item->p_input->lock );
276         if( i_type == ITEM_TYPE_FILE )
277         {
278             char *psz_uri_orig = input_item_GetURI( p_item->p_input );
279             char *psz_uri = psz_uri_orig;
280             if( !strncmp( psz_uri, "file://", 7 ) )
281                 psz_uri += 7; /* strlen("file://") = 7 */
282             
283             p_export.psz_file = strndup( psz_uri, PATH_MAX );
284             free( psz_uri_orig );
285         }
286         else
287             goto end;
288
289         #define utf8( o_blub ) \
290             [[o_blub stringValue] UTF8String]
291
292         input_item_SetName( p_item->p_input, utf8( o_title_txt ) );
293         input_item_SetTitle( p_item->p_input, utf8( o_title_txt ) );
294         input_item_SetArtist( p_item->p_input, utf8( o_author_txt ) );
295         input_item_SetAlbum( p_item->p_input, utf8( o_collection_txt ) );
296         input_item_SetGenre( p_item->p_input, utf8( o_genre_txt ) );
297         input_item_SetTrackNum( p_item->p_input, utf8( o_seqNum_txt ) );
298         input_item_SetDate( p_item->p_input, utf8( o_date_txt ) );
299         input_item_SetCopyright( p_item->p_input, utf8( o_copyright_txt ) );
300         input_item_SetPublisher( p_item->p_input, utf8( o_publisher_txt ) );
301         input_item_SetDescription( p_item->p_input, utf8( o_description_txt ) );
302         input_item_SetLanguage( p_item->p_input, utf8( o_language_txt ) );
303
304         PL_LOCK;
305         p_playlist->p_private = &p_export;
306
307         module_t *p_mod = module_Need( p_playlist, "meta writer", NULL, 0 );
308         if( p_mod )
309             module_Unneed( p_playlist, p_mod );
310         PL_UNLOCK;
311
312         val.b_bool = VLC_TRUE;
313         var_Set( p_playlist, "intf-change", val );
314         [self updatePanel];
315     }
316
317     end:
318     vlc_object_release( p_playlist );
319     [o_saveMetaData_btn setEnabled: NO];
320 }
321
322 - (playlist_item_t *)getItem
323 {
324     return p_item;
325 }
326
327 - (BOOL)isItemInPlaylist:(playlist_item_t *)p_local_item
328 {
329     intf_thread_t * p_intf = VLCIntf;
330     playlist_t * p_playlist = pl_Yield( p_intf );
331     int i;
332
333     for( i = 0 ; i < p_playlist->all_items.i_size ; i++ )
334     {
335         if( ARRAY_VAL( p_playlist->all_items, i ) == p_local_item )
336         {
337             vlc_object_release( p_playlist );
338             return YES;
339         }
340     }
341     vlc_object_release( p_playlist );
342     return NO;
343 }
344
345 - (BOOL)windowShouldClose:(id)sender
346 {
347     if( [o_statUpdateTimer isValid] )
348         [o_statUpdateTimer invalidate];
349
350     if( o_statUpdateTimer )
351         [o_statUpdateTimer release];
352
353     return YES;
354 }
355
356 @end
357
358 @implementation VLCInfo (NSMenuValidation)
359
360 - (BOOL)validateMenuItem:(NSMenuItem *)o_mi
361 {
362     BOOL bEnabled = TRUE;
363
364     intf_thread_t * p_intf = VLCIntf;
365     input_thread_t * p_input = vlc_object_find( p_intf, VLC_OBJECT_INPUT,
366                                                        FIND_ANYWHERE );
367
368     if( [[o_mi title] isEqualToString: _NS("Information")] )
369     {
370         if( p_input == NULL )
371         {
372             bEnabled = FALSE;
373         }
374     }
375     if( p_input ) vlc_object_release( p_input );
376
377     return( bEnabled );
378 }
379
380 @end
381
382 @implementation VLCInfo (NSTableDataSource)
383
384 - (int)outlineView:(NSOutlineView *)outlineView numberOfChildrenOfItem:(id)item
385 {
386     return (item == nil) ? [[VLCInfoTreeItem rootItem] numberOfChildren] : [item numberOfChildren];
387 }
388
389 - (BOOL)outlineView:(NSOutlineView *)outlineView isItemExpandable:(id)item {
390     return ([item numberOfChildren] > 0);
391 }
392
393 - (id)outlineView:(NSOutlineView *)outlineView child:(int)index ofItem:(id)item
394 {
395     return (item == nil) ? [[VLCInfoTreeItem rootItem] childAtIndex:index] : (id)[item childAtIndex:index];
396 }
397
398 - (id)outlineView:(NSOutlineView *)outlineView objectValueForTableColumn:(NSTableColumn *)tableColumn byItem:(id)item
399 {
400     if ([[tableColumn identifier] isEqualToString:@"0"])
401     {
402         return (item == nil) ? @"" : (id)[item getName];
403     }
404     else
405     {
406         return (item == nil) ? @"" : (id)[item getValue];
407     }
408 }
409
410
411 @end
412
413 @implementation VLCInfoTreeItem
414
415 static VLCInfoTreeItem *o_root_item = nil;
416
417 #define IsALeafNode ((id)-1)
418
419 - (id)initWithName: (NSString *)o_item_name value: (NSString *)o_item_value ID: (int)i_id parent:(VLCInfoTreeItem *)o_parent_item
420 {
421     self = [super init];
422
423     if( self != nil )
424     {
425         o_name = [o_item_name copy];
426         o_value = [o_item_value copy];
427         i_object_id = i_id;
428         o_parent = o_parent_item;
429         if( [[VLCMain sharedInstance] getInfo] != nil )
430             p_item = [[[VLCMain sharedInstance] getInfo] getItem];
431         else
432             p_item = NULL;
433     }
434     return( self );
435 }
436
437 + (VLCInfoTreeItem *)rootItem {
438     if( o_root_item == nil )
439         o_root_item = [[VLCInfoTreeItem alloc] initWithName:@"main" value: @"" ID: 0 parent:nil];
440     return o_root_item;
441 }
442
443 - (void)dealloc
444 {
445     if( o_children != IsALeafNode ) [o_children release];
446     [o_name release];
447     [super dealloc];
448 }
449
450 /* Creates and returns the array of children
451  * Loads children incrementally */
452 - (NSArray *)children
453 {
454     if (o_children == NULL)
455     {
456         int i;
457
458         if( [[[VLCMain sharedInstance] getInfo] isItemInPlaylist: p_item] )
459         {
460             if( self == o_root_item )
461             {
462                 vlc_mutex_lock( &p_item->p_input->lock );
463                 o_children = [[NSMutableArray alloc] initWithCapacity:
464                                                 p_item->p_input->i_categories];
465                 for (i = 0 ; i < p_item->p_input->i_categories ; i++)
466                 {
467                     [o_children addObject:[[VLCInfoTreeItem alloc]
468                         initWithName: [NSString stringWithUTF8String:
469                             p_item->p_input->pp_categories[i]->psz_name]
470                         value: @""
471                         ID: i
472                         parent: self]];
473                 }
474                 vlc_mutex_unlock( &p_item->p_input->lock );
475             }
476             else if( o_parent == o_root_item )
477             {
478                 vlc_mutex_lock( &p_item->p_input->lock );
479                 o_children = [[NSMutableArray alloc] initWithCapacity:
480                     p_item->p_input->pp_categories[i_object_id]->i_infos];
481
482                 for (i = 0 ; i < p_item->p_input->pp_categories[i_object_id]->i_infos ; i++)
483                 {
484                     [o_children addObject:[[VLCInfoTreeItem alloc]
485                     initWithName: [NSString stringWithUTF8String:
486                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_name]
487                         value: [NSString stringWithUTF8String:
488                             p_item->p_input->pp_categories[i_object_id]->pp_infos[i]->psz_value ? : ""]
489                         ID: i
490                         parent: self]];
491                 }
492                 vlc_mutex_unlock( &p_item->p_input->lock );
493             }
494             else
495             {
496                 o_children = IsALeafNode;
497             }
498         }
499     }
500     return o_children;
501 }
502
503 - (NSString *)getName
504 {
505     return o_name;
506 }
507
508 - (NSString *)getValue
509 {
510     return o_value;
511 }
512
513 - (VLCInfoTreeItem *)childAtIndex:(int)i_index {
514     return [[self children] objectAtIndex:i_index];
515 }
516
517 - (int)numberOfChildren {
518     id i_tmp = [self children];
519     return ( i_tmp == IsALeafNode ) ? (-1) : (int)[i_tmp count];
520 }
521
522 - (void)refresh
523 {
524     p_item = [[[VLCMain sharedInstance] getInfo] getItem];
525     if( o_children != NULL )
526     {
527         [o_children release];
528         o_children = NULL;
529     }
530 }
531
532 @end
533