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 <errno.h> /* ENOMEM */
47 #include <stdio.h> /* sprintf() */
49 #include <stdlib.h> /* free() */
52 # include <netinet/in.h> /* BSD: struct in_addr */
57 #elif defined( WIN32 ) && !defined( UNDER_CE )
61 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
62 # include "extras/getopt.h"
70 # include <libintl.h> /* bindtextdomain */
74 /* used for one-instance mode */
75 # include <dbus/dbus.h>
78 #include <vlc_playlist.h>
79 #include <vlc_interface.h>
82 #include "audio_output/aout_internal.h"
84 #include <vlc_charset.h>
90 #include "playlist/playlist_internal.h"
95 # include <libkern/OSAtomic.h>
100 /*****************************************************************************
101 * The evil global variables. We handle them with care, don't worry.
102 *****************************************************************************/
103 static unsigned i_instances = 0;
106 static bool b_daemon = false;
114 * Atomically set the reference count to 1.
115 * @param p_gc reference counted object
116 * @param pf_destruct destruction calback
119 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
121 /* There is no point in using the GC if there is no destructor... */
122 assert (pf_destruct);
123 p_gc->pf_destructor = pf_destruct;
126 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
127 __sync_synchronize ();
128 #elif defined (WIN32) && defined (__GNUC__)
129 #elif defined(__APPLE__)
132 /* Nobody else can possibly lock the spin - it's there as a barrier */
133 vlc_spin_init (&p_gc->spin);
134 vlc_spin_lock (&p_gc->spin);
135 vlc_spin_unlock (&p_gc->spin);
141 * Atomically increment the reference count.
142 * @param p_gc reference counted object
145 void *vlc_hold (gc_object_t * p_gc)
149 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
151 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
152 refs = __sync_add_and_fetch (&p_gc->refs, 1);
153 #elif defined (WIN64)
154 refs = InterlockedIncrement64 (&p_gc->refs);
155 #elif defined (WIN32)
156 refs = InterlockedIncrement (&p_gc->refs);
157 #elif defined(__APPLE__)
158 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
160 vlc_spin_lock (&p_gc->spin);
162 vlc_spin_unlock (&p_gc->spin);
164 assert (refs != 1); /* there had to be a reference already */
169 * Atomically decrement the reference count and, if it reaches zero, destroy.
170 * @param p_gc reference counted object.
172 void vlc_release (gc_object_t *p_gc)
177 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
179 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
180 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
181 #elif defined (WIN64)
182 refs = InterlockedDecrement64 (&p_gc->refs);
183 #elif defined (WIN32)
184 refs = InterlockedDecrement (&p_gc->refs);
185 #elif defined(__APPLE__)
186 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
188 vlc_spin_lock (&p_gc->spin);
190 vlc_spin_unlock (&p_gc->spin);
193 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
196 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
197 #elif defined (WIN32) && defined (__GNUC__)
198 #elif defined(__APPLE__)
200 vlc_spin_destroy (&p_gc->spin);
202 p_gc->pf_destructor (p_gc);
206 /*****************************************************************************
208 *****************************************************************************/
209 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
210 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
211 static void SetLanguage ( char const * );
213 static inline int LoadMessages (void);
214 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
215 static void Help ( libvlc_int_t *, char const *psz_help_name );
216 static void Usage ( libvlc_int_t *, char const *psz_search );
217 static void ListModules ( libvlc_int_t *, bool );
218 static void Version ( void );
221 static void ShowConsole ( bool );
222 static void PauseConsole ( void );
224 static int ConsoleWidth ( void );
226 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
229 * Allocate a libvlc instance, initialize global data if needed
230 * It also initializes the threading system
232 libvlc_int_t * libvlc_InternalCreate( void )
234 libvlc_int_t *p_libvlc;
236 char *psz_env = NULL;
238 /* Now that the thread system is initialized, we don't have much, but
239 * at least we have variables */
240 vlc_mutex_lock( &global_lock );
241 if( i_instances == 0 )
243 /* Guess what CPU we have */
244 cpu_flags = CPUCapabilities();
245 /* The module bank will be initialized later */
248 /* Allocate a libvlc instance object */
249 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
250 VLC_OBJECT_GENERIC, "libvlc" );
251 if( p_libvlc != NULL )
253 vlc_mutex_unlock( &global_lock );
255 if( p_libvlc == NULL )
258 priv = libvlc_priv (p_libvlc);
259 priv->p_playlist = NULL;
260 priv->p_dialog_provider = NULL;
263 /* Initialize message queue */
264 msg_Create( p_libvlc );
266 /* Find verbosity from VLC_VERBOSE environment variable */
267 psz_env = getenv( "VLC_VERBOSE" );
268 if( psz_env != NULL )
269 priv->i_verbose = atoi( psz_env );
272 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
273 priv->b_color = isatty( 2 ); /* 2 is for stderr */
275 priv->b_color = false;
278 /* Initialize mutexes */
279 vlc_mutex_init( &priv->timer_lock );
285 * Initialize a libvlc instance
286 * This function initializes a previously allocated libvlc instance:
288 * - gettext initialization
289 * - message queue, module bank and playlist initialization
290 * - configuration and commandline parsing
292 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
293 const char *ppsz_argv[] )
295 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
297 char * psz_modules = NULL;
298 char * psz_parser = NULL;
299 char * psz_control = NULL;
301 int i_ret = VLC_EEXIT;
302 playlist_t *p_playlist = NULL;
304 #if defined( ENABLE_NLS ) \
305 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
306 # if defined (WIN32) || defined (__APPLE__)
311 /* System specific initialization code */
312 system_Init( p_libvlc, &i_argc, ppsz_argv );
315 * Support for gettext
319 /* Initialize the module bank and load the configuration of the
320 * main module. We need to do this at this stage to be able to display
321 * a short help if required by the user. (short help == main module
323 module_InitBank( p_libvlc );
325 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
327 module_EndBank( p_libvlc, false );
331 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
332 /* Announce who we are - Do it only for first instance ? */
333 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
334 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
335 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
336 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
338 /* Check for short help option */
339 if( config_GetInt( p_libvlc, "help" ) > 0 )
341 Help( p_libvlc, "help" );
343 i_ret = VLC_EEXITSUCCESS;
345 /* Check for version option */
346 else if( config_GetInt( p_libvlc, "version" ) > 0 )
350 i_ret = VLC_EEXITSUCCESS;
353 /* Check for plugins cache options */
354 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
356 /* Check for daemon mode */
358 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
361 char *psz_pidfile = NULL;
363 if( daemon( 1, 0) != 0 )
365 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
370 /* lets check if we need to write the pidfile */
371 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
372 if( psz_pidfile != NULL )
375 pid_t i_pid = getpid ();
376 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
377 i_pid, psz_pidfile );
378 pidfile = utf8_fopen( psz_pidfile,"w" );
379 if( pidfile != NULL )
381 utf8_fprintf( pidfile, "%d", (int)i_pid );
386 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
395 if( ( i_pid = fork() ) < 0 )
397 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
402 /* This is the parent, exit right now */
403 msg_Dbg( p_libvlc, "closing parent process" );
405 i_ret = VLC_EEXITSUCCESS;
409 /* We are the child */
410 msg_Dbg( p_libvlc, "daemon spawned" );
411 close( STDIN_FILENO );
412 close( STDOUT_FILENO );
413 close( STDERR_FILENO );
423 module_EndBank( p_libvlc, false );
427 /* Check for translation config option */
428 #if defined( ENABLE_NLS ) \
429 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
430 # if defined (WIN32) || defined (__APPLE__)
431 /* This ain't really nice to have to reload the config here but it seems
432 * the only way to do it. */
434 if( !config_GetInt( p_libvlc, "ignore-config" ) )
435 config_LoadConfigFile( p_libvlc, "main" );
436 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
437 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
439 /* Check if the user specified a custom language */
440 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
441 if( psz_language && strcmp( psz_language, "auto" ) )
443 /* Reset the default domain */
444 SetLanguage( psz_language );
446 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
447 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
449 module_EndBank( p_libvlc, false );
450 module_InitBank( p_libvlc );
451 if( !config_GetInt( p_libvlc, "ignore-config" ) )
452 config_LoadConfigFile( p_libvlc, "main" );
453 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
454 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
456 free( psz_language );
461 * Load the builtins and plugins into the module_bank.
462 * We have to do it before config_Load*() because this also gets the
463 * list of configuration options exported by each module and loads their
466 module_LoadPlugins( p_libvlc, b_cache_delete );
467 if( p_libvlc->b_die )
473 module_t **list = module_list_get( &module_count );
474 module_list_free( list );
475 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
477 /* Check for help on modules */
478 if( (p_tmp = var_CreateGetNonEmptyString( p_libvlc, "module" )) )
480 Help( p_libvlc, p_tmp );
483 i_ret = VLC_EEXITSUCCESS;
485 /* Check for full help option */
486 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
488 config_PutInt( p_libvlc, "advanced", 1);
489 config_PutInt( p_libvlc, "help-verbose", 1);
490 Help( p_libvlc, "full-help" );
492 i_ret = VLC_EEXITSUCCESS;
494 /* Check for long help option */
495 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
497 Help( p_libvlc, "longhelp" );
499 i_ret = VLC_EEXITSUCCESS;
501 /* Check for module list option */
502 else if( config_GetInt( p_libvlc, "list" ) > 0 )
504 ListModules( p_libvlc, false );
506 i_ret = VLC_EEXITSUCCESS;
508 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
510 ListModules( p_libvlc, true );
512 i_ret = VLC_EEXITSUCCESS;
515 /* Check for config file options */
516 if( !config_GetInt( p_libvlc, "ignore-config" ) )
518 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
520 config_ResetAll( p_libvlc );
521 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
522 config_SaveConfigFile( p_libvlc, NULL );
524 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
526 config_LoadConfigFile( p_libvlc, NULL );
527 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
528 config_SaveConfigFile( p_libvlc, NULL );
532 if( module_count <= 1)
534 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
535 "that you properly gave a module path with --plugin-path.");
542 module_EndBank( p_libvlc, true );
547 * Override default configuration with config file settings
549 if( !config_GetInt( p_libvlc, "ignore-config" ) )
550 config_LoadConfigFile( p_libvlc, NULL );
553 * Override configuration with command line settings
555 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
558 ShowConsole( false );
559 /* Pause the console because it's destroyed when we exit */
560 fprintf( stderr, "The command line options couldn't be loaded, check "
561 "that they are valid.\n" );
564 module_EndBank( p_libvlc, true );
567 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
570 * System specific configuration
572 system_Configure( p_libvlc, &i_argc, ppsz_argv );
574 /* FIXME: could be replaced by using Unix sockets */
576 dbus_threads_init_default();
578 if( config_GetInt( p_libvlc, "one-instance" ) > 0
579 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
580 && config_GetInt( p_libvlc, "started-from-file" ) ) )
582 /* Initialise D-Bus interface, check for other instances */
583 DBusConnection *p_conn = NULL;
584 DBusError dbus_error;
586 dbus_error_init( &dbus_error );
588 /* connect to the session bus */
589 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
592 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
593 dbus_error.message );
594 dbus_error_free( &dbus_error );
598 /* check if VLC is available on the bus
599 * if not: D-Bus control is not enabled on the other
600 * instance and we can't pass MRLs to it */
601 DBusMessage *p_test_msg = NULL;
602 DBusMessage *p_test_reply = NULL;
603 p_test_msg = dbus_message_new_method_call(
604 "org.mpris.vlc", "/",
605 "org.freedesktop.MediaPlayer", "Identity" );
606 /* block until a reply arrives */
607 p_test_reply = dbus_connection_send_with_reply_and_block(
608 p_conn, p_test_msg, -1, &dbus_error );
609 dbus_message_unref( p_test_msg );
610 if( p_test_reply == NULL )
612 dbus_error_free( &dbus_error );
613 msg_Dbg( p_libvlc, "No Media Player is running. "
614 "Continuing normally." );
619 DBusMessage* p_dbus_msg = NULL;
620 DBusMessageIter dbus_args;
621 DBusPendingCall* p_dbus_pending = NULL;
624 dbus_message_unref( p_test_reply );
625 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
627 for( i_input = optind;i_input < i_argc;i_input++ )
629 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
630 ppsz_argv[i_input] );
632 p_dbus_msg = dbus_message_new_method_call(
633 "org.mpris.vlc", "/TrackList",
634 "org.freedesktop.MediaPlayer", "AddTrack" );
636 if ( NULL == p_dbus_msg )
638 msg_Err( p_libvlc, "D-Bus problem" );
639 system_End( p_libvlc );
644 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
645 if ( !dbus_message_iter_append_basic( &dbus_args,
646 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
648 dbus_message_unref( p_dbus_msg );
649 system_End( p_libvlc );
653 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
655 if ( !dbus_message_iter_append_basic( &dbus_args,
656 DBUS_TYPE_BOOLEAN, &b_play ) )
658 dbus_message_unref( p_dbus_msg );
659 system_End( p_libvlc );
663 /* send message and get a handle for a reply */
664 if ( !dbus_connection_send_with_reply ( p_conn,
665 p_dbus_msg, &p_dbus_pending, -1 ) )
667 msg_Err( p_libvlc, "D-Bus problem" );
668 dbus_message_unref( p_dbus_msg );
669 system_End( p_libvlc );
673 if ( NULL == p_dbus_pending )
675 msg_Err( p_libvlc, "D-Bus problem" );
676 dbus_message_unref( p_dbus_msg );
677 system_End( p_libvlc );
680 dbus_connection_flush( p_conn );
681 dbus_message_unref( p_dbus_msg );
682 /* block until we receive a reply */
683 dbus_pending_call_block( p_dbus_pending );
684 dbus_pending_call_unref( p_dbus_pending );
685 } /* processes all command line MRLs */
688 system_End( p_libvlc );
692 /* we unreference the connection when we've finished with it */
693 if( p_conn ) dbus_connection_unref( p_conn );
698 * Message queue options
700 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
701 if( psz_verbose_objects )
703 char * psz_object, * iter = psz_verbose_objects;
704 while( (psz_object = strsep( &iter, "," )) )
706 switch( psz_object[0] )
708 printf("%s\n", psz_object+1);
709 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
710 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
712 msg_Err( p_libvlc, "verbose-objects usage: \n"
713 "--verbose-objects=+printthatobject,"
714 "-dontprintthatone\n"
715 "(keyword 'all' to applies to all objects)");
716 free( psz_verbose_objects );
717 /* FIXME: leaks!!!! */
721 free( psz_verbose_objects );
724 /* Last chance to set the verbosity. Once we start interfaces and other
725 * threads, verbosity becomes read-only. */
726 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
727 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
729 var_SetInteger( p_libvlc, "verbose", -1 );
730 priv->i_verbose = -1;
732 vlc_threads_setup( p_libvlc );
735 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
737 char p_capabilities[200];
738 #define PRINT_CAPABILITY( capability, string ) \
739 if( vlc_CPU() & capability ) \
741 strncat( p_capabilities, string " ", \
742 sizeof(p_capabilities) - strlen(p_capabilities) ); \
743 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
745 p_capabilities[0] = '\0';
747 #if defined( __i386__ ) || defined( __x86_64__ )
748 if( !config_GetInt( p_libvlc, "mmx" ) )
749 cpu_flags &= ~CPU_CAPABILITY_MMX;
750 if( !config_GetInt( p_libvlc, "3dn" ) )
751 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
752 if( !config_GetInt( p_libvlc, "mmxext" ) )
753 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
754 if( !config_GetInt( p_libvlc, "sse" ) )
755 cpu_flags &= ~CPU_CAPABILITY_SSE;
756 if( !config_GetInt( p_libvlc, "sse2" ) )
757 cpu_flags &= ~CPU_CAPABILITY_SSE2;
758 if( !config_GetInt( p_libvlc, "sse3" ) )
759 cpu_flags &= ~CPU_CAPABILITY_SSE3;
760 if( !config_GetInt( p_libvlc, "ssse3" ) )
761 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
762 if( !config_GetInt( p_libvlc, "sse41" ) )
763 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
764 if( !config_GetInt( p_libvlc, "sse42" ) )
765 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
767 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
768 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
769 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
770 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
771 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
772 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
773 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSSE3" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
778 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
779 if( !config_GetInt( p_libvlc, "altivec" ) )
780 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
782 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
784 #elif defined( __arm__ )
785 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
790 strncat( p_capabilities, "FPU ",
791 sizeof(p_capabilities) - strlen( p_capabilities) );
792 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
795 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
798 * Choose the best memcpy module
800 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
801 /* Avoid being called "memcpy":*/
802 vlc_object_set_name( p_libvlc, "main" );
804 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
806 priv->pp_timers = NULL;
808 priv->i_last_input_id = 0; /* Not very safe, should be removed */
811 * Initialize hotkey handling
813 vlc_InitActions( p_libvlc );
815 /* variables for signalling creation of new files */
816 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
817 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
819 /* Initialize playlist and get commandline files */
820 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
823 msg_Err( p_libvlc, "playlist initialization failed" );
824 if( priv->p_memcpy_module != NULL )
826 module_unneed( p_libvlc, priv->p_memcpy_module );
828 module_EndBank( p_libvlc, true );
831 playlist_Activate( p_playlist );
832 vlc_object_attach( p_playlist, p_libvlc );
834 /* Add service discovery modules */
835 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
838 char *p = psz_modules, *m;
839 while( ( m = strsep( &p, " :," ) ) != NULL )
840 playlist_ServicesDiscoveryAdd( p_playlist, m );
845 /* Initialize VLM if vlm-conf is specified */
846 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
849 priv->p_vlm = vlm_New( p_libvlc );
851 msg_Err( p_libvlc, "VLM initialization failed" );
857 * Load background interfaces
859 /* Create volume callback system. (this variable must be created before
860 all interfaces as they can use it) */
861 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
862 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
864 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
865 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
867 if( psz_modules && psz_control )
870 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
873 psz_modules = psz_tmp;
876 else if( psz_control )
879 psz_modules = strdup( psz_control );
882 psz_parser = psz_modules;
883 while ( psz_parser && *psz_parser )
885 char *psz_module, *psz_temp;
886 psz_module = psz_parser;
887 psz_parser = strchr( psz_module, ':' );
893 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
895 intf_Create( p_libvlc, psz_temp );
903 * Always load the hotkeys interface if it exists
905 intf_Create( p_libvlc, "hotkeys,none" );
908 /* loads dbus control interface if in one-instance mode
909 * we do it only when playlist exists, because dbus module needs it */
910 if( config_GetInt( p_libvlc, "one-instance" ) > 0
911 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
912 && config_GetInt( p_libvlc, "started-from-file" ) ) )
913 intf_Create( p_libvlc, "dbus,none" );
915 # if !defined (HAVE_MAEMO)
916 /* Prevents the power management daemon from suspending the system
917 * when VLC is active */
918 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
919 intf_Create( p_libvlc, "inhibit,none" );
923 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
924 !config_GetInt( p_libvlc, "syslog" ) )
926 intf_Create( p_libvlc, "logger,none" );
929 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
931 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
932 var_SetString( p_libvlc, "logmode", "syslog" );
933 intf_Create( p_libvlc, "logger,none" );
937 var_SetString( p_libvlc, "logmode", logmode );
940 var_Destroy( p_libvlc, "logmode" );
944 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
946 intf_Create( p_libvlc, "netsync,none" );
950 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
952 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
955 char *psz_morecodecs;
956 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
958 var_SetString( p_libvlc, "codec", psz_morecodecs);
959 free( psz_morecodecs );
964 var_SetString( p_libvlc, "codec", "dmo,quicktime");
968 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
969 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
970 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
971 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
972 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
973 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
974 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
975 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
978 /* Create a variable for showing the fullscreen interface from hotkeys */
979 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
980 var_SetBool( p_libvlc, "intf-show", true );
982 /* Create a variable for showing the right click menu */
983 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
986 * Get input filenames given as commandline arguments
988 GetFilenames( p_libvlc, i_argc, ppsz_argv );
991 * Get --open argument
993 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
994 if ( psz_val != NULL )
996 playlist_t *p_playlist = pl_Hold( p_libvlc );
997 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
998 -1, 0, NULL, 0, true, pl_Unlocked );
999 pl_Release( p_libvlc );
1007 * Cleanup a libvlc instance. The instance is not completely deallocated
1008 * \param p_libvlc the instance to clean
1010 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1012 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1013 playlist_t *p_playlist = priv->p_playlist;
1015 /* Deactivate the playlist */
1016 msg_Dbg( p_libvlc, "deactivating the playlist" );
1017 playlist_Deactivate( p_playlist );
1019 /* Remove all services discovery */
1020 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1021 playlist_ServicesDiscoveryKillAll( p_playlist );
1023 /* Ask the interfaces to stop and destroy them */
1024 msg_Dbg( p_libvlc, "removing all interfaces" );
1025 libvlc_Quit( p_libvlc );
1026 intf_DestroyAll( p_libvlc );
1029 /* Destroy VLM if created in libvlc_InternalInit */
1032 vlm_Delete( priv->p_vlm );
1037 /* Any thread still running must not assume pl_Hold() succeeds. */
1038 msg_Dbg( p_libvlc, "removing playlist" );
1040 libvlc_priv(p_libvlc)->p_playlist = NULL;
1041 barrier(); /* FIXME is that correct ? */
1043 vlc_object_release( p_playlist );
1045 stats_TimersDumpAll( p_libvlc );
1046 stats_TimersCleanAll( p_libvlc );
1048 msg_Dbg( p_libvlc, "removing stats" );
1051 char* psz_pidfile = NULL;
1055 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1056 if( psz_pidfile != NULL )
1058 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1059 if( unlink( psz_pidfile ) == -1 )
1061 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1065 free( psz_pidfile );
1069 if( priv->p_memcpy_module )
1071 module_unneed( p_libvlc, priv->p_memcpy_module );
1072 priv->p_memcpy_module = NULL;
1075 /* Free module bank. It is refcounted, so we call this each time */
1076 module_EndBank( p_libvlc, true );
1078 vlc_DeinitActions( p_libvlc );
1082 * Destroy everything.
1083 * This function requests the running threads to finish, waits for their
1084 * termination, and destroys their structure.
1085 * It stops the thread systems: no instance can run after this has run
1086 * \param p_libvlc the instance to destroy
1088 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1090 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1092 vlc_mutex_lock( &global_lock );
1095 if( i_instances == 0 )
1097 /* System specific cleaning code */
1098 system_End( p_libvlc );
1100 vlc_mutex_unlock( &global_lock );
1102 msg_Destroy( p_libvlc );
1104 /* Destroy mutexes */
1105 vlc_mutex_destroy( &priv->timer_lock );
1107 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1108 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1109 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1110 vlc_object_release( p_libvlc );
1113 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1114 vlc_object_release( p_libvlc );
1118 * Add an interface plugin and run it
1120 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1123 return VLC_EGENERIC;
1125 if( !psz_module ) /* requesting the default interface */
1127 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1128 if( !psz_interface ) /* "intf" has not been set */
1132 /* Daemon mode hack.
1133 * We prefer the dummy interface if none is specified. */
1134 psz_module = "dummy";
1137 msg_Info( p_libvlc, "%s",
1138 _("Running vlc with the default interface. "
1139 "Use 'cvlc' to use vlc without interface.") );
1141 free( psz_interface );
1142 var_Destroy( p_libvlc, "intf" );
1145 /* Try to create the interface */
1146 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1148 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1149 psz_module ? psz_module : "default" );
1154 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1155 static vlc_cond_t exiting = VLC_STATIC_COND;
1157 extern vlc_mutex_t super_mutex;
1158 extern vlc_cond_t super_variable;
1159 # define exit_lock super_mutex
1160 # define exiting super_variable
1164 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1165 * when the user "exits" an interface plugin.
1167 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1169 vlc_mutex_lock( &exit_lock );
1170 while( vlc_object_alive( p_libvlc ) )
1171 vlc_cond_wait( &exiting, &exit_lock );
1172 vlc_mutex_unlock( &exit_lock );
1176 * Posts an exit signal to LibVLC instance. This will normally initiate the
1177 * cleanup and destroy process. It should only be called on behalf of the user.
1179 void libvlc_Quit( libvlc_int_t *p_libvlc )
1181 vlc_mutex_lock( &exit_lock );
1182 vlc_object_kill( p_libvlc );
1183 vlc_cond_broadcast( &exiting );
1184 vlc_mutex_unlock( &exit_lock );
1187 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1188 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1189 /*****************************************************************************
1190 * SetLanguage: set the interface language.
1191 *****************************************************************************
1192 * We set the LC_MESSAGES locale category for interface messages and buttons,
1193 * as well as the LC_CTYPE category for string sorting and possible wide
1194 * character support.
1195 *****************************************************************************/
1196 static void SetLanguage ( const char *psz_lang )
1199 /* I need that under Darwin, please check it doesn't disturb
1200 * other platforms. --Meuuh */
1201 setenv( "LANG", psz_lang, 1 );
1204 /* We set LC_ALL manually because it is the only way to set
1205 * the language at runtime under eg. Windows. Beware that this
1206 * makes the environment unconsistent when libvlc is unloaded and
1207 * should probably be moved to a safer place like vlc.c. */
1208 static char psz_lcall[20];
1209 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1210 psz_lcall[19] = '\0';
1211 putenv( psz_lcall );
1214 setlocale( LC_ALL, psz_lang );
1219 static inline int LoadMessages (void)
1221 #if defined( ENABLE_NLS ) \
1222 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1223 /* Specify where to find the locales for current domain */
1224 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1225 static const char psz_path[] = LOCALEDIR;
1227 char psz_path[1024];
1228 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1229 config_GetDataDirDefault(), "locale")
1230 >= (int)sizeof (psz_path))
1234 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1236 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1237 " to directory %s\n", psz_path);
1241 /* LibVLC wants all messages in UTF-8.
1242 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1243 * and other functions that are not part of our text domain.
1245 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1247 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1249 // Unbinds the text domain to avoid broken encoding
1250 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1254 /* LibVLC does NOT set the default textdomain, since it is a library.
1255 * This could otherwise break programs using LibVLC (other than VLC).
1256 * textdomain (PACKAGE_NAME);
1262 /*****************************************************************************
1263 * GetFilenames: parse command line options which are not flags
1264 *****************************************************************************
1265 * Parse command line for input files as well as their associated options.
1266 * An option always follows its associated input and begins with a ":".
1267 *****************************************************************************/
1268 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1270 int i_opt, i_options;
1272 /* We assume that the remaining parameters are filenames
1273 * and their input options */
1274 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1278 /* Count the input options */
1279 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1285 /* TODO: write an internal function of this one, to avoid
1286 * unnecessary lookups. */
1287 char *mrl = make_URI( ppsz_argv[i_opt] );
1291 playlist_t *p_playlist = pl_Hold( p_vlc );
1292 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1293 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1294 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1295 pl_Release( p_vlc );
1302 /*****************************************************************************
1303 * Help: print program help
1304 *****************************************************************************
1305 * Print a short inline help. Message interface is initialized at this stage.
1306 *****************************************************************************/
1307 static inline void print_help_on_full_help( void )
1309 utf8_fprintf( stdout, "\n" );
1310 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1313 static const char vlc_usage[] = N_(
1314 "Usage: %s [options] [stream] ..."
1315 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1316 "\nThe first item specified will be played first."
1319 "\n --option A global option that is set for the duration of the program."
1320 "\n -option A single letter version of a global --option."
1321 "\n :option An option that only applies to the stream directly before it"
1322 "\n and that overrides previous settings."
1324 "\nStream MRL syntax:"
1325 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1327 "\n Many of the global --options can also be used as MRL specific :options."
1328 "\n Multiple :option=value pairs can be specified."
1331 "\n [file://]filename Plain media file"
1332 "\n http://ip:port/file HTTP URL"
1333 "\n ftp://ip:port/file FTP URL"
1334 "\n mms://ip:port/file MMS URL"
1335 "\n screen:// Screen capture"
1336 "\n [dvd://][device][@raw_device] DVD device"
1337 "\n [vcd://][device] VCD device"
1338 "\n [cdda://][device] Audio CD device"
1339 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1340 "\n UDP stream sent by a streaming server"
1341 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1342 "\n vlc://quit Special item to quit VLC"
1345 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1348 ShowConsole( true );
1351 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1353 utf8_fprintf( stdout, vlc_usage, "vlc" );
1354 Usage( p_this, "=help" );
1355 Usage( p_this, "=main" );
1356 print_help_on_full_help();
1358 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1360 utf8_fprintf( stdout, vlc_usage, "vlc" );
1361 Usage( p_this, NULL );
1362 print_help_on_full_help();
1364 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1366 utf8_fprintf( stdout, vlc_usage, "vlc" );
1367 Usage( p_this, NULL );
1369 else if( psz_help_name )
1371 Usage( p_this, psz_help_name );
1374 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1379 /*****************************************************************************
1380 * Usage: print module usage
1381 *****************************************************************************
1382 * Print a short inline help. Message interface is initialized at this stage.
1383 *****************************************************************************/
1384 # define COL(x) "\033[" #x ";1m"
1385 # define RED COL(31)
1386 # define GREEN COL(32)
1387 # define YELLOW COL(33)
1388 # define BLUE COL(34)
1389 # define MAGENTA COL(35)
1390 # define CYAN COL(36)
1391 # define WHITE COL(0)
1392 # define GRAY "\033[0m"
1393 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1395 if( !p_item ) return;
1398 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1399 if( b_description && p_item->psz_longtext )
1400 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1401 _( p_item->psz_longtext ) );
1405 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1406 if( b_description && p_item->psz_longtext )
1407 utf8_fprintf( stdout, " %s\n", _( p_item->psz_longtext ) );
1411 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1413 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1414 /* short option ------' | | | | | | |
1415 * option name ------------' | | | | | |
1416 * <bra ---------------------' | | | | |
1417 * option type or "" ----------' | | | |
1418 * ket> -------------------------' | | |
1419 * padding spaces -----------------' | |
1420 * comment --------------------------' |
1421 * comment suffix ---------------------'
1423 * The purpose of having bra and ket is that we might i18n them as well.
1426 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1427 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1429 #define LINE_START 8
1430 #define PADDING_SPACES 25
1432 # define OPTION_VALUE_SEP "="
1434 # define OPTION_VALUE_SEP " "
1436 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1437 char psz_spaces_longtext[LINE_START+3];
1438 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1439 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1440 char psz_buffer[10000];
1442 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1443 int i_width_description = i_width + PADDING_SPACES - 1;
1444 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1445 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1446 bool b_description_hack;
1447 bool b_color = config_GetInt( p_this, "color" ) > 0;
1448 bool b_has_advanced = false;
1449 bool b_found = false;
1450 int i_only_advanced = 0; /* Number of modules ignored because they
1451 * only have advanced options */
1452 bool b_strict = psz_search && *psz_search == '=';
1453 if( b_strict ) psz_search++;
1455 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1456 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1457 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1458 psz_spaces_longtext[LINE_START+2] = '\0';
1462 b_color = false; // don't put color control codes in a .txt file
1466 strcpy( psz_format, COLOR_FORMAT_STRING );
1467 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1471 strcpy( psz_format, FORMAT_STRING );
1472 strcpy( psz_format_bool, FORMAT_STRING );
1475 /* List all modules */
1476 module_t **list = module_list_get (NULL);
1480 /* Ugly hack to make sure that the help options always come first
1483 Usage( p_this, "help" );
1485 /* Enumerate the config for each module */
1486 for (size_t i = 0; list[i]; i++)
1489 module_t *p_parser = list[i];
1490 module_config_t *p_item = NULL;
1491 module_config_t *p_section = NULL;
1492 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1495 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1496 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1498 char *const *pp_shortcut = p_parser->pp_shortcuts;
1499 while( *pp_shortcut )
1501 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1502 : !!strstr( *pp_shortcut, psz_search ) )
1510 /* Ignore modules without config options */
1511 if( !p_parser->i_config_items )
1516 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1517 /* Ugly hack to make sure that the help options always come first
1519 if( !psz_search && b_help_module )
1522 /* Ignore modules with only advanced config options if requested */
1525 for( p_item = p_parser->p_config;
1529 if( (p_item->i_type & CONFIG_ITEM) &&
1530 !p_item->b_advanced && !p_item->b_removed ) break;
1533 if( p_item == p_end )
1542 /* Print name of module */
1543 if( strcmp( "main", p_parser->psz_object_name ) )
1546 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1547 _( p_parser->psz_longname ),
1548 p_parser->psz_object_name );
1550 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1552 if( p_parser->psz_help )
1555 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1556 _( p_parser->psz_help ) );
1558 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1561 /* Print module options */
1562 for( p_item = p_parser->p_config;
1566 char *psz_text, *psz_spaces = psz_spaces_text;
1567 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1568 const char *psz_suf = "", *psz_prefix = NULL;
1572 /* Skip removed options */
1573 if( p_item->b_removed )
1577 /* Skip advanced options if requested */
1578 if( p_item->b_advanced && !b_advanced )
1580 b_has_advanced = true;
1584 switch( p_item->i_type )
1586 case CONFIG_HINT_CATEGORY:
1587 case CONFIG_HINT_USAGE:
1588 if( !strcmp( "main", p_parser->psz_object_name ) )
1591 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1592 _( p_item->psz_text ) );
1594 utf8_fprintf( stdout, "\n %s\n",
1595 _( p_item->psz_text ) );
1597 if( b_description && p_item->psz_longtext )
1600 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1601 _( p_item->psz_longtext ) );
1603 utf8_fprintf( stdout, " %s\n",
1604 _( p_item->psz_longtext ) );
1608 case CONFIG_HINT_SUBCATEGORY:
1609 if( strcmp( "main", p_parser->psz_object_name ) )
1611 case CONFIG_SECTION:
1615 case CONFIG_ITEM_STRING:
1616 case CONFIG_ITEM_FILE:
1617 case CONFIG_ITEM_DIRECTORY:
1618 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1619 case CONFIG_ITEM_MODULE_CAT:
1620 case CONFIG_ITEM_MODULE_LIST:
1621 case CONFIG_ITEM_MODULE_LIST_CAT:
1622 case CONFIG_ITEM_FONT:
1623 case CONFIG_ITEM_PASSWORD:
1624 print_help_section( p_section, b_color, b_description );
1626 psz_bra = OPTION_VALUE_SEP "<";
1627 psz_type = _("string");
1630 if( p_item->ppsz_list )
1632 psz_bra = OPTION_VALUE_SEP "{";
1633 psz_type = psz_buffer;
1634 psz_buffer[0] = '\0';
1635 for( i = 0; p_item->ppsz_list[i]; i++ )
1637 if( i ) strcat( psz_buffer, "," );
1638 strcat( psz_buffer, p_item->ppsz_list[i] );
1643 case CONFIG_ITEM_INTEGER:
1644 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1645 print_help_section( p_section, b_color, b_description );
1647 psz_bra = OPTION_VALUE_SEP "<";
1648 psz_type = _("integer");
1651 if( p_item->min.i || p_item->max.i )
1653 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1654 p_item->min.i, p_item->max.i );
1655 psz_type = psz_buffer;
1658 if( p_item->i_list )
1660 psz_bra = OPTION_VALUE_SEP "{";
1661 psz_type = psz_buffer;
1662 psz_buffer[0] = '\0';
1663 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1665 if( i ) strcat( psz_buffer, ", " );
1666 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1668 _( p_item->ppsz_list_text[i] ) );
1673 case CONFIG_ITEM_FLOAT:
1674 print_help_section( p_section, b_color, b_description );
1676 psz_bra = OPTION_VALUE_SEP "<";
1677 psz_type = _("float");
1679 if( p_item->min.f || p_item->max.f )
1681 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1682 p_item->min.f, p_item->max.f );
1683 psz_type = psz_buffer;
1686 case CONFIG_ITEM_BOOL:
1687 print_help_section( p_section, b_color, b_description );
1689 psz_bra = ""; psz_type = ""; psz_ket = "";
1690 if( !b_help_module )
1692 psz_suf = p_item->value.i ? _(" (default enabled)") :
1693 _(" (default disabled)");
1703 /* Add short option if any */
1704 if( p_item->i_short )
1706 sprintf( psz_short, "-%c,", p_item->i_short );
1710 strcpy( psz_short, " " );
1713 i = PADDING_SPACES - strlen( p_item->psz_name )
1714 - strlen( psz_bra ) - strlen( psz_type )
1715 - strlen( psz_ket ) - 1;
1717 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1719 psz_prefix = ", --no-";
1720 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1725 psz_spaces[0] = '\n';
1730 psz_spaces[i] = '\0';
1733 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1735 utf8_fprintf( stdout, psz_format_bool, psz_short,
1736 p_item->psz_name, psz_prefix, p_item->psz_name,
1737 psz_bra, psz_type, psz_ket, psz_spaces );
1741 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1742 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1745 psz_spaces[i] = ' ';
1747 /* We wrap the rest of the output */
1748 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1750 b_description_hack = b_description;
1753 psz_text = psz_buffer;
1754 i_cur_width = b_description && !b_description_hack
1755 ? i_width_description
1759 char *psz_parser, *psz_word;
1760 size_t i_end = strlen( psz_text );
1762 /* If the remaining text fits in a line, print it. */
1763 if( i_end <= i_cur_width )
1767 if( !b_description || b_description_hack )
1768 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1770 utf8_fprintf( stdout, "%s\n", psz_text );
1774 utf8_fprintf( stdout, "%s\n", psz_text );
1779 /* Otherwise, eat as many words as possible */
1780 psz_parser = psz_text;
1783 psz_word = psz_parser;
1784 psz_parser = strchr( psz_word, ' ' );
1785 /* If no space was found, we reached the end of the text
1786 * block; otherwise, we skip the space we just found. */
1787 psz_parser = psz_parser ? psz_parser + 1
1790 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1792 /* We cut a word in one of these cases:
1793 * - it's the only word in the line and it's too long.
1794 * - we used less than 80% of the width and the word we are
1795 * going to wrap is longer than 40% of the width, and even
1796 * if the word would have fit in the next line. */
1797 if( psz_word == psz_text
1798 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1799 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1801 char c = psz_text[i_cur_width];
1802 psz_text[i_cur_width] = '\0';
1805 if( !b_description || b_description_hack )
1806 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1807 psz_text, psz_spaces );
1809 utf8_fprintf( stdout, "%s\n%s",
1810 psz_text, psz_spaces );
1814 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1816 psz_text += i_cur_width;
1821 psz_word[-1] = '\0';
1824 if( !b_description || b_description_hack )
1825 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1826 psz_text, psz_spaces );
1828 utf8_fprintf( stdout, "%s\n%s",
1829 psz_text, psz_spaces );
1833 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1835 psz_text = psz_word;
1839 if( b_description_hack && p_item->psz_longtext )
1841 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1843 b_description_hack = false;
1844 psz_spaces = psz_spaces_longtext;
1845 utf8_fprintf( stdout, "%s", psz_spaces );
1851 if( b_has_advanced )
1854 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1855 _( "add --advanced to your command line to see advanced options."));
1857 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1858 _( "add --advanced to your command line to see advanced options."));
1861 if( i_only_advanced > 0 )
1865 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1866 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1870 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1871 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1877 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1878 _( "No matching module found. Use --list or " \
1879 "--list-verbose to list available modules." ) );
1881 utf8_fprintf( stdout, "\n%s\n",
1882 _( "No matching module found. Use --list or " \
1883 "--list-verbose to list available modules." ) );
1886 /* Release the module list */
1887 module_list_free (list);
1890 /*****************************************************************************
1891 * ListModules: list the available modules with their description
1892 *****************************************************************************
1893 * Print a list of all available modules (builtins and plugins) and a short
1894 * description for each one.
1895 *****************************************************************************/
1896 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1900 bool b_color = config_GetInt( p_this, "color" ) > 0;
1903 ShowConsole( true );
1904 b_color = false; // don't put color control codes in a .txt file
1910 /* List all modules */
1911 module_t **list = module_list_get (NULL);
1913 /* Enumerate each module */
1914 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1917 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1918 p_parser->psz_object_name,
1919 _( p_parser->psz_longname ) );
1921 utf8_fprintf( stdout, " %-22s %s\n",
1922 p_parser->psz_object_name,
1923 _( p_parser->psz_longname ) );
1927 char *const *pp_shortcut = p_parser->pp_shortcuts;
1928 while( *pp_shortcut )
1930 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1933 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1936 utf8_fprintf( stdout, " s %s\n",
1941 if( p_parser->psz_capability )
1944 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1945 p_parser->psz_capability,
1946 p_parser->i_score );
1948 utf8_fprintf( stdout, " c %s (%d)\n",
1949 p_parser->psz_capability,
1950 p_parser->i_score );
1954 module_list_free (list);
1956 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1961 /*****************************************************************************
1962 * Version: print complete program version
1963 *****************************************************************************
1964 * Print complete program version and build number.
1965 *****************************************************************************/
1966 static void Version( void )
1968 extern const char psz_vlc_changeset[];
1970 ShowConsole( true );
1973 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1974 psz_vlc_changeset );
1975 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1976 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1977 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1978 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1980 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1985 /*****************************************************************************
1986 * ShowConsole: On Win32, create an output console for debug messages
1987 *****************************************************************************
1988 * This function is useful only on Win32.
1989 *****************************************************************************/
1991 static void ShowConsole( bool b_dofile )
1994 FILE *f_help = NULL;
1996 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1999 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2000 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2001 * page (e.g. CP437 or CP850). */
2002 SetConsoleOutputCP (GetACP ());
2003 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2005 freopen( "CONOUT$", "w", stderr );
2006 freopen( "CONIN$", "r", stdin );
2008 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2011 freopen( "vlc-help.txt", "wt", stdout );
2012 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2014 else freopen( "CONOUT$", "w", stdout );
2020 /*****************************************************************************
2021 * PauseConsole: On Win32, wait for a key press before closing the console
2022 *****************************************************************************
2023 * This function is useful only on Win32.
2024 *****************************************************************************/
2026 static void PauseConsole( void )
2030 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2032 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2040 /*****************************************************************************
2041 * ConsoleWidth: Return the console width in characters
2042 *****************************************************************************
2043 * We use the stty shell command to get the console width; if this fails or
2044 * if the width is less than 80, we default to 80.
2045 *****************************************************************************/
2046 static int ConsoleWidth( void )
2048 unsigned i_width = 80;
2051 FILE *file = popen( "stty size 2>/dev/null", "r" );
2054 if (fscanf (file, "%*u %u", &i_width) <= 0)
2058 #elif !defined (UNDER_CE)
2059 CONSOLE_SCREEN_BUFFER_INFO buf;
2061 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2062 i_width = buf.dwSize.X;
2068 #include <vlc_avcodec.h>
2070 void vlc_avcodec_mutex (bool acquire)
2072 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2075 vlc_mutex_lock (&lock);
2077 vlc_mutex_unlock (&lock);