git.sesse.net Git - vlc/blob - modules/gui/macosx/macosx.m

   1 /*****************************************************************************
   2  * macosx.m: Mac OS X module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001-2013 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Felix Paul Kühne <fkuehne at videolan dot org>
   8  *          David Fuhrmann <david dot fuhrmann at googlemail dot com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>                                      /* malloc(), free() */
  29 #include <string.h>
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_vout_window.h>
  38
  39 #include "CompatibilityFixes.h"
  40
  41 /*****************************************************************************
  42  * External prototypes
  43  *****************************************************************************/
  44 int  OpenIntf     (vlc_object_t *);
  45 void CloseIntf    (vlc_object_t *);
  46
  47 int  WindowOpen   (vout_window_t *, const vout_window_cfg_t *);
  48 void WindowClose  (vout_window_t *);
  49
  50 /*****************************************************************************
  51  * Module descriptor
  52  *****************************************************************************/
  53 #define VDEV_TEXT N_("Video device")
  54 #define VDEV_LONGTEXT N_("Number of the screen to use by default to display " \
  55                          "videos in 'fullscreen'. The screen number correspondance can be found in "\
  56                          "the video device selection menu.")
  57
  58 #define OPAQUENESS_TEXT N_("Opaqueness")
  59 #define OPAQUENESS_LONGTEXT N_("Set the transparency of the video output. 1 is non-transparent (default) " \
  60                                 "0 is fully transparent.")
  61
  62 #define BLACK_TEXT N_("Black screens in fullscreen")
  63 #define BLACK_LONGTEXT N_("In fullscreen mode, keep screen where there is no " \
  64                           "video displayed black")
  65
  66 #define FSPANEL_TEXT N_("Show Fullscreen controller")
  67 #define FSPANEL_LONGTEXT N_("Shows a lucent controller when moving the mouse " \
  68                             "in fullscreen mode.")
  69
  70 #define AUTOPLAY_OSX_TEST N_("Auto-playback of new items")
  71 #define AUTOPLAY_OSX_LONGTEXT N_("Start playback of new items immediately " \
  72                                  "once they were added.")
  73
  74 #define RECENT_ITEMS_TEXT N_("Keep Recent Items")
  75 #define RECENT_ITEMS_LONGTEXT N_("By default, VLC keeps a list of the last 10 items. " \
  76                                  "This feature can be disabled here.")
  77
  78 #define USE_APPLE_REMOTE_TEXT N_("Control playback with the Apple Remote")
  79 #define USE_APPLE_REMOTE_LONGTEXT N_("By default, VLC can be remotely controlled with the Apple Remote.")
  80
  81 #define USE_APPLE_REMOTE_VOLUME_TEXT N_("Control system volume with the Apple Remote")
  82 #define USE_APPLE_REMOTE_VOLUME_LONGTEXT N_("By default, VLC will control its own volume with the Apple Remote. However, you can choose to control the global system volume instead.")
  83
  84 #define USE_APPLE_REMOTE_PREVNEXT_TEXT N_("Control playlist items with the Apple Remote")
  85 #define USE_APPLE_REMOTE_PREVNEXT_LONGTEXT N_("By default, VLC will allow you to switch to the next or previous item with the Apple Remote. You can disable this behavior with this option.")
  86
  87 #define USE_MEDIAKEYS_TEXT N_("Control playback with media keys")
  88 #define USE_MEDIAKEYS_LONGTEXT N_("By default, VLC can be controlled using the media keys on modern Apple " \
  89                                   "keyboards.")
  90
  91 #define INTERFACE_STYLE_TEXT N_("Run VLC with dark interface style")
  92 #define INTERFACE_STYLE_LONGTEXT N_("If this option is enabled, VLC will use the dark interface style. Otherwise, the grey interface style is used.")
  93
  94 #define NATIVE_FULLSCREEN_MODE_ON_LION_TEXT N_("Use the native fullscreen mode")
  95 #define NATIVE_FULLSCREEN_MODE_ON_LION_LONGTEXT N_("By default, VLC uses the fullscreen mode known from previous Mac OS X releases. It can also use the native fullscreen mode on Mac OS X 10.7 and later.")
  96
  97 #define KEEPSIZE_TEXT N_("Resize interface to the native video size")
  98 #define KEEPSIZE_LONGTEXT N_("You have two choices:\n" \
  99 " - The interface will resize to the native video size\n" \
 100 " - The video will fit to the interface size\n " \
 101 "By default, interface resize to the native video size.")
 102
 103 #define PAUSE_MINIMIZED_TEXT N_("Pause the video playback when minimized")
 104 #define PAUSE_MINIMIZED_LONGTEXT N_(\
 105 "With this option enabled, the playback will be automatically paused when minimizing the window.")
 106
 107 #define ICONCHANGE_TEXT N_("Allow automatic icon changes")
 108 #define ICONCHANGE_LONGTEXT N_("This option allows the interface to change its icon on various occasions.")
 109
 110 #define LOCK_ASPECT_RATIO_TEXT N_("Lock Aspect Ratio")
 111
 112 #define JUMPBUTTONS_TEXT N_("Show Previous & Next Buttons")
 113 #define JUMPBUTTONS_LONGTEXT N_("Shows the previous and next buttons in the main window.")
 114
 115 #define PLAYMODEBUTTONS_TEXT N_("Show Shuffle & Repeat Buttons")
 116 #define PLAYMODEBUTTONS_LONGTEXT N_("Shows the shuffle and repeat buttons in the main window.")
 117
 118 #define EFFECTSBUTTON_TEXT N_("Show Audio Effects Button")
 119 #define EFFECTSBUTTON_LONGTEXT N_("Shows the audio effects button in the main window.")
 120
 121 #define SIDEBAR_TEXT N_("Show Sidebar")
 122 #define SIDEBAR_LONGTEXT N_("Shows a sidebar in the main window listing media sources.")
 123
 124 #define ITUNES_TEXT N_("Pause iTunes during VLC playback")
 125 #define ITUNES_LONGTEXT N_("Pauses iTunes playback when VLC playback starts. If selected, iTunes playback will be resumed again if VLC playback is finished.")
 126
 127 static const int itunes_list[] =
 128     { 0, 1, 2 };
 129 static const char *const itunes_list_text[] = {
 130     N_("Do nothing"), N_("Pause iTunes"), N_("Pause and resume iTunes")
 131 };
 132
 133 #define VOLUME_MAX_TEXT N_("Maximum Volume displayed")
 134
 135
 136 vlc_module_begin()
 137     set_description(N_("Mac OS X interface"))
 138     set_capability("interface", 200)
 139     set_callbacks(OpenIntf, CloseIntf)
 140     set_category(CAT_INTERFACE)
 141     set_subcategory(SUBCAT_INTERFACE_MAIN)
 142     cannot_unload_broken_library()
 143
 144     BOOL b_have_mavericks = OSX_MAVERICKS;
 145
 146     set_section(N_("Appearance"), 0)
 147         add_bool("macosx-interfacestyle", false, INTERFACE_STYLE_TEXT, INTERFACE_STYLE_LONGTEXT, false)
 148         add_bool("macosx-nativefullscreenmode", b_have_mavericks, NATIVE_FULLSCREEN_MODE_ON_LION_TEXT, NATIVE_FULLSCREEN_MODE_ON_LION_LONGTEXT, false)
 149         add_bool("macosx-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true)
 150         add_bool("macosx-show-playback-buttons", false, JUMPBUTTONS_TEXT, JUMPBUTTONS_LONGTEXT, false)
 151         add_bool("macosx-show-playmode-buttons", false, PLAYMODEBUTTONS_TEXT, PLAYMODEBUTTONS_LONGTEXT, false)
 152         add_bool("macosx-show-effects-button", false, EFFECTSBUTTON_TEXT, EFFECTSBUTTON_LONGTEXT, false)
 153         add_bool("macosx-show-sidebar", true, SIDEBAR_TEXT, SIDEBAR_LONGTEXT, false)
 154         add_integer_with_range("macosx-max-volume", 125, 60, 200, VOLUME_MAX_TEXT, VOLUME_MAX_TEXT, true)
 155
 156     set_section(N_("Behavior"), 0)
 157         add_bool("macosx-autoplay", true, AUTOPLAY_OSX_TEST, AUTOPLAY_OSX_LONGTEXT, false)
 158         add_bool("macosx-recentitems", true, RECENT_ITEMS_TEXT, RECENT_ITEMS_LONGTEXT, false)
 159         add_bool("macosx-fspanel", true, FSPANEL_TEXT, FSPANEL_LONGTEXT, false)
 160         add_bool("macosx-video-autoresize", true, KEEPSIZE_TEXT, KEEPSIZE_LONGTEXT, false)
 161         add_bool("macosx-pause-minimized", false, PAUSE_MINIMIZED_TEXT, PAUSE_MINIMIZED_LONGTEXT, false)
 162         add_bool("macosx-lock-aspect-ratio", true, LOCK_ASPECT_RATIO_TEXT, LOCK_ASPECT_RATIO_TEXT, true)
 163         add_integer("macosx-control-itunes", 1, ITUNES_TEXT, ITUNES_LONGTEXT, false)
 164         change_integer_list(itunes_list, itunes_list_text)
 165
 166     set_section(N_("Apple Remote and media keys"), 0)
 167         add_bool("macosx-appleremote", true, USE_APPLE_REMOTE_TEXT, USE_APPLE_REMOTE_LONGTEXT, false)
 168         add_bool("macosx-appleremote-sysvol", false, USE_APPLE_REMOTE_VOLUME_TEXT, USE_APPLE_REMOTE_VOLUME_LONGTEXT, false)
 169         add_bool("macosx-appleremote-prevnext", false, USE_APPLE_REMOTE_PREVNEXT_TEXT, USE_APPLE_REMOTE_PREVNEXT_LONGTEXT, false)
 170         add_bool("macosx-mediakeys", true, USE_MEDIAKEYS_TEXT, USE_MEDIAKEYS_LONGTEXT, false)
 171
 172     add_obsolete_bool("macosx-stretch") /* since 2.0.0 */
 173     add_obsolete_bool("macosx-eq-keep") /* since 2.0.0 */
 174     add_obsolete_bool("macosx-autosave-volume") /* since 2.1.0 */
 175
 176     add_submodule()
 177         set_description("Mac OS X Video Output Provider")
 178         set_capability("vout window nsobject", 100)
 179         set_callbacks(WindowOpen, WindowClose)
 180
 181         set_section(N_("Video output"), 0)
 182         add_integer("macosx-vdev", 0, VDEV_TEXT, VDEV_LONGTEXT, false)
 183         add_float_with_range("macosx-opaqueness", 1, 0, 1, OPAQUENESS_TEXT, OPAQUENESS_LONGTEXT, true);
 184         add_bool("macosx-black", false, BLACK_TEXT, BLACK_LONGTEXT, false)
 185 vlc_module_end()
 186