* modules/*: sanitization of the modules description strings.
[vlc.git] / modules / video_output / x11 / xvideo.c
1 /*****************************************************************************
2  * xvideo.c : Xvideo plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 1998-2001 VideoLAN
5  * $Id: xvideo.c,v 1.6 2003/03/30 18:14:39 gbazin Exp $
6  *
7  * Authors: Shane Harper <shanegh@optusnet.com.au>
8  *          Vincent Seguin <seguin@via.ecp.fr>
9  *          Samuel Hocevar <sam@zoy.org>
10  *          David Kennedy <dkennedy@tinytoad.com>
11  *      
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  * 
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30 #include <stdlib.h>                                      /* malloc(), free() */
31 #include <string.h>                                            /* strerror() */
32
33 #include <vlc/vlc.h>
34
35 /*****************************************************************************
36  * Exported prototypes
37  *****************************************************************************/
38 extern int  E_(Activate)   ( vlc_object_t * );
39 extern void E_(Deactivate) ( vlc_object_t * );
40
41 /*****************************************************************************
42  * Module descriptor
43  *****************************************************************************/
44 #define ADAPTOR_TEXT N_("XVideo adaptor number")
45 #define ADAPTOR_LONGTEXT N_( \
46     "If you graphics card provides several adaptors, this option allows you " \
47     "to choose which one will be used (you shouldn't have to change this).")
48
49 #define ALT_FS_TEXT N_("alternate fullscreen method")
50 #define ALT_FS_LONGTEXT N_( \
51     "There are two ways to make a fullscreen window, unfortunately each one " \
52     "has its drawbacks.\n" \
53     "1) Let the window manager handle your fullscreen window (default). But " \
54     "things like taskbars will likely show on top of the video.\n" \
55     "2) Completly bypass the window manager, but then nothing will be able " \
56     "to show on top of the video.")
57
58 #define DISPLAY_TEXT N_("X11 display name")
59 #define DISPLAY_LONGTEXT N_( \
60     "Specify the X11 hardware display you want to use. By default VLC will " \
61     "use the value of the DISPLAY environment variable.")
62
63 #define CHROMA_TEXT N_("XVimage chroma format")
64 #define CHROMA_LONGTEXT N_( \
65     "Force the XVideo renderer to use a specific chroma format instead of " \
66     "trying to improve performances by using the most efficient one.")
67
68 #define SHM_TEXT N_("use shared memory")
69 #define SHM_LONGTEXT N_( \
70     "Use shared memory to communicate between VLC and the X server.")
71
72 vlc_module_begin();
73     add_category_hint( N_("XVideo"), NULL, VLC_TRUE );
74     add_string( "xvideo-display", NULL, NULL, DISPLAY_TEXT, DISPLAY_LONGTEXT, VLC_TRUE );
75     add_integer( "xvideo-adaptor", -1, NULL, ADAPTOR_TEXT, ADAPTOR_LONGTEXT, VLC_TRUE );
76     add_bool( "xvideo-altfullscreen", 0, NULL, ALT_FS_TEXT, ALT_FS_LONGTEXT, VLC_TRUE );
77     add_string( "xvideo-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, VLC_TRUE );
78 #ifdef HAVE_SYS_SHM_H
79     add_bool( "xvideo-shm", 1, NULL, SHM_TEXT, SHM_LONGTEXT, VLC_TRUE );
80 #endif
81     set_description( _("XVideo extension video output") );
82     set_capability( "video output", 150 );
83     set_callbacks( E_(Activate), E_(Deactivate) );
84 vlc_module_end();
85
86 /* following functions are local */
87
88 #if 0
89 /*****************************************************************************
90  * XVideoSetAttribute
91  *****************************************************************************
92  * This function can be used to set attributes, e.g. XV_BRIGHTNESS and
93  * XV_CONTRAST. "f_value" should be in the range of 0 to 1.
94  *****************************************************************************/
95 static void XVideoSetAttribute( vout_thread_t *p_vout,
96                                 char *attr_name, float f_value )
97 {
98     int             i_attrib;
99     XvAttribute    *p_attrib;
100     Display        *p_display = p_vout->p_sys->p_display;
101     int             i_xvport  = p_vout->p_sys->i_xvport;
102
103     p_attrib = XvQueryPortAttributes( p_display, i_xvport, &i_attrib );
104
105     do
106     {
107         i_attrib--;
108
109         if( i_attrib >= 0 && !strcmp( p_attrib[ i_attrib ].name, attr_name ) )
110         {
111             int i_sv = f_value * ( p_attrib[ i_attrib ].max_value
112                                     - p_attrib[ i_attrib ].min_value + 1 )
113                         + p_attrib[ i_attrib ].min_value;
114
115             XvSetPortAttribute( p_display, i_xvport,
116                             XInternAtom( p_display, attr_name, False ), i_sv );
117             break;
118         }
119
120     } while( i_attrib > 0 );
121
122     if( p_attrib )
123         XFree( p_attrib );
124 }
125 #endif
126