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.98 2002/08/04 20:04:11 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
  62     /* Allocate structure */
  63     p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF );
  64     if( !p_intf )
  65     {
  66         msg_Err( p_this, "out of memory" );
  67         return NULL;
  68     }
  69
  70     /* Choose the best module */
  71     p_intf->p_module = module_Need( p_intf, "interface", "$intf" );
  72
  73     if( p_intf->p_module == NULL )
  74     {
  75         msg_Err( p_intf, "no suitable intf module" );
  76         vlc_object_destroy( p_intf );
  77         return NULL;
  78     }
  79
  80     /* Initialize structure */
  81     p_intf->b_menu        = 0;
  82     p_intf->b_menu_change = 0;
  83
  84     /* Initialize mutexes */
  85     vlc_mutex_init( p_intf, &p_intf->change_lock );
  86
  87     msg_Dbg( p_intf, "interface initialized" );
  88
  89     /* Attach interface to its parent object */
  90     vlc_object_attach( p_intf, p_this );
  91
  92     return p_intf;
  93 }
  94
  95 /*****************************************************************************
  96  * intf_RunThread: launch the interface thread
  97  *****************************************************************************
  98  * This function either creates a new thread and runs the interface in it,
  99  * or runs the interface in the current thread, depending on b_block.
 100  *****************************************************************************/
 101 vlc_error_t intf_RunThread( intf_thread_t *p_intf )
 102 {
 103     if( p_intf->b_block )
 104     {
 105         /* Run a manager thread, launch the interface, kill the manager */
 106         if( vlc_thread_create( p_intf, "manager", Manager, 0 ) )
 107         {
 108             msg_Err( p_intf, "cannot spawn manager thread" );
 109             return VLC_EGENERIC;
 110         }
 111
 112         p_intf->pf_run( p_intf );
 113
 114         p_intf->b_die = 1;
 115
 116         /* Do not join the thread... intf_StopThread will do it for us */
 117     }
 118     else
 119     {
 120         /* Run the interface in a separate thread */
 121         if( vlc_thread_create( p_intf, "interface", p_intf->pf_run, 0 ) )
 122         {
 123             msg_Err( p_intf, "cannot spawn interface thread" );
 124             return VLC_EGENERIC;
 125         }
 126     }
 127
 128     return VLC_SUCCESS;
 129 }
 130
 131 /*****************************************************************************
 132  * intf_StopThread: end the interface thread
 133  *****************************************************************************
 134  * This function asks the interface thread to stop.
 135  *****************************************************************************/
 136 void intf_StopThread( intf_thread_t *p_intf )
 137 {
 138     /* Tell the interface to die */
 139     if( !p_intf->b_block )
 140     {
 141         p_intf->b_die = 1;
 142     }
 143
 144     /* Wait for the thread to exit */
 145     vlc_thread_join( p_intf );
 146 }
 147
 148 /*****************************************************************************
 149  * intf_Destroy: clean interface after main loop
 150  *****************************************************************************
 151  * This function destroys specific interfaces and close output devices.
 152  *****************************************************************************/
 153 void intf_Destroy( intf_thread_t *p_intf )
 154 {
 155     /* Unlock module */
 156     module_Unneed( p_intf, p_intf->p_module );
 157
 158     vlc_mutex_destroy( &p_intf->change_lock );
 159
 160     /* Free structure */
 161     vlc_object_destroy( p_intf );
 162 }
 163
 164 /* Following functions are local */
 165
 166 /*****************************************************************************
 167  * Manager: helper thread for blocking interfaces
 168  *****************************************************************************
 169  * If the interface is launched in the main thread, it will not listen to
 170  * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die.
 171  * This thread takes care of the matter.
 172  *****************************************************************************/
 173 static void Manager( intf_thread_t *p_intf )
 174 {
 175     while( !p_intf->b_die )
 176     {
 177         msleep( INTF_IDLE_SLEEP );
 178
 179         if( p_intf->p_vlc->b_die )
 180         {
 181             p_intf->b_die = 1;
 182             return;
 183         }
 184     }
 185 }
 186