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

   1 /*****************************************************************************
   2  * vlc_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: vlc_interface.h,v 1.9 2004/01/25 18:17:08 zorglub 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 typedef struct intf_dialog_args_t intf_dialog_args_t;
  27
  28 /**
  29  * \file
  30  * This file contains structures and function prototypes for
  31  * interface management in vlc
  32  */
  33
  34
  35 /*****************************************************************************
  36  * intf_thread_t: describe an interface thread
  37  *****************************************************************************
  38  * This struct describes all interface-specific data of the main (interface)
  39  * thread.
  40  *****************************************************************************/
  41
  42 /**
  43  * \defgroup vlc_interface Interface
  44  * These functions and structures are for interface management
  45  * @{
  46  */
  47 struct intf_thread_t
  48 {
  49     VLC_COMMON_MEMBERS
  50
  51     /* Thread properties and locks */
  52     vlc_bool_t          b_block;
  53
  54     /* Specific interfaces */
  55     intf_console_t *    p_console;                               /** console */
  56     intf_sys_t *        p_sys;                          /** system interface */
  57
  58     /** Interface module */
  59     module_t *   p_module;
  60     void      ( *pf_run )    ( intf_thread_t * ); /** Run function */
  61
  62     /** Specific for dialogs providers */
  63     void ( *pf_show_dialog ) ( intf_thread_t *, int, int,
  64                                intf_dialog_args_t * );
  65
  66     /* XXX: new message passing stuff will go here */
  67     vlc_mutex_t  change_lock;
  68     vlc_bool_t   b_menu_change;
  69     vlc_bool_t   b_menu;
  70
  71     /* Provides the ability to switch an interface on the fly */
  72     char *psz_switch_intf;
  73 };
  74
  75 /*****************************************************************************
  76  * intf_dialog_args_t: arguments structure passed to a dialogs provider.
  77  *****************************************************************************
  78  * This struct describes the arguments passed to the dialogs provider.
  79  * For now they are only used with INTF_DIALOG_FILE_GENERIC.
  80  *****************************************************************************/
  81 struct intf_dialog_args_t
  82 {
  83     char *psz_title;
  84
  85     vlc_bool_t  b_blocking;
  86     vlc_bool_t  b_ready;
  87     vlc_mutex_t lock;
  88     vlc_cond_t  wait;
  89
  90     char **psz_results;
  91     int  i_results;
  92
  93     void (*pf_callback) ( intf_dialog_args_t * );
  94     void *p_arg;
  95
  96     /* Specifically for INTF_DIALOG_FILE_GENERIC */
  97     char *psz_extensions;
  98     vlc_bool_t b_save;
  99     vlc_bool_t b_multiple;
 100 };
 101
 102 /*****************************************************************************
 103  * Prototypes
 104  *****************************************************************************/
 105 #define intf_Create(a,b) __intf_Create(VLC_OBJECT(a),b)
 106 VLC_EXPORT( intf_thread_t *, __intf_Create,     ( vlc_object_t *, const char * ) );
 107 VLC_EXPORT( int,               intf_RunThread,  ( intf_thread_t * ) );
 108 VLC_EXPORT( void,              intf_StopThread, ( intf_thread_t * ) );
 109 VLC_EXPORT( void,              intf_Destroy,    ( intf_thread_t * ) );
 110
 111 /*@}*/
 112
 113 /*****************************************************************************
 114  * Macros
 115  *****************************************************************************/
 116 #if defined( WIN32 ) && !defined( UNDER_CE )
 117 #    define CONSOLE_INTRO_MSG \
 118          AllocConsole(); \
 119          freopen( "CONOUT$", "w", stdout ); \
 120          freopen( "CONOUT$", "w", stderr ); \
 121          freopen( "CONIN$", "r", stdin ); \
 122          msg_Info( p_intf, COPYRIGHT_MESSAGE ); \
 123          msg_Info( p_intf, _("\nWarning: if you can't access the GUI " \
 124                              "anymore, open a dos command box, go to the " \
 125                              "directory where you installed VLC and run " \
 126                              "\"vlc -I wxwin\"\n") )
 127 #else
 128 #    define CONSOLE_INTRO_MSG
 129 #endif
 130
 131 /* Interface dialog ids for dialog providers */
 132 #define INTF_DIALOG_FILE_SIMPLE 1
 133 #define INTF_DIALOG_FILE        2
 134 #define INTF_DIALOG_DISC        3
 135 #define INTF_DIALOG_NET         4
 136 #define INTF_DIALOG_SAT         5
 137
 138 #define INTF_DIALOG_STREAM     8
 139
 140 #define INTF_DIALOG_PLAYLIST   10
 141 #define INTF_DIALOG_MESSAGES   11
 142 #define INTF_DIALOG_FILEINFO   12
 143 #define INTF_DIALOG_PREFS      13
 144
 145 #define INTF_DIALOG_POPUPMENU  20
 146
 147 #define INTF_DIALOG_FILE_GENERIC 30
 148
 149 #define INTF_DIALOG_EXIT       99
 150
 151 /* Useful text messages shared by interfaces */
 152 #define INTF_ABOUT_MSG \
 153     _( "VLC is an open-source and cross-platform multimedia " \
 154        "player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, " \
 155        "DivX, mp3, Ogg, ...) as well as DVDs, VCDs, CD audio, and various " \
 156        "streaming protocols.\n\n" \
 157        "VLC is also a streaming server with transcoding capabilities " \
 158        "(UDP unicast and multicast, HTTP, ...) mainly designed for " \
 159        "high-bandwidth networks.\n\n"\
 160        "For more information, have a look at the web site." )