]> git.sesse.net Git - vlc/blob - src/libvlc.c
Use module_get_object() where appropriate and improve error handling
[vlc] / src / libvlc.c
1 /*****************************************************************************
2  * libvlc.c: libvlc instances creation and deletion, interfaces handling
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  * $Id$
6  *
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>
12  *
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.
17  *
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.
22  *
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  *****************************************************************************/
27
28 /** \file
29  * This file contains functions to create and destroy libvlc instances
30  */
31
32 /*****************************************************************************
33  * Preamble
34  *****************************************************************************/
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include <vlc_common.h>
40 #include "control/libvlc_internal.h"
41 #include <vlc_input.h>
42
43 #include "modules/modules.h"
44 #include "config/configuration.h"
45
46 #include <stdio.h>                                              /* sprintf() */
47 #include <string.h>
48 #include <stdlib.h>                                                /* free() */
49
50 #ifndef WIN32
51 #   include <netinet/in.h>                            /* BSD: struct in_addr */
52 #endif
53
54 #ifdef HAVE_UNISTD_H
55 #   include <unistd.h>
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
57 #   include <io.h>
58 #endif
59
60 #include "config/vlc_getopt.h"
61
62 #ifdef HAVE_LOCALE_H
63 #   include <locale.h>
64 #endif
65
66 #ifdef HAVE_DBUS
67 /* used for one-instance mode */
68 #   include <dbus/dbus.h>
69 #endif
70
71
72 #include <vlc_media_library.h>
73 #include <vlc_playlist.h>
74 #include <vlc_interface.h>
75
76 #include <vlc_aout.h>
77 #include "audio_output/aout_internal.h"
78
79 #include <vlc_charset.h>
80 #include <vlc_fs.h>
81 #include <vlc_cpu.h>
82 #include <vlc_url.h>
83 #include <vlc_atomic.h>
84 #include <vlc_modules.h>
85
86 #include "libvlc.h"
87
88 #include "playlist/playlist_internal.h"
89
90 #include <vlc_vlm.h>
91
92 #ifdef __APPLE__
93 # include <libkern/OSAtomic.h>
94 #endif
95
96 #include <assert.h>
97
98 /*****************************************************************************
99  * The evil global variables. We handle them with care, don't worry.
100  *****************************************************************************/
101 static unsigned          i_instances = 0;
102
103 #ifndef WIN32
104 static bool b_daemon = false;
105 #endif
106
107 #undef vlc_gc_init
108 #undef vlc_hold
109 #undef vlc_release
110
111 /**
112  * Atomically set the reference count to 1.
113  * @param p_gc reference counted object
114  * @param pf_destruct destruction calback
115  * @return p_gc.
116  */
117 void *vlc_gc_init (gc_object_t *p_gc, void (*pf_destruct) (gc_object_t *))
118 {
119     /* There is no point in using the GC if there is no destructor... */
120     assert (pf_destruct);
121     p_gc->pf_destructor = pf_destruct;
122
123     vlc_atomic_set (&p_gc->refs, 1);
124     return p_gc;
125 }
126
127 /**
128  * Atomically increment the reference count.
129  * @param p_gc reference counted object
130  * @return p_gc.
131  */
132 void *vlc_hold (gc_object_t * p_gc)
133 {
134     uintptr_t refs;
135
136     assert( p_gc );
137     refs = vlc_atomic_inc (&p_gc->refs);
138     assert (refs != 1); /* there had to be a reference already */
139     return p_gc;
140 }
141
142 /**
143  * Atomically decrement the reference count and, if it reaches zero, destroy.
144  * @param p_gc reference counted object.
145  */
146 void vlc_release (gc_object_t *p_gc)
147 {
148     uintptr_t refs;
149
150     assert( p_gc );
151     refs = vlc_atomic_dec (&p_gc->refs);
152     assert (refs != (uintptr_t)(-1)); /* reference underflow?! */
153     if (refs == 0)
154         p_gc->pf_destructor (p_gc);
155 }
156
157 /*****************************************************************************
158  * Local prototypes
159  *****************************************************************************/
160 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
161     ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
162 static void SetLanguage   ( char const * );
163 #endif
164 static void GetFilenames  ( libvlc_int_t *, unsigned, const char *const [] );
165 static void Help          ( libvlc_int_t *, char const *psz_help_name );
166 static void Usage         ( libvlc_int_t *, char const *psz_search );
167 static void ListModules   ( libvlc_int_t *, bool );
168 static void Version       ( void );
169
170 #ifdef WIN32
171 static void ShowConsole   ( bool );
172 static void PauseConsole  ( void );
173 #endif
174 static int  ConsoleWidth  ( void );
175
176 static vlc_mutex_t global_lock = VLC_STATIC_MUTEX;
177 extern const char psz_vlc_changeset[];
178
179 /**
180  * Allocate a libvlc instance, initialize global data if needed
181  * It also initializes the threading system
182  */
183 libvlc_int_t * libvlc_InternalCreate( void )
184 {
185     libvlc_int_t *p_libvlc;
186     libvlc_priv_t *priv;
187     char *psz_env = NULL;
188
189     /* Now that the thread system is initialized, we don't have much, but
190      * at least we have variables */
191     vlc_mutex_lock( &global_lock );
192     if( i_instances == 0 )
193     {
194         /* Guess what CPU we have */
195         cpu_flags = CPUCapabilities();
196         /* The module bank will be initialized later */
197     }
198
199     /* Allocate a libvlc instance object */
200     p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
201                                   "libvlc" );
202     if( p_libvlc != NULL )
203         i_instances++;
204     vlc_mutex_unlock( &global_lock );
205
206     if( p_libvlc == NULL )
207         return NULL;
208
209     priv = libvlc_priv (p_libvlc);
210     priv->p_playlist = NULL;
211     priv->p_ml = NULL;
212     priv->p_dialog_provider = NULL;
213     priv->p_vlm = NULL;
214
215     /* Initialize message queue */
216     priv->msg_bank = msg_Create ();
217     if (unlikely(priv->msg_bank == NULL))
218         goto error;
219
220     /* Find verbosity from VLC_VERBOSE environment variable */
221     psz_env = getenv( "VLC_VERBOSE" );
222     if( psz_env != NULL )
223         priv->i_verbose = atoi( psz_env );
224     else
225         priv->i_verbose = 3;
226 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
227     priv->b_color = isatty( 2 ); /* 2 is for stderr */
228 #else
229     priv->b_color = false;
230 #endif
231
232     /* Initialize mutexes */
233     vlc_mutex_init( &priv->ml_lock );
234     vlc_mutex_init( &priv->timer_lock );
235     vlc_ExitInit( &priv->exit );
236
237     return p_libvlc;
238 error:
239     vlc_object_release (p_libvlc);
240     return NULL;
241 }
242
243 /**
244  * Initialize a libvlc instance
245  * This function initializes a previously allocated libvlc instance:
246  *  - CPU detection
247  *  - gettext initialization
248  *  - message queue, module bank and playlist initialization
249  *  - configuration and commandline parsing
250  */
251 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
252                          const char *ppsz_argv[] )
253 {
254     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
255     char *       p_tmp = NULL;
256     char *       psz_modules = NULL;
257     char *       psz_parser = NULL;
258     char *       psz_control = NULL;
259     bool   b_exit = false;
260     int          i_ret = VLC_EEXIT;
261     playlist_t  *p_playlist = NULL;
262     char        *psz_val;
263 #if defined( ENABLE_NLS ) \
264      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
265 # if defined (WIN32) || defined (__APPLE__)
266     char *       psz_language;
267 #endif
268 #endif
269
270     /* System specific initialization code */
271     system_Init();
272
273     /*
274      * Support for gettext
275      */
276     vlc_bindtextdomain (PACKAGE_NAME);
277
278     /* Initialize the module bank and load the configuration of the
279      * main module. We need to do this at this stage to be able to display
280      * a short help if required by the user. (short help == main module
281      * options) */
282     module_InitBank( p_libvlc );
283
284     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
285     {
286         module_EndBank( p_libvlc, false );
287         return VLC_EGENERIC;
288     }
289
290     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
291     /* Announce who we are - Do it only for first instance ? */
292     msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
293     msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
294     msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
295     msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
296     /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
297     msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
298
299     /* Check for short help option */
300     if( var_InheritBool( p_libvlc, "help" ) )
301     {
302         Help( p_libvlc, "help" );
303         b_exit = true;
304         i_ret = VLC_EEXITSUCCESS;
305     }
306     /* Check for version option */
307     else if( var_InheritBool( p_libvlc, "version" ) )
308     {
309         Version();
310         b_exit = true;
311         i_ret = VLC_EEXITSUCCESS;
312     }
313
314     /* Check for daemon mode */
315 #if !defined( WIN32 ) && !defined( __SYMBIAN32__ )
316     if( var_InheritBool( p_libvlc, "daemon" ) )
317     {
318 #ifdef HAVE_DAEMON
319         char *psz_pidfile = NULL;
320
321         if( daemon( 1, 0) != 0 )
322         {
323             msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
324             b_exit = true;
325         }
326         b_daemon = true;
327
328         /* lets check if we need to write the pidfile */
329         psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
330         if( psz_pidfile != NULL )
331         {
332             FILE *pidfile;
333             pid_t i_pid = getpid ();
334             msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
335                                i_pid, psz_pidfile );
336             pidfile = vlc_fopen( psz_pidfile,"w" );
337             if( pidfile != NULL )
338             {
339                 utf8_fprintf( pidfile, "%d", (int)i_pid );
340                 fclose( pidfile );
341             }
342             else
343             {
344                 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
345                          psz_pidfile );
346             }
347         }
348         free( psz_pidfile );
349
350 #else
351         pid_t i_pid;
352
353         if( ( i_pid = fork() ) < 0 )
354         {
355             msg_Err( p_libvlc, "unable to fork vlc to daemon mode" );
356             b_exit = true;
357         }
358         else if( i_pid )
359         {
360             /* This is the parent, exit right now */
361             msg_Dbg( p_libvlc, "closing parent process" );
362             b_exit = true;
363             i_ret = VLC_EEXITSUCCESS;
364         }
365         else
366         {
367             /* We are the child */
368             msg_Dbg( p_libvlc, "daemon spawned" );
369             close( STDIN_FILENO );
370             close( STDOUT_FILENO );
371             close( STDERR_FILENO );
372
373             b_daemon = true;
374         }
375 #endif
376     }
377 #endif
378
379     if( b_exit )
380     {
381         module_EndBank( p_libvlc, false );
382         return i_ret;
383     }
384
385     /* Check for translation config option */
386 #if defined( ENABLE_NLS ) \
387      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
388 # if defined (WIN32) || defined (__APPLE__)
389     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
390         config_LoadConfigFile( p_libvlc );
391     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
392
393     /* Check if the user specified a custom language */
394     psz_language = var_CreateGetNonEmptyString( p_libvlc, "language" );
395     if( psz_language && strcmp( psz_language, "auto" ) )
396     {
397         /* Reset the default domain */
398         SetLanguage( psz_language );
399
400         /* Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
401         msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
402     }
403     free( psz_language );
404 # endif
405 #endif
406
407     /*
408      * Load the builtins and plugins into the module_bank.
409      * We have to do it before config_Load*() because this also gets the
410      * list of configuration options exported by each module and loads their
411      * default values.
412      */
413     module_LoadPlugins( p_libvlc );
414     if( p_libvlc->b_die )
415     {
416         b_exit = true;
417     }
418
419     size_t module_count;
420     module_t **list = module_list_get( &module_count );
421     module_list_free( list );
422     msg_Dbg( p_libvlc, "module bank initialized (%zu modules)", module_count );
423
424     /* Check for help on modules */
425     if( (p_tmp = var_InheritString( p_libvlc, "module" )) )
426     {
427         Help( p_libvlc, p_tmp );
428         free( p_tmp );
429         b_exit = true;
430         i_ret = VLC_EEXITSUCCESS;
431     }
432     /* Check for full help option */
433     else if( var_InheritBool( p_libvlc, "full-help" ) )
434     {
435         var_Create( p_libvlc, "advanced", VLC_VAR_BOOL );
436         var_SetBool( p_libvlc, "advanced", true );
437         var_Create( p_libvlc, "help-verbose", VLC_VAR_BOOL );
438         var_SetBool( p_libvlc, "help-verbose", true );
439         Help( p_libvlc, "full-help" );
440         b_exit = true;
441         i_ret = VLC_EEXITSUCCESS;
442     }
443     /* Check for long help option */
444     else if( var_InheritBool( p_libvlc, "longhelp" ) )
445     {
446         Help( p_libvlc, "longhelp" );
447         b_exit = true;
448         i_ret = VLC_EEXITSUCCESS;
449     }
450     /* Check for module list option */
451     else if( var_InheritBool( p_libvlc, "list" ) )
452     {
453         ListModules( p_libvlc, false );
454         b_exit = true;
455         i_ret = VLC_EEXITSUCCESS;
456     }
457     else if( var_InheritBool( p_libvlc, "list-verbose" ) )
458     {
459         ListModules( p_libvlc, true );
460         b_exit = true;
461         i_ret = VLC_EEXITSUCCESS;
462     }
463
464     if( module_count <= 1 )
465     {
466         msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
467         b_exit = true;
468         i_ret = VLC_ENOITEM;
469     }
470
471     if( b_exit )
472     {
473         module_EndBank( p_libvlc, true );
474         return i_ret;
475     }
476
477     /*
478      * Override default configuration with config file settings
479      */
480     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
481     {
482         if( var_InheritBool( p_libvlc, "reset-config" ) )
483         {
484             config_ResetAll( p_libvlc );
485             config_SaveConfigFile( p_libvlc );
486         }
487         else
488             config_LoadConfigFile( p_libvlc );
489     }
490
491     /*
492      * Override configuration with command line settings
493      */
494     int vlc_optind;
495     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
496     {
497 #ifdef WIN32
498         ShowConsole( false );
499         /* Pause the console because it's destroyed when we exit */
500         fprintf( stderr, "The command line options couldn't be loaded, check "
501                  "that they are valid.\n" );
502         PauseConsole();
503 #endif
504         module_EndBank( p_libvlc, true );
505         return VLC_EGENERIC;
506     }
507     priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
508
509 /* FIXME: could be replaced by using Unix sockets */
510 #ifdef HAVE_DBUS
511     dbus_threads_init_default();
512
513     if( var_InheritBool( p_libvlc, "one-instance" )
514     || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
515       && var_InheritBool( p_libvlc, "started-from-file" ) ) )
516     {
517         /* Initialise D-Bus interface, check for other instances */
518         DBusConnection  *p_conn = NULL;
519         DBusError       dbus_error;
520
521         dbus_error_init( &dbus_error );
522
523         /* connect to the session bus */
524         p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
525         if( !p_conn )
526         {
527             msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
528                     dbus_error.message );
529             dbus_error_free( &dbus_error );
530         }
531         else
532         {
533             /* check if VLC is available on the bus
534              * if not: D-Bus control is not enabled on the other
535              * instance and we can't pass MRLs to it */
536             DBusMessage *p_test_msg   = NULL;
537             DBusMessage *p_test_reply = NULL;
538
539             p_test_msg =  dbus_message_new_method_call(
540                     "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
541                     "org.freedesktop.DBus.Introspectable", "Introspect" );
542
543             /* block until a reply arrives */
544             p_test_reply = dbus_connection_send_with_reply_and_block(
545                     p_conn, p_test_msg, -1, &dbus_error );
546             dbus_message_unref( p_test_msg );
547             if( p_test_reply == NULL )
548             {
549                 dbus_error_free( &dbus_error );
550                 msg_Dbg( p_libvlc, "No Media Player is running. "
551                         "Continuing normally." );
552             }
553             else
554             {
555                 int i_input;
556                 DBusMessage* p_dbus_msg = NULL;
557                 DBusMessageIter dbus_args;
558                 DBusPendingCall* p_dbus_pending = NULL;
559                 dbus_bool_t b_play;
560
561                 dbus_message_unref( p_test_reply );
562                 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
563
564                 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
565                 {
566                     /* Skip input options, we can't pass them through D-Bus */
567                     if( ppsz_argv[i_input][0] == ':' )
568                     {
569                         msg_Warn( p_libvlc, "Ignoring option %s",
570                                   ppsz_argv[i_input] );
571                         continue;
572                     }
573
574                     /* We need to resolve relative paths in this instance */
575                     char *psz_mrl = make_URI( ppsz_argv[i_input], NULL );
576                     const char *psz_after_track = "/";
577
578                     if( psz_mrl == NULL )
579                         continue;
580                     msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
581                              psz_mrl );
582
583                     p_dbus_msg = dbus_message_new_method_call(
584                         "org.mpris.MediaPlayer2.vlc", "/org/mpris/MediaPlayer2",
585                         "org.mpris.MediaPlayer2.TrackList", "AddTrack" );
586
587                     if ( NULL == p_dbus_msg )
588                     {
589                         msg_Err( p_libvlc, "D-Bus problem" );
590                         free( psz_mrl );
591                         system_End( p_libvlc );
592                         exit( 1 );
593                     }
594
595                     /* append MRLs */
596                     dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
597                     if ( !dbus_message_iter_append_basic( &dbus_args,
598                                 DBUS_TYPE_STRING, &psz_mrl ) )
599                     {
600                         dbus_message_unref( p_dbus_msg );
601                         free( psz_mrl );
602                         system_End( p_libvlc );
603                         exit( 1 );
604                     }
605                     free( psz_mrl );
606
607                     if( !dbus_message_iter_append_basic( &dbus_args,
608                                 DBUS_TYPE_OBJECT_PATH, &psz_after_track ) )
609                     {
610                         dbus_message_unref( p_dbus_msg );
611                         system_End( p_libvlc );
612                         exit( 1 );
613                     }
614
615                     b_play = TRUE;
616                     if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
617                         b_play = FALSE;
618
619                     if ( !dbus_message_iter_append_basic( &dbus_args,
620                                 DBUS_TYPE_BOOLEAN, &b_play ) )
621                     {
622                         dbus_message_unref( p_dbus_msg );
623                         system_End( p_libvlc );
624                         exit( 1 );
625                     }
626
627                     /* send message and get a handle for a reply */
628                     if ( !dbus_connection_send_with_reply ( p_conn,
629                                 p_dbus_msg, &p_dbus_pending, -1 ) )
630                     {
631                         msg_Err( p_libvlc, "D-Bus problem" );
632                         dbus_message_unref( p_dbus_msg );
633                         system_End( p_libvlc );
634                         exit( 1 );
635                     }
636
637                     if ( NULL == p_dbus_pending )
638                     {
639                         msg_Err( p_libvlc, "D-Bus problem" );
640                         dbus_message_unref( p_dbus_msg );
641                         system_End( p_libvlc );
642                         exit( 1 );
643                     }
644                     dbus_connection_flush( p_conn );
645                     dbus_message_unref( p_dbus_msg );
646                     /* block until we receive a reply */
647                     dbus_pending_call_block( p_dbus_pending );
648                     dbus_pending_call_unref( p_dbus_pending );
649                 } /* processes all command line MRLs */
650
651                 /* bye bye */
652                 system_End( p_libvlc );
653                 exit( 0 );
654             }
655         }
656         /* we unreference the connection when we've finished with it */
657         if( p_conn ) dbus_connection_unref( p_conn );
658     }
659 #endif
660
661     /*
662      * Message queue options
663      */
664     char * psz_verbose_objects = var_CreateGetNonEmptyString( p_libvlc, "verbose-objects" );
665     if( psz_verbose_objects )
666     {
667         char * psz_object, * iter = psz_verbose_objects;
668         while( (psz_object = strsep( &iter, "," )) )
669         {
670             switch( psz_object[0] )
671             {
672                 printf("%s\n", psz_object+1);
673                 case '+': msg_EnableObjectPrinting(p_libvlc, psz_object+1); break;
674                 case '-': msg_DisableObjectPrinting(p_libvlc, psz_object+1); break;
675                 default:
676                     msg_Err( p_libvlc, "verbose-objects usage: \n"
677                             "--verbose-objects=+printthatobject,"
678                             "-dontprintthatone\n"
679                             "(keyword 'all' to applies to all objects)");
680                     free( psz_verbose_objects );
681                     /* FIXME: leaks!!!! */
682                     return VLC_EGENERIC;
683             }
684         }
685         free( psz_verbose_objects );
686     }
687
688     /* Last chance to set the verbosity. Once we start interfaces and other
689      * threads, verbosity becomes read-only. */
690     var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
691     if( var_InheritBool( p_libvlc, "quiet" ) )
692     {
693         var_SetInteger( p_libvlc, "verbose", -1 );
694         priv->i_verbose = -1;
695     }
696     vlc_threads_setup( p_libvlc );
697
698     if( priv->b_color )
699         priv->b_color = var_InheritBool( p_libvlc, "color" );
700
701     char p_capabilities[200];
702 #define PRINT_CAPABILITY( capability, string )                              \
703     if( vlc_CPU() & capability )                                            \
704     {                                                                       \
705         strncat( p_capabilities, string " ",                                \
706                  sizeof(p_capabilities) - strlen(p_capabilities) );         \
707         p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
708     }
709     p_capabilities[0] = '\0';
710
711 #if defined( __i386__ ) || defined( __x86_64__ )
712     if( !var_InheritBool( p_libvlc, "mmx" ) )
713         cpu_flags &= ~CPU_CAPABILITY_MMX;
714     if( !var_InheritBool( p_libvlc, "3dn" ) )
715         cpu_flags &= ~CPU_CAPABILITY_3DNOW;
716     if( !var_InheritBool( p_libvlc, "mmxext" ) )
717         cpu_flags &= ~CPU_CAPABILITY_MMXEXT;
718     if( !var_InheritBool( p_libvlc, "sse" ) )
719         cpu_flags &= ~CPU_CAPABILITY_SSE;
720     if( !var_InheritBool( p_libvlc, "sse2" ) )
721         cpu_flags &= ~CPU_CAPABILITY_SSE2;
722     if( !var_InheritBool( p_libvlc, "sse3" ) )
723         cpu_flags &= ~CPU_CAPABILITY_SSE3;
724     if( !var_InheritBool( p_libvlc, "ssse3" ) )
725         cpu_flags &= ~CPU_CAPABILITY_SSSE3;
726     if( !var_InheritBool( p_libvlc, "sse41" ) )
727         cpu_flags &= ~CPU_CAPABILITY_SSE4_1;
728     if( !var_InheritBool( p_libvlc, "sse42" ) )
729         cpu_flags &= ~CPU_CAPABILITY_SSE4_2;
730
731     PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
732     PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
733     PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
734     PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
735     PRINT_CAPABILITY( CPU_CAPABILITY_SSE2, "SSE2" );
736     PRINT_CAPABILITY( CPU_CAPABILITY_SSE3, "SSE3" );
737     PRINT_CAPABILITY( CPU_CAPABILITY_SSSE3, "SSSE3" );
738     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_1, "SSE4.1" );
739     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4_2, "SSE4.2" );
740     PRINT_CAPABILITY( CPU_CAPABILITY_SSE4A,  "SSE4A" );
741
742 #elif defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
743     if( !var_InheritBool( p_libvlc, "altivec" ) )
744         cpu_flags &= ~CPU_CAPABILITY_ALTIVEC;
745
746     PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
747
748 #elif defined( __arm__ )
749     PRINT_CAPABILITY( CPU_CAPABILITY_NEON, "NEONv1" );
750
751 #endif
752
753 #if HAVE_FPU
754     strncat( p_capabilities, "FPU ",
755              sizeof(p_capabilities) - strlen( p_capabilities) );
756     p_capabilities[sizeof(p_capabilities) - 1] = '\0';
757 #endif
758
759     if (p_capabilities[0])
760         msg_Dbg( p_libvlc, "CPU has capabilities %s", p_capabilities );
761
762     /*
763      * Choose the best memcpy module
764      */
765     priv->p_memcpy_module = module_need( p_libvlc, "memcpy", "$memcpy", false );
766     /* Avoid being called "memcpy":*/
767     vlc_object_set_name( p_libvlc, "main" );
768
769     priv->b_stats = var_InheritBool( p_libvlc, "stats" );
770     priv->i_timers = 0;
771     priv->pp_timers = NULL;
772
773     /*
774      * Initialize hotkey handling
775      */
776     priv->actions = vlc_InitActions( p_libvlc );
777
778     /* Create a variable for showing the fullscreen interface */
779     var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
780     var_SetBool( p_libvlc, "intf-show", true );
781
782     /* Create a variable for showing the right click menu */
783     var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
784
785     /* variables for signalling creation of new files */
786     var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
787     var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
788
789     /* some default internal settings */
790     var_Create( p_libvlc, "window", VLC_VAR_STRING );
791     var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
792     var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
793
794     /* Initialize playlist and get commandline files */
795     p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
796     if( !p_playlist )
797     {
798         msg_Err( p_libvlc, "playlist initialization failed" );
799         if( priv->p_memcpy_module != NULL )
800         {
801             module_unneed( p_libvlc, priv->p_memcpy_module );
802         }
803         module_EndBank( p_libvlc, true );
804         return VLC_EGENERIC;
805     }
806
807     /* System specific configuration */
808     system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
809
810 #if defined(MEDIA_LIBRARY)
811     /* Get the ML */
812     if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
813     {
814         priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
815         if( !priv->p_ml )
816         {
817             msg_Err( p_libvlc, "ML initialization failed" );
818             return VLC_EGENERIC;
819         }
820     }
821     else
822     {
823         priv->p_ml = NULL;
824     }
825 #endif
826
827     /* Add service discovery modules */
828     psz_modules = var_InheritString( p_libvlc, "services-discovery" );
829     if( psz_modules )
830     {
831         char *p = psz_modules, *m;
832         while( ( m = strsep( &p, " :," ) ) != NULL )
833             playlist_ServicesDiscoveryAdd( p_playlist, m );
834         free( psz_modules );
835     }
836
837 #ifdef ENABLE_VLM
838     /* Initialize VLM if vlm-conf is specified */
839     psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
840     if( psz_parser )
841     {
842         priv->p_vlm = vlm_New( p_libvlc );
843         if( !priv->p_vlm )
844             msg_Err( p_libvlc, "VLM initialization failed" );
845     }
846     free( psz_parser );
847 #endif
848
849     /*
850      * Load background interfaces
851      */
852     psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
853     psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
854
855     if( psz_modules && psz_control )
856     {
857         char* psz_tmp;
858         if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
859         {
860             free( psz_modules );
861             psz_modules = psz_tmp;
862         }
863     }
864     else if( psz_control )
865     {
866         free( psz_modules );
867         psz_modules = strdup( psz_control );
868     }
869
870     psz_parser = psz_modules;
871     while ( psz_parser && *psz_parser )
872     {
873         char *psz_module, *psz_temp;
874         psz_module = psz_parser;
875         psz_parser = strchr( psz_module, ':' );
876         if ( psz_parser )
877         {
878             *psz_parser = '\0';
879             psz_parser++;
880         }
881         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
882         {
883             intf_Create( p_libvlc, psz_temp );
884             free( psz_temp );
885         }
886     }
887     free( psz_modules );
888     free( psz_control );
889
890     /*
891      * Always load the hotkeys interface if it exists
892      */
893     intf_Create( p_libvlc, "hotkeys,none" );
894
895 #ifdef HAVE_DBUS
896     /* loads dbus control interface if in one-instance mode
897      * we do it only when playlist exists, because dbus module needs it */
898     if( var_InheritBool( p_libvlc, "one-instance" )
899      || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
900        && var_InheritBool( p_libvlc, "started-from-file" ) ) )
901         intf_Create( p_libvlc, "dbus,none" );
902
903 # if !defined (HAVE_MAEMO)
904     /* Prevents the power management daemon from suspending the system
905      * when VLC is active */
906     if( var_InheritBool( p_libvlc, "inhibit" ) > 0 )
907         intf_Create( p_libvlc, "inhibit,none" );
908 # endif
909 #endif
910
911     if( var_InheritBool( p_libvlc, "file-logging" ) &&
912         !var_InheritBool( p_libvlc, "syslog" ) )
913     {
914         intf_Create( p_libvlc, "logger,none" );
915     }
916 #ifdef HAVE_SYSLOG_H
917     if( var_InheritBool( p_libvlc, "syslog" ) )
918     {
919         char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
920         var_SetString( p_libvlc, "logmode", "syslog" );
921         intf_Create( p_libvlc, "logger,none" );
922
923         if( logmode )
924         {
925             var_SetString( p_libvlc, "logmode", logmode );
926             free( logmode );
927         }
928         var_Destroy( p_libvlc, "logmode" );
929     }
930 #endif
931
932     if( var_InheritBool( p_libvlc, "network-synchronisation") )
933     {
934         intf_Create( p_libvlc, "netsync,none" );
935     }
936
937 #ifdef __APPLE__
938     var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
939     var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
940     var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
941     var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
942     var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
943     var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
944     var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
945     var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
946     var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
947 #endif
948 #ifdef WIN32
949     var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
950 #endif
951
952     /*
953      * Get input filenames given as commandline arguments.
954      * We assume that the remaining parameters are filenames
955      * and their input options.
956      */
957     GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
958
959     /*
960      * Get --open argument
961      */
962     psz_val = var_InheritString( p_libvlc, "open" );
963     if ( psz_val != NULL )
964     {
965         playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
966                          -1, 0, NULL, 0, true, pl_Unlocked );
967         free( psz_val );
968     }
969
970     return VLC_SUCCESS;
971 }
972
973 /**
974  * Cleanup a libvlc instance. The instance is not completely deallocated
975  * \param p_libvlc the instance to clean
976  */
977 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
978 {
979     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
980     playlist_t    *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
981
982     /* Deactivate the playlist */
983     msg_Dbg( p_libvlc, "deactivating the playlist" );
984     pl_Deactivate( p_libvlc );
985
986     /* Remove all services discovery */
987     msg_Dbg( p_libvlc, "removing all services discovery tasks" );
988     playlist_ServicesDiscoveryKillAll( p_playlist );
989
990     /* Ask the interfaces to stop and destroy them */
991     msg_Dbg( p_libvlc, "removing all interfaces" );
992     libvlc_Quit( p_libvlc );
993     intf_DestroyAll( p_libvlc );
994
995 #ifdef ENABLE_VLM
996     /* Destroy VLM if created in libvlc_InternalInit */
997     if( priv->p_vlm )
998     {
999         vlm_Delete( priv->p_vlm );
1000     }
1001 #endif
1002
1003 #if defined(MEDIA_LIBRARY)
1004     media_library_t* p_ml = priv->p_ml;
1005     if( p_ml )
1006     {
1007         ml_Destroy( VLC_OBJECT( p_ml ) );
1008         vlc_object_release( p_ml );
1009         libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
1010     }
1011 #endif
1012
1013     /* Free playlist now, all threads are gone */
1014     playlist_Destroy( p_playlist );
1015     stats_TimersDumpAll( p_libvlc );
1016     stats_TimersCleanAll( p_libvlc );
1017
1018     msg_Dbg( p_libvlc, "removing stats" );
1019
1020 #ifndef WIN32
1021     char* psz_pidfile = NULL;
1022
1023     if( b_daemon )
1024     {
1025         psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
1026         if( psz_pidfile != NULL )
1027         {
1028             msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
1029             if( unlink( psz_pidfile ) == -1 )
1030             {
1031                 msg_Dbg( p_libvlc, "removing pid file %s: %m",
1032                         psz_pidfile );
1033             }
1034         }
1035         free( psz_pidfile );
1036     }
1037 #endif
1038
1039     if( priv->p_memcpy_module )
1040     {
1041         module_unneed( p_libvlc, priv->p_memcpy_module );
1042         priv->p_memcpy_module = NULL;
1043     }
1044
1045     /* Save the configuration */
1046     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
1047         config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
1048
1049     /* Free module bank. It is refcounted, so we call this each time  */
1050     module_EndBank( p_libvlc, true );
1051
1052     vlc_DeinitActions( p_libvlc, priv->actions );
1053 }
1054
1055 /**
1056  * Destroy everything.
1057  * This function requests the running threads to finish, waits for their
1058  * termination, and destroys their structure.
1059  * It stops the thread systems: no instance can run after this has run
1060  * \param p_libvlc the instance to destroy
1061  */
1062 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
1063 {
1064     libvlc_priv_t *priv = libvlc_priv( p_libvlc );
1065
1066     vlc_mutex_lock( &global_lock );
1067     i_instances--;
1068
1069     if( i_instances == 0 )
1070     {
1071         /* System specific cleaning code */
1072         system_End( p_libvlc );
1073     }
1074     vlc_mutex_unlock( &global_lock );
1075
1076     msg_Destroy (priv->msg_bank);
1077
1078     /* Destroy mutexes */
1079     vlc_ExitDestroy( &priv->exit );
1080     vlc_mutex_destroy( &priv->timer_lock );
1081     vlc_mutex_destroy( &priv->ml_lock );
1082
1083 #ifndef NDEBUG /* Hack to dump leaked objects tree */
1084     if( vlc_internals( p_libvlc )->i_refcount > 1 )
1085         while( vlc_internals( p_libvlc )->i_refcount > 0 )
1086             vlc_object_release( p_libvlc );
1087 #endif
1088
1089     assert( vlc_internals( p_libvlc )->i_refcount == 1 );
1090     vlc_object_release( p_libvlc );
1091 }
1092
1093 /**
1094  * Add an interface plugin and run it
1095  */
1096 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
1097 {
1098     if( !p_libvlc )
1099         return VLC_EGENERIC;
1100
1101     if( !psz_module ) /* requesting the default interface */
1102     {
1103         char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
1104         if( !psz_interface ) /* "intf" has not been set */
1105         {
1106 #ifndef WIN32
1107             if( b_daemon )
1108                  /* Daemon mode hack.
1109                   * We prefer the dummy interface if none is specified. */
1110                 psz_module = "dummy";
1111             else
1112 #endif
1113                 msg_Info( p_libvlc, "%s",
1114                           _("Running vlc with the default interface. "
1115                             "Use 'cvlc' to use vlc without interface.") );
1116         }
1117         free( psz_interface );
1118         var_Destroy( p_libvlc, "intf" );
1119     }
1120
1121     /* Try to create the interface */
1122     int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
1123     if( ret )
1124         msg_Err( p_libvlc, "interface \"%s\" initialization failed",
1125                  psz_module ? psz_module : "default" );
1126     return ret;
1127 }
1128
1129 #if defined( ENABLE_NLS ) && (defined (__APPLE__) || defined (WIN32)) && \
1130     ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
1131 /*****************************************************************************
1132  * SetLanguage: set the interface language.
1133  *****************************************************************************
1134  * We set the LC_MESSAGES locale category for interface messages and buttons,
1135  * as well as the LC_CTYPE category for string sorting and possible wide
1136  * character support.
1137  *****************************************************************************/
1138 static void SetLanguage ( const char *psz_lang )
1139 {
1140 #ifdef __APPLE__
1141     /* I need that under Darwin, please check it doesn't disturb
1142      * other platforms. --Meuuh */
1143     setenv( "LANG", psz_lang, 1 );
1144
1145 #else
1146     /* We set LC_ALL manually because it is the only way to set
1147      * the language at runtime under eg. Windows. Beware that this
1148      * makes the environment unconsistent when libvlc is unloaded and
1149      * should probably be moved to a safer place like vlc.c. */
1150     setenv( "LC_ALL", psz_lang, 1 );
1151
1152 #endif
1153
1154     setlocale( LC_ALL, psz_lang );
1155 }
1156 #endif
1157
1158 /*****************************************************************************
1159  * GetFilenames: parse command line options which are not flags
1160  *****************************************************************************
1161  * Parse command line for input files as well as their associated options.
1162  * An option always follows its associated input and begins with a ":".
1163  *****************************************************************************/
1164 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
1165                           const char *const args[] )
1166 {
1167     while( n > 0 )
1168     {
1169         /* Count the input options */
1170         unsigned i_options = 0;
1171
1172         while( args[--n][0] == ':' )
1173         {
1174             i_options++;
1175             if( n == 0 )
1176             {
1177                 msg_Warn( p_vlc, "options %s without item", args[n] );
1178                 return; /* syntax!? */
1179             }
1180         }
1181
1182         char *mrl = make_URI( args[n], NULL );
1183         if( !mrl )
1184             continue;
1185
1186         playlist_AddExt( pl_Get( p_vlc ), mrl, NULL, PLAYLIST_INSERT,
1187                 0, -1, i_options, ( i_options ? &args[n + 1] : NULL ),
1188                 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );
1189         free( mrl );
1190     }
1191 }
1192
1193 /*****************************************************************************
1194  * Help: print program help
1195  *****************************************************************************
1196  * Print a short inline help. Message interface is initialized at this stage.
1197  *****************************************************************************/
1198 static inline void print_help_on_full_help( void )
1199 {
1200     utf8_fprintf( stdout, "\n" );
1201     utf8_fprintf( stdout, "%s\n", _("To get exhaustive help, use '-H'.") );
1202 }
1203
1204 static const char vlc_usage[] = N_(
1205                             "Usage: %s [options] [stream] ..."
1206                             "\nYou can specify multiple streams on the commandline. They will be enqueued in the playlist."
1207                             "\nThe first item specified will be played first."
1208                             "\n"
1209                             "\nOptions-styles:"
1210                             "\n  --option  A global option that is set for the duration of the program."
1211                             "\n   -option  A single letter version of a global --option."
1212                             "\n   :option  An option that only applies to the stream directly before it"
1213                             "\n            and that overrides previous settings."
1214                             "\n"
1215                             "\nStream MRL syntax:"
1216                             "\n  [[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]"
1217                             "\n"
1218                             "\n  Many of the global --options can also be used as MRL specific :options."
1219                             "\n  Multiple :option=value pairs can be specified."
1220                             "\n"
1221                             "\nURL syntax:"
1222                             "\n  [file://]filename              Plain media file"
1223                             "\n  http://ip:port/file            HTTP URL"
1224                             "\n  ftp://ip:port/file             FTP URL"
1225                             "\n  mms://ip:port/file             MMS URL"
1226                             "\n  screen://                      Screen capture"
1227                             "\n  [dvd://][device][@raw_device]  DVD device"
1228                             "\n  [vcd://][device]               VCD device"
1229                             "\n  [cdda://][device]              Audio CD device"
1230                             "\n  udp://[[<source address>]@[<bind address>][:<bind port>]]"
1231                             "\n                                 UDP stream sent by a streaming server"
1232                             "\n  vlc://pause:<seconds>          Special item to pause the playlist for a certain time"
1233                             "\n  vlc://quit                     Special item to quit VLC"
1234                             "\n");
1235
1236 static void Help( libvlc_int_t *p_this, char const *psz_help_name )
1237 {
1238 #ifdef WIN32
1239     ShowConsole( true );
1240 #endif
1241
1242     if( psz_help_name && !strcmp( psz_help_name, "help" ) )
1243     {
1244         utf8_fprintf( stdout, vlc_usage, "vlc" );
1245         Usage( p_this, "=help" );
1246         Usage( p_this, "=main" );
1247         print_help_on_full_help();
1248     }
1249     else if( psz_help_name && !strcmp( psz_help_name, "longhelp" ) )
1250     {
1251         utf8_fprintf( stdout, vlc_usage, "vlc" );
1252         Usage( p_this, NULL );
1253         print_help_on_full_help();
1254     }
1255     else if( psz_help_name && !strcmp( psz_help_name, "full-help" ) )
1256     {
1257         utf8_fprintf( stdout, vlc_usage, "vlc" );
1258         Usage( p_this, NULL );
1259     }
1260     else if( psz_help_name )
1261     {
1262         Usage( p_this, psz_help_name );
1263     }
1264
1265 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1266     PauseConsole();
1267 #endif
1268     fflush( stdout );
1269 }
1270
1271 /*****************************************************************************
1272  * Usage: print module usage
1273  *****************************************************************************
1274  * Print a short inline help. Message interface is initialized at this stage.
1275  *****************************************************************************/
1276 #   define COL(x)  "\033[" #x ";1m"
1277 #   define RED     COL(31)
1278 #   define GREEN   COL(32)
1279 #   define YELLOW  COL(33)
1280 #   define BLUE    COL(34)
1281 #   define MAGENTA COL(35)
1282 #   define CYAN    COL(36)
1283 #   define WHITE   COL(0)
1284 #   define GRAY    "\033[0m"
1285 static void
1286 print_help_section( const module_t *m, const module_config_t *p_item,
1287                     bool b_color, bool b_description )
1288 {
1289     if( !p_item ) return;
1290     if( b_color )
1291     {
1292         utf8_fprintf( stdout, RED"   %s:\n"GRAY,
1293                       module_gettext( m, p_item->psz_text ) );
1294         if( b_description && p_item->psz_longtext )
1295             utf8_fprintf( stdout, MAGENTA"   %s\n"GRAY,
1296                           module_gettext( m, p_item->psz_longtext ) );
1297     }
1298     else
1299     {
1300         utf8_fprintf( stdout, "   %s:\n",
1301                       module_gettext( m, p_item->psz_text ) );
1302         if( b_description && p_item->psz_longtext )
1303             utf8_fprintf( stdout, "   %s\n",
1304                           module_gettext(m, p_item->psz_longtext ) );
1305     }
1306 }
1307
1308 static void Usage( libvlc_int_t *p_this, char const *psz_search )
1309 {
1310 #define FORMAT_STRING "  %s --%s%s%s%s%s%s%s "
1311     /* short option ------'    | | | | | | |
1312      * option name ------------' | | | | | |
1313      * <bra ---------------------' | | | | |
1314      * option type or "" ----------' | | | |
1315      * ket> -------------------------' | | |
1316      * padding spaces -----------------' | |
1317      * comment --------------------------' |
1318      * comment suffix ---------------------'
1319      *
1320      * The purpose of having bra and ket is that we might i18n them as well.
1321      */
1322
1323 #define COLOR_FORMAT_STRING (WHITE"  %s --%s"YELLOW"%s%s%s%s%s%s "GRAY)
1324 #define COLOR_FORMAT_STRING_BOOL (WHITE"  %s --%s%s%s%s%s%s%s "GRAY)
1325
1326 #define LINE_START 8
1327 #define PADDING_SPACES 25
1328 #ifdef WIN32
1329 #   define OPTION_VALUE_SEP "="
1330 #else
1331 #   define OPTION_VALUE_SEP " "
1332 #endif
1333     char psz_spaces_text[PADDING_SPACES+LINE_START+1];
1334     char psz_spaces_longtext[LINE_START+3];
1335     char psz_format[sizeof(COLOR_FORMAT_STRING)];
1336     char psz_format_bool[sizeof(COLOR_FORMAT_STRING_BOOL)];
1337     char psz_buffer[10000];
1338     char psz_short[4];
1339     int i_width = ConsoleWidth() - (PADDING_SPACES+LINE_START+1);
1340     int i_width_description = i_width + PADDING_SPACES - 1;
1341     bool b_advanced    = var_InheritBool( p_this, "advanced" );
1342     bool b_description = var_InheritBool( p_this, "help-verbose" );
1343     bool b_description_hack;
1344     bool b_color       = var_InheritBool( p_this, "color" );
1345     bool b_has_advanced = false;
1346     bool b_found       = false;
1347     int  i_only_advanced = 0; /* Number of modules ignored because they
1348                                * only have advanced options */
1349     bool b_strict = psz_search && *psz_search == '=';
1350     if( b_strict ) psz_search++;
1351
1352     memset( psz_spaces_text, ' ', PADDING_SPACES+LINE_START );
1353     psz_spaces_text[PADDING_SPACES+LINE_START] = '\0';
1354     memset( psz_spaces_longtext, ' ', LINE_START+2 );
1355     psz_spaces_longtext[LINE_START+2] = '\0';
1356 #ifndef WIN32
1357     if( !isatty( 1 ) )
1358 #endif
1359         b_color = false; // don't put color control codes in a .txt file
1360
1361     if( b_color )
1362     {
1363         strcpy( psz_format, COLOR_FORMAT_STRING );
1364         strcpy( psz_format_bool, COLOR_FORMAT_STRING_BOOL );
1365     }
1366     else
1367     {
1368         strcpy( psz_format, FORMAT_STRING );
1369         strcpy( psz_format_bool, FORMAT_STRING );
1370     }
1371
1372     /* List all modules */
1373     module_t **list = module_list_get (NULL);
1374     if (!list)
1375         return;
1376
1377     /* Ugly hack to make sure that the help options always come first
1378      * (part 1) */
1379     if( !psz_search )
1380         Usage( p_this, "help" );
1381
1382     /* Enumerate the config for each module */
1383     for (size_t i = 0; list[i]; i++)
1384     {
1385         bool b_help_module;
1386         module_t *p_parser = list[i];
1387         module_config_t *p_item = NULL;
1388         module_config_t *p_section = NULL;
1389         module_config_t *p_end = p_parser->p_config + p_parser->confsize;
1390         const char *objname = module_get_object (p_parser);
1391
1392         if( psz_search &&
1393             ( b_strict ? strcmp( objname, psz_search )
1394                        : !strstr( objname, psz_search ) ) )
1395         {
1396             char *const *pp_shortcuts = p_parser->pp_shortcuts;
1397             unsigned i;
1398             for( i = 0; i < p_parser->i_shortcuts; i++ )
1399             {
1400                 if( b_strict ? !strcmp( psz_search, pp_shortcuts[i] )
1401                              : !!strstr( pp_shortcuts[i], psz_search ) )
1402                     break;
1403             }
1404             if( i == p_parser->i_shortcuts )
1405                 continue;
1406         }
1407
1408         /* Ignore modules without config options */
1409         if( !p_parser->i_config_items )
1410         {
1411             continue;
1412         }
1413
1414         b_help_module = !strcmp( "help", objname );
1415         /* Ugly hack to make sure that the help options always come first
1416          * (part 2) */
1417         if( !psz_search && b_help_module )
1418             continue;
1419
1420         /* Ignore modules with only advanced config options if requested */
1421         if( !b_advanced )
1422         {
1423             for( p_item = p_parser->p_config;
1424                  p_item < p_end;
1425                  p_item++ )
1426             {
1427                 if( CONFIG_ITEM(p_item->i_type) &&
1428                     !p_item->b_advanced && !p_item->b_removed ) break;
1429             }
1430
1431             if( p_item == p_end )
1432             {
1433                 i_only_advanced++;
1434                 continue;
1435             }
1436         }
1437
1438         b_found = true;
1439
1440         /* Print name of module */
1441         if( strcmp( "main", objname ) )
1442         {
1443             if( b_color )
1444                 utf8_fprintf( stdout, "\n " GREEN "%s" GRAY " (%s)\n",
1445                               module_gettext( p_parser, p_parser->psz_longname ),
1446                               objname );
1447             else
1448                 utf8_fprintf( stdout, "\n %s\n",
1449                               module_gettext(p_parser, p_parser->psz_longname ) );
1450         }
1451         if( p_parser->psz_help )
1452         {
1453             if( b_color )
1454                 utf8_fprintf( stdout, CYAN" %s\n"GRAY,
1455                               module_gettext( p_parser, p_parser->psz_help ) );
1456             else
1457                 utf8_fprintf( stdout, " %s\n",
1458                               module_gettext( p_parser, p_parser->psz_help ) );
1459         }
1460
1461         /* Print module options */
1462         for( p_item = p_parser->p_config;
1463              p_item < p_end;
1464              p_item++ )
1465         {
1466             char *psz_text, *psz_spaces = psz_spaces_text;
1467             const char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
1468             const char *psz_suf = "", *psz_prefix = NULL;
1469             signed int i;
1470             size_t i_cur_width;
1471
1472             /* Skip removed options */
1473             if( p_item->b_removed )
1474             {
1475                 continue;
1476             }
1477             /* Skip advanced options if requested */
1478             if( p_item->b_advanced && !b_advanced )
1479             {
1480                 b_has_advanced = true;
1481                 continue;
1482             }
1483
1484             switch( CONFIG_CLASS(p_item->i_type) )
1485             {
1486             case 0: // hint class
1487                 switch( p_item->i_type )
1488                 {
1489                 case CONFIG_HINT_CATEGORY:
1490                 case CONFIG_HINT_USAGE:
1491                     if( !strcmp( "main", objname ) )
1492                     {
1493                         if( b_color )
1494                             utf8_fprintf( stdout, GREEN "\n %s\n" GRAY,
1495                                           module_gettext( p_parser, p_item->psz_text ) );
1496                         else
1497                             utf8_fprintf( stdout, "\n %s\n",
1498                                           module_gettext( p_parser, p_item->psz_text ) );
1499                     }
1500                     if( b_description && p_item->psz_longtext )
1501                     {
1502                         if( b_color )
1503                             utf8_fprintf( stdout, CYAN " %s\n" GRAY,
1504                                           module_gettext( p_parser, p_item->psz_longtext ) );
1505                         else
1506                             utf8_fprintf( stdout, " %s\n",
1507                                           module_gettext( p_parser, p_item->psz_longtext ) );
1508                 }
1509                 break;
1510
1511                 case CONFIG_HINT_SUBCATEGORY:
1512                     if( strcmp( "main", objname ) )
1513                         break;
1514                 case CONFIG_SECTION:
1515                     p_section = p_item;
1516                     break;
1517                 }
1518                 break;
1519
1520             case CONFIG_ITEM_STRING:
1521                 print_help_section( p_parser, p_section, b_color,
1522                                     b_description );
1523                 p_section = NULL;
1524                 psz_bra = OPTION_VALUE_SEP "<";
1525                 psz_type = _("string");
1526                 psz_ket = ">";
1527
1528                 if( p_item->ppsz_list )
1529                 {
1530                     psz_bra = OPTION_VALUE_SEP "{";
1531                     psz_type = psz_buffer;
1532                     psz_buffer[0] = '\0';
1533                     for( i = 0; p_item->ppsz_list[i]; i++ )
1534                     {
1535                         if( i ) strcat( psz_buffer, "," );
1536                         strcat( psz_buffer, p_item->ppsz_list[i] );
1537                     }
1538                     psz_ket = "}";
1539                 }
1540                 break;
1541             case CONFIG_ITEM_INTEGER:
1542                 print_help_section( p_parser, p_section, b_color,
1543                                     b_description );
1544                 p_section = NULL;
1545                 psz_bra = OPTION_VALUE_SEP "<";
1546                 psz_type = _("integer");
1547                 psz_ket = ">";
1548
1549                 if( p_item->min.i || p_item->max.i )
1550                 {
1551                     sprintf( psz_buffer, "%s [%"PRId64" .. %"PRId64"]",
1552                              psz_type, p_item->min.i, p_item->max.i );
1553                     psz_type = psz_buffer;
1554                 }
1555
1556                 if( p_item->i_list )
1557                 {
1558                     psz_bra = OPTION_VALUE_SEP "{";
1559                     psz_type = psz_buffer;
1560                     psz_buffer[0] = '\0';
1561                     for( i = 0; p_item->ppsz_list_text[i]; i++ )
1562                     {
1563                         if( i ) strcat( psz_buffer, ", " );
1564                         sprintf( psz_buffer + strlen(psz_buffer), "%i (%s)",
1565                                  p_item->pi_list[i],
1566                                  module_gettext( p_parser, p_item->ppsz_list_text[i] ) );
1567                     }
1568                     psz_ket = "}";
1569                 }
1570                 break;
1571             case CONFIG_ITEM_FLOAT:
1572                 print_help_section( p_parser, p_section, b_color,
1573                                     b_description );
1574                 p_section = NULL;
1575                 psz_bra = OPTION_VALUE_SEP "<";
1576                 psz_type = _("float");
1577                 psz_ket = ">";
1578                 if( p_item->min.f || p_item->max.f )
1579                 {
1580                     sprintf( psz_buffer, "%s [%f .. %f]", psz_type,
1581                              p_item->min.f, p_item->max.f );
1582                     psz_type = psz_buffer;
1583                 }
1584                 break;
1585             case CONFIG_ITEM_BOOL:
1586                 print_help_section( p_parser, p_section, b_color,
1587                                     b_description );
1588                 p_section = NULL;
1589                 psz_bra = ""; psz_type = ""; psz_ket = "";
1590                 if( !b_help_module )
1591                 {
1592                     psz_suf = p_item->value.i ? _(" (default enabled)") :
1593                                                 _(" (default disabled)");
1594                 }
1595                 break;
1596             }
1597
1598             if( !psz_type )
1599             {
1600                 continue;
1601             }
1602
1603             /* Add short option if any */
1604             if( p_item->i_short )
1605             {
1606                 sprintf( psz_short, "-%c,", p_item->i_short );
1607             }
1608             else
1609             {
1610                 strcpy( psz_short, "   " );
1611             }
1612
1613             i = PADDING_SPACES - strlen( p_item->psz_name )
1614                  - strlen( psz_bra ) - strlen( psz_type )
1615                  - strlen( psz_ket ) - 1;
1616
1617             if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
1618              && !b_help_module )
1619             {
1620                 psz_prefix =  ", --no-";
1621                 i -= strlen( p_item->psz_name ) + strlen( psz_prefix );
1622             }
1623
1624             if( i < 0 )
1625             {
1626                 psz_spaces[0] = '\n';
1627                 i = 0;
1628             }
1629             else
1630             {
1631                 psz_spaces[i] = '\0';
1632             }
1633
1634             if( CONFIG_CLASS(p_item->i_type) == CONFIG_ITEM_BOOL
1635              && !b_help_module )
1636             {
1637                 utf8_fprintf( stdout, psz_format_bool, psz_short,
1638                               p_item->psz_name, psz_prefix, p_item->psz_name,
1639                               psz_bra, psz_type, psz_ket, psz_spaces );
1640             }
1641             else
1642             {
1643                 utf8_fprintf( stdout, psz_format, psz_short, p_item->psz_name,
1644                          "", "", psz_bra, psz_type, psz_ket, psz_spaces );
1645             }
1646
1647             psz_spaces[i] = ' ';
1648
1649             /* We wrap the rest of the output */
1650             sprintf( psz_buffer, "%s%s", module_gettext( p_parser, p_item->psz_text ),
1651                      psz_suf );
1652             b_description_hack = b_description;
1653
1654  description:
1655             psz_text = psz_buffer;
1656             i_cur_width = b_description && !b_description_hack
1657                           ? i_width_description
1658                           : i_width;
1659             if( !*psz_text ) strcpy(psz_text, " ");
1660             while( *psz_text )
1661             {
1662                 char *psz_parser, *psz_word;
1663                 size_t i_end = strlen( psz_text );
1664
1665                 /* If the remaining text fits in a line, print it. */
1666                 if( i_end <= i_cur_width )
1667                 {
1668                     if( b_color )
1669                     {
1670                         if( !b_description || b_description_hack )
1671                             utf8_fprintf( stdout, BLUE"%s\n"GRAY, psz_text );
1672                         else
1673                             utf8_fprintf( stdout, "%s\n", psz_text );
1674                     }
1675                     else
1676                     {
1677                         utf8_fprintf( stdout, "%s\n", psz_text );
1678                     }
1679                     break;
1680                 }
1681
1682                 /* Otherwise, eat as many words as possible */
1683                 psz_parser = psz_text;
1684                 do
1685                 {
1686                     psz_word = psz_parser;
1687                     psz_parser = strchr( psz_word, ' ' );
1688                     /* If no space was found, we reached the end of the text
1689                      * block; otherwise, we skip the space we just found. */
1690                     psz_parser = psz_parser ? psz_parser + 1
1691                                             : psz_text + i_end;
1692
1693                 } while( (size_t)(psz_parser - psz_text) <= i_cur_width );
1694
1695                 /* We cut a word in one of these cases:
1696                  *  - it's the only word in the line and it's too long.
1697                  *  - we used less than 80% of the width and the word we are
1698                  *    going to wrap is longer than 40% of the width, and even
1699                  *    if the word would have fit in the next line. */
1700                 if( psz_word == psz_text
1701              || ( (size_t)(psz_word - psz_text) < 80 * i_cur_width / 100
1702              && (size_t)(psz_parser - psz_word) > 40 * i_cur_width / 100 ) )
1703                 {
1704                     char c = psz_text[i_cur_width];
1705                     psz_text[i_cur_width] = '\0';
1706                     if( b_color )
1707                     {
1708                         if( !b_description || b_description_hack )
1709                             utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1710                                           psz_text, psz_spaces );
1711                         else
1712                             utf8_fprintf( stdout, "%s\n%s",
1713                                           psz_text, psz_spaces );
1714                     }
1715                     else
1716                     {
1717                         utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1718                     }
1719                     psz_text += i_cur_width;
1720                     psz_text[0] = c;
1721                 }
1722                 else
1723                 {
1724                     psz_word[-1] = '\0';
1725                     if( b_color )
1726                     {
1727                         if( !b_description || b_description_hack )
1728                             utf8_fprintf( stdout, BLUE"%s\n%s"GRAY,
1729                                           psz_text, psz_spaces );
1730                         else
1731                             utf8_fprintf( stdout, "%s\n%s",
1732                                           psz_text, psz_spaces );
1733                     }
1734                     else
1735                     {
1736                         utf8_fprintf( stdout, "%s\n%s", psz_text, psz_spaces );
1737                     }
1738                     psz_text = psz_word;
1739                 }
1740             }
1741
1742             if( b_description_hack && p_item->psz_longtext )
1743             {
1744                 sprintf( psz_buffer, "%s%s",
1745                          module_gettext( p_parser, p_item->psz_longtext ),
1746                          psz_suf );
1747                 b_description_hack = false;
1748                 psz_spaces = psz_spaces_longtext;
1749                 utf8_fprintf( stdout, "%s", psz_spaces );
1750                 goto description;
1751             }
1752         }
1753     }
1754
1755     if( b_has_advanced )
1756     {
1757         if( b_color )
1758             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " %s\n", _( "Note:" ),
1759            _( "add --advanced to your command line to see advanced options."));
1760         else
1761             utf8_fprintf( stdout, "\n%s %s\n", _( "Note:" ),
1762            _( "add --advanced to your command line to see advanced options."));
1763     }
1764
1765     if( i_only_advanced > 0 )
1766     {
1767         if( b_color )
1768         {
1769             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY " ", _( "Note:" ) );
1770             utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1771         }
1772         else
1773         {
1774             utf8_fprintf( stdout, "\n%s ", _( "Note:" ) );
1775             utf8_fprintf( stdout, _( "%d module(s) were not displayed because they only have advanced options.\n" ), i_only_advanced );
1776         }
1777     }
1778     else if( !b_found )
1779     {
1780         if( b_color )
1781             utf8_fprintf( stdout, "\n" WHITE "%s" GRAY "\n",
1782                        _( "No matching module found. Use --list or " \
1783                           "--list-verbose to list available modules." ) );
1784         else
1785             utf8_fprintf( stdout, "\n%s\n",
1786                        _( "No matching module found. Use --list or " \
1787                           "--list-verbose to list available modules." ) );
1788     }
1789
1790     /* Release the module list */
1791     module_list_free (list);
1792 }
1793
1794 /*****************************************************************************
1795  * ListModules: list the available modules with their description
1796  *****************************************************************************
1797  * Print a list of all available modules (builtins and plugins) and a short
1798  * description for each one.
1799  *****************************************************************************/
1800 static void ListModules( libvlc_int_t *p_this, bool b_verbose )
1801 {
1802     module_t *p_parser;
1803
1804     bool b_color = var_InheritBool( p_this, "color" );
1805
1806 #ifdef WIN32
1807     ShowConsole( true );
1808     b_color = false; // don't put color control codes in a .txt file
1809 #else
1810     if( !isatty( 1 ) )
1811         b_color = false;
1812 #endif
1813
1814     /* List all modules */
1815     module_t **list = module_list_get (NULL);
1816
1817     /* Enumerate each module */
1818     for (size_t j = 0; (p_parser = list[j]) != NULL; j++)
1819     {
1820         const char *objname = module_get_object (p_parser);
1821         if( b_color )
1822             utf8_fprintf( stdout, GREEN"  %-22s "WHITE"%s\n"GRAY, objname,
1823                           module_gettext( p_parser, p_parser->psz_longname ) );
1824         else
1825             utf8_fprintf( stdout, "  %-22s %s\n", objname,
1826                           module_gettext( p_parser, p_parser->psz_longname ) );
1827
1828         if( b_verbose )
1829         {
1830             char *const *pp_shortcuts = p_parser->pp_shortcuts;
1831             for( unsigned i = 0; i < p_parser->i_shortcuts; i++ )
1832             {
1833                 if( strcmp( pp_shortcuts[i], objname ) )
1834                 {
1835                     if( b_color )
1836                         utf8_fprintf( stdout, CYAN"   s %s\n"GRAY,
1837                                       pp_shortcuts[i] );
1838                     else
1839                         utf8_fprintf( stdout, "   s %s\n",
1840                                       pp_shortcuts[i] );
1841                 }
1842             }
1843             if( p_parser->psz_capability )
1844             {
1845                 if( b_color )
1846                     utf8_fprintf( stdout, MAGENTA"   c %s (%d)\n"GRAY,
1847                                   p_parser->psz_capability,
1848                                   p_parser->i_score );
1849                 else
1850                     utf8_fprintf( stdout, "   c %s (%d)\n",
1851                                   p_parser->psz_capability,
1852                                   p_parser->i_score );
1853             }
1854         }
1855     }
1856     module_list_free (list);
1857
1858 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1859     PauseConsole();
1860 #endif
1861 }
1862
1863 /*****************************************************************************
1864  * Version: print complete program version
1865  *****************************************************************************
1866  * Print complete program version and build number.
1867  *****************************************************************************/
1868 static void Version( void )
1869 {
1870 #ifdef WIN32
1871     ShowConsole( true );
1872 #endif
1873
1874     utf8_fprintf( stdout, _("VLC version %s (%s)\n"), VERSION_MESSAGE,
1875                   psz_vlc_changeset );
1876     utf8_fprintf( stdout, _("Compiled by %s on %s (%s)\n"),
1877              VLC_CompileBy(), VLC_CompileHost(), __DATE__" "__TIME__ );
1878     utf8_fprintf( stdout, _("Compiler: %s\n"), VLC_Compiler() );
1879     utf8_fprintf( stdout, "%s", LICENSE_MSG );
1880
1881 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1882     PauseConsole();
1883 #endif
1884 }
1885
1886 /*****************************************************************************
1887  * ShowConsole: On Win32, create an output console for debug messages
1888  *****************************************************************************
1889  * This function is useful only on Win32.
1890  *****************************************************************************/
1891 #ifdef WIN32 /*  */
1892 static void ShowConsole( bool b_dofile )
1893 {
1894 #   ifndef UNDER_CE
1895     FILE *f_help = NULL;
1896
1897     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
1898
1899     AllocConsole();
1900     /* Use the ANSI code page (e.g. Windows-1252) as expected by the LibVLC
1901      * Unicode/locale subsystem. By default, we have the obsolecent OEM code
1902      * page (e.g. CP437 or CP850). */
1903     SetConsoleOutputCP (GetACP ());
1904     SetConsoleTitle ("VLC media player version "PACKAGE_VERSION);
1905
1906     freopen( "CONOUT$", "w", stderr );
1907     freopen( "CONIN$", "r", stdin );
1908
1909     if( b_dofile && (f_help = fopen( "vlc-help.txt", "wt" )) )
1910     {
1911         fclose( f_help );
1912         freopen( "vlc-help.txt", "wt", stdout );
1913         utf8_fprintf( stderr, _("\nDumped content to vlc-help.txt file.\n") );
1914     }
1915     else freopen( "CONOUT$", "w", stdout );
1916
1917 #   endif
1918 }
1919 #endif
1920
1921 /*****************************************************************************
1922  * PauseConsole: On Win32, wait for a key press before closing the console
1923  *****************************************************************************
1924  * This function is useful only on Win32.
1925  *****************************************************************************/
1926 #ifdef WIN32 /*  */
1927 static void PauseConsole( void )
1928 {
1929 #   ifndef UNDER_CE
1930
1931     if( getenv( "PWD" ) ) return; /* Cygwin shell or Wine */
1932
1933     utf8_fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1934     getchar();
1935     fclose( stdout );
1936
1937 #   endif
1938 }
1939 #endif
1940
1941 /*****************************************************************************
1942  * ConsoleWidth: Return the console width in characters
1943  *****************************************************************************
1944  * We use the stty shell command to get the console width; if this fails or
1945  * if the width is less than 80, we default to 80.
1946  *****************************************************************************/
1947 static int ConsoleWidth( void )
1948 {
1949     unsigned i_width = 80;
1950
1951 #ifndef WIN32
1952     FILE *file = popen( "stty size 2>/dev/null", "r" );
1953     if (file != NULL)
1954     {
1955         if (fscanf (file, "%*u %u", &i_width) <= 0)
1956             i_width = 80;
1957         pclose( file );
1958     }
1959 #elif !defined (UNDER_CE)
1960     CONSOLE_SCREEN_BUFFER_INFO buf;
1961
1962     if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &buf))
1963         i_width = buf.dwSize.X;
1964 #endif
1965
1966     return i_width;
1967 }