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 void InitDeviceValues( libvlc_int_t * );
227 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
230 * Allocate a libvlc instance, initialize global data if needed
231 * It also initializes the threading system
233 libvlc_int_t * libvlc_InternalCreate( void )
235 libvlc_int_t *p_libvlc;
237 char *psz_env = NULL;
239 /* Now that the thread system is initialized, we don't have much, but
240 * at least we have variables */
241 vlc_mutex_lock( &global_lock );
242 if( i_instances == 0 )
244 /* Guess what CPU we have */
245 cpu_flags = CPUCapabilities();
246 /* The module bank will be initialized later */
249 /* Allocate a libvlc instance object */
250 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
251 VLC_OBJECT_GENERIC, "libvlc" );
252 if( p_libvlc != NULL )
254 vlc_mutex_unlock( &global_lock );
256 if( p_libvlc == NULL )
259 priv = libvlc_priv (p_libvlc);
260 priv->p_playlist = NULL;
261 priv->p_interaction = NULL;
263 p_libvlc->psz_object_name = strdup( "libvlc" );
265 /* Initialize message queue */
266 msg_Create( p_libvlc );
268 /* Find verbosity from VLC_VERBOSE environment variable */
269 psz_env = getenv( "VLC_VERBOSE" );
270 if( psz_env != NULL )
271 priv->i_verbose = atoi( psz_env );
274 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
275 priv->b_color = isatty( 2 ); /* 2 is for stderr */
277 priv->b_color = false;
280 /* Initialize mutexes */
281 vlc_mutex_init( &priv->timer_lock );
282 vlc_mutex_init( &priv->config_lock );
283 vlc_cond_init( &priv->exiting );
289 * Initialize a libvlc instance
290 * This function initializes a previously allocated libvlc instance:
292 * - gettext initialization
293 * - message queue, module bank and playlist initialization
294 * - configuration and commandline parsing
296 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
297 const char *ppsz_argv[] )
299 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
300 char p_capabilities[200];
302 char * psz_modules = NULL;
303 char * psz_parser = NULL;
304 char * psz_control = NULL;
306 int i_ret = VLC_EEXIT;
307 playlist_t *p_playlist = NULL;
309 #if defined( ENABLE_NLS ) \
310 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
311 # if defined (WIN32) || defined (__APPLE__)
316 /* System specific initialization code */
317 system_Init( p_libvlc, &i_argc, ppsz_argv );
320 * Support for gettext
324 /* Initialize the module bank and load the configuration of the
325 * main module. We need to do this at this stage to be able to display
326 * a short help if required by the user. (short help == main module
328 module_InitBank( p_libvlc );
330 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
332 module_EndBank( p_libvlc );
336 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
337 /* Announce who we are - Do it only for first instance ? */
338 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
339 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
340 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
341 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
343 /* Check for short help option */
344 if( config_GetInt( p_libvlc, "help" ) > 0 )
346 Help( p_libvlc, "help" );
348 i_ret = VLC_EEXITSUCCESS;
350 /* Check for version option */
351 else if( config_GetInt( p_libvlc, "version" ) > 0 )
355 i_ret = VLC_EEXITSUCCESS;
358 /* Set the config file stuff */
359 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
361 /* Check for plugins cache options */
362 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
364 /* Check for daemon mode */
366 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
369 char *psz_pidfile = NULL;
371 if( daemon( 1, 0) != 0 )
373 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
378 /* lets check if we need to write the pidfile */
379 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
380 if( psz_pidfile != NULL )
383 pid_t i_pid = getpid ();
384 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
385 i_pid, psz_pidfile );
386 pidfile = utf8_fopen( psz_pidfile,"w" );
387 if( pidfile != NULL )
389 utf8_fprintf( pidfile, "%d", (int)i_pid );
394 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
403 if( ( i_pid = fork() ) < 0 )
405 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
410 /* This is the parent, exit right now */
411 msg_Dbg( p_libvlc, "closing parent process" );
413 i_ret = VLC_EEXITSUCCESS;
417 /* We are the child */
418 msg_Dbg( p_libvlc, "daemon spawned" );
419 close( STDIN_FILENO );
420 close( STDOUT_FILENO );
421 close( STDERR_FILENO );
431 free( priv->psz_configfile );
432 module_EndBank( p_libvlc );
436 /* Check for translation config option */
437 #if defined( ENABLE_NLS ) \
438 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
439 # if defined (WIN32) || defined (__APPLE__)
440 /* This ain't really nice to have to reload the config here but it seems
441 * the only way to do it. */
443 if( !config_GetInt( p_libvlc, "ignore-config" ) )
444 config_LoadConfigFile( p_libvlc, "main" );
445 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
447 /* Check if the user specified a custom language */
448 psz_language = config_GetPsz( p_libvlc, "language" );
449 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
451 /* Reset the default domain */
452 SetLanguage( psz_language );
454 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
455 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
457 module_EndBank( p_libvlc );
458 module_InitBank( p_libvlc );
459 if( !config_GetInt( p_libvlc, "ignore-config" ) )
460 config_LoadConfigFile( p_libvlc, "main" );
461 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
463 free( psz_language );
468 * Load the builtins and plugins into the module_bank.
469 * We have to do it before config_Load*() because this also gets the
470 * list of configuration options exported by each module and loads their
473 module_LoadBuiltins( p_libvlc );
474 module_LoadPlugins( p_libvlc, b_cache_delete );
475 if( p_libvlc->b_die )
481 module_t **list = module_list_get( &module_count );
482 module_list_free( list );
483 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
485 /* Check for help on modules */
486 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
488 Help( p_libvlc, p_tmp );
491 i_ret = VLC_EEXITSUCCESS;
493 /* Check for full help option */
494 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
496 config_PutInt( p_libvlc, "advanced", 1);
497 config_PutInt( p_libvlc, "help-verbose", 1);
498 Help( p_libvlc, "full-help" );
500 i_ret = VLC_EEXITSUCCESS;
502 /* Check for long help option */
503 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
505 Help( p_libvlc, "longhelp" );
507 i_ret = VLC_EEXITSUCCESS;
509 /* Check for module list option */
510 else if( config_GetInt( p_libvlc, "list" ) > 0 )
512 ListModules( p_libvlc, false );
514 i_ret = VLC_EEXITSUCCESS;
516 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
518 ListModules( p_libvlc, true );
520 i_ret = VLC_EEXITSUCCESS;
523 /* Check for config file options */
524 if( !config_GetInt( p_libvlc, "ignore-config" ) )
526 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
528 config_ResetAll( p_libvlc );
529 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
530 config_SaveConfigFile( p_libvlc, NULL );
532 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
534 config_LoadConfigFile( p_libvlc, NULL );
535 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
536 config_SaveConfigFile( p_libvlc, NULL );
542 free( priv->psz_configfile );
543 module_EndBank( p_libvlc );
550 InitDeviceValues( p_libvlc );
553 * Override default configuration with config file settings
555 if( !config_GetInt( p_libvlc, "ignore-config" ) )
556 config_LoadConfigFile( p_libvlc, NULL );
559 * Override configuration with command line settings
561 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
564 ShowConsole( false );
565 /* Pause the console because it's destroyed when we exit */
566 fprintf( stderr, "The command line options couldn't be loaded, check "
567 "that they are valid.\n" );
570 free( priv->psz_configfile );
571 module_EndBank( p_libvlc );
576 * System specific configuration
578 system_Configure( p_libvlc, &i_argc, ppsz_argv );
580 /* FIXME: could be replaced by using Unix sockets */
582 dbus_threads_init_default();
584 if( config_GetInt( p_libvlc, "one-instance" ) > 0
585 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
586 && config_GetInt( p_libvlc, "started-from-file" ) ) )
588 /* Initialise D-Bus interface, check for other instances */
589 DBusConnection *p_conn = NULL;
590 DBusError dbus_error;
592 dbus_error_init( &dbus_error );
594 /* connect to the session bus */
595 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
598 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
599 dbus_error.message );
600 dbus_error_free( &dbus_error );
604 /* check if VLC is available on the bus
605 * if not: D-Bus control is not enabled on the other
606 * instance and we can't pass MRLs to it */
607 DBusMessage *p_test_msg = NULL;
608 DBusMessage *p_test_reply = NULL;
609 p_test_msg = dbus_message_new_method_call(
610 "org.mpris.vlc", "/",
611 "org.freedesktop.MediaPlayer", "Identity" );
612 /* block until a reply arrives */
613 p_test_reply = dbus_connection_send_with_reply_and_block(
614 p_conn, p_test_msg, -1, &dbus_error );
615 dbus_message_unref( p_test_msg );
616 if( p_test_reply == NULL )
618 dbus_error_free( &dbus_error );
619 msg_Dbg( p_libvlc, "No Media Player is running. "
620 "Continuing normally." );
625 DBusMessage* p_dbus_msg = NULL;
626 DBusMessageIter dbus_args;
627 DBusPendingCall* p_dbus_pending = NULL;
630 dbus_message_unref( p_test_reply );
631 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
633 for( i_input = optind;i_input < i_argc;i_input++ )
635 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
636 ppsz_argv[i_input] );
638 p_dbus_msg = dbus_message_new_method_call(
639 "org.mpris.vlc", "/TrackList",
640 "org.freedesktop.MediaPlayer", "AddTrack" );
642 if ( NULL == p_dbus_msg )
644 msg_Err( p_libvlc, "D-Bus problem" );
645 system_End( p_libvlc );
646 exit( VLC_ETIMEOUT );
650 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
651 if ( !dbus_message_iter_append_basic( &dbus_args,
652 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
654 dbus_message_unref( p_dbus_msg );
655 system_End( p_libvlc );
659 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
661 if ( !dbus_message_iter_append_basic( &dbus_args,
662 DBUS_TYPE_BOOLEAN, &b_play ) )
664 dbus_message_unref( p_dbus_msg );
665 system_End( p_libvlc );
669 /* send message and get a handle for a reply */
670 if ( !dbus_connection_send_with_reply ( p_conn,
671 p_dbus_msg, &p_dbus_pending, -1 ) )
673 msg_Err( p_libvlc, "D-Bus problem" );
674 dbus_message_unref( p_dbus_msg );
675 system_End( p_libvlc );
676 exit( VLC_ETIMEOUT );
679 if ( NULL == p_dbus_pending )
681 msg_Err( p_libvlc, "D-Bus problem" );
682 dbus_message_unref( p_dbus_msg );
683 system_End( p_libvlc );
684 exit( VLC_ETIMEOUT );
686 dbus_connection_flush( p_conn );
687 dbus_message_unref( p_dbus_msg );
688 /* block until we receive a reply */
689 dbus_pending_call_block( p_dbus_pending );
690 dbus_pending_call_unref( p_dbus_pending );
691 } /* processes all command line MRLs */
694 system_End( p_libvlc );
698 /* we unreference the connection when we've finished with it */
699 if( p_conn ) dbus_connection_unref( p_conn );
704 * Message queue options
706 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
707 if( psz_verbose_objects )
709 char * psz_object, * iter = psz_verbose_objects;
710 while( (psz_object = strsep( &iter, "," )) )
712 switch( psz_object[0] )
714 printf("%s\n", psz_object+1);
715 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
716 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
718 msg_Err( p_libvlc, "verbose-objects usage: \n"
719 "--verbose-objects=+printthatobject,"
720 "-dontprintthatone\n"
721 "(keyword 'all' to applies to all objects)");
722 free( psz_verbose_objects );
723 /* FIXME: leaks!!!! */
727 free( psz_verbose_objects );
730 /* Last change to set the verbosity. Once we start interfaces and other
731 * threads, verbosity becomes read-only. */
732 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
733 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
735 var_SetInteger( p_libvlc, "verbose", -1 );
736 priv->i_verbose = -1;
740 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
742 if( !config_GetInt( p_libvlc, "fpu" ) )
743 cpu_flags &= ~CPU_CAPABILITY_FPU;
745 #if defined( __i386__ ) || defined( __x86_64__ )
746 if( !config_GetInt( p_libvlc, "mmx" ) )
747 cpu_flags &= ~CPU_CAPABILITY_MMX;
748 if( !config_GetInt( p_libvlc, "3dn" ) )
749 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
750 if( !config_GetInt( p_libvlc, "mmxext" ) )
751 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
752 if( !config_GetInt( p_libvlc, "sse" ) )
753 cpu_flags &= ~CPU_CAPABILITY_SSE;
754 if( !config_GetInt( p_libvlc, "sse2" ) )
755 cpu_flags &= ~CPU_CAPABILITY_SSE2;
757 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
758 if( !config_GetInt( p_libvlc, "altivec" ) )
759 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
762 #define PRINT_CAPABILITY( capability, string ) \
763 if( vlc_CPU() & capability ) \
765 strncat( p_capabilities, string " ", \
766 sizeof(p_capabilities) - strlen(p_capabilities) ); \
767 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
770 p_capabilities[0] = '\0';
771 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
772 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
773 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
778 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
779 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
780 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
781 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
784 * Choose the best memcpy module
786 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
788 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
790 priv->pp_timers = NULL;
793 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
794 if( !p_libvlc->p_stats )
796 vlc_object_release( p_libvlc );
797 return VLC_ENOMEM; /* FIXME: leaks */
799 vlc_mutex_init( &p_libvlc->p_stats->lock );
800 priv->p_stats_computer = NULL;
802 priv->i_last_input_id = 0; /* Not very safe, should be removed */
805 * Initialize hotkey handling
807 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
808 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
809 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
810 /* Do a copy (we don't need to modify the strings) */
811 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
812 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
813 p_libvlc->p_hotkeys );
815 /* Initialize interaction */
816 priv->p_interaction = interaction_Init( p_libvlc );
818 /* Initialize playlist and get commandline files */
819 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
822 msg_Err( p_libvlc, "playlist initialization failed" );
823 if( priv->p_memcpy_module != NULL )
825 module_unneed( p_libvlc, priv->p_memcpy_module );
827 module_EndBank( p_libvlc );
828 free( priv->psz_configfile );
831 playlist_Activate( p_playlist );
832 vlc_object_attach( p_playlist, p_libvlc );
834 /* Add service discovery modules */
835 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
836 if( psz_modules && *psz_modules )
838 char *p = psz_modules, *m;
839 while( ( m = strsep( &p, " :," ) ) != NULL )
840 playlist_ServicesDiscoveryAdd( p_playlist, m );
845 /* Initialize VLM if vlm-conf is specified */
846 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
847 if( psz_parser && *psz_parser )
849 priv->p_vlm = vlm_New( p_libvlc );
851 msg_Err( p_libvlc, "VLM initialization failed" );
857 * Load background interfaces
859 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
860 psz_control = config_GetPsz( p_libvlc, "control" );
862 if( psz_modules && *psz_modules && psz_control && *psz_control )
865 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
868 psz_modules = psz_tmp;
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-xid", VLC_VAR_INTEGER );
984 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
986 var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
991 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
992 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
993 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
994 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
995 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
997 /* Create volume callback system. */
998 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
1000 /* Create a variable for showing the interface (moved from playlist). */
1001 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
1002 var_SetBool( p_libvlc, "intf-show", true );
1004 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1007 * Get input filenames given as commandline arguments
1009 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1012 * Get --open argument
1014 var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
1015 var_Get( p_libvlc, "open", &val );
1016 if ( val.psz_string != NULL && *val.psz_string )
1018 playlist_t *p_playlist = pl_Hold( p_libvlc );
1019 playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
1020 -1, 0, NULL, 0, true, pl_Unlocked );
1021 pl_Release( p_libvlc );
1023 free( val.psz_string );
1029 * Cleanup a libvlc instance. The instance is not completely deallocated
1030 * \param p_libvlc the instance to clean
1032 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1034 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1035 playlist_t *p_playlist = priv->p_playlist;
1037 /* Deactivate the playlist */
1038 msg_Dbg( p_libvlc, "deactivating the playlist" );
1039 playlist_Deactivate( p_playlist );
1041 /* Remove all services discovery */
1042 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1043 playlist_ServicesDiscoveryKillAll( p_playlist );
1045 /* Ask the interfaces to stop and destroy them */
1046 msg_Dbg( p_libvlc, "removing all interfaces" );
1047 intf_thread_t *p_intf;
1048 while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
1050 intf_StopThread( p_intf );
1051 vlc_object_detach( p_intf );
1052 vlc_object_release( p_intf ); /* for intf_Create() */
1053 vlc_object_release( p_intf ); /* for vlc_object_find() */
1057 /* Destroy VLM if created in libvlc_InternalInit */
1060 vlm_Delete( priv->p_vlm );
1065 /* Any thread still running must not assume pl_Hold() succeeds. */
1066 msg_Dbg( p_libvlc, "removing playlist" );
1068 libvlc_priv(p_playlist->p_libvlc)->p_playlist = NULL;
1069 barrier(); /* FIXME is that correct ? */
1071 vlc_object_release( p_playlist );
1073 /* Free interaction */
1074 msg_Dbg( p_libvlc, "removing interaction" );
1075 interaction_Destroy( priv->p_interaction );
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 );
1085 char* psz_pidfile = NULL;
1089 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1090 if( psz_pidfile != NULL )
1092 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1093 if( unlink( psz_pidfile ) == -1 )
1095 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1099 free( psz_pidfile );
1103 if( priv->p_memcpy_module )
1105 module_unneed( p_libvlc, priv->p_memcpy_module );
1106 priv->p_memcpy_module = NULL;
1109 /* Free module bank. It is refcounted, so we call this each time */
1110 module_EndBank( p_libvlc );
1112 FREENULL( priv->psz_configfile );
1113 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1114 p_libvlc->p_hotkeys );
1115 FREENULL( p_libvlc->p_hotkeys );
1119 * Destroy everything.
1120 * This function requests the running threads to finish, waits for their
1121 * termination, and destroys their structure.
1122 * It stops the thread systems: no instance can run after this has run
1123 * \param p_libvlc the instance to destroy
1125 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1127 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1129 vlc_mutex_lock( &global_lock );
1132 if( i_instances == 0 )
1134 /* System specific cleaning code */
1135 system_End( p_libvlc );
1137 vlc_mutex_unlock( &global_lock );
1139 msg_Destroy( p_libvlc );
1141 /* Destroy mutexes */
1142 vlc_cond_destroy( &priv->exiting );
1143 vlc_mutex_destroy( &priv->config_lock );
1144 vlc_mutex_destroy( &priv->timer_lock );
1146 vlc_object_release( p_libvlc );
1150 * Add an interface plugin and run it
1152 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1155 intf_thread_t *p_intf = NULL;
1158 return VLC_EGENERIC;
1160 if( !psz_module ) /* requesting the default interface */
1162 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1163 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1167 /* Daemon mode hack.
1168 * We prefer the dummy interface if none is specified. */
1169 psz_module = "dummy";
1172 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1174 free( psz_interface );
1177 /* Try to create the interface */
1178 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1179 if( p_intf == NULL )
1181 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1183 return VLC_EGENERIC;
1186 /* Try to run the interface */
1187 i_err = intf_RunThread( p_intf );
1190 vlc_object_detach( p_intf );
1191 vlc_object_release( p_intf );
1199 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1200 * when the user "exits" an interface plugin.
1202 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1204 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1205 vlc_object_internals_t *internals = vlc_internals( p_libvlc );
1207 vlc_object_lock( p_libvlc );
1208 while( vlc_object_alive( p_libvlc ) )
1209 vlc_cond_wait( &priv->exiting, &internals->lock );
1210 vlc_object_unlock( p_libvlc );
1214 * Posts an exit signal to LibVLC instance. This will normally initiate the
1215 * cleanup and destroy process. It should only be called on behalf of the user.
1217 void libvlc_Quit( libvlc_int_t *p_libvlc )
1219 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1221 vlc_object_kill( p_libvlc );
1222 vlc_cond_signal( &priv->exiting ); /* OK, kill took care of the lock */
1225 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1226 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1227 /*****************************************************************************
1228 * SetLanguage: set the interface language.
1229 *****************************************************************************
1230 * We set the LC_MESSAGES locale category for interface messages and buttons,
1231 * as well as the LC_CTYPE category for string sorting and possible wide
1232 * character support.
1233 *****************************************************************************/
1234 static void SetLanguage ( const char *psz_lang )
1237 /* I need that under Darwin, please check it doesn't disturb
1238 * other platforms. --Meuuh */
1239 setenv( "LANG", psz_lang, 1 );
1242 /* We set LC_ALL manually because it is the only way to set
1243 * the language at runtime under eg. Windows. Beware that this
1244 * makes the environment unconsistent when libvlc is unloaded and
1245 * should probably be moved to a safer place like vlc.c. */
1246 static char psz_lcall[20];
1247 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1248 psz_lcall[19] = '\0';
1249 putenv( psz_lcall );
1252 setlocale( LC_ALL, psz_lang );
1257 static inline int LoadMessages (void)
1259 #if defined( ENABLE_NLS ) \
1260 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1261 /* Specify where to find the locales for current domain */
1262 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1263 static const char psz_path[] = LOCALEDIR;
1265 char psz_path[1024];
1266 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1267 config_GetDataDir(), "locale")
1268 >= (int)sizeof (psz_path))
1272 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1274 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1275 " to directory %s\n", psz_path);
1279 /* LibVLC wants all messages in UTF-8.
1280 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1281 * and other functions that are not part of our text domain.
1283 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1285 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1287 // Unbinds the text domain to avoid broken encoding
1288 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1292 /* LibVLC does NOT set the default textdomain, since it is a library.
1293 * This could otherwise break programs using LibVLC (other than VLC).
1294 * textdomain (PACKAGE_NAME);
1300 /*****************************************************************************
1301 * GetFilenames: parse command line options which are not flags
1302 *****************************************************************************
1303 * Parse command line for input files as well as their associated options.
1304 * An option always follows its associated input and begins with a ":".
1305 *****************************************************************************/
1306 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1308 int i_opt, i_options;
1310 /* We assume that the remaining parameters are filenames
1311 * and their input options */
1312 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1316 /* Count the input options */
1317 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1323 /* TODO: write an internal function of this one, to avoid
1324 * unnecessary lookups. */
1326 playlist_t *p_playlist = pl_Hold( p_vlc );
1327 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1329 i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ), VLC_INPUT_OPTION_TRUSTED,
1330 true, pl_Unlocked );
1331 pl_Release( p_vlc );
1337 /*****************************************************************************
1338 * Help: print program help
1339 *****************************************************************************
1340 * Print a short inline help. Message interface is initialized at this stage.
1341 *****************************************************************************/
1342 static inline void print_help_on_full_help( void )
1344 utf8_fprintf( stdout, "\n" );
1345 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1348 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1351 ShowConsole( true );
1354 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1356 utf8_fprintf( stdout, vlc_usage, "vlc" );
1357 Usage( p_this, "=help" );
1358 Usage( p_this, "=main" );
1359 print_help_on_full_help();
1361 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1363 utf8_fprintf( stdout, vlc_usage, "vlc" );
1364 Usage( p_this, NULL );
1365 print_help_on_full_help();
1367 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1369 utf8_fprintf( stdout, vlc_usage, "vlc" );
1370 Usage( p_this, NULL );
1372 else if( psz_help_name )
1374 Usage( p_this, psz_help_name );
1377 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1382 /*****************************************************************************
1383 * Usage: print module usage
1384 *****************************************************************************
1385 * Print a short inline help. Message interface is initialized at this stage.
1386 *****************************************************************************/
1387 # define COL(x) "\033[" #x ";1m"
1388 # define RED COL(31)
1389 # define GREEN COL(32)
1390 # define YELLOW COL(33)
1391 # define BLUE COL(34)
1392 # define MAGENTA COL(35)
1393 # define CYAN COL(36)
1394 # define WHITE COL(0)
1395 # define GRAY "\033[0m"
1396 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1398 if( !p_item ) return;
1401 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1403 if( b_description && p_item->psz_longtext )
1404 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1405 p_item->psz_longtext );
1409 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1410 if( b_description && p_item->psz_longtext )
1411 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1415 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1417 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1418 /* short option ------' | | | | | | |
1419 * option name ------------' | | | | | |
1420 * <bra ---------------------' | | | | |
1421 * option type or "" ----------' | | | |
1422 * ket> -------------------------' | | |
1423 * padding spaces -----------------' | |
1424 * comment --------------------------' |
1425 * comment suffix ---------------------'
1427 * The purpose of having bra and ket is that we might i18n them as well.
1430 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1431 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1433 #define LINE_START 8
1434 #define PADDING_SPACES 25
1436 # define OPTION_VALUE_SEP "="
1438 # define OPTION_VALUE_SEP " "
1440 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1441 char psz_spaces_longtext[LINE_START+3];
1442 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1443 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1444 char psz_buffer[10000];
1446 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1447 int i_width_description = i_width + PADDING_SPACES - 1;
1448 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1449 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1450 bool b_description_hack;
1451 bool b_color = config_GetInt( p_this, "color" ) > 0;
1452 bool b_has_advanced = false;
1453 bool b_found = false;
1454 int i_only_advanced = 0; /* Number of modules ignored because they
1455 * only have advanced options */
1456 bool b_strict = psz_search && *psz_search == '=';
1457 if( b_strict ) psz_search++;
1459 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1460 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1461 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1462 psz_spaces_longtext[LINE_START+2] = '\0';
1466 b_color = false; // don't put color control codes in a .txt file
1470 strcpy( psz_format, COLOR_FORMAT_STRING );
1471 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1475 strcpy( psz_format, FORMAT_STRING );
1476 strcpy( psz_format_bool, FORMAT_STRING );
1479 /* List all modules */
1480 module_t **list = module_list_get (NULL);
1484 /* Ugly hack to make sure that the help options always come first
1487 Usage( p_this, "help" );
1489 /* Enumerate the config for each module */
1490 for (size_t i = 0; list[i]; i++)
1493 module_t *p_parser = list[i];
1494 module_config_t *p_item = NULL;
1495 module_config_t *p_section = NULL;
1496 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1499 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1500 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1502 char *const *pp_shortcut = p_parser->pp_shortcuts;
1503 while( *pp_shortcut )
1505 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1506 : !!strstr( *pp_shortcut, psz_search ) )
1514 /* Ignore modules without config options */
1515 if( !p_parser->i_config_items )
1520 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1521 /* Ugly hack to make sure that the help options always come first
1523 if( !psz_search && b_help_module )
1526 /* Ignore modules with only advanced config options if requested */
1529 for( p_item = p_parser->p_config;
1533 if( (p_item->i_type & CONFIG_ITEM) &&
1534 !p_item->b_advanced && !p_item->b_removed ) break;
1537 if( p_item == p_end )
1546 /* Print name of module */
1547 if( strcmp( "main", p_parser->psz_object_name ) )
1550 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1551 p_parser->psz_longname,
1552 p_parser->psz_object_name );
1554 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1556 if( p_parser->psz_help )
1559 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1561 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1564 /* Print module options */
1565 for( p_item = p_parser->p_config;
1569 char *psz_text, *psz_spaces = psz_spaces_text;
1570 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1571 const char *psz_suf = "", *psz_prefix = NULL;
1575 /* Skip removed options */
1576 if( p_item->b_removed )
1580 /* Skip advanced options if requested */
1581 if( p_item->b_advanced && !b_advanced )
1583 b_has_advanced = true;
1587 switch( p_item->i_type )
1589 case CONFIG_HINT_CATEGORY:
1590 case CONFIG_HINT_USAGE:
1591 if( !strcmp( "main", p_parser->psz_object_name ) )
1594 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1597 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1599 if( b_description && p_item->psz_longtext )
1602 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1603 p_item->psz_longtext );
1605 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1609 case CONFIG_HINT_SUBCATEGORY:
1610 if( strcmp( "main", p_parser->psz_object_name ) )
1612 case CONFIG_SECTION:
1616 case CONFIG_ITEM_STRING:
1617 case CONFIG_ITEM_FILE:
1618 case CONFIG_ITEM_DIRECTORY:
1619 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1620 case CONFIG_ITEM_MODULE_CAT:
1621 case CONFIG_ITEM_MODULE_LIST:
1622 case CONFIG_ITEM_MODULE_LIST_CAT:
1623 case CONFIG_ITEM_FONT:
1624 case CONFIG_ITEM_PASSWORD:
1625 print_help_section( p_section, b_color, b_description );
1627 psz_bra = OPTION_VALUE_SEP "<";
1628 psz_type = _("string");
1631 if( p_item->ppsz_list )
1633 psz_bra = OPTION_VALUE_SEP "{";
1634 psz_type = psz_buffer;
1635 psz_buffer[0] = '\0';
1636 for( i = 0; p_item->ppsz_list[i]; i++ )
1638 if( i ) strcat( psz_buffer, "," );
1639 strcat( psz_buffer, p_item->ppsz_list[i] );
1644 case CONFIG_ITEM_INTEGER:
1645 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1646 print_help_section( p_section, b_color, b_description );
1648 psz_bra = OPTION_VALUE_SEP "<";
1649 psz_type = _("integer");
1652 if( p_item->min.i || p_item->max.i )
1654 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1655 p_item->min.i, p_item->max.i );
1656 psz_type = psz_buffer;
1659 if( p_item->i_list )
1661 psz_bra = OPTION_VALUE_SEP "{";
1662 psz_type = psz_buffer;
1663 psz_buffer[0] = '\0';
1664 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1666 if( i ) strcat( psz_buffer, ", " );
1667 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1669 p_item->ppsz_list_text[i] );
1674 case CONFIG_ITEM_FLOAT:
1675 print_help_section( p_section, b_color, b_description );
1677 psz_bra = OPTION_VALUE_SEP "<";
1678 psz_type = _("float");
1680 if( p_item->min.f || p_item->max.f )
1682 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1683 p_item->min.f, p_item->max.f );
1684 psz_type = psz_buffer;
1687 case CONFIG_ITEM_BOOL:
1688 print_help_section( p_section, b_color, b_description );
1690 psz_bra = ""; psz_type = ""; psz_ket = "";
1691 if( !b_help_module )
1693 psz_suf = p_item->value.i ? _(" (default enabled)") :
1694 _(" (default disabled)");
1704 /* Add short option if any */
1705 if( p_item->i_short )
1707 sprintf( psz_short, "-%c,", p_item->i_short );
1711 strcpy( psz_short, " " );
1714 i = PADDING_SPACES - strlen( p_item->psz_name )
1715 - strlen( psz_bra ) - strlen( psz_type )
1716 - strlen( psz_ket ) - 1;
1718 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1720 psz_prefix = ", --no-";
1721 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1726 psz_spaces[0] = '\n';
1731 psz_spaces[i] = '\0';
1734 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1736 utf8_fprintf( stdout, psz_format_bool, psz_short,
1737 p_item->psz_name, psz_prefix, p_item->psz_name,
1738 psz_bra, psz_type, psz_ket, psz_spaces );
1742 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1743 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1746 psz_spaces[i] = ' ';
1748 /* We wrap the rest of the output */
1749 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1750 b_description_hack = b_description;
1753 psz_text = psz_buffer;
1754 i_cur_width = b_description && !b_description_hack
1755 ? i_width_description
1759 char *psz_parser, *psz_word;
1760 size_t i_end = strlen( psz_text );
1762 /* If the remaining text fits in a line, print it. */
1763 if( i_end <= i_cur_width )
1767 if( !b_description || b_description_hack )
1768 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1770 utf8_fprintf( stdout, "%s\n", psz_text );
1774 utf8_fprintf( stdout, "%s\n", psz_text );
1779 /* Otherwise, eat as many words as possible */
1780 psz_parser = psz_text;
1783 psz_word = psz_parser;
1784 psz_parser = strchr( psz_word, ' ' );
1785 /* If no space was found, we reached the end of the text
1786 * block; otherwise, we skip the space we just found. */
1787 psz_parser = psz_parser ? psz_parser + 1
1790 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1792 /* We cut a word in one of these cases:
1793 * - it's the only word in the line and it's too long.
1794 * - we used less than 80% of the width and the word we are
1795 * going to wrap is longer than 40% of the width, and even
1796 * if the word would have fit in the next line. */
1797 if( psz_word == psz_text
1798 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1799 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1801 char c = psz_text[i_cur_width];
1802 psz_text[i_cur_width] = '\0';
1805 if( !b_description || b_description_hack )
1806 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1807 psz_text, psz_spaces );
1809 utf8_fprintf( stdout, "%s\n%s",
1810 psz_text, psz_spaces );
1814 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1816 psz_text += i_cur_width;
1821 psz_word[-1] = '\0';
1824 if( !b_description || b_description_hack )
1825 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1826 psz_text, psz_spaces );
1828 utf8_fprintf( stdout, "%s\n%s",
1829 psz_text, psz_spaces );
1833 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1835 psz_text = psz_word;
1839 if( b_description_hack && p_item->psz_longtext )
1841 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1842 b_description_hack = false;
1843 psz_spaces = psz_spaces_longtext;
1844 utf8_fprintf( stdout, "%s", psz_spaces );
1850 if( b_has_advanced )
1853 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1854 _( "add --advanced to your command line to see advanced options."));
1856 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1857 _( "add --advanced to your command line to see advanced options."));
1860 if( i_only_advanced > 0 )
1864 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1865 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1869 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1870 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1876 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1877 _( "No matching module found. Use --list or" \
1878 "--list-verbose to list available modules." ) );
1880 utf8_fprintf( stdout, "\n%s\n",
1881 _( "No matching module found. Use --list or" \
1882 "--list-verbose to list available modules." ) );
1885 /* Release the module list */
1886 module_list_free (list);
1889 /*****************************************************************************
1890 * ListModules: list the available modules with their description
1891 *****************************************************************************
1892 * Print a list of all available modules (builtins and plugins) and a short
1893 * description for each one.
1894 *****************************************************************************/
1895 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1898 char psz_spaces[22];
1900 bool b_color = config_GetInt( p_this, "color" ) > 0;
1902 memset( psz_spaces, ' ', 22 );
1905 ShowConsole( true );
1908 /* List all modules */
1909 module_t **list = module_list_get (NULL);
1911 /* Enumerate each module */
1912 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1916 /* Nasty hack, but right now I'm too tired to think about a nice
1918 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1923 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1924 p_parser->psz_object_name,
1926 p_parser->psz_longname );
1928 utf8_fprintf( stdout, " %s%s %s\n",
1929 p_parser->psz_object_name,
1930 psz_spaces, p_parser->psz_longname );
1934 char *const *pp_shortcut = p_parser->pp_shortcuts;
1935 while( *pp_shortcut )
1937 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1940 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1943 utf8_fprintf( stdout, " s %s\n",
1948 if( p_parser->psz_capability )
1951 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1952 p_parser->psz_capability,
1953 p_parser->i_score );
1955 utf8_fprintf( stdout, " c %s (%d)\n",
1956 p_parser->psz_capability,
1957 p_parser->i_score );
1961 psz_spaces[i] = ' ';
1963 module_list_free (list);
1965 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1970 /*****************************************************************************
1971 * Version: print complete program version
1972 *****************************************************************************
1973 * Print complete program version and build number.
1974 *****************************************************************************/
1975 static void Version( void )
1978 ShowConsole( true );
1981 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1982 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1983 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1984 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1985 if( strcmp( VLC_Changeset(), "exported" ) )
1986 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1988 utf8_fprintf( stdout, LICENSE_MSG );
1990 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1995 /*****************************************************************************
1996 * ShowConsole: On Win32, create an output console for debug messages
1997 *****************************************************************************
1998 * This function is useful only on Win32.
1999 *****************************************************************************/
2001 static void ShowConsole( bool b_dofile )
2004 FILE *f_help = NULL;
2006 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2009 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2010 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2011 * page (e.g. CP437 or CP850). */
2012 SetConsoleOutputCP (GetACP ());
2013 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2015 freopen( "CONOUT$", "w", stderr );
2016 freopen( "CONIN$", "r", stdin );
2018 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2021 freopen( "vlc-help.txt", "wt", stdout );
2022 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2024 else freopen( "CONOUT$", "w", stdout );
2030 /*****************************************************************************
2031 * PauseConsole: On Win32, wait for a key press before closing the console
2032 *****************************************************************************
2033 * This function is useful only on Win32.
2034 *****************************************************************************/
2036 static void PauseConsole( void )
2040 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2042 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2050 /*****************************************************************************
2051 * ConsoleWidth: Return the console width in characters
2052 *****************************************************************************
2053 * We use the stty shell command to get the console width; if this fails or
2054 * if the width is less than 80, we default to 80.
2055 *****************************************************************************/
2056 static int ConsoleWidth( void )
2058 unsigned i_width = 80;
2061 FILE *file = popen( "stty size 2>/dev/null", "r" );
2064 if (fscanf (file, "%*u %u", &i_width) <= 0)
2068 #elif !defined (UNDER_CE)
2069 CONSOLE_SCREEN_BUFFER_INFO buf;
2071 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2072 i_width = buf.dwSize.X;
2078 /*****************************************************************************
2079 * InitDeviceValues: initialize device values
2080 *****************************************************************************
2081 * This function inits the dvd, vcd and cd-audio values
2082 *****************************************************************************/
2083 static void InitDeviceValues( libvlc_int_t *p_vlc )
2086 LibHalContext * ctx = NULL;
2088 char **devices = NULL;
2089 char *block_dev = NULL;
2092 DBusConnection *p_connection = NULL;
2095 ctx = libhal_ctx_new();
2097 dbus_error_init( &error );
2098 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2099 if( dbus_error_is_set( &error ) || !p_connection )
2101 libhal_ctx_free( ctx );
2102 dbus_error_free( &error );
2105 libhal_ctx_set_dbus_connection( ctx, p_connection );
2106 if( libhal_ctx_init( ctx, &error ) )
2108 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2110 for( i = 0; i < i_devices; i++ )
2112 if( !libhal_device_property_exists( ctx, devices[i],
2113 "storage.cdrom.dvd", NULL ) )
2117 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2118 "storage.cdrom.dvd", NULL );
2119 block_dev = libhal_device_get_property_string( ctx,
2120 devices[ i ], "block.device" , NULL );
2123 config_PutPsz( p_vlc, "dvd", block_dev );
2126 config_PutPsz( p_vlc, "vcd", block_dev );
2127 config_PutPsz( p_vlc, "cd-audio", block_dev );
2128 libhal_free_string( block_dev );
2130 libhal_free_string_array( devices );
2132 libhal_ctx_shutdown( ctx, NULL );
2133 dbus_connection_unref( p_connection );
2134 libhal_ctx_free( ctx );
2138 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2142 #endif /* HAVE_HAL */