]> git.sesse.net Git - vlc/blob - bin/vlc.c
winvlc: various cleaning and comments
[vlc] / bin / vlc.c
1 /*****************************************************************************
2  * vlc.c: the VLC player
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@zoy.org>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *          Derk-Jan Hartman <hartman at videolan dot org>
11  *          Lots of other people, see the libvlc AUTHORS file
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc/vlc.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <stdbool.h>
36 #include <locale.h>
37 #include <signal.h>
38 #include <pthread.h>
39 #include <unistd.h>
40
41 #ifdef __APPLE__
42 #include <string.h>
43 #endif
44
45
46 /* Explicit HACK */
47 extern void LocaleFree (const char *);
48 extern char *FromLocale (const char *);
49 extern void vlc_enable_override (void);
50
51 #ifdef HAVE_MAEMO
52 static void dummy_handler (int signum)
53 {
54     (void) signum;
55 }
56 #endif
57
58 static bool signal_ignored (int signum)
59 {
60     struct sigaction sa;
61
62     if (sigaction (signum, NULL, &sa))
63         return false;
64     return ((sa.sa_flags & SA_SIGINFO)
65             ? (void *)sa.sa_sigaction : (void *)sa.sa_handler) == SIG_IGN;
66 }
67
68 static void vlc_kill (void *data)
69 {
70     pthread_t *ps = data;
71
72     pthread_kill (*ps, SIGTERM);
73 }
74
75 static void exit_timeout (int signum)
76 {
77     (void) signum;
78     signal (SIGINT, SIG_DFL);
79 }
80
81 /*****************************************************************************
82  * main: parse command line, start interface and spawn threads.
83  *****************************************************************************/
84 int main( int i_argc, const char *ppsz_argv[] )
85 {
86     /* The so-called POSIX-compliant MacOS X reportedly processes SIGPIPE even
87      * if it is blocked in all thread.
88      * Note: this is NOT an excuse for not protecting against SIGPIPE. If
89      * LibVLC runs outside of VLC, we cannot rely on this code snippet. */
90     signal (SIGPIPE, SIG_IGN);
91     /* Restore SIGCHLD in case our parent process ignores it. */
92     signal (SIGCHLD, SIG_DFL);
93
94 #ifndef NDEBUG
95     /* Activate malloc checking routines to detect heap corruptions. */
96     setenv ("MALLOC_CHECK_", "2", 1);
97
98     /* Disable the ugly Gnome crash dialog so that we properly segfault */
99     setenv ("GNOME_DISABLE_CRASH_DIALOG", "1", 1);
100 #endif
101
102 #ifdef TOP_BUILDDIR
103     setenv ("VLC_PLUGIN_PATH", TOP_BUILDDIR"/modules", 1);
104 #endif
105
106     /* Clear the X.Org startup notification ID. Otherwise the UI might try to
107      * change the environment while the process is multi-threaded. That could
108      * crash. Screw you X.Org. Next time write a thread-safe specification. */
109     unsetenv ("DESKTOP_STARTUP_ID");
110
111 #ifndef ALLOW_RUN_AS_ROOT
112     if (geteuid () == 0)
113     {
114         fprintf (stderr, "VLC is not supposed to be run as root. Sorry.\n"
115         "If you need to use real-time priorities and/or privileged TCP ports\n"
116         "you can use %s-wrapper (make sure it is Set-UID root and\n"
117         "cannot be run by non-trusted users first).\n", ppsz_argv[0]);
118         return 1;
119     }
120 #endif
121
122     setlocale (LC_ALL, "");
123
124 #ifndef __APPLE__
125     /* This clutters OSX GUI error logs */
126     fprintf( stderr, "VLC media player %s (revision %s)\n",
127              libvlc_get_version(), libvlc_get_changeset() );
128 #endif
129
130     sigset_t set;
131
132     sigemptyset (&set);
133     /* VLC uses sigwait() to dequeue interesting signals.
134      * For this to work, those signals must be blocked in all threads,
135      * including the thread calling sigwait() (see the man page for details).
136      *
137      * There are two advantages to sigwait() over traditional signal handlers:
138      *  - delivery is synchronous: no need to worry about async-safety,
139      *  - EINTR is not generated: other threads need not handle that error.
140      * That being said, some LibVLC programs do not use sigwait(). Therefore
141      * EINTR must still be handled cleanly, notably from poll() calls.
142      *
143      * Signals that request a clean shutdown, and force an unclean shutdown
144      * if they are triggered again 2+ seconds later.
145      * We have to handle SIGTERM cleanly because of daemon mode. */
146     sigaddset (&set, SIGINT);
147     sigaddset (&set, SIGHUP);
148     sigaddset (&set, SIGQUIT);
149     sigaddset (&set, SIGTERM);
150
151     /* SIGPIPE can happen and would crash the process. On modern systems,
152      * the MSG_NOSIGNAL flag protects socket write operations against SIGPIPE.
153      * But we still need to block SIGPIPE when:
154      *  - writing to pipes,
155      *  - using write() instead of send() for code not specific to sockets.
156      * LibVLC code assumes that SIGPIPE is blocked. Other LibVLC applications
157      * shall block it (or handle it somehow) too.
158      */
159     sigaddset (&set, SIGPIPE);
160
161     /* SIGCHLD must be dequeued to clean up zombie child processes.
162      * Furthermore the handler must not be set to SIG_IGN (see above).
163      * We cannot pragmatically handle EINTR, short reads and short writes
164      * in every code paths (including underlying libraries). So we just
165      * block SIGCHLD in all threads, and dequeue it below. */
166     sigaddset (&set, SIGCHLD);
167
168 #ifdef HAVE_MAEMO
169     sigaddset (&set, SIGRTMIN);
170     {
171         struct sigaction act = { .sa_handler = dummy_handler, };
172         sigaction (SIGRTMIN, &act, NULL);
173     }
174 #endif
175     /* Block all these signals */
176     pthread_sigmask (SIG_SETMASK, &set, NULL);
177
178     /* Note that FromLocale() can be used before libvlc is initialized */
179     const char *argv[i_argc + 3];
180     int argc = 0;
181
182     argv[argc++] = "--no-ignore-config";
183     argv[argc++] = "--media-library";
184 #ifdef TOP_SRCDIR
185     argv[argc++] = FromLocale ("--data-path="TOP_SRCDIR"/share");
186 #endif
187
188     int i = 1;
189 #ifdef __APPLE__
190     /* When VLC.app is run by double clicking in Mac OS X, the 2nd arg
191      * is the PSN - process serial number (a unique PID-ish thingie)
192      * still ok for real Darwin & when run from command line
193      * for example -psn_0_9306113 */
194     if(i_argc >= 2 && !strncmp( ppsz_argv[1] , "-psn" , 4 ))
195         i = 2;
196 #endif
197     for (; i < i_argc; i++)
198         if ((argv[argc++] = FromLocale (ppsz_argv[i])) == NULL)
199             return 1; // BOOM!
200     argv[argc] = NULL;
201
202     vlc_enable_override ();
203
204     /* Initialize libvlc */
205     libvlc_instance_t *vlc = libvlc_new (argc, argv);
206     if (vlc == NULL)
207         goto out;
208
209     libvlc_set_user_agent (vlc, "VLC media player", "VLC/"PACKAGE_VERSION);
210
211 #if !defined (HAVE_MAEMO) && !defined __APPLE__
212     libvlc_add_intf (vlc, "globalhotkeys,none");
213 #endif
214     if (libvlc_add_intf (vlc, NULL))
215         goto out;
216
217     libvlc_playlist_play (vlc, -1, 0, NULL);
218
219     /* Wait for a termination signal */
220     pthread_t self = pthread_self ();
221     libvlc_set_exit_handler (vlc, vlc_kill, &self);
222
223     /* Qt4 insists on catching SIGCHLD via signal handler. To work around that,
224      * unblock it after all our child threads are created. */
225     sigdelset (&set, SIGCHLD);
226     pthread_sigmask (SIG_SETMASK, &set, NULL);
227
228     /* Do not dequeue SIGHUP if it is ignored (nohup) */
229     if (signal_ignored (SIGHUP))
230         sigdelset (&set, SIGHUP);
231     /* Ignore SIGPIPE */
232     sigdelset (&set, SIGPIPE);
233
234     int signum;
235     sigwait (&set, &signum);
236
237     /* Restore default signal behaviour after 3 seconds */
238     sigemptyset (&set);
239     sigaddset (&set, SIGINT);
240     sigaddset (&set, SIGALRM);
241     signal (SIGINT, SIG_IGN);
242     signal (SIGALRM, exit_timeout);
243     pthread_sigmask (SIG_UNBLOCK, &set, NULL);
244     alarm (3);
245
246     /* Cleanup */
247 out:
248     if (vlc != NULL)
249         libvlc_release (vlc);
250     for (int i = 1; i < argc; i++)
251         LocaleFree (argv[i]);
252
253     return 0;
254 }