4662a71bfb63c6aa9a3c0c61024cbfd538e7a7ea
[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  *      @brief                  This structure defines all the components and the signals\r
56  *                                      for a Dual-Decode GUI window. There will be two such\r
57  *                                      windows when the application is running \r
58  ******************************************************************************/\r
59 typedef struct{\r
60 \r
61         /*The Window and its delete-event signal handler*/\r
62         GtkWidget *window;\r
63         gulong windowCloseSignal;\r
64  \r
65     /*Image sink for the window*/\r
66     GstElement *sink;\r
67 \r
68         /*The Seekbar widget and the value-changed signal handler                       */\r
69         /*value-changed handler is called when media is seeked using seekbar*/\r
70         GtkWidget *seekScale;\r
71         gulong seekSignal;\r
72 \r
73         /*File Open button and clicked signal handler*/\r
74         GtkWidget *openButton;\r
75         gulong openSignal;\r
76 \r
77         /*media control buttons and clicked signal handlers*/\r
78         GtkWidget *playButton;\r
79         gulong playSignal;\r
80         GtkWidget *pauseButton;\r
81         gulong pauseSignal;\r
82         GtkWidget *stopButton;\r
83         gulong stopSignal;\r
84         GtkWidget *forwardButton;\r
85         gulong forwardSignal;\r
86         GtkWidget *rewindButton;\r
87         gulong rewindSignal;\r
88 \r
89         /*Help Button and clicked signal handler*/\r
90         GtkWidget *helpButton;\r
91         gulong helpSignal;\r
92 \r
93         /*The decode mode switch button and the clicked signal handler*/\r
94         GtkWidget *switchButton;\r
95         gulong switchSignal;\r
96 \r
97         /*Labels to display media playback status and position in media*/\r
98         GtkWidget *statusLabel;\r
99         GtkWidget *timeLabel;\r
100 \r
101         /*The timer signal to report position in media every*/\r
102         /*REPORT_INTERVAL seconds                                                       */\r
103         gulong timerSignal;\r
104 \r
105         /*The draw area where the video is displayed*/\r
106         GtkWidget *drawArea;\r
107 \r
108         /*The state of the controls*/\r
109         gint activeFlag;\r
110         gint modeFlag;\r
111 } GUIWindow;\r
112 \r
113 /*To index the static GUIWindow and Pipeline structures                 */\r
114 /*There are two of them, since it is a dual-decode application  */\r
115 #define DECODER_INDEX_SINGLE 0\r
116 #define DECODER_INDEX_DOUBLE 1\r
117 \r
118 /*ratio of screen size per window*/\r
119 #define SCREEN_WIDTH_FACTOR 3\r
120 #define SCREEN_HEIGHT_FACTOR 2\r
121 \r
122 /*Whether the control buttons are active*/\r
123 #define CONTROL_MODE_ACTIVE TRUE\r
124 #define CONTROL_MODE_INACTIVE FALSE\r
125 \r
126 #define CONTROL_MODE_STOPPED 0\r
127 #define CONTROL_MODE_PLAYING 1\r
128 #define CONTROL_MODE_PAUSED 2\r
129 #define CONTROL_MODE_NO_FILE 4\r
130 \r
131 #define LABEL_TEXT_NO_FILE "No File"\r
132 #define LABEL_TEXT_PLAYING "Playing"\r
133 #define LABEL_TEXT_STOPPED "Stopped"\r
134 #define LABEL_TEXT_PAUSED "Paused"\r
135 \r
136 #define TIME_LABEL_ORIGIN "--:--:--/--:--:--"\r
137 \r
138 #define FORWARD 3000000000\r
139 #define REWIND 3000000000\r
140 #define SWITCH_TEXT_SINGLE "Single Decode"\r
141 #define SWITCH_TEXT_DUAL "Dual Decode"\r
142 \r
143 #define TIMER_INTERVAL 1000\r
144 #define TIMER_SIGNAL_NONE 0\r
145 \r
146 /******************************************************************************\r
147  *      @brief                  initialises GTK if X is present\r
148  *\r
149  *      @param[in,out] argc             number of command line arguments\r
150  *      @param[in,out] argv             command line arguments\r
151  *\r
152  *      @return                 TRUE if X present, FALSE otherwise              \r
153  *\r
154  *      Called From             main()\r
155  ******************************************************************************/\r
156 gboolean DualDecode_initGUI(gint *argc, char **argv[]);\r
157 \r
158 /******************************************************************************\r
159  *      @brief                  start the application\r
160  *\r
161  *      Called From             main()\r
162  ******************************************************************************/\r
163 void DualDecode_startApplication();\r
164 \r
165 /******************************************************************************\r
166  *      @brief                  stop the application and return to main()\r
167  *\r
168  *      Called From             delete-event handlers of the windows\r
169  ******************************************************************************/\r
170 void DualDecode_exitApplication();\r
171 \r
172 /*The glade file to import widgets from*/\r
173 #define GLADE_FILE "res/gui.xml"\r
174 \r
175 /*statically used variables per GUI component file*/\r
176 static GError *error                    = NULL;\r
177 static GtkBuilder *builder              = NULL;\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 static inline void DualDecode_checkError(){\r
183         if(NULL == error){\r
184                 g_printerr("GError Report : Unknown error\n");\r
185         }else{\r
186                 g_printerr("GError Report : %s\n",error->message);\r
187                 g_error_free(error);\r
188                 error = NULL;\r
189         }\r
190 }\r
191 \r
192 /*create and close a static GtkBuilder*/\r
193 static inline void DualDecode_builderClose() {\r
194         g_object_unref(G_OBJECT(builder));\r
195         builder = NULL;\r
196 }\r
197 static inline void DualDecode_builderCreate() {\r
198         builder = gtk_builder_new();\r
199         if(0 == gtk_builder_add_from_file(builder,GLADE_FILE,&error)){\r
200                 DualDecode_checkError();\r
201                 DualDecode_builderClose();\r
202         }\r
203 }\r
204 \r
205 /*get a widget from the builder*/\r
206 static inline GtkWidget *DualDecode_getWidget(const char *widget) {\r
207         GtkWidget *retWidget = NULL;\r
208         if(NULL == builder){\r
209                 retWidget = NULL;\r
210         }else{\r
211                 retWidget = (GtkWidget *)gtk_builder_get_object(builder,widget);\r
212         }\r
213         return retWidget;\r
214 }\r
215 \r
216 /* get a widget exclusively from the builder                      */\r
217 /* this will let the application create two instances             */\r
218 /* of a widget defined in the glade file.                         */\r
219 /*                                                                */\r
220 /* For example : this macro can be used like -                    */\r
221 /*                                                                */\r
222 /* widget0 = DualDecode_getWidgetExclusive("applicationWindow")   */\r
223 /* widget1 = DualDecode_getWidgetExclusive("applicationWindow")   */\r
224 /*                                                                */\r
225 /* this will create two different widgets with the same           */\r
226 /* look and feel                                                  */\r
227 \r
228 static inline GtkWidget *DualDecode_getWidgetExclusive(const char *widget) {\r
229         GtkWidget *retWidget = NULL;\r
230         DualDecode_builderCreate();\r
231         retWidget=DualDecode_getWidget(widget);\r
232         DualDecode_builderClose();\r
233         return retWidget;\r
234 }\r
235 #endif /*__GUI_H__*/\r