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 );
286 vlc_cond_init( &priv->exiting );
292 * Initialize a libvlc instance
293 * This function initializes a previously allocated libvlc instance:
295 * - gettext initialization
296 * - message queue, module bank and playlist initialization
297 * - configuration and commandline parsing
299 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
300 const char *ppsz_argv[] )
302 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
303 char p_capabilities[200];
305 char * psz_modules = NULL;
306 char * psz_parser = NULL;
307 char * psz_control = NULL;
309 int i_ret = VLC_EEXIT;
310 playlist_t *p_playlist = NULL;
312 #if defined( ENABLE_NLS ) \
313 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
314 # if defined (WIN32) || defined (__APPLE__)
319 /* System specific initialization code */
320 system_Init( p_libvlc, &i_argc, ppsz_argv );
323 * Support for gettext
327 /* Initialize the module bank and load the configuration of the
328 * main module. We need to do this at this stage to be able to display
329 * a short help if required by the user. (short help == main module
331 module_InitBank( p_libvlc );
333 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
335 module_EndBank( p_libvlc );
339 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
340 /* Announce who we are - Do it only for first instance ? */
341 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
342 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
343 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
344 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
346 /* Check for short help option */
347 if( config_GetInt( p_libvlc, "help" ) > 0 )
349 Help( p_libvlc, "help" );
351 i_ret = VLC_EEXITSUCCESS;
353 /* Check for version option */
354 else if( config_GetInt( p_libvlc, "version" ) > 0 )
358 i_ret = VLC_EEXITSUCCESS;
361 /* Set the config file stuff */
362 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
364 /* Check for plugins cache options */
365 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
367 /* Check for daemon mode */
369 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
372 char *psz_pidfile = NULL;
374 if( daemon( 1, 0) != 0 )
376 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
381 /* lets check if we need to write the pidfile */
382 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
383 if( psz_pidfile != NULL )
386 pid_t i_pid = getpid ();
387 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
388 i_pid, psz_pidfile );
389 pidfile = utf8_fopen( psz_pidfile,"w" );
390 if( pidfile != NULL )
392 utf8_fprintf( pidfile, "%d", (int)i_pid );
397 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
406 if( ( i_pid = fork() ) < 0 )
408 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
413 /* This is the parent, exit right now */
414 msg_Dbg( p_libvlc, "closing parent process" );
416 i_ret = VLC_EEXITSUCCESS;
420 /* We are the child */
421 msg_Dbg( p_libvlc, "daemon spawned" );
422 close( STDIN_FILENO );
423 close( STDOUT_FILENO );
424 close( STDERR_FILENO );
434 free( priv->psz_configfile );
435 module_EndBank( p_libvlc );
439 /* Check for translation config option */
440 #if defined( ENABLE_NLS ) \
441 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
442 # if defined (WIN32) || defined (__APPLE__)
443 /* This ain't really nice to have to reload the config here but it seems
444 * the only way to do it. */
446 if( !config_GetInt( p_libvlc, "ignore-config" ) )
447 config_LoadConfigFile( p_libvlc, "main" );
448 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
450 /* Check if the user specified a custom language */
451 psz_language = config_GetPsz( p_libvlc, "language" );
452 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
454 /* Reset the default domain */
455 SetLanguage( psz_language );
457 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
458 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
460 module_EndBank( p_libvlc );
461 module_InitBank( p_libvlc );
462 if( !config_GetInt( p_libvlc, "ignore-config" ) )
463 config_LoadConfigFile( p_libvlc, "main" );
464 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
466 free( psz_language );
471 * Load the builtins and plugins into the module_bank.
472 * We have to do it before config_Load*() because this also gets the
473 * list of configuration options exported by each module and loads their
476 module_LoadBuiltins( p_libvlc );
477 module_LoadPlugins( p_libvlc, b_cache_delete );
478 if( p_libvlc->b_die )
484 module_t **list = module_list_get( &module_count );
485 module_list_free( list );
486 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
488 /* Check for help on modules */
489 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
491 Help( p_libvlc, p_tmp );
494 i_ret = VLC_EEXITSUCCESS;
496 /* Check for full help option */
497 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
499 config_PutInt( p_libvlc, "advanced", 1);
500 config_PutInt( p_libvlc, "help-verbose", 1);
501 Help( p_libvlc, "full-help" );
503 i_ret = VLC_EEXITSUCCESS;
505 /* Check for long help option */
506 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
508 Help( p_libvlc, "longhelp" );
510 i_ret = VLC_EEXITSUCCESS;
512 /* Check for module list option */
513 else if( config_GetInt( p_libvlc, "list" ) > 0 )
515 ListModules( p_libvlc, false );
517 i_ret = VLC_EEXITSUCCESS;
519 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
521 ListModules( p_libvlc, true );
523 i_ret = VLC_EEXITSUCCESS;
526 /* Check for config file options */
527 if( !config_GetInt( p_libvlc, "ignore-config" ) )
529 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
531 config_ResetAll( p_libvlc );
532 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
533 config_SaveConfigFile( p_libvlc, NULL );
535 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
537 config_LoadConfigFile( p_libvlc, NULL );
538 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
539 config_SaveConfigFile( p_libvlc, NULL );
545 free( priv->psz_configfile );
546 module_EndBank( p_libvlc );
553 InitDeviceValues( p_libvlc );
556 * Override default configuration with config file settings
558 if( !config_GetInt( p_libvlc, "ignore-config" ) )
559 config_LoadConfigFile( p_libvlc, NULL );
562 * Override configuration with command line settings
564 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
567 ShowConsole( false );
568 /* Pause the console because it's destroyed when we exit */
569 fprintf( stderr, "The command line options couldn't be loaded, check "
570 "that they are valid.\n" );
573 free( priv->psz_configfile );
574 module_EndBank( p_libvlc );
579 * System specific configuration
581 system_Configure( p_libvlc, &i_argc, ppsz_argv );
583 /* FIXME: could be replaced by using Unix sockets */
585 dbus_threads_init_default();
587 if( config_GetInt( p_libvlc, "one-instance" ) > 0
588 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
589 && config_GetInt( p_libvlc, "started-from-file" ) ) )
591 /* Initialise D-Bus interface, check for other instances */
592 DBusConnection *p_conn = NULL;
593 DBusError dbus_error;
595 dbus_error_init( &dbus_error );
597 /* connect to the session bus */
598 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
601 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
602 dbus_error.message );
603 dbus_error_free( &dbus_error );
607 /* check if VLC is available on the bus
608 * if not: D-Bus control is not enabled on the other
609 * instance and we can't pass MRLs to it */
610 DBusMessage *p_test_msg = NULL;
611 DBusMessage *p_test_reply = NULL;
612 p_test_msg = dbus_message_new_method_call(
613 "org.mpris.vlc", "/",
614 "org.freedesktop.MediaPlayer", "Identity" );
615 /* block until a reply arrives */
616 p_test_reply = dbus_connection_send_with_reply_and_block(
617 p_conn, p_test_msg, -1, &dbus_error );
618 dbus_message_unref( p_test_msg );
619 if( p_test_reply == NULL )
621 dbus_error_free( &dbus_error );
622 msg_Dbg( p_libvlc, "No Media Player is running. "
623 "Continuing normally." );
628 DBusMessage* p_dbus_msg = NULL;
629 DBusMessageIter dbus_args;
630 DBusPendingCall* p_dbus_pending = NULL;
633 dbus_message_unref( p_test_reply );
634 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
636 for( i_input = optind;i_input < i_argc;i_input++ )
638 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
639 ppsz_argv[i_input] );
641 p_dbus_msg = dbus_message_new_method_call(
642 "org.mpris.vlc", "/TrackList",
643 "org.freedesktop.MediaPlayer", "AddTrack" );
645 if ( NULL == p_dbus_msg )
647 msg_Err( p_libvlc, "D-Bus problem" );
648 system_End( p_libvlc );
649 exit( VLC_ETIMEOUT );
653 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
654 if ( !dbus_message_iter_append_basic( &dbus_args,
655 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
657 dbus_message_unref( p_dbus_msg );
658 system_End( p_libvlc );
662 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
664 if ( !dbus_message_iter_append_basic( &dbus_args,
665 DBUS_TYPE_BOOLEAN, &b_play ) )
667 dbus_message_unref( p_dbus_msg );
668 system_End( p_libvlc );
672 /* send message and get a handle for a reply */
673 if ( !dbus_connection_send_with_reply ( p_conn,
674 p_dbus_msg, &p_dbus_pending, -1 ) )
676 msg_Err( p_libvlc, "D-Bus problem" );
677 dbus_message_unref( p_dbus_msg );
678 system_End( p_libvlc );
679 exit( VLC_ETIMEOUT );
682 if ( NULL == p_dbus_pending )
684 msg_Err( p_libvlc, "D-Bus problem" );
685 dbus_message_unref( p_dbus_msg );
686 system_End( p_libvlc );
687 exit( VLC_ETIMEOUT );
689 dbus_connection_flush( p_conn );
690 dbus_message_unref( p_dbus_msg );
691 /* block until we receive a reply */
692 dbus_pending_call_block( p_dbus_pending );
693 dbus_pending_call_unref( p_dbus_pending );
694 } /* processes all command line MRLs */
697 system_End( p_libvlc );
701 /* we unreference the connection when we've finished with it */
702 if( p_conn ) dbus_connection_unref( p_conn );
707 * Message queue options
709 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
710 if( psz_verbose_objects )
712 char * psz_object, * iter = psz_verbose_objects;
713 while( (psz_object = strsep( &iter, "," )) )
715 switch( psz_object[0] )
717 printf("%s\n", psz_object+1);
718 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
719 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
721 msg_Err( p_libvlc, "verbose-objects usage: \n"
722 "--verbose-objects=+printthatobject,"
723 "-dontprintthatone\n"
724 "(keyword 'all' to applies to all objects)\n");
725 free( psz_verbose_objects );
726 /* FIXME: leaks!!!! */
730 free( psz_verbose_objects );
733 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
734 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
737 var_Set( p_libvlc, "verbose", val );
739 var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
740 var_TriggerCallback( p_libvlc, "verbose" );
743 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
745 if( !config_GetInt( p_libvlc, "fpu" ) )
746 cpu_flags &= ~CPU_CAPABILITY_FPU;
748 #if defined( __i386__ ) || defined( __x86_64__ )
749 if( !config_GetInt( p_libvlc, "mmx" ) )
750 cpu_flags &= ~CPU_CAPABILITY_MMX;
751 if( !config_GetInt( p_libvlc, "3dn" ) )
752 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
753 if( !config_GetInt( p_libvlc, "mmxext" ) )
754 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
755 if( !config_GetInt( p_libvlc, "sse" ) )
756 cpu_flags &= ~CPU_CAPABILITY_SSE;
757 if( !config_GetInt( p_libvlc, "sse2" ) )
758 cpu_flags &= ~CPU_CAPABILITY_SSE2;
760 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
761 if( !config_GetInt( p_libvlc, "altivec" ) )
762 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
765 #define PRINT_CAPABILITY( capability, string ) \
766 if( vlc_CPU() & capability ) \
768 strncat( p_capabilities, string " ", \
769 sizeof(p_capabilities) - strlen(p_capabilities) ); \
770 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
773 p_capabilities[0] = '\0';
774 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
778 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
779 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
780 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
781 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
782 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
783 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
784 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
787 * Choose the best memcpy module
789 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
791 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
793 priv->pp_timers = NULL;
796 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
797 if( !p_libvlc->p_stats )
799 vlc_object_release( p_libvlc );
800 return VLC_ENOMEM; /* FIXME: leaks */
802 vlc_mutex_init( &p_libvlc->p_stats->lock );
803 priv->p_stats_computer = NULL;
805 priv->i_last_input_id = 0; /* Not very safe, should be removed */
808 * Initialize hotkey handling
810 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
811 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
812 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
813 /* Do a copy (we don't need to modify the strings) */
814 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
815 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
816 p_libvlc->p_hotkeys );
818 /* Initialize interaction */
819 priv->p_interaction = interaction_Init( p_libvlc );
821 /* Initialize playlist and get commandline files */
822 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
825 msg_Err( p_libvlc, "playlist initialization failed" );
826 if( priv->p_memcpy_module != NULL )
828 module_unneed( p_libvlc, priv->p_memcpy_module );
830 module_EndBank( p_libvlc );
831 free( priv->psz_configfile );
834 playlist_Activate( p_playlist );
835 vlc_object_attach( p_playlist, p_libvlc );
837 /* Add service discovery modules */
838 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
839 if( psz_modules && *psz_modules )
841 char *p = psz_modules, *m;
842 while( ( m = strsep( &p, " :," ) ) != NULL )
843 playlist_ServicesDiscoveryAdd( p_playlist, m );
848 /* Initialize VLM if vlm-conf is specified */
849 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
850 if( psz_parser && *psz_parser )
852 priv->p_vlm = vlm_New( p_libvlc );
854 msg_Err( p_libvlc, "VLM initialization failed" );
860 * Load background interfaces
862 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
863 psz_control = config_GetPsz( p_libvlc, "control" );
865 if( psz_modules && *psz_modules && psz_control && *psz_control )
867 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
868 strlen( psz_control ) + 1 );
869 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
871 else if( psz_control && *psz_control )
874 psz_modules = strdup( psz_control );
877 psz_parser = psz_modules;
878 while ( psz_parser && *psz_parser )
880 char *psz_module, *psz_temp;
881 psz_module = psz_parser;
882 psz_parser = strchr( psz_module, ':' );
888 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
890 libvlc_InternalAddIntf( p_libvlc, psz_temp );
898 * Always load the hotkeys interface if it exists
900 libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
901 if( module_exists( "globalhotkeys" ) )
902 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, 0, 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_cond_destroy( &priv->exiting );
1139 vlc_mutex_destroy( &priv->config_lock );
1140 vlc_mutex_destroy( &priv->timer_lock );
1142 vlc_object_release( p_libvlc );
1146 * Add an interface plugin and run it
1148 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1151 intf_thread_t *p_intf = NULL;
1154 return VLC_EGENERIC;
1156 if( !psz_module ) /* requesting the default interface */
1158 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1159 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1163 /* Daemon mode hack.
1164 * We prefer the dummy interface if none is specified. */
1165 psz_module = "dummy";
1168 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1170 free( psz_interface );
1173 /* Try to create the interface */
1174 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1175 if( p_intf == NULL )
1177 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1179 return VLC_EGENERIC;
1182 /* Try to run the interface */
1183 i_err = intf_RunThread( p_intf );
1186 vlc_object_detach( p_intf );
1187 vlc_object_release( p_intf );
1195 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1196 * when the user "exits" an interface plugin.
1198 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1200 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1201 vlc_object_internals_t *internals = vlc_internals( p_libvlc );
1203 vlc_object_lock( p_libvlc );
1204 while( vlc_object_alive( p_libvlc ) )
1205 vlc_cond_wait( &priv->exiting, &internals->lock );
1206 vlc_object_unlock( p_libvlc );
1210 * Posts an exit signal to LibVLC instance. This will normally initiate the
1211 * cleanup and destroy process. It should only be called on behalf of the user.
1213 void libvlc_Quit( libvlc_int_t *p_libvlc )
1215 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1217 vlc_object_kill( p_libvlc );
1218 vlc_cond_signal( &priv->exiting ); /* OK, kill took care of the lock */
1221 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1222 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1223 /*****************************************************************************
1224 * SetLanguage: set the interface language.
1225 *****************************************************************************
1226 * We set the LC_MESSAGES locale category for interface messages and buttons,
1227 * as well as the LC_CTYPE category for string sorting and possible wide
1228 * character support.
1229 *****************************************************************************/
1230 static void SetLanguage ( const char *psz_lang )
1233 /* I need that under Darwin, please check it doesn't disturb
1234 * other platforms. --Meuuh */
1235 setenv( "LANG", psz_lang, 1 );
1238 /* We set LC_ALL manually because it is the only way to set
1239 * the language at runtime under eg. Windows. Beware that this
1240 * makes the environment unconsistent when libvlc is unloaded and
1241 * should probably be moved to a safer place like vlc.c. */
1242 static char psz_lcall[20];
1243 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1244 psz_lcall[19] = '\0';
1245 putenv( psz_lcall );
1248 setlocale( LC_ALL, psz_lang );
1253 static inline int LoadMessages (void)
1255 #if defined( ENABLE_NLS ) \
1256 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1257 /* Specify where to find the locales for current domain */
1258 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1259 static const char psz_path[] = LOCALEDIR;
1261 char psz_path[1024];
1262 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1263 config_GetDataDir(), "locale")
1264 >= (int)sizeof (psz_path))
1268 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1270 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1271 " to directory %s\n", psz_path);
1275 /* LibVLC wants all messages in UTF-8.
1276 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1277 * and other functions that are not part of our text domain.
1279 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1281 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1283 // Unbinds the text domain to avoid broken encoding
1284 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1288 /* LibVLC does NOT set the default textdomain, since it is a library.
1289 * This could otherwise break programs using LibVLC (other than VLC).
1290 * textdomain (PACKAGE_NAME);
1296 /*****************************************************************************
1297 * GetFilenames: parse command line options which are not flags
1298 *****************************************************************************
1299 * Parse command line for input files as well as their associated options.
1300 * An option always follows its associated input and begins with a ":".
1301 *****************************************************************************/
1302 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1304 int i_opt, i_options;
1306 /* We assume that the remaining parameters are filenames
1307 * and their input options */
1308 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1312 /* Count the input options */
1313 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1319 /* TODO: write an internal function of this one, to avoid
1320 * unnecessary lookups. */
1322 playlist_t *p_playlist = pl_Hold( p_vlc );
1323 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1325 i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ), VLC_INPUT_OPTION_TRUSTED,
1326 true, pl_Unlocked );
1327 pl_Release( p_vlc );
1333 /*****************************************************************************
1334 * Help: print program help
1335 *****************************************************************************
1336 * Print a short inline help. Message interface is initialized at this stage.
1337 *****************************************************************************/
1338 static inline void print_help_on_full_help( void )
1340 utf8_fprintf( stdout, "\n" );
1341 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1344 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1347 ShowConsole( true );
1350 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1352 utf8_fprintf( stdout, vlc_usage, "vlc" );
1353 Usage( p_this, "=help" );
1354 Usage( p_this, "=main" );
1355 print_help_on_full_help();
1357 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1359 utf8_fprintf( stdout, vlc_usage, "vlc" );
1360 Usage( p_this, NULL );
1361 print_help_on_full_help();
1363 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1365 utf8_fprintf( stdout, vlc_usage, "vlc" );
1366 Usage( p_this, NULL );
1368 else if( psz_help_name )
1370 Usage( p_this, psz_help_name );
1373 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1378 /*****************************************************************************
1379 * Usage: print module usage
1380 *****************************************************************************
1381 * Print a short inline help. Message interface is initialized at this stage.
1382 *****************************************************************************/
1383 # define COL(x) "\033[" #x ";1m"
1384 # define RED COL(31)
1385 # define GREEN COL(32)
1386 # define YELLOW COL(33)
1387 # define BLUE COL(34)
1388 # define MAGENTA COL(35)
1389 # define CYAN COL(36)
1390 # define WHITE COL(0)
1391 # define GRAY "\033[0m"
1392 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1394 if( !p_item ) return;
1397 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1399 if( b_description && p_item->psz_longtext )
1400 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1401 p_item->psz_longtext );
1405 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1406 if( b_description && p_item->psz_longtext )
1407 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1411 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1413 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1414 /* short option ------' | | | | | | |
1415 * option name ------------' | | | | | |
1416 * <bra ---------------------' | | | | |
1417 * option type or "" ----------' | | | |
1418 * ket> -------------------------' | | |
1419 * padding spaces -----------------' | |
1420 * comment --------------------------' |
1421 * comment suffix ---------------------'
1423 * The purpose of having bra and ket is that we might i18n them as well.
1426 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1427 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1429 #define LINE_START 8
1430 #define PADDING_SPACES 25
1432 # define OPTION_VALUE_SEP "="
1434 # define OPTION_VALUE_SEP " "
1436 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1437 char psz_spaces_longtext[LINE_START+3];
1438 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1439 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1440 char psz_buffer[10000];
1442 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1443 int i_width_description = i_width + PADDING_SPACES - 1;
1444 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1445 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1446 bool b_description_hack;
1447 bool b_color = config_GetInt( p_this, "color" ) > 0;
1448 bool b_has_advanced = false;
1449 bool b_found = false;
1450 int i_only_advanced = 0; /* Number of modules ignored because they
1451 * only have advanced options */
1452 bool b_strict = psz_search && *psz_search == '=';
1453 if( b_strict ) psz_search++;
1455 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1456 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1457 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1458 psz_spaces_longtext[LINE_START+2] = '\0';
1462 b_color = false; // don't put color control codes in a .txt file
1466 strcpy( psz_format, COLOR_FORMAT_STRING );
1467 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1471 strcpy( psz_format, FORMAT_STRING );
1472 strcpy( psz_format_bool, FORMAT_STRING );
1475 /* List all modules */
1476 module_t **list = module_list_get (NULL);
1480 /* Ugly hack to make sure that the help options always come first
1483 Usage( p_this, "help" );
1485 /* Enumerate the config for each module */
1486 for (size_t i = 0; list[i]; i++)
1489 module_t *p_parser = list[i];
1490 module_config_t *p_item = NULL;
1491 module_config_t *p_section = NULL;
1492 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1495 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1496 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1498 char *const *pp_shortcut = p_parser->pp_shortcuts;
1499 while( *pp_shortcut )
1501 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1502 : !!strstr( *pp_shortcut, psz_search ) )
1510 /* Ignore modules without config options */
1511 if( !p_parser->i_config_items )
1516 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1517 /* Ugly hack to make sure that the help options always come first
1519 if( !psz_search && b_help_module )
1522 /* Ignore modules with only advanced config options if requested */
1525 for( p_item = p_parser->p_config;
1529 if( (p_item->i_type & CONFIG_ITEM) &&
1530 !p_item->b_advanced && !p_item->b_removed ) break;
1533 if( p_item == p_end )
1542 /* Print name of module */
1543 if( strcmp( "main", p_parser->psz_object_name ) )
1546 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1547 p_parser->psz_longname,
1548 p_parser->psz_object_name );
1550 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1552 if( p_parser->psz_help )
1555 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1557 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1560 /* Print module options */
1561 for( p_item = p_parser->p_config;
1565 char *psz_text, *psz_spaces = psz_spaces_text;
1566 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1567 const char *psz_suf = "", *psz_prefix = NULL;
1571 /* Skip removed options */
1572 if( p_item->b_removed )
1576 /* Skip advanced options if requested */
1577 if( p_item->b_advanced && !b_advanced )
1579 b_has_advanced = true;
1583 switch( p_item->i_type )
1585 case CONFIG_HINT_CATEGORY:
1586 case CONFIG_HINT_USAGE:
1587 if( !strcmp( "main", p_parser->psz_object_name ) )
1590 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1593 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1595 if( b_description && p_item->psz_longtext )
1598 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1599 p_item->psz_longtext );
1601 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1605 case CONFIG_HINT_SUBCATEGORY:
1606 if( strcmp( "main", p_parser->psz_object_name ) )
1608 case CONFIG_SECTION:
1612 case CONFIG_ITEM_STRING:
1613 case CONFIG_ITEM_FILE:
1614 case CONFIG_ITEM_DIRECTORY:
1615 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1616 case CONFIG_ITEM_MODULE_CAT:
1617 case CONFIG_ITEM_MODULE_LIST:
1618 case CONFIG_ITEM_MODULE_LIST_CAT:
1619 case CONFIG_ITEM_FONT:
1620 case CONFIG_ITEM_PASSWORD:
1621 print_help_section( p_section, b_color, b_description );
1623 psz_bra = OPTION_VALUE_SEP "<";
1624 psz_type = _("string");
1627 if( p_item->ppsz_list )
1629 psz_bra = OPTION_VALUE_SEP "{";
1630 psz_type = psz_buffer;
1631 psz_buffer[0] = '\0';
1632 for( i = 0; p_item->ppsz_list[i]; i++ )
1634 if( i ) strcat( psz_buffer, "," );
1635 strcat( psz_buffer, p_item->ppsz_list[i] );
1640 case CONFIG_ITEM_INTEGER:
1641 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1642 print_help_section( p_section, b_color, b_description );
1644 psz_bra = OPTION_VALUE_SEP "<";
1645 psz_type = _("integer");
1648 if( p_item->min.i || p_item->max.i )
1650 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1651 p_item->min.i, p_item->max.i );
1652 psz_type = psz_buffer;
1655 if( p_item->i_list )
1657 psz_bra = OPTION_VALUE_SEP "{";
1658 psz_type = psz_buffer;
1659 psz_buffer[0] = '\0';
1660 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1662 if( i ) strcat( psz_buffer, ", " );
1663 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1665 p_item->ppsz_list_text[i] );
1670 case CONFIG_ITEM_FLOAT:
1671 print_help_section( p_section, b_color, b_description );
1673 psz_bra = OPTION_VALUE_SEP "<";
1674 psz_type = _("float");
1676 if( p_item->min.f || p_item->max.f )
1678 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1679 p_item->min.f, p_item->max.f );
1680 psz_type = psz_buffer;
1683 case CONFIG_ITEM_BOOL:
1684 print_help_section( p_section, b_color, b_description );
1686 psz_bra = ""; psz_type = ""; psz_ket = "";
1687 if( !b_help_module )
1689 psz_suf = p_item->value.i ? _(" (default enabled)") :
1690 _(" (default disabled)");
1700 /* Add short option if any */
1701 if( p_item->i_short )
1703 sprintf( psz_short, "-%c,", p_item->i_short );
1707 strcpy( psz_short, " " );
1710 i = PADDING_SPACES - strlen( p_item->psz_name )
1711 - strlen( psz_bra ) - strlen( psz_type )
1712 - strlen( psz_ket ) - 1;
1714 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1716 psz_prefix = ", --no-";
1717 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1722 psz_spaces[0] = '\n';
1727 psz_spaces[i] = '\0';
1730 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1732 utf8_fprintf( stdout, psz_format_bool, psz_short,
1733 p_item->psz_name, psz_prefix, p_item->psz_name,
1734 psz_bra, psz_type, psz_ket, psz_spaces );
1738 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1739 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1742 psz_spaces[i] = ' ';
1744 /* We wrap the rest of the output */
1745 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1746 b_description_hack = b_description;
1749 psz_text = psz_buffer;
1750 i_cur_width = b_description && !b_description_hack
1751 ? i_width_description
1755 char *psz_parser, *psz_word;
1756 size_t i_end = strlen( psz_text );
1758 /* If the remaining text fits in a line, print it. */
1759 if( i_end <= i_cur_width )
1763 if( !b_description || b_description_hack )
1764 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1766 utf8_fprintf( stdout, "%s\n", psz_text );
1770 utf8_fprintf( stdout, "%s\n", psz_text );
1775 /* Otherwise, eat as many words as possible */
1776 psz_parser = psz_text;
1779 psz_word = psz_parser;
1780 psz_parser = strchr( psz_word, ' ' );
1781 /* If no space was found, we reached the end of the text
1782 * block; otherwise, we skip the space we just found. */
1783 psz_parser = psz_parser ? psz_parser + 1
1786 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1788 /* We cut a word in one of these cases:
1789 * - it's the only word in the line and it's too long.
1790 * - we used less than 80% of the width and the word we are
1791 * going to wrap is longer than 40% of the width, and even
1792 * if the word would have fit in the next line. */
1793 if( psz_word == psz_text
1794 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1795 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1797 char c = psz_text[i_cur_width];
1798 psz_text[i_cur_width] = '\0';
1801 if( !b_description || b_description_hack )
1802 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1803 psz_text, psz_spaces );
1805 utf8_fprintf( stdout, "%s\n%s",
1806 psz_text, psz_spaces );
1810 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1812 psz_text += i_cur_width;
1817 psz_word[-1] = '\0';
1820 if( !b_description || b_description_hack )
1821 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1822 psz_text, psz_spaces );
1824 utf8_fprintf( stdout, "%s\n%s",
1825 psz_text, psz_spaces );
1829 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1831 psz_text = psz_word;
1835 if( b_description_hack && p_item->psz_longtext )
1837 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1838 b_description_hack = false;
1839 psz_spaces = psz_spaces_longtext;
1840 utf8_fprintf( stdout, "%s", psz_spaces );
1846 if( b_has_advanced )
1849 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1850 _( "add --advanced to your command line to see advanced options."));
1852 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1853 _( "add --advanced to your command line to see advanced options."));
1856 if( i_only_advanced > 0 )
1860 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1861 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1865 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1866 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1872 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1873 _( "No matching module found. Use --list or" \
1874 "--list-verbose to list available modules." ) );
1876 utf8_fprintf( stdout, "\n%s\n",
1877 _( "No matching module found. Use --list or" \
1878 "--list-verbose to list available modules." ) );
1881 /* Release the module list */
1882 module_list_free (list);
1885 /*****************************************************************************
1886 * ListModules: list the available modules with their description
1887 *****************************************************************************
1888 * Print a list of all available modules (builtins and plugins) and a short
1889 * description for each one.
1890 *****************************************************************************/
1891 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1894 char psz_spaces[22];
1896 bool b_color = config_GetInt( p_this, "color" ) > 0;
1898 memset( psz_spaces, ' ', 22 );
1901 ShowConsole( true );
1904 /* List all modules */
1905 module_t **list = module_list_get (NULL);
1907 /* Enumerate each module */
1908 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1912 /* Nasty hack, but right now I'm too tired to think about a nice
1914 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1919 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1920 p_parser->psz_object_name,
1922 p_parser->psz_longname );
1924 utf8_fprintf( stdout, " %s%s %s\n",
1925 p_parser->psz_object_name,
1926 psz_spaces, p_parser->psz_longname );
1930 char *const *pp_shortcut = p_parser->pp_shortcuts;
1931 while( *pp_shortcut )
1933 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1936 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1939 utf8_fprintf( stdout, " s %s\n",
1944 if( p_parser->psz_capability )
1947 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1948 p_parser->psz_capability,
1949 p_parser->i_score );
1951 utf8_fprintf( stdout, " c %s (%d)\n",
1952 p_parser->psz_capability,
1953 p_parser->i_score );
1957 psz_spaces[i] = ' ';
1959 module_list_free (list);
1961 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1966 /*****************************************************************************
1967 * Version: print complete program version
1968 *****************************************************************************
1969 * Print complete program version and build number.
1970 *****************************************************************************/
1971 static void Version( void )
1974 ShowConsole( true );
1977 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1978 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1979 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1980 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1981 if( strcmp( VLC_Changeset(), "exported" ) )
1982 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1984 utf8_fprintf( stdout, LICENSE_MSG );
1986 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1991 /*****************************************************************************
1992 * ShowConsole: On Win32, create an output console for debug messages
1993 *****************************************************************************
1994 * This function is useful only on Win32.
1995 *****************************************************************************/
1997 static void ShowConsole( bool b_dofile )
2000 FILE *f_help = NULL;
2002 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2005 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2006 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2007 * page (e.g. CP437 or CP850). */
2008 SetConsoleOutputCP (GetACP ());
2009 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2011 freopen( "CONOUT$", "w", stderr );
2012 freopen( "CONIN$", "r", stdin );
2014 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2017 freopen( "vlc-help.txt", "wt", stdout );
2018 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2020 else freopen( "CONOUT$", "w", stdout );
2026 /*****************************************************************************
2027 * PauseConsole: On Win32, wait for a key press before closing the console
2028 *****************************************************************************
2029 * This function is useful only on Win32.
2030 *****************************************************************************/
2032 static void PauseConsole( void )
2036 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2038 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2046 /*****************************************************************************
2047 * ConsoleWidth: Return the console width in characters
2048 *****************************************************************************
2049 * We use the stty shell command to get the console width; if this fails or
2050 * if the width is less than 80, we default to 80.
2051 *****************************************************************************/
2052 static int ConsoleWidth( void )
2054 unsigned i_width = 80;
2057 FILE *file = popen( "stty size 2>/dev/null", "r" );
2060 if (fscanf (file, "%*u %u", &i_width) <= 0)
2064 #elif !defined (UNDER_CE)
2065 CONSOLE_SCREEN_BUFFER_INFO buf;
2067 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2068 i_width = buf.dwSize.X;
2074 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2075 vlc_value_t old_val, vlc_value_t new_val, void *param)
2077 libvlc_int_t *p_libvlc = (libvlc_int_t *)p_this;
2082 if( new_val.i_int >= -1 )
2084 libvlc_priv (p_libvlc)->i_verbose = __MIN( new_val.i_int, 2 );
2089 /*****************************************************************************
2090 * InitDeviceValues: initialize device values
2091 *****************************************************************************
2092 * This function inits the dvd, vcd and cd-audio values
2093 *****************************************************************************/
2094 static void InitDeviceValues( libvlc_int_t *p_vlc )
2097 LibHalContext * ctx = NULL;
2099 char **devices = NULL;
2100 char *block_dev = NULL;
2103 DBusConnection *p_connection = NULL;
2106 ctx = libhal_ctx_new();
2108 dbus_error_init( &error );
2109 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2110 if( dbus_error_is_set( &error ) || !p_connection )
2112 libhal_ctx_free( ctx );
2113 dbus_error_free( &error );
2116 libhal_ctx_set_dbus_connection( ctx, p_connection );
2117 if( libhal_ctx_init( ctx, &error ) )
2119 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2121 for( i = 0; i < i_devices; i++ )
2123 if( !libhal_device_property_exists( ctx, devices[i],
2124 "storage.cdrom.dvd", NULL ) )
2128 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2129 "storage.cdrom.dvd", NULL );
2130 block_dev = libhal_device_get_property_string( ctx,
2131 devices[ i ], "block.device" , NULL );
2134 config_PutPsz( p_vlc, "dvd", block_dev );
2137 config_PutPsz( p_vlc, "vcd", block_dev );
2138 config_PutPsz( p_vlc, "cd-audio", block_dev );
2139 libhal_free_string( block_dev );
2141 libhal_free_string_array( devices );
2143 libhal_ctx_shutdown( ctx, NULL );
2144 dbus_connection_unref( p_connection );
2145 libhal_ctx_free( ctx );
2149 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2153 #endif /* HAVE_HAL */