20d64ac960ef540fb5012c2b53aa966b7560ff00
[vlc.git] / 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.33 2002/07/31 20:56:50 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  * intf_thread_t: describe an interface thread
28  *****************************************************************************
29  * This structe describes all interface-specific data of the main (interface)
30  * thread.
31  *****************************************************************************/
32 struct intf_thread_t
33 {
34     VLC_COMMON_MEMBERS
35
36     /* Thread properties and locks */
37     vlc_bool_t          b_block;
38
39     /* Specific interfaces */
40     intf_console_t *    p_console;                                /* console */
41     intf_sys_t *        p_sys;                           /* system interface */
42     
43     /* Interface module */
44     module_t *   p_module;
45     void      ( *pf_run )    ( intf_thread_t * );
46
47     /* XXX: new message passing stuff will go here */
48     vlc_mutex_t  change_lock;
49     vlc_bool_t   b_menu_change;
50     vlc_bool_t   b_menu;
51 };
52
53 /*****************************************************************************
54  * Prototypes
55  *****************************************************************************/
56 #define intf_Create(a) __intf_Create(VLC_OBJECT(a))
57 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t * ) );
58 VLC_EXPORT( vlc_error_t,       intf_RunThread,  ( intf_thread_t * ) );
59 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
60 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
61