git.sesse.net Git - vlc/blob - modules/video_output/x11/x11.c

   1 /*****************************************************************************
   2  * x11.c : X11 plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 1998-2001 VideoLAN
   5  * $Id: x11.c,v 1.2 2002/08/26 09:12:46 sam Exp $
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          David Kennedy <dkennedy@tinytoad.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #include <stdlib.h>                                      /* malloc(), free() */
  30 #include <string.h>                                            /* strerror() */
  31
  32 #include <vlc/vlc.h>
  33
  34 /*****************************************************************************
  35  * Exported prototypes
  36  *****************************************************************************/
  37 extern int  E_(Activate)   ( vlc_object_t * );
  38 extern void E_(Deactivate) ( vlc_object_t * );
  39
  40 /*****************************************************************************
  41  * Module descriptor
  42  *****************************************************************************/
  43 #define ALT_FS_TEXT N_("alternate fullscreen method")
  44 #define ALT_FS_LONGTEXT N_( \
  45     "There are two ways to make a fullscreen window, unfortunately each one " \
  46     "has its drawbacks.\n" \
  47     "1) Let the window manager handle your fullscreen window (default). But " \
  48     "things like taskbars will likely show on top of the video.\n" \
  49     "2) Completly bypass the window manager, but then nothing will be able " \
  50     "to show on top of the video.")
  51
  52 #define DISPLAY_TEXT N_("X11 display name")
  53 #define DISPLAY_LONGTEXT N_( \
  54     "Specify the X11 hardware display you want to use. By default vlc will " \
  55     "use the value of the DISPLAY environment variable.")
  56
  57 #define DRAWABLE_TEXT N_("X11 drawable")
  58 #define DRAWABLE_LONGTEXT N_( \
  59     "Specify a X11 drawable to use instead of opening a new window. This " \
  60     "option is DANGEROUS, use with care.")
  61
  62 #define SHM_TEXT N_("use shared memory")
  63 #define SHM_LONGTEXT N_( \
  64     "Use shared memory to communicate between vlc and the X server.")
  65
  66 vlc_module_begin();
  67     add_category_hint( N_("X11"), NULL );
  68     add_string( "x11-display", NULL, NULL, DISPLAY_TEXT, DISPLAY_LONGTEXT );
  69     add_bool( "x11-altfullscreen", 0, NULL, ALT_FS_TEXT, ALT_FS_LONGTEXT );
  70     add_integer( "x11-drawable", -1, NULL, DRAWABLE_TEXT, DRAWABLE_LONGTEXT );
  71 #ifdef HAVE_SYS_SHM_H
  72     add_bool( "x11-shm", 1, NULL, SHM_TEXT, SHM_LONGTEXT );
  73 #endif
  74     set_description( _("X11 module") );
  75     set_capability( "video output", 50 );
  76     set_callbacks( E_(Activate), E_(Deactivate) );
  77 vlc_module_end();
  78