git.sesse.net Git - vlc/blob - include/interface.h

   1 /*****************************************************************************
   2  * 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 VideoLAN
   7  * $Id: interface.h,v 1.23 2001/12/09 17:01:35 sam Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Required headers:
  28  *  <X11/Xlib.h>
  29  *  <X11/extensions/XShm.h>
  30  *  "config.h"
  31  *  "common.h"
  32  *  "mtime.h"
  33  *  "threads.h"
  34  *  "input.h"
  35  *  "video.h"
  36  *  "video_output.h"
  37  *  "audio_output.h"
  38  *  "xconsole.h"
  39  *****************************************************************************/
  40
  41 /*****************************************************************************
  42  * intf_thread_t: describe an interface thread
  43  *****************************************************************************
  44  * This structe describes all interface-specific data of the main (interface)
  45  * thread.
  46  *****************************************************************************/
  47 typedef struct intf_thread_s
  48 {
  49     boolean_t           b_die;                                 /* `die' flag */
  50
  51     /* Specific interfaces */
  52     p_intf_console_t    p_console;                                /* console */
  53     p_intf_sys_t        p_sys;                           /* system interface */
  54
  55     /* Plugin used and shortcuts to access its capabilities */
  56     struct module_s *   p_module;
  57     int              ( *pf_open )   ( struct intf_thread_s * );
  58     void             ( *pf_close )  ( struct intf_thread_s * );
  59     void             ( *pf_run )    ( struct intf_thread_s * );
  60
  61     /* Interface callback */
  62     void             ( *pf_manage ) ( struct intf_thread_s * );
  63
  64     /* XXX: Channels array - new API */
  65   //p_intf_channel_t *  p_channel[INTF_MAX_CHANNELS];/* channel descriptions */
  66
  67     /* Channels array - NULL if not used */
  68     p_intf_channel_t    p_channel;                /* description of channels */
  69
  70     /* Input thread - NULL if not active */
  71     p_input_thread_t    p_input;
  72
  73     /* XXX: new message passing stuff will go here */
  74     vlc_mutex_t         change_lock;
  75     boolean_t           b_menu_change;
  76     boolean_t           b_menu;
  77
  78 } intf_thread_t;
  79
  80 /*****************************************************************************
  81  * Prototypes
  82  *****************************************************************************/
  83 intf_thread_t * intf_Create             ( void );
  84 void            intf_Destroy            ( intf_thread_t * p_intf );
  85