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