bin/darwinvlc.m

   1 /*****************************************************************************
   2  * darwinvlc.m: OS X specific main executable for VLC media player
   3  *****************************************************************************
   4  * Copyright (C) 2013-2015 VLC authors and VideoLAN
   5  *
   6  * Authors: Felix Paul Kühne <fkuehne at videolan dot org>
   7  *          David Fuhrmann <dfuhrmann at videolan dot 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc_common.h>
  30 #include <vlc_charset.h>
  31
  32 #include <stdlib.h>
  33 #include <locale.h>
  34 #include <signal.h>
  35 #include <string.h>
  36
  37 #import <CoreFoundation/CoreFoundation.h>
  38 #import <Cocoa/Cocoa.h>
  39
  40 #ifdef HAVE_BREAKPAD
  41 #import <Breakpad/Breakpad.h>
  42 #endif
  43
  44
  45 /**
  46  * Handler called when VLC asks to terminate the program.
  47  */
  48 static void vlc_terminate(void *data)
  49 {
  50     (void)data;
  51
  52     dispatch_async(dispatch_get_main_queue(), ^{
  53         /*
  54          * Stop the main loop. When using the CoreFoundation mainloop, simply
  55          * CFRunLoopStop can be used.
  56          *
  57          * But this does not work when having an interface.
  58          * In this case, [NSApp stop:nil] needs to be used, but the used flag is only
  59          * evaluated at the end of main loop event processing. This is always true
  60          * in the case of code inside a action method. But here, this is
  61          * not true and thus we need to send an dummy event to make sure the stop
  62          * flag is actually processed by the main loop.
  63          */
  64         if (NSApp == nil) {
  65             CFRunLoopStop(CFRunLoopGetCurrent());
  66         } else {
  67
  68             [NSApp stop:nil];
  69             NSEvent* event = [NSEvent otherEventWithType:NSApplicationDefined
  70                                                 location:NSMakePoint(0,0)
  71                                            modifierFlags:0
  72                                                timestamp:0.0
  73                                             windowNumber:0
  74                                                  context:nil
  75                                                  subtype:0
  76                                                    data1:0
  77                                                    data2:0];
  78             [NSApp postEvent:event atStart:YES];
  79         }
  80
  81     });
  82 }
  83
  84 #ifdef HAVE_BREAKPAD
  85 BreakpadRef initBreakpad()
  86 {
  87     BreakpadRef bp = nil;
  88
  89     /* Create caches directory in case it does not exist */
  90     NSFileManager *fileManager = [NSFileManager defaultManager];
  91     NSString *cachePath = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) firstObject];
  92     NSString *bundleName = [[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleIdentifier"];
  93     NSString *cacheAppPath = [cachePath stringByAppendingPathComponent:bundleName];
  94     if (![fileManager fileExistsAtPath:cacheAppPath]) {
  95         [fileManager createDirectoryAtPath:cacheAppPath withIntermediateDirectories:NO attributes:nil error:nil];
  96     }
  97
  98     /* Get Info.plist config */
  99     NSMutableDictionary *breakpad_config = [[[NSBundle mainBundle] infoDictionary] mutableCopy];
 100
 101     /* Use in-process reporting */
 102     [breakpad_config setObject:[NSNumber numberWithBool:YES]
 103                         forKey:@BREAKPAD_IN_PROCESS];
 104
 105     /* Set dump location */
 106     [breakpad_config setObject:cacheAppPath
 107                         forKey:@BREAKPAD_DUMP_DIRECTORY];
 108
 109     bp = BreakpadCreate(breakpad_config);
 110     return bp;
 111 }
 112 #endif
 113
 114 /*****************************************************************************
 115  * main: parse command line, start interface and spawn threads.
 116  *****************************************************************************/
 117 int main(int i_argc, const char *ppsz_argv[])
 118 {
 119     /* The so-called POSIX-compliant MacOS X reportedly processes SIGPIPE even
 120      * if it is blocked in all thread.
 121      * Note: this is NOT an excuse for not protecting against SIGPIPE. If
 122      * LibVLC runs outside of VLC, we cannot rely on this code snippet. */
 123     signal(SIGPIPE, SIG_IGN);
 124     /* Restore SIGCHLD in case our parent process ignores it. */
 125     signal(SIGCHLD, SIG_DFL);
 126
 127 #ifndef NDEBUG
 128     /* Activate malloc checking routines to detect heap corruptions. */
 129     setenv("MALLOC_CHECK_", "2", 1);
 130 #endif
 131
 132 #ifdef TOP_BUILDDIR
 133     setenv("VLC_PLUGIN_PATH", TOP_BUILDDIR"/modules", 1);
 134     setenv("VLC_DATA_PATH", TOP_SRCDIR"/share", 1);
 135     setenv("VLC_LIB_PATH", TOP_BUILDDIR"/modules", 1);
 136 #endif
 137
 138 #ifndef ALLOW_RUN_AS_ROOT
 139     if (geteuid() == 0)
 140     {
 141         fprintf(stderr, "VLC is not supposed to be run as root. Sorry.\n"
 142         "If you need to use real-time priorities and/or privileged TCP ports\n"
 143         "you can use %s-wrapper (make sure it is Set-UID root and\n"
 144         "cannot be run by non-trusted users first).\n", ppsz_argv[0]);
 145         return 1;
 146     }
 147 #endif
 148
 149     setlocale(LC_ALL, "");
 150
 151     if (isatty(STDERR_FILENO))
 152         /* This message clutters error logs. It is printed only on a TTY.
 153          * Fortunately, LibVLC prints version info with -vv anyway. */
 154         fprintf(stderr, "VLC media player %s (revision %s)\n",
 155                  libvlc_get_version(), libvlc_get_changeset());
 156
 157     sigset_t set;
 158
 159     sigemptyset(&set);
 160     /*
 161      * The darwin version of VLC used GCD to dequeue interesting signals.
 162      * For this to work, those signals must be blocked.
 163      *
 164      * There are two advantages over traditional signal handlers:
 165      *  - handling is done on a separate thread: no need to worry about async-safety,
 166      *  - EINTR is not generated: other threads need not handle that error.
 167      * That being said, some LibVLC programs do not use sigwait(). Therefore
 168      * EINTR must still be handled cleanly, notably from poll() calls.
 169      *
 170      * Signals that request a clean shutdown.
 171      * We have to handle SIGTERM cleanly because of daemon mode. */
 172     sigaddset(&set, SIGINT);
 173     sigaddset(&set, SIGTERM);
 174
 175     /* SIGPIPE can happen and would crash the process. On modern systems,
 176      * the MSG_NOSIGNAL flag protects socket write operations against SIGPIPE.
 177      * But we still need to block SIGPIPE when:
 178      *  - writing to pipes,
 179      *  - using write() instead of send() for code not specific to sockets.
 180      * LibVLC code assumes that SIGPIPE is blocked. Other LibVLC applications
 181      * shall block it (or handle it somehow) too.
 182      */
 183     sigaddset(&set, SIGPIPE);
 184
 185     /* SIGCHLD must be dequeued to clean up zombie child processes.
 186      * Furthermore the handler must not be set to SIG_IGN (see above).
 187      * We cannot pragmatically handle EINTR, short reads and short writes
 188      * in every code paths (including underlying libraries). So we just
 189      * block SIGCHLD in all threads, and dequeue it below. */
 190     sigaddset(&set, SIGCHLD);
 191
 192     /* Block all these signals */
 193     pthread_sigmask(SIG_SETMASK, &set, NULL);
 194
 195     /* Handle signals with GCD */
 196     dispatch_queue_t queue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
 197     dispatch_source_t sigIntSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGINT, 0, queue);
 198     dispatch_source_t sigTermSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGTERM, 0, queue);
 199     dispatch_source_t sigChldSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGCHLD, 0, queue);
 200
 201     if (!sigIntSource || !sigTermSource || !sigChldSource)
 202         abort();
 203
 204     dispatch_source_set_event_handler(sigIntSource, ^{
 205         vlc_terminate(nil);
 206     });
 207     dispatch_source_set_event_handler(sigTermSource, ^{
 208         vlc_terminate(nil);
 209     });
 210
 211     dispatch_source_set_event_handler(sigChldSource, ^{
 212         int status;
 213         while(waitpid(-1, &status, WNOHANG) > 0)
 214             ;
 215     });
 216
 217     dispatch_resume(sigIntSource);
 218     dispatch_resume(sigTermSource);
 219     dispatch_resume(sigChldSource);
 220
 221
 222     /* Handle parameters */
 223     const char *argv[i_argc + 2];
 224     int argc = 0;
 225
 226     argv[argc++] = "--no-ignore-config";
 227     argv[argc++] = "--media-library";
 228
 229     /* overwrite system language on Mac */
 230     char *lang = NULL;
 231
 232     for (int i = 0; i < i_argc; i++) {
 233         if (!strncmp(ppsz_argv[i], "--language", 10)) {
 234             lang = strstr(ppsz_argv[i], "=");
 235             ppsz_argv++, i_argc--;
 236             continue;
 237         }
 238     }
 239     if (lang && strncmp( lang, "auto", 4 )) {
 240         char tmp[11];
 241         snprintf(tmp, 11, "LANG%s", lang);
 242         putenv(tmp);
 243     }
 244
 245     if (!lang) {
 246         CFStringRef language;
 247         language = (CFStringRef)CFPreferencesCopyAppValue(CFSTR("language"),
 248                                                           kCFPreferencesCurrentApplication);
 249         if (language) {
 250             lang = FromCFString(language, kCFStringEncodingUTF8);
 251             if (strncmp( lang, "auto", 4 )) {
 252                 char tmp[11];
 253                 snprintf(tmp, 11, "LANG=%s", lang);
 254                 putenv(tmp);
 255             }
 256             free(lang);
 257             CFRelease(language);
 258         }
 259     }
 260
 261     ppsz_argv++; i_argc--; /* skip executable path */
 262
 263     /* When VLC.app is run by double clicking in Mac OS X < 10.9, the 2nd arg
 264      * is the PSN - process serial number (a unique PID-ish thingie)
 265      * still ok for real Darwin & when run from command line
 266      * for example -psn_0_9306113 */
 267     if (i_argc >= 1 && !strncmp(*ppsz_argv, "-psn" , 4))
 268         ppsz_argv++, i_argc--;
 269
 270     memcpy (argv + argc, ppsz_argv, i_argc * sizeof(*argv));
 271     argc += i_argc;
 272     argv[argc] = NULL;
 273
 274     /* Initialize libvlc */
 275     libvlc_instance_t *vlc = libvlc_new(argc, argv);
 276     if (vlc == NULL)
 277         return 1;
 278
 279     int ret = 1;
 280     libvlc_set_exit_handler(vlc, vlc_terminate, NULL);
 281     libvlc_set_app_id(vlc, "org.VideoLAN.VLC", PACKAGE_VERSION, PACKAGE_NAME);
 282     libvlc_set_user_agent(vlc, "VLC media player", "VLC/"PACKAGE_VERSION);
 283
 284     libvlc_add_intf(vlc, "hotkeys,none");
 285
 286     if (libvlc_add_intf(vlc, NULL)) {
 287         fprintf(stderr, "VLC cannot start any interface. Exiting.\n");
 288         goto out;
 289     }
 290     libvlc_playlist_play(vlc);
 291
 292     /*
 293      * Run the main loop. If the mac interface is not initialized, only the CoreFoundation
 294      * runloop is used. Otherwise, [NSApp run] needs to be called, which setups more stuff
 295      * before actually starting the loop.
 296      */
 297 #ifdef HAVE_BREAKPAD
 298     BreakpadRef breakpad;
 299     breakpad = initBreakpad();
 300 #endif
 301     @autoreleasepool {
 302         if(NSApp == nil) {
 303             CFRunLoopRun();
 304
 305         } else {
 306             [NSApp run];
 307         }
 308     }
 309
 310     ret = 0;
 311     /* Cleanup */
 312 out:
 313     dispatch_release(sigIntSource);
 314     dispatch_release(sigTermSource);
 315     dispatch_release(sigChldSource);
 316
 317     libvlc_release(vlc);
 318
 319 #ifdef HAVE_BREAKPAD
 320     BreakpadRelease(breakpad);
 321 #endif
 322
 323     return ret;
 324 }