* modules/*: sanitization of the modules description strings.
[vlc.git] / modules / gui / gtk2 / gtk2.c
1 /*****************************************************************************
2  * gtk2.c : Gtk2 plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
5  * $Id: gtk2.c,v 1.2 2003/03/30 18:14:37 gbazin Exp $
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <errno.h>                                                 /* ENOMEM */
29 #include <string.h>                                            /* strerror() */
30 #include <stdio.h>
31
32 #include <vlc/vlc.h>
33 #include <vlc/intf.h>
34
35 #include <gtk/gtk.h>
36
37 #include "gtk2_callbacks.h"
38 #include "gtk2_interface.h"
39 #include "gtk2_support.h"
40
41 /*****************************************************************************
42  * Local prototypes.
43  *****************************************************************************/
44 static int  Open         ( vlc_object_t * );
45 static void Close        ( vlc_object_t * );
46
47 static void Run          ( intf_thread_t * );
48 static int  Manage       ( intf_thread_t * );
49
50 /*****************************************************************************
51  * Module descriptor
52  *****************************************************************************/
53 vlc_module_begin();
54     int i = getenv( "DISPLAY" ) == NULL ? 15 : 95;
55     set_description( _("Gtk2 interface") );
56     set_capability( "interface", i );
57     set_callbacks( Open, Close );
58     set_program( "gvlc" );
59 vlc_module_end();
60
61 /*****************************************************************************
62  * intf_sys_t
63  *****************************************************************************/
64 struct intf_sys_t
65 {
66     module_t *p_gui_helper;
67
68     GtkWidget *p_window;
69 };
70
71 /*****************************************************************************
72  * Open: initialize and create window
73  *****************************************************************************/
74 static int Open( vlc_object_t *p_this )
75 {
76     intf_thread_t *p_intf = (intf_thread_t *)p_this;
77
78     /* Allocate instance and initialize some members */
79     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
80     if( p_intf->p_sys == NULL )
81     {
82         msg_Err( p_intf, "out of memory" );
83         return VLC_ENOMEM;
84     }
85
86 #ifdef NEED_GTK2_MAIN
87     p_intf->p_sys->p_gui_helper = module_Need( p_this, "gui-helper", "gtk2" );
88     if( p_intf->p_sys->p_gui_helper == NULL )
89     {
90         free( p_intf->p_sys );
91         return VLC_ENOMOD;
92     }
93 #endif
94
95     p_intf->pf_run = Run;
96
97     return VLC_SUCCESS;
98 }
99
100 /*****************************************************************************
101  * Close: destroy interface window
102  *****************************************************************************/
103 static void Close( vlc_object_t *p_this )
104 {
105     intf_thread_t *p_intf = (intf_thread_t *)p_this;
106
107 #ifdef NEED_GTK2_MAIN
108     module_Unneed( p_intf, p_intf->p_sys->p_gui_helper );
109 #endif
110
111     /* Destroy structure */
112     free( p_intf->p_sys );
113 }
114
115 /*****************************************************************************
116  * Run: Gtk2 thread
117  *****************************************************************************
118  * this part of the interface is in a separate thread so that we can call
119  * gtk_main() from within it without annoying the rest of the program.
120  *****************************************************************************/
121 static void Run( intf_thread_t *p_intf )
122 {
123 #ifdef NEED_GTK2_MAIN
124     gdk_threads_enter();
125 #else
126     /* gtk_init needs to know the command line. We don't care, so we
127      * give it an empty one */
128     char  *p_args[] = { "", NULL };
129     char **pp_args  = p_args;
130     int    i_args   = 1;
131     int    i_dummy;
132
133     gtk_set_locale();
134     gtk_init( &i_args, &pp_args );
135 #endif
136
137     /* Create some useful widgets that will certainly be used */
138     p_intf->p_sys->p_window = create_window1();
139
140     /* Set the title of the main window */
141     gtk_window_set_title( GTK_WINDOW(p_intf->p_sys->p_window),
142                           VOUT_TITLE " (Gtk2 interface)");
143
144     /* Show the control window */
145     gtk_widget_show( p_intf->p_sys->p_window );
146
147 #ifdef NEED_GTK2_MAIN
148     while( !p_intf->b_die )
149     {
150         Manage( p_intf );
151
152         /* Sleep to avoid using all CPU - since some interfaces need to
153          * access keyboard events, a 100ms delay is a good compromise */
154         gdk_threads_leave();
155         msleep( INTF_IDLE_SLEEP );
156         gdk_threads_enter();
157     }
158 #else
159     /* Sleep to avoid using all CPU - since some interfaces needs to access
160      * keyboard events, a 100ms delay is a good compromise */
161     i_dummy = gtk_timeout_add( INTF_IDLE_SLEEP / 1000, (GtkFunction)Manage,
162                                p_intf );
163     /* Enter Gtk mode */
164     gtk_main();
165     /* Remove the timeout */
166     gtk_timeout_remove( i_dummy );
167 #endif
168
169     gtk_object_destroy( GTK_OBJECT(p_intf->p_sys->p_window) );
170
171 #ifdef NEED_GTK2_MAIN
172     gdk_threads_leave();
173 #endif
174 }
175
176 /* following functions are local */
177
178 /*****************************************************************************
179  * Manage: manage main thread messages
180  *****************************************************************************
181  * In this function, called approx. 10 times a second, we check what the
182  * main program wanted to tell us.
183  *****************************************************************************/
184 static int Manage( intf_thread_t *p_intf )
185 {
186 #ifndef NEED_GTK2_MAIN
187     if( p_intf->b_die )
188     {
189         gtk_main_quit();
190
191         return FALSE;
192     }
193 #endif
194
195     return TRUE;
196 }