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 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
205 static void Help ( libvlc_int_t *, char const *psz_help_name );
206 static void Usage ( libvlc_int_t *, char const *psz_search );
207 static void ListModules ( libvlc_int_t *, bool );
208 static void Version ( void );
211 static void ShowConsole ( bool );
212 static void PauseConsole ( void );
214 static int ConsoleWidth ( void );
216 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
219 * Allocate a libvlc instance, initialize global data if needed
220 * It also initializes the threading system
222 libvlc_int_t * libvlc_InternalCreate( void )
224 libvlc_int_t *p_libvlc;
226 char *psz_env = NULL;
228 /* Now that the thread system is initialized, we don't have much, but
229 * at least we have variables */
230 vlc_mutex_lock( &global_lock );
231 if( i_instances == 0 )
233 /* Guess what CPU we have */
234 cpu_flags = CPUCapabilities();
235 /* The module bank will be initialized later */
238 /* Allocate a libvlc instance object */
239 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
240 VLC_OBJECT_GENERIC, "libvlc" );
241 if( p_libvlc != NULL )
243 vlc_mutex_unlock( &global_lock );
245 if( p_libvlc == NULL )
248 priv = libvlc_priv (p_libvlc);
249 priv->p_playlist = NULL;
250 priv->p_dialog_provider = NULL;
253 /* Initialize message queue */
254 msg_Create( p_libvlc );
256 /* Find verbosity from VLC_VERBOSE environment variable */
257 psz_env = getenv( "VLC_VERBOSE" );
258 if( psz_env != NULL )
259 priv->i_verbose = atoi( psz_env );
262 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
263 priv->b_color = isatty( 2 ); /* 2 is for stderr */
265 priv->b_color = false;
268 /* Initialize mutexes */
269 vlc_mutex_init( &priv->timer_lock );
275 * Initialize a libvlc instance
276 * This function initializes a previously allocated libvlc instance:
278 * - gettext initialization
279 * - message queue, module bank and playlist initialization
280 * - configuration and commandline parsing
282 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
283 const char *ppsz_argv[] )
285 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
287 char * psz_modules = NULL;
288 char * psz_parser = NULL;
289 char * psz_control = NULL;
291 int i_ret = VLC_EEXIT;
292 playlist_t *p_playlist = NULL;
294 #if defined( ENABLE_NLS ) \
295 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
296 # if defined (WIN32) || defined (__APPLE__)
301 /* System specific initialization code */
302 system_Init( p_libvlc, &i_argc, ppsz_argv );
305 * Support for gettext
307 vlc_bindtextdomain (PACKAGE_NAME);
309 /* Initialize the module bank and load the configuration of the
310 * main module. We need to do this at this stage to be able to display
311 * a short help if required by the user. (short help == main module
313 module_InitBank( p_libvlc );
315 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
317 module_EndBank( p_libvlc, false );
321 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
322 /* Announce who we are - Do it only for first instance ? */
323 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
324 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
325 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
326 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
328 /* Check for short help option */
329 if( var_InheritBool( p_libvlc, "help" ) )
331 Help( p_libvlc, "help" );
333 i_ret = VLC_EEXITSUCCESS;
335 /* Check for version option */
336 else if( var_InheritBool( p_libvlc, "version" ) )
340 i_ret = VLC_EEXITSUCCESS;
343 /* Check for plugins cache options */
344 bool b_cache_delete = var_InheritBool( p_libvlc, "reset-plugins-cache" );
346 /* Check for daemon mode */
348 if( var_InheritBool( p_libvlc, "daemon" ) )
351 char *psz_pidfile = NULL;
353 if( daemon( 1, 0) != 0 )
355 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
360 /* lets check if we need to write the pidfile */
361 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
362 if( psz_pidfile != NULL )
365 pid_t i_pid = getpid ();
366 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
367 i_pid, psz_pidfile );
368 pidfile = utf8_fopen( psz_pidfile,"w" );
369 if( pidfile != NULL )
371 utf8_fprintf( pidfile, "%d", (int)i_pid );
376 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
385 if( ( i_pid = fork() ) < 0 )
387 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
392 /* This is the parent, exit right now */
393 msg_Dbg( p_libvlc, "closing parent process" );
395 i_ret = VLC_EEXITSUCCESS;
399 /* We are the child */
400 msg_Dbg( p_libvlc, "daemon spawned" );
401 close( STDIN_FILENO );
402 close( STDOUT_FILENO );
403 close( STDERR_FILENO );
413 module_EndBank( p_libvlc, false );
417 /* Check for translation config option */
418 #if defined( ENABLE_NLS ) \
419 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
420 # if defined (WIN32) || defined (__APPLE__)
421 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
422 config_LoadConfigFile( p_libvlc, "main" );
423 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
425 /* Check if the user specified a custom language */
426 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
427 if( psz_language && strcmp( psz_language, "auto" ) )
429 /* Reset the default domain */
430 SetLanguage( psz_language );
432 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
433 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
435 free( psz_language );
440 * Load the builtins and plugins into the module_bank.
441 * We have to do it before config_Load*() because this also gets the
442 * list of configuration options exported by each module and loads their
445 module_LoadPlugins( p_libvlc, b_cache_delete );
446 if( p_libvlc->b_die )
452 module_t **list = module_list_get( &module_count );
453 module_list_free( list );
454 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
456 /* Check for help on modules */
457 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
459 Help( p_libvlc, p_tmp );
462 i_ret = VLC_EEXITSUCCESS;
464 /* Check for full help option */
465 else if( var_InheritBool( p_libvlc, "full-help" ) )
467 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
468 var_SetBool( p_libvlc, "advanced", true );
469 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
470 var_SetBool( p_libvlc, "help-verbose", true );
471 Help( p_libvlc, "full-help" );
473 i_ret = VLC_EEXITSUCCESS;
475 /* Check for long help option */
476 else if( var_InheritBool( p_libvlc, "longhelp" ) )
478 Help( p_libvlc, "longhelp" );
480 i_ret = VLC_EEXITSUCCESS;
482 /* Check for module list option */
483 else if( var_InheritBool( p_libvlc, "list" ) )
485 ListModules( p_libvlc, false );
487 i_ret = VLC_EEXITSUCCESS;
489 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
491 ListModules( p_libvlc, true );
493 i_ret = VLC_EEXITSUCCESS;
496 /* Check for config file options */
497 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
499 if( var_InheritBool( p_libvlc, "reset-config" ) )
501 config_ResetAll( p_libvlc );
502 config_SaveConfigFile( p_libvlc, NULL );
506 if( module_count <= 1)
508 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
509 "that you properly gave a module path with --plugin-path.");
516 module_EndBank( p_libvlc, true );
521 * Override default configuration with config file settings
523 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
524 config_LoadConfigFile( p_libvlc, NULL );
527 * Override configuration with command line settings
529 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
532 ShowConsole( false );
533 /* Pause the console because it's destroyed when we exit */
534 fprintf( stderr, "The command line options couldn't be loaded, check "
535 "that they are valid.\n" );
538 module_EndBank( p_libvlc, true );
541 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
544 * System specific configuration
546 system_Configure( p_libvlc, &i_argc, ppsz_argv );
548 /* FIXME: could be replaced by using Unix sockets */
550 dbus_threads_init_default();
552 if( var_InheritBool( p_libvlc, "one-instance" )
553 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
554 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
556 /* Initialise D-Bus interface, check for other instances */
557 DBusConnection *p_conn = NULL;
558 DBusError dbus_error;
560 dbus_error_init( &dbus_error );
562 /* connect to the session bus */
563 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
566 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
567 dbus_error.message );
568 dbus_error_free( &dbus_error );
572 /* check if VLC is available on the bus
573 * if not: D-Bus control is not enabled on the other
574 * instance and we can't pass MRLs to it */
575 DBusMessage *p_test_msg = NULL;
576 DBusMessage *p_test_reply = NULL;
577 p_test_msg = dbus_message_new_method_call(
578 "org.mpris.vlc", "/",
579 "org.freedesktop.MediaPlayer", "Identity" );
580 /* block until a reply arrives */
581 p_test_reply = dbus_connection_send_with_reply_and_block(
582 p_conn, p_test_msg, -1, &dbus_error );
583 dbus_message_unref( p_test_msg );
584 if( p_test_reply == NULL )
586 dbus_error_free( &dbus_error );
587 msg_Dbg( p_libvlc, "No Media Player is running. "
588 "Continuing normally." );
593 DBusMessage* p_dbus_msg = NULL;
594 DBusMessageIter dbus_args;
595 DBusPendingCall* p_dbus_pending = NULL;
598 dbus_message_unref( p_test_reply );
599 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
601 for( i_input = optind;i_input < i_argc;i_input++ )
603 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
604 ppsz_argv[i_input] );
606 p_dbus_msg = dbus_message_new_method_call(
607 "org.mpris.vlc", "/TrackList",
608 "org.freedesktop.MediaPlayer", "AddTrack" );
610 if ( NULL == p_dbus_msg )
612 msg_Err( p_libvlc, "D-Bus problem" );
613 system_End( p_libvlc );
618 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
619 if ( !dbus_message_iter_append_basic( &dbus_args,
620 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
622 dbus_message_unref( p_dbus_msg );
623 system_End( p_libvlc );
627 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
629 if ( !dbus_message_iter_append_basic( &dbus_args,
630 DBUS_TYPE_BOOLEAN, &b_play ) )
632 dbus_message_unref( p_dbus_msg );
633 system_End( p_libvlc );
637 /* send message and get a handle for a reply */
638 if ( !dbus_connection_send_with_reply ( p_conn,
639 p_dbus_msg, &p_dbus_pending, -1 ) )
641 msg_Err( p_libvlc, "D-Bus problem" );
642 dbus_message_unref( p_dbus_msg );
643 system_End( p_libvlc );
647 if ( NULL == p_dbus_pending )
649 msg_Err( p_libvlc, "D-Bus problem" );
650 dbus_message_unref( p_dbus_msg );
651 system_End( p_libvlc );
654 dbus_connection_flush( p_conn );
655 dbus_message_unref( p_dbus_msg );
656 /* block until we receive a reply */
657 dbus_pending_call_block( p_dbus_pending );
658 dbus_pending_call_unref( p_dbus_pending );
659 } /* processes all command line MRLs */
662 system_End( p_libvlc );
666 /* we unreference the connection when we've finished with it */
667 if( p_conn ) dbus_connection_unref( p_conn );
672 * Message queue options
674 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
675 if( psz_verbose_objects )
677 char * psz_object, * iter = psz_verbose_objects;
678 while( (psz_object = strsep( &iter, "," )) )
680 switch( psz_object[0] )
682 printf("%s\n", psz_object+1);
683 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
684 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
686 msg_Err( p_libvlc, "verbose-objects usage: \n"
687 "--verbose-objects=+printthatobject,"
688 "-dontprintthatone\n"
689 "(keyword 'all' to applies to all objects)");
690 free( psz_verbose_objects );
691 /* FIXME: leaks!!!! */
695 free( psz_verbose_objects );
698 /* Last chance to set the verbosity. Once we start interfaces and other
699 * threads, verbosity becomes read-only. */
700 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
701 if( var_InheritBool( p_libvlc, "quiet" ) )
703 var_SetInteger( p_libvlc, "verbose", -1 );
704 priv->i_verbose = -1;
706 vlc_threads_setup( p_libvlc );
709 priv->b_color = var_InheritBool( p_libvlc, "color" );
711 char p_capabilities[200];
712 #define PRINT_CAPABILITY( capability, string ) \
713 if( vlc_CPU() & capability ) \
715 strncat( p_capabilities, string " ", \
716 sizeof(p_capabilities) - strlen(p_capabilities) ); \
717 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
719 p_capabilities[0] = '\0';
721 #if defined( __i386__ ) || defined( __x86_64__ )
722 if( !var_InheritBool( p_libvlc, "mmx" ) )
723 cpu_flags &= ~CPU_CAPABILITY_MMX;
724 if( !var_InheritBool( p_libvlc, "3dn" ) )
725 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
726 if( !var_InheritBool( p_libvlc, "mmxext" ) )
727 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
728 if( !var_InheritBool( p_libvlc, "sse" ) )
729 cpu_flags &= ~CPU_CAPABILITY_SSE;
730 if( !var_InheritBool( p_libvlc, "sse2" ) )
731 cpu_flags &= ~CPU_CAPABILITY_SSE2;
732 if( !var_InheritBool( p_libvlc, "sse3" ) )
733 cpu_flags &= ~CPU_CAPABILITY_SSE3;
734 if( !var_InheritBool( p_libvlc, "ssse3" ) )
735 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
736 if( !var_InheritBool( p_libvlc, "sse41" ) )
737 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
738 if( !var_InheritBool( p_libvlc, "sse42" ) )
739 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
741 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
742 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
743 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
744 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
745 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
752 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
753 if( !var_InheritBool( p_libvlc, "altivec" ) )
754 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
756 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
758 #elif defined( __arm__ )
759 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
764 strncat( p_capabilities, "FPU ",
765 sizeof(p_capabilities) - strlen( p_capabilities) );
766 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
769 if (p_capabilities[0])
770 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
773 * Choose the best memcpy module
775 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
776 /* Avoid being called "memcpy":*/
777 vlc_object_set_name( p_libvlc, "main" );
779 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
781 priv->pp_timers = NULL;
783 priv->i_last_input_id = 0; /* Not very safe, should be removed */
786 * Initialize hotkey handling
788 vlc_InitActions( p_libvlc );
790 /* variables for signalling creation of new files */
791 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
792 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
794 /* Initialize playlist and get commandline files */
795 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
798 msg_Err( p_libvlc, "playlist initialization failed" );
799 if( priv->p_memcpy_module != NULL )
801 module_unneed( p_libvlc, priv->p_memcpy_module );
803 module_EndBank( p_libvlc, true );
806 playlist_Activate( p_playlist );
808 /* Add service discovery modules */
809 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
812 char *p = psz_modules, *m;
813 while( ( m = strsep( &p, " :," ) ) != NULL )
814 playlist_ServicesDiscoveryAdd( p_playlist, m );
819 /* Initialize VLM if vlm-conf is specified */
820 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
823 priv->p_vlm = vlm_New( p_libvlc );
825 msg_Err( p_libvlc, "VLM initialization failed" );
831 * Load background interfaces
833 /* Create volume callback system. (this variable must be created before
834 all interfaces as they can use it) */
835 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
836 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
838 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
839 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
841 if( psz_modules && psz_control )
844 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
847 psz_modules = psz_tmp;
850 else if( psz_control )
853 psz_modules = strdup( psz_control );
856 psz_parser = psz_modules;
857 while ( psz_parser && *psz_parser )
859 char *psz_module, *psz_temp;
860 psz_module = psz_parser;
861 psz_parser = strchr( psz_module, ':' );
867 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
869 intf_Create( p_libvlc, psz_temp );
877 * Always load the hotkeys interface if it exists
879 intf_Create( p_libvlc, "hotkeys,none" );
882 /* loads dbus control interface if in one-instance mode
883 * we do it only when playlist exists, because dbus module needs it */
884 if( var_InheritBool( p_libvlc, "one-instance" )
885 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
886 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
887 intf_Create( p_libvlc, "dbus,none" );
889 # if !defined (HAVE_MAEMO)
890 /* Prevents the power management daemon from suspending the system
891 * when VLC is active */
892 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
893 intf_Create( p_libvlc, "inhibit,none" );
897 if( var_InheritBool( p_libvlc, "file-logging" ) &&
898 !var_InheritBool( p_libvlc, "syslog" ) )
900 intf_Create( p_libvlc, "logger,none" );
903 if( var_InheritBool( p_libvlc, "syslog" ) )
905 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
906 var_SetString( p_libvlc, "logmode", "syslog" );
907 intf_Create( p_libvlc, "logger,none" );
911 var_SetString( p_libvlc, "logmode", logmode );
914 var_Destroy( p_libvlc, "logmode" );
918 if( var_InheritBool( p_libvlc, "network-synchronisation") )
920 intf_Create( p_libvlc, "netsync,none" );
924 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
926 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
929 char *psz_morecodecs;
930 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
932 var_SetString( p_libvlc, "codec", psz_morecodecs);
933 free( psz_morecodecs );
938 var_SetString( p_libvlc, "codec", "dmo,quicktime");
942 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
943 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
944 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
945 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
946 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
947 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
948 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
949 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
952 /* Create a variable for showing the fullscreen interface from hotkeys */
953 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
954 var_SetBool( p_libvlc, "intf-show", true );
956 /* Create a variable for showing the right click menu */
957 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
960 * Get input filenames given as commandline arguments
962 GetFilenames( p_libvlc, i_argc, ppsz_argv );
965 * Get --open argument
967 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
968 if ( psz_val != NULL )
970 playlist_t *p_playlist = pl_Hold( p_libvlc );
971 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
972 -1, 0, NULL, 0, true, pl_Unlocked );
973 pl_Release( p_libvlc );
981 * Cleanup a libvlc instance. The instance is not completely deallocated
982 * \param p_libvlc the instance to clean
984 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
986 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
987 playlist_t *p_playlist = priv->p_playlist;
989 /* Deactivate the playlist */
990 msg_Dbg( p_libvlc, "deactivating the playlist" );
991 playlist_Deactivate( p_playlist );
993 /* Remove all services discovery */
994 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
995 playlist_ServicesDiscoveryKillAll( p_playlist );
997 /* Ask the interfaces to stop and destroy them */
998 msg_Dbg( p_libvlc, "removing all interfaces" );
999 libvlc_Quit( p_libvlc );
1000 intf_DestroyAll( p_libvlc );
1003 /* Destroy VLM if created in libvlc_InternalInit */
1006 vlm_Delete( priv->p_vlm );
1011 /* Any thread still running must not assume pl_Hold() succeeds. */
1012 msg_Dbg( p_libvlc, "removing playlist" );
1014 libvlc_priv(p_libvlc)->p_playlist = NULL;
1015 barrier(); /* FIXME is that correct ? */
1017 vlc_object_release( p_playlist );
1019 stats_TimersDumpAll( p_libvlc );
1020 stats_TimersCleanAll( p_libvlc );
1022 msg_Dbg( p_libvlc, "removing stats" );
1025 char* psz_pidfile = NULL;
1029 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1030 if( psz_pidfile != NULL )
1032 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1033 if( unlink( psz_pidfile ) == -1 )
1035 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1039 free( psz_pidfile );
1043 if( priv->p_memcpy_module )
1045 module_unneed( p_libvlc, priv->p_memcpy_module );
1046 priv->p_memcpy_module = NULL;
1049 /* Free module bank. It is refcounted, so we call this each time */
1050 module_EndBank( p_libvlc, true );
1052 vlc_DeinitActions( p_libvlc );
1056 * Destroy everything.
1057 * This function requests the running threads to finish, waits for their
1058 * termination, and destroys their structure.
1059 * It stops the thread systems: no instance can run after this has run
1060 * \param p_libvlc the instance to destroy
1062 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1064 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1066 vlc_mutex_lock( &global_lock );
1069 if( i_instances == 0 )
1071 /* System specific cleaning code */
1072 system_End( p_libvlc );
1074 vlc_mutex_unlock( &global_lock );
1076 msg_Destroy( p_libvlc );
1078 /* Destroy mutexes */
1079 vlc_mutex_destroy( &priv->timer_lock );
1081 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1082 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1083 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1084 vlc_object_release( p_libvlc );
1087 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1088 vlc_object_release( p_libvlc );
1092 * Add an interface plugin and run it
1094 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1097 return VLC_EGENERIC;
1099 if( !psz_module ) /* requesting the default interface */
1101 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1102 if( !psz_interface ) /* "intf" has not been set */
1106 /* Daemon mode hack.
1107 * We prefer the dummy interface if none is specified. */
1108 psz_module = "dummy";
1111 msg_Info( p_libvlc, "%s",
1112 _("Running vlc with the default interface. "
1113 "Use 'cvlc' to use vlc without interface.") );
1115 free( psz_interface );
1116 var_Destroy( p_libvlc, "intf" );
1119 /* Try to create the interface */
1120 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1122 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1123 psz_module ? psz_module : "default" );
1128 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1129 static vlc_cond_t exiting = VLC_STATIC_COND;
1131 extern vlc_mutex_t super_mutex;
1132 extern vlc_cond_t super_variable;
1133 # define exit_lock super_mutex
1134 # define exiting super_variable
1138 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1139 * when the user "exits" an interface plugin.
1141 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1143 vlc_mutex_lock( &exit_lock );
1144 while( vlc_object_alive( p_libvlc ) )
1145 vlc_cond_wait( &exiting, &exit_lock );
1146 vlc_mutex_unlock( &exit_lock );
1150 * Posts an exit signal to LibVLC instance. This will normally initiate the
1151 * cleanup and destroy process. It should only be called on behalf of the user.
1153 void libvlc_Quit( libvlc_int_t *p_libvlc )
1155 vlc_mutex_lock( &exit_lock );
1156 vlc_object_kill( p_libvlc );
1157 vlc_cond_broadcast( &exiting );
1158 vlc_mutex_unlock( &exit_lock );
1161 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1162 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1163 /*****************************************************************************
1164 * SetLanguage: set the interface language.
1165 *****************************************************************************
1166 * We set the LC_MESSAGES locale category for interface messages and buttons,
1167 * as well as the LC_CTYPE category for string sorting and possible wide
1168 * character support.
1169 *****************************************************************************/
1170 static void SetLanguage ( const char *psz_lang )
1173 /* I need that under Darwin, please check it doesn't disturb
1174 * other platforms. --Meuuh */
1175 setenv( "LANG", psz_lang, 1 );
1178 /* We set LC_ALL manually because it is the only way to set
1179 * the language at runtime under eg. Windows. Beware that this
1180 * makes the environment unconsistent when libvlc is unloaded and
1181 * should probably be moved to a safer place like vlc.c. */
1182 static char psz_lcall[20];
1183 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1184 psz_lcall[19] = '\0';
1185 putenv( psz_lcall );
1188 setlocale( LC_ALL, psz_lang );
1192 /*****************************************************************************
1193 * GetFilenames: parse command line options which are not flags
1194 *****************************************************************************
1195 * Parse command line for input files as well as their associated options.
1196 * An option always follows its associated input and begins with a ":".
1197 *****************************************************************************/
1198 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1200 int i_opt, i_options;
1202 /* We assume that the remaining parameters are filenames
1203 * and their input options */
1204 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1208 /* Count the input options */
1209 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1215 /* TODO: write an internal function of this one, to avoid
1216 * unnecessary lookups. */
1217 char *mrl = make_URI( ppsz_argv[i_opt] );
1221 playlist_t *p_playlist = pl_Hold( p_vlc );
1222 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1223 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1224 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1225 pl_Release( p_vlc );
1232 /*****************************************************************************
1233 * Help: print program help
1234 *****************************************************************************
1235 * Print a short inline help. Message interface is initialized at this stage.
1236 *****************************************************************************/
1237 static inline void print_help_on_full_help( void )
1239 utf8_fprintf( stdout, "\n" );
1240 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1243 static const char vlc_usage[] = N_(
1244 "Usage: %s [options] [stream] ..."
1245 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1246 "\nThe first item specified will be played first."
1249 "\n --option A global option that is set for the duration of the program."
1250 "\n -option A single letter version of a global --option."
1251 "\n :option An option that only applies to the stream directly before it"
1252 "\n and that overrides previous settings."
1254 "\nStream MRL syntax:"
1255 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1257 "\n Many of the global --options can also be used as MRL specific :options."
1258 "\n Multiple :option=value pairs can be specified."
1261 "\n [file://]filename Plain media file"
1262 "\n http://ip:port/file HTTP URL"
1263 "\n ftp://ip:port/file FTP URL"
1264 "\n mms://ip:port/file MMS URL"
1265 "\n screen:// Screen capture"
1266 "\n [dvd://][device][@raw_device] DVD device"
1267 "\n [vcd://][device] VCD device"
1268 "\n [cdda://][device] Audio CD device"
1269 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1270 "\n UDP stream sent by a streaming server"
1271 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1272 "\n vlc://quit Special item to quit VLC"
1275 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1278 ShowConsole( true );
1281 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1283 utf8_fprintf( stdout, vlc_usage, "vlc" );
1284 Usage( p_this, "=help" );
1285 Usage( p_this, "=main" );
1286 print_help_on_full_help();
1288 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1290 utf8_fprintf( stdout, vlc_usage, "vlc" );
1291 Usage( p_this, NULL );
1292 print_help_on_full_help();
1294 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1296 utf8_fprintf( stdout, vlc_usage, "vlc" );
1297 Usage( p_this, NULL );
1299 else if( psz_help_name )
1301 Usage( p_this, psz_help_name );
1304 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1309 /*****************************************************************************
1310 * Usage: print module usage
1311 *****************************************************************************
1312 * Print a short inline help. Message interface is initialized at this stage.
1313 *****************************************************************************/
1314 # define COL(x) "\033[" #x ";1m"
1315 # define RED COL(31)
1316 # define GREEN COL(32)
1317 # define YELLOW COL(33)
1318 # define BLUE COL(34)
1319 # define MAGENTA COL(35)
1320 # define CYAN COL(36)
1321 # define WHITE COL(0)
1322 # define GRAY "\033[0m"
1323 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1325 if( !p_item ) return;
1328 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1329 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1330 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1331 _( p_item->psz_longtext ) );
1335 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1336 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1337 utf8_fprintf( stdout, " %s\n", _( 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 _( p_parser->psz_longname ),
1478 p_parser->psz_object_name );
1480 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1482 if( p_parser->psz_help )
1485 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1486 _( p_parser->psz_help ) );
1488 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1491 /* Print module options */
1492 for( p_item = p_parser->p_config;
1496 char *psz_text, *psz_spaces = psz_spaces_text;
1497 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1498 const char *psz_suf = "", *psz_prefix = NULL;
1502 /* Skip removed options */
1503 if( p_item->b_removed )
1507 /* Skip advanced options if requested */
1508 if( p_item->b_advanced && !b_advanced )
1510 b_has_advanced = true;
1514 switch( p_item->i_type )
1516 case CONFIG_HINT_CATEGORY:
1517 case CONFIG_HINT_USAGE:
1518 if( !strcmp( "main", p_parser->psz_object_name ) )
1521 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1522 _( p_item->psz_text ) );
1524 utf8_fprintf( stdout, "\n %s\n",
1525 _( p_item->psz_text ) );
1527 if( b_description && p_item->psz_longtext
1528 && *p_item->psz_longtext )
1531 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1532 _( p_item->psz_longtext ) );
1534 utf8_fprintf( stdout, " %s\n",
1535 _( p_item->psz_longtext ) );
1539 case CONFIG_HINT_SUBCATEGORY:
1540 if( strcmp( "main", p_parser->psz_object_name ) )
1542 case CONFIG_SECTION:
1546 case CONFIG_ITEM_STRING:
1547 case CONFIG_ITEM_FILE:
1548 case CONFIG_ITEM_DIRECTORY:
1549 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1550 case CONFIG_ITEM_MODULE_CAT:
1551 case CONFIG_ITEM_MODULE_LIST:
1552 case CONFIG_ITEM_MODULE_LIST_CAT:
1553 case CONFIG_ITEM_FONT:
1554 case CONFIG_ITEM_PASSWORD:
1555 print_help_section( p_section, b_color, b_description );
1557 psz_bra = OPTION_VALUE_SEP "<";
1558 psz_type = _("string");
1561 if( p_item->ppsz_list )
1563 psz_bra = OPTION_VALUE_SEP "{";
1564 psz_type = psz_buffer;
1565 psz_buffer[0] = '\0';
1566 for( i = 0; p_item->ppsz_list[i]; i++ )
1568 if( i ) strcat( psz_buffer, "," );
1569 strcat( psz_buffer, p_item->ppsz_list[i] );
1574 case CONFIG_ITEM_INTEGER:
1575 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1576 print_help_section( p_section, b_color, b_description );
1578 psz_bra = OPTION_VALUE_SEP "<";
1579 psz_type = _("integer");
1582 if( p_item->min.i || p_item->max.i )
1584 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1585 p_item->min.i, p_item->max.i );
1586 psz_type = psz_buffer;
1589 if( p_item->i_list )
1591 psz_bra = OPTION_VALUE_SEP "{";
1592 psz_type = psz_buffer;
1593 psz_buffer[0] = '\0';
1594 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1596 if( i ) strcat( psz_buffer, ", " );
1597 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1599 _( p_item->ppsz_list_text[i] ) );
1604 case CONFIG_ITEM_FLOAT:
1605 print_help_section( p_section, b_color, b_description );
1607 psz_bra = OPTION_VALUE_SEP "<";
1608 psz_type = _("float");
1610 if( p_item->min.f || p_item->max.f )
1612 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1613 p_item->min.f, p_item->max.f );
1614 psz_type = psz_buffer;
1617 case CONFIG_ITEM_BOOL:
1618 print_help_section( p_section, b_color, b_description );
1620 psz_bra = ""; psz_type = ""; psz_ket = "";
1621 if( !b_help_module )
1623 psz_suf = p_item->value.i ? _(" (default enabled)") :
1624 _(" (default disabled)");
1634 /* Add short option if any */
1635 if( p_item->i_short )
1637 sprintf( psz_short, "-%c,", p_item->i_short );
1641 strcpy( psz_short, " " );
1644 i = PADDING_SPACES - strlen( p_item->psz_name )
1645 - strlen( psz_bra ) - strlen( psz_type )
1646 - strlen( psz_ket ) - 1;
1648 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1650 psz_prefix = ", --no-";
1651 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1656 psz_spaces[0] = '\n';
1661 psz_spaces[i] = '\0';
1664 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1666 utf8_fprintf( stdout, psz_format_bool, psz_short,
1667 p_item->psz_name, psz_prefix, p_item->psz_name,
1668 psz_bra, psz_type, psz_ket, psz_spaces );
1672 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1673 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1676 psz_spaces[i] = ' ';
1678 /* We wrap the rest of the output */
1679 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1681 b_description_hack = b_description;
1684 psz_text = psz_buffer;
1685 i_cur_width = b_description && !b_description_hack
1686 ? i_width_description
1690 char *psz_parser, *psz_word;
1691 size_t i_end = strlen( psz_text );
1693 /* If the remaining text fits in a line, print it. */
1694 if( i_end <= i_cur_width )
1698 if( !b_description || b_description_hack )
1699 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1701 utf8_fprintf( stdout, "%s\n", psz_text );
1705 utf8_fprintf( stdout, "%s\n", psz_text );
1710 /* Otherwise, eat as many words as possible */
1711 psz_parser = psz_text;
1714 psz_word = psz_parser;
1715 psz_parser = strchr( psz_word, ' ' );
1716 /* If no space was found, we reached the end of the text
1717 * block; otherwise, we skip the space we just found. */
1718 psz_parser = psz_parser ? psz_parser + 1
1721 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1723 /* We cut a word in one of these cases:
1724 * - it's the only word in the line and it's too long.
1725 * - we used less than 80% of the width and the word we are
1726 * going to wrap is longer than 40% of the width, and even
1727 * if the word would have fit in the next line. */
1728 if( psz_word == psz_text
1729 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1730 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1732 char c = psz_text[i_cur_width];
1733 psz_text[i_cur_width] = '\0';
1736 if( !b_description || b_description_hack )
1737 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1738 psz_text, psz_spaces );
1740 utf8_fprintf( stdout, "%s\n%s",
1741 psz_text, psz_spaces );
1745 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1747 psz_text += i_cur_width;
1752 psz_word[-1] = '\0';
1755 if( !b_description || b_description_hack )
1756 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1757 psz_text, psz_spaces );
1759 utf8_fprintf( stdout, "%s\n%s",
1760 psz_text, psz_spaces );
1764 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1766 psz_text = psz_word;
1770 if( b_description_hack && p_item->psz_longtext
1771 && *p_item->psz_longtext )
1773 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1775 b_description_hack = false;
1776 psz_spaces = psz_spaces_longtext;
1777 utf8_fprintf( stdout, "%s", psz_spaces );
1783 if( b_has_advanced )
1786 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1787 _( "add --advanced to your command line to see advanced options."));
1789 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1790 _( "add --advanced to your command line to see advanced options."));
1793 if( i_only_advanced > 0 )
1797 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1798 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1802 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1803 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1809 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1810 _( "No matching module found. Use --list or " \
1811 "--list-verbose to list available modules." ) );
1813 utf8_fprintf( stdout, "\n%s\n",
1814 _( "No matching module found. Use --list or " \
1815 "--list-verbose to list available modules." ) );
1818 /* Release the module list */
1819 module_list_free (list);
1822 /*****************************************************************************
1823 * ListModules: list the available modules with their description
1824 *****************************************************************************
1825 * Print a list of all available modules (builtins and plugins) and a short
1826 * description for each one.
1827 *****************************************************************************/
1828 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1832 bool b_color = var_InheritBool( p_this, "color" );
1835 ShowConsole( true );
1836 b_color = false; // don't put color control codes in a .txt file
1842 /* List all modules */
1843 module_t **list = module_list_get (NULL);
1845 /* Enumerate each module */
1846 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1849 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1850 p_parser->psz_object_name,
1851 _( p_parser->psz_longname ) );
1853 utf8_fprintf( stdout, " %-22s %s\n",
1854 p_parser->psz_object_name,
1855 _( p_parser->psz_longname ) );
1859 char *const *pp_shortcut = p_parser->pp_shortcuts;
1860 while( *pp_shortcut )
1862 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1865 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1868 utf8_fprintf( stdout, " s %s\n",
1873 if( p_parser->psz_capability )
1876 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1877 p_parser->psz_capability,
1878 p_parser->i_score );
1880 utf8_fprintf( stdout, " c %s (%d)\n",
1881 p_parser->psz_capability,
1882 p_parser->i_score );
1886 module_list_free (list);
1888 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1893 /*****************************************************************************
1894 * Version: print complete program version
1895 *****************************************************************************
1896 * Print complete program version and build number.
1897 *****************************************************************************/
1898 static void Version( void )
1900 extern const char psz_vlc_changeset[];
1902 ShowConsole( true );
1905 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1906 psz_vlc_changeset );
1907 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1908 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1909 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1910 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1912 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1917 /*****************************************************************************
1918 * ShowConsole: On Win32, create an output console for debug messages
1919 *****************************************************************************
1920 * This function is useful only on Win32.
1921 *****************************************************************************/
1923 static void ShowConsole( bool b_dofile )
1926 FILE *f_help = NULL;
1928 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1931 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1932 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1933 * page (e.g. CP437 or CP850). */
1934 SetConsoleOutputCP (GetACP ());
1935 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1937 freopen( "CONOUT$", "w", stderr );
1938 freopen( "CONIN$", "r", stdin );
1940 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1943 freopen( "vlc-help.txt", "wt", stdout );
1944 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1946 else freopen( "CONOUT$", "w", stdout );
1952 /*****************************************************************************
1953 * PauseConsole: On Win32, wait for a key press before closing the console
1954 *****************************************************************************
1955 * This function is useful only on Win32.
1956 *****************************************************************************/
1958 static void PauseConsole( void )
1962 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1964 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1972 /*****************************************************************************
1973 * ConsoleWidth: Return the console width in characters
1974 *****************************************************************************
1975 * We use the stty shell command to get the console width; if this fails or
1976 * if the width is less than 80, we default to 80.
1977 *****************************************************************************/
1978 static int ConsoleWidth( void )
1980 unsigned i_width = 80;
1983 FILE *file = popen( "stty size 2>/dev/null", "r" );
1986 if (fscanf (file, "%*u %u", &i_width) <= 0)
1990 #elif !defined (UNDER_CE)
1991 CONSOLE_SCREEN_BUFFER_INFO buf;
1993 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1994 i_width = buf.dwSize.X;
2000 #include <vlc_avcodec.h>
2002 void vlc_avcodec_mutex (bool acquire)
2004 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2007 vlc_mutex_lock (&lock);
2009 vlc_mutex_unlock (&lock);