Win32: don't forget to remove the plugins cache at uninstall
[vlc/solaris.git] / src / libvlc.c
blob6ed2af2ca10ebcd10b7027ff7ba5ca7f70e1f16e
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 int GetFilenames ( libvlc_int_t *, int, const char *[] );
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;
222 * Allocate a libvlc instance, initialize global data if needed
223 * It also initializes the threading system
225 libvlc_int_t * libvlc_InternalCreate( void )
227 libvlc_int_t *p_libvlc;
228 libvlc_priv_t *priv;
229 char *psz_env = NULL;
231 /* Now that the thread system is initialized, we don't have much, but
232 * at least we have variables */
233 vlc_mutex_lock( &global_lock );
234 if( i_instances == 0 )
236 /* Guess what CPU we have */
237 cpu_flags = CPUCapabilities();
238 /* The module bank will be initialized later */
241 /* Allocate a libvlc instance object */
242 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
243 VLC_OBJECT_GENERIC, "libvlc" );
244 if( p_libvlc != NULL )
245 i_instances++;
246 vlc_mutex_unlock( &global_lock );
248 if( p_libvlc == NULL )
249 return NULL;
251 priv = libvlc_priv (p_libvlc);
252 priv->p_playlist = NULL;
253 priv->p_dialog_provider = NULL;
254 priv->p_vlm = NULL;
256 /* Initialize message queue */
257 priv->msg_bank = msg_Create ();
258 if (unlikely(priv->msg_bank == NULL))
259 goto error;
261 /* Find verbosity from VLC_VERBOSE environment variable */
262 psz_env = getenv( "VLC_VERBOSE" );
263 if( psz_env != NULL )
264 priv->i_verbose = atoi( psz_env );
265 else
266 priv->i_verbose = 3;
267 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
268 priv->b_color = isatty( 2 ); /* 2 is for stderr */
269 #else
270 priv->b_color = false;
271 #endif
273 /* Initialize mutexes */
274 vlc_mutex_init( &priv->timer_lock );
276 return p_libvlc;
277 error:
278 vlc_object_release (p_libvlc);
279 return NULL;
283 * Initialize a libvlc instance
284 * This function initializes a previously allocated libvlc instance:
285 * - CPU detection
286 * - gettext initialization
287 * - message queue, module bank and playlist initialization
288 * - configuration and commandline parsing
290 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
291 const char *ppsz_argv[] )
293 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
294 char * p_tmp = NULL;
295 char * psz_modules = NULL;
296 char * psz_parser = NULL;
297 char * psz_control = NULL;
298 bool b_exit = false;
299 int i_ret = VLC_EEXIT;
300 playlist_t *p_playlist = NULL;
301 char *psz_val;
302 #if defined( ENABLE_NLS ) \
303 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
304 # if defined (WIN32) || defined (__APPLE__)
305 char * psz_language;
306 #endif
307 #endif
309 /* System specific initialization code */
310 system_Init( p_libvlc, &i_argc, ppsz_argv );
313 * Support for gettext
315 vlc_bindtextdomain (PACKAGE_NAME);
317 /* Initialize the module bank and load the configuration of the
318 * main module. We need to do this at this stage to be able to display
319 * a short help if required by the user. (short help == main module
320 * options) */
321 module_InitBank( p_libvlc );
323 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
325 module_EndBank( p_libvlc, false );
326 return VLC_EGENERIC;
329 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
330 /* Announce who we are - Do it only for first instance ? */
331 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
332 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
333 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
334 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
336 /* Check for short help option */
337 if( var_InheritBool( p_libvlc, "help" ) )
339 Help( p_libvlc, "help" );
340 b_exit = true;
341 i_ret = VLC_EEXITSUCCESS;
343 /* Check for version option */
344 else if( var_InheritBool( p_libvlc, "version" ) )
346 Version();
347 b_exit = true;
348 i_ret = VLC_EEXITSUCCESS;
351 /* Check for daemon mode */
352 #ifndef WIN32
353 if( var_InheritBool( p_libvlc, "daemon" ) )
355 #ifdef HAVE_DAEMON
356 char *psz_pidfile = NULL;
358 if( daemon( 1, 0) != 0 )
360 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
361 b_exit = true;
363 b_daemon = true;
365 /* lets check if we need to write the pidfile */
366 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
367 if( psz_pidfile != NULL )
369 FILE *pidfile;
370 pid_t i_pid = getpid ();
371 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
372 i_pid, psz_pidfile );
373 pidfile = vlc_fopen( psz_pidfile,"w" );
374 if( pidfile != NULL )
376 utf8_fprintf( pidfile, "%d", (int)i_pid );
377 fclose( pidfile );
379 else
381 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
382 psz_pidfile );
385 free( psz_pidfile );
387 #else
388 pid_t i_pid;
390 if( ( i_pid = fork() ) < 0 )
392 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
393 b_exit = true;
395 else if( i_pid )
397 /* This is the parent, exit right now */
398 msg_Dbg( p_libvlc, "closing parent process" );
399 b_exit = true;
400 i_ret = VLC_EEXITSUCCESS;
402 else
404 /* We are the child */
405 msg_Dbg( p_libvlc, "daemon spawned" );
406 close( STDIN_FILENO );
407 close( STDOUT_FILENO );
408 close( STDERR_FILENO );
410 b_daemon = true;
412 #endif
414 #endif
416 if( b_exit )
418 module_EndBank( p_libvlc, false );
419 return i_ret;
422 /* Check for translation config option */
423 #if defined( ENABLE_NLS ) \
424 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
425 # if defined (WIN32) || defined (__APPLE__)
426 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
427 config_LoadConfigFile( p_libvlc, "main" );
428 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
430 /* Check if the user specified a custom language */
431 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
432 if( psz_language && strcmp( psz_language, "auto" ) )
434 /* Reset the default domain */
435 SetLanguage( psz_language );
437 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
438 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
440 free( psz_language );
441 # endif
442 #endif
445 * Load the builtins and plugins into the module_bank.
446 * We have to do it before config_Load*() because this also gets the
447 * list of configuration options exported by each module and loads their
448 * default values.
450 module_LoadPlugins( p_libvlc );
451 if( p_libvlc->b_die )
453 b_exit = true;
456 size_t module_count;
457 module_t **list = module_list_get( &module_count );
458 module_list_free( list );
459 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
461 /* Check for help on modules */
462 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
464 Help( p_libvlc, p_tmp );
465 free( p_tmp );
466 b_exit = true;
467 i_ret = VLC_EEXITSUCCESS;
469 /* Check for full help option */
470 else if( var_InheritBool( p_libvlc, "full-help" ) )
472 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
473 var_SetBool( p_libvlc, "advanced", true );
474 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
475 var_SetBool( p_libvlc, "help-verbose", true );
476 Help( p_libvlc, "full-help" );
477 b_exit = true;
478 i_ret = VLC_EEXITSUCCESS;
480 /* Check for long help option */
481 else if( var_InheritBool( p_libvlc, "longhelp" ) )
483 Help( p_libvlc, "longhelp" );
484 b_exit = true;
485 i_ret = VLC_EEXITSUCCESS;
487 /* Check for module list option */
488 else if( var_InheritBool( p_libvlc, "list" ) )
490 ListModules( p_libvlc, false );
491 b_exit = true;
492 i_ret = VLC_EEXITSUCCESS;
494 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
496 ListModules( p_libvlc, true );
497 b_exit = true;
498 i_ret = VLC_EEXITSUCCESS;
501 /* Check for config file options */
502 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
504 if( var_InheritBool( p_libvlc, "reset-config" ) )
506 config_ResetAll( p_libvlc );
507 config_SaveConfigFile( p_libvlc, NULL );
511 if( module_count <= 1)
513 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
514 "that you properly gave a module path with --plugin-path.");
515 b_exit = true;
516 i_ret = VLC_ENOITEM;
519 if( b_exit )
521 module_EndBank( p_libvlc, true );
522 return i_ret;
526 * Override default configuration with config file settings
528 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
529 config_LoadConfigFile( p_libvlc, NULL );
532 * Override configuration with command line settings
534 /* config_LoadCmdLine(), DBus (below) and Win32-specific use vlc_optind,
535 * vlc_optarg and vlc_optopt globals. This is not thread-safe!! */
536 #warning BUG!
537 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
539 #ifdef WIN32
540 ShowConsole( false );
541 /* Pause the console because it's destroyed when we exit */
542 fprintf( stderr, "The command line options couldn't be loaded, check "
543 "that they are valid.\n" );
544 PauseConsole();
545 #endif
546 module_EndBank( p_libvlc, true );
547 return VLC_EGENERIC;
549 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
551 /* FIXME: could be replaced by using Unix sockets */
552 #ifdef HAVE_DBUS
553 dbus_threads_init_default();
555 if( var_InheritBool( p_libvlc, "one-instance" )
556 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
557 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
559 /* Initialise D-Bus interface, check for other instances */
560 DBusConnection *p_conn = NULL;
561 DBusError dbus_error;
563 dbus_error_init( &dbus_error );
565 /* connect to the session bus */
566 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
567 if( !p_conn )
569 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
570 dbus_error.message );
571 dbus_error_free( &dbus_error );
573 else
575 /* check if VLC is available on the bus
576 * if not: D-Bus control is not enabled on the other
577 * instance and we can't pass MRLs to it */
578 DBusMessage *p_test_msg = NULL;
579 DBusMessage *p_test_reply = NULL;
580 p_test_msg = dbus_message_new_method_call(
581 "org.mpris.vlc", "/",
582 "org.freedesktop.MediaPlayer", "Identity" );
583 /* block until a reply arrives */
584 p_test_reply = dbus_connection_send_with_reply_and_block(
585 p_conn, p_test_msg, -1, &dbus_error );
586 dbus_message_unref( p_test_msg );
587 if( p_test_reply == NULL )
589 dbus_error_free( &dbus_error );
590 msg_Dbg( p_libvlc, "No Media Player is running. "
591 "Continuing normally." );
593 else
595 int i_input;
596 DBusMessage* p_dbus_msg = NULL;
597 DBusMessageIter dbus_args;
598 DBusPendingCall* p_dbus_pending = NULL;
599 dbus_bool_t b_play;
601 dbus_message_unref( p_test_reply );
602 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
604 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
606 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
607 ppsz_argv[i_input] );
609 p_dbus_msg = dbus_message_new_method_call(
610 "org.mpris.vlc", "/TrackList",
611 "org.freedesktop.MediaPlayer", "AddTrack" );
613 if ( NULL == p_dbus_msg )
615 msg_Err( p_libvlc, "D-Bus problem" );
616 system_End( p_libvlc );
617 exit( 1 );
620 /* append MRLs */
621 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
622 if ( !dbus_message_iter_append_basic( &dbus_args,
623 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
625 dbus_message_unref( p_dbus_msg );
626 system_End( p_libvlc );
627 exit( 1 );
629 b_play = TRUE;
630 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
631 b_play = FALSE;
632 if ( !dbus_message_iter_append_basic( &dbus_args,
633 DBUS_TYPE_BOOLEAN, &b_play ) )
635 dbus_message_unref( p_dbus_msg );
636 system_End( p_libvlc );
637 exit( 1 );
640 /* send message and get a handle for a reply */
641 if ( !dbus_connection_send_with_reply ( p_conn,
642 p_dbus_msg, &p_dbus_pending, -1 ) )
644 msg_Err( p_libvlc, "D-Bus problem" );
645 dbus_message_unref( p_dbus_msg );
646 system_End( p_libvlc );
647 exit( 1 );
650 if ( NULL == p_dbus_pending )
652 msg_Err( p_libvlc, "D-Bus problem" );
653 dbus_message_unref( p_dbus_msg );
654 system_End( p_libvlc );
655 exit( 1 );
657 dbus_connection_flush( p_conn );
658 dbus_message_unref( p_dbus_msg );
659 /* block until we receive a reply */
660 dbus_pending_call_block( p_dbus_pending );
661 dbus_pending_call_unref( p_dbus_pending );
662 } /* processes all command line MRLs */
664 /* bye bye */
665 system_End( p_libvlc );
666 exit( 0 );
669 /* we unreference the connection when we've finished with it */
670 if( p_conn ) dbus_connection_unref( p_conn );
672 #endif
675 * Message queue options
677 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
678 if( psz_verbose_objects )
680 char * psz_object, * iter = psz_verbose_objects;
681 while( (psz_object = strsep( &iter, "," )) )
683 switch( psz_object[0] )
685 printf("%s\n", psz_object+1);
686 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
687 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
688 default:
689 msg_Err( p_libvlc, "verbose-objects usage: \n"
690 "--verbose-objects=+printthatobject,"
691 "-dontprintthatone\n"
692 "(keyword 'all' to applies to all objects)");
693 free( psz_verbose_objects );
694 /* FIXME: leaks!!!! */
695 return VLC_EGENERIC;
698 free( psz_verbose_objects );
701 /* Last chance to set the verbosity. Once we start interfaces and other
702 * threads, verbosity becomes read-only. */
703 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
704 if( var_InheritBool( p_libvlc, "quiet" ) )
706 var_SetInteger( p_libvlc, "verbose", -1 );
707 priv->i_verbose = -1;
709 vlc_threads_setup( p_libvlc );
711 if( priv->b_color )
712 priv->b_color = var_InheritBool( p_libvlc, "color" );
714 char p_capabilities[200];
715 #define PRINT_CAPABILITY( capability, string ) \
716 if( vlc_CPU() & capability ) \
718 strncat( p_capabilities, string " ", \
719 sizeof(p_capabilities) - strlen(p_capabilities) ); \
720 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
722 p_capabilities[0] = '\0';
724 #if defined( __i386__ ) || defined( __x86_64__ )
725 if( !var_InheritBool( p_libvlc, "mmx" ) )
726 cpu_flags &= ~CPU_CAPABILITY_MMX;
727 if( !var_InheritBool( p_libvlc, "3dn" ) )
728 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
729 if( !var_InheritBool( p_libvlc, "mmxext" ) )
730 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
731 if( !var_InheritBool( p_libvlc, "sse" ) )
732 cpu_flags &= ~CPU_CAPABILITY_SSE;
733 if( !var_InheritBool( p_libvlc, "sse2" ) )
734 cpu_flags &= ~CPU_CAPABILITY_SSE2;
735 if( !var_InheritBool( p_libvlc, "sse3" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSE3;
737 if( !var_InheritBool( p_libvlc, "ssse3" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
739 if( !var_InheritBool( p_libvlc, "sse41" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
741 if( !var_InheritBool( p_libvlc, "sse42" ) )
742 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
744 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
745 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
752 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
753 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
755 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
756 if( !var_InheritBool( p_libvlc, "altivec" ) )
757 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
759 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
761 #elif defined( __arm__ )
762 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
764 #endif
766 #if HAVE_FPU
767 strncat( p_capabilities, "FPU ",
768 sizeof(p_capabilities) - strlen( p_capabilities) );
769 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
770 #endif
772 if (p_capabilities[0])
773 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
776 * Choose the best memcpy module
778 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
779 /* Avoid being called "memcpy":*/
780 vlc_object_set_name( p_libvlc, "main" );
782 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
783 priv->i_timers = 0;
784 priv->pp_timers = NULL;
786 priv->i_last_input_id = 0; /* Not very safe, should be removed */
789 * Initialize hotkey handling
791 vlc_InitActions( p_libvlc );
793 /* Create a variable for showing the fullscreen interface */
794 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
795 var_SetBool( p_libvlc, "intf-show", true );
797 /* Create a variable for showing the right click menu */
798 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
800 /* variables for signalling creation of new files */
801 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
802 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
804 /* Initialize playlist and get commandline files */
805 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
806 if( !p_playlist )
808 msg_Err( p_libvlc, "playlist initialization failed" );
809 if( priv->p_memcpy_module != NULL )
811 module_unneed( p_libvlc, priv->p_memcpy_module );
813 module_EndBank( p_libvlc, true );
814 return VLC_EGENERIC;
817 /* System specific configuration */
818 system_Configure( p_libvlc, &i_argc, ppsz_argv );
820 /* Add service discovery modules */
821 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
822 if( psz_modules )
824 char *p = psz_modules, *m;
825 while( ( m = strsep( &p, " :," ) ) != NULL )
826 playlist_ServicesDiscoveryAdd( p_playlist, m );
827 free( psz_modules );
830 #ifdef ENABLE_VLM
831 /* Initialize VLM if vlm-conf is specified */
832 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
833 if( psz_parser )
835 priv->p_vlm = vlm_New( p_libvlc );
836 if( !priv->p_vlm )
837 msg_Err( p_libvlc, "VLM initialization failed" );
839 free( psz_parser );
840 #endif
843 * Load background interfaces
845 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
846 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
848 if( psz_modules && psz_control )
850 char* psz_tmp;
851 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
853 free( psz_modules );
854 psz_modules = psz_tmp;
857 else if( psz_control )
859 free( psz_modules );
860 psz_modules = strdup( psz_control );
863 psz_parser = psz_modules;
864 while ( psz_parser && *psz_parser )
866 char *psz_module, *psz_temp;
867 psz_module = psz_parser;
868 psz_parser = strchr( psz_module, ':' );
869 if ( psz_parser )
871 *psz_parser = '\0';
872 psz_parser++;
874 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
876 intf_Create( p_libvlc, psz_temp );
877 free( psz_temp );
880 free( psz_modules );
881 free( psz_control );
884 * Always load the hotkeys interface if it exists
886 intf_Create( p_libvlc, "hotkeys,none" );
888 #ifdef HAVE_DBUS
889 /* loads dbus control interface if in one-instance mode
890 * we do it only when playlist exists, because dbus module needs it */
891 if( var_InheritBool( p_libvlc, "one-instance" )
892 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
893 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
894 intf_Create( p_libvlc, "dbus,none" );
896 # if !defined (HAVE_MAEMO)
897 /* Prevents the power management daemon from suspending the system
898 * when VLC is active */
899 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
900 intf_Create( p_libvlc, "inhibit,none" );
901 # endif
902 #endif
904 if( var_InheritBool( p_libvlc, "file-logging" ) &&
905 !var_InheritBool( p_libvlc, "syslog" ) )
907 intf_Create( p_libvlc, "logger,none" );
909 #ifdef HAVE_SYSLOG_H
910 if( var_InheritBool( p_libvlc, "syslog" ) )
912 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
913 var_SetString( p_libvlc, "logmode", "syslog" );
914 intf_Create( p_libvlc, "logger,none" );
916 if( logmode )
918 var_SetString( p_libvlc, "logmode", logmode );
919 free( logmode );
921 var_Destroy( p_libvlc, "logmode" );
923 #endif
925 if( var_InheritBool( p_libvlc, "network-synchronisation") )
927 intf_Create( p_libvlc, "netsync,none" );
930 #ifdef WIN32
931 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
933 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
934 if( psz_codecs )
936 char *psz_morecodecs;
937 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
939 var_SetString( p_libvlc, "codec", psz_morecodecs);
940 free( psz_morecodecs );
942 free( psz_codecs );
944 else
945 var_SetString( p_libvlc, "codec", "dmo,quicktime");
947 #endif
949 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
952 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
953 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
954 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
955 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
956 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
957 #ifdef WIN32
958 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_ADDRESS );
959 #endif
962 * Get input filenames given as commandline arguments
964 GetFilenames( p_libvlc, i_argc, ppsz_argv );
967 * Get --open argument
969 psz_val = var_InheritString( p_libvlc, "open" );
970 if ( psz_val != NULL )
972 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
973 -1, 0, NULL, 0, true, pl_Unlocked );
974 free( psz_val );
977 return VLC_SUCCESS;
981 * Cleanup a libvlc instance. The instance is not completely deallocated
982 * \param p_libvlc the instance to clean
984 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
986 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
987 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
989 /* Deactivate the playlist */
990 msg_Dbg( p_libvlc, "deactivating the playlist" );
991 pl_Deactivate( p_libvlc );
993 /* Remove all services discovery */
994 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
995 playlist_ServicesDiscoveryKillAll( p_playlist );
997 /* Ask the interfaces to stop and destroy them */
998 msg_Dbg( p_libvlc, "removing all interfaces" );
999 libvlc_Quit( p_libvlc );
1000 intf_DestroyAll( p_libvlc );
1002 #ifdef ENABLE_VLM
1003 /* Destroy VLM if created in libvlc_InternalInit */
1004 if( priv->p_vlm )
1006 vlm_Delete( priv->p_vlm );
1008 #endif
1010 /* Free playlist now, all threads are gone */
1011 playlist_Destroy( p_playlist );
1013 stats_TimersDumpAll( p_libvlc );
1014 stats_TimersCleanAll( p_libvlc );
1016 msg_Dbg( p_libvlc, "removing stats" );
1018 #ifndef WIN32
1019 char* psz_pidfile = NULL;
1021 if( b_daemon )
1023 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1024 if( psz_pidfile != NULL )
1026 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1027 if( unlink( psz_pidfile ) == -1 )
1029 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1030 psz_pidfile );
1033 free( psz_pidfile );
1035 #endif
1037 if( priv->p_memcpy_module )
1039 module_unneed( p_libvlc, priv->p_memcpy_module );
1040 priv->p_memcpy_module = NULL;
1043 /* Free module bank. It is refcounted, so we call this each time */
1044 module_EndBank( p_libvlc, true );
1046 vlc_DeinitActions( p_libvlc );
1050 * Destroy everything.
1051 * This function requests the running threads to finish, waits for their
1052 * termination, and destroys their structure.
1053 * It stops the thread systems: no instance can run after this has run
1054 * \param p_libvlc the instance to destroy
1056 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1058 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1060 vlc_mutex_lock( &global_lock );
1061 i_instances--;
1063 if( i_instances == 0 )
1065 /* System specific cleaning code */
1066 system_End( p_libvlc );
1068 vlc_mutex_unlock( &global_lock );
1070 msg_Destroy (priv->msg_bank);
1072 /* Destroy mutexes */
1073 vlc_mutex_destroy( &priv->timer_lock );
1075 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1076 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1077 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1078 vlc_object_release( p_libvlc );
1079 #endif
1081 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1082 vlc_object_release( p_libvlc );
1086 * Add an interface plugin and run it
1088 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1090 if( !p_libvlc )
1091 return VLC_EGENERIC;
1093 if( !psz_module ) /* requesting the default interface */
1095 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1096 if( !psz_interface ) /* "intf" has not been set */
1098 #ifndef WIN32
1099 if( b_daemon )
1100 /* Daemon mode hack.
1101 * We prefer the dummy interface if none is specified. */
1102 psz_module = "dummy";
1103 else
1104 #endif
1105 msg_Info( p_libvlc, "%s",
1106 _("Running vlc with the default interface. "
1107 "Use 'cvlc' to use vlc without interface.") );
1109 free( psz_interface );
1110 var_Destroy( p_libvlc, "intf" );
1113 /* Try to create the interface */
1114 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1115 if( ret )
1116 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1117 psz_module ? psz_module : "default" );
1118 return ret;
1121 #ifndef WIN32
1122 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1123 static vlc_cond_t exiting = VLC_STATIC_COND;
1124 #else
1125 extern vlc_mutex_t super_mutex;
1126 extern vlc_cond_t super_variable;
1127 # define exit_lock super_mutex
1128 # define exiting super_variable
1129 #endif
1132 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1133 * when the user "exits" an interface plugin.
1135 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1137 vlc_mutex_lock( &exit_lock );
1138 while( vlc_object_alive( p_libvlc ) )
1139 vlc_cond_wait( &exiting, &exit_lock );
1140 vlc_mutex_unlock( &exit_lock );
1144 * Posts an exit signal to LibVLC instance. This will normally initiate the
1145 * cleanup and destroy process. It should only be called on behalf of the user.
1147 void libvlc_Quit( libvlc_int_t *p_libvlc )
1149 vlc_mutex_lock( &exit_lock );
1150 vlc_object_kill( p_libvlc );
1151 vlc_cond_broadcast( &exiting );
1152 vlc_mutex_unlock( &exit_lock );
1155 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1156 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1157 /*****************************************************************************
1158 * SetLanguage: set the interface language.
1159 *****************************************************************************
1160 * We set the LC_MESSAGES locale category for interface messages and buttons,
1161 * as well as the LC_CTYPE category for string sorting and possible wide
1162 * character support.
1163 *****************************************************************************/
1164 static void SetLanguage ( const char *psz_lang )
1166 #ifdef __APPLE__
1167 /* I need that under Darwin, please check it doesn't disturb
1168 * other platforms. --Meuuh */
1169 setenv( "LANG", psz_lang, 1 );
1171 #else
1172 /* We set LC_ALL manually because it is the only way to set
1173 * the language at runtime under eg. Windows. Beware that this
1174 * makes the environment unconsistent when libvlc is unloaded and
1175 * should probably be moved to a safer place like vlc.c. */
1176 static char psz_lcall[20];
1177 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1178 psz_lcall[19] = '\0';
1179 putenv( psz_lcall );
1180 #endif
1182 setlocale( LC_ALL, psz_lang );
1184 #endif
1186 /*****************************************************************************
1187 * GetFilenames: parse command line options which are not flags
1188 *****************************************************************************
1189 * Parse command line for input files as well as their associated options.
1190 * An option always follows its associated input and begins with a ":".
1191 *****************************************************************************/
1192 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1194 int i_opt, i_options;
1196 /* We assume that the remaining parameters are filenames
1197 * and their input options */
1198 for( i_opt = i_argc - 1; i_opt >= vlc_optind; i_opt-- )
1200 i_options = 0;
1202 /* Count the input options */
1203 while( *ppsz_argv[ i_opt ] == ':' && i_opt > vlc_optind )
1205 i_options++;
1206 i_opt--;
1209 /* TODO: write an internal function of this one, to avoid
1210 * unnecessary lookups. */
1211 char *mrl = make_URI( ppsz_argv[i_opt] );
1212 if( !mrl )
1213 continue;
1215 playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1216 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1217 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1218 free( mrl );
1221 return VLC_SUCCESS;
1224 /*****************************************************************************
1225 * Help: print program help
1226 *****************************************************************************
1227 * Print a short inline help. Message interface is initialized at this stage.
1228 *****************************************************************************/
1229 static inline void print_help_on_full_help( void )
1231 utf8_fprintf( stdout, "\n" );
1232 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1235 static const char vlc_usage[] = N_(
1236 "Usage: %s [options] [stream] ..."
1237 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1238 "\nThe first item specified will be played first."
1239 "\n"
1240 "\nOptions-styles:"
1241 "\n --option A global option that is set for the duration of the program."
1242 "\n -option A single letter version of a global --option."
1243 "\n :option An option that only applies to the stream directly before it"
1244 "\n and that overrides previous settings."
1245 "\n"
1246 "\nStream MRL syntax:"
1247 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1248 "\n"
1249 "\n Many of the global --options can also be used as MRL specific :options."
1250 "\n Multiple :option=value pairs can be specified."
1251 "\n"
1252 "\nURL syntax:"
1253 "\n [file://]filename Plain media file"
1254 "\n http://ip:port/file HTTP URL"
1255 "\n ftp://ip:port/file FTP URL"
1256 "\n mms://ip:port/file MMS URL"
1257 "\n screen:// Screen capture"
1258 "\n [dvd://][device][@raw_device] DVD device"
1259 "\n [vcd://][device] VCD device"
1260 "\n [cdda://][device] Audio CD device"
1261 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1262 "\n UDP stream sent by a streaming server"
1263 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1264 "\n vlc://quit Special item to quit VLC"
1265 "\n");
1267 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1269 #ifdef WIN32
1270 ShowConsole( true );
1271 #endif
1273 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1275 utf8_fprintf( stdout, vlc_usage, "vlc" );
1276 Usage( p_this, "=help" );
1277 Usage( p_this, "=main" );
1278 print_help_on_full_help();
1280 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1282 utf8_fprintf( stdout, vlc_usage, "vlc" );
1283 Usage( p_this, NULL );
1284 print_help_on_full_help();
1286 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1288 utf8_fprintf( stdout, vlc_usage, "vlc" );
1289 Usage( p_this, NULL );
1291 else if( psz_help_name )
1293 Usage( p_this, psz_help_name );
1296 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1297 PauseConsole();
1298 #endif
1301 /*****************************************************************************
1302 * Usage: print module usage
1303 *****************************************************************************
1304 * Print a short inline help. Message interface is initialized at this stage.
1305 *****************************************************************************/
1306 # define COL(x) "\033[" #x ";1m"
1307 # define RED COL(31)
1308 # define GREEN COL(32)
1309 # define YELLOW COL(33)
1310 # define BLUE COL(34)
1311 # define MAGENTA COL(35)
1312 # define CYAN COL(36)
1313 # define WHITE COL(0)
1314 # define GRAY "\033[0m"
1315 static void
1316 print_help_section( const module_t *m, const module_config_t *p_item,
1317 bool b_color, bool b_description )
1319 if( !p_item ) return;
1320 if( b_color )
1322 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1323 module_gettext( m, p_item->psz_text ) );
1324 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1325 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1326 module_gettext( m, p_item->psz_longtext ) );
1328 else
1330 utf8_fprintf( stdout, " %s:\n",
1331 module_gettext( m, p_item->psz_text ) );
1332 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1333 utf8_fprintf( stdout, " %s\n",
1334 module_gettext(m, p_item->psz_longtext ) );
1338 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1340 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1341 /* short option ------' | | | | | | |
1342 * option name ------------' | | | | | |
1343 * <bra ---------------------' | | | | |
1344 * option type or "" ----------' | | | |
1345 * ket> -------------------------' | | |
1346 * padding spaces -----------------' | |
1347 * comment --------------------------' |
1348 * comment suffix ---------------------'
1350 * The purpose of having bra and ket is that we might i18n them as well.
1353 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1354 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1356 #define LINE_START 8
1357 #define PADDING_SPACES 25
1358 #ifdef WIN32
1359 # define OPTION_VALUE_SEP "="
1360 #else
1361 # define OPTION_VALUE_SEP " "
1362 #endif
1363 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1364 char psz_spaces_longtext[LINE_START+3];
1365 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1366 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1367 char psz_buffer[10000];
1368 char psz_short[4];
1369 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1370 int i_width_description = i_width + PADDING_SPACES - 1;
1371 bool b_advanced = var_InheritBool( p_this, "advanced" );
1372 bool b_description = var_InheritBool( p_this, "help-verbose" );
1373 bool b_description_hack;
1374 bool b_color = var_InheritBool( p_this, "color" );
1375 bool b_has_advanced = false;
1376 bool b_found = false;
1377 int i_only_advanced = 0; /* Number of modules ignored because they
1378 * only have advanced options */
1379 bool b_strict = psz_search && *psz_search == '=';
1380 if( b_strict ) psz_search++;
1382 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1383 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1384 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1385 psz_spaces_longtext[LINE_START+2] = '\0';
1386 #ifndef WIN32
1387 if( !isatty( 1 ) )
1388 #endif
1389 b_color = false; // don't put color control codes in a .txt file
1391 if( b_color )
1393 strcpy( psz_format, COLOR_FORMAT_STRING );
1394 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1396 else
1398 strcpy( psz_format, FORMAT_STRING );
1399 strcpy( psz_format_bool, FORMAT_STRING );
1402 /* List all modules */
1403 module_t **list = module_list_get (NULL);
1404 if (!list)
1405 return;
1407 /* Ugly hack to make sure that the help options always come first
1408 * (part 1) */
1409 if( !psz_search )
1410 Usage( p_this, "help" );
1412 /* Enumerate the config for each module */
1413 for (size_t i = 0; list[i]; i++)
1415 bool b_help_module;
1416 module_t *p_parser = list[i];
1417 module_config_t *p_item = NULL;
1418 module_config_t *p_section = NULL;
1419 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1421 if( psz_search &&
1422 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1423 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1425 char *const *pp_shortcut = p_parser->pp_shortcuts;
1426 while( *pp_shortcut )
1428 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1429 : !!strstr( *pp_shortcut, psz_search ) )
1430 break;
1431 pp_shortcut ++;
1433 if( !*pp_shortcut )
1434 continue;
1437 /* Ignore modules without config options */
1438 if( !p_parser->i_config_items )
1440 continue;
1443 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1444 /* Ugly hack to make sure that the help options always come first
1445 * (part 2) */
1446 if( !psz_search && b_help_module )
1447 continue;
1449 /* Ignore modules with only advanced config options if requested */
1450 if( !b_advanced )
1452 for( p_item = p_parser->p_config;
1453 p_item < p_end;
1454 p_item++ )
1456 if( (p_item->i_type & CONFIG_ITEM) &&
1457 !p_item->b_advanced && !p_item->b_removed ) break;
1460 if( p_item == p_end )
1462 i_only_advanced++;
1463 continue;
1467 b_found = true;
1469 /* Print name of module */
1470 if( strcmp( "main", p_parser->psz_object_name ) )
1472 if( b_color )
1473 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1474 module_gettext( p_parser, p_parser->psz_longname ),
1475 p_parser->psz_object_name );
1476 else
1477 utf8_fprintf( stdout, "\n %s\n",
1478 module_gettext(p_parser, p_parser->psz_longname ) );
1480 if( p_parser->psz_help )
1482 if( b_color )
1483 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1484 module_gettext( p_parser, p_parser->psz_help ) );
1485 else
1486 utf8_fprintf( stdout, " %s\n",
1487 module_gettext( p_parser, p_parser->psz_help ) );
1490 /* Print module options */
1491 for( p_item = p_parser->p_config;
1492 p_item < p_end;
1493 p_item++ )
1495 char *psz_text, *psz_spaces = psz_spaces_text;
1496 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1497 const char *psz_suf = "", *psz_prefix = NULL;
1498 signed int i;
1499 size_t i_cur_width;
1501 /* Skip removed options */
1502 if( p_item->b_removed )
1504 continue;
1506 /* Skip advanced options if requested */
1507 if( p_item->b_advanced && !b_advanced )
1509 b_has_advanced = true;
1510 continue;
1513 switch( p_item->i_type )
1515 case CONFIG_HINT_CATEGORY:
1516 case CONFIG_HINT_USAGE:
1517 if( !strcmp( "main", p_parser->psz_object_name ) )
1519 if( b_color )
1520 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1521 module_gettext( p_parser, p_item->psz_text ) );
1522 else
1523 utf8_fprintf( stdout, "\n %s\n",
1524 module_gettext( p_parser, p_item->psz_text ) );
1526 if( b_description && p_item->psz_longtext
1527 && *p_item->psz_longtext )
1529 if( b_color )
1530 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1531 module_gettext( p_parser, p_item->psz_longtext ) );
1532 else
1533 utf8_fprintf( stdout, " %s\n",
1534 module_gettext( p_parser, p_item->psz_longtext ) );
1536 break;
1538 case CONFIG_HINT_SUBCATEGORY:
1539 if( strcmp( "main", p_parser->psz_object_name ) )
1540 break;
1541 case CONFIG_SECTION:
1542 p_section = p_item;
1543 break;
1545 case CONFIG_ITEM_STRING:
1546 case CONFIG_ITEM_FILE:
1547 case CONFIG_ITEM_DIRECTORY:
1548 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1549 case CONFIG_ITEM_MODULE_CAT:
1550 case CONFIG_ITEM_MODULE_LIST:
1551 case CONFIG_ITEM_MODULE_LIST_CAT:
1552 case CONFIG_ITEM_FONT:
1553 case CONFIG_ITEM_PASSWORD:
1554 print_help_section( p_parser, p_section, b_color,
1555 b_description );
1556 p_section = NULL;
1557 psz_bra = OPTION_VALUE_SEP "<";
1558 psz_type = _("string");
1559 psz_ket = ">";
1561 if( p_item->ppsz_list )
1563 psz_bra = OPTION_VALUE_SEP "{";
1564 psz_type = psz_buffer;
1565 psz_buffer[0] = '\0';
1566 for( i = 0; p_item->ppsz_list[i]; i++ )
1568 if( i ) strcat( psz_buffer, "," );
1569 strcat( psz_buffer, p_item->ppsz_list[i] );
1571 psz_ket = "}";
1573 break;
1574 case CONFIG_ITEM_INTEGER:
1575 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1576 print_help_section( p_parser, p_section, b_color,
1577 b_description );
1578 p_section = NULL;
1579 psz_bra = OPTION_VALUE_SEP "<";
1580 psz_type = _("integer");
1581 psz_ket = ">";
1583 if( p_item->min.i || p_item->max.i )
1585 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1586 p_item->min.i, p_item->max.i );
1587 psz_type = psz_buffer;
1590 if( p_item->i_list )
1592 psz_bra = OPTION_VALUE_SEP "{";
1593 psz_type = psz_buffer;
1594 psz_buffer[0] = '\0';
1595 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1597 if( i ) strcat( psz_buffer, ", " );
1598 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1599 p_item->pi_list[i],
1600 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1602 psz_ket = "}";
1604 break;
1605 case CONFIG_ITEM_FLOAT:
1606 print_help_section( p_parser, p_section, b_color,
1607 b_description );
1608 p_section = NULL;
1609 psz_bra = OPTION_VALUE_SEP "<";
1610 psz_type = _("float");
1611 psz_ket = ">";
1612 if( p_item->min.f || p_item->max.f )
1614 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1615 p_item->min.f, p_item->max.f );
1616 psz_type = psz_buffer;
1618 break;
1619 case CONFIG_ITEM_BOOL:
1620 print_help_section( p_parser, p_section, b_color,
1621 b_description );
1622 p_section = NULL;
1623 psz_bra = ""; psz_type = ""; psz_ket = "";
1624 if( !b_help_module )
1626 psz_suf = p_item->value.i ? _(" (default enabled)") :
1627 _(" (default disabled)");
1629 break;
1632 if( !psz_type )
1634 continue;
1637 /* Add short option if any */
1638 if( p_item->i_short )
1640 sprintf( psz_short, "-%c,", p_item->i_short );
1642 else
1644 strcpy( psz_short, " " );
1647 i = PADDING_SPACES - strlen( p_item->psz_name )
1648 - strlen( psz_bra ) - strlen( psz_type )
1649 - strlen( psz_ket ) - 1;
1651 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1653 psz_prefix = ", --no-";
1654 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1657 if( i < 0 )
1659 psz_spaces[0] = '\n';
1660 i = 0;
1662 else
1664 psz_spaces[i] = '\0';
1667 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1669 utf8_fprintf( stdout, psz_format_bool, psz_short,
1670 p_item->psz_name, psz_prefix, p_item->psz_name,
1671 psz_bra, psz_type, psz_ket, psz_spaces );
1673 else
1675 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1676 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1679 psz_spaces[i] = ' ';
1681 /* We wrap the rest of the output */
1682 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1683 psz_suf );
1684 b_description_hack = b_description;
1686 description:
1687 psz_text = psz_buffer;
1688 i_cur_width = b_description && !b_description_hack
1689 ? i_width_description
1690 : i_width;
1691 while( *psz_text )
1693 char *psz_parser, *psz_word;
1694 size_t i_end = strlen( psz_text );
1696 /* If the remaining text fits in a line, print it. */
1697 if( i_end <= i_cur_width )
1699 if( b_color )
1701 if( !b_description || b_description_hack )
1702 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1703 else
1704 utf8_fprintf( stdout, "%s\n", psz_text );
1706 else
1708 utf8_fprintf( stdout, "%s\n", psz_text );
1710 break;
1713 /* Otherwise, eat as many words as possible */
1714 psz_parser = psz_text;
1717 psz_word = psz_parser;
1718 psz_parser = strchr( psz_word, ' ' );
1719 /* If no space was found, we reached the end of the text
1720 * block; otherwise, we skip the space we just found. */
1721 psz_parser = psz_parser ? psz_parser + 1
1722 : psz_text + i_end;
1724 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1726 /* We cut a word in one of these cases:
1727 * - it's the only word in the line and it's too long.
1728 * - we used less than 80% of the width and the word we are
1729 * going to wrap is longer than 40% of the width, and even
1730 * if the word would have fit in the next line. */
1731 if( psz_word == psz_text
1732 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1733 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1735 char c = psz_text[i_cur_width];
1736 psz_text[i_cur_width] = '\0';
1737 if( b_color )
1739 if( !b_description || b_description_hack )
1740 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1741 psz_text, psz_spaces );
1742 else
1743 utf8_fprintf( stdout, "%s\n%s",
1744 psz_text, psz_spaces );
1746 else
1748 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1750 psz_text += i_cur_width;
1751 psz_text[0] = c;
1753 else
1755 psz_word[-1] = '\0';
1756 if( b_color )
1758 if( !b_description || b_description_hack )
1759 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1760 psz_text, psz_spaces );
1761 else
1762 utf8_fprintf( stdout, "%s\n%s",
1763 psz_text, psz_spaces );
1765 else
1767 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1769 psz_text = psz_word;
1773 if( b_description_hack && p_item->psz_longtext
1774 && *p_item->psz_longtext )
1776 sprintf( psz_buffer, "%s%s",
1777 module_gettext( p_parser, p_item->psz_longtext ),
1778 psz_suf );
1779 b_description_hack = false;
1780 psz_spaces = psz_spaces_longtext;
1781 utf8_fprintf( stdout, "%s", psz_spaces );
1782 goto description;
1787 if( b_has_advanced )
1789 if( b_color )
1790 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1791 _( "add --advanced to your command line to see advanced options."));
1792 else
1793 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1794 _( "add --advanced to your command line to see advanced options."));
1797 if( i_only_advanced > 0 )
1799 if( b_color )
1801 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1802 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1804 else
1806 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1807 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1810 else if( !b_found )
1812 if( b_color )
1813 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1814 _( "No matching module found. Use --list or " \
1815 "--list-verbose to list available modules." ) );
1816 else
1817 utf8_fprintf( stdout, "\n%s\n",
1818 _( "No matching module found. Use --list or " \
1819 "--list-verbose to list available modules." ) );
1822 /* Release the module list */
1823 module_list_free (list);
1826 /*****************************************************************************
1827 * ListModules: list the available modules with their description
1828 *****************************************************************************
1829 * Print a list of all available modules (builtins and plugins) and a short
1830 * description for each one.
1831 *****************************************************************************/
1832 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1834 module_t *p_parser;
1836 bool b_color = var_InheritBool( p_this, "color" );
1838 #ifdef WIN32
1839 ShowConsole( true );
1840 b_color = false; // don't put color control codes in a .txt file
1841 #else
1842 if( !isatty( 1 ) )
1843 b_color = false;
1844 #endif
1846 /* List all modules */
1847 module_t **list = module_list_get (NULL);
1849 /* Enumerate each module */
1850 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1852 if( b_color )
1853 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1854 p_parser->psz_object_name,
1855 module_gettext( p_parser, p_parser->psz_longname ) );
1856 else
1857 utf8_fprintf( stdout, " %-22s %s\n",
1858 p_parser->psz_object_name,
1859 module_gettext( p_parser, p_parser->psz_longname ) );
1861 if( b_verbose )
1863 char *const *pp_shortcut = p_parser->pp_shortcuts;
1864 while( *pp_shortcut )
1866 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1868 if( b_color )
1869 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1870 *pp_shortcut );
1871 else
1872 utf8_fprintf( stdout, " s %s\n",
1873 *pp_shortcut );
1875 pp_shortcut++;
1877 if( p_parser->psz_capability )
1879 if( b_color )
1880 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1881 p_parser->psz_capability,
1882 p_parser->i_score );
1883 else
1884 utf8_fprintf( stdout, " c %s (%d)\n",
1885 p_parser->psz_capability,
1886 p_parser->i_score );
1890 module_list_free (list);
1892 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1893 PauseConsole();
1894 #endif
1897 /*****************************************************************************
1898 * Version: print complete program version
1899 *****************************************************************************
1900 * Print complete program version and build number.
1901 *****************************************************************************/
1902 static void Version( void )
1904 extern const char psz_vlc_changeset[];
1905 #ifdef WIN32
1906 ShowConsole( true );
1907 #endif
1909 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1910 psz_vlc_changeset );
1911 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1912 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1913 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1914 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1916 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1917 PauseConsole();
1918 #endif
1921 /*****************************************************************************
1922 * ShowConsole: On Win32, create an output console for debug messages
1923 *****************************************************************************
1924 * This function is useful only on Win32.
1925 *****************************************************************************/
1926 #ifdef WIN32 /* */
1927 static void ShowConsole( bool b_dofile )
1929 # ifndef UNDER_CE
1930 FILE *f_help = NULL;
1932 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1934 AllocConsole();
1935 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1936 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1937 * page (e.g. CP437 or CP850). */
1938 SetConsoleOutputCP (GetACP ());
1939 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1941 freopen( "CONOUT$", "w", stderr );
1942 freopen( "CONIN$", "r", stdin );
1944 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1946 fclose( f_help );
1947 freopen( "vlc-help.txt", "wt", stdout );
1948 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1950 else freopen( "CONOUT$", "w", stdout );
1952 # endif
1954 #endif
1956 /*****************************************************************************
1957 * PauseConsole: On Win32, wait for a key press before closing the console
1958 *****************************************************************************
1959 * This function is useful only on Win32.
1960 *****************************************************************************/
1961 #ifdef WIN32 /* */
1962 static void PauseConsole( void )
1964 # ifndef UNDER_CE
1966 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1968 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1969 getchar();
1970 fclose( stdout );
1972 # endif
1974 #endif
1976 /*****************************************************************************
1977 * ConsoleWidth: Return the console width in characters
1978 *****************************************************************************
1979 * We use the stty shell command to get the console width; if this fails or
1980 * if the width is less than 80, we default to 80.
1981 *****************************************************************************/
1982 static int ConsoleWidth( void )
1984 unsigned i_width = 80;
1986 #ifndef WIN32
1987 FILE *file = popen( "stty size 2>/dev/null", "r" );
1988 if (file != NULL)
1990 if (fscanf (file, "%*u %u", &i_width) <= 0)
1991 i_width = 80;
1992 pclose( file );
1994 #elif !defined (UNDER_CE)
1995 CONSOLE_SCREEN_BUFFER_INFO buf;
1997 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1998 i_width = buf.dwSize.X;
1999 #endif
2001 return i_width;
2004 #include <vlc_avcodec.h>
2006 void vlc_avcodec_mutex (bool acquire)
2008 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2010 if (acquire)
2011 vlc_mutex_lock (&lock);
2012 else
2013 vlc_mutex_unlock (&lock);