]> git.sesse.net Git - vlc/blob - modules/gui/skins2/src/vlcproc.hpp
skins2: replace polling with callbacks
[vlc] / 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef VLCPROC_HPP
26 #define VLCPROC_HPP
27
28 #include <set>
29
30 #include <vlc_common.h>
31 #include <vlc_input.h>
32 #include <vlc_vout.h>
33 #include "../vars/equalizer.hpp"
34 #include "../vars/playtree.hpp"
35 #include "../vars/time.hpp"
36 #include "../vars/volume.hpp"
37 #include "../utils/position.hpp"
38 #include "../utils/var_text.hpp"
39 #include "../commands/cmd_generic.hpp"
40 #include "../controls/ctrl_video.hpp"
41
42 class OSTimer;
43 class VarBool;
44 struct aout_instance_t;
45 struct vout_window_t;
46
47
48 /// Singleton object handling VLC internal state and playlist
49 class VlcProc: public SkinObject
50 {
51     public:
52         /// Get the instance of VlcProc
53         /// Returns NULL if the initialization of the object failed
54         static VlcProc *instance( intf_thread_t *pIntf );
55
56         /// Delete the instance of VlcProc
57         static void destroy( intf_thread_t *pIntf );
58
59         /// Getter for the playtree variable
60         Playtree &getPlaytreeVar() { return *((Playtree*)m_cPlaytree.get()); }
61
62         /// Getter for the time variable
63         StreamTime &getTimeVar() { return *((StreamTime*)(m_cVarTime.get())); }
64
65         /// Getter for the volume variable
66         Volume &getVolumeVar() { return *((Volume*)(m_cVarVolume.get())); }
67
68         /// Getter for the stream name variable
69         VarText &getStreamNameVar()
70            { return *((VarText*)(m_cVarStreamName.get())); }
71
72         /// Getter for the stream URI variable
73         VarText &getStreamURIVar()
74             { return *((VarText*)(m_cVarStreamURI.get())); }
75
76         /// Getter for the stream bitrate variable
77         VarText &getStreamBitRateVar()
78             { return *((VarText*)(m_cVarStreamBitRate.get())); }
79
80         /// Getter for the stream sample rate variable
81         VarText &getStreamSampleRateVar()
82             { return *((VarText*)(m_cVarStreamSampleRate.get())); }
83
84         /// Getter for the vout size variable
85         VarBox &getVoutSizeVar() { return m_varVoutSize; }
86
87         /// Indicate whether the embedded video output is currently used
88         bool isVoutUsed() const { return m_pVout != NULL; }
89
90         void on_item_current_changed( vlc_object_t* p_obj, vlc_value_t newVal );
91         void on_intf_event_changed( vlc_object_t* p_obj, vlc_value_t newVal );
92         void on_bit_rate_changed( vlc_object_t* p_obj, vlc_value_t newVal );
93         void on_sample_rate_changed( vlc_object_t* p_obj, vlc_value_t newVal );
94
95         void on_random_changed( vlc_object_t* p_obj, vlc_value_t newVal );
96         void on_loop_changed( vlc_object_t* p_obj, vlc_value_t newVal );
97         void on_repeat_changed( vlc_object_t* p_obj, vlc_value_t newVal );
98
99         void on_volume_changed( vlc_object_t* p_obj, vlc_value_t newVal );
100         void on_audio_filter_changed( vlc_object_t* p_obj, vlc_value_t newVal );
101
102     protected:
103         // Protected because it is a singleton
104         VlcProc( intf_thread_t *pIntf );
105         virtual ~VlcProc();
106
107     private:
108         /// Timer to call manage() regularly (via doManage())
109         OSTimer *m_pTimer;
110         /// Playtree variable
111         VariablePtr m_cPlaytree;
112         VariablePtr m_cVarRandom;
113         VariablePtr m_cVarLoop;
114         VariablePtr m_cVarRepeat;
115         /// Variable for current position of the stream
116         VariablePtr m_cVarTime;
117         /// Variable for audio volume
118         VariablePtr m_cVarVolume;
119         /// Variable for current stream properties
120         VariablePtr m_cVarStreamName;
121         VariablePtr m_cVarStreamURI;
122         VariablePtr m_cVarStreamBitRate;
123         VariablePtr m_cVarStreamSampleRate;
124         /// Variable for the "mute" state
125         VariablePtr m_cVarMute;
126         /// Variables related to the input
127         VariablePtr m_cVarPlaying;
128         VariablePtr m_cVarStopped;
129         VariablePtr m_cVarPaused;
130         VariablePtr m_cVarSeekable;
131         /// Variables related to the vout
132         VariablePtr m_cVarFullscreen;
133         VarBox m_varVoutSize;
134         VariablePtr m_cVarHasVout;
135         /// Variables related to audio
136         VariablePtr m_cVarHasAudio;
137         /// Equalizer variables
138         EqualizerBands m_varEqBands;
139         VariablePtr m_cVarEqPreamp;
140         VariablePtr m_cVarEqualizer;
141         /// Variable for DVD detection
142         VariablePtr m_cVarDvdActive;
143
144         /// Vout thread
145         vout_thread_t *m_pVout;
146         /// Audio output
147         aout_instance_t *m_pAout;
148
149         /**
150          * Poll VLC internals to update the status (volume, current time in
151          * the stream, current filename, play/pause/stop status, ...)
152          * This function should be called regurlarly, since there is no
153          * callback mechanism (yet?) to automatically update a variable when
154          * the internal status changes
155          */
156         void manage();
157
158         /// Define the command that calls manage()
159         DEFINE_CALLBACK( VlcProc, Manage );
160
161         /// Update the stream name variable
162         void updateStreamName();
163
164         /// Callback for intf-change variable
165         static int onIntfChange( vlc_object_t *pObj, const char *pVariable,
166                                  vlc_value_t oldVal, vlc_value_t newVal,
167                                  void *pParam );
168
169         /// Callback for intf-show variable
170         static int onIntfShow( vlc_object_t *pObj, const char *pVariable,
171                                vlc_value_t oldVal, vlc_value_t newVal,
172                                void *pParam );
173
174         /// Callback for item-change variable
175         static int onItemChange( vlc_object_t *pObj, const char *pVariable,
176                                  vlc_value_t oldVal, vlc_value_t newVal,
177                                  void *pParam );
178
179         /// Callback for item-change variable
180         static int onItemAppend( vlc_object_t *pObj, const char *pVariable,
181                                  vlc_value_t oldVal, vlc_value_t newVal,
182                                  void *pParam );
183
184         /// Callback for item-change variable
185         static int onItemDelete( vlc_object_t *pObj, const char *pVariable,
186                                  vlc_value_t oldVal, vlc_value_t newVal,
187                                  void *pParam );
188
189
190         /// Callback for playlist-current variable
191         static int onPlaylistChange( vlc_object_t *pObj, const char *pVariable,
192                                      vlc_value_t oldVal, vlc_value_t newVal,
193                                      void *pParam );
194
195         /// Callback for skins2-to-load variable
196         static int onSkinToLoad( vlc_object_t *pObj, const char *pVariable,
197                                  vlc_value_t oldVal, vlc_value_t newVal,
198                                  void *pParam );
199
200         /// Callback for interaction variable
201         static int onInteraction( vlc_object_t *pObj, const char *pVariable,
202                                   vlc_value_t oldVal, vlc_value_t newVal,
203                                   void *pParam );
204
205         /// Callback for equalizer-bands variable
206         static int onEqBandsChange( vlc_object_t *pObj, const char *pVariable,
207                                     vlc_value_t oldVal, vlc_value_t newVal,
208                                     void *pParam );
209
210         /// Callback for equalizer-preamp variable
211         static int onEqPreampChange( vlc_object_t *pObj, const char *pVariable,
212                                      vlc_value_t oldVal, vlc_value_t newVal,
213                                      void *pParam );
214
215         /// Generic Callback
216         static int onGenericCallback( vlc_object_t *pObj, const char *pVariable,
217                                       vlc_value_t oldVal, vlc_value_t newVal,
218                                       void *pParam );
219
220 };
221
222
223 #endif