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 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
61 # include "extras/getopt.h"
69 # include <libintl.h> /* bindtextdomain */
73 /* used for one-instance mode */
74 # include <dbus/dbus.h>
77 #include <vlc_playlist.h>
78 #include <vlc_interface.h>
81 #include "audio_output/aout_internal.h"
83 #include <vlc_charset.h>
89 #include "playlist/playlist_internal.h"
94 # include <libkern/OSAtomic.h>
99 /*****************************************************************************
100 * The evil global variables. We handle them with care, don't worry.
101 *****************************************************************************/
102 static unsigned i_instances = 0;
105 static bool b_daemon = false;
113 * Atomically set the reference count to 1.
114 * @param p_gc reference counted object
115 * @param pf_destruct destruction calback
118 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
120 /* There is no point in using the GC if there is no destructor... */
121 assert (pf_destruct);
122 p_gc->pf_destructor = pf_destruct;
125 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
126 __sync_synchronize ();
127 #elif defined (WIN32) && defined (__GNUC__)
128 #elif defined(__APPLE__)
131 /* Nobody else can possibly lock the spin - it's there as a barrier */
132 vlc_spin_init (&p_gc->spin);
133 vlc_spin_lock (&p_gc->spin);
134 vlc_spin_unlock (&p_gc->spin);
140 * Atomically increment the reference count.
141 * @param p_gc reference counted object
144 void *vlc_hold (gc_object_t * p_gc)
148 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
150 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
151 refs = __sync_add_and_fetch (&p_gc->refs, 1);
152 #elif defined (WIN64)
153 refs = InterlockedIncrement64 (&p_gc->refs);
154 #elif defined (WIN32)
155 refs = InterlockedIncrement (&p_gc->refs);
156 #elif defined(__APPLE__)
157 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
159 vlc_spin_lock (&p_gc->spin);
161 vlc_spin_unlock (&p_gc->spin);
163 assert (refs != 1); /* there had to be a reference already */
168 * Atomically decrement the reference count and, if it reaches zero, destroy.
169 * @param p_gc reference counted object.
171 void vlc_release (gc_object_t *p_gc)
176 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
178 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
179 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
180 #elif defined (WIN64)
181 refs = InterlockedDecrement64 (&p_gc->refs);
182 #elif defined (WIN32)
183 refs = InterlockedDecrement (&p_gc->refs);
184 #elif defined(__APPLE__)
185 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
187 vlc_spin_lock (&p_gc->spin);
189 vlc_spin_unlock (&p_gc->spin);
192 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
195 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
196 #elif defined (WIN32) && defined (__GNUC__)
197 #elif defined(__APPLE__)
199 vlc_spin_destroy (&p_gc->spin);
201 p_gc->pf_destructor (p_gc);
205 /*****************************************************************************
207 *****************************************************************************/
208 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
209 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
210 static void SetLanguage ( char const * );
212 static inline int LoadMessages (void);
213 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
214 static void Help ( libvlc_int_t *, char const *psz_help_name );
215 static void Usage ( libvlc_int_t *, char const *psz_search );
216 static void ListModules ( libvlc_int_t *, bool );
217 static void Version ( void );
220 static void ShowConsole ( bool );
221 static void PauseConsole ( void );
223 static int ConsoleWidth ( void );
225 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
228 * Allocate a libvlc instance, initialize global data if needed
229 * It also initializes the threading system
231 libvlc_int_t * libvlc_InternalCreate( void )
233 libvlc_int_t *p_libvlc;
235 char *psz_env = NULL;
237 /* Now that the thread system is initialized, we don't have much, but
238 * at least we have variables */
239 vlc_mutex_lock( &global_lock );
240 if( i_instances == 0 )
242 /* Guess what CPU we have */
243 cpu_flags = CPUCapabilities();
244 /* The module bank will be initialized later */
247 /* Allocate a libvlc instance object */
248 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
249 VLC_OBJECT_GENERIC, "libvlc" );
250 if( p_libvlc != NULL )
252 vlc_mutex_unlock( &global_lock );
254 if( p_libvlc == NULL )
257 priv = libvlc_priv (p_libvlc);
258 priv->p_playlist = NULL;
259 priv->p_dialog_provider = NULL;
262 /* Initialize message queue */
263 msg_Create( p_libvlc );
265 /* Find verbosity from VLC_VERBOSE environment variable */
266 psz_env = getenv( "VLC_VERBOSE" );
267 if( psz_env != NULL )
268 priv->i_verbose = atoi( psz_env );
271 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
272 priv->b_color = isatty( 2 ); /* 2 is for stderr */
274 priv->b_color = false;
277 /* Initialize mutexes */
278 vlc_mutex_init( &priv->timer_lock );
284 * Initialize a libvlc instance
285 * This function initializes a previously allocated libvlc instance:
287 * - gettext initialization
288 * - message queue, module bank and playlist initialization
289 * - configuration and commandline parsing
291 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
292 const char *ppsz_argv[] )
294 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
296 char * psz_modules = NULL;
297 char * psz_parser = NULL;
298 char * psz_control = NULL;
300 int i_ret = VLC_EEXIT;
301 playlist_t *p_playlist = NULL;
303 #if defined( ENABLE_NLS ) \
304 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
305 # if defined (WIN32) || defined (__APPLE__)
310 /* System specific initialization code */
311 system_Init( p_libvlc, &i_argc, ppsz_argv );
314 * Support for gettext
318 /* Initialize the module bank and load the configuration of the
319 * main module. We need to do this at this stage to be able to display
320 * a short help if required by the user. (short help == main module
322 module_InitBank( p_libvlc );
324 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
326 module_EndBank( p_libvlc, false );
330 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
331 /* Announce who we are - Do it only for first instance ? */
332 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
333 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
334 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
335 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
337 /* Check for short help option */
338 if( var_InheritBool( p_libvlc, "help" ) )
340 Help( p_libvlc, "help" );
342 i_ret = VLC_EEXITSUCCESS;
344 /* Check for version option */
345 else if( var_InheritBool( p_libvlc, "version" ) )
349 i_ret = VLC_EEXITSUCCESS;
352 /* Check for plugins cache options */
353 bool b_cache_delete = var_InheritBool( p_libvlc, "reset-plugins-cache" );
355 /* Check for daemon mode */
357 if( var_InheritBool( p_libvlc, "daemon" ) )
360 char *psz_pidfile = NULL;
362 if( daemon( 1, 0) != 0 )
364 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
369 /* lets check if we need to write the pidfile */
370 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
371 if( psz_pidfile != NULL )
374 pid_t i_pid = getpid ();
375 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
376 i_pid, psz_pidfile );
377 pidfile = utf8_fopen( psz_pidfile,"w" );
378 if( pidfile != NULL )
380 utf8_fprintf( pidfile, "%d", (int)i_pid );
385 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
394 if( ( i_pid = fork() ) < 0 )
396 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
401 /* This is the parent, exit right now */
402 msg_Dbg( p_libvlc, "closing parent process" );
404 i_ret = VLC_EEXITSUCCESS;
408 /* We are the child */
409 msg_Dbg( p_libvlc, "daemon spawned" );
410 close( STDIN_FILENO );
411 close( STDOUT_FILENO );
412 close( STDERR_FILENO );
422 module_EndBank( p_libvlc, false );
426 /* Check for translation config option */
427 #if defined( ENABLE_NLS ) \
428 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
429 # if defined (WIN32) || defined (__APPLE__)
430 /* This ain't really nice to have to reload the config here but it seems
431 * the only way to do it. */
433 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
434 config_LoadConfigFile( p_libvlc, "main" );
435 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
436 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
438 /* Check if the user specified a custom language */
439 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
440 if( psz_language && strcmp( psz_language, "auto" ) )
442 /* Reset the default domain */
443 SetLanguage( psz_language );
445 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
446 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
448 module_EndBank( p_libvlc, false );
449 module_InitBank( p_libvlc );
450 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
451 config_LoadConfigFile( p_libvlc, "main" );
452 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
453 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
455 free( psz_language );
460 * Load the builtins and plugins into the module_bank.
461 * We have to do it before config_Load*() because this also gets the
462 * list of configuration options exported by each module and loads their
465 module_LoadPlugins( p_libvlc, b_cache_delete );
466 if( p_libvlc->b_die )
472 module_t **list = module_list_get( &module_count );
473 module_list_free( list );
474 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
476 /* Check for help on modules */
477 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
479 Help( p_libvlc, p_tmp );
482 i_ret = VLC_EEXITSUCCESS;
484 /* Check for full help option */
485 else if( var_InheritBool( p_libvlc, "full-help" ) )
487 config_PutInt( p_libvlc, "advanced", 1);
488 config_PutInt( p_libvlc, "help-verbose", 1);
489 Help( p_libvlc, "full-help" );
491 i_ret = VLC_EEXITSUCCESS;
493 /* Check for long help option */
494 else if( var_InheritBool( p_libvlc, "longhelp" ) )
496 Help( p_libvlc, "longhelp" );
498 i_ret = VLC_EEXITSUCCESS;
500 /* Check for module list option */
501 else if( var_InheritBool( p_libvlc, "list" ) )
503 ListModules( p_libvlc, false );
505 i_ret = VLC_EEXITSUCCESS;
507 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
509 ListModules( p_libvlc, true );
511 i_ret = VLC_EEXITSUCCESS;
514 /* Check for config file options */
515 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
517 if( var_InheritBool( p_libvlc, "reset-config" ) )
519 config_ResetAll( p_libvlc );
520 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
521 config_SaveConfigFile( p_libvlc, NULL );
525 if( module_count <= 1)
527 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
528 "that you properly gave a module path with --plugin-path.");
535 module_EndBank( p_libvlc, true );
540 * Override default configuration with config file settings
542 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
543 config_LoadConfigFile( p_libvlc, NULL );
546 * Override configuration with command line settings
548 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
551 ShowConsole( false );
552 /* Pause the console because it's destroyed when we exit */
553 fprintf( stderr, "The command line options couldn't be loaded, check "
554 "that they are valid.\n" );
557 module_EndBank( p_libvlc, true );
560 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
563 * System specific configuration
565 system_Configure( p_libvlc, &i_argc, ppsz_argv );
567 /* FIXME: could be replaced by using Unix sockets */
569 dbus_threads_init_default();
571 if( var_InheritBool( p_libvlc, "one-instance" )
572 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
573 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
575 /* Initialise D-Bus interface, check for other instances */
576 DBusConnection *p_conn = NULL;
577 DBusError dbus_error;
579 dbus_error_init( &dbus_error );
581 /* connect to the session bus */
582 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
585 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
586 dbus_error.message );
587 dbus_error_free( &dbus_error );
591 /* check if VLC is available on the bus
592 * if not: D-Bus control is not enabled on the other
593 * instance and we can't pass MRLs to it */
594 DBusMessage *p_test_msg = NULL;
595 DBusMessage *p_test_reply = NULL;
596 p_test_msg = dbus_message_new_method_call(
597 "org.mpris.vlc", "/",
598 "org.freedesktop.MediaPlayer", "Identity" );
599 /* block until a reply arrives */
600 p_test_reply = dbus_connection_send_with_reply_and_block(
601 p_conn, p_test_msg, -1, &dbus_error );
602 dbus_message_unref( p_test_msg );
603 if( p_test_reply == NULL )
605 dbus_error_free( &dbus_error );
606 msg_Dbg( p_libvlc, "No Media Player is running. "
607 "Continuing normally." );
612 DBusMessage* p_dbus_msg = NULL;
613 DBusMessageIter dbus_args;
614 DBusPendingCall* p_dbus_pending = NULL;
617 dbus_message_unref( p_test_reply );
618 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
620 for( i_input = optind;i_input < i_argc;i_input++ )
622 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
623 ppsz_argv[i_input] );
625 p_dbus_msg = dbus_message_new_method_call(
626 "org.mpris.vlc", "/TrackList",
627 "org.freedesktop.MediaPlayer", "AddTrack" );
629 if ( NULL == p_dbus_msg )
631 msg_Err( p_libvlc, "D-Bus problem" );
632 system_End( p_libvlc );
637 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
638 if ( !dbus_message_iter_append_basic( &dbus_args,
639 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
641 dbus_message_unref( p_dbus_msg );
642 system_End( p_libvlc );
646 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
648 if ( !dbus_message_iter_append_basic( &dbus_args,
649 DBUS_TYPE_BOOLEAN, &b_play ) )
651 dbus_message_unref( p_dbus_msg );
652 system_End( p_libvlc );
656 /* send message and get a handle for a reply */
657 if ( !dbus_connection_send_with_reply ( p_conn,
658 p_dbus_msg, &p_dbus_pending, -1 ) )
660 msg_Err( p_libvlc, "D-Bus problem" );
661 dbus_message_unref( p_dbus_msg );
662 system_End( p_libvlc );
666 if ( NULL == p_dbus_pending )
668 msg_Err( p_libvlc, "D-Bus problem" );
669 dbus_message_unref( p_dbus_msg );
670 system_End( p_libvlc );
673 dbus_connection_flush( p_conn );
674 dbus_message_unref( p_dbus_msg );
675 /* block until we receive a reply */
676 dbus_pending_call_block( p_dbus_pending );
677 dbus_pending_call_unref( p_dbus_pending );
678 } /* processes all command line MRLs */
681 system_End( p_libvlc );
685 /* we unreference the connection when we've finished with it */
686 if( p_conn ) dbus_connection_unref( p_conn );
691 * Message queue options
693 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
694 if( psz_verbose_objects )
696 char * psz_object, * iter = psz_verbose_objects;
697 while( (psz_object = strsep( &iter, "," )) )
699 switch( psz_object[0] )
701 printf("%s\n", psz_object+1);
702 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
703 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
705 msg_Err( p_libvlc, "verbose-objects usage: \n"
706 "--verbose-objects=+printthatobject,"
707 "-dontprintthatone\n"
708 "(keyword 'all' to applies to all objects)");
709 free( psz_verbose_objects );
710 /* FIXME: leaks!!!! */
714 free( psz_verbose_objects );
717 /* Last chance to set the verbosity. Once we start interfaces and other
718 * threads, verbosity becomes read-only. */
719 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
720 if( var_InheritBool( p_libvlc, "quiet" ) )
722 var_SetInteger( p_libvlc, "verbose", -1 );
723 priv->i_verbose = -1;
725 vlc_threads_setup( p_libvlc );
728 priv->b_color = var_InheritBool( p_libvlc, "color" );
730 char p_capabilities[200];
731 #define PRINT_CAPABILITY( capability, string ) \
732 if( vlc_CPU() & capability ) \
734 strncat( p_capabilities, string " ", \
735 sizeof(p_capabilities) - strlen(p_capabilities) ); \
736 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
738 p_capabilities[0] = '\0';
740 #if defined( __i386__ ) || defined( __x86_64__ )
741 if( !var_InheritBool( p_libvlc, "mmx" ) )
742 cpu_flags &= ~CPU_CAPABILITY_MMX;
743 if( !var_InheritBool( p_libvlc, "3dn" ) )
744 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
745 if( !var_InheritBool( p_libvlc, "mmxext" ) )
746 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
747 if( !var_InheritBool( p_libvlc, "sse" ) )
748 cpu_flags &= ~CPU_CAPABILITY_SSE;
749 if( !var_InheritBool( p_libvlc, "sse2" ) )
750 cpu_flags &= ~CPU_CAPABILITY_SSE2;
751 if( !var_InheritBool( p_libvlc, "sse3" ) )
752 cpu_flags &= ~CPU_CAPABILITY_SSE3;
753 if( !var_InheritBool( p_libvlc, "ssse3" ) )
754 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
755 if( !var_InheritBool( p_libvlc, "sse41" ) )
756 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
757 if( !var_InheritBool( p_libvlc, "sse42" ) )
758 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
760 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
761 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
762 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
763 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
764 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
765 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
766 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
767 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
768 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
769 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
771 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
772 if( !var_InheritBool( p_libvlc, "altivec" ) )
773 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
775 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
777 #elif defined( __arm__ )
778 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
783 strncat( p_capabilities, "FPU ",
784 sizeof(p_capabilities) - strlen( p_capabilities) );
785 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
788 if (p_capabilities[0])
789 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
792 * Choose the best memcpy module
794 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
795 /* Avoid being called "memcpy":*/
796 vlc_object_set_name( p_libvlc, "main" );
798 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
800 priv->pp_timers = NULL;
802 priv->i_last_input_id = 0; /* Not very safe, should be removed */
805 * Initialize hotkey handling
807 vlc_InitActions( p_libvlc );
809 /* variables for signalling creation of new files */
810 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
811 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
813 /* Initialize playlist and get commandline files */
814 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
817 msg_Err( p_libvlc, "playlist initialization failed" );
818 if( priv->p_memcpy_module != NULL )
820 module_unneed( p_libvlc, priv->p_memcpy_module );
822 module_EndBank( p_libvlc, true );
825 playlist_Activate( p_playlist );
826 vlc_object_attach( p_playlist, p_libvlc );
828 /* Add service discovery modules */
829 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
832 char *p = psz_modules, *m;
833 while( ( m = strsep( &p, " :," ) ) != NULL )
834 playlist_ServicesDiscoveryAdd( p_playlist, m );
839 /* Initialize VLM if vlm-conf is specified */
840 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
843 priv->p_vlm = vlm_New( p_libvlc );
845 msg_Err( p_libvlc, "VLM initialization failed" );
851 * Load background interfaces
853 /* Create volume callback system. (this variable must be created before
854 all interfaces as they can use it) */
855 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
856 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
858 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
859 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
861 if( psz_modules && psz_control )
864 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
867 psz_modules = psz_tmp;
870 else if( psz_control )
873 psz_modules = strdup( psz_control );
876 psz_parser = psz_modules;
877 while ( psz_parser && *psz_parser )
879 char *psz_module, *psz_temp;
880 psz_module = psz_parser;
881 psz_parser = strchr( psz_module, ':' );
887 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
889 intf_Create( p_libvlc, psz_temp );
897 * Always load the hotkeys interface if it exists
899 intf_Create( p_libvlc, "hotkeys,none" );
902 /* loads dbus control interface if in one-instance mode
903 * we do it only when playlist exists, because dbus module needs it */
904 if( var_InheritBool( p_libvlc, "one-instance" )
905 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
906 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
907 intf_Create( p_libvlc, "dbus,none" );
909 # if !defined (HAVE_MAEMO)
910 /* Prevents the power management daemon from suspending the system
911 * when VLC is active */
912 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
913 intf_Create( p_libvlc, "inhibit,none" );
917 if( var_InheritBool( p_libvlc, "file-logging" ) &&
918 !var_InheritBool( p_libvlc, "syslog" ) )
920 intf_Create( p_libvlc, "logger,none" );
923 if( var_InheritBool( p_libvlc, "syslog" ) )
925 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
926 var_SetString( p_libvlc, "logmode", "syslog" );
927 intf_Create( p_libvlc, "logger,none" );
931 var_SetString( p_libvlc, "logmode", logmode );
934 var_Destroy( p_libvlc, "logmode" );
938 if( var_InheritBool( p_libvlc, "network-synchronisation") )
940 intf_Create( p_libvlc, "netsync,none" );
944 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
946 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
949 char *psz_morecodecs;
950 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
952 var_SetString( p_libvlc, "codec", psz_morecodecs);
953 free( psz_morecodecs );
958 var_SetString( p_libvlc, "codec", "dmo,quicktime");
962 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
963 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
964 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
965 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
966 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
967 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
968 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
969 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
972 /* Create a variable for showing the fullscreen interface from hotkeys */
973 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
974 var_SetBool( p_libvlc, "intf-show", true );
976 /* Create a variable for showing the right click menu */
977 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
980 * Get input filenames given as commandline arguments
982 GetFilenames( p_libvlc, i_argc, ppsz_argv );
985 * Get --open argument
987 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
988 if ( psz_val != NULL )
990 playlist_t *p_playlist = pl_Hold( p_libvlc );
991 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
992 -1, 0, NULL, 0, true, pl_Unlocked );
993 pl_Release( p_libvlc );
1001 * Cleanup a libvlc instance. The instance is not completely deallocated
1002 * \param p_libvlc the instance to clean
1004 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1006 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1007 playlist_t *p_playlist = priv->p_playlist;
1009 /* Deactivate the playlist */
1010 msg_Dbg( p_libvlc, "deactivating the playlist" );
1011 playlist_Deactivate( p_playlist );
1013 /* Remove all services discovery */
1014 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1015 playlist_ServicesDiscoveryKillAll( p_playlist );
1017 /* Ask the interfaces to stop and destroy them */
1018 msg_Dbg( p_libvlc, "removing all interfaces" );
1019 libvlc_Quit( p_libvlc );
1020 intf_DestroyAll( p_libvlc );
1023 /* Destroy VLM if created in libvlc_InternalInit */
1026 vlm_Delete( priv->p_vlm );
1031 /* Any thread still running must not assume pl_Hold() succeeds. */
1032 msg_Dbg( p_libvlc, "removing playlist" );
1034 libvlc_priv(p_libvlc)->p_playlist = NULL;
1035 barrier(); /* FIXME is that correct ? */
1037 vlc_object_release( p_playlist );
1039 stats_TimersDumpAll( p_libvlc );
1040 stats_TimersCleanAll( p_libvlc );
1042 msg_Dbg( p_libvlc, "removing stats" );
1045 char* psz_pidfile = NULL;
1049 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1050 if( psz_pidfile != NULL )
1052 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1053 if( unlink( psz_pidfile ) == -1 )
1055 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1059 free( psz_pidfile );
1063 if( priv->p_memcpy_module )
1065 module_unneed( p_libvlc, priv->p_memcpy_module );
1066 priv->p_memcpy_module = NULL;
1069 /* Free module bank. It is refcounted, so we call this each time */
1070 module_EndBank( p_libvlc, true );
1072 vlc_DeinitActions( p_libvlc );
1076 * Destroy everything.
1077 * This function requests the running threads to finish, waits for their
1078 * termination, and destroys their structure.
1079 * It stops the thread systems: no instance can run after this has run
1080 * \param p_libvlc the instance to destroy
1082 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1084 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1086 vlc_mutex_lock( &global_lock );
1089 if( i_instances == 0 )
1091 /* System specific cleaning code */
1092 system_End( p_libvlc );
1094 vlc_mutex_unlock( &global_lock );
1096 msg_Destroy( p_libvlc );
1098 /* Destroy mutexes */
1099 vlc_mutex_destroy( &priv->timer_lock );
1101 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1102 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1103 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1104 vlc_object_release( p_libvlc );
1107 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1108 vlc_object_release( p_libvlc );
1112 * Add an interface plugin and run it
1114 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1117 return VLC_EGENERIC;
1119 if( !psz_module ) /* requesting the default interface */
1121 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1122 if( !psz_interface ) /* "intf" has not been set */
1126 /* Daemon mode hack.
1127 * We prefer the dummy interface if none is specified. */
1128 psz_module = "dummy";
1131 msg_Info( p_libvlc, "%s",
1132 _("Running vlc with the default interface. "
1133 "Use 'cvlc' to use vlc without interface.") );
1135 free( psz_interface );
1136 var_Destroy( p_libvlc, "intf" );
1139 /* Try to create the interface */
1140 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1142 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1143 psz_module ? psz_module : "default" );
1148 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1149 static vlc_cond_t exiting = VLC_STATIC_COND;
1151 extern vlc_mutex_t super_mutex;
1152 extern vlc_cond_t super_variable;
1153 # define exit_lock super_mutex
1154 # define exiting super_variable
1158 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1159 * when the user "exits" an interface plugin.
1161 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1163 vlc_mutex_lock( &exit_lock );
1164 while( vlc_object_alive( p_libvlc ) )
1165 vlc_cond_wait( &exiting, &exit_lock );
1166 vlc_mutex_unlock( &exit_lock );
1170 * Posts an exit signal to LibVLC instance. This will normally initiate the
1171 * cleanup and destroy process. It should only be called on behalf of the user.
1173 void libvlc_Quit( libvlc_int_t *p_libvlc )
1175 vlc_mutex_lock( &exit_lock );
1176 vlc_object_kill( p_libvlc );
1177 vlc_cond_broadcast( &exiting );
1178 vlc_mutex_unlock( &exit_lock );
1181 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1182 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1183 /*****************************************************************************
1184 * SetLanguage: set the interface language.
1185 *****************************************************************************
1186 * We set the LC_MESSAGES locale category for interface messages and buttons,
1187 * as well as the LC_CTYPE category for string sorting and possible wide
1188 * character support.
1189 *****************************************************************************/
1190 static void SetLanguage ( const char *psz_lang )
1193 /* I need that under Darwin, please check it doesn't disturb
1194 * other platforms. --Meuuh */
1195 setenv( "LANG", psz_lang, 1 );
1198 /* We set LC_ALL manually because it is the only way to set
1199 * the language at runtime under eg. Windows. Beware that this
1200 * makes the environment unconsistent when libvlc is unloaded and
1201 * should probably be moved to a safer place like vlc.c. */
1202 static char psz_lcall[20];
1203 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1204 psz_lcall[19] = '\0';
1205 putenv( psz_lcall );
1208 setlocale( LC_ALL, psz_lang );
1213 static inline int LoadMessages (void)
1215 #if defined( ENABLE_NLS ) \
1216 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1217 /* Specify where to find the locales for current domain */
1218 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1219 static const char psz_path[] = LOCALEDIR;
1221 char psz_path[1024];
1222 char *datadir = config_GetDataDirDefault();
1225 if (unlikely(datadir == NULL))
1227 ret = snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "locale",
1230 if (ret >= (int)sizeof (psz_path))
1233 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1235 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1236 " to directory %s\n", psz_path);
1240 /* LibVLC wants all messages in UTF-8.
1241 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1242 * and other functions that are not part of our text domain.
1244 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1246 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1248 // Unbinds the text domain to avoid broken encoding
1249 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1253 /* LibVLC does NOT set the default textdomain, since it is a library.
1254 * This could otherwise break programs using LibVLC (other than VLC).
1255 * textdomain (PACKAGE_NAME);
1261 /*****************************************************************************
1262 * GetFilenames: parse command line options which are not flags
1263 *****************************************************************************
1264 * Parse command line for input files as well as their associated options.
1265 * An option always follows its associated input and begins with a ":".
1266 *****************************************************************************/
1267 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1269 int i_opt, i_options;
1271 /* We assume that the remaining parameters are filenames
1272 * and their input options */
1273 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1277 /* Count the input options */
1278 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1284 /* TODO: write an internal function of this one, to avoid
1285 * unnecessary lookups. */
1286 char *mrl = make_URI( ppsz_argv[i_opt] );
1290 playlist_t *p_playlist = pl_Hold( p_vlc );
1291 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1292 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1293 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1294 pl_Release( p_vlc );
1301 /*****************************************************************************
1302 * Help: print program help
1303 *****************************************************************************
1304 * Print a short inline help. Message interface is initialized at this stage.
1305 *****************************************************************************/
1306 static inline void print_help_on_full_help( void )
1308 utf8_fprintf( stdout, "\n" );
1309 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1312 static const char vlc_usage[] = N_(
1313 "Usage: %s [options] [stream] ..."
1314 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1315 "\nThe first item specified will be played first."
1318 "\n --option A global option that is set for the duration of the program."
1319 "\n -option A single letter version of a global --option."
1320 "\n :option An option that only applies to the stream directly before it"
1321 "\n and that overrides previous settings."
1323 "\nStream MRL syntax:"
1324 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1326 "\n Many of the global --options can also be used as MRL specific :options."
1327 "\n Multiple :option=value pairs can be specified."
1330 "\n [file://]filename Plain media file"
1331 "\n http://ip:port/file HTTP URL"
1332 "\n ftp://ip:port/file FTP URL"
1333 "\n mms://ip:port/file MMS URL"
1334 "\n screen:// Screen capture"
1335 "\n [dvd://][device][@raw_device] DVD device"
1336 "\n [vcd://][device] VCD device"
1337 "\n [cdda://][device] Audio CD device"
1338 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1339 "\n UDP stream sent by a streaming server"
1340 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1341 "\n vlc://quit Special item to quit VLC"
1344 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1347 ShowConsole( true );
1350 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1352 utf8_fprintf( stdout, vlc_usage, "vlc" );
1353 Usage( p_this, "=help" );
1354 Usage( p_this, "=main" );
1355 print_help_on_full_help();
1357 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1359 utf8_fprintf( stdout, vlc_usage, "vlc" );
1360 Usage( p_this, NULL );
1361 print_help_on_full_help();
1363 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1365 utf8_fprintf( stdout, vlc_usage, "vlc" );
1366 Usage( p_this, NULL );
1368 else if( psz_help_name )
1370 Usage( p_this, psz_help_name );
1373 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1378 /*****************************************************************************
1379 * Usage: print module usage
1380 *****************************************************************************
1381 * Print a short inline help. Message interface is initialized at this stage.
1382 *****************************************************************************/
1383 # define COL(x) "\033[" #x ";1m"
1384 # define RED COL(31)
1385 # define GREEN COL(32)
1386 # define YELLOW COL(33)
1387 # define BLUE COL(34)
1388 # define MAGENTA COL(35)
1389 # define CYAN COL(36)
1390 # define WHITE COL(0)
1391 # define GRAY "\033[0m"
1392 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1394 if( !p_item ) return;
1397 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1398 if( b_description && p_item->psz_longtext )
1399 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1400 _( p_item->psz_longtext ) );
1404 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1405 if( b_description && p_item->psz_longtext )
1406 utf8_fprintf( stdout, " %s\n", _( p_item->psz_longtext ) );
1410 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1412 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1413 /* short option ------' | | | | | | |
1414 * option name ------------' | | | | | |
1415 * <bra ---------------------' | | | | |
1416 * option type or "" ----------' | | | |
1417 * ket> -------------------------' | | |
1418 * padding spaces -----------------' | |
1419 * comment --------------------------' |
1420 * comment suffix ---------------------'
1422 * The purpose of having bra and ket is that we might i18n them as well.
1425 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1426 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1428 #define LINE_START 8
1429 #define PADDING_SPACES 25
1431 # define OPTION_VALUE_SEP "="
1433 # define OPTION_VALUE_SEP " "
1435 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1436 char psz_spaces_longtext[LINE_START+3];
1437 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1438 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1439 char psz_buffer[10000];
1441 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1442 int i_width_description = i_width + PADDING_SPACES - 1;
1443 bool b_advanced = var_InheritBool( p_this, "advanced" );
1444 bool b_description = var_InheritBool( p_this, "help-verbose" );
1445 bool b_description_hack;
1446 bool b_color = var_InheritBool( p_this, "color" );
1447 bool b_has_advanced = false;
1448 bool b_found = false;
1449 int i_only_advanced = 0; /* Number of modules ignored because they
1450 * only have advanced options */
1451 bool b_strict = psz_search && *psz_search == '=';
1452 if( b_strict ) psz_search++;
1454 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1455 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1456 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1457 psz_spaces_longtext[LINE_START+2] = '\0';
1461 b_color = false; // don't put color control codes in a .txt file
1465 strcpy( psz_format, COLOR_FORMAT_STRING );
1466 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1470 strcpy( psz_format, FORMAT_STRING );
1471 strcpy( psz_format_bool, FORMAT_STRING );
1474 /* List all modules */
1475 module_t **list = module_list_get (NULL);
1479 /* Ugly hack to make sure that the help options always come first
1482 Usage( p_this, "help" );
1484 /* Enumerate the config for each module */
1485 for (size_t i = 0; list[i]; i++)
1488 module_t *p_parser = list[i];
1489 module_config_t *p_item = NULL;
1490 module_config_t *p_section = NULL;
1491 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1494 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1495 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1497 char *const *pp_shortcut = p_parser->pp_shortcuts;
1498 while( *pp_shortcut )
1500 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1501 : !!strstr( *pp_shortcut, psz_search ) )
1509 /* Ignore modules without config options */
1510 if( !p_parser->i_config_items )
1515 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1516 /* Ugly hack to make sure that the help options always come first
1518 if( !psz_search && b_help_module )
1521 /* Ignore modules with only advanced config options if requested */
1524 for( p_item = p_parser->p_config;
1528 if( (p_item->i_type & CONFIG_ITEM) &&
1529 !p_item->b_advanced && !p_item->b_removed ) break;
1532 if( p_item == p_end )
1541 /* Print name of module */
1542 if( strcmp( "main", p_parser->psz_object_name ) )
1545 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1546 _( p_parser->psz_longname ),
1547 p_parser->psz_object_name );
1549 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1551 if( p_parser->psz_help )
1554 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1555 _( p_parser->psz_help ) );
1557 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1560 /* Print module options */
1561 for( p_item = p_parser->p_config;
1565 char *psz_text, *psz_spaces = psz_spaces_text;
1566 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1567 const char *psz_suf = "", *psz_prefix = NULL;
1571 /* Skip removed options */
1572 if( p_item->b_removed )
1576 /* Skip advanced options if requested */
1577 if( p_item->b_advanced && !b_advanced )
1579 b_has_advanced = true;
1583 switch( p_item->i_type )
1585 case CONFIG_HINT_CATEGORY:
1586 case CONFIG_HINT_USAGE:
1587 if( !strcmp( "main", p_parser->psz_object_name ) )
1590 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1591 _( p_item->psz_text ) );
1593 utf8_fprintf( stdout, "\n %s\n",
1594 _( p_item->psz_text ) );
1596 if( b_description && p_item->psz_longtext )
1599 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1600 _( p_item->psz_longtext ) );
1602 utf8_fprintf( stdout, " %s\n",
1603 _( p_item->psz_longtext ) );
1607 case CONFIG_HINT_SUBCATEGORY:
1608 if( strcmp( "main", p_parser->psz_object_name ) )
1610 case CONFIG_SECTION:
1614 case CONFIG_ITEM_STRING:
1615 case CONFIG_ITEM_FILE:
1616 case CONFIG_ITEM_DIRECTORY:
1617 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1618 case CONFIG_ITEM_MODULE_CAT:
1619 case CONFIG_ITEM_MODULE_LIST:
1620 case CONFIG_ITEM_MODULE_LIST_CAT:
1621 case CONFIG_ITEM_FONT:
1622 case CONFIG_ITEM_PASSWORD:
1623 print_help_section( p_section, b_color, b_description );
1625 psz_bra = OPTION_VALUE_SEP "<";
1626 psz_type = _("string");
1629 if( p_item->ppsz_list )
1631 psz_bra = OPTION_VALUE_SEP "{";
1632 psz_type = psz_buffer;
1633 psz_buffer[0] = '\0';
1634 for( i = 0; p_item->ppsz_list[i]; i++ )
1636 if( i ) strcat( psz_buffer, "," );
1637 strcat( psz_buffer, p_item->ppsz_list[i] );
1642 case CONFIG_ITEM_INTEGER:
1643 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1644 print_help_section( p_section, b_color, b_description );
1646 psz_bra = OPTION_VALUE_SEP "<";
1647 psz_type = _("integer");
1650 if( p_item->min.i || p_item->max.i )
1652 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1653 p_item->min.i, p_item->max.i );
1654 psz_type = psz_buffer;
1657 if( p_item->i_list )
1659 psz_bra = OPTION_VALUE_SEP "{";
1660 psz_type = psz_buffer;
1661 psz_buffer[0] = '\0';
1662 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1664 if( i ) strcat( psz_buffer, ", " );
1665 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1667 _( p_item->ppsz_list_text[i] ) );
1672 case CONFIG_ITEM_FLOAT:
1673 print_help_section( p_section, b_color, b_description );
1675 psz_bra = OPTION_VALUE_SEP "<";
1676 psz_type = _("float");
1678 if( p_item->min.f || p_item->max.f )
1680 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1681 p_item->min.f, p_item->max.f );
1682 psz_type = psz_buffer;
1685 case CONFIG_ITEM_BOOL:
1686 print_help_section( p_section, b_color, b_description );
1688 psz_bra = ""; psz_type = ""; psz_ket = "";
1689 if( !b_help_module )
1691 psz_suf = p_item->value.i ? _(" (default enabled)") :
1692 _(" (default disabled)");
1702 /* Add short option if any */
1703 if( p_item->i_short )
1705 sprintf( psz_short, "-%c,", p_item->i_short );
1709 strcpy( psz_short, " " );
1712 i = PADDING_SPACES - strlen( p_item->psz_name )
1713 - strlen( psz_bra ) - strlen( psz_type )
1714 - strlen( psz_ket ) - 1;
1716 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1718 psz_prefix = ", --no-";
1719 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1724 psz_spaces[0] = '\n';
1729 psz_spaces[i] = '\0';
1732 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1734 utf8_fprintf( stdout, psz_format_bool, psz_short,
1735 p_item->psz_name, psz_prefix, p_item->psz_name,
1736 psz_bra, psz_type, psz_ket, psz_spaces );
1740 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1741 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1744 psz_spaces[i] = ' ';
1746 /* We wrap the rest of the output */
1747 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1749 b_description_hack = b_description;
1752 psz_text = psz_buffer;
1753 i_cur_width = b_description && !b_description_hack
1754 ? i_width_description
1758 char *psz_parser, *psz_word;
1759 size_t i_end = strlen( psz_text );
1761 /* If the remaining text fits in a line, print it. */
1762 if( i_end <= i_cur_width )
1766 if( !b_description || b_description_hack )
1767 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1769 utf8_fprintf( stdout, "%s\n", psz_text );
1773 utf8_fprintf( stdout, "%s\n", psz_text );
1778 /* Otherwise, eat as many words as possible */
1779 psz_parser = psz_text;
1782 psz_word = psz_parser;
1783 psz_parser = strchr( psz_word, ' ' );
1784 /* If no space was found, we reached the end of the text
1785 * block; otherwise, we skip the space we just found. */
1786 psz_parser = psz_parser ? psz_parser + 1
1789 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1791 /* We cut a word in one of these cases:
1792 * - it's the only word in the line and it's too long.
1793 * - we used less than 80% of the width and the word we are
1794 * going to wrap is longer than 40% of the width, and even
1795 * if the word would have fit in the next line. */
1796 if( psz_word == psz_text
1797 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1798 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1800 char c = psz_text[i_cur_width];
1801 psz_text[i_cur_width] = '\0';
1804 if( !b_description || b_description_hack )
1805 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1806 psz_text, psz_spaces );
1808 utf8_fprintf( stdout, "%s\n%s",
1809 psz_text, psz_spaces );
1813 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1815 psz_text += i_cur_width;
1820 psz_word[-1] = '\0';
1823 if( !b_description || b_description_hack )
1824 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1825 psz_text, psz_spaces );
1827 utf8_fprintf( stdout, "%s\n%s",
1828 psz_text, psz_spaces );
1832 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1834 psz_text = psz_word;
1838 if( b_description_hack && p_item->psz_longtext )
1840 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1842 b_description_hack = false;
1843 psz_spaces = psz_spaces_longtext;
1844 utf8_fprintf( stdout, "%s", psz_spaces );
1850 if( b_has_advanced )
1853 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1854 _( "add --advanced to your command line to see advanced options."));
1856 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1857 _( "add --advanced to your command line to see advanced options."));
1860 if( i_only_advanced > 0 )
1864 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1865 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1869 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1870 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1876 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1877 _( "No matching module found. Use --list or " \
1878 "--list-verbose to list available modules." ) );
1880 utf8_fprintf( stdout, "\n%s\n",
1881 _( "No matching module found. Use --list or " \
1882 "--list-verbose to list available modules." ) );
1885 /* Release the module list */
1886 module_list_free (list);
1889 /*****************************************************************************
1890 * ListModules: list the available modules with their description
1891 *****************************************************************************
1892 * Print a list of all available modules (builtins and plugins) and a short
1893 * description for each one.
1894 *****************************************************************************/
1895 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1899 bool b_color = var_InheritBool( p_this, "color" );
1902 ShowConsole( true );
1903 b_color = false; // don't put color control codes in a .txt file
1909 /* List all modules */
1910 module_t **list = module_list_get (NULL);
1912 /* Enumerate each module */
1913 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1916 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1917 p_parser->psz_object_name,
1918 _( p_parser->psz_longname ) );
1920 utf8_fprintf( stdout, " %-22s %s\n",
1921 p_parser->psz_object_name,
1922 _( p_parser->psz_longname ) );
1926 char *const *pp_shortcut = p_parser->pp_shortcuts;
1927 while( *pp_shortcut )
1929 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1932 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1935 utf8_fprintf( stdout, " s %s\n",
1940 if( p_parser->psz_capability )
1943 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1944 p_parser->psz_capability,
1945 p_parser->i_score );
1947 utf8_fprintf( stdout, " c %s (%d)\n",
1948 p_parser->psz_capability,
1949 p_parser->i_score );
1953 module_list_free (list);
1955 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1960 /*****************************************************************************
1961 * Version: print complete program version
1962 *****************************************************************************
1963 * Print complete program version and build number.
1964 *****************************************************************************/
1965 static void Version( void )
1967 extern const char psz_vlc_changeset[];
1969 ShowConsole( true );
1972 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1973 psz_vlc_changeset );
1974 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1975 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1976 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1977 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1979 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1984 /*****************************************************************************
1985 * ShowConsole: On Win32, create an output console for debug messages
1986 *****************************************************************************
1987 * This function is useful only on Win32.
1988 *****************************************************************************/
1990 static void ShowConsole( bool b_dofile )
1993 FILE *f_help = NULL;
1995 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1998 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1999 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2000 * page (e.g. CP437 or CP850). */
2001 SetConsoleOutputCP (GetACP ());
2002 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2004 freopen( "CONOUT$", "w", stderr );
2005 freopen( "CONIN$", "r", stdin );
2007 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2010 freopen( "vlc-help.txt", "wt", stdout );
2011 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2013 else freopen( "CONOUT$", "w", stdout );
2019 /*****************************************************************************
2020 * PauseConsole: On Win32, wait for a key press before closing the console
2021 *****************************************************************************
2022 * This function is useful only on Win32.
2023 *****************************************************************************/
2025 static void PauseConsole( void )
2029 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2031 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2039 /*****************************************************************************
2040 * ConsoleWidth: Return the console width in characters
2041 *****************************************************************************
2042 * We use the stty shell command to get the console width; if this fails or
2043 * if the width is less than 80, we default to 80.
2044 *****************************************************************************/
2045 static int ConsoleWidth( void )
2047 unsigned i_width = 80;
2050 FILE *file = popen( "stty size 2>/dev/null", "r" );
2053 if (fscanf (file, "%*u %u", &i_width) <= 0)
2057 #elif !defined (UNDER_CE)
2058 CONSOLE_SCREEN_BUFFER_INFO buf;
2060 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2061 i_width = buf.dwSize.X;
2067 #include <vlc_avcodec.h>
2069 void vlc_avcodec_mutex (bool acquire)
2071 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2074 vlc_mutex_lock (&lock);
2076 vlc_mutex_unlock (&lock);