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"
87 #include <vlc_charset.h>
91 #include "playlist/playlist_internal.h"
96 # include <libkern/OSAtomic.h>
101 /*****************************************************************************
102 * The evil global variables. We handle them with care, don't worry.
103 *****************************************************************************/
104 static libvlc_int_t * p_static_vlc = NULL;
105 static unsigned i_instances = 0;
108 static bool b_daemon = false;
116 * Atomically set the reference count to 1.
117 * @param p_gc reference counted object
118 * @param pf_destruct destruction calback
121 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
123 /* There is no point in using the GC if there is no destructor... */
124 assert (pf_destruct);
125 p_gc->pf_destructor = pf_destruct;
128 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
129 __sync_synchronize ();
130 #elif defined (WIN32) && defined (__GNUC__)
131 #elif defined(__APPLE__)
134 /* Nobody else can possibly lock the spin - it's there as a barrier */
135 vlc_spin_init (&p_gc->spin);
136 vlc_spin_lock (&p_gc->spin);
137 vlc_spin_unlock (&p_gc->spin);
143 * Atomically increment the reference count.
144 * @param p_gc reference counted object
147 void *vlc_hold (gc_object_t * p_gc)
152 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
153 refs = __sync_add_and_fetch (&p_gc->refs, 1);
154 #elif defined (WIN32) && defined (__GNUC__)
155 refs = __builtin_choose_expr (sizeof (uintptr_t) == 4,
156 InterlockedIncrement (&p_gc->refs),
157 InterlockedIncrement64 (&p_gc->refs));
158 #elif defined(__APPLE__)
159 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
161 vlc_spin_lock (&p_gc->spin);
163 vlc_spin_unlock (&p_gc->spin);
165 assert (refs != 1); /* there had to be a reference already */
170 * Atomically decrement the reference count and, if it reaches zero, destroy.
171 * @param p_gc reference counted object.
173 void vlc_release (gc_object_t *p_gc)
179 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
180 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
181 #elif defined (WIN32) && defined (__GNUC__)
182 refs = __builtin_choose_expr (sizeof (uintptr_t) == 4,
183 InterlockedDecrement (&p_gc->refs),
184 InterlockedDecrement64 (&p_gc->refs));
185 #elif defined(__APPLE__)
186 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
188 vlc_spin_lock (&p_gc->spin);
190 vlc_spin_unlock (&p_gc->spin);
193 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
197 #elif defined (WIN32) && defined (__GNUC__)
198 #elif defined(__APPLE__)
200 vlc_spin_destroy (&p_gc->spin);
202 p_gc->pf_destructor (p_gc);
206 /*****************************************************************************
208 *****************************************************************************/
209 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
210 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
211 static void SetLanguage ( char const * );
213 static inline int LoadMessages (void);
214 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
215 static void Help ( libvlc_int_t *, char const *psz_help_name );
216 static void Usage ( libvlc_int_t *, char const *psz_search );
217 static void ListModules ( libvlc_int_t *, bool );
218 static void Version ( void );
221 static void ShowConsole ( bool );
222 static void PauseConsole ( void );
224 static int ConsoleWidth ( void );
226 static int VerboseCallback( vlc_object_t *, char const *,
227 vlc_value_t, vlc_value_t, void * );
229 static void InitDeviceValues( libvlc_int_t * );
231 vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
234 * Allocate a libvlc instance, initialize global data if needed
235 * It also initializes the threading system
237 libvlc_int_t * libvlc_InternalCreate( void )
239 libvlc_int_t *p_libvlc;
241 char *psz_env = NULL;
243 /* Now that the thread system is initialized, we don't have much, but
244 * at least we have variables */
245 vlc_mutex_lock( &global_lock );
246 if( i_instances == 0 )
248 /* Guess what CPU we have */
249 cpu_flags = CPUCapabilities();
250 /* The module bank will be initialized later */
253 /* Allocate a libvlc instance object */
254 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
255 VLC_OBJECT_GENERIC, "libvlc" );
256 if( p_libvlc != NULL )
258 vlc_mutex_unlock( &global_lock );
260 if( p_libvlc == NULL )
263 priv = libvlc_priv (p_libvlc);
264 priv->p_playlist = NULL;
265 priv->p_interaction = NULL;
267 p_libvlc->psz_object_name = strdup( "libvlc" );
269 /* Initialize message queue */
270 msg_Create( p_libvlc );
272 /* Find verbosity from VLC_VERBOSE environment variable */
273 psz_env = getenv( "VLC_VERBOSE" );
274 if( psz_env != NULL )
275 priv->i_verbose = atoi( psz_env );
278 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
279 priv->b_color = isatty( 2 ); /* 2 is for stderr */
281 priv->b_color = false;
284 /* Announce who we are - Do it only for first instance ? */
285 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
286 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
288 /* Initialize mutexes */
289 vlc_mutex_init( &priv->timer_lock );
290 vlc_mutex_init( &priv->config_lock );
292 /* Store data for the non-reentrant API */
293 p_static_vlc = p_libvlc;
299 * Initialize a libvlc instance
300 * This function initializes a previously allocated libvlc instance:
302 * - gettext initialization
303 * - message queue, module bank and playlist initialization
304 * - configuration and commandline parsing
306 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
307 const char *ppsz_argv[] )
309 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
310 char p_capabilities[200];
312 char * psz_modules = NULL;
313 char * psz_parser = NULL;
314 char * psz_control = NULL;
316 int i_ret = VLC_EEXIT;
317 playlist_t *p_playlist = NULL;
319 #if defined( ENABLE_NLS ) \
320 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
321 # if defined (WIN32) || defined (__APPLE__)
326 /* System specific initialization code */
327 system_Init( p_libvlc, &i_argc, ppsz_argv );
330 * Support for gettext
334 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
335 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
337 /* Initialize the module bank and load the configuration of the
338 * main module. We need to do this at this stage to be able to display
339 * a short help if required by the user. (short help == main module
341 module_InitBank( p_libvlc );
343 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
345 module_EndBank( p_libvlc );
349 /* Check for short help option */
350 if( config_GetInt( p_libvlc, "help" ) > 0 )
352 Help( p_libvlc, "help" );
354 i_ret = VLC_EEXITSUCCESS;
356 /* Check for version option */
357 else if( config_GetInt( p_libvlc, "version" ) > 0 )
361 i_ret = VLC_EEXITSUCCESS;
364 /* Set the config file stuff */
365 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
367 /* Check for plugins cache options */
368 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
370 /* Will be re-done properly later on */
371 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
373 /* Check for daemon mode */
375 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
378 char *psz_pidfile = NULL;
380 if( daemon( 1, 0) != 0 )
382 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
387 /* lets check if we need to write the pidfile */
388 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
389 if( psz_pidfile != NULL )
392 pid_t i_pid = getpid ();
393 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
394 i_pid, psz_pidfile );
395 pidfile = utf8_fopen( psz_pidfile,"w" );
396 if( pidfile != NULL )
398 utf8_fprintf( pidfile, "%d", (int)i_pid );
403 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
412 if( ( i_pid = fork() ) < 0 )
414 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
419 /* This is the parent, exit right now */
420 msg_Dbg( p_libvlc, "closing parent process" );
422 i_ret = VLC_EEXITSUCCESS;
426 /* We are the child */
427 msg_Dbg( p_libvlc, "daemon spawned" );
428 close( STDIN_FILENO );
429 close( STDOUT_FILENO );
430 close( STDERR_FILENO );
440 module_EndBank( p_libvlc );
444 /* Check for translation config option */
445 #if defined( ENABLE_NLS ) \
446 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
447 # if defined (WIN32) || defined (__APPLE__)
448 /* This ain't really nice to have to reload the config here but it seems
449 * the only way to do it. */
451 if( !config_GetInt( p_libvlc, "ignore-config" ) )
452 config_LoadConfigFile( p_libvlc, "main" );
453 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
455 /* Check if the user specified a custom language */
456 psz_language = config_GetPsz( p_libvlc, "language" );
457 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
459 /* Reset the default domain */
460 SetLanguage( psz_language );
462 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
463 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
465 module_EndBank( p_libvlc );
466 module_InitBank( p_libvlc );
467 if( !config_GetInt( p_libvlc, "ignore-config" ) )
468 config_LoadConfigFile( p_libvlc, "main" );
469 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
471 free( psz_language );
476 * Load the builtins and plugins into the module_bank.
477 * We have to do it before config_Load*() because this also gets the
478 * list of configuration options exported by each module and loads their
481 module_LoadBuiltins( p_libvlc );
482 module_LoadPlugins( p_libvlc, b_cache_delete );
483 if( p_libvlc->b_die )
489 module_t **list = module_list_get( &module_count );
490 module_list_free( list );
491 msg_Dbg( p_libvlc, "module bank initialized (%u modules)", module_count );
493 /* Check for help on modules */
494 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
496 Help( p_libvlc, p_tmp );
499 i_ret = VLC_EEXITSUCCESS;
501 /* Check for full help option */
502 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
504 config_PutInt( p_libvlc, "advanced", 1);
505 config_PutInt( p_libvlc, "help-verbose", 1);
506 Help( p_libvlc, "full-help" );
508 i_ret = VLC_EEXITSUCCESS;
510 /* Check for long help option */
511 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
513 Help( p_libvlc, "longhelp" );
515 i_ret = VLC_EEXITSUCCESS;
517 /* Check for module list option */
518 else if( config_GetInt( p_libvlc, "list" ) > 0 )
520 ListModules( p_libvlc, false );
522 i_ret = VLC_EEXITSUCCESS;
524 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
526 ListModules( p_libvlc, true );
528 i_ret = VLC_EEXITSUCCESS;
531 /* Check for config file options */
532 if( !config_GetInt( p_libvlc, "ignore-config" ) )
534 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
536 config_ResetAll( p_libvlc );
537 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
538 config_SaveConfigFile( p_libvlc, NULL );
540 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
542 config_LoadConfigFile( p_libvlc, NULL );
543 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
544 config_SaveConfigFile( p_libvlc, NULL );
550 module_EndBank( p_libvlc );
557 InitDeviceValues( p_libvlc );
560 * Override default configuration with config file settings
562 if( !config_GetInt( p_libvlc, "ignore-config" ) )
563 config_LoadConfigFile( p_libvlc, NULL );
566 * Override configuration with command line settings
568 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
571 ShowConsole( false );
572 /* Pause the console because it's destroyed when we exit */
573 fprintf( stderr, "The command line options couldn't be loaded, check "
574 "that they are valid.\n" );
577 module_EndBank( p_libvlc );
582 * System specific configuration
584 system_Configure( p_libvlc, &i_argc, ppsz_argv );
586 /* FIXME: could be replaced by using Unix sockets */
588 dbus_threads_init_default();
590 if( config_GetInt( p_libvlc, "one-instance" ) > 0
591 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
592 && config_GetInt( p_libvlc, "started-from-file" ) ) )
594 /* Initialise D-Bus interface, check for other instances */
595 DBusConnection *p_conn = NULL;
596 DBusError dbus_error;
598 dbus_error_init( &dbus_error );
600 /* connect to the session bus */
601 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
604 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
605 dbus_error.message );
606 dbus_error_free( &dbus_error );
610 /* check if VLC is available on the bus
611 * if not: D-Bus control is not enabled on the other
612 * instance and we can't pass MRLs to it */
613 DBusMessage *p_test_msg = NULL;
614 DBusMessage *p_test_reply = NULL;
615 p_test_msg = dbus_message_new_method_call(
616 "org.mpris.vlc", "/",
617 "org.freedesktop.MediaPlayer", "Identity" );
618 /* block until a reply arrives */
619 p_test_reply = dbus_connection_send_with_reply_and_block(
620 p_conn, p_test_msg, -1, &dbus_error );
621 dbus_message_unref( p_test_msg );
622 if( p_test_reply == NULL )
624 dbus_error_free( &dbus_error );
625 msg_Dbg( p_libvlc, "No Media Player is running. "
626 "Continuing normally." );
631 DBusMessage* p_dbus_msg = NULL;
632 DBusMessageIter dbus_args;
633 DBusPendingCall* p_dbus_pending = NULL;
636 dbus_message_unref( p_test_reply );
637 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
639 for( i_input = optind;i_input < i_argc;i_input++ )
641 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
642 ppsz_argv[i_input] );
644 p_dbus_msg = dbus_message_new_method_call(
645 "org.mpris.vlc", "/TrackList",
646 "org.freedesktop.MediaPlayer", "AddTrack" );
648 if ( NULL == p_dbus_msg )
650 msg_Err( p_libvlc, "D-Bus problem" );
651 system_End( p_libvlc );
652 exit( VLC_ETIMEOUT );
656 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
657 if ( !dbus_message_iter_append_basic( &dbus_args,
658 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
660 dbus_message_unref( p_dbus_msg );
661 system_End( p_libvlc );
665 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
667 if ( !dbus_message_iter_append_basic( &dbus_args,
668 DBUS_TYPE_BOOLEAN, &b_play ) )
670 dbus_message_unref( p_dbus_msg );
671 system_End( p_libvlc );
675 /* send message and get a handle for a reply */
676 if ( !dbus_connection_send_with_reply ( p_conn,
677 p_dbus_msg, &p_dbus_pending, -1 ) )
679 msg_Err( p_libvlc, "D-Bus problem" );
680 dbus_message_unref( p_dbus_msg );
681 system_End( p_libvlc );
682 exit( VLC_ETIMEOUT );
685 if ( NULL == p_dbus_pending )
687 msg_Err( p_libvlc, "D-Bus problem" );
688 dbus_message_unref( p_dbus_msg );
689 system_End( p_libvlc );
690 exit( VLC_ETIMEOUT );
692 dbus_connection_flush( p_conn );
693 dbus_message_unref( p_dbus_msg );
694 /* block until we receive a reply */
695 dbus_pending_call_block( p_dbus_pending );
696 dbus_pending_call_unref( p_dbus_pending );
697 } /* processes all command line MRLs */
700 system_End( p_libvlc );
704 /* we unreference the connection when we've finished with it */
705 if( p_conn ) dbus_connection_unref( p_conn );
710 * Message queue options
712 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
713 if( psz_verbose_objects )
715 char * psz_object, * iter = psz_verbose_objects;
716 while( (psz_object = strsep( &iter, "," )) )
718 switch( psz_object[0] )
720 printf("%s\n", psz_object+1);
721 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
722 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
724 msg_Err( p_libvlc, "verbose-objects usage: \n"
725 "--verbose-objects=+printthatobject,"
726 "-dontprintthatone\n"
727 "(keyword 'all' to applies to all objects)\n");
728 free( psz_verbose_objects );
732 free( psz_verbose_objects );
735 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
736 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
739 var_Set( p_libvlc, "verbose", val );
741 var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
742 var_Change( p_libvlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
745 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
748 * Output messages that may still be in the queue
750 msg_Flush( p_libvlc );
752 if( !config_GetInt( p_libvlc, "fpu" ) )
753 cpu_flags &= ~CPU_CAPABILITY_FPU;
755 #if defined( __i386__ ) || defined( __x86_64__ )
756 if( !config_GetInt( p_libvlc, "mmx" ) )
757 cpu_flags &= ~CPU_CAPABILITY_MMX;
758 if( !config_GetInt( p_libvlc, "3dn" ) )
759 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
760 if( !config_GetInt( p_libvlc, "mmxext" ) )
761 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
762 if( !config_GetInt( p_libvlc, "sse" ) )
763 cpu_flags &= ~CPU_CAPABILITY_SSE;
764 if( !config_GetInt( p_libvlc, "sse2" ) )
765 cpu_flags &= ~CPU_CAPABILITY_SSE2;
767 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
768 if( !config_GetInt( p_libvlc, "altivec" ) )
769 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
772 #define PRINT_CAPABILITY( capability, string ) \
773 if( vlc_CPU() & capability ) \
775 strncat( p_capabilities, string " ", \
776 sizeof(p_capabilities) - strlen(p_capabilities) ); \
777 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
780 p_capabilities[0] = '\0';
781 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
782 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
783 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
784 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
785 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
786 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
787 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
788 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
789 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
790 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
791 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
794 * Choose the best memcpy module
796 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", 0 );
798 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
800 priv->pp_timers = NULL;
803 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
804 if( !p_libvlc->p_stats )
806 vlc_object_release( p_libvlc );
809 vlc_mutex_init( &p_libvlc->p_stats->lock );
810 priv->p_stats_computer = NULL;
812 priv->i_last_input_id = 0; /* Not very safe, should be removed */
815 * Initialize hotkey handling
817 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
818 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
819 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
820 /* Do a copy (we don't need to modify the strings) */
821 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
822 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
823 p_libvlc->p_hotkeys );
825 /* Initialize interaction */
826 priv->p_interaction = interaction_Init( p_libvlc );
828 /* Initialize playlist and get commandline files */
829 playlist_ThreadCreate( p_libvlc );
830 if( !priv->p_playlist )
832 msg_Err( p_libvlc, "playlist initialization failed" );
833 if( priv->p_memcpy_module != NULL )
835 module_unneed( p_libvlc, priv->p_memcpy_module );
837 module_EndBank( p_libvlc );
840 p_playlist = priv->p_playlist;
842 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
843 if( psz_modules && *psz_modules )
845 /* Add service discovery modules */
846 playlist_ServicesDiscoveryAdd( p_playlist, psz_modules );
851 /* Initialize VLM if vlm-conf is specified */
852 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
853 if( psz_parser && *psz_parser )
855 priv->p_vlm = vlm_New( p_libvlc );
857 msg_Err( p_libvlc, "VLM initialization failed" );
863 * Load background interfaces
865 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
866 psz_control = config_GetPsz( p_libvlc, "control" );
868 if( psz_modules && *psz_modules && psz_control && *psz_control )
870 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
871 strlen( psz_control ) + 1 );
872 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
874 else if( psz_control && *psz_control )
877 psz_modules = strdup( psz_control );
880 psz_parser = psz_modules;
881 while ( psz_parser && *psz_parser )
883 char *psz_module, *psz_temp;
884 psz_module = psz_parser;
885 psz_parser = strchr( psz_module, ':' );
891 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
894 sprintf( psz_temp, "%s,none", psz_module );
895 libvlc_InternalAddIntf( p_libvlc, psz_temp );
903 * Always load the hotkeys interface if it exists
905 libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
908 /* loads dbus control interface if in one-instance mode
909 * we do it only when playlist exists, because dbus module needs it */
910 if( config_GetInt( p_libvlc, "one-instance" ) > 0
911 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
912 && config_GetInt( p_libvlc, "started-from-file" ) ) )
913 libvlc_InternalAddIntf( p_libvlc, "dbus,none" );
915 /* Prevents the power management daemon from suspending the system
916 * when VLC is active */
917 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
918 libvlc_InternalAddIntf( p_libvlc, "inhibit,none" );
922 * If needed, load the Xscreensaver interface
923 * Currently, only for X
925 #ifdef HAVE_X11_XLIB_H
926 if( config_GetInt( p_libvlc, "disable-screensaver" ) )
928 libvlc_InternalAddIntf( p_libvlc, "screensaver,none" );
932 if( config_GetInt( p_libvlc, "file-logging" ) > 0 )
934 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
937 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
939 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
940 var_SetString( p_libvlc, "logmode", "syslog" );
941 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
945 var_SetString( p_libvlc, "logmode", logmode );
949 var_Destroy( p_libvlc, "logmode" );
953 if( config_GetInt( p_libvlc, "show-intf" ) > 0 )
955 libvlc_InternalAddIntf( p_libvlc, "showintf,none" );
958 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
960 libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
964 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
966 char *psz_codecs = config_GetPsz( p_playlist, "codec" );
969 char *psz_morecodecs;
970 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
972 config_PutPsz( p_libvlc, "codec", psz_morecodecs);
973 free( psz_morecodecs );
977 config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
983 * FIXME: kludge to use a p_libvlc-local variable for the Mozilla plugin
985 var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
986 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
987 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
991 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
992 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
993 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
995 /* Create volume callback system. */
996 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
998 /* Create a variable for showing the interface (moved from playlist). */
999 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
1000 var_SetBool( p_libvlc, "intf-show", true );
1002 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1005 * Get input filenames given as commandline arguments
1007 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1010 * Get --open argument
1012 var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
1013 var_Get( p_libvlc, "open", &val );
1014 if ( val.psz_string != NULL && *val.psz_string )
1016 playlist_t *p_playlist = pl_Hold( p_libvlc );
1017 playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
1018 -1, NULL, 0, true, pl_Unlocked );
1019 pl_Release( p_libvlc );
1021 free( val.psz_string );
1027 * Cleanup a libvlc instance. The instance is not completely deallocated
1028 * \param p_libvlc the instance to clean
1030 int libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1032 intf_thread_t * p_intf = NULL;
1033 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1035 /* Ask the interfaces to stop and destroy them */
1036 msg_Dbg( p_libvlc, "removing all interfaces" );
1037 while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
1039 intf_StopThread( p_intf );
1040 vlc_object_detach( p_intf );
1041 vlc_object_release( p_intf ); /* for intf_Create() */
1042 vlc_object_release( p_intf ); /* for vlc_object_find() */
1046 /* Destroy VLM if created in libvlc_InternalInit */
1049 vlm_Delete( priv->p_vlm );
1053 playlist_t *p_playlist = priv->p_playlist;
1054 /* Remove all services discovery */
1055 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1056 playlist_ServicesDiscoveryKillAll( p_playlist );
1059 /* Any thread still running must not assume pl_Hold() succeeds. */
1060 msg_Dbg( p_libvlc, "removing playlist" );
1061 priv->p_playlist = NULL;
1062 vlc_object_kill( p_playlist ); /* <-- memory barrier for pl_Hold() */
1063 vlc_thread_join( p_playlist );
1064 vlc_object_release( p_playlist );
1066 /* Free interaction */
1067 msg_Dbg( p_libvlc, "removing interaction" );
1068 interaction_Destroy( priv->p_interaction );
1070 /* Free video outputs */
1071 msg_Dbg( p_libvlc, "removing all video outputs" );
1072 vlc_list_t *list = vlc_list_find (p_libvlc, VLC_OBJECT_VOUT, FIND_CHILD);
1073 for (int i = 0; i < list->i_count; i++)
1074 vlc_object_release (list->p_values[i].p_object);
1075 vlc_list_release (list);
1077 stats_TimersDumpAll( p_libvlc );
1078 stats_TimersCleanAll( p_libvlc );
1080 msg_Dbg( p_libvlc, "removing stats" );
1081 vlc_mutex_destroy( &p_libvlc->p_stats->lock );
1082 FREENULL( p_libvlc->p_stats );
1088 * Destroy everything.
1089 * This function requests the running threads to finish, waits for their
1090 * termination, and destroys their structure.
1091 * It stops the thread systems: no instance can run after this has run
1092 * \param p_libvlc the instance to destroy
1094 int libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1097 return VLC_EGENERIC;
1099 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1102 char* psz_pidfile = NULL;
1106 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1107 if( psz_pidfile != NULL )
1109 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1110 if( unlink( psz_pidfile ) == -1 )
1112 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1116 free( psz_pidfile );
1120 if( priv->p_memcpy_module )
1122 module_unneed( p_libvlc, priv->p_memcpy_module );
1123 priv->p_memcpy_module = NULL;
1126 /* Free module bank. It is refcounted, so we call this each time */
1127 module_EndBank( p_libvlc );
1129 FREENULL( priv->psz_configfile );
1130 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1131 p_libvlc->p_hotkeys );
1132 FREENULL( p_libvlc->p_hotkeys );
1134 vlc_mutex_lock( &global_lock );
1137 if( i_instances == 0 )
1139 /* System specific cleaning code */
1140 system_End( p_libvlc );
1142 vlc_mutex_unlock( &global_lock );
1144 msg_Flush( p_libvlc );
1145 msg_Destroy( p_libvlc );
1147 /* Destroy mutexes */
1148 vlc_mutex_destroy( &priv->config_lock );
1149 vlc_mutex_destroy( &priv->timer_lock );
1151 vlc_object_release( p_libvlc );
1158 * Add an interface plugin and run it
1160 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1163 intf_thread_t *p_intf = NULL;
1166 return VLC_EGENERIC;
1168 if( !psz_module ) /* requesting the default interface */
1170 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1171 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1175 /* Daemon mode hack.
1176 * We prefer the dummy interface if none is specified. */
1177 psz_module = "dummy";
1180 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1182 free( psz_interface );
1185 /* Try to create the interface */
1186 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1187 if( p_intf == NULL )
1189 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1191 return VLC_EGENERIC;
1194 /* Try to run the interface */
1195 i_err = intf_RunThread( p_intf );
1198 vlc_object_detach( p_intf );
1199 vlc_object_release( p_intf );
1206 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1207 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1208 /*****************************************************************************
1209 * SetLanguage: set the interface language.
1210 *****************************************************************************
1211 * We set the LC_MESSAGES locale category for interface messages and buttons,
1212 * as well as the LC_CTYPE category for string sorting and possible wide
1213 * character support.
1214 *****************************************************************************/
1215 static void SetLanguage ( const char *psz_lang )
1218 /* I need that under Darwin, please check it doesn't disturb
1219 * other platforms. --Meuuh */
1220 setenv( "LANG", psz_lang, 1 );
1223 /* We set LC_ALL manually because it is the only way to set
1224 * the language at runtime under eg. Windows. Beware that this
1225 * makes the environment unconsistent when libvlc is unloaded and
1226 * should probably be moved to a safer place like vlc.c. */
1227 static char psz_lcall[20];
1228 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1229 psz_lcall[19] = '\0';
1230 putenv( psz_lcall );
1233 setlocale( LC_ALL, psz_lang );
1238 static inline int LoadMessages (void)
1240 #if defined( ENABLE_NLS ) \
1241 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1242 /* Specify where to find the locales for current domain */
1243 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1244 static const char psz_path[] = LOCALEDIR;
1246 char psz_path[1024];
1247 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1248 config_GetDataDir(), "locale")
1249 >= (int)sizeof (psz_path))
1253 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1255 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1256 " to directory %s\n", psz_path);
1260 /* LibVLC wants all messages in UTF-8.
1261 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1262 * and other functions that are not part of our text domain.
1264 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1266 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1268 // Unbinds the text domain to avoid broken encoding
1269 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1273 /* LibVLC does NOT set the default textdomain, since it is a library.
1274 * This could otherwise break programs using LibVLC (other than VLC).
1275 * textdomain (PACKAGE_NAME);
1281 /*****************************************************************************
1282 * GetFilenames: parse command line options which are not flags
1283 *****************************************************************************
1284 * Parse command line for input files as well as their associated options.
1285 * An option always follows its associated input and begins with a ":".
1286 *****************************************************************************/
1287 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1289 int i_opt, i_options;
1291 /* We assume that the remaining parameters are filenames
1292 * and their input options */
1293 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1297 /* Count the input options */
1298 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1304 /* TODO: write an internal function of this one, to avoid
1305 * unnecessary lookups. */
1307 playlist_t *p_playlist = pl_Hold( p_vlc );
1308 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1309 0, -1, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1310 i_options, true, pl_Unlocked );
1311 pl_Release( p_vlc );
1317 /*****************************************************************************
1318 * Help: print program help
1319 *****************************************************************************
1320 * Print a short inline help. Message interface is initialized at this stage.
1321 *****************************************************************************/
1322 static inline void print_help_on_full_help( void )
1324 utf8_fprintf( stdout, "\n" );
1325 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1328 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1331 ShowConsole( true );
1334 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1336 utf8_fprintf( stdout, vlc_usage, "vlc" );
1337 Usage( p_this, "=help" );
1338 Usage( p_this, "=main" );
1339 print_help_on_full_help();
1341 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1343 utf8_fprintf( stdout, vlc_usage, "vlc" );
1344 Usage( p_this, NULL );
1345 print_help_on_full_help();
1347 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1349 utf8_fprintf( stdout, vlc_usage, "vlc" );
1350 Usage( p_this, NULL );
1352 else if( psz_help_name )
1354 Usage( p_this, psz_help_name );
1357 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1362 /*****************************************************************************
1363 * Usage: print module usage
1364 *****************************************************************************
1365 * Print a short inline help. Message interface is initialized at this stage.
1366 *****************************************************************************/
1367 # define COL(x) "\033[" #x ";1m"
1368 # define RED COL(31)
1369 # define GREEN COL(32)
1370 # define YELLOW COL(33)
1371 # define BLUE COL(34)
1372 # define MAGENTA COL(35)
1373 # define CYAN COL(36)
1374 # define WHITE COL(0)
1375 # define GRAY "\033[0m"
1376 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1378 if( !p_item ) return;
1381 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1383 if( b_description && p_item->psz_longtext )
1384 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1385 p_item->psz_longtext );
1389 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1390 if( b_description && p_item->psz_longtext )
1391 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1395 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1397 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1398 /* short option ------' | | | | | | |
1399 * option name ------------' | | | | | |
1400 * <bra ---------------------' | | | | |
1401 * option type or "" ----------' | | | |
1402 * ket> -------------------------' | | |
1403 * padding spaces -----------------' | |
1404 * comment --------------------------' |
1405 * comment suffix ---------------------'
1407 * The purpose of having bra and ket is that we might i18n them as well.
1410 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1411 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1413 #define LINE_START 8
1414 #define PADDING_SPACES 25
1416 # define OPTION_VALUE_SEP "="
1418 # define OPTION_VALUE_SEP " "
1420 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1421 char psz_spaces_longtext[LINE_START+3];
1422 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1423 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1424 char psz_buffer[10000];
1426 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1427 int i_width_description = i_width + PADDING_SPACES - 1;
1428 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1429 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1430 bool b_description_hack;
1431 bool b_color = config_GetInt( p_this, "color" ) > 0;
1432 bool b_has_advanced = false;
1433 bool b_found = false;
1434 int i_only_advanced = 0; /* Number of modules ignored because they
1435 * only have advanced options */
1436 bool b_strict = psz_search && *psz_search == '=';
1437 if( b_strict ) psz_search++;
1439 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1440 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1441 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1442 psz_spaces_longtext[LINE_START+2] = '\0';
1446 b_color = false; // don't put color control codes in a .txt file
1450 strcpy( psz_format, COLOR_FORMAT_STRING );
1451 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1455 strcpy( psz_format, FORMAT_STRING );
1456 strcpy( psz_format_bool, FORMAT_STRING );
1459 /* List all modules */
1460 module_t **list = module_list_get (NULL);
1464 /* Ugly hack to make sure that the help options always come first
1467 Usage( p_this, "help" );
1469 /* Enumerate the config for each module */
1470 for (size_t i = 0; list[i]; i++)
1473 module_t *p_parser = list[i];
1474 module_config_t *p_item = NULL;
1475 module_config_t *p_section = NULL;
1476 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1479 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1480 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1482 char *const *pp_shortcut = p_parser->pp_shortcuts;
1483 while( *pp_shortcut )
1485 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1486 : !!strstr( *pp_shortcut, psz_search ) )
1494 /* Ignore modules without config options */
1495 if( !p_parser->i_config_items )
1500 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1501 /* Ugly hack to make sure that the help options always come first
1503 if( !psz_search && b_help_module )
1506 /* Ignore modules with only advanced config options if requested */
1509 for( p_item = p_parser->p_config;
1513 if( (p_item->i_type & CONFIG_ITEM) &&
1514 !p_item->b_advanced && !p_item->b_removed ) break;
1517 if( p_item == p_end )
1526 /* Print name of module */
1527 if( strcmp( "main", p_parser->psz_object_name ) )
1530 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1531 p_parser->psz_longname,
1532 p_parser->psz_object_name );
1534 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1536 if( p_parser->psz_help )
1539 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1541 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1544 /* Print module options */
1545 for( p_item = p_parser->p_config;
1549 char *psz_text, *psz_spaces = psz_spaces_text;
1550 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1551 const char *psz_suf = "", *psz_prefix = NULL;
1555 /* Skip removed options */
1556 if( p_item->b_removed )
1560 /* Skip advanced options if requested */
1561 if( p_item->b_advanced && !b_advanced )
1563 b_has_advanced = true;
1567 switch( p_item->i_type )
1569 case CONFIG_HINT_CATEGORY:
1570 case CONFIG_HINT_USAGE:
1571 if( !strcmp( "main", p_parser->psz_object_name ) )
1574 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1577 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1579 if( b_description && p_item->psz_longtext )
1582 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1583 p_item->psz_longtext );
1585 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1589 case CONFIG_HINT_SUBCATEGORY:
1590 if( strcmp( "main", p_parser->psz_object_name ) )
1592 case CONFIG_SECTION:
1596 case CONFIG_ITEM_STRING:
1597 case CONFIG_ITEM_FILE:
1598 case CONFIG_ITEM_DIRECTORY:
1599 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1600 case CONFIG_ITEM_MODULE_CAT:
1601 case CONFIG_ITEM_MODULE_LIST:
1602 case CONFIG_ITEM_MODULE_LIST_CAT:
1603 case CONFIG_ITEM_FONT:
1604 case CONFIG_ITEM_PASSWORD:
1605 print_help_section( p_section, b_color, b_description );
1607 psz_bra = OPTION_VALUE_SEP "<";
1608 psz_type = _("string");
1611 if( p_item->ppsz_list )
1613 psz_bra = OPTION_VALUE_SEP "{";
1614 psz_type = psz_buffer;
1615 psz_buffer[0] = '\0';
1616 for( i = 0; p_item->ppsz_list[i]; i++ )
1618 if( i ) strcat( psz_buffer, "," );
1619 strcat( psz_buffer, p_item->ppsz_list[i] );
1624 case CONFIG_ITEM_INTEGER:
1625 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1626 print_help_section( p_section, b_color, b_description );
1628 psz_bra = OPTION_VALUE_SEP "<";
1629 psz_type = _("integer");
1632 if( p_item->min.i || p_item->max.i )
1634 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1635 p_item->min.i, p_item->max.i );
1636 psz_type = psz_buffer;
1639 if( p_item->i_list )
1641 psz_bra = OPTION_VALUE_SEP "{";
1642 psz_type = psz_buffer;
1643 psz_buffer[0] = '\0';
1644 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1646 if( i ) strcat( psz_buffer, ", " );
1647 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1649 p_item->ppsz_list_text[i] );
1654 case CONFIG_ITEM_FLOAT:
1655 print_help_section( p_section, b_color, b_description );
1657 psz_bra = OPTION_VALUE_SEP "<";
1658 psz_type = _("float");
1660 if( p_item->min.f || p_item->max.f )
1662 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1663 p_item->min.f, p_item->max.f );
1664 psz_type = psz_buffer;
1667 case CONFIG_ITEM_BOOL:
1668 print_help_section( p_section, b_color, b_description );
1670 psz_bra = ""; psz_type = ""; psz_ket = "";
1671 if( !b_help_module )
1673 psz_suf = p_item->value.i ? _(" (default enabled)") :
1674 _(" (default disabled)");
1684 /* Add short option if any */
1685 if( p_item->i_short )
1687 sprintf( psz_short, "-%c,", p_item->i_short );
1691 strcpy( psz_short, " " );
1694 i = PADDING_SPACES - strlen( p_item->psz_name )
1695 - strlen( psz_bra ) - strlen( psz_type )
1696 - strlen( psz_ket ) - 1;
1698 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1700 psz_prefix = ", --no-";
1701 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1706 psz_spaces[0] = '\n';
1711 psz_spaces[i] = '\0';
1714 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1716 utf8_fprintf( stdout, psz_format_bool, psz_short,
1717 p_item->psz_name, psz_prefix, p_item->psz_name,
1718 psz_bra, psz_type, psz_ket, psz_spaces );
1722 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1723 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1726 psz_spaces[i] = ' ';
1728 /* We wrap the rest of the output */
1729 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1730 b_description_hack = b_description;
1733 psz_text = psz_buffer;
1734 i_cur_width = b_description && !b_description_hack
1735 ? i_width_description
1739 char *psz_parser, *psz_word;
1740 size_t i_end = strlen( psz_text );
1742 /* If the remaining text fits in a line, print it. */
1743 if( i_end <= i_cur_width )
1747 if( !b_description || b_description_hack )
1748 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1750 utf8_fprintf( stdout, "%s\n", psz_text );
1754 utf8_fprintf( stdout, "%s\n", psz_text );
1759 /* Otherwise, eat as many words as possible */
1760 psz_parser = psz_text;
1763 psz_word = psz_parser;
1764 psz_parser = strchr( psz_word, ' ' );
1765 /* If no space was found, we reached the end of the text
1766 * block; otherwise, we skip the space we just found. */
1767 psz_parser = psz_parser ? psz_parser + 1
1770 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1772 /* We cut a word in one of these cases:
1773 * - it's the only word in the line and it's too long.
1774 * - we used less than 80% of the width and the word we are
1775 * going to wrap is longer than 40% of the width, and even
1776 * if the word would have fit in the next line. */
1777 if( psz_word == psz_text
1778 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1779 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1781 char c = psz_text[i_cur_width];
1782 psz_text[i_cur_width] = '\0';
1785 if( !b_description || b_description_hack )
1786 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1787 psz_text, psz_spaces );
1789 utf8_fprintf( stdout, "%s\n%s",
1790 psz_text, psz_spaces );
1794 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1796 psz_text += i_cur_width;
1801 psz_word[-1] = '\0';
1804 if( !b_description || b_description_hack )
1805 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1806 psz_text, psz_spaces );
1808 utf8_fprintf( stdout, "%s\n%s",
1809 psz_text, psz_spaces );
1813 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1815 psz_text = psz_word;
1819 if( b_description_hack && p_item->psz_longtext )
1821 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1822 b_description_hack = false;
1823 psz_spaces = psz_spaces_longtext;
1824 utf8_fprintf( stdout, "%s", psz_spaces );
1830 if( b_has_advanced )
1833 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1834 _( "add --advanced to your command line to see advanced options."));
1836 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1837 _( "add --advanced to your command line to see advanced options."));
1840 if( i_only_advanced > 0 )
1844 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1845 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1849 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1850 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1856 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1857 _( "No matching module found. Use --list or" \
1858 "--list-verbose to list available modules." ) );
1860 utf8_fprintf( stdout, "\n%s\n",
1861 _( "No matching module found. Use --list or" \
1862 "--list-verbose to list available modules." ) );
1865 /* Release the module list */
1866 module_list_free (list);
1869 /*****************************************************************************
1870 * ListModules: list the available modules with their description
1871 *****************************************************************************
1872 * Print a list of all available modules (builtins and plugins) and a short
1873 * description for each one.
1874 *****************************************************************************/
1875 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1878 char psz_spaces[22];
1880 bool b_color = config_GetInt( p_this, "color" ) > 0;
1882 memset( psz_spaces, ' ', 22 );
1885 ShowConsole( true );
1888 /* List all modules */
1889 module_t **list = module_list_get (NULL);
1891 /* Enumerate each module */
1892 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1896 /* Nasty hack, but right now I'm too tired to think about a nice
1898 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1903 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1904 p_parser->psz_object_name,
1906 p_parser->psz_longname );
1908 utf8_fprintf( stdout, " %s%s %s\n",
1909 p_parser->psz_object_name,
1910 psz_spaces, p_parser->psz_longname );
1914 char *const *pp_shortcut = p_parser->pp_shortcuts;
1915 while( *pp_shortcut )
1917 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1920 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1923 utf8_fprintf( stdout, " s %s\n",
1928 if( p_parser->psz_capability )
1931 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1932 p_parser->psz_capability,
1933 p_parser->i_score );
1935 utf8_fprintf( stdout, " c %s (%d)\n",
1936 p_parser->psz_capability,
1937 p_parser->i_score );
1941 psz_spaces[i] = ' ';
1943 module_list_free (list);
1945 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1950 /*****************************************************************************
1951 * Version: print complete program version
1952 *****************************************************************************
1953 * Print complete program version and build number.
1954 *****************************************************************************/
1955 static void Version( void )
1958 ShowConsole( true );
1961 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1962 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1963 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1964 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1965 if( strcmp( VLC_Changeset(), "exported" ) )
1966 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1968 utf8_fprintf( stdout, LICENSE_MSG );
1970 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1975 /*****************************************************************************
1976 * ShowConsole: On Win32, create an output console for debug messages
1977 *****************************************************************************
1978 * This function is useful only on Win32.
1979 *****************************************************************************/
1981 static void ShowConsole( bool b_dofile )
1984 FILE *f_help = NULL;
1986 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1989 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1990 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1991 * page (e.g. CP437 or CP850). */
1992 SetConsoleOutputCP (GetACP ());
1993 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1995 freopen( "CONOUT$", "w", stderr );
1996 freopen( "CONIN$", "r", stdin );
1998 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2001 freopen( "vlc-help.txt", "wt", stdout );
2002 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2004 else freopen( "CONOUT$", "w", stdout );
2010 /*****************************************************************************
2011 * PauseConsole: On Win32, wait for a key press before closing the console
2012 *****************************************************************************
2013 * This function is useful only on Win32.
2014 *****************************************************************************/
2016 static void PauseConsole( void )
2020 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2022 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2030 /*****************************************************************************
2031 * ConsoleWidth: Return the console width in characters
2032 *****************************************************************************
2033 * We use the stty shell command to get the console width; if this fails or
2034 * if the width is less than 80, we default to 80.
2035 *****************************************************************************/
2036 static int ConsoleWidth( void )
2038 unsigned i_width = 80;
2041 FILE *file = popen( "stty size 2>/dev/null", "r" );
2044 if (fscanf (file, "%*u %u", &i_width) <= 0)
2048 #elif !defined (UNDER_CE)
2049 CONSOLE_SCREEN_BUFFER_INFO buf;
2051 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2052 i_width = buf.dwSize.X;
2058 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2059 vlc_value_t old_val, vlc_value_t new_val, void *param)
2061 libvlc_int_t *p_libvlc = (libvlc_int_t *)p_this;
2066 if( new_val.i_int >= -1 )
2068 libvlc_priv (p_libvlc)->i_verbose = __MIN( new_val.i_int, 2 );
2073 /*****************************************************************************
2074 * InitDeviceValues: initialize device values
2075 *****************************************************************************
2076 * This function inits the dvd, vcd and cd-audio values
2077 *****************************************************************************/
2078 static void InitDeviceValues( libvlc_int_t *p_vlc )
2081 LibHalContext * ctx = NULL;
2083 char **devices = NULL;
2084 char *block_dev = NULL;
2087 DBusConnection *p_connection = NULL;
2090 ctx = libhal_ctx_new();
2092 dbus_error_init( &error );
2093 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2094 if( dbus_error_is_set( &error ) || !p_connection )
2096 libhal_ctx_free( ctx );
2097 dbus_error_free( &error );
2100 libhal_ctx_set_dbus_connection( ctx, p_connection );
2101 if( libhal_ctx_init( ctx, &error ) )
2103 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2105 for( i = 0; i < i_devices; i++ )
2107 if( !libhal_device_property_exists( ctx, devices[i],
2108 "storage.cdrom.dvd", NULL ) )
2112 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2113 "storage.cdrom.dvd", NULL );
2114 block_dev = libhal_device_get_property_string( ctx,
2115 devices[ i ], "block.device" , NULL );
2118 config_PutPsz( p_vlc, "dvd", block_dev );
2121 config_PutPsz( p_vlc, "vcd", block_dev );
2122 config_PutPsz( p_vlc, "cd-audio", block_dev );
2123 libhal_free_string( block_dev );
2125 libhal_free_string_array( devices );
2127 libhal_ctx_shutdown( ctx, NULL );
2128 dbus_connection_unref( p_connection );
2129 libhal_ctx_free( ctx );
2133 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2137 #endif /* HAVE_HAL */