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 /* used for one-instance mode */
70 # include <dbus/dbus.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
85 #include "playlist/playlist_internal.h"
90 # include <libkern/OSAtomic.h>
95 /*****************************************************************************
96 * The evil global variables. We handle them with care, don't worry.
97 *****************************************************************************/
98 static unsigned i_instances = 0;
101 static bool b_daemon = false;
109 * Atomically set the reference count to 1.
110 * @param p_gc reference counted object
111 * @param pf_destruct destruction calback
114 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
116 /* There is no point in using the GC if there is no destructor... */
117 assert (pf_destruct);
118 p_gc->pf_destructor = pf_destruct;
121 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
122 __sync_synchronize ();
123 #elif defined (WIN32) && defined (__GNUC__)
124 #elif defined(__APPLE__)
127 /* Nobody else can possibly lock the spin - it's there as a barrier */
128 vlc_spin_init (&p_gc->spin);
129 vlc_spin_lock (&p_gc->spin);
130 vlc_spin_unlock (&p_gc->spin);
136 * Atomically increment the reference count.
137 * @param p_gc reference counted object
140 void *vlc_hold (gc_object_t * p_gc)
144 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
146 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
147 refs = __sync_add_and_fetch (&p_gc->refs, 1);
148 #elif defined (WIN64)
149 refs = InterlockedIncrement64 (&p_gc->refs);
150 #elif defined (WIN32)
151 refs = InterlockedIncrement (&p_gc->refs);
152 #elif defined(__APPLE__)
153 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
155 vlc_spin_lock (&p_gc->spin);
157 vlc_spin_unlock (&p_gc->spin);
159 assert (refs != 1); /* there had to be a reference already */
164 * Atomically decrement the reference count and, if it reaches zero, destroy.
165 * @param p_gc reference counted object.
167 void vlc_release (gc_object_t *p_gc)
172 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
174 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
175 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
176 #elif defined (WIN64)
177 refs = InterlockedDecrement64 (&p_gc->refs);
178 #elif defined (WIN32)
179 refs = InterlockedDecrement (&p_gc->refs);
180 #elif defined(__APPLE__)
181 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
183 vlc_spin_lock (&p_gc->spin);
185 vlc_spin_unlock (&p_gc->spin);
188 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
191 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
192 #elif defined (WIN32) && defined (__GNUC__)
193 #elif defined(__APPLE__)
195 vlc_spin_destroy (&p_gc->spin);
197 p_gc->pf_destructor (p_gc);
201 /*****************************************************************************
203 *****************************************************************************/
204 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
205 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
206 static void SetLanguage ( char const * );
208 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
209 static void Help ( libvlc_int_t *, char const *psz_help_name );
210 static void Usage ( libvlc_int_t *, char const *psz_search );
211 static void ListModules ( libvlc_int_t *, bool );
212 static void Version ( void );
215 static void ShowConsole ( bool );
216 static void PauseConsole ( void );
218 static int ConsoleWidth ( void );
220 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
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( 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 msg_Create( p_libvlc );
260 /* Find verbosity from VLC_VERBOSE environment variable */
261 psz_env = getenv( "VLC_VERBOSE" );
262 if( psz_env != NULL )
263 priv->i_verbose = atoi( psz_env );
266 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
267 priv->b_color = isatty( 2 ); /* 2 is for stderr */
269 priv->b_color = false;
272 /* Initialize mutexes */
273 vlc_mutex_init( &priv->timer_lock );
279 * Initialize a libvlc instance
280 * This function initializes a previously allocated libvlc instance:
282 * - gettext initialization
283 * - message queue, module bank and playlist initialization
284 * - configuration and commandline parsing
286 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
287 const char *ppsz_argv[] )
289 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
291 char * psz_modules = NULL;
292 char * psz_parser = NULL;
293 char * psz_control = NULL;
295 int i_ret = VLC_EEXIT;
296 playlist_t *p_playlist = NULL;
298 #if defined( ENABLE_NLS ) \
299 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
300 # if defined (WIN32) || defined (__APPLE__)
305 /* System specific initialization code */
306 system_Init( p_libvlc, &i_argc, ppsz_argv );
309 * Support for gettext
311 vlc_bindtextdomain (PACKAGE_NAME);
313 /* Initialize the module bank and load the configuration of the
314 * main module. We need to do this at this stage to be able to display
315 * a short help if required by the user. (short help == main module
317 module_InitBank( p_libvlc );
319 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
321 module_EndBank( p_libvlc, false );
325 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
326 /* Announce who we are - Do it only for first instance ? */
327 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
328 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
329 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
330 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
332 /* Check for short help option */
333 if( var_InheritBool( p_libvlc, "help" ) )
335 Help( p_libvlc, "help" );
337 i_ret = VLC_EEXITSUCCESS;
339 /* Check for version option */
340 else if( var_InheritBool( p_libvlc, "version" ) )
344 i_ret = VLC_EEXITSUCCESS;
347 /* Check for daemon mode */
349 if( var_InheritBool( p_libvlc, "daemon" ) )
352 char *psz_pidfile = NULL;
354 if( daemon( 1, 0) != 0 )
356 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
361 /* lets check if we need to write the pidfile */
362 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
363 if( psz_pidfile != NULL )
366 pid_t i_pid = getpid ();
367 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
368 i_pid, psz_pidfile );
369 pidfile = utf8_fopen( psz_pidfile,"w" );
370 if( pidfile != NULL )
372 utf8_fprintf( pidfile, "%d", (int)i_pid );
377 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
386 if( ( i_pid = fork() ) < 0 )
388 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
393 /* This is the parent, exit right now */
394 msg_Dbg( p_libvlc, "closing parent process" );
396 i_ret = VLC_EEXITSUCCESS;
400 /* We are the child */
401 msg_Dbg( p_libvlc, "daemon spawned" );
402 close( STDIN_FILENO );
403 close( STDOUT_FILENO );
404 close( STDERR_FILENO );
414 module_EndBank( p_libvlc, false );
418 /* Check for translation config option */
419 #if defined( ENABLE_NLS ) \
420 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
421 # if defined (WIN32) || defined (__APPLE__)
422 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
423 config_LoadConfigFile( p_libvlc, "main" );
424 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
426 /* Check if the user specified a custom language */
427 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
428 if( psz_language && strcmp( psz_language, "auto" ) )
430 /* Reset the default domain */
431 SetLanguage( psz_language );
433 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
434 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
436 free( psz_language );
441 * Load the builtins and plugins into the module_bank.
442 * We have to do it before config_Load*() because this also gets the
443 * list of configuration options exported by each module and loads their
446 module_LoadPlugins( p_libvlc );
447 if( p_libvlc->b_die )
453 module_t **list = module_list_get( &module_count );
454 module_list_free( list );
455 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
457 /* Check for help on modules */
458 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
460 Help( p_libvlc, p_tmp );
463 i_ret = VLC_EEXITSUCCESS;
465 /* Check for full help option */
466 else if( var_InheritBool( p_libvlc, "full-help" ) )
468 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
469 var_SetBool( p_libvlc, "advanced", true );
470 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
471 var_SetBool( p_libvlc, "help-verbose", true );
472 Help( p_libvlc, "full-help" );
474 i_ret = VLC_EEXITSUCCESS;
476 /* Check for long help option */
477 else if( var_InheritBool( p_libvlc, "longhelp" ) )
479 Help( p_libvlc, "longhelp" );
481 i_ret = VLC_EEXITSUCCESS;
483 /* Check for module list option */
484 else if( var_InheritBool( p_libvlc, "list" ) )
486 ListModules( p_libvlc, false );
488 i_ret = VLC_EEXITSUCCESS;
490 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
492 ListModules( p_libvlc, true );
494 i_ret = VLC_EEXITSUCCESS;
497 /* Check for config file options */
498 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
500 if( var_InheritBool( p_libvlc, "reset-config" ) )
502 config_ResetAll( p_libvlc );
503 config_SaveConfigFile( p_libvlc, NULL );
507 if( module_count <= 1)
509 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
510 "that you properly gave a module path with --plugin-path.");
517 module_EndBank( p_libvlc, true );
522 * Override default configuration with config file settings
524 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
525 config_LoadConfigFile( p_libvlc, NULL );
528 * Override configuration with command line settings
530 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
533 ShowConsole( false );
534 /* Pause the console because it's destroyed when we exit */
535 fprintf( stderr, "The command line options couldn't be loaded, check "
536 "that they are valid.\n" );
539 module_EndBank( p_libvlc, true );
542 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
545 * System specific configuration
547 system_Configure( p_libvlc, &i_argc, ppsz_argv );
549 /* FIXME: could be replaced by using Unix sockets */
551 dbus_threads_init_default();
553 if( var_InheritBool( p_libvlc, "one-instance" )
554 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
555 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
557 /* Initialise D-Bus interface, check for other instances */
558 DBusConnection *p_conn = NULL;
559 DBusError dbus_error;
561 dbus_error_init( &dbus_error );
563 /* connect to the session bus */
564 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
567 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
568 dbus_error.message );
569 dbus_error_free( &dbus_error );
573 /* check if VLC is available on the bus
574 * if not: D-Bus control is not enabled on the other
575 * instance and we can't pass MRLs to it */
576 DBusMessage *p_test_msg = NULL;
577 DBusMessage *p_test_reply = NULL;
578 p_test_msg = dbus_message_new_method_call(
579 "org.mpris.vlc", "/",
580 "org.freedesktop.MediaPlayer", "Identity" );
581 /* block until a reply arrives */
582 p_test_reply = dbus_connection_send_with_reply_and_block(
583 p_conn, p_test_msg, -1, &dbus_error );
584 dbus_message_unref( p_test_msg );
585 if( p_test_reply == NULL )
587 dbus_error_free( &dbus_error );
588 msg_Dbg( p_libvlc, "No Media Player is running. "
589 "Continuing normally." );
594 DBusMessage* p_dbus_msg = NULL;
595 DBusMessageIter dbus_args;
596 DBusPendingCall* p_dbus_pending = NULL;
599 dbus_message_unref( p_test_reply );
600 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
602 for( i_input = optind;i_input < i_argc;i_input++ )
604 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
605 ppsz_argv[i_input] );
607 p_dbus_msg = dbus_message_new_method_call(
608 "org.mpris.vlc", "/TrackList",
609 "org.freedesktop.MediaPlayer", "AddTrack" );
611 if ( NULL == p_dbus_msg )
613 msg_Err( p_libvlc, "D-Bus problem" );
614 system_End( p_libvlc );
619 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
620 if ( !dbus_message_iter_append_basic( &dbus_args,
621 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
623 dbus_message_unref( p_dbus_msg );
624 system_End( p_libvlc );
628 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
630 if ( !dbus_message_iter_append_basic( &dbus_args,
631 DBUS_TYPE_BOOLEAN, &b_play ) )
633 dbus_message_unref( p_dbus_msg );
634 system_End( p_libvlc );
638 /* send message and get a handle for a reply */
639 if ( !dbus_connection_send_with_reply ( p_conn,
640 p_dbus_msg, &p_dbus_pending, -1 ) )
642 msg_Err( p_libvlc, "D-Bus problem" );
643 dbus_message_unref( p_dbus_msg );
644 system_End( p_libvlc );
648 if ( NULL == p_dbus_pending )
650 msg_Err( p_libvlc, "D-Bus problem" );
651 dbus_message_unref( p_dbus_msg );
652 system_End( p_libvlc );
655 dbus_connection_flush( p_conn );
656 dbus_message_unref( p_dbus_msg );
657 /* block until we receive a reply */
658 dbus_pending_call_block( p_dbus_pending );
659 dbus_pending_call_unref( p_dbus_pending );
660 } /* processes all command line MRLs */
663 system_End( p_libvlc );
667 /* we unreference the connection when we've finished with it */
668 if( p_conn ) dbus_connection_unref( p_conn );
673 * Message queue options
675 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
676 if( psz_verbose_objects )
678 char * psz_object, * iter = psz_verbose_objects;
679 while( (psz_object = strsep( &iter, "," )) )
681 switch( psz_object[0] )
683 printf("%s\n", psz_object+1);
684 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
685 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
687 msg_Err( p_libvlc, "verbose-objects usage: \n"
688 "--verbose-objects=+printthatobject,"
689 "-dontprintthatone\n"
690 "(keyword 'all' to applies to all objects)");
691 free( psz_verbose_objects );
692 /* FIXME: leaks!!!! */
696 free( psz_verbose_objects );
699 /* Last chance to set the verbosity. Once we start interfaces and other
700 * threads, verbosity becomes read-only. */
701 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
702 if( var_InheritBool( p_libvlc, "quiet" ) )
704 var_SetInteger( p_libvlc, "verbose", -1 );
705 priv->i_verbose = -1;
707 vlc_threads_setup( p_libvlc );
710 priv->b_color = var_InheritBool( p_libvlc, "color" );
712 char p_capabilities[200];
713 #define PRINT_CAPABILITY( capability, string ) \
714 if( vlc_CPU() & capability ) \
716 strncat( p_capabilities, string " ", \
717 sizeof(p_capabilities) - strlen(p_capabilities) ); \
718 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
720 p_capabilities[0] = '\0';
722 #if defined( __i386__ ) || defined( __x86_64__ )
723 if( !var_InheritBool( p_libvlc, "mmx" ) )
724 cpu_flags &= ~CPU_CAPABILITY_MMX;
725 if( !var_InheritBool( p_libvlc, "3dn" ) )
726 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
727 if( !var_InheritBool( p_libvlc, "mmxext" ) )
728 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
729 if( !var_InheritBool( p_libvlc, "sse" ) )
730 cpu_flags &= ~CPU_CAPABILITY_SSE;
731 if( !var_InheritBool( p_libvlc, "sse2" ) )
732 cpu_flags &= ~CPU_CAPABILITY_SSE2;
733 if( !var_InheritBool( p_libvlc, "sse3" ) )
734 cpu_flags &= ~CPU_CAPABILITY_SSE3;
735 if( !var_InheritBool( p_libvlc, "ssse3" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
737 if( !var_InheritBool( p_libvlc, "sse41" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
739 if( !var_InheritBool( p_libvlc, "sse42" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
742 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
743 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
744 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
745 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
753 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
754 if( !var_InheritBool( p_libvlc, "altivec" ) )
755 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
757 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
759 #elif defined( __arm__ )
760 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
765 strncat( p_capabilities, "FPU ",
766 sizeof(p_capabilities) - strlen( p_capabilities) );
767 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
770 if (p_capabilities[0])
771 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
774 * Choose the best memcpy module
776 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
777 /* Avoid being called "memcpy":*/
778 vlc_object_set_name( p_libvlc, "main" );
780 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
782 priv->pp_timers = NULL;
784 priv->i_last_input_id = 0; /* Not very safe, should be removed */
787 * Initialize hotkey handling
789 vlc_InitActions( p_libvlc );
791 /* variables for signalling creation of new files */
792 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
793 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
795 /* Initialize playlist and get commandline files */
796 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
799 msg_Err( p_libvlc, "playlist initialization failed" );
800 if( priv->p_memcpy_module != NULL )
802 module_unneed( p_libvlc, priv->p_memcpy_module );
804 module_EndBank( p_libvlc, true );
807 playlist_Activate( p_playlist );
809 /* Add service discovery modules */
810 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
813 char *p = psz_modules, *m;
814 playlist_t *p_playlist = pl_Hold( p_libvlc );
815 while( ( m = strsep( &p, " :," ) ) != NULL )
816 playlist_ServicesDiscoveryAdd( p_playlist, m );
818 pl_Release (p_playlist);
822 /* Initialize VLM if vlm-conf is specified */
823 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
826 priv->p_vlm = vlm_New( p_libvlc );
828 msg_Err( p_libvlc, "VLM initialization failed" );
834 * Load background interfaces
836 /* Create volume callback system. (this variable must be created before
837 all interfaces as they can use it) */
838 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
839 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
841 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
842 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
844 if( psz_modules && psz_control )
847 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
850 psz_modules = psz_tmp;
853 else if( psz_control )
856 psz_modules = strdup( psz_control );
859 psz_parser = psz_modules;
860 while ( psz_parser && *psz_parser )
862 char *psz_module, *psz_temp;
863 psz_module = psz_parser;
864 psz_parser = strchr( psz_module, ':' );
870 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
872 intf_Create( p_libvlc, psz_temp );
880 * Always load the hotkeys interface if it exists
882 intf_Create( p_libvlc, "hotkeys,none" );
885 /* loads dbus control interface if in one-instance mode
886 * we do it only when playlist exists, because dbus module needs it */
887 if( var_InheritBool( p_libvlc, "one-instance" )
888 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
889 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
890 intf_Create( p_libvlc, "dbus,none" );
892 # if !defined (HAVE_MAEMO)
893 /* Prevents the power management daemon from suspending the system
894 * when VLC is active */
895 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
896 intf_Create( p_libvlc, "inhibit,none" );
900 if( var_InheritBool( p_libvlc, "file-logging" ) &&
901 !var_InheritBool( p_libvlc, "syslog" ) )
903 intf_Create( p_libvlc, "logger,none" );
906 if( var_InheritBool( p_libvlc, "syslog" ) )
908 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
909 var_SetString( p_libvlc, "logmode", "syslog" );
910 intf_Create( p_libvlc, "logger,none" );
914 var_SetString( p_libvlc, "logmode", logmode );
917 var_Destroy( p_libvlc, "logmode" );
921 if( var_InheritBool( p_libvlc, "network-synchronisation") )
923 intf_Create( p_libvlc, "netsync,none" );
927 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
929 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
932 char *psz_morecodecs;
933 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
935 var_SetString( p_libvlc, "codec", psz_morecodecs);
936 free( psz_morecodecs );
941 var_SetString( p_libvlc, "codec", "dmo,quicktime");
945 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
946 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
947 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
948 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
949 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
955 /* Create a variable for showing the fullscreen interface from hotkeys */
956 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
957 var_SetBool( p_libvlc, "intf-show", true );
959 /* Create a variable for showing the right click menu */
960 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
963 * Get input filenames given as commandline arguments
965 GetFilenames( p_libvlc, i_argc, ppsz_argv );
968 * Get --open argument
970 psz_val = var_InheritString( p_libvlc, "open" );
971 if ( psz_val != NULL )
973 playlist_t *p_playlist = pl_Hold( p_libvlc );
974 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
975 -1, 0, NULL, 0, true, pl_Unlocked );
976 pl_Release( p_libvlc );
984 * Cleanup a libvlc instance. The instance is not completely deallocated
985 * \param p_libvlc the instance to clean
987 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
989 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
990 playlist_t *p_playlist = priv->p_playlist;
992 /* Deactivate the playlist */
993 msg_Dbg( p_libvlc, "deactivating the playlist" );
994 playlist_Deactivate( p_playlist );
996 /* Remove all services discovery */
997 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
998 playlist_ServicesDiscoveryKillAll( p_playlist );
1000 /* Ask the interfaces to stop and destroy them */
1001 msg_Dbg( p_libvlc, "removing all interfaces" );
1002 libvlc_Quit( p_libvlc );
1003 intf_DestroyAll( p_libvlc );
1006 /* Destroy VLM if created in libvlc_InternalInit */
1009 vlm_Delete( priv->p_vlm );
1014 /* Any thread still running must not assume pl_Hold() succeeds. */
1015 msg_Dbg( p_libvlc, "removing playlist" );
1017 libvlc_priv(p_libvlc)->p_playlist = NULL;
1018 barrier(); /* FIXME is that correct ? */
1020 vlc_object_release( p_playlist );
1022 stats_TimersDumpAll( p_libvlc );
1023 stats_TimersCleanAll( p_libvlc );
1025 msg_Dbg( p_libvlc, "removing stats" );
1028 char* psz_pidfile = NULL;
1032 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1033 if( psz_pidfile != NULL )
1035 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1036 if( unlink( psz_pidfile ) == -1 )
1038 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1042 free( psz_pidfile );
1046 if( priv->p_memcpy_module )
1048 module_unneed( p_libvlc, priv->p_memcpy_module );
1049 priv->p_memcpy_module = NULL;
1052 /* Free module bank. It is refcounted, so we call this each time */
1053 module_EndBank( p_libvlc, true );
1055 vlc_DeinitActions( p_libvlc );
1059 * Destroy everything.
1060 * This function requests the running threads to finish, waits for their
1061 * termination, and destroys their structure.
1062 * It stops the thread systems: no instance can run after this has run
1063 * \param p_libvlc the instance to destroy
1065 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1067 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1069 vlc_mutex_lock( &global_lock );
1072 if( i_instances == 0 )
1074 /* System specific cleaning code */
1075 system_End( p_libvlc );
1077 vlc_mutex_unlock( &global_lock );
1079 msg_Destroy( p_libvlc );
1081 /* Destroy mutexes */
1082 vlc_mutex_destroy( &priv->timer_lock );
1084 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1085 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1086 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1087 vlc_object_release( p_libvlc );
1090 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1091 vlc_object_release( p_libvlc );
1095 * Add an interface plugin and run it
1097 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1100 return VLC_EGENERIC;
1102 if( !psz_module ) /* requesting the default interface */
1104 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1105 if( !psz_interface ) /* "intf" has not been set */
1109 /* Daemon mode hack.
1110 * We prefer the dummy interface if none is specified. */
1111 psz_module = "dummy";
1114 msg_Info( p_libvlc, "%s",
1115 _("Running vlc with the default interface. "
1116 "Use 'cvlc' to use vlc without interface.") );
1118 free( psz_interface );
1119 var_Destroy( p_libvlc, "intf" );
1122 /* Try to create the interface */
1123 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1125 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1126 psz_module ? psz_module : "default" );
1131 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1132 static vlc_cond_t exiting = VLC_STATIC_COND;
1134 extern vlc_mutex_t super_mutex;
1135 extern vlc_cond_t super_variable;
1136 # define exit_lock super_mutex
1137 # define exiting super_variable
1141 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1142 * when the user "exits" an interface plugin.
1144 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1146 vlc_mutex_lock( &exit_lock );
1147 while( vlc_object_alive( p_libvlc ) )
1148 vlc_cond_wait( &exiting, &exit_lock );
1149 vlc_mutex_unlock( &exit_lock );
1153 * Posts an exit signal to LibVLC instance. This will normally initiate the
1154 * cleanup and destroy process. It should only be called on behalf of the user.
1156 void libvlc_Quit( libvlc_int_t *p_libvlc )
1158 vlc_mutex_lock( &exit_lock );
1159 vlc_object_kill( p_libvlc );
1160 vlc_cond_broadcast( &exiting );
1161 vlc_mutex_unlock( &exit_lock );
1164 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1165 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1166 /*****************************************************************************
1167 * SetLanguage: set the interface language.
1168 *****************************************************************************
1169 * We set the LC_MESSAGES locale category for interface messages and buttons,
1170 * as well as the LC_CTYPE category for string sorting and possible wide
1171 * character support.
1172 *****************************************************************************/
1173 static void SetLanguage ( const char *psz_lang )
1176 /* I need that under Darwin, please check it doesn't disturb
1177 * other platforms. --Meuuh */
1178 setenv( "LANG", psz_lang, 1 );
1181 /* We set LC_ALL manually because it is the only way to set
1182 * the language at runtime under eg. Windows. Beware that this
1183 * makes the environment unconsistent when libvlc is unloaded and
1184 * should probably be moved to a safer place like vlc.c. */
1185 static char psz_lcall[20];
1186 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1187 psz_lcall[19] = '\0';
1188 putenv( psz_lcall );
1191 setlocale( LC_ALL, psz_lang );
1195 /*****************************************************************************
1196 * GetFilenames: parse command line options which are not flags
1197 *****************************************************************************
1198 * Parse command line for input files as well as their associated options.
1199 * An option always follows its associated input and begins with a ":".
1200 *****************************************************************************/
1201 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1203 int i_opt, i_options;
1205 /* We assume that the remaining parameters are filenames
1206 * and their input options */
1207 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1211 /* Count the input options */
1212 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1218 /* TODO: write an internal function of this one, to avoid
1219 * unnecessary lookups. */
1220 char *mrl = make_URI( ppsz_argv[i_opt] );
1224 playlist_t *p_playlist = pl_Hold( p_vlc );
1225 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1226 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1227 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1228 pl_Release( p_vlc );
1235 /*****************************************************************************
1236 * Help: print program help
1237 *****************************************************************************
1238 * Print a short inline help. Message interface is initialized at this stage.
1239 *****************************************************************************/
1240 static inline void print_help_on_full_help( void )
1242 utf8_fprintf( stdout, "\n" );
1243 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1246 static const char vlc_usage[] = N_(
1247 "Usage: %s [options] [stream] ..."
1248 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1249 "\nThe first item specified will be played first."
1252 "\n --option A global option that is set for the duration of the program."
1253 "\n -option A single letter version of a global --option."
1254 "\n :option An option that only applies to the stream directly before it"
1255 "\n and that overrides previous settings."
1257 "\nStream MRL syntax:"
1258 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1260 "\n Many of the global --options can also be used as MRL specific :options."
1261 "\n Multiple :option=value pairs can be specified."
1264 "\n [file://]filename Plain media file"
1265 "\n http://ip:port/file HTTP URL"
1266 "\n ftp://ip:port/file FTP URL"
1267 "\n mms://ip:port/file MMS URL"
1268 "\n screen:// Screen capture"
1269 "\n [dvd://][device][@raw_device] DVD device"
1270 "\n [vcd://][device] VCD device"
1271 "\n [cdda://][device] Audio CD device"
1272 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1273 "\n UDP stream sent by a streaming server"
1274 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1275 "\n vlc://quit Special item to quit VLC"
1278 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1281 ShowConsole( true );
1284 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1286 utf8_fprintf( stdout, vlc_usage, "vlc" );
1287 Usage( p_this, "=help" );
1288 Usage( p_this, "=main" );
1289 print_help_on_full_help();
1291 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1293 utf8_fprintf( stdout, vlc_usage, "vlc" );
1294 Usage( p_this, NULL );
1295 print_help_on_full_help();
1297 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1299 utf8_fprintf( stdout, vlc_usage, "vlc" );
1300 Usage( p_this, NULL );
1302 else if( psz_help_name )
1304 Usage( p_this, psz_help_name );
1307 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1312 /*****************************************************************************
1313 * Usage: print module usage
1314 *****************************************************************************
1315 * Print a short inline help. Message interface is initialized at this stage.
1316 *****************************************************************************/
1317 # define COL(x) "\033[" #x ";1m"
1318 # define RED COL(31)
1319 # define GREEN COL(32)
1320 # define YELLOW COL(33)
1321 # define BLUE COL(34)
1322 # define MAGENTA COL(35)
1323 # define CYAN COL(36)
1324 # define WHITE COL(0)
1325 # define GRAY "\033[0m"
1327 print_help_section( const module_t *m, const module_config_t *p_item,
1328 bool b_color, bool b_description )
1330 if( !p_item ) return;
1333 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1334 module_gettext( m, p_item->psz_text ) );
1335 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1336 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1337 module_gettext( m, p_item->psz_longtext ) );
1341 utf8_fprintf( stdout, " %s:\n",
1342 module_gettext( m, p_item->psz_text ) );
1343 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1344 utf8_fprintf( stdout, " %s\n",
1345 module_gettext(m, p_item->psz_longtext ) );
1349 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1351 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1352 /* short option ------' | | | | | | |
1353 * option name ------------' | | | | | |
1354 * <bra ---------------------' | | | | |
1355 * option type or "" ----------' | | | |
1356 * ket> -------------------------' | | |
1357 * padding spaces -----------------' | |
1358 * comment --------------------------' |
1359 * comment suffix ---------------------'
1361 * The purpose of having bra and ket is that we might i18n them as well.
1364 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1365 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1367 #define LINE_START 8
1368 #define PADDING_SPACES 25
1370 # define OPTION_VALUE_SEP "="
1372 # define OPTION_VALUE_SEP " "
1374 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1375 char psz_spaces_longtext[LINE_START+3];
1376 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1377 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1378 char psz_buffer[10000];
1380 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1381 int i_width_description = i_width + PADDING_SPACES - 1;
1382 bool b_advanced = var_InheritBool( p_this, "advanced" );
1383 bool b_description = var_InheritBool( p_this, "help-verbose" );
1384 bool b_description_hack;
1385 bool b_color = var_InheritBool( p_this, "color" );
1386 bool b_has_advanced = false;
1387 bool b_found = false;
1388 int i_only_advanced = 0; /* Number of modules ignored because they
1389 * only have advanced options */
1390 bool b_strict = psz_search && *psz_search == '=';
1391 if( b_strict ) psz_search++;
1393 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1394 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1395 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1396 psz_spaces_longtext[LINE_START+2] = '\0';
1400 b_color = false; // don't put color control codes in a .txt file
1404 strcpy( psz_format, COLOR_FORMAT_STRING );
1405 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1409 strcpy( psz_format, FORMAT_STRING );
1410 strcpy( psz_format_bool, FORMAT_STRING );
1413 /* List all modules */
1414 module_t **list = module_list_get (NULL);
1418 /* Ugly hack to make sure that the help options always come first
1421 Usage( p_this, "help" );
1423 /* Enumerate the config for each module */
1424 for (size_t i = 0; list[i]; i++)
1427 module_t *p_parser = list[i];
1428 module_config_t *p_item = NULL;
1429 module_config_t *p_section = NULL;
1430 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1433 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1434 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1436 char *const *pp_shortcut = p_parser->pp_shortcuts;
1437 while( *pp_shortcut )
1439 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1440 : !!strstr( *pp_shortcut, psz_search ) )
1448 /* Ignore modules without config options */
1449 if( !p_parser->i_config_items )
1454 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1455 /* Ugly hack to make sure that the help options always come first
1457 if( !psz_search && b_help_module )
1460 /* Ignore modules with only advanced config options if requested */
1463 for( p_item = p_parser->p_config;
1467 if( (p_item->i_type & CONFIG_ITEM) &&
1468 !p_item->b_advanced && !p_item->b_removed ) break;
1471 if( p_item == p_end )
1480 /* Print name of module */
1481 if( strcmp( "main", p_parser->psz_object_name ) )
1484 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1485 module_gettext( p_parser, p_parser->psz_longname ),
1486 p_parser->psz_object_name );
1488 utf8_fprintf( stdout, "\n %s\n",
1489 module_gettext(p_parser, p_parser->psz_longname ) );
1491 if( p_parser->psz_help )
1494 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1495 module_gettext( p_parser, p_parser->psz_help ) );
1497 utf8_fprintf( stdout, " %s\n",
1498 module_gettext( p_parser, p_parser->psz_help ) );
1501 /* Print module options */
1502 for( p_item = p_parser->p_config;
1506 char *psz_text, *psz_spaces = psz_spaces_text;
1507 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1508 const char *psz_suf = "", *psz_prefix = NULL;
1512 /* Skip removed options */
1513 if( p_item->b_removed )
1517 /* Skip advanced options if requested */
1518 if( p_item->b_advanced && !b_advanced )
1520 b_has_advanced = true;
1524 switch( p_item->i_type )
1526 case CONFIG_HINT_CATEGORY:
1527 case CONFIG_HINT_USAGE:
1528 if( !strcmp( "main", p_parser->psz_object_name ) )
1531 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1532 module_gettext( p_parser, p_item->psz_text ) );
1534 utf8_fprintf( stdout, "\n %s\n",
1535 module_gettext( p_parser, p_item->psz_text ) );
1537 if( b_description && p_item->psz_longtext
1538 && *p_item->psz_longtext )
1541 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1542 module_gettext( p_parser, p_item->psz_longtext ) );
1544 utf8_fprintf( stdout, " %s\n",
1545 module_gettext( p_parser, p_item->psz_longtext ) );
1549 case CONFIG_HINT_SUBCATEGORY:
1550 if( strcmp( "main", p_parser->psz_object_name ) )
1552 case CONFIG_SECTION:
1556 case CONFIG_ITEM_STRING:
1557 case CONFIG_ITEM_FILE:
1558 case CONFIG_ITEM_DIRECTORY:
1559 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1560 case CONFIG_ITEM_MODULE_CAT:
1561 case CONFIG_ITEM_MODULE_LIST:
1562 case CONFIG_ITEM_MODULE_LIST_CAT:
1563 case CONFIG_ITEM_FONT:
1564 case CONFIG_ITEM_PASSWORD:
1565 print_help_section( p_parser, p_section, b_color,
1568 psz_bra = OPTION_VALUE_SEP "<";
1569 psz_type = _("string");
1572 if( p_item->ppsz_list )
1574 psz_bra = OPTION_VALUE_SEP "{";
1575 psz_type = psz_buffer;
1576 psz_buffer[0] = '\0';
1577 for( i = 0; p_item->ppsz_list[i]; i++ )
1579 if( i ) strcat( psz_buffer, "," );
1580 strcat( psz_buffer, p_item->ppsz_list[i] );
1585 case CONFIG_ITEM_INTEGER:
1586 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1587 print_help_section( p_parser, p_section, b_color,
1590 psz_bra = OPTION_VALUE_SEP "<";
1591 psz_type = _("integer");
1594 if( p_item->min.i || p_item->max.i )
1596 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1597 p_item->min.i, p_item->max.i );
1598 psz_type = psz_buffer;
1601 if( p_item->i_list )
1603 psz_bra = OPTION_VALUE_SEP "{";
1604 psz_type = psz_buffer;
1605 psz_buffer[0] = '\0';
1606 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1608 if( i ) strcat( psz_buffer, ", " );
1609 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1611 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1616 case CONFIG_ITEM_FLOAT:
1617 print_help_section( p_parser, p_section, b_color,
1620 psz_bra = OPTION_VALUE_SEP "<";
1621 psz_type = _("float");
1623 if( p_item->min.f || p_item->max.f )
1625 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1626 p_item->min.f, p_item->max.f );
1627 psz_type = psz_buffer;
1630 case CONFIG_ITEM_BOOL:
1631 print_help_section( p_parser, p_section, b_color,
1634 psz_bra = ""; psz_type = ""; psz_ket = "";
1635 if( !b_help_module )
1637 psz_suf = p_item->value.i ? _(" (default enabled)") :
1638 _(" (default disabled)");
1648 /* Add short option if any */
1649 if( p_item->i_short )
1651 sprintf( psz_short, "-%c,", p_item->i_short );
1655 strcpy( psz_short, " " );
1658 i = PADDING_SPACES - strlen( p_item->psz_name )
1659 - strlen( psz_bra ) - strlen( psz_type )
1660 - strlen( psz_ket ) - 1;
1662 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1664 psz_prefix = ", --no-";
1665 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1670 psz_spaces[0] = '\n';
1675 psz_spaces[i] = '\0';
1678 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1680 utf8_fprintf( stdout, psz_format_bool, psz_short,
1681 p_item->psz_name, psz_prefix, p_item->psz_name,
1682 psz_bra, psz_type, psz_ket, psz_spaces );
1686 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1687 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1690 psz_spaces[i] = ' ';
1692 /* We wrap the rest of the output */
1693 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1695 b_description_hack = b_description;
1698 psz_text = psz_buffer;
1699 i_cur_width = b_description && !b_description_hack
1700 ? i_width_description
1704 char *psz_parser, *psz_word;
1705 size_t i_end = strlen( psz_text );
1707 /* If the remaining text fits in a line, print it. */
1708 if( i_end <= i_cur_width )
1712 if( !b_description || b_description_hack )
1713 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1715 utf8_fprintf( stdout, "%s\n", psz_text );
1719 utf8_fprintf( stdout, "%s\n", psz_text );
1724 /* Otherwise, eat as many words as possible */
1725 psz_parser = psz_text;
1728 psz_word = psz_parser;
1729 psz_parser = strchr( psz_word, ' ' );
1730 /* If no space was found, we reached the end of the text
1731 * block; otherwise, we skip the space we just found. */
1732 psz_parser = psz_parser ? psz_parser + 1
1735 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1737 /* We cut a word in one of these cases:
1738 * - it's the only word in the line and it's too long.
1739 * - we used less than 80% of the width and the word we are
1740 * going to wrap is longer than 40% of the width, and even
1741 * if the word would have fit in the next line. */
1742 if( psz_word == psz_text
1743 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1744 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1746 char c = psz_text[i_cur_width];
1747 psz_text[i_cur_width] = '\0';
1750 if( !b_description || b_description_hack )
1751 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1752 psz_text, psz_spaces );
1754 utf8_fprintf( stdout, "%s\n%s",
1755 psz_text, psz_spaces );
1759 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1761 psz_text += i_cur_width;
1766 psz_word[-1] = '\0';
1769 if( !b_description || b_description_hack )
1770 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1771 psz_text, psz_spaces );
1773 utf8_fprintf( stdout, "%s\n%s",
1774 psz_text, psz_spaces );
1778 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1780 psz_text = psz_word;
1784 if( b_description_hack && p_item->psz_longtext
1785 && *p_item->psz_longtext )
1787 sprintf( psz_buffer, "%s%s",
1788 module_gettext( p_parser, p_item->psz_longtext ),
1790 b_description_hack = false;
1791 psz_spaces = psz_spaces_longtext;
1792 utf8_fprintf( stdout, "%s", psz_spaces );
1798 if( b_has_advanced )
1801 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1802 _( "add --advanced to your command line to see advanced options."));
1804 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1805 _( "add --advanced to your command line to see advanced options."));
1808 if( i_only_advanced > 0 )
1812 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1813 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1817 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1818 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1824 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1825 _( "No matching module found. Use --list or " \
1826 "--list-verbose to list available modules." ) );
1828 utf8_fprintf( stdout, "\n%s\n",
1829 _( "No matching module found. Use --list or " \
1830 "--list-verbose to list available modules." ) );
1833 /* Release the module list */
1834 module_list_free (list);
1837 /*****************************************************************************
1838 * ListModules: list the available modules with their description
1839 *****************************************************************************
1840 * Print a list of all available modules (builtins and plugins) and a short
1841 * description for each one.
1842 *****************************************************************************/
1843 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1847 bool b_color = var_InheritBool( p_this, "color" );
1850 ShowConsole( true );
1851 b_color = false; // don't put color control codes in a .txt file
1857 /* List all modules */
1858 module_t **list = module_list_get (NULL);
1860 /* Enumerate each module */
1861 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1864 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1865 p_parser->psz_object_name,
1866 module_gettext( p_parser, p_parser->psz_longname ) );
1868 utf8_fprintf( stdout, " %-22s %s\n",
1869 p_parser->psz_object_name,
1870 module_gettext( p_parser, p_parser->psz_longname ) );
1874 char *const *pp_shortcut = p_parser->pp_shortcuts;
1875 while( *pp_shortcut )
1877 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1880 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1883 utf8_fprintf( stdout, " s %s\n",
1888 if( p_parser->psz_capability )
1891 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1892 p_parser->psz_capability,
1893 p_parser->i_score );
1895 utf8_fprintf( stdout, " c %s (%d)\n",
1896 p_parser->psz_capability,
1897 p_parser->i_score );
1901 module_list_free (list);
1903 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1908 /*****************************************************************************
1909 * Version: print complete program version
1910 *****************************************************************************
1911 * Print complete program version and build number.
1912 *****************************************************************************/
1913 static void Version( void )
1915 extern const char psz_vlc_changeset[];
1917 ShowConsole( true );
1920 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1921 psz_vlc_changeset );
1922 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1923 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1924 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1925 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1927 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1932 /*****************************************************************************
1933 * ShowConsole: On Win32, create an output console for debug messages
1934 *****************************************************************************
1935 * This function is useful only on Win32.
1936 *****************************************************************************/
1938 static void ShowConsole( bool b_dofile )
1941 FILE *f_help = NULL;
1943 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1946 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1947 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1948 * page (e.g. CP437 or CP850). */
1949 SetConsoleOutputCP (GetACP ());
1950 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1952 freopen( "CONOUT$", "w", stderr );
1953 freopen( "CONIN$", "r", stdin );
1955 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1958 freopen( "vlc-help.txt", "wt", stdout );
1959 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1961 else freopen( "CONOUT$", "w", stdout );
1967 /*****************************************************************************
1968 * PauseConsole: On Win32, wait for a key press before closing the console
1969 *****************************************************************************
1970 * This function is useful only on Win32.
1971 *****************************************************************************/
1973 static void PauseConsole( void )
1977 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1979 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1987 /*****************************************************************************
1988 * ConsoleWidth: Return the console width in characters
1989 *****************************************************************************
1990 * We use the stty shell command to get the console width; if this fails or
1991 * if the width is less than 80, we default to 80.
1992 *****************************************************************************/
1993 static int ConsoleWidth( void )
1995 unsigned i_width = 80;
1998 FILE *file = popen( "stty size 2>/dev/null", "r" );
2001 if (fscanf (file, "%*u %u", &i_width) <= 0)
2005 #elif !defined (UNDER_CE)
2006 CONSOLE_SCREEN_BUFFER_INFO buf;
2008 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2009 i_width = buf.dwSize.X;
2015 #include <vlc_avcodec.h>
2017 void vlc_avcodec_mutex (bool acquire)
2019 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2022 vlc_mutex_lock (&lock);
2024 vlc_mutex_unlock (&lock);