* Playtree start. Basic functionalities work. Still needs a lot of
[vlc.git] / modules / gui / skins2 / src / vlcproc.hpp
1 /*****************************************************************************
2  * vlcproc.hpp
3  *****************************************************************************
4  * Copyright (C) 2003 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
8  *          Olivier Teulière <ipkiss@via.ecp.fr>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 #ifndef VLCPROC_HPP
26 #define VLCPROC_HPP
27
28 #include <set>
29
30 #include "../vars/playlist.hpp"
31 #include "../vars/playtree.hpp"
32 #include "../vars/time.hpp"
33 #include "../vars/volume.hpp"
34 #include "../utils/var_text.hpp"
35 #include "../commands/cmd_generic.hpp"
36
37 class OSTimer;
38 class VarBool;
39
40
41 /// Singleton object handling VLC internal state and playlist
42 class VlcProc: public SkinObject
43 {
44     public:
45         /// Get the instance of VlcProc
46         /// Returns NULL if the initialization of the object failed
47         static VlcProc *instance( intf_thread_t *pIntf );
48
49         /// Delete the instance of VlcProc
50         static void destroy( intf_thread_t *pIntf );
51
52         /// Getter for the playlist variable
53         Playlist &getPlaylistVar() { return *((Playlist*)m_cPlaylist.get()); }
54
55         /// Getter for the playtree variable
56         Playtree &getPlaytreeVar() { return *((Playtree*)m_cPlaytree.get()); }
57
58         /// Getter for the time variable
59         StreamTime &getTimeVar() { return *((StreamTime*)(m_cVarTime.get())); }
60
61         /// Getter for the volume variable
62         Volume &getVolumeVar() { return *((Volume*)(m_cVarVolume.get())); }
63
64         /// Getter for the stream name variable
65         VarText &getStreamNameVar()
66            { return *((VarText*)(m_cVarStreamName.get())); }
67
68         /// Getter for the stream URI variable
69         VarText &getStreamURIVar()
70             { return *((VarText*)(m_cVarStreamURI.get())); }
71
72         /// Set the vout window handle
73         void registerVoutWindow( void *pVoutWindow );
74
75         /// Unset the vout window handle
76         void unregisterVoutWindow( void *pVoutWindow );
77
78         /// Indicate whether the embedded video output is currently used
79         bool isVoutUsed() const { return m_pVout != NULL; }
80
81         /// If an embedded video output is used, drop it (i.e. tell it to stop
82         /// using our window handle)
83         void dropVout();
84
85     protected:
86         // Protected because it is a singleton
87         VlcProc( intf_thread_t *pIntf );
88         virtual ~VlcProc();
89
90     private:
91         /// Timer to call manage() regularly (via doManage())
92         OSTimer *m_pTimer;
93         /// Playlist variable
94         VariablePtr m_cPlaylist;
95         /// Playtree variable FIXME
96         VariablePtr m_cPlaytree;
97         VariablePtr m_cVarRandom;
98         VariablePtr m_cVarLoop;
99         VariablePtr m_cVarRepeat;
100         /// Variable for current position of the stream
101         VariablePtr m_cVarTime;
102         /// Variable for audio volume
103         VariablePtr m_cVarVolume;
104         /// Variable for current stream properties
105         VariablePtr m_cVarStreamName;
106         VariablePtr m_cVarStreamURI;
107         /// Variable for the "mute" state
108         VariablePtr m_cVarMute;
109         /// Variables related to the input
110         VariablePtr m_cVarPlaying;
111         VariablePtr m_cVarStopped;
112         VariablePtr m_cVarPaused;
113         VariablePtr m_cVarSeekable;
114
115         /// Set of handles of vout windows
116         /**
117          * When changing the skin, the handles of the 2 skins coexist in the
118          * set (but this is temporary, until the old theme is destroyed).
119          */
120         set<void *> m_handleSet;
121         /// Vout thread
122         vout_thread_t *m_pVout;
123
124         /**
125          * Poll VLC internals to update the status (volume, current time in
126          * the stream, current filename, play/pause/stop status, ...)
127          * This function should be called regurlarly, since there is no
128          * callback mechanism (yet?) to automatically update a variable when
129          * the internal status changes
130          */
131         void manage();
132
133         /// Define the command that calls manage()
134         DEFINE_CALLBACK( VlcProc, Manage );
135
136         /// Update the stream name variable
137         void updateStreamName( playlist_t *p_playlist );
138
139         /// Callback for intf-change variable
140         static int onIntfChange( vlc_object_t *pObj, const char *pVariable,
141                                  vlc_value_t oldVal, vlc_value_t newVal,
142                                  void *pParam );
143
144         /// Callback for intf-show variable
145         static int onIntfShow( vlc_object_t *pObj, const char *pVariable,
146                                vlc_value_t oldVal, vlc_value_t newVal,
147                                void *pParam );
148
149         /// Callback for item-change variable
150         static int onItemChange( vlc_object_t *pObj, const char *pVariable,
151                                  vlc_value_t oldVal, vlc_value_t newVal,
152                                  void *pParam );
153
154         /// Callback for playlist-current variable
155         static int onPlaylistChange( vlc_object_t *pObj, const char *pVariable,
156                                      vlc_value_t oldVal, vlc_value_t newVal,
157                                      void *pParam );
158
159         /// Callback for skins2-to-load variable
160         static int onSkinToLoad( vlc_object_t *pObj, const char *pVariable,
161                                  vlc_value_t oldVal, vlc_value_t newVal,
162                                  void *pParam );
163
164         /// Callback to request a vout window
165         static void *getWindow( intf_thread_t *pIntf, vout_thread_t *pVout,
166                                 int *pXHint, int *pYHint,
167                                 unsigned int *pWidthHint,
168                                 unsigned int *pHeightHint );
169
170         /// Callback to release a vout window
171         static void releaseWindow( intf_thread_t *pIntf, void *pWindow );
172
173         /// Callback to change a vout window
174         static int controlWindow( intf_thread_t *pIntf, void *pWindow,
175                                   int query, va_list args );
176 };
177
178
179 #endif