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 /* Check for help on modules */
479 if( (p_tmp = var_CreateGetNonEmptyString( p_libvlc, "module" )) )
481 Help( p_libvlc, p_tmp );
484 i_ret = VLC_EEXITSUCCESS;
486 /* Check for full help option */
487 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
489 config_PutInt( p_libvlc, "advanced", 1);
490 config_PutInt( p_libvlc, "help-verbose", 1);
491 Help( p_libvlc, "full-help" );
493 i_ret = VLC_EEXITSUCCESS;
495 /* Check for long help option */
496 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
498 Help( p_libvlc, "longhelp" );
500 i_ret = VLC_EEXITSUCCESS;
502 /* Check for module list option */
503 else if( config_GetInt( p_libvlc, "list" ) > 0 )
505 ListModules( p_libvlc, false );
507 i_ret = VLC_EEXITSUCCESS;
509 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
511 ListModules( p_libvlc, true );
513 i_ret = VLC_EEXITSUCCESS;
516 /* Check for config file options */
517 if( !config_GetInt( p_libvlc, "ignore-config" ) )
519 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
521 config_ResetAll( p_libvlc );
522 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
523 config_SaveConfigFile( p_libvlc, NULL );
525 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
527 config_LoadConfigFile( p_libvlc, NULL );
528 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
529 config_SaveConfigFile( p_libvlc, NULL );
533 if( module_count <= 1)
535 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
536 "that you properly gave a module path with --plugin-path.");
543 module_EndBank( p_libvlc, true );
548 * Override default configuration with config file settings
550 if( !config_GetInt( p_libvlc, "ignore-config" ) )
551 config_LoadConfigFile( p_libvlc, NULL );
554 * Override configuration with command line settings
556 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
559 ShowConsole( false );
560 /* Pause the console because it's destroyed when we exit */
561 fprintf( stderr, "The command line options couldn't be loaded, check "
562 "that they are valid.\n" );
565 module_EndBank( p_libvlc, true );
568 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
571 * System specific configuration
573 system_Configure( p_libvlc, &i_argc, ppsz_argv );
575 /* FIXME: could be replaced by using Unix sockets */
577 dbus_threads_init_default();
579 if( config_GetInt( p_libvlc, "one-instance" ) > 0
580 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
581 && config_GetInt( p_libvlc, "started-from-file" ) ) )
583 /* Initialise D-Bus interface, check for other instances */
584 DBusConnection *p_conn = NULL;
585 DBusError dbus_error;
587 dbus_error_init( &dbus_error );
589 /* connect to the session bus */
590 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
593 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
594 dbus_error.message );
595 dbus_error_free( &dbus_error );
599 /* check if VLC is available on the bus
600 * if not: D-Bus control is not enabled on the other
601 * instance and we can't pass MRLs to it */
602 DBusMessage *p_test_msg = NULL;
603 DBusMessage *p_test_reply = NULL;
604 p_test_msg = dbus_message_new_method_call(
605 "org.mpris.vlc", "/",
606 "org.freedesktop.MediaPlayer", "Identity" );
607 /* block until a reply arrives */
608 p_test_reply = dbus_connection_send_with_reply_and_block(
609 p_conn, p_test_msg, -1, &dbus_error );
610 dbus_message_unref( p_test_msg );
611 if( p_test_reply == NULL )
613 dbus_error_free( &dbus_error );
614 msg_Dbg( p_libvlc, "No Media Player is running. "
615 "Continuing normally." );
620 DBusMessage* p_dbus_msg = NULL;
621 DBusMessageIter dbus_args;
622 DBusPendingCall* p_dbus_pending = NULL;
625 dbus_message_unref( p_test_reply );
626 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
628 for( i_input = optind;i_input < i_argc;i_input++ )
630 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
631 ppsz_argv[i_input] );
633 p_dbus_msg = dbus_message_new_method_call(
634 "org.mpris.vlc", "/TrackList",
635 "org.freedesktop.MediaPlayer", "AddTrack" );
637 if ( NULL == p_dbus_msg )
639 msg_Err( p_libvlc, "D-Bus problem" );
640 system_End( p_libvlc );
645 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
646 if ( !dbus_message_iter_append_basic( &dbus_args,
647 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
649 dbus_message_unref( p_dbus_msg );
650 system_End( p_libvlc );
654 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
656 if ( !dbus_message_iter_append_basic( &dbus_args,
657 DBUS_TYPE_BOOLEAN, &b_play ) )
659 dbus_message_unref( p_dbus_msg );
660 system_End( p_libvlc );
664 /* send message and get a handle for a reply */
665 if ( !dbus_connection_send_with_reply ( p_conn,
666 p_dbus_msg, &p_dbus_pending, -1 ) )
668 msg_Err( p_libvlc, "D-Bus problem" );
669 dbus_message_unref( p_dbus_msg );
670 system_End( p_libvlc );
674 if ( NULL == p_dbus_pending )
676 msg_Err( p_libvlc, "D-Bus problem" );
677 dbus_message_unref( p_dbus_msg );
678 system_End( p_libvlc );
681 dbus_connection_flush( p_conn );
682 dbus_message_unref( p_dbus_msg );
683 /* block until we receive a reply */
684 dbus_pending_call_block( p_dbus_pending );
685 dbus_pending_call_unref( p_dbus_pending );
686 } /* processes all command line MRLs */
689 system_End( p_libvlc );
693 /* we unreference the connection when we've finished with it */
694 if( p_conn ) dbus_connection_unref( p_conn );
699 * Message queue options
701 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
702 if( psz_verbose_objects )
704 char * psz_object, * iter = psz_verbose_objects;
705 while( (psz_object = strsep( &iter, "," )) )
707 switch( psz_object[0] )
709 printf("%s\n", psz_object+1);
710 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
711 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
713 msg_Err( p_libvlc, "verbose-objects usage: \n"
714 "--verbose-objects=+printthatobject,"
715 "-dontprintthatone\n"
716 "(keyword 'all' to applies to all objects)");
717 free( psz_verbose_objects );
718 /* FIXME: leaks!!!! */
722 free( psz_verbose_objects );
725 /* Last chance to set the verbosity. Once we start interfaces and other
726 * threads, verbosity becomes read-only. */
727 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
728 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
730 var_SetInteger( p_libvlc, "verbose", -1 );
731 priv->i_verbose = -1;
733 vlc_threads_setup( p_libvlc );
736 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
738 char p_capabilities[200];
739 #define PRINT_CAPABILITY( capability, string ) \
740 if( vlc_CPU() & capability ) \
742 strncat( p_capabilities, string " ", \
743 sizeof(p_capabilities) - strlen(p_capabilities) ); \
744 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
746 p_capabilities[0] = '\0';
748 #if defined( __i386__ ) || defined( __x86_64__ )
749 if( !config_GetInt( p_libvlc, "mmx" ) )
750 cpu_flags &= ~CPU_CAPABILITY_MMX;
751 if( !config_GetInt( p_libvlc, "3dn" ) )
752 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
753 if( !config_GetInt( p_libvlc, "mmxext" ) )
754 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
755 if( !config_GetInt( p_libvlc, "sse" ) )
756 cpu_flags &= ~CPU_CAPABILITY_SSE;
757 if( !config_GetInt( p_libvlc, "sse2" ) )
758 cpu_flags &= ~CPU_CAPABILITY_SSE2;
759 if( !config_GetInt( p_libvlc, "sse3" ) )
760 cpu_flags &= ~CPU_CAPABILITY_SSE3;
761 if( !config_GetInt( p_libvlc, "ssse3" ) )
762 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
763 if( !config_GetInt( p_libvlc, "sse41" ) )
764 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
765 if( !config_GetInt( p_libvlc, "sse42" ) )
766 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
768 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
769 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
770 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
771 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
772 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
773 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
774 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSSE3" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
776 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
779 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
780 if( !config_GetInt( p_libvlc, "altivec" ) )
781 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
783 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
785 #elif defined( __arm__ )
786 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
791 strncat( p_capabilities, "FPU ",
792 sizeof(p_capabilities) - strlen( p_capabilities) );
793 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
796 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
799 * Choose the best memcpy module
801 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
802 /* Avoid being called "memcpy":*/
803 vlc_object_set_name( p_libvlc, "main" );
805 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
807 priv->pp_timers = NULL;
809 priv->i_last_input_id = 0; /* Not very safe, should be removed */
812 * Initialize hotkey handling
814 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
815 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
817 struct hotkey *p_keys =
818 malloc( (libvlc_actions_count + 1) * sizeof (*p_keys) );
820 /* Initialize from configuration */
821 for( size_t i = 0; i < libvlc_actions_count; i++ )
823 p_keys[i].psz_action = libvlc_actions[i].name;
824 p_keys[i].i_key = config_GetInt( p_libvlc,
825 libvlc_actions[i].name );
826 p_keys[i].i_action = libvlc_actions[i].value;
828 p_keys[libvlc_actions_count].psz_action = NULL;
829 p_keys[libvlc_actions_count].i_key = 0;
830 p_keys[libvlc_actions_count].i_action = 0;
831 p_libvlc->p_hotkeys = p_keys;
832 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
836 /* variables for signalling creation of new files */
837 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
838 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
840 /* Initialize playlist and get commandline files */
841 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
844 msg_Err( p_libvlc, "playlist initialization failed" );
845 if( priv->p_memcpy_module != NULL )
847 module_unneed( p_libvlc, priv->p_memcpy_module );
849 module_EndBank( p_libvlc, true );
852 playlist_Activate( p_playlist );
853 vlc_object_attach( p_playlist, p_libvlc );
855 /* Add service discovery modules */
856 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
859 char *p = psz_modules, *m;
860 while( ( m = strsep( &p, " :," ) ) != NULL )
861 playlist_ServicesDiscoveryAdd( p_playlist, m );
866 /* Initialize VLM if vlm-conf is specified */
867 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
870 priv->p_vlm = vlm_New( p_libvlc );
872 msg_Err( p_libvlc, "VLM initialization failed" );
878 * Load background interfaces
880 /* Create volume callback system. (this variable must be created before
881 all interfaces as they can use it) */
882 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
884 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
885 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
887 if( psz_modules && psz_control )
890 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
893 psz_modules = psz_tmp;
896 else if( psz_control )
899 psz_modules = strdup( psz_control );
902 psz_parser = psz_modules;
903 while ( psz_parser && *psz_parser )
905 char *psz_module, *psz_temp;
906 psz_module = psz_parser;
907 psz_parser = strchr( psz_module, ':' );
913 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
915 intf_Create( p_libvlc, psz_temp );
923 * Always load the hotkeys interface if it exists
925 intf_Create( p_libvlc, "hotkeys,none" );
928 /* loads dbus control interface if in one-instance mode
929 * we do it only when playlist exists, because dbus module needs it */
930 if( config_GetInt( p_libvlc, "one-instance" ) > 0
931 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
932 && config_GetInt( p_libvlc, "started-from-file" ) ) )
933 intf_Create( p_libvlc, "dbus,none" );
935 # if !defined (HAVE_MAEMO)
936 /* Prevents the power management daemon from suspending the system
937 * when VLC is active */
938 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
939 intf_Create( p_libvlc, "inhibit,none" );
943 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
944 !config_GetInt( p_libvlc, "syslog" ) )
946 intf_Create( p_libvlc, "logger,none" );
949 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
951 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
952 var_SetString( p_libvlc, "logmode", "syslog" );
953 intf_Create( p_libvlc, "logger,none" );
957 var_SetString( p_libvlc, "logmode", logmode );
960 var_Destroy( p_libvlc, "logmode" );
964 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
966 intf_Create( p_libvlc, "netsync,none" );
970 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
972 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
975 char *psz_morecodecs;
976 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
978 var_SetString( p_libvlc, "codec", psz_morecodecs);
979 free( psz_morecodecs );
984 var_SetString( p_libvlc, "codec", "dmo,quicktime");
988 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
990 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
991 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
992 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
993 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
994 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
995 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
998 /* Create a variable for showing the fullscreen interface from hotkeys */
999 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
1000 var_SetBool( p_libvlc, "intf-show", true );
1002 /* Create a variable for showing the right click menu */
1003 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1006 * Get input filenames given as commandline arguments
1008 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1011 * Get --open argument
1013 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
1014 if ( psz_val != NULL )
1016 playlist_t *p_playlist = pl_Hold( p_libvlc );
1017 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
1018 -1, 0, NULL, 0, true, pl_Unlocked );
1019 pl_Release( p_libvlc );
1027 * Cleanup a libvlc instance. The instance is not completely deallocated
1028 * \param p_libvlc the instance to clean
1030 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1032 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1033 playlist_t *p_playlist = priv->p_playlist;
1035 /* Deactivate the playlist */
1036 msg_Dbg( p_libvlc, "deactivating the playlist" );
1037 playlist_Deactivate( p_playlist );
1039 /* Remove all services discovery */
1040 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1041 playlist_ServicesDiscoveryKillAll( p_playlist );
1043 /* Ask the interfaces to stop and destroy them */
1044 msg_Dbg( p_libvlc, "removing all interfaces" );
1045 libvlc_Quit( p_libvlc );
1046 intf_DestroyAll( p_libvlc );
1049 /* Destroy VLM if created in libvlc_InternalInit */
1052 vlm_Delete( priv->p_vlm );
1057 /* Any thread still running must not assume pl_Hold() succeeds. */
1058 msg_Dbg( p_libvlc, "removing playlist" );
1060 libvlc_priv(p_libvlc)->p_playlist = NULL;
1061 barrier(); /* FIXME is that correct ? */
1063 vlc_object_release( p_playlist );
1065 stats_TimersDumpAll( p_libvlc );
1066 stats_TimersCleanAll( p_libvlc );
1068 msg_Dbg( p_libvlc, "removing stats" );
1071 char* psz_pidfile = NULL;
1075 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1076 if( psz_pidfile != NULL )
1078 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1079 if( unlink( psz_pidfile ) == -1 )
1081 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1085 free( psz_pidfile );
1089 if( priv->p_memcpy_module )
1091 module_unneed( p_libvlc, priv->p_memcpy_module );
1092 priv->p_memcpy_module = NULL;
1095 /* Free module bank. It is refcounted, so we call this each time */
1096 module_EndBank( p_libvlc, true );
1098 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1099 (void *)p_libvlc->p_hotkeys );
1100 free( (void *)p_libvlc->p_hotkeys );
1104 * Destroy everything.
1105 * This function requests the running threads to finish, waits for their
1106 * termination, and destroys their structure.
1107 * It stops the thread systems: no instance can run after this has run
1108 * \param p_libvlc the instance to destroy
1110 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1112 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1114 vlc_mutex_lock( &global_lock );
1117 if( i_instances == 0 )
1119 /* System specific cleaning code */
1120 system_End( p_libvlc );
1122 vlc_mutex_unlock( &global_lock );
1124 msg_Destroy( p_libvlc );
1126 /* Destroy mutexes */
1127 vlc_cond_destroy( &priv->exiting );
1128 vlc_mutex_destroy( &priv->timer_lock );
1130 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1131 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1132 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1133 vlc_object_release( p_libvlc );
1136 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1137 vlc_object_release( p_libvlc );
1141 * Add an interface plugin and run it
1143 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1146 return VLC_EGENERIC;
1148 if( !psz_module ) /* requesting the default interface */
1150 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1151 if( !psz_interface ) /* "intf" has not been set */
1155 /* Daemon mode hack.
1156 * We prefer the dummy interface if none is specified. */
1157 psz_module = "dummy";
1160 msg_Info( p_libvlc, "%s",
1161 _("Running vlc with the default interface. "
1162 "Use 'cvlc' to use vlc without interface.") );
1164 free( psz_interface );
1167 /* Try to create the interface */
1168 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1170 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1171 psz_module ? psz_module : "default" );
1172 var_Destroy( p_libvlc, "intf" );
1176 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1179 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1180 * when the user "exits" an interface plugin.
1182 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1184 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1186 vlc_mutex_lock( &exit_lock );
1187 while( vlc_object_alive( p_libvlc ) )
1188 vlc_cond_wait( &priv->exiting, &exit_lock );
1189 vlc_mutex_unlock( &exit_lock );
1193 * Posts an exit signal to LibVLC instance. This will normally initiate the
1194 * cleanup and destroy process. It should only be called on behalf of the user.
1196 void libvlc_Quit( libvlc_int_t *p_libvlc )
1198 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1200 vlc_mutex_lock( &exit_lock );
1201 vlc_object_kill( p_libvlc );
1202 vlc_cond_signal( &priv->exiting );
1203 vlc_mutex_unlock( &exit_lock );
1206 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1207 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1208 /*****************************************************************************
1209 * SetLanguage: set the interface language.
1210 *****************************************************************************
1211 * We set the LC_MESSAGES locale category for interface messages and buttons,
1212 * as well as the LC_CTYPE category for string sorting and possible wide
1213 * character support.
1214 *****************************************************************************/
1215 static void SetLanguage ( const char *psz_lang )
1218 /* I need that under Darwin, please check it doesn't disturb
1219 * other platforms. --Meuuh */
1220 setenv( "LANG", psz_lang, 1 );
1223 /* We set LC_ALL manually because it is the only way to set
1224 * the language at runtime under eg. Windows. Beware that this
1225 * makes the environment unconsistent when libvlc is unloaded and
1226 * should probably be moved to a safer place like vlc.c. */
1227 static char psz_lcall[20];
1228 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1229 psz_lcall[19] = '\0';
1230 putenv( psz_lcall );
1233 setlocale( LC_ALL, psz_lang );
1238 static inline int LoadMessages (void)
1240 #if defined( ENABLE_NLS ) \
1241 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1242 /* Specify where to find the locales for current domain */
1243 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1244 static const char psz_path[] = LOCALEDIR;
1246 char psz_path[1024];
1247 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1248 config_GetDataDirDefault(), "locale")
1249 >= (int)sizeof (psz_path))
1253 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1255 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1256 " to directory %s\n", psz_path);
1260 /* LibVLC wants all messages in UTF-8.
1261 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1262 * and other functions that are not part of our text domain.
1264 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1266 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1268 // Unbinds the text domain to avoid broken encoding
1269 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1273 /* LibVLC does NOT set the default textdomain, since it is a library.
1274 * This could otherwise break programs using LibVLC (other than VLC).
1275 * textdomain (PACKAGE_NAME);
1281 /*****************************************************************************
1282 * GetFilenames: parse command line options which are not flags
1283 *****************************************************************************
1284 * Parse command line for input files as well as their associated options.
1285 * An option always follows its associated input and begins with a ":".
1286 *****************************************************************************/
1287 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1289 int i_opt, i_options;
1291 /* We assume that the remaining parameters are filenames
1292 * and their input options */
1293 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1297 /* Count the input options */
1298 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1304 /* TODO: write an internal function of this one, to avoid
1305 * unnecessary lookups. */
1306 char *mrl = make_URI( ppsz_argv[i_opt] );
1310 playlist_t *p_playlist = pl_Hold( p_vlc );
1311 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1312 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1313 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1314 pl_Release( p_vlc );
1321 /*****************************************************************************
1322 * Help: print program help
1323 *****************************************************************************
1324 * Print a short inline help. Message interface is initialized at this stage.
1325 *****************************************************************************/
1326 static inline void print_help_on_full_help( void )
1328 utf8_fprintf( stdout, "\n" );
1329 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1332 static const char vlc_usage[] = N_(
1333 "Usage: %s [options] [stream] ..."
1334 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1335 "\nThe first item specified will be played first."
1338 "\n --option A global option that is set for the duration of the program."
1339 "\n -option A single letter version of a global --option."
1340 "\n :option An option that only applies to the stream directly before it"
1341 "\n and that overrides previous settings."
1343 "\nStream MRL syntax:"
1344 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1346 "\n Many of the global --options can also be used as MRL specific :options."
1347 "\n Multiple :option=value pairs can be specified."
1350 "\n [file://]filename Plain media file"
1351 "\n http://ip:port/file HTTP URL"
1352 "\n ftp://ip:port/file FTP URL"
1353 "\n mms://ip:port/file MMS URL"
1354 "\n screen:// Screen capture"
1355 "\n [dvd://][device][@raw_device] DVD device"
1356 "\n [vcd://][device] VCD device"
1357 "\n [cdda://][device] Audio CD device"
1358 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1359 "\n UDP stream sent by a streaming server"
1360 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1361 "\n vlc://quit Special item to quit VLC"
1364 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1367 ShowConsole( true );
1370 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1372 utf8_fprintf( stdout, vlc_usage, "vlc" );
1373 Usage( p_this, "=help" );
1374 Usage( p_this, "=main" );
1375 print_help_on_full_help();
1377 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1379 utf8_fprintf( stdout, vlc_usage, "vlc" );
1380 Usage( p_this, NULL );
1381 print_help_on_full_help();
1383 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1385 utf8_fprintf( stdout, vlc_usage, "vlc" );
1386 Usage( p_this, NULL );
1388 else if( psz_help_name )
1390 Usage( p_this, psz_help_name );
1393 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1398 /*****************************************************************************
1399 * Usage: print module usage
1400 *****************************************************************************
1401 * Print a short inline help. Message interface is initialized at this stage.
1402 *****************************************************************************/
1403 # define COL(x) "\033[" #x ";1m"
1404 # define RED COL(31)
1405 # define GREEN COL(32)
1406 # define YELLOW COL(33)
1407 # define BLUE COL(34)
1408 # define MAGENTA COL(35)
1409 # define CYAN COL(36)
1410 # define WHITE COL(0)
1411 # define GRAY "\033[0m"
1412 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1414 if( !p_item ) return;
1417 utf8_fprintf( stdout, RED" %s:\n"GRAY, _( p_item->psz_text ) );
1418 if( b_description && p_item->psz_longtext )
1419 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1420 _( p_item->psz_longtext ) );
1424 utf8_fprintf( stdout, " %s:\n", _( p_item->psz_text ) );
1425 if( b_description && p_item->psz_longtext )
1426 utf8_fprintf( stdout, " %s\n", _( p_item->psz_longtext ) );
1430 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1432 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1433 /* short option ------' | | | | | | |
1434 * option name ------------' | | | | | |
1435 * <bra ---------------------' | | | | |
1436 * option type or "" ----------' | | | |
1437 * ket> -------------------------' | | |
1438 * padding spaces -----------------' | |
1439 * comment --------------------------' |
1440 * comment suffix ---------------------'
1442 * The purpose of having bra and ket is that we might i18n them as well.
1445 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1446 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1448 #define LINE_START 8
1449 #define PADDING_SPACES 25
1451 # define OPTION_VALUE_SEP "="
1453 # define OPTION_VALUE_SEP " "
1455 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1456 char psz_spaces_longtext[LINE_START+3];
1457 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1458 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1459 char psz_buffer[10000];
1461 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1462 int i_width_description = i_width + PADDING_SPACES - 1;
1463 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1464 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1465 bool b_description_hack;
1466 bool b_color = config_GetInt( p_this, "color" ) > 0;
1467 bool b_has_advanced = false;
1468 bool b_found = false;
1469 int i_only_advanced = 0; /* Number of modules ignored because they
1470 * only have advanced options */
1471 bool b_strict = psz_search && *psz_search == '=';
1472 if( b_strict ) psz_search++;
1474 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1475 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1476 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1477 psz_spaces_longtext[LINE_START+2] = '\0';
1481 b_color = false; // don't put color control codes in a .txt file
1485 strcpy( psz_format, COLOR_FORMAT_STRING );
1486 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1490 strcpy( psz_format, FORMAT_STRING );
1491 strcpy( psz_format_bool, FORMAT_STRING );
1494 /* List all modules */
1495 module_t **list = module_list_get (NULL);
1499 /* Ugly hack to make sure that the help options always come first
1502 Usage( p_this, "help" );
1504 /* Enumerate the config for each module */
1505 for (size_t i = 0; list[i]; i++)
1508 module_t *p_parser = list[i];
1509 module_config_t *p_item = NULL;
1510 module_config_t *p_section = NULL;
1511 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1514 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1515 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1517 char *const *pp_shortcut = p_parser->pp_shortcuts;
1518 while( *pp_shortcut )
1520 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1521 : !!strstr( *pp_shortcut, psz_search ) )
1529 /* Ignore modules without config options */
1530 if( !p_parser->i_config_items )
1535 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1536 /* Ugly hack to make sure that the help options always come first
1538 if( !psz_search && b_help_module )
1541 /* Ignore modules with only advanced config options if requested */
1544 for( p_item = p_parser->p_config;
1548 if( (p_item->i_type & CONFIG_ITEM) &&
1549 !p_item->b_advanced && !p_item->b_removed ) break;
1552 if( p_item == p_end )
1561 /* Print name of module */
1562 if( strcmp( "main", p_parser->psz_object_name ) )
1565 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1566 _( p_parser->psz_longname ),
1567 p_parser->psz_object_name );
1569 utf8_fprintf( stdout, "\n %s\n", _( p_parser->psz_longname ) );
1571 if( p_parser->psz_help )
1574 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1575 _( p_parser->psz_help ) );
1577 utf8_fprintf( stdout, " %s\n", _( p_parser->psz_help ) );
1580 /* Print module options */
1581 for( p_item = p_parser->p_config;
1585 char *psz_text, *psz_spaces = psz_spaces_text;
1586 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1587 const char *psz_suf = "", *psz_prefix = NULL;
1591 /* Skip removed options */
1592 if( p_item->b_removed )
1596 /* Skip advanced options if requested */
1597 if( p_item->b_advanced && !b_advanced )
1599 b_has_advanced = true;
1603 switch( p_item->i_type )
1605 case CONFIG_HINT_CATEGORY:
1606 case CONFIG_HINT_USAGE:
1607 if( !strcmp( "main", p_parser->psz_object_name ) )
1610 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1611 _( p_item->psz_text ) );
1613 utf8_fprintf( stdout, "\n %s\n",
1614 _( p_item->psz_text ) );
1616 if( b_description && p_item->psz_longtext )
1619 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1620 _( p_item->psz_longtext ) );
1622 utf8_fprintf( stdout, " %s\n",
1623 _( p_item->psz_longtext ) );
1627 case CONFIG_HINT_SUBCATEGORY:
1628 if( strcmp( "main", p_parser->psz_object_name ) )
1630 case CONFIG_SECTION:
1634 case CONFIG_ITEM_STRING:
1635 case CONFIG_ITEM_FILE:
1636 case CONFIG_ITEM_DIRECTORY:
1637 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1638 case CONFIG_ITEM_MODULE_CAT:
1639 case CONFIG_ITEM_MODULE_LIST:
1640 case CONFIG_ITEM_MODULE_LIST_CAT:
1641 case CONFIG_ITEM_FONT:
1642 case CONFIG_ITEM_PASSWORD:
1643 print_help_section( p_section, b_color, b_description );
1645 psz_bra = OPTION_VALUE_SEP "<";
1646 psz_type = _("string");
1649 if( p_item->ppsz_list )
1651 psz_bra = OPTION_VALUE_SEP "{";
1652 psz_type = psz_buffer;
1653 psz_buffer[0] = '\0';
1654 for( i = 0; p_item->ppsz_list[i]; i++ )
1656 if( i ) strcat( psz_buffer, "," );
1657 strcat( psz_buffer, p_item->ppsz_list[i] );
1662 case CONFIG_ITEM_INTEGER:
1663 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1664 print_help_section( p_section, b_color, b_description );
1666 psz_bra = OPTION_VALUE_SEP "<";
1667 psz_type = _("integer");
1670 if( p_item->min.i || p_item->max.i )
1672 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1673 p_item->min.i, p_item->max.i );
1674 psz_type = psz_buffer;
1677 if( p_item->i_list )
1679 psz_bra = OPTION_VALUE_SEP "{";
1680 psz_type = psz_buffer;
1681 psz_buffer[0] = '\0';
1682 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1684 if( i ) strcat( psz_buffer, ", " );
1685 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1687 _( p_item->ppsz_list_text[i] ) );
1692 case CONFIG_ITEM_FLOAT:
1693 print_help_section( p_section, b_color, b_description );
1695 psz_bra = OPTION_VALUE_SEP "<";
1696 psz_type = _("float");
1698 if( p_item->min.f || p_item->max.f )
1700 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1701 p_item->min.f, p_item->max.f );
1702 psz_type = psz_buffer;
1705 case CONFIG_ITEM_BOOL:
1706 print_help_section( p_section, b_color, b_description );
1708 psz_bra = ""; psz_type = ""; psz_ket = "";
1709 if( !b_help_module )
1711 psz_suf = p_item->value.i ? _(" (default enabled)") :
1712 _(" (default disabled)");
1722 /* Add short option if any */
1723 if( p_item->i_short )
1725 sprintf( psz_short, "-%c,", p_item->i_short );
1729 strcpy( psz_short, " " );
1732 i = PADDING_SPACES - strlen( p_item->psz_name )
1733 - strlen( psz_bra ) - strlen( psz_type )
1734 - strlen( psz_ket ) - 1;
1736 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1738 psz_prefix = ", --no-";
1739 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1744 psz_spaces[0] = '\n';
1749 psz_spaces[i] = '\0';
1752 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1754 utf8_fprintf( stdout, psz_format_bool, psz_short,
1755 p_item->psz_name, psz_prefix, p_item->psz_name,
1756 psz_bra, psz_type, psz_ket, psz_spaces );
1760 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1761 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1764 psz_spaces[i] = ' ';
1766 /* We wrap the rest of the output */
1767 sprintf( psz_buffer, "%s%s", _( p_item->psz_text ),
1769 b_description_hack = b_description;
1772 psz_text = psz_buffer;
1773 i_cur_width = b_description && !b_description_hack
1774 ? i_width_description
1778 char *psz_parser, *psz_word;
1779 size_t i_end = strlen( psz_text );
1781 /* If the remaining text fits in a line, print it. */
1782 if( i_end <= i_cur_width )
1786 if( !b_description || b_description_hack )
1787 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1789 utf8_fprintf( stdout, "%s\n", psz_text );
1793 utf8_fprintf( stdout, "%s\n", psz_text );
1798 /* Otherwise, eat as many words as possible */
1799 psz_parser = psz_text;
1802 psz_word = psz_parser;
1803 psz_parser = strchr( psz_word, ' ' );
1804 /* If no space was found, we reached the end of the text
1805 * block; otherwise, we skip the space we just found. */
1806 psz_parser = psz_parser ? psz_parser + 1
1809 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1811 /* We cut a word in one of these cases:
1812 * - it's the only word in the line and it's too long.
1813 * - we used less than 80% of the width and the word we are
1814 * going to wrap is longer than 40% of the width, and even
1815 * if the word would have fit in the next line. */
1816 if( psz_word == psz_text
1817 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1818 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1820 char c = psz_text[i_cur_width];
1821 psz_text[i_cur_width] = '\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 += i_cur_width;
1840 psz_word[-1] = '\0';
1843 if( !b_description || b_description_hack )
1844 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1845 psz_text, psz_spaces );
1847 utf8_fprintf( stdout, "%s\n%s",
1848 psz_text, psz_spaces );
1852 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1854 psz_text = psz_word;
1858 if( b_description_hack && p_item->psz_longtext )
1860 sprintf( psz_buffer, "%s%s", _( p_item->psz_longtext ),
1862 b_description_hack = false;
1863 psz_spaces = psz_spaces_longtext;
1864 utf8_fprintf( stdout, "%s", psz_spaces );
1870 if( b_has_advanced )
1873 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1874 _( "add --advanced to your command line to see advanced options."));
1876 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1877 _( "add --advanced to your command line to see advanced options."));
1880 if( i_only_advanced > 0 )
1884 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1885 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1889 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1890 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1896 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1897 _( "No matching module found. Use --list or " \
1898 "--list-verbose to list available modules." ) );
1900 utf8_fprintf( stdout, "\n%s\n",
1901 _( "No matching module found. Use --list or " \
1902 "--list-verbose to list available modules." ) );
1905 /* Release the module list */
1906 module_list_free (list);
1909 /*****************************************************************************
1910 * ListModules: list the available modules with their description
1911 *****************************************************************************
1912 * Print a list of all available modules (builtins and plugins) and a short
1913 * description for each one.
1914 *****************************************************************************/
1915 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1919 bool b_color = config_GetInt( p_this, "color" ) > 0;
1922 ShowConsole( true );
1925 /* List all modules */
1926 module_t **list = module_list_get (NULL);
1928 /* Enumerate each module */
1929 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1932 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1933 p_parser->psz_object_name,
1934 _( p_parser->psz_longname ) );
1936 utf8_fprintf( stdout, " %-22s %s\n",
1937 p_parser->psz_object_name,
1938 _( p_parser->psz_longname ) );
1942 char *const *pp_shortcut = p_parser->pp_shortcuts;
1943 while( *pp_shortcut )
1945 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1948 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1951 utf8_fprintf( stdout, " s %s\n",
1956 if( p_parser->psz_capability )
1959 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1960 p_parser->psz_capability,
1961 p_parser->i_score );
1963 utf8_fprintf( stdout, " c %s (%d)\n",
1964 p_parser->psz_capability,
1965 p_parser->i_score );
1969 module_list_free (list);
1971 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1976 /*****************************************************************************
1977 * Version: print complete program version
1978 *****************************************************************************
1979 * Print complete program version and build number.
1980 *****************************************************************************/
1981 static void Version( void )
1983 extern const char psz_vlc_changeset[];
1985 ShowConsole( true );
1988 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1989 psz_vlc_changeset );
1990 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1991 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1992 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1993 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1995 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
2000 /*****************************************************************************
2001 * ShowConsole: On Win32, create an output console for debug messages
2002 *****************************************************************************
2003 * This function is useful only on Win32.
2004 *****************************************************************************/
2006 static void ShowConsole( bool b_dofile )
2009 FILE *f_help = NULL;
2011 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2014 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2015 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2016 * page (e.g. CP437 or CP850). */
2017 SetConsoleOutputCP (GetACP ());
2018 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2020 freopen( "CONOUT$", "w", stderr );
2021 freopen( "CONIN$", "r", stdin );
2023 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2026 freopen( "vlc-help.txt", "wt", stdout );
2027 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2029 else freopen( "CONOUT$", "w", stdout );
2035 /*****************************************************************************
2036 * PauseConsole: On Win32, wait for a key press before closing the console
2037 *****************************************************************************
2038 * This function is useful only on Win32.
2039 *****************************************************************************/
2041 static void PauseConsole( void )
2045 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2047 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2055 /*****************************************************************************
2056 * ConsoleWidth: Return the console width in characters
2057 *****************************************************************************
2058 * We use the stty shell command to get the console width; if this fails or
2059 * if the width is less than 80, we default to 80.
2060 *****************************************************************************/
2061 static int ConsoleWidth( void )
2063 unsigned i_width = 80;
2066 FILE *file = popen( "stty size 2>/dev/null", "r" );
2069 if (fscanf (file, "%*u %u", &i_width) <= 0)
2073 #elif !defined (UNDER_CE)
2074 CONSOLE_SCREEN_BUFFER_INFO buf;
2076 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2077 i_width = buf.dwSize.X;
2083 #include <vlc_avcodec.h>
2085 void vlc_avcodec_mutex (bool acquire)
2087 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2090 vlc_mutex_lock (&lock);
2092 vlc_mutex_unlock (&lock);