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 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
431 config_LoadConfigFile( p_libvlc, "main" );
432 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
433 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
435 /* Check if the user specified a custom language */
436 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
437 if( psz_language && strcmp( psz_language, "auto" ) )
439 /* Reset the default domain */
440 SetLanguage( psz_language );
442 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
443 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
445 free( psz_language );
450 * Load the builtins and plugins into the module_bank.
451 * We have to do it before config_Load*() because this also gets the
452 * list of configuration options exported by each module and loads their
455 module_LoadPlugins( p_libvlc, b_cache_delete );
456 if( p_libvlc->b_die )
462 module_t **list = module_list_get( &module_count );
463 module_list_free( list );
464 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
466 /* Check for help on modules */
467 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
469 Help( p_libvlc, p_tmp );
472 i_ret = VLC_EEXITSUCCESS;
474 /* Check for full help option */
475 else if( var_InheritBool( p_libvlc, "full-help" ) )
477 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
478 var_SetBool( p_libvlc, "advanced", true );
479 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
480 var_SetBool( p_libvlc, "help-verbose", true );
481 Help( p_libvlc, "full-help" );
483 i_ret = VLC_EEXITSUCCESS;
485 /* Check for long help option */
486 else if( var_InheritBool( p_libvlc, "longhelp" ) )
488 Help( p_libvlc, "longhelp" );
490 i_ret = VLC_EEXITSUCCESS;
492 /* Check for module list option */
493 else if( var_InheritBool( p_libvlc, "list" ) )
495 ListModules( p_libvlc, false );
497 i_ret = VLC_EEXITSUCCESS;
499 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
501 ListModules( p_libvlc, true );
503 i_ret = VLC_EEXITSUCCESS;
506 /* Check for config file options */
507 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
509 if( var_InheritBool( p_libvlc, "reset-config" ) )
511 config_ResetAll( p_libvlc );
512 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
513 config_SaveConfigFile( p_libvlc, NULL );
517 if( module_count <= 1)
519 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
520 "that you properly gave a module path with --plugin-path.");
527 module_EndBank( p_libvlc, true );
532 * Override default configuration with config file settings
534 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
535 config_LoadConfigFile( p_libvlc, NULL );
538 * Override configuration with command line settings
540 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
543 ShowConsole( false );
544 /* Pause the console because it's destroyed when we exit */
545 fprintf( stderr, "The command line options couldn't be loaded, check "
546 "that they are valid.\n" );
549 module_EndBank( p_libvlc, true );
552 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
555 * System specific configuration
557 system_Configure( p_libvlc, &i_argc, ppsz_argv );
559 /* FIXME: could be replaced by using Unix sockets */
561 dbus_threads_init_default();
563 if( var_InheritBool( p_libvlc, "one-instance" )
564 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
565 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
567 /* Initialise D-Bus interface, check for other instances */
568 DBusConnection *p_conn = NULL;
569 DBusError dbus_error;
571 dbus_error_init( &dbus_error );
573 /* connect to the session bus */
574 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
577 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
578 dbus_error.message );
579 dbus_error_free( &dbus_error );
583 /* check if VLC is available on the bus
584 * if not: D-Bus control is not enabled on the other
585 * instance and we can't pass MRLs to it */
586 DBusMessage *p_test_msg = NULL;
587 DBusMessage *p_test_reply = NULL;
588 p_test_msg = dbus_message_new_method_call(
589 "org.mpris.vlc", "/",
590 "org.freedesktop.MediaPlayer", "Identity" );
591 /* block until a reply arrives */
592 p_test_reply = dbus_connection_send_with_reply_and_block(
593 p_conn, p_test_msg, -1, &dbus_error );
594 dbus_message_unref( p_test_msg );
595 if( p_test_reply == NULL )
597 dbus_error_free( &dbus_error );
598 msg_Dbg( p_libvlc, "No Media Player is running. "
599 "Continuing normally." );
604 DBusMessage* p_dbus_msg = NULL;
605 DBusMessageIter dbus_args;
606 DBusPendingCall* p_dbus_pending = NULL;
609 dbus_message_unref( p_test_reply );
610 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
612 for( i_input = optind;i_input < i_argc;i_input++ )
614 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
615 ppsz_argv[i_input] );
617 p_dbus_msg = dbus_message_new_method_call(
618 "org.mpris.vlc", "/TrackList",
619 "org.freedesktop.MediaPlayer", "AddTrack" );
621 if ( NULL == p_dbus_msg )
623 msg_Err( p_libvlc, "D-Bus problem" );
624 system_End( p_libvlc );
629 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
630 if ( !dbus_message_iter_append_basic( &dbus_args,
631 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
633 dbus_message_unref( p_dbus_msg );
634 system_End( p_libvlc );
638 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
640 if ( !dbus_message_iter_append_basic( &dbus_args,
641 DBUS_TYPE_BOOLEAN, &b_play ) )
643 dbus_message_unref( p_dbus_msg );
644 system_End( p_libvlc );
648 /* send message and get a handle for a reply */
649 if ( !dbus_connection_send_with_reply ( p_conn,
650 p_dbus_msg, &p_dbus_pending, -1 ) )
652 msg_Err( p_libvlc, "D-Bus problem" );
653 dbus_message_unref( p_dbus_msg );
654 system_End( p_libvlc );
658 if ( NULL == p_dbus_pending )
660 msg_Err( p_libvlc, "D-Bus problem" );
661 dbus_message_unref( p_dbus_msg );
662 system_End( p_libvlc );
665 dbus_connection_flush( p_conn );
666 dbus_message_unref( p_dbus_msg );
667 /* block until we receive a reply */
668 dbus_pending_call_block( p_dbus_pending );
669 dbus_pending_call_unref( p_dbus_pending );
670 } /* processes all command line MRLs */
673 system_End( p_libvlc );
677 /* we unreference the connection when we've finished with it */
678 if( p_conn ) dbus_connection_unref( p_conn );
683 * Message queue options
685 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
686 if( psz_verbose_objects )
688 char * psz_object, * iter = psz_verbose_objects;
689 while( (psz_object = strsep( &iter, "," )) )
691 switch( psz_object[0] )
693 printf("%s\n", psz_object+1);
694 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
695 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
697 msg_Err( p_libvlc, "verbose-objects usage: \n"
698 "--verbose-objects=+printthatobject,"
699 "-dontprintthatone\n"
700 "(keyword 'all' to applies to all objects)");
701 free( psz_verbose_objects );
702 /* FIXME: leaks!!!! */
706 free( psz_verbose_objects );
709 /* Last chance to set the verbosity. Once we start interfaces and other
710 * threads, verbosity becomes read-only. */
711 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
712 if( var_InheritBool( p_libvlc, "quiet" ) )
714 var_SetInteger( p_libvlc, "verbose", -1 );
715 priv->i_verbose = -1;
717 vlc_threads_setup( p_libvlc );
720 priv->b_color = var_InheritBool( p_libvlc, "color" );
722 char p_capabilities[200];
723 #define PRINT_CAPABILITY( capability, string ) \
724 if( vlc_CPU() & capability ) \
726 strncat( p_capabilities, string " ", \
727 sizeof(p_capabilities) - strlen(p_capabilities) ); \
728 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
730 p_capabilities[0] = '\0';
732 #if defined( __i386__ ) || defined( __x86_64__ )
733 if( !var_InheritBool( p_libvlc, "mmx" ) )
734 cpu_flags &= ~CPU_CAPABILITY_MMX;
735 if( !var_InheritBool( p_libvlc, "3dn" ) )
736 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
737 if( !var_InheritBool( p_libvlc, "mmxext" ) )
738 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
739 if( !var_InheritBool( p_libvlc, "sse" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE;
741 if( !var_InheritBool( p_libvlc, "sse2" ) )
742 cpu_flags &= ~CPU_CAPABILITY_SSE2;
743 if( !var_InheritBool( p_libvlc, "sse3" ) )
744 cpu_flags &= ~CPU_CAPABILITY_SSE3;
745 if( !var_InheritBool( p_libvlc, "ssse3" ) )
746 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
747 if( !var_InheritBool( p_libvlc, "sse41" ) )
748 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
749 if( !var_InheritBool( p_libvlc, "sse42" ) )
750 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
752 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
755 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
756 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
757 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
758 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
759 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
760 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
761 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
763 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
764 if( !var_InheritBool( p_libvlc, "altivec" ) )
765 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
767 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
769 #elif defined( __arm__ )
770 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
775 strncat( p_capabilities, "FPU ",
776 sizeof(p_capabilities) - strlen( p_capabilities) );
777 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
780 if (p_capabilities[0])
781 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
784 * Choose the best memcpy module
786 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
787 /* Avoid being called "memcpy":*/
788 vlc_object_set_name( p_libvlc, "main" );
790 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
792 priv->pp_timers = NULL;
794 priv->i_last_input_id = 0; /* Not very safe, should be removed */
797 * Initialize hotkey handling
799 vlc_InitActions( p_libvlc );
801 /* variables for signalling creation of new files */
802 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
803 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
805 /* Initialize playlist and get commandline files */
806 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
809 msg_Err( p_libvlc, "playlist initialization failed" );
810 if( priv->p_memcpy_module != NULL )
812 module_unneed( p_libvlc, priv->p_memcpy_module );
814 module_EndBank( p_libvlc, true );
817 playlist_Activate( p_playlist );
818 vlc_object_attach( p_playlist, p_libvlc );
820 /* Add service discovery modules */
821 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
824 char *p = psz_modules, *m;
825 while( ( m = strsep( &p, " :," ) ) != NULL )
826 playlist_ServicesDiscoveryAdd( p_playlist, m );
831 /* Initialize VLM if vlm-conf is specified */
832 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
835 priv->p_vlm = vlm_New( p_libvlc );
837 msg_Err( p_libvlc, "VLM initialization failed" );
843 * Load background interfaces
845 /* Create volume callback system. (this variable must be created before
846 all interfaces as they can use it) */
847 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
848 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
850 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
851 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
853 if( psz_modules && psz_control )
856 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
859 psz_modules = psz_tmp;
862 else if( psz_control )
865 psz_modules = strdup( psz_control );
868 psz_parser = psz_modules;
869 while ( psz_parser && *psz_parser )
871 char *psz_module, *psz_temp;
872 psz_module = psz_parser;
873 psz_parser = strchr( psz_module, ':' );
879 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
881 intf_Create( p_libvlc, psz_temp );
889 * Always load the hotkeys interface if it exists
891 intf_Create( p_libvlc, "hotkeys,none" );
894 /* loads dbus control interface if in one-instance mode
895 * we do it only when playlist exists, because dbus module needs it */
896 if( var_InheritBool( p_libvlc, "one-instance" )
897 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
898 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
899 intf_Create( p_libvlc, "dbus,none" );
901 # if !defined (HAVE_MAEMO)
902 /* Prevents the power management daemon from suspending the system
903 * when VLC is active */
904 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
905 intf_Create( p_libvlc, "inhibit,none" );
909 if( var_InheritBool( p_libvlc, "file-logging" ) &&
910 !var_InheritBool( p_libvlc, "syslog" ) )
912 intf_Create( p_libvlc, "logger,none" );
915 if( var_InheritBool( p_libvlc, "syslog" ) )
917 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
918 var_SetString( p_libvlc, "logmode", "syslog" );
919 intf_Create( p_libvlc, "logger,none" );
923 var_SetString( p_libvlc, "logmode", logmode );
926 var_Destroy( p_libvlc, "logmode" );
930 if( var_InheritBool( p_libvlc, "network-synchronisation") )
932 intf_Create( p_libvlc, "netsync,none" );
936 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
938 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
941 char *psz_morecodecs;
942 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
944 var_SetString( p_libvlc, "codec", psz_morecodecs);
945 free( psz_morecodecs );
950 var_SetString( p_libvlc, "codec", "dmo,quicktime");
954 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
956 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
957 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
958 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
959 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
960 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
961 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
964 /* Create a variable for showing the fullscreen interface from hotkeys */
965 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
966 var_SetBool( p_libvlc, "intf-show", true );
968 /* Create a variable for showing the right click menu */
969 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
972 * Get input filenames given as commandline arguments
974 GetFilenames( p_libvlc, i_argc, ppsz_argv );
977 * Get --open argument
979 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
980 if ( psz_val != NULL )
982 playlist_t *p_playlist = pl_Hold( p_libvlc );
983 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
984 -1, 0, NULL, 0, true, pl_Unlocked );
985 pl_Release( p_libvlc );
993 * Cleanup a libvlc instance. The instance is not completely deallocated
994 * \param p_libvlc the instance to clean
996 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
998 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
999 playlist_t *p_playlist = priv->p_playlist;
1001 /* Deactivate the playlist */
1002 msg_Dbg( p_libvlc, "deactivating the playlist" );
1003 playlist_Deactivate( p_playlist );
1005 /* Remove all services discovery */
1006 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1007 playlist_ServicesDiscoveryKillAll( p_playlist );
1009 /* Ask the interfaces to stop and destroy them */
1010 msg_Dbg( p_libvlc, "removing all interfaces" );
1011 libvlc_Quit( p_libvlc );
1012 intf_DestroyAll( p_libvlc );
1015 /* Destroy VLM if created in libvlc_InternalInit */
1018 vlm_Delete( priv->p_vlm );
1023 /* Any thread still running must not assume pl_Hold() succeeds. */
1024 msg_Dbg( p_libvlc, "removing playlist" );
1026 libvlc_priv(p_libvlc)->p_playlist = NULL;
1027 barrier(); /* FIXME is that correct ? */
1029 vlc_object_release( p_playlist );
1031 stats_TimersDumpAll( p_libvlc );
1032 stats_TimersCleanAll( p_libvlc );
1034 msg_Dbg( p_libvlc, "removing stats" );
1037 char* psz_pidfile = NULL;
1041 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1042 if( psz_pidfile != NULL )
1044 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1045 if( unlink( psz_pidfile ) == -1 )
1047 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1051 free( psz_pidfile );
1055 if( priv->p_memcpy_module )
1057 module_unneed( p_libvlc, priv->p_memcpy_module );
1058 priv->p_memcpy_module = NULL;
1061 /* Free module bank. It is refcounted, so we call this each time */
1062 module_EndBank( p_libvlc, true );
1064 vlc_DeinitActions( p_libvlc );
1068 * Destroy everything.
1069 * This function requests the running threads to finish, waits for their
1070 * termination, and destroys their structure.
1071 * It stops the thread systems: no instance can run after this has run
1072 * \param p_libvlc the instance to destroy
1074 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1076 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1078 vlc_mutex_lock( &global_lock );
1081 if( i_instances == 0 )
1083 /* System specific cleaning code */
1084 system_End( p_libvlc );
1086 vlc_mutex_unlock( &global_lock );
1088 msg_Destroy( p_libvlc );
1090 /* Destroy mutexes */
1091 vlc_mutex_destroy( &priv->timer_lock );
1093 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1094 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1095 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1096 vlc_object_release( p_libvlc );
1099 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1100 vlc_object_release( p_libvlc );
1104 * Add an interface plugin and run it
1106 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1109 return VLC_EGENERIC;
1111 if( !psz_module ) /* requesting the default interface */
1113 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1114 if( !psz_interface ) /* "intf" has not been set */
1118 /* Daemon mode hack.
1119 * We prefer the dummy interface if none is specified. */
1120 psz_module = "dummy";
1123 msg_Info( p_libvlc, "%s",
1124 _("Running vlc with the default interface. "
1125 "Use 'cvlc' to use vlc without interface.") );
1127 free( psz_interface );
1128 var_Destroy( p_libvlc, "intf" );
1131 /* Try to create the interface */
1132 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1134 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1135 psz_module ? psz_module : "default" );
1140 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1141 static vlc_cond_t exiting = VLC_STATIC_COND;
1143 extern vlc_mutex_t super_mutex;
1144 extern vlc_cond_t super_variable;
1145 # define exit_lock super_mutex
1146 # define exiting super_variable
1150 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1151 * when the user "exits" an interface plugin.
1153 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1155 vlc_mutex_lock( &exit_lock );
1156 while( vlc_object_alive( p_libvlc ) )
1157 vlc_cond_wait( &exiting, &exit_lock );
1158 vlc_mutex_unlock( &exit_lock );
1162 * Posts an exit signal to LibVLC instance. This will normally initiate the
1163 * cleanup and destroy process. It should only be called on behalf of the user.
1165 void libvlc_Quit( libvlc_int_t *p_libvlc )
1167 vlc_mutex_lock( &exit_lock );
1168 vlc_object_kill( p_libvlc );
1169 vlc_cond_broadcast( &exiting );
1170 vlc_mutex_unlock( &exit_lock );
1173 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1174 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1175 /*****************************************************************************
1176 * SetLanguage: set the interface language.
1177 *****************************************************************************
1178 * We set the LC_MESSAGES locale category for interface messages and buttons,
1179 * as well as the LC_CTYPE category for string sorting and possible wide
1180 * character support.
1181 *****************************************************************************/
1182 static void SetLanguage ( const char *psz_lang )
1185 /* I need that under Darwin, please check it doesn't disturb
1186 * other platforms. --Meuuh */
1187 setenv( "LANG", psz_lang, 1 );
1190 /* We set LC_ALL manually because it is the only way to set
1191 * the language at runtime under eg. Windows. Beware that this
1192 * makes the environment unconsistent when libvlc is unloaded and
1193 * should probably be moved to a safer place like vlc.c. */
1194 static char psz_lcall[20];
1195 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1196 psz_lcall[19] = '\0';
1197 putenv( psz_lcall );
1200 setlocale( LC_ALL, psz_lang );
1205 static inline int LoadMessages (void)
1207 #if defined( ENABLE_NLS ) \
1208 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1209 /* Specify where to find the locales for current domain */
1210 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1211 static const char psz_path[] = LOCALEDIR;
1213 char psz_path[1024];
1214 char *datadir = config_GetDataDirDefault();
1217 if (unlikely(datadir == NULL))
1219 ret = snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "locale",
1222 if (ret >= (int)sizeof (psz_path))
1225 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1227 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1228 " to directory %s\n", psz_path);
1232 /* LibVLC wants all messages in UTF-8.
1233 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1234 * and other functions that are not part of our text domain.
1236 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1238 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1240 // Unbinds the text domain to avoid broken encoding
1241 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1245 /* LibVLC does NOT set the default textdomain, since it is a library.
1246 * This could otherwise break programs using LibVLC (other than VLC).
1247 * textdomain (PACKAGE_NAME);
1253 /*****************************************************************************
1254 * GetFilenames: parse command line options which are not flags
1255 *****************************************************************************
1256 * Parse command line for input files as well as their associated options.
1257 * An option always follows its associated input and begins with a ":".
1258 *****************************************************************************/
1259 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1261 int i_opt, i_options;
1263 /* We assume that the remaining parameters are filenames
1264 * and their input options */
1265 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1269 /* Count the input options */
1270 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1276 /* TODO: write an internal function of this one, to avoid
1277 * unnecessary lookups. */
1278 char *mrl = make_URI( ppsz_argv[i_opt] );
1282 playlist_t *p_playlist = pl_Hold( p_vlc );
1283 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1284 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1285 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1286 pl_Release( p_vlc );
1293 /*****************************************************************************
1294 * Help: print program help
1295 *****************************************************************************
1296 * Print a short inline help. Message interface is initialized at this stage.
1297 *****************************************************************************/
1298 static inline void print_help_on_full_help( void )
1300 utf8_fprintf( stdout, "\n" );
1301 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1304 static const char vlc_usage[] = N_(
1305 "Usage: %s [options] [stream] ..."
1306 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1307 "\nThe first item specified will be played first."
1310 "\n --option A global option that is set for the duration of the program."
1311 "\n -option A single letter version of a global --option."
1312 "\n :option An option that only applies to the stream directly before it"
1313 "\n and that overrides previous settings."
1315 "\nStream MRL syntax:"
1316 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1318 "\n Many of the global --options can also be used as MRL specific :options."
1319 "\n Multiple :option=value pairs can be specified."
1322 "\n [file://]filename Plain media file"
1323 "\n http://ip:port/file HTTP URL"
1324 "\n ftp://ip:port/file FTP URL"
1325 "\n mms://ip:port/file MMS URL"
1326 "\n screen:// Screen capture"
1327 "\n [dvd://][device][@raw_device] DVD device"
1328 "\n [vcd://][device] VCD device"
1329 "\n [cdda://][device] Audio CD device"
1330 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1331 "\n UDP stream sent by a streaming server"
1332 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1333 "\n vlc://quit Special item to quit VLC"
1336 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1339 ShowConsole( true );
1342 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1344 utf8_fprintf( stdout, vlc_usage, "vlc" );
1345 Usage( p_this, "=help" );
1346 Usage( p_this, "=main" );
1347 print_help_on_full_help();
1349 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1351 utf8_fprintf( stdout, vlc_usage, "vlc" );
1352 Usage( p_this, NULL );
1353 print_help_on_full_help();
1355 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1357 utf8_fprintf( stdout, vlc_usage, "vlc" );
1358 Usage( p_this, NULL );
1360 else if( psz_help_name )
1362 Usage( p_this, psz_help_name );
1365 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1370 /*****************************************************************************
1371 * Usage: print module usage
1372 *****************************************************************************
1373 * Print a short inline help. Message interface is initialized at this stage.
1374 *****************************************************************************/
1375 # define COL(x) "\033[" #x ";1m"
1376 # define RED COL(31)
1377 # define GREEN COL(32)
1378 # define YELLOW COL(33)
1379 # define BLUE COL(34)
1380 # define MAGENTA COL(35)
1381 # define CYAN COL(36)
1382 # define WHITE COL(0)
1383 # define GRAY "\033[0m"
1384 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1386 if( !p_item ) return;
1389 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1390 if( b_description && p_item->psz_longtext )
1391 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1392 _( p_item->psz_longtext ) );
1396 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1397 if( b_description && p_item->psz_longtext )
1398 utf8_fprintf( stdout, " %s\n", _( p_item->psz_longtext ) );
1402 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1404 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1405 /* short option ------' | | | | | | |
1406 * option name ------------' | | | | | |
1407 * <bra ---------------------' | | | | |
1408 * option type or "" ----------' | | | |
1409 * ket> -------------------------' | | |
1410 * padding spaces -----------------' | |
1411 * comment --------------------------' |
1412 * comment suffix ---------------------'
1414 * The purpose of having bra and ket is that we might i18n them as well.
1417 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1418 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1420 #define LINE_START 8
1421 #define PADDING_SPACES 25
1423 # define OPTION_VALUE_SEP "="
1425 # define OPTION_VALUE_SEP " "
1427 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1428 char psz_spaces_longtext[LINE_START+3];
1429 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1430 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1431 char psz_buffer[10000];
1433 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1434 int i_width_description = i_width + PADDING_SPACES - 1;
1435 bool b_advanced = var_InheritBool( p_this, "advanced" );
1436 bool b_description = var_InheritBool( p_this, "help-verbose" );
1437 bool b_description_hack;
1438 bool b_color = var_InheritBool( p_this, "color" );
1439 bool b_has_advanced = false;
1440 bool b_found = false;
1441 int i_only_advanced = 0; /* Number of modules ignored because they
1442 * only have advanced options */
1443 bool b_strict = psz_search && *psz_search == '=';
1444 if( b_strict ) psz_search++;
1446 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1447 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1448 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1449 psz_spaces_longtext[LINE_START+2] = '\0';
1453 b_color = false; // don't put color control codes in a .txt file
1457 strcpy( psz_format, COLOR_FORMAT_STRING );
1458 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1462 strcpy( psz_format, FORMAT_STRING );
1463 strcpy( psz_format_bool, FORMAT_STRING );
1466 /* List all modules */
1467 module_t **list = module_list_get (NULL);
1471 /* Ugly hack to make sure that the help options always come first
1474 Usage( p_this, "help" );
1476 /* Enumerate the config for each module */
1477 for (size_t i = 0; list[i]; i++)
1480 module_t *p_parser = list[i];
1481 module_config_t *p_item = NULL;
1482 module_config_t *p_section = NULL;
1483 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1486 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1487 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1489 char *const *pp_shortcut = p_parser->pp_shortcuts;
1490 while( *pp_shortcut )
1492 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1493 : !!strstr( *pp_shortcut, psz_search ) )
1501 /* Ignore modules without config options */
1502 if( !p_parser->i_config_items )
1507 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1508 /* Ugly hack to make sure that the help options always come first
1510 if( !psz_search && b_help_module )
1513 /* Ignore modules with only advanced config options if requested */
1516 for( p_item = p_parser->p_config;
1520 if( (p_item->i_type & CONFIG_ITEM) &&
1521 !p_item->b_advanced && !p_item->b_removed ) break;
1524 if( p_item == p_end )
1533 /* Print name of module */
1534 if( strcmp( "main", p_parser->psz_object_name ) )
1537 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1538 _( p_parser->psz_longname ),
1539 p_parser->psz_object_name );
1541 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1543 if( p_parser->psz_help )
1546 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1547 _( p_parser->psz_help ) );
1549 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1552 /* Print module options */
1553 for( p_item = p_parser->p_config;
1557 char *psz_text, *psz_spaces = psz_spaces_text;
1558 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1559 const char *psz_suf = "", *psz_prefix = NULL;
1563 /* Skip removed options */
1564 if( p_item->b_removed )
1568 /* Skip advanced options if requested */
1569 if( p_item->b_advanced && !b_advanced )
1571 b_has_advanced = true;
1575 switch( p_item->i_type )
1577 case CONFIG_HINT_CATEGORY:
1578 case CONFIG_HINT_USAGE:
1579 if( !strcmp( "main", p_parser->psz_object_name ) )
1582 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1583 _( p_item->psz_text ) );
1585 utf8_fprintf( stdout, "\n %s\n",
1586 _( p_item->psz_text ) );
1588 if( b_description && p_item->psz_longtext )
1591 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1592 _( p_item->psz_longtext ) );
1594 utf8_fprintf( stdout, " %s\n",
1595 _( p_item->psz_longtext ) );
1599 case CONFIG_HINT_SUBCATEGORY:
1600 if( strcmp( "main", p_parser->psz_object_name ) )
1602 case CONFIG_SECTION:
1606 case CONFIG_ITEM_STRING:
1607 case CONFIG_ITEM_FILE:
1608 case CONFIG_ITEM_DIRECTORY:
1609 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1610 case CONFIG_ITEM_MODULE_CAT:
1611 case CONFIG_ITEM_MODULE_LIST:
1612 case CONFIG_ITEM_MODULE_LIST_CAT:
1613 case CONFIG_ITEM_FONT:
1614 case CONFIG_ITEM_PASSWORD:
1615 print_help_section( p_section, b_color, b_description );
1617 psz_bra = OPTION_VALUE_SEP "<";
1618 psz_type = _("string");
1621 if( p_item->ppsz_list )
1623 psz_bra = OPTION_VALUE_SEP "{";
1624 psz_type = psz_buffer;
1625 psz_buffer[0] = '\0';
1626 for( i = 0; p_item->ppsz_list[i]; i++ )
1628 if( i ) strcat( psz_buffer, "," );
1629 strcat( psz_buffer, p_item->ppsz_list[i] );
1634 case CONFIG_ITEM_INTEGER:
1635 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1636 print_help_section( p_section, b_color, b_description );
1638 psz_bra = OPTION_VALUE_SEP "<";
1639 psz_type = _("integer");
1642 if( p_item->min.i || p_item->max.i )
1644 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1645 p_item->min.i, p_item->max.i );
1646 psz_type = psz_buffer;
1649 if( p_item->i_list )
1651 psz_bra = OPTION_VALUE_SEP "{";
1652 psz_type = psz_buffer;
1653 psz_buffer[0] = '\0';
1654 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1656 if( i ) strcat( psz_buffer, ", " );
1657 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1659 _( p_item->ppsz_list_text[i] ) );
1664 case CONFIG_ITEM_FLOAT:
1665 print_help_section( p_section, b_color, b_description );
1667 psz_bra = OPTION_VALUE_SEP "<";
1668 psz_type = _("float");
1670 if( p_item->min.f || p_item->max.f )
1672 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1673 p_item->min.f, p_item->max.f );
1674 psz_type = psz_buffer;
1677 case CONFIG_ITEM_BOOL:
1678 print_help_section( p_section, b_color, b_description );
1680 psz_bra = ""; psz_type = ""; psz_ket = "";
1681 if( !b_help_module )
1683 psz_suf = p_item->value.i ? _(" (default enabled)") :
1684 _(" (default disabled)");
1694 /* Add short option if any */
1695 if( p_item->i_short )
1697 sprintf( psz_short, "-%c,", p_item->i_short );
1701 strcpy( psz_short, " " );
1704 i = PADDING_SPACES - strlen( p_item->psz_name )
1705 - strlen( psz_bra ) - strlen( psz_type )
1706 - strlen( psz_ket ) - 1;
1708 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1710 psz_prefix = ", --no-";
1711 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1716 psz_spaces[0] = '\n';
1721 psz_spaces[i] = '\0';
1724 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1726 utf8_fprintf( stdout, psz_format_bool, psz_short,
1727 p_item->psz_name, psz_prefix, p_item->psz_name,
1728 psz_bra, psz_type, psz_ket, psz_spaces );
1732 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1733 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1736 psz_spaces[i] = ' ';
1738 /* We wrap the rest of the output */
1739 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1741 b_description_hack = b_description;
1744 psz_text = psz_buffer;
1745 i_cur_width = b_description && !b_description_hack
1746 ? i_width_description
1750 char *psz_parser, *psz_word;
1751 size_t i_end = strlen( psz_text );
1753 /* If the remaining text fits in a line, print it. */
1754 if( i_end <= i_cur_width )
1758 if( !b_description || b_description_hack )
1759 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1761 utf8_fprintf( stdout, "%s\n", psz_text );
1765 utf8_fprintf( stdout, "%s\n", psz_text );
1770 /* Otherwise, eat as many words as possible */
1771 psz_parser = psz_text;
1774 psz_word = psz_parser;
1775 psz_parser = strchr( psz_word, ' ' );
1776 /* If no space was found, we reached the end of the text
1777 * block; otherwise, we skip the space we just found. */
1778 psz_parser = psz_parser ? psz_parser + 1
1781 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1783 /* We cut a word in one of these cases:
1784 * - it's the only word in the line and it's too long.
1785 * - we used less than 80% of the width and the word we are
1786 * going to wrap is longer than 40% of the width, and even
1787 * if the word would have fit in the next line. */
1788 if( psz_word == psz_text
1789 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1790 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1792 char c = psz_text[i_cur_width];
1793 psz_text[i_cur_width] = '\0';
1796 if( !b_description || b_description_hack )
1797 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1798 psz_text, psz_spaces );
1800 utf8_fprintf( stdout, "%s\n%s",
1801 psz_text, psz_spaces );
1805 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1807 psz_text += i_cur_width;
1812 psz_word[-1] = '\0';
1815 if( !b_description || b_description_hack )
1816 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1817 psz_text, psz_spaces );
1819 utf8_fprintf( stdout, "%s\n%s",
1820 psz_text, psz_spaces );
1824 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1826 psz_text = psz_word;
1830 if( b_description_hack && p_item->psz_longtext )
1832 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1834 b_description_hack = false;
1835 psz_spaces = psz_spaces_longtext;
1836 utf8_fprintf( stdout, "%s", psz_spaces );
1842 if( b_has_advanced )
1845 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1846 _( "add --advanced to your command line to see advanced options."));
1848 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1849 _( "add --advanced to your command line to see advanced options."));
1852 if( i_only_advanced > 0 )
1856 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1857 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1861 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1862 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1868 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1869 _( "No matching module found. Use --list or " \
1870 "--list-verbose to list available modules." ) );
1872 utf8_fprintf( stdout, "\n%s\n",
1873 _( "No matching module found. Use --list or " \
1874 "--list-verbose to list available modules." ) );
1877 /* Release the module list */
1878 module_list_free (list);
1881 /*****************************************************************************
1882 * ListModules: list the available modules with their description
1883 *****************************************************************************
1884 * Print a list of all available modules (builtins and plugins) and a short
1885 * description for each one.
1886 *****************************************************************************/
1887 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1891 bool b_color = var_InheritBool( p_this, "color" );
1894 ShowConsole( true );
1895 b_color = false; // don't put color control codes in a .txt file
1901 /* List all modules */
1902 module_t **list = module_list_get (NULL);
1904 /* Enumerate each module */
1905 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1908 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1909 p_parser->psz_object_name,
1910 _( p_parser->psz_longname ) );
1912 utf8_fprintf( stdout, " %-22s %s\n",
1913 p_parser->psz_object_name,
1914 _( p_parser->psz_longname ) );
1918 char *const *pp_shortcut = p_parser->pp_shortcuts;
1919 while( *pp_shortcut )
1921 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1924 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1927 utf8_fprintf( stdout, " s %s\n",
1932 if( p_parser->psz_capability )
1935 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1936 p_parser->psz_capability,
1937 p_parser->i_score );
1939 utf8_fprintf( stdout, " c %s (%d)\n",
1940 p_parser->psz_capability,
1941 p_parser->i_score );
1945 module_list_free (list);
1947 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1952 /*****************************************************************************
1953 * Version: print complete program version
1954 *****************************************************************************
1955 * Print complete program version and build number.
1956 *****************************************************************************/
1957 static void Version( void )
1959 extern const char psz_vlc_changeset[];
1961 ShowConsole( true );
1964 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1965 psz_vlc_changeset );
1966 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1967 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1968 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1969 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1971 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1976 /*****************************************************************************
1977 * ShowConsole: On Win32, create an output console for debug messages
1978 *****************************************************************************
1979 * This function is useful only on Win32.
1980 *****************************************************************************/
1982 static void ShowConsole( bool b_dofile )
1985 FILE *f_help = NULL;
1987 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1990 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1991 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1992 * page (e.g. CP437 or CP850). */
1993 SetConsoleOutputCP (GetACP ());
1994 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1996 freopen( "CONOUT$", "w", stderr );
1997 freopen( "CONIN$", "r", stdin );
1999 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2002 freopen( "vlc-help.txt", "wt", stdout );
2003 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2005 else freopen( "CONOUT$", "w", stdout );
2011 /*****************************************************************************
2012 * PauseConsole: On Win32, wait for a key press before closing the console
2013 *****************************************************************************
2014 * This function is useful only on Win32.
2015 *****************************************************************************/
2017 static void PauseConsole( void )
2021 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2023 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2031 /*****************************************************************************
2032 * ConsoleWidth: Return the console width in characters
2033 *****************************************************************************
2034 * We use the stty shell command to get the console width; if this fails or
2035 * if the width is less than 80, we default to 80.
2036 *****************************************************************************/
2037 static int ConsoleWidth( void )
2039 unsigned i_width = 80;
2042 FILE *file = popen( "stty size 2>/dev/null", "r" );
2045 if (fscanf (file, "%*u %u", &i_width) <= 0)
2049 #elif !defined (UNDER_CE)
2050 CONSOLE_SCREEN_BUFFER_INFO buf;
2052 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2053 i_width = buf.dwSize.X;
2059 #include <vlc_avcodec.h>
2061 void vlc_avcodec_mutex (bool acquire)
2063 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2066 vlc_mutex_lock (&lock);
2068 vlc_mutex_unlock (&lock);