Modified in accordance to coding guidelines for header and C files.
[glsdk/dual-decode.git] / include / gui.h
1 /*\r
2  *  Copyright (c) 2012-2013, Texas Instruments Incorporated\r
3  *\r
4  *  Redistribution and use in source and binary forms, with or without\r
5  *  modification, are permitted provided that the following conditions\r
6  *  are met:\r
7  *\r
8  *  *  Redistributions of source code must retain the above copyright\r
9  *     notice, this list of conditions and the following disclaimer.\r
10  *\r
11  *  *  Redistributions in binary form must reproduce the above copyright\r
12  *     notice, this list of conditions and the following disclaimer in the\r
13  *     documentation and/or other materials provided with the distribution.\r
14  *\r
15  *  *  Neither the name of Texas Instruments Incorporated nor the names of\r
16  *     its contributors may be used to endorse or promote products derived\r
17  *     from this software without specific prior written permission.\r
18  *\r
19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
20  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,\r
21  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
22  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\r
23  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
24  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\r
25  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\r
26  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
27  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
28  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
29  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
30  *\r
31  *  Contact information for paper mail:\r
32  *  Texas Instruments\r
33  *  Post Office Box 655303\r
34  *  Dallas, Texas 75265\r
35  *  Contact information:\r
36  *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm\r
37  *  ?DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact\r
38  *  ============================================================================\r
39  *\r
40  */\r
41 \r
42 /**\r
43  * @file                gui.h\r
44  *\r
45  * @brief               Declares the data structures and the functions exported by the \r
46  *                              GUI. \r
47  */\r
48 \r
49 #ifndef __GUI_H__\r
50 #define __GUI_H__\r
51 \r
52 #include <gtk/gtk.h>\r
53 #include <gst/gst.h>\r
54 \r
55 /******************************************************************************\r
56  \r
57                          Structure Definitions\r
58  \r
59 *****************************************************************************/\r
60 \r
61 /**\r
62  *      @brief                  This structure defines all the components and the signals\r
63  *                                      for a Dual-Decode GUI window. There will be two such\r
64  *                                      windows when the application is running \r
65  */\r
66 typedef struct{\r
67 \r
68         /*The Window and its delete-event signal handler*/\r
69         GtkWidget *window;\r
70         gulong windowCloseSignal;\r
71  \r
72     /*Image sink for the window*/\r
73     GstElement *sink;\r
74 \r
75         /*The Seekbar widget and the value-changed signal handler                       */\r
76         /*value-changed handler is called when media is seeked using seekbar*/\r
77         GtkWidget *seekScale;\r
78         gulong seekSignal;\r
79 \r
80         /*File Open button and clicked signal handler*/\r
81         GtkWidget *openButton;\r
82         gulong openSignal;\r
83 \r
84         /*Media control buttons and clicked signal handlers*/\r
85         GtkWidget *playButton;\r
86         gulong playSignal;\r
87         GtkWidget *pauseButton;\r
88         gulong pauseSignal;\r
89         GtkWidget *stopButton;\r
90         gulong stopSignal;\r
91         GtkWidget *forwardButton;\r
92         gulong forwardSignal;\r
93         GtkWidget *rewindButton;\r
94         gulong rewindSignal;\r
95 \r
96         /*Help Button and clicked signal handler*/\r
97         GtkWidget *helpButton;\r
98         gulong helpSignal;\r
99 \r
100         /*The decode mode switch button and the clicked signal handler*/\r
101         GtkWidget *switchButton;\r
102         gulong switchSignal;\r
103 \r
104         /*Labels to display media playback status and position in media*/\r
105         GtkWidget *statusLabel;\r
106         GtkWidget *timeLabel;\r
107 \r
108         /*The timer signal to report position in media every*/\r
109         /*REPORT_INTERVAL seconds                                                       */\r
110         gulong timerSignal;\r
111 \r
112         /*The draw area where the video is displayed*/\r
113         GtkWidget *drawArea;\r
114 \r
115         /*The state of the controls*/\r
116         gint activeFlag;\r
117         gint modeFlag;\r
118 } GUIWindow;\r
119 \r
120 \r
121 \r
122 /******************************************************************************\r
123 \r
124                                 Macros\r
125 \r
126  *****************************************************************************/\r
127 /*To index the static GUIWindow and Pipeline structures                 */\r
128 /*There are two of them, since it is a dual-decode application  */\r
129 #define DECODER_INDEX_SINGLE 0\r
130 #define DECODER_INDEX_DOUBLE 1\r
131 \r
132 /*ratio of screen size per window*/\r
133 #define SCREEN_WIDTH_FACTOR 3\r
134 #define SCREEN_HEIGHT_FACTOR 2\r
135 \r
136 /*Whether the control buttons are active*/\r
137 #define CONTROL_MODE_ACTIVE TRUE\r
138 #define CONTROL_MODE_INACTIVE FALSE\r
139 \r
140 #define CONTROL_MODE_STOPPED 0\r
141 #define CONTROL_MODE_PLAYING 1\r
142 #define CONTROL_MODE_PAUSED 2\r
143 #define CONTROL_MODE_NO_FILE 4\r
144 \r
145 #define LABEL_TEXT_NO_FILE "No File"\r
146 #define LABEL_TEXT_PLAYING "Playing"\r
147 #define LABEL_TEXT_STOPPED "Stopped"\r
148 #define LABEL_TEXT_PAUSED "Paused"\r
149 \r
150 #define TIME_LABEL_ORIGIN "--:--:--/--:--:--"\r
151 \r
152 #define FORWARD 3000000000\r
153 #define REWIND 3000000000\r
154 #define SWITCH_TEXT_SINGLE "Single Decode"\r
155 #define SWITCH_TEXT_DUAL "Dual Decode"\r
156 \r
157 #define TIMER_INTERVAL 1000\r
158 #define TIMER_SIGNAL_NONE 0\r
159 \r
160 /*The glade file to import widgets from*/\r
161 #define GLADE_FILE "res/gui.xml"\r
162 \r
163 /******************************************************************************\r
164  \r
165               Statically used variables per GUI component file\r
166 \r
167  *****************************************************************************/\r
168 \r
169 static GError *error                    = NULL;\r
170 static GtkBuilder *builder              = NULL;\r
171 \r
172 /******************************************************************************\r
173  \r
174                         Static Inline functions\r
175  \r
176 *****************************************************************************/\r
177 \r
178 /**\r
179  * Report and then free the error, if error is not NULL\r
180  *This function is called when a NULL is returned from\r
181  *an allocation function\r
182  */                              \r
183 static inline void DualDecode_checkError(){\r
184         if(NULL == error){\r
185                 g_printerr("GError Report : Unknown error\n");\r
186         }else{\r
187                 g_printerr("GError Report : %s\n",error->message);\r
188                 g_error_free(error);\r
189                 error = NULL;\r
190         }\r
191 }\r
192 \r
193 /*create and close a static GtkBuilder*/\r
194 static inline void DualDecode_builderClose() {\r
195         g_object_unref(G_OBJECT(builder));\r
196         builder = NULL;\r
197 }\r
198 static inline void DualDecode_builderCreate() {\r
199         builder = gtk_builder_new();\r
200         if(0 == gtk_builder_add_from_file (builder,GLADE_FILE,&error)){\r
201                 DualDecode_checkError();\r
202                 DualDecode_builderClose();\r
203         }\r
204 }\r
205 \r
206 /*get a widget from the builder*/\r
207 static inline GtkWidget *DualDecode_getWidget(const char *widget) {\r
208         GtkWidget *retWidget = NULL;\r
209         if(NULL == builder){\r
210                 retWidget = NULL;\r
211         }else{\r
212                 retWidget = (GtkWidget *)gtk_builder_get_object(builder,widget);\r
213         }\r
214         return retWidget;\r
215 }\r
216 \r
217 /**\r
218  * Get a widget exclusively from the builder                      \r
219  * this will let the application create two instances             \r
220  * of a widget defined in the glade file.                         \r
221  *                                                                \r
222  * For example : this macro can be used like -                    \r
223  *                                                                \r
224  * widget0 = DualDecode_getWidgetExclusive("applicationWindow")   \r
225  * widget1 = DualDecode_getWidgetExclusive("applicationWindow")   \r
226  *                                                                \r
227  * this will create two different widgets with the same           \r
228  * look and feel                                                  \r
229  */\r
230 \r
231 static inline GtkWidget *DualDecode_getWidgetExclusive(const char *widget) {\r
232         GtkWidget *retWidget = NULL;\r
233         DualDecode_builderCreate();\r
234         retWidget=DualDecode_getWidget(widget);\r
235         DualDecode_builderClose();\r
236         return retWidget;\r
237 }\r
238 \r
239 /******************************************************************************\r
240  \r
241                         Public functions declarations\r
242  \r
243 ******************************************************************************/\r
244 \r
245 /**\r
246  *      @brief                  initialises GTK if X is present\r
247  *\r
248  *      @param[in,out] argc             number of command line arguments\r
249  *      @param[in,out] argv             command line arguments\r
250  *\r
251  *      @return                 TRUE if X present, FALSE otherwise              \r
252  *\r
253  *      Called From             main()\r
254  */\r
255 gboolean DualDecode_initGUI(gint *argc, char **argv[]);\r
256 \r
257 /**\r
258  *      @brief                  start the application\r
259  *\r
260  *      Called From             main()\r
261  */\r
262 void DualDecode_startApplication();\r
263 \r
264 /**\r
265  *      @brief                  stop the application and return to main()\r
266  *\r
267  *      Called From             delete-event handlers of the windows\r
268  */\r
269 void DualDecode_exitApplication();\r
270 \r
271 \r
272 #endif /*__GUI_H__*/\r