Qt: neat and crispy location bar, new location buttons
[vlc.git] / src / libvlc.c
blob961671bbf98fd258e3622fc9a2318f9bf53b7a89
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 #ifdef WIN32 /* optind, getopt(), included in unistd.h */
61 # include "extras/getopt.h"
62 #endif
64 #ifdef HAVE_LOCALE_H
65 # include <locale.h>
66 #endif
68 #ifdef HAVE_DBUS
69 /* used for one-instance mode */
70 # include <dbus/dbus.h>
71 #endif
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
76 #include <vlc_aout.h>
77 #include "audio_output/aout_internal.h"
79 #include <vlc_charset.h>
80 #include <vlc_cpu.h>
81 #include <vlc_url.h>
83 #include "libvlc.h"
85 #include "playlist/playlist_internal.h"
87 #include <vlc_vlm.h>
89 #ifdef __APPLE__
90 # include <libkern/OSAtomic.h>
91 #endif
93 #include <assert.h>
95 /*****************************************************************************
96 * The evil global variables. We handle them with care, don't worry.
97 *****************************************************************************/
98 static unsigned i_instances = 0;
100 #ifndef WIN32
101 static bool b_daemon = false;
102 #endif
104 #undef vlc_gc_init
105 #undef vlc_hold
106 #undef vlc_release
109 * Atomically set the reference count to 1.
110 * @param p_gc reference counted object
111 * @param pf_destruct destruction calback
112 * @return p_gc.
114 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
116 /* There is no point in using the GC if there is no destructor... */
117 assert (pf_destruct);
118 p_gc->pf_destructor = pf_destruct;
120 p_gc->refs = 1;
121 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
122 __sync_synchronize ();
123 #elif defined (WIN32) && defined (__GNUC__)
124 #elif defined(__APPLE__)
125 OSMemoryBarrier ();
126 #else
127 /* Nobody else can possibly lock the spin - it's there as a barrier */
128 vlc_spin_init (&p_gc->spin);
129 vlc_spin_lock (&p_gc->spin);
130 vlc_spin_unlock (&p_gc->spin);
131 #endif
132 return p_gc;
136 * Atomically increment the reference count.
137 * @param p_gc reference counted object
138 * @return p_gc.
140 void *vlc_hold (gc_object_t * p_gc)
142 uintptr_t refs;
143 assert( p_gc );
144 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
146 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
147 refs = __sync_add_and_fetch (&p_gc->refs, 1);
148 #elif defined (WIN64)
149 refs = InterlockedIncrement64 (&p_gc->refs);
150 #elif defined (WIN32)
151 refs = InterlockedIncrement (&p_gc->refs);
152 #elif defined(__APPLE__)
153 refs = OSAtomicIncrement32Barrier((int*)&p_gc->refs);
154 #else
155 vlc_spin_lock (&p_gc->spin);
156 refs = ++p_gc->refs;
157 vlc_spin_unlock (&p_gc->spin);
158 #endif
159 assert (refs != 1); /* there had to be a reference already */
160 return p_gc;
164 * Atomically decrement the reference count and, if it reaches zero, destroy.
165 * @param p_gc reference counted object.
167 void vlc_release (gc_object_t *p_gc)
169 unsigned refs;
171 assert( p_gc );
172 assert ((((uintptr_t)&p_gc->refs) & (sizeof (void *) - 1)) == 0); /* alignment */
174 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
175 refs = __sync_sub_and_fetch (&p_gc->refs, 1);
176 #elif defined (WIN64)
177 refs = InterlockedDecrement64 (&p_gc->refs);
178 #elif defined (WIN32)
179 refs = InterlockedDecrement (&p_gc->refs);
180 #elif defined(__APPLE__)
181 refs = OSAtomicDecrement32Barrier((int*)&p_gc->refs);
182 #else
183 vlc_spin_lock (&p_gc->spin);
184 refs = --p_gc->refs;
185 vlc_spin_unlock (&p_gc->spin);
186 #endif
188 assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
189 if (refs == 0)
191 #if defined (__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4)
192 #elif defined (WIN32) && defined (__GNUC__)
193 #elif defined(__APPLE__)
194 #else
195 vlc_spin_destroy (&p_gc->spin);
196 #endif
197 p_gc->pf_destructor (p_gc);
201 /*****************************************************************************
202 * Local prototypes
203 *****************************************************************************/
204 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
205 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
206 static void SetLanguage ( char const * );
207 #endif
208 static int GetFilenames ( libvlc_int_t *, int, const char *[] );
209 static void Help ( libvlc_int_t *, char const *psz_help_name );
210 static void Usage ( libvlc_int_t *, char const *psz_search );
211 static void ListModules ( libvlc_int_t *, bool );
212 static void Version ( void );
214 #ifdef WIN32
215 static void ShowConsole ( bool );
216 static void PauseConsole ( void );
217 #endif
218 static int ConsoleWidth ( void );
220 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
223 * Allocate a libvlc instance, initialize global data if needed
224 * It also initializes the threading system
226 libvlc_int_t * libvlc_InternalCreate( void )
228 libvlc_int_t *p_libvlc;
229 libvlc_priv_t *priv;
230 char *psz_env = NULL;
232 /* Now that the thread system is initialized, we don't have much, but
233 * at least we have variables */
234 vlc_mutex_lock( &global_lock );
235 if( i_instances == 0 )
237 /* Guess what CPU we have */
238 cpu_flags = CPUCapabilities();
239 /* The module bank will be initialized later */
242 /* Allocate a libvlc instance object */
243 p_libvlc = __vlc_custom_create( NULL, sizeof (*priv),
244 VLC_OBJECT_GENERIC, "libvlc" );
245 if( p_libvlc != NULL )
246 i_instances++;
247 vlc_mutex_unlock( &global_lock );
249 if( p_libvlc == NULL )
250 return NULL;
252 priv = libvlc_priv (p_libvlc);
253 priv->p_playlist = NULL;
254 priv->p_dialog_provider = NULL;
255 priv->p_vlm = NULL;
257 /* Initialize message queue */
258 msg_Create( p_libvlc );
260 /* Find verbosity from VLC_VERBOSE environment variable */
261 psz_env = getenv( "VLC_VERBOSE" );
262 if( psz_env != NULL )
263 priv->i_verbose = atoi( psz_env );
264 else
265 priv->i_verbose = 3;
266 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
267 priv->b_color = isatty( 2 ); /* 2 is for stderr */
268 #else
269 priv->b_color = false;
270 #endif
272 /* Initialize mutexes */
273 vlc_mutex_init( &priv->timer_lock );
275 return p_libvlc;
279 * Initialize a libvlc instance
280 * This function initializes a previously allocated libvlc instance:
281 * - CPU detection
282 * - gettext initialization
283 * - message queue, module bank and playlist initialization
284 * - configuration and commandline parsing
286 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
287 const char *ppsz_argv[] )
289 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
290 char * p_tmp = NULL;
291 char * psz_modules = NULL;
292 char * psz_parser = NULL;
293 char * psz_control = NULL;
294 bool b_exit = false;
295 int i_ret = VLC_EEXIT;
296 playlist_t *p_playlist = NULL;
297 char *psz_val;
298 #if defined( ENABLE_NLS ) \
299 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
300 # if defined (WIN32) || defined (__APPLE__)
301 char * psz_language;
302 #endif
303 #endif
305 /* System specific initialization code */
306 system_Init( p_libvlc, &i_argc, ppsz_argv );
309 * Support for gettext
311 vlc_bindtextdomain (PACKAGE_NAME);
313 /* Initialize the module bank and load the configuration of the
314 * main module. We need to do this at this stage to be able to display
315 * a short help if required by the user. (short help == main module
316 * options) */
317 module_InitBank( p_libvlc );
319 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, true ) )
321 module_EndBank( p_libvlc, false );
322 return VLC_EGENERIC;
325 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
326 /* Announce who we are - Do it only for first instance ? */
327 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
328 msg_Dbg( p_libvlc, "libvlc was configured with %s", CONFIGURE_LINE );
329 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
330 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
332 /* Check for short help option */
333 if( var_InheritBool( p_libvlc, "help" ) )
335 Help( p_libvlc, "help" );
336 b_exit = true;
337 i_ret = VLC_EEXITSUCCESS;
339 /* Check for version option */
340 else if( var_InheritBool( p_libvlc, "version" ) )
342 Version();
343 b_exit = true;
344 i_ret = VLC_EEXITSUCCESS;
347 /* Check for daemon mode */
348 #ifndef WIN32
349 if( var_InheritBool( p_libvlc, "daemon" ) )
351 #ifdef HAVE_DAEMON
352 char *psz_pidfile = NULL;
354 if( daemon( 1, 0) != 0 )
356 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
357 b_exit = true;
359 b_daemon = true;
361 /* lets check if we need to write the pidfile */
362 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
363 if( psz_pidfile != NULL )
365 FILE *pidfile;
366 pid_t i_pid = getpid ();
367 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
368 i_pid, psz_pidfile );
369 pidfile = utf8_fopen( psz_pidfile,"w" );
370 if( pidfile != NULL )
372 utf8_fprintf( pidfile, "%d", (int)i_pid );
373 fclose( pidfile );
375 else
377 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
378 psz_pidfile );
381 free( psz_pidfile );
383 #else
384 pid_t i_pid;
386 if( ( i_pid = fork() ) < 0 )
388 msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
389 b_exit = true;
391 else if( i_pid )
393 /* This is the parent, exit right now */
394 msg_Dbg( p_libvlc, "closing parent process" );
395 b_exit = true;
396 i_ret = VLC_EEXITSUCCESS;
398 else
400 /* We are the child */
401 msg_Dbg( p_libvlc, "daemon spawned" );
402 close( STDIN_FILENO );
403 close( STDOUT_FILENO );
404 close( STDERR_FILENO );
406 b_daemon = true;
408 #endif
410 #endif
412 if( b_exit )
414 module_EndBank( p_libvlc, false );
415 return i_ret;
418 /* Check for translation config option */
419 #if defined( ENABLE_NLS ) \
420 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
421 # if defined (WIN32) || defined (__APPLE__)
422 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
423 config_LoadConfigFile( p_libvlc, "main" );
424 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
426 /* Check if the user specified a custom language */
427 psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
428 if( psz_language && strcmp( psz_language, "auto" ) )
430 /* Reset the default domain */
431 SetLanguage( psz_language );
433 /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
434 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
436 free( psz_language );
437 # endif
438 #endif
441 * Load the builtins and plugins into the module_bank.
442 * We have to do it before config_Load*() because this also gets the
443 * list of configuration options exported by each module and loads their
444 * default values.
446 module_LoadPlugins( p_libvlc );
447 if( p_libvlc->b_die )
449 b_exit = true;
452 size_t module_count;
453 module_t **list = module_list_get( &module_count );
454 module_list_free( list );
455 msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
457 /* Check for help on modules */
458 if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
460 Help( p_libvlc, p_tmp );
461 free( p_tmp );
462 b_exit = true;
463 i_ret = VLC_EEXITSUCCESS;
465 /* Check for full help option */
466 else if( var_InheritBool( p_libvlc, "full-help" ) )
468 var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
469 var_SetBool( p_libvlc, "advanced", true );
470 var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
471 var_SetBool( p_libvlc, "help-verbose", true );
472 Help( p_libvlc, "full-help" );
473 b_exit = true;
474 i_ret = VLC_EEXITSUCCESS;
476 /* Check for long help option */
477 else if( var_InheritBool( p_libvlc, "longhelp" ) )
479 Help( p_libvlc, "longhelp" );
480 b_exit = true;
481 i_ret = VLC_EEXITSUCCESS;
483 /* Check for module list option */
484 else if( var_InheritBool( p_libvlc, "list" ) )
486 ListModules( p_libvlc, false );
487 b_exit = true;
488 i_ret = VLC_EEXITSUCCESS;
490 else if( var_InheritBool( p_libvlc, "list-verbose" ) )
492 ListModules( p_libvlc, true );
493 b_exit = true;
494 i_ret = VLC_EEXITSUCCESS;
497 /* Check for config file options */
498 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
500 if( var_InheritBool( p_libvlc, "reset-config" ) )
502 config_ResetAll( p_libvlc );
503 config_SaveConfigFile( p_libvlc, NULL );
507 if( module_count <= 1)
509 msg_Err( p_libvlc, "No modules were found, refusing to start. Check "
510 "that you properly gave a module path with --plugin-path.");
511 b_exit = true;
512 i_ret = VLC_ENOITEM;
515 if( b_exit )
517 module_EndBank( p_libvlc, true );
518 return i_ret;
522 * Override default configuration with config file settings
524 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
525 config_LoadConfigFile( p_libvlc, NULL );
528 * Override configuration with command line settings
530 if( config_LoadCmdLine( p_libvlc, &i_argc, ppsz_argv, false ) )
532 #ifdef WIN32
533 ShowConsole( false );
534 /* Pause the console because it's destroyed when we exit */
535 fprintf( stderr, "The command line options couldn't be loaded, check "
536 "that they are valid.\n" );
537 PauseConsole();
538 #endif
539 module_EndBank( p_libvlc, true );
540 return VLC_EGENERIC;
542 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
545 * System specific configuration
547 system_Configure( p_libvlc, &i_argc, ppsz_argv );
549 /* FIXME: could be replaced by using Unix sockets */
550 #ifdef HAVE_DBUS
551 dbus_threads_init_default();
553 if( var_InheritBool( p_libvlc, "one-instance" )
554 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
555 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
557 /* Initialise D-Bus interface, check for other instances */
558 DBusConnection *p_conn = NULL;
559 DBusError dbus_error;
561 dbus_error_init( &dbus_error );
563 /* connect to the session bus */
564 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
565 if( !p_conn )
567 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
568 dbus_error.message );
569 dbus_error_free( &dbus_error );
571 else
573 /* check if VLC is available on the bus
574 * if not: D-Bus control is not enabled on the other
575 * instance and we can't pass MRLs to it */
576 DBusMessage *p_test_msg = NULL;
577 DBusMessage *p_test_reply = NULL;
578 p_test_msg = dbus_message_new_method_call(
579 "org.mpris.vlc", "/",
580 "org.freedesktop.MediaPlayer", "Identity" );
581 /* block until a reply arrives */
582 p_test_reply = dbus_connection_send_with_reply_and_block(
583 p_conn, p_test_msg, -1, &dbus_error );
584 dbus_message_unref( p_test_msg );
585 if( p_test_reply == NULL )
587 dbus_error_free( &dbus_error );
588 msg_Dbg( p_libvlc, "No Media Player is running. "
589 "Continuing normally." );
591 else
593 int i_input;
594 DBusMessage* p_dbus_msg = NULL;
595 DBusMessageIter dbus_args;
596 DBusPendingCall* p_dbus_pending = NULL;
597 dbus_bool_t b_play;
599 dbus_message_unref( p_test_reply );
600 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
602 for( i_input = optind;i_input < i_argc;i_input++ )
604 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
605 ppsz_argv[i_input] );
607 p_dbus_msg = dbus_message_new_method_call(
608 "org.mpris.vlc", "/TrackList",
609 "org.freedesktop.MediaPlayer", "AddTrack" );
611 if ( NULL == p_dbus_msg )
613 msg_Err( p_libvlc, "D-Bus problem" );
614 system_End( p_libvlc );
615 exit( 1 );
618 /* append MRLs */
619 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
620 if ( !dbus_message_iter_append_basic( &dbus_args,
621 DBUS_TYPE_STRING, &ppsz_argv[i_input] ) )
623 dbus_message_unref( p_dbus_msg );
624 system_End( p_libvlc );
625 exit( 1 );
627 b_play = TRUE;
628 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
629 b_play = FALSE;
630 if ( !dbus_message_iter_append_basic( &dbus_args,
631 DBUS_TYPE_BOOLEAN, &b_play ) )
633 dbus_message_unref( p_dbus_msg );
634 system_End( p_libvlc );
635 exit( 1 );
638 /* send message and get a handle for a reply */
639 if ( !dbus_connection_send_with_reply ( p_conn,
640 p_dbus_msg, &p_dbus_pending, -1 ) )
642 msg_Err( p_libvlc, "D-Bus problem" );
643 dbus_message_unref( p_dbus_msg );
644 system_End( p_libvlc );
645 exit( 1 );
648 if ( NULL == p_dbus_pending )
650 msg_Err( p_libvlc, "D-Bus problem" );
651 dbus_message_unref( p_dbus_msg );
652 system_End( p_libvlc );
653 exit( 1 );
655 dbus_connection_flush( p_conn );
656 dbus_message_unref( p_dbus_msg );
657 /* block until we receive a reply */
658 dbus_pending_call_block( p_dbus_pending );
659 dbus_pending_call_unref( p_dbus_pending );
660 } /* processes all command line MRLs */
662 /* bye bye */
663 system_End( p_libvlc );
664 exit( 0 );
667 /* we unreference the connection when we've finished with it */
668 if( p_conn ) dbus_connection_unref( p_conn );
670 #endif
673 * Message queue options
675 char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
676 if( psz_verbose_objects )
678 char * psz_object, * iter = psz_verbose_objects;
679 while( (psz_object = strsep( &iter, "," )) )
681 switch( psz_object[0] )
683 printf("%s\n", psz_object+1);
684 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
685 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
686 default:
687 msg_Err( p_libvlc, "verbose-objects usage: \n"
688 "--verbose-objects=+printthatobject,"
689 "-dontprintthatone\n"
690 "(keyword 'all' to applies to all objects)");
691 free( psz_verbose_objects );
692 /* FIXME: leaks!!!! */
693 return VLC_EGENERIC;
696 free( psz_verbose_objects );
699 /* Last chance to set the verbosity. Once we start interfaces and other
700 * threads, verbosity becomes read-only. */
701 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
702 if( var_InheritBool( p_libvlc, "quiet" ) )
704 var_SetInteger( p_libvlc, "verbose", -1 );
705 priv->i_verbose = -1;
707 vlc_threads_setup( p_libvlc );
709 if( priv->b_color )
710 priv->b_color = var_InheritBool( p_libvlc, "color" );
712 char p_capabilities[200];
713 #define PRINT_CAPABILITY( capability, string ) \
714 if( vlc_CPU() & capability ) \
716 strncat( p_capabilities, string " ", \
717 sizeof(p_capabilities) - strlen(p_capabilities) ); \
718 p_capabilities[sizeof(p_capabilities) - 1] = '\0'; \
720 p_capabilities[0] = '\0';
722 #if defined( __i386__ ) || defined( __x86_64__ )
723 if( !var_InheritBool( p_libvlc, "mmx" ) )
724 cpu_flags &= ~CPU_CAPABILITY_MMX;
725 if( !var_InheritBool( p_libvlc, "3dn" ) )
726 cpu_flags &= ~CPU_CAPABILITY_3DNOW;
727 if( !var_InheritBool( p_libvlc, "mmxext" ) )
728 cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
729 if( !var_InheritBool( p_libvlc, "sse" ) )
730 cpu_flags &= ~CPU_CAPABILITY_SSE;
731 if( !var_InheritBool( p_libvlc, "sse2" ) )
732 cpu_flags &= ~CPU_CAPABILITY_SSE2;
733 if( !var_InheritBool( p_libvlc, "sse3" ) )
734 cpu_flags &= ~CPU_CAPABILITY_SSE3;
735 if( !var_InheritBool( p_libvlc, "ssse3" ) )
736 cpu_flags &= ~CPU_CAPABILITY_SSSE3;
737 if( !var_InheritBool( p_libvlc, "sse41" ) )
738 cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
739 if( !var_InheritBool( p_libvlc, "sse42" ) )
740 cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
742 PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
743 PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
744 PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
745 PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
746 PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
747 PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
748 PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
749 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
750 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
751 PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A, "SSE4A" );
753 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
754 if( !var_InheritBool( p_libvlc, "altivec" ) )
755 cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
757 PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
759 #elif defined( __arm__ )
760 PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
762 #endif
764 #if HAVE_FPU
765 strncat( p_capabilities, "FPU ",
766 sizeof(p_capabilities) - strlen( p_capabilities) );
767 p_capabilities[sizeof(p_capabilities) - 1] = '\0';
768 #endif
770 if (p_capabilities[0])
771 msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
774 * Choose the best memcpy module
776 priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
777 /* Avoid being called "memcpy":*/
778 vlc_object_set_name( p_libvlc, "main" );
780 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
781 priv->i_timers = 0;
782 priv->pp_timers = NULL;
784 priv->i_last_input_id = 0; /* Not very safe, should be removed */
787 * Initialize hotkey handling
789 vlc_InitActions( p_libvlc );
791 /* variables for signalling creation of new files */
792 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
793 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
795 /* Initialize playlist and get commandline files */
796 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
797 if( !p_playlist )
799 msg_Err( p_libvlc, "playlist initialization failed" );
800 if( priv->p_memcpy_module != NULL )
802 module_unneed( p_libvlc, priv->p_memcpy_module );
804 module_EndBank( p_libvlc, true );
805 return VLC_EGENERIC;
808 /* Add service discovery modules */
809 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
810 if( psz_modules )
812 char *p = psz_modules, *m;
813 playlist_t *p_playlist = pl_Hold( p_libvlc );
814 while( ( m = strsep( &p, " :," ) ) != NULL )
815 playlist_ServicesDiscoveryAdd( p_playlist, m );
816 free( psz_modules );
817 pl_Release (p_playlist);
820 #ifdef ENABLE_VLM
821 /* Initialize VLM if vlm-conf is specified */
822 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
823 if( psz_parser )
825 priv->p_vlm = vlm_New( p_libvlc );
826 if( !priv->p_vlm )
827 msg_Err( p_libvlc, "VLM initialization failed" );
829 free( psz_parser );
830 #endif
833 * Load background interfaces
835 /* Create volume callback system. (this variable must be created before
836 all interfaces as they can use it) */
837 var_Create( p_libvlc, "volume-change", VLC_VAR_VOID );
838 var_Create( p_libvlc, "volume-muted", VLC_VAR_BOOL );
840 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
841 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
843 if( psz_modules && psz_control )
845 char* psz_tmp;
846 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
848 free( psz_modules );
849 psz_modules = psz_tmp;
852 else if( psz_control )
854 free( psz_modules );
855 psz_modules = strdup( psz_control );
858 psz_parser = psz_modules;
859 while ( psz_parser && *psz_parser )
861 char *psz_module, *psz_temp;
862 psz_module = psz_parser;
863 psz_parser = strchr( psz_module, ':' );
864 if ( psz_parser )
866 *psz_parser = '\0';
867 psz_parser++;
869 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
871 intf_Create( p_libvlc, psz_temp );
872 free( psz_temp );
875 free( psz_modules );
876 free( psz_control );
879 * Always load the hotkeys interface if it exists
881 intf_Create( p_libvlc, "hotkeys,none" );
883 #ifdef HAVE_DBUS
884 /* loads dbus control interface if in one-instance mode
885 * we do it only when playlist exists, because dbus module needs it */
886 if( var_InheritBool( p_libvlc, "one-instance" )
887 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
888 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
889 intf_Create( p_libvlc, "dbus,none" );
891 # if !defined (HAVE_MAEMO)
892 /* Prevents the power management daemon from suspending the system
893 * when VLC is active */
894 if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
895 intf_Create( p_libvlc, "inhibit,none" );
896 # endif
897 #endif
899 if( var_InheritBool( p_libvlc, "file-logging" ) &&
900 !var_InheritBool( p_libvlc, "syslog" ) )
902 intf_Create( p_libvlc, "logger,none" );
904 #ifdef HAVE_SYSLOG_H
905 if( var_InheritBool( p_libvlc, "syslog" ) )
907 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
908 var_SetString( p_libvlc, "logmode", "syslog" );
909 intf_Create( p_libvlc, "logger,none" );
911 if( logmode )
913 var_SetString( p_libvlc, "logmode", logmode );
914 free( logmode );
916 var_Destroy( p_libvlc, "logmode" );
918 #endif
920 if( var_InheritBool( p_libvlc, "network-synchronisation") )
922 intf_Create( p_libvlc, "netsync,none" );
925 #ifdef WIN32
926 if( var_InheritBool( p_libvlc, "prefer-system-codecs") )
928 char *psz_codecs = var_CreateGetNonEmptyString( p_libvlc, "codec" );
929 if( psz_codecs )
931 char *psz_morecodecs;
932 if( asprintf(&psz_morecodecs, "%s,dmo,quicktime", psz_codecs) != -1 )
934 var_SetString( p_libvlc, "codec", psz_morecodecs);
935 free( psz_morecodecs );
937 free( psz_codecs );
939 else
940 var_SetString( p_libvlc, "codec", "dmo,quicktime");
942 #endif
944 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
945 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
946 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
947 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
948 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
949 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
950 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
951 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
954 /* Create a variable for showing the fullscreen interface from hotkeys */
955 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
956 var_SetBool( p_libvlc, "intf-show", true );
958 /* Create a variable for showing the right click menu */
959 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
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_t *p_playlist = pl_Hold( p_libvlc );
973 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
974 -1, 0, NULL, 0, true, pl_Unlocked );
975 pl_Release( p_libvlc );
976 free( psz_val );
979 return VLC_SUCCESS;
983 * Cleanup a libvlc instance. The instance is not completely deallocated
984 * \param p_libvlc the instance to clean
986 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
988 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
989 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
991 /* Deactivate the playlist */
992 msg_Dbg( p_libvlc, "deactivating the playlist" );
993 pl_Deactivate( p_libvlc );
995 /* Remove all services discovery */
996 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
997 playlist_ServicesDiscoveryKillAll( p_playlist );
999 /* Ask the interfaces to stop and destroy them */
1000 msg_Dbg( p_libvlc, "removing all interfaces" );
1001 libvlc_Quit( p_libvlc );
1002 intf_DestroyAll( p_libvlc );
1004 #ifdef ENABLE_VLM
1005 /* Destroy VLM if created in libvlc_InternalInit */
1006 if( priv->p_vlm )
1008 vlm_Delete( priv->p_vlm );
1010 #endif
1012 /* Free playlist now */
1013 msg_Dbg( p_libvlc, "removing playlist" );
1014 vlc_object_release( p_playlist );
1016 stats_TimersDumpAll( p_libvlc );
1017 stats_TimersCleanAll( p_libvlc );
1019 msg_Dbg( p_libvlc, "removing stats" );
1021 #ifndef WIN32
1022 char* psz_pidfile = NULL;
1024 if( b_daemon )
1026 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1027 if( psz_pidfile != NULL )
1029 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1030 if( unlink( psz_pidfile ) == -1 )
1032 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1033 psz_pidfile );
1036 free( psz_pidfile );
1038 #endif
1040 if( priv->p_memcpy_module )
1042 module_unneed( p_libvlc, priv->p_memcpy_module );
1043 priv->p_memcpy_module = NULL;
1046 /* Free module bank. It is refcounted, so we call this each time */
1047 module_EndBank( p_libvlc, true );
1049 vlc_DeinitActions( p_libvlc );
1053 * Destroy everything.
1054 * This function requests the running threads to finish, waits for their
1055 * termination, and destroys their structure.
1056 * It stops the thread systems: no instance can run after this has run
1057 * \param p_libvlc the instance to destroy
1059 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1061 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1063 vlc_mutex_lock( &global_lock );
1064 i_instances--;
1066 if( i_instances == 0 )
1068 /* System specific cleaning code */
1069 system_End( p_libvlc );
1071 vlc_mutex_unlock( &global_lock );
1073 msg_Destroy( p_libvlc );
1075 /* Destroy mutexes */
1076 vlc_mutex_destroy( &priv->timer_lock );
1078 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1079 if( vlc_internals( p_libvlc )->i_refcount > 1 )
1080 while( vlc_internals( p_libvlc )->i_refcount > 0 )
1081 vlc_object_release( p_libvlc );
1082 #endif
1084 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1085 vlc_object_release( p_libvlc );
1089 * Add an interface plugin and run it
1091 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1093 if( !p_libvlc )
1094 return VLC_EGENERIC;
1096 if( !psz_module ) /* requesting the default interface */
1098 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1099 if( !psz_interface ) /* "intf" has not been set */
1101 #ifndef WIN32
1102 if( b_daemon )
1103 /* Daemon mode hack.
1104 * We prefer the dummy interface if none is specified. */
1105 psz_module = "dummy";
1106 else
1107 #endif
1108 msg_Info( p_libvlc, "%s",
1109 _("Running vlc with the default interface. "
1110 "Use 'cvlc' to use vlc without interface.") );
1112 free( psz_interface );
1113 var_Destroy( p_libvlc, "intf" );
1116 /* Try to create the interface */
1117 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1118 if( ret )
1119 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1120 psz_module ? psz_module : "default" );
1121 return ret;
1124 #ifndef WIN32
1125 static vlc_mutex_t exit_lock = VLC_STATIC_MUTEX;
1126 static vlc_cond_t exiting = VLC_STATIC_COND;
1127 #else
1128 extern vlc_mutex_t super_mutex;
1129 extern vlc_cond_t super_variable;
1130 # define exit_lock super_mutex
1131 # define exiting super_variable
1132 #endif
1135 * Waits until the LibVLC instance gets an exit signal. Normally, this happens
1136 * when the user "exits" an interface plugin.
1138 void libvlc_InternalWait( libvlc_int_t *p_libvlc )
1140 vlc_mutex_lock( &exit_lock );
1141 while( vlc_object_alive( p_libvlc ) )
1142 vlc_cond_wait( &exiting, &exit_lock );
1143 vlc_mutex_unlock( &exit_lock );
1147 * Posts an exit signal to LibVLC instance. This will normally initiate the
1148 * cleanup and destroy process. It should only be called on behalf of the user.
1150 void libvlc_Quit( libvlc_int_t *p_libvlc )
1152 vlc_mutex_lock( &exit_lock );
1153 vlc_object_kill( p_libvlc );
1154 vlc_cond_broadcast( &exiting );
1155 vlc_mutex_unlock( &exit_lock );
1158 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1159 ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1160 /*****************************************************************************
1161 * SetLanguage: set the interface language.
1162 *****************************************************************************
1163 * We set the LC_MESSAGES locale category for interface messages and buttons,
1164 * as well as the LC_CTYPE category for string sorting and possible wide
1165 * character support.
1166 *****************************************************************************/
1167 static void SetLanguage ( const char *psz_lang )
1169 #ifdef __APPLE__
1170 /* I need that under Darwin, please check it doesn't disturb
1171 * other platforms. --Meuuh */
1172 setenv( "LANG", psz_lang, 1 );
1174 #else
1175 /* We set LC_ALL manually because it is the only way to set
1176 * the language at runtime under eg. Windows. Beware that this
1177 * makes the environment unconsistent when libvlc is unloaded and
1178 * should probably be moved to a safer place like vlc.c. */
1179 static char psz_lcall[20];
1180 snprintf( psz_lcall, 19, "LC_ALL=%s", psz_lang );
1181 psz_lcall[19] = '\0';
1182 putenv( psz_lcall );
1183 #endif
1185 setlocale( LC_ALL, psz_lang );
1187 #endif
1189 /*****************************************************************************
1190 * GetFilenames: parse command line options which are not flags
1191 *****************************************************************************
1192 * Parse command line for input files as well as their associated options.
1193 * An option always follows its associated input and begins with a ":".
1194 *****************************************************************************/
1195 static int GetFilenames( libvlc_int_t *p_vlc, int i_argc, const char *ppsz_argv[] )
1197 int i_opt, i_options;
1199 /* We assume that the remaining parameters are filenames
1200 * and their input options */
1201 for( i_opt = i_argc - 1; i_opt >= optind; i_opt-- )
1203 i_options = 0;
1205 /* Count the input options */
1206 while( *ppsz_argv[ i_opt ] == ':' && i_opt > optind )
1208 i_options++;
1209 i_opt--;
1212 /* TODO: write an internal function of this one, to avoid
1213 * unnecessary lookups. */
1214 char *mrl = make_URI( ppsz_argv[i_opt] );
1215 if( !mrl )
1216 continue;
1218 playlist_t *p_playlist = pl_Hold( p_vlc );
1219 playlist_AddExt( p_playlist, mrl, NULL, PLAYLIST_INSERT,
1220 0, -1, i_options, ( i_options ? &ppsz_argv[i_opt + 1] : NULL ),
1221 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1222 pl_Release( p_vlc );
1223 free( mrl );
1226 return VLC_SUCCESS;
1229 /*****************************************************************************
1230 * Help: print program help
1231 *****************************************************************************
1232 * Print a short inline help. Message interface is initialized at this stage.
1233 *****************************************************************************/
1234 static inline void print_help_on_full_help( void )
1236 utf8_fprintf( stdout, "\n" );
1237 utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1240 static const char vlc_usage[] = N_(
1241 "Usage: %s [options] [stream] ..."
1242 "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1243 "\nThe first item specified will be played first."
1244 "\n"
1245 "\nOptions-styles:"
1246 "\n --option A global option that is set for the duration of the program."
1247 "\n -option A single letter version of a global --option."
1248 "\n :option An option that only applies to the stream directly before it"
1249 "\n and that overrides previous settings."
1250 "\n"
1251 "\nStream MRL syntax:"
1252 "\n [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1253 "\n"
1254 "\n Many of the global --options can also be used as MRL specific :options."
1255 "\n Multiple :option=value pairs can be specified."
1256 "\n"
1257 "\nURL syntax:"
1258 "\n [file://]filename Plain media file"
1259 "\n http://ip:port/file HTTP URL"
1260 "\n ftp://ip:port/file FTP URL"
1261 "\n mms://ip:port/file MMS URL"
1262 "\n screen:// Screen capture"
1263 "\n [dvd://][device][@raw_device] DVD device"
1264 "\n [vcd://][device] VCD device"
1265 "\n [cdda://][device] Audio CD device"
1266 "\n udp://[[<source address>]@[<bind address>][:<bind port>]]"
1267 "\n UDP stream sent by a streaming server"
1268 "\n vlc://pause:<seconds> Special item to pause the playlist for a certain time"
1269 "\n vlc://quit Special item to quit VLC"
1270 "\n");
1272 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1274 #ifdef WIN32
1275 ShowConsole( true );
1276 #endif
1278 if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1280 utf8_fprintf( stdout, vlc_usage, "vlc" );
1281 Usage( p_this, "=help" );
1282 Usage( p_this, "=main" );
1283 print_help_on_full_help();
1285 else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1287 utf8_fprintf( stdout, vlc_usage, "vlc" );
1288 Usage( p_this, NULL );
1289 print_help_on_full_help();
1291 else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1293 utf8_fprintf( stdout, vlc_usage, "vlc" );
1294 Usage( p_this, NULL );
1296 else if( psz_help_name )
1298 Usage( p_this, psz_help_name );
1301 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1302 PauseConsole();
1303 #endif
1306 /*****************************************************************************
1307 * Usage: print module usage
1308 *****************************************************************************
1309 * Print a short inline help. Message interface is initialized at this stage.
1310 *****************************************************************************/
1311 # define COL(x) "\033[" #x ";1m"
1312 # define RED COL(31)
1313 # define GREEN COL(32)
1314 # define YELLOW COL(33)
1315 # define BLUE COL(34)
1316 # define MAGENTA COL(35)
1317 # define CYAN COL(36)
1318 # define WHITE COL(0)
1319 # define GRAY "\033[0m"
1320 static void
1321 print_help_section( const module_t *m, const module_config_t *p_item,
1322 bool b_color, bool b_description )
1324 if( !p_item ) return;
1325 if( b_color )
1327 utf8_fprintf( stdout, RED" %s:\n"GRAY,
1328 module_gettext( m, p_item->psz_text ) );
1329 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1330 utf8_fprintf( stdout, MAGENTA" %s\n"GRAY,
1331 module_gettext( m, p_item->psz_longtext ) );
1333 else
1335 utf8_fprintf( stdout, " %s:\n",
1336 module_gettext( m, p_item->psz_text ) );
1337 if( b_description && p_item->psz_longtext && *p_item->psz_longtext )
1338 utf8_fprintf( stdout, " %s\n",
1339 module_gettext(m, p_item->psz_longtext ) );
1343 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1345 #define FORMAT_STRING " %s --%s%s%s%s%s%s%s "
1346 /* short option ------' | | | | | | |
1347 * option name ------------' | | | | | |
1348 * <bra ---------------------' | | | | |
1349 * option type or "" ----------' | | | |
1350 * ket> -------------------------' | | |
1351 * padding spaces -----------------' | |
1352 * comment --------------------------' |
1353 * comment suffix ---------------------'
1355 * The purpose of having bra and ket is that we might i18n them as well.
1358 #define COLOR_FORMAT_STRING (WHITE" %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1359 #define COLOR_FORMAT_STRING_BOOL (WHITE" %s --%s%s%s%s%s%s%s "GRAY)
1361 #define LINE_START 8
1362 #define PADDING_SPACES 25
1363 #ifdef WIN32
1364 # define OPTION_VALUE_SEP "="
1365 #else
1366 # define OPTION_VALUE_SEP " "
1367 #endif
1368 char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1369 char psz_spaces_longtext[LINE_START+3];
1370 char psz_format[sizeof(COLOR_FORMAT_STRING)];
1371 char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1372 char psz_buffer[10000];
1373 char psz_short[4];
1374 int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1375 int i_width_description = i_width + PADDING_SPACES - 1;
1376 bool b_advanced = var_InheritBool( p_this, "advanced" );
1377 bool b_description = var_InheritBool( p_this, "help-verbose" );
1378 bool b_description_hack;
1379 bool b_color = var_InheritBool( p_this, "color" );
1380 bool b_has_advanced = false;
1381 bool b_found = false;
1382 int i_only_advanced = 0; /* Number of modules ignored because they
1383 * only have advanced options */
1384 bool b_strict = psz_search && *psz_search == '=';
1385 if( b_strict ) psz_search++;
1387 memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1388 psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1389 memset( psz_spaces_longtext, ' ', LINE_START+2 );
1390 psz_spaces_longtext[LINE_START+2] = '\0';
1391 #ifndef WIN32
1392 if( !isatty( 1 ) )
1393 #endif
1394 b_color = false; // don't put color control codes in a .txt file
1396 if( b_color )
1398 strcpy( psz_format, COLOR_FORMAT_STRING );
1399 strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1401 else
1403 strcpy( psz_format, FORMAT_STRING );
1404 strcpy( psz_format_bool, FORMAT_STRING );
1407 /* List all modules */
1408 module_t **list = module_list_get (NULL);
1409 if (!list)
1410 return;
1412 /* Ugly hack to make sure that the help options always come first
1413 * (part 1) */
1414 if( !psz_search )
1415 Usage( p_this, "help" );
1417 /* Enumerate the config for each module */
1418 for (size_t i = 0; list[i]; i++)
1420 bool b_help_module;
1421 module_t *p_parser = list[i];
1422 module_config_t *p_item = NULL;
1423 module_config_t *p_section = NULL;
1424 module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1426 if( psz_search &&
1427 ( b_strict ? strcmp( psz_search, p_parser->psz_object_name )
1428 : !strstr( p_parser->psz_object_name, psz_search ) ) )
1430 char *const *pp_shortcut = p_parser->pp_shortcuts;
1431 while( *pp_shortcut )
1433 if( b_strict ? !strcmp( psz_search, *pp_shortcut )
1434 : !!strstr( *pp_shortcut, psz_search ) )
1435 break;
1436 pp_shortcut ++;
1438 if( !*pp_shortcut )
1439 continue;
1442 /* Ignore modules without config options */
1443 if( !p_parser->i_config_items )
1445 continue;
1448 b_help_module = !strcmp( "help", p_parser->psz_object_name );
1449 /* Ugly hack to make sure that the help options always come first
1450 * (part 2) */
1451 if( !psz_search && b_help_module )
1452 continue;
1454 /* Ignore modules with only advanced config options if requested */
1455 if( !b_advanced )
1457 for( p_item = p_parser->p_config;
1458 p_item < p_end;
1459 p_item++ )
1461 if( (p_item->i_type & CONFIG_ITEM) &&
1462 !p_item->b_advanced && !p_item->b_removed ) break;
1465 if( p_item == p_end )
1467 i_only_advanced++;
1468 continue;
1472 b_found = true;
1474 /* Print name of module */
1475 if( strcmp( "main", p_parser->psz_object_name ) )
1477 if( b_color )
1478 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1479 module_gettext( p_parser, p_parser->psz_longname ),
1480 p_parser->psz_object_name );
1481 else
1482 utf8_fprintf( stdout, "\n %s\n",
1483 module_gettext(p_parser, p_parser->psz_longname ) );
1485 if( p_parser->psz_help )
1487 if( b_color )
1488 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1489 module_gettext( p_parser, p_parser->psz_help ) );
1490 else
1491 utf8_fprintf( stdout, " %s\n",
1492 module_gettext( p_parser, p_parser->psz_help ) );
1495 /* Print module options */
1496 for( p_item = p_parser->p_config;
1497 p_item < p_end;
1498 p_item++ )
1500 char *psz_text, *psz_spaces = psz_spaces_text;
1501 const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1502 const char *psz_suf = "", *psz_prefix = NULL;
1503 signed int i;
1504 size_t i_cur_width;
1506 /* Skip removed options */
1507 if( p_item->b_removed )
1509 continue;
1511 /* Skip advanced options if requested */
1512 if( p_item->b_advanced && !b_advanced )
1514 b_has_advanced = true;
1515 continue;
1518 switch( p_item->i_type )
1520 case CONFIG_HINT_CATEGORY:
1521 case CONFIG_HINT_USAGE:
1522 if( !strcmp( "main", p_parser->psz_object_name ) )
1524 if( b_color )
1525 utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1526 module_gettext( p_parser, p_item->psz_text ) );
1527 else
1528 utf8_fprintf( stdout, "\n %s\n",
1529 module_gettext( p_parser, p_item->psz_text ) );
1531 if( b_description && p_item->psz_longtext
1532 && *p_item->psz_longtext )
1534 if( b_color )
1535 utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1536 module_gettext( p_parser, p_item->psz_longtext ) );
1537 else
1538 utf8_fprintf( stdout, " %s\n",
1539 module_gettext( p_parser, p_item->psz_longtext ) );
1541 break;
1543 case CONFIG_HINT_SUBCATEGORY:
1544 if( strcmp( "main", p_parser->psz_object_name ) )
1545 break;
1546 case CONFIG_SECTION:
1547 p_section = p_item;
1548 break;
1550 case CONFIG_ITEM_STRING:
1551 case CONFIG_ITEM_FILE:
1552 case CONFIG_ITEM_DIRECTORY:
1553 case CONFIG_ITEM_MODULE: /* We could also have "=<" here */
1554 case CONFIG_ITEM_MODULE_CAT:
1555 case CONFIG_ITEM_MODULE_LIST:
1556 case CONFIG_ITEM_MODULE_LIST_CAT:
1557 case CONFIG_ITEM_FONT:
1558 case CONFIG_ITEM_PASSWORD:
1559 print_help_section( p_parser, p_section, b_color,
1560 b_description );
1561 p_section = NULL;
1562 psz_bra = OPTION_VALUE_SEP "<";
1563 psz_type = _("string");
1564 psz_ket = ">";
1566 if( p_item->ppsz_list )
1568 psz_bra = OPTION_VALUE_SEP "{";
1569 psz_type = psz_buffer;
1570 psz_buffer[0] = '\0';
1571 for( i = 0; p_item->ppsz_list[i]; i++ )
1573 if( i ) strcat( psz_buffer, "," );
1574 strcat( psz_buffer, p_item->ppsz_list[i] );
1576 psz_ket = "}";
1578 break;
1579 case CONFIG_ITEM_INTEGER:
1580 case CONFIG_ITEM_KEY: /* FIXME: do something a bit more clever */
1581 print_help_section( p_parser, p_section, b_color,
1582 b_description );
1583 p_section = NULL;
1584 psz_bra = OPTION_VALUE_SEP "<";
1585 psz_type = _("integer");
1586 psz_ket = ">";
1588 if( p_item->min.i || p_item->max.i )
1590 sprintf( psz_buffer, "%s [%i .. %i]", psz_type,
1591 p_item->min.i, p_item->max.i );
1592 psz_type = psz_buffer;
1595 if( p_item->i_list )
1597 psz_bra = OPTION_VALUE_SEP "{";
1598 psz_type = psz_buffer;
1599 psz_buffer[0] = '\0';
1600 for( i = 0; p_item->ppsz_list_text[i]; i++ )
1602 if( i ) strcat( psz_buffer, ", " );
1603 sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1604 p_item->pi_list[i],
1605 module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1607 psz_ket = "}";
1609 break;
1610 case CONFIG_ITEM_FLOAT:
1611 print_help_section( p_parser, p_section, b_color,
1612 b_description );
1613 p_section = NULL;
1614 psz_bra = OPTION_VALUE_SEP "<";
1615 psz_type = _("float");
1616 psz_ket = ">";
1617 if( p_item->min.f || p_item->max.f )
1619 sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1620 p_item->min.f, p_item->max.f );
1621 psz_type = psz_buffer;
1623 break;
1624 case CONFIG_ITEM_BOOL:
1625 print_help_section( p_parser, p_section, b_color,
1626 b_description );
1627 p_section = NULL;
1628 psz_bra = ""; psz_type = ""; psz_ket = "";
1629 if( !b_help_module )
1631 psz_suf = p_item->value.i ? _(" (default enabled)") :
1632 _(" (default disabled)");
1634 break;
1637 if( !psz_type )
1639 continue;
1642 /* Add short option if any */
1643 if( p_item->i_short )
1645 sprintf( psz_short, "-%c,", p_item->i_short );
1647 else
1649 strcpy( psz_short, " " );
1652 i = PADDING_SPACES - strlen( p_item->psz_name )
1653 - strlen( psz_bra ) - strlen( psz_type )
1654 - strlen( psz_ket ) - 1;
1656 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1658 psz_prefix = ", --no-";
1659 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1662 if( i < 0 )
1664 psz_spaces[0] = '\n';
1665 i = 0;
1667 else
1669 psz_spaces[i] = '\0';
1672 if( p_item->i_type == CONFIG_ITEM_BOOL && !b_help_module )
1674 utf8_fprintf( stdout, psz_format_bool, psz_short,
1675 p_item->psz_name, psz_prefix, p_item->psz_name,
1676 psz_bra, psz_type, psz_ket, psz_spaces );
1678 else
1680 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1681 "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1684 psz_spaces[i] = ' ';
1686 /* We wrap the rest of the output */
1687 sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1688 psz_suf );
1689 b_description_hack = b_description;
1691 description:
1692 psz_text = psz_buffer;
1693 i_cur_width = b_description && !b_description_hack
1694 ? i_width_description
1695 : i_width;
1696 while( *psz_text )
1698 char *psz_parser, *psz_word;
1699 size_t i_end = strlen( psz_text );
1701 /* If the remaining text fits in a line, print it. */
1702 if( i_end <= i_cur_width )
1704 if( b_color )
1706 if( !b_description || b_description_hack )
1707 utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1708 else
1709 utf8_fprintf( stdout, "%s\n", psz_text );
1711 else
1713 utf8_fprintf( stdout, "%s\n", psz_text );
1715 break;
1718 /* Otherwise, eat as many words as possible */
1719 psz_parser = psz_text;
1722 psz_word = psz_parser;
1723 psz_parser = strchr( psz_word, ' ' );
1724 /* If no space was found, we reached the end of the text
1725 * block; otherwise, we skip the space we just found. */
1726 psz_parser = psz_parser ? psz_parser + 1
1727 : psz_text + i_end;
1729 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1731 /* We cut a word in one of these cases:
1732 * - it's the only word in the line and it's too long.
1733 * - we used less than 80% of the width and the word we are
1734 * going to wrap is longer than 40% of the width, and even
1735 * if the word would have fit in the next line. */
1736 if( psz_word == psz_text
1737 || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1738 && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1740 char c = psz_text[i_cur_width];
1741 psz_text[i_cur_width] = '\0';
1742 if( b_color )
1744 if( !b_description || b_description_hack )
1745 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1746 psz_text, psz_spaces );
1747 else
1748 utf8_fprintf( stdout, "%s\n%s",
1749 psz_text, psz_spaces );
1751 else
1753 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1755 psz_text += i_cur_width;
1756 psz_text[0] = c;
1758 else
1760 psz_word[-1] = '\0';
1761 if( b_color )
1763 if( !b_description || b_description_hack )
1764 utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1765 psz_text, psz_spaces );
1766 else
1767 utf8_fprintf( stdout, "%s\n%s",
1768 psz_text, psz_spaces );
1770 else
1772 utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1774 psz_text = psz_word;
1778 if( b_description_hack && p_item->psz_longtext
1779 && *p_item->psz_longtext )
1781 sprintf( psz_buffer, "%s%s",
1782 module_gettext( p_parser, p_item->psz_longtext ),
1783 psz_suf );
1784 b_description_hack = false;
1785 psz_spaces = psz_spaces_longtext;
1786 utf8_fprintf( stdout, "%s", psz_spaces );
1787 goto description;
1792 if( b_has_advanced )
1794 if( b_color )
1795 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1796 _( "add --advanced to your command line to see advanced options."));
1797 else
1798 utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1799 _( "add --advanced to your command line to see advanced options."));
1802 if( i_only_advanced > 0 )
1804 if( b_color )
1806 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1807 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1809 else
1811 utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1812 utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1815 else if( !b_found )
1817 if( b_color )
1818 utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1819 _( "No matching module found. Use --list or " \
1820 "--list-verbose to list available modules." ) );
1821 else
1822 utf8_fprintf( stdout, "\n%s\n",
1823 _( "No matching module found. Use --list or " \
1824 "--list-verbose to list available modules." ) );
1827 /* Release the module list */
1828 module_list_free (list);
1831 /*****************************************************************************
1832 * ListModules: list the available modules with their description
1833 *****************************************************************************
1834 * Print a list of all available modules (builtins and plugins) and a short
1835 * description for each one.
1836 *****************************************************************************/
1837 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1839 module_t *p_parser;
1841 bool b_color = var_InheritBool( p_this, "color" );
1843 #ifdef WIN32
1844 ShowConsole( true );
1845 b_color = false; // don't put color control codes in a .txt file
1846 #else
1847 if( !isatty( 1 ) )
1848 b_color = false;
1849 #endif
1851 /* List all modules */
1852 module_t **list = module_list_get (NULL);
1854 /* Enumerate each module */
1855 for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1857 if( b_color )
1858 utf8_fprintf( stdout, GREEN" %-22s "WHITE"%s\n"GRAY,
1859 p_parser->psz_object_name,
1860 module_gettext( p_parser, p_parser->psz_longname ) );
1861 else
1862 utf8_fprintf( stdout, " %-22s %s\n",
1863 p_parser->psz_object_name,
1864 module_gettext( p_parser, p_parser->psz_longname ) );
1866 if( b_verbose )
1868 char *const *pp_shortcut = p_parser->pp_shortcuts;
1869 while( *pp_shortcut )
1871 if( strcmp( *pp_shortcut, p_parser->psz_object_name ) )
1873 if( b_color )
1874 utf8_fprintf( stdout, CYAN" s %s\n"GRAY,
1875 *pp_shortcut );
1876 else
1877 utf8_fprintf( stdout, " s %s\n",
1878 *pp_shortcut );
1880 pp_shortcut++;
1882 if( p_parser->psz_capability )
1884 if( b_color )
1885 utf8_fprintf( stdout, MAGENTA" c %s (%d)\n"GRAY,
1886 p_parser->psz_capability,
1887 p_parser->i_score );
1888 else
1889 utf8_fprintf( stdout, " c %s (%d)\n",
1890 p_parser->psz_capability,
1891 p_parser->i_score );
1895 module_list_free (list);
1897 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1898 PauseConsole();
1899 #endif
1902 /*****************************************************************************
1903 * Version: print complete program version
1904 *****************************************************************************
1905 * Print complete program version and build number.
1906 *****************************************************************************/
1907 static void Version( void )
1909 extern const char psz_vlc_changeset[];
1910 #ifdef WIN32
1911 ShowConsole( true );
1912 #endif
1914 utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VLC_Version(),
1915 psz_vlc_changeset );
1916 utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1917 VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1918 utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1919 utf8_fprintf( stdout, "%s", LICENSE_MSG );
1921 #ifdef WIN32 /* Pause the console because it's destroyed when we exit */
1922 PauseConsole();
1923 #endif
1926 /*****************************************************************************
1927 * ShowConsole: On Win32, create an output console for debug messages
1928 *****************************************************************************
1929 * This function is useful only on Win32.
1930 *****************************************************************************/
1931 #ifdef WIN32 /* */
1932 static void ShowConsole( bool b_dofile )
1934 # ifndef UNDER_CE
1935 FILE *f_help = NULL;
1937 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1939 AllocConsole();
1940 /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1941 * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1942 * page (e.g. CP437 or CP850). */
1943 SetConsoleOutputCP (GetACP ());
1944 SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1946 freopen( "CONOUT$", "w", stderr );
1947 freopen( "CONIN$", "r", stdin );
1949 if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1951 fclose( f_help );
1952 freopen( "vlc-help.txt", "wt", stdout );
1953 utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1955 else freopen( "CONOUT$", "w", stdout );
1957 # endif
1959 #endif
1961 /*****************************************************************************
1962 * PauseConsole: On Win32, wait for a key press before closing the console
1963 *****************************************************************************
1964 * This function is useful only on Win32.
1965 *****************************************************************************/
1966 #ifdef WIN32 /* */
1967 static void PauseConsole( void )
1969 # ifndef UNDER_CE
1971 if( getenv( "PWD" ) && getenv( "PS1" ) ) return; /* cygwin shell */
1973 utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1974 getchar();
1975 fclose( stdout );
1977 # endif
1979 #endif
1981 /*****************************************************************************
1982 * ConsoleWidth: Return the console width in characters
1983 *****************************************************************************
1984 * We use the stty shell command to get the console width; if this fails or
1985 * if the width is less than 80, we default to 80.
1986 *****************************************************************************/
1987 static int ConsoleWidth( void )
1989 unsigned i_width = 80;
1991 #ifndef WIN32
1992 FILE *file = popen( "stty size 2>/dev/null", "r" );
1993 if (file != NULL)
1995 if (fscanf (file, "%*u %u", &i_width) <= 0)
1996 i_width = 80;
1997 pclose( file );
1999 #elif !defined (UNDER_CE)
2000 CONSOLE_SCREEN_BUFFER_INFO buf;
2002 if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
2003 i_width = buf.dwSize.X;
2004 #endif
2006 return i_width;
2009 #include <vlc_avcodec.h>
2011 void vlc_avcodec_mutex (bool acquire)
2013 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
2015 if (acquire)
2016 vlc_mutex_lock (&lock);
2017 else
2018 vlc_mutex_unlock (&lock);