git.sesse.net Git - vlc/blob - src/interface/interface.c

   1 /*****************************************************************************
   2  * interface.c: interface access for other threads
   3  * This library provides basic functions for threads to interact with user
   4  * interface, such as command line.
   5  *****************************************************************************
   6  * Copyright (C) 1998-2001 VideoLAN
   7  * $Id: interface.c,v 1.97 2002/07/31 20:56:52 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  * Preamble
  28  *****************************************************************************/
  29 #include <errno.h>                                                 /* ENOMEM */
  30 #include <stdlib.h>                                      /* free(), strtol() */
  31 #include <stdio.h>                                                   /* FILE */
  32 #include <string.h>                                            /* strerror() */
  33 #include <sys/types.h>                                              /* off_t */
  34
  35 #include <vlc/vlc.h>
  36
  37 #include "stream_control.h"
  38 #include "input_ext-intf.h"
  39
  40 #include "audio_output.h"
  41
  42 #include "interface.h"
  43
  44 #include "video.h"
  45 #include "video_output.h"
  46
  47 /*****************************************************************************
  48  * Local prototypes
  49  *****************************************************************************/
  50 static void Manager( intf_thread_t *p_intf );
  51
  52 /*****************************************************************************
  53  * intf_Create: prepare interface before main loop
  54  *****************************************************************************
  55  * This function opens output devices and creates specific interfaces. It sends
  56  * its own error messages.
  57  *****************************************************************************/
  58 intf_thread_t* __intf_Create( vlc_object_t *p_this )
  59 {
  60     intf_thread_t * p_intf;
  61     char *psz_name;
  62
  63     /* Allocate structure */
  64     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  65     if( !p_intf )
  66     {
  67         msg_Err( p_this, "out of memory" );
  68         return NULL;
  69     }
  70
  71     /* Choose the best module */
  72     psz_name = config_GetPsz( p_intf, "intf" );
  73     p_intf->p_module = module_Need( p_intf, "interface", psz_name );
  74
  75     if( psz_name ) free( psz_name );
  76     if( p_intf->p_module == NULL )
  77     {
  78         msg_Err( p_intf, "no suitable intf module" );
  79         vlc_object_destroy( p_intf );
  80         return NULL;
  81     }
  82
  83     /* Initialize structure */
  84     p_intf->b_menu        = 0;
  85     p_intf->b_menu_change = 0;
  86
  87     /* Initialize mutexes */
  88     vlc_mutex_init( p_intf, &p_intf->change_lock );
  89
  90     msg_Dbg( p_intf, "interface initialized" );
  91
  92     /* Attach interface to its parent object */
  93     vlc_object_attach( p_intf, p_this );
  94
  95     return p_intf;
  96 }
  97
  98 /*****************************************************************************
  99  * intf_RunThread: launch the interface thread
 100  *****************************************************************************
 101  * This function either creates a new thread and runs the interface in it,
 102  * or runs the interface in the current thread, depending on b_block.
 103  *****************************************************************************/
 104 vlc_error_t intf_RunThread( intf_thread_t *p_intf )
 105 {
 106     if( p_intf->b_block )
 107     {
 108         /* Run a manager thread, launch the interface, kill the manager */
 109         if( vlc_thread_create( p_intf, "manager", Manager, 0 ) )
 110         {
 111             msg_Err( p_intf, "cannot spawn manager thread" );
 112             return VLC_EGENERIC;
 113         }
 114
 115         p_intf->pf_run( p_intf );
 116
 117         p_intf->b_die = 1;
 118
 119         /* Do not join the thread... intf_StopThread will do it for us */
 120     }
 121     else
 122     {
 123         /* Run the interface in a separate thread */
 124         if( vlc_thread_create( p_intf, "interface", p_intf->pf_run, 0 ) )
 125         {
 126             msg_Err( p_intf, "cannot spawn interface thread" );
 127             return VLC_EGENERIC;
 128         }
 129     }
 130
 131     return VLC_SUCCESS;
 132 }
 133
 134 /*****************************************************************************
 135  * intf_StopThread: end the interface thread
 136  *****************************************************************************
 137  * This function asks the interface thread to stop.
 138  *****************************************************************************/
 139 void intf_StopThread( intf_thread_t *p_intf )
 140 {
 141     /* Tell the interface to die */
 142     if( !p_intf->b_block )
 143     {
 144         p_intf->b_die = 1;
 145     }
 146
 147     /* Wait for the thread to exit */
 148     vlc_thread_join( p_intf );
 149 }
 150
 151 /*****************************************************************************
 152  * intf_Destroy: clean interface after main loop
 153  *****************************************************************************
 154  * This function destroys specific interfaces and close output devices.
 155  *****************************************************************************/
 156 void intf_Destroy( intf_thread_t *p_intf )
 157 {
 158     /* Unlock module */
 159     module_Unneed( p_intf, p_intf->p_module );
 160
 161     vlc_mutex_destroy( &p_intf->change_lock );
 162
 163     /* Free structure */
 164     vlc_object_destroy( p_intf );
 165 }
 166
 167 /* Following functions are local */
 168
 169 /*****************************************************************************
 170  * Manager: helper thread for blocking interfaces
 171  *****************************************************************************
 172  * If the interface is launched in the main thread, it will not listen to
 173  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 174  * This thread takes care of the matter.
 175  *****************************************************************************/
 176 static void Manager( intf_thread_t *p_intf )
 177 {
 178     while( !p_intf->b_die )
 179     {
 180         msleep( INTF_IDLE_SLEEP );
 181
 182         if( p_intf->p_vlc->b_die )
 183         {
 184             p_intf->b_die = 1;
 185             return;
 186         }
 187     }
 188 }
 189