libvlc_version.h: build-time version macros
[vlc/asuraparaju-public.git] / src / libvlc.c
blobe7e2c19d2f15125ef31ec44c0d014c721e083c84
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
72 #include <vlc_media_library.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
76 #include <vlc_aout.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
80 #include <vlc_fs.h>
81 #include <vlc_cpu.h>
82 #include <vlc_url.h>
83 #include <vlc_atomic.h>
84 #include <vlc_modules.h>
86 #include "libvlc.h"
88 #include "playlist/playlist_internal.h"
90 #include <vlc_vlm.h>
92 #ifdef __APPLE__
93 # include <libkern/OSAtomic.h>
94 #endif
96 #include <assert.h>
98 /*****************************************************************************
99 * The evil global variables. We handle them with care, don't worry.
100 *****************************************************************************/
101 static unsigned i_instances = 0;
103 #ifndef WIN32
104 static bool b_daemon = false;
105 #endif
107 #undef vlc_gc_init
108 #undef vlc_hold
109 #undef vlc_release
112 * Atomically set the reference count to 1.
113 * @param p_gc reference counted object
114 * @param pf_destruct destruction calback
115 * @return p_gc.
117 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
119 /* There is no point in using the GC if there is no destructor... */
120 assert (pf_destruct);
121 p_gc->pf_destructor = pf_destruct;
123 vlc_atomic_set (&p_gc->refs, 1);
124 return p_gc;
128 * Atomically increment the reference count.
129 * @param p_gc reference counted object
130 * @return p_gc.
132 void *vlc_hold (gc_object_t * p_gc)
134 uintptr_t refs;
136 assert( p_gc );
137 refs = vlc_atomic_inc (&p_gc->refs);
138 assert (refs != 1); /* there had to be a reference already */
139 return p_gc;
143 * Atomically decrement the reference count and, if it reaches zero, destroy.
144 * @param p_gc reference counted object.
146 void vlc_release (gc_object_t *p_gc)
148 unsigned refs;
150 assert( p_gc );
151 refs = vlc_atomic_dec (&p_gc->refs);
152 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
153 if (refs == 0)
154 p_gc->pf_destructor (p_gc);
157 /*****************************************************************************
158 * Local prototypes
159 *****************************************************************************/
160 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
161 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
162 static void SetLanguage ( char const * );
163 #endif
164 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
165 static void Help ( libvlc_int_t *, char const *psz_help_name );
166 static void Usage ( libvlc_int_t *, char const *psz_search );
167 static void ListModules ( libvlc_int_t *, bool );
168 static void Version ( void );
170 #ifdef WIN32
171 static void ShowConsole ( bool );
172 static void PauseConsole ( void );
173 #endif
174 static int ConsoleWidth ( void );
176 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
177 extern const char psz_vlc_changeset[];
180 * Allocate a libvlc instance, initialize global data if needed
181 * It also initializes the threading system
183 libvlc_int_t * libvlc_InternalCreate( void )
185 libvlc_int_t *p_libvlc;
186 libvlc_priv_t *priv;
187 char *psz_env = NULL;
189 /* Now that the thread system is initialized, we don't have much, but
190 * at least we have variables */
191 vlc_mutex_lock( &global_lock );
192 if( i_instances == 0 )
194 /* Guess what CPU we have */
195 cpu_flags = CPUCapabilities();
196 /* The module bank will be initialized later */
199 /* Allocate a libvlc instance object */
200 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
201 VLC_OBJECT_GENERIC, "libvlc" );
202 if( p_libvlc != NULL )
203 i_instances++;
204 vlc_mutex_unlock( &global_lock );
206 if( p_libvlc == NULL )
207 return NULL;
209 priv = libvlc_priv (p_libvlc);
210 priv->p_playlist = NULL;
211 priv->p_ml = NULL;
212 priv->p_dialog_provider = NULL;
213 priv->p_vlm = NULL;
215 /* Initialize message queue */
216 priv->msg_bank = msg_Create ();
217 if (unlikely(priv->msg_bank == NULL))
218 goto error;
220 /* Find verbosity from VLC_VERBOSE environment variable */
221 psz_env = getenv( "VLC_VERBOSE" );
222 if( psz_env != NULL )
223 priv->i_verbose = atoi( psz_env );
224 else
225 priv->i_verbose = 3;
226 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
227 priv->b_color = isatty( 2 ); /* 2 is for stderr */
228 #else
229 priv->b_color = false;
230 #endif
232 /* Initialize mutexes */
233 vlc_mutex_init( &priv->ml_lock );
234 vlc_mutex_init( &priv->timer_lock );
235 vlc_ExitInit( &priv->exit );
237 return p_libvlc;
238 error:
239 vlc_object_release (p_libvlc);
240 return NULL;
244 * Initialize a libvlc instance
245 * This function initializes a previously allocated libvlc instance:
246 * - CPU detection
247 * - gettext initialization
248 * - message queue, module bank and playlist initialization
249 * - configuration and commandline parsing
251 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
252 const char *ppsz_argv[] )
254 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
255 char * p_tmp = NULL;
256 char * psz_modules = NULL;
257 char * psz_parser = NULL;
258 char * psz_control = NULL;
259 bool b_exit = false;
260 int i_ret = VLC_EEXIT;
261 playlist_t *p_playlist = NULL;
262 char *psz_val;
263 #if defined( ENABLE_NLS ) \
264 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
265 # if defined (WIN32) || defined (__APPLE__)
266 char * psz_language;
267 #endif
268 #endif
270 /* System specific initialization code */
271 system_Init( p_libvlc, &i_argc, ppsz_argv );
274 * Support for gettext
276 vlc_bindtextdomain (PACKAGE_NAME);
278 /* Initialize the module bank and load the configuration of the
279 * main module. We need to do this at this stage to be able to display
280 * a short help if required by the user. (short help == main module
281 * options) */
282 module_InitBank( p_libvlc );
284 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
286 module_EndBank( p_libvlc, false );
287 return VLC_EGENERIC;
290 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
291 /* Announce who we are - Do it only for first instance ? */
292 msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
293 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
294 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
295 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
296 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
297 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
299 /* Check for short help option */
300 if( var_InheritBool( p_libvlc, "help" ) )
302 Help( p_libvlc, "help" );
303 b_exit = true;
304 i_ret = VLC_EEXITSUCCESS;
306 /* Check for version option */
307 else if( var_InheritBool( p_libvlc, "version" ) )
309 Version();
310 b_exit = true;
311 i_ret = VLC_EEXITSUCCESS;
314 /* Check for daemon mode */
315 #ifndef WIN32
316 if( var_InheritBool( p_libvlc, "daemon" ) )
318 #ifdef HAVE_DAEMON
319 char *psz_pidfile = NULL;
321 if( daemon( 1, 0) != 0 )
323 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
324 b_exit = true;
326 b_daemon = true;
328 /* lets check if we need to write the pidfile */
329 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
330 if( psz_pidfile != NULL )
332 FILE *pidfile;
333 pid_t i_pid = getpid ();
334 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
335 i_pid, psz_pidfile );
336 pidfile = vlc_fopen( psz_pidfile,"w" );
337 if( pidfile != NULL )
339 utf8_fprintf( pidfile, "%d", (int)i_pid );
340 fclose( pidfile );
342 else
344 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
345 psz_pidfile );
348 free( psz_pidfile );
350 #else
351 pid_t i_pid;
353 if( ( i_pid = fork() ) < 0 )
355 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
356 b_exit = true;
358 else if( i_pid )
360 /* This is the parent, exit right now */
361 msg_Dbg( p_libvlc, "closing parent process" );
362 b_exit = true;
363 i_ret = VLC_EEXITSUCCESS;
365 else
367 /* We are the child */
368 msg_Dbg( p_libvlc, "daemon spawned" );
369 close( STDIN_FILENO );
370 close( STDOUT_FILENO );
371 close( STDERR_FILENO );
373 b_daemon = true;
375 #endif
377 #endif
379 if( b_exit )
381 module_EndBank( p_libvlc, false );
382 return i_ret;
385 /* Check for translation config option */
386 #if defined( ENABLE_NLS ) \
387 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
388 # if defined (WIN32) || defined (__APPLE__)
389 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
390 config_LoadConfigFile( p_libvlc, "main" );
391 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
393 /* Check if the user specified a custom language */
394 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
395 if( psz_language && strcmp( psz_language, "auto" ) )
397 /* Reset the default domain */
398 SetLanguage( psz_language );
400 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
401 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
403 free( psz_language );
404 # endif
405 #endif
408 * Load the builtins and plugins into the module_bank.
409 * We have to do it before config_Load*() because this also gets the
410 * list of configuration options exported by each module and loads their
411 * default values.
413 module_LoadPlugins( p_libvlc );
414 if( p_libvlc->b_die )
416 b_exit = true;
419 size_t module_count;
420 module_t **list = module_list_get( &module_count );
421 module_list_free( list );
422 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
424 /* Check for help on modules */
425 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
427 Help( p_libvlc, p_tmp );
428 free( p_tmp );
429 b_exit = true;
430 i_ret = VLC_EEXITSUCCESS;
432 /* Check for full help option */
433 else if( var_InheritBool( p_libvlc, "full-help" ) )
435 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
436 var_SetBool( p_libvlc, "advanced", true );
437 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
438 var_SetBool( p_libvlc, "help-verbose", true );
439 Help( p_libvlc, "full-help" );
440 b_exit = true;
441 i_ret = VLC_EEXITSUCCESS;
443 /* Check for long help option */
444 else if( var_InheritBool( p_libvlc, "longhelp" ) )
446 Help( p_libvlc, "longhelp" );
447 b_exit = true;
448 i_ret = VLC_EEXITSUCCESS;
450 /* Check for module list option */
451 else if( var_InheritBool( p_libvlc, "list" ) )
453 ListModules( p_libvlc, false );
454 b_exit = true;
455 i_ret = VLC_EEXITSUCCESS;
457 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
459 ListModules( p_libvlc, true );
460 b_exit = true;
461 i_ret = VLC_EEXITSUCCESS;
464 /* Check for config file options */
465 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
467 if( var_InheritBool( p_libvlc, "reset-config" ) )
469 config_ResetAll( p_libvlc );
470 config_SaveConfigFile( p_libvlc, NULL );
474 if( module_count <= 1)
476 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
477 "that you properly gave a module path with --plugin-path.");
478 b_exit = true;
479 i_ret = VLC_ENOITEM;
482 if( b_exit )
484 module_EndBank( p_libvlc, true );
485 return i_ret;
489 * Override default configuration with config file settings
491 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
492 config_LoadConfigFile( p_libvlc, NULL );
495 * Override configuration with command line settings
497 int vlc_optind;
498 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
500 #ifdef WIN32
501 ShowConsole( false );
502 /* Pause the console because it's destroyed when we exit */
503 fprintf( stderr, "The command line options couldn't be loaded, check "
504 "that they are valid.\n" );
505 PauseConsole();
506 #endif
507 module_EndBank( p_libvlc, true );
508 return VLC_EGENERIC;
510 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
512 /* FIXME: could be replaced by using Unix sockets */
513 #ifdef HAVE_DBUS
514 dbus_threads_init_default();
516 if( var_InheritBool( p_libvlc, "one-instance" )
517 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
518 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
520 /* Initialise D-Bus interface, check for other instances */
521 DBusConnection *p_conn = NULL;
522 DBusError dbus_error;
524 dbus_error_init( &dbus_error );
526 /* connect to the session bus */
527 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
528 if( !p_conn )
530 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
531 dbus_error.message );
532 dbus_error_free( &dbus_error );
534 else
536 /* check if VLC is available on the bus
537 * if not: D-Bus control is not enabled on the other
538 * instance and we can't pass MRLs to it */
539 DBusMessage *p_test_msg = NULL;
540 DBusMessage *p_test_reply = NULL;
541 p_test_msg = dbus_message_new_method_call(
542 "org.mpris.vlc", "/",
543 "org.freedesktop.MediaPlayer", "Identity" );
544 /* block until a reply arrives */
545 p_test_reply = dbus_connection_send_with_reply_and_block(
546 p_conn, p_test_msg, -1, &dbus_error );
547 dbus_message_unref( p_test_msg );
548 if( p_test_reply == NULL )
550 dbus_error_free( &dbus_error );
551 msg_Dbg( p_libvlc, "No Media Player is running. "
552 "Continuing normally." );
554 else
556 int i_input;
557 DBusMessage* p_dbus_msg = NULL;
558 DBusMessageIter dbus_args;
559 DBusPendingCall* p_dbus_pending = NULL;
560 dbus_bool_t b_play;
562 dbus_message_unref( p_test_reply );
563 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
565 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
567 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
568 ppsz_argv[i_input] );
570 p_dbus_msg = dbus_message_new_method_call(
571 "org.mpris.vlc", "/TrackList",
572 "org.freedesktop.MediaPlayer", "AddTrack" );
574 if ( NULL == p_dbus_msg )
576 msg_Err( p_libvlc, "D-Bus problem" );
577 system_End( p_libvlc );
578 exit( 1 );
581 /* append MRLs */
582 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
583 if ( !dbus_message_iter_append_basic( &dbus_args,
584 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
586 dbus_message_unref( p_dbus_msg );
587 system_End( p_libvlc );
588 exit( 1 );
590 b_play = TRUE;
591 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
592 b_play = FALSE;
593 if ( !dbus_message_iter_append_basic( &dbus_args,
594 DBUS_TYPE_BOOLEAN, &b_play ) )
596 dbus_message_unref( p_dbus_msg );
597 system_End( p_libvlc );
598 exit( 1 );
601 /* send message and get a handle for a reply */
602 if ( !dbus_connection_send_with_reply ( p_conn,
603 p_dbus_msg, &p_dbus_pending, -1 ) )
605 msg_Err( p_libvlc, "D-Bus problem" );
606 dbus_message_unref( p_dbus_msg );
607 system_End( p_libvlc );
608 exit( 1 );
611 if ( NULL == p_dbus_pending )
613 msg_Err( p_libvlc, "D-Bus problem" );
614 dbus_message_unref( p_dbus_msg );
615 system_End( p_libvlc );
616 exit( 1 );
618 dbus_connection_flush( p_conn );
619 dbus_message_unref( p_dbus_msg );
620 /* block until we receive a reply */
621 dbus_pending_call_block( p_dbus_pending );
622 dbus_pending_call_unref( p_dbus_pending );
623 } /* processes all command line MRLs */
625 /* bye bye */
626 system_End( p_libvlc );
627 exit( 0 );
630 /* we unreference the connection when we've finished with it */
631 if( p_conn ) dbus_connection_unref( p_conn );
633 #endif
636 * Message queue options
638 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
639 if( psz_verbose_objects )
641 char * psz_object, * iter = psz_verbose_objects;
642 while( (psz_object = strsep( &iter, "," )) )
644 switch( psz_object[0] )
646 printf("%s\n", psz_object+1);
647 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
648 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
649 default:
650 msg_Err( p_libvlc, "verbose-objects usage: \n"
651 "--verbose-objects=+printthatobject,"
652 "-dontprintthatone\n"
653 "(keyword 'all' to applies to all objects)");
654 free( psz_verbose_objects );
655 /* FIXME: leaks!!!! */
656 return VLC_EGENERIC;
659 free( psz_verbose_objects );
662 /* Last chance to set the verbosity. Once we start interfaces and other
663 * threads, verbosity becomes read-only. */
664 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
665 if( var_InheritBool( p_libvlc, "quiet" ) )
667 var_SetInteger( p_libvlc, "verbose", -1 );
668 priv->i_verbose = -1;
670 vlc_threads_setup( p_libvlc );
672 if( priv->b_color )
673 priv->b_color = var_InheritBool( p_libvlc, "color" );
675 char p_capabilities[200];
676 #define PRINT_CAPABILITY( capability, string ) \
677 if( vlc_CPU() & capability ) \
679 strncat( p_capabilities, string " ", \
680 sizeof(p_capabilities) - strlen(p_capabilities) ); \
681 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
683 p_capabilities[0] = '\0';
685 #if defined( __i386__ ) || defined( __x86_64__ )
686 if( !var_InheritBool( p_libvlc, "mmx" ) )
687 cpu_flags &= ~CPU_CAPABILITY_MMX;
688 if( !var_InheritBool( p_libvlc, "3dn" ) )
689 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
690 if( !var_InheritBool( p_libvlc, "mmxext" ) )
691 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
692 if( !var_InheritBool( p_libvlc, "sse" ) )
693 cpu_flags &= ~CPU_CAPABILITY_SSE;
694 if( !var_InheritBool( p_libvlc, "sse2" ) )
695 cpu_flags &= ~CPU_CAPABILITY_SSE2;
696 if( !var_InheritBool( p_libvlc, "sse3" ) )
697 cpu_flags &= ~CPU_CAPABILITY_SSE3;
698 if( !var_InheritBool( p_libvlc, "ssse3" ) )
699 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
700 if( !var_InheritBool( p_libvlc, "sse41" ) )
701 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
702 if( !var_InheritBool( p_libvlc, "sse42" ) )
703 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
705 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
706 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
707 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
708 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
709 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
710 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
711 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
712 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
713 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
714 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
716 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
717 if( !var_InheritBool( p_libvlc, "altivec" ) )
718 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
720 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
722 #elif defined( __arm__ )
723 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
725 #endif
727 #if HAVE_FPU
728 strncat( p_capabilities, "FPU ",
729 sizeof(p_capabilities) - strlen( p_capabilities) );
730 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
731 #endif
733 if (p_capabilities[0])
734 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
737 * Choose the best memcpy module
739 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
740 /* Avoid being called "memcpy":*/
741 vlc_object_set_name( p_libvlc, "main" );
743 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
744 priv->i_timers = 0;
745 priv->pp_timers = NULL;
747 priv->i_last_input_id = 0; /* Not very safe, should be removed */
750 * Initialize hotkey handling
752 vlc_InitActions( p_libvlc );
754 /* Create a variable for showing the fullscreen interface */
755 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
756 var_SetBool( p_libvlc, "intf-show", true );
758 /* Create a variable for showing the right click menu */
759 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
761 /* variables for signalling creation of new files */
762 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
763 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
765 /* some default internal settings */
766 var_Create( p_libvlc, "window", VLC_VAR_STRING );
767 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
768 var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
770 /* Initialize playlist and get commandline files */
771 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
772 if( !p_playlist )
774 msg_Err( p_libvlc, "playlist initialization failed" );
775 if( priv->p_memcpy_module != NULL )
777 module_unneed( p_libvlc, priv->p_memcpy_module );
779 module_EndBank( p_libvlc, true );
780 return VLC_EGENERIC;
783 /* System specific configuration */
784 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
786 #if defined(MEDIA_LIBRARY)
787 /* Get the ML */
788 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) == true )
790 priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
791 if( !priv->p_ml )
793 msg_Err( p_libvlc, "ML initialization failed" );
794 return VLC_EGENERIC;
797 else
799 priv->p_ml = NULL;
801 #endif
803 /* Add service discovery modules */
804 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
805 if( psz_modules )
807 char *p = psz_modules, *m;
808 while( ( m = strsep( &p, " :," ) ) != NULL )
809 playlist_ServicesDiscoveryAdd( p_playlist, m );
810 free( psz_modules );
813 #ifdef ENABLE_VLM
814 /* Initialize VLM if vlm-conf is specified */
815 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
816 if( psz_parser )
818 priv->p_vlm = vlm_New( p_libvlc );
819 if( !priv->p_vlm )
820 msg_Err( p_libvlc, "VLM initialization failed" );
822 free( psz_parser );
823 #endif
826 * Load background interfaces
828 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
829 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
831 if( psz_modules && psz_control )
833 char* psz_tmp;
834 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
836 free( psz_modules );
837 psz_modules = psz_tmp;
840 else if( psz_control )
842 free( psz_modules );
843 psz_modules = strdup( psz_control );
846 psz_parser = psz_modules;
847 while ( psz_parser && *psz_parser )
849 char *psz_module, *psz_temp;
850 psz_module = psz_parser;
851 psz_parser = strchr( psz_module, ':' );
852 if ( psz_parser )
854 *psz_parser = '\0';
855 psz_parser++;
857 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
859 intf_Create( p_libvlc, psz_temp );
860 free( psz_temp );
863 free( psz_modules );
864 free( psz_control );
867 * Always load the hotkeys interface if it exists
869 intf_Create( p_libvlc, "hotkeys,none" );
871 #ifdef HAVE_DBUS
872 /* loads dbus control interface if in one-instance mode
873 * we do it only when playlist exists, because dbus module needs it */
874 if( var_InheritBool( p_libvlc, "one-instance" )
875 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
876 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
877 intf_Create( p_libvlc, "dbus,none" );
879 # if !defined (HAVE_MAEMO)
880 /* Prevents the power management daemon from suspending the system
881 * when VLC is active */
882 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
883 intf_Create( p_libvlc, "inhibit,none" );
884 # endif
885 #endif
887 if( var_InheritBool( p_libvlc, "file-logging" ) &&
888 !var_InheritBool( p_libvlc, "syslog" ) )
890 intf_Create( p_libvlc, "logger,none" );
892 #ifdef HAVE_SYSLOG_H
893 if( var_InheritBool( p_libvlc, "syslog" ) )
895 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
896 var_SetString( p_libvlc, "logmode", "syslog" );
897 intf_Create( p_libvlc, "logger,none" );
899 if( logmode )
901 var_SetString( p_libvlc, "logmode", logmode );
902 free( logmode );
904 var_Destroy( p_libvlc, "logmode" );
906 #endif
908 if( var_InheritBool( p_libvlc, "network-synchronisation") )
910 intf_Create( p_libvlc, "netsync,none" );
913 #ifdef WIN32
914 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
916 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
917 if( psz_codecs )
919 char *psz_morecodecs;
920 if( asprintf(&psz_morecodecs, "%s,dmo", psz_codecs) != -1 )
922 var_SetString( p_libvlc, "codec", psz_morecodecs);
923 free( psz_morecodecs );
925 free( psz_codecs );
927 else
928 var_SetString( p_libvlc, "codec", "dmo");
930 #endif
932 #ifdef __APPLE__
933 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
934 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
935 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
936 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
937 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
938 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
939 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
940 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
941 #endif
942 #ifdef WIN32
943 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
944 #endif
947 * Get input filenames given as commandline arguments.
948 * We assume that the remaining parameters are filenames
949 * and their input options.
951 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
954 * Get --open argument
956 psz_val = var_InheritString( p_libvlc, "open" );
957 if ( psz_val != NULL )
959 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
960 -1, 0, NULL, 0, true, pl_Unlocked );
961 free( psz_val );
964 return VLC_SUCCESS;
968 * Cleanup a libvlc instance. The instance is not completely deallocated
969 * \param p_libvlc the instance to clean
971 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
973 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
974 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
976 /* Deactivate the playlist */
977 msg_Dbg( p_libvlc, "deactivating the playlist" );
978 pl_Deactivate( p_libvlc );
980 /* Remove all services discovery */
981 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
982 playlist_ServicesDiscoveryKillAll( p_playlist );
984 /* Ask the interfaces to stop and destroy them */
985 msg_Dbg( p_libvlc, "removing all interfaces" );
986 libvlc_Quit( p_libvlc );
987 intf_DestroyAll( p_libvlc );
989 #ifdef ENABLE_VLM
990 /* Destroy VLM if created in libvlc_InternalInit */
991 if( priv->p_vlm )
993 vlm_Delete( priv->p_vlm );
995 #endif
997 /* Free playlist now, all threads are gone */
998 playlist_Destroy( p_playlist );
1000 #if defined(MEDIA_LIBRARY)
1001 media_library_t* p_ml = priv->p_ml;
1002 if( p_ml )
1004 ml_Destroy( VLC_OBJECT( p_ml ) );
1005 vlc_object_release( p_ml );
1006 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
1008 #endif
1010 stats_TimersDumpAll( p_libvlc );
1011 stats_TimersCleanAll( p_libvlc );
1013 msg_Dbg( p_libvlc, "removing stats" );
1015 #ifndef WIN32
1016 char* psz_pidfile = NULL;
1018 if( b_daemon )
1020 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1021 if( psz_pidfile != NULL )
1023 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1024 if( unlink( psz_pidfile ) == -1 )
1026 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1027 psz_pidfile );
1030 free( psz_pidfile );
1032 #endif
1034 if( priv->p_memcpy_module )
1036 module_unneed( p_libvlc, priv->p_memcpy_module );
1037 priv->p_memcpy_module = NULL;
1040 /* Free module bank. It is refcounted, so we call this each time */
1041 module_EndBank( p_libvlc, true );
1043 vlc_DeinitActions( p_libvlc );
1047 * Destroy everything.
1048 * This function requests the running threads to finish, waits for their
1049 * termination, and destroys their structure.
1050 * It stops the thread systems: no instance can run after this has run
1051 * \param p_libvlc the instance to destroy
1053 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1055 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1057 vlc_mutex_lock( &global_lock );
1058 i_instances--;
1060 if( i_instances == 0 )
1062 /* System specific cleaning code */
1063 system_End( p_libvlc );
1065 vlc_mutex_unlock( &global_lock );
1067 msg_Destroy (priv->msg_bank);
1069 /* Destroy mutexes */
1070 vlc_ExitDestroy( &priv->exit );
1071 vlc_mutex_destroy( &priv->timer_lock );
1072 vlc_mutex_destroy( &priv->ml_lock );
1074 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1075 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1076 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1077 vlc_object_release( p_libvlc );
1078 #endif
1080 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1081 vlc_object_release( p_libvlc );
1085 * Add an interface plugin and run it
1087 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1089 if( !p_libvlc )
1090 return VLC_EGENERIC;
1092 if( !psz_module ) /* requesting the default interface */
1094 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1095 if( !psz_interface ) /* "intf" has not been set */
1097 #ifndef WIN32
1098 if( b_daemon )
1099 /* Daemon mode hack.
1100 * We prefer the dummy interface if none is specified. */
1101 psz_module = "dummy";
1102 else
1103 #endif
1104 msg_Info( p_libvlc, "%s",
1105 _("Running vlc with the default interface. "
1106 "Use 'cvlc' to use vlc without interface.") );
1108 free( psz_interface );
1109 var_Destroy( p_libvlc, "intf" );
1112 /* Try to create the interface */
1113 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1114 if( ret )
1115 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1116 psz_module ? psz_module : "default" );
1117 return ret;
1120 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1121 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1122 /*****************************************************************************
1123 * SetLanguage: set the interface language.
1124 *****************************************************************************
1125 * We set the LC_MESSAGES locale category for interface messages and buttons,
1126 * as well as the LC_CTYPE category for string sorting and possible wide
1127 * character support.
1128 *****************************************************************************/
1129 static void SetLanguage ( const char *psz_lang )
1131 #ifdef __APPLE__
1132 /* I need that under Darwin, please check it doesn't disturb
1133 * other platforms. --Meuuh */
1134 setenv( "LANG", psz_lang, 1 );
1136 #else
1137 /* We set LC_ALL manually because it is the only way to set
1138 * the language at runtime under eg. Windows. Beware that this
1139 * makes the environment unconsistent when libvlc is unloaded and
1140 * should probably be moved to a safer place like vlc.c. */
1141 static char psz_lcall[20];
1142 snprintf( psz_lcall, sizeof(psz_lcall), "LC_ALL=%s", psz_lang );
1143 putenv( psz_lcall );
1144 #endif
1146 setlocale( LC_ALL, psz_lang );
1148 #endif
1150 /*****************************************************************************
1151 * GetFilenames: parse command line options which are not flags
1152 *****************************************************************************
1153 * Parse command line for input files as well as their associated options.
1154 * An option always follows its associated input and begins with a ":".
1155 *****************************************************************************/
1156 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1157 const char *const args[] )
1159 while( n > 0 )
1161 /* Count the input options */
1162 unsigned i_options = 0;
1164 while( args[--n][0] == ':' )
1166 i_options++;
1167 if( n == 0 )
1169 msg_Warn( p_vlc, "options %s without item", args[n] );
1170 return; /* syntax!? */
1174 char *mrl = make_URI( args[n], NULL );
1175 if( !mrl )
1176 continue;
1178 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1179 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1180 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1181 free( mrl );
1185 /*****************************************************************************
1186 * Help: print program help
1187 *****************************************************************************
1188 * Print a short inline help. Message interface is initialized at this stage.
1189 *****************************************************************************/
1190 static inline void print_help_on_full_help( void )
1192 utf8_fprintf( stdout, "\n" );
1193 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1196 static const char vlc_usage[] = N_(
1197 "Usage: %s [options] [stream] ..."
1198 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1199 "\nThe first item specified will be played first."
1200 "\n"
1201 "\nOptions-styles:"
1202 "\n --option A global option that is set for the duration of the program."
1203 "\n -option A single letter version of a global --option."
1204 "\n :option An option that only applies to the stream directly before it"
1205 "\n and that overrides previous settings."
1206 "\n"
1207 "\nStream MRL syntax:"
1208 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1209 "\n"
1210 "\n Many of the global --options can also be used as MRL specific :options."
1211 "\n Multiple :option=value pairs can be specified."
1212 "\n"
1213 "\nURL syntax:"
1214 "\n [file://]filename Plain media file"
1215 "\n http://ip:port/file HTTP URL"
1216 "\n ftp://ip:port/file FTP URL"
1217 "\n mms://ip:port/file MMS URL"
1218 "\n screen:// Screen capture"
1219 "\n [dvd://][device][@raw_device] DVD device"
1220 "\n [vcd://][device] VCD device"
1221 "\n [cdda://][device] Audio CD device"
1222 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1223 "\n UDP stream sent by a streaming server"
1224 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1225 "\n vlc://quit Special item to quit VLC"
1226 "\n");
1228 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1230 #ifdef WIN32
1231 ShowConsole( true );
1232 #endif
1234 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1236 utf8_fprintf( stdout, vlc_usage, "vlc" );
1237 Usage( p_this, "=help" );
1238 Usage( p_this, "=main" );
1239 print_help_on_full_help();
1241 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1243 utf8_fprintf( stdout, vlc_usage, "vlc" );
1244 Usage( p_this, NULL );
1245 print_help_on_full_help();
1247 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1249 utf8_fprintf( stdout, vlc_usage, "vlc" );
1250 Usage( p_this, NULL );
1252 else if( psz_help_name )
1254 Usage( p_this, psz_help_name );
1257 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1258 PauseConsole();
1259 #endif
1262 /*****************************************************************************
1263 * Usage: print module usage
1264 *****************************************************************************
1265 * Print a short inline help. Message interface is initialized at this stage.
1266 *****************************************************************************/
1267 # define COL(x) "\033[" #x ";1m"
1268 # define RED COL(31)
1269 # define GREEN COL(32)
1270 # define YELLOW COL(33)
1271 # define BLUE COL(34)
1272 # define MAGENTA COL(35)
1273 # define CYAN COL(36)
1274 # define WHITE COL(0)
1275 # define GRAY "\033[0m"
1276 static void
1277 print_help_section( const module_t *m, const module_config_t *p_item,
1278 bool b_color, bool b_description )
1280 if( !p_item ) return;
1281 if( b_color )
1283 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1284 module_gettext( m, p_item->psz_text ) );
1285 if( b_description && p_item->psz_longtext )
1286 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1287 module_gettext( m, p_item->psz_longtext ) );
1289 else
1291 utf8_fprintf( stdout, " %s:\n",
1292 module_gettext( m, p_item->psz_text ) );
1293 if( b_description && p_item->psz_longtext )
1294 utf8_fprintf( stdout, " %s\n",
1295 module_gettext(m, p_item->psz_longtext ) );
1299 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1301 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1302 /* short option ------' | | | | | | |
1303 * option name ------------' | | | | | |
1304 * <bra ---------------------' | | | | |
1305 * option type or "" ----------' | | | |
1306 * ket> -------------------------' | | |
1307 * padding spaces -----------------' | |
1308 * comment --------------------------' |
1309 * comment suffix ---------------------'
1311 * The purpose of having bra and ket is that we might i18n them as well.
1314 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1315 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1317 #define LINE_START 8
1318 #define PADDING_SPACES 25
1319 #ifdef WIN32
1320 # define OPTION_VALUE_SEP "="
1321 #else
1322 # define OPTION_VALUE_SEP " "
1323 #endif
1324 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1325 char psz_spaces_longtext[LINE_START+3];
1326 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1327 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1328 char psz_buffer[10000];
1329 char psz_short[4];
1330 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1331 int i_width_description = i_width + PADDING_SPACES - 1;
1332 bool b_advanced = var_InheritBool( p_this, "advanced" );
1333 bool b_description = var_InheritBool( p_this, "help-verbose" );
1334 bool b_description_hack;
1335 bool b_color = var_InheritBool( p_this, "color" );
1336 bool b_has_advanced = false;
1337 bool b_found = false;
1338 int i_only_advanced = 0; /* Number of modules ignored because they
1339 * only have advanced options */
1340 bool b_strict = psz_search && *psz_search == '=';
1341 if( b_strict ) psz_search++;
1343 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1344 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1345 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1346 psz_spaces_longtext[LINE_START+2] = '\0';
1347 #ifndef WIN32
1348 if( !isatty( 1 ) )
1349 #endif
1350 b_color = false; // don't put color control codes in a .txt file
1352 if( b_color )
1354 strcpy( psz_format, COLOR_FORMAT_STRING );
1355 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1357 else
1359 strcpy( psz_format, FORMAT_STRING );
1360 strcpy( psz_format_bool, FORMAT_STRING );
1363 /* List all modules */
1364 module_t **list = module_list_get (NULL);
1365 if (!list)
1366 return;
1368 /* Ugly hack to make sure that the help options always come first
1369 * (part 1) */
1370 if( !psz_search )
1371 Usage( p_this, "help" );
1373 /* Enumerate the config for each module */
1374 for (size_t i = 0; list[i]; i++)
1376 bool b_help_module;
1377 module_t *p_parser = list[i];
1378 module_config_t *p_item = NULL;
1379 module_config_t *p_section = NULL;
1380 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1382 if( psz_search &&
1383 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1384 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1386 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1387 unsigned i;
1388 for( i = 0; i < p_parser->i_shortcuts; i++ )
1390 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1391 : !!strstr( pp_shortcuts[i], psz_search ) )
1392 break;
1394 if( i == p_parser->i_shortcuts )
1395 continue;
1398 /* Ignore modules without config options */
1399 if( !p_parser->i_config_items )
1401 continue;
1404 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1405 /* Ugly hack to make sure that the help options always come first
1406 * (part 2) */
1407 if( !psz_search && b_help_module )
1408 continue;
1410 /* Ignore modules with only advanced config options if requested */
1411 if( !b_advanced )
1413 for( p_item = p_parser->p_config;
1414 p_item < p_end;
1415 p_item++ )
1417 if( (p_item->i_type & CONFIG_ITEM) &&
1418 !p_item->b_advanced && !p_item->b_removed ) break;
1421 if( p_item == p_end )
1423 i_only_advanced++;
1424 continue;
1428 b_found = true;
1430 /* Print name of module */
1431 if( strcmp( "main", p_parser->psz_object_name ) )
1433 if( b_color )
1434 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1435 module_gettext( p_parser, p_parser->psz_longname ),
1436 p_parser->psz_object_name );
1437 else
1438 utf8_fprintf( stdout, "\n %s\n",
1439 module_gettext(p_parser, p_parser->psz_longname ) );
1441 if( p_parser->psz_help )
1443 if( b_color )
1444 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1445 module_gettext( p_parser, p_parser->psz_help ) );
1446 else
1447 utf8_fprintf( stdout, " %s\n",
1448 module_gettext( p_parser, p_parser->psz_help ) );
1451 /* Print module options */
1452 for( p_item = p_parser->p_config;
1453 p_item < p_end;
1454 p_item++ )
1456 char *psz_text, *psz_spaces = psz_spaces_text;
1457 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1458 const char *psz_suf = "", *psz_prefix = NULL;
1459 signed int i;
1460 size_t i_cur_width;
1462 /* Skip removed options */
1463 if( p_item->b_removed )
1465 continue;
1467 /* Skip advanced options if requested */
1468 if( p_item->b_advanced && !b_advanced )
1470 b_has_advanced = true;
1471 continue;
1474 switch( p_item->i_type )
1476 case CONFIG_HINT_CATEGORY:
1477 case CONFIG_HINT_USAGE:
1478 if( !strcmp( "main", p_parser->psz_object_name ) )
1480 if( b_color )
1481 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1482 module_gettext( p_parser, p_item->psz_text ) );
1483 else
1484 utf8_fprintf( stdout, "\n %s\n",
1485 module_gettext( p_parser, p_item->psz_text ) );
1487 if( b_description && p_item->psz_longtext )
1489 if( b_color )
1490 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1491 module_gettext( p_parser, p_item->psz_longtext ) );
1492 else
1493 utf8_fprintf( stdout, " %s\n",
1494 module_gettext( p_parser, p_item->psz_longtext ) );
1496 break;
1498 case CONFIG_HINT_SUBCATEGORY:
1499 if( strcmp( "main", p_parser->psz_object_name ) )
1500 break;
1501 case CONFIG_SECTION:
1502 p_section = p_item;
1503 break;
1505 case CONFIG_ITEM_STRING:
1506 case CONFIG_ITEM_FILE:
1507 case CONFIG_ITEM_DIRECTORY:
1508 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1509 case CONFIG_ITEM_MODULE_CAT:
1510 case CONFIG_ITEM_MODULE_LIST:
1511 case CONFIG_ITEM_MODULE_LIST_CAT:
1512 case CONFIG_ITEM_FONT:
1513 case CONFIG_ITEM_PASSWORD:
1514 print_help_section( p_parser, p_section, b_color,
1515 b_description );
1516 p_section = NULL;
1517 psz_bra = OPTION_VALUE_SEP "<";
1518 psz_type = _("string");
1519 psz_ket = ">";
1521 if( p_item->ppsz_list )
1523 psz_bra = OPTION_VALUE_SEP "{";
1524 psz_type = psz_buffer;
1525 psz_buffer[0] = '\0';
1526 for( i = 0; p_item->ppsz_list[i]; i++ )
1528 if( i ) strcat( psz_buffer, "," );
1529 strcat( psz_buffer, p_item->ppsz_list[i] );
1531 psz_ket = "}";
1533 break;
1534 case CONFIG_ITEM_INTEGER:
1535 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1536 print_help_section( p_parser, p_section, b_color,
1537 b_description );
1538 p_section = NULL;
1539 psz_bra = OPTION_VALUE_SEP "<";
1540 psz_type = _("integer");
1541 psz_ket = ">";
1543 if( p_item->min.i || p_item->max.i )
1545 sprintf( psz_buffer, "%s [%"PRId64" .. %"PRId64"]",
1546 psz_type, p_item->min.i, p_item->max.i );
1547 psz_type = psz_buffer;
1550 if( p_item->i_list )
1552 psz_bra = OPTION_VALUE_SEP "{";
1553 psz_type = psz_buffer;
1554 psz_buffer[0] = '\0';
1555 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1557 if( i ) strcat( psz_buffer, ", " );
1558 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1559 p_item->pi_list[i],
1560 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1562 psz_ket = "}";
1564 break;
1565 case CONFIG_ITEM_FLOAT:
1566 print_help_section( p_parser, p_section, b_color,
1567 b_description );
1568 p_section = NULL;
1569 psz_bra = OPTION_VALUE_SEP "<";
1570 psz_type = _("float");
1571 psz_ket = ">";
1572 if( p_item->min.f || p_item->max.f )
1574 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1575 p_item->min.f, p_item->max.f );
1576 psz_type = psz_buffer;
1578 break;
1579 case CONFIG_ITEM_BOOL:
1580 print_help_section( p_parser, p_section, b_color,
1581 b_description );
1582 p_section = NULL;
1583 psz_bra = ""; psz_type = ""; psz_ket = "";
1584 if( !b_help_module )
1586 psz_suf = p_item->value.i ? _(" (default enabled)") :
1587 _(" (default disabled)");
1589 break;
1592 if( !psz_type )
1594 continue;
1597 /* Add short option if any */
1598 if( p_item->i_short )
1600 sprintf( psz_short, "-%c,", p_item->i_short );
1602 else
1604 strcpy( psz_short, " " );
1607 i = PADDING_SPACES - strlen( p_item->psz_name )
1608 - strlen( psz_bra ) - strlen( psz_type )
1609 - strlen( psz_ket ) - 1;
1611 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1613 psz_prefix = ", --no-";
1614 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1617 if( i < 0 )
1619 psz_spaces[0] = '\n';
1620 i = 0;
1622 else
1624 psz_spaces[i] = '\0';
1627 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1629 utf8_fprintf( stdout, psz_format_bool, psz_short,
1630 p_item->psz_name, psz_prefix, p_item->psz_name,
1631 psz_bra, psz_type, psz_ket, psz_spaces );
1633 else
1635 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1636 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1639 psz_spaces[i] = ' ';
1641 /* We wrap the rest of the output */
1642 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1643 psz_suf );
1644 b_description_hack = b_description;
1646 description:
1647 psz_text = psz_buffer;
1648 i_cur_width = b_description && !b_description_hack
1649 ? i_width_description
1650 : i_width;
1651 while( *psz_text )
1653 char *psz_parser, *psz_word;
1654 size_t i_end = strlen( psz_text );
1656 /* If the remaining text fits in a line, print it. */
1657 if( i_end <= i_cur_width )
1659 if( b_color )
1661 if( !b_description || b_description_hack )
1662 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1663 else
1664 utf8_fprintf( stdout, "%s\n", psz_text );
1666 else
1668 utf8_fprintf( stdout, "%s\n", psz_text );
1670 break;
1673 /* Otherwise, eat as many words as possible */
1674 psz_parser = psz_text;
1677 psz_word = psz_parser;
1678 psz_parser = strchr( psz_word, ' ' );
1679 /* If no space was found, we reached the end of the text
1680 * block; otherwise, we skip the space we just found. */
1681 psz_parser = psz_parser ? psz_parser + 1
1682 : psz_text + i_end;
1684 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1686 /* We cut a word in one of these cases:
1687 * - it's the only word in the line and it's too long.
1688 * - we used less than 80% of the width and the word we are
1689 * going to wrap is longer than 40% of the width, and even
1690 * if the word would have fit in the next line. */
1691 if( psz_word == psz_text
1692 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1693 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1695 char c = psz_text[i_cur_width];
1696 psz_text[i_cur_width] = '\0';
1697 if( b_color )
1699 if( !b_description || b_description_hack )
1700 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1701 psz_text, psz_spaces );
1702 else
1703 utf8_fprintf( stdout, "%s\n%s",
1704 psz_text, psz_spaces );
1706 else
1708 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1710 psz_text += i_cur_width;
1711 psz_text[0] = c;
1713 else
1715 psz_word[-1] = '\0';
1716 if( b_color )
1718 if( !b_description || b_description_hack )
1719 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1720 psz_text, psz_spaces );
1721 else
1722 utf8_fprintf( stdout, "%s\n%s",
1723 psz_text, psz_spaces );
1725 else
1727 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1729 psz_text = psz_word;
1733 if( b_description_hack && p_item->psz_longtext )
1735 sprintf( psz_buffer, "%s%s",
1736 module_gettext( p_parser, p_item->psz_longtext ),
1737 psz_suf );
1738 b_description_hack = false;
1739 psz_spaces = psz_spaces_longtext;
1740 utf8_fprintf( stdout, "%s", psz_spaces );
1741 goto description;
1746 if( b_has_advanced )
1748 if( b_color )
1749 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1750 _( "add --advanced to your command line to see advanced options."));
1751 else
1752 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1753 _( "add --advanced to your command line to see advanced options."));
1756 if( i_only_advanced > 0 )
1758 if( b_color )
1760 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1761 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1763 else
1765 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1766 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1769 else if( !b_found )
1771 if( b_color )
1772 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1773 _( "No matching module found. Use --list or " \
1774 "--list-verbose to list available modules." ) );
1775 else
1776 utf8_fprintf( stdout, "\n%s\n",
1777 _( "No matching module found. Use --list or " \
1778 "--list-verbose to list available modules." ) );
1781 /* Release the module list */
1782 module_list_free (list);
1785 /*****************************************************************************
1786 * ListModules: list the available modules with their description
1787 *****************************************************************************
1788 * Print a list of all available modules (builtins and plugins) and a short
1789 * description for each one.
1790 *****************************************************************************/
1791 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1793 module_t *p_parser;
1795 bool b_color = var_InheritBool( p_this, "color" );
1797 #ifdef WIN32
1798 ShowConsole( true );
1799 b_color = false; // don't put color control codes in a .txt file
1800 #else
1801 if( !isatty( 1 ) )
1802 b_color = false;
1803 #endif
1805 /* List all modules */
1806 module_t **list = module_list_get (NULL);
1808 /* Enumerate each module */
1809 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1811 if( b_color )
1812 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1813 p_parser->psz_object_name,
1814 module_gettext( p_parser, p_parser->psz_longname ) );
1815 else
1816 utf8_fprintf( stdout, " %-22s %s\n",
1817 p_parser->psz_object_name,
1818 module_gettext( p_parser, p_parser->psz_longname ) );
1820 if( b_verbose )
1822 char *const *pp_shortcuts = p_parser->pp_shortcuts;
1823 for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1825 if( strcmp( pp_shortcuts[i], p_parser->psz_object_name ) )
1827 if( b_color )
1828 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1829 pp_shortcuts[i] );
1830 else
1831 utf8_fprintf( stdout, " s %s\n",
1832 pp_shortcuts[i] );
1835 if( p_parser->psz_capability )
1837 if( b_color )
1838 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1839 p_parser->psz_capability,
1840 p_parser->i_score );
1841 else
1842 utf8_fprintf( stdout, " c %s (%d)\n",
1843 p_parser->psz_capability,
1844 p_parser->i_score );
1848 module_list_free (list);
1850 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1851 PauseConsole();
1852 #endif
1855 /*****************************************************************************
1856 * Version: print complete program version
1857 *****************************************************************************
1858 * Print complete program version and build number.
1859 *****************************************************************************/
1860 static void Version( void )
1862 #ifdef WIN32
1863 ShowConsole( true );
1864 #endif
1866 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1867 psz_vlc_changeset );
1868 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1869 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1870 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1871 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1873 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1874 PauseConsole();
1875 #endif
1878 /*****************************************************************************
1879 * ShowConsole: On Win32, create an output console for debug messages
1880 *****************************************************************************
1881 * This function is useful only on Win32.
1882 *****************************************************************************/
1883 #ifdef WIN32 /* */
1884 static void ShowConsole( bool b_dofile )
1886 # ifndef UNDER_CE
1887 FILE *f_help = NULL;
1889 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1891 AllocConsole();
1892 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1893 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1894 * page (e.g. CP437 or CP850). */
1895 SetConsoleOutputCP (GetACP ());
1896 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1898 freopen( "CONOUT$", "w", stderr );
1899 freopen( "CONIN$", "r", stdin );
1901 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1903 fclose( f_help );
1904 freopen( "vlc-help.txt", "wt", stdout );
1905 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1907 else freopen( "CONOUT$", "w", stdout );
1909 # endif
1911 #endif
1913 /*****************************************************************************
1914 * PauseConsole: On Win32, wait for a key press before closing the console
1915 *****************************************************************************
1916 * This function is useful only on Win32.
1917 *****************************************************************************/
1918 #ifdef WIN32 /* */
1919 static void PauseConsole( void )
1921 # ifndef UNDER_CE
1923 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1925 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1926 getchar();
1927 fclose( stdout );
1929 # endif
1931 #endif
1933 /*****************************************************************************
1934 * ConsoleWidth: Return the console width in characters
1935 *****************************************************************************
1936 * We use the stty shell command to get the console width; if this fails or
1937 * if the width is less than 80, we default to 80.
1938 *****************************************************************************/
1939 static int ConsoleWidth( void )
1941 unsigned i_width = 80;
1943 #ifndef WIN32
1944 FILE *file = popen( "stty size 2>/dev/null", "r" );
1945 if (file != NULL)
1947 if (fscanf (file, "%*u %u", &i_width) <= 0)
1948 i_width = 80;
1949 pclose( file );
1951 #elif !defined (UNDER_CE)
1952 CONSOLE_SCREEN_BUFFER_INFO buf;
1954 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1955 i_width = buf.dwSize.X;
1956 #endif
1958 return i_width;