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( (vlc_object_t *)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 priv->msg_bank = msg_Create ();
259 if (unlikely(priv->msg_bank == NULL))
262 /* Find verbosity from VLC_VERBOSE environment variable */
263 psz_env = getenv( "VLC_VERBOSE" );
264 if( psz_env != NULL )
265 priv->i_verbose = atoi( psz_env );
268 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
269 priv->b_color = isatty( 2 ); /* 2 is for stderr */
271 priv->b_color = false;
274 /* Initialize mutexes */
275 vlc_mutex_init( &priv->timer_lock );
279 vlc_object_release (p_libvlc);
284 * Initialize a libvlc instance
285 * This function initializes a previously allocated libvlc instance:
287 * - gettext initialization
288 * - message queue, module bank and playlist initialization
289 * - configuration and commandline parsing
291 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
292 const char *ppsz_argv[] )
294 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
296 char * psz_modules = NULL;
297 char * psz_parser = NULL;
298 char * psz_control = NULL;
300 int i_ret = VLC_EEXIT;
301 playlist_t *p_playlist = NULL;
303 #if defined( ENABLE_NLS ) \
304 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
305 # if defined (WIN32) || defined (__APPLE__)
310 /* System specific initialization code */
311 system_Init( p_libvlc, &i_argc, ppsz_argv );
314 * Support for gettext
316 vlc_bindtextdomain (PACKAGE_NAME);
318 /* Initialize the module bank and load the configuration of the
319 * main module. We need to do this at this stage to be able to display
320 * a short help if required by the user. (short help == main module
322 module_InitBank( p_libvlc );
324 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
326 module_EndBank( p_libvlc, false );
330 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
331 /* Announce who we are - Do it only for first instance ? */
332 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
333 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
334 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
335 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
337 /* Check for short help option */
338 if( var_InheritBool( p_libvlc, "help" ) )
340 Help( p_libvlc, "help" );
342 i_ret = VLC_EEXITSUCCESS;
344 /* Check for version option */
345 else if( var_InheritBool( p_libvlc, "version" ) )
349 i_ret = VLC_EEXITSUCCESS;
352 /* Check for daemon mode */
354 if( var_InheritBool( p_libvlc, "daemon" ) )
357 char *psz_pidfile = NULL;
359 if( daemon( 1, 0) != 0 )
361 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
366 /* lets check if we need to write the pidfile */
367 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
368 if( psz_pidfile != NULL )
371 pid_t i_pid = getpid ();
372 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
373 i_pid, psz_pidfile );
374 pidfile = utf8_fopen( psz_pidfile,"w" );
375 if( pidfile != NULL )
377 utf8_fprintf( pidfile, "%d", (int)i_pid );
382 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
391 if( ( i_pid = fork() ) < 0 )
393 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
398 /* This is the parent, exit right now */
399 msg_Dbg( p_libvlc, "closing parent process" );
401 i_ret = VLC_EEXITSUCCESS;
405 /* We are the child */
406 msg_Dbg( p_libvlc, "daemon spawned" );
407 close( STDIN_FILENO );
408 close( STDOUT_FILENO );
409 close( STDERR_FILENO );
419 module_EndBank( p_libvlc, false );
423 /* Check for translation config option */
424 #if defined( ENABLE_NLS ) \
425 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
426 # if defined (WIN32) || defined (__APPLE__)
427 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
428 config_LoadConfigFile( p_libvlc, "main" );
429 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
431 /* Check if the user specified a custom language */
432 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
433 if( psz_language && strcmp( psz_language, "auto" ) )
435 /* Reset the default domain */
436 SetLanguage( psz_language );
438 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
439 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
441 free( psz_language );
446 * Load the builtins and plugins into the module_bank.
447 * We have to do it before config_Load*() because this also gets the
448 * list of configuration options exported by each module and loads their
451 module_LoadPlugins( p_libvlc );
452 if( p_libvlc->b_die )
458 module_t **list = module_list_get( &module_count );
459 module_list_free( list );
460 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
462 /* Check for help on modules */
463 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
465 Help( p_libvlc, p_tmp );
468 i_ret = VLC_EEXITSUCCESS;
470 /* Check for full help option */
471 else if( var_InheritBool( p_libvlc, "full-help" ) )
473 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
474 var_SetBool( p_libvlc, "advanced", true );
475 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
476 var_SetBool( p_libvlc, "help-verbose", true );
477 Help( p_libvlc, "full-help" );
479 i_ret = VLC_EEXITSUCCESS;
481 /* Check for long help option */
482 else if( var_InheritBool( p_libvlc, "longhelp" ) )
484 Help( p_libvlc, "longhelp" );
486 i_ret = VLC_EEXITSUCCESS;
488 /* Check for module list option */
489 else if( var_InheritBool( p_libvlc, "list" ) )
491 ListModules( p_libvlc, false );
493 i_ret = VLC_EEXITSUCCESS;
495 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
497 ListModules( p_libvlc, true );
499 i_ret = VLC_EEXITSUCCESS;
502 /* Check for config file options */
503 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
505 if( var_InheritBool( p_libvlc, "reset-config" ) )
507 config_ResetAll( p_libvlc );
508 config_SaveConfigFile( p_libvlc, NULL );
512 if( module_count <= 1)
514 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
515 "that you properly gave a module path with --plugin-path.");
522 module_EndBank( p_libvlc, true );
527 * Override default configuration with config file settings
529 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
530 config_LoadConfigFile( p_libvlc, NULL );
533 * Override configuration with command line settings
535 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
538 ShowConsole( false );
539 /* Pause the console because it's destroyed when we exit */
540 fprintf( stderr, "The command line options couldn't be loaded, check "
541 "that they are valid.\n" );
544 module_EndBank( p_libvlc, true );
547 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
550 * System specific configuration
552 system_Configure( p_libvlc, &i_argc, ppsz_argv );
554 /* FIXME: could be replaced by using Unix sockets */
556 dbus_threads_init_default();
558 if( var_InheritBool( p_libvlc, "one-instance" )
559 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
560 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
562 /* Initialise D-Bus interface, check for other instances */
563 DBusConnection *p_conn = NULL;
564 DBusError dbus_error;
566 dbus_error_init( &dbus_error );
568 /* connect to the session bus */
569 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
572 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
573 dbus_error.message );
574 dbus_error_free( &dbus_error );
578 /* check if VLC is available on the bus
579 * if not: D-Bus control is not enabled on the other
580 * instance and we can't pass MRLs to it */
581 DBusMessage *p_test_msg = NULL;
582 DBusMessage *p_test_reply = NULL;
583 p_test_msg = dbus_message_new_method_call(
584 "org.mpris.vlc", "/",
585 "org.freedesktop.MediaPlayer", "Identity" );
586 /* block until a reply arrives */
587 p_test_reply = dbus_connection_send_with_reply_and_block(
588 p_conn, p_test_msg, -1, &dbus_error );
589 dbus_message_unref( p_test_msg );
590 if( p_test_reply == NULL )
592 dbus_error_free( &dbus_error );
593 msg_Dbg( p_libvlc, "No Media Player is running. "
594 "Continuing normally." );
599 DBusMessage* p_dbus_msg = NULL;
600 DBusMessageIter dbus_args;
601 DBusPendingCall* p_dbus_pending = NULL;
604 dbus_message_unref( p_test_reply );
605 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
607 for( i_input = optind;i_input < i_argc;i_input++ )
609 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
610 ppsz_argv[i_input] );
612 p_dbus_msg = dbus_message_new_method_call(
613 "org.mpris.vlc", "/TrackList",
614 "org.freedesktop.MediaPlayer", "AddTrack" );
616 if ( NULL == p_dbus_msg )
618 msg_Err( p_libvlc, "D-Bus problem" );
619 system_End( p_libvlc );
624 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
625 if ( !dbus_message_iter_append_basic( &dbus_args,
626 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
628 dbus_message_unref( p_dbus_msg );
629 system_End( p_libvlc );
633 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
635 if ( !dbus_message_iter_append_basic( &dbus_args,
636 DBUS_TYPE_BOOLEAN, &b_play ) )
638 dbus_message_unref( p_dbus_msg );
639 system_End( p_libvlc );
643 /* send message and get a handle for a reply */
644 if ( !dbus_connection_send_with_reply ( p_conn,
645 p_dbus_msg, &p_dbus_pending, -1 ) )
647 msg_Err( p_libvlc, "D-Bus problem" );
648 dbus_message_unref( p_dbus_msg );
649 system_End( p_libvlc );
653 if ( NULL == p_dbus_pending )
655 msg_Err( p_libvlc, "D-Bus problem" );
656 dbus_message_unref( p_dbus_msg );
657 system_End( p_libvlc );
660 dbus_connection_flush( p_conn );
661 dbus_message_unref( p_dbus_msg );
662 /* block until we receive a reply */
663 dbus_pending_call_block( p_dbus_pending );
664 dbus_pending_call_unref( p_dbus_pending );
665 } /* processes all command line MRLs */
668 system_End( p_libvlc );
672 /* we unreference the connection when we've finished with it */
673 if( p_conn ) dbus_connection_unref( p_conn );
678 * Message queue options
680 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
681 if( psz_verbose_objects )
683 char * psz_object, * iter = psz_verbose_objects;
684 while( (psz_object = strsep( &iter, "," )) )
686 switch( psz_object[0] )
688 printf("%s\n", psz_object+1);
689 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
690 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
692 msg_Err( p_libvlc, "verbose-objects usage: \n"
693 "--verbose-objects=+printthatobject,"
694 "-dontprintthatone\n"
695 "(keyword 'all' to applies to all objects)");
696 free( psz_verbose_objects );
697 /* FIXME: leaks!!!! */
701 free( psz_verbose_objects );
704 /* Last chance to set the verbosity. Once we start interfaces and other
705 * threads, verbosity becomes read-only. */
706 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
707 if( var_InheritBool( p_libvlc, "quiet" ) )
709 var_SetInteger( p_libvlc, "verbose", -1 );
710 priv->i_verbose = -1;
712 vlc_threads_setup( p_libvlc );
715 priv->b_color = var_InheritBool( p_libvlc, "color" );
717 char p_capabilities[200];
718 #define PRINT_CAPABILITY( capability, string ) \
719 if( vlc_CPU() & capability ) \
721 strncat( p_capabilities, string " ", \
722 sizeof(p_capabilities) - strlen(p_capabilities) ); \
723 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
725 p_capabilities[0] = '\0';
727 #if defined( __i386__ ) || defined( __x86_64__ )
728 if( !var_InheritBool( p_libvlc, "mmx" ) )
729 cpu_flags &= ~CPU_CAPABILITY_MMX;
730 if( !var_InheritBool( p_libvlc, "3dn" ) )
731 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
732 if( !var_InheritBool( p_libvlc, "mmxext" ) )
733 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
734 if( !var_InheritBool( p_libvlc, "sse" ) )
735 cpu_flags &= ~CPU_CAPABILITY_SSE;
736 if( !var_InheritBool( p_libvlc, "sse2" ) )
737 cpu_flags &= ~CPU_CAPABILITY_SSE2;
738 if( !var_InheritBool( p_libvlc, "sse3" ) )
739 cpu_flags &= ~CPU_CAPABILITY_SSE3;
740 if( !var_InheritBool( p_libvlc, "ssse3" ) )
741 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
742 if( !var_InheritBool( p_libvlc, "sse41" ) )
743 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
744 if( !var_InheritBool( p_libvlc, "sse42" ) )
745 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
747 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
755 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
756 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
758 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
759 if( !var_InheritBool( p_libvlc, "altivec" ) )
760 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
762 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
764 #elif defined( __arm__ )
765 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
770 strncat( p_capabilities, "FPU ",
771 sizeof(p_capabilities) - strlen( p_capabilities) );
772 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
775 if (p_capabilities[0])
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 = var_InheritBool( p_libvlc, "stats" );
787 priv->pp_timers = NULL;
789 priv->i_last_input_id = 0; /* Not very safe, should be removed */
792 * Initialize hotkey handling
794 vlc_InitActions( p_libvlc );
796 /* variables for signalling creation of new files */
797 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
798 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
800 /* Initialize playlist and get commandline files */
801 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
804 msg_Err( p_libvlc, "playlist initialization failed" );
805 if( priv->p_memcpy_module != NULL )
807 module_unneed( p_libvlc, priv->p_memcpy_module );
809 module_EndBank( p_libvlc, true );
813 /* Add service discovery modules */
814 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
817 char *p = psz_modules, *m;
818 playlist_t *p_playlist = pl_Hold( p_libvlc );
819 while( ( m = strsep( &p, " :," ) ) != NULL )
820 playlist_ServicesDiscoveryAdd( p_playlist, m );
822 pl_Release (p_libvlc);
826 /* Initialize VLM if vlm-conf is specified */
827 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
830 priv->p_vlm = vlm_New( p_libvlc );
832 msg_Err( p_libvlc, "VLM initialization failed" );
838 * Load background interfaces
840 /* Create volume callback system. (this variable must be created before
841 all interfaces as they can use it) */
842 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
843 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
845 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
846 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
848 if( psz_modules && psz_control )
851 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
854 psz_modules = psz_tmp;
857 else if( psz_control )
860 psz_modules = strdup( psz_control );
863 psz_parser = psz_modules;
864 while ( psz_parser && *psz_parser )
866 char *psz_module, *psz_temp;
867 psz_module = psz_parser;
868 psz_parser = strchr( psz_module, ':' );
874 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
876 intf_Create( p_libvlc, psz_temp );
884 * Always load the hotkeys interface if it exists
886 intf_Create( p_libvlc, "hotkeys,none" );
889 /* loads dbus control interface if in one-instance mode
890 * we do it only when playlist exists, because dbus module needs it */
891 if( var_InheritBool( p_libvlc, "one-instance" )
892 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
893 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
894 intf_Create( p_libvlc, "dbus,none" );
896 # if !defined (HAVE_MAEMO)
897 /* Prevents the power management daemon from suspending the system
898 * when VLC is active */
899 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
900 intf_Create( p_libvlc, "inhibit,none" );
904 if( var_InheritBool( p_libvlc, "file-logging" ) &&
905 !var_InheritBool( p_libvlc, "syslog" ) )
907 intf_Create( p_libvlc, "logger,none" );
910 if( var_InheritBool( p_libvlc, "syslog" ) )
912 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
913 var_SetString( p_libvlc, "logmode", "syslog" );
914 intf_Create( p_libvlc, "logger,none" );
918 var_SetString( p_libvlc, "logmode", logmode );
921 var_Destroy( p_libvlc, "logmode" );
925 if( var_InheritBool( p_libvlc, "network-synchronisation") )
927 intf_Create( p_libvlc, "netsync,none" );
931 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
933 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
936 char *psz_morecodecs;
937 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
939 var_SetString( p_libvlc, "codec", psz_morecodecs);
940 free( psz_morecodecs );
945 var_SetString( p_libvlc, "codec", "dmo,quicktime");
949 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
953 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
954 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
956 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
959 /* Create a variable for showing the fullscreen interface from hotkeys */
960 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
961 var_SetBool( p_libvlc, "intf-show", true );
963 /* Create a variable for showing the right click menu */
964 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
967 * Get input filenames given as commandline arguments
969 GetFilenames( p_libvlc, i_argc, ppsz_argv );
972 * Get --open argument
974 psz_val = var_InheritString( p_libvlc, "open" );
975 if ( psz_val != NULL )
977 playlist_t *p_playlist = pl_Hold( p_libvlc );
978 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
979 -1, 0, NULL, 0, true, pl_Unlocked );
980 pl_Release( p_libvlc );
988 * Cleanup a libvlc instance. The instance is not completely deallocated
989 * \param p_libvlc the instance to clean
991 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
993 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
994 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
996 /* Deactivate the playlist */
997 msg_Dbg( p_libvlc, "deactivating the playlist" );
998 pl_Deactivate( p_libvlc );
1000 /* Remove all services discovery */
1001 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1002 playlist_ServicesDiscoveryKillAll( p_playlist );
1004 /* Ask the interfaces to stop and destroy them */
1005 msg_Dbg( p_libvlc, "removing all interfaces" );
1006 libvlc_Quit( p_libvlc );
1007 intf_DestroyAll( p_libvlc );
1010 /* Destroy VLM if created in libvlc_InternalInit */
1013 vlm_Delete( priv->p_vlm );
1017 /* Free playlist now */
1018 msg_Dbg( p_libvlc, "removing playlist" );
1019 vlc_object_release( p_playlist );
1021 stats_TimersDumpAll( p_libvlc );
1022 stats_TimersCleanAll( p_libvlc );
1024 msg_Dbg( p_libvlc, "removing stats" );
1027 char* psz_pidfile = NULL;
1031 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1032 if( psz_pidfile != NULL )
1034 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1035 if( unlink( psz_pidfile ) == -1 )
1037 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1041 free( psz_pidfile );
1045 if( priv->p_memcpy_module )
1047 module_unneed( p_libvlc, priv->p_memcpy_module );
1048 priv->p_memcpy_module = NULL;
1051 /* Free module bank. It is refcounted, so we call this each time */
1052 module_EndBank( p_libvlc, true );
1054 vlc_DeinitActions( p_libvlc );
1058 * Destroy everything.
1059 * This function requests the running threads to finish, waits for their
1060 * termination, and destroys their structure.
1061 * It stops the thread systems: no instance can run after this has run
1062 * \param p_libvlc the instance to destroy
1064 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1066 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1068 vlc_mutex_lock( &global_lock );
1071 if( i_instances == 0 )
1073 /* System specific cleaning code */
1074 system_End( p_libvlc );
1076 vlc_mutex_unlock( &global_lock );
1078 msg_Destroy (priv->msg_bank);
1080 /* Destroy mutexes */
1081 vlc_mutex_destroy( &priv->timer_lock );
1083 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1084 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1085 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1086 vlc_object_release( p_libvlc );
1089 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1090 vlc_object_release( p_libvlc );
1094 * Add an interface plugin and run it
1096 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1099 return VLC_EGENERIC;
1101 if( !psz_module ) /* requesting the default interface */
1103 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1104 if( !psz_interface ) /* "intf" has not been set */
1108 /* Daemon mode hack.
1109 * We prefer the dummy interface if none is specified. */
1110 psz_module = "dummy";
1113 msg_Info( p_libvlc, "%s",
1114 _("Running vlc with the default interface. "
1115 "Use 'cvlc' to use vlc without interface.") );
1117 free( psz_interface );
1118 var_Destroy( p_libvlc, "intf" );
1121 /* Try to create the interface */
1122 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1124 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1125 psz_module ? psz_module : "default" );
1130 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1131 static vlc_cond_t exiting = VLC_STATIC_COND;
1133 extern vlc_mutex_t super_mutex;
1134 extern vlc_cond_t super_variable;
1135 # define exit_lock super_mutex
1136 # define exiting super_variable
1140 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1141 * when the user "exits" an interface plugin.
1143 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1145 vlc_mutex_lock( &exit_lock );
1146 while( vlc_object_alive( p_libvlc ) )
1147 vlc_cond_wait( &exiting, &exit_lock );
1148 vlc_mutex_unlock( &exit_lock );
1152 * Posts an exit signal to LibVLC instance. This will normally initiate the
1153 * cleanup and destroy process. It should only be called on behalf of the user.
1155 void libvlc_Quit( libvlc_int_t *p_libvlc )
1157 vlc_mutex_lock( &exit_lock );
1158 vlc_object_kill( p_libvlc );
1159 vlc_cond_broadcast( &exiting );
1160 vlc_mutex_unlock( &exit_lock );
1163 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1164 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1165 /*****************************************************************************
1166 * SetLanguage: set the interface language.
1167 *****************************************************************************
1168 * We set the LC_MESSAGES locale category for interface messages and buttons,
1169 * as well as the LC_CTYPE category for string sorting and possible wide
1170 * character support.
1171 *****************************************************************************/
1172 static void SetLanguage ( const char *psz_lang )
1175 /* I need that under Darwin, please check it doesn't disturb
1176 * other platforms. --Meuuh */
1177 setenv( "LANG", psz_lang, 1 );
1180 /* We set LC_ALL manually because it is the only way to set
1181 * the language at runtime under eg. Windows. Beware that this
1182 * makes the environment unconsistent when libvlc is unloaded and
1183 * should probably be moved to a safer place like vlc.c. */
1184 static char psz_lcall[20];
1185 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1186 psz_lcall[19] = '\0';
1187 putenv( psz_lcall );
1190 setlocale( LC_ALL, psz_lang );
1194 /*****************************************************************************
1195 * GetFilenames: parse command line options which are not flags
1196 *****************************************************************************
1197 * Parse command line for input files as well as their associated options.
1198 * An option always follows its associated input and begins with a ":".
1199 *****************************************************************************/
1200 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1202 int i_opt, i_options;
1204 /* We assume that the remaining parameters are filenames
1205 * and their input options */
1206 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1210 /* Count the input options */
1211 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1217 /* TODO: write an internal function of this one, to avoid
1218 * unnecessary lookups. */
1219 char *mrl = make_URI( ppsz_argv[i_opt] );
1223 playlist_t *p_playlist = pl_Hold( p_vlc );
1224 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1225 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1226 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1227 pl_Release( p_vlc );
1234 /*****************************************************************************
1235 * Help: print program help
1236 *****************************************************************************
1237 * Print a short inline help. Message interface is initialized at this stage.
1238 *****************************************************************************/
1239 static inline void print_help_on_full_help( void )
1241 utf8_fprintf( stdout, "\n" );
1242 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1245 static const char vlc_usage[] = N_(
1246 "Usage: %s [options] [stream] ..."
1247 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1248 "\nThe first item specified will be played first."
1251 "\n --option A global option that is set for the duration of the program."
1252 "\n -option A single letter version of a global --option."
1253 "\n :option An option that only applies to the stream directly before it"
1254 "\n and that overrides previous settings."
1256 "\nStream MRL syntax:"
1257 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1259 "\n Many of the global --options can also be used as MRL specific :options."
1260 "\n Multiple :option=value pairs can be specified."
1263 "\n [file://]filename Plain media file"
1264 "\n http://ip:port/file HTTP URL"
1265 "\n ftp://ip:port/file FTP URL"
1266 "\n mms://ip:port/file MMS URL"
1267 "\n screen:// Screen capture"
1268 "\n [dvd://][device][@raw_device] DVD device"
1269 "\n [vcd://][device] VCD device"
1270 "\n [cdda://][device] Audio CD device"
1271 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1272 "\n UDP stream sent by a streaming server"
1273 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1274 "\n vlc://quit Special item to quit VLC"
1277 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1280 ShowConsole( true );
1283 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1285 utf8_fprintf( stdout, vlc_usage, "vlc" );
1286 Usage( p_this, "=help" );
1287 Usage( p_this, "=main" );
1288 print_help_on_full_help();
1290 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1292 utf8_fprintf( stdout, vlc_usage, "vlc" );
1293 Usage( p_this, NULL );
1294 print_help_on_full_help();
1296 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1298 utf8_fprintf( stdout, vlc_usage, "vlc" );
1299 Usage( p_this, NULL );
1301 else if( psz_help_name )
1303 Usage( p_this, psz_help_name );
1306 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1311 /*****************************************************************************
1312 * Usage: print module usage
1313 *****************************************************************************
1314 * Print a short inline help. Message interface is initialized at this stage.
1315 *****************************************************************************/
1316 # define COL(x) "\033[" #x ";1m"
1317 # define RED COL(31)
1318 # define GREEN COL(32)
1319 # define YELLOW COL(33)
1320 # define BLUE COL(34)
1321 # define MAGENTA COL(35)
1322 # define CYAN COL(36)
1323 # define WHITE COL(0)
1324 # define GRAY "\033[0m"
1326 print_help_section( const module_t *m, const module_config_t *p_item,
1327 bool b_color, bool b_description )
1329 if( !p_item ) return;
1332 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1333 module_gettext( m, p_item->psz_text ) );
1334 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1335 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1336 module_gettext( m, p_item->psz_longtext ) );
1340 utf8_fprintf( stdout, " %s:\n",
1341 module_gettext( m, p_item->psz_text ) );
1342 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1343 utf8_fprintf( stdout, " %s\n",
1344 module_gettext(m, p_item->psz_longtext ) );
1348 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1350 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1351 /* short option ------' | | | | | | |
1352 * option name ------------' | | | | | |
1353 * <bra ---------------------' | | | | |
1354 * option type or "" ----------' | | | |
1355 * ket> -------------------------' | | |
1356 * padding spaces -----------------' | |
1357 * comment --------------------------' |
1358 * comment suffix ---------------------'
1360 * The purpose of having bra and ket is that we might i18n them as well.
1363 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1364 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1366 #define LINE_START 8
1367 #define PADDING_SPACES 25
1369 # define OPTION_VALUE_SEP "="
1371 # define OPTION_VALUE_SEP " "
1373 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1374 char psz_spaces_longtext[LINE_START+3];
1375 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1376 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1377 char psz_buffer[10000];
1379 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1380 int i_width_description = i_width + PADDING_SPACES - 1;
1381 bool b_advanced = var_InheritBool( p_this, "advanced" );
1382 bool b_description = var_InheritBool( p_this, "help-verbose" );
1383 bool b_description_hack;
1384 bool b_color = var_InheritBool( p_this, "color" );
1385 bool b_has_advanced = false;
1386 bool b_found = false;
1387 int i_only_advanced = 0; /* Number of modules ignored because they
1388 * only have advanced options */
1389 bool b_strict = psz_search && *psz_search == '=';
1390 if( b_strict ) psz_search++;
1392 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1393 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1394 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1395 psz_spaces_longtext[LINE_START+2] = '\0';
1399 b_color = false; // don't put color control codes in a .txt file
1403 strcpy( psz_format, COLOR_FORMAT_STRING );
1404 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1408 strcpy( psz_format, FORMAT_STRING );
1409 strcpy( psz_format_bool, FORMAT_STRING );
1412 /* List all modules */
1413 module_t **list = module_list_get (NULL);
1417 /* Ugly hack to make sure that the help options always come first
1420 Usage( p_this, "help" );
1422 /* Enumerate the config for each module */
1423 for (size_t i = 0; list[i]; i++)
1426 module_t *p_parser = list[i];
1427 module_config_t *p_item = NULL;
1428 module_config_t *p_section = NULL;
1429 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1432 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1433 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1435 char *const *pp_shortcut = p_parser->pp_shortcuts;
1436 while( *pp_shortcut )
1438 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1439 : !!strstr( *pp_shortcut, psz_search ) )
1447 /* Ignore modules without config options */
1448 if( !p_parser->i_config_items )
1453 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1454 /* Ugly hack to make sure that the help options always come first
1456 if( !psz_search && b_help_module )
1459 /* Ignore modules with only advanced config options if requested */
1462 for( p_item = p_parser->p_config;
1466 if( (p_item->i_type & CONFIG_ITEM) &&
1467 !p_item->b_advanced && !p_item->b_removed ) break;
1470 if( p_item == p_end )
1479 /* Print name of module */
1480 if( strcmp( "main", p_parser->psz_object_name ) )
1483 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1484 module_gettext( p_parser, p_parser->psz_longname ),
1485 p_parser->psz_object_name );
1487 utf8_fprintf( stdout, "\n %s\n",
1488 module_gettext(p_parser, p_parser->psz_longname ) );
1490 if( p_parser->psz_help )
1493 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1494 module_gettext( p_parser, p_parser->psz_help ) );
1496 utf8_fprintf( stdout, " %s\n",
1497 module_gettext( p_parser, p_parser->psz_help ) );
1500 /* Print module options */
1501 for( p_item = p_parser->p_config;
1505 char *psz_text, *psz_spaces = psz_spaces_text;
1506 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1507 const char *psz_suf = "", *psz_prefix = NULL;
1511 /* Skip removed options */
1512 if( p_item->b_removed )
1516 /* Skip advanced options if requested */
1517 if( p_item->b_advanced && !b_advanced )
1519 b_has_advanced = true;
1523 switch( p_item->i_type )
1525 case CONFIG_HINT_CATEGORY:
1526 case CONFIG_HINT_USAGE:
1527 if( !strcmp( "main", p_parser->psz_object_name ) )
1530 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1531 module_gettext( p_parser, p_item->psz_text ) );
1533 utf8_fprintf( stdout, "\n %s\n",
1534 module_gettext( p_parser, p_item->psz_text ) );
1536 if( b_description && p_item->psz_longtext
1537 && *p_item->psz_longtext )
1540 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1541 module_gettext( p_parser, p_item->psz_longtext ) );
1543 utf8_fprintf( stdout, " %s\n",
1544 module_gettext( p_parser, p_item->psz_longtext ) );
1548 case CONFIG_HINT_SUBCATEGORY:
1549 if( strcmp( "main", p_parser->psz_object_name ) )
1551 case CONFIG_SECTION:
1555 case CONFIG_ITEM_STRING:
1556 case CONFIG_ITEM_FILE:
1557 case CONFIG_ITEM_DIRECTORY:
1558 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1559 case CONFIG_ITEM_MODULE_CAT:
1560 case CONFIG_ITEM_MODULE_LIST:
1561 case CONFIG_ITEM_MODULE_LIST_CAT:
1562 case CONFIG_ITEM_FONT:
1563 case CONFIG_ITEM_PASSWORD:
1564 print_help_section( p_parser, p_section, b_color,
1567 psz_bra = OPTION_VALUE_SEP "<";
1568 psz_type = _("string");
1571 if( p_item->ppsz_list )
1573 psz_bra = OPTION_VALUE_SEP "{";
1574 psz_type = psz_buffer;
1575 psz_buffer[0] = '\0';
1576 for( i = 0; p_item->ppsz_list[i]; i++ )
1578 if( i ) strcat( psz_buffer, "," );
1579 strcat( psz_buffer, p_item->ppsz_list[i] );
1584 case CONFIG_ITEM_INTEGER:
1585 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1586 print_help_section( p_parser, p_section, b_color,
1589 psz_bra = OPTION_VALUE_SEP "<";
1590 psz_type = _("integer");
1593 if( p_item->min.i || p_item->max.i )
1595 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1596 p_item->min.i, p_item->max.i );
1597 psz_type = psz_buffer;
1600 if( p_item->i_list )
1602 psz_bra = OPTION_VALUE_SEP "{";
1603 psz_type = psz_buffer;
1604 psz_buffer[0] = '\0';
1605 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1607 if( i ) strcat( psz_buffer, ", " );
1608 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1610 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1615 case CONFIG_ITEM_FLOAT:
1616 print_help_section( p_parser, p_section, b_color,
1619 psz_bra = OPTION_VALUE_SEP "<";
1620 psz_type = _("float");
1622 if( p_item->min.f || p_item->max.f )
1624 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1625 p_item->min.f, p_item->max.f );
1626 psz_type = psz_buffer;
1629 case CONFIG_ITEM_BOOL:
1630 print_help_section( p_parser, p_section, b_color,
1633 psz_bra = ""; psz_type = ""; psz_ket = "";
1634 if( !b_help_module )
1636 psz_suf = p_item->value.i ? _(" (default enabled)") :
1637 _(" (default disabled)");
1647 /* Add short option if any */
1648 if( p_item->i_short )
1650 sprintf( psz_short, "-%c,", p_item->i_short );
1654 strcpy( psz_short, " " );
1657 i = PADDING_SPACES - strlen( p_item->psz_name )
1658 - strlen( psz_bra ) - strlen( psz_type )
1659 - strlen( psz_ket ) - 1;
1661 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1663 psz_prefix = ", --no-";
1664 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1669 psz_spaces[0] = '\n';
1674 psz_spaces[i] = '\0';
1677 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1679 utf8_fprintf( stdout, psz_format_bool, psz_short,
1680 p_item->psz_name, psz_prefix, p_item->psz_name,
1681 psz_bra, psz_type, psz_ket, psz_spaces );
1685 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1686 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1689 psz_spaces[i] = ' ';
1691 /* We wrap the rest of the output */
1692 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1694 b_description_hack = b_description;
1697 psz_text = psz_buffer;
1698 i_cur_width = b_description && !b_description_hack
1699 ? i_width_description
1703 char *psz_parser, *psz_word;
1704 size_t i_end = strlen( psz_text );
1706 /* If the remaining text fits in a line, print it. */
1707 if( i_end <= i_cur_width )
1711 if( !b_description || b_description_hack )
1712 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1714 utf8_fprintf( stdout, "%s\n", psz_text );
1718 utf8_fprintf( stdout, "%s\n", psz_text );
1723 /* Otherwise, eat as many words as possible */
1724 psz_parser = psz_text;
1727 psz_word = psz_parser;
1728 psz_parser = strchr( psz_word, ' ' );
1729 /* If no space was found, we reached the end of the text
1730 * block; otherwise, we skip the space we just found. */
1731 psz_parser = psz_parser ? psz_parser + 1
1734 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1736 /* We cut a word in one of these cases:
1737 * - it's the only word in the line and it's too long.
1738 * - we used less than 80% of the width and the word we are
1739 * going to wrap is longer than 40% of the width, and even
1740 * if the word would have fit in the next line. */
1741 if( psz_word == psz_text
1742 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1743 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1745 char c = psz_text[i_cur_width];
1746 psz_text[i_cur_width] = '\0';
1749 if( !b_description || b_description_hack )
1750 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1751 psz_text, psz_spaces );
1753 utf8_fprintf( stdout, "%s\n%s",
1754 psz_text, psz_spaces );
1758 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1760 psz_text += i_cur_width;
1765 psz_word[-1] = '\0';
1768 if( !b_description || b_description_hack )
1769 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1770 psz_text, psz_spaces );
1772 utf8_fprintf( stdout, "%s\n%s",
1773 psz_text, psz_spaces );
1777 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1779 psz_text = psz_word;
1783 if( b_description_hack && p_item->psz_longtext
1784 && *p_item->psz_longtext )
1786 sprintf( psz_buffer, "%s%s",
1787 module_gettext( p_parser, p_item->psz_longtext ),
1789 b_description_hack = false;
1790 psz_spaces = psz_spaces_longtext;
1791 utf8_fprintf( stdout, "%s", psz_spaces );
1797 if( b_has_advanced )
1800 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1801 _( "add --advanced to your command line to see advanced options."));
1803 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1804 _( "add --advanced to your command line to see advanced options."));
1807 if( i_only_advanced > 0 )
1811 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1812 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1816 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1817 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1823 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1824 _( "No matching module found. Use --list or " \
1825 "--list-verbose to list available modules." ) );
1827 utf8_fprintf( stdout, "\n%s\n",
1828 _( "No matching module found. Use --list or " \
1829 "--list-verbose to list available modules." ) );
1832 /* Release the module list */
1833 module_list_free (list);
1836 /*****************************************************************************
1837 * ListModules: list the available modules with their description
1838 *****************************************************************************
1839 * Print a list of all available modules (builtins and plugins) and a short
1840 * description for each one.
1841 *****************************************************************************/
1842 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1846 bool b_color = var_InheritBool( p_this, "color" );
1849 ShowConsole( true );
1850 b_color = false; // don't put color control codes in a .txt file
1856 /* List all modules */
1857 module_t **list = module_list_get (NULL);
1859 /* Enumerate each module */
1860 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1863 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1864 p_parser->psz_object_name,
1865 module_gettext( p_parser, p_parser->psz_longname ) );
1867 utf8_fprintf( stdout, " %-22s %s\n",
1868 p_parser->psz_object_name,
1869 module_gettext( p_parser, p_parser->psz_longname ) );
1873 char *const *pp_shortcut = p_parser->pp_shortcuts;
1874 while( *pp_shortcut )
1876 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1879 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1882 utf8_fprintf( stdout, " s %s\n",
1887 if( p_parser->psz_capability )
1890 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1891 p_parser->psz_capability,
1892 p_parser->i_score );
1894 utf8_fprintf( stdout, " c %s (%d)\n",
1895 p_parser->psz_capability,
1896 p_parser->i_score );
1900 module_list_free (list);
1902 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1907 /*****************************************************************************
1908 * Version: print complete program version
1909 *****************************************************************************
1910 * Print complete program version and build number.
1911 *****************************************************************************/
1912 static void Version( void )
1914 extern const char psz_vlc_changeset[];
1916 ShowConsole( true );
1919 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1920 psz_vlc_changeset );
1921 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1922 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1923 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1924 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1926 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1931 /*****************************************************************************
1932 * ShowConsole: On Win32, create an output console for debug messages
1933 *****************************************************************************
1934 * This function is useful only on Win32.
1935 *****************************************************************************/
1937 static void ShowConsole( bool b_dofile )
1940 FILE *f_help = NULL;
1942 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1945 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1946 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1947 * page (e.g. CP437 or CP850). */
1948 SetConsoleOutputCP (GetACP ());
1949 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1951 freopen( "CONOUT$", "w", stderr );
1952 freopen( "CONIN$", "r", stdin );
1954 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1957 freopen( "vlc-help.txt", "wt", stdout );
1958 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1960 else freopen( "CONOUT$", "w", stdout );
1966 /*****************************************************************************
1967 * PauseConsole: On Win32, wait for a key press before closing the console
1968 *****************************************************************************
1969 * This function is useful only on Win32.
1970 *****************************************************************************/
1972 static void PauseConsole( void )
1976 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1978 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1986 /*****************************************************************************
1987 * ConsoleWidth: Return the console width in characters
1988 *****************************************************************************
1989 * We use the stty shell command to get the console width; if this fails or
1990 * if the width is less than 80, we default to 80.
1991 *****************************************************************************/
1992 static int ConsoleWidth( void )
1994 unsigned i_width = 80;
1997 FILE *file = popen( "stty size 2>/dev/null", "r" );
2000 if (fscanf (file, "%*u %u", &i_width) <= 0)
2004 #elif !defined (UNDER_CE)
2005 CONSOLE_SCREEN_BUFFER_INFO buf;
2007 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2008 i_width = buf.dwSize.X;
2014 #include <vlc_avcodec.h>
2016 void vlc_avcodec_mutex (bool acquire)
2018 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2021 vlc_mutex_lock (&lock);
2023 vlc_mutex_unlock (&lock);