1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
43 #include "modules/modules.h"
44 #include "config/configuration.h"
46 #include <stdio.h> /* sprintf() */
48 #include <stdlib.h> /* free() */
51 # include <netinet/in.h> /* BSD: struct in_addr */
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
60 #include "config/vlc_getopt.h"
67 /* used for one-instance mode */
68 # include <dbus/dbus.h>
71 #include <vlc_playlist.h>
72 #include <vlc_interface.h>
75 #include "audio_output/aout_internal.h"
77 #include <vlc_charset.h>
84 #include "playlist/playlist_internal.h"
89 # include <libkern/OSAtomic.h>
94 /*****************************************************************************
95 * The evil global variables. We handle them with care, don't worry.
96 *****************************************************************************/
97 static unsigned i_instances = 0;
100 static bool b_daemon = false;
108 * Atomically set the reference count to 1.
109 * @param p_gc reference counted object
110 * @param pf_destruct destruction calback
113 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
115 /* There is no point in using the GC if there is no destructor... */
116 assert (pf_destruct);
117 p_gc->pf_destructor = pf_destruct;
120 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
121 __sync_synchronize ();
122 #elif defined (WIN32) && defined (__GNUC__)
123 #elif defined(__APPLE__)
126 /* Nobody else can possibly lock the spin - it's there as a barrier */
127 vlc_spin_init (&p_gc->spin);
128 vlc_spin_lock (&p_gc->spin);
129 vlc_spin_unlock (&p_gc->spin);
135 * Atomically increment the reference count.
136 * @param p_gc reference counted object
139 void *vlc_hold (gc_object_t * p_gc)
143 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
145 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
146 refs = __sync_add_and_fetch (&p_gc->refs, 1);
147 #elif defined (WIN64)
148 refs = InterlockedIncrement64 (&p_gc->refs);
149 #elif defined (WIN32)
150 refs = InterlockedIncrement (&p_gc->refs);
151 #elif defined(__APPLE__)
152 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
154 vlc_spin_lock (&p_gc->spin);
156 vlc_spin_unlock (&p_gc->spin);
158 assert (refs != 1); /* there had to be a reference already */
163 * Atomically decrement the reference count and, if it reaches zero, destroy.
164 * @param p_gc reference counted object.
166 void vlc_release (gc_object_t *p_gc)
171 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
173 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
174 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
175 #elif defined (WIN64)
176 refs = InterlockedDecrement64 (&p_gc->refs);
177 #elif defined (WIN32)
178 refs = InterlockedDecrement (&p_gc->refs);
179 #elif defined(__APPLE__)
180 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
182 vlc_spin_lock (&p_gc->spin);
184 vlc_spin_unlock (&p_gc->spin);
187 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
190 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
191 #elif defined (WIN32) && defined (__GNUC__)
192 #elif defined(__APPLE__)
194 vlc_spin_destroy (&p_gc->spin);
196 p_gc->pf_destructor (p_gc);
200 /*****************************************************************************
202 *****************************************************************************/
203 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
204 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
205 static void SetLanguage ( char const * );
207 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
208 static void Help ( libvlc_int_t *, char const *psz_help_name );
209 static void Usage ( libvlc_int_t *, char const *psz_search );
210 static void ListModules ( libvlc_int_t *, bool );
211 static void Version ( void );
214 static void ShowConsole ( bool );
215 static void PauseConsole ( void );
217 static int ConsoleWidth ( void );
219 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
220 extern const char psz_vlc_changeset[];
223 * Allocate a libvlc instance, initialize global data if needed
224 * It also initializes the threading system
226 libvlc_int_t * libvlc_InternalCreate( void )
228 libvlc_int_t *p_libvlc;
230 char *psz_env = NULL;
232 /* Now that the thread system is initialized, we don't have much, but
233 * at least we have variables */
234 vlc_mutex_lock( &global_lock );
235 if( i_instances == 0 )
237 /* Guess what CPU we have */
238 cpu_flags = CPUCapabilities();
239 /* The module bank will be initialized later */
242 /* Allocate a libvlc instance object */
243 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
244 VLC_OBJECT_GENERIC, "libvlc" );
245 if( p_libvlc != NULL )
247 vlc_mutex_unlock( &global_lock );
249 if( p_libvlc == NULL )
252 priv = libvlc_priv (p_libvlc);
253 priv->p_playlist = NULL;
254 priv->p_dialog_provider = NULL;
257 /* Initialize message queue */
258 priv->msg_bank = msg_Create ();
259 if (unlikely(priv->msg_bank == NULL))
262 /* Find verbosity from VLC_VERBOSE environment variable */
263 psz_env = getenv( "VLC_VERBOSE" );
264 if( psz_env != NULL )
265 priv->i_verbose = atoi( psz_env );
268 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
269 priv->b_color = isatty( 2 ); /* 2 is for stderr */
271 priv->b_color = false;
274 /* Initialize mutexes */
275 vlc_mutex_init( &priv->timer_lock );
279 vlc_object_release (p_libvlc);
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
316 vlc_bindtextdomain (PACKAGE_NAME);
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, NULL ) )
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, "VLC media player - %s", VERSION_MESSAGE );
333 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
334 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
335 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
336 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
337 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
339 /* Check for short help option */
340 if( var_InheritBool( p_libvlc, "help" ) )
342 Help( p_libvlc, "help" );
344 i_ret = VLC_EEXITSUCCESS;
346 /* Check for version option */
347 else if( var_InheritBool( p_libvlc, "version" ) )
351 i_ret = VLC_EEXITSUCCESS;
354 /* Check for daemon mode */
356 if( var_InheritBool( p_libvlc, "daemon" ) )
359 char *psz_pidfile = NULL;
361 if( daemon( 1, 0) != 0 )
363 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
368 /* lets check if we need to write the pidfile */
369 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
370 if( psz_pidfile != NULL )
373 pid_t i_pid = getpid ();
374 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
375 i_pid, psz_pidfile );
376 pidfile = vlc_fopen( psz_pidfile,"w" );
377 if( pidfile != NULL )
379 utf8_fprintf( pidfile, "%d", (int)i_pid );
384 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
393 if( ( i_pid = fork() ) < 0 )
395 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
400 /* This is the parent, exit right now */
401 msg_Dbg( p_libvlc, "closing parent process" );
403 i_ret = VLC_EEXITSUCCESS;
407 /* We are the child */
408 msg_Dbg( p_libvlc, "daemon spawned" );
409 close( STDIN_FILENO );
410 close( STDOUT_FILENO );
411 close( STDERR_FILENO );
421 module_EndBank( p_libvlc, false );
425 /* Check for translation config option */
426 #if defined( ENABLE_NLS ) \
427 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
428 # if defined (WIN32) || defined (__APPLE__)
429 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
430 config_LoadConfigFile( p_libvlc, "main" );
431 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
433 /* Check if the user specified a custom language */
434 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
435 if( psz_language && strcmp( psz_language, "auto" ) )
437 /* Reset the default domain */
438 SetLanguage( psz_language );
440 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
441 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
443 free( psz_language );
448 * Load the builtins and plugins into the module_bank.
449 * We have to do it before config_Load*() because this also gets the
450 * list of configuration options exported by each module and loads their
453 module_LoadPlugins( p_libvlc );
454 if( p_libvlc->b_die )
460 module_t **list = module_list_get( &module_count );
461 module_list_free( list );
462 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
464 /* Check for help on modules */
465 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
467 Help( p_libvlc, p_tmp );
470 i_ret = VLC_EEXITSUCCESS;
472 /* Check for full help option */
473 else if( var_InheritBool( p_libvlc, "full-help" ) )
475 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
476 var_SetBool( p_libvlc, "advanced", true );
477 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
478 var_SetBool( p_libvlc, "help-verbose", true );
479 Help( p_libvlc, "full-help" );
481 i_ret = VLC_EEXITSUCCESS;
483 /* Check for long help option */
484 else if( var_InheritBool( p_libvlc, "longhelp" ) )
486 Help( p_libvlc, "longhelp" );
488 i_ret = VLC_EEXITSUCCESS;
490 /* Check for module list option */
491 else if( var_InheritBool( p_libvlc, "list" ) )
493 ListModules( p_libvlc, false );
495 i_ret = VLC_EEXITSUCCESS;
497 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
499 ListModules( p_libvlc, true );
501 i_ret = VLC_EEXITSUCCESS;
504 /* Check for config file options */
505 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
507 if( var_InheritBool( p_libvlc, "reset-config" ) )
509 config_ResetAll( p_libvlc );
510 config_SaveConfigFile( p_libvlc, NULL );
514 if( module_count <= 1)
516 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
517 "that you properly gave a module path with --plugin-path.");
524 module_EndBank( p_libvlc, true );
529 * Override default configuration with config file settings
531 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
532 config_LoadConfigFile( p_libvlc, NULL );
535 * Override configuration with command line settings
538 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
541 ShowConsole( false );
542 /* Pause the console because it's destroyed when we exit */
543 fprintf( stderr, "The command line options couldn't be loaded, check "
544 "that they are valid.\n" );
547 module_EndBank( p_libvlc, true );
550 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
552 /* FIXME: could be replaced by using Unix sockets */
554 dbus_threads_init_default();
556 if( var_InheritBool( p_libvlc, "one-instance" )
557 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
558 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
560 /* Initialise D-Bus interface, check for other instances */
561 DBusConnection *p_conn = NULL;
562 DBusError dbus_error;
564 dbus_error_init( &dbus_error );
566 /* connect to the session bus */
567 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
570 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
571 dbus_error.message );
572 dbus_error_free( &dbus_error );
576 /* check if VLC is available on the bus
577 * if not: D-Bus control is not enabled on the other
578 * instance and we can't pass MRLs to it */
579 DBusMessage *p_test_msg = NULL;
580 DBusMessage *p_test_reply = NULL;
581 p_test_msg = dbus_message_new_method_call(
582 "org.mpris.vlc", "/",
583 "org.freedesktop.MediaPlayer", "Identity" );
584 /* block until a reply arrives */
585 p_test_reply = dbus_connection_send_with_reply_and_block(
586 p_conn, p_test_msg, -1, &dbus_error );
587 dbus_message_unref( p_test_msg );
588 if( p_test_reply == NULL )
590 dbus_error_free( &dbus_error );
591 msg_Dbg( p_libvlc, "No Media Player is running. "
592 "Continuing normally." );
597 DBusMessage* p_dbus_msg = NULL;
598 DBusMessageIter dbus_args;
599 DBusPendingCall* p_dbus_pending = NULL;
602 dbus_message_unref( p_test_reply );
603 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
605 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
607 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
608 ppsz_argv[i_input] );
610 p_dbus_msg = dbus_message_new_method_call(
611 "org.mpris.vlc", "/TrackList",
612 "org.freedesktop.MediaPlayer", "AddTrack" );
614 if ( NULL == p_dbus_msg )
616 msg_Err( p_libvlc, "D-Bus problem" );
617 system_End( p_libvlc );
622 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
623 if ( !dbus_message_iter_append_basic( &dbus_args,
624 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
626 dbus_message_unref( p_dbus_msg );
627 system_End( p_libvlc );
631 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
633 if ( !dbus_message_iter_append_basic( &dbus_args,
634 DBUS_TYPE_BOOLEAN, &b_play ) )
636 dbus_message_unref( p_dbus_msg );
637 system_End( p_libvlc );
641 /* send message and get a handle for a reply */
642 if ( !dbus_connection_send_with_reply ( p_conn,
643 p_dbus_msg, &p_dbus_pending, -1 ) )
645 msg_Err( p_libvlc, "D-Bus problem" );
646 dbus_message_unref( p_dbus_msg );
647 system_End( p_libvlc );
651 if ( NULL == p_dbus_pending )
653 msg_Err( p_libvlc, "D-Bus problem" );
654 dbus_message_unref( p_dbus_msg );
655 system_End( p_libvlc );
658 dbus_connection_flush( p_conn );
659 dbus_message_unref( p_dbus_msg );
660 /* block until we receive a reply */
661 dbus_pending_call_block( p_dbus_pending );
662 dbus_pending_call_unref( p_dbus_pending );
663 } /* processes all command line MRLs */
666 system_End( p_libvlc );
670 /* we unreference the connection when we've finished with it */
671 if( p_conn ) dbus_connection_unref( p_conn );
676 * Message queue options
678 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
679 if( psz_verbose_objects )
681 char * psz_object, * iter = psz_verbose_objects;
682 while( (psz_object = strsep( &iter, "," )) )
684 switch( psz_object[0] )
686 printf("%s\n", psz_object+1);
687 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
688 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
690 msg_Err( p_libvlc, "verbose-objects usage: \n"
691 "--verbose-objects=+printthatobject,"
692 "-dontprintthatone\n"
693 "(keyword 'all' to applies to all objects)");
694 free( psz_verbose_objects );
695 /* FIXME: leaks!!!! */
699 free( psz_verbose_objects );
702 /* Last chance to set the verbosity. Once we start interfaces and other
703 * threads, verbosity becomes read-only. */
704 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
705 if( var_InheritBool( p_libvlc, "quiet" ) )
707 var_SetInteger( p_libvlc, "verbose", -1 );
708 priv->i_verbose = -1;
710 vlc_threads_setup( p_libvlc );
713 priv->b_color = var_InheritBool( p_libvlc, "color" );
715 char p_capabilities[200];
716 #define PRINT_CAPABILITY( capability, string ) \
717 if( vlc_CPU() & capability ) \
719 strncat( p_capabilities, string " ", \
720 sizeof(p_capabilities) - strlen(p_capabilities) ); \
721 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
723 p_capabilities[0] = '\0';
725 #if defined( __i386__ ) || defined( __x86_64__ )
726 if( !var_InheritBool( p_libvlc, "mmx" ) )
727 cpu_flags &= ~CPU_CAPABILITY_MMX;
728 if( !var_InheritBool( p_libvlc, "3dn" ) )
729 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
730 if( !var_InheritBool( p_libvlc, "mmxext" ) )
731 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
732 if( !var_InheritBool( p_libvlc, "sse" ) )
733 cpu_flags &= ~CPU_CAPABILITY_SSE;
734 if( !var_InheritBool( p_libvlc, "sse2" ) )
735 cpu_flags &= ~CPU_CAPABILITY_SSE2;
736 if( !var_InheritBool( p_libvlc, "sse3" ) )
737 cpu_flags &= ~CPU_CAPABILITY_SSE3;
738 if( !var_InheritBool( p_libvlc, "ssse3" ) )
739 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
740 if( !var_InheritBool( p_libvlc, "sse41" ) )
741 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
742 if( !var_InheritBool( p_libvlc, "sse42" ) )
743 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
745 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
756 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
757 if( !var_InheritBool( p_libvlc, "altivec" ) )
758 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
760 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
762 #elif defined( __arm__ )
763 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
768 strncat( p_capabilities, "FPU ",
769 sizeof(p_capabilities) - strlen( p_capabilities) );
770 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
773 if (p_capabilities[0])
774 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
777 * Choose the best memcpy module
779 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
780 /* Avoid being called "memcpy":*/
781 vlc_object_set_name( p_libvlc, "main" );
783 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
785 priv->pp_timers = NULL;
787 priv->i_last_input_id = 0; /* Not very safe, should be removed */
790 * Initialize hotkey handling
792 vlc_InitActions( p_libvlc );
794 /* Create a variable for showing the fullscreen interface */
795 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
796 var_SetBool( p_libvlc, "intf-show", true );
798 /* Create a variable for showing the right click menu */
799 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
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 );
818 /* System specific configuration */
819 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
821 /* Add service discovery modules */
822 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
825 char *p = psz_modules, *m;
826 while( ( m = strsep( &p, " :," ) ) != NULL )
827 playlist_ServicesDiscoveryAdd( p_playlist, m );
832 /* Initialize VLM if vlm-conf is specified */
833 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
836 priv->p_vlm = vlm_New( p_libvlc );
838 msg_Err( p_libvlc, "VLM initialization failed" );
844 * Load background interfaces
846 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
847 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
849 if( psz_modules && psz_control )
852 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
855 psz_modules = psz_tmp;
858 else if( psz_control )
861 psz_modules = strdup( psz_control );
864 psz_parser = psz_modules;
865 while ( psz_parser && *psz_parser )
867 char *psz_module, *psz_temp;
868 psz_module = psz_parser;
869 psz_parser = strchr( psz_module, ':' );
875 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
877 intf_Create( p_libvlc, psz_temp );
885 * Always load the hotkeys interface if it exists
887 intf_Create( p_libvlc, "hotkeys,none" );
890 /* loads dbus control interface if in one-instance mode
891 * we do it only when playlist exists, because dbus module needs it */
892 if( var_InheritBool( p_libvlc, "one-instance" )
893 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
894 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
895 intf_Create( p_libvlc, "dbus,none" );
897 # if !defined (HAVE_MAEMO)
898 /* Prevents the power management daemon from suspending the system
899 * when VLC is active */
900 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
901 intf_Create( p_libvlc, "inhibit,none" );
905 if( var_InheritBool( p_libvlc, "file-logging" ) &&
906 !var_InheritBool( p_libvlc, "syslog" ) )
908 intf_Create( p_libvlc, "logger,none" );
911 if( var_InheritBool( p_libvlc, "syslog" ) )
913 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
914 var_SetString( p_libvlc, "logmode", "syslog" );
915 intf_Create( p_libvlc, "logger,none" );
919 var_SetString( p_libvlc, "logmode", logmode );
922 var_Destroy( p_libvlc, "logmode" );
926 if( var_InheritBool( p_libvlc, "network-synchronisation") )
928 intf_Create( p_libvlc, "netsync,none" );
932 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
934 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
937 char *psz_morecodecs;
938 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
940 var_SetString( p_libvlc, "codec", psz_morecodecs);
941 free( psz_morecodecs );
946 var_SetString( p_libvlc, "codec", "dmo,quicktime");
950 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
953 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
954 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
956 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
957 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
959 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
963 * Get input filenames given as commandline arguments.
964 * We assume that the remaining parameters are filenames
965 * and their input options.
967 msg_Info( p_libvlc, "optind = %u", vlc_optind );
968 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
971 * Get --open argument
973 psz_val = var_InheritString( p_libvlc, "open" );
974 if ( psz_val != NULL )
976 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
977 -1, 0, NULL, 0, true, pl_Unlocked );
985 * Cleanup a libvlc instance. The instance is not completely deallocated
986 * \param p_libvlc the instance to clean
988 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
990 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
991 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
993 /* Deactivate the playlist */
994 msg_Dbg( p_libvlc, "deactivating the playlist" );
995 pl_Deactivate( p_libvlc );
997 /* Remove all services discovery */
998 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
999 playlist_ServicesDiscoveryKillAll( p_playlist );
1001 /* Ask the interfaces to stop and destroy them */
1002 msg_Dbg( p_libvlc, "removing all interfaces" );
1003 libvlc_Quit( p_libvlc );
1004 intf_DestroyAll( p_libvlc );
1007 /* Destroy VLM if created in libvlc_InternalInit */
1010 vlm_Delete( priv->p_vlm );
1014 /* Free playlist now, all threads are gone */
1015 playlist_Destroy( p_playlist );
1017 stats_TimersDumpAll( p_libvlc );
1018 stats_TimersCleanAll( p_libvlc );
1020 msg_Dbg( p_libvlc, "removing stats" );
1023 char* psz_pidfile = NULL;
1027 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1028 if( psz_pidfile != NULL )
1030 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1031 if( unlink( psz_pidfile ) == -1 )
1033 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1037 free( psz_pidfile );
1041 if( priv->p_memcpy_module )
1043 module_unneed( p_libvlc, priv->p_memcpy_module );
1044 priv->p_memcpy_module = NULL;
1047 /* Free module bank. It is refcounted, so we call this each time */
1048 module_EndBank( p_libvlc, true );
1050 vlc_DeinitActions( p_libvlc );
1054 * Destroy everything.
1055 * This function requests the running threads to finish, waits for their
1056 * termination, and destroys their structure.
1057 * It stops the thread systems: no instance can run after this has run
1058 * \param p_libvlc the instance to destroy
1060 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1062 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1064 vlc_mutex_lock( &global_lock );
1067 if( i_instances == 0 )
1069 /* System specific cleaning code */
1070 system_End( p_libvlc );
1072 vlc_mutex_unlock( &global_lock );
1074 msg_Destroy (priv->msg_bank);
1076 /* Destroy mutexes */
1077 vlc_mutex_destroy( &priv->timer_lock );
1079 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1080 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1081 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1082 vlc_object_release( p_libvlc );
1085 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1086 vlc_object_release( p_libvlc );
1090 * Add an interface plugin and run it
1092 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1095 return VLC_EGENERIC;
1097 if( !psz_module ) /* requesting the default interface */
1099 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1100 if( !psz_interface ) /* "intf" has not been set */
1104 /* Daemon mode hack.
1105 * We prefer the dummy interface if none is specified. */
1106 psz_module = "dummy";
1109 msg_Info( p_libvlc, "%s",
1110 _("Running vlc with the default interface. "
1111 "Use 'cvlc' to use vlc without interface.") );
1113 free( psz_interface );
1114 var_Destroy( p_libvlc, "intf" );
1117 /* Try to create the interface */
1118 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1120 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1121 psz_module ? psz_module : "default" );
1126 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1127 static vlc_cond_t exiting = VLC_STATIC_COND;
1129 extern vlc_mutex_t super_mutex;
1130 extern vlc_cond_t super_variable;
1131 # define exit_lock super_mutex
1132 # define exiting super_variable
1136 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1137 * when the user "exits" an interface plugin.
1139 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1141 vlc_mutex_lock( &exit_lock );
1142 while( vlc_object_alive( p_libvlc ) )
1143 vlc_cond_wait( &exiting, &exit_lock );
1144 vlc_mutex_unlock( &exit_lock );
1148 * Posts an exit signal to LibVLC instance. This will normally initiate the
1149 * cleanup and destroy process. It should only be called on behalf of the user.
1151 void libvlc_Quit( libvlc_int_t *p_libvlc )
1153 vlc_mutex_lock( &exit_lock );
1154 vlc_object_kill( p_libvlc );
1155 vlc_cond_broadcast( &exiting );
1156 vlc_mutex_unlock( &exit_lock );
1159 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1160 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1161 /*****************************************************************************
1162 * SetLanguage: set the interface language.
1163 *****************************************************************************
1164 * We set the LC_MESSAGES locale category for interface messages and buttons,
1165 * as well as the LC_CTYPE category for string sorting and possible wide
1166 * character support.
1167 *****************************************************************************/
1168 static void SetLanguage ( const char *psz_lang )
1171 /* I need that under Darwin, please check it doesn't disturb
1172 * other platforms. --Meuuh */
1173 setenv( "LANG", psz_lang, 1 );
1176 /* We set LC_ALL manually because it is the only way to set
1177 * the language at runtime under eg. Windows. Beware that this
1178 * makes the environment unconsistent when libvlc is unloaded and
1179 * should probably be moved to a safer place like vlc.c. */
1180 static char psz_lcall[20];
1181 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1182 psz_lcall[19] = '\0';
1183 putenv( psz_lcall );
1186 setlocale( LC_ALL, psz_lang );
1190 /*****************************************************************************
1191 * GetFilenames: parse command line options which are not flags
1192 *****************************************************************************
1193 * Parse command line for input files as well as their associated options.
1194 * An option always follows its associated input and begins with a ":".
1195 *****************************************************************************/
1196 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1197 const char *const args[] )
1201 /* Count the input options */
1202 unsigned i_options = 0;
1204 while( args[--n][0] == ':' )
1209 msg_Warn( p_vlc, "options %s without item", args[n] );
1210 return; /* syntax!? */
1214 /* TODO: write an internal function of this one, to avoid
1215 * unnecessary lookups. */
1216 char *mrl = make_URI( args[n] );
1220 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1221 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1222 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1227 /*****************************************************************************
1228 * Help: print program help
1229 *****************************************************************************
1230 * Print a short inline help. Message interface is initialized at this stage.
1231 *****************************************************************************/
1232 static inline void print_help_on_full_help( void )
1234 utf8_fprintf( stdout, "\n" );
1235 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1238 static const char vlc_usage[] = N_(
1239 "Usage: %s [options] [stream] ..."
1240 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1241 "\nThe first item specified will be played first."
1244 "\n --option A global option that is set for the duration of the program."
1245 "\n -option A single letter version of a global --option."
1246 "\n :option An option that only applies to the stream directly before it"
1247 "\n and that overrides previous settings."
1249 "\nStream MRL syntax:"
1250 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1252 "\n Many of the global --options can also be used as MRL specific :options."
1253 "\n Multiple :option=value pairs can be specified."
1256 "\n [file://]filename Plain media file"
1257 "\n http://ip:port/file HTTP URL"
1258 "\n ftp://ip:port/file FTP URL"
1259 "\n mms://ip:port/file MMS URL"
1260 "\n screen:// Screen capture"
1261 "\n [dvd://][device][@raw_device] DVD device"
1262 "\n [vcd://][device] VCD device"
1263 "\n [cdda://][device] Audio CD device"
1264 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1265 "\n UDP stream sent by a streaming server"
1266 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1267 "\n vlc://quit Special item to quit VLC"
1270 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1273 ShowConsole( true );
1276 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1278 utf8_fprintf( stdout, vlc_usage, "vlc" );
1279 Usage( p_this, "=help" );
1280 Usage( p_this, "=main" );
1281 print_help_on_full_help();
1283 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1285 utf8_fprintf( stdout, vlc_usage, "vlc" );
1286 Usage( p_this, NULL );
1287 print_help_on_full_help();
1289 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1291 utf8_fprintf( stdout, vlc_usage, "vlc" );
1292 Usage( p_this, NULL );
1294 else if( psz_help_name )
1296 Usage( p_this, psz_help_name );
1299 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1304 /*****************************************************************************
1305 * Usage: print module usage
1306 *****************************************************************************
1307 * Print a short inline help. Message interface is initialized at this stage.
1308 *****************************************************************************/
1309 # define COL(x) "\033[" #x ";1m"
1310 # define RED COL(31)
1311 # define GREEN COL(32)
1312 # define YELLOW COL(33)
1313 # define BLUE COL(34)
1314 # define MAGENTA COL(35)
1315 # define CYAN COL(36)
1316 # define WHITE COL(0)
1317 # define GRAY "\033[0m"
1319 print_help_section( const module_t *m, const module_config_t *p_item,
1320 bool b_color, bool b_description )
1322 if( !p_item ) return;
1325 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1326 module_gettext( m, p_item->psz_text ) );
1327 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1328 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1329 module_gettext( m, p_item->psz_longtext ) );
1333 utf8_fprintf( stdout, " %s:\n",
1334 module_gettext( m, p_item->psz_text ) );
1335 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1336 utf8_fprintf( stdout, " %s\n",
1337 module_gettext(m, p_item->psz_longtext ) );
1341 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1343 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1344 /* short option ------' | | | | | | |
1345 * option name ------------' | | | | | |
1346 * <bra ---------------------' | | | | |
1347 * option type or "" ----------' | | | |
1348 * ket> -------------------------' | | |
1349 * padding spaces -----------------' | |
1350 * comment --------------------------' |
1351 * comment suffix ---------------------'
1353 * The purpose of having bra and ket is that we might i18n them as well.
1356 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1357 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1359 #define LINE_START 8
1360 #define PADDING_SPACES 25
1362 # define OPTION_VALUE_SEP "="
1364 # define OPTION_VALUE_SEP " "
1366 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1367 char psz_spaces_longtext[LINE_START+3];
1368 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1369 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1370 char psz_buffer[10000];
1372 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1373 int i_width_description = i_width + PADDING_SPACES - 1;
1374 bool b_advanced = var_InheritBool( p_this, "advanced" );
1375 bool b_description = var_InheritBool( p_this, "help-verbose" );
1376 bool b_description_hack;
1377 bool b_color = var_InheritBool( p_this, "color" );
1378 bool b_has_advanced = false;
1379 bool b_found = false;
1380 int i_only_advanced = 0; /* Number of modules ignored because they
1381 * only have advanced options */
1382 bool b_strict = psz_search && *psz_search == '=';
1383 if( b_strict ) psz_search++;
1385 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1386 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1387 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1388 psz_spaces_longtext[LINE_START+2] = '\0';
1392 b_color = false; // don't put color control codes in a .txt file
1396 strcpy( psz_format, COLOR_FORMAT_STRING );
1397 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1401 strcpy( psz_format, FORMAT_STRING );
1402 strcpy( psz_format_bool, FORMAT_STRING );
1405 /* List all modules */
1406 module_t **list = module_list_get (NULL);
1410 /* Ugly hack to make sure that the help options always come first
1413 Usage( p_this, "help" );
1415 /* Enumerate the config for each module */
1416 for (size_t i = 0; list[i]; i++)
1419 module_t *p_parser = list[i];
1420 module_config_t *p_item = NULL;
1421 module_config_t *p_section = NULL;
1422 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1425 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1426 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1428 char *const *pp_shortcut = p_parser->pp_shortcuts;
1429 while( *pp_shortcut )
1431 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1432 : !!strstr( *pp_shortcut, psz_search ) )
1440 /* Ignore modules without config options */
1441 if( !p_parser->i_config_items )
1446 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1447 /* Ugly hack to make sure that the help options always come first
1449 if( !psz_search && b_help_module )
1452 /* Ignore modules with only advanced config options if requested */
1455 for( p_item = p_parser->p_config;
1459 if( (p_item->i_type & CONFIG_ITEM) &&
1460 !p_item->b_advanced && !p_item->b_removed ) break;
1463 if( p_item == p_end )
1472 /* Print name of module */
1473 if( strcmp( "main", p_parser->psz_object_name ) )
1476 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1477 module_gettext( p_parser, p_parser->psz_longname ),
1478 p_parser->psz_object_name );
1480 utf8_fprintf( stdout, "\n %s\n",
1481 module_gettext(p_parser, p_parser->psz_longname ) );
1483 if( p_parser->psz_help )
1486 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1487 module_gettext( p_parser, p_parser->psz_help ) );
1489 utf8_fprintf( stdout, " %s\n",
1490 module_gettext( p_parser, p_parser->psz_help ) );
1493 /* Print module options */
1494 for( p_item = p_parser->p_config;
1498 char *psz_text, *psz_spaces = psz_spaces_text;
1499 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1500 const char *psz_suf = "", *psz_prefix = NULL;
1504 /* Skip removed options */
1505 if( p_item->b_removed )
1509 /* Skip advanced options if requested */
1510 if( p_item->b_advanced && !b_advanced )
1512 b_has_advanced = true;
1516 switch( p_item->i_type )
1518 case CONFIG_HINT_CATEGORY:
1519 case CONFIG_HINT_USAGE:
1520 if( !strcmp( "main", p_parser->psz_object_name ) )
1523 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1524 module_gettext( p_parser, p_item->psz_text ) );
1526 utf8_fprintf( stdout, "\n %s\n",
1527 module_gettext( p_parser, p_item->psz_text ) );
1529 if( b_description && p_item->psz_longtext
1530 && *p_item->psz_longtext )
1533 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1534 module_gettext( p_parser, p_item->psz_longtext ) );
1536 utf8_fprintf( stdout, " %s\n",
1537 module_gettext( p_parser, p_item->psz_longtext ) );
1541 case CONFIG_HINT_SUBCATEGORY:
1542 if( strcmp( "main", p_parser->psz_object_name ) )
1544 case CONFIG_SECTION:
1548 case CONFIG_ITEM_STRING:
1549 case CONFIG_ITEM_FILE:
1550 case CONFIG_ITEM_DIRECTORY:
1551 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1552 case CONFIG_ITEM_MODULE_CAT:
1553 case CONFIG_ITEM_MODULE_LIST:
1554 case CONFIG_ITEM_MODULE_LIST_CAT:
1555 case CONFIG_ITEM_FONT:
1556 case CONFIG_ITEM_PASSWORD:
1557 print_help_section( p_parser, p_section, b_color,
1560 psz_bra = OPTION_VALUE_SEP "<";
1561 psz_type = _("string");
1564 if( p_item->ppsz_list )
1566 psz_bra = OPTION_VALUE_SEP "{";
1567 psz_type = psz_buffer;
1568 psz_buffer[0] = '\0';
1569 for( i = 0; p_item->ppsz_list[i]; i++ )
1571 if( i ) strcat( psz_buffer, "," );
1572 strcat( psz_buffer, p_item->ppsz_list[i] );
1577 case CONFIG_ITEM_INTEGER:
1578 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1579 print_help_section( p_parser, p_section, b_color,
1582 psz_bra = OPTION_VALUE_SEP "<";
1583 psz_type = _("integer");
1586 if( p_item->min.i || p_item->max.i )
1588 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1589 p_item->min.i, p_item->max.i );
1590 psz_type = psz_buffer;
1593 if( p_item->i_list )
1595 psz_bra = OPTION_VALUE_SEP "{";
1596 psz_type = psz_buffer;
1597 psz_buffer[0] = '\0';
1598 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1600 if( i ) strcat( psz_buffer, ", " );
1601 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1603 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1608 case CONFIG_ITEM_FLOAT:
1609 print_help_section( p_parser, p_section, b_color,
1612 psz_bra = OPTION_VALUE_SEP "<";
1613 psz_type = _("float");
1615 if( p_item->min.f || p_item->max.f )
1617 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1618 p_item->min.f, p_item->max.f );
1619 psz_type = psz_buffer;
1622 case CONFIG_ITEM_BOOL:
1623 print_help_section( p_parser, p_section, b_color,
1626 psz_bra = ""; psz_type = ""; psz_ket = "";
1627 if( !b_help_module )
1629 psz_suf = p_item->value.i ? _(" (default enabled)") :
1630 _(" (default disabled)");
1640 /* Add short option if any */
1641 if( p_item->i_short )
1643 sprintf( psz_short, "-%c,", p_item->i_short );
1647 strcpy( psz_short, " " );
1650 i = PADDING_SPACES - strlen( p_item->psz_name )
1651 - strlen( psz_bra ) - strlen( psz_type )
1652 - strlen( psz_ket ) - 1;
1654 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1656 psz_prefix = ", --no-";
1657 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1662 psz_spaces[0] = '\n';
1667 psz_spaces[i] = '\0';
1670 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1672 utf8_fprintf( stdout, psz_format_bool, psz_short,
1673 p_item->psz_name, psz_prefix, p_item->psz_name,
1674 psz_bra, psz_type, psz_ket, psz_spaces );
1678 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1679 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1682 psz_spaces[i] = ' ';
1684 /* We wrap the rest of the output */
1685 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1687 b_description_hack = b_description;
1690 psz_text = psz_buffer;
1691 i_cur_width = b_description && !b_description_hack
1692 ? i_width_description
1696 char *psz_parser, *psz_word;
1697 size_t i_end = strlen( psz_text );
1699 /* If the remaining text fits in a line, print it. */
1700 if( i_end <= i_cur_width )
1704 if( !b_description || b_description_hack )
1705 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1707 utf8_fprintf( stdout, "%s\n", psz_text );
1711 utf8_fprintf( stdout, "%s\n", psz_text );
1716 /* Otherwise, eat as many words as possible */
1717 psz_parser = psz_text;
1720 psz_word = psz_parser;
1721 psz_parser = strchr( psz_word, ' ' );
1722 /* If no space was found, we reached the end of the text
1723 * block; otherwise, we skip the space we just found. */
1724 psz_parser = psz_parser ? psz_parser + 1
1727 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1729 /* We cut a word in one of these cases:
1730 * - it's the only word in the line and it's too long.
1731 * - we used less than 80% of the width and the word we are
1732 * going to wrap is longer than 40% of the width, and even
1733 * if the word would have fit in the next line. */
1734 if( psz_word == psz_text
1735 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1736 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1738 char c = psz_text[i_cur_width];
1739 psz_text[i_cur_width] = '\0';
1742 if( !b_description || b_description_hack )
1743 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1744 psz_text, psz_spaces );
1746 utf8_fprintf( stdout, "%s\n%s",
1747 psz_text, psz_spaces );
1751 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1753 psz_text += i_cur_width;
1758 psz_word[-1] = '\0';
1761 if( !b_description || b_description_hack )
1762 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1763 psz_text, psz_spaces );
1765 utf8_fprintf( stdout, "%s\n%s",
1766 psz_text, psz_spaces );
1770 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1772 psz_text = psz_word;
1776 if( b_description_hack && p_item->psz_longtext
1777 && *p_item->psz_longtext )
1779 sprintf( psz_buffer, "%s%s",
1780 module_gettext( p_parser, p_item->psz_longtext ),
1782 b_description_hack = false;
1783 psz_spaces = psz_spaces_longtext;
1784 utf8_fprintf( stdout, "%s", psz_spaces );
1790 if( b_has_advanced )
1793 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1794 _( "add --advanced to your command line to see advanced options."));
1796 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1797 _( "add --advanced to your command line to see advanced options."));
1800 if( i_only_advanced > 0 )
1804 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1805 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1809 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1810 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1816 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1817 _( "No matching module found. Use --list or " \
1818 "--list-verbose to list available modules." ) );
1820 utf8_fprintf( stdout, "\n%s\n",
1821 _( "No matching module found. Use --list or " \
1822 "--list-verbose to list available modules." ) );
1825 /* Release the module list */
1826 module_list_free (list);
1829 /*****************************************************************************
1830 * ListModules: list the available modules with their description
1831 *****************************************************************************
1832 * Print a list of all available modules (builtins and plugins) and a short
1833 * description for each one.
1834 *****************************************************************************/
1835 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1839 bool b_color = var_InheritBool( p_this, "color" );
1842 ShowConsole( true );
1843 b_color = false; // don't put color control codes in a .txt file
1849 /* List all modules */
1850 module_t **list = module_list_get (NULL);
1852 /* Enumerate each module */
1853 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1856 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1857 p_parser->psz_object_name,
1858 module_gettext( p_parser, p_parser->psz_longname ) );
1860 utf8_fprintf( stdout, " %-22s %s\n",
1861 p_parser->psz_object_name,
1862 module_gettext( p_parser, p_parser->psz_longname ) );
1866 char *const *pp_shortcut = p_parser->pp_shortcuts;
1867 while( *pp_shortcut )
1869 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1872 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1875 utf8_fprintf( stdout, " s %s\n",
1880 if( p_parser->psz_capability )
1883 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1884 p_parser->psz_capability,
1885 p_parser->i_score );
1887 utf8_fprintf( stdout, " c %s (%d)\n",
1888 p_parser->psz_capability,
1889 p_parser->i_score );
1893 module_list_free (list);
1895 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1900 /*****************************************************************************
1901 * Version: print complete program version
1902 *****************************************************************************
1903 * Print complete program version and build number.
1904 *****************************************************************************/
1905 static void Version( void )
1908 ShowConsole( true );
1911 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1912 psz_vlc_changeset );
1913 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1914 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1915 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1916 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1918 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1923 /*****************************************************************************
1924 * ShowConsole: On Win32, create an output console for debug messages
1925 *****************************************************************************
1926 * This function is useful only on Win32.
1927 *****************************************************************************/
1929 static void ShowConsole( bool b_dofile )
1932 FILE *f_help = NULL;
1934 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1937 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1938 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1939 * page (e.g. CP437 or CP850). */
1940 SetConsoleOutputCP (GetACP ());
1941 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1943 freopen( "CONOUT$", "w", stderr );
1944 freopen( "CONIN$", "r", stdin );
1946 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1949 freopen( "vlc-help.txt", "wt", stdout );
1950 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1952 else freopen( "CONOUT$", "w", stdout );
1958 /*****************************************************************************
1959 * PauseConsole: On Win32, wait for a key press before closing the console
1960 *****************************************************************************
1961 * This function is useful only on Win32.
1962 *****************************************************************************/
1964 static void PauseConsole( void )
1968 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1970 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1978 /*****************************************************************************
1979 * ConsoleWidth: Return the console width in characters
1980 *****************************************************************************
1981 * We use the stty shell command to get the console width; if this fails or
1982 * if the width is less than 80, we default to 80.
1983 *****************************************************************************/
1984 static int ConsoleWidth( void )
1986 unsigned i_width = 80;
1989 FILE *file = popen( "stty size 2>/dev/null", "r" );
1992 if (fscanf (file, "%*u %u", &i_width) <= 0)
1996 #elif !defined (UNDER_CE)
1997 CONSOLE_SCREEN_BUFFER_INFO buf;
1999 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2000 i_width = buf.dwSize.X;
2006 #include <vlc_avcodec.h>
2008 void vlc_avcodec_mutex (bool acquire)
2010 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2013 vlc_mutex_lock (&lock);
2015 vlc_mutex_unlock (&lock);