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 libvlc_int_t * p_static_vlc = NULL;
103 static unsigned i_instances = 0;
106 static bool b_daemon = false;
114 * Atomically set the reference count to 1.
115 * @param p_gc reference counted object
116 * @param pf_destruct destruction calback
119 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
121 /* There is no point in using the GC if there is no destructor... */
122 assert (pf_destruct);
123 p_gc->pf_destructor = pf_destruct;
126 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
127 __sync_synchronize ();
128 #elif defined (WIN32) && defined (__GNUC__)
129 #elif defined(__APPLE__)
132 /* Nobody else can possibly lock the spin - it's there as a barrier */
133 vlc_spin_init (&p_gc->spin);
134 vlc_spin_lock (&p_gc->spin);
135 vlc_spin_unlock (&p_gc->spin);
141 * Atomically increment the reference count.
142 * @param p_gc reference counted object
145 void *vlc_hold (gc_object_t * p_gc)
149 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
151 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
152 refs = __sync_add_and_fetch (&p_gc->refs, 1);
153 #elif defined (WIN64)
154 refs = InterlockedIncrement64 (&p_gc->refs);
155 #elif defined (WIN32)
156 refs = InterlockedIncrement (&p_gc->refs);
157 #elif defined(__APPLE__)
158 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
160 vlc_spin_lock (&p_gc->spin);
162 vlc_spin_unlock (&p_gc->spin);
164 assert (refs != 1); /* there had to be a reference already */
169 * Atomically decrement the reference count and, if it reaches zero, destroy.
170 * @param p_gc reference counted object.
172 void vlc_release (gc_object_t *p_gc)
177 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
179 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
180 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
181 #elif defined (WIN64)
182 refs = InterlockedDecrement64 (&p_gc->refs);
183 #elif defined (WIN32)
184 refs = InterlockedDecrement (&p_gc->refs);
185 #elif defined(__APPLE__)
186 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
188 vlc_spin_lock (&p_gc->spin);
190 vlc_spin_unlock (&p_gc->spin);
193 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
197 #elif defined (WIN32) && defined (__GNUC__)
198 #elif defined(__APPLE__)
200 vlc_spin_destroy (&p_gc->spin);
202 p_gc->pf_destructor (p_gc);
206 /*****************************************************************************
208 *****************************************************************************/
209 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
210 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
211 static void SetLanguage ( char const * );
213 static inline int LoadMessages (void);
214 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
215 static void Help ( libvlc_int_t *, char const *psz_help_name );
216 static void Usage ( libvlc_int_t *, char const *psz_search );
217 static void ListModules ( libvlc_int_t *, bool );
218 static void Version ( void );
221 static void ShowConsole ( bool );
222 static void PauseConsole ( void );
224 static int ConsoleWidth ( void );
226 static int VerboseCallback( vlc_object_t *, char const *,
227 vlc_value_t, vlc_value_t, void * );
229 static void InitDeviceValues( libvlc_int_t * );
231 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
234 * Allocate a libvlc instance, initialize global data if needed
235 * It also initializes the threading system
237 libvlc_int_t * libvlc_InternalCreate( void )
239 libvlc_int_t *p_libvlc;
241 char *psz_env = NULL;
243 /* Now that the thread system is initialized, we don't have much, but
244 * at least we have variables */
245 vlc_mutex_lock( &global_lock );
246 if( i_instances == 0 )
248 /* Guess what CPU we have */
249 cpu_flags = CPUCapabilities();
250 /* The module bank will be initialized later */
253 /* Allocate a libvlc instance object */
254 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
255 VLC_OBJECT_GENERIC, "libvlc" );
256 if( p_libvlc != NULL )
258 vlc_mutex_unlock( &global_lock );
260 if( p_libvlc == NULL )
263 priv = libvlc_priv (p_libvlc);
264 priv->p_playlist = NULL;
265 priv->p_interaction = NULL;
267 p_libvlc->psz_object_name = strdup( "libvlc" );
269 /* Initialize message queue */
270 msg_Create( p_libvlc );
272 /* Find verbosity from VLC_VERBOSE environment variable */
273 psz_env = getenv( "VLC_VERBOSE" );
274 if( psz_env != NULL )
275 priv->i_verbose = atoi( psz_env );
278 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
279 priv->b_color = isatty( 2 ); /* 2 is for stderr */
281 priv->b_color = false;
284 /* Initialize mutexes */
285 vlc_mutex_init( &priv->timer_lock );
286 vlc_mutex_init( &priv->config_lock );
288 /* Store data for the non-reentrant API */
289 p_static_vlc = p_libvlc;
295 * Initialize a libvlc instance
296 * This function initializes a previously allocated libvlc instance:
298 * - gettext initialization
299 * - message queue, module bank and playlist initialization
300 * - configuration and commandline parsing
302 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
303 const char *ppsz_argv[] )
305 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
306 char p_capabilities[200];
308 char * psz_modules = NULL;
309 char * psz_parser = NULL;
310 char * psz_control = NULL;
312 int i_ret = VLC_EEXIT;
313 playlist_t *p_playlist = NULL;
315 #if defined( ENABLE_NLS ) \
316 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
317 # if defined (WIN32) || defined (__APPLE__)
322 /* System specific initialization code */
323 system_Init( p_libvlc, &i_argc, ppsz_argv );
326 * Support for gettext
330 /* Initialize the module bank and load the configuration of the
331 * main module. We need to do this at this stage to be able to display
332 * a short help if required by the user. (short help == main module
334 module_InitBank( p_libvlc );
336 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
338 module_EndBank( p_libvlc );
342 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
343 /* Announce who we are - Do it only for first instance ? */
344 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
345 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
346 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
347 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
349 /* Check for short help option */
350 if( config_GetInt( p_libvlc, "help" ) > 0 )
352 Help( p_libvlc, "help" );
354 i_ret = VLC_EEXITSUCCESS;
356 /* Check for version option */
357 else if( config_GetInt( p_libvlc, "version" ) > 0 )
361 i_ret = VLC_EEXITSUCCESS;
364 /* Set the config file stuff */
365 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
367 /* Check for plugins cache options */
368 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
370 /* Check for daemon mode */
372 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
375 char *psz_pidfile = NULL;
377 if( daemon( 1, 0) != 0 )
379 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
384 /* lets check if we need to write the pidfile */
385 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
386 if( psz_pidfile != NULL )
389 pid_t i_pid = getpid ();
390 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
391 i_pid, psz_pidfile );
392 pidfile = utf8_fopen( psz_pidfile,"w" );
393 if( pidfile != NULL )
395 utf8_fprintf( pidfile, "%d", (int)i_pid );
400 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
409 if( ( i_pid = fork() ) < 0 )
411 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
416 /* This is the parent, exit right now */
417 msg_Dbg( p_libvlc, "closing parent process" );
419 i_ret = VLC_EEXITSUCCESS;
423 /* We are the child */
424 msg_Dbg( p_libvlc, "daemon spawned" );
425 close( STDIN_FILENO );
426 close( STDOUT_FILENO );
427 close( STDERR_FILENO );
437 module_EndBank( p_libvlc );
441 /* Check for translation config option */
442 #if defined( ENABLE_NLS ) \
443 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
444 # if defined (WIN32) || defined (__APPLE__)
445 /* This ain't really nice to have to reload the config here but it seems
446 * the only way to do it. */
448 if( !config_GetInt( p_libvlc, "ignore-config" ) )
449 config_LoadConfigFile( p_libvlc, "main" );
450 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
452 /* Check if the user specified a custom language */
453 psz_language = config_GetPsz( p_libvlc, "language" );
454 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
456 /* Reset the default domain */
457 SetLanguage( psz_language );
459 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
460 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
462 module_EndBank( p_libvlc );
463 module_InitBank( p_libvlc );
464 if( !config_GetInt( p_libvlc, "ignore-config" ) )
465 config_LoadConfigFile( p_libvlc, "main" );
466 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
468 free( psz_language );
473 * Load the builtins and plugins into the module_bank.
474 * We have to do it before config_Load*() because this also gets the
475 * list of configuration options exported by each module and loads their
478 module_LoadBuiltins( p_libvlc );
479 module_LoadPlugins( p_libvlc, b_cache_delete );
480 if( p_libvlc->b_die )
486 module_t **list = module_list_get( &module_count );
487 module_list_free( list );
488 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
490 /* Check for help on modules */
491 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
493 Help( p_libvlc, p_tmp );
496 i_ret = VLC_EEXITSUCCESS;
498 /* Check for full help option */
499 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
501 config_PutInt( p_libvlc, "advanced", 1);
502 config_PutInt( p_libvlc, "help-verbose", 1);
503 Help( p_libvlc, "full-help" );
505 i_ret = VLC_EEXITSUCCESS;
507 /* Check for long help option */
508 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
510 Help( p_libvlc, "longhelp" );
512 i_ret = VLC_EEXITSUCCESS;
514 /* Check for module list option */
515 else if( config_GetInt( p_libvlc, "list" ) > 0 )
517 ListModules( p_libvlc, false );
519 i_ret = VLC_EEXITSUCCESS;
521 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
523 ListModules( p_libvlc, true );
525 i_ret = VLC_EEXITSUCCESS;
528 /* Check for config file options */
529 if( !config_GetInt( p_libvlc, "ignore-config" ) )
531 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
533 config_ResetAll( p_libvlc );
534 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
535 config_SaveConfigFile( p_libvlc, NULL );
537 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
539 config_LoadConfigFile( p_libvlc, NULL );
540 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
541 config_SaveConfigFile( p_libvlc, NULL );
547 module_EndBank( p_libvlc );
554 InitDeviceValues( p_libvlc );
557 * Override default configuration with config file settings
559 if( !config_GetInt( p_libvlc, "ignore-config" ) )
560 config_LoadConfigFile( p_libvlc, NULL );
563 * Override configuration with command line settings
565 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
568 ShowConsole( false );
569 /* Pause the console because it's destroyed when we exit */
570 fprintf( stderr, "The command line options couldn't be loaded, check "
571 "that they are valid.\n" );
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 );
729 free( psz_verbose_objects );
732 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
733 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
736 var_Set( p_libvlc, "verbose", val );
738 var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
739 var_TriggerCallback( p_libvlc, "verbose" );
742 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
744 if( !config_GetInt( p_libvlc, "fpu" ) )
745 cpu_flags &= ~CPU_CAPABILITY_FPU;
747 #if defined( __i386__ ) || defined( __x86_64__ )
748 if( !config_GetInt( p_libvlc, "mmx" ) )
749 cpu_flags &= ~CPU_CAPABILITY_MMX;
750 if( !config_GetInt( p_libvlc, "3dn" ) )
751 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
752 if( !config_GetInt( p_libvlc, "mmxext" ) )
753 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
754 if( !config_GetInt( p_libvlc, "sse" ) )
755 cpu_flags &= ~CPU_CAPABILITY_SSE;
756 if( !config_GetInt( p_libvlc, "sse2" ) )
757 cpu_flags &= ~CPU_CAPABILITY_SSE2;
759 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
760 if( !config_GetInt( p_libvlc, "altivec" ) )
761 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
764 #define PRINT_CAPABILITY( capability, string ) \
765 if( vlc_CPU() & capability ) \
767 strncat( p_capabilities, string " ", \
768 sizeof(p_capabilities) - strlen(p_capabilities) ); \
769 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
772 p_capabilities[0] = '\0';
773 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
778 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
779 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
780 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
781 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
782 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
783 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
786 * Choose the best memcpy module
788 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
790 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
792 priv->pp_timers = NULL;
795 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
796 if( !p_libvlc->p_stats )
798 vlc_object_release( p_libvlc );
801 vlc_mutex_init( &p_libvlc->p_stats->lock );
802 priv->p_stats_computer = NULL;
804 priv->i_last_input_id = 0; /* Not very safe, should be removed */
807 * Initialize hotkey handling
809 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
810 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
811 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
812 /* Do a copy (we don't need to modify the strings) */
813 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
814 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
815 p_libvlc->p_hotkeys );
817 /* Initialize interaction */
818 priv->p_interaction = interaction_Init( p_libvlc );
820 /* Initialize playlist and get commandline files */
821 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
824 msg_Err( p_libvlc, "playlist initialization failed" );
825 if( priv->p_memcpy_module != NULL )
827 module_unneed( p_libvlc, priv->p_memcpy_module );
829 module_EndBank( p_libvlc );
832 playlist_Activate( p_playlist );
833 vlc_object_attach( p_playlist, p_libvlc );
835 /* Add service discovery modules */
836 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
837 if( psz_modules && *psz_modules )
839 char *p = psz_modules, *m;
840 while( ( m = strsep( &p, " :," ) ) != NULL )
841 playlist_ServicesDiscoveryAdd( p_playlist, m );
846 /* Initialize VLM if vlm-conf is specified */
847 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
848 if( psz_parser && *psz_parser )
850 priv->p_vlm = vlm_New( p_libvlc );
852 msg_Err( p_libvlc, "VLM initialization failed" );
858 * Load background interfaces
860 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
861 psz_control = config_GetPsz( p_libvlc, "control" );
863 if( psz_modules && *psz_modules && psz_control && *psz_control )
865 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
866 strlen( psz_control ) + 1 );
867 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
869 else if( psz_control && *psz_control )
872 psz_modules = strdup( psz_control );
875 psz_parser = psz_modules;
876 while ( psz_parser && *psz_parser )
878 char *psz_module, *psz_temp;
879 psz_module = psz_parser;
880 psz_parser = strchr( psz_module, ':' );
886 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
888 libvlc_InternalAddIntf( p_libvlc, psz_temp );
896 * Always load the hotkeys interface if it exists
898 libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
900 libvlc_InternalAddIntf( p_libvlc, "globalhotkeys,none" );
904 /* loads dbus control interface if in one-instance mode
905 * we do it only when playlist exists, because dbus module needs it */
906 if( config_GetInt( p_libvlc, "one-instance" ) > 0
907 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
908 && config_GetInt( p_libvlc, "started-from-file" ) ) )
909 libvlc_InternalAddIntf( p_libvlc, "dbus,none" );
911 /* Prevents the power management daemon from suspending the system
912 * when VLC is active */
913 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
914 libvlc_InternalAddIntf( p_libvlc, "inhibit,none" );
918 * If needed, load the Xscreensaver interface
919 * Currently, only for X
921 #ifdef HAVE_X11_XLIB_H
922 if( config_GetInt( p_libvlc, "disable-screensaver" ) )
924 libvlc_InternalAddIntf( p_libvlc, "screensaver,none" );
928 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
929 !config_GetInt( p_libvlc, "syslog" ) )
931 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
934 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
936 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
937 var_SetString( p_libvlc, "logmode", "syslog" );
938 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
942 var_SetString( p_libvlc, "logmode", logmode );
946 var_Destroy( p_libvlc, "logmode" );
950 if( config_GetInt( p_libvlc, "show-intf" ) > 0 )
952 libvlc_InternalAddIntf( p_libvlc, "showintf,none" );
955 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
957 libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
961 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
963 char *psz_codecs = config_GetPsz( p_playlist, "codec" );
966 char *psz_morecodecs;
967 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
969 config_PutPsz( p_libvlc, "codec", psz_morecodecs);
970 free( psz_morecodecs );
974 config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
980 * FIXME: kludge to use a p_libvlc-local variable for the Mozilla plugin
982 var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
983 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
984 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
985 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
986 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
987 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
992 /* Create volume callback system. */
993 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
995 /* Create a variable for showing the interface (moved from playlist). */
996 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
997 var_SetBool( p_libvlc, "intf-show", true );
999 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1002 * Get input filenames given as commandline arguments
1004 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1007 * Get --open argument
1009 var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
1010 var_Get( p_libvlc, "open", &val );
1011 if ( val.psz_string != NULL && *val.psz_string )
1013 playlist_t *p_playlist = pl_Hold( p_libvlc );
1014 playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
1015 -1, NULL, 0, true, pl_Unlocked );
1016 pl_Release( p_libvlc );
1018 free( val.psz_string );
1024 * Cleanup a libvlc instance. The instance is not completely deallocated
1025 * \param p_libvlc the instance to clean
1027 int libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1029 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1030 playlist_t *p_playlist = priv->p_playlist;
1032 /* Deactivate the playlist */
1033 msg_Dbg( p_libvlc, "deactivating the playlist" );
1034 playlist_Deactivate( p_playlist );
1036 /* Remove all services discovery */
1037 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1038 playlist_ServicesDiscoveryKillAll( p_playlist );
1040 /* Ask the interfaces to stop and destroy them */
1041 msg_Dbg( p_libvlc, "removing all interfaces" );
1042 intf_thread_t *p_intf;
1043 while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
1045 intf_StopThread( p_intf );
1046 vlc_object_detach( p_intf );
1047 vlc_object_release( p_intf ); /* for intf_Create() */
1048 vlc_object_release( p_intf ); /* for vlc_object_find() */
1052 /* Destroy VLM if created in libvlc_InternalInit */
1055 vlm_Delete( priv->p_vlm );
1060 /* Any thread still running must not assume pl_Hold() succeeds. */
1061 msg_Dbg( p_libvlc, "removing playlist" );
1063 libvlc_priv(p_playlist->p_libvlc)->p_playlist = NULL;
1064 barrier(); /* FIXME is that correct ? */
1066 vlc_object_release( p_playlist );
1068 /* Free interaction */
1069 msg_Dbg( p_libvlc, "removing interaction" );
1070 interaction_Destroy( priv->p_interaction );
1072 stats_TimersDumpAll( p_libvlc );
1073 stats_TimersCleanAll( p_libvlc );
1075 msg_Dbg( p_libvlc, "removing stats" );
1076 vlc_mutex_destroy( &p_libvlc->p_stats->lock );
1077 FREENULL( p_libvlc->p_stats );
1083 * Destroy everything.
1084 * This function requests the running threads to finish, waits for their
1085 * termination, and destroys their structure.
1086 * It stops the thread systems: no instance can run after this has run
1087 * \param p_libvlc the instance to destroy
1089 int libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1092 return VLC_EGENERIC;
1094 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1097 char* psz_pidfile = NULL;
1101 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1102 if( psz_pidfile != NULL )
1104 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1105 if( unlink( psz_pidfile ) == -1 )
1107 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1111 free( psz_pidfile );
1115 if( priv->p_memcpy_module )
1117 module_unneed( p_libvlc, priv->p_memcpy_module );
1118 priv->p_memcpy_module = NULL;
1121 /* Free module bank. It is refcounted, so we call this each time */
1122 module_EndBank( p_libvlc );
1124 FREENULL( priv->psz_configfile );
1125 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1126 p_libvlc->p_hotkeys );
1127 FREENULL( p_libvlc->p_hotkeys );
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_mutex_destroy( &priv->config_lock );
1143 vlc_mutex_destroy( &priv->timer_lock );
1145 vlc_object_release( p_libvlc );
1152 * Add an interface plugin and run it
1154 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1157 intf_thread_t *p_intf = NULL;
1160 return VLC_EGENERIC;
1162 if( !psz_module ) /* requesting the default interface */
1164 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1165 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1169 /* Daemon mode hack.
1170 * We prefer the dummy interface if none is specified. */
1171 psz_module = "dummy";
1174 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1176 free( psz_interface );
1179 /* Try to create the interface */
1180 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1181 if( p_intf == NULL )
1183 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1185 return VLC_EGENERIC;
1188 /* Try to run the interface */
1189 i_err = intf_RunThread( p_intf );
1192 vlc_object_detach( p_intf );
1193 vlc_object_release( p_intf );
1200 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1201 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1202 /*****************************************************************************
1203 * SetLanguage: set the interface language.
1204 *****************************************************************************
1205 * We set the LC_MESSAGES locale category for interface messages and buttons,
1206 * as well as the LC_CTYPE category for string sorting and possible wide
1207 * character support.
1208 *****************************************************************************/
1209 static void SetLanguage ( const char *psz_lang )
1212 /* I need that under Darwin, please check it doesn't disturb
1213 * other platforms. --Meuuh */
1214 setenv( "LANG", psz_lang, 1 );
1217 /* We set LC_ALL manually because it is the only way to set
1218 * the language at runtime under eg. Windows. Beware that this
1219 * makes the environment unconsistent when libvlc is unloaded and
1220 * should probably be moved to a safer place like vlc.c. */
1221 static char psz_lcall[20];
1222 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1223 psz_lcall[19] = '\0';
1224 putenv( psz_lcall );
1227 setlocale( LC_ALL, psz_lang );
1232 static inline int LoadMessages (void)
1234 #if defined( ENABLE_NLS ) \
1235 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1236 /* Specify where to find the locales for current domain */
1237 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1238 static const char psz_path[] = LOCALEDIR;
1240 char psz_path[1024];
1241 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1242 config_GetDataDir(), "locale")
1243 >= (int)sizeof (psz_path))
1247 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1249 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1250 " to directory %s\n", psz_path);
1254 /* LibVLC wants all messages in UTF-8.
1255 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1256 * and other functions that are not part of our text domain.
1258 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1260 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1262 // Unbinds the text domain to avoid broken encoding
1263 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1267 /* LibVLC does NOT set the default textdomain, since it is a library.
1268 * This could otherwise break programs using LibVLC (other than VLC).
1269 * textdomain (PACKAGE_NAME);
1275 /*****************************************************************************
1276 * GetFilenames: parse command line options which are not flags
1277 *****************************************************************************
1278 * Parse command line for input files as well as their associated options.
1279 * An option always follows its associated input and begins with a ":".
1280 *****************************************************************************/
1281 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1283 int i_opt, i_options;
1285 /* We assume that the remaining parameters are filenames
1286 * and their input options */
1287 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1291 /* Count the input options */
1292 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1298 /* TODO: write an internal function of this one, to avoid
1299 * unnecessary lookups. */
1301 playlist_t *p_playlist = pl_Hold( p_vlc );
1302 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1303 0, -1, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1304 i_options, true, pl_Unlocked );
1305 pl_Release( p_vlc );
1311 /*****************************************************************************
1312 * Help: print program help
1313 *****************************************************************************
1314 * Print a short inline help. Message interface is initialized at this stage.
1315 *****************************************************************************/
1316 static inline void print_help_on_full_help( void )
1318 utf8_fprintf( stdout, "\n" );
1319 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1322 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1325 ShowConsole( true );
1328 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1330 utf8_fprintf( stdout, vlc_usage, "vlc" );
1331 Usage( p_this, "=help" );
1332 Usage( p_this, "=main" );
1333 print_help_on_full_help();
1335 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1337 utf8_fprintf( stdout, vlc_usage, "vlc" );
1338 Usage( p_this, NULL );
1339 print_help_on_full_help();
1341 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1343 utf8_fprintf( stdout, vlc_usage, "vlc" );
1344 Usage( p_this, NULL );
1346 else if( psz_help_name )
1348 Usage( p_this, psz_help_name );
1351 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1356 /*****************************************************************************
1357 * Usage: print module usage
1358 *****************************************************************************
1359 * Print a short inline help. Message interface is initialized at this stage.
1360 *****************************************************************************/
1361 # define COL(x) "\033[" #x ";1m"
1362 # define RED COL(31)
1363 # define GREEN COL(32)
1364 # define YELLOW COL(33)
1365 # define BLUE COL(34)
1366 # define MAGENTA COL(35)
1367 # define CYAN COL(36)
1368 # define WHITE COL(0)
1369 # define GRAY "\033[0m"
1370 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1372 if( !p_item ) return;
1375 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1377 if( b_description && p_item->psz_longtext )
1378 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1379 p_item->psz_longtext );
1383 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1384 if( b_description && p_item->psz_longtext )
1385 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1389 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1391 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1392 /* short option ------' | | | | | | |
1393 * option name ------------' | | | | | |
1394 * <bra ---------------------' | | | | |
1395 * option type or "" ----------' | | | |
1396 * ket> -------------------------' | | |
1397 * padding spaces -----------------' | |
1398 * comment --------------------------' |
1399 * comment suffix ---------------------'
1401 * The purpose of having bra and ket is that we might i18n them as well.
1404 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1405 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1407 #define LINE_START 8
1408 #define PADDING_SPACES 25
1410 # define OPTION_VALUE_SEP "="
1412 # define OPTION_VALUE_SEP " "
1414 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1415 char psz_spaces_longtext[LINE_START+3];
1416 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1417 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1418 char psz_buffer[10000];
1420 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1421 int i_width_description = i_width + PADDING_SPACES - 1;
1422 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1423 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1424 bool b_description_hack;
1425 bool b_color = config_GetInt( p_this, "color" ) > 0;
1426 bool b_has_advanced = false;
1427 bool b_found = false;
1428 int i_only_advanced = 0; /* Number of modules ignored because they
1429 * only have advanced options */
1430 bool b_strict = psz_search && *psz_search == '=';
1431 if( b_strict ) psz_search++;
1433 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1434 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1435 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1436 psz_spaces_longtext[LINE_START+2] = '\0';
1440 b_color = false; // don't put color control codes in a .txt file
1444 strcpy( psz_format, COLOR_FORMAT_STRING );
1445 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1449 strcpy( psz_format, FORMAT_STRING );
1450 strcpy( psz_format_bool, FORMAT_STRING );
1453 /* List all modules */
1454 module_t **list = module_list_get (NULL);
1458 /* Ugly hack to make sure that the help options always come first
1461 Usage( p_this, "help" );
1463 /* Enumerate the config for each module */
1464 for (size_t i = 0; list[i]; i++)
1467 module_t *p_parser = list[i];
1468 module_config_t *p_item = NULL;
1469 module_config_t *p_section = NULL;
1470 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1473 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1474 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1476 char *const *pp_shortcut = p_parser->pp_shortcuts;
1477 while( *pp_shortcut )
1479 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1480 : !!strstr( *pp_shortcut, psz_search ) )
1488 /* Ignore modules without config options */
1489 if( !p_parser->i_config_items )
1494 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1495 /* Ugly hack to make sure that the help options always come first
1497 if( !psz_search && b_help_module )
1500 /* Ignore modules with only advanced config options if requested */
1503 for( p_item = p_parser->p_config;
1507 if( (p_item->i_type & CONFIG_ITEM) &&
1508 !p_item->b_advanced && !p_item->b_removed ) break;
1511 if( p_item == p_end )
1520 /* Print name of module */
1521 if( strcmp( "main", p_parser->psz_object_name ) )
1524 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1525 p_parser->psz_longname,
1526 p_parser->psz_object_name );
1528 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1530 if( p_parser->psz_help )
1533 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1535 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1538 /* Print module options */
1539 for( p_item = p_parser->p_config;
1543 char *psz_text, *psz_spaces = psz_spaces_text;
1544 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1545 const char *psz_suf = "", *psz_prefix = NULL;
1549 /* Skip removed options */
1550 if( p_item->b_removed )
1554 /* Skip advanced options if requested */
1555 if( p_item->b_advanced && !b_advanced )
1557 b_has_advanced = true;
1561 switch( p_item->i_type )
1563 case CONFIG_HINT_CATEGORY:
1564 case CONFIG_HINT_USAGE:
1565 if( !strcmp( "main", p_parser->psz_object_name ) )
1568 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1571 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1573 if( b_description && p_item->psz_longtext )
1576 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1577 p_item->psz_longtext );
1579 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1583 case CONFIG_HINT_SUBCATEGORY:
1584 if( strcmp( "main", p_parser->psz_object_name ) )
1586 case CONFIG_SECTION:
1590 case CONFIG_ITEM_STRING:
1591 case CONFIG_ITEM_FILE:
1592 case CONFIG_ITEM_DIRECTORY:
1593 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1594 case CONFIG_ITEM_MODULE_CAT:
1595 case CONFIG_ITEM_MODULE_LIST:
1596 case CONFIG_ITEM_MODULE_LIST_CAT:
1597 case CONFIG_ITEM_FONT:
1598 case CONFIG_ITEM_PASSWORD:
1599 print_help_section( p_section, b_color, b_description );
1601 psz_bra = OPTION_VALUE_SEP "<";
1602 psz_type = _("string");
1605 if( p_item->ppsz_list )
1607 psz_bra = OPTION_VALUE_SEP "{";
1608 psz_type = psz_buffer;
1609 psz_buffer[0] = '\0';
1610 for( i = 0; p_item->ppsz_list[i]; i++ )
1612 if( i ) strcat( psz_buffer, "," );
1613 strcat( psz_buffer, p_item->ppsz_list[i] );
1618 case CONFIG_ITEM_INTEGER:
1619 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1620 print_help_section( p_section, b_color, b_description );
1622 psz_bra = OPTION_VALUE_SEP "<";
1623 psz_type = _("integer");
1626 if( p_item->min.i || p_item->max.i )
1628 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1629 p_item->min.i, p_item->max.i );
1630 psz_type = psz_buffer;
1633 if( p_item->i_list )
1635 psz_bra = OPTION_VALUE_SEP "{";
1636 psz_type = psz_buffer;
1637 psz_buffer[0] = '\0';
1638 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1640 if( i ) strcat( psz_buffer, ", " );
1641 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1643 p_item->ppsz_list_text[i] );
1648 case CONFIG_ITEM_FLOAT:
1649 print_help_section( p_section, b_color, b_description );
1651 psz_bra = OPTION_VALUE_SEP "<";
1652 psz_type = _("float");
1654 if( p_item->min.f || p_item->max.f )
1656 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1657 p_item->min.f, p_item->max.f );
1658 psz_type = psz_buffer;
1661 case CONFIG_ITEM_BOOL:
1662 print_help_section( p_section, b_color, b_description );
1664 psz_bra = ""; psz_type = ""; psz_ket = "";
1665 if( !b_help_module )
1667 psz_suf = p_item->value.i ? _(" (default enabled)") :
1668 _(" (default disabled)");
1678 /* Add short option if any */
1679 if( p_item->i_short )
1681 sprintf( psz_short, "-%c,", p_item->i_short );
1685 strcpy( psz_short, " " );
1688 i = PADDING_SPACES - strlen( p_item->psz_name )
1689 - strlen( psz_bra ) - strlen( psz_type )
1690 - strlen( psz_ket ) - 1;
1692 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1694 psz_prefix = ", --no-";
1695 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1700 psz_spaces[0] = '\n';
1705 psz_spaces[i] = '\0';
1708 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1710 utf8_fprintf( stdout, psz_format_bool, psz_short,
1711 p_item->psz_name, psz_prefix, p_item->psz_name,
1712 psz_bra, psz_type, psz_ket, psz_spaces );
1716 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1717 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1720 psz_spaces[i] = ' ';
1722 /* We wrap the rest of the output */
1723 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1724 b_description_hack = b_description;
1727 psz_text = psz_buffer;
1728 i_cur_width = b_description && !b_description_hack
1729 ? i_width_description
1733 char *psz_parser, *psz_word;
1734 size_t i_end = strlen( psz_text );
1736 /* If the remaining text fits in a line, print it. */
1737 if( i_end <= i_cur_width )
1741 if( !b_description || b_description_hack )
1742 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1744 utf8_fprintf( stdout, "%s\n", psz_text );
1748 utf8_fprintf( stdout, "%s\n", psz_text );
1753 /* Otherwise, eat as many words as possible */
1754 psz_parser = psz_text;
1757 psz_word = psz_parser;
1758 psz_parser = strchr( psz_word, ' ' );
1759 /* If no space was found, we reached the end of the text
1760 * block; otherwise, we skip the space we just found. */
1761 psz_parser = psz_parser ? psz_parser + 1
1764 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1766 /* We cut a word in one of these cases:
1767 * - it's the only word in the line and it's too long.
1768 * - we used less than 80% of the width and the word we are
1769 * going to wrap is longer than 40% of the width, and even
1770 * if the word would have fit in the next line. */
1771 if( psz_word == psz_text
1772 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1773 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1775 char c = psz_text[i_cur_width];
1776 psz_text[i_cur_width] = '\0';
1779 if( !b_description || b_description_hack )
1780 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1781 psz_text, psz_spaces );
1783 utf8_fprintf( stdout, "%s\n%s",
1784 psz_text, psz_spaces );
1788 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1790 psz_text += i_cur_width;
1795 psz_word[-1] = '\0';
1798 if( !b_description || b_description_hack )
1799 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1800 psz_text, psz_spaces );
1802 utf8_fprintf( stdout, "%s\n%s",
1803 psz_text, psz_spaces );
1807 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1809 psz_text = psz_word;
1813 if( b_description_hack && p_item->psz_longtext )
1815 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1816 b_description_hack = false;
1817 psz_spaces = psz_spaces_longtext;
1818 utf8_fprintf( stdout, "%s", psz_spaces );
1824 if( b_has_advanced )
1827 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1828 _( "add --advanced to your command line to see advanced options."));
1830 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1831 _( "add --advanced to your command line to see advanced options."));
1834 if( i_only_advanced > 0 )
1838 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1839 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1843 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1844 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1850 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1851 _( "No matching module found. Use --list or" \
1852 "--list-verbose to list available modules." ) );
1854 utf8_fprintf( stdout, "\n%s\n",
1855 _( "No matching module found. Use --list or" \
1856 "--list-verbose to list available modules." ) );
1859 /* Release the module list */
1860 module_list_free (list);
1863 /*****************************************************************************
1864 * ListModules: list the available modules with their description
1865 *****************************************************************************
1866 * Print a list of all available modules (builtins and plugins) and a short
1867 * description for each one.
1868 *****************************************************************************/
1869 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1872 char psz_spaces[22];
1874 bool b_color = config_GetInt( p_this, "color" ) > 0;
1876 memset( psz_spaces, ' ', 22 );
1879 ShowConsole( true );
1882 /* List all modules */
1883 module_t **list = module_list_get (NULL);
1885 /* Enumerate each module */
1886 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1890 /* Nasty hack, but right now I'm too tired to think about a nice
1892 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1897 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1898 p_parser->psz_object_name,
1900 p_parser->psz_longname );
1902 utf8_fprintf( stdout, " %s%s %s\n",
1903 p_parser->psz_object_name,
1904 psz_spaces, p_parser->psz_longname );
1908 char *const *pp_shortcut = p_parser->pp_shortcuts;
1909 while( *pp_shortcut )
1911 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1914 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1917 utf8_fprintf( stdout, " s %s\n",
1922 if( p_parser->psz_capability )
1925 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1926 p_parser->psz_capability,
1927 p_parser->i_score );
1929 utf8_fprintf( stdout, " c %s (%d)\n",
1930 p_parser->psz_capability,
1931 p_parser->i_score );
1935 psz_spaces[i] = ' ';
1937 module_list_free (list);
1939 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1944 /*****************************************************************************
1945 * Version: print complete program version
1946 *****************************************************************************
1947 * Print complete program version and build number.
1948 *****************************************************************************/
1949 static void Version( void )
1952 ShowConsole( true );
1955 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1956 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1957 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1958 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1959 if( strcmp( VLC_Changeset(), "exported" ) )
1960 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1962 utf8_fprintf( stdout, LICENSE_MSG );
1964 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1969 /*****************************************************************************
1970 * ShowConsole: On Win32, create an output console for debug messages
1971 *****************************************************************************
1972 * This function is useful only on Win32.
1973 *****************************************************************************/
1975 static void ShowConsole( bool b_dofile )
1978 FILE *f_help = NULL;
1980 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1983 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1984 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1985 * page (e.g. CP437 or CP850). */
1986 SetConsoleOutputCP (GetACP ());
1987 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1989 freopen( "CONOUT$", "w", stderr );
1990 freopen( "CONIN$", "r", stdin );
1992 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1995 freopen( "vlc-help.txt", "wt", stdout );
1996 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1998 else freopen( "CONOUT$", "w", stdout );
2004 /*****************************************************************************
2005 * PauseConsole: On Win32, wait for a key press before closing the console
2006 *****************************************************************************
2007 * This function is useful only on Win32.
2008 *****************************************************************************/
2010 static void PauseConsole( void )
2014 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2016 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2024 /*****************************************************************************
2025 * ConsoleWidth: Return the console width in characters
2026 *****************************************************************************
2027 * We use the stty shell command to get the console width; if this fails or
2028 * if the width is less than 80, we default to 80.
2029 *****************************************************************************/
2030 static int ConsoleWidth( void )
2032 unsigned i_width = 80;
2035 FILE *file = popen( "stty size 2>/dev/null", "r" );
2038 if (fscanf (file, "%*u %u", &i_width) <= 0)
2042 #elif !defined (UNDER_CE)
2043 CONSOLE_SCREEN_BUFFER_INFO buf;
2045 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2046 i_width = buf.dwSize.X;
2052 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2053 vlc_value_t old_val, vlc_value_t new_val, void *param)
2055 libvlc_int_t *p_libvlc = (libvlc_int_t *)p_this;
2060 if( new_val.i_int >= -1 )
2062 libvlc_priv (p_libvlc)->i_verbose = __MIN( new_val.i_int, 2 );
2067 /*****************************************************************************
2068 * InitDeviceValues: initialize device values
2069 *****************************************************************************
2070 * This function inits the dvd, vcd and cd-audio values
2071 *****************************************************************************/
2072 static void InitDeviceValues( libvlc_int_t *p_vlc )
2075 LibHalContext * ctx = NULL;
2077 char **devices = NULL;
2078 char *block_dev = NULL;
2081 DBusConnection *p_connection = NULL;
2084 ctx = libhal_ctx_new();
2086 dbus_error_init( &error );
2087 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2088 if( dbus_error_is_set( &error ) || !p_connection )
2090 libhal_ctx_free( ctx );
2091 dbus_error_free( &error );
2094 libhal_ctx_set_dbus_connection( ctx, p_connection );
2095 if( libhal_ctx_init( ctx, &error ) )
2097 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2099 for( i = 0; i < i_devices; i++ )
2101 if( !libhal_device_property_exists( ctx, devices[i],
2102 "storage.cdrom.dvd", NULL ) )
2106 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2107 "storage.cdrom.dvd", NULL );
2108 block_dev = libhal_device_get_property_string( ctx,
2109 devices[ i ], "block.device" , NULL );
2112 config_PutPsz( p_vlc, "dvd", block_dev );
2115 config_PutPsz( p_vlc, "vcd", block_dev );
2116 config_PutPsz( p_vlc, "cd-audio", block_dev );
2117 libhal_free_string( block_dev );
2119 libhal_free_string_array( devices );
2121 libhal_ctx_shutdown( ctx, NULL );
2122 dbus_connection_unref( p_connection );
2123 libhal_ctx_free( ctx );
2127 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2131 #endif /* HAVE_HAL */