vlc_interface.h 6.08 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_interface.h: interface access for other threads
Michel Kaempf's avatar
Michel Kaempf committed
3 4
 * This library provides basic functions for threads to interact with user
 * interface, such as message output.
5
 *****************************************************************************
6
 * Copyright (C) 1999, 2000 VideoLAN
7
 * $Id$
8
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 11 12 13 14
 *
 * 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.
15
 *
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
20
 *
21 22 23
 * 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.
24 25
 *****************************************************************************/

Gildas Bazin's avatar
 
Gildas Bazin committed
26 27
typedef struct intf_dialog_args_t intf_dialog_args_t;

Clément Stenac's avatar
Clément Stenac committed
28 29
/**
 * \file
Clément Stenac's avatar
Clément Stenac committed
30 31
 * This file contains structures and function prototypes for
 * interface management in vlc
Clément Stenac's avatar
Clément Stenac committed
32 33 34
 */


35
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
36
 * intf_thread_t: describe an interface thread
37
 *****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
38
 * This struct describes all interface-specific data of the main (interface)
Michel Kaempf's avatar
Michel Kaempf committed
39
 * thread.
40
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
41 42 43 44 45 46

/**
 * \defgroup vlc_interface Interface
 * These functions and structures are for interface management
 * @{
 */
47
struct intf_thread_t
Michel Kaempf's avatar
Michel Kaempf committed
48
{
49 50 51 52
    VLC_COMMON_MEMBERS

    /* Thread properties and locks */
    vlc_bool_t          b_block;
Michel Kaempf's avatar
Michel Kaempf committed
53

54
    /* Specific interfaces */
Gildas Bazin's avatar
 
Gildas Bazin committed
55 56
    intf_console_t *    p_console;                               /** console */
    intf_sys_t *        p_sys;                          /** system interface */
57

Clément Stenac's avatar
Clément Stenac committed
58
    /** Interface module */
59
    module_t *   p_module;
Clément Stenac's avatar
Clément Stenac committed
60
    void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
61

Clément Stenac's avatar
Clément Stenac committed
62
    /** Specific for dialogs providers */
Gildas Bazin's avatar
 
Gildas Bazin committed
63 64
    void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
                               intf_dialog_args_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
65

Gildas Bazin's avatar
Gildas Bazin committed
66 67 68 69 70
    /** Video window callbacks */
    void * ( *pf_request_window ) ( intf_thread_t *, int *, int *,
                                    unsigned int *, unsigned int * );
    void   ( *pf_release_window ) ( intf_thread_t *, void * );

Sam Hocevar's avatar
 
Sam Hocevar committed
71
    /* XXX: new message passing stuff will go here */
72 73 74
    vlc_mutex_t  change_lock;
    vlc_bool_t   b_menu_change;
    vlc_bool_t   b_menu;
Gildas Bazin's avatar
 
Gildas Bazin committed
75 76 77

    /* Provides the ability to switch an interface on the fly */
    char *psz_switch_intf;
78
};
Sam Hocevar's avatar
 
Sam Hocevar committed
79

Gildas Bazin's avatar
 
Gildas Bazin committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
/*****************************************************************************
 * intf_dialog_args_t: arguments structure passed to a dialogs provider.
 *****************************************************************************
 * This struct describes the arguments passed to the dialogs provider.
 * For now they are only used with INTF_DIALOG_FILE_GENERIC.
 *****************************************************************************/
struct intf_dialog_args_t
{
    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;

    void (*pf_callback) ( intf_dialog_args_t * );
    void *p_arg;

    /* Specifically for INTF_DIALOG_FILE_GENERIC */
    char *psz_extensions;
    vlc_bool_t b_save;
    vlc_bool_t b_multiple;
};

107
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
108
 * Prototypes
109
 *****************************************************************************/
110
#define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
111
VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
Sam Hocevar's avatar
Sam Hocevar committed
112
VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
113 114
VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
Vincent Seguin's avatar
Vincent Seguin committed
115

Clément Stenac's avatar
Clément Stenac committed
116 117
/*@}*/

Gildas Bazin's avatar
 
Gildas Bazin committed
118 119 120
/*****************************************************************************
 * Macros
 *****************************************************************************/
121
#if defined( WIN32 ) && !defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
122
#    define CONSOLE_INTRO_MSG \
Gildas Bazin's avatar
 
Gildas Bazin committed
123 124 125 126
         AllocConsole(); \
         freopen( "CONOUT$", "w", stdout ); \
         freopen( "CONOUT$", "w", stderr ); \
         freopen( "CONIN$", "r", stdin ); \
Sam Hocevar's avatar
Sam Hocevar committed
127
         msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
Gildas Bazin's avatar
 
Gildas Bazin committed
128 129 130
         msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
                             "anymore, open a dos command box, go to the " \
                             "directory where you installed VLC and run " \
Gildas Bazin's avatar
 
Gildas Bazin committed
131
                             "\"vlc -I wxwin\"\n") )
Gildas Bazin's avatar
 
Gildas Bazin committed
132 133 134
#else
#    define CONSOLE_INTRO_MSG
#endif
Gildas Bazin's avatar
 
Gildas Bazin committed
135 136 137 138 139 140 141 142

/* Interface dialog ids for dialog providers */
#define INTF_DIALOG_FILE_SIMPLE 1
#define INTF_DIALOG_FILE        2
#define INTF_DIALOG_DISC        3
#define INTF_DIALOG_NET         4
#define INTF_DIALOG_SAT         5

Gildas Bazin's avatar
 
Gildas Bazin committed
143
#define INTF_DIALOG_STREAMWIZARD 8
144
#define INTF_DIALOG_WIZARD 9
145

Gildas Bazin's avatar
 
Gildas Bazin committed
146 147 148 149
#define INTF_DIALOG_PLAYLIST   10
#define INTF_DIALOG_MESSAGES   11
#define INTF_DIALOG_FILEINFO   12
#define INTF_DIALOG_PREFS      13
Gildas Bazin's avatar
Gildas Bazin committed
150
#define INTF_DIALOG_BOOKMARKS  14
Gildas Bazin's avatar
 
Gildas Bazin committed
151 152

#define INTF_DIALOG_POPUPMENU  20
Gildas Bazin's avatar
 
Gildas Bazin committed
153 154 155 156

#define INTF_DIALOG_FILE_GENERIC 30

#define INTF_DIALOG_EXIT       99
Gildas Bazin's avatar
 
Gildas Bazin committed
157 158 159 160 161 162 163 164 165 166 167

/* Useful text messages shared by interfaces */
#define INTF_ABOUT_MSG \
    _( "VLC is an open-source and cross-platform multimedia " \
       "player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, " \
       "DivX, mp3, Ogg, ...) as well as DVDs, VCDs, CD audio, and various " \
       "streaming protocols.\n\n" \
       "VLC is also a streaming server with transcoding capabilities " \
       "(UDP unicast and multicast, HTTP, ...) mainly designed for " \
       "high-bandwidth networks.\n\n"\
       "For more information, have a look at the web site." )