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"
46 #include <stdio.h> /* sprintf() */
48 #include <stdlib.h> /* free() */
51 # include <netinet/in.h> /* BSD: struct in_addr */
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
60 #include "config/vlc_getopt.h"
67 /* used for one-instance mode */
68 # include <dbus/dbus.h>
72 #include <vlc_media_library.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
83 #include <vlc_atomic.h>
84 #include <vlc_modules.h>
88 #include "playlist/playlist_internal.h"
93 # include <libkern/OSAtomic.h>
98 /*****************************************************************************
99 * The evil global variables. We handle them with care, don't worry.
100 *****************************************************************************/
101 static unsigned i_instances
= 0;
104 static bool b_daemon
= false;
112 * Atomically set the reference count to 1.
113 * @param p_gc reference counted object
114 * @param pf_destruct destruction calback
117 void *vlc_gc_init (gc_object_t
*p_gc
, void (*pf_destruct
) (gc_object_t
*))
119 /* There is no point in using the GC if there is no destructor... */
120 assert (pf_destruct
);
121 p_gc
->pf_destructor
= pf_destruct
;
123 vlc_atomic_set (&p_gc
->refs
, 1);
128 * Atomically increment the reference count.
129 * @param p_gc reference counted object
132 void *vlc_hold (gc_object_t
* p_gc
)
137 refs
= vlc_atomic_inc (&p_gc
->refs
);
138 assert (refs
!= 1); /* there had to be a reference already */
143 * Atomically decrement the reference count and, if it reaches zero, destroy.
144 * @param p_gc reference counted object.
146 void vlc_release (gc_object_t
*p_gc
)
151 refs
= vlc_atomic_dec (&p_gc
->refs
);
152 assert (refs
!= (uintptr_t)(-1)); /* reference underflow?! */
154 p_gc
->pf_destructor (p_gc
);
157 /*****************************************************************************
159 *****************************************************************************/
160 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
161 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
162 static void SetLanguage ( char const * );
164 static void GetFilenames ( libvlc_int_t
*, unsigned, const char *const [] );
165 static void Help ( libvlc_int_t
*, char const *psz_help_name
);
166 static void Usage ( libvlc_int_t
*, char const *psz_search
);
167 static void ListModules ( libvlc_int_t
*, bool );
168 static void Version ( void );
171 static void ShowConsole ( bool );
172 static void PauseConsole ( void );
174 static int ConsoleWidth ( void );
176 static vlc_mutex_t global_lock
= VLC_STATIC_MUTEX
;
177 extern const char psz_vlc_changeset
[];
180 * Allocate a libvlc instance, initialize global data if needed
181 * It also initializes the threading system
183 libvlc_int_t
* libvlc_InternalCreate( void )
185 libvlc_int_t
*p_libvlc
;
187 char *psz_env
= NULL
;
189 /* Now that the thread system is initialized, we don't have much, but
190 * at least we have variables */
191 vlc_mutex_lock( &global_lock
);
192 if( i_instances
== 0 )
194 /* Guess what CPU we have */
195 cpu_flags
= CPUCapabilities();
196 /* The module bank will be initialized later */
199 /* Allocate a libvlc instance object */
200 p_libvlc
= vlc_custom_create( (vlc_object_t
*)NULL
, sizeof (*priv
),
201 VLC_OBJECT_GENERIC
, "libvlc" );
202 if( p_libvlc
!= NULL
)
204 vlc_mutex_unlock( &global_lock
);
206 if( p_libvlc
== NULL
)
209 priv
= libvlc_priv (p_libvlc
);
210 priv
->p_playlist
= NULL
;
212 priv
->p_dialog_provider
= NULL
;
215 /* Initialize message queue */
216 priv
->msg_bank
= msg_Create ();
217 if (unlikely(priv
->msg_bank
== NULL
))
220 /* Find verbosity from VLC_VERBOSE environment variable */
221 psz_env
= getenv( "VLC_VERBOSE" );
222 if( psz_env
!= NULL
)
223 priv
->i_verbose
= atoi( psz_env
);
226 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
227 priv
->b_color
= isatty( 2 ); /* 2 is for stderr */
229 priv
->b_color
= false;
232 /* Initialize mutexes */
233 vlc_mutex_init( &priv
->ml_lock
);
234 vlc_mutex_init( &priv
->timer_lock
);
235 vlc_ExitInit( &priv
->exit
);
239 vlc_object_release (p_libvlc
);
244 * Initialize a libvlc instance
245 * This function initializes a previously allocated libvlc instance:
247 * - gettext initialization
248 * - message queue, module bank and playlist initialization
249 * - configuration and commandline parsing
251 int libvlc_InternalInit( libvlc_int_t
*p_libvlc
, int i_argc
,
252 const char *ppsz_argv
[] )
254 libvlc_priv_t
*priv
= libvlc_priv (p_libvlc
);
256 char * psz_modules
= NULL
;
257 char * psz_parser
= NULL
;
258 char * psz_control
= NULL
;
260 int i_ret
= VLC_EEXIT
;
261 playlist_t
*p_playlist
= NULL
;
263 #if defined( ENABLE_NLS ) \
264 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
265 # if defined (WIN32) || defined (__APPLE__)
270 /* System specific initialization code */
274 * Support for gettext
276 vlc_bindtextdomain (PACKAGE_NAME
);
278 /* Initialize the module bank and load the configuration of the
279 * main module. We need to do this at this stage to be able to display
280 * a short help if required by the user. (short help == main module
282 module_InitBank( p_libvlc
);
284 if( config_LoadCmdLine( p_libvlc
, i_argc
, ppsz_argv
, NULL
) )
286 module_EndBank( p_libvlc
, false );
290 priv
->i_verbose
= var_InheritInteger( p_libvlc
, "verbose" );
291 /* Announce who we are - Do it only for first instance ? */
292 msg_Dbg( p_libvlc
, "VLC media player - %s", VERSION_MESSAGE
);
293 msg_Dbg( p_libvlc
, "%s", COPYRIGHT_MESSAGE
);
294 msg_Dbg( p_libvlc
, "revision %s", psz_vlc_changeset
);
295 msg_Dbg( p_libvlc
, "configured with %s", CONFIGURE_LINE
);
296 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
297 msg_Dbg( p_libvlc
, "translation test: code is \"%s\"", _("C") );
299 /* Check for short help option */
300 if( var_InheritBool( p_libvlc
, "help" ) )
302 Help( p_libvlc
, "help" );
304 i_ret
= VLC_EEXITSUCCESS
;
306 /* Check for version option */
307 else if( var_InheritBool( p_libvlc
, "version" ) )
311 i_ret
= VLC_EEXITSUCCESS
;
314 /* Check for daemon mode */
315 #if !defined( WIN32 ) && !defined( __SYMBIAN32__ )
316 if( var_InheritBool( p_libvlc
, "daemon" ) )
319 char *psz_pidfile
= NULL
;
321 if( daemon( 1, 0) != 0 )
323 msg_Err( p_libvlc
, "Unable to fork vlc to daemon mode" );
328 /* lets check if we need to write the pidfile */
329 psz_pidfile
= var_CreateGetNonEmptyString( p_libvlc
, "pidfile" );
330 if( psz_pidfile
!= NULL
)
333 pid_t i_pid
= getpid ();
334 msg_Dbg( p_libvlc
, "PID is %d, writing it to %s",
335 i_pid
, psz_pidfile
);
336 pidfile
= vlc_fopen( psz_pidfile
,"w" );
337 if( pidfile
!= NULL
)
339 utf8_fprintf( pidfile
, "%d", (int)i_pid
);
344 msg_Err( p_libvlc
, "cannot open pid file for writing: %s (%m)",
353 if( ( i_pid
= fork() ) < 0 )
355 msg_Err( p_libvlc
, "unable to fork vlc to daemon mode" );
360 /* This is the parent, exit right now */
361 msg_Dbg( p_libvlc
, "closing parent process" );
363 i_ret
= VLC_EEXITSUCCESS
;
367 /* We are the child */
368 msg_Dbg( p_libvlc
, "daemon spawned" );
369 close( STDIN_FILENO
);
370 close( STDOUT_FILENO
);
371 close( STDERR_FILENO
);
381 module_EndBank( p_libvlc
, false );
385 /* Check for translation config option */
386 #if defined( ENABLE_NLS ) \
387 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
388 # if defined (WIN32) || defined (__APPLE__)
389 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
390 config_LoadConfigFile( p_libvlc
);
391 priv
->i_verbose
= var_InheritInteger( p_libvlc
, "verbose" );
393 /* Check if the user specified a custom language */
394 psz_language
= var_CreateGetNonEmptyString( p_libvlc
, "language" );
395 if( psz_language
&& strcmp( psz_language
, "auto" ) )
397 /* Reset the default domain */
398 SetLanguage( psz_language
);
400 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
401 msg_Dbg( p_libvlc
, "translation test: code is \"%s\"", _("C") );
403 free( psz_language
);
408 * Load the builtins and plugins into the module_bank.
409 * We have to do it before config_Load*() because this also gets the
410 * list of configuration options exported by each module and loads their
413 module_LoadPlugins( p_libvlc
);
414 if( p_libvlc
->b_die
)
420 module_t
**list
= module_list_get( &module_count
);
421 module_list_free( list
);
422 msg_Dbg( p_libvlc
, "module bank initialized (%zu modules)", module_count
);
424 /* Check for help on modules */
425 if( (p_tmp
= var_InheritString( p_libvlc
, "module" )) )
427 Help( p_libvlc
, p_tmp
);
430 i_ret
= VLC_EEXITSUCCESS
;
432 /* Check for full help option */
433 else if( var_InheritBool( p_libvlc
, "full-help" ) )
435 var_Create( p_libvlc
, "advanced", VLC_VAR_BOOL
);
436 var_SetBool( p_libvlc
, "advanced", true );
437 var_Create( p_libvlc
, "help-verbose", VLC_VAR_BOOL
);
438 var_SetBool( p_libvlc
, "help-verbose", true );
439 Help( p_libvlc
, "full-help" );
441 i_ret
= VLC_EEXITSUCCESS
;
443 /* Check for long help option */
444 else if( var_InheritBool( p_libvlc
, "longhelp" ) )
446 Help( p_libvlc
, "longhelp" );
448 i_ret
= VLC_EEXITSUCCESS
;
450 /* Check for module list option */
451 else if( var_InheritBool( p_libvlc
, "list" ) )
453 ListModules( p_libvlc
, false );
455 i_ret
= VLC_EEXITSUCCESS
;
457 else if( var_InheritBool( p_libvlc
, "list-verbose" ) )
459 ListModules( p_libvlc
, true );
461 i_ret
= VLC_EEXITSUCCESS
;
464 if( module_count
<= 1 )
466 msg_Err( p_libvlc
, "No plugins found! Check your VLC installation.");
473 module_EndBank( p_libvlc
, true );
478 * Override default configuration with config file settings
480 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
482 if( var_InheritBool( p_libvlc
, "reset-config" ) )
484 config_ResetAll( p_libvlc
);
485 config_SaveConfigFile( p_libvlc
);
488 config_LoadConfigFile( p_libvlc
);
492 * Override configuration with command line settings
495 if( config_LoadCmdLine( p_libvlc
, i_argc
, ppsz_argv
, &vlc_optind
) )
498 ShowConsole( false );
499 /* Pause the console because it's destroyed when we exit */
500 fprintf( stderr
, "The command line options couldn't be loaded, check "
501 "that they are valid.\n" );
504 module_EndBank( p_libvlc
, true );
507 priv
->i_verbose
= var_InheritInteger( p_libvlc
, "verbose" );
509 /* FIXME: could be replaced by using Unix sockets */
511 dbus_threads_init_default();
513 if( var_InheritBool( p_libvlc
, "one-instance" )
514 || ( var_InheritBool( p_libvlc
, "one-instance-when-started-from-file" )
515 && var_InheritBool( p_libvlc
, "started-from-file" ) ) )
517 /* Initialise D-Bus interface, check for other instances */
518 DBusConnection
*p_conn
= NULL
;
519 DBusError dbus_error
;
521 dbus_error_init( &dbus_error
);
523 /* connect to the session bus */
524 p_conn
= dbus_bus_get( DBUS_BUS_SESSION
, &dbus_error
);
527 msg_Err( p_libvlc
, "Failed to connect to D-Bus session daemon: %s",
528 dbus_error
.message
);
529 dbus_error_free( &dbus_error
);
533 /* check if VLC is available on the bus
534 * if not: D-Bus control is not enabled on the other
535 * instance and we can't pass MRLs to it */
536 DBusMessage
*p_test_msg
= NULL
;
537 DBusMessage
*p_test_reply
= NULL
;
539 p_test_msg
= dbus_message_new_method_call(
540 "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
541 "org.freedesktop.DBus.Introspectable", "Introspect" );
543 /* block until a reply arrives */
544 p_test_reply
= dbus_connection_send_with_reply_and_block(
545 p_conn
, p_test_msg
, -1, &dbus_error
);
546 dbus_message_unref( p_test_msg
);
547 if( p_test_reply
== NULL
)
549 dbus_error_free( &dbus_error
);
550 msg_Dbg( p_libvlc
, "No Media Player is running. "
551 "Continuing normally." );
556 DBusMessage
* p_dbus_msg
= NULL
;
557 DBusMessageIter dbus_args
;
558 DBusPendingCall
* p_dbus_pending
= NULL
;
561 dbus_message_unref( p_test_reply
);
562 msg_Warn( p_libvlc
, "Another Media Player is running. Exiting");
564 for( i_input
= vlc_optind
; i_input
< i_argc
;i_input
++ )
566 /* Skip input options, we can't pass them through D-Bus */
567 if( ppsz_argv
[i_input
][0] == ':' )
569 msg_Warn( p_libvlc
, "Ignoring option %s",
570 ppsz_argv
[i_input
] );
574 /* We need to resolve relative paths in this instance */
575 char *psz_mrl
= make_URI( ppsz_argv
[i_input
], NULL
);
576 const char *psz_after_track
= "/";
578 if( psz_mrl
== NULL
)
580 msg_Dbg( p_libvlc
, "Adds %s to the running Media Player",
583 p_dbus_msg
= dbus_message_new_method_call(
584 "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
585 "org.mpris.MediaPlayer2.TrackList", "AddTrack" );
587 if ( NULL
== p_dbus_msg
)
589 msg_Err( p_libvlc
, "D-Bus problem" );
591 system_End( p_libvlc
);
596 dbus_message_iter_init_append( p_dbus_msg
, &dbus_args
);
597 if ( !dbus_message_iter_append_basic( &dbus_args
,
598 DBUS_TYPE_STRING
, &psz_mrl
) )
600 dbus_message_unref( p_dbus_msg
);
602 system_End( p_libvlc
);
607 if( !dbus_message_iter_append_basic( &dbus_args
,
608 DBUS_TYPE_OBJECT_PATH
, &psz_after_track
) )
610 dbus_message_unref( p_dbus_msg
);
611 system_End( p_libvlc
);
616 if( var_InheritBool( p_libvlc
, "playlist-enqueue" ) )
619 if ( !dbus_message_iter_append_basic( &dbus_args
,
620 DBUS_TYPE_BOOLEAN
, &b_play
) )
622 dbus_message_unref( p_dbus_msg
);
623 system_End( p_libvlc
);
627 /* send message and get a handle for a reply */
628 if ( !dbus_connection_send_with_reply ( p_conn
,
629 p_dbus_msg
, &p_dbus_pending
, -1 ) )
631 msg_Err( p_libvlc
, "D-Bus problem" );
632 dbus_message_unref( p_dbus_msg
);
633 system_End( p_libvlc
);
637 if ( NULL
== p_dbus_pending
)
639 msg_Err( p_libvlc
, "D-Bus problem" );
640 dbus_message_unref( p_dbus_msg
);
641 system_End( p_libvlc
);
644 dbus_connection_flush( p_conn
);
645 dbus_message_unref( p_dbus_msg
);
646 /* block until we receive a reply */
647 dbus_pending_call_block( p_dbus_pending
);
648 dbus_pending_call_unref( p_dbus_pending
);
649 } /* processes all command line MRLs */
652 system_End( p_libvlc
);
656 /* we unreference the connection when we've finished with it */
657 if( p_conn
) dbus_connection_unref( p_conn
);
662 * Message queue options
664 char * psz_verbose_objects
= var_CreateGetNonEmptyString( p_libvlc
, "verbose-objects" );
665 if( psz_verbose_objects
)
667 char * psz_object
, * iter
= psz_verbose_objects
;
668 while( (psz_object
= strsep( &iter
, "," )) )
670 switch( psz_object
[0] )
672 printf("%s\n", psz_object
+1);
673 case '+': msg_EnableObjectPrinting(p_libvlc
, psz_object
+1); break;
674 case '-': msg_DisableObjectPrinting(p_libvlc
, psz_object
+1); break;
676 msg_Err( p_libvlc
, "verbose-objects usage: \n"
677 "--verbose-objects=+printthatobject,"
678 "-dontprintthatone\n"
679 "(keyword 'all' to applies to all objects)");
680 free( psz_verbose_objects
);
681 /* FIXME: leaks!!!! */
685 free( psz_verbose_objects
);
688 /* Last chance to set the verbosity. Once we start interfaces and other
689 * threads, verbosity becomes read-only. */
690 var_Create( p_libvlc
, "verbose", VLC_VAR_INTEGER
| VLC_VAR_DOINHERIT
);
691 if( var_InheritBool( p_libvlc
, "quiet" ) )
693 var_SetInteger( p_libvlc
, "verbose", -1 );
694 priv
->i_verbose
= -1;
696 vlc_threads_setup( p_libvlc
);
699 priv
->b_color
= var_InheritBool( p_libvlc
, "color" );
701 char p_capabilities
[200];
702 #define PRINT_CAPABILITY( capability, string ) \
703 if( vlc_CPU() & capability ) \
705 strncat( p_capabilities, string " ", \
706 sizeof(p_capabilities) - strlen(p_capabilities) ); \
707 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
709 p_capabilities
[0] = '\0';
711 #if defined( __i386__ ) || defined( __x86_64__ )
712 if( !var_InheritBool( p_libvlc
, "mmx" ) )
713 cpu_flags
&= ~CPU_CAPABILITY_MMX
;
714 if( !var_InheritBool( p_libvlc
, "3dn" ) )
715 cpu_flags
&= ~CPU_CAPABILITY_3DNOW
;
716 if( !var_InheritBool( p_libvlc
, "mmxext" ) )
717 cpu_flags
&= ~CPU_CAPABILITY_MMXEXT
;
718 if( !var_InheritBool( p_libvlc
, "sse" ) )
719 cpu_flags
&= ~CPU_CAPABILITY_SSE
;
720 if( !var_InheritBool( p_libvlc
, "sse2" ) )
721 cpu_flags
&= ~CPU_CAPABILITY_SSE2
;
722 if( !var_InheritBool( p_libvlc
, "sse3" ) )
723 cpu_flags
&= ~CPU_CAPABILITY_SSE3
;
724 if( !var_InheritBool( p_libvlc
, "ssse3" ) )
725 cpu_flags
&= ~CPU_CAPABILITY_SSSE3
;
726 if( !var_InheritBool( p_libvlc
, "sse41" ) )
727 cpu_flags
&= ~CPU_CAPABILITY_SSE4_1
;
728 if( !var_InheritBool( p_libvlc
, "sse42" ) )
729 cpu_flags
&= ~CPU_CAPABILITY_SSE4_2
;
731 PRINT_CAPABILITY( CPU_CAPABILITY_MMX
, "MMX" );
732 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW
, "3DNow!" );
733 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT
, "MMXEXT" );
734 PRINT_CAPABILITY( CPU_CAPABILITY_SSE
, "SSE" );
735 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2
, "SSE2" );
736 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3
, "SSE3" );
737 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3
, "SSSE3" );
738 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1
, "SSE4.1" );
739 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2
, "SSE4.2" );
740 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A
, "SSE4A" );
742 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
743 if( !var_InheritBool( p_libvlc
, "altivec" ) )
744 cpu_flags
&= ~CPU_CAPABILITY_ALTIVEC
;
746 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC
, "AltiVec" );
748 #elif defined( __arm__ )
749 PRINT_CAPABILITY( CPU_CAPABILITY_NEON
, "NEONv1" );
754 strncat( p_capabilities
, "FPU ",
755 sizeof(p_capabilities
) - strlen( p_capabilities
) );
756 p_capabilities
[sizeof(p_capabilities
) - 1] = '\0';
759 if (p_capabilities
[0])
760 msg_Dbg( p_libvlc
, "CPU has capabilities %s", p_capabilities
);
763 * Choose the best memcpy module
765 priv
->p_memcpy_module
= module_need( p_libvlc
, "memcpy", "$memcpy", false );
766 /* Avoid being called "memcpy":*/
767 vlc_object_set_name( p_libvlc
, "main" );
769 priv
->b_stats
= var_InheritBool( p_libvlc
, "stats" );
771 priv
->pp_timers
= NULL
;
773 priv
->i_last_input_id
= 0; /* Not very safe, should be removed */
776 * Initialize hotkey handling
778 priv
->actions
= vlc_InitActions( p_libvlc
);
780 /* Create a variable for showing the fullscreen interface */
781 var_Create( p_libvlc
, "intf-show", VLC_VAR_BOOL
);
782 var_SetBool( p_libvlc
, "intf-show", true );
784 /* Create a variable for showing the right click menu */
785 var_Create( p_libvlc
, "intf-popupmenu", VLC_VAR_BOOL
);
787 /* variables for signalling creation of new files */
788 var_Create( p_libvlc
, "snapshot-file", VLC_VAR_STRING
);
789 var_Create( p_libvlc
, "record-file", VLC_VAR_STRING
);
791 /* some default internal settings */
792 var_Create( p_libvlc
, "window", VLC_VAR_STRING
);
793 var_Create( p_libvlc
, "user-agent", VLC_VAR_STRING
);
794 var_SetString( p_libvlc
, "user-agent", "(LibVLC "VERSION
")" );
796 /* Initialize playlist and get commandline files */
797 p_playlist
= playlist_Create( VLC_OBJECT(p_libvlc
) );
800 msg_Err( p_libvlc
, "playlist initialization failed" );
801 if( priv
->p_memcpy_module
!= NULL
)
803 module_unneed( p_libvlc
, priv
->p_memcpy_module
);
805 module_EndBank( p_libvlc
, true );
809 /* System specific configuration */
810 system_Configure( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
812 #if defined(MEDIA_LIBRARY)
814 if( var_GetBool( p_libvlc
, "load-media-library-on-startup" ) )
816 priv
->p_ml
= ml_Create( VLC_OBJECT( p_libvlc
), NULL
);
819 msg_Err( p_libvlc
, "ML initialization failed" );
829 /* Add service discovery modules */
830 psz_modules
= var_InheritString( p_libvlc
, "services-discovery" );
833 char *p
= psz_modules
, *m
;
834 while( ( m
= strsep( &p
, " :," ) ) != NULL
)
835 playlist_ServicesDiscoveryAdd( p_playlist
, m
);
840 /* Initialize VLM if vlm-conf is specified */
841 psz_parser
= var_CreateGetNonEmptyString( p_libvlc
, "vlm-conf" );
844 priv
->p_vlm
= vlm_New( p_libvlc
);
846 msg_Err( p_libvlc
, "VLM initialization failed" );
852 * Load background interfaces
854 psz_modules
= var_CreateGetNonEmptyString( p_libvlc
, "extraintf" );
855 psz_control
= var_CreateGetNonEmptyString( p_libvlc
, "control" );
857 if( psz_modules
&& psz_control
)
860 if( asprintf( &psz_tmp
, "%s:%s", psz_modules
, psz_control
) != -1 )
863 psz_modules
= psz_tmp
;
866 else if( psz_control
)
869 psz_modules
= strdup( psz_control
);
872 psz_parser
= psz_modules
;
873 while ( psz_parser
&& *psz_parser
)
875 char *psz_module
, *psz_temp
;
876 psz_module
= psz_parser
;
877 psz_parser
= strchr( psz_module
, ':' );
883 if( asprintf( &psz_temp
, "%s,none", psz_module
) != -1)
885 intf_Create( p_libvlc
, psz_temp
);
893 * Always load the hotkeys interface if it exists
895 intf_Create( p_libvlc
, "hotkeys,none" );
898 /* loads dbus control interface if in one-instance mode
899 * we do it only when playlist exists, because dbus module needs it */
900 if( var_InheritBool( p_libvlc
, "one-instance" )
901 || ( var_InheritBool( p_libvlc
, "one-instance-when-started-from-file" )
902 && var_InheritBool( p_libvlc
, "started-from-file" ) ) )
903 intf_Create( p_libvlc
, "dbus,none" );
905 # if !defined (HAVE_MAEMO)
906 /* Prevents the power management daemon from suspending the system
907 * when VLC is active */
908 if( var_InheritBool( p_libvlc
, "inhibit" ) > 0 )
909 intf_Create( p_libvlc
, "inhibit,none" );
913 if( var_InheritBool( p_libvlc
, "file-logging" ) &&
914 !var_InheritBool( p_libvlc
, "syslog" ) )
916 intf_Create( p_libvlc
, "logger,none" );
919 if( var_InheritBool( p_libvlc
, "syslog" ) )
921 char *logmode
= var_CreateGetNonEmptyString( p_libvlc
, "logmode" );
922 var_SetString( p_libvlc
, "logmode", "syslog" );
923 intf_Create( p_libvlc
, "logger,none" );
927 var_SetString( p_libvlc
, "logmode", logmode
);
930 var_Destroy( p_libvlc
, "logmode" );
934 if( var_InheritBool( p_libvlc
, "network-synchronisation") )
936 intf_Create( p_libvlc
, "netsync,none" );
940 var_Create( p_libvlc
, "drawable-view-top", VLC_VAR_INTEGER
);
941 var_Create( p_libvlc
, "drawable-view-left", VLC_VAR_INTEGER
);
942 var_Create( p_libvlc
, "drawable-view-bottom", VLC_VAR_INTEGER
);
943 var_Create( p_libvlc
, "drawable-view-right", VLC_VAR_INTEGER
);
944 var_Create( p_libvlc
, "drawable-clip-top", VLC_VAR_INTEGER
);
945 var_Create( p_libvlc
, "drawable-clip-left", VLC_VAR_INTEGER
);
946 var_Create( p_libvlc
, "drawable-clip-bottom", VLC_VAR_INTEGER
);
947 var_Create( p_libvlc
, "drawable-clip-right", VLC_VAR_INTEGER
);
948 var_Create( p_libvlc
, "drawable-nsobject", VLC_VAR_ADDRESS
);
951 var_Create( p_libvlc
, "drawable-hwnd", VLC_VAR_INTEGER
);
955 * Get input filenames given as commandline arguments.
956 * We assume that the remaining parameters are filenames
957 * and their input options.
959 GetFilenames( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
962 * Get --open argument
964 psz_val
= var_InheritString( p_libvlc
, "open" );
965 if ( psz_val
!= NULL
)
967 playlist_AddExt( p_playlist
, psz_val
, NULL
, PLAYLIST_INSERT
, 0,
968 -1, 0, NULL
, 0, true, pl_Unlocked
);
976 * Cleanup a libvlc instance. The instance is not completely deallocated
977 * \param p_libvlc the instance to clean
979 void libvlc_InternalCleanup( libvlc_int_t
*p_libvlc
)
981 libvlc_priv_t
*priv
= libvlc_priv (p_libvlc
);
982 playlist_t
*p_playlist
= libvlc_priv (p_libvlc
)->p_playlist
;
984 /* Deactivate the playlist */
985 msg_Dbg( p_libvlc
, "deactivating the playlist" );
986 pl_Deactivate( p_libvlc
);
988 /* Remove all services discovery */
989 msg_Dbg( p_libvlc
, "removing all services discovery tasks" );
990 playlist_ServicesDiscoveryKillAll( p_playlist
);
992 /* Ask the interfaces to stop and destroy them */
993 msg_Dbg( p_libvlc
, "removing all interfaces" );
994 libvlc_Quit( p_libvlc
);
995 intf_DestroyAll( p_libvlc
);
998 /* Destroy VLM if created in libvlc_InternalInit */
1001 vlm_Delete( priv
->p_vlm
);
1005 #if defined(MEDIA_LIBRARY)
1006 media_library_t
* p_ml
= priv
->p_ml
;
1009 ml_Destroy( VLC_OBJECT( p_ml
) );
1010 vlc_object_release( p_ml
);
1011 libvlc_priv(p_playlist
->p_libvlc
)->p_ml
= NULL
;
1015 /* Free playlist now, all threads are gone */
1016 playlist_Destroy( p_playlist
);
1017 stats_TimersDumpAll( p_libvlc
);
1018 stats_TimersCleanAll( p_libvlc
);
1020 msg_Dbg( p_libvlc
, "removing stats" );
1023 char* psz_pidfile
= NULL
;
1027 psz_pidfile
= var_CreateGetNonEmptyString( p_libvlc
, "pidfile" );
1028 if( psz_pidfile
!= NULL
)
1030 msg_Dbg( p_libvlc
, "removing pid file %s", psz_pidfile
);
1031 if( unlink( psz_pidfile
) == -1 )
1033 msg_Dbg( p_libvlc
, "removing pid file %s: %m",
1037 free( psz_pidfile
);
1041 if( priv
->p_memcpy_module
)
1043 module_unneed( p_libvlc
, priv
->p_memcpy_module
);
1044 priv
->p_memcpy_module
= NULL
;
1047 /* Save the configuration */
1048 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
1049 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc
) );
1051 /* Free module bank. It is refcounted, so we call this each time */
1052 module_EndBank( p_libvlc
, true );
1054 vlc_DeinitActions( p_libvlc
, priv
->actions
);
1058 * Destroy everything.
1059 * This function requests the running threads to finish, waits for their
1060 * termination, and destroys their structure.
1061 * It stops the thread systems: no instance can run after this has run
1062 * \param p_libvlc the instance to destroy
1064 void libvlc_InternalDestroy( libvlc_int_t
*p_libvlc
)
1066 libvlc_priv_t
*priv
= libvlc_priv( p_libvlc
);
1068 vlc_mutex_lock( &global_lock
);
1071 if( i_instances
== 0 )
1073 /* System specific cleaning code */
1074 system_End( p_libvlc
);
1076 vlc_mutex_unlock( &global_lock
);
1078 msg_Destroy (priv
->msg_bank
);
1080 /* Destroy mutexes */
1081 vlc_ExitDestroy( &priv
->exit
);
1082 vlc_mutex_destroy( &priv
->timer_lock
);
1083 vlc_mutex_destroy( &priv
->ml_lock
);
1085 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1086 if( vlc_internals( p_libvlc
)->i_refcount
> 1 )
1087 while( vlc_internals( p_libvlc
)->i_refcount
> 0 )
1088 vlc_object_release( p_libvlc
);
1091 assert( vlc_internals( p_libvlc
)->i_refcount
== 1 );
1092 vlc_object_release( p_libvlc
);
1096 * Add an interface plugin and run it
1098 int libvlc_InternalAddIntf( libvlc_int_t
*p_libvlc
, char const *psz_module
)
1101 return VLC_EGENERIC
;
1103 if( !psz_module
) /* requesting the default interface */
1105 char *psz_interface
= var_CreateGetNonEmptyString( p_libvlc
, "intf" );
1106 if( !psz_interface
) /* "intf" has not been set */
1110 /* Daemon mode hack.
1111 * We prefer the dummy interface if none is specified. */
1112 psz_module
= "dummy";
1115 msg_Info( p_libvlc
, "%s",
1116 _("Running vlc with the default interface. "
1117 "Use 'cvlc' to use vlc without interface.") );
1119 free( psz_interface
);
1120 var_Destroy( p_libvlc
, "intf" );
1123 /* Try to create the interface */
1124 int ret
= intf_Create( p_libvlc
, psz_module
? psz_module
: "$intf" );
1126 msg_Err( p_libvlc
, "interface \"%s\" initialization failed",
1127 psz_module
? psz_module
: "default" );
1131 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1132 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1133 /*****************************************************************************
1134 * SetLanguage: set the interface language.
1135 *****************************************************************************
1136 * We set the LC_MESSAGES locale category for interface messages and buttons,
1137 * as well as the LC_CTYPE category for string sorting and possible wide
1138 * character support.
1139 *****************************************************************************/
1140 static void SetLanguage ( const char *psz_lang
)
1143 /* I need that under Darwin, please check it doesn't disturb
1144 * other platforms. --Meuuh */
1145 setenv( "LANG", psz_lang
, 1 );
1148 /* We set LC_ALL manually because it is the only way to set
1149 * the language at runtime under eg. Windows. Beware that this
1150 * makes the environment unconsistent when libvlc is unloaded and
1151 * should probably be moved to a safer place like vlc.c. */
1152 setenv( "LC_ALL", psz_lang
, 1 );
1156 setlocale( LC_ALL
, psz_lang
);
1160 /*****************************************************************************
1161 * GetFilenames: parse command line options which are not flags
1162 *****************************************************************************
1163 * Parse command line for input files as well as their associated options.
1164 * An option always follows its associated input and begins with a ":".
1165 *****************************************************************************/
1166 static void GetFilenames( libvlc_int_t
*p_vlc
, unsigned n
,
1167 const char *const args
[] )
1171 /* Count the input options */
1172 unsigned i_options
= 0;
1174 while( args
[--n
][0] == ':' )
1179 msg_Warn( p_vlc
, "options %s without item", args
[n
] );
1180 return; /* syntax!? */
1184 char *mrl
= make_URI( args
[n
], NULL
);
1188 playlist_AddExt( pl_Get( p_vlc
), mrl
, NULL
, PLAYLIST_INSERT
,
1189 0, -1, i_options
, ( i_options
? &args
[n
+ 1] : NULL
),
1190 VLC_INPUT_OPTION_TRUSTED
, true, pl_Unlocked
);
1195 /*****************************************************************************
1196 * Help: print program help
1197 *****************************************************************************
1198 * Print a short inline help. Message interface is initialized at this stage.
1199 *****************************************************************************/
1200 static inline void print_help_on_full_help( void )
1202 utf8_fprintf( stdout
, "\n" );
1203 utf8_fprintf( stdout
, "%s\n", _("To get exhaustive help, use '-H'.") );
1206 static const char vlc_usage
[] = N_(
1207 "Usage: %s [options] [stream] ..."
1208 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1209 "\nThe first item specified will be played first."
1212 "\n --option A global option that is set for the duration of the program."
1213 "\n -option A single letter version of a global --option."
1214 "\n :option An option that only applies to the stream directly before it"
1215 "\n and that overrides previous settings."
1217 "\nStream MRL syntax:"
1218 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1220 "\n Many of the global --options can also be used as MRL specific :options."
1221 "\n Multiple :option=value pairs can be specified."
1224 "\n [file://]filename Plain media file"
1225 "\n http://ip:port/file HTTP URL"
1226 "\n ftp://ip:port/file FTP URL"
1227 "\n mms://ip:port/file MMS URL"
1228 "\n screen:// Screen capture"
1229 "\n [dvd://][device][@raw_device] DVD device"
1230 "\n [vcd://][device] VCD device"
1231 "\n [cdda://][device] Audio CD device"
1232 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1233 "\n UDP stream sent by a streaming server"
1234 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1235 "\n vlc://quit Special item to quit VLC"
1238 static void Help( libvlc_int_t
*p_this
, char const *psz_help_name
)
1241 ShowConsole( true );
1244 if( psz_help_name
&& !strcmp( psz_help_name
, "help" ) )
1246 utf8_fprintf( stdout
, vlc_usage
, "vlc" );
1247 Usage( p_this
, "=help" );
1248 Usage( p_this
, "=main" );
1249 print_help_on_full_help();
1251 else if( psz_help_name
&& !strcmp( psz_help_name
, "longhelp" ) )
1253 utf8_fprintf( stdout
, vlc_usage
, "vlc" );
1254 Usage( p_this
, NULL
);
1255 print_help_on_full_help();
1257 else if( psz_help_name
&& !strcmp( psz_help_name
, "full-help" ) )
1259 utf8_fprintf( stdout
, vlc_usage
, "vlc" );
1260 Usage( p_this
, NULL
);
1262 else if( psz_help_name
)
1264 Usage( p_this
, psz_help_name
);
1267 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1273 /*****************************************************************************
1274 * Usage: print module usage
1275 *****************************************************************************
1276 * Print a short inline help. Message interface is initialized at this stage.
1277 *****************************************************************************/
1278 # define COL(x) "\033[" #x ";1m"
1279 # define RED COL(31)
1280 # define GREEN COL(32)
1281 # define YELLOW COL(33)
1282 # define BLUE COL(34)
1283 # define MAGENTA COL(35)
1284 # define CYAN COL(36)
1285 # define WHITE COL(0)
1286 # define GRAY "\033[0m"
1288 print_help_section( const module_t
*m
, const module_config_t
*p_item
,
1289 bool b_color
, bool b_description
)
1291 if( !p_item
) return;
1294 utf8_fprintf( stdout
, RED
" %s:\n"GRAY
,
1295 module_gettext( m
, p_item
->psz_text
) );
1296 if( b_description
&& p_item
->psz_longtext
)
1297 utf8_fprintf( stdout
, MAGENTA
" %s\n"GRAY
,
1298 module_gettext( m
, p_item
->psz_longtext
) );
1302 utf8_fprintf( stdout
, " %s:\n",
1303 module_gettext( m
, p_item
->psz_text
) );
1304 if( b_description
&& p_item
->psz_longtext
)
1305 utf8_fprintf( stdout
, " %s\n",
1306 module_gettext(m
, p_item
->psz_longtext
) );
1310 static void Usage( libvlc_int_t
*p_this
, char const *psz_search
)
1312 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1313 /* short option ------' | | | | | | |
1314 * option name ------------' | | | | | |
1315 * <bra ---------------------' | | | | |
1316 * option type or "" ----------' | | | |
1317 * ket> -------------------------' | | |
1318 * padding spaces -----------------' | |
1319 * comment --------------------------' |
1320 * comment suffix ---------------------'
1322 * The purpose of having bra and ket is that we might i18n them as well.
1325 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1326 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1328 #define LINE_START 8
1329 #define PADDING_SPACES 25
1331 # define OPTION_VALUE_SEP "="
1333 # define OPTION_VALUE_SEP " "
1335 char psz_spaces_text
[PADDING_SPACES
+LINE_START
+1];
1336 char psz_spaces_longtext
[LINE_START
+3];
1337 char psz_format
[sizeof(COLOR_FORMAT_STRING
)];
1338 char psz_format_bool
[sizeof(COLOR_FORMAT_STRING_BOOL
)];
1339 char psz_buffer
[10000];
1341 int i_width
= ConsoleWidth() - (PADDING_SPACES
+LINE_START
+1);
1342 int i_width_description
= i_width
+ PADDING_SPACES
- 1;
1343 bool b_advanced
= var_InheritBool( p_this
, "advanced" );
1344 bool b_description
= var_InheritBool( p_this
, "help-verbose" );
1345 bool b_description_hack
;
1346 bool b_color
= var_InheritBool( p_this
, "color" );
1347 bool b_has_advanced
= false;
1348 bool b_found
= false;
1349 int i_only_advanced
= 0; /* Number of modules ignored because they
1350 * only have advanced options */
1351 bool b_strict
= psz_search
&& *psz_search
== '=';
1352 if( b_strict
) psz_search
++;
1354 memset( psz_spaces_text
, ' ', PADDING_SPACES
+LINE_START
);
1355 psz_spaces_text
[PADDING_SPACES
+LINE_START
] = '\0';
1356 memset( psz_spaces_longtext
, ' ', LINE_START
+2 );
1357 psz_spaces_longtext
[LINE_START
+2] = '\0';
1361 b_color
= false; // don't put color control codes in a .txt file
1365 strcpy( psz_format
, COLOR_FORMAT_STRING
);
1366 strcpy( psz_format_bool
, COLOR_FORMAT_STRING_BOOL
);
1370 strcpy( psz_format
, FORMAT_STRING
);
1371 strcpy( psz_format_bool
, FORMAT_STRING
);
1374 /* List all modules */
1375 module_t
**list
= module_list_get (NULL
);
1379 /* Ugly hack to make sure that the help options always come first
1382 Usage( p_this
, "help" );
1384 /* Enumerate the config for each module */
1385 for (size_t i
= 0; list
[i
]; i
++)
1388 module_t
*p_parser
= list
[i
];
1389 module_config_t
*p_item
= NULL
;
1390 module_config_t
*p_section
= NULL
;
1391 module_config_t
*p_end
= p_parser
->p_config
+ p_parser
->confsize
;
1394 ( b_strict
? strcmp( psz_search
, p_parser
->psz_object_name
)
1395 : !strstr( p_parser
->psz_object_name
, psz_search
) ) )
1397 char *const *pp_shortcuts
= p_parser
->pp_shortcuts
;
1399 for( i
= 0; i
< p_parser
->i_shortcuts
; i
++ )
1401 if( b_strict
? !strcmp( psz_search
, pp_shortcuts
[i
] )
1402 : !!strstr( pp_shortcuts
[i
], psz_search
) )
1405 if( i
== p_parser
->i_shortcuts
)
1409 /* Ignore modules without config options */
1410 if( !p_parser
->i_config_items
)
1415 b_help_module
= !strcmp( "help", p_parser
->psz_object_name
);
1416 /* Ugly hack to make sure that the help options always come first
1418 if( !psz_search
&& b_help_module
)
1421 /* Ignore modules with only advanced config options if requested */
1424 for( p_item
= p_parser
->p_config
;
1428 if( (p_item
->i_type
& CONFIG_ITEM
) &&
1429 !p_item
->b_advanced
&& !p_item
->b_removed
) break;
1432 if( p_item
== p_end
)
1441 /* Print name of module */
1442 if( strcmp( "main", p_parser
->psz_object_name
) )
1445 utf8_fprintf( stdout
, "\n " GREEN
"%s" GRAY
" (%s)\n",
1446 module_gettext( p_parser
, p_parser
->psz_longname
),
1447 p_parser
->psz_object_name
);
1449 utf8_fprintf( stdout
, "\n %s\n",
1450 module_gettext(p_parser
, p_parser
->psz_longname
) );
1452 if( p_parser
->psz_help
)
1455 utf8_fprintf( stdout
, CYAN
" %s\n"GRAY
,
1456 module_gettext( p_parser
, p_parser
->psz_help
) );
1458 utf8_fprintf( stdout
, " %s\n",
1459 module_gettext( p_parser
, p_parser
->psz_help
) );
1462 /* Print module options */
1463 for( p_item
= p_parser
->p_config
;
1467 char *psz_text
, *psz_spaces
= psz_spaces_text
;
1468 const char *psz_bra
= NULL
, *psz_type
= NULL
, *psz_ket
= NULL
;
1469 const char *psz_suf
= "", *psz_prefix
= NULL
;
1473 /* Skip removed options */
1474 if( p_item
->b_removed
)
1478 /* Skip advanced options if requested */
1479 if( p_item
->b_advanced
&& !b_advanced
)
1481 b_has_advanced
= true;
1485 switch( p_item
->i_type
)
1487 case CONFIG_HINT_CATEGORY
:
1488 case CONFIG_HINT_USAGE
:
1489 if( !strcmp( "main", p_parser
->psz_object_name
) )
1492 utf8_fprintf( stdout
, GREEN
"\n %s\n" GRAY
,
1493 module_gettext( p_parser
, p_item
->psz_text
) );
1495 utf8_fprintf( stdout
, "\n %s\n",
1496 module_gettext( p_parser
, p_item
->psz_text
) );
1498 if( b_description
&& p_item
->psz_longtext
)
1501 utf8_fprintf( stdout
, CYAN
" %s\n" GRAY
,
1502 module_gettext( p_parser
, p_item
->psz_longtext
) );
1504 utf8_fprintf( stdout
, " %s\n",
1505 module_gettext( p_parser
, p_item
->psz_longtext
) );
1509 case CONFIG_HINT_SUBCATEGORY
:
1510 if( strcmp( "main", p_parser
->psz_object_name
) )
1512 case CONFIG_SECTION
:
1516 case CONFIG_ITEM_STRING
:
1517 case CONFIG_ITEM_LOADFILE
:
1518 case CONFIG_ITEM_SAVEFILE
:
1519 case CONFIG_ITEM_DIRECTORY
:
1520 case CONFIG_ITEM_KEY
:
1521 case CONFIG_ITEM_MODULE
: /* We could also have "=<" here */
1522 case CONFIG_ITEM_MODULE_CAT
:
1523 case CONFIG_ITEM_MODULE_LIST
:
1524 case CONFIG_ITEM_MODULE_LIST_CAT
:
1525 case CONFIG_ITEM_FONT
:
1526 case CONFIG_ITEM_PASSWORD
:
1527 print_help_section( p_parser
, p_section
, b_color
,
1530 psz_bra
= OPTION_VALUE_SEP
"<";
1531 psz_type
= _("string");
1534 if( p_item
->ppsz_list
)
1536 psz_bra
= OPTION_VALUE_SEP
"{";
1537 psz_type
= psz_buffer
;
1538 psz_buffer
[0] = '\0';
1539 for( i
= 0; p_item
->ppsz_list
[i
]; i
++ )
1541 if( i
) strcat( psz_buffer
, "," );
1542 strcat( psz_buffer
, p_item
->ppsz_list
[i
] );
1547 case CONFIG_ITEM_INTEGER
:
1548 print_help_section( p_parser
, p_section
, b_color
,
1551 psz_bra
= OPTION_VALUE_SEP
"<";
1552 psz_type
= _("integer");
1555 if( p_item
->min
.i
|| p_item
->max
.i
)
1557 sprintf( psz_buffer
, "%s [%"PRId64
" .. %"PRId64
"]",
1558 psz_type
, p_item
->min
.i
, p_item
->max
.i
);
1559 psz_type
= psz_buffer
;
1562 if( p_item
->i_list
)
1564 psz_bra
= OPTION_VALUE_SEP
"{";
1565 psz_type
= psz_buffer
;
1566 psz_buffer
[0] = '\0';
1567 for( i
= 0; p_item
->ppsz_list_text
[i
]; i
++ )
1569 if( i
) strcat( psz_buffer
, ", " );
1570 sprintf( psz_buffer
+ strlen(psz_buffer
), "%i (%s)",
1572 module_gettext( p_parser
, p_item
->ppsz_list_text
[i
] ) );
1577 case CONFIG_ITEM_FLOAT
:
1578 print_help_section( p_parser
, p_section
, b_color
,
1581 psz_bra
= OPTION_VALUE_SEP
"<";
1582 psz_type
= _("float");
1584 if( p_item
->min
.f
|| p_item
->max
.f
)
1586 sprintf( psz_buffer
, "%s [%f .. %f]", psz_type
,
1587 p_item
->min
.f
, p_item
->max
.f
);
1588 psz_type
= psz_buffer
;
1591 case CONFIG_ITEM_BOOL
:
1592 print_help_section( p_parser
, p_section
, b_color
,
1595 psz_bra
= ""; psz_type
= ""; psz_ket
= "";
1596 if( !b_help_module
)
1598 psz_suf
= p_item
->value
.i
? _(" (default enabled)") :
1599 _(" (default disabled)");
1609 /* Add short option if any */
1610 if( p_item
->i_short
)
1612 sprintf( psz_short
, "-%c,", p_item
->i_short
);
1616 strcpy( psz_short
, " " );
1619 i
= PADDING_SPACES
- strlen( p_item
->psz_name
)
1620 - strlen( psz_bra
) - strlen( psz_type
)
1621 - strlen( psz_ket
) - 1;
1623 if( p_item
->i_type
== CONFIG_ITEM_BOOL
&& !b_help_module
)
1625 psz_prefix
= ", --no-";
1626 i
-= strlen( p_item
->psz_name
) + strlen( psz_prefix
);
1631 psz_spaces
[0] = '\n';
1636 psz_spaces
[i
] = '\0';
1639 if( p_item
->i_type
== CONFIG_ITEM_BOOL
&& !b_help_module
)
1641 utf8_fprintf( stdout
, psz_format_bool
, psz_short
,
1642 p_item
->psz_name
, psz_prefix
, p_item
->psz_name
,
1643 psz_bra
, psz_type
, psz_ket
, psz_spaces
);
1647 utf8_fprintf( stdout
, psz_format
, psz_short
, p_item
->psz_name
,
1648 "", "", psz_bra
, psz_type
, psz_ket
, psz_spaces
);
1651 psz_spaces
[i
] = ' ';
1653 /* We wrap the rest of the output */
1654 sprintf( psz_buffer
, "%s%s", module_gettext( p_parser
, p_item
->psz_text
),
1656 b_description_hack
= b_description
;
1659 psz_text
= psz_buffer
;
1660 i_cur_width
= b_description
&& !b_description_hack
1661 ? i_width_description
1663 if( !*psz_text
) strcpy(psz_text
, " ");
1666 char *psz_parser
, *psz_word
;
1667 size_t i_end
= strlen( psz_text
);
1669 /* If the remaining text fits in a line, print it. */
1670 if( i_end
<= i_cur_width
)
1674 if( !b_description
|| b_description_hack
)
1675 utf8_fprintf( stdout
, BLUE
"%s\n"GRAY
, psz_text
);
1677 utf8_fprintf( stdout
, "%s\n", psz_text
);
1681 utf8_fprintf( stdout
, "%s\n", psz_text
);
1686 /* Otherwise, eat as many words as possible */
1687 psz_parser
= psz_text
;
1690 psz_word
= psz_parser
;
1691 psz_parser
= strchr( psz_word
, ' ' );
1692 /* If no space was found, we reached the end of the text
1693 * block; otherwise, we skip the space we just found. */
1694 psz_parser
= psz_parser
? psz_parser
+ 1
1697 } while( (size_t)(psz_parser
- psz_text
) <= i_cur_width
);
1699 /* We cut a word in one of these cases:
1700 * - it's the only word in the line and it's too long.
1701 * - we used less than 80% of the width and the word we are
1702 * going to wrap is longer than 40% of the width, and even
1703 * if the word would have fit in the next line. */
1704 if( psz_word
== psz_text
1705 || ( (size_t)(psz_word
- psz_text
) < 80 * i_cur_width
/ 100
1706 && (size_t)(psz_parser
- psz_word
) > 40 * i_cur_width
/ 100 ) )
1708 char c
= psz_text
[i_cur_width
];
1709 psz_text
[i_cur_width
] = '\0';
1712 if( !b_description
|| b_description_hack
)
1713 utf8_fprintf( stdout
, BLUE
"%s\n%s"GRAY
,
1714 psz_text
, psz_spaces
);
1716 utf8_fprintf( stdout
, "%s\n%s",
1717 psz_text
, psz_spaces
);
1721 utf8_fprintf( stdout
, "%s\n%s", psz_text
, psz_spaces
);
1723 psz_text
+= i_cur_width
;
1728 psz_word
[-1] = '\0';
1731 if( !b_description
|| b_description_hack
)
1732 utf8_fprintf( stdout
, BLUE
"%s\n%s"GRAY
,
1733 psz_text
, psz_spaces
);
1735 utf8_fprintf( stdout
, "%s\n%s",
1736 psz_text
, psz_spaces
);
1740 utf8_fprintf( stdout
, "%s\n%s", psz_text
, psz_spaces
);
1742 psz_text
= psz_word
;
1746 if( b_description_hack
&& p_item
->psz_longtext
)
1748 sprintf( psz_buffer
, "%s%s",
1749 module_gettext( p_parser
, p_item
->psz_longtext
),
1751 b_description_hack
= false;
1752 psz_spaces
= psz_spaces_longtext
;
1753 utf8_fprintf( stdout
, "%s", psz_spaces
);
1759 if( b_has_advanced
)
1762 utf8_fprintf( stdout
, "\n" WHITE
"%s" GRAY
" %s\n", _( "Note:" ),
1763 _( "add --advanced to your command line to see advanced options."));
1765 utf8_fprintf( stdout
, "\n%s %s\n", _( "Note:" ),
1766 _( "add --advanced to your command line to see advanced options."));
1769 if( i_only_advanced
> 0 )
1773 utf8_fprintf( stdout
, "\n" WHITE
"%s" GRAY
" ", _( "Note:" ) );
1774 utf8_fprintf( stdout
, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced
);
1778 utf8_fprintf( stdout
, "\n%s ", _( "Note:" ) );
1779 utf8_fprintf( stdout
, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced
);
1785 utf8_fprintf( stdout
, "\n" WHITE
"%s" GRAY
"\n",
1786 _( "No matching module found. Use --list or " \
1787 "--list-verbose to list available modules." ) );
1789 utf8_fprintf( stdout
, "\n%s\n",
1790 _( "No matching module found. Use --list or " \
1791 "--list-verbose to list available modules." ) );
1794 /* Release the module list */
1795 module_list_free (list
);
1798 /*****************************************************************************
1799 * ListModules: list the available modules with their description
1800 *****************************************************************************
1801 * Print a list of all available modules (builtins and plugins) and a short
1802 * description for each one.
1803 *****************************************************************************/
1804 static void ListModules( libvlc_int_t
*p_this
, bool b_verbose
)
1808 bool b_color
= var_InheritBool( p_this
, "color" );
1811 ShowConsole( true );
1812 b_color
= false; // don't put color control codes in a .txt file
1818 /* List all modules */
1819 module_t
**list
= module_list_get (NULL
);
1821 /* Enumerate each module */
1822 for (size_t j
= 0; (p_parser
= list
[j
]) != NULL
; j
++)
1825 utf8_fprintf( stdout
, GREEN
" %-22s "WHITE
"%s\n"GRAY
,
1826 p_parser
->psz_object_name
,
1827 module_gettext( p_parser
, p_parser
->psz_longname
) );
1829 utf8_fprintf( stdout
, " %-22s %s\n",
1830 p_parser
->psz_object_name
,
1831 module_gettext( p_parser
, p_parser
->psz_longname
) );
1835 char *const *pp_shortcuts
= p_parser
->pp_shortcuts
;
1836 for( unsigned i
= 0; i
< p_parser
->i_shortcuts
; i
++ )
1838 if( strcmp( pp_shortcuts
[i
], p_parser
->psz_object_name
) )
1841 utf8_fprintf( stdout
, CYAN
" s %s\n"GRAY
,
1844 utf8_fprintf( stdout
, " s %s\n",
1848 if( p_parser
->psz_capability
)
1851 utf8_fprintf( stdout
, MAGENTA
" c %s (%d)\n"GRAY
,
1852 p_parser
->psz_capability
,
1853 p_parser
->i_score
);
1855 utf8_fprintf( stdout
, " c %s (%d)\n",
1856 p_parser
->psz_capability
,
1857 p_parser
->i_score
);
1861 module_list_free (list
);
1863 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1868 /*****************************************************************************
1869 * Version: print complete program version
1870 *****************************************************************************
1871 * Print complete program version and build number.
1872 *****************************************************************************/
1873 static void Version( void )
1876 ShowConsole( true );
1879 utf8_fprintf( stdout
, _("VLC version %s (%s)\n"), VERSION_MESSAGE
,
1880 psz_vlc_changeset
);
1881 utf8_fprintf( stdout
, _("Compiled by %s on %s (%s)\n"),
1882 VLC_CompileBy(), VLC_CompileHost(), __DATE__
" "__TIME__
);
1883 utf8_fprintf( stdout
, _("Compiler: %s\n"), VLC_Compiler() );
1884 utf8_fprintf( stdout
, "%s", LICENSE_MSG
);
1886 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1891 /*****************************************************************************
1892 * ShowConsole: On Win32, create an output console for debug messages
1893 *****************************************************************************
1894 * This function is useful only on Win32.
1895 *****************************************************************************/
1897 static void ShowConsole( bool b_dofile
)
1900 FILE *f_help
= NULL
;
1902 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1905 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1906 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1907 * page (e.g. CP437 or CP850). */
1908 SetConsoleOutputCP (GetACP ());
1909 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION
);
1911 freopen( "CONOUT$", "w", stderr
);
1912 freopen( "CONIN$", "r", stdin
);
1914 if( b_dofile
&& (f_help
= fopen( "vlc-help.txt", "wt" )) )
1917 freopen( "vlc-help.txt", "wt", stdout
);
1918 utf8_fprintf( stderr
, _("\nDumped content to vlc-help.txt file.\n") );
1920 else freopen( "CONOUT$", "w", stdout
);
1926 /*****************************************************************************
1927 * PauseConsole: On Win32, wait for a key press before closing the console
1928 *****************************************************************************
1929 * This function is useful only on Win32.
1930 *****************************************************************************/
1932 static void PauseConsole( void )
1936 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1938 utf8_fprintf( stderr
, _("\nPress the RETURN key to continue...\n") );
1946 /*****************************************************************************
1947 * ConsoleWidth: Return the console width in characters
1948 *****************************************************************************
1949 * We use the stty shell command to get the console width; if this fails or
1950 * if the width is less than 80, we default to 80.
1951 *****************************************************************************/
1952 static int ConsoleWidth( void )
1954 unsigned i_width
= 80;
1957 FILE *file
= popen( "stty size 2>/dev/null", "r" );
1960 if (fscanf (file
, "%*u %u", &i_width
) <= 0)
1964 #elif !defined (UNDER_CE)
1965 CONSOLE_SCREEN_BUFFER_INFO buf
;
1967 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE
), &buf
))
1968 i_width
= buf
.dwSize
.X
;