Qt: remove the bottom line of the channel list widget.
[vlc/gmpfix.git] / src / libvlc.c
blobefd4952445624efa3436cd354c03e98b3b4df537
1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
5 * $Id$
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 *****************************************************************************/
28 /** \file
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
33 * Preamble
34 *****************************************************************************/
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
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() */
47 #include <string.h>
48 #include <stdlib.h> /* free() */
50 #ifndef WIN32
51 # include <netinet/in.h> /* BSD: struct in_addr */
52 #endif
54 #ifdef HAVE_UNISTD_H
55 # include <unistd.h>
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
57 # include <io.h>
58 #endif
60 #include "config/vlc_getopt.h"
62 #ifdef HAVE_LOCALE_H
63 # include <locale.h>
64 #endif
66 #ifdef HAVE_DBUS
67 /* used for one-instance mode */
68 # include <dbus/dbus.h>
69 #endif
71 #include <vlc_playlist.h>
72 #include <vlc_interface.h>
74 #include <vlc_aout.h>
75 #include "audio_output/aout_internal.h"
77 #include <vlc_charset.h>
78 #include <vlc_fs.h>
79 #include <vlc_cpu.h>
80 #include <vlc_url.h>
82 #include "libvlc.h"
84 #include "playlist/playlist_internal.h"
86 #include <vlc_vlm.h>
88 #ifdef __APPLE__
89 # include <libkern/OSAtomic.h>
90 #endif
92 #include <assert.h>
94 /*****************************************************************************
95 * The evil global variables. We handle them with care, don't worry.
96 *****************************************************************************/
97 static unsigned i_instances = 0;
99 #ifndef WIN32
100 static bool b_daemon = false;
101 #endif
103 #undef vlc_gc_init
104 #undef vlc_hold
105 #undef vlc_release
108 * Atomically set the reference count to 1.
109 * @param p_gc reference counted object
110 * @param pf_destruct destruction calback
111 * @return p_gc.
113 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
115 /* There is no point in using the GC if there is no destructor... */
116 assert (pf_destruct);
117 p_gc->pf_destructor = pf_destruct;
119 p_gc->refs = 1;
120 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
121 __sync_synchronize ();
122 #elif defined (WIN32) && defined (__GNUC__)
123 #elif defined(__APPLE__)
124 OSMemoryBarrier ();
125 #else
126 /* Nobody else can possibly lock the spin - it's there as a barrier */
127 vlc_spin_init (&p_gc->spin);
128 vlc_spin_lock (&p_gc->spin);
129 vlc_spin_unlock (&p_gc->spin);
130 #endif
131 return p_gc;
135 * Atomically increment the reference count.
136 * @param p_gc reference counted object
137 * @return p_gc.
139 void *vlc_hold (gc_object_t * p_gc)
141 uintptr_t refs;
142 assert( p_gc );
143 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
145 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
146 refs = __sync_add_and_fetch (&p_gc->refs, 1);
147 #elif defined (WIN64)
148 refs = InterlockedIncrement64 (&p_gc->refs);
149 #elif defined (WIN32)
150 refs = InterlockedIncrement (&p_gc->refs);
151 #elif defined(__APPLE__)
152 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
153 #else
154 vlc_spin_lock (&p_gc->spin);
155 refs = ++p_gc->refs;
156 vlc_spin_unlock (&p_gc->spin);
157 #endif
158 assert (refs != 1); /* there had to be a reference already */
159 return p_gc;
163 * Atomically decrement the reference count and, if it reaches zero, destroy.
164 * @param p_gc reference counted object.
166 void vlc_release (gc_object_t *p_gc)
168 unsigned refs;
170 assert( p_gc );
171 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
173 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
174 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
175 #elif defined (WIN64)
176 refs = InterlockedDecrement64 (&p_gc->refs);
177 #elif defined (WIN32)
178 refs = InterlockedDecrement (&p_gc->refs);
179 #elif defined(__APPLE__)
180 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
181 #else
182 vlc_spin_lock (&p_gc->spin);
183 refs = --p_gc->refs;
184 vlc_spin_unlock (&p_gc->spin);
185 #endif
187 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
188 if (refs == 0)
190 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
191 #elif defined (WIN32) && defined (__GNUC__)
192 #elif defined(__APPLE__)
193 #else
194 vlc_spin_destroy (&p_gc->spin);
195 #endif
196 p_gc->pf_destructor (p_gc);
200 /*****************************************************************************
201 * Local prototypes
202 *****************************************************************************/
203 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
204 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
205 static void SetLanguage ( char const * );
206 #endif
207 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
208 static void Help ( libvlc_int_t *, char const *psz_help_name );
209 static void Usage ( libvlc_int_t *, char const *psz_search );
210 static void ListModules ( libvlc_int_t *, bool );
211 static void Version ( void );
213 #ifdef WIN32
214 static void ShowConsole ( bool );
215 static void PauseConsole ( void );
216 #endif
217 static int ConsoleWidth ( void );
219 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
220 extern const char psz_vlc_changeset[];
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;
229 libvlc_priv_t *priv;
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 )
246 i_instances++;
247 vlc_mutex_unlock( &global_lock );
249 if( p_libvlc == NULL )
250 return NULL;
252 priv = libvlc_priv (p_libvlc);
253 priv->p_playlist = NULL;
254 priv->p_dialog_provider = NULL;
255 priv->p_vlm = NULL;
257 /* Initialize message queue */
258 priv->msg_bank = msg_Create ();
259 if (unlikely(priv->msg_bank == NULL))
260 goto error;
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 );
266 else
267 priv->i_verbose = 3;
268 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
269 priv->b_color = isatty( 2 ); /* 2 is for stderr */
270 #else
271 priv->b_color = false;
272 #endif
274 /* Initialize mutexes */
275 vlc_mutex_init( &priv->timer_lock );
276 vlc_ExitInit( &priv->exit );
278 return p_libvlc;
279 error:
280 vlc_object_release (p_libvlc);
281 return NULL;
285 * Initialize a libvlc instance
286 * This function initializes a previously allocated libvlc instance:
287 * - CPU detection
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);
296 char * p_tmp = NULL;
297 char * psz_modules = NULL;
298 char * psz_parser = NULL;
299 char * psz_control = NULL;
300 bool b_exit = false;
301 int i_ret = VLC_EEXIT;
302 playlist_t *p_playlist = NULL;
303 char *psz_val;
304 #if defined( ENABLE_NLS ) \
305 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
306 # if defined (WIN32) || defined (__APPLE__)
307 char * psz_language;
308 #endif
309 #endif
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
322 * options) */
323 module_InitBank( p_libvlc );
325 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
327 module_EndBank( p_libvlc, false );
328 return VLC_EGENERIC;
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, "VLC media player - %s", VERSION_MESSAGE );
334 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
335 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
336 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
337 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
338 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
340 /* Check for short help option */
341 if( var_InheritBool( p_libvlc, "help" ) )
343 Help( p_libvlc, "help" );
344 b_exit = true;
345 i_ret = VLC_EEXITSUCCESS;
347 /* Check for version option */
348 else if( var_InheritBool( p_libvlc, "version" ) )
350 Version();
351 b_exit = true;
352 i_ret = VLC_EEXITSUCCESS;
355 /* Check for daemon mode */
356 #ifndef WIN32
357 if( var_InheritBool( p_libvlc, "daemon" ) )
359 #ifdef HAVE_DAEMON
360 char *psz_pidfile = NULL;
362 if( daemon( 1, 0) != 0 )
364 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
365 b_exit = true;
367 b_daemon = true;
369 /* lets check if we need to write the pidfile */
370 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
371 if( psz_pidfile != NULL )
373 FILE *pidfile;
374 pid_t i_pid = getpid ();
375 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
376 i_pid, psz_pidfile );
377 pidfile = vlc_fopen( psz_pidfile,"w" );
378 if( pidfile != NULL )
380 utf8_fprintf( pidfile, "%d", (int)i_pid );
381 fclose( pidfile );
383 else
385 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
386 psz_pidfile );
389 free( psz_pidfile );
391 #else
392 pid_t i_pid;
394 if( ( i_pid = fork() ) < 0 )
396 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
397 b_exit = true;
399 else if( i_pid )
401 /* This is the parent, exit right now */
402 msg_Dbg( p_libvlc, "closing parent process" );
403 b_exit = true;
404 i_ret = VLC_EEXITSUCCESS;
406 else
408 /* We are the child */
409 msg_Dbg( p_libvlc, "daemon spawned" );
410 close( STDIN_FILENO );
411 close( STDOUT_FILENO );
412 close( STDERR_FILENO );
414 b_daemon = true;
416 #endif
418 #endif
420 if( b_exit )
422 module_EndBank( p_libvlc, false );
423 return i_ret;
426 /* Check for translation config option */
427 #if defined( ENABLE_NLS ) \
428 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
429 # if defined (WIN32) || defined (__APPLE__)
430 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
431 config_LoadConfigFile( p_libvlc, "main" );
432 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
434 /* Check if the user specified a custom language */
435 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
436 if( psz_language && strcmp( psz_language, "auto" ) )
438 /* Reset the default domain */
439 SetLanguage( psz_language );
441 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
442 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
444 free( psz_language );
445 # endif
446 #endif
449 * Load the builtins and plugins into the module_bank.
450 * We have to do it before config_Load*() because this also gets the
451 * list of configuration options exported by each module and loads their
452 * default values.
454 module_LoadPlugins( p_libvlc );
455 if( p_libvlc->b_die )
457 b_exit = true;
460 size_t module_count;
461 module_t **list = module_list_get( &module_count );
462 module_list_free( list );
463 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
465 /* Check for help on modules */
466 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
468 Help( p_libvlc, p_tmp );
469 free( p_tmp );
470 b_exit = true;
471 i_ret = VLC_EEXITSUCCESS;
473 /* Check for full help option */
474 else if( var_InheritBool( p_libvlc, "full-help" ) )
476 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
477 var_SetBool( p_libvlc, "advanced", true );
478 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
479 var_SetBool( p_libvlc, "help-verbose", true );
480 Help( p_libvlc, "full-help" );
481 b_exit = true;
482 i_ret = VLC_EEXITSUCCESS;
484 /* Check for long help option */
485 else if( var_InheritBool( p_libvlc, "longhelp" ) )
487 Help( p_libvlc, "longhelp" );
488 b_exit = true;
489 i_ret = VLC_EEXITSUCCESS;
491 /* Check for module list option */
492 else if( var_InheritBool( p_libvlc, "list" ) )
494 ListModules( p_libvlc, false );
495 b_exit = true;
496 i_ret = VLC_EEXITSUCCESS;
498 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
500 ListModules( p_libvlc, true );
501 b_exit = true;
502 i_ret = VLC_EEXITSUCCESS;
505 /* Check for config file options */
506 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
508 if( var_InheritBool( p_libvlc, "reset-config" ) )
510 config_ResetAll( p_libvlc );
511 config_SaveConfigFile( p_libvlc, NULL );
515 if( module_count <= 1)
517 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
518 "that you properly gave a module path with --plugin-path.");
519 b_exit = true;
520 i_ret = VLC_ENOITEM;
523 if( b_exit )
525 module_EndBank( p_libvlc, true );
526 return i_ret;
530 * Override default configuration with config file settings
532 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
533 config_LoadConfigFile( p_libvlc, NULL );
536 * Override configuration with command line settings
538 int vlc_optind;
539 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
541 #ifdef WIN32
542 ShowConsole( false );
543 /* Pause the console because it's destroyed when we exit */
544 fprintf( stderr, "The command line options couldn't be loaded, check "
545 "that they are valid.\n" );
546 PauseConsole();
547 #endif
548 module_EndBank( p_libvlc, true );
549 return VLC_EGENERIC;
551 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
553 /* FIXME: could be replaced by using Unix sockets */
554 #ifdef HAVE_DBUS
555 dbus_threads_init_default();
557 if( var_InheritBool( p_libvlc, "one-instance" )
558 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
559 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
561 /* Initialise D-Bus interface, check for other instances */
562 DBusConnection *p_conn = NULL;
563 DBusError dbus_error;
565 dbus_error_init( &dbus_error );
567 /* connect to the session bus */
568 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
569 if( !p_conn )
571 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
572 dbus_error.message );
573 dbus_error_free( &dbus_error );
575 else
577 /* check if VLC is available on the bus
578 * if not: D-Bus control is not enabled on the other
579 * instance and we can't pass MRLs to it */
580 DBusMessage *p_test_msg = NULL;
581 DBusMessage *p_test_reply = NULL;
582 p_test_msg = dbus_message_new_method_call(
583 "org.mpris.vlc", "/",
584 "org.freedesktop.MediaPlayer", "Identity" );
585 /* block until a reply arrives */
586 p_test_reply = dbus_connection_send_with_reply_and_block(
587 p_conn, p_test_msg, -1, &dbus_error );
588 dbus_message_unref( p_test_msg );
589 if( p_test_reply == NULL )
591 dbus_error_free( &dbus_error );
592 msg_Dbg( p_libvlc, "No Media Player is running. "
593 "Continuing normally." );
595 else
597 int i_input;
598 DBusMessage* p_dbus_msg = NULL;
599 DBusMessageIter dbus_args;
600 DBusPendingCall* p_dbus_pending = NULL;
601 dbus_bool_t b_play;
603 dbus_message_unref( p_test_reply );
604 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
606 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
608 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
609 ppsz_argv[i_input] );
611 p_dbus_msg = dbus_message_new_method_call(
612 "org.mpris.vlc", "/TrackList",
613 "org.freedesktop.MediaPlayer", "AddTrack" );
615 if ( NULL == p_dbus_msg )
617 msg_Err( p_libvlc, "D-Bus problem" );
618 system_End( p_libvlc );
619 exit( 1 );
622 /* append MRLs */
623 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
624 if ( !dbus_message_iter_append_basic( &dbus_args,
625 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
627 dbus_message_unref( p_dbus_msg );
628 system_End( p_libvlc );
629 exit( 1 );
631 b_play = TRUE;
632 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
633 b_play = FALSE;
634 if ( !dbus_message_iter_append_basic( &dbus_args,
635 DBUS_TYPE_BOOLEAN, &b_play ) )
637 dbus_message_unref( p_dbus_msg );
638 system_End( p_libvlc );
639 exit( 1 );
642 /* send message and get a handle for a reply */
643 if ( !dbus_connection_send_with_reply ( p_conn,
644 p_dbus_msg, &p_dbus_pending, -1 ) )
646 msg_Err( p_libvlc, "D-Bus problem" );
647 dbus_message_unref( p_dbus_msg );
648 system_End( p_libvlc );
649 exit( 1 );
652 if ( NULL == p_dbus_pending )
654 msg_Err( p_libvlc, "D-Bus problem" );
655 dbus_message_unref( p_dbus_msg );
656 system_End( p_libvlc );
657 exit( 1 );
659 dbus_connection_flush( p_conn );
660 dbus_message_unref( p_dbus_msg );
661 /* block until we receive a reply */
662 dbus_pending_call_block( p_dbus_pending );
663 dbus_pending_call_unref( p_dbus_pending );
664 } /* processes all command line MRLs */
666 /* bye bye */
667 system_End( p_libvlc );
668 exit( 0 );
671 /* we unreference the connection when we've finished with it */
672 if( p_conn ) dbus_connection_unref( p_conn );
674 #endif
677 * Message queue options
679 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
680 if( psz_verbose_objects )
682 char * psz_object, * iter = psz_verbose_objects;
683 while( (psz_object = strsep( &iter, "," )) )
685 switch( psz_object[0] )
687 printf("%s\n", psz_object+1);
688 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
689 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
690 default:
691 msg_Err( p_libvlc, "verbose-objects usage: \n"
692 "--verbose-objects=+printthatobject,"
693 "-dontprintthatone\n"
694 "(keyword 'all' to applies to all objects)");
695 free( psz_verbose_objects );
696 /* FIXME: leaks!!!! */
697 return VLC_EGENERIC;
700 free( psz_verbose_objects );
703 /* Last chance to set the verbosity. Once we start interfaces and other
704 * threads, verbosity becomes read-only. */
705 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
706 if( var_InheritBool( p_libvlc, "quiet" ) )
708 var_SetInteger( p_libvlc, "verbose", -1 );
709 priv->i_verbose = -1;
711 vlc_threads_setup( p_libvlc );
713 if( priv->b_color )
714 priv->b_color = var_InheritBool( p_libvlc, "color" );
716 char p_capabilities[200];
717 #define PRINT_CAPABILITY( capability, string ) \
718 if( vlc_CPU() & capability ) \
720 strncat( p_capabilities, string " ", \
721 sizeof(p_capabilities) - strlen(p_capabilities) ); \
722 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
724 p_capabilities[0] = '\0';
726 #if defined( __i386__ ) || defined( __x86_64__ )
727 if( !var_InheritBool( p_libvlc, "mmx" ) )
728 cpu_flags &= ~CPU_CAPABILITY_MMX;
729 if( !var_InheritBool( p_libvlc, "3dn" ) )
730 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
731 if( !var_InheritBool( p_libvlc, "mmxext" ) )
732 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
733 if( !var_InheritBool( p_libvlc, "sse" ) )
734 cpu_flags &= ~CPU_CAPABILITY_SSE;
735 if( !var_InheritBool( p_libvlc, "sse2" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSE2;
737 if( !var_InheritBool( p_libvlc, "sse3" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSE3;
739 if( !var_InheritBool( p_libvlc, "ssse3" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
741 if( !var_InheritBool( p_libvlc, "sse41" ) )
742 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
743 if( !var_InheritBool( p_libvlc, "sse42" ) )
744 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
746 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
754 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
755 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
757 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
758 if( !var_InheritBool( p_libvlc, "altivec" ) )
759 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
761 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
763 #elif defined( __arm__ )
764 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
766 #endif
768 #if HAVE_FPU
769 strncat( p_capabilities, "FPU ",
770 sizeof(p_capabilities) - strlen( p_capabilities) );
771 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
772 #endif
774 if (p_capabilities[0])
775 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
778 * Choose the best memcpy module
780 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
781 /* Avoid being called "memcpy":*/
782 vlc_object_set_name( p_libvlc, "main" );
784 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
785 priv->i_timers = 0;
786 priv->pp_timers = NULL;
788 priv->i_last_input_id = 0; /* Not very safe, should be removed */
791 * Initialize hotkey handling
793 vlc_InitActions( p_libvlc );
795 /* Create a variable for showing the fullscreen interface */
796 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
797 var_SetBool( p_libvlc, "intf-show", true );
799 /* Create a variable for showing the right click menu */
800 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
802 /* variables for signalling creation of new files */
803 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
804 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
806 /* Initialize playlist and get commandline files */
807 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
808 if( !p_playlist )
810 msg_Err( p_libvlc, "playlist initialization failed" );
811 if( priv->p_memcpy_module != NULL )
813 module_unneed( p_libvlc, priv->p_memcpy_module );
815 module_EndBank( p_libvlc, true );
816 return VLC_EGENERIC;
819 /* System specific configuration */
820 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
822 /* Add service discovery modules */
823 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
824 if( psz_modules )
826 char *p = psz_modules, *m;
827 while( ( m = strsep( &p, " :," ) ) != NULL )
828 playlist_ServicesDiscoveryAdd( p_playlist, m );
829 free( psz_modules );
832 #ifdef ENABLE_VLM
833 /* Initialize VLM if vlm-conf is specified */
834 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
835 if( psz_parser )
837 priv->p_vlm = vlm_New( p_libvlc );
838 if( !priv->p_vlm )
839 msg_Err( p_libvlc, "VLM initialization failed" );
841 free( psz_parser );
842 #endif
845 * Load background interfaces
847 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
848 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
850 if( psz_modules && psz_control )
852 char* psz_tmp;
853 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
855 free( psz_modules );
856 psz_modules = psz_tmp;
859 else if( psz_control )
861 free( psz_modules );
862 psz_modules = strdup( psz_control );
865 psz_parser = psz_modules;
866 while ( psz_parser && *psz_parser )
868 char *psz_module, *psz_temp;
869 psz_module = psz_parser;
870 psz_parser = strchr( psz_module, ':' );
871 if ( psz_parser )
873 *psz_parser = '\0';
874 psz_parser++;
876 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
878 intf_Create( p_libvlc, psz_temp );
879 free( psz_temp );
882 free( psz_modules );
883 free( psz_control );
886 * Always load the hotkeys interface if it exists
888 intf_Create( p_libvlc, "hotkeys,none" );
890 #ifdef HAVE_DBUS
891 /* loads dbus control interface if in one-instance mode
892 * we do it only when playlist exists, because dbus module needs it */
893 if( var_InheritBool( p_libvlc, "one-instance" )
894 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
895 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
896 intf_Create( p_libvlc, "dbus,none" );
898 # if !defined (HAVE_MAEMO)
899 /* Prevents the power management daemon from suspending the system
900 * when VLC is active */
901 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
902 intf_Create( p_libvlc, "inhibit,none" );
903 # endif
904 #endif
906 if( var_InheritBool( p_libvlc, "file-logging" ) &&
907 !var_InheritBool( p_libvlc, "syslog" ) )
909 intf_Create( p_libvlc, "logger,none" );
911 #ifdef HAVE_SYSLOG_H
912 if( var_InheritBool( p_libvlc, "syslog" ) )
914 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
915 var_SetString( p_libvlc, "logmode", "syslog" );
916 intf_Create( p_libvlc, "logger,none" );
918 if( logmode )
920 var_SetString( p_libvlc, "logmode", logmode );
921 free( logmode );
923 var_Destroy( p_libvlc, "logmode" );
925 #endif
927 if( var_InheritBool( p_libvlc, "network-synchronisation") )
929 intf_Create( p_libvlc, "netsync,none" );
932 #ifdef WIN32
933 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
935 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
936 if( psz_codecs )
938 char *psz_morecodecs;
939 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
941 var_SetString( p_libvlc, "codec", psz_morecodecs);
942 free( psz_morecodecs );
944 free( psz_codecs );
946 else
947 var_SetString( p_libvlc, "codec", "dmo,quicktime");
949 #endif
951 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
953 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
954 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
956 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
957 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
958 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
959 #ifdef WIN32
960 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
961 #endif
964 * Get input filenames given as commandline arguments.
965 * We assume that the remaining parameters are filenames
966 * and their input options.
968 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
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 );
978 free( psz_val );
981 return VLC_SUCCESS;
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 );
1006 #ifdef ENABLE_VLM
1007 /* Destroy VLM if created in libvlc_InternalInit */
1008 if( priv->p_vlm )
1010 vlm_Delete( priv->p_vlm );
1012 #endif
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" );
1022 #ifndef WIN32
1023 char* psz_pidfile = NULL;
1025 if( b_daemon )
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",
1034 psz_pidfile );
1037 free( psz_pidfile );
1039 #endif
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 );
1065 i_instances--;
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_ExitDestroy( &priv->exit );
1078 vlc_mutex_destroy( &priv->timer_lock );
1080 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1081 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1082 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1083 vlc_object_release( p_libvlc );
1084 #endif
1086 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1087 vlc_object_release( p_libvlc );
1091 * Add an interface plugin and run it
1093 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1095 if( !p_libvlc )
1096 return VLC_EGENERIC;
1098 if( !psz_module ) /* requesting the default interface */
1100 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1101 if( !psz_interface ) /* "intf" has not been set */
1103 #ifndef WIN32
1104 if( b_daemon )
1105 /* Daemon mode hack.
1106 * We prefer the dummy interface if none is specified. */
1107 psz_module = "dummy";
1108 else
1109 #endif
1110 msg_Info( p_libvlc, "%s",
1111 _("Running vlc with the default interface. "
1112 "Use 'cvlc' to use vlc without interface.") );
1114 free( psz_interface );
1115 var_Destroy( p_libvlc, "intf" );
1118 /* Try to create the interface */
1119 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1120 if( ret )
1121 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1122 psz_module ? psz_module : "default" );
1123 return ret;
1126 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1127 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1128 /*****************************************************************************
1129 * SetLanguage: set the interface language.
1130 *****************************************************************************
1131 * We set the LC_MESSAGES locale category for interface messages and buttons,
1132 * as well as the LC_CTYPE category for string sorting and possible wide
1133 * character support.
1134 *****************************************************************************/
1135 static void SetLanguage ( const char *psz_lang )
1137 #ifdef __APPLE__
1138 /* I need that under Darwin, please check it doesn't disturb
1139 * other platforms. --Meuuh */
1140 setenv( "LANG", psz_lang, 1 );
1142 #else
1143 /* We set LC_ALL manually because it is the only way to set
1144 * the language at runtime under eg. Windows. Beware that this
1145 * makes the environment unconsistent when libvlc is unloaded and
1146 * should probably be moved to a safer place like vlc.c. */
1147 static char psz_lcall[20];
1148 snprintf( psz_lcall, sizeof(psz_lcall), "LC_ALL=%s", psz_lang );
1149 putenv( psz_lcall );
1150 #endif
1152 setlocale( LC_ALL, psz_lang );
1154 #endif
1156 /*****************************************************************************
1157 * GetFilenames: parse command line options which are not flags
1158 *****************************************************************************
1159 * Parse command line for input files as well as their associated options.
1160 * An option always follows its associated input and begins with a ":".
1161 *****************************************************************************/
1162 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1163 const char *const args[] )
1165 while( n > 0 )
1167 /* Count the input options */
1168 unsigned i_options = 0;
1170 while( args[--n][0] == ':' )
1172 i_options++;
1173 if( n == 0 )
1175 msg_Warn( p_vlc, "options %s without item", args[n] );
1176 return; /* syntax!? */
1180 /* TODO: write an internal function of this one, to avoid
1181 * unnecessary lookups. */
1182 char *mrl = make_URI( args[n] );
1183 if( !mrl )
1184 continue;
1186 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1187 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1188 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1189 free( mrl );
1193 /*****************************************************************************
1194 * Help: print program help
1195 *****************************************************************************
1196 * Print a short inline help. Message interface is initialized at this stage.
1197 *****************************************************************************/
1198 static inline void print_help_on_full_help( void )
1200 utf8_fprintf( stdout, "\n" );
1201 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1204 static const char vlc_usage[] = N_(
1205 "Usage: %s [options] [stream] ..."
1206 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1207 "\nThe first item specified will be played first."
1208 "\n"
1209 "\nOptions-styles:"
1210 "\n --option A global option that is set for the duration of the program."
1211 "\n -option A single letter version of a global --option."
1212 "\n :option An option that only applies to the stream directly before it"
1213 "\n and that overrides previous settings."
1214 "\n"
1215 "\nStream MRL syntax:"
1216 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1217 "\n"
1218 "\n Many of the global --options can also be used as MRL specific :options."
1219 "\n Multiple :option=value pairs can be specified."
1220 "\n"
1221 "\nURL syntax:"
1222 "\n [file://]filename Plain media file"
1223 "\n http://ip:port/file HTTP URL"
1224 "\n ftp://ip:port/file FTP URL"
1225 "\n mms://ip:port/file MMS URL"
1226 "\n screen:// Screen capture"
1227 "\n [dvd://][device][@raw_device] DVD device"
1228 "\n [vcd://][device] VCD device"
1229 "\n [cdda://][device] Audio CD device"
1230 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1231 "\n UDP stream sent by a streaming server"
1232 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1233 "\n vlc://quit Special item to quit VLC"
1234 "\n");
1236 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1238 #ifdef WIN32
1239 ShowConsole( true );
1240 #endif
1242 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1244 utf8_fprintf( stdout, vlc_usage, "vlc" );
1245 Usage( p_this, "=help" );
1246 Usage( p_this, "=main" );
1247 print_help_on_full_help();
1249 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1251 utf8_fprintf( stdout, vlc_usage, "vlc" );
1252 Usage( p_this, NULL );
1253 print_help_on_full_help();
1255 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1257 utf8_fprintf( stdout, vlc_usage, "vlc" );
1258 Usage( p_this, NULL );
1260 else if( psz_help_name )
1262 Usage( p_this, psz_help_name );
1265 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1266 PauseConsole();
1267 #endif
1270 /*****************************************************************************
1271 * Usage: print module usage
1272 *****************************************************************************
1273 * Print a short inline help. Message interface is initialized at this stage.
1274 *****************************************************************************/
1275 # define COL(x) "\033[" #x ";1m"
1276 # define RED COL(31)
1277 # define GREEN COL(32)
1278 # define YELLOW COL(33)
1279 # define BLUE COL(34)
1280 # define MAGENTA COL(35)
1281 # define CYAN COL(36)
1282 # define WHITE COL(0)
1283 # define GRAY "\033[0m"
1284 static void
1285 print_help_section( const module_t *m, const module_config_t *p_item,
1286 bool b_color, bool b_description )
1288 if( !p_item ) return;
1289 if( b_color )
1291 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1292 module_gettext( m, p_item->psz_text ) );
1293 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1294 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1295 module_gettext( m, p_item->psz_longtext ) );
1297 else
1299 utf8_fprintf( stdout, " %s:\n",
1300 module_gettext( m, p_item->psz_text ) );
1301 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1302 utf8_fprintf( stdout, " %s\n",
1303 module_gettext(m, p_item->psz_longtext ) );
1307 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1309 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1310 /* short option ------' | | | | | | |
1311 * option name ------------' | | | | | |
1312 * <bra ---------------------' | | | | |
1313 * option type or "" ----------' | | | |
1314 * ket> -------------------------' | | |
1315 * padding spaces -----------------' | |
1316 * comment --------------------------' |
1317 * comment suffix ---------------------'
1319 * The purpose of having bra and ket is that we might i18n them as well.
1322 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1323 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1325 #define LINE_START 8
1326 #define PADDING_SPACES 25
1327 #ifdef WIN32
1328 # define OPTION_VALUE_SEP "="
1329 #else
1330 # define OPTION_VALUE_SEP " "
1331 #endif
1332 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1333 char psz_spaces_longtext[LINE_START+3];
1334 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1335 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1336 char psz_buffer[10000];
1337 char psz_short[4];
1338 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1339 int i_width_description = i_width + PADDING_SPACES - 1;
1340 bool b_advanced = var_InheritBool( p_this, "advanced" );
1341 bool b_description = var_InheritBool( p_this, "help-verbose" );
1342 bool b_description_hack;
1343 bool b_color = var_InheritBool( p_this, "color" );
1344 bool b_has_advanced = false;
1345 bool b_found = false;
1346 int i_only_advanced = 0; /* Number of modules ignored because they
1347 * only have advanced options */
1348 bool b_strict = psz_search && *psz_search == '=';
1349 if( b_strict ) psz_search++;
1351 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1352 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1353 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1354 psz_spaces_longtext[LINE_START+2] = '\0';
1355 #ifndef WIN32
1356 if( !isatty( 1 ) )
1357 #endif
1358 b_color = false; // don't put color control codes in a .txt file
1360 if( b_color )
1362 strcpy( psz_format, COLOR_FORMAT_STRING );
1363 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1365 else
1367 strcpy( psz_format, FORMAT_STRING );
1368 strcpy( psz_format_bool, FORMAT_STRING );
1371 /* List all modules */
1372 module_t **list = module_list_get (NULL);
1373 if (!list)
1374 return;
1376 /* Ugly hack to make sure that the help options always come first
1377 * (part 1) */
1378 if( !psz_search )
1379 Usage( p_this, "help" );
1381 /* Enumerate the config for each module */
1382 for (size_t i = 0; list[i]; i++)
1384 bool b_help_module;
1385 module_t *p_parser = list[i];
1386 module_config_t *p_item = NULL;
1387 module_config_t *p_section = NULL;
1388 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1390 if( psz_search &&
1391 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1392 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1394 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1395 unsigned i;
1396 for( i = 0; i < p_parser->i_shortcuts; i++ )
1398 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1399 : !!strstr( pp_shortcuts[i], psz_search ) )
1400 break;
1402 if( i == p_parser->i_shortcuts )
1403 continue;
1406 /* Ignore modules without config options */
1407 if( !p_parser->i_config_items )
1409 continue;
1412 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1413 /* Ugly hack to make sure that the help options always come first
1414 * (part 2) */
1415 if( !psz_search && b_help_module )
1416 continue;
1418 /* Ignore modules with only advanced config options if requested */
1419 if( !b_advanced )
1421 for( p_item = p_parser->p_config;
1422 p_item < p_end;
1423 p_item++ )
1425 if( (p_item->i_type & CONFIG_ITEM) &&
1426 !p_item->b_advanced && !p_item->b_removed ) break;
1429 if( p_item == p_end )
1431 i_only_advanced++;
1432 continue;
1436 b_found = true;
1438 /* Print name of module */
1439 if( strcmp( "main", p_parser->psz_object_name ) )
1441 if( b_color )
1442 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1443 module_gettext( p_parser, p_parser->psz_longname ),
1444 p_parser->psz_object_name );
1445 else
1446 utf8_fprintf( stdout, "\n %s\n",
1447 module_gettext(p_parser, p_parser->psz_longname ) );
1449 if( p_parser->psz_help )
1451 if( b_color )
1452 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1453 module_gettext( p_parser, p_parser->psz_help ) );
1454 else
1455 utf8_fprintf( stdout, " %s\n",
1456 module_gettext( p_parser, p_parser->psz_help ) );
1459 /* Print module options */
1460 for( p_item = p_parser->p_config;
1461 p_item < p_end;
1462 p_item++ )
1464 char *psz_text, *psz_spaces = psz_spaces_text;
1465 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1466 const char *psz_suf = "", *psz_prefix = NULL;
1467 signed int i;
1468 size_t i_cur_width;
1470 /* Skip removed options */
1471 if( p_item->b_removed )
1473 continue;
1475 /* Skip advanced options if requested */
1476 if( p_item->b_advanced && !b_advanced )
1478 b_has_advanced = true;
1479 continue;
1482 switch( p_item->i_type )
1484 case CONFIG_HINT_CATEGORY:
1485 case CONFIG_HINT_USAGE:
1486 if( !strcmp( "main", p_parser->psz_object_name ) )
1488 if( b_color )
1489 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1490 module_gettext( p_parser, p_item->psz_text ) );
1491 else
1492 utf8_fprintf( stdout, "\n %s\n",
1493 module_gettext( p_parser, p_item->psz_text ) );
1495 if( b_description && p_item->psz_longtext
1496 && *p_item->psz_longtext )
1498 if( b_color )
1499 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1500 module_gettext( p_parser, p_item->psz_longtext ) );
1501 else
1502 utf8_fprintf( stdout, " %s\n",
1503 module_gettext( p_parser, p_item->psz_longtext ) );
1505 break;
1507 case CONFIG_HINT_SUBCATEGORY:
1508 if( strcmp( "main", p_parser->psz_object_name ) )
1509 break;
1510 case CONFIG_SECTION:
1511 p_section = p_item;
1512 break;
1514 case CONFIG_ITEM_STRING:
1515 case CONFIG_ITEM_FILE:
1516 case CONFIG_ITEM_DIRECTORY:
1517 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1518 case CONFIG_ITEM_MODULE_CAT:
1519 case CONFIG_ITEM_MODULE_LIST:
1520 case CONFIG_ITEM_MODULE_LIST_CAT:
1521 case CONFIG_ITEM_FONT:
1522 case CONFIG_ITEM_PASSWORD:
1523 print_help_section( p_parser, p_section, b_color,
1524 b_description );
1525 p_section = NULL;
1526 psz_bra = OPTION_VALUE_SEP "<";
1527 psz_type = _("string");
1528 psz_ket = ">";
1530 if( p_item->ppsz_list )
1532 psz_bra = OPTION_VALUE_SEP "{";
1533 psz_type = psz_buffer;
1534 psz_buffer[0] = '\0';
1535 for( i = 0; p_item->ppsz_list[i]; i++ )
1537 if( i ) strcat( psz_buffer, "," );
1538 strcat( psz_buffer, p_item->ppsz_list[i] );
1540 psz_ket = "}";
1542 break;
1543 case CONFIG_ITEM_INTEGER:
1544 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1545 print_help_section( p_parser, p_section, b_color,
1546 b_description );
1547 p_section = NULL;
1548 psz_bra = OPTION_VALUE_SEP "<";
1549 psz_type = _("integer");
1550 psz_ket = ">";
1552 if( p_item->min.i || p_item->max.i )
1554 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1555 p_item->min.i, p_item->max.i );
1556 psz_type = psz_buffer;
1559 if( p_item->i_list )
1561 psz_bra = OPTION_VALUE_SEP "{";
1562 psz_type = psz_buffer;
1563 psz_buffer[0] = '\0';
1564 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1566 if( i ) strcat( psz_buffer, ", " );
1567 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1568 p_item->pi_list[i],
1569 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1571 psz_ket = "}";
1573 break;
1574 case CONFIG_ITEM_FLOAT:
1575 print_help_section( p_parser, p_section, b_color,
1576 b_description );
1577 p_section = NULL;
1578 psz_bra = OPTION_VALUE_SEP "<";
1579 psz_type = _("float");
1580 psz_ket = ">";
1581 if( p_item->min.f || p_item->max.f )
1583 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1584 p_item->min.f, p_item->max.f );
1585 psz_type = psz_buffer;
1587 break;
1588 case CONFIG_ITEM_BOOL:
1589 print_help_section( p_parser, p_section, b_color,
1590 b_description );
1591 p_section = NULL;
1592 psz_bra = ""; psz_type = ""; psz_ket = "";
1593 if( !b_help_module )
1595 psz_suf = p_item->value.i ? _(" (default enabled)") :
1596 _(" (default disabled)");
1598 break;
1601 if( !psz_type )
1603 continue;
1606 /* Add short option if any */
1607 if( p_item->i_short )
1609 sprintf( psz_short, "-%c,", p_item->i_short );
1611 else
1613 strcpy( psz_short, " " );
1616 i = PADDING_SPACES - strlen( p_item->psz_name )
1617 - strlen( psz_bra ) - strlen( psz_type )
1618 - strlen( psz_ket ) - 1;
1620 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1622 psz_prefix = ", --no-";
1623 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1626 if( i < 0 )
1628 psz_spaces[0] = '\n';
1629 i = 0;
1631 else
1633 psz_spaces[i] = '\0';
1636 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1638 utf8_fprintf( stdout, psz_format_bool, psz_short,
1639 p_item->psz_name, psz_prefix, p_item->psz_name,
1640 psz_bra, psz_type, psz_ket, psz_spaces );
1642 else
1644 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1645 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1648 psz_spaces[i] = ' ';
1650 /* We wrap the rest of the output */
1651 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1652 psz_suf );
1653 b_description_hack = b_description;
1655 description:
1656 psz_text = psz_buffer;
1657 i_cur_width = b_description && !b_description_hack
1658 ? i_width_description
1659 : i_width;
1660 while( *psz_text )
1662 char *psz_parser, *psz_word;
1663 size_t i_end = strlen( psz_text );
1665 /* If the remaining text fits in a line, print it. */
1666 if( i_end <= i_cur_width )
1668 if( b_color )
1670 if( !b_description || b_description_hack )
1671 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1672 else
1673 utf8_fprintf( stdout, "%s\n", psz_text );
1675 else
1677 utf8_fprintf( stdout, "%s\n", psz_text );
1679 break;
1682 /* Otherwise, eat as many words as possible */
1683 psz_parser = psz_text;
1686 psz_word = psz_parser;
1687 psz_parser = strchr( psz_word, ' ' );
1688 /* If no space was found, we reached the end of the text
1689 * block; otherwise, we skip the space we just found. */
1690 psz_parser = psz_parser ? psz_parser + 1
1691 : psz_text + i_end;
1693 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1695 /* We cut a word in one of these cases:
1696 * - it's the only word in the line and it's too long.
1697 * - we used less than 80% of the width and the word we are
1698 * going to wrap is longer than 40% of the width, and even
1699 * if the word would have fit in the next line. */
1700 if( psz_word == psz_text
1701 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1702 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1704 char c = psz_text[i_cur_width];
1705 psz_text[i_cur_width] = '\0';
1706 if( b_color )
1708 if( !b_description || b_description_hack )
1709 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1710 psz_text, psz_spaces );
1711 else
1712 utf8_fprintf( stdout, "%s\n%s",
1713 psz_text, psz_spaces );
1715 else
1717 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1719 psz_text += i_cur_width;
1720 psz_text[0] = c;
1722 else
1724 psz_word[-1] = '\0';
1725 if( b_color )
1727 if( !b_description || b_description_hack )
1728 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1729 psz_text, psz_spaces );
1730 else
1731 utf8_fprintf( stdout, "%s\n%s",
1732 psz_text, psz_spaces );
1734 else
1736 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1738 psz_text = psz_word;
1742 if( b_description_hack && p_item->psz_longtext
1743 && *p_item->psz_longtext )
1745 sprintf( psz_buffer, "%s%s",
1746 module_gettext( p_parser, p_item->psz_longtext ),
1747 psz_suf );
1748 b_description_hack = false;
1749 psz_spaces = psz_spaces_longtext;
1750 utf8_fprintf( stdout, "%s", psz_spaces );
1751 goto description;
1756 if( b_has_advanced )
1758 if( b_color )
1759 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1760 _( "add --advanced to your command line to see advanced options."));
1761 else
1762 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1763 _( "add --advanced to your command line to see advanced options."));
1766 if( i_only_advanced > 0 )
1768 if( b_color )
1770 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1771 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1773 else
1775 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1776 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1779 else if( !b_found )
1781 if( b_color )
1782 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1783 _( "No matching module found. Use --list or " \
1784 "--list-verbose to list available modules." ) );
1785 else
1786 utf8_fprintf( stdout, "\n%s\n",
1787 _( "No matching module found. Use --list or " \
1788 "--list-verbose to list available modules." ) );
1791 /* Release the module list */
1792 module_list_free (list);
1795 /*****************************************************************************
1796 * ListModules: list the available modules with their description
1797 *****************************************************************************
1798 * Print a list of all available modules (builtins and plugins) and a short
1799 * description for each one.
1800 *****************************************************************************/
1801 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1803 module_t *p_parser;
1805 bool b_color = var_InheritBool( p_this, "color" );
1807 #ifdef WIN32
1808 ShowConsole( true );
1809 b_color = false; // don't put color control codes in a .txt file
1810 #else
1811 if( !isatty( 1 ) )
1812 b_color = false;
1813 #endif
1815 /* List all modules */
1816 module_t **list = module_list_get (NULL);
1818 /* Enumerate each module */
1819 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1821 if( b_color )
1822 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1823 p_parser->psz_object_name,
1824 module_gettext( p_parser, p_parser->psz_longname ) );
1825 else
1826 utf8_fprintf( stdout, " %-22s %s\n",
1827 p_parser->psz_object_name,
1828 module_gettext( p_parser, p_parser->psz_longname ) );
1830 if( b_verbose )
1832 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1833 for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1835 if( strcmp( pp_shortcuts[i], p_parser->psz_object_name ) )
1837 if( b_color )
1838 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1839 pp_shortcuts[i] );
1840 else
1841 utf8_fprintf( stdout, " s %s\n",
1842 pp_shortcuts[i] );
1845 if( p_parser->psz_capability )
1847 if( b_color )
1848 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1849 p_parser->psz_capability,
1850 p_parser->i_score );
1851 else
1852 utf8_fprintf( stdout, " c %s (%d)\n",
1853 p_parser->psz_capability,
1854 p_parser->i_score );
1858 module_list_free (list);
1860 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1861 PauseConsole();
1862 #endif
1865 /*****************************************************************************
1866 * Version: print complete program version
1867 *****************************************************************************
1868 * Print complete program version and build number.
1869 *****************************************************************************/
1870 static void Version( void )
1872 #ifdef WIN32
1873 ShowConsole( true );
1874 #endif
1876 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1877 psz_vlc_changeset );
1878 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1879 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1880 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1881 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1883 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1884 PauseConsole();
1885 #endif
1888 /*****************************************************************************
1889 * ShowConsole: On Win32, create an output console for debug messages
1890 *****************************************************************************
1891 * This function is useful only on Win32.
1892 *****************************************************************************/
1893 #ifdef WIN32 /* */
1894 static void ShowConsole( bool b_dofile )
1896 # ifndef UNDER_CE
1897 FILE *f_help = NULL;
1899 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1901 AllocConsole();
1902 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1903 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1904 * page (e.g. CP437 or CP850). */
1905 SetConsoleOutputCP (GetACP ());
1906 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1908 freopen( "CONOUT$", "w", stderr );
1909 freopen( "CONIN$", "r", stdin );
1911 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1913 fclose( f_help );
1914 freopen( "vlc-help.txt", "wt", stdout );
1915 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1917 else freopen( "CONOUT$", "w", stdout );
1919 # endif
1921 #endif
1923 /*****************************************************************************
1924 * PauseConsole: On Win32, wait for a key press before closing the console
1925 *****************************************************************************
1926 * This function is useful only on Win32.
1927 *****************************************************************************/
1928 #ifdef WIN32 /* */
1929 static void PauseConsole( void )
1931 # ifndef UNDER_CE
1933 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1935 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1936 getchar();
1937 fclose( stdout );
1939 # endif
1941 #endif
1943 /*****************************************************************************
1944 * ConsoleWidth: Return the console width in characters
1945 *****************************************************************************
1946 * We use the stty shell command to get the console width; if this fails or
1947 * if the width is less than 80, we default to 80.
1948 *****************************************************************************/
1949 static int ConsoleWidth( void )
1951 unsigned i_width = 80;
1953 #ifndef WIN32
1954 FILE *file = popen( "stty size 2>/dev/null", "r" );
1955 if (file != NULL)
1957 if (fscanf (file, "%*u %u", &i_width) <= 0)
1958 i_width = 80;
1959 pclose( file );
1961 #elif !defined (UNDER_CE)
1962 CONSOLE_SCREEN_BUFFER_INFO buf;
1964 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1965 i_width = buf.dwSize.X;
1966 #endif
1968 return i_width;