* Make ParseOption (from input) a global service (var_OptionParse)
[vlc.git] / include / vlc_interface.h
1 /*****************************************************************************
2  * vlc_interface.h: interface access for other threads
3  * This library provides basic functions for threads to interact with user
4  * interface, such as message output.
5  *****************************************************************************
6  * Copyright (C) 1999, 2000 the VideoLAN team
7  * $Id$
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26
27 typedef struct intf_dialog_args_t intf_dialog_args_t;
28
29 /**
30  * \file
31  * This file contains structures and function prototypes for
32  * interface management in vlc
33  */
34
35
36 /*****************************************************************************
37  * intf_thread_t: describe an interface thread
38  *****************************************************************************
39  * This struct describes all interface-specific data of the main (interface)
40  * thread.
41  *****************************************************************************/
42
43 /**
44  * \defgroup vlc_interface Interface
45  * These functions and structures are for interface management
46  * @{
47  */
48 struct intf_thread_t
49 {
50     VLC_COMMON_MEMBERS
51
52     /* Thread properties and locks */
53     vlc_bool_t          b_block;
54     vlc_bool_t          b_play;
55
56     /* Specific interfaces */
57     intf_console_t *    p_console;                               /** console */
58     intf_sys_t *        p_sys;                          /** system interface */
59
60     /** Interface module */
61     module_t *   p_module;
62     void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
63
64     /** Specific for dialogs providers */
65     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
66                                intf_dialog_args_t * );
67
68     /** Interaction stuff */
69     vlc_bool_t b_interaction;
70
71     /** Video window callbacks */
72     void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
73                                     int *, int *,
74                                     unsigned int *, unsigned int * );
75     void   ( *pf_release_window ) ( intf_thread_t *, void * );
76     int    ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
77
78     /* XXX: new message passing stuff will go here */
79     vlc_mutex_t  change_lock;
80     vlc_bool_t   b_menu_change;
81     vlc_bool_t   b_menu;
82
83     /* Provides the ability to switch an interface on the fly */
84     char *psz_switch_intf;
85 };
86
87 /*****************************************************************************
88  * intf_dialog_args_t: arguments structure passed to a dialogs provider.
89  *****************************************************************************
90  * This struct describes the arguments passed to the dialogs provider.
91  * For now they are only used with INTF_DIALOG_FILE_GENERIC.
92  *****************************************************************************/
93 struct intf_dialog_args_t
94 {
95     intf_thread_t *p_intf;
96     char *psz_title;
97
98     char **psz_results;
99     int  i_results;
100
101     void (*pf_callback) ( intf_dialog_args_t * );
102     void *p_arg;
103
104     /* Specifically for INTF_DIALOG_FILE_GENERIC */
105     char *psz_extensions;
106     vlc_bool_t b_save;
107     vlc_bool_t b_multiple;
108
109     /* Specific to INTF_DIALOG_INTERACTION */
110     interaction_dialog_t *p_dialog;
111 };
112
113 /*****************************************************************************
114  * Prototypes
115  *****************************************************************************/
116 #define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
117 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char *, int, char ** ) );
118 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
119 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
120 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
121
122 /*@}*/
123
124 /*****************************************************************************
125  * Macros
126  *****************************************************************************/
127 #if defined( WIN32 ) && !defined( UNDER_CE )
128 #    define CONSOLE_INTRO_MSG \
129          if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
130          { \
131          AllocConsole(); \
132          freopen( "CONOUT$", "w", stdout ); \
133          freopen( "CONOUT$", "w", stderr ); \
134          freopen( "CONIN$", "r", stdin ); \
135          } \
136          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
137          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
138                              "anymore, open a dos command box, go to the " \
139                              "directory where you installed VLC and run " \
140                              "\"vlc -I wxwin\"\n") )
141 #else
142 #    define CONSOLE_INTRO_MSG
143 #endif
144
145 /* Interface dialog ids for dialog providers */
146 #define INTF_DIALOG_FILE_SIMPLE 1
147 #define INTF_DIALOG_FILE        2
148 #define INTF_DIALOG_DISC        3
149 #define INTF_DIALOG_NET         4
150 #define INTF_DIALOG_CAPTURE     5
151 #define INTF_DIALOG_SAT         6
152
153 #define INTF_DIALOG_DIRECTORY   7
154
155 #define INTF_DIALOG_STREAMWIZARD 8
156 #define INTF_DIALOG_WIZARD 9
157
158 #define INTF_DIALOG_PLAYLIST   10
159 #define INTF_DIALOG_MESSAGES   11
160 #define INTF_DIALOG_FILEINFO   12
161 #define INTF_DIALOG_PREFS      13
162 #define INTF_DIALOG_BOOKMARKS  14
163
164 #define INTF_DIALOG_POPUPMENU  20
165
166 #define INTF_DIALOG_FILE_GENERIC 30
167 #define INTF_DIALOG_INTERACTION 50
168
169 #define INTF_DIALOG_UPDATEVLC   90
170 #define INTF_DIALOG_VLM   91
171
172 #define INTF_DIALOG_EXIT       99
173
174 /* Useful text messages shared by interfaces */
175 #define INTF_ABOUT_MSG LICENSE_MSG