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>
47 /* Callback prototype */
48 static int PlaylistChanged( vlc_object_t *, const char *,
49 vlc_value_t, vlc_value_t, void * );
50 static int PlaylistNext( vlc_object_t *, const char *,
51 vlc_value_t, vlc_value_t, void * );
52 static int ItemChanged( vlc_object_t *, const char *,
53 vlc_value_t, vlc_value_t, void * );
54 static int ItemAppended( vlc_object_t *p_this, const char *psz_variable,
55 vlc_value_t oval, vlc_value_t nval, void *param );
56 static int ItemDeleted( vlc_object_t *p_this, const char *psz_variable,
57 vlc_value_t oval, vlc_value_t nval, void *param );
59 /*****************************************************************************
61 *****************************************************************************/
63 /* IDs for the controls and the menu commands */
73 DEFINE_LOCAL_EVENT_TYPE( wxEVT_PLAYLIST );
75 BEGIN_EVENT_TABLE(PlaylistManager, wxPanel)
76 /* Tree control events */
77 EVT_TREE_ITEM_ACTIVATED( TreeCtrl_Event, PlaylistManager::OnActivateItem )
80 EVT_COMMAND(-1, wxEVT_PLAYLIST, PlaylistManager::OnPlaylistEvent)
83 /*****************************************************************************
85 ****************************************************************************/
86 class PlaylistItem : public wxTreeItemData
89 PlaylistItem( playlist_item_t *p_item ) : i_id(p_item->input.i_id) {}
93 /*****************************************************************************
95 *****************************************************************************/
96 PlaylistManager::PlaylistManager( intf_thread_t *_p_intf, wxWindow *p_parent ):
97 wxPanel( p_parent, -1, wxDefaultPosition, wxSize(0,0) )
101 b_need_update = VLC_FALSE;
102 i_items_to_append = 0;
103 i_cached_item_id = -1;
104 i_update_counter = 0;
106 p_playlist = (playlist_t *)
107 vlc_object_find( p_intf, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
108 if( p_playlist == NULL ) return;
110 var_Create( p_intf, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
111 var_Create( p_intf, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
112 var_Create( p_intf, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );;
114 /* Create the tree */
115 treectrl = new wxTreeCtrl( this, TreeCtrl_Event,
116 wxDefaultPosition, wxDefaultSize,
117 wxTR_HIDE_ROOT | wxTR_LINES_AT_ROOT|
119 wxTR_HAS_BUTTONS | wxTR_TWIST_BUTTONS |
120 wxTR_MULTIPLE | wxTR_EXTENDED );
122 /* Add everything to the panel */
123 sizer = new wxBoxSizer( wxHORIZONTAL );
125 sizer->Add( treectrl, 1, wxEXPAND );
129 /* Create image list */
130 wxImageList *p_images = new wxImageList( 16 , 16, TRUE );
132 /* FIXME: absolutely needs to be in the right order FIXME */
133 p_images->Add( wxIcon( type_unknown_xpm ) );
134 p_images->Add( wxIcon( type_afile_xpm ) );
135 p_images->Add( wxIcon( type_vfile_xpm ) );
136 p_images->Add( wxIcon( type_directory_xpm ) );
137 p_images->Add( wxIcon( type_disc_xpm ) );
138 p_images->Add( wxIcon( type_cdda_xpm ) );
139 p_images->Add( wxIcon( type_card_xpm ) );
140 p_images->Add( wxIcon( type_net_xpm ) );
141 p_images->Add( wxIcon( type_playlist_xpm ) );
142 p_images->Add( wxIcon( type_node_xpm ) );
143 treectrl->AssignImageList( p_images );
145 /* Reduce font size */
146 wxFont font = treectrl->GetFont(); font.SetPointSize(9);
147 treectrl->SetFont( font );
149 #if wxUSE_DRAG_AND_DROP
150 /* Associate drop targets with the playlist */
151 SetDropTarget( new DragAndDrop( p_intf, VLC_TRUE ) );
154 /* Update the playlist */
158 * We want to be notified of playlist changes
161 /* Some global changes happened -> Rebuild all */
162 var_AddCallback( p_playlist, "intf-change", PlaylistChanged, this );
164 /* We went to the next item */
165 var_AddCallback( p_playlist, "playlist-current", PlaylistNext, this );
167 /* One item has been updated */
168 var_AddCallback( p_playlist, "item-change", ItemChanged, this );
170 var_AddCallback( p_playlist, "item-append", ItemAppended, this );
171 var_AddCallback( p_playlist, "item-deleted", ItemDeleted, this );
174 PlaylistManager::~PlaylistManager()
176 if( p_playlist == NULL ) return;
178 var_DelCallback( p_playlist, "item-change", ItemChanged, this );
179 var_DelCallback( p_playlist, "playlist-current", PlaylistNext, this );
180 var_DelCallback( p_playlist, "intf-change", PlaylistChanged, this );
181 var_DelCallback( p_playlist, "item-append", ItemAppended, this );
182 var_DelCallback( p_playlist, "item-deleted", ItemDeleted, this );
183 vlc_object_release( p_playlist );
186 /*****************************************************************************
187 * PlaylistChanged: callback triggered by the intf-change playlist variable
188 * We don't rebuild the playlist directly here because we don't want the
189 * caller to block for a too long time.
190 *****************************************************************************/
191 static int PlaylistChanged( vlc_object_t *p_this, const char *psz_variable,
192 vlc_value_t oval, vlc_value_t nval, void *param )
194 PlaylistManager *p_playlist = (PlaylistManager *)param;
195 p_playlist->b_need_update = VLC_TRUE;
199 /*****************************************************************************
200 * Next: callback triggered by the playlist-current playlist variable
201 *****************************************************************************/
202 static int PlaylistNext( vlc_object_t *p_this, const char *psz_variable,
203 vlc_value_t oval, vlc_value_t nval, void *param )
205 PlaylistManager *p_playlist = (PlaylistManager *)param;
207 wxCommandEvent event( wxEVT_PLAYLIST, UpdateItem_Event );
208 event.SetInt( oval.i_int );
209 p_playlist->AddPendingEvent( event );
210 event.SetInt( nval.i_int );
211 p_playlist->AddPendingEvent( event );
216 /*****************************************************************************
218 *****************************************************************************/
219 void PlaylistManager::CreateNode( playlist_item_t *p_node, wxTreeItemId parent)
222 treectrl->AppendItem( parent, wxL2U( p_node->input.psz_name ), -1, -1,
223 new PlaylistItem( p_node ) );
224 treectrl->SetItemImage( node, p_node->input.i_type );
226 UpdateNodeChildren( p_node, node );
229 void PlaylistManager::UpdateNode( playlist_item_t *p_node, wxTreeItemId node )
231 wxTreeItemIdValue cookie;
234 for( int i = 0; i < p_node->i_children ; i++ )
236 if( !i ) child = treectrl->GetFirstChild( node, cookie);
237 else child = treectrl->GetNextChild( node, cookie );
241 /* Not enough children */
242 CreateNode( p_node->pp_children[i], node );
243 /* Keep the tree pointer up to date */
244 child = treectrl->GetNextChild( node, cookie );
248 treectrl->SetItemImage( node, p_node->input.i_type );
252 void PlaylistManager::UpdateNodeChildren( playlist_item_t *p_node,
255 for( int i = 0; i< p_node->i_children ; i++ )
257 /* Append the item */
258 if( p_node->pp_children[i]->i_children == -1 )
261 treectrl->AppendItem( node,
262 wxL2U( p_node->pp_children[i]->input.psz_name ), -1,-1,
263 new PlaylistItem( p_node->pp_children[i]) );
265 UpdateTreeItem( item );
269 CreateNode( p_node->pp_children[i], node );
274 void PlaylistManager::UpdateTreeItem( wxTreeItemId item )
276 if( ! item.IsOk() ) return;
278 wxTreeItemData *p_data = treectrl->GetItemData( item );
279 if( !p_data ) return;
281 LockPlaylist( p_intf->p_sys, p_playlist );
282 playlist_item_t *p_item =
283 playlist_ItemGetById( p_playlist, ((PlaylistItem *)p_data)->i_id );
286 UnlockPlaylist( p_intf->p_sys, p_playlist );
291 wxString duration = wxU( "" );
293 vlc_input_item_GetInfo( &p_item->input,
294 _("Meta-information"), _("Artist"));
297 UnlockPlaylist( p_intf->p_sys, p_playlist );
301 char psz_duration[MSTRTIME_MAX_SIZE];
302 mtime_t dur = p_item->input.i_duration;
306 secstotimestr( psz_duration, dur/1000000 );
307 duration.Append( wxU( " ( " ) + wxString( wxU( psz_duration ) ) +
311 if( !strcmp( psz_author, "" ) || p_item->input.b_fixed_name == VLC_TRUE )
313 msg = wxString( wxU( p_item->input.psz_name ) ) + duration;
317 msg = wxString(wxU( psz_author )) + wxT(" - ") +
318 wxString(wxU(p_item->input.psz_name)) + duration;
321 treectrl->SetItemText( item , msg );
322 treectrl->SetItemImage( item, p_item->input.i_type );
324 if( p_playlist->status.p_item == p_item )
326 treectrl->SetItemBold( item, true );
327 while( treectrl->GetItemParent( item ).IsOk() )
329 item = treectrl->GetItemParent( item );
330 treectrl->Expand( item );
335 treectrl->SetItemBold( item, false );
337 UnlockPlaylist( p_intf->p_sys, p_playlist );
340 void PlaylistManager::AppendItem( wxCommandEvent& event )
342 playlist_add_t *p_add = (playlist_add_t *)event.GetClientData();
343 playlist_item_t *p_item = NULL;
344 wxTreeItemId item, node;
348 /* No need to do anything if the playlist is going to be rebuilt */
349 if( b_need_update ) return;
351 //if( p_add->i_view != i_current_view ) goto update;
353 node = FindItem( treectrl->GetRootItem(), p_add->i_node );
354 if( !node.IsOk() ) goto update;
356 p_item = playlist_ItemGetById( p_playlist, p_add->i_item );
357 if( !p_item ) goto update;
359 item = FindItem( treectrl->GetRootItem(), p_add->i_item );
360 if( item.IsOk() ) goto update;
362 item = treectrl->AppendItem( node, wxL2U( p_item->input.psz_name ), -1,-1,
363 new PlaylistItem( p_item ) );
364 treectrl->SetItemImage( item, p_item->input.i_type );
366 if( item.IsOk() && p_item->i_children == -1 ) UpdateTreeItem( item );
372 void PlaylistManager::UpdateItem( int i )
374 if( i < 0 ) return; /* Sanity check */
376 wxTreeItemId item = FindItem( treectrl->GetRootItem(), i );
377 if( item.IsOk() ) UpdateTreeItem( item );
380 void PlaylistManager::RemoveItem( int i )
382 if( i <= 0 ) return; /* Sanity check */
384 wxTreeItemId item = FindItem( treectrl->GetRootItem(), i );
387 treectrl->Delete( item );
389 /* Invalidate cache */
390 i_cached_item_id = -1;
394 /* This function is called on a regular basis */
395 void PlaylistManager::Update()
399 /* If the playlist isn't show there's no need to update it */
400 if( !IsShown() ) return;
402 if( this->b_need_update )
404 this->b_need_update = VLC_FALSE;
408 /* Updating the playing status every 0.5s is enough */
409 if( i_update_counter % 5 ) return;
412 /**********************************************************************
413 * Rebuild the playlist
414 **********************************************************************/
415 void PlaylistManager::Rebuild( vlc_bool_t b_root )
417 playlist_view_t *p_view;
419 i_items_to_append = 0;
420 i_cached_item_id = -1;
422 p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
424 treectrl->DeleteAllItems();
425 treectrl->AddRoot( wxU(_("root" )), -1, -1,
426 new PlaylistItem( p_view->p_root ) );
428 wxTreeItemId root = treectrl->GetRootItem();
429 UpdateNode( p_view->p_root, root );
432 /**********************************************************************
433 * Search functions (internal)
434 **********************************************************************/
436 /* Find a wxItem from a playlist id */
437 wxTreeItemId PlaylistManager::FindItem( wxTreeItemId root, int i_id )
439 wxTreeItemIdValue cookie;
440 PlaylistItem *p_wxcurrent;
441 wxTreeItemId dummy, search, item, child;
443 if( i_id < 0 ) return dummy;
444 if( i_cached_item_id == i_id ) return cached_item;
446 p_wxcurrent = (PlaylistItem *)treectrl->GetItemData( root );
447 if( !p_wxcurrent ) return dummy;
449 if( p_wxcurrent->i_id == i_id )
451 i_cached_item_id = i_id;
456 item = treectrl->GetFirstChild( root, cookie );
459 p_wxcurrent = (PlaylistItem *)treectrl->GetItemData( item );
462 item = treectrl->GetNextChild( root, cookie );
466 if( p_wxcurrent->i_id == i_id )
468 i_cached_item_id = i_id;
473 if( treectrl->ItemHasChildren( item ) )
475 wxTreeItemId search = FindItem( item, i_id );
476 if( search.IsOk() ) return search;
479 item = treectrl->GetNextChild( root, cookie );
485 /********************************************************************
487 ********************************************************************/
488 void PlaylistManager::OnActivateItem( wxTreeEvent& event )
490 playlist_item_t *p_item, *p_node;
491 wxTreeItemId parent = treectrl->GetItemParent( event.GetItem() );
492 PlaylistItem *p_wxitem = (PlaylistItem *)
493 treectrl->GetItemData( event.GetItem() );
495 if( !p_wxitem || !parent.IsOk() ) return;
497 PlaylistItem *p_wxparent = (PlaylistItem *)treectrl->GetItemData( parent );
498 if( !p_wxparent ) return;
500 LockPlaylist( p_intf->p_sys, p_playlist );
501 p_item = playlist_ItemGetById( p_playlist, p_wxitem->i_id );
502 p_node = playlist_ItemGetById( p_playlist, p_wxparent->i_id );
503 if( !p_item || p_item->i_children >= 0 )
509 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY, VIEW_CATEGORY,
511 UnlockPlaylist( p_intf->p_sys, p_playlist );
514 void PlaylistManager::OnPlaylistEvent( wxCommandEvent& event )
516 switch( event.GetId() )
518 case UpdateItem_Event:
519 UpdateItem( event.GetInt() );
521 case AppendItem_Event:
524 case RemoveItem_Event:
525 RemoveItem( event.GetInt() );
530 /*****************************************************************************
531 * ItemChanged: callback triggered by the item-change playlist variable
532 *****************************************************************************/
533 static int ItemChanged( vlc_object_t *p_this, const char *psz_variable,
534 vlc_value_t old_val, vlc_value_t new_val, void *param )
536 PlaylistManager *p_playlist = (PlaylistManager *)param;
538 wxCommandEvent event( wxEVT_PLAYLIST, UpdateItem_Event );
539 event.SetInt( new_val.i_int );
540 p_playlist->AddPendingEvent( event );
544 static int ItemDeleted( vlc_object_t *p_this, const char *psz_variable,
545 vlc_value_t old_val, vlc_value_t new_val, void *param )
547 PlaylistManager *p_playlist = (PlaylistManager *)param;
549 wxCommandEvent event( wxEVT_PLAYLIST, RemoveItem_Event );
550 event.SetInt( new_val.i_int );
551 p_playlist->AddPendingEvent( event );
556 static int ItemAppended( vlc_object_t *p_this, const char *psz_variable,
557 vlc_value_t oval, vlc_value_t nval, void *param )
559 PlaylistManager *p_playlist = (PlaylistManager *)param;
561 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
562 memcpy( p_add, nval.p_address, sizeof( playlist_add_t ) );
564 if( p_playlist->i_items_to_append++ > 50 )
566 /* Too many items waiting to be added, it will be quicker to rebuild
567 * the whole playlist */
568 p_playlist->b_need_update = VLC_TRUE;
572 wxCommandEvent event( wxEVT_PLAYLIST, AppendItem_Event );
573 event.SetClientData( (void *)p_add );
574 p_playlist->AddPendingEvent( event );