1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
43 #include "modules/modules.h"
44 #include "config/configuration.h"
45 #include "interface/interface.h"
47 #include <errno.h> /* ENOMEM */
48 #include <stdio.h> /* sprintf() */
50 #include <stdlib.h> /* free() */
53 # include <netinet/in.h> /* BSD: struct in_addr */
58 #elif defined( WIN32 ) && !defined( UNDER_CE )
62 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
63 # include "extras/getopt.h"
71 /* used for one-instance mode */
72 # include <dbus/dbus.h>
76 # include <hal/libhal.h>
79 #include <vlc_playlist.h>
80 #include <vlc_interface.h>
83 #include "audio_output/aout_internal.h"
85 #include <vlc_charset.h>
89 #include "playlist/playlist_internal.h"
94 # include <libkern/OSAtomic.h>
99 /*****************************************************************************
100 * The evil global variables. We handle them with care, don't worry.
101 *****************************************************************************/
102 static unsigned i_instances = 0;
105 static bool b_daemon = false;
113 * Atomically set the reference count to 1.
114 * @param p_gc reference counted object
115 * @param pf_destruct destruction calback
118 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
120 /* There is no point in using the GC if there is no destructor... */
121 assert (pf_destruct);
122 p_gc->pf_destructor = pf_destruct;
125 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
126 __sync_synchronize ();
127 #elif defined (WIN32) && defined (__GNUC__)
128 #elif defined(__APPLE__)
131 /* Nobody else can possibly lock the spin - it's there as a barrier */
132 vlc_spin_init (&p_gc->spin);
133 vlc_spin_lock (&p_gc->spin);
134 vlc_spin_unlock (&p_gc->spin);
140 * Atomically increment the reference count.
141 * @param p_gc reference counted object
144 void *vlc_hold (gc_object_t * p_gc)
148 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
150 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
151 refs = __sync_add_and_fetch (&p_gc->refs, 1);
152 #elif defined (WIN64)
153 refs = InterlockedIncrement64 (&p_gc->refs);
154 #elif defined (WIN32)
155 refs = InterlockedIncrement (&p_gc->refs);
156 #elif defined(__APPLE__)
157 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
159 vlc_spin_lock (&p_gc->spin);
161 vlc_spin_unlock (&p_gc->spin);
163 assert (refs != 1); /* there had to be a reference already */
168 * Atomically decrement the reference count and, if it reaches zero, destroy.
169 * @param p_gc reference counted object.
171 void vlc_release (gc_object_t *p_gc)
176 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
178 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
179 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
180 #elif defined (WIN64)
181 refs = InterlockedDecrement64 (&p_gc->refs);
182 #elif defined (WIN32)
183 refs = InterlockedDecrement (&p_gc->refs);
184 #elif defined(__APPLE__)
185 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
187 vlc_spin_lock (&p_gc->spin);
189 vlc_spin_unlock (&p_gc->spin);
192 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
196 #elif defined (WIN32) && defined (__GNUC__)
197 #elif defined(__APPLE__)
199 vlc_spin_destroy (&p_gc->spin);
201 p_gc->pf_destructor (p_gc);
205 /*****************************************************************************
207 *****************************************************************************/
208 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
209 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
210 static void SetLanguage ( char const * );
212 static inline int LoadMessages (void);
213 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
214 static void Help ( libvlc_int_t *, char const *psz_help_name );
215 static void Usage ( libvlc_int_t *, char const *psz_search );
216 static void ListModules ( libvlc_int_t *, bool );
217 static void Version ( void );
220 static void ShowConsole ( bool );
221 static void PauseConsole ( void );
223 static int ConsoleWidth ( void );
225 static int VerboseCallback( vlc_object_t *, char const *,
226 vlc_value_t, vlc_value_t, void * );
228 static void InitDeviceValues( libvlc_int_t * );
230 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
233 * Allocate a libvlc instance, initialize global data if needed
234 * It also initializes the threading system
236 libvlc_int_t * libvlc_InternalCreate( void )
238 libvlc_int_t *p_libvlc;
240 char *psz_env = NULL;
242 /* Now that the thread system is initialized, we don't have much, but
243 * at least we have variables */
244 vlc_mutex_lock( &global_lock );
245 if( i_instances == 0 )
247 /* Guess what CPU we have */
248 cpu_flags = CPUCapabilities();
249 /* The module bank will be initialized later */
252 /* Allocate a libvlc instance object */
253 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
254 VLC_OBJECT_GENERIC, "libvlc" );
255 if( p_libvlc != NULL )
257 vlc_mutex_unlock( &global_lock );
259 if( p_libvlc == NULL )
262 priv = libvlc_priv (p_libvlc);
263 priv->p_playlist = NULL;
264 priv->p_interaction = NULL;
266 p_libvlc->psz_object_name = strdup( "libvlc" );
268 /* Initialize message queue */
269 msg_Create( p_libvlc );
271 /* Find verbosity from VLC_VERBOSE environment variable */
272 psz_env = getenv( "VLC_VERBOSE" );
273 if( psz_env != NULL )
274 priv->i_verbose = atoi( psz_env );
277 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
278 priv->b_color = isatty( 2 ); /* 2 is for stderr */
280 priv->b_color = false;
283 /* Initialize mutexes */
284 vlc_mutex_init( &priv->timer_lock );
285 vlc_mutex_init( &priv->config_lock );
291 * Initialize a libvlc instance
292 * This function initializes a previously allocated libvlc instance:
294 * - gettext initialization
295 * - message queue, module bank and playlist initialization
296 * - configuration and commandline parsing
298 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
299 const char *ppsz_argv[] )
301 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
302 char p_capabilities[200];
304 char * psz_modules = NULL;
305 char * psz_parser = NULL;
306 char * psz_control = NULL;
308 int i_ret = VLC_EEXIT;
309 playlist_t *p_playlist = NULL;
311 #if defined( ENABLE_NLS ) \
312 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
313 # if defined (WIN32) || defined (__APPLE__)
318 /* System specific initialization code */
319 system_Init( p_libvlc, &i_argc, ppsz_argv );
322 * Support for gettext
326 /* Initialize the module bank and load the configuration of the
327 * main module. We need to do this at this stage to be able to display
328 * a short help if required by the user. (short help == main module
330 module_InitBank( p_libvlc );
332 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
334 module_EndBank( p_libvlc );
338 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
339 /* Announce who we are - Do it only for first instance ? */
340 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
341 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
342 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
343 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
345 /* Check for short help option */
346 if( config_GetInt( p_libvlc, "help" ) > 0 )
348 Help( p_libvlc, "help" );
350 i_ret = VLC_EEXITSUCCESS;
352 /* Check for version option */
353 else if( config_GetInt( p_libvlc, "version" ) > 0 )
357 i_ret = VLC_EEXITSUCCESS;
360 /* Set the config file stuff */
361 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
363 /* Check for plugins cache options */
364 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
366 /* Check for daemon mode */
368 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
371 char *psz_pidfile = NULL;
373 if( daemon( 1, 0) != 0 )
375 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
380 /* lets check if we need to write the pidfile */
381 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
382 if( psz_pidfile != NULL )
385 pid_t i_pid = getpid ();
386 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
387 i_pid, psz_pidfile );
388 pidfile = utf8_fopen( psz_pidfile,"w" );
389 if( pidfile != NULL )
391 utf8_fprintf( pidfile, "%d", (int)i_pid );
396 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
405 if( ( i_pid = fork() ) < 0 )
407 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
412 /* This is the parent, exit right now */
413 msg_Dbg( p_libvlc, "closing parent process" );
415 i_ret = VLC_EEXITSUCCESS;
419 /* We are the child */
420 msg_Dbg( p_libvlc, "daemon spawned" );
421 close( STDIN_FILENO );
422 close( STDOUT_FILENO );
423 close( STDERR_FILENO );
433 free( priv->psz_configfile );
434 module_EndBank( p_libvlc );
438 /* Check for translation config option */
439 #if defined( ENABLE_NLS ) \
440 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
441 # if defined (WIN32) || defined (__APPLE__)
442 /* This ain't really nice to have to reload the config here but it seems
443 * the only way to do it. */
445 if( !config_GetInt( p_libvlc, "ignore-config" ) )
446 config_LoadConfigFile( p_libvlc, "main" );
447 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
449 /* Check if the user specified a custom language */
450 psz_language = config_GetPsz( p_libvlc, "language" );
451 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
453 /* Reset the default domain */
454 SetLanguage( psz_language );
456 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
457 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
459 module_EndBank( p_libvlc );
460 module_InitBank( p_libvlc );
461 if( !config_GetInt( p_libvlc, "ignore-config" ) )
462 config_LoadConfigFile( p_libvlc, "main" );
463 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
465 free( psz_language );
470 * Load the builtins and plugins into the module_bank.
471 * We have to do it before config_Load*() because this also gets the
472 * list of configuration options exported by each module and loads their
475 module_LoadBuiltins( p_libvlc );
476 module_LoadPlugins( p_libvlc, b_cache_delete );
477 if( p_libvlc->b_die )
483 module_t **list = module_list_get( &module_count );
484 module_list_free( list );
485 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
487 /* Check for help on modules */
488 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
490 Help( p_libvlc, p_tmp );
493 i_ret = VLC_EEXITSUCCESS;
495 /* Check for full help option */
496 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
498 config_PutInt( p_libvlc, "advanced", 1);
499 config_PutInt( p_libvlc, "help-verbose", 1);
500 Help( p_libvlc, "full-help" );
502 i_ret = VLC_EEXITSUCCESS;
504 /* Check for long help option */
505 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
507 Help( p_libvlc, "longhelp" );
509 i_ret = VLC_EEXITSUCCESS;
511 /* Check for module list option */
512 else if( config_GetInt( p_libvlc, "list" ) > 0 )
514 ListModules( p_libvlc, false );
516 i_ret = VLC_EEXITSUCCESS;
518 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
520 ListModules( p_libvlc, true );
522 i_ret = VLC_EEXITSUCCESS;
525 /* Check for config file options */
526 if( !config_GetInt( p_libvlc, "ignore-config" ) )
528 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
530 config_ResetAll( p_libvlc );
531 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
532 config_SaveConfigFile( p_libvlc, NULL );
534 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
536 config_LoadConfigFile( p_libvlc, NULL );
537 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
538 config_SaveConfigFile( p_libvlc, NULL );
544 free( priv->psz_configfile );
545 module_EndBank( p_libvlc );
552 InitDeviceValues( p_libvlc );
555 * Override default configuration with config file settings
557 if( !config_GetInt( p_libvlc, "ignore-config" ) )
558 config_LoadConfigFile( p_libvlc, NULL );
561 * Override configuration with command line settings
563 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
566 ShowConsole( false );
567 /* Pause the console because it's destroyed when we exit */
568 fprintf( stderr, "The command line options couldn't be loaded, check "
569 "that they are valid.\n" );
572 free( priv->psz_configfile );
573 module_EndBank( p_libvlc );
578 * System specific configuration
580 system_Configure( p_libvlc, &i_argc, ppsz_argv );
582 /* FIXME: could be replaced by using Unix sockets */
584 dbus_threads_init_default();
586 if( config_GetInt( p_libvlc, "one-instance" ) > 0
587 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
588 && config_GetInt( p_libvlc, "started-from-file" ) ) )
590 /* Initialise D-Bus interface, check for other instances */
591 DBusConnection *p_conn = NULL;
592 DBusError dbus_error;
594 dbus_error_init( &dbus_error );
596 /* connect to the session bus */
597 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
600 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
601 dbus_error.message );
602 dbus_error_free( &dbus_error );
606 /* check if VLC is available on the bus
607 * if not: D-Bus control is not enabled on the other
608 * instance and we can't pass MRLs to it */
609 DBusMessage *p_test_msg = NULL;
610 DBusMessage *p_test_reply = NULL;
611 p_test_msg = dbus_message_new_method_call(
612 "org.mpris.vlc", "/",
613 "org.freedesktop.MediaPlayer", "Identity" );
614 /* block until a reply arrives */
615 p_test_reply = dbus_connection_send_with_reply_and_block(
616 p_conn, p_test_msg, -1, &dbus_error );
617 dbus_message_unref( p_test_msg );
618 if( p_test_reply == NULL )
620 dbus_error_free( &dbus_error );
621 msg_Dbg( p_libvlc, "No Media Player is running. "
622 "Continuing normally." );
627 DBusMessage* p_dbus_msg = NULL;
628 DBusMessageIter dbus_args;
629 DBusPendingCall* p_dbus_pending = NULL;
632 dbus_message_unref( p_test_reply );
633 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
635 for( i_input = optind;i_input < i_argc;i_input++ )
637 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
638 ppsz_argv[i_input] );
640 p_dbus_msg = dbus_message_new_method_call(
641 "org.mpris.vlc", "/TrackList",
642 "org.freedesktop.MediaPlayer", "AddTrack" );
644 if ( NULL == p_dbus_msg )
646 msg_Err( p_libvlc, "D-Bus problem" );
647 system_End( p_libvlc );
648 exit( VLC_ETIMEOUT );
652 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
653 if ( !dbus_message_iter_append_basic( &dbus_args,
654 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
656 dbus_message_unref( p_dbus_msg );
657 system_End( p_libvlc );
661 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
663 if ( !dbus_message_iter_append_basic( &dbus_args,
664 DBUS_TYPE_BOOLEAN, &b_play ) )
666 dbus_message_unref( p_dbus_msg );
667 system_End( p_libvlc );
671 /* send message and get a handle for a reply */
672 if ( !dbus_connection_send_with_reply ( p_conn,
673 p_dbus_msg, &p_dbus_pending, -1 ) )
675 msg_Err( p_libvlc, "D-Bus problem" );
676 dbus_message_unref( p_dbus_msg );
677 system_End( p_libvlc );
678 exit( VLC_ETIMEOUT );
681 if ( NULL == p_dbus_pending )
683 msg_Err( p_libvlc, "D-Bus problem" );
684 dbus_message_unref( p_dbus_msg );
685 system_End( p_libvlc );
686 exit( VLC_ETIMEOUT );
688 dbus_connection_flush( p_conn );
689 dbus_message_unref( p_dbus_msg );
690 /* block until we receive a reply */
691 dbus_pending_call_block( p_dbus_pending );
692 dbus_pending_call_unref( p_dbus_pending );
693 } /* processes all command line MRLs */
696 system_End( p_libvlc );
700 /* we unreference the connection when we've finished with it */
701 if( p_conn ) dbus_connection_unref( p_conn );
706 * Message queue options
708 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
709 if( psz_verbose_objects )
711 char * psz_object, * iter = psz_verbose_objects;
712 while( (psz_object = strsep( &iter, "," )) )
714 switch( psz_object[0] )
716 printf("%s\n", psz_object+1);
717 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
718 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
720 msg_Err( p_libvlc, "verbose-objects usage: \n"
721 "--verbose-objects=+printthatobject,"
722 "-dontprintthatone\n"
723 "(keyword 'all' to applies to all objects)\n");
724 free( psz_verbose_objects );
725 /* FIXME: leaks!!!! */
729 free( psz_verbose_objects );
732 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
733 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
736 var_Set( p_libvlc, "verbose", val );
738 var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
739 var_TriggerCallback( p_libvlc, "verbose" );
742 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
744 if( !config_GetInt( p_libvlc, "fpu" ) )
745 cpu_flags &= ~CPU_CAPABILITY_FPU;
747 #if defined( __i386__ ) || defined( __x86_64__ )
748 if( !config_GetInt( p_libvlc, "mmx" ) )
749 cpu_flags &= ~CPU_CAPABILITY_MMX;
750 if( !config_GetInt( p_libvlc, "3dn" ) )
751 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
752 if( !config_GetInt( p_libvlc, "mmxext" ) )
753 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
754 if( !config_GetInt( p_libvlc, "sse" ) )
755 cpu_flags &= ~CPU_CAPABILITY_SSE;
756 if( !config_GetInt( p_libvlc, "sse2" ) )
757 cpu_flags &= ~CPU_CAPABILITY_SSE2;
759 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
760 if( !config_GetInt( p_libvlc, "altivec" ) )
761 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
764 #define PRINT_CAPABILITY( capability, string ) \
765 if( vlc_CPU() & capability ) \
767 strncat( p_capabilities, string " ", \
768 sizeof(p_capabilities) - strlen(p_capabilities) ); \
769 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
772 p_capabilities[0] = '\0';
773 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
778 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
779 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
780 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
781 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
782 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
783 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
786 * Choose the best memcpy module
788 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
790 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
792 priv->pp_timers = NULL;
795 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
796 if( !p_libvlc->p_stats )
798 vlc_object_release( p_libvlc );
799 return VLC_ENOMEM; /* FIXME: leaks */
801 vlc_mutex_init( &p_libvlc->p_stats->lock );
802 priv->p_stats_computer = NULL;
804 priv->i_last_input_id = 0; /* Not very safe, should be removed */
807 * Initialize hotkey handling
809 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
810 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
811 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
812 /* Do a copy (we don't need to modify the strings) */
813 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
814 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
815 p_libvlc->p_hotkeys );
817 /* Initialize interaction */
818 priv->p_interaction = interaction_Init( p_libvlc );
820 /* Initialize playlist and get commandline files */
821 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
824 msg_Err( p_libvlc, "playlist initialization failed" );
825 if( priv->p_memcpy_module != NULL )
827 module_unneed( p_libvlc, priv->p_memcpy_module );
829 module_EndBank( p_libvlc );
830 free( priv->psz_configfile );
833 playlist_Activate( p_playlist );
834 vlc_object_attach( p_playlist, p_libvlc );
836 /* Add service discovery modules */
837 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
838 if( psz_modules && *psz_modules )
840 char *p = psz_modules, *m;
841 while( ( m = strsep( &p, " :," ) ) != NULL )
842 playlist_ServicesDiscoveryAdd( p_playlist, m );
847 /* Initialize VLM if vlm-conf is specified */
848 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
849 if( psz_parser && *psz_parser )
851 priv->p_vlm = vlm_New( p_libvlc );
853 msg_Err( p_libvlc, "VLM initialization failed" );
859 * Load background interfaces
861 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
862 psz_control = config_GetPsz( p_libvlc, "control" );
864 if( psz_modules && *psz_modules && psz_control && *psz_control )
866 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
867 strlen( psz_control ) + 1 );
868 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
870 else if( psz_control && *psz_control )
873 psz_modules = strdup( psz_control );
876 psz_parser = psz_modules;
877 while ( psz_parser && *psz_parser )
879 char *psz_module, *psz_temp;
880 psz_module = psz_parser;
881 psz_parser = strchr( psz_module, ':' );
887 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
889 libvlc_InternalAddIntf( p_libvlc, psz_temp );
897 * Always load the hotkeys interface if it exists
899 libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
901 libvlc_InternalAddIntf( p_libvlc, "globalhotkeys,none" );
905 /* loads dbus control interface if in one-instance mode
906 * we do it only when playlist exists, because dbus module needs it */
907 if( config_GetInt( p_libvlc, "one-instance" ) > 0
908 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
909 && config_GetInt( p_libvlc, "started-from-file" ) ) )
910 libvlc_InternalAddIntf( p_libvlc, "dbus,none" );
912 /* Prevents the power management daemon from suspending the system
913 * when VLC is active */
914 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
915 libvlc_InternalAddIntf( p_libvlc, "inhibit,none" );
919 * If needed, load the Xscreensaver interface
920 * Currently, only for X
922 #ifdef HAVE_X11_XLIB_H
923 if( config_GetInt( p_libvlc, "disable-screensaver" ) )
925 libvlc_InternalAddIntf( p_libvlc, "screensaver,none" );
929 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
930 !config_GetInt( p_libvlc, "syslog" ) )
932 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
935 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
937 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
938 var_SetString( p_libvlc, "logmode", "syslog" );
939 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
943 var_SetString( p_libvlc, "logmode", logmode );
947 var_Destroy( p_libvlc, "logmode" );
951 if( config_GetInt( p_libvlc, "show-intf" ) > 0 )
953 libvlc_InternalAddIntf( p_libvlc, "showintf,none" );
956 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
958 libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
962 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
964 char *psz_codecs = config_GetPsz( p_playlist, "codec" );
967 char *psz_morecodecs;
968 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
970 config_PutPsz( p_libvlc, "codec", psz_morecodecs);
971 free( psz_morecodecs );
975 config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
981 * FIXME: kludge to use a p_libvlc-local variable for the Mozilla plugin
983 var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
984 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
985 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
986 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
987 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
991 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
993 /* Create volume callback system. */
994 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
996 /* Create a variable for showing the interface (moved from playlist). */
997 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
998 var_SetBool( p_libvlc, "intf-show", true );
1000 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1003 * Get input filenames given as commandline arguments
1005 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1008 * Get --open argument
1010 var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
1011 var_Get( p_libvlc, "open", &val );
1012 if ( val.psz_string != NULL && *val.psz_string )
1014 playlist_t *p_playlist = pl_Hold( p_libvlc );
1015 playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
1016 -1, NULL, 0, true, pl_Unlocked );
1017 pl_Release( p_libvlc );
1019 free( val.psz_string );
1025 * Cleanup a libvlc instance. The instance is not completely deallocated
1026 * \param p_libvlc the instance to clean
1028 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1030 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1031 playlist_t *p_playlist = priv->p_playlist;
1033 /* Deactivate the playlist */
1034 msg_Dbg( p_libvlc, "deactivating the playlist" );
1035 playlist_Deactivate( p_playlist );
1037 /* Remove all services discovery */
1038 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1039 playlist_ServicesDiscoveryKillAll( p_playlist );
1041 /* Ask the interfaces to stop and destroy them */
1042 msg_Dbg( p_libvlc, "removing all interfaces" );
1043 intf_thread_t *p_intf;
1044 while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
1046 intf_StopThread( p_intf );
1047 vlc_object_detach( p_intf );
1048 vlc_object_release( p_intf ); /* for intf_Create() */
1049 vlc_object_release( p_intf ); /* for vlc_object_find() */
1053 /* Destroy VLM if created in libvlc_InternalInit */
1056 vlm_Delete( priv->p_vlm );
1061 /* Any thread still running must not assume pl_Hold() succeeds. */
1062 msg_Dbg( p_libvlc, "removing playlist" );
1064 libvlc_priv(p_playlist->p_libvlc)->p_playlist = NULL;
1065 barrier(); /* FIXME is that correct ? */
1067 vlc_object_release( p_playlist );
1069 /* Free interaction */
1070 msg_Dbg( p_libvlc, "removing interaction" );
1071 interaction_Destroy( priv->p_interaction );
1073 stats_TimersDumpAll( p_libvlc );
1074 stats_TimersCleanAll( p_libvlc );
1076 msg_Dbg( p_libvlc, "removing stats" );
1077 vlc_mutex_destroy( &p_libvlc->p_stats->lock );
1078 FREENULL( p_libvlc->p_stats );
1081 char* psz_pidfile = NULL;
1085 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1086 if( psz_pidfile != NULL )
1088 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1089 if( unlink( psz_pidfile ) == -1 )
1091 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1095 free( psz_pidfile );
1099 if( priv->p_memcpy_module )
1101 module_unneed( p_libvlc, priv->p_memcpy_module );
1102 priv->p_memcpy_module = NULL;
1105 /* Free module bank. It is refcounted, so we call this each time */
1106 module_EndBank( p_libvlc );
1108 FREENULL( priv->psz_configfile );
1109 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1110 p_libvlc->p_hotkeys );
1111 FREENULL( p_libvlc->p_hotkeys );
1115 * Destroy everything.
1116 * This function requests the running threads to finish, waits for their
1117 * termination, and destroys their structure.
1118 * It stops the thread systems: no instance can run after this has run
1119 * \param p_libvlc the instance to destroy
1121 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1123 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1125 vlc_mutex_lock( &global_lock );
1128 if( i_instances == 0 )
1130 /* System specific cleaning code */
1131 system_End( p_libvlc );
1133 vlc_mutex_unlock( &global_lock );
1135 msg_Destroy( p_libvlc );
1137 /* Destroy mutexes */
1138 vlc_mutex_destroy( &priv->config_lock );
1139 vlc_mutex_destroy( &priv->timer_lock );
1141 vlc_object_release( p_libvlc );
1145 * Add an interface plugin and run it
1147 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1150 intf_thread_t *p_intf = NULL;
1153 return VLC_EGENERIC;
1155 if( !psz_module ) /* requesting the default interface */
1157 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1158 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1162 /* Daemon mode hack.
1163 * We prefer the dummy interface if none is specified. */
1164 psz_module = "dummy";
1167 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1169 free( psz_interface );
1172 /* Try to create the interface */
1173 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1174 if( p_intf == NULL )
1176 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1178 return VLC_EGENERIC;
1181 /* Try to run the interface */
1182 i_err = intf_RunThread( p_intf );
1185 vlc_object_detach( p_intf );
1186 vlc_object_release( p_intf );
1193 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1194 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1195 /*****************************************************************************
1196 * SetLanguage: set the interface language.
1197 *****************************************************************************
1198 * We set the LC_MESSAGES locale category for interface messages and buttons,
1199 * as well as the LC_CTYPE category for string sorting and possible wide
1200 * character support.
1201 *****************************************************************************/
1202 static void SetLanguage ( const char *psz_lang )
1205 /* I need that under Darwin, please check it doesn't disturb
1206 * other platforms. --Meuuh */
1207 setenv( "LANG", psz_lang, 1 );
1210 /* We set LC_ALL manually because it is the only way to set
1211 * the language at runtime under eg. Windows. Beware that this
1212 * makes the environment unconsistent when libvlc is unloaded and
1213 * should probably be moved to a safer place like vlc.c. */
1214 static char psz_lcall[20];
1215 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1216 psz_lcall[19] = '\0';
1217 putenv( psz_lcall );
1220 setlocale( LC_ALL, psz_lang );
1225 static inline int LoadMessages (void)
1227 #if defined( ENABLE_NLS ) \
1228 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1229 /* Specify where to find the locales for current domain */
1230 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1231 static const char psz_path[] = LOCALEDIR;
1233 char psz_path[1024];
1234 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1235 config_GetDataDir(), "locale")
1236 >= (int)sizeof (psz_path))
1240 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1242 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1243 " to directory %s\n", psz_path);
1247 /* LibVLC wants all messages in UTF-8.
1248 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1249 * and other functions that are not part of our text domain.
1251 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1253 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1255 // Unbinds the text domain to avoid broken encoding
1256 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1260 /* LibVLC does NOT set the default textdomain, since it is a library.
1261 * This could otherwise break programs using LibVLC (other than VLC).
1262 * textdomain (PACKAGE_NAME);
1268 /*****************************************************************************
1269 * GetFilenames: parse command line options which are not flags
1270 *****************************************************************************
1271 * Parse command line for input files as well as their associated options.
1272 * An option always follows its associated input and begins with a ":".
1273 *****************************************************************************/
1274 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1276 int i_opt, i_options;
1278 /* We assume that the remaining parameters are filenames
1279 * and their input options */
1280 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1284 /* Count the input options */
1285 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1291 /* TODO: write an internal function of this one, to avoid
1292 * unnecessary lookups. */
1294 playlist_t *p_playlist = pl_Hold( p_vlc );
1295 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1296 0, -1, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1297 i_options, true, pl_Unlocked );
1298 pl_Release( p_vlc );
1304 /*****************************************************************************
1305 * Help: print program help
1306 *****************************************************************************
1307 * Print a short inline help. Message interface is initialized at this stage.
1308 *****************************************************************************/
1309 static inline void print_help_on_full_help( void )
1311 utf8_fprintf( stdout, "\n" );
1312 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1315 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1318 ShowConsole( true );
1321 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1323 utf8_fprintf( stdout, vlc_usage, "vlc" );
1324 Usage( p_this, "=help" );
1325 Usage( p_this, "=main" );
1326 print_help_on_full_help();
1328 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1330 utf8_fprintf( stdout, vlc_usage, "vlc" );
1331 Usage( p_this, NULL );
1332 print_help_on_full_help();
1334 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1336 utf8_fprintf( stdout, vlc_usage, "vlc" );
1337 Usage( p_this, NULL );
1339 else if( psz_help_name )
1341 Usage( p_this, psz_help_name );
1344 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1349 /*****************************************************************************
1350 * Usage: print module usage
1351 *****************************************************************************
1352 * Print a short inline help. Message interface is initialized at this stage.
1353 *****************************************************************************/
1354 # define COL(x) "\033[" #x ";1m"
1355 # define RED COL(31)
1356 # define GREEN COL(32)
1357 # define YELLOW COL(33)
1358 # define BLUE COL(34)
1359 # define MAGENTA COL(35)
1360 # define CYAN COL(36)
1361 # define WHITE COL(0)
1362 # define GRAY "\033[0m"
1363 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1365 if( !p_item ) return;
1368 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1370 if( b_description && p_item->psz_longtext )
1371 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1372 p_item->psz_longtext );
1376 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1377 if( b_description && p_item->psz_longtext )
1378 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1382 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1384 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1385 /* short option ------' | | | | | | |
1386 * option name ------------' | | | | | |
1387 * <bra ---------------------' | | | | |
1388 * option type or "" ----------' | | | |
1389 * ket> -------------------------' | | |
1390 * padding spaces -----------------' | |
1391 * comment --------------------------' |
1392 * comment suffix ---------------------'
1394 * The purpose of having bra and ket is that we might i18n them as well.
1397 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1398 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1400 #define LINE_START 8
1401 #define PADDING_SPACES 25
1403 # define OPTION_VALUE_SEP "="
1405 # define OPTION_VALUE_SEP " "
1407 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1408 char psz_spaces_longtext[LINE_START+3];
1409 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1410 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1411 char psz_buffer[10000];
1413 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1414 int i_width_description = i_width + PADDING_SPACES - 1;
1415 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1416 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1417 bool b_description_hack;
1418 bool b_color = config_GetInt( p_this, "color" ) > 0;
1419 bool b_has_advanced = false;
1420 bool b_found = false;
1421 int i_only_advanced = 0; /* Number of modules ignored because they
1422 * only have advanced options */
1423 bool b_strict = psz_search && *psz_search == '=';
1424 if( b_strict ) psz_search++;
1426 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1427 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1428 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1429 psz_spaces_longtext[LINE_START+2] = '\0';
1433 b_color = false; // don't put color control codes in a .txt file
1437 strcpy( psz_format, COLOR_FORMAT_STRING );
1438 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1442 strcpy( psz_format, FORMAT_STRING );
1443 strcpy( psz_format_bool, FORMAT_STRING );
1446 /* List all modules */
1447 module_t **list = module_list_get (NULL);
1451 /* Ugly hack to make sure that the help options always come first
1454 Usage( p_this, "help" );
1456 /* Enumerate the config for each module */
1457 for (size_t i = 0; list[i]; i++)
1460 module_t *p_parser = list[i];
1461 module_config_t *p_item = NULL;
1462 module_config_t *p_section = NULL;
1463 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1466 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1467 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1469 char *const *pp_shortcut = p_parser->pp_shortcuts;
1470 while( *pp_shortcut )
1472 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1473 : !!strstr( *pp_shortcut, psz_search ) )
1481 /* Ignore modules without config options */
1482 if( !p_parser->i_config_items )
1487 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1488 /* Ugly hack to make sure that the help options always come first
1490 if( !psz_search && b_help_module )
1493 /* Ignore modules with only advanced config options if requested */
1496 for( p_item = p_parser->p_config;
1500 if( (p_item->i_type & CONFIG_ITEM) &&
1501 !p_item->b_advanced && !p_item->b_removed ) break;
1504 if( p_item == p_end )
1513 /* Print name of module */
1514 if( strcmp( "main", p_parser->psz_object_name ) )
1517 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1518 p_parser->psz_longname,
1519 p_parser->psz_object_name );
1521 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1523 if( p_parser->psz_help )
1526 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1528 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1531 /* Print module options */
1532 for( p_item = p_parser->p_config;
1536 char *psz_text, *psz_spaces = psz_spaces_text;
1537 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1538 const char *psz_suf = "", *psz_prefix = NULL;
1542 /* Skip removed options */
1543 if( p_item->b_removed )
1547 /* Skip advanced options if requested */
1548 if( p_item->b_advanced && !b_advanced )
1550 b_has_advanced = true;
1554 switch( p_item->i_type )
1556 case CONFIG_HINT_CATEGORY:
1557 case CONFIG_HINT_USAGE:
1558 if( !strcmp( "main", p_parser->psz_object_name ) )
1561 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1564 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1566 if( b_description && p_item->psz_longtext )
1569 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1570 p_item->psz_longtext );
1572 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1576 case CONFIG_HINT_SUBCATEGORY:
1577 if( strcmp( "main", p_parser->psz_object_name ) )
1579 case CONFIG_SECTION:
1583 case CONFIG_ITEM_STRING:
1584 case CONFIG_ITEM_FILE:
1585 case CONFIG_ITEM_DIRECTORY:
1586 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1587 case CONFIG_ITEM_MODULE_CAT:
1588 case CONFIG_ITEM_MODULE_LIST:
1589 case CONFIG_ITEM_MODULE_LIST_CAT:
1590 case CONFIG_ITEM_FONT:
1591 case CONFIG_ITEM_PASSWORD:
1592 print_help_section( p_section, b_color, b_description );
1594 psz_bra = OPTION_VALUE_SEP "<";
1595 psz_type = _("string");
1598 if( p_item->ppsz_list )
1600 psz_bra = OPTION_VALUE_SEP "{";
1601 psz_type = psz_buffer;
1602 psz_buffer[0] = '\0';
1603 for( i = 0; p_item->ppsz_list[i]; i++ )
1605 if( i ) strcat( psz_buffer, "," );
1606 strcat( psz_buffer, p_item->ppsz_list[i] );
1611 case CONFIG_ITEM_INTEGER:
1612 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1613 print_help_section( p_section, b_color, b_description );
1615 psz_bra = OPTION_VALUE_SEP "<";
1616 psz_type = _("integer");
1619 if( p_item->min.i || p_item->max.i )
1621 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1622 p_item->min.i, p_item->max.i );
1623 psz_type = psz_buffer;
1626 if( p_item->i_list )
1628 psz_bra = OPTION_VALUE_SEP "{";
1629 psz_type = psz_buffer;
1630 psz_buffer[0] = '\0';
1631 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1633 if( i ) strcat( psz_buffer, ", " );
1634 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1636 p_item->ppsz_list_text[i] );
1641 case CONFIG_ITEM_FLOAT:
1642 print_help_section( p_section, b_color, b_description );
1644 psz_bra = OPTION_VALUE_SEP "<";
1645 psz_type = _("float");
1647 if( p_item->min.f || p_item->max.f )
1649 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1650 p_item->min.f, p_item->max.f );
1651 psz_type = psz_buffer;
1654 case CONFIG_ITEM_BOOL:
1655 print_help_section( p_section, b_color, b_description );
1657 psz_bra = ""; psz_type = ""; psz_ket = "";
1658 if( !b_help_module )
1660 psz_suf = p_item->value.i ? _(" (default enabled)") :
1661 _(" (default disabled)");
1671 /* Add short option if any */
1672 if( p_item->i_short )
1674 sprintf( psz_short, "-%c,", p_item->i_short );
1678 strcpy( psz_short, " " );
1681 i = PADDING_SPACES - strlen( p_item->psz_name )
1682 - strlen( psz_bra ) - strlen( psz_type )
1683 - strlen( psz_ket ) - 1;
1685 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1687 psz_prefix = ", --no-";
1688 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1693 psz_spaces[0] = '\n';
1698 psz_spaces[i] = '\0';
1701 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1703 utf8_fprintf( stdout, psz_format_bool, psz_short,
1704 p_item->psz_name, psz_prefix, p_item->psz_name,
1705 psz_bra, psz_type, psz_ket, psz_spaces );
1709 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1710 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1713 psz_spaces[i] = ' ';
1715 /* We wrap the rest of the output */
1716 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1717 b_description_hack = b_description;
1720 psz_text = psz_buffer;
1721 i_cur_width = b_description && !b_description_hack
1722 ? i_width_description
1726 char *psz_parser, *psz_word;
1727 size_t i_end = strlen( psz_text );
1729 /* If the remaining text fits in a line, print it. */
1730 if( i_end <= i_cur_width )
1734 if( !b_description || b_description_hack )
1735 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1737 utf8_fprintf( stdout, "%s\n", psz_text );
1741 utf8_fprintf( stdout, "%s\n", psz_text );
1746 /* Otherwise, eat as many words as possible */
1747 psz_parser = psz_text;
1750 psz_word = psz_parser;
1751 psz_parser = strchr( psz_word, ' ' );
1752 /* If no space was found, we reached the end of the text
1753 * block; otherwise, we skip the space we just found. */
1754 psz_parser = psz_parser ? psz_parser + 1
1757 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1759 /* We cut a word in one of these cases:
1760 * - it's the only word in the line and it's too long.
1761 * - we used less than 80% of the width and the word we are
1762 * going to wrap is longer than 40% of the width, and even
1763 * if the word would have fit in the next line. */
1764 if( psz_word == psz_text
1765 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1766 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1768 char c = psz_text[i_cur_width];
1769 psz_text[i_cur_width] = '\0';
1772 if( !b_description || b_description_hack )
1773 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1774 psz_text, psz_spaces );
1776 utf8_fprintf( stdout, "%s\n%s",
1777 psz_text, psz_spaces );
1781 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1783 psz_text += i_cur_width;
1788 psz_word[-1] = '\0';
1791 if( !b_description || b_description_hack )
1792 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1793 psz_text, psz_spaces );
1795 utf8_fprintf( stdout, "%s\n%s",
1796 psz_text, psz_spaces );
1800 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1802 psz_text = psz_word;
1806 if( b_description_hack && p_item->psz_longtext )
1808 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1809 b_description_hack = false;
1810 psz_spaces = psz_spaces_longtext;
1811 utf8_fprintf( stdout, "%s", psz_spaces );
1817 if( b_has_advanced )
1820 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1821 _( "add --advanced to your command line to see advanced options."));
1823 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1824 _( "add --advanced to your command line to see advanced options."));
1827 if( i_only_advanced > 0 )
1831 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1832 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1836 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1837 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1843 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1844 _( "No matching module found. Use --list or" \
1845 "--list-verbose to list available modules." ) );
1847 utf8_fprintf( stdout, "\n%s\n",
1848 _( "No matching module found. Use --list or" \
1849 "--list-verbose to list available modules." ) );
1852 /* Release the module list */
1853 module_list_free (list);
1856 /*****************************************************************************
1857 * ListModules: list the available modules with their description
1858 *****************************************************************************
1859 * Print a list of all available modules (builtins and plugins) and a short
1860 * description for each one.
1861 *****************************************************************************/
1862 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1865 char psz_spaces[22];
1867 bool b_color = config_GetInt( p_this, "color" ) > 0;
1869 memset( psz_spaces, ' ', 22 );
1872 ShowConsole( true );
1875 /* List all modules */
1876 module_t **list = module_list_get (NULL);
1878 /* Enumerate each module */
1879 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1883 /* Nasty hack, but right now I'm too tired to think about a nice
1885 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1890 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1891 p_parser->psz_object_name,
1893 p_parser->psz_longname );
1895 utf8_fprintf( stdout, " %s%s %s\n",
1896 p_parser->psz_object_name,
1897 psz_spaces, p_parser->psz_longname );
1901 char *const *pp_shortcut = p_parser->pp_shortcuts;
1902 while( *pp_shortcut )
1904 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1907 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1910 utf8_fprintf( stdout, " s %s\n",
1915 if( p_parser->psz_capability )
1918 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1919 p_parser->psz_capability,
1920 p_parser->i_score );
1922 utf8_fprintf( stdout, " c %s (%d)\n",
1923 p_parser->psz_capability,
1924 p_parser->i_score );
1928 psz_spaces[i] = ' ';
1930 module_list_free (list);
1932 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1937 /*****************************************************************************
1938 * Version: print complete program version
1939 *****************************************************************************
1940 * Print complete program version and build number.
1941 *****************************************************************************/
1942 static void Version( void )
1945 ShowConsole( true );
1948 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1949 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1950 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1951 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1952 if( strcmp( VLC_Changeset(), "exported" ) )
1953 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1955 utf8_fprintf( stdout, LICENSE_MSG );
1957 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1962 /*****************************************************************************
1963 * ShowConsole: On Win32, create an output console for debug messages
1964 *****************************************************************************
1965 * This function is useful only on Win32.
1966 *****************************************************************************/
1968 static void ShowConsole( bool b_dofile )
1971 FILE *f_help = NULL;
1973 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1976 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1977 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1978 * page (e.g. CP437 or CP850). */
1979 SetConsoleOutputCP (GetACP ());
1980 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1982 freopen( "CONOUT$", "w", stderr );
1983 freopen( "CONIN$", "r", stdin );
1985 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1988 freopen( "vlc-help.txt", "wt", stdout );
1989 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1991 else freopen( "CONOUT$", "w", stdout );
1997 /*****************************************************************************
1998 * PauseConsole: On Win32, wait for a key press before closing the console
1999 *****************************************************************************
2000 * This function is useful only on Win32.
2001 *****************************************************************************/
2003 static void PauseConsole( void )
2007 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2009 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2017 /*****************************************************************************
2018 * ConsoleWidth: Return the console width in characters
2019 *****************************************************************************
2020 * We use the stty shell command to get the console width; if this fails or
2021 * if the width is less than 80, we default to 80.
2022 *****************************************************************************/
2023 static int ConsoleWidth( void )
2025 unsigned i_width = 80;
2028 FILE *file = popen( "stty size 2>/dev/null", "r" );
2031 if (fscanf (file, "%*u %u", &i_width) <= 0)
2035 #elif !defined (UNDER_CE)
2036 CONSOLE_SCREEN_BUFFER_INFO buf;
2038 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2039 i_width = buf.dwSize.X;
2045 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2046 vlc_value_t old_val, vlc_value_t new_val, void *param)
2048 libvlc_int_t *p_libvlc = (libvlc_int_t *)p_this;
2053 if( new_val.i_int >= -1 )
2055 libvlc_priv (p_libvlc)->i_verbose = __MIN( new_val.i_int, 2 );
2060 /*****************************************************************************
2061 * InitDeviceValues: initialize device values
2062 *****************************************************************************
2063 * This function inits the dvd, vcd and cd-audio values
2064 *****************************************************************************/
2065 static void InitDeviceValues( libvlc_int_t *p_vlc )
2068 LibHalContext * ctx = NULL;
2070 char **devices = NULL;
2071 char *block_dev = NULL;
2074 DBusConnection *p_connection = NULL;
2077 ctx = libhal_ctx_new();
2079 dbus_error_init( &error );
2080 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2081 if( dbus_error_is_set( &error ) || !p_connection )
2083 libhal_ctx_free( ctx );
2084 dbus_error_free( &error );
2087 libhal_ctx_set_dbus_connection( ctx, p_connection );
2088 if( libhal_ctx_init( ctx, &error ) )
2090 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2092 for( i = 0; i < i_devices; i++ )
2094 if( !libhal_device_property_exists( ctx, devices[i],
2095 "storage.cdrom.dvd", NULL ) )
2099 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2100 "storage.cdrom.dvd", NULL );
2101 block_dev = libhal_device_get_property_string( ctx,
2102 devices[ i ], "block.device" , NULL );
2105 config_PutPsz( p_vlc, "dvd", block_dev );
2108 config_PutPsz( p_vlc, "vcd", block_dev );
2109 config_PutPsz( p_vlc, "cd-audio", block_dev );
2110 libhal_free_string( block_dev );
2112 libhal_free_string_array( devices );
2114 libhal_ctx_shutdown( ctx, NULL );
2115 dbus_connection_unref( p_connection );
2116 libhal_ctx_free( ctx );
2120 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2124 #endif /* HAVE_HAL */