modules/gui/macosx/macosx.m

   1 /*****************************************************************************
   2  * macosx.m: Mac OS X module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001-2014 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
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_vout_window.h>
  38
  39 /*****************************************************************************
  40  * External prototypes
  41  *****************************************************************************/
  42 int  OpenIntf     (vlc_object_t *);
  43 void CloseIntf    (vlc_object_t *);
  44
  45 int  WindowOpen   (vout_window_t *, const vout_window_cfg_t *);
  46 void WindowClose  (vout_window_t *);
  47
  48 /*****************************************************************************
  49  * Module descriptor
  50  *****************************************************************************/
  51 #define VDEV_TEXT N_("Video device")
  52 #define VDEV_LONGTEXT N_("Number of the screen to use by default to display " \
  53                          "videos in 'fullscreen'. The screen number correspondance can be found in "\
  54                          "the video device selection menu.")
  55
  56 #define OPAQUENESS_TEXT N_("Opaqueness")
  57 #define OPAQUENESS_LONGTEXT N_("Set the transparency of the video output. 1 is non-transparent (default) " \
  58                                 "0 is fully transparent.")
  59
  60 #define BLACK_TEXT N_("Black screens in fullscreen")
  61 #define BLACK_LONGTEXT N_("In fullscreen mode, keep screen where there is no " \
  62                           "video displayed black")
  63
  64 #define FSPANEL_TEXT N_("Show Fullscreen controller")
  65 #define FSPANEL_LONGTEXT N_("Shows a lucent controller when moving the mouse " \
  66                             "in fullscreen mode.")
  67
  68 #define AUTOPLAY_OSX_TEST N_("Auto-playback of new items")
  69 #define AUTOPLAY_OSX_LONGTEXT N_("Start playback of new items immediately " \
  70                                  "once they were added.")
  71
  72 #define RECENT_ITEMS_TEXT N_("Keep Recent Items")
  73 #define RECENT_ITEMS_LONGTEXT N_("By default, VLC keeps a list of the last 10 items. " \
  74                                  "This feature can be disabled here.")
  75
  76 #define USE_APPLE_REMOTE_TEXT N_("Control playback with the Apple Remote")
  77 #define USE_APPLE_REMOTE_LONGTEXT N_("By default, VLC can be remotely controlled with the Apple Remote.")
  78
  79 #define USE_APPLE_REMOTE_VOLUME_TEXT N_("Control system volume with the Apple Remote")
  80 #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.")
  81
  82 #define DISPLAY_STATUS_ICONMENU_TEXT N_("Display VLC status menu icon")
  83 #define DISPLAY_STATUS_ICONMENU_LONGTEXT N_("By default, VLC will show the statusbar icon menu. However, you can choose to disable it (restart required).")
  84
  85 #define USE_APPLE_REMOTE_PREVNEXT_TEXT N_("Control playlist items with the Apple Remote")
  86 #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.")
  87
  88 #define USE_MEDIAKEYS_TEXT N_("Control playback with media keys")
  89 #define USE_MEDIAKEYS_LONGTEXT N_("By default, VLC can be controlled using the media keys on modern Apple " \
  90                                   "keyboards.")
  91
  92 #define INTERFACE_STYLE_TEXT N_("Run VLC with dark interface style")
  93 #define INTERFACE_STYLE_LONGTEXT N_("If this option is enabled, VLC will use the dark interface style. Otherwise, the grey interface style is used.")
  94
  95 #define NATIVE_FULLSCREEN_MODE_ON_LION_TEXT N_("Use the native fullscreen mode")
  96 #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.")
  97
  98 #define KEEPSIZE_TEXT N_("Resize interface to the native video size")
  99 #define KEEPSIZE_LONGTEXT N_("You have two choices:\n" \
 100 " - The interface will resize to the native video size\n" \
 101 " - The video will fit to the interface size\n " \
 102 "By default, interface resize to the native video size.")
 103
 104 #define PAUSE_MINIMIZED_TEXT N_("Pause the video playback when minimized")
 105 #define PAUSE_MINIMIZED_LONGTEXT N_(\
 106 "With this option enabled, the playback will be automatically paused when minimizing the window.")
 107
 108 #define ICONCHANGE_TEXT N_("Allow automatic icon changes")
 109 #define ICONCHANGE_LONGTEXT N_("This option allows the interface to change its icon on various occasions.")
 110
 111 #define LOCK_ASPECT_RATIO_TEXT N_("Lock Aspect Ratio")
 112
 113 #define DIM_KEYBOARD_PLAYBACK_TEXT N_("Dim keyboard backlight during fullscreen playback")
 114 #define DIM_KEYBOARD_PLAYBACK_LONGTEXT N_("Turn off the MacBook keyboard backlight while a video is playing in fullscreen. Automatic brightness adjustment should be disabled in System Preferences.")
 115
 116 #define JUMPBUTTONS_TEXT N_("Show Previous & Next Buttons")
 117 #define JUMPBUTTONS_LONGTEXT N_("Shows the previous and next buttons in the main window.")
 118
 119 #define PLAYMODEBUTTONS_TEXT N_("Show Shuffle & Repeat Buttons")
 120 #define PLAYMODEBUTTONS_LONGTEXT N_("Shows the shuffle and repeat buttons in the main window.")
 121
 122 #define EFFECTSBUTTON_TEXT N_("Show Audio Effects Button")
 123 #define EFFECTSBUTTON_LONGTEXT N_("Shows the audio effects button in the main window.")
 124
 125 #define SIDEBAR_TEXT N_("Show Sidebar")
 126 #define SIDEBAR_LONGTEXT N_("Shows a sidebar in the main window listing media sources.")
 127
 128 #define ITUNES_TEXT N_("Control external music players")
 129 #define ITUNES_LONGTEXT N_("VLC will pause and resume supported music players on playback.")
 130
 131 #define LARGE_LISTFONT_TEXT N_("Use large text for list views")
 132
 133 static const int itunes_list[] =
 134     { 0, 1, 2 };
 135 static const char *const itunes_list_text[] = {
 136     N_("Do nothing"), N_("Pause iTunes / Spotify"), N_("Pause and resume iTunes / Spotify")
 137 };
 138
 139 #define CONTINUE_PLAYBACK_TEXT N_("Continue playback where you left off")
 140 #define CONTINUE_PLAYBACK_LONGTEXT N_("VLC will store playback positions of the last 30 items you played. If you re-open one of those, playback will continue.")
 141
 142 static const int continue_playback_list[] =
 143 { 0, 1, 2 };
 144 static const char *const continue_playback_list_text[] = {
 145     N_("Ask"), N_("Always"), N_("Never")
 146 };
 147
 148 #define VOLUME_MAX_TEXT N_("Maximum Volume displayed")
 149
 150
 151 vlc_module_begin()
 152     set_description(N_("Mac OS X interface"))
 153     set_capability("interface", 200)
 154     set_callbacks(OpenIntf, CloseIntf)
 155     set_category(CAT_INTERFACE)
 156     set_subcategory(SUBCAT_INTERFACE_MAIN)
 157     cannot_unload_broken_library()
 158
 159     set_section(N_("Appearance"), 0)
 160         add_bool("macosx-interfacestyle", false, INTERFACE_STYLE_TEXT, INTERFACE_STYLE_LONGTEXT, false)
 161         add_bool("macosx-nativefullscreenmode", false, NATIVE_FULLSCREEN_MODE_ON_LION_TEXT, NATIVE_FULLSCREEN_MODE_ON_LION_LONGTEXT, false)
 162         add_bool("macosx-statusicon", true, DISPLAY_STATUS_ICONMENU_TEXT, DISPLAY_STATUS_ICONMENU_LONGTEXT, false)
 163         add_bool("macosx-icon-change", true, ICONCHANGE_TEXT, ICONCHANGE_LONGTEXT, true)
 164         add_bool("macosx-show-playback-buttons", false, JUMPBUTTONS_TEXT, JUMPBUTTONS_LONGTEXT, false)
 165         add_bool("macosx-show-playmode-buttons", false, PLAYMODEBUTTONS_TEXT, PLAYMODEBUTTONS_LONGTEXT, false)
 166         add_bool("macosx-show-effects-button", false, EFFECTSBUTTON_TEXT, EFFECTSBUTTON_LONGTEXT, false)
 167         add_bool("macosx-show-sidebar", true, SIDEBAR_TEXT, SIDEBAR_LONGTEXT, false)
 168         add_integer_with_range("macosx-max-volume", 125, 60, 200, VOLUME_MAX_TEXT, VOLUME_MAX_TEXT, true)
 169         add_bool("macosx-large-text", false, LARGE_LISTFONT_TEXT, LARGE_LISTFONT_TEXT, false)
 170
 171     set_section(N_("Behavior"), 0)
 172         add_bool("macosx-autoplay", true, AUTOPLAY_OSX_TEST, AUTOPLAY_OSX_LONGTEXT, false)
 173         add_bool("macosx-recentitems", true, RECENT_ITEMS_TEXT, RECENT_ITEMS_LONGTEXT, false)
 174         add_bool("macosx-fspanel", true, FSPANEL_TEXT, FSPANEL_LONGTEXT, false)
 175         add_bool("macosx-video-autoresize", true, KEEPSIZE_TEXT, KEEPSIZE_LONGTEXT, false)
 176         add_bool("macosx-pause-minimized", false, PAUSE_MINIMIZED_TEXT, PAUSE_MINIMIZED_LONGTEXT, false)
 177         add_bool("macosx-lock-aspect-ratio", true, LOCK_ASPECT_RATIO_TEXT, LOCK_ASPECT_RATIO_TEXT, true)
 178         add_bool("macosx-dim-keyboard", false, DIM_KEYBOARD_PLAYBACK_TEXT, DIM_KEYBOARD_PLAYBACK_LONGTEXT, false)
 179         add_integer("macosx-control-itunes", 1, ITUNES_TEXT, ITUNES_LONGTEXT, false)
 180         change_integer_list(itunes_list, itunes_list_text)
 181         add_integer("macosx-continue-playback", 0, CONTINUE_PLAYBACK_TEXT, CONTINUE_PLAYBACK_LONGTEXT, false)
 182         change_integer_list(continue_playback_list, continue_playback_list_text)
 183
 184     set_section(N_("Apple Remote and media keys"), 0)
 185         add_bool("macosx-appleremote", true, USE_APPLE_REMOTE_TEXT, USE_APPLE_REMOTE_LONGTEXT, false)
 186         add_bool("macosx-appleremote-sysvol", false, USE_APPLE_REMOTE_VOLUME_TEXT, USE_APPLE_REMOTE_VOLUME_LONGTEXT, false)
 187         add_bool("macosx-appleremote-prevnext", false, USE_APPLE_REMOTE_PREVNEXT_TEXT, USE_APPLE_REMOTE_PREVNEXT_LONGTEXT, false)
 188         add_bool("macosx-mediakeys", true, USE_MEDIAKEYS_TEXT, USE_MEDIAKEYS_LONGTEXT, false)
 189
 190     add_obsolete_bool("macosx-stretch") /* since 2.0.0 */
 191     add_obsolete_bool("macosx-eq-keep") /* since 2.0.0 */
 192     add_obsolete_bool("macosx-autosave-volume") /* since 2.1.0 */
 193
 194     add_submodule()
 195         set_description("Mac OS X Video Output Provider")
 196         set_capability("vout window", 100)
 197         set_callbacks(WindowOpen, WindowClose)
 198
 199         set_section(N_("Video output"), 0)
 200         add_integer("macosx-vdev", 0, VDEV_TEXT, VDEV_LONGTEXT, false)
 201         add_float_with_range("macosx-opaqueness", 1, 0, 1, OPAQUENESS_TEXT, OPAQUENESS_LONGTEXT, true);
 202         add_bool("macosx-black", false, BLACK_TEXT, BLACK_LONGTEXT, false)
 203 vlc_module_end()
 204