1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 *****************************************************************************/
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
43 #include "modules/modules.h"
44 #include "config/configuration.h"
46 #include <stdio.h> /* sprintf() */
48 #include <stdlib.h> /* free() */
51 # include <netinet/in.h> /* BSD: struct in_addr */
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
60 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
61 # include "extras/getopt.h"
69 /* used for one-instance mode */
70 # include <dbus/dbus.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
85 #include "playlist/playlist_internal.h"
90 # include <libkern/OSAtomic.h>
95 /*****************************************************************************
96 * The evil global variables. We handle them with care, don't worry.
97 *****************************************************************************/
98 static unsigned i_instances = 0;
101 static bool b_daemon = false;
109 * Atomically set the reference count to 1.
110 * @param p_gc reference counted object
111 * @param pf_destruct destruction calback
114 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
116 /* There is no point in using the GC if there is no destructor... */
117 assert (pf_destruct);
118 p_gc->pf_destructor = pf_destruct;
121 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
122 __sync_synchronize ();
123 #elif defined (WIN32) && defined (__GNUC__)
124 #elif defined(__APPLE__)
127 /* Nobody else can possibly lock the spin - it's there as a barrier */
128 vlc_spin_init (&p_gc->spin);
129 vlc_spin_lock (&p_gc->spin);
130 vlc_spin_unlock (&p_gc->spin);
136 * Atomically increment the reference count.
137 * @param p_gc reference counted object
140 void *vlc_hold (gc_object_t * p_gc)
144 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
146 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
147 refs = __sync_add_and_fetch (&p_gc->refs, 1);
148 #elif defined (WIN64)
149 refs = InterlockedIncrement64 (&p_gc->refs);
150 #elif defined (WIN32)
151 refs = InterlockedIncrement (&p_gc->refs);
152 #elif defined(__APPLE__)
153 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
155 vlc_spin_lock (&p_gc->spin);
157 vlc_spin_unlock (&p_gc->spin);
159 assert (refs != 1); /* there had to be a reference already */
164 * Atomically decrement the reference count and, if it reaches zero, destroy.
165 * @param p_gc reference counted object.
167 void vlc_release (gc_object_t *p_gc)
172 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
174 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
175 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
176 #elif defined (WIN64)
177 refs = InterlockedDecrement64 (&p_gc->refs);
178 #elif defined (WIN32)
179 refs = InterlockedDecrement (&p_gc->refs);
180 #elif defined(__APPLE__)
181 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
183 vlc_spin_lock (&p_gc->spin);
185 vlc_spin_unlock (&p_gc->spin);
188 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
191 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
192 #elif defined (WIN32) && defined (__GNUC__)
193 #elif defined(__APPLE__)
195 vlc_spin_destroy (&p_gc->spin);
197 p_gc->pf_destructor (p_gc);
201 /*****************************************************************************
203 *****************************************************************************/
204 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
205 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
206 static void SetLanguage ( char const * );
208 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
209 static void Help ( libvlc_int_t *, char const *psz_help_name );
210 static void Usage ( libvlc_int_t *, char const *psz_search );
211 static void ListModules ( libvlc_int_t *, bool );
212 static void Version ( void );
215 static void ShowConsole ( bool );
216 static void PauseConsole ( void );
218 static int ConsoleWidth ( void );
220 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
223 * Allocate a libvlc instance, initialize global data if needed
224 * It also initializes the threading system
226 libvlc_int_t * libvlc_InternalCreate( void )
228 libvlc_int_t *p_libvlc;
230 char *psz_env = NULL;
232 /* Now that the thread system is initialized, we don't have much, but
233 * at least we have variables */
234 vlc_mutex_lock( &global_lock );
235 if( i_instances == 0 )
237 /* Guess what CPU we have */
238 cpu_flags = CPUCapabilities();
239 /* The module bank will be initialized later */
242 /* Allocate a libvlc instance object */
243 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
244 VLC_OBJECT_GENERIC, "libvlc" );
245 if( p_libvlc != NULL )
247 vlc_mutex_unlock( &global_lock );
249 if( p_libvlc == NULL )
252 priv = libvlc_priv (p_libvlc);
253 priv->p_playlist = NULL;
254 priv->p_dialog_provider = NULL;
257 /* Initialize message queue */
258 msg_Create( p_libvlc );
260 /* Find verbosity from VLC_VERBOSE environment variable */
261 psz_env = getenv( "VLC_VERBOSE" );
262 if( psz_env != NULL )
263 priv->i_verbose = atoi( psz_env );
266 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
267 priv->b_color = isatty( 2 ); /* 2 is for stderr */
269 priv->b_color = false;
272 /* Initialize mutexes */
273 vlc_mutex_init( &priv->timer_lock );
279 * Initialize a libvlc instance
280 * This function initializes a previously allocated libvlc instance:
282 * - gettext initialization
283 * - message queue, module bank and playlist initialization
284 * - configuration and commandline parsing
286 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
287 const char *ppsz_argv[] )
289 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
291 char * psz_modules = NULL;
292 char * psz_parser = NULL;
293 char * psz_control = NULL;
295 int i_ret = VLC_EEXIT;
296 playlist_t *p_playlist = NULL;
298 #if defined( ENABLE_NLS ) \
299 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
300 # if defined (WIN32) || defined (__APPLE__)
305 /* System specific initialization code */
306 system_Init( p_libvlc, &i_argc, ppsz_argv );
309 * Support for gettext
311 vlc_bindtextdomain (PACKAGE_NAME);
313 /* Initialize the module bank and load the configuration of the
314 * main module. We need to do this at this stage to be able to display
315 * a short help if required by the user. (short help == main module
317 module_InitBank( p_libvlc );
319 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
321 module_EndBank( p_libvlc, false );
325 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
326 /* Announce who we are - Do it only for first instance ? */
327 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
328 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
329 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
330 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
332 /* Check for short help option */
333 if( var_InheritBool( p_libvlc, "help" ) )
335 Help( p_libvlc, "help" );
337 i_ret = VLC_EEXITSUCCESS;
339 /* Check for version option */
340 else if( var_InheritBool( p_libvlc, "version" ) )
344 i_ret = VLC_EEXITSUCCESS;
347 /* Check for daemon mode */
349 if( var_InheritBool( p_libvlc, "daemon" ) )
352 char *psz_pidfile = NULL;
354 if( daemon( 1, 0) != 0 )
356 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
361 /* lets check if we need to write the pidfile */
362 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
363 if( psz_pidfile != NULL )
366 pid_t i_pid = getpid ();
367 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
368 i_pid, psz_pidfile );
369 pidfile = utf8_fopen( psz_pidfile,"w" );
370 if( pidfile != NULL )
372 utf8_fprintf( pidfile, "%d", (int)i_pid );
377 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
386 if( ( i_pid = fork() ) < 0 )
388 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
393 /* This is the parent, exit right now */
394 msg_Dbg( p_libvlc, "closing parent process" );
396 i_ret = VLC_EEXITSUCCESS;
400 /* We are the child */
401 msg_Dbg( p_libvlc, "daemon spawned" );
402 close( STDIN_FILENO );
403 close( STDOUT_FILENO );
404 close( STDERR_FILENO );
414 module_EndBank( p_libvlc, false );
418 /* Check for translation config option */
419 #if defined( ENABLE_NLS ) \
420 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
421 # if defined (WIN32) || defined (__APPLE__)
422 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
423 config_LoadConfigFile( p_libvlc, "main" );
424 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
426 /* Check if the user specified a custom language */
427 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
428 if( psz_language && strcmp( psz_language, "auto" ) )
430 /* Reset the default domain */
431 SetLanguage( psz_language );
433 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
434 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
436 free( psz_language );
441 * Load the builtins and plugins into the module_bank.
442 * We have to do it before config_Load*() because this also gets the
443 * list of configuration options exported by each module and loads their
446 module_LoadPlugins( p_libvlc );
447 if( p_libvlc->b_die )
453 module_t **list = module_list_get( &module_count );
454 module_list_free( list );
455 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
457 /* Check for help on modules */
458 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
460 Help( p_libvlc, p_tmp );
463 i_ret = VLC_EEXITSUCCESS;
465 /* Check for full help option */
466 else if( var_InheritBool( p_libvlc, "full-help" ) )
468 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
469 var_SetBool( p_libvlc, "advanced", true );
470 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
471 var_SetBool( p_libvlc, "help-verbose", true );
472 Help( p_libvlc, "full-help" );
474 i_ret = VLC_EEXITSUCCESS;
476 /* Check for long help option */
477 else if( var_InheritBool( p_libvlc, "longhelp" ) )
479 Help( p_libvlc, "longhelp" );
481 i_ret = VLC_EEXITSUCCESS;
483 /* Check for module list option */
484 else if( var_InheritBool( p_libvlc, "list" ) )
486 ListModules( p_libvlc, false );
488 i_ret = VLC_EEXITSUCCESS;
490 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
492 ListModules( p_libvlc, true );
494 i_ret = VLC_EEXITSUCCESS;
497 /* Check for config file options */
498 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
500 if( var_InheritBool( p_libvlc, "reset-config" ) )
502 config_ResetAll( p_libvlc );
503 config_SaveConfigFile( p_libvlc, NULL );
507 if( module_count <= 1)
509 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
510 "that you properly gave a module path with --plugin-path.");
517 module_EndBank( p_libvlc, true );
522 * Override default configuration with config file settings
524 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
525 config_LoadConfigFile( p_libvlc, NULL );
528 * Override configuration with command line settings
530 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
533 ShowConsole( false );
534 /* Pause the console because it's destroyed when we exit */
535 fprintf( stderr, "The command line options couldn't be loaded, check "
536 "that they are valid.\n" );
539 module_EndBank( p_libvlc, true );
542 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
545 * System specific configuration
547 system_Configure( p_libvlc, &i_argc, ppsz_argv );
549 /* FIXME: could be replaced by using Unix sockets */
551 dbus_threads_init_default();
553 if( var_InheritBool( p_libvlc, "one-instance" )
554 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
555 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
557 /* Initialise D-Bus interface, check for other instances */
558 DBusConnection *p_conn = NULL;
559 DBusError dbus_error;
561 dbus_error_init( &dbus_error );
563 /* connect to the session bus */
564 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
567 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
568 dbus_error.message );
569 dbus_error_free( &dbus_error );
573 /* check if VLC is available on the bus
574 * if not: D-Bus control is not enabled on the other
575 * instance and we can't pass MRLs to it */
576 DBusMessage *p_test_msg = NULL;
577 DBusMessage *p_test_reply = NULL;
578 p_test_msg = dbus_message_new_method_call(
579 "org.mpris.vlc", "/",
580 "org.freedesktop.MediaPlayer", "Identity" );
581 /* block until a reply arrives */
582 p_test_reply = dbus_connection_send_with_reply_and_block(
583 p_conn, p_test_msg, -1, &dbus_error );
584 dbus_message_unref( p_test_msg );
585 if( p_test_reply == NULL )
587 dbus_error_free( &dbus_error );
588 msg_Dbg( p_libvlc, "No Media Player is running. "
589 "Continuing normally." );
594 DBusMessage* p_dbus_msg = NULL;
595 DBusMessageIter dbus_args;
596 DBusPendingCall* p_dbus_pending = NULL;
599 dbus_message_unref( p_test_reply );
600 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
602 for( i_input = optind;i_input < i_argc;i_input++ )
604 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
605 ppsz_argv[i_input] );
607 p_dbus_msg = dbus_message_new_method_call(
608 "org.mpris.vlc", "/TrackList",
609 "org.freedesktop.MediaPlayer", "AddTrack" );
611 if ( NULL == p_dbus_msg )
613 msg_Err( p_libvlc, "D-Bus problem" );
614 system_End( p_libvlc );
619 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
620 if ( !dbus_message_iter_append_basic( &dbus_args,
621 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
623 dbus_message_unref( p_dbus_msg );
624 system_End( p_libvlc );
628 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
630 if ( !dbus_message_iter_append_basic( &dbus_args,
631 DBUS_TYPE_BOOLEAN, &b_play ) )
633 dbus_message_unref( p_dbus_msg );
634 system_End( p_libvlc );
638 /* send message and get a handle for a reply */
639 if ( !dbus_connection_send_with_reply ( p_conn,
640 p_dbus_msg, &p_dbus_pending, -1 ) )
642 msg_Err( p_libvlc, "D-Bus problem" );
643 dbus_message_unref( p_dbus_msg );
644 system_End( p_libvlc );
648 if ( NULL == p_dbus_pending )
650 msg_Err( p_libvlc, "D-Bus problem" );
651 dbus_message_unref( p_dbus_msg );
652 system_End( p_libvlc );
655 dbus_connection_flush( p_conn );
656 dbus_message_unref( p_dbus_msg );
657 /* block until we receive a reply */
658 dbus_pending_call_block( p_dbus_pending );
659 dbus_pending_call_unref( p_dbus_pending );
660 } /* processes all command line MRLs */
663 system_End( p_libvlc );
667 /* we unreference the connection when we've finished with it */
668 if( p_conn ) dbus_connection_unref( p_conn );
673 * Message queue options
675 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
676 if( psz_verbose_objects )
678 char * psz_object, * iter = psz_verbose_objects;
679 while( (psz_object = strsep( &iter, "," )) )
681 switch( psz_object[0] )
683 printf("%s\n", psz_object+1);
684 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
685 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
687 msg_Err( p_libvlc, "verbose-objects usage: \n"
688 "--verbose-objects=+printthatobject,"
689 "-dontprintthatone\n"
690 "(keyword 'all' to applies to all objects)");
691 free( psz_verbose_objects );
692 /* FIXME: leaks!!!! */
696 free( psz_verbose_objects );
699 /* Last chance to set the verbosity. Once we start interfaces and other
700 * threads, verbosity becomes read-only. */
701 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
702 if( var_InheritBool( p_libvlc, "quiet" ) )
704 var_SetInteger( p_libvlc, "verbose", -1 );
705 priv->i_verbose = -1;
707 vlc_threads_setup( p_libvlc );
710 priv->b_color = var_InheritBool( p_libvlc, "color" );
712 char p_capabilities[200];
713 #define PRINT_CAPABILITY( capability, string ) \
714 if( vlc_CPU() & capability ) \
716 strncat( p_capabilities, string " ", \
717 sizeof(p_capabilities) - strlen(p_capabilities) ); \
718 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
720 p_capabilities[0] = '\0';
722 #if defined( __i386__ ) || defined( __x86_64__ )
723 if( !var_InheritBool( p_libvlc, "mmx" ) )
724 cpu_flags &= ~CPU_CAPABILITY_MMX;
725 if( !var_InheritBool( p_libvlc, "3dn" ) )
726 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
727 if( !var_InheritBool( p_libvlc, "mmxext" ) )
728 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
729 if( !var_InheritBool( p_libvlc, "sse" ) )
730 cpu_flags &= ~CPU_CAPABILITY_SSE;
731 if( !var_InheritBool( p_libvlc, "sse2" ) )
732 cpu_flags &= ~CPU_CAPABILITY_SSE2;
733 if( !var_InheritBool( p_libvlc, "sse3" ) )
734 cpu_flags &= ~CPU_CAPABILITY_SSE3;
735 if( !var_InheritBool( p_libvlc, "ssse3" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
737 if( !var_InheritBool( p_libvlc, "sse41" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
739 if( !var_InheritBool( p_libvlc, "sse42" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
742 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
743 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
744 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
745 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
753 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
754 if( !var_InheritBool( p_libvlc, "altivec" ) )
755 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
757 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
759 #elif defined( __arm__ )
760 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
765 strncat( p_capabilities, "FPU ",
766 sizeof(p_capabilities) - strlen( p_capabilities) );
767 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
770 if (p_capabilities[0])
771 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
774 * Choose the best memcpy module
776 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
777 /* Avoid being called "memcpy":*/
778 vlc_object_set_name( p_libvlc, "main" );
780 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
782 priv->pp_timers = NULL;
784 priv->i_last_input_id = 0; /* Not very safe, should be removed */
787 * Initialize hotkey handling
789 vlc_InitActions( p_libvlc );
791 /* variables for signalling creation of new files */
792 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
793 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
795 /* Initialize playlist and get commandline files */
796 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
799 msg_Err( p_libvlc, "playlist initialization failed" );
800 if( priv->p_memcpy_module != NULL )
802 module_unneed( p_libvlc, priv->p_memcpy_module );
804 module_EndBank( p_libvlc, true );
807 playlist_Activate( p_playlist );
809 /* Add service discovery modules */
810 psz_modules = var_CreateGetNonEmptyString( p_playlist, "services-discovery" );
813 char *p = psz_modules, *m;
814 while( ( m = strsep( &p, " :," ) ) != NULL )
815 playlist_ServicesDiscoveryAdd( p_playlist, m );
820 /* Initialize VLM if vlm-conf is specified */
821 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
824 priv->p_vlm = vlm_New( p_libvlc );
826 msg_Err( p_libvlc, "VLM initialization failed" );
832 * Load background interfaces
834 /* Create volume callback system. (this variable must be created before
835 all interfaces as they can use it) */
836 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
837 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
839 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
840 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
842 if( psz_modules && psz_control )
845 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
848 psz_modules = psz_tmp;
851 else if( psz_control )
854 psz_modules = strdup( psz_control );
857 psz_parser = psz_modules;
858 while ( psz_parser && *psz_parser )
860 char *psz_module, *psz_temp;
861 psz_module = psz_parser;
862 psz_parser = strchr( psz_module, ':' );
868 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
870 intf_Create( p_libvlc, psz_temp );
878 * Always load the hotkeys interface if it exists
880 intf_Create( p_libvlc, "hotkeys,none" );
883 /* loads dbus control interface if in one-instance mode
884 * we do it only when playlist exists, because dbus module needs it */
885 if( var_InheritBool( p_libvlc, "one-instance" )
886 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
887 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
888 intf_Create( p_libvlc, "dbus,none" );
890 # if !defined (HAVE_MAEMO)
891 /* Prevents the power management daemon from suspending the system
892 * when VLC is active */
893 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
894 intf_Create( p_libvlc, "inhibit,none" );
898 if( var_InheritBool( p_libvlc, "file-logging" ) &&
899 !var_InheritBool( p_libvlc, "syslog" ) )
901 intf_Create( p_libvlc, "logger,none" );
904 if( var_InheritBool( p_libvlc, "syslog" ) )
906 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
907 var_SetString( p_libvlc, "logmode", "syslog" );
908 intf_Create( p_libvlc, "logger,none" );
912 var_SetString( p_libvlc, "logmode", logmode );
915 var_Destroy( p_libvlc, "logmode" );
919 if( var_InheritBool( p_libvlc, "network-synchronisation") )
921 intf_Create( p_libvlc, "netsync,none" );
925 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
927 char *psz_codecs = var_CreateGetNonEmptyString( p_playlist, "codec" );
930 char *psz_morecodecs;
931 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
933 var_SetString( p_libvlc, "codec", psz_morecodecs);
934 free( psz_morecodecs );
939 var_SetString( p_libvlc, "codec", "dmo,quicktime");
943 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
944 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
945 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
946 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
947 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
948 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
949 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
953 /* Create a variable for showing the fullscreen interface from hotkeys */
954 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
955 var_SetBool( p_libvlc, "intf-show", true );
957 /* Create a variable for showing the right click menu */
958 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
961 * Get input filenames given as commandline arguments
963 GetFilenames( p_libvlc, i_argc, ppsz_argv );
966 * Get --open argument
968 psz_val = var_CreateGetNonEmptyString( p_libvlc, "open" );
969 if ( psz_val != NULL )
971 playlist_t *p_playlist = pl_Hold( p_libvlc );
972 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
973 -1, 0, NULL, 0, true, pl_Unlocked );
974 pl_Release( p_libvlc );
982 * Cleanup a libvlc instance. The instance is not completely deallocated
983 * \param p_libvlc the instance to clean
985 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
987 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
988 playlist_t *p_playlist = priv->p_playlist;
990 /* Deactivate the playlist */
991 msg_Dbg( p_libvlc, "deactivating the playlist" );
992 playlist_Deactivate( p_playlist );
994 /* Remove all services discovery */
995 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
996 playlist_ServicesDiscoveryKillAll( p_playlist );
998 /* Ask the interfaces to stop and destroy them */
999 msg_Dbg( p_libvlc, "removing all interfaces" );
1000 libvlc_Quit( p_libvlc );
1001 intf_DestroyAll( p_libvlc );
1004 /* Destroy VLM if created in libvlc_InternalInit */
1007 vlm_Delete( priv->p_vlm );
1012 /* Any thread still running must not assume pl_Hold() succeeds. */
1013 msg_Dbg( p_libvlc, "removing playlist" );
1015 libvlc_priv(p_libvlc)->p_playlist = NULL;
1016 barrier(); /* FIXME is that correct ? */
1018 vlc_object_release( p_playlist );
1020 stats_TimersDumpAll( p_libvlc );
1021 stats_TimersCleanAll( p_libvlc );
1023 msg_Dbg( p_libvlc, "removing stats" );
1026 char* psz_pidfile = NULL;
1030 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1031 if( psz_pidfile != NULL )
1033 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1034 if( unlink( psz_pidfile ) == -1 )
1036 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1040 free( psz_pidfile );
1044 if( priv->p_memcpy_module )
1046 module_unneed( p_libvlc, priv->p_memcpy_module );
1047 priv->p_memcpy_module = NULL;
1050 /* Free module bank. It is refcounted, so we call this each time */
1051 module_EndBank( p_libvlc, true );
1053 vlc_DeinitActions( p_libvlc );
1057 * Destroy everything.
1058 * This function requests the running threads to finish, waits for their
1059 * termination, and destroys their structure.
1060 * It stops the thread systems: no instance can run after this has run
1061 * \param p_libvlc the instance to destroy
1063 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1065 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1067 vlc_mutex_lock( &global_lock );
1070 if( i_instances == 0 )
1072 /* System specific cleaning code */
1073 system_End( p_libvlc );
1075 vlc_mutex_unlock( &global_lock );
1077 msg_Destroy( p_libvlc );
1079 /* Destroy mutexes */
1080 vlc_mutex_destroy( &priv->timer_lock );
1082 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1083 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1084 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1085 vlc_object_release( p_libvlc );
1088 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1089 vlc_object_release( p_libvlc );
1093 * Add an interface plugin and run it
1095 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1098 return VLC_EGENERIC;
1100 if( !psz_module ) /* requesting the default interface */
1102 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1103 if( !psz_interface ) /* "intf" has not been set */
1107 /* Daemon mode hack.
1108 * We prefer the dummy interface if none is specified. */
1109 psz_module = "dummy";
1112 msg_Info( p_libvlc, "%s",
1113 _("Running vlc with the default interface. "
1114 "Use 'cvlc' to use vlc without interface.") );
1116 free( psz_interface );
1117 var_Destroy( p_libvlc, "intf" );
1120 /* Try to create the interface */
1121 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1123 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1124 psz_module ? psz_module : "default" );
1129 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1130 static vlc_cond_t exiting = VLC_STATIC_COND;
1132 extern vlc_mutex_t super_mutex;
1133 extern vlc_cond_t super_variable;
1134 # define exit_lock super_mutex
1135 # define exiting super_variable
1139 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1140 * when the user "exits" an interface plugin.
1142 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1144 vlc_mutex_lock( &exit_lock );
1145 while( vlc_object_alive( p_libvlc ) )
1146 vlc_cond_wait( &exiting, &exit_lock );
1147 vlc_mutex_unlock( &exit_lock );
1151 * Posts an exit signal to LibVLC instance. This will normally initiate the
1152 * cleanup and destroy process. It should only be called on behalf of the user.
1154 void libvlc_Quit( libvlc_int_t *p_libvlc )
1156 vlc_mutex_lock( &exit_lock );
1157 vlc_object_kill( p_libvlc );
1158 vlc_cond_broadcast( &exiting );
1159 vlc_mutex_unlock( &exit_lock );
1162 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1163 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1164 /*****************************************************************************
1165 * SetLanguage: set the interface language.
1166 *****************************************************************************
1167 * We set the LC_MESSAGES locale category for interface messages and buttons,
1168 * as well as the LC_CTYPE category for string sorting and possible wide
1169 * character support.
1170 *****************************************************************************/
1171 static void SetLanguage ( const char *psz_lang )
1174 /* I need that under Darwin, please check it doesn't disturb
1175 * other platforms. --Meuuh */
1176 setenv( "LANG", psz_lang, 1 );
1179 /* We set LC_ALL manually because it is the only way to set
1180 * the language at runtime under eg. Windows. Beware that this
1181 * makes the environment unconsistent when libvlc is unloaded and
1182 * should probably be moved to a safer place like vlc.c. */
1183 static char psz_lcall[20];
1184 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1185 psz_lcall[19] = '\0';
1186 putenv( psz_lcall );
1189 setlocale( LC_ALL, psz_lang );
1193 /*****************************************************************************
1194 * GetFilenames: parse command line options which are not flags
1195 *****************************************************************************
1196 * Parse command line for input files as well as their associated options.
1197 * An option always follows its associated input and begins with a ":".
1198 *****************************************************************************/
1199 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1201 int i_opt, i_options;
1203 /* We assume that the remaining parameters are filenames
1204 * and their input options */
1205 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1209 /* Count the input options */
1210 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1216 /* TODO: write an internal function of this one, to avoid
1217 * unnecessary lookups. */
1218 char *mrl = make_URI( ppsz_argv[i_opt] );
1222 playlist_t *p_playlist = pl_Hold( p_vlc );
1223 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1224 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1225 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1226 pl_Release( p_vlc );
1233 /*****************************************************************************
1234 * Help: print program help
1235 *****************************************************************************
1236 * Print a short inline help. Message interface is initialized at this stage.
1237 *****************************************************************************/
1238 static inline void print_help_on_full_help( void )
1240 utf8_fprintf( stdout, "\n" );
1241 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1244 static const char vlc_usage[] = N_(
1245 "Usage: %s [options] [stream] ..."
1246 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1247 "\nThe first item specified will be played first."
1250 "\n --option A global option that is set for the duration of the program."
1251 "\n -option A single letter version of a global --option."
1252 "\n :option An option that only applies to the stream directly before it"
1253 "\n and that overrides previous settings."
1255 "\nStream MRL syntax:"
1256 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1258 "\n Many of the global --options can also be used as MRL specific :options."
1259 "\n Multiple :option=value pairs can be specified."
1262 "\n [file://]filename Plain media file"
1263 "\n http://ip:port/file HTTP URL"
1264 "\n ftp://ip:port/file FTP URL"
1265 "\n mms://ip:port/file MMS URL"
1266 "\n screen:// Screen capture"
1267 "\n [dvd://][device][@raw_device] DVD device"
1268 "\n [vcd://][device] VCD device"
1269 "\n [cdda://][device] Audio CD device"
1270 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1271 "\n UDP stream sent by a streaming server"
1272 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1273 "\n vlc://quit Special item to quit VLC"
1276 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1279 ShowConsole( true );
1282 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1284 utf8_fprintf( stdout, vlc_usage, "vlc" );
1285 Usage( p_this, "=help" );
1286 Usage( p_this, "=main" );
1287 print_help_on_full_help();
1289 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1291 utf8_fprintf( stdout, vlc_usage, "vlc" );
1292 Usage( p_this, NULL );
1293 print_help_on_full_help();
1295 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1297 utf8_fprintf( stdout, vlc_usage, "vlc" );
1298 Usage( p_this, NULL );
1300 else if( psz_help_name )
1302 Usage( p_this, psz_help_name );
1305 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1310 /*****************************************************************************
1311 * Usage: print module usage
1312 *****************************************************************************
1313 * Print a short inline help. Message interface is initialized at this stage.
1314 *****************************************************************************/
1315 # define COL(x) "\033[" #x ";1m"
1316 # define RED COL(31)
1317 # define GREEN COL(32)
1318 # define YELLOW COL(33)
1319 # define BLUE COL(34)
1320 # define MAGENTA COL(35)
1321 # define CYAN COL(36)
1322 # define WHITE COL(0)
1323 # define GRAY "\033[0m"
1325 print_help_section( const module_t *m, const module_config_t *p_item,
1326 bool b_color, bool b_description )
1328 if( !p_item ) return;
1331 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1332 module_gettext( m, p_item->psz_text ) );
1333 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1334 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1335 module_gettext( m, p_item->psz_longtext ) );
1339 utf8_fprintf( stdout, " %s:\n",
1340 module_gettext( m, p_item->psz_text ) );
1341 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1342 utf8_fprintf( stdout, " %s\n",
1343 module_gettext(m, p_item->psz_longtext ) );
1347 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1349 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1350 /* short option ------' | | | | | | |
1351 * option name ------------' | | | | | |
1352 * <bra ---------------------' | | | | |
1353 * option type or "" ----------' | | | |
1354 * ket> -------------------------' | | |
1355 * padding spaces -----------------' | |
1356 * comment --------------------------' |
1357 * comment suffix ---------------------'
1359 * The purpose of having bra and ket is that we might i18n them as well.
1362 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1363 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1365 #define LINE_START 8
1366 #define PADDING_SPACES 25
1368 # define OPTION_VALUE_SEP "="
1370 # define OPTION_VALUE_SEP " "
1372 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1373 char psz_spaces_longtext[LINE_START+3];
1374 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1375 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1376 char psz_buffer[10000];
1378 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1379 int i_width_description = i_width + PADDING_SPACES - 1;
1380 bool b_advanced = var_InheritBool( p_this, "advanced" );
1381 bool b_description = var_InheritBool( p_this, "help-verbose" );
1382 bool b_description_hack;
1383 bool b_color = var_InheritBool( p_this, "color" );
1384 bool b_has_advanced = false;
1385 bool b_found = false;
1386 int i_only_advanced = 0; /* Number of modules ignored because they
1387 * only have advanced options */
1388 bool b_strict = psz_search && *psz_search == '=';
1389 if( b_strict ) psz_search++;
1391 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1392 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1393 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1394 psz_spaces_longtext[LINE_START+2] = '\0';
1398 b_color = false; // don't put color control codes in a .txt file
1402 strcpy( psz_format, COLOR_FORMAT_STRING );
1403 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1407 strcpy( psz_format, FORMAT_STRING );
1408 strcpy( psz_format_bool, FORMAT_STRING );
1411 /* List all modules */
1412 module_t **list = module_list_get (NULL);
1416 /* Ugly hack to make sure that the help options always come first
1419 Usage( p_this, "help" );
1421 /* Enumerate the config for each module */
1422 for (size_t i = 0; list[i]; i++)
1425 module_t *p_parser = list[i];
1426 module_config_t *p_item = NULL;
1427 module_config_t *p_section = NULL;
1428 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1431 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1432 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1434 char *const *pp_shortcut = p_parser->pp_shortcuts;
1435 while( *pp_shortcut )
1437 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1438 : !!strstr( *pp_shortcut, psz_search ) )
1446 /* Ignore modules without config options */
1447 if( !p_parser->i_config_items )
1452 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1453 /* Ugly hack to make sure that the help options always come first
1455 if( !psz_search && b_help_module )
1458 /* Ignore modules with only advanced config options if requested */
1461 for( p_item = p_parser->p_config;
1465 if( (p_item->i_type & CONFIG_ITEM) &&
1466 !p_item->b_advanced && !p_item->b_removed ) break;
1469 if( p_item == p_end )
1478 /* Print name of module */
1479 if( strcmp( "main", p_parser->psz_object_name ) )
1482 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1483 module_gettext( p_parser, p_parser->psz_longname ),
1484 p_parser->psz_object_name );
1486 utf8_fprintf( stdout, "\n %s\n",
1487 module_gettext(p_parser, p_parser->psz_longname ) );
1489 if( p_parser->psz_help )
1492 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1493 module_gettext( p_parser, p_parser->psz_help ) );
1495 utf8_fprintf( stdout, " %s\n",
1496 module_gettext( p_parser, p_parser->psz_help ) );
1499 /* Print module options */
1500 for( p_item = p_parser->p_config;
1504 char *psz_text, *psz_spaces = psz_spaces_text;
1505 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1506 const char *psz_suf = "", *psz_prefix = NULL;
1510 /* Skip removed options */
1511 if( p_item->b_removed )
1515 /* Skip advanced options if requested */
1516 if( p_item->b_advanced && !b_advanced )
1518 b_has_advanced = true;
1522 switch( p_item->i_type )
1524 case CONFIG_HINT_CATEGORY:
1525 case CONFIG_HINT_USAGE:
1526 if( !strcmp( "main", p_parser->psz_object_name ) )
1529 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1530 module_gettext( p_parser, p_item->psz_text ) );
1532 utf8_fprintf( stdout, "\n %s\n",
1533 module_gettext( p_parser, p_item->psz_text ) );
1535 if( b_description && p_item->psz_longtext
1536 && *p_item->psz_longtext )
1539 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1540 module_gettext( p_parser, p_item->psz_longtext ) );
1542 utf8_fprintf( stdout, " %s\n",
1543 module_gettext( p_parser, p_item->psz_longtext ) );
1547 case CONFIG_HINT_SUBCATEGORY:
1548 if( strcmp( "main", p_parser->psz_object_name ) )
1550 case CONFIG_SECTION:
1554 case CONFIG_ITEM_STRING:
1555 case CONFIG_ITEM_FILE:
1556 case CONFIG_ITEM_DIRECTORY:
1557 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1558 case CONFIG_ITEM_MODULE_CAT:
1559 case CONFIG_ITEM_MODULE_LIST:
1560 case CONFIG_ITEM_MODULE_LIST_CAT:
1561 case CONFIG_ITEM_FONT:
1562 case CONFIG_ITEM_PASSWORD:
1563 print_help_section( p_parser, p_section, b_color,
1566 psz_bra = OPTION_VALUE_SEP "<";
1567 psz_type = _("string");
1570 if( p_item->ppsz_list )
1572 psz_bra = OPTION_VALUE_SEP "{";
1573 psz_type = psz_buffer;
1574 psz_buffer[0] = '\0';
1575 for( i = 0; p_item->ppsz_list[i]; i++ )
1577 if( i ) strcat( psz_buffer, "," );
1578 strcat( psz_buffer, p_item->ppsz_list[i] );
1583 case CONFIG_ITEM_INTEGER:
1584 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1585 print_help_section( p_parser, p_section, b_color,
1588 psz_bra = OPTION_VALUE_SEP "<";
1589 psz_type = _("integer");
1592 if( p_item->min.i || p_item->max.i )
1594 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1595 p_item->min.i, p_item->max.i );
1596 psz_type = psz_buffer;
1599 if( p_item->i_list )
1601 psz_bra = OPTION_VALUE_SEP "{";
1602 psz_type = psz_buffer;
1603 psz_buffer[0] = '\0';
1604 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1606 if( i ) strcat( psz_buffer, ", " );
1607 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1609 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1614 case CONFIG_ITEM_FLOAT:
1615 print_help_section( p_parser, p_section, b_color,
1618 psz_bra = OPTION_VALUE_SEP "<";
1619 psz_type = _("float");
1621 if( p_item->min.f || p_item->max.f )
1623 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1624 p_item->min.f, p_item->max.f );
1625 psz_type = psz_buffer;
1628 case CONFIG_ITEM_BOOL:
1629 print_help_section( p_parser, p_section, b_color,
1632 psz_bra = ""; psz_type = ""; psz_ket = "";
1633 if( !b_help_module )
1635 psz_suf = p_item->value.i ? _(" (default enabled)") :
1636 _(" (default disabled)");
1646 /* Add short option if any */
1647 if( p_item->i_short )
1649 sprintf( psz_short, "-%c,", p_item->i_short );
1653 strcpy( psz_short, " " );
1656 i = PADDING_SPACES - strlen( p_item->psz_name )
1657 - strlen( psz_bra ) - strlen( psz_type )
1658 - strlen( psz_ket ) - 1;
1660 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1662 psz_prefix = ", --no-";
1663 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1668 psz_spaces[0] = '\n';
1673 psz_spaces[i] = '\0';
1676 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1678 utf8_fprintf( stdout, psz_format_bool, psz_short,
1679 p_item->psz_name, psz_prefix, p_item->psz_name,
1680 psz_bra, psz_type, psz_ket, psz_spaces );
1684 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1685 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1688 psz_spaces[i] = ' ';
1690 /* We wrap the rest of the output */
1691 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1693 b_description_hack = b_description;
1696 psz_text = psz_buffer;
1697 i_cur_width = b_description && !b_description_hack
1698 ? i_width_description
1702 char *psz_parser, *psz_word;
1703 size_t i_end = strlen( psz_text );
1705 /* If the remaining text fits in a line, print it. */
1706 if( i_end <= i_cur_width )
1710 if( !b_description || b_description_hack )
1711 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1713 utf8_fprintf( stdout, "%s\n", psz_text );
1717 utf8_fprintf( stdout, "%s\n", psz_text );
1722 /* Otherwise, eat as many words as possible */
1723 psz_parser = psz_text;
1726 psz_word = psz_parser;
1727 psz_parser = strchr( psz_word, ' ' );
1728 /* If no space was found, we reached the end of the text
1729 * block; otherwise, we skip the space we just found. */
1730 psz_parser = psz_parser ? psz_parser + 1
1733 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1735 /* We cut a word in one of these cases:
1736 * - it's the only word in the line and it's too long.
1737 * - we used less than 80% of the width and the word we are
1738 * going to wrap is longer than 40% of the width, and even
1739 * if the word would have fit in the next line. */
1740 if( psz_word == psz_text
1741 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1742 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1744 char c = psz_text[i_cur_width];
1745 psz_text[i_cur_width] = '\0';
1748 if( !b_description || b_description_hack )
1749 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1750 psz_text, psz_spaces );
1752 utf8_fprintf( stdout, "%s\n%s",
1753 psz_text, psz_spaces );
1757 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1759 psz_text += i_cur_width;
1764 psz_word[-1] = '\0';
1767 if( !b_description || b_description_hack )
1768 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1769 psz_text, psz_spaces );
1771 utf8_fprintf( stdout, "%s\n%s",
1772 psz_text, psz_spaces );
1776 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1778 psz_text = psz_word;
1782 if( b_description_hack && p_item->psz_longtext
1783 && *p_item->psz_longtext )
1785 sprintf( psz_buffer, "%s%s",
1786 module_gettext( p_parser, p_item->psz_longtext ),
1788 b_description_hack = false;
1789 psz_spaces = psz_spaces_longtext;
1790 utf8_fprintf( stdout, "%s", psz_spaces );
1796 if( b_has_advanced )
1799 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1800 _( "add --advanced to your command line to see advanced options."));
1802 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1803 _( "add --advanced to your command line to see advanced options."));
1806 if( i_only_advanced > 0 )
1810 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1811 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1815 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1816 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1822 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1823 _( "No matching module found. Use --list or " \
1824 "--list-verbose to list available modules." ) );
1826 utf8_fprintf( stdout, "\n%s\n",
1827 _( "No matching module found. Use --list or " \
1828 "--list-verbose to list available modules." ) );
1831 /* Release the module list */
1832 module_list_free (list);
1835 /*****************************************************************************
1836 * ListModules: list the available modules with their description
1837 *****************************************************************************
1838 * Print a list of all available modules (builtins and plugins) and a short
1839 * description for each one.
1840 *****************************************************************************/
1841 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1845 bool b_color = var_InheritBool( p_this, "color" );
1848 ShowConsole( true );
1849 b_color = false; // don't put color control codes in a .txt file
1855 /* List all modules */
1856 module_t **list = module_list_get (NULL);
1858 /* Enumerate each module */
1859 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1862 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1863 p_parser->psz_object_name,
1864 module_gettext( p_parser, p_parser->psz_longname ) );
1866 utf8_fprintf( stdout, " %-22s %s\n",
1867 p_parser->psz_object_name,
1868 module_gettext( p_parser, p_parser->psz_longname ) );
1872 char *const *pp_shortcut = p_parser->pp_shortcuts;
1873 while( *pp_shortcut )
1875 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1878 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1881 utf8_fprintf( stdout, " s %s\n",
1886 if( p_parser->psz_capability )
1889 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1890 p_parser->psz_capability,
1891 p_parser->i_score );
1893 utf8_fprintf( stdout, " c %s (%d)\n",
1894 p_parser->psz_capability,
1895 p_parser->i_score );
1899 module_list_free (list);
1901 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1906 /*****************************************************************************
1907 * Version: print complete program version
1908 *****************************************************************************
1909 * Print complete program version and build number.
1910 *****************************************************************************/
1911 static void Version( void )
1913 extern const char psz_vlc_changeset[];
1915 ShowConsole( true );
1918 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1919 psz_vlc_changeset );
1920 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1921 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1922 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1923 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1925 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1930 /*****************************************************************************
1931 * ShowConsole: On Win32, create an output console for debug messages
1932 *****************************************************************************
1933 * This function is useful only on Win32.
1934 *****************************************************************************/
1936 static void ShowConsole( bool b_dofile )
1939 FILE *f_help = NULL;
1941 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1944 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1945 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1946 * page (e.g. CP437 or CP850). */
1947 SetConsoleOutputCP (GetACP ());
1948 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1950 freopen( "CONOUT$", "w", stderr );
1951 freopen( "CONIN$", "r", stdin );
1953 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1956 freopen( "vlc-help.txt", "wt", stdout );
1957 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1959 else freopen( "CONOUT$", "w", stdout );
1965 /*****************************************************************************
1966 * PauseConsole: On Win32, wait for a key press before closing the console
1967 *****************************************************************************
1968 * This function is useful only on Win32.
1969 *****************************************************************************/
1971 static void PauseConsole( void )
1975 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1977 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1985 /*****************************************************************************
1986 * ConsoleWidth: Return the console width in characters
1987 *****************************************************************************
1988 * We use the stty shell command to get the console width; if this fails or
1989 * if the width is less than 80, we default to 80.
1990 *****************************************************************************/
1991 static int ConsoleWidth( void )
1993 unsigned i_width = 80;
1996 FILE *file = popen( "stty size 2>/dev/null", "r" );
1999 if (fscanf (file, "%*u %u", &i_width) <= 0)
2003 #elif !defined (UNDER_CE)
2004 CONSOLE_SCREEN_BUFFER_INFO buf;
2006 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2007 i_width = buf.dwSize.X;
2013 #include <vlc_avcodec.h>
2015 void vlc_avcodec_mutex (bool acquire)
2017 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2020 vlc_mutex_lock (&lock);
2022 vlc_mutex_unlock (&lock);