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 );
280 vlc_cond_init( &priv->exiting );
286 * Initialize a libvlc instance
287 * This function initializes a previously allocated libvlc instance:
289 * - gettext initialization
290 * - message queue, module bank and playlist initialization
291 * - configuration and commandline parsing
293 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
294 const char *ppsz_argv[] )
296 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
298 char * psz_modules = NULL;
299 char * psz_parser = NULL;
300 char * psz_control = NULL;
302 int i_ret = VLC_EEXIT;
303 playlist_t *p_playlist = NULL;
305 #if defined( ENABLE_NLS ) \
306 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
307 # if defined (WIN32) || defined (__APPLE__)
312 /* System specific initialization code */
313 system_Init( p_libvlc, &i_argc, ppsz_argv );
316 * Support for gettext
320 /* Initialize the module bank and load the configuration of the
321 * main module. We need to do this at this stage to be able to display
322 * a short help if required by the user. (short help == main module
324 module_InitBank( p_libvlc );
326 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
328 module_EndBank( p_libvlc, false );
332 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
333 /* Announce who we are - Do it only for first instance ? */
334 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
335 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
336 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
337 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
339 /* Check for short help option */
340 if( config_GetInt( p_libvlc, "help" ) > 0 )
342 Help( p_libvlc, "help" );
344 i_ret = VLC_EEXITSUCCESS;
346 /* Check for version option */
347 else if( config_GetInt( p_libvlc, "version" ) > 0 )
351 i_ret = VLC_EEXITSUCCESS;
354 /* Check for plugins cache options */
355 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
357 /* Check for daemon mode */
359 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
362 char *psz_pidfile = NULL;
364 if( daemon( 1, 0) != 0 )
366 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
371 /* lets check if we need to write the pidfile */
372 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
373 if( psz_pidfile != NULL )
376 pid_t i_pid = getpid ();
377 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
378 i_pid, psz_pidfile );
379 pidfile = utf8_fopen( psz_pidfile,"w" );
380 if( pidfile != NULL )
382 utf8_fprintf( pidfile, "%d", (int)i_pid );
387 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
396 if( ( i_pid = fork() ) < 0 )
398 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
403 /* This is the parent, exit right now */
404 msg_Dbg( p_libvlc, "closing parent process" );
406 i_ret = VLC_EEXITSUCCESS;
410 /* We are the child */
411 msg_Dbg( p_libvlc, "daemon spawned" );
412 close( STDIN_FILENO );
413 close( STDOUT_FILENO );
414 close( STDERR_FILENO );
424 module_EndBank( p_libvlc, false );
428 /* Check for translation config option */
429 #if defined( ENABLE_NLS ) \
430 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
431 # if defined (WIN32) || defined (__APPLE__)
432 /* This ain't really nice to have to reload the config here but it seems
433 * the only way to do it. */
435 if( !config_GetInt( p_libvlc, "ignore-config" ) )
436 config_LoadConfigFile( p_libvlc, "main" );
437 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
438 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
440 /* Check if the user specified a custom language */
441 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
442 if( psz_language && strcmp( psz_language, "auto" ) )
444 /* Reset the default domain */
445 SetLanguage( psz_language );
447 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
448 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
450 module_EndBank( p_libvlc, false );
451 module_InitBank( p_libvlc );
452 if( !config_GetInt( p_libvlc, "ignore-config" ) )
453 config_LoadConfigFile( p_libvlc, "main" );
454 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
455 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
457 free( psz_language );
462 * Load the builtins and plugins into the module_bank.
463 * We have to do it before config_Load*() because this also gets the
464 * list of configuration options exported by each module and loads their
467 module_LoadPlugins( p_libvlc, b_cache_delete );
468 if( p_libvlc->b_die )
474 module_t **list = module_list_get( &module_count );
475 module_list_free( list );
476 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
478 if( module_count <= 1)
480 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
481 "that you properly gave a module path with --plugin-path.");
484 /* Check for help on modules */
485 if( (p_tmp = var_CreateGetNonEmptyString( p_libvlc, "module" )) )
487 Help( p_libvlc, p_tmp );
490 i_ret = VLC_EEXITSUCCESS;
492 /* Check for full help option */
493 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
495 config_PutInt( p_libvlc, "advanced", 1);
496 config_PutInt( p_libvlc, "help-verbose", 1);
497 Help( p_libvlc, "full-help" );
499 i_ret = VLC_EEXITSUCCESS;
501 /* Check for long help option */
502 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
504 Help( p_libvlc, "longhelp" );
506 i_ret = VLC_EEXITSUCCESS;
508 /* Check for module list option */
509 else if( config_GetInt( p_libvlc, "list" ) > 0 )
511 ListModules( p_libvlc, false );
513 i_ret = VLC_EEXITSUCCESS;
515 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
517 ListModules( p_libvlc, true );
519 i_ret = VLC_EEXITSUCCESS;
522 /* Check for config file options */
523 if( !config_GetInt( p_libvlc, "ignore-config" ) )
525 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
527 config_ResetAll( p_libvlc );
528 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
529 config_SaveConfigFile( p_libvlc, NULL );
531 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
533 config_LoadConfigFile( p_libvlc, NULL );
534 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
535 config_SaveConfigFile( p_libvlc, NULL );
541 module_EndBank( p_libvlc, true );
546 * Override default configuration with config file settings
548 if( !config_GetInt( p_libvlc, "ignore-config" ) )
549 config_LoadConfigFile( p_libvlc, NULL );
552 * Override configuration with command line settings
554 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
557 ShowConsole( false );
558 /* Pause the console because it's destroyed when we exit */
559 fprintf( stderr, "The command line options couldn't be loaded, check "
560 "that they are valid.\n" );
563 module_EndBank( p_libvlc, true );
566 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
569 * System specific configuration
571 system_Configure( p_libvlc, &i_argc, ppsz_argv );
573 /* FIXME: could be replaced by using Unix sockets */
575 dbus_threads_init_default();
577 if( config_GetInt( p_libvlc, "one-instance" ) > 0
578 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
579 && config_GetInt( p_libvlc, "started-from-file" ) ) )
581 /* Initialise D-Bus interface, check for other instances */
582 DBusConnection *p_conn = NULL;
583 DBusError dbus_error;
585 dbus_error_init( &dbus_error );
587 /* connect to the session bus */
588 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
591 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
592 dbus_error.message );
593 dbus_error_free( &dbus_error );
597 /* check if VLC is available on the bus
598 * if not: D-Bus control is not enabled on the other
599 * instance and we can't pass MRLs to it */
600 DBusMessage *p_test_msg = NULL;
601 DBusMessage *p_test_reply = NULL;
602 p_test_msg = dbus_message_new_method_call(
603 "org.mpris.vlc", "/",
604 "org.freedesktop.MediaPlayer", "Identity" );
605 /* block until a reply arrives */
606 p_test_reply = dbus_connection_send_with_reply_and_block(
607 p_conn, p_test_msg, -1, &dbus_error );
608 dbus_message_unref( p_test_msg );
609 if( p_test_reply == NULL )
611 dbus_error_free( &dbus_error );
612 msg_Dbg( p_libvlc, "No Media Player is running. "
613 "Continuing normally." );
618 DBusMessage* p_dbus_msg = NULL;
619 DBusMessageIter dbus_args;
620 DBusPendingCall* p_dbus_pending = NULL;
623 dbus_message_unref( p_test_reply );
624 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
626 for( i_input = optind;i_input < i_argc;i_input++ )
628 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
629 ppsz_argv[i_input] );
631 p_dbus_msg = dbus_message_new_method_call(
632 "org.mpris.vlc", "/TrackList",
633 "org.freedesktop.MediaPlayer", "AddTrack" );
635 if ( NULL == p_dbus_msg )
637 msg_Err( p_libvlc, "D-Bus problem" );
638 system_End( p_libvlc );
643 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
644 if ( !dbus_message_iter_append_basic( &dbus_args,
645 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
647 dbus_message_unref( p_dbus_msg );
648 system_End( p_libvlc );
652 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
654 if ( !dbus_message_iter_append_basic( &dbus_args,
655 DBUS_TYPE_BOOLEAN, &b_play ) )
657 dbus_message_unref( p_dbus_msg );
658 system_End( p_libvlc );
662 /* send message and get a handle for a reply */
663 if ( !dbus_connection_send_with_reply ( p_conn,
664 p_dbus_msg, &p_dbus_pending, -1 ) )
666 msg_Err( p_libvlc, "D-Bus problem" );
667 dbus_message_unref( p_dbus_msg );
668 system_End( p_libvlc );
672 if ( NULL == p_dbus_pending )
674 msg_Err( p_libvlc, "D-Bus problem" );
675 dbus_message_unref( p_dbus_msg );
676 system_End( p_libvlc );
679 dbus_connection_flush( p_conn );
680 dbus_message_unref( p_dbus_msg );
681 /* block until we receive a reply */
682 dbus_pending_call_block( p_dbus_pending );
683 dbus_pending_call_unref( p_dbus_pending );
684 } /* processes all command line MRLs */
687 system_End( p_libvlc );
691 /* we unreference the connection when we've finished with it */
692 if( p_conn ) dbus_connection_unref( p_conn );
697 * Message queue options
699 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
700 if( psz_verbose_objects )
702 char * psz_object, * iter = psz_verbose_objects;
703 while( (psz_object = strsep( &iter, "," )) )
705 switch( psz_object[0] )
707 printf("%s\n", psz_object+1);
708 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
709 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
711 msg_Err( p_libvlc, "verbose-objects usage: \n"
712 "--verbose-objects=+printthatobject,"
713 "-dontprintthatone\n"
714 "(keyword 'all' to applies to all objects)");
715 free( psz_verbose_objects );
716 /* FIXME: leaks!!!! */
720 free( psz_verbose_objects );
723 /* Last chance to set the verbosity. Once we start interfaces and other
724 * threads, verbosity becomes read-only. */
725 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
726 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
728 var_SetInteger( p_libvlc, "verbose", -1 );
729 priv->i_verbose = -1;
731 vlc_threads_setup( p_libvlc );
734 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
736 char p_capabilities[200];
737 #define PRINT_CAPABILITY( capability, string ) \
738 if( vlc_CPU() & capability ) \
740 strncat( p_capabilities, string " ", \
741 sizeof(p_capabilities) - strlen(p_capabilities) ); \
742 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
744 p_capabilities[0] = '\0';
746 #if defined( __i386__ ) || defined( __x86_64__ )
747 if( !config_GetInt( p_libvlc, "mmx" ) )
748 cpu_flags &= ~CPU_CAPABILITY_MMX;
749 if( !config_GetInt( p_libvlc, "3dn" ) )
750 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
751 if( !config_GetInt( p_libvlc, "mmxext" ) )
752 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
753 if( !config_GetInt( p_libvlc, "sse" ) )
754 cpu_flags &= ~CPU_CAPABILITY_SSE;
755 if( !config_GetInt( p_libvlc, "sse2" ) )
756 cpu_flags &= ~CPU_CAPABILITY_SSE2;
757 if( !config_GetInt( p_libvlc, "sse3" ) )
758 cpu_flags &= ~CPU_CAPABILITY_SSE3;
759 if( !config_GetInt( p_libvlc, "ssse3" ) )
760 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
761 if( !config_GetInt( p_libvlc, "sse41" ) )
762 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
763 if( !config_GetInt( p_libvlc, "sse42" ) )
764 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
766 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
767 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
768 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
769 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
770 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
771 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
772 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSSE3" );
773 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
777 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
778 if( !config_GetInt( p_libvlc, "altivec" ) )
779 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
781 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
783 #elif defined( __arm__ )
784 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
789 strncat( p_capabilities, "FPU ",
790 sizeof(p_capabilities) - strlen( p_capabilities) );
791 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
794 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
797 * Choose the best memcpy module
799 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
800 /* Avoid being called "memcpy":*/
801 vlc_object_set_name( p_libvlc, "main" );
803 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
805 priv->pp_timers = NULL;
807 priv->i_last_input_id = 0; /* Not very safe, should be removed */
810 * Initialize hotkey handling
812 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
813 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
815 struct hotkey *p_keys =
816 malloc( (libvlc_actions_count + 1) * sizeof (*p_keys) );
818 /* Initialize from configuration */
819 for( size_t i = 0; i < libvlc_actions_count; i++ )
821 p_keys[i].psz_action = libvlc_actions[i].name;
822 p_keys[i].i_key = config_GetInt( p_libvlc,
823 libvlc_actions[i].name );
824 p_keys[i].i_action = libvlc_actions[i].value;
826 p_keys[libvlc_actions_count].psz_action = NULL;
827 p_keys[libvlc_actions_count].i_key = 0;
828 p_keys[libvlc_actions_count].i_action = 0;
829 p_libvlc->p_hotkeys = p_keys;
830 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
834 /* variables for signalling creation of new files */
835 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
836 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
838 /* Initialize playlist and get commandline files */
839 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
842 msg_Err( p_libvlc, "playlist initialization failed" );
843 if( priv->p_memcpy_module != NULL )
845 module_unneed( p_libvlc, priv->p_memcpy_module );
847 module_EndBank( p_libvlc, true );
850 playlist_Activate( p_playlist );
851 vlc_object_attach( p_playlist, p_libvlc );
853 /* Add service discovery modules */
854 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
857 char *p = psz_modules, *m;
858 while( ( m = strsep( &p, " :," ) ) != NULL )
859 playlist_ServicesDiscoveryAdd( p_playlist, m );
864 /* Initialize VLM if vlm-conf is specified */
865 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
868 priv->p_vlm = vlm_New( p_libvlc );
870 msg_Err( p_libvlc, "VLM initialization failed" );
876 * Load background interfaces
878 /* Create volume callback system. (this variable must be created before
879 all interfaces as they can use it) */
880 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
882 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
883 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
885 if( psz_modules && psz_control )
888 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
891 psz_modules = psz_tmp;
894 else if( psz_control )
897 psz_modules = strdup( psz_control );
900 psz_parser = psz_modules;
901 while ( psz_parser && *psz_parser )
903 char *psz_module, *psz_temp;
904 psz_module = psz_parser;
905 psz_parser = strchr( psz_module, ':' );
911 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
913 intf_Create( p_libvlc, psz_temp );
921 * Always load the hotkeys interface if it exists
923 intf_Create( p_libvlc, "hotkeys,none" );
926 /* loads dbus control interface if in one-instance mode
927 * we do it only when playlist exists, because dbus module needs it */
928 if( config_GetInt( p_libvlc, "one-instance" ) > 0
929 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
930 && config_GetInt( p_libvlc, "started-from-file" ) ) )
931 intf_Create( p_libvlc, "dbus,none" );
933 # if !defined (HAVE_MAEMO)
934 /* Prevents the power management daemon from suspending the system
935 * when VLC is active */
936 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
937 intf_Create( p_libvlc, "inhibit,none" );
941 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
942 !config_GetInt( p_libvlc, "syslog" ) )
944 intf_Create( p_libvlc, "logger,none" );
947 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
949 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
950 var_SetString( p_libvlc, "logmode", "syslog" );
951 intf_Create( p_libvlc, "logger,none" );
955 var_SetString( p_libvlc, "logmode", logmode );
959 var_Destroy( p_libvlc, "logmode" );
963 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
965 intf_Create( p_libvlc, "netsync,none" );
969 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
971 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
974 char *psz_morecodecs;
975 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
977 var_SetString( p_libvlc, "codec", psz_morecodecs);
978 free( psz_morecodecs );
983 var_SetString( p_libvlc, "codec", "dmo,quicktime");
987 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
991 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
992 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
993 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
994 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
997 /* Create a variable for showing the fullscreen interface from hotkeys */
998 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
999 var_SetBool( p_libvlc, "intf-show", true );
1001 /* Create a variable for showing the right click menu */
1002 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1005 * Get input filenames given as commandline arguments
1007 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1010 * Get --open argument
1012 psz_val = var_CreateGetString( p_libvlc, "open" );
1013 if ( psz_val != NULL && *psz_val )
1015 playlist_t *p_playlist = pl_Hold( p_libvlc );
1016 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
1017 -1, 0, NULL, 0, true, pl_Unlocked );
1018 pl_Release( p_libvlc );
1026 * Cleanup a libvlc instance. The instance is not completely deallocated
1027 * \param p_libvlc the instance to clean
1029 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1031 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1032 playlist_t *p_playlist = priv->p_playlist;
1034 /* Deactivate the playlist */
1035 msg_Dbg( p_libvlc, "deactivating the playlist" );
1036 playlist_Deactivate( p_playlist );
1038 /* Remove all services discovery */
1039 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1040 playlist_ServicesDiscoveryKillAll( p_playlist );
1042 /* Ask the interfaces to stop and destroy them */
1043 msg_Dbg( p_libvlc, "removing all interfaces" );
1044 libvlc_Quit( p_libvlc );
1045 intf_DestroyAll( p_libvlc );
1048 /* Destroy VLM if created in libvlc_InternalInit */
1051 vlm_Delete( priv->p_vlm );
1056 /* Any thread still running must not assume pl_Hold() succeeds. */
1057 msg_Dbg( p_libvlc, "removing playlist" );
1059 libvlc_priv(p_libvlc)->p_playlist = NULL;
1060 barrier(); /* FIXME is that correct ? */
1062 vlc_object_release( p_playlist );
1064 stats_TimersDumpAll( p_libvlc );
1065 stats_TimersCleanAll( p_libvlc );
1067 msg_Dbg( p_libvlc, "removing stats" );
1070 char* psz_pidfile = NULL;
1074 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1075 if( psz_pidfile != NULL )
1077 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1078 if( unlink( psz_pidfile ) == -1 )
1080 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1084 free( psz_pidfile );
1088 if( priv->p_memcpy_module )
1090 module_unneed( p_libvlc, priv->p_memcpy_module );
1091 priv->p_memcpy_module = NULL;
1094 /* Free module bank. It is refcounted, so we call this each time */
1095 module_EndBank( p_libvlc, true );
1097 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1098 (void *)p_libvlc->p_hotkeys );
1099 free( (void *)p_libvlc->p_hotkeys );
1103 * Destroy everything.
1104 * This function requests the running threads to finish, waits for their
1105 * termination, and destroys their structure.
1106 * It stops the thread systems: no instance can run after this has run
1107 * \param p_libvlc the instance to destroy
1109 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1111 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1113 vlc_mutex_lock( &global_lock );
1116 if( i_instances == 0 )
1118 /* System specific cleaning code */
1119 system_End( p_libvlc );
1121 vlc_mutex_unlock( &global_lock );
1123 msg_Destroy( p_libvlc );
1125 /* Destroy mutexes */
1126 vlc_cond_destroy( &priv->exiting );
1127 vlc_mutex_destroy( &priv->timer_lock );
1129 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1130 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1131 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1132 vlc_object_release( p_libvlc );
1135 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1136 vlc_object_release( p_libvlc );
1140 * Add an interface plugin and run it
1142 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1145 return VLC_EGENERIC;
1147 if( !psz_module ) /* requesting the default interface */
1149 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1150 if( !psz_interface ) /* "intf" has not been set */
1154 /* Daemon mode hack.
1155 * We prefer the dummy interface if none is specified. */
1156 psz_module = "dummy";
1159 msg_Info( p_libvlc, "%s",
1160 _("Running vlc with the default interface. "
1161 "Use 'cvlc' to use vlc without interface.") );
1163 free( psz_interface );
1166 /* Try to create the interface */
1167 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1169 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1170 psz_module ? psz_module : "default" );
1171 var_Destroy( p_libvlc, "intf" );
1175 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1178 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1179 * when the user "exits" an interface plugin.
1181 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1183 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1185 vlc_mutex_lock( &exit_lock );
1186 while( vlc_object_alive( p_libvlc ) )
1187 vlc_cond_wait( &priv->exiting, &exit_lock );
1188 vlc_mutex_unlock( &exit_lock );
1192 * Posts an exit signal to LibVLC instance. This will normally initiate the
1193 * cleanup and destroy process. It should only be called on behalf of the user.
1195 void libvlc_Quit( libvlc_int_t *p_libvlc )
1197 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1199 vlc_mutex_lock( &exit_lock );
1200 vlc_object_kill( p_libvlc );
1201 vlc_cond_signal( &priv->exiting );
1202 vlc_mutex_unlock( &exit_lock );
1205 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1206 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1207 /*****************************************************************************
1208 * SetLanguage: set the interface language.
1209 *****************************************************************************
1210 * We set the LC_MESSAGES locale category for interface messages and buttons,
1211 * as well as the LC_CTYPE category for string sorting and possible wide
1212 * character support.
1213 *****************************************************************************/
1214 static void SetLanguage ( const char *psz_lang )
1217 /* I need that under Darwin, please check it doesn't disturb
1218 * other platforms. --Meuuh */
1219 setenv( "LANG", psz_lang, 1 );
1222 /* We set LC_ALL manually because it is the only way to set
1223 * the language at runtime under eg. Windows. Beware that this
1224 * makes the environment unconsistent when libvlc is unloaded and
1225 * should probably be moved to a safer place like vlc.c. */
1226 static char psz_lcall[20];
1227 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1228 psz_lcall[19] = '\0';
1229 putenv( psz_lcall );
1232 setlocale( LC_ALL, psz_lang );
1237 static inline int LoadMessages (void)
1239 #if defined( ENABLE_NLS ) \
1240 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1241 /* Specify where to find the locales for current domain */
1242 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1243 static const char psz_path[] = LOCALEDIR;
1245 char psz_path[1024];
1246 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1247 config_GetDataDir(), "locale")
1248 >= (int)sizeof (psz_path))
1252 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1254 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1255 " to directory %s\n", psz_path);
1259 /* LibVLC wants all messages in UTF-8.
1260 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1261 * and other functions that are not part of our text domain.
1263 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1265 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1267 // Unbinds the text domain to avoid broken encoding
1268 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1272 /* LibVLC does NOT set the default textdomain, since it is a library.
1273 * This could otherwise break programs using LibVLC (other than VLC).
1274 * textdomain (PACKAGE_NAME);
1280 /*****************************************************************************
1281 * GetFilenames: parse command line options which are not flags
1282 *****************************************************************************
1283 * Parse command line for input files as well as their associated options.
1284 * An option always follows its associated input and begins with a ":".
1285 *****************************************************************************/
1286 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1288 int i_opt, i_options;
1290 /* We assume that the remaining parameters are filenames
1291 * and their input options */
1292 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1296 /* Count the input options */
1297 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1303 /* TODO: write an internal function of this one, to avoid
1304 * unnecessary lookups. */
1305 char *mrl = make_URI( ppsz_argv[i_opt] );
1309 playlist_t *p_playlist = pl_Hold( p_vlc );
1310 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1311 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1312 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1313 pl_Release( p_vlc );
1320 /*****************************************************************************
1321 * Help: print program help
1322 *****************************************************************************
1323 * Print a short inline help. Message interface is initialized at this stage.
1324 *****************************************************************************/
1325 static inline void print_help_on_full_help( void )
1327 utf8_fprintf( stdout, "\n" );
1328 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1331 static const char vlc_usage[] = N_(
1332 "Usage: %s [options] [stream] ..."
1333 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1334 "\nThe first item specified will be played first."
1337 "\n --option A global option that is set for the duration of the program."
1338 "\n -option A single letter version of a global --option."
1339 "\n :option An option that only applies to the stream directly before it"
1340 "\n and that overrides previous settings."
1342 "\nStream MRL syntax:"
1343 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1345 "\n Many of the global --options can also be used as MRL specific :options."
1346 "\n Multiple :option=value pairs can be specified."
1349 "\n [file://]filename Plain media file"
1350 "\n http://ip:port/file HTTP URL"
1351 "\n ftp://ip:port/file FTP URL"
1352 "\n mms://ip:port/file MMS URL"
1353 "\n screen:// Screen capture"
1354 "\n [dvd://][device][@raw_device] DVD device"
1355 "\n [vcd://][device] VCD device"
1356 "\n [cdda://][device] Audio CD device"
1357 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1358 "\n UDP stream sent by a streaming server"
1359 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1360 "\n vlc://quit Special item to quit VLC"
1363 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1366 ShowConsole( true );
1369 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1371 utf8_fprintf( stdout, vlc_usage, "vlc" );
1372 Usage( p_this, "=help" );
1373 Usage( p_this, "=main" );
1374 print_help_on_full_help();
1376 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1378 utf8_fprintf( stdout, vlc_usage, "vlc" );
1379 Usage( p_this, NULL );
1380 print_help_on_full_help();
1382 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1384 utf8_fprintf( stdout, vlc_usage, "vlc" );
1385 Usage( p_this, NULL );
1387 else if( psz_help_name )
1389 Usage( p_this, psz_help_name );
1392 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1397 /*****************************************************************************
1398 * Usage: print module usage
1399 *****************************************************************************
1400 * Print a short inline help. Message interface is initialized at this stage.
1401 *****************************************************************************/
1402 # define COL(x) "\033[" #x ";1m"
1403 # define RED COL(31)
1404 # define GREEN COL(32)
1405 # define YELLOW COL(33)
1406 # define BLUE COL(34)
1407 # define MAGENTA COL(35)
1408 # define CYAN COL(36)
1409 # define WHITE COL(0)
1410 # define GRAY "\033[0m"
1411 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1413 if( !p_item ) return;
1416 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1417 if( b_description && p_item->psz_longtext )
1418 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1419 _( p_item->psz_longtext ) );
1423 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1424 if( b_description && p_item->psz_longtext )
1425 utf8_fprintf( stdout, " %s\n", _( p_item->psz_longtext ) );
1429 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1431 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1432 /* short option ------' | | | | | | |
1433 * option name ------------' | | | | | |
1434 * <bra ---------------------' | | | | |
1435 * option type or "" ----------' | | | |
1436 * ket> -------------------------' | | |
1437 * padding spaces -----------------' | |
1438 * comment --------------------------' |
1439 * comment suffix ---------------------'
1441 * The purpose of having bra and ket is that we might i18n them as well.
1444 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1445 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1447 #define LINE_START 8
1448 #define PADDING_SPACES 25
1450 # define OPTION_VALUE_SEP "="
1452 # define OPTION_VALUE_SEP " "
1454 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1455 char psz_spaces_longtext[LINE_START+3];
1456 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1457 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1458 char psz_buffer[10000];
1460 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1461 int i_width_description = i_width + PADDING_SPACES - 1;
1462 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1463 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1464 bool b_description_hack;
1465 bool b_color = config_GetInt( p_this, "color" ) > 0;
1466 bool b_has_advanced = false;
1467 bool b_found = false;
1468 int i_only_advanced = 0; /* Number of modules ignored because they
1469 * only have advanced options */
1470 bool b_strict = psz_search && *psz_search == '=';
1471 if( b_strict ) psz_search++;
1473 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1474 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1475 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1476 psz_spaces_longtext[LINE_START+2] = '\0';
1480 b_color = false; // don't put color control codes in a .txt file
1484 strcpy( psz_format, COLOR_FORMAT_STRING );
1485 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1489 strcpy( psz_format, FORMAT_STRING );
1490 strcpy( psz_format_bool, FORMAT_STRING );
1493 /* List all modules */
1494 module_t **list = module_list_get (NULL);
1498 /* Ugly hack to make sure that the help options always come first
1501 Usage( p_this, "help" );
1503 /* Enumerate the config for each module */
1504 for (size_t i = 0; list[i]; i++)
1507 module_t *p_parser = list[i];
1508 module_config_t *p_item = NULL;
1509 module_config_t *p_section = NULL;
1510 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1513 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1514 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1516 char *const *pp_shortcut = p_parser->pp_shortcuts;
1517 while( *pp_shortcut )
1519 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1520 : !!strstr( *pp_shortcut, psz_search ) )
1528 /* Ignore modules without config options */
1529 if( !p_parser->i_config_items )
1534 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1535 /* Ugly hack to make sure that the help options always come first
1537 if( !psz_search && b_help_module )
1540 /* Ignore modules with only advanced config options if requested */
1543 for( p_item = p_parser->p_config;
1547 if( (p_item->i_type & CONFIG_ITEM) &&
1548 !p_item->b_advanced && !p_item->b_removed ) break;
1551 if( p_item == p_end )
1560 /* Print name of module */
1561 if( strcmp( "main", p_parser->psz_object_name ) )
1564 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1565 _( p_parser->psz_longname ),
1566 p_parser->psz_object_name );
1568 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1570 if( p_parser->psz_help )
1573 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1574 _( p_parser->psz_help ) );
1576 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1579 /* Print module options */
1580 for( p_item = p_parser->p_config;
1584 char *psz_text, *psz_spaces = psz_spaces_text;
1585 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1586 const char *psz_suf = "", *psz_prefix = NULL;
1590 /* Skip removed options */
1591 if( p_item->b_removed )
1595 /* Skip advanced options if requested */
1596 if( p_item->b_advanced && !b_advanced )
1598 b_has_advanced = true;
1602 switch( p_item->i_type )
1604 case CONFIG_HINT_CATEGORY:
1605 case CONFIG_HINT_USAGE:
1606 if( !strcmp( "main", p_parser->psz_object_name ) )
1609 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1610 _( p_item->psz_text ) );
1612 utf8_fprintf( stdout, "\n %s\n",
1613 _( p_item->psz_text ) );
1615 if( b_description && p_item->psz_longtext )
1618 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1619 _( p_item->psz_longtext ) );
1621 utf8_fprintf( stdout, " %s\n",
1622 _( p_item->psz_longtext ) );
1626 case CONFIG_HINT_SUBCATEGORY:
1627 if( strcmp( "main", p_parser->psz_object_name ) )
1629 case CONFIG_SECTION:
1633 case CONFIG_ITEM_STRING:
1634 case CONFIG_ITEM_FILE:
1635 case CONFIG_ITEM_DIRECTORY:
1636 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1637 case CONFIG_ITEM_MODULE_CAT:
1638 case CONFIG_ITEM_MODULE_LIST:
1639 case CONFIG_ITEM_MODULE_LIST_CAT:
1640 case CONFIG_ITEM_FONT:
1641 case CONFIG_ITEM_PASSWORD:
1642 print_help_section( p_section, b_color, b_description );
1644 psz_bra = OPTION_VALUE_SEP "<";
1645 psz_type = _("string");
1648 if( p_item->ppsz_list )
1650 psz_bra = OPTION_VALUE_SEP "{";
1651 psz_type = psz_buffer;
1652 psz_buffer[0] = '\0';
1653 for( i = 0; p_item->ppsz_list[i]; i++ )
1655 if( i ) strcat( psz_buffer, "," );
1656 strcat( psz_buffer, p_item->ppsz_list[i] );
1661 case CONFIG_ITEM_INTEGER:
1662 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1663 print_help_section( p_section, b_color, b_description );
1665 psz_bra = OPTION_VALUE_SEP "<";
1666 psz_type = _("integer");
1669 if( p_item->min.i || p_item->max.i )
1671 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1672 p_item->min.i, p_item->max.i );
1673 psz_type = psz_buffer;
1676 if( p_item->i_list )
1678 psz_bra = OPTION_VALUE_SEP "{";
1679 psz_type = psz_buffer;
1680 psz_buffer[0] = '\0';
1681 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1683 if( i ) strcat( psz_buffer, ", " );
1684 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1686 _( p_item->ppsz_list_text[i] ) );
1691 case CONFIG_ITEM_FLOAT:
1692 print_help_section( p_section, b_color, b_description );
1694 psz_bra = OPTION_VALUE_SEP "<";
1695 psz_type = _("float");
1697 if( p_item->min.f || p_item->max.f )
1699 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1700 p_item->min.f, p_item->max.f );
1701 psz_type = psz_buffer;
1704 case CONFIG_ITEM_BOOL:
1705 print_help_section( p_section, b_color, b_description );
1707 psz_bra = ""; psz_type = ""; psz_ket = "";
1708 if( !b_help_module )
1710 psz_suf = p_item->value.i ? _(" (default enabled)") :
1711 _(" (default disabled)");
1721 /* Add short option if any */
1722 if( p_item->i_short )
1724 sprintf( psz_short, "-%c,", p_item->i_short );
1728 strcpy( psz_short, " " );
1731 i = PADDING_SPACES - strlen( p_item->psz_name )
1732 - strlen( psz_bra ) - strlen( psz_type )
1733 - strlen( psz_ket ) - 1;
1735 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1737 psz_prefix = ", --no-";
1738 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1743 psz_spaces[0] = '\n';
1748 psz_spaces[i] = '\0';
1751 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1753 utf8_fprintf( stdout, psz_format_bool, psz_short,
1754 p_item->psz_name, psz_prefix, p_item->psz_name,
1755 psz_bra, psz_type, psz_ket, psz_spaces );
1759 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1760 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1763 psz_spaces[i] = ' ';
1765 /* We wrap the rest of the output */
1766 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1768 b_description_hack = b_description;
1771 psz_text = psz_buffer;
1772 i_cur_width = b_description && !b_description_hack
1773 ? i_width_description
1777 char *psz_parser, *psz_word;
1778 size_t i_end = strlen( psz_text );
1780 /* If the remaining text fits in a line, print it. */
1781 if( i_end <= i_cur_width )
1785 if( !b_description || b_description_hack )
1786 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1788 utf8_fprintf( stdout, "%s\n", psz_text );
1792 utf8_fprintf( stdout, "%s\n", psz_text );
1797 /* Otherwise, eat as many words as possible */
1798 psz_parser = psz_text;
1801 psz_word = psz_parser;
1802 psz_parser = strchr( psz_word, ' ' );
1803 /* If no space was found, we reached the end of the text
1804 * block; otherwise, we skip the space we just found. */
1805 psz_parser = psz_parser ? psz_parser + 1
1808 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1810 /* We cut a word in one of these cases:
1811 * - it's the only word in the line and it's too long.
1812 * - we used less than 80% of the width and the word we are
1813 * going to wrap is longer than 40% of the width, and even
1814 * if the word would have fit in the next line. */
1815 if( psz_word == psz_text
1816 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1817 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1819 char c = psz_text[i_cur_width];
1820 psz_text[i_cur_width] = '\0';
1823 if( !b_description || b_description_hack )
1824 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1825 psz_text, psz_spaces );
1827 utf8_fprintf( stdout, "%s\n%s",
1828 psz_text, psz_spaces );
1832 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1834 psz_text += i_cur_width;
1839 psz_word[-1] = '\0';
1842 if( !b_description || b_description_hack )
1843 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1844 psz_text, psz_spaces );
1846 utf8_fprintf( stdout, "%s\n%s",
1847 psz_text, psz_spaces );
1851 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1853 psz_text = psz_word;
1857 if( b_description_hack && p_item->psz_longtext )
1859 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1861 b_description_hack = false;
1862 psz_spaces = psz_spaces_longtext;
1863 utf8_fprintf( stdout, "%s", psz_spaces );
1869 if( b_has_advanced )
1872 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1873 _( "add --advanced to your command line to see advanced options."));
1875 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1876 _( "add --advanced to your command line to see advanced options."));
1879 if( i_only_advanced > 0 )
1883 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1884 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1888 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1889 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1895 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1896 _( "No matching module found. Use --list or " \
1897 "--list-verbose to list available modules." ) );
1899 utf8_fprintf( stdout, "\n%s\n",
1900 _( "No matching module found. Use --list or " \
1901 "--list-verbose to list available modules." ) );
1904 /* Release the module list */
1905 module_list_free (list);
1908 /*****************************************************************************
1909 * ListModules: list the available modules with their description
1910 *****************************************************************************
1911 * Print a list of all available modules (builtins and plugins) and a short
1912 * description for each one.
1913 *****************************************************************************/
1914 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1918 bool b_color = config_GetInt( p_this, "color" ) > 0;
1921 ShowConsole( true );
1924 /* List all modules */
1925 module_t **list = module_list_get (NULL);
1927 /* Enumerate each module */
1928 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1931 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1932 p_parser->psz_object_name,
1933 _( p_parser->psz_longname ) );
1935 utf8_fprintf( stdout, " %-22s %s\n",
1936 p_parser->psz_object_name,
1937 _( p_parser->psz_longname ) );
1941 char *const *pp_shortcut = p_parser->pp_shortcuts;
1942 while( *pp_shortcut )
1944 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1947 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1950 utf8_fprintf( stdout, " s %s\n",
1955 if( p_parser->psz_capability )
1958 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1959 p_parser->psz_capability,
1960 p_parser->i_score );
1962 utf8_fprintf( stdout, " c %s (%d)\n",
1963 p_parser->psz_capability,
1964 p_parser->i_score );
1968 module_list_free (list);
1970 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1975 /*****************************************************************************
1976 * Version: print complete program version
1977 *****************************************************************************
1978 * Print complete program version and build number.
1979 *****************************************************************************/
1980 static void Version( void )
1982 extern const char psz_vlc_changeset[];
1984 ShowConsole( true );
1987 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1988 psz_vlc_changeset );
1989 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1990 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1991 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1992 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1994 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1999 /*****************************************************************************
2000 * ShowConsole: On Win32, create an output console for debug messages
2001 *****************************************************************************
2002 * This function is useful only on Win32.
2003 *****************************************************************************/
2005 static void ShowConsole( bool b_dofile )
2008 FILE *f_help = NULL;
2010 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2013 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2014 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2015 * page (e.g. CP437 or CP850). */
2016 SetConsoleOutputCP (GetACP ());
2017 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2019 freopen( "CONOUT$", "w", stderr );
2020 freopen( "CONIN$", "r", stdin );
2022 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2025 freopen( "vlc-help.txt", "wt", stdout );
2026 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2028 else freopen( "CONOUT$", "w", stdout );
2034 /*****************************************************************************
2035 * PauseConsole: On Win32, wait for a key press before closing the console
2036 *****************************************************************************
2037 * This function is useful only on Win32.
2038 *****************************************************************************/
2040 static void PauseConsole( void )
2044 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2046 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2054 /*****************************************************************************
2055 * ConsoleWidth: Return the console width in characters
2056 *****************************************************************************
2057 * We use the stty shell command to get the console width; if this fails or
2058 * if the width is less than 80, we default to 80.
2059 *****************************************************************************/
2060 static int ConsoleWidth( void )
2062 unsigned i_width = 80;
2065 FILE *file = popen( "stty size 2>/dev/null", "r" );
2068 if (fscanf (file, "%*u %u", &i_width) <= 0)
2072 #elif !defined (UNDER_CE)
2073 CONSOLE_SCREEN_BUFFER_INFO buf;
2075 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2076 i_width = buf.dwSize.X;
2082 #include <vlc_avcodec.h>
2084 void vlc_avcodec_mutex (bool acquire)
2086 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2089 vlc_mutex_lock (&lock);
2091 vlc_mutex_unlock (&lock);