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 = config_GetPsz( 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 = config_GetPsz( p_libvlc, "language" );
442 if( psz_language && *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 = config_GetPsz( 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 );
535 module_EndBank( p_libvlc, true );
540 * Override default configuration with config file settings
542 if( !config_GetInt( p_libvlc, "ignore-config" ) )
543 config_LoadConfigFile( p_libvlc, NULL );
546 * Override configuration with command line settings
548 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
551 ShowConsole( false );
552 /* Pause the console because it's destroyed when we exit */
553 fprintf( stderr, "The command line options couldn't be loaded, check "
554 "that they are valid.\n" );
557 module_EndBank( p_libvlc, true );
560 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
563 * System specific configuration
565 system_Configure( p_libvlc, &i_argc, ppsz_argv );
567 /* FIXME: could be replaced by using Unix sockets */
569 dbus_threads_init_default();
571 if( config_GetInt( p_libvlc, "one-instance" ) > 0
572 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
573 && config_GetInt( p_libvlc, "started-from-file" ) ) )
575 /* Initialise D-Bus interface, check for other instances */
576 DBusConnection *p_conn = NULL;
577 DBusError dbus_error;
579 dbus_error_init( &dbus_error );
581 /* connect to the session bus */
582 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
585 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
586 dbus_error.message );
587 dbus_error_free( &dbus_error );
591 /* check if VLC is available on the bus
592 * if not: D-Bus control is not enabled on the other
593 * instance and we can't pass MRLs to it */
594 DBusMessage *p_test_msg = NULL;
595 DBusMessage *p_test_reply = NULL;
596 p_test_msg = dbus_message_new_method_call(
597 "org.mpris.vlc", "/",
598 "org.freedesktop.MediaPlayer", "Identity" );
599 /* block until a reply arrives */
600 p_test_reply = dbus_connection_send_with_reply_and_block(
601 p_conn, p_test_msg, -1, &dbus_error );
602 dbus_message_unref( p_test_msg );
603 if( p_test_reply == NULL )
605 dbus_error_free( &dbus_error );
606 msg_Dbg( p_libvlc, "No Media Player is running. "
607 "Continuing normally." );
612 DBusMessage* p_dbus_msg = NULL;
613 DBusMessageIter dbus_args;
614 DBusPendingCall* p_dbus_pending = NULL;
617 dbus_message_unref( p_test_reply );
618 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
620 for( i_input = optind;i_input < i_argc;i_input++ )
622 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
623 ppsz_argv[i_input] );
625 p_dbus_msg = dbus_message_new_method_call(
626 "org.mpris.vlc", "/TrackList",
627 "org.freedesktop.MediaPlayer", "AddTrack" );
629 if ( NULL == p_dbus_msg )
631 msg_Err( p_libvlc, "D-Bus problem" );
632 system_End( p_libvlc );
637 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
638 if ( !dbus_message_iter_append_basic( &dbus_args,
639 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
641 dbus_message_unref( p_dbus_msg );
642 system_End( p_libvlc );
646 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
648 if ( !dbus_message_iter_append_basic( &dbus_args,
649 DBUS_TYPE_BOOLEAN, &b_play ) )
651 dbus_message_unref( p_dbus_msg );
652 system_End( p_libvlc );
656 /* send message and get a handle for a reply */
657 if ( !dbus_connection_send_with_reply ( p_conn,
658 p_dbus_msg, &p_dbus_pending, -1 ) )
660 msg_Err( p_libvlc, "D-Bus problem" );
661 dbus_message_unref( p_dbus_msg );
662 system_End( p_libvlc );
666 if ( NULL == p_dbus_pending )
668 msg_Err( p_libvlc, "D-Bus problem" );
669 dbus_message_unref( p_dbus_msg );
670 system_End( p_libvlc );
673 dbus_connection_flush( p_conn );
674 dbus_message_unref( p_dbus_msg );
675 /* block until we receive a reply */
676 dbus_pending_call_block( p_dbus_pending );
677 dbus_pending_call_unref( p_dbus_pending );
678 } /* processes all command line MRLs */
681 system_End( p_libvlc );
685 /* we unreference the connection when we've finished with it */
686 if( p_conn ) dbus_connection_unref( p_conn );
691 * Message queue options
693 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
694 if( psz_verbose_objects )
696 char * psz_object, * iter = psz_verbose_objects;
697 while( (psz_object = strsep( &iter, "," )) )
699 switch( psz_object[0] )
701 printf("%s\n", psz_object+1);
702 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
703 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
705 msg_Err( p_libvlc, "verbose-objects usage: \n"
706 "--verbose-objects=+printthatobject,"
707 "-dontprintthatone\n"
708 "(keyword 'all' to applies to all objects)");
709 free( psz_verbose_objects );
710 /* FIXME: leaks!!!! */
714 free( psz_verbose_objects );
717 /* Last chance to set the verbosity. Once we start interfaces and other
718 * threads, verbosity becomes read-only. */
719 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
720 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
722 var_SetInteger( p_libvlc, "verbose", -1 );
723 priv->i_verbose = -1;
725 vlc_threads_setup( p_libvlc );
728 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
730 if( !config_GetInt( p_libvlc, "fpu" ) )
731 cpu_flags &= ~CPU_CAPABILITY_FPU;
733 char p_capabilities[200];
734 #define PRINT_CAPABILITY( capability, string ) \
735 if( vlc_CPU() & capability ) \
737 strncat( p_capabilities, string " ", \
738 sizeof(p_capabilities) - strlen(p_capabilities) ); \
739 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
741 p_capabilities[0] = '\0';
743 #if defined( __i386__ ) || defined( __x86_64__ )
744 if( !config_GetInt( p_libvlc, "mmx" ) )
745 cpu_flags &= ~CPU_CAPABILITY_MMX;
746 if( !config_GetInt( p_libvlc, "3dn" ) )
747 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
748 if( !config_GetInt( p_libvlc, "mmxext" ) )
749 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
750 if( !config_GetInt( p_libvlc, "sse" ) )
751 cpu_flags &= ~CPU_CAPABILITY_SSE;
752 if( !config_GetInt( p_libvlc, "sse2" ) )
753 cpu_flags &= ~CPU_CAPABILITY_SSE2;
754 if( !config_GetInt( p_libvlc, "sse3" ) )
755 cpu_flags &= ~CPU_CAPABILITY_SSE3;
757 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
758 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
759 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
760 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
761 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
762 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
764 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
765 if( !config_GetInt( p_libvlc, "altivec" ) )
766 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
768 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
770 #elif defined( __arm__ )
771 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
775 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
776 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
779 * Choose the best memcpy module
781 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
782 /* Avoid being called "memcpy":*/
783 vlc_object_set_name( p_libvlc, "main" );
785 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
787 priv->pp_timers = NULL;
789 priv->i_last_input_id = 0; /* Not very safe, should be removed */
792 * Initialize hotkey handling
794 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
795 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
797 struct hotkey *p_keys =
798 malloc( (libvlc_actions_count + 1) * sizeof (*p_keys) );
800 /* Initialize from configuration */
801 for( size_t i = 0; i < libvlc_actions_count; i++ )
803 p_keys[i].psz_action = libvlc_actions[i].name;
804 p_keys[i].i_key = config_GetInt( p_libvlc,
805 libvlc_actions[i].name );
806 p_keys[i].i_action = libvlc_actions[i].value;
808 p_keys[libvlc_actions_count].psz_action = NULL;
809 p_keys[libvlc_actions_count].i_key = 0;
810 p_keys[libvlc_actions_count].i_action = 0;
811 p_libvlc->p_hotkeys = p_keys;
812 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
816 /* variables for signalling creation of new files */
817 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
818 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
820 /* Initialize playlist and get commandline files */
821 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
824 msg_Err( p_libvlc, "playlist initialization failed" );
825 if( priv->p_memcpy_module != NULL )
827 module_unneed( p_libvlc, priv->p_memcpy_module );
829 module_EndBank( p_libvlc, true );
832 playlist_Activate( p_playlist );
833 vlc_object_attach( p_playlist, p_libvlc );
835 /* Add service discovery modules */
836 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
837 if( psz_modules && *psz_modules )
839 char *p = psz_modules, *m;
840 while( ( m = strsep( &p, " :," ) ) != NULL )
841 playlist_ServicesDiscoveryAdd( p_playlist, m );
846 /* Initialize VLM if vlm-conf is specified */
847 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
848 if( psz_parser && *psz_parser )
850 priv->p_vlm = vlm_New( p_libvlc );
852 msg_Err( p_libvlc, "VLM initialization failed" );
858 * Load background interfaces
860 /* Create volume callback system. (this variable must be created before
861 all interfaces as they can use it) */
862 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
864 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
865 psz_control = config_GetPsz( p_libvlc, "control" );
867 if( psz_modules && *psz_modules && psz_control && *psz_control )
870 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
873 psz_modules = psz_tmp;
876 else if( psz_control && *psz_control )
879 psz_modules = strdup( psz_control );
882 psz_parser = psz_modules;
883 while ( psz_parser && *psz_parser )
885 char *psz_module, *psz_temp;
886 psz_module = psz_parser;
887 psz_parser = strchr( psz_module, ':' );
893 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
895 intf_Create( p_libvlc, psz_temp );
903 * Always load the hotkeys interface if it exists
905 intf_Create( p_libvlc, "hotkeys,none" );
908 /* loads dbus control interface if in one-instance mode
909 * we do it only when playlist exists, because dbus module needs it */
910 if( config_GetInt( p_libvlc, "one-instance" ) > 0
911 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
912 && config_GetInt( p_libvlc, "started-from-file" ) ) )
913 intf_Create( p_libvlc, "dbus,none" );
915 /* Prevents the power management daemon from suspending the system
916 * when VLC is active */
917 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
918 intf_Create( p_libvlc, "inhibit,none" );
921 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
922 !config_GetInt( p_libvlc, "syslog" ) )
924 intf_Create( p_libvlc, "logger,none" );
927 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
929 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
930 var_SetString( p_libvlc, "logmode", "syslog" );
931 intf_Create( p_libvlc, "logger,none" );
935 var_SetString( p_libvlc, "logmode", logmode );
939 var_Destroy( p_libvlc, "logmode" );
943 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
945 intf_Create( p_libvlc, "netsync,none" );
949 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
951 char *psz_codecs = config_GetPsz( p_playlist, "codec" );
954 char *psz_morecodecs;
955 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
957 config_PutPsz( p_libvlc, "codec", psz_morecodecs);
958 free( psz_morecodecs );
962 config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
967 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
968 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
969 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
970 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
971 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
972 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
973 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
974 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
977 /* Create a variable for showing the fullscreen interface from hotkeys */
978 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
979 var_SetBool( p_libvlc, "intf-show", true );
981 /* Create a variable for showing the right click menu */
982 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
985 * Get input filenames given as commandline arguments
987 GetFilenames( p_libvlc, i_argc, ppsz_argv );
990 * Get --open argument
992 psz_val = var_CreateGetString( p_libvlc, "open" );
993 if ( psz_val != NULL && *psz_val )
995 playlist_t *p_playlist = pl_Hold( p_libvlc );
996 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
997 -1, 0, NULL, 0, true, pl_Unlocked );
998 pl_Release( p_libvlc );
1006 * Cleanup a libvlc instance. The instance is not completely deallocated
1007 * \param p_libvlc the instance to clean
1009 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1011 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1012 playlist_t *p_playlist = priv->p_playlist;
1014 /* Deactivate the playlist */
1015 msg_Dbg( p_libvlc, "deactivating the playlist" );
1016 playlist_Deactivate( p_playlist );
1018 /* Remove all services discovery */
1019 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1020 playlist_ServicesDiscoveryKillAll( p_playlist );
1022 /* Ask the interfaces to stop and destroy them */
1023 msg_Dbg( p_libvlc, "removing all interfaces" );
1024 libvlc_Quit( p_libvlc );
1025 intf_DestroyAll( p_libvlc );
1028 /* Destroy VLM if created in libvlc_InternalInit */
1031 vlm_Delete( priv->p_vlm );
1036 /* Any thread still running must not assume pl_Hold() succeeds. */
1037 msg_Dbg( p_libvlc, "removing playlist" );
1039 libvlc_priv(p_libvlc)->p_playlist = NULL;
1040 barrier(); /* FIXME is that correct ? */
1042 vlc_object_release( p_playlist );
1044 stats_TimersDumpAll( p_libvlc );
1045 stats_TimersCleanAll( p_libvlc );
1047 msg_Dbg( p_libvlc, "removing stats" );
1050 char* psz_pidfile = NULL;
1054 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1055 if( psz_pidfile != NULL )
1057 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1058 if( unlink( psz_pidfile ) == -1 )
1060 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1064 free( psz_pidfile );
1068 if( priv->p_memcpy_module )
1070 module_unneed( p_libvlc, priv->p_memcpy_module );
1071 priv->p_memcpy_module = NULL;
1074 /* Free module bank. It is refcounted, so we call this each time */
1075 module_EndBank( p_libvlc, true );
1077 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1078 (void *)p_libvlc->p_hotkeys );
1079 free( (void *)p_libvlc->p_hotkeys );
1083 * Destroy everything.
1084 * This function requests the running threads to finish, waits for their
1085 * termination, and destroys their structure.
1086 * It stops the thread systems: no instance can run after this has run
1087 * \param p_libvlc the instance to destroy
1089 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1091 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1093 vlc_mutex_lock( &global_lock );
1096 if( i_instances == 0 )
1098 /* System specific cleaning code */
1099 system_End( p_libvlc );
1101 vlc_mutex_unlock( &global_lock );
1103 msg_Destroy( p_libvlc );
1105 /* Destroy mutexes */
1106 vlc_cond_destroy( &priv->exiting );
1107 vlc_mutex_destroy( &priv->timer_lock );
1109 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1110 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1111 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1112 vlc_object_release( p_libvlc );
1115 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1116 vlc_object_release( p_libvlc );
1120 * Add an interface plugin and run it
1122 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1125 return VLC_EGENERIC;
1127 if( !psz_module ) /* requesting the default interface */
1129 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1130 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1134 /* Daemon mode hack.
1135 * We prefer the dummy interface if none is specified. */
1136 psz_module = "dummy";
1139 msg_Info( p_libvlc, "%s",
1140 _("Running vlc with the default interface. "
1141 "Use 'cvlc' to use vlc without interface.") );
1143 free( psz_interface );
1146 /* Try to create the interface */
1147 if( intf_Create( p_libvlc, psz_module ? psz_module : "$intf" ) )
1149 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1150 psz_module ? psz_module : "default" );
1151 return VLC_EGENERIC;
1156 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1159 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1160 * when the user "exits" an interface plugin.
1162 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1164 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1166 vlc_mutex_lock( &exit_lock );
1167 while( vlc_object_alive( p_libvlc ) )
1168 vlc_cond_wait( &priv->exiting, &exit_lock );
1169 vlc_mutex_unlock( &exit_lock );
1173 * Posts an exit signal to LibVLC instance. This will normally initiate the
1174 * cleanup and destroy process. It should only be called on behalf of the user.
1176 void libvlc_Quit( libvlc_int_t *p_libvlc )
1178 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1180 vlc_mutex_lock( &exit_lock );
1181 vlc_object_kill( p_libvlc );
1182 vlc_cond_signal( &priv->exiting );
1183 vlc_mutex_unlock( &exit_lock );
1186 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1187 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1188 /*****************************************************************************
1189 * SetLanguage: set the interface language.
1190 *****************************************************************************
1191 * We set the LC_MESSAGES locale category for interface messages and buttons,
1192 * as well as the LC_CTYPE category for string sorting and possible wide
1193 * character support.
1194 *****************************************************************************/
1195 static void SetLanguage ( const char *psz_lang )
1198 /* I need that under Darwin, please check it doesn't disturb
1199 * other platforms. --Meuuh */
1200 setenv( "LANG", psz_lang, 1 );
1203 /* We set LC_ALL manually because it is the only way to set
1204 * the language at runtime under eg. Windows. Beware that this
1205 * makes the environment unconsistent when libvlc is unloaded and
1206 * should probably be moved to a safer place like vlc.c. */
1207 static char psz_lcall[20];
1208 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1209 psz_lcall[19] = '\0';
1210 putenv( psz_lcall );
1213 setlocale( LC_ALL, psz_lang );
1218 static inline int LoadMessages (void)
1220 #if defined( ENABLE_NLS ) \
1221 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1222 /* Specify where to find the locales for current domain */
1223 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1224 static const char psz_path[] = LOCALEDIR;
1226 char psz_path[1024];
1227 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1228 config_GetDataDir(), "locale")
1229 >= (int)sizeof (psz_path))
1233 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1235 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1236 " to directory %s\n", psz_path);
1240 /* LibVLC wants all messages in UTF-8.
1241 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1242 * and other functions that are not part of our text domain.
1244 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1246 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1248 // Unbinds the text domain to avoid broken encoding
1249 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1253 /* LibVLC does NOT set the default textdomain, since it is a library.
1254 * This could otherwise break programs using LibVLC (other than VLC).
1255 * textdomain (PACKAGE_NAME);
1261 /*****************************************************************************
1262 * GetFilenames: parse command line options which are not flags
1263 *****************************************************************************
1264 * Parse command line for input files as well as their associated options.
1265 * An option always follows its associated input and begins with a ":".
1266 *****************************************************************************/
1267 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1269 int i_opt, i_options;
1271 /* We assume that the remaining parameters are filenames
1272 * and their input options */
1273 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1277 /* Count the input options */
1278 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1284 /* TODO: write an internal function of this one, to avoid
1285 * unnecessary lookups. */
1286 char *mrl = make_URI( ppsz_argv[i_opt] );
1290 playlist_t *p_playlist = pl_Hold( p_vlc );
1291 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1292 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1293 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1294 pl_Release( p_vlc );
1301 /*****************************************************************************
1302 * Help: print program help
1303 *****************************************************************************
1304 * Print a short inline help. Message interface is initialized at this stage.
1305 *****************************************************************************/
1306 static inline void print_help_on_full_help( void )
1308 utf8_fprintf( stdout, "\n" );
1309 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1312 static const char vlc_usage[] = N_(
1313 "Usage: %s [options] [stream] ..."
1314 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1315 "\nThe first item specified will be played first."
1318 "\n --option A global option that is set for the duration of the program."
1319 "\n -option A single letter version of a global --option."
1320 "\n :option An option that only applies to the stream directly before it"
1321 "\n and that overrides previous settings."
1323 "\nStream MRL syntax:"
1324 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1326 "\n Many of the global --options can also be used as MRL specific :options."
1327 "\n Multiple :option=value pairs can be specified."
1330 "\n [file://]filename Plain media file"
1331 "\n http://ip:port/file HTTP URL"
1332 "\n ftp://ip:port/file FTP URL"
1333 "\n mms://ip:port/file MMS URL"
1334 "\n screen:// Screen capture"
1335 "\n [dvd://][device][@raw_device] DVD device"
1336 "\n [vcd://][device] VCD device"
1337 "\n [cdda://][device] Audio CD device"
1338 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1339 "\n UDP stream sent by a streaming server"
1340 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1341 "\n vlc://quit Special item to quit VLC"
1344 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1347 ShowConsole( true );
1350 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1352 utf8_fprintf( stdout, vlc_usage, "vlc" );
1353 Usage( p_this, "=help" );
1354 Usage( p_this, "=main" );
1355 print_help_on_full_help();
1357 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1359 utf8_fprintf( stdout, vlc_usage, "vlc" );
1360 Usage( p_this, NULL );
1361 print_help_on_full_help();
1363 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1365 utf8_fprintf( stdout, vlc_usage, "vlc" );
1366 Usage( p_this, NULL );
1368 else if( psz_help_name )
1370 Usage( p_this, psz_help_name );
1373 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1378 /*****************************************************************************
1379 * Usage: print module usage
1380 *****************************************************************************
1381 * Print a short inline help. Message interface is initialized at this stage.
1382 *****************************************************************************/
1383 # define COL(x) "\033[" #x ";1m"
1384 # define RED COL(31)
1385 # define GREEN COL(32)
1386 # define YELLOW COL(33)
1387 # define BLUE COL(34)
1388 # define MAGENTA COL(35)
1389 # define CYAN COL(36)
1390 # define WHITE COL(0)
1391 # define GRAY "\033[0m"
1392 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1394 if( !p_item ) return;
1397 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1399 if( b_description && p_item->psz_longtext )
1400 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1401 p_item->psz_longtext );
1405 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1406 if( b_description && p_item->psz_longtext )
1407 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1411 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1413 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1414 /* short option ------' | | | | | | |
1415 * option name ------------' | | | | | |
1416 * <bra ---------------------' | | | | |
1417 * option type or "" ----------' | | | |
1418 * ket> -------------------------' | | |
1419 * padding spaces -----------------' | |
1420 * comment --------------------------' |
1421 * comment suffix ---------------------'
1423 * The purpose of having bra and ket is that we might i18n them as well.
1426 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1427 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1429 #define LINE_START 8
1430 #define PADDING_SPACES 25
1432 # define OPTION_VALUE_SEP "="
1434 # define OPTION_VALUE_SEP " "
1436 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1437 char psz_spaces_longtext[LINE_START+3];
1438 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1439 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1440 char psz_buffer[10000];
1442 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1443 int i_width_description = i_width + PADDING_SPACES - 1;
1444 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1445 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1446 bool b_description_hack;
1447 bool b_color = config_GetInt( p_this, "color" ) > 0;
1448 bool b_has_advanced = false;
1449 bool b_found = false;
1450 int i_only_advanced = 0; /* Number of modules ignored because they
1451 * only have advanced options */
1452 bool b_strict = psz_search && *psz_search == '=';
1453 if( b_strict ) psz_search++;
1455 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1456 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1457 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1458 psz_spaces_longtext[LINE_START+2] = '\0';
1462 b_color = false; // don't put color control codes in a .txt file
1466 strcpy( psz_format, COLOR_FORMAT_STRING );
1467 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1471 strcpy( psz_format, FORMAT_STRING );
1472 strcpy( psz_format_bool, FORMAT_STRING );
1475 /* List all modules */
1476 module_t **list = module_list_get (NULL);
1480 /* Ugly hack to make sure that the help options always come first
1483 Usage( p_this, "help" );
1485 /* Enumerate the config for each module */
1486 for (size_t i = 0; list[i]; i++)
1489 module_t *p_parser = list[i];
1490 module_config_t *p_item = NULL;
1491 module_config_t *p_section = NULL;
1492 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1495 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1496 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1498 char *const *pp_shortcut = p_parser->pp_shortcuts;
1499 while( *pp_shortcut )
1501 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1502 : !!strstr( *pp_shortcut, psz_search ) )
1510 /* Ignore modules without config options */
1511 if( !p_parser->i_config_items )
1516 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1517 /* Ugly hack to make sure that the help options always come first
1519 if( !psz_search && b_help_module )
1522 /* Ignore modules with only advanced config options if requested */
1525 for( p_item = p_parser->p_config;
1529 if( (p_item->i_type & CONFIG_ITEM) &&
1530 !p_item->b_advanced && !p_item->b_removed ) break;
1533 if( p_item == p_end )
1542 /* Print name of module */
1543 if( strcmp( "main", p_parser->psz_object_name ) )
1546 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1547 p_parser->psz_longname,
1548 p_parser->psz_object_name );
1550 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1552 if( p_parser->psz_help )
1555 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1557 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1560 /* Print module options */
1561 for( p_item = p_parser->p_config;
1565 char *psz_text, *psz_spaces = psz_spaces_text;
1566 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1567 const char *psz_suf = "", *psz_prefix = NULL;
1571 /* Skip removed options */
1572 if( p_item->b_removed )
1576 /* Skip advanced options if requested */
1577 if( p_item->b_advanced && !b_advanced )
1579 b_has_advanced = true;
1583 switch( p_item->i_type )
1585 case CONFIG_HINT_CATEGORY:
1586 case CONFIG_HINT_USAGE:
1587 if( !strcmp( "main", p_parser->psz_object_name ) )
1590 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1593 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1595 if( b_description && p_item->psz_longtext )
1598 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1599 p_item->psz_longtext );
1601 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1605 case CONFIG_HINT_SUBCATEGORY:
1606 if( strcmp( "main", p_parser->psz_object_name ) )
1608 case CONFIG_SECTION:
1612 case CONFIG_ITEM_STRING:
1613 case CONFIG_ITEM_FILE:
1614 case CONFIG_ITEM_DIRECTORY:
1615 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1616 case CONFIG_ITEM_MODULE_CAT:
1617 case CONFIG_ITEM_MODULE_LIST:
1618 case CONFIG_ITEM_MODULE_LIST_CAT:
1619 case CONFIG_ITEM_FONT:
1620 case CONFIG_ITEM_PASSWORD:
1621 print_help_section( p_section, b_color, b_description );
1623 psz_bra = OPTION_VALUE_SEP "<";
1624 psz_type = _("string");
1627 if( p_item->ppsz_list )
1629 psz_bra = OPTION_VALUE_SEP "{";
1630 psz_type = psz_buffer;
1631 psz_buffer[0] = '\0';
1632 for( i = 0; p_item->ppsz_list[i]; i++ )
1634 if( i ) strcat( psz_buffer, "," );
1635 strcat( psz_buffer, p_item->ppsz_list[i] );
1640 case CONFIG_ITEM_INTEGER:
1641 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1642 print_help_section( p_section, b_color, b_description );
1644 psz_bra = OPTION_VALUE_SEP "<";
1645 psz_type = _("integer");
1648 if( p_item->min.i || p_item->max.i )
1650 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1651 p_item->min.i, p_item->max.i );
1652 psz_type = psz_buffer;
1655 if( p_item->i_list )
1657 psz_bra = OPTION_VALUE_SEP "{";
1658 psz_type = psz_buffer;
1659 psz_buffer[0] = '\0';
1660 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1662 if( i ) strcat( psz_buffer, ", " );
1663 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1665 p_item->ppsz_list_text[i] );
1670 case CONFIG_ITEM_FLOAT:
1671 print_help_section( p_section, b_color, b_description );
1673 psz_bra = OPTION_VALUE_SEP "<";
1674 psz_type = _("float");
1676 if( p_item->min.f || p_item->max.f )
1678 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1679 p_item->min.f, p_item->max.f );
1680 psz_type = psz_buffer;
1683 case CONFIG_ITEM_BOOL:
1684 print_help_section( p_section, b_color, b_description );
1686 psz_bra = ""; psz_type = ""; psz_ket = "";
1687 if( !b_help_module )
1689 psz_suf = p_item->value.i ? _(" (default enabled)") :
1690 _(" (default disabled)");
1700 /* Add short option if any */
1701 if( p_item->i_short )
1703 sprintf( psz_short, "-%c,", p_item->i_short );
1707 strcpy( psz_short, " " );
1710 i = PADDING_SPACES - strlen( p_item->psz_name )
1711 - strlen( psz_bra ) - strlen( psz_type )
1712 - strlen( psz_ket ) - 1;
1714 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1716 psz_prefix = ", --no-";
1717 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1722 psz_spaces[0] = '\n';
1727 psz_spaces[i] = '\0';
1730 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1732 utf8_fprintf( stdout, psz_format_bool, psz_short,
1733 p_item->psz_name, psz_prefix, p_item->psz_name,
1734 psz_bra, psz_type, psz_ket, psz_spaces );
1738 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1739 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1742 psz_spaces[i] = ' ';
1744 /* We wrap the rest of the output */
1745 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1746 b_description_hack = b_description;
1749 psz_text = psz_buffer;
1750 i_cur_width = b_description && !b_description_hack
1751 ? i_width_description
1755 char *psz_parser, *psz_word;
1756 size_t i_end = strlen( psz_text );
1758 /* If the remaining text fits in a line, print it. */
1759 if( i_end <= i_cur_width )
1763 if( !b_description || b_description_hack )
1764 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1766 utf8_fprintf( stdout, "%s\n", psz_text );
1770 utf8_fprintf( stdout, "%s\n", psz_text );
1775 /* Otherwise, eat as many words as possible */
1776 psz_parser = psz_text;
1779 psz_word = psz_parser;
1780 psz_parser = strchr( psz_word, ' ' );
1781 /* If no space was found, we reached the end of the text
1782 * block; otherwise, we skip the space we just found. */
1783 psz_parser = psz_parser ? psz_parser + 1
1786 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1788 /* We cut a word in one of these cases:
1789 * - it's the only word in the line and it's too long.
1790 * - we used less than 80% of the width and the word we are
1791 * going to wrap is longer than 40% of the width, and even
1792 * if the word would have fit in the next line. */
1793 if( psz_word == psz_text
1794 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1795 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1797 char c = psz_text[i_cur_width];
1798 psz_text[i_cur_width] = '\0';
1801 if( !b_description || b_description_hack )
1802 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1803 psz_text, psz_spaces );
1805 utf8_fprintf( stdout, "%s\n%s",
1806 psz_text, psz_spaces );
1810 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1812 psz_text += i_cur_width;
1817 psz_word[-1] = '\0';
1820 if( !b_description || b_description_hack )
1821 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1822 psz_text, psz_spaces );
1824 utf8_fprintf( stdout, "%s\n%s",
1825 psz_text, psz_spaces );
1829 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1831 psz_text = psz_word;
1835 if( b_description_hack && p_item->psz_longtext )
1837 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1838 b_description_hack = false;
1839 psz_spaces = psz_spaces_longtext;
1840 utf8_fprintf( stdout, "%s", psz_spaces );
1846 if( b_has_advanced )
1849 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1850 _( "add --advanced to your command line to see advanced options."));
1852 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1853 _( "add --advanced to your command line to see advanced options."));
1856 if( i_only_advanced > 0 )
1860 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1861 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1865 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1866 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1872 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1873 _( "No matching module found. Use --list or " \
1874 "--list-verbose to list available modules." ) );
1876 utf8_fprintf( stdout, "\n%s\n",
1877 _( "No matching module found. Use --list or " \
1878 "--list-verbose to list available modules." ) );
1881 /* Release the module list */
1882 module_list_free (list);
1885 /*****************************************************************************
1886 * ListModules: list the available modules with their description
1887 *****************************************************************************
1888 * Print a list of all available modules (builtins and plugins) and a short
1889 * description for each one.
1890 *****************************************************************************/
1891 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1894 char psz_spaces[22];
1896 bool b_color = config_GetInt( p_this, "color" ) > 0;
1898 memset( psz_spaces, ' ', 22 );
1901 ShowConsole( true );
1904 /* List all modules */
1905 module_t **list = module_list_get (NULL);
1907 /* Enumerate each module */
1908 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1912 /* Nasty hack, but right now I'm too tired to think about a nice
1914 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1919 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1920 p_parser->psz_object_name,
1922 p_parser->psz_longname );
1924 utf8_fprintf( stdout, " %s%s %s\n",
1925 p_parser->psz_object_name,
1926 psz_spaces, p_parser->psz_longname );
1930 char *const *pp_shortcut = p_parser->pp_shortcuts;
1931 while( *pp_shortcut )
1933 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1936 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1939 utf8_fprintf( stdout, " s %s\n",
1944 if( p_parser->psz_capability )
1947 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1948 p_parser->psz_capability,
1949 p_parser->i_score );
1951 utf8_fprintf( stdout, " c %s (%d)\n",
1952 p_parser->psz_capability,
1953 p_parser->i_score );
1957 psz_spaces[i] = ' ';
1959 module_list_free (list);
1961 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1966 /*****************************************************************************
1967 * Version: print complete program version
1968 *****************************************************************************
1969 * Print complete program version and build number.
1970 *****************************************************************************/
1971 static void Version( void )
1973 extern const char psz_vlc_changeset[];
1975 ShowConsole( true );
1978 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1979 psz_vlc_changeset );
1980 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1981 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1982 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1983 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1985 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1990 /*****************************************************************************
1991 * ShowConsole: On Win32, create an output console for debug messages
1992 *****************************************************************************
1993 * This function is useful only on Win32.
1994 *****************************************************************************/
1996 static void ShowConsole( bool b_dofile )
1999 FILE *f_help = NULL;
2001 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2004 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
2005 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
2006 * page (e.g. CP437 or CP850). */
2007 SetConsoleOutputCP (GetACP ());
2008 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
2010 freopen( "CONOUT$", "w", stderr );
2011 freopen( "CONIN$", "r", stdin );
2013 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
2016 freopen( "vlc-help.txt", "wt", stdout );
2017 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
2019 else freopen( "CONOUT$", "w", stdout );
2025 /*****************************************************************************
2026 * PauseConsole: On Win32, wait for a key press before closing the console
2027 *****************************************************************************
2028 * This function is useful only on Win32.
2029 *****************************************************************************/
2031 static void PauseConsole( void )
2035 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2037 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2045 /*****************************************************************************
2046 * ConsoleWidth: Return the console width in characters
2047 *****************************************************************************
2048 * We use the stty shell command to get the console width; if this fails or
2049 * if the width is less than 80, we default to 80.
2050 *****************************************************************************/
2051 static int ConsoleWidth( void )
2053 unsigned i_width = 80;
2056 FILE *file = popen( "stty size 2>/dev/null", "r" );
2059 if (fscanf (file, "%*u %u", &i_width) <= 0)
2063 #elif !defined (UNDER_CE)
2064 CONSOLE_SCREEN_BUFFER_INFO buf;
2066 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2067 i_width = buf.dwSize.X;
2073 #include <vlc_avcodec.h>
2075 void vlc_avcodec_mutex (bool acquire)
2077 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2080 vlc_mutex_lock (&lock);
2082 vlc_mutex_unlock (&lock);