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>
86 #include "playlist/playlist_internal.h"
91 # include <libkern/OSAtomic.h>
96 /*****************************************************************************
97 * The evil global variables. We handle them with care, don't worry.
98 *****************************************************************************/
99 static unsigned i_instances = 0;
102 static bool b_daemon = false;
110 * Atomically set the reference count to 1.
111 * @param p_gc reference counted object
112 * @param pf_destruct destruction calback
115 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
117 /* There is no point in using the GC if there is no destructor... */
118 assert (pf_destruct);
119 p_gc->pf_destructor = pf_destruct;
122 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
123 __sync_synchronize ();
124 #elif defined (WIN32) && defined (__GNUC__)
125 #elif defined(__APPLE__)
128 /* Nobody else can possibly lock the spin - it's there as a barrier */
129 vlc_spin_init (&p_gc->spin);
130 vlc_spin_lock (&p_gc->spin);
131 vlc_spin_unlock (&p_gc->spin);
137 * Atomically increment the reference count.
138 * @param p_gc reference counted object
141 void *vlc_hold (gc_object_t * p_gc)
145 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
147 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
148 refs = __sync_add_and_fetch (&p_gc->refs, 1);
149 #elif defined (WIN64)
150 refs = InterlockedIncrement64 (&p_gc->refs);
151 #elif defined (WIN32)
152 refs = InterlockedIncrement (&p_gc->refs);
153 #elif defined(__APPLE__)
154 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
156 vlc_spin_lock (&p_gc->spin);
158 vlc_spin_unlock (&p_gc->spin);
160 assert (refs != 1); /* there had to be a reference already */
165 * Atomically decrement the reference count and, if it reaches zero, destroy.
166 * @param p_gc reference counted object.
168 void vlc_release (gc_object_t *p_gc)
173 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
175 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
176 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
177 #elif defined (WIN64)
178 refs = InterlockedDecrement64 (&p_gc->refs);
179 #elif defined (WIN32)
180 refs = InterlockedDecrement (&p_gc->refs);
181 #elif defined(__APPLE__)
182 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
184 vlc_spin_lock (&p_gc->spin);
186 vlc_spin_unlock (&p_gc->spin);
189 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
192 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
193 #elif defined (WIN32) && defined (__GNUC__)
194 #elif defined(__APPLE__)
196 vlc_spin_destroy (&p_gc->spin);
198 p_gc->pf_destructor (p_gc);
202 /*****************************************************************************
204 *****************************************************************************/
205 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
206 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
207 static void SetLanguage ( char const * );
209 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
210 static void Help ( libvlc_int_t *, char const *psz_help_name );
211 static void Usage ( libvlc_int_t *, char const *psz_search );
212 static void ListModules ( libvlc_int_t *, bool );
213 static void Version ( void );
216 static void ShowConsole ( bool );
217 static void PauseConsole ( void );
219 static int ConsoleWidth ( void );
221 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
224 * Allocate a libvlc instance, initialize global data if needed
225 * It also initializes the threading system
227 libvlc_int_t * libvlc_InternalCreate( void )
229 libvlc_int_t *p_libvlc;
231 char *psz_env = NULL;
233 /* Now that the thread system is initialized, we don't have much, but
234 * at least we have variables */
235 vlc_mutex_lock( &global_lock );
236 if( i_instances == 0 )
238 /* Guess what CPU we have */
239 cpu_flags = CPUCapabilities();
240 /* The module bank will be initialized later */
243 /* Allocate a libvlc instance object */
244 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
245 VLC_OBJECT_GENERIC, "libvlc" );
246 if( p_libvlc != NULL )
248 vlc_mutex_unlock( &global_lock );
250 if( p_libvlc == NULL )
253 priv = libvlc_priv (p_libvlc);
254 priv->p_playlist = NULL;
255 priv->p_dialog_provider = NULL;
258 /* Initialize message queue */
259 priv->msg_bank = msg_Create ();
260 if (unlikely(priv->msg_bank == NULL))
263 /* Find verbosity from VLC_VERBOSE environment variable */
264 psz_env = getenv( "VLC_VERBOSE" );
265 if( psz_env != NULL )
266 priv->i_verbose = atoi( psz_env );
269 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
270 priv->b_color = isatty( 2 ); /* 2 is for stderr */
272 priv->b_color = false;
275 /* Initialize mutexes */
276 vlc_mutex_init( &priv->timer_lock );
280 vlc_object_release (p_libvlc);
285 * Initialize a libvlc instance
286 * This function initializes a previously allocated libvlc instance:
288 * - gettext initialization
289 * - message queue, module bank and playlist initialization
290 * - configuration and commandline parsing
292 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
293 const char *ppsz_argv[] )
295 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
297 char * psz_modules = NULL;
298 char * psz_parser = NULL;
299 char * psz_control = NULL;
301 int i_ret = VLC_EEXIT;
302 playlist_t *p_playlist = NULL;
304 #if defined( ENABLE_NLS ) \
305 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
306 # if defined (WIN32) || defined (__APPLE__)
311 /* System specific initialization code */
312 system_Init( p_libvlc, &i_argc, ppsz_argv );
315 * Support for gettext
317 vlc_bindtextdomain (PACKAGE_NAME);
319 /* Initialize the module bank and load the configuration of the
320 * main module. We need to do this at this stage to be able to display
321 * a short help if required by the user. (short help == main module
323 module_InitBank( p_libvlc );
325 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
327 module_EndBank( p_libvlc, false );
331 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
332 /* Announce who we are - Do it only for first instance ? */
333 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
334 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
335 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
336 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
338 /* Check for short help option */
339 if( var_InheritBool( p_libvlc, "help" ) )
341 Help( p_libvlc, "help" );
343 i_ret = VLC_EEXITSUCCESS;
345 /* Check for version option */
346 else if( var_InheritBool( p_libvlc, "version" ) )
350 i_ret = VLC_EEXITSUCCESS;
353 /* Check for daemon mode */
355 if( var_InheritBool( p_libvlc, "daemon" ) )
358 char *psz_pidfile = NULL;
360 if( daemon( 1, 0) != 0 )
362 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
367 /* lets check if we need to write the pidfile */
368 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
369 if( psz_pidfile != NULL )
372 pid_t i_pid = getpid ();
373 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
374 i_pid, psz_pidfile );
375 pidfile = vlc_fopen( psz_pidfile,"w" );
376 if( pidfile != NULL )
378 utf8_fprintf( pidfile, "%d", (int)i_pid );
383 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
392 if( ( i_pid = fork() ) < 0 )
394 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
399 /* This is the parent, exit right now */
400 msg_Dbg( p_libvlc, "closing parent process" );
402 i_ret = VLC_EEXITSUCCESS;
406 /* We are the child */
407 msg_Dbg( p_libvlc, "daemon spawned" );
408 close( STDIN_FILENO );
409 close( STDOUT_FILENO );
410 close( STDERR_FILENO );
420 module_EndBank( p_libvlc, false );
424 /* Check for translation config option */
425 #if defined( ENABLE_NLS ) \
426 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
427 # if defined (WIN32) || defined (__APPLE__)
428 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
429 config_LoadConfigFile( p_libvlc, "main" );
430 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
432 /* Check if the user specified a custom language */
433 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
434 if( psz_language && strcmp( psz_language, "auto" ) )
436 /* Reset the default domain */
437 SetLanguage( psz_language );
439 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
440 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
442 free( psz_language );
447 * Load the builtins and plugins into the module_bank.
448 * We have to do it before config_Load*() because this also gets the
449 * list of configuration options exported by each module and loads their
452 module_LoadPlugins( p_libvlc );
453 if( p_libvlc->b_die )
459 module_t **list = module_list_get( &module_count );
460 module_list_free( list );
461 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
463 /* Check for help on modules */
464 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
466 Help( p_libvlc, p_tmp );
469 i_ret = VLC_EEXITSUCCESS;
471 /* Check for full help option */
472 else if( var_InheritBool( p_libvlc, "full-help" ) )
474 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
475 var_SetBool( p_libvlc, "advanced", true );
476 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
477 var_SetBool( p_libvlc, "help-verbose", true );
478 Help( p_libvlc, "full-help" );
480 i_ret = VLC_EEXITSUCCESS;
482 /* Check for long help option */
483 else if( var_InheritBool( p_libvlc, "longhelp" ) )
485 Help( p_libvlc, "longhelp" );
487 i_ret = VLC_EEXITSUCCESS;
489 /* Check for module list option */
490 else if( var_InheritBool( p_libvlc, "list" ) )
492 ListModules( p_libvlc, false );
494 i_ret = VLC_EEXITSUCCESS;
496 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
498 ListModules( p_libvlc, true );
500 i_ret = VLC_EEXITSUCCESS;
503 /* Check for config file options */
504 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
506 if( var_InheritBool( p_libvlc, "reset-config" ) )
508 config_ResetAll( p_libvlc );
509 config_SaveConfigFile( p_libvlc, NULL );
513 if( module_count <= 1)
515 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
516 "that you properly gave a module path with --plugin-path.");
523 module_EndBank( p_libvlc, true );
528 * Override default configuration with config file settings
530 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
531 config_LoadConfigFile( p_libvlc, NULL );
534 * Override configuration with command line settings
536 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
539 ShowConsole( false );
540 /* Pause the console because it's destroyed when we exit */
541 fprintf( stderr, "The command line options couldn't be loaded, check "
542 "that they are valid.\n" );
545 module_EndBank( p_libvlc, true );
548 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
551 * System specific configuration
553 system_Configure( p_libvlc, &i_argc, ppsz_argv );
555 /* FIXME: could be replaced by using Unix sockets */
557 dbus_threads_init_default();
559 if( var_InheritBool( p_libvlc, "one-instance" )
560 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
561 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
563 /* Initialise D-Bus interface, check for other instances */
564 DBusConnection *p_conn = NULL;
565 DBusError dbus_error;
567 dbus_error_init( &dbus_error );
569 /* connect to the session bus */
570 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
573 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
574 dbus_error.message );
575 dbus_error_free( &dbus_error );
579 /* check if VLC is available on the bus
580 * if not: D-Bus control is not enabled on the other
581 * instance and we can't pass MRLs to it */
582 DBusMessage *p_test_msg = NULL;
583 DBusMessage *p_test_reply = NULL;
584 p_test_msg = dbus_message_new_method_call(
585 "org.mpris.vlc", "/",
586 "org.freedesktop.MediaPlayer", "Identity" );
587 /* block until a reply arrives */
588 p_test_reply = dbus_connection_send_with_reply_and_block(
589 p_conn, p_test_msg, -1, &dbus_error );
590 dbus_message_unref( p_test_msg );
591 if( p_test_reply == NULL )
593 dbus_error_free( &dbus_error );
594 msg_Dbg( p_libvlc, "No Media Player is running. "
595 "Continuing normally." );
600 DBusMessage* p_dbus_msg = NULL;
601 DBusMessageIter dbus_args;
602 DBusPendingCall* p_dbus_pending = NULL;
605 dbus_message_unref( p_test_reply );
606 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
608 for( i_input = optind;i_input < i_argc;i_input++ )
610 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
611 ppsz_argv[i_input] );
613 p_dbus_msg = dbus_message_new_method_call(
614 "org.mpris.vlc", "/TrackList",
615 "org.freedesktop.MediaPlayer", "AddTrack" );
617 if ( NULL == p_dbus_msg )
619 msg_Err( p_libvlc, "D-Bus problem" );
620 system_End( p_libvlc );
625 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
626 if ( !dbus_message_iter_append_basic( &dbus_args,
627 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
629 dbus_message_unref( p_dbus_msg );
630 system_End( p_libvlc );
634 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
636 if ( !dbus_message_iter_append_basic( &dbus_args,
637 DBUS_TYPE_BOOLEAN, &b_play ) )
639 dbus_message_unref( p_dbus_msg );
640 system_End( p_libvlc );
644 /* send message and get a handle for a reply */
645 if ( !dbus_connection_send_with_reply ( p_conn,
646 p_dbus_msg, &p_dbus_pending, -1 ) )
648 msg_Err( p_libvlc, "D-Bus problem" );
649 dbus_message_unref( p_dbus_msg );
650 system_End( p_libvlc );
654 if ( NULL == p_dbus_pending )
656 msg_Err( p_libvlc, "D-Bus problem" );
657 dbus_message_unref( p_dbus_msg );
658 system_End( p_libvlc );
661 dbus_connection_flush( p_conn );
662 dbus_message_unref( p_dbus_msg );
663 /* block until we receive a reply */
664 dbus_pending_call_block( p_dbus_pending );
665 dbus_pending_call_unref( p_dbus_pending );
666 } /* processes all command line MRLs */
669 system_End( p_libvlc );
673 /* we unreference the connection when we've finished with it */
674 if( p_conn ) dbus_connection_unref( p_conn );
679 * Message queue options
681 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
682 if( psz_verbose_objects )
684 char * psz_object, * iter = psz_verbose_objects;
685 while( (psz_object = strsep( &iter, "," )) )
687 switch( psz_object[0] )
689 printf("%s\n", psz_object+1);
690 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
691 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
693 msg_Err( p_libvlc, "verbose-objects usage: \n"
694 "--verbose-objects=+printthatobject,"
695 "-dontprintthatone\n"
696 "(keyword 'all' to applies to all objects)");
697 free( psz_verbose_objects );
698 /* FIXME: leaks!!!! */
702 free( psz_verbose_objects );
705 /* Last chance to set the verbosity. Once we start interfaces and other
706 * threads, verbosity becomes read-only. */
707 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
708 if( var_InheritBool( p_libvlc, "quiet" ) )
710 var_SetInteger( p_libvlc, "verbose", -1 );
711 priv->i_verbose = -1;
713 vlc_threads_setup( p_libvlc );
716 priv->b_color = var_InheritBool( p_libvlc, "color" );
718 char p_capabilities[200];
719 #define PRINT_CAPABILITY( capability, string ) \
720 if( vlc_CPU() & capability ) \
722 strncat( p_capabilities, string " ", \
723 sizeof(p_capabilities) - strlen(p_capabilities) ); \
724 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
726 p_capabilities[0] = '\0';
728 #if defined( __i386__ ) || defined( __x86_64__ )
729 if( !var_InheritBool( p_libvlc, "mmx" ) )
730 cpu_flags &= ~CPU_CAPABILITY_MMX;
731 if( !var_InheritBool( p_libvlc, "3dn" ) )
732 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
733 if( !var_InheritBool( p_libvlc, "mmxext" ) )
734 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
735 if( !var_InheritBool( p_libvlc, "sse" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSE;
737 if( !var_InheritBool( p_libvlc, "sse2" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSE2;
739 if( !var_InheritBool( p_libvlc, "sse3" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE3;
741 if( !var_InheritBool( p_libvlc, "ssse3" ) )
742 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
743 if( !var_InheritBool( p_libvlc, "sse41" ) )
744 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
745 if( !var_InheritBool( p_libvlc, "sse42" ) )
746 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
748 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
755 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
756 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
757 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
759 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
760 if( !var_InheritBool( p_libvlc, "altivec" ) )
761 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
763 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
765 #elif defined( __arm__ )
766 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
771 strncat( p_capabilities, "FPU ",
772 sizeof(p_capabilities) - strlen( p_capabilities) );
773 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
776 if (p_capabilities[0])
777 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
780 * Choose the best memcpy module
782 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
783 /* Avoid being called "memcpy":*/
784 vlc_object_set_name( p_libvlc, "main" );
786 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
788 priv->pp_timers = NULL;
790 priv->i_last_input_id = 0; /* Not very safe, should be removed */
793 * Initialize hotkey handling
795 vlc_InitActions( p_libvlc );
797 /* variables for signalling creation of new files */
798 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
799 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
801 /* Initialize playlist and get commandline files */
802 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
805 msg_Err( p_libvlc, "playlist initialization failed" );
806 if( priv->p_memcpy_module != NULL )
808 module_unneed( p_libvlc, priv->p_memcpy_module );
810 module_EndBank( p_libvlc, true );
814 /* Add service discovery modules */
815 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
818 char *p = psz_modules, *m;
819 while( ( m = strsep( &p, " :," ) ) != NULL )
820 playlist_ServicesDiscoveryAdd( p_playlist, m );
825 /* Initialize VLM if vlm-conf is specified */
826 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
829 priv->p_vlm = vlm_New( p_libvlc );
831 msg_Err( p_libvlc, "VLM initialization failed" );
837 * Load background interfaces
839 /* Create volume callback system. (this variable must be created before
840 all interfaces as they can use it) */
841 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
842 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
844 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
845 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
847 if( psz_modules && psz_control )
850 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
853 psz_modules = psz_tmp;
856 else if( psz_control )
859 psz_modules = strdup( psz_control );
862 psz_parser = psz_modules;
863 while ( psz_parser && *psz_parser )
865 char *psz_module, *psz_temp;
866 psz_module = psz_parser;
867 psz_parser = strchr( psz_module, ':' );
873 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
875 intf_Create( p_libvlc, psz_temp );
883 * Always load the hotkeys interface if it exists
885 intf_Create( p_libvlc, "hotkeys,none" );
888 /* loads dbus control interface if in one-instance mode
889 * we do it only when playlist exists, because dbus module needs it */
890 if( var_InheritBool( p_libvlc, "one-instance" )
891 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
892 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
893 intf_Create( p_libvlc, "dbus,none" );
895 # if !defined (HAVE_MAEMO)
896 /* Prevents the power management daemon from suspending the system
897 * when VLC is active */
898 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
899 intf_Create( p_libvlc, "inhibit,none" );
903 if( var_InheritBool( p_libvlc, "file-logging" ) &&
904 !var_InheritBool( p_libvlc, "syslog" ) )
906 intf_Create( p_libvlc, "logger,none" );
909 if( var_InheritBool( p_libvlc, "syslog" ) )
911 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
912 var_SetString( p_libvlc, "logmode", "syslog" );
913 intf_Create( p_libvlc, "logger,none" );
917 var_SetString( p_libvlc, "logmode", logmode );
920 var_Destroy( p_libvlc, "logmode" );
924 if( var_InheritBool( p_libvlc, "network-synchronisation") )
926 intf_Create( p_libvlc, "netsync,none" );
930 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
932 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
935 char *psz_morecodecs;
936 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
938 var_SetString( p_libvlc, "codec", psz_morecodecs);
939 free( psz_morecodecs );
944 var_SetString( p_libvlc, "codec", "dmo,quicktime");
948 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
949 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
953 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
954 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
958 /* Create a variable for showing the fullscreen interface from hotkeys */
959 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
960 var_SetBool( p_libvlc, "intf-show", true );
962 /* Create a variable for showing the right click menu */
963 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
966 * Get input filenames given as commandline arguments
968 GetFilenames( p_libvlc, i_argc, ppsz_argv );
971 * Get --open argument
973 psz_val = var_InheritString( p_libvlc, "open" );
974 if ( psz_val != NULL )
976 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
977 -1, 0, NULL, 0, true, pl_Unlocked );
985 * Cleanup a libvlc instance. The instance is not completely deallocated
986 * \param p_libvlc the instance to clean
988 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
990 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
991 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
993 /* Deactivate the playlist */
994 msg_Dbg( p_libvlc, "deactivating the playlist" );
995 pl_Deactivate( p_libvlc );
997 /* Remove all services discovery */
998 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
999 playlist_ServicesDiscoveryKillAll( p_playlist );
1001 /* Ask the interfaces to stop and destroy them */
1002 msg_Dbg( p_libvlc, "removing all interfaces" );
1003 libvlc_Quit( p_libvlc );
1004 intf_DestroyAll( p_libvlc );
1007 /* Destroy VLM if created in libvlc_InternalInit */
1010 vlm_Delete( priv->p_vlm );
1014 /* Free playlist now, all threads are gone */
1015 playlist_Destroy( p_playlist );
1017 stats_TimersDumpAll( p_libvlc );
1018 stats_TimersCleanAll( p_libvlc );
1020 msg_Dbg( p_libvlc, "removing stats" );
1023 char* psz_pidfile = NULL;
1027 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1028 if( psz_pidfile != NULL )
1030 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1031 if( unlink( psz_pidfile ) == -1 )
1033 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1037 free( psz_pidfile );
1041 if( priv->p_memcpy_module )
1043 module_unneed( p_libvlc, priv->p_memcpy_module );
1044 priv->p_memcpy_module = NULL;
1047 /* Free module bank. It is refcounted, so we call this each time */
1048 module_EndBank( p_libvlc, true );
1050 vlc_DeinitActions( p_libvlc );
1054 * Destroy everything.
1055 * This function requests the running threads to finish, waits for their
1056 * termination, and destroys their structure.
1057 * It stops the thread systems: no instance can run after this has run
1058 * \param p_libvlc the instance to destroy
1060 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1062 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1064 vlc_mutex_lock( &global_lock );
1067 if( i_instances == 0 )
1069 /* System specific cleaning code */
1070 system_End( p_libvlc );
1072 vlc_mutex_unlock( &global_lock );
1074 msg_Destroy (priv->msg_bank);
1076 /* Destroy mutexes */
1077 vlc_mutex_destroy( &priv->timer_lock );
1079 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1080 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1081 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1082 vlc_object_release( p_libvlc );
1085 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1086 vlc_object_release( p_libvlc );
1090 * Add an interface plugin and run it
1092 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1095 return VLC_EGENERIC;
1097 if( !psz_module ) /* requesting the default interface */
1099 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1100 if( !psz_interface ) /* "intf" has not been set */
1104 /* Daemon mode hack.
1105 * We prefer the dummy interface if none is specified. */
1106 psz_module = "dummy";
1109 msg_Info( p_libvlc, "%s",
1110 _("Running vlc with the default interface. "
1111 "Use 'cvlc' to use vlc without interface.") );
1113 free( psz_interface );
1114 var_Destroy( p_libvlc, "intf" );
1117 /* Try to create the interface */
1118 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1120 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1121 psz_module ? psz_module : "default" );
1126 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1127 static vlc_cond_t exiting = VLC_STATIC_COND;
1129 extern vlc_mutex_t super_mutex;
1130 extern vlc_cond_t super_variable;
1131 # define exit_lock super_mutex
1132 # define exiting super_variable
1136 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1137 * when the user "exits" an interface plugin.
1139 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1141 vlc_mutex_lock( &exit_lock );
1142 while( vlc_object_alive( p_libvlc ) )
1143 vlc_cond_wait( &exiting, &exit_lock );
1144 vlc_mutex_unlock( &exit_lock );
1148 * Posts an exit signal to LibVLC instance. This will normally initiate the
1149 * cleanup and destroy process. It should only be called on behalf of the user.
1151 void libvlc_Quit( libvlc_int_t *p_libvlc )
1153 vlc_mutex_lock( &exit_lock );
1154 vlc_object_kill( p_libvlc );
1155 vlc_cond_broadcast( &exiting );
1156 vlc_mutex_unlock( &exit_lock );
1159 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1160 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1161 /*****************************************************************************
1162 * SetLanguage: set the interface language.
1163 *****************************************************************************
1164 * We set the LC_MESSAGES locale category for interface messages and buttons,
1165 * as well as the LC_CTYPE category for string sorting and possible wide
1166 * character support.
1167 *****************************************************************************/
1168 static void SetLanguage ( const char *psz_lang )
1171 /* I need that under Darwin, please check it doesn't disturb
1172 * other platforms. --Meuuh */
1173 setenv( "LANG", psz_lang, 1 );
1176 /* We set LC_ALL manually because it is the only way to set
1177 * the language at runtime under eg. Windows. Beware that this
1178 * makes the environment unconsistent when libvlc is unloaded and
1179 * should probably be moved to a safer place like vlc.c. */
1180 static char psz_lcall[20];
1181 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1182 psz_lcall[19] = '\0';
1183 putenv( psz_lcall );
1186 setlocale( LC_ALL, psz_lang );
1190 /*****************************************************************************
1191 * GetFilenames: parse command line options which are not flags
1192 *****************************************************************************
1193 * Parse command line for input files as well as their associated options.
1194 * An option always follows its associated input and begins with a ":".
1195 *****************************************************************************/
1196 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1198 int i_opt, i_options;
1200 /* We assume that the remaining parameters are filenames
1201 * and their input options */
1202 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1206 /* Count the input options */
1207 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1213 /* TODO: write an internal function of this one, to avoid
1214 * unnecessary lookups. */
1215 char *mrl = make_URI( ppsz_argv[i_opt] );
1219 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1220 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1221 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1228 /*****************************************************************************
1229 * Help: print program help
1230 *****************************************************************************
1231 * Print a short inline help. Message interface is initialized at this stage.
1232 *****************************************************************************/
1233 static inline void print_help_on_full_help( void )
1235 utf8_fprintf( stdout, "\n" );
1236 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1239 static const char vlc_usage[] = N_(
1240 "Usage: %s [options] [stream] ..."
1241 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1242 "\nThe first item specified will be played first."
1245 "\n --option A global option that is set for the duration of the program."
1246 "\n -option A single letter version of a global --option."
1247 "\n :option An option that only applies to the stream directly before it"
1248 "\n and that overrides previous settings."
1250 "\nStream MRL syntax:"
1251 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1253 "\n Many of the global --options can also be used as MRL specific :options."
1254 "\n Multiple :option=value pairs can be specified."
1257 "\n [file://]filename Plain media file"
1258 "\n http://ip:port/file HTTP URL"
1259 "\n ftp://ip:port/file FTP URL"
1260 "\n mms://ip:port/file MMS URL"
1261 "\n screen:// Screen capture"
1262 "\n [dvd://][device][@raw_device] DVD device"
1263 "\n [vcd://][device] VCD device"
1264 "\n [cdda://][device] Audio CD device"
1265 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1266 "\n UDP stream sent by a streaming server"
1267 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1268 "\n vlc://quit Special item to quit VLC"
1271 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1274 ShowConsole( true );
1277 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1279 utf8_fprintf( stdout, vlc_usage, "vlc" );
1280 Usage( p_this, "=help" );
1281 Usage( p_this, "=main" );
1282 print_help_on_full_help();
1284 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1286 utf8_fprintf( stdout, vlc_usage, "vlc" );
1287 Usage( p_this, NULL );
1288 print_help_on_full_help();
1290 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1292 utf8_fprintf( stdout, vlc_usage, "vlc" );
1293 Usage( p_this, NULL );
1295 else if( psz_help_name )
1297 Usage( p_this, psz_help_name );
1300 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1305 /*****************************************************************************
1306 * Usage: print module usage
1307 *****************************************************************************
1308 * Print a short inline help. Message interface is initialized at this stage.
1309 *****************************************************************************/
1310 # define COL(x) "\033[" #x ";1m"
1311 # define RED COL(31)
1312 # define GREEN COL(32)
1313 # define YELLOW COL(33)
1314 # define BLUE COL(34)
1315 # define MAGENTA COL(35)
1316 # define CYAN COL(36)
1317 # define WHITE COL(0)
1318 # define GRAY "\033[0m"
1320 print_help_section( const module_t *m, const module_config_t *p_item,
1321 bool b_color, bool b_description )
1323 if( !p_item ) return;
1326 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1327 module_gettext( m, p_item->psz_text ) );
1328 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1329 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1330 module_gettext( m, p_item->psz_longtext ) );
1334 utf8_fprintf( stdout, " %s:\n",
1335 module_gettext( m, p_item->psz_text ) );
1336 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1337 utf8_fprintf( stdout, " %s\n",
1338 module_gettext(m, p_item->psz_longtext ) );
1342 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1344 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1345 /* short option ------' | | | | | | |
1346 * option name ------------' | | | | | |
1347 * <bra ---------------------' | | | | |
1348 * option type or "" ----------' | | | |
1349 * ket> -------------------------' | | |
1350 * padding spaces -----------------' | |
1351 * comment --------------------------' |
1352 * comment suffix ---------------------'
1354 * The purpose of having bra and ket is that we might i18n them as well.
1357 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1358 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1360 #define LINE_START 8
1361 #define PADDING_SPACES 25
1363 # define OPTION_VALUE_SEP "="
1365 # define OPTION_VALUE_SEP " "
1367 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1368 char psz_spaces_longtext[LINE_START+3];
1369 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1370 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1371 char psz_buffer[10000];
1373 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1374 int i_width_description = i_width + PADDING_SPACES - 1;
1375 bool b_advanced = var_InheritBool( p_this, "advanced" );
1376 bool b_description = var_InheritBool( p_this, "help-verbose" );
1377 bool b_description_hack;
1378 bool b_color = var_InheritBool( p_this, "color" );
1379 bool b_has_advanced = false;
1380 bool b_found = false;
1381 int i_only_advanced = 0; /* Number of modules ignored because they
1382 * only have advanced options */
1383 bool b_strict = psz_search && *psz_search == '=';
1384 if( b_strict ) psz_search++;
1386 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1387 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1388 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1389 psz_spaces_longtext[LINE_START+2] = '\0';
1393 b_color = false; // don't put color control codes in a .txt file
1397 strcpy( psz_format, COLOR_FORMAT_STRING );
1398 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1402 strcpy( psz_format, FORMAT_STRING );
1403 strcpy( psz_format_bool, FORMAT_STRING );
1406 /* List all modules */
1407 module_t **list = module_list_get (NULL);
1411 /* Ugly hack to make sure that the help options always come first
1414 Usage( p_this, "help" );
1416 /* Enumerate the config for each module */
1417 for (size_t i = 0; list[i]; i++)
1420 module_t *p_parser = list[i];
1421 module_config_t *p_item = NULL;
1422 module_config_t *p_section = NULL;
1423 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1426 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1427 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1429 char *const *pp_shortcut = p_parser->pp_shortcuts;
1430 while( *pp_shortcut )
1432 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1433 : !!strstr( *pp_shortcut, psz_search ) )
1441 /* Ignore modules without config options */
1442 if( !p_parser->i_config_items )
1447 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1448 /* Ugly hack to make sure that the help options always come first
1450 if( !psz_search && b_help_module )
1453 /* Ignore modules with only advanced config options if requested */
1456 for( p_item = p_parser->p_config;
1460 if( (p_item->i_type & CONFIG_ITEM) &&
1461 !p_item->b_advanced && !p_item->b_removed ) break;
1464 if( p_item == p_end )
1473 /* Print name of module */
1474 if( strcmp( "main", p_parser->psz_object_name ) )
1477 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1478 module_gettext( p_parser, p_parser->psz_longname ),
1479 p_parser->psz_object_name );
1481 utf8_fprintf( stdout, "\n %s\n",
1482 module_gettext(p_parser, p_parser->psz_longname ) );
1484 if( p_parser->psz_help )
1487 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1488 module_gettext( p_parser, p_parser->psz_help ) );
1490 utf8_fprintf( stdout, " %s\n",
1491 module_gettext( p_parser, p_parser->psz_help ) );
1494 /* Print module options */
1495 for( p_item = p_parser->p_config;
1499 char *psz_text, *psz_spaces = psz_spaces_text;
1500 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1501 const char *psz_suf = "", *psz_prefix = NULL;
1505 /* Skip removed options */
1506 if( p_item->b_removed )
1510 /* Skip advanced options if requested */
1511 if( p_item->b_advanced && !b_advanced )
1513 b_has_advanced = true;
1517 switch( p_item->i_type )
1519 case CONFIG_HINT_CATEGORY:
1520 case CONFIG_HINT_USAGE:
1521 if( !strcmp( "main", p_parser->psz_object_name ) )
1524 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1525 module_gettext( p_parser, p_item->psz_text ) );
1527 utf8_fprintf( stdout, "\n %s\n",
1528 module_gettext( p_parser, p_item->psz_text ) );
1530 if( b_description && p_item->psz_longtext
1531 && *p_item->psz_longtext )
1534 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1535 module_gettext( p_parser, p_item->psz_longtext ) );
1537 utf8_fprintf( stdout, " %s\n",
1538 module_gettext( p_parser, p_item->psz_longtext ) );
1542 case CONFIG_HINT_SUBCATEGORY:
1543 if( strcmp( "main", p_parser->psz_object_name ) )
1545 case CONFIG_SECTION:
1549 case CONFIG_ITEM_STRING:
1550 case CONFIG_ITEM_FILE:
1551 case CONFIG_ITEM_DIRECTORY:
1552 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1553 case CONFIG_ITEM_MODULE_CAT:
1554 case CONFIG_ITEM_MODULE_LIST:
1555 case CONFIG_ITEM_MODULE_LIST_CAT:
1556 case CONFIG_ITEM_FONT:
1557 case CONFIG_ITEM_PASSWORD:
1558 print_help_section( p_parser, p_section, b_color,
1561 psz_bra = OPTION_VALUE_SEP "<";
1562 psz_type = _("string");
1565 if( p_item->ppsz_list )
1567 psz_bra = OPTION_VALUE_SEP "{";
1568 psz_type = psz_buffer;
1569 psz_buffer[0] = '\0';
1570 for( i = 0; p_item->ppsz_list[i]; i++ )
1572 if( i ) strcat( psz_buffer, "," );
1573 strcat( psz_buffer, p_item->ppsz_list[i] );
1578 case CONFIG_ITEM_INTEGER:
1579 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1580 print_help_section( p_parser, p_section, b_color,
1583 psz_bra = OPTION_VALUE_SEP "<";
1584 psz_type = _("integer");
1587 if( p_item->min.i || p_item->max.i )
1589 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1590 p_item->min.i, p_item->max.i );
1591 psz_type = psz_buffer;
1594 if( p_item->i_list )
1596 psz_bra = OPTION_VALUE_SEP "{";
1597 psz_type = psz_buffer;
1598 psz_buffer[0] = '\0';
1599 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1601 if( i ) strcat( psz_buffer, ", " );
1602 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1604 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1609 case CONFIG_ITEM_FLOAT:
1610 print_help_section( p_parser, p_section, b_color,
1613 psz_bra = OPTION_VALUE_SEP "<";
1614 psz_type = _("float");
1616 if( p_item->min.f || p_item->max.f )
1618 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1619 p_item->min.f, p_item->max.f );
1620 psz_type = psz_buffer;
1623 case CONFIG_ITEM_BOOL:
1624 print_help_section( p_parser, p_section, b_color,
1627 psz_bra = ""; psz_type = ""; psz_ket = "";
1628 if( !b_help_module )
1630 psz_suf = p_item->value.i ? _(" (default enabled)") :
1631 _(" (default disabled)");
1641 /* Add short option if any */
1642 if( p_item->i_short )
1644 sprintf( psz_short, "-%c,", p_item->i_short );
1648 strcpy( psz_short, " " );
1651 i = PADDING_SPACES - strlen( p_item->psz_name )
1652 - strlen( psz_bra ) - strlen( psz_type )
1653 - strlen( psz_ket ) - 1;
1655 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1657 psz_prefix = ", --no-";
1658 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1663 psz_spaces[0] = '\n';
1668 psz_spaces[i] = '\0';
1671 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1673 utf8_fprintf( stdout, psz_format_bool, psz_short,
1674 p_item->psz_name, psz_prefix, p_item->psz_name,
1675 psz_bra, psz_type, psz_ket, psz_spaces );
1679 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1680 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1683 psz_spaces[i] = ' ';
1685 /* We wrap the rest of the output */
1686 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1688 b_description_hack = b_description;
1691 psz_text = psz_buffer;
1692 i_cur_width = b_description && !b_description_hack
1693 ? i_width_description
1697 char *psz_parser, *psz_word;
1698 size_t i_end = strlen( psz_text );
1700 /* If the remaining text fits in a line, print it. */
1701 if( i_end <= i_cur_width )
1705 if( !b_description || b_description_hack )
1706 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1708 utf8_fprintf( stdout, "%s\n", psz_text );
1712 utf8_fprintf( stdout, "%s\n", psz_text );
1717 /* Otherwise, eat as many words as possible */
1718 psz_parser = psz_text;
1721 psz_word = psz_parser;
1722 psz_parser = strchr( psz_word, ' ' );
1723 /* If no space was found, we reached the end of the text
1724 * block; otherwise, we skip the space we just found. */
1725 psz_parser = psz_parser ? psz_parser + 1
1728 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1730 /* We cut a word in one of these cases:
1731 * - it's the only word in the line and it's too long.
1732 * - we used less than 80% of the width and the word we are
1733 * going to wrap is longer than 40% of the width, and even
1734 * if the word would have fit in the next line. */
1735 if( psz_word == psz_text
1736 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1737 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1739 char c = psz_text[i_cur_width];
1740 psz_text[i_cur_width] = '\0';
1743 if( !b_description || b_description_hack )
1744 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1745 psz_text, psz_spaces );
1747 utf8_fprintf( stdout, "%s\n%s",
1748 psz_text, psz_spaces );
1752 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1754 psz_text += i_cur_width;
1759 psz_word[-1] = '\0';
1762 if( !b_description || b_description_hack )
1763 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1764 psz_text, psz_spaces );
1766 utf8_fprintf( stdout, "%s\n%s",
1767 psz_text, psz_spaces );
1771 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1773 psz_text = psz_word;
1777 if( b_description_hack && p_item->psz_longtext
1778 && *p_item->psz_longtext )
1780 sprintf( psz_buffer, "%s%s",
1781 module_gettext( p_parser, p_item->psz_longtext ),
1783 b_description_hack = false;
1784 psz_spaces = psz_spaces_longtext;
1785 utf8_fprintf( stdout, "%s", psz_spaces );
1791 if( b_has_advanced )
1794 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1795 _( "add --advanced to your command line to see advanced options."));
1797 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1798 _( "add --advanced to your command line to see advanced options."));
1801 if( i_only_advanced > 0 )
1805 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1806 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1810 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1811 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1817 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1818 _( "No matching module found. Use --list or " \
1819 "--list-verbose to list available modules." ) );
1821 utf8_fprintf( stdout, "\n%s\n",
1822 _( "No matching module found. Use --list or " \
1823 "--list-verbose to list available modules." ) );
1826 /* Release the module list */
1827 module_list_free (list);
1830 /*****************************************************************************
1831 * ListModules: list the available modules with their description
1832 *****************************************************************************
1833 * Print a list of all available modules (builtins and plugins) and a short
1834 * description for each one.
1835 *****************************************************************************/
1836 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1840 bool b_color = var_InheritBool( p_this, "color" );
1843 ShowConsole( true );
1844 b_color = false; // don't put color control codes in a .txt file
1850 /* List all modules */
1851 module_t **list = module_list_get (NULL);
1853 /* Enumerate each module */
1854 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1857 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1858 p_parser->psz_object_name,
1859 module_gettext( p_parser, p_parser->psz_longname ) );
1861 utf8_fprintf( stdout, " %-22s %s\n",
1862 p_parser->psz_object_name,
1863 module_gettext( p_parser, p_parser->psz_longname ) );
1867 char *const *pp_shortcut = p_parser->pp_shortcuts;
1868 while( *pp_shortcut )
1870 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1873 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1876 utf8_fprintf( stdout, " s %s\n",
1881 if( p_parser->psz_capability )
1884 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1885 p_parser->psz_capability,
1886 p_parser->i_score );
1888 utf8_fprintf( stdout, " c %s (%d)\n",
1889 p_parser->psz_capability,
1890 p_parser->i_score );
1894 module_list_free (list);
1896 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1901 /*****************************************************************************
1902 * Version: print complete program version
1903 *****************************************************************************
1904 * Print complete program version and build number.
1905 *****************************************************************************/
1906 static void Version( void )
1908 extern const char psz_vlc_changeset[];
1910 ShowConsole( true );
1913 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1914 psz_vlc_changeset );
1915 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1916 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1917 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1918 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1920 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1925 /*****************************************************************************
1926 * ShowConsole: On Win32, create an output console for debug messages
1927 *****************************************************************************
1928 * This function is useful only on Win32.
1929 *****************************************************************************/
1931 static void ShowConsole( bool b_dofile )
1934 FILE *f_help = NULL;
1936 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1939 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1940 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1941 * page (e.g. CP437 or CP850). */
1942 SetConsoleOutputCP (GetACP ());
1943 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1945 freopen( "CONOUT$", "w", stderr );
1946 freopen( "CONIN$", "r", stdin );
1948 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1951 freopen( "vlc-help.txt", "wt", stdout );
1952 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1954 else freopen( "CONOUT$", "w", stdout );
1960 /*****************************************************************************
1961 * PauseConsole: On Win32, wait for a key press before closing the console
1962 *****************************************************************************
1963 * This function is useful only on Win32.
1964 *****************************************************************************/
1966 static void PauseConsole( void )
1970 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1972 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1980 /*****************************************************************************
1981 * ConsoleWidth: Return the console width in characters
1982 *****************************************************************************
1983 * We use the stty shell command to get the console width; if this fails or
1984 * if the width is less than 80, we default to 80.
1985 *****************************************************************************/
1986 static int ConsoleWidth( void )
1988 unsigned i_width = 80;
1991 FILE *file = popen( "stty size 2>/dev/null", "r" );
1994 if (fscanf (file, "%*u %u", &i_width) <= 0)
1998 #elif !defined (UNDER_CE)
1999 CONSOLE_SCREEN_BUFFER_INFO buf;
2001 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2002 i_width = buf.dwSize.X;
2008 #include <vlc_avcodec.h>
2010 void vlc_avcodec_mutex (bool acquire)
2012 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2015 vlc_mutex_lock (&lock);
2017 vlc_mutex_unlock (&lock);