X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Finterface%2Finterface.c;h=f729444aa25cf77899c1675777ee8e57fad742e3;hb=bf680e8fb64910e8d968addce71139d135a9b33f;hp=f7a35bedd631621f74a3a8d19686ef2887e8be7a;hpb=959674591f4ec45888fcb34321958d080efd73cd;p=vlc diff --git a/src/interface/interface.c b/src/interface/interface.c index f7a35bedd6..f729444aa2 100644 --- a/src/interface/interface.c +++ b/src/interface/interface.c @@ -3,15 +3,16 @@ * This library provides basic functions for threads to interact with user * interface, such as command line. ***************************************************************************** - * Copyright (C) 1998, 1999, 2000 VideoLAN + * Copyright (C) 1998-2004 VideoLAN + * $Id$ * - * Authors: + * Authors: Vincent Seguin * * 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. - * + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the @@ -22,43 +23,42 @@ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. *****************************************************************************/ +/** + * \file + * This file contains functions related to interface management + */ + + /***************************************************************************** * Preamble *****************************************************************************/ -#include "defs.h" - -#include /* ENOMEM */ #include /* free(), strtol() */ #include /* FILE */ #include /* strerror() */ -#include "config.h" -#include "common.h" -#include "threads.h" -#include "mtime.h" -#include "modules.h" - -#include "stream_control.h" -#include "input_ext-intf.h" +#include +#include #include "audio_output.h" -#include "intf_msg.h" -#include "interface.h" -#include "intf_cmd.h" -#include "intf_plst.h" -#include "intf_channels.h" -#include "keystrokes.h" - -#include "video.h" +#include "vlc_interface.h" +#include "vlc_video.h" #include "video_output.h" -#include "main.h" +#ifdef SYS_DARWIN +# include "Cocoa/Cocoa.h" +#endif /* SYS_DARWIN */ /***************************************************************************** * Local prototypes *****************************************************************************/ -static void intf_Manage( intf_thread_t *p_intf ); +static void Manager( intf_thread_t *p_intf ); +static void RunInterface( intf_thread_t *p_intf ); + +static int SwitchIntfCallback( vlc_object_t *, char const *, + vlc_value_t , vlc_value_t , void * ); +static int AddIntfCallback( vlc_object_t *, char const *, + vlc_value_t , vlc_value_t , void * ); /***************************************************************************** * intf_Create: prepare interface before main loop @@ -66,308 +66,355 @@ static void intf_Manage( intf_thread_t *p_intf ); * This function opens output devices and creates specific interfaces. It sends * its own error messages. *****************************************************************************/ -intf_thread_t* intf_Create( void ) +/** + * Create the interface, and prepare it for main loop. + * + * \param p_this the calling vlc_object_t + * \param psz_module a prefered interface module + * \return a pointer to the created interface thread, NULL on error + */ +intf_thread_t* __intf_Create( vlc_object_t *p_this, const char *psz_module ) { intf_thread_t * p_intf; /* Allocate structure */ - p_intf = malloc( sizeof( intf_thread_t ) ); + p_intf = vlc_object_create( p_this, VLC_OBJECT_INTF ); if( !p_intf ) { - intf_ErrMsg( "intf error: cannot create interface thread (%s)", - strerror( ENOMEM ) ); - return( NULL ); + msg_Err( p_this, "out of memory" ); + return NULL; } + p_intf->pf_request_window = NULL; + p_intf->pf_release_window = NULL; + p_intf->pf_control_window = NULL; + p_intf->b_play = VLC_FALSE; /* Choose the best module */ - p_intf->p_module = module_Need( p_main->p_bank, - MODULE_CAPABILITY_INTF, NULL ); + p_intf->p_module = module_Need( p_intf, "interface", psz_module, 0 ); if( p_intf->p_module == NULL ) { - intf_ErrMsg( "intf error: no suitable intf module" ); - free( p_intf ); - return( NULL ); + msg_Err( p_intf, "no suitable intf module" ); + vlc_object_destroy( p_intf ); + return NULL; } -#define f p_intf->p_module->p_functions->intf.functions.intf - p_intf->pf_open = f.pf_open; - p_intf->pf_close = f.pf_close; - p_intf->pf_run = f.pf_run; -#undef f - - /* Initialize callbacks */ - p_intf->pf_manage = intf_Manage; - /* Initialize structure */ - p_intf->b_die = 0; - - p_intf->p_input = NULL; - p_intf->p_keys = NULL; - p_intf->b_menu = 0; - p_intf->b_menu_change = 0; - - if( p_intf->pf_open( p_intf ) ) - { - intf_ErrMsg("intf error: cannot create interface"); - module_Unneed( p_main->p_bank, p_intf->p_module ); - free( p_intf ); - return( NULL ); - } + p_intf->b_menu = VLC_FALSE; + p_intf->b_menu_change = VLC_FALSE; /* Initialize mutexes */ - vlc_mutex_init( &p_intf->change_lock ); + vlc_mutex_init( p_intf, &p_intf->change_lock ); + + msg_Dbg( p_intf, "interface initialized" ); - /* Load channels - the pointer will be set to NULL on failure. The - * return value is ignored since the program can work without - * channels */ - intf_LoadChannels( p_intf, main_GetPszVariable( INTF_CHANNELS_VAR, - INTF_CHANNELS_DEFAULT )); + /* Attach interface to its parent object */ + vlc_object_attach( p_intf, p_this ); - intf_Msg("intf: interface initialized"); - return( p_intf ); + return p_intf; } /***************************************************************************** - * intf_Manage: manage interface + * intf_RunThread: launch the interface thread ***************************************************************************** - * This function has to be called regularly by the interface plugin. It - * checks for playlist end, module expiration, message flushing, and a few - * other useful things. + * This function either creates a new thread and runs the interface in it, + * or runs the interface in the current thread, depending on b_block. *****************************************************************************/ -static void intf_Manage( intf_thread_t *p_intf ) +/** + * Run the interface thread. + * + * If b_block is not set, runs the interface in the thread, else, + * creates a new thread and runs the interface. + * \param p_intf the interface thread + * \return VLC_SUCCESS on success, an error number else + */ +int intf_RunThread( intf_thread_t *p_intf ) { - /* Flush waiting messages */ - intf_FlushMsg(); - - /* Manage module bank */ - module_ManageBank( p_main->p_bank ); - - if( ( p_intf->p_input != NULL ) && - ( p_intf->p_input->b_error || p_intf->p_input->b_eof ) ) +#ifdef SYS_DARWIN + if( p_intf->b_block ) { - input_DestroyThread( p_intf->p_input, NULL ); - p_intf->p_input = NULL; - intf_DbgMsg("Input thread destroyed"); + /* This is the primary intf */ + /* Run a manager thread, launch the interface, kill the manager */ + if( vlc_thread_create( p_intf, "manager", Manager, + VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) ) + { + msg_Err( p_intf, "cannot spawn manager thread" ); + return VLC_EGENERIC; + } } - /* If no stream is being played, try to find one */ - if( p_intf->p_input == NULL && !p_intf->b_die ) + if( p_intf->b_block && !strncmp( p_intf->p_module->psz_shortname, "macosx" , 6 ) ) { - /* Select the next playlist item */ - intf_PlstNext( p_main->p_playlist ); + /* this is OSX, we are cheating :) + This is NOT I REPEAT NOT blocking since [NSApp run] is */ + p_intf->b_block = VLC_FALSE; - if( p_main->p_playlist->i_index == -1 ) + RunInterface( p_intf ); + p_intf->b_block = VLC_TRUE; + } + else if( p_intf->b_block && !strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) ) + { + /* VLC OS X in cli mode ( no blocking [NSApp run] ) + this is equal to running in normal non-OSX primary intf mode */ + RunInterface( p_intf ); + p_intf->b_die = VLC_TRUE; + } + else + { + /* If anything else is the primary intf and we are not in cli mode, + then don't make it blocking ([NSApp run] will be blocking) + but run it in a seperate thread. */ + p_intf->b_block = VLC_FALSE; +#else + if( p_intf->b_block ) + { + /* Run a manager thread, launch the interface, kill the manager */ + if( vlc_thread_create( p_intf, "manager", Manager, + VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) ) { - /* FIXME: wait for user to add stuff to playlist ? */ - p_intf->b_die = 1; + msg_Err( p_intf, "cannot spawn manager thread" ); + return VLC_EGENERIC; } - else + + RunInterface( p_intf ); + + p_intf->b_die = VLC_TRUE; + /* Do not join the thread... intf_StopThread will do it for us */ + } + else + { +#endif + /* Run the interface in a separate thread */ + if( vlc_thread_create( p_intf, "interface", RunInterface, + VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) ) { - p_intf->p_input = - input_CreateThread( &p_main->p_playlist->current, NULL ); + msg_Err( p_intf, "cannot spawn interface thread" ); + return VLC_EGENERIC; } } + + return VLC_SUCCESS; } -/***************************************************************************** - * intf_Destroy: clean interface after main loop - ***************************************************************************** - * This function destroys specific interfaces and close output devices. - *****************************************************************************/ -void intf_Destroy( intf_thread_t *p_intf ) +/** + * Stops the interface thread + * + * This function asks the interface thread to stop + * \param p_intf the interface thread + * \return nothing + */ +void intf_StopThread( intf_thread_t *p_intf ) { - p_intf_key p_cur; - p_intf_key p_next; - - /* Unload channels */ - intf_UnloadChannels( p_intf ); - - /* Destroy interfaces */ - p_intf->pf_close( p_intf ); - - /* Close input thread, if any (blocking) */ - if( p_intf->p_input ) - { - input_DestroyThread( p_intf->p_input, NULL ); + /* Tell the interface to die */ + if( !p_intf->b_block ) + { + p_intf->b_die = VLC_TRUE; } - /* Destroy keymap */ - p_cur = p_intf->p_keys; - while( p_cur != NULL) + /* Wait for the thread to exit */ + vlc_thread_join( p_intf ); +} + +/** + * \brief Destroy the interface after the main loop endeed. + * + * Destroys interfaces and closes output devices + * \param p_intf the interface thread + * \return nothing + */ +void intf_Destroy( intf_thread_t *p_intf ) +{ + /* Unlock module if present (a switch may have failed) */ + if( p_intf->p_module ) { - p_next = p_cur->next; - free(p_cur); - p_cur = p_next; + module_Unneed( p_intf, p_intf->p_module ); } - - /* Unlock module */ - module_Unneed( p_main->p_bank, p_intf->p_module ); vlc_mutex_destroy( &p_intf->change_lock ); /* Free structure */ - free( p_intf ); + vlc_object_destroy( p_intf ); } + +/* Following functions are local */ + /***************************************************************************** - * intf_AssignKey: assign standartkeys * + * Manager: helper thread for blocking interfaces ***************************************************************************** - * This function fills in the associative array that links the key pressed * - * and the key we use internally. Support one extra parameter. * - ****************************************************************************/ -void intf_AssignKey( intf_thread_t *p_intf, int r_key, int f_key, int param) + * If the interface is launched in the main thread, it will not listen to + * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die. + * This thread takes care of the matter. + *****************************************************************************/ +/** + * \brief Helper thread for blocking interfaces. + * \ingroup vlc_interface + * + * This is a local function + * If the interface is launched in the main thread, it will not listen to + * p_vlc->b_die events because it is only supposed to listen to p_intf->b_die. + * This thread takes care of the matter. + * \see intf_RunThread + * \param p_intf an interface thread + * \return nothing + */ +static void Manager( intf_thread_t *p_intf ) { - p_intf_key p_cur = p_intf->p_keys; - if( p_cur == NULL ) - { - p_cur = (p_intf_key )(malloc ( sizeof( intf_key ) ) ); - p_cur->received_key = r_key; - p_cur->forwarded.key = f_key; - p_cur->forwarded.param = param; - p_cur->next = NULL; - p_intf->p_keys = p_cur; - } - else + while( !p_intf->b_die ) { - while( p_cur->next != NULL && p_cur ->received_key != r_key) - { - p_cur = p_cur->next; - } - if( p_cur->next == NULL ) - { - p_cur->next = ( p_intf_key )( malloc( sizeof( intf_key ) ) ); - p_cur = p_cur->next; - p_cur->next = NULL; - p_cur->forwarded.param = param; - p_cur->received_key = r_key; - } - p_cur->forwarded.key = f_key; - } -} + msleep( INTF_IDLE_SLEEP ); -/* Basic getKey function... */ -keyparm intf_GetKey( intf_thread_t *p_intf, int r_key) -{ - keyparm reply; - - p_intf_key current = p_intf->p_keys; - while(current != NULL && current->received_key != r_key) - { - current = current->next; - } - if(current == NULL) - { /* didn't find any key in the array */ - reply.key = INTF_KEY_UNKNOWN; - reply.param = 0; - } - else + if( p_intf->p_vlc->b_die ) + { + p_intf->b_die = VLC_TRUE; +#ifdef SYS_DARWIN + if( strncmp( p_intf->p_vlc->psz_object_name, "clivlc", 6 ) ) { - reply.key = current->forwarded.key; - reply.param = current->forwarded.param; + [NSApp stop: NULL]; + } +#endif + return; + } } - return reply; } /***************************************************************************** -* intf_AssignNormalKeys: used for normal interfaces. -***************************************************************************** -* This function assign the basic key to the normal keys. -*****************************************************************************/ - -void intf_AssignNormalKeys( intf_thread_t *p_intf) -{ - p_intf->p_intf_get_key = intf_GetKey; - - intf_AssignKey( p_intf , 'Q', INTF_KEY_QUIT, 0); - intf_AssignKey( p_intf , 'q', INTF_KEY_QUIT, 0); - intf_AssignKey( p_intf , 27, INTF_KEY_QUIT, 0); - intf_AssignKey( p_intf , 3, INTF_KEY_QUIT, 0); - intf_AssignKey( p_intf , '0', INTF_KEY_SET_CHANNEL, 0); - intf_AssignKey( p_intf , '1', INTF_KEY_SET_CHANNEL, 1); - intf_AssignKey( p_intf , '2', INTF_KEY_SET_CHANNEL, 2); - intf_AssignKey( p_intf , '3', INTF_KEY_SET_CHANNEL, 3); - intf_AssignKey( p_intf , '4', INTF_KEY_SET_CHANNEL, 4); - intf_AssignKey( p_intf , '5', INTF_KEY_SET_CHANNEL, 5); - intf_AssignKey( p_intf , '6', INTF_KEY_SET_CHANNEL, 6); - intf_AssignKey( p_intf , '7', INTF_KEY_SET_CHANNEL, 7); - intf_AssignKey( p_intf , '8', INTF_KEY_SET_CHANNEL, 8); - intf_AssignKey( p_intf , '9', INTF_KEY_SET_CHANNEL, 9); - intf_AssignKey( p_intf , '0', INTF_KEY_SET_CHANNEL, 0); - intf_AssignKey( p_intf , '+', INTF_KEY_INC_VOLUME, 0); - intf_AssignKey( p_intf , '-', INTF_KEY_DEC_VOLUME, 0); - intf_AssignKey( p_intf , 'm', INTF_KEY_TOGGLE_VOLUME, 0); - intf_AssignKey( p_intf , 'M', INTF_KEY_TOGGLE_VOLUME, 0); - intf_AssignKey( p_intf , 'g', INTF_KEY_DEC_GAMMA, 0); - intf_AssignKey( p_intf , 'G', INTF_KEY_INC_GAMMA, 0); - intf_AssignKey( p_intf , 'c', INTF_KEY_TOGGLE_GRAYSCALE, 0); - intf_AssignKey( p_intf , ' ', INTF_KEY_TOGGLE_INTERFACE, 0); - intf_AssignKey( p_intf , 'i', INTF_KEY_TOGGLE_INFO, 0); - intf_AssignKey( p_intf , 's', INTF_KEY_TOGGLE_SCALING, 0); -} - -/***************************************************************************** - * intf_ProcessKey: process standard keys - ***************************************************************************** - * This function will process standard keys and return non 0 if the key was - * unknown. + * RunInterface: setups necessary data and give control to the interface *****************************************************************************/ -int intf_ProcessKey( intf_thread_t *p_intf, int g_key ) +static void RunInterface( intf_thread_t *p_intf ) { - static int i_volbackup; - keyparm k_reply; - - k_reply = intf_GetKey( p_intf, g_key); - - switch( k_reply.key ) + static char *ppsz_interfaces[] = { - case INTF_KEY_QUIT: /* quit order */ - p_intf->b_die = 1; - break; - case INTF_KEY_SET_CHANNEL: - /* Change channel - return code is ignored since SelectChannel displays - * its own error messages */ - intf_SelectChannel( p_intf, k_reply.param ); - break; - case INTF_KEY_INC_VOLUME: /* volume + */ - if( (p_main->p_aout != NULL) && (p_main->p_aout->vol < VOLUME_MAX) ) - p_main->p_aout->vol += VOLUME_STEP; - break; - case INTF_KEY_DEC_VOLUME: /* volume - */ - if( (p_main->p_aout != NULL) && (p_main->p_aout->vol > VOLUME_STEP) ) - p_main->p_aout->vol -= VOLUME_STEP; - break; - case INTF_KEY_TOGGLE_VOLUME: /* toggle mute */ - if( (p_main->p_aout != NULL) && (p_main->p_aout->vol)) - { - i_volbackup = p_main->p_aout->vol; - p_main->p_aout->vol = 0; - } - else if( (p_main->p_aout != NULL) && (!p_main->p_aout->vol)) - p_main->p_aout->vol = i_volbackup; - break; - case INTF_KEY_DEC_GAMMA: /* gamma - */ - if( (p_main->p_vout != NULL) && (p_main->p_vout->f_gamma > -INTF_GAMMA_LIMIT) ) + "skins", "Skins", + "skins2", "Skins 2", + "wxwindows", "wxWindows", + NULL, NULL + }; + char **ppsz_parser; + + vlc_list_t *p_list; + int i; + vlc_value_t val, text; + char *psz_intf; + + /* Variable used for interface switching */ + p_intf->psz_switch_intf = NULL; + var_Create( p_intf, "intf-switch", VLC_VAR_STRING | + VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND ); + text.psz_string = _("Switch interface"); + var_Change( p_intf, "intf-switch", VLC_VAR_SETTEXT, &text, NULL ); + + /* Only fill the list with available modules */ + p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE, FIND_ANYWHERE ); + for( ppsz_parser = ppsz_interfaces; *ppsz_parser; ppsz_parser += 2 ) + { + for( i = 0; i < p_list->i_count; i++ ) { - vlc_mutex_lock( &p_main->p_vout->change_lock ); - p_main->p_vout->f_gamma -= INTF_GAMMA_STEP; - p_main->p_vout->i_changes |= VOUT_GAMMA_CHANGE; - vlc_mutex_unlock( &p_main->p_vout->change_lock ); + module_t *p_module = (module_t *)p_list->p_values[i].p_object; + if( !strcmp( p_module->psz_object_name, ppsz_parser[0] ) ) + { + val.psz_string = ppsz_parser[0]; + text.psz_string = ppsz_parser[1]; + var_Change( p_intf, "intf-switch", VLC_VAR_ADDCHOICE, + &val, &text ); + break; + } } - break; - case INTF_KEY_INC_GAMMA: /* gamma + */ - if( (p_main->p_vout != NULL) && (p_main->p_vout->f_gamma < INTF_GAMMA_LIMIT) ) + } + vlc_list_release( p_list ); + + var_AddCallback( p_intf, "intf-switch", SwitchIntfCallback, NULL ); + + /* Variable used for interface spawning */ + var_Create( p_intf, "intf-add", VLC_VAR_STRING | + VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND ); + text.psz_string = _("Add Interface"); + var_Change( p_intf, "intf-add", VLC_VAR_SETTEXT, &text, NULL ); + + val.psz_string = "rc"; text.psz_string = "Console"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + val.psz_string = "telnet"; text.psz_string = "Telnet Interface"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + val.psz_string = "http"; text.psz_string = "Web Interface"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + val.psz_string = "logger"; text.psz_string = "Debug logging"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + val.psz_string = "sap"; text.psz_string = "SAP Playlist"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + val.psz_string = "gestures"; text.psz_string = "Mouse Gestures"; + var_Change( p_intf, "intf-add", VLC_VAR_ADDCHOICE, &val, &text ); + + var_AddCallback( p_intf, "intf-add", AddIntfCallback, NULL ); + + do + { + /* Give control to the interface */ + p_intf->pf_run( p_intf ); + + /* Reset play on start status */ + p_intf->b_play = VLC_FALSE; + + if( !p_intf->psz_switch_intf ) { - vlc_mutex_lock( &p_main->p_vout->change_lock ); - p_main->p_vout->f_gamma += INTF_GAMMA_STEP; - p_main->p_vout->i_changes |= VOUT_GAMMA_CHANGE; - vlc_mutex_unlock( &p_main->p_vout->change_lock ); + break; } - break; - default: /* unknown key */ - return( 1 ); + + /* Make sure the old interface is completely uninitialized */ + module_Unneed( p_intf, p_intf->p_module ); + + /* Provide ability to switch the main interface on the fly */ + psz_intf = p_intf->psz_switch_intf; + p_intf->psz_switch_intf = NULL; + + vlc_mutex_lock( &p_intf->object_lock ); + p_intf->b_die = VLC_FALSE; + p_intf->b_dead = VLC_FALSE; + vlc_mutex_unlock( &p_intf->object_lock ); + + p_intf->p_module = module_Need( p_intf, "interface", psz_intf, 0 ); + free( psz_intf ); } + while( p_intf->p_module ); +} - return( 0 ); +static int SwitchIntfCallback( vlc_object_t *p_this, char const *psz_cmd, + vlc_value_t oldval, vlc_value_t newval, void *p_data ) +{ + intf_thread_t *p_intf = (intf_thread_t *)p_this; + + p_intf->psz_switch_intf = + malloc( strlen(newval.psz_string) + sizeof(",none") ); + sprintf( p_intf->psz_switch_intf, "%s,none", newval.psz_string ); + p_intf->b_die = VLC_TRUE; + + return VLC_SUCCESS; } +static int AddIntfCallback( vlc_object_t *p_this, char const *psz_cmd, + vlc_value_t oldval, vlc_value_t newval, void *p_data ) +{ + intf_thread_t *p_intf; + char *psz_intf = malloc( strlen(newval.psz_string) + sizeof(",none") ); + + /* Try to create the interface */ + sprintf( psz_intf, "%s,none", newval.psz_string ); + p_intf = intf_Create( p_this->p_vlc, psz_intf ); + free( psz_intf ); + if( p_intf == NULL ) + { + msg_Err( p_this, "interface \"%s\" initialization failed", + newval.psz_string ); + return VLC_EGENERIC; + } + + /* Try to run the interface */ + p_intf->b_block = VLC_FALSE; + if( intf_RunThread( p_intf ) != VLC_SUCCESS ) + { + vlc_object_detach( p_intf ); + intf_Destroy( p_intf ); + return VLC_EGENERIC; + } + + return VLC_SUCCESS; +}