]> git.sesse.net Git - vlc/blob - modules/gui/qt4/components/infopanels.cpp
Qt4 - Info Panels, clean code, add comments and cosmetics.
[vlc] / modules / gui / qt4 / components / infopanels.cpp
1 /*****************************************************************************
2  * infopanels.cpp : Panels for the information dialogs
3  ****************************************************************************
4  * Copyright (C) 2006-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Baptiste Kempf <jb@videolan.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 #include "qt4.hpp"
26 #include "components/infopanels.hpp"
27
28 #include <QTreeWidget>
29 #include <QListView>
30 #include <QPushButton>
31 #include <QHeaderView>
32 #include <QList>
33 #include <QStringList>
34 #include <QGridLayout>
35 #include <QLineEdit>
36 #include <QLabel>
37 #include <QSpinBox>
38 #include <QTabWidget>
39
40 /************************************************************************
41  * Single panels
42  ************************************************************************/
43
44 /**
45  * First Panel - Meta Info
46  * All the usual MetaData are displayed and can be changed.
47  **/
48 MetaPanel::MetaPanel( QWidget *parent,
49                       intf_thread_t *_p_intf )
50                       : QWidget( parent ), p_intf( _p_intf )
51 {
52     QGridLayout *l = new QGridLayout( this );
53     int line = 0; /* Counter for GridLayout */
54     p_input = NULL;
55
56 #define ADD_META( string, widget ) {                             \
57     l->addWidget( new QLabel( qtr( string ) + " :" ), line, 0 ); \
58     widget = new QLineEdit;                                      \
59     l->addWidget( widget, line, 1, 1, 9 );                       \
60     line++;            }
61
62     /* Title, artist and album*/
63     ADD_META( VLC_META_TITLE, title_text ); /* OK */
64     ADD_META( VLC_META_ARTIST, artist_text ); /* OK */
65     ADD_META( VLC_META_COLLECTION, collection_text ); /* OK */
66
67     /* Genre Name */
68     /* FIXME List id3genres.h is not includable yet ? */
69     genre_text = new QLineEdit;
70     l->addWidget( new QLabel( qtr( VLC_META_GENRE ) + " :" ), line, 0 );
71     l->addWidget( genre_text, line, 1, 1, 6 );
72
73     /* Date (Should be in years) */
74     date_text = new QSpinBox; setSpinBounds( date_text );
75     l->addWidget( new QLabel( qtr( VLC_META_DATE ) + " :" ), line, 7 );
76     l->addWidget( date_text, line, 8, 1, 2 );
77     line++;
78
79     /* Number and Rating */
80     l->addWidget( new QLabel( qtr( "Track number/Position" )  + " :" ),
81                   line, 0 );
82     seqnum_text = new QSpinBox; setSpinBounds( seqnum_text );
83     l->addWidget( seqnum_text, line, 1, 1, 4 );
84
85     l->addWidget( new QLabel( qtr( VLC_META_RATING ) + " :" ), line, 5 );
86     rating_text = new QSpinBox; setSpinBounds( rating_text) ;
87     l->addWidget( rating_text, line, 6, 1, 4 );
88     line++;
89
90     /* Now Playing ? */
91     ADD_META( VLC_META_NOW_PLAYING, nowplaying_text );
92
93     /* Language and settings */
94     l->addWidget( new QLabel( qfu( VLC_META_LANGUAGE ) + " :" ), line, 0 );
95     language_text = new QLineEdit;
96     l->addWidget( language_text, line, 1, 1, 4 );
97     l->addWidget( new QLabel( qtr( VLC_META_SETTING ) + " :" ), line, 5 );
98     setting_text = new QLineEdit;
99     l->addWidget( setting_text, line, 6, 1, 4 );
100     line++;
101
102     /* ART_URL */
103     art_cover = new QLabel( "" );
104     art_cover->setMinimumHeight( 128 );
105     art_cover->setMinimumWidth( 128 );
106     art_cover->setMaximumHeight( 128 );
107     art_cover->setMaximumWidth( 128 );
108     art_cover->setScaledContents( true );
109     art_cover->setPixmap( QPixmap( ":/noart.png" ) );
110     l->addWidget( art_cover, line, 8, 4, 2 );
111
112 #define ADD_META_2( string, widget ) {                             \
113     l->addWidget( new QLabel( qtr( string ) + " :" ), line, 0 ); \
114     widget = new QLineEdit;                                      \
115     l->addWidget( widget, line, 1, 1, 7 );                       \
116     line++;            }
117
118     ADD_META_2( VLC_META_COPYRIGHT, copyright_text );
119     ADD_META_2( VLC_META_PUBLISHER, publisher_text );
120
121     ADD_META_2( VLC_META_ENCODED_BY, publisher_text );
122     ADD_META_2( VLC_META_DESCRIPTION, description_text );
123
124     /*  ADD_META( TRACKID )  Useless ? */
125     /*  ADD_URI - DO not show it, done outside */
126
127 #undef ADD_META
128 #undef ADD_META_2
129 }
130
131 MetaPanel::~MetaPanel(){}
132
133 /**
134  * Save the MetaData, triggered by parent->save Button
135  **/
136 void MetaPanel::saveMeta()
137 {
138     playlist_t *p_playlist;
139
140     meta_export_t p_export;
141     p_export.p_item = p_input;
142
143     if( p_input == NULL )
144         return;
145
146     /* we can write meta data only in a file */
147     if( ( p_input->i_type == ITEM_TYPE_AFILE ) || \
148         ( p_input->i_type == ITEM_TYPE_VFILE ) )
149         /* some audio files are detected as video files */
150     {
151         char *psz_uri = p_input->psz_uri;
152         if( !strncmp( psz_uri, "file://", 7 ) )
153             psz_uri += 7; /* strlen("file://") = 7 */
154
155         p_export.psz_file = strndup( psz_uri, PATH_MAX );
156     }
157     else
158         return;
159
160     /* now we read the modified meta data */
161     free( p_input->p_meta->psz_artist );
162     p_input->p_meta->psz_artist = strdup( qtu( artist_text->text() ) );
163     free( p_input->p_meta->psz_album );
164     p_input->p_meta->psz_album = strdup( qtu( collection_text->text() ) );
165     free( p_input->p_meta->psz_genre );
166     p_input->p_meta->psz_genre = strdup( qtu( genre_text->text() ) );
167     free( p_input->p_meta->psz_date );
168     p_input->p_meta->psz_date = (char*) malloc(5);
169     snprintf( p_input->p_meta->psz_date, 5, "%d", date_text->value() );
170     free( p_input->p_meta->psz_tracknum );
171     p_input->p_meta->psz_tracknum = (char*) malloc(5);
172     snprintf( p_input->p_meta->psz_tracknum, 5, "%d", seqnum_text->value() );
173     free( p_input->p_meta->psz_title );
174     p_input->p_meta->psz_title = strdup( qtu( title_text->text() ) );
175
176     p_playlist = pl_Yield( p_intf );
177
178     PL_LOCK;
179     p_playlist->p_private = &p_export;
180
181     module_t *p_mod = module_Need( p_playlist, "meta writer", NULL, 0 );
182     if( p_mod )
183         module_Unneed( p_playlist, p_mod );
184     PL_UNLOCK;
185     pl_Release( p_playlist );
186 }
187
188 /**
189  * Update all the MetaData and art on an "item-changed" event
190  **/
191 void MetaPanel::update( input_item_t *p_item )
192 {
193     char *psz_meta;
194 #define UPDATE_META( meta, widget ) {               \
195     psz_meta = p_item->p_meta->psz_##meta;          \
196     if( !EMPTY_STR( psz_meta ) )                    \
197         widget->setText( qfu( psz_meta ) );         \
198     else                                            \
199         widget->setText( "" ); }
200
201 #define UPDATE_META_INT( meta, widget ) {           \
202     psz_meta = p_item->p_meta->psz_##meta;          \
203     if( !EMPTY_STR( psz_meta ) )                    \
204         widget->setValue( atoi( psz_meta ) ); }
205
206     /* Name / Title */
207     psz_meta = p_item->p_meta->psz_title;
208     if( !EMPTY_STR( psz_meta ) )
209         title_text->setText( qfu( psz_meta ) );
210     else if( !EMPTY_STR( p_item->psz_name ) )
211         title_text->setText( qfu( p_item->psz_name ) );
212     else title_text->setText( "" );
213
214     /* URL / URI */
215     psz_meta = p_item->p_meta->psz_url;
216     if( !EMPTY_STR( psz_meta ) )
217         emit uriSet( QString( psz_meta ) );
218     else if( !EMPTY_STR( p_item->psz_uri ) )
219         emit uriSet( QString( p_item->psz_uri ) );
220
221     /* Other classic though */
222     UPDATE_META( artist, artist_text );
223     UPDATE_META( genre, genre_text );
224     UPDATE_META( copyright, copyright_text );
225     UPDATE_META( album, collection_text );
226     UPDATE_META( description, description_text );
227     UPDATE_META( language, language_text );
228     UPDATE_META( nowplaying, nowplaying_text );
229     UPDATE_META( publisher, publisher_text );
230     UPDATE_META( setting, setting_text );
231
232     UPDATE_META_INT( date, date_text );
233     UPDATE_META_INT( tracknum, seqnum_text );
234     UPDATE_META_INT( rating, rating_text );
235
236 #undef UPDATE_META
237
238     /* Art Urls */
239     psz_meta = p_item->p_meta->psz_arturl;
240     if( psz_meta && !strncmp( psz_meta, "file://", 7 ) )
241     {
242         QString artUrl = qfu( psz_meta ).replace( "file://",QString("" ) );
243         art_cover->setPixmap( QPixmap( artUrl ) );
244     }
245     else
246         art_cover->setPixmap( QPixmap( ":/noart.png" ) );
247 }
248
249 /*
250  * Clear all the metadata widgets
251  * Unused yet
252  */
253 void MetaPanel::clear(){}
254
255 /**
256  * Second Panel - Shows the extra metadata in a tree, non editable.
257  **/
258 ExtraMetaPanel::ExtraMetaPanel( QWidget *parent,
259                                 intf_thread_t *_p_intf )
260                                 : QWidget( parent ), p_intf( _p_intf )
261 {
262      QGridLayout *layout = new QGridLayout(this);
263
264      QLabel *topLabel = new QLabel( qtr( "Extra metadata and other information"
265                  " are shown in this list.\n" ) );
266      topLabel->setWordWrap( true );
267      layout->addWidget( topLabel, 0, 0 );
268
269      extraMetaTree = new QTreeWidget( this );
270      extraMetaTree->setAlternatingRowColors( true );
271      extraMetaTree->setColumnCount( 2 );
272      extraMetaTree->header()->hide();
273 /*     QStringList headerList = ( QStringList() << qtr( "Type" )
274  *                                             << qtr( "Value" ) );
275  * Useless, add this header if you think it would help the user          **
276  */
277
278      layout->addWidget( extraMetaTree, 1, 0 );
279 }
280
281 /**
282  * Update the Extra Metadata from p_meta->i_extras 
283  **/
284 void ExtraMetaPanel::update( input_item_t *p_item )
285 {
286     vlc_meta_t *p_meta = p_item->p_meta;
287     QStringList tempItem;
288
289     QList<QTreeWidgetItem *> items;
290     for (int i = 0; i < p_meta->i_extra; i++ )
291     {
292         tempItem.append( qfu( p_meta->ppsz_extra_name[i] ) + " : ");
293         tempItem.append( qfu( p_meta->ppsz_extra_value[i] ) );
294         items.append( new QTreeWidgetItem ( extraMetaTree, tempItem ) );
295     }
296     extraMetaTree->addTopLevelItems( items );
297 }
298
299 /**
300  * Clear the ExtraMetaData Tree
301  **/
302 void ExtraMetaPanel::clear()
303 {
304     extraMetaTree->clear();
305 }
306
307 /**
308  * Third panel - Stream info
309  * Display all codecs and muxers info that we could gather.
310  **/
311 InfoPanel::InfoPanel( QWidget *parent,
312                       intf_thread_t *_p_intf )
313                       : QWidget( parent ), p_intf( _p_intf )
314 {
315      QGridLayout *layout = new QGridLayout(this);
316
317      QList<QTreeWidgetItem *> items;
318
319      QLabel *topLabel = new QLabel( qtr( "Information about what your media or"
320               " stream is made of.\n Muxer, Audio and Video Codecs, Subtitles "
321               "are shown." ) );
322      topLabel->setWordWrap( true );
323      layout->addWidget( topLabel, 0, 0 );
324
325      InfoTree = new QTreeWidget(this);
326      InfoTree->setColumnCount( 1 );
327      InfoTree->header()->hide();
328      layout->addWidget(InfoTree, 1, 0 );
329 }
330
331 InfoPanel::~InfoPanel()
332 {
333 }
334
335 /**
336  * Update the Codecs information on parent->update()
337  **/
338 void InfoPanel::update( input_item_t *p_item)
339 {
340     InfoTree->clear();
341     QTreeWidgetItem *current_item = NULL;
342     QTreeWidgetItem *child_item = NULL;
343
344     for( int i = 0; i< p_item->i_categories ; i++)
345     {
346         current_item = new QTreeWidgetItem();
347         current_item->setText( 0, qfu(p_item->pp_categories[i]->psz_name) );
348         InfoTree->addTopLevelItem( current_item );
349
350         for( int j = 0 ; j < p_item->pp_categories[i]->i_infos ; j++ )
351         {
352             child_item = new QTreeWidgetItem ();
353             child_item->setText( 0,
354                     qfu(p_item->pp_categories[i]->pp_infos[j]->psz_name)
355                     + ": "
356                     + qfu(p_item->pp_categories[i]->pp_infos[j]->psz_value));
357
358             current_item->addChild(child_item);
359         }
360          InfoTree->setItemExpanded( current_item, true);
361     }
362 }
363
364 /**
365  * Clear the tree
366  **/
367 void InfoPanel::clear()
368 {
369     InfoTree->clear();
370 }
371
372 /**
373  * Save all the information to a file
374  * Not yet implemented.
375  **/
376 /*
377 void InfoPanel::saveCodecsInfo()
378 {
379
380 }
381 */
382
383 /**
384  * Fourth Panel - Stats
385  * Displays the Statistics for reading/streaming/encoding/displaying in a tree
386  */
387 InputStatsPanel::InputStatsPanel( QWidget *parent,
388                                   intf_thread_t *_p_intf )
389                                   : QWidget( parent ), p_intf( _p_intf )
390 {
391      QGridLayout *layout = new QGridLayout(this);
392
393      QList<QTreeWidgetItem *> items;
394
395      QLabel *topLabel = new QLabel( qtr( "Various statistics about the current"
396                  " media or stream.\n Played and streamed info are shown." ) );
397      topLabel->setWordWrap( true );
398      layout->addWidget( topLabel, 0, 0 );
399
400      StatsTree = new QTreeWidget(this);
401      StatsTree->setColumnCount( 3 );
402      StatsTree->header()->hide();
403
404 #define CREATE_TREE_ITEM( itemName, itemText, itemValue, unit ) {              \
405     itemName =                                                                 \
406       new QTreeWidgetItem((QStringList () << itemText << itemValue << unit )); \
407     itemName->setTextAlignment( 1 , Qt::AlignRight ) ; }
408
409 #define CREATE_CATEGORY( catName, itemText ) {                           \
410     CREATE_TREE_ITEM( catName, itemText , "", "" );                      \
411     catName->setExpanded( true );                                        \
412     StatsTree->addTopLevelItem( catName );    }
413
414 #define CREATE_AND_ADD_TO_CAT( itemName, itemText, itemValue, catName, unit ){ \
415     CREATE_TREE_ITEM( itemName, itemText, itemValue, unit );                   \
416     catName->addChild( itemName ); }
417
418     /* Create the main categories */
419     CREATE_CATEGORY( input, qtr("Input") );
420     CREATE_CATEGORY( video, qtr("Video") );
421     CREATE_CATEGORY( streaming, qtr("Streaming") );
422     CREATE_CATEGORY( audio, qtr("Audio") );
423
424     CREATE_AND_ADD_TO_CAT( read_media_stat, qtr("Read at media"),
425                            "0", input , "kB" );
426     CREATE_AND_ADD_TO_CAT( input_bitrate_stat, qtr("Input bitrate"),
427                            "0", input, "kb/s" );
428     CREATE_AND_ADD_TO_CAT( demuxed_stat, qtr("Demuxed"), "0", input, "kB") ;
429     CREATE_AND_ADD_TO_CAT( stream_bitrate_stat, qtr("Stream bitrate"),
430                            "0", input, "kb/s" );
431
432     CREATE_AND_ADD_TO_CAT( vdecoded_stat, qtr("Decoded blocks"),
433                            "0", video, "" );
434     CREATE_AND_ADD_TO_CAT( vdisplayed_stat, qtr("Displayed frames"),
435                            "0", video, "" );
436     CREATE_AND_ADD_TO_CAT( vlost_frames_stat, qtr("Lost frames"),
437                            "0", video, "" );
438
439     CREATE_AND_ADD_TO_CAT( send_stat, qtr("Sent packets"), "0", streaming, "" );
440     CREATE_AND_ADD_TO_CAT( send_bytes_stat, qtr("Sent bytes"),
441                            "0", streaming, "kB" );
442     CREATE_AND_ADD_TO_CAT( send_bitrate_stat, qtr("Sent bitrates"),
443                            "0", streaming, "kb/s" );
444
445     CREATE_AND_ADD_TO_CAT( adecoded_stat, qtr("Decoded blocks"),
446                            "0", audio, "" );
447     CREATE_AND_ADD_TO_CAT( aplayed_stat, qtr("Played buffers"),
448                            "0", audio, "" );
449     CREATE_AND_ADD_TO_CAT( alost_stat, qtr("Lost buffers"), "0", audio, "" );
450
451     input->setExpanded( true );
452     video->setExpanded( true );
453     streaming->setExpanded( true );
454     audio->setExpanded( true );
455
456     StatsTree->resizeColumnToContents( 0 );
457     StatsTree->setColumnWidth( 1 , 100 );
458
459     layout->addWidget(StatsTree, 1, 0 );
460 }
461
462 InputStatsPanel::~InputStatsPanel()
463 {
464 }
465
466 /**
467  * Update the Statistics
468  **/
469 void InputStatsPanel::update( input_item_t *p_item )
470 {
471     vlc_mutex_lock( &p_item->p_stats->lock );
472
473 #define UPDATE( widget, format, calc... ) \
474     { QString str; widget->setText( 1 , str.sprintf( format, ## calc ) );  }
475
476     UPDATE( read_media_stat, "%8.0f",
477             (float)(p_item->p_stats->i_read_bytes)/1000);
478     UPDATE( input_bitrate_stat, "%6.0f",
479                     (float)(p_item->p_stats->f_input_bitrate * 8000 ));
480     UPDATE( demuxed_stat, "%8.0f",
481                     (float)(p_item->p_stats->i_demux_read_bytes)/1000 );
482     UPDATE( stream_bitrate_stat, "%6.0f",
483                     (float)(p_item->p_stats->f_demux_bitrate * 8000 ));
484
485     /* Video */
486     UPDATE( vdecoded_stat, "%5i", p_item->p_stats->i_decoded_video );
487     UPDATE( vdisplayed_stat, "%5i", p_item->p_stats->i_displayed_pictures );
488     UPDATE( vlost_frames_stat, "%5i", p_item->p_stats->i_lost_pictures );
489
490     /* Sout */
491     UPDATE( send_stat, "%5i", p_item->p_stats->i_sent_packets );
492     UPDATE( send_bytes_stat, "%8.0f",
493             (float)(p_item->p_stats->i_sent_bytes)/1000 );
494     UPDATE( send_bitrate_stat, "%6.0f",
495             (float)(p_item->p_stats->f_send_bitrate*8)*1000 );
496
497     /* Audio*/
498     UPDATE( adecoded_stat, "%5i", p_item->p_stats->i_decoded_audio );
499     UPDATE( aplayed_stat, "%5i", p_item->p_stats->i_played_abuffers );
500     UPDATE( alost_stat, "%5i", p_item->p_stats->i_lost_abuffers );
501
502     vlc_mutex_unlock(& p_item->p_stats->lock );
503 }
504
505 void InputStatsPanel::clear()
506 {
507 }
508
509