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  *
   8  * Authors:
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Required headers:
  27  *  <X11/Xlib.h>
  28  *  <X11/extensions/XShm.h>
  29  *  "config.h"
  30  *  "common.h"
  31  *  "mtime.h"
  32  *  "threads.h"
  33  *  "input.h"
  34  *  "video.h"
  35  *  "video_output.h"
  36  *  "audio_output.h"
  37  *  "xconsole.h"
  38  *****************************************************************************/
  39
  40 /*****************************************************************************
  41  * intf_thread_t: describe an interface thread
  42  *****************************************************************************
  43  * This structe describes all interface-specific data of the main (interface)
  44  * thread.
  45  *****************************************************************************/
  46 typedef int   ( intf_sys_create_t )   ( p_intf_thread_t p_intf );
  47 typedef void  ( intf_sys_destroy_t )  ( p_intf_thread_t p_intf );
  48 typedef void  ( intf_sys_manage_t )   ( p_intf_thread_t p_intf );
  49
  50
  51 typedef struct _keyparam
  52 {
  53     int key;
  54     int param;
  55 } keyparm;
  56
  57 typedef struct _key
  58 {
  59     int received_key;
  60     keyparm forwarded;
  61     struct _key *  next;
  62 } intf_key;
  63
  64 typedef intf_key * p_intf_key;
  65
  66 typedef struct intf_thread_s
  67 {
  68     boolean_t           b_die;                                 /* `die' flag */
  69
  70     /* Specific interfaces */
  71     p_intf_console_t    p_console;                                /* console */
  72     p_intf_sys_t        p_sys;                           /* system interface */
  73     p_intf_key          p_keys;
  74
  75     /* Plugin */
  76     intf_sys_create_t *     p_sys_create;         /* create interface thread */
  77     intf_sys_manage_t *     p_sys_manage;                       /* main loop */
  78     intf_sys_destroy_t *    p_sys_destroy;              /* destroy interface */
  79
  80     /* XXX: Channels array - new API */
  81   //p_intf_channel_t *  p_channel[INTF_MAX_CHANNELS];/* channel descriptions */
  82
  83     /* Channels array - NULL if not used */
  84     p_intf_channel_t    p_channel;                /* description of channels */
  85
  86     /* Main threads - NULL if not active */
  87     p_vout_thread_t     p_vout;
  88     p_input_thread_t    p_input;
  89
  90     /* Specific functions */
  91     keyparm (*p_intf_get_key)(struct intf_thread_s *p_intf, int r_key) ;
  92
  93     /* Warning messages level */
  94     int                 i_warning_level;
  95 } intf_thread_t;
  96
  97 /*****************************************************************************
  98  * Prototypes
  99  *****************************************************************************/
 100 intf_thread_t * intf_Create             ( void );
 101 void            intf_Run                ( intf_thread_t * p_intf );
 102 void            intf_Destroy            ( intf_thread_t * p_intf );
 103
 104 int             intf_SelectChannel      ( intf_thread_t * p_intf, int i_channel );
 105 int             intf_ProcessKey         ( intf_thread_t * p_intf, int i_key );
 106
 107 void intf_AssignKey( intf_thread_t *p_intf, int r_key, int f_key, int param);
 108 keyparm intf_GetKey( intf_thread_t *p_intf, int r_key);
 109 void intf_AssignNormalKeys( intf_thread_t *p_intf);
 110