]> git.sesse.net Git - vlc/blobdiff - include/vlc_interface.h
* Make ParseOption (from input) a global service (var_OptionParse)
[vlc] / include / vlc_interface.h
index 9b7c2562456854e8b8adc7b8485988f1b2dfeb43..0b8747a9dc6e2e3e38658a2b5186014cdeeea6b1 100644 (file)
@@ -3,8 +3,8 @@
  * This library provides basic functions for threads to interact with user
  * interface, such as message output.
  *****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
- * $Id: vlc_interface.h,v 1.4 2003/07/20 10:38:49 gbazin Exp $
+ * Copyright (C) 1999, 2000 the VideoLAN team
+ * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+
 typedef struct intf_dialog_args_t intf_dialog_args_t;
 
+/**
+ * \file
+ * This file contains structures and function prototypes for
+ * interface management in vlc
+ */
+
+
 /*****************************************************************************
  * intf_thread_t: describe an interface thread
  *****************************************************************************
  * This struct describes all interface-specific data of the main (interface)
  * thread.
  *****************************************************************************/
+
+/**
+ * \defgroup vlc_interface Interface
+ * These functions and structures are for interface management
+ * @{
+ */
 struct intf_thread_t
 {
     VLC_COMMON_MEMBERS
 
     /* Thread properties and locks */
     vlc_bool_t          b_block;
+    vlc_bool_t          b_play;
 
     /* Specific interfaces */
-    intf_console_t *    p_console;                                /* console */
-    intf_sys_t *        p_sys;                           /* system interface */
+    intf_console_t *    p_console;                               /** console */
+    intf_sys_t *        p_sys;                          /** system interface */
 
-    /* Interface module */
+    /** Interface module */
     module_t *   p_module;
-    void      ( *pf_run )    ( intf_thread_t * );
+    void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
 
-    /* Specific for dialogs providers */
+    /** Specific for dialogs providers */
     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
                                intf_dialog_args_t * );
 
+    /** Interaction stuff */
+    vlc_bool_t b_interaction;
+
+    /** Video window callbacks */
+    void * ( *pf_request_window ) ( intf_thread_t *, vout_thread_t *,
+                                    int *, int *,
+                                    unsigned int *, unsigned int * );
+    void   ( *pf_release_window ) ( intf_thread_t *, void * );
+    int    ( *pf_control_window ) ( intf_thread_t *, void *, int, va_list );
+
     /* XXX: new message passing stuff will go here */
     vlc_mutex_t  change_lock;
     vlc_bool_t   b_menu_change;
     vlc_bool_t   b_menu;
+
+    /* Provides the ability to switch an interface on the fly */
+    char *psz_switch_intf;
 };
 
 /*****************************************************************************
@@ -64,13 +92,9 @@ struct intf_thread_t
  *****************************************************************************/
 struct intf_dialog_args_t
 {
+    intf_thread_t *p_intf;
     char *psz_title;
 
-    vlc_bool_t  b_blocking;
-    vlc_bool_t  b_ready;
-    vlc_mutex_t lock;
-    vlc_cond_t  wait;
-
     char **psz_results;
     int  i_results;
 
@@ -81,26 +105,34 @@ struct intf_dialog_args_t
     char *psz_extensions;
     vlc_bool_t b_save;
     vlc_bool_t b_multiple;
+
+    /* Specific to INTF_DIALOG_INTERACTION */
+    interaction_dialog_t *p_dialog;
 };
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-#define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
-VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
+#define intf_Create(a,b,c,d) __intf_Create(VLC_OBJECT(a),b,c,d)
+VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char *, int, char ** ) );
 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
 
+/*@}*/
+
 /*****************************************************************************
  * Macros
  *****************************************************************************/
 #if defined( WIN32 ) && !defined( UNDER_CE )
 #    define CONSOLE_INTRO_MSG \
+         if( !getenv( "PWD" ) || !getenv( "PS1" ) ) /* detect cygwin shell */ \
+         { \
          AllocConsole(); \
          freopen( "CONOUT$", "w", stdout ); \
          freopen( "CONOUT$", "w", stderr ); \
          freopen( "CONIN$", "r", stdin ); \
+         } \
          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
                              "anymore, open a dos command box, go to the " \
@@ -115,15 +147,29 @@ VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
 #define INTF_DIALOG_FILE        2
 #define INTF_DIALOG_DISC        3
 #define INTF_DIALOG_NET         4
-#define INTF_DIALOG_SAT         5
+#define INTF_DIALOG_CAPTURE     5
+#define INTF_DIALOG_SAT         6
+
+#define INTF_DIALOG_DIRECTORY   7
+
+#define INTF_DIALOG_STREAMWIZARD 8
+#define INTF_DIALOG_WIZARD 9
 
 #define INTF_DIALOG_PLAYLIST   10
 #define INTF_DIALOG_MESSAGES   11
 #define INTF_DIALOG_FILEINFO   12
 #define INTF_DIALOG_PREFS      13
+#define INTF_DIALOG_BOOKMARKS  14
 
 #define INTF_DIALOG_POPUPMENU  20
 
 #define INTF_DIALOG_FILE_GENERIC 30
+#define INTF_DIALOG_INTERACTION 50
+
+#define INTF_DIALOG_UPDATEVLC   90
+#define INTF_DIALOG_VLM   91
 
 #define INTF_DIALOG_EXIT       99
+
+/* Useful text messages shared by interfaces */
+#define INTF_ABOUT_MSG LICENSE_MSG