1 /*****************************************************************************
2 * playlist_manager.cpp : wxWindows plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2005 the VideoLAN team
7 * Authors: Olivier Teulière <ipkiss@via.ecp.fr>
8 * Clément Stenac <zorglub@videolan.org>
9 * Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/OR MODIFy
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
29 #include "playlist_manager.hpp"
30 #include "interface.hpp"
32 #include "bitmaps/type_unknown.xpm"
33 #include "bitmaps/type_afile.xpm"
34 #include "bitmaps/type_vfile.xpm"
35 #include "bitmaps/type_net.xpm"
36 #include "bitmaps/type_card.xpm"
37 #include "bitmaps/type_disc.xpm"
38 #include "bitmaps/type_cdda.xpm"
39 #include "bitmaps/type_directory.xpm"
40 #include "bitmaps/type_playlist.xpm"
41 #include "bitmaps/type_node.xpm"
43 #include <wx/dynarray.h>
44 #include <wx/imaglist.h>
48 /* Callback prototype */
49 static int PlaylistChanged( vlc_object_t *, const char *,
50 vlc_value_t, vlc_value_t, void * );
51 static int PlaylistNext( vlc_object_t *, const char *,
52 vlc_value_t, vlc_value_t, void * );
53 static int ItemChanged( vlc_object_t *, const char *,
54 vlc_value_t, vlc_value_t, void * );
55 static int ItemAppended( vlc_object_t *p_this, const char *psz_variable,
56 vlc_value_t oval, vlc_value_t nval, void *param );
57 static int ItemDeleted( vlc_object_t *p_this, const char *psz_variable,
58 vlc_value_t oval, vlc_value_t nval, void *param );
60 /*****************************************************************************
62 *****************************************************************************/
64 /* IDs for the controls and the menu commands */
74 DEFINE_LOCAL_EVENT_TYPE( wxEVT_PLAYLIST );
76 BEGIN_EVENT_TABLE(PlaylistManager, wxPanel)
77 /* Tree control events */
78 EVT_TREE_ITEM_ACTIVATED( TreeCtrl_Event, PlaylistManager::OnActivateItem )
81 EVT_COMMAND(-1, wxEVT_PLAYLIST, PlaylistManager::OnPlaylistEvent)
84 /*****************************************************************************
86 ****************************************************************************/
87 class PlaylistItem : public wxTreeItemData
90 PlaylistItem( playlist_item_t *p_item ) : i_id(p_item->p_input->i_id) {}
94 /*****************************************************************************
96 *****************************************************************************/
97 PlaylistManager::PlaylistManager( intf_thread_t *_p_intf, wxWindow *p_parent ):
98 wxPanel( p_parent, -1, wxDefaultPosition, wxSize(0,0) )
100 /* Initializations */
102 b_need_update = VLC_FALSE;
103 i_items_to_append = 0;
104 i_cached_item_id = -1;
105 i_update_counter = 0;
107 p_playlist = (playlist_t *)
108 vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
109 if( p_playlist == NULL ) return;
111 var_Create( p_intf, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
112 var_Create( p_intf, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
113 var_Create( p_intf, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );;
115 /* Create the tree */
116 treectrl = new wxTreeCtrl( this, TreeCtrl_Event,
117 wxDefaultPosition, wxDefaultSize,
118 wxTR_HIDE_ROOT | wxTR_LINES_AT_ROOT|
120 wxTR_HAS_BUTTONS | wxTR_TWIST_BUTTONS |
121 wxTR_MULTIPLE | wxTR_EXTENDED );
123 /* Add everything to the panel */
124 sizer = new wxBoxSizer( wxHORIZONTAL );
126 sizer->Add( treectrl, 1, wxEXPAND );
130 /* Create image list */
131 wxImageList *p_images = new wxImageList( 16 , 16, TRUE );
133 /* FIXME: absolutely needs to be in the right order FIXME */
134 p_images->Add( wxIcon( type_unknown_xpm ) );
135 p_images->Add( wxIcon( type_afile_xpm ) );
136 p_images->Add( wxIcon( type_vfile_xpm ) );
137 p_images->Add( wxIcon( type_directory_xpm ) );
138 p_images->Add( wxIcon( type_disc_xpm ) );
139 p_images->Add( wxIcon( type_cdda_xpm ) );
140 p_images->Add( wxIcon( type_card_xpm ) );
141 p_images->Add( wxIcon( type_net_xpm ) );
142 p_images->Add( wxIcon( type_playlist_xpm ) );
143 p_images->Add( wxIcon( type_node_xpm ) );
144 treectrl->AssignImageList( p_images );
146 /* Reduce font size */
147 wxFont font = treectrl->GetFont(); font.SetPointSize(9);
148 treectrl->SetFont( font );
150 #if wxUSE_DRAG_AND_DROP
151 /* Associate drop targets with the playlist */
152 SetDropTarget( new DragAndDrop( p_intf, VLC_TRUE ) );
155 /* Update the playlist */
159 * We want to be notified of playlist changes
162 /* Some global changes happened -> Rebuild all */
163 var_AddCallback( p_playlist, "intf-change", PlaylistChanged, this );
165 /* We went to the next item */
166 var_AddCallback( p_playlist, "playlist-current", PlaylistNext, this );
168 /* One item has been updated */
169 var_AddCallback( p_playlist, "item-change", ItemChanged, this );
171 var_AddCallback( p_playlist, "item-append", ItemAppended, this );
172 var_AddCallback( p_playlist, "item-deleted", ItemDeleted, this );
175 PlaylistManager::~PlaylistManager()
177 if( p_playlist == NULL ) return;
179 var_DelCallback( p_playlist, "item-change", ItemChanged, this );
180 var_DelCallback( p_playlist, "playlist-current", PlaylistNext, this );
181 var_DelCallback( p_playlist, "intf-change", PlaylistChanged, this );
182 var_DelCallback( p_playlist, "item-append", ItemAppended, this );
183 var_DelCallback( p_playlist, "item-deleted", ItemDeleted, this );
184 vlc_object_release( p_playlist );
187 /*****************************************************************************
188 * PlaylistChanged: callback triggered by the intf-change playlist variable
189 * We don't rebuild the playlist directly here because we don't want the
190 * caller to block for a too long time.
191 *****************************************************************************/
192 static int PlaylistChanged( vlc_object_t *p_this, const char *psz_variable,
193 vlc_value_t oval, vlc_value_t nval, void *param )
195 PlaylistManager *p_playlist = (PlaylistManager *)param;
196 p_playlist->b_need_update = VLC_TRUE;
200 /*****************************************************************************
201 * Next: callback triggered by the playlist-current playlist variable
202 *****************************************************************************/
203 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
204 vlc_value_t oval, vlc_value_t nval, void *param )
206 PlaylistManager *p_playlist = (PlaylistManager *)param;
208 wxCommandEvent event( wxEVT_PLAYLIST, UpdateItem_Event );
209 event.SetInt( oval.i_int );
210 p_playlist->AddPendingEvent( event );
211 event.SetInt( nval.i_int );
212 p_playlist->AddPendingEvent( event );
217 /*****************************************************************************
219 *****************************************************************************/
220 void PlaylistManager::CreateNode( playlist_item_t *p_node, wxTreeItemId parent)
223 treectrl->AppendItem( parent, wxL2U( p_node->p_input->psz_name ), -1, -1,
224 new PlaylistItem( p_node ) );
225 treectrl->SetItemImage( node, p_node->p_input->i_type );
227 UpdateNodeChildren( p_node, node );
230 void PlaylistManager::UpdateNode( playlist_item_t *p_node, wxTreeItemId node )
232 wxTreeItemIdValue cookie;
235 for( int i = 0; i < p_node->i_children ; i++ )
237 if( !i ) child = treectrl->GetFirstChild( node, cookie);
238 else child = treectrl->GetNextChild( node, cookie );
242 /* Not enough children */
243 CreateNode( p_node->pp_children[i], node );
244 /* Keep the tree pointer up to date */
245 child = treectrl->GetNextChild( node, cookie );
249 treectrl->SetItemImage( node, p_node->p_input->i_type );
253 void PlaylistManager::UpdateNodeChildren( playlist_item_t *p_node,
256 for( int i = 0; i< p_node->i_children ; i++ )
258 /* Append the item */
259 if( p_node->pp_children[i]->i_children == -1 )
262 treectrl->AppendItem( node,
263 wxL2U( p_node->pp_children[i]->p_input->psz_name ), -1,-1,
264 new PlaylistItem( p_node->pp_children[i]) );
266 UpdateTreeItem( item );
270 CreateNode( p_node->pp_children[i], node );
275 void PlaylistManager::UpdateTreeItem( wxTreeItemId item )
277 if( ! item.IsOk() ) return;
279 wxTreeItemData *p_data = treectrl->GetItemData( item );
280 if( !p_data ) return;
282 LockPlaylist( p_intf->p_sys, p_playlist );
283 playlist_item_t *p_item =
284 playlist_ItemGetById( p_playlist, ((PlaylistItem *)p_data)->i_id );
287 UnlockPlaylist( p_intf->p_sys, p_playlist );
292 wxString duration = wxU( "" );
293 char *psz_author = p_item->p_input->p_meta->psz_artist ?
294 strdup( p_item->p_input->p_meta->psz_artist ) :
298 UnlockPlaylist( p_intf->p_sys, p_playlist );
302 char psz_duration[MSTRTIME_MAX_SIZE];
303 mtime_t dur = p_item->p_input->i_duration;
307 secstotimestr( psz_duration, dur/1000000 );
308 duration.Append( wxU( " ( " ) + wxString( wxU( psz_duration ) ) +
312 if( !strcmp( psz_author, "" ) || p_item->p_input->b_fixed_name == VLC_TRUE )
314 msg = wxString( wxU( p_item->p_input->psz_name ) ) + duration;
318 msg = wxString(wxU( psz_author )) + wxT(" - ") +
319 wxString(wxU(p_item->p_input->psz_name)) + duration;
322 treectrl->SetItemText( item , msg );
323 treectrl->SetItemImage( item, p_item->p_input->i_type );
325 if( p_playlist->status.p_item == p_item )
327 treectrl->SetItemBold( item, true );
328 while( treectrl->GetItemParent( item ).IsOk() )
330 item = treectrl->GetItemParent( item );
331 treectrl->Expand( item );
336 treectrl->SetItemBold( item, false );
338 UnlockPlaylist( p_intf->p_sys, p_playlist );
341 void PlaylistManager::AppendItem( wxCommandEvent& event )
343 playlist_add_t *p_add = (playlist_add_t *)event.GetClientData();
344 playlist_item_t *p_item = NULL;
345 wxTreeItemId item, node;
349 /* No need to do anything if the playlist is going to be rebuilt */
350 if( b_need_update ) return;
352 //if( p_add->i_view != i_current_view ) goto update;
354 node = FindItem( treectrl->GetRootItem(), p_add->i_node );
355 if( !node.IsOk() ) goto update;
357 p_item = playlist_ItemGetById( p_playlist, p_add->i_item );
358 if( !p_item ) goto update;
360 item = FindItem( treectrl->GetRootItem(), p_add->i_item );
361 if( item.IsOk() ) goto update;
363 item = treectrl->AppendItem( node, wxL2U( p_item->p_input->psz_name ), -1,-1,
364 new PlaylistItem( p_item ) );
365 treectrl->SetItemImage( item, p_item->p_input->i_type );
367 if( item.IsOk() && p_item->i_children == -1 ) UpdateTreeItem( item );
373 void PlaylistManager::UpdateItem( int i )
375 if( i < 0 ) return; /* Sanity check */
377 wxTreeItemId item = FindItem( treectrl->GetRootItem(), i );
378 if( item.IsOk() ) UpdateTreeItem( item );
381 void PlaylistManager::RemoveItem( int i )
383 if( i <= 0 ) return; /* Sanity check */
385 wxTreeItemId item = FindItem( treectrl->GetRootItem(), i );
388 treectrl->Delete( item );
390 /* Invalidate cache */
391 i_cached_item_id = -1;
395 /* This function is called on a regular basis */
396 void PlaylistManager::Update()
400 /* If the playlist isn't show there's no need to update it */
401 if( !IsShown() ) return;
403 if( this->b_need_update )
405 this->b_need_update = VLC_FALSE;
409 /* Updating the playing status every 0.5s is enough */
410 if( i_update_counter % 5 ) return;
413 /**********************************************************************
414 * Rebuild the playlist
415 **********************************************************************/
416 void PlaylistManager::Rebuild( vlc_bool_t b_root )
418 i_items_to_append = 0;
419 i_cached_item_id = -1;
421 treectrl->DeleteAllItems();
422 treectrl->AddRoot( wxU(_("root" )), -1, -1,
423 new PlaylistItem( p_playlist->p_root_category ) );
425 wxTreeItemId root = treectrl->GetRootItem();
426 UpdateNode( p_playlist->p_root_category, root );
429 /**********************************************************************
430 * Search functions (internal)
431 **********************************************************************/
433 /* Find a wxItem from a playlist id */
434 wxTreeItemId PlaylistManager::FindItem( wxTreeItemId root, int i_id )
436 wxTreeItemIdValue cookie;
437 PlaylistItem *p_wxcurrent;
438 wxTreeItemId dummy, search, item, child;
440 if( i_id < 0 ) return dummy;
441 if( i_cached_item_id == i_id ) return cached_item;
443 p_wxcurrent = (PlaylistItem *)treectrl->GetItemData( root );
444 if( !p_wxcurrent ) return dummy;
446 if( p_wxcurrent->i_id == i_id )
448 i_cached_item_id = i_id;
453 item = treectrl->GetFirstChild( root, cookie );
456 p_wxcurrent = (PlaylistItem *)treectrl->GetItemData( item );
459 item = treectrl->GetNextChild( root, cookie );
463 if( p_wxcurrent->i_id == i_id )
465 i_cached_item_id = i_id;
470 if( treectrl->ItemHasChildren( item ) )
472 wxTreeItemId search = FindItem( item, i_id );
473 if( search.IsOk() ) return search;
476 item = treectrl->GetNextChild( root, cookie );
482 /********************************************************************
484 ********************************************************************/
485 void PlaylistManager::OnActivateItem( wxTreeEvent& event )
487 playlist_item_t *p_item, *p_node;
488 wxTreeItemId parent = treectrl->GetItemParent( event.GetItem() );
489 PlaylistItem *p_wxitem = (PlaylistItem *)
490 treectrl->GetItemData( event.GetItem() );
492 if( !p_wxitem || !parent.IsOk() ) return;
494 PlaylistItem *p_wxparent = (PlaylistItem *)treectrl->GetItemData( parent );
495 if( !p_wxparent ) return;
497 LockPlaylist( p_intf->p_sys, p_playlist );
498 p_item = playlist_ItemGetById( p_playlist, p_wxitem->i_id );
499 p_node = playlist_ItemGetById( p_playlist, p_wxparent->i_id );
500 if( !p_item || p_item->i_children >= 0 )
505 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY, p_node, p_item );
506 UnlockPlaylist( p_intf->p_sys, p_playlist );
509 void PlaylistManager::OnPlaylistEvent( wxCommandEvent& event )
511 switch( event.GetId() )
513 case UpdateItem_Event:
514 UpdateItem( event.GetInt() );
516 case AppendItem_Event:
519 case RemoveItem_Event:
520 RemoveItem( event.GetInt() );
525 /*****************************************************************************
526 * ItemChanged: callback triggered by the item-change playlist variable
527 *****************************************************************************/
528 static int ItemChanged( vlc_object_t *p_this, const char *psz_variable,
529 vlc_value_t old_val, vlc_value_t new_val, void *param )
531 PlaylistManager *p_playlist = (PlaylistManager *)param;
533 wxCommandEvent event( wxEVT_PLAYLIST, UpdateItem_Event );
534 event.SetInt( new_val.i_int );
535 p_playlist->AddPendingEvent( event );
539 static int ItemDeleted( vlc_object_t *p_this, const char *psz_variable,
540 vlc_value_t old_val, vlc_value_t new_val, void *param )
542 PlaylistManager *p_playlist = (PlaylistManager *)param;
544 wxCommandEvent event( wxEVT_PLAYLIST, RemoveItem_Event );
545 event.SetInt( new_val.i_int );
546 p_playlist->AddPendingEvent( event );
551 static int ItemAppended( vlc_object_t *p_this, const char *psz_variable,
552 vlc_value_t oval, vlc_value_t nval, void *param )
554 PlaylistManager *p_playlist = (PlaylistManager *)param;
556 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
557 memcpy( p_add, nval.p_address, sizeof( playlist_add_t ) );
559 if( ++p_playlist->i_items_to_append >= 50 )
561 /* Too many items waiting to be added, it will be quicker to rebuild
562 * the whole playlist */
563 p_playlist->b_need_update = VLC_TRUE;
567 wxCommandEvent event( wxEVT_PLAYLIST, AppendItem_Event );
568 event.SetClientData( (void *)p_add );
569 p_playlist->AddPendingEvent( event );