diff options
Diffstat (limited to 'vdr_menu.h')
| -rw-r--r-- | vdr_menu.h | 386 |
1 files changed, 302 insertions, 84 deletions
@@ -1,10 +1,10 @@ -/*! +/*! * \file vdr_menu.h * \brief Implements menu handling for broswing media libraries within VDR * * \version $Revision: 1.13 $ * \date $Date$ - * \author Ralf Klueber, Lars von Wedel, Andreas Kellner + * \author Ralf Klueber, Lars von Wedel, Andreas Kellner, Wolfgang Rohdewald * \author Responsible author: $Author$ * * $Id$ @@ -18,106 +18,324 @@ #include <vector> #include <osd.h> +#include <plugin.h> +#include <status.h> #include "i18n.h" +#include "mg_actions.h" + +#include "vdr_player.h" + +using namespace std; + +//! \brief play a selection, aborting what is currently played +//! \param select if true, play only what the current position selects +void Play(mgSelection *sel,const bool select=false); class cCommands; -class mgMedia; -class mgSelectionTreeNode; -class mgPlaylist; -class mgTracklist; +class mgSelection; +class mgMenu; +class mgMainMenu; + +//! \brief if a player is running, return it +mgPlayerControl * PlayerControl (); + +//! \brief callback class, monitors state changes in vdr +class mgStatus : public cStatus +{ + private: + //! \brief the mgMainMenu that wants to be notified + mgMainMenu *main; + public: + //! \brief default constructor + mgStatus(mgMainMenu* m) { main = m;IgnoreNextEventOn=NULL;} + /*! \brief vdr calls OsdCurrentItem more often than we + * want. This tells mgStatus to ignore the next call + * for a specific item. + * \todo is this behaviour intended or a bug in vdr + * or in muggle ? + */ + cOsdItem* IgnoreNextEventOn; + protected: + //! \brief the event we want to know about + virtual void OsdCurrentItem(const char *Text); +}; + /*! - * \brief a special menu item + * \brief the muggle main OSD */ -class mgMenuTreeItem : public cOsdItem + +class mgMainMenu:public cOsdMenu { - public: + private: + mgSelection m_treesel; + mgSelection m_playsel; + mgSelection m_collectionsel; + char *m_message; + void showMessage(); + public: + //! \brief syntactic sugar: expose the protected cOsdMenu::SetHelp + void SetHelpKeys(const char *Red,const char *Green, const char *Yellow, const char *Blue) { SetHelp(Red,Green,Yellow,Blue); } + + //! \brief callback object, lets vdr notify us about OSD changes + mgStatus *m_Status; + + //! \brief play the play selection, abort ongoing instant play + void PlayQueue(); + + //! \brief instant play the selection, abort ongoing queue playing + void PlayInstant(const bool select=false); + + //! \brief true if we are browsing m_collectionsel + bool UsingCollection; + + //! \brief the different menus, the last one is active + vector < mgMenu * >Menus; + + //! \brief true if an item from the "playing" selection is being played + bool queue_playing; + + //! \brief true if an item is being instant played + bool instant_playing; + + //! \brief parent menu if any + mgMenu * Parent (); + + //! \brief default constructor + mgMainMenu (); + + //! \brief default destructor + ~mgMainMenu (); + + //! \brief save the entire muggle state + void SaveState(); + + //! \brief adds a new mgMenu to the stack + void AddMenu (mgMenu * m); + + //! \brief initializes using values from nv + void InitMapFromSetup (mgValmap& nv); + + //! \brief main entry point, called from vdr + eOSState ProcessKey (eKeys Key); + + //! \brief from now on use the normal selection + void UseNormalSelection () + { + UsingCollection= false; + } + + //! \brief from now on use the collection selection + void UseCollectionSelection () + { + UsingCollection= true; + } + + //! \brief this is the collection things will be added to + string default_collection; + +/*! \brief this is the "now playing" collection translated in + * the current language. When changing the OSD language, this + * collection will NOT be renamed in the data base, but a new + * empty collection will be started. The collection for the + * previous language will stay, so the user can copy from the + * old one to the new one. + */ + string play_collection; + +/*! \brief selects a certain line on the OSD and displays the OSD + * \param select the line that we want to be selected + */ + void DisplayGoto (unsigned int select); + + //! \brief external commands + cCommands *external_commands; + + //! \brief Actions can set newmenu which will then be displayed next + mgMenu *newmenu; + + //! \brief Actions can set newstate which will then be returned to main vdr + eOSState newstate; - mgMenuTreeItem( mgSelectionTreeNode *node ); + //! \brief Actions can set forcerefresh. This will force a redisplay of the OSD + bool forcerefresh; - mgSelectionTreeNode *Node(); + //! \brief show a message. Can be called by actions. It will + // only be shown at the end of the next mgMainMenu::ProcessKey + // because that might do forcerefresh which overwrites the message + void Message (const char *msg) { m_message = strdup(msg); } + void Message1 (const char *msg, const char *arg1); + void Message1 (const char *msg, string arg1) { Message1(msg,arg1.c_str()); } - void Set(); + //! \brief Actions can request a new position. -1 means none wanted + int newposition; - private: + //! \brief clears the screen, sets a title and buttons with text on them + void InitOsd (const char *title,const bool hashotkeys); - mgSelectionTreeNode *m_node; + //! \brief expose the protected DisplayMenu() from cOsdMenu + cSkinDisplayMenu *DisplayMenu(void) + { + return cOsdMenu::DisplayMenu(); + } + + //! \brief expose the protected cOsdMenu::hk() + const char *hk (const char *s) + { + return cOsdMenu::hk (s); + } + + //! \brief the current selection + mgSelection* selection () + { + if (UsingCollection) + return &m_collectionsel; + else + return &m_treesel; + } + + //! \brief the collection selection + mgSelection* collselection() + { + return &m_collectionsel; + } + +//! \brief the "now playing" selection + mgSelection* playselection () + { + return &m_playsel; + } + +//! \brief true if the cursor is placed in the collection list + bool ShowingCollections(); + +//! \brief true if the cursor is placed on the default collection + bool DefaultCollectionSelected(); + +//! \brief true if the cursor is placed in the default collection + bool DefaultCollectionEntered(); }; -/*! - * \brief the muggle main OSD +//! \brief a generic muggle menu +class mgMenu +{ + private: + mgMainMenu* m_osd; + protected: +//! \brief adds the wanted action to the OSD menu +// \param hotkey if true, add this as a hotkey + void AddAction(const mgActions action, const bool hotkey=true); + + //! \brief add an external action, always with hotkey + void AddExternalAction(const mgActions action, const char *title); + +//! \brief adds entries for all selected data base items to the OSD menu. +// If this is the list of collections, appends a command for collection +// creation. + void AddSelectionItems (); + //! \brief the name of the blue button depends of where we are + const char *mgMenu::BlueName (); + public: + /*! sets the correct help keys. + * \todo without data from mysql, no key is shown, + * not even yellow or blue + */ + void SetHelpKeys(); +//! \brief generates an object for the wanted action + mgOsdItem* GenerateAction(const mgActions action); + +//! \brief executes the wanted action + void ExecuteAction (const mgActions action); + +//! \brief sets the pointer to the owning mgMainMenu + void setosd (mgMainMenu* osd) + { + m_osd = osd; + } + +//! \brief the pointer to the owning mgMainMenu + mgMainMenu* osd () + { + return m_osd; + } + +//! \brief the currently active selection of the owning mgMainMenu + mgSelection* selection () + { + return osd ()->selection (); + } +//! \brief the playselection of the owning mgMainMenu + mgSelection* playselection () + { + return osd ()->playselection (); + } + + mgMenu (); + + virtual ~ mgMenu () + { + } + +//! \brief clears the screen, sets a title and buttons with text on them + void InitOsd (const char *title,const bool hashotkeys=true); + +//! \brief display OSD and go to position + void Display (const unsigned int position); + +//! \brief BuildOsd() should be abstract but then we cannot compile + virtual void BuildOsd () + { + } + +/*! \brief Process() should be abstract but then we cannot compile. + * \return Process may decide that we want another screen to be displayed. + * If the mgMenu* returned is not "this", the caller will use the return + * value for a new display. If NULL is returned, the caller will display + * the previous menu. */ -class mgMainMenu : public cOsdMenu + virtual eOSState Process (eKeys Key) + { + return osUnknown; + } + +//! \brief the ID of the action defined by the red button. + mgActions TreeRedAction; + mgActions CollRedAction; + +//! \brief the ID of the action defined by the green button. + mgActions TreeGreenAction; + mgActions CollGreenAction; + +//! \brief the action defined by the yellow button. + mgActions TreeYellowAction; + mgActions CollYellowAction; +}; + +//! \brief an mgMenu class for navigating through the data base +class mgTree:public mgMenu +{ + public: + eOSState Process (eKeys Key); + protected: + void BuildOsd (); +}; + +//! \brief an mgMenu class for submenus +class mgSubmenu:public mgMenu +{ + public: + eOSState Process (eKeys Key); + protected: + void BuildOsd (); +}; + +//! \brief an mgMenu class for selecting a search view +class mgTreeViewSelector:public mgMenu { - public: - - mgMainMenu(mgMedia *media, mgSelectionTreeNode *root, - mgPlaylist *playlist, cCommands *playlist_commands ); - - mgSelectionTreeNode *CurrentNode(); - mgMenuTreeItem *CurrentItem(); - - eOSState ProcessKey(eKeys Key); - - protected: - - enum MuggleStatus - { - TREE, TREE_SUBMENU, - PLAYLIST, LOAD_PLAYLIST, SAVE_PLAYLIST, - PLAYLIST_SUBMENU, PLAYLIST_COMMANDS, - FILTER, FILTER_SUBMENU - }; - - void SetButtons(); - void Move( int from, int to ); - - // Tree view handling - void DisplayTree( mgSelectionTreeNode *node, int select = 0 ); - void DisplayTreeViewSelector(); - void DisplayTreeSubmenu(); - eOSState TreeSubmenuAction( int n ); - - // Playlist view handling - void DisplayPlaylist( int index_current = -1 ); - void DisplayTrackInfo(); - void DisplayAlbumInfo(); - - void LoadPlaylist(); - void SavePlaylist(); - void RenamePlaylist( std::string name ); - void DisplayPlaylistSubmenu(); - eOSState PlaylistSubmenuAction( int n ); - void DisplayPlaylistCommands(); - eOSState ExecutePlaylistCommand( int current ); - - // Filter view handling - void DisplayFilter(); - void DisplayFilterSelector(); - - private: - //! \brief launch the actual player - void Play( mgPlaylist *plist, unsigned first ); - - // content stuff - mgMedia *m_media; - mgSelectionTreeNode *m_root; - mgSelectionTreeNode *m_node; - mgSelectionTreeNode *m_menu_item; - mgPlaylist *m_current_playlist; - std::vector< std::string > *m_plists; - - MuggleStatus m_state; - std::list< int > m_history; - - cCommands *m_playlist_commands; - - int m_last_osd_index; - - char m_listname[32]; - bool m_editing_listname; + protected: + void BuildOsd (); }; #endif |