mouseReleaseEvent was not correctly dispatched under certain circumstance
[vlc.git] / src / libvlc.c
blob2523f8dd979f2034a2fe78b80dbad4a1551ce319
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"
45 #include "interface/interface.h"
47 #include <errno.h> /* ENOMEM */
48 #include <stdio.h> /* sprintf() */
49 #include <string.h>
50 #include <stdlib.h> /* free() */
52 #ifndef WIN32
53 # include <netinet/in.h> /* BSD: struct in_addr */
54 #endif
56 #ifdef HAVE_UNISTD_H
57 # include <unistd.h>
58 #elif defined( WIN32 ) && !defined( UNDER_CE )
59 # include <io.h>
60 #endif
62 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
63 # include "extras/getopt.h"
64 #endif
66 #ifdef HAVE_LOCALE_H
67 # include <locale.h>
68 #endif
70 #ifdef HAVE_DBUS
71 /* used for one-instance mode */
72 # include <dbus/dbus.h>
73 #endif
75 #ifdef HAVE_HAL
76 # include <hal/libhal.h>
77 #endif
79 #include <vlc_playlist.h>
80 #include <vlc_interface.h>
82 #include <vlc_aout.h>
83 #include "audio_output/aout_internal.h"
85 #include <vlc_vout.h>
86 #include <vlc_sout.h>
87 #include <vlc_charset.h>
89 #include "libvlc.h"
91 #include "playlist/playlist_internal.h"
93 #include <vlc_vlm.h>
95 #ifdef __APPLE__
96 # include <libkern/OSAtomic.h>
97 #endif
99 #include <assert.h>
101 /*****************************************************************************
102 * The evil global variables. We handle them with care, don't worry.
103 *****************************************************************************/
104 static libvlc_int_t * p_static_vlc = NULL;
105 static unsigned i_instances = 0;
107 #ifndef WIN32
108 static bool b_daemon = false;
109 #endif
111 #undef vlc_gc_init
112 #undef vlc_hold
113 #undef vlc_release
116 * Atomically set the reference count to 1.
117 * @param p_gc reference counted object
118 * @param pf_destruct destruction calback
119 * @return p_gc.
121 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
123 /* There is no point in using the GC if there is no destructor... */
124 assert (pf_destruct);
125 p_gc->pf_destructor = pf_destruct;
127 p_gc->refs = 1;
128 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
129 __sync_synchronize ();
130 #elif defined (WIN32) && defined (__GNUC__)
131 #elif defined(__APPLE__)
132 OSMemoryBarrier ();
133 #else
134 /* Nobody else can possibly lock the spin - it's there as a barrier */
135 vlc_spin_init (&p_gc->spin);
136 vlc_spin_lock (&p_gc->spin);
137 vlc_spin_unlock (&p_gc->spin);
138 #endif
139 return p_gc;
143 * Atomically increment the reference count.
144 * @param p_gc reference counted object
145 * @return p_gc.
147 void *vlc_hold (gc_object_t * p_gc)
149 uintptr_t refs;
150 assert( p_gc );
152 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
153 refs = __sync_add_and_fetch (&p_gc->refs, 1);
154 #elif defined (WIN32) && defined (__GNUC__)
155 refs = __builtin_choose_expr (sizeof (uintptr_t) == 4,
156 InterlockedIncrement (&p_gc->refs),
157 InterlockedIncrement64 (&p_gc->refs));
158 #elif defined(__APPLE__)
159 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
160 #else
161 vlc_spin_lock (&p_gc->spin);
162 refs = ++p_gc->refs;
163 vlc_spin_unlock (&p_gc->spin);
164 #endif
165 assert (refs != 1); /* there had to be a reference already */
166 return p_gc;
170 * Atomically decrement the reference count and, if it reaches zero, destroy.
171 * @param p_gc reference counted object.
173 void vlc_release (gc_object_t *p_gc)
175 unsigned refs;
177 assert( p_gc );
179 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
180 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
181 #elif defined (WIN32) && defined (__GNUC__)
182 refs = __builtin_choose_expr (sizeof (uintptr_t) == 4,
183 InterlockedDecrement (&p_gc->refs),
184 InterlockedDecrement64 (&p_gc->refs));
185 #elif defined(__APPLE__)
186 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
187 #else
188 vlc_spin_lock (&p_gc->spin);
189 refs = --p_gc->refs;
190 vlc_spin_unlock (&p_gc->spin);
191 #endif
193 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
194 if (refs == 0)
196 #ifdef USE_SYNC
197 #elif defined (WIN32) && defined (__GNUC__)
198 #elif defined(__APPLE__)
199 #else
200 vlc_spin_destroy (&p_gc->spin);
201 #endif
202 p_gc->pf_destructor (p_gc);
206 /*****************************************************************************
207 * Local prototypes
208 *****************************************************************************/
209 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
210 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
211 static void SetLanguage ( char const * );
212 #endif
213 static inline int LoadMessages (void);
214 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
215 static void Help ( libvlc_int_t *, char const *psz_help_name );
216 static void Usage ( libvlc_int_t *, char const *psz_search );
217 static void ListModules ( libvlc_int_t *, bool );
218 static void Version ( void );
220 #ifdef WIN32
221 static void ShowConsole ( bool );
222 static void PauseConsole ( void );
223 #endif
224 static int ConsoleWidth ( void );
226 static int VerboseCallback( vlc_object_t *, char const *,
227 vlc_value_t, vlc_value_t, void * );
229 static void InitDeviceValues( libvlc_int_t * );
231 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
234 * Allocate a libvlc instance, initialize global data if needed
235 * It also initializes the threading system
237 libvlc_int_t * libvlc_InternalCreate( void )
239 libvlc_int_t *p_libvlc;
240 libvlc_priv_t *priv;
241 char *psz_env = NULL;
243 /* Now that the thread system is initialized, we don't have much, but
244 * at least we have variables */
245 vlc_mutex_lock( &global_lock );
246 if( i_instances == 0 )
248 /* Guess what CPU we have */
249 cpu_flags = CPUCapabilities();
250 /* The module bank will be initialized later */
253 /* Allocate a libvlc instance object */
254 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
255 VLC_OBJECT_GENERIC, "libvlc" );
256 if( p_libvlc != NULL )
257 i_instances++;
258 vlc_mutex_unlock( &global_lock );
260 if( p_libvlc == NULL )
261 return NULL;
263 priv = libvlc_priv (p_libvlc);
264 priv->p_playlist = NULL;
265 priv->p_interaction = NULL;
266 priv->p_vlm = NULL;
267 p_libvlc->psz_object_name = strdup( "libvlc" );
269 /* Initialize message queue */
270 msg_Create( p_libvlc );
272 /* Find verbosity from VLC_VERBOSE environment variable */
273 psz_env = getenv( "VLC_VERBOSE" );
274 if( psz_env != NULL )
275 priv->i_verbose = atoi( psz_env );
276 else
277 priv->i_verbose = 3;
278 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
279 priv->b_color = isatty( 2 ); /* 2 is for stderr */
280 #else
281 priv->b_color = false;
282 #endif
284 /* Announce who we are - Do it only for first instance ? */
285 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
286 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
288 /* Initialize mutexes */
289 vlc_mutex_init( &priv->timer_lock );
290 vlc_mutex_init( &priv->config_lock );
292 /* Store data for the non-reentrant API */
293 p_static_vlc = p_libvlc;
295 return p_libvlc;
299 * Initialize a libvlc instance
300 * This function initializes a previously allocated libvlc instance:
301 * - CPU detection
302 * - gettext initialization
303 * - message queue, module bank and playlist initialization
304 * - configuration and commandline parsing
306 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
307 const char *ppsz_argv[] )
309 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
310 char p_capabilities[200];
311 char * p_tmp = NULL;
312 char * psz_modules = NULL;
313 char * psz_parser = NULL;
314 char * psz_control = NULL;
315 bool b_exit = false;
316 int i_ret = VLC_EEXIT;
317 playlist_t *p_playlist = NULL;
318 vlc_value_t val;
319 #if defined( ENABLE_NLS ) \
320 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
321 # if defined (WIN32) || defined (__APPLE__)
322 char * psz_language;
323 #endif
324 #endif
326 /* System specific initialization code */
327 system_Init( p_libvlc, &i_argc, ppsz_argv );
330 * Support for gettext
332 LoadMessages ();
334 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
335 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
337 /* Initialize the module bank and load the configuration of the
338 * main module. We need to do this at this stage to be able to display
339 * a short help if required by the user. (short help == main module
340 * options) */
341 module_InitBank( p_libvlc );
343 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
345 module_EndBank( p_libvlc );
346 return VLC_EGENERIC;
349 /* Check for short help option */
350 if( config_GetInt( p_libvlc, "help" ) > 0 )
352 Help( p_libvlc, "help" );
353 b_exit = true;
354 i_ret = VLC_EEXITSUCCESS;
356 /* Check for version option */
357 else if( config_GetInt( p_libvlc, "version" ) > 0 )
359 Version();
360 b_exit = true;
361 i_ret = VLC_EEXITSUCCESS;
364 /* Set the config file stuff */
365 priv->psz_configfile = config_GetCustomConfigFile( p_libvlc );
367 /* Check for plugins cache options */
368 bool b_cache_delete = config_GetInt( p_libvlc, "reset-plugins-cache" ) > 0;
370 /* Will be re-done properly later on */
371 priv->i_verbose = config_GetInt( p_libvlc, "verbose" );
373 /* Check for daemon mode */
374 #ifndef WIN32
375 if( config_GetInt( p_libvlc, "daemon" ) > 0 )
377 #ifdef HAVE_DAEMON
378 char *psz_pidfile = NULL;
380 if( daemon( 1, 0) != 0 )
382 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
383 b_exit = true;
385 b_daemon = true;
387 /* lets check if we need to write the pidfile */
388 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
389 if( psz_pidfile != NULL )
391 FILE *pidfile;
392 pid_t i_pid = getpid ();
393 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
394 i_pid, psz_pidfile );
395 pidfile = utf8_fopen( psz_pidfile,"w" );
396 if( pidfile != NULL )
398 utf8_fprintf( pidfile, "%d", (int)i_pid );
399 fclose( pidfile );
401 else
403 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
404 psz_pidfile );
407 free( psz_pidfile );
409 #else
410 pid_t i_pid;
412 if( ( i_pid = fork() ) < 0 )
414 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
415 b_exit = true;
417 else if( i_pid )
419 /* This is the parent, exit right now */
420 msg_Dbg( p_libvlc, "closing parent process" );
421 b_exit = true;
422 i_ret = VLC_EEXITSUCCESS;
424 else
426 /* We are the child */
427 msg_Dbg( p_libvlc, "daemon spawned" );
428 close( STDIN_FILENO );
429 close( STDOUT_FILENO );
430 close( STDERR_FILENO );
432 b_daemon = true;
434 #endif
436 #endif
438 if( b_exit )
440 module_EndBank( p_libvlc );
441 return i_ret;
444 /* Check for translation config option */
445 #if defined( ENABLE_NLS ) \
446 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
447 # if defined (WIN32) || defined (__APPLE__)
448 /* This ain't really nice to have to reload the config here but it seems
449 * the only way to do it. */
451 if( !config_GetInt( p_libvlc, "ignore-config" ) )
452 config_LoadConfigFile( p_libvlc, "main" );
453 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
455 /* Check if the user specified a custom language */
456 psz_language = config_GetPsz( p_libvlc, "language" );
457 if( psz_language && *psz_language && strcmp( psz_language, "auto" ) )
459 /* Reset the default domain */
460 SetLanguage( psz_language );
462 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
463 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
465 module_EndBank( p_libvlc );
466 module_InitBank( p_libvlc );
467 if( !config_GetInt( p_libvlc, "ignore-config" ) )
468 config_LoadConfigFile( p_libvlc, "main" );
469 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
471 free( psz_language );
472 # endif
473 #endif
476 * Load the builtins and plugins into the module_bank.
477 * We have to do it before config_Load*() because this also gets the
478 * list of configuration options exported by each module and loads their
479 * default values.
481 module_LoadBuiltins( p_libvlc );
482 module_LoadPlugins( p_libvlc, b_cache_delete );
483 if( p_libvlc->b_die )
485 b_exit = true;
488 size_t module_count;
489 module_t **list = module_list_get( &module_count );
490 module_list_free( list );
491 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
493 /* Check for help on modules */
494 if( (p_tmp = config_GetPsz( p_libvlc, "module" )) )
496 Help( p_libvlc, p_tmp );
497 free( p_tmp );
498 b_exit = true;
499 i_ret = VLC_EEXITSUCCESS;
501 /* Check for full help option */
502 else if( config_GetInt( p_libvlc, "full-help" ) > 0 )
504 config_PutInt( p_libvlc, "advanced", 1);
505 config_PutInt( p_libvlc, "help-verbose", 1);
506 Help( p_libvlc, "full-help" );
507 b_exit = true;
508 i_ret = VLC_EEXITSUCCESS;
510 /* Check for long help option */
511 else if( config_GetInt( p_libvlc, "longhelp" ) > 0 )
513 Help( p_libvlc, "longhelp" );
514 b_exit = true;
515 i_ret = VLC_EEXITSUCCESS;
517 /* Check for module list option */
518 else if( config_GetInt( p_libvlc, "list" ) > 0 )
520 ListModules( p_libvlc, false );
521 b_exit = true;
522 i_ret = VLC_EEXITSUCCESS;
524 else if( config_GetInt( p_libvlc, "list-verbose" ) > 0 )
526 ListModules( p_libvlc, true );
527 b_exit = true;
528 i_ret = VLC_EEXITSUCCESS;
531 /* Check for config file options */
532 if( !config_GetInt( p_libvlc, "ignore-config" ) )
534 if( config_GetInt( p_libvlc, "reset-config" ) > 0 )
536 config_ResetAll( p_libvlc );
537 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
538 config_SaveConfigFile( p_libvlc, NULL );
540 if( config_GetInt( p_libvlc, "save-config" ) > 0 )
542 config_LoadConfigFile( p_libvlc, NULL );
543 config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true );
544 config_SaveConfigFile( p_libvlc, NULL );
548 if( b_exit )
550 module_EndBank( p_libvlc );
551 return i_ret;
555 * Init device values
557 InitDeviceValues( p_libvlc );
560 * Override default configuration with config file settings
562 if( !config_GetInt( p_libvlc, "ignore-config" ) )
563 config_LoadConfigFile( p_libvlc, NULL );
566 * Override configuration with command line settings
568 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
570 #ifdef WIN32
571 ShowConsole( false );
572 /* Pause the console because it's destroyed when we exit */
573 fprintf( stderr, "The command line options couldn't be loaded, check "
574 "that they are valid.\n" );
575 PauseConsole();
576 #endif
577 module_EndBank( p_libvlc );
578 return VLC_EGENERIC;
582 * System specific configuration
584 system_Configure( p_libvlc, &i_argc, ppsz_argv );
586 /* FIXME: could be replaced by using Unix sockets */
587 #ifdef HAVE_DBUS
588 dbus_threads_init_default();
590 if( config_GetInt( p_libvlc, "one-instance" ) > 0
591 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
592 && config_GetInt( p_libvlc, "started-from-file" ) ) )
594 /* Initialise D-Bus interface, check for other instances */
595 DBusConnection *p_conn = NULL;
596 DBusError dbus_error;
598 dbus_error_init( &dbus_error );
600 /* connect to the session bus */
601 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
602 if( !p_conn )
604 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
605 dbus_error.message );
606 dbus_error_free( &dbus_error );
608 else
610 /* check if VLC is available on the bus
611 * if not: D-Bus control is not enabled on the other
612 * instance and we can't pass MRLs to it */
613 DBusMessage *p_test_msg = NULL;
614 DBusMessage *p_test_reply = NULL;
615 p_test_msg = dbus_message_new_method_call(
616 "org.mpris.vlc", "/",
617 "org.freedesktop.MediaPlayer", "Identity" );
618 /* block until a reply arrives */
619 p_test_reply = dbus_connection_send_with_reply_and_block(
620 p_conn, p_test_msg, -1, &dbus_error );
621 dbus_message_unref( p_test_msg );
622 if( p_test_reply == NULL )
624 dbus_error_free( &dbus_error );
625 msg_Dbg( p_libvlc, "No Media Player is running. "
626 "Continuing normally." );
628 else
630 int i_input;
631 DBusMessage* p_dbus_msg = NULL;
632 DBusMessageIter dbus_args;
633 DBusPendingCall* p_dbus_pending = NULL;
634 dbus_bool_t b_play;
636 dbus_message_unref( p_test_reply );
637 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
639 for( i_input = optind;i_input < i_argc;i_input++ )
641 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
642 ppsz_argv[i_input] );
644 p_dbus_msg = dbus_message_new_method_call(
645 "org.mpris.vlc", "/TrackList",
646 "org.freedesktop.MediaPlayer", "AddTrack" );
648 if ( NULL == p_dbus_msg )
650 msg_Err( p_libvlc, "D-Bus problem" );
651 system_End( p_libvlc );
652 exit( VLC_ETIMEOUT );
655 /* append MRLs */
656 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
657 if ( !dbus_message_iter_append_basic( &dbus_args,
658 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
660 dbus_message_unref( p_dbus_msg );
661 system_End( p_libvlc );
662 exit( VLC_ENOMEM );
664 b_play = TRUE;
665 if( config_GetInt( p_libvlc, "playlist-enqueue" ) > 0 )
666 b_play = FALSE;
667 if ( !dbus_message_iter_append_basic( &dbus_args,
668 DBUS_TYPE_BOOLEAN, &b_play ) )
670 dbus_message_unref( p_dbus_msg );
671 system_End( p_libvlc );
672 exit( VLC_ENOMEM );
675 /* send message and get a handle for a reply */
676 if ( !dbus_connection_send_with_reply ( p_conn,
677 p_dbus_msg, &p_dbus_pending, -1 ) )
679 msg_Err( p_libvlc, "D-Bus problem" );
680 dbus_message_unref( p_dbus_msg );
681 system_End( p_libvlc );
682 exit( VLC_ETIMEOUT );
685 if ( NULL == p_dbus_pending )
687 msg_Err( p_libvlc, "D-Bus problem" );
688 dbus_message_unref( p_dbus_msg );
689 system_End( p_libvlc );
690 exit( VLC_ETIMEOUT );
692 dbus_connection_flush( p_conn );
693 dbus_message_unref( p_dbus_msg );
694 /* block until we receive a reply */
695 dbus_pending_call_block( p_dbus_pending );
696 dbus_pending_call_unref( p_dbus_pending );
697 } /* processes all command line MRLs */
699 /* bye bye */
700 system_End( p_libvlc );
701 exit( VLC_SUCCESS );
704 /* we unreference the connection when we've finished with it */
705 if( p_conn ) dbus_connection_unref( p_conn );
707 #endif
710 * Message queue options
712 char * psz_verbose_objects = config_GetPsz( p_libvlc, "verbose-objects" );
713 if( psz_verbose_objects )
715 char * psz_object, * iter = psz_verbose_objects;
716 while( (psz_object = strsep( &iter, "," )) )
718 switch( psz_object[0] )
720 printf("%s\n", psz_object+1);
721 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
722 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
723 default:
724 msg_Err( p_libvlc, "verbose-objects usage: \n"
725 "--verbose-objects=+printthatobject,"
726 "-dontprintthatone\n"
727 "(keyword 'all' to applies to all objects)\n");
728 free( psz_verbose_objects );
729 return VLC_EGENERIC;
732 free( psz_verbose_objects );
735 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
736 if( config_GetInt( p_libvlc, "quiet" ) > 0 )
738 val.i_int = -1;
739 var_Set( p_libvlc, "verbose", val );
741 var_AddCallback( p_libvlc, "verbose", VerboseCallback, NULL );
742 var_Change( p_libvlc, "verbose", VLC_VAR_TRIGGER_CALLBACKS, NULL, NULL );
744 if( priv->b_color )
745 priv->b_color = config_GetInt( p_libvlc, "color" ) > 0;
747 if( !config_GetInt( p_libvlc, "fpu" ) )
748 cpu_flags &= ~CPU_CAPABILITY_FPU;
750 #if defined( __i386__ ) || defined( __x86_64__ )
751 if( !config_GetInt( p_libvlc, "mmx" ) )
752 cpu_flags &= ~CPU_CAPABILITY_MMX;
753 if( !config_GetInt( p_libvlc, "3dn" ) )
754 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
755 if( !config_GetInt( p_libvlc, "mmxext" ) )
756 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
757 if( !config_GetInt( p_libvlc, "sse" ) )
758 cpu_flags &= ~CPU_CAPABILITY_SSE;
759 if( !config_GetInt( p_libvlc, "sse2" ) )
760 cpu_flags &= ~CPU_CAPABILITY_SSE2;
761 #endif
762 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
763 if( !config_GetInt( p_libvlc, "altivec" ) )
764 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
765 #endif
767 #define PRINT_CAPABILITY( capability, string ) \
768 if( vlc_CPU() & capability ) \
770 strncat( p_capabilities, string " ", \
771 sizeof(p_capabilities) - strlen(p_capabilities) ); \
772 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
775 p_capabilities[0] = '\0';
776 PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
777 PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
778 PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
779 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
780 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
781 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
782 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
783 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
784 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
785 PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
786 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
789 * Choose the best memcpy module
791 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", 0 );
793 priv->b_stats = config_GetInt( p_libvlc, "stats" ) > 0;
794 priv->i_timers = 0;
795 priv->pp_timers = NULL;
797 /* Init stats */
798 p_libvlc->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
799 if( !p_libvlc->p_stats )
801 vlc_object_release( p_libvlc );
802 return VLC_ENOMEM;
804 vlc_mutex_init( &p_libvlc->p_stats->lock );
805 priv->p_stats_computer = NULL;
807 priv->i_last_input_id = 0; /* Not very safe, should be removed */
810 * Initialize hotkey handling
812 var_Create( p_libvlc, "key-pressed", VLC_VAR_INTEGER );
813 var_Create( p_libvlc, "key-action", VLC_VAR_INTEGER );
814 p_libvlc->p_hotkeys = malloc( libvlc_hotkeys_size );
815 /* Do a copy (we don't need to modify the strings) */
816 memcpy( p_libvlc->p_hotkeys, libvlc_hotkeys, libvlc_hotkeys_size );
817 var_AddCallback( p_libvlc, "key-pressed", vlc_key_to_action,
818 p_libvlc->p_hotkeys );
820 /* Initialize interaction */
821 priv->p_interaction = interaction_Init( p_libvlc );
823 /* Initialize playlist and get commandline files */
824 playlist_ThreadCreate( p_libvlc );
825 if( !priv->p_playlist )
827 msg_Err( p_libvlc, "playlist initialization failed" );
828 if( priv->p_memcpy_module != NULL )
830 module_unneed( p_libvlc, priv->p_memcpy_module );
832 module_EndBank( p_libvlc );
833 return VLC_EGENERIC;
835 p_playlist = priv->p_playlist;
837 psz_modules = config_GetPsz( p_playlist, "services-discovery" );
838 if( psz_modules && *psz_modules )
840 /* Add service discovery modules */
841 playlist_ServicesDiscoveryAdd( p_playlist, psz_modules );
843 free( psz_modules );
845 #ifdef ENABLE_VLM
846 /* Initialize VLM if vlm-conf is specified */
847 psz_parser = config_GetPsz( p_libvlc, "vlm-conf" );
848 if( psz_parser && *psz_parser )
850 priv->p_vlm = vlm_New( p_libvlc );
851 if( !priv->p_vlm )
852 msg_Err( p_libvlc, "VLM initialization failed" );
854 free( psz_parser );
855 #endif
858 * Load background interfaces
860 psz_modules = config_GetPsz( p_libvlc, "extraintf" );
861 psz_control = config_GetPsz( p_libvlc, "control" );
863 if( psz_modules && *psz_modules && psz_control && *psz_control )
865 psz_modules = (char *)realloc( psz_modules, strlen( psz_modules ) +
866 strlen( psz_control ) + 1 );
867 sprintf( psz_modules, "%s:%s", psz_modules, psz_control );
869 else if( psz_control && *psz_control )
871 free( psz_modules );
872 psz_modules = strdup( psz_control );
875 psz_parser = psz_modules;
876 while ( psz_parser && *psz_parser )
878 char *psz_module, *psz_temp;
879 psz_module = psz_parser;
880 psz_parser = strchr( psz_module, ':' );
881 if ( psz_parser )
883 *psz_parser = '\0';
884 psz_parser++;
886 psz_temp = (char *)malloc( strlen(psz_module) + sizeof(",none") );
887 if( psz_temp )
889 sprintf( psz_temp, "%s,none", psz_module );
890 libvlc_InternalAddIntf( p_libvlc, psz_temp );
891 free( psz_temp );
894 free( psz_modules );
895 free( psz_control );
898 * Always load the hotkeys interface if it exists
900 libvlc_InternalAddIntf( p_libvlc, "hotkeys,none" );
902 #ifdef HAVE_DBUS
903 /* loads dbus control interface if in one-instance mode
904 * we do it only when playlist exists, because dbus module needs it */
905 if( config_GetInt( p_libvlc, "one-instance" ) > 0
906 || ( config_GetInt( p_libvlc, "one-instance-when-started-from-file" )
907 && config_GetInt( p_libvlc, "started-from-file" ) ) )
908 libvlc_InternalAddIntf( p_libvlc, "dbus,none" );
910 /* Prevents the power management daemon from suspending the system
911 * when VLC is active */
912 if( config_GetInt( p_libvlc, "inhibit" ) > 0 )
913 libvlc_InternalAddIntf( p_libvlc, "inhibit,none" );
914 #endif
917 * If needed, load the Xscreensaver interface
918 * Currently, only for X
920 #ifdef HAVE_X11_XLIB_H
921 if( config_GetInt( p_libvlc, "disable-screensaver" ) )
923 libvlc_InternalAddIntf( p_libvlc, "screensaver,none" );
925 #endif
927 if( (config_GetInt( p_libvlc, "file-logging" ) > 0) &&
928 !config_GetInt( p_libvlc, "syslog" ) )
930 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
932 #ifdef HAVE_SYSLOG_H
933 if( config_GetInt( p_libvlc, "syslog" ) > 0 )
935 char *logmode = var_CreateGetString( p_libvlc, "logmode" );
936 var_SetString( p_libvlc, "logmode", "syslog" );
937 libvlc_InternalAddIntf( p_libvlc, "logger,none" );
939 if( logmode )
941 var_SetString( p_libvlc, "logmode", logmode );
942 free( logmode );
944 else
945 var_Destroy( p_libvlc, "logmode" );
947 #endif
949 if( config_GetInt( p_libvlc, "show-intf" ) > 0 )
951 libvlc_InternalAddIntf( p_libvlc, "showintf,none" );
954 if( config_GetInt( p_libvlc, "network-synchronisation") > 0 )
956 libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
959 #ifdef WIN32
960 if( config_GetInt( p_libvlc, "prefer-system-codecs") > 0 )
962 char *psz_codecs = config_GetPsz( p_playlist, "codec" );
963 if( psz_codecs )
965 char *psz_morecodecs;
966 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
968 config_PutPsz( p_libvlc, "codec", psz_morecodecs);
969 free( psz_morecodecs );
972 else
973 config_PutPsz( p_libvlc, "codec", "dmo,quicktime");
974 free( psz_codecs );
976 #endif
979 * FIXME: kludge to use a p_libvlc-local variable for the Mozilla plugin
981 var_Create( p_libvlc, "drawable", VLC_VAR_INTEGER );
982 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
983 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
984 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
985 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
986 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
987 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
988 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
989 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
991 /* Create volume callback system. */
992 var_Create( p_libvlc, "volume-change", VLC_VAR_BOOL );
994 /* Create a variable for showing the interface (moved from playlist). */
995 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
996 var_SetBool( p_libvlc, "intf-show", true );
998 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
1001 * Get input filenames given as commandline arguments
1003 GetFilenames( p_libvlc, i_argc, ppsz_argv );
1006 * Get --open argument
1008 var_Create( p_libvlc, "open", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
1009 var_Get( p_libvlc, "open", &val );
1010 if ( val.psz_string != NULL && *val.psz_string )
1012 playlist_t *p_playlist = pl_Hold( p_libvlc );
1013 playlist_AddExt( p_playlist, val.psz_string, NULL, PLAYLIST_INSERT, 0,
1014 -1, NULL, 0, true, pl_Unlocked );
1015 pl_Release( p_libvlc );
1017 free( val.psz_string );
1019 return VLC_SUCCESS;
1023 * Cleanup a libvlc instance. The instance is not completely deallocated
1024 * \param p_libvlc the instance to clean
1026 int libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
1028 intf_thread_t * p_intf = NULL;
1029 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1031 /* Ask the interfaces to stop and destroy them */
1032 msg_Dbg( p_libvlc, "removing all interfaces" );
1033 while( (p_intf = vlc_object_find( p_libvlc, VLC_OBJECT_INTF, FIND_CHILD )) )
1035 intf_StopThread( p_intf );
1036 vlc_object_detach( p_intf );
1037 vlc_object_release( p_intf ); /* for intf_Create() */
1038 vlc_object_release( p_intf ); /* for vlc_object_find() */
1041 #ifdef ENABLE_VLM
1042 /* Destroy VLM if created in libvlc_InternalInit */
1043 if( priv->p_vlm )
1045 vlm_Delete( priv->p_vlm );
1047 #endif
1049 playlist_t *p_playlist = priv->p_playlist;
1050 /* Remove all services discovery */
1051 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
1052 playlist_ServicesDiscoveryKillAll( p_playlist );
1054 /* Free playlist */
1055 /* Any thread still running must not assume pl_Hold() succeeds. */
1056 msg_Dbg( p_libvlc, "removing playlist" );
1057 priv->p_playlist = NULL;
1058 vlc_object_kill( p_playlist ); /* <-- memory barrier for pl_Hold() */
1059 vlc_thread_join( p_playlist );
1060 vlc_object_release( p_playlist );
1062 /* Free interaction */
1063 msg_Dbg( p_libvlc, "removing interaction" );
1064 interaction_Destroy( priv->p_interaction );
1066 /* Free video outputs */
1067 msg_Dbg( p_libvlc, "removing all video outputs" );
1068 vlc_list_t *list = vlc_list_find (p_libvlc, VLC_OBJECT_VOUT, FIND_CHILD);
1069 for (int i = 0; i < list->i_count; i++)
1070 vlc_object_release (list->p_values[i].p_object);
1071 vlc_list_release (list);
1073 stats_TimersDumpAll( p_libvlc );
1074 stats_TimersCleanAll( p_libvlc );
1076 msg_Dbg( p_libvlc, "removing stats" );
1077 vlc_mutex_destroy( &p_libvlc->p_stats->lock );
1078 FREENULL( p_libvlc->p_stats );
1080 return VLC_SUCCESS;
1084 * Destroy everything.
1085 * This function requests the running threads to finish, waits for their
1086 * termination, and destroys their structure.
1087 * It stops the thread systems: no instance can run after this has run
1088 * \param p_libvlc the instance to destroy
1090 int libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1092 if( !p_libvlc )
1093 return VLC_EGENERIC;
1095 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
1097 #ifndef WIN32
1098 char* psz_pidfile = NULL;
1100 if( b_daemon )
1102 psz_pidfile = config_GetPsz( p_libvlc, "pidfile" );
1103 if( psz_pidfile != NULL )
1105 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1106 if( unlink( psz_pidfile ) == -1 )
1108 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1109 psz_pidfile );
1112 free( psz_pidfile );
1114 #endif
1116 if( priv->p_memcpy_module )
1118 module_unneed( p_libvlc, priv->p_memcpy_module );
1119 priv->p_memcpy_module = NULL;
1122 /* Free module bank. It is refcounted, so we call this each time */
1123 module_EndBank( p_libvlc );
1125 FREENULL( priv->psz_configfile );
1126 var_DelCallback( p_libvlc, "key-pressed", vlc_key_to_action,
1127 p_libvlc->p_hotkeys );
1128 FREENULL( p_libvlc->p_hotkeys );
1130 vlc_mutex_lock( &global_lock );
1131 i_instances--;
1133 if( i_instances == 0 )
1135 /* System specific cleaning code */
1136 system_End( p_libvlc );
1138 vlc_mutex_unlock( &global_lock );
1140 msg_Destroy( p_libvlc );
1142 /* Destroy mutexes */
1143 vlc_mutex_destroy( &priv->config_lock );
1144 vlc_mutex_destroy( &priv->timer_lock );
1146 vlc_object_release( p_libvlc );
1147 p_libvlc = NULL;
1149 return VLC_SUCCESS;
1153 * Add an interface plugin and run it
1155 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1157 int i_err;
1158 intf_thread_t *p_intf = NULL;
1160 if( !p_libvlc )
1161 return VLC_EGENERIC;
1163 if( !psz_module ) /* requesting the default interface */
1165 char *psz_interface = config_GetPsz( p_libvlc, "intf" );
1166 if( !psz_interface || !*psz_interface ) /* "intf" has not been set */
1168 #ifndef WIN32
1169 if( b_daemon )
1170 /* Daemon mode hack.
1171 * We prefer the dummy interface if none is specified. */
1172 psz_module = "dummy";
1173 else
1174 #endif
1175 msg_Info( p_libvlc, _("Running vlc with the default interface. Use 'cvlc' to use vlc without interface.") );
1177 free( psz_interface );
1180 /* Try to create the interface */
1181 p_intf = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1182 if( p_intf == NULL )
1184 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1185 psz_module );
1186 return VLC_EGENERIC;
1189 /* Try to run the interface */
1190 i_err = intf_RunThread( p_intf );
1191 if( i_err )
1193 vlc_object_detach( p_intf );
1194 vlc_object_release( p_intf );
1195 return i_err;
1198 return VLC_SUCCESS;
1201 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1202 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1203 /*****************************************************************************
1204 * SetLanguage: set the interface language.
1205 *****************************************************************************
1206 * We set the LC_MESSAGES locale category for interface messages and buttons,
1207 * as well as the LC_CTYPE category for string sorting and possible wide
1208 * character support.
1209 *****************************************************************************/
1210 static void SetLanguage ( const char *psz_lang )
1212 #ifdef __APPLE__
1213 /* I need that under Darwin, please check it doesn't disturb
1214 * other platforms. --Meuuh */
1215 setenv( "LANG", psz_lang, 1 );
1217 #else
1218 /* We set LC_ALL manually because it is the only way to set
1219 * the language at runtime under eg. Windows. Beware that this
1220 * makes the environment unconsistent when libvlc is unloaded and
1221 * should probably be moved to a safer place like vlc.c. */
1222 static char psz_lcall[20];
1223 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1224 psz_lcall[19] = '\0';
1225 putenv( psz_lcall );
1226 #endif
1228 setlocale( LC_ALL, psz_lang );
1230 #endif
1233 static inline int LoadMessages (void)
1235 #if defined( ENABLE_NLS ) \
1236 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1237 /* Specify where to find the locales for current domain */
1238 #if !defined( __APPLE__ ) && !defined( WIN32 ) && !defined( SYS_BEOS )
1239 static const char psz_path[] = LOCALEDIR;
1240 #else
1241 char psz_path[1024];
1242 if (snprintf (psz_path, sizeof (psz_path), "%s" DIR_SEP "%s",
1243 config_GetDataDir(), "locale")
1244 >= (int)sizeof (psz_path))
1245 return -1;
1247 #endif
1248 if (bindtextdomain (PACKAGE_NAME, psz_path) == NULL)
1250 fprintf (stderr, "Warning: cannot bind text domain "PACKAGE_NAME
1251 " to directory %s\n", psz_path);
1252 return -1;
1255 /* LibVLC wants all messages in UTF-8.
1256 * Unfortunately, we cannot ask UTF-8 for strerror_r(), strsignal_r()
1257 * and other functions that are not part of our text domain.
1259 if (bind_textdomain_codeset (PACKAGE_NAME, "UTF-8") == NULL)
1261 fprintf (stderr, "Error: cannot set Unicode encoding for text domain "
1262 PACKAGE_NAME"\n");
1263 // Unbinds the text domain to avoid broken encoding
1264 bindtextdomain (PACKAGE_NAME, "DOES_NOT_EXIST");
1265 return -1;
1268 /* LibVLC does NOT set the default textdomain, since it is a library.
1269 * This could otherwise break programs using LibVLC (other than VLC).
1270 * textdomain (PACKAGE_NAME);
1272 #endif
1273 return 0;
1276 /*****************************************************************************
1277 * GetFilenames: parse command line options which are not flags
1278 *****************************************************************************
1279 * Parse command line for input files as well as their associated options.
1280 * An option always follows its associated input and begins with a ":".
1281 *****************************************************************************/
1282 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1284 int i_opt, i_options;
1286 /* We assume that the remaining parameters are filenames
1287 * and their input options */
1288 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1290 i_options = 0;
1292 /* Count the input options */
1293 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1295 i_options++;
1296 i_opt--;
1299 /* TODO: write an internal function of this one, to avoid
1300 * unnecessary lookups. */
1302 playlist_t *p_playlist = pl_Hold( p_vlc );
1303 playlist_AddExt( p_playlist, ppsz_argv[i_opt], NULL, PLAYLIST_INSERT,
1304 0, -1, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1305 i_options, true, pl_Unlocked );
1306 pl_Release( p_vlc );
1309 return VLC_SUCCESS;
1312 /*****************************************************************************
1313 * Help: print program help
1314 *****************************************************************************
1315 * Print a short inline help. Message interface is initialized at this stage.
1316 *****************************************************************************/
1317 static inline void print_help_on_full_help( void )
1319 utf8_fprintf( stdout, "\n" );
1320 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1323 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1325 #ifdef WIN32
1326 ShowConsole( true );
1327 #endif
1329 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1331 utf8_fprintf( stdout, vlc_usage, "vlc" );
1332 Usage( p_this, "=help" );
1333 Usage( p_this, "=main" );
1334 print_help_on_full_help();
1336 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1338 utf8_fprintf( stdout, vlc_usage, "vlc" );
1339 Usage( p_this, NULL );
1340 print_help_on_full_help();
1342 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1344 utf8_fprintf( stdout, vlc_usage, "vlc" );
1345 Usage( p_this, NULL );
1347 else if( psz_help_name )
1349 Usage( p_this, psz_help_name );
1352 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1353 PauseConsole();
1354 #endif
1357 /*****************************************************************************
1358 * Usage: print module usage
1359 *****************************************************************************
1360 * Print a short inline help. Message interface is initialized at this stage.
1361 *****************************************************************************/
1362 # define COL(x) "\033[" #x ";1m"
1363 # define RED COL(31)
1364 # define GREEN COL(32)
1365 # define YELLOW COL(33)
1366 # define BLUE COL(34)
1367 # define MAGENTA COL(35)
1368 # define CYAN COL(36)
1369 # define WHITE COL(0)
1370 # define GRAY "\033[0m"
1371 static void print_help_section( module_config_t *p_item, bool b_color, bool b_description )
1373 if( !p_item ) return;
1374 if( b_color )
1376 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1377 p_item->psz_text );
1378 if( b_description && p_item->psz_longtext )
1379 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1380 p_item->psz_longtext );
1382 else
1384 utf8_fprintf( stdout, " %s:\n", p_item->psz_text );
1385 if( b_description && p_item->psz_longtext )
1386 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1390 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1392 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1393 /* short option ------' | | | | | | |
1394 * option name ------------' | | | | | |
1395 * <bra ---------------------' | | | | |
1396 * option type or "" ----------' | | | |
1397 * ket> -------------------------' | | |
1398 * padding spaces -----------------' | |
1399 * comment --------------------------' |
1400 * comment suffix ---------------------'
1402 * The purpose of having bra and ket is that we might i18n them as well.
1405 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1406 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1408 #define LINE_START 8
1409 #define PADDING_SPACES 25
1410 #ifdef WIN32
1411 # define OPTION_VALUE_SEP "="
1412 #else
1413 # define OPTION_VALUE_SEP " "
1414 #endif
1415 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1416 char psz_spaces_longtext[LINE_START+3];
1417 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1418 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1419 char psz_buffer[10000];
1420 char psz_short[4];
1421 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1422 int i_width_description = i_width + PADDING_SPACES - 1;
1423 bool b_advanced = config_GetInt( p_this, "advanced" ) > 0;
1424 bool b_description = config_GetInt( p_this, "help-verbose" ) > 0;
1425 bool b_description_hack;
1426 bool b_color = config_GetInt( p_this, "color" ) > 0;
1427 bool b_has_advanced = false;
1428 bool b_found = false;
1429 int i_only_advanced = 0; /* Number of modules ignored because they
1430 * only have advanced options */
1431 bool b_strict = psz_search && *psz_search == '=';
1432 if( b_strict ) psz_search++;
1434 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1435 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1436 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1437 psz_spaces_longtext[LINE_START+2] = '\0';
1438 #ifndef WIN32
1439 if( !isatty( 1 ) )
1440 #endif
1441 b_color = false; // don't put color control codes in a .txt file
1443 if( b_color )
1445 strcpy( psz_format, COLOR_FORMAT_STRING );
1446 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1448 else
1450 strcpy( psz_format, FORMAT_STRING );
1451 strcpy( psz_format_bool, FORMAT_STRING );
1454 /* List all modules */
1455 module_t **list = module_list_get (NULL);
1456 if (!list)
1457 return;
1459 /* Ugly hack to make sure that the help options always come first
1460 * (part 1) */
1461 if( !psz_search )
1462 Usage( p_this, "help" );
1464 /* Enumerate the config for each module */
1465 for (size_t i = 0; list[i]; i++)
1467 bool b_help_module;
1468 module_t *p_parser = list[i];
1469 module_config_t *p_item = NULL;
1470 module_config_t *p_section = NULL;
1471 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1473 if( psz_search &&
1474 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1475 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1477 char *const *pp_shortcut = p_parser->pp_shortcuts;
1478 while( *pp_shortcut )
1480 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1481 : !!strstr( *pp_shortcut, psz_search ) )
1482 break;
1483 pp_shortcut ++;
1485 if( !*pp_shortcut )
1486 continue;
1489 /* Ignore modules without config options */
1490 if( !p_parser->i_config_items )
1492 continue;
1495 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1496 /* Ugly hack to make sure that the help options always come first
1497 * (part 2) */
1498 if( !psz_search && b_help_module )
1499 continue;
1501 /* Ignore modules with only advanced config options if requested */
1502 if( !b_advanced )
1504 for( p_item = p_parser->p_config;
1505 p_item < p_end;
1506 p_item++ )
1508 if( (p_item->i_type & CONFIG_ITEM) &&
1509 !p_item->b_advanced && !p_item->b_removed ) break;
1512 if( p_item == p_end )
1514 i_only_advanced++;
1515 continue;
1519 b_found = true;
1521 /* Print name of module */
1522 if( strcmp( "main", p_parser->psz_object_name ) )
1524 if( b_color )
1525 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1526 p_parser->psz_longname,
1527 p_parser->psz_object_name );
1528 else
1529 utf8_fprintf( stdout, "\n %s\n", p_parser->psz_longname );
1531 if( p_parser->psz_help )
1533 if( b_color )
1534 utf8_fprintf( stdout, CYAN" %s\n"GRAY, p_parser->psz_help );
1535 else
1536 utf8_fprintf( stdout, " %s\n", p_parser->psz_help );
1539 /* Print module options */
1540 for( p_item = p_parser->p_config;
1541 p_item < p_end;
1542 p_item++ )
1544 char *psz_text, *psz_spaces = psz_spaces_text;
1545 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1546 const char *psz_suf = "", *psz_prefix = NULL;
1547 signed int i;
1548 size_t i_cur_width;
1550 /* Skip removed options */
1551 if( p_item->b_removed )
1553 continue;
1555 /* Skip advanced options if requested */
1556 if( p_item->b_advanced && !b_advanced )
1558 b_has_advanced = true;
1559 continue;
1562 switch( p_item->i_type )
1564 case CONFIG_HINT_CATEGORY:
1565 case CONFIG_HINT_USAGE:
1566 if( !strcmp( "main", p_parser->psz_object_name ) )
1568 if( b_color )
1569 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1570 p_item->psz_text );
1571 else
1572 utf8_fprintf( stdout, "\n %s\n", p_item->psz_text );
1574 if( b_description && p_item->psz_longtext )
1576 if( b_color )
1577 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1578 p_item->psz_longtext );
1579 else
1580 utf8_fprintf( stdout, " %s\n", p_item->psz_longtext );
1582 break;
1584 case CONFIG_HINT_SUBCATEGORY:
1585 if( strcmp( "main", p_parser->psz_object_name ) )
1586 break;
1587 case CONFIG_SECTION:
1588 p_section = p_item;
1589 break;
1591 case CONFIG_ITEM_STRING:
1592 case CONFIG_ITEM_FILE:
1593 case CONFIG_ITEM_DIRECTORY:
1594 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1595 case CONFIG_ITEM_MODULE_CAT:
1596 case CONFIG_ITEM_MODULE_LIST:
1597 case CONFIG_ITEM_MODULE_LIST_CAT:
1598 case CONFIG_ITEM_FONT:
1599 case CONFIG_ITEM_PASSWORD:
1600 print_help_section( p_section, b_color, b_description );
1601 p_section = NULL;
1602 psz_bra = OPTION_VALUE_SEP "<";
1603 psz_type = _("string");
1604 psz_ket = ">";
1606 if( p_item->ppsz_list )
1608 psz_bra = OPTION_VALUE_SEP "{";
1609 psz_type = psz_buffer;
1610 psz_buffer[0] = '\0';
1611 for( i = 0; p_item->ppsz_list[i]; i++ )
1613 if( i ) strcat( psz_buffer, "," );
1614 strcat( psz_buffer, p_item->ppsz_list[i] );
1616 psz_ket = "}";
1618 break;
1619 case CONFIG_ITEM_INTEGER:
1620 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1621 print_help_section( p_section, b_color, b_description );
1622 p_section = NULL;
1623 psz_bra = OPTION_VALUE_SEP "<";
1624 psz_type = _("integer");
1625 psz_ket = ">";
1627 if( p_item->min.i || p_item->max.i )
1629 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1630 p_item->min.i, p_item->max.i );
1631 psz_type = psz_buffer;
1634 if( p_item->i_list )
1636 psz_bra = OPTION_VALUE_SEP "{";
1637 psz_type = psz_buffer;
1638 psz_buffer[0] = '\0';
1639 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1641 if( i ) strcat( psz_buffer, ", " );
1642 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1643 p_item->pi_list[i],
1644 p_item->ppsz_list_text[i] );
1646 psz_ket = "}";
1648 break;
1649 case CONFIG_ITEM_FLOAT:
1650 print_help_section( p_section, b_color, b_description );
1651 p_section = NULL;
1652 psz_bra = OPTION_VALUE_SEP "<";
1653 psz_type = _("float");
1654 psz_ket = ">";
1655 if( p_item->min.f || p_item->max.f )
1657 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1658 p_item->min.f, p_item->max.f );
1659 psz_type = psz_buffer;
1661 break;
1662 case CONFIG_ITEM_BOOL:
1663 print_help_section( p_section, b_color, b_description );
1664 p_section = NULL;
1665 psz_bra = ""; psz_type = ""; psz_ket = "";
1666 if( !b_help_module )
1668 psz_suf = p_item->value.i ? _(" (default enabled)") :
1669 _(" (default disabled)");
1671 break;
1674 if( !psz_type )
1676 continue;
1679 /* Add short option if any */
1680 if( p_item->i_short )
1682 sprintf( psz_short, "-%c,", p_item->i_short );
1684 else
1686 strcpy( psz_short, " " );
1689 i = PADDING_SPACES - strlen( p_item->psz_name )
1690 - strlen( psz_bra ) - strlen( psz_type )
1691 - strlen( psz_ket ) - 1;
1693 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1695 psz_prefix = ", --no-";
1696 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1699 if( i < 0 )
1701 psz_spaces[0] = '\n';
1702 i = 0;
1704 else
1706 psz_spaces[i] = '\0';
1709 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1711 utf8_fprintf( stdout, psz_format_bool, psz_short,
1712 p_item->psz_name, psz_prefix, p_item->psz_name,
1713 psz_bra, psz_type, psz_ket, psz_spaces );
1715 else
1717 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1718 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1721 psz_spaces[i] = ' ';
1723 /* We wrap the rest of the output */
1724 sprintf( psz_buffer, "%s%s", p_item->psz_text, psz_suf );
1725 b_description_hack = b_description;
1727 description:
1728 psz_text = psz_buffer;
1729 i_cur_width = b_description && !b_description_hack
1730 ? i_width_description
1731 : i_width;
1732 while( *psz_text )
1734 char *psz_parser, *psz_word;
1735 size_t i_end = strlen( psz_text );
1737 /* If the remaining text fits in a line, print it. */
1738 if( i_end <= i_cur_width )
1740 if( b_color )
1742 if( !b_description || b_description_hack )
1743 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1744 else
1745 utf8_fprintf( stdout, "%s\n", psz_text );
1747 else
1749 utf8_fprintf( stdout, "%s\n", psz_text );
1751 break;
1754 /* Otherwise, eat as many words as possible */
1755 psz_parser = psz_text;
1758 psz_word = psz_parser;
1759 psz_parser = strchr( psz_word, ' ' );
1760 /* If no space was found, we reached the end of the text
1761 * block; otherwise, we skip the space we just found. */
1762 psz_parser = psz_parser ? psz_parser + 1
1763 : psz_text + i_end;
1765 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1767 /* We cut a word in one of these cases:
1768 * - it's the only word in the line and it's too long.
1769 * - we used less than 80% of the width and the word we are
1770 * going to wrap is longer than 40% of the width, and even
1771 * if the word would have fit in the next line. */
1772 if( psz_word == psz_text
1773 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1774 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1776 char c = psz_text[i_cur_width];
1777 psz_text[i_cur_width] = '\0';
1778 if( b_color )
1780 if( !b_description || b_description_hack )
1781 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1782 psz_text, psz_spaces );
1783 else
1784 utf8_fprintf( stdout, "%s\n%s",
1785 psz_text, psz_spaces );
1787 else
1789 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1791 psz_text += i_cur_width;
1792 psz_text[0] = c;
1794 else
1796 psz_word[-1] = '\0';
1797 if( b_color )
1799 if( !b_description || b_description_hack )
1800 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1801 psz_text, psz_spaces );
1802 else
1803 utf8_fprintf( stdout, "%s\n%s",
1804 psz_text, psz_spaces );
1806 else
1808 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1810 psz_text = psz_word;
1814 if( b_description_hack && p_item->psz_longtext )
1816 sprintf( psz_buffer, "%s%s", p_item->psz_longtext, psz_suf );
1817 b_description_hack = false;
1818 psz_spaces = psz_spaces_longtext;
1819 utf8_fprintf( stdout, "%s", psz_spaces );
1820 goto description;
1825 if( b_has_advanced )
1827 if( b_color )
1828 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1829 _( "add --advanced to your command line to see advanced options."));
1830 else
1831 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1832 _( "add --advanced to your command line to see advanced options."));
1835 if( i_only_advanced > 0 )
1837 if( b_color )
1839 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1840 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1842 else
1844 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1845 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1848 else if( !b_found )
1850 if( b_color )
1851 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1852 _( "No matching module found. Use --list or" \
1853 "--list-verbose to list available modules." ) );
1854 else
1855 utf8_fprintf( stdout, "\n%s\n",
1856 _( "No matching module found. Use --list or" \
1857 "--list-verbose to list available modules." ) );
1860 /* Release the module list */
1861 module_list_free (list);
1864 /*****************************************************************************
1865 * ListModules: list the available modules with their description
1866 *****************************************************************************
1867 * Print a list of all available modules (builtins and plugins) and a short
1868 * description for each one.
1869 *****************************************************************************/
1870 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1872 module_t *p_parser;
1873 char psz_spaces[22];
1875 bool b_color = config_GetInt( p_this, "color" ) > 0;
1877 memset( psz_spaces, ' ', 22 );
1879 #ifdef WIN32
1880 ShowConsole( true );
1881 #endif
1883 /* List all modules */
1884 module_t **list = module_list_get (NULL);
1886 /* Enumerate each module */
1887 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1889 int i;
1891 /* Nasty hack, but right now I'm too tired to think about a nice
1892 * solution */
1893 i = 22 - strlen( p_parser->psz_object_name ) - 1;
1894 if( i < 0 ) i = 0;
1895 psz_spaces[i] = 0;
1897 if( b_color )
1898 utf8_fprintf( stdout, GREEN" %s%s "WHITE"%s\n"GRAY,
1899 p_parser->psz_object_name,
1900 psz_spaces,
1901 p_parser->psz_longname );
1902 else
1903 utf8_fprintf( stdout, " %s%s %s\n",
1904 p_parser->psz_object_name,
1905 psz_spaces, p_parser->psz_longname );
1907 if( b_verbose )
1909 char *const *pp_shortcut = p_parser->pp_shortcuts;
1910 while( *pp_shortcut )
1912 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1914 if( b_color )
1915 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1916 *pp_shortcut );
1917 else
1918 utf8_fprintf( stdout, " s %s\n",
1919 *pp_shortcut );
1921 pp_shortcut++;
1923 if( p_parser->psz_capability )
1925 if( b_color )
1926 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1927 p_parser->psz_capability,
1928 p_parser->i_score );
1929 else
1930 utf8_fprintf( stdout, " c %s (%d)\n",
1931 p_parser->psz_capability,
1932 p_parser->i_score );
1936 psz_spaces[i] = ' ';
1938 module_list_free (list);
1940 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1941 PauseConsole();
1942 #endif
1945 /*****************************************************************************
1946 * Version: print complete program version
1947 *****************************************************************************
1948 * Print complete program version and build number.
1949 *****************************************************************************/
1950 static void Version( void )
1952 #ifdef WIN32
1953 ShowConsole( true );
1954 #endif
1956 utf8_fprintf( stdout, _("VLC version %s\n"), VLC_Version() );
1957 utf8_fprintf( stdout, _("Compiled by %s@%s.%s\n"),
1958 VLC_CompileBy(), VLC_CompileHost(), VLC_CompileDomain() );
1959 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1960 if( strcmp( VLC_Changeset(), "exported" ) )
1961 utf8_fprintf( stdout, _("Based upon Git commit [%s]\n"),
1962 VLC_Changeset() );
1963 utf8_fprintf( stdout, LICENSE_MSG );
1965 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1966 PauseConsole();
1967 #endif
1970 /*****************************************************************************
1971 * ShowConsole: On Win32, create an output console for debug messages
1972 *****************************************************************************
1973 * This function is useful only on Win32.
1974 *****************************************************************************/
1975 #ifdef WIN32 /* */
1976 static void ShowConsole( bool b_dofile )
1978 # ifndef UNDER_CE
1979 FILE *f_help = NULL;
1981 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1983 AllocConsole();
1984 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1985 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1986 * page (e.g. CP437 or CP850). */
1987 SetConsoleOutputCP (GetACP ());
1988 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1990 freopen( "CONOUT$", "w", stderr );
1991 freopen( "CONIN$", "r", stdin );
1993 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1995 fclose( f_help );
1996 freopen( "vlc-help.txt", "wt", stdout );
1997 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1999 else freopen( "CONOUT$", "w", stdout );
2001 # endif
2003 #endif
2005 /*****************************************************************************
2006 * PauseConsole: On Win32, wait for a key press before closing the console
2007 *****************************************************************************
2008 * This function is useful only on Win32.
2009 *****************************************************************************/
2010 #ifdef WIN32 /* */
2011 static void PauseConsole( void )
2013 # ifndef UNDER_CE
2015 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
2017 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
2018 getchar();
2019 fclose( stdout );
2021 # endif
2023 #endif
2025 /*****************************************************************************
2026 * ConsoleWidth: Return the console width in characters
2027 *****************************************************************************
2028 * We use the stty shell command to get the console width; if this fails or
2029 * if the width is less than 80, we default to 80.
2030 *****************************************************************************/
2031 static int ConsoleWidth( void )
2033 unsigned i_width = 80;
2035 #ifndef WIN32
2036 FILE *file = popen( "stty size 2>/dev/null", "r" );
2037 if (file != NULL)
2039 if (fscanf (file, "%*u %u", &i_width) <= 0)
2040 i_width = 80;
2041 pclose( file );
2043 #elif !defined (UNDER_CE)
2044 CONSOLE_SCREEN_BUFFER_INFO buf;
2046 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2047 i_width = buf.dwSize.X;
2048 #endif
2050 return i_width;
2053 static int VerboseCallback( vlc_object_t *p_this, const char *psz_variable,
2054 vlc_value_t old_val, vlc_value_t new_val, void *param)
2056 libvlc_int_t *p_libvlc = (libvlc_int_t *)p_this;
2057 (void)psz_variable;
2058 (void)old_val;
2059 (void)param;
2061 if( new_val.i_int >= -1 )
2063 libvlc_priv (p_libvlc)->i_verbose = __MIN( new_val.i_int, 2 );
2065 return VLC_SUCCESS;
2068 /*****************************************************************************
2069 * InitDeviceValues: initialize device values
2070 *****************************************************************************
2071 * This function inits the dvd, vcd and cd-audio values
2072 *****************************************************************************/
2073 static void InitDeviceValues( libvlc_int_t *p_vlc )
2075 #ifdef HAVE_HAL
2076 LibHalContext * ctx = NULL;
2077 int i, i_devices;
2078 char **devices = NULL;
2079 char *block_dev = NULL;
2080 dbus_bool_t b_dvd;
2082 DBusConnection *p_connection = NULL;
2083 DBusError error;
2085 ctx = libhal_ctx_new();
2086 if( !ctx ) return;
2087 dbus_error_init( &error );
2088 p_connection = dbus_bus_get ( DBUS_BUS_SYSTEM, &error );
2089 if( dbus_error_is_set( &error ) || !p_connection )
2091 libhal_ctx_free( ctx );
2092 dbus_error_free( &error );
2093 return;
2095 libhal_ctx_set_dbus_connection( ctx, p_connection );
2096 if( libhal_ctx_init( ctx, &error ) )
2098 if( ( devices = libhal_get_all_devices( ctx, &i_devices, NULL ) ) )
2100 for( i = 0; i < i_devices; i++ )
2102 if( !libhal_device_property_exists( ctx, devices[i],
2103 "storage.cdrom.dvd", NULL ) )
2105 continue;
2107 b_dvd = libhal_device_get_property_bool( ctx, devices[ i ],
2108 "storage.cdrom.dvd", NULL );
2109 block_dev = libhal_device_get_property_string( ctx,
2110 devices[ i ], "block.device" , NULL );
2111 if( b_dvd )
2113 config_PutPsz( p_vlc, "dvd", block_dev );
2116 config_PutPsz( p_vlc, "vcd", block_dev );
2117 config_PutPsz( p_vlc, "cd-audio", block_dev );
2118 libhal_free_string( block_dev );
2120 libhal_free_string_array( devices );
2122 libhal_ctx_shutdown( ctx, NULL );
2123 dbus_connection_unref( p_connection );
2124 libhal_ctx_free( ctx );
2126 else
2128 msg_Warn( p_vlc, "Unable to get HAL device properties" );
2130 #else
2131 (void)p_vlc;
2132 #endif /* HAVE_HAL */