]> git.sesse.net Git - vlc/blobdiff - include/interface.h
* ./include/os_specific.h: fixed a C++ compilation issue.
[vlc] / include / interface.h
index 3791abb631e45f5b2c13962564fb6c9ae19d03e6..a688c423c94a2f3eaf6e7e9062e038e3728e3776 100644 (file)
-/******************************************************************************
+/*****************************************************************************
  * interface.h: interface access for other threads
- * (c)1999 VideoLAN
- ******************************************************************************
  * This library provides basic functions for threads to interact with user
  * interface, such as message output.
- ******************************************************************************
- * Required headers:
- *  <sys/uio.h>
- *  <X11/Xlib.h>
- *  <X11/extensions/XShm.h>
- *  "config.h"
- *  "common.h"
- *  "mtime.h"
- *  "vlc_thread.h"
- *  "input.h"
- *  "video.h"
- *  "video_output.h"
- *  "audio_output.h"
- *  "xconsole.h"
- ******************************************************************************/
-
-/******************************************************************************
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ * $Id: interface.h,v 1.28 2002/04/24 00:36:24 sam Exp $
+ *
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ *****************************************************************************/
+
+/*****************************************************************************
  * intf_thread_t: describe an interface thread
- ******************************************************************************
+ *****************************************************************************
  * This structe describes all interface-specific data of the main (interface)
  * thread.
- ******************************************************************************/
+ *****************************************************************************/
 typedef struct intf_thread_s
 {
-    boolean_t           b_die;                                  /* `die' flag */
+    boolean_t           b_die;                                 /* `die' flag */
 
-    /* Specific interfaces */     
-    p_intf_console_t    p_console;                                 /* console */
-    p_intf_sys_t        p_sys;                            /* system interface */
+    /* Specific interfaces */
+    p_intf_console_t    p_console;                                /* console */
+    p_intf_sys_t        p_sys;                           /* system interface */
+    
+    /* Plugin used and shortcuts to access its capabilities */
+    struct module_s *   p_module;
+    int              ( *pf_open )   ( struct intf_thread_s * );
+    void             ( *pf_close )  ( struct intf_thread_s * );
+    void             ( *pf_run )    ( struct intf_thread_s * );
 
-    /* Channels array - NULL if not used */
-    p_intf_channel_t    p_channel;                 /* description of channels */    
+    /* Interface callback */
+    void             ( *pf_manage ) ( struct intf_thread_s * );
 
-    /* Main threads - NULL if not active */
-    p_vout_thread_t     p_vout;
-    p_input_thread_t    p_input;        
+    /* XXX: new message passing stuff will go here */
+    vlc_mutex_t         change_lock;
+    boolean_t           b_menu_change;
+    boolean_t           b_menu;
+    
 } intf_thread_t;
 
-/******************************************************************************
+/*****************************************************************************
+ * msg_item_t
+ *****************************************************************************
+ * Store a single message. Messages have a maximal size of INTF_MSG_MSGSIZE.
+ *****************************************************************************/
+typedef struct
+{
+    int     i_type;                               /* message type, see below */
+    char *  psz_msg;                                   /* the message itself */
+
+#if 0
+    mtime_t date;                                     /* date of the message */
+    char *  psz_file;               /* file in which the function was called */
+    char *  psz_function;     /* function from which the function was called */
+    int     i_line;                 /* line at which the function was called */
+#endif
+} msg_item_t;
+
+/* Message types */
+#define INTF_MSG_STD    0                                /* standard message */
+#define INTF_MSG_ERR    1                                   /* error message */
+#define INTF_MSG_WARN   2                                 /* warning message */
+#define INTF_MSG_STAT   3                               /* statistic message */
+
+/*****************************************************************************
+ * intf_subscription_t
+ *****************************************************************************
+ * Used by interface plugins which subscribe to the message queue.
+ *****************************************************************************/
+typedef struct intf_subscription_s
+{
+    int   i_start;
+    int*  pi_stop;
+
+    msg_item_t*  p_msg;
+    vlc_mutex_t* p_lock;
+} intf_subscription_t;
+
+/*****************************************************************************
  * Prototypes
- ******************************************************************************/
-intf_thread_t * intf_Create             ( void );
-void            intf_Run                ( intf_thread_t * p_intf );
-void            intf_Destroy            ( intf_thread_t * p_intf );
+ *****************************************************************************/
+intf_thread_t * intf_Create       ( void );
+void            intf_Destroy      ( intf_thread_t * p_intf );
+
+void            intf_MsgCreate    ( void );
+void            intf_MsgDestroy   ( void );
 
-int             intf_SelectChannel      ( intf_thread_t * p_intf, int i_channel );
-int             intf_ProcessKey         ( intf_thread_t * p_intf, int i_key );
+#ifndef __PLUGIN__
+intf_subscription_t* intf_MsgSub    ( void );
+void                 intf_MsgUnsub  ( intf_subscription_t * );
+#else
+#   define intf_MsgSub p_symbols->intf_MsgSub
+#   define intf_MsgUnsub p_symbols->intf_MsgUnsub
+#endif