(new in MAIN)
[vlc.git] / src / libvlc.c
1 /*****************************************************************************
2  * libvlc.c: main libvlc source
3  * Includes the main() function for vlc. Parses command line, starts playlist
4  * and spawns threads.
5  *****************************************************************************
6  * Copyright (C) 1998-2001 VideoLAN
7  * $Id: libvlc.c,v 1.7 2002/06/04 00:11:12 sam Exp $
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *          Samuel Hocevar <sam@zoy.org>
11  *          Gildas Bazin <gbazin@netcourrier.com>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
26  *****************************************************************************/
27
28 /*****************************************************************************
29  * Pretend we are a builtin module
30  *****************************************************************************/
31 #define MODULE_NAME main
32 #define __BUILTIN__
33
34 /*****************************************************************************
35  * Preamble
36  *****************************************************************************/
37 #include <errno.h>                                                 /* ENOMEM */
38 #include <stdio.h>                                              /* sprintf() */
39 #include <string.h>                                            /* strerror() */
40 #include <stdlib.h>                                                /* free() */
41 #include <signal.h>                               /* SIGHUP, SIGINT, SIGKILL */
42
43 #include <vlc/vlc.h>
44
45 #ifdef HAVE_GETOPT_LONG
46 #   ifdef HAVE_GETOPT_H
47 #       include <getopt.h>                                       /* getopt() */
48 #   endif
49 #else
50 #   include "GNUgetopt/getopt.h"
51 #endif
52
53 #ifndef WIN32
54 #   include <netinet/in.h>                            /* BSD: struct in_addr */
55 #endif
56
57 #ifdef HAVE_UNISTD_H
58 #   include <unistd.h>
59 #elif defined( _MSC_VER ) && defined( _WIN32 )
60 #   include <io.h>
61 #endif
62
63 #ifdef HAVE_LOCALE_H
64 #   include <locale.h>
65 #endif
66
67 #include "vlc_cpu.h"                                        /* CPU detection */
68 #include "os_specific.h"
69
70 #include "netutils.h"                                 /* network_ChannelJoin */
71
72 #include "stream_control.h"
73 #include "input_ext-intf.h"
74
75 #include "playlist.h"
76 #include "interface.h"
77
78 #include "audio_output.h"
79
80 #include "video.h"
81 #include "video_output.h"
82
83 #include "libvlc.h"
84
85 /*****************************************************************************
86  * The evil global variables. We handle them with care, don't worry.
87  *****************************************************************************/
88
89 /* This global lock is used for critical sections - don't abuse it! */
90 static vlc_mutex_t global_lock;
91 void *             p_global_data;
92
93 /* A list of all the currently allocated vlc objects */
94 static volatile int i_vlc = 0;
95 static volatile vlc_t **pp_vlc = NULL;
96
97 /*****************************************************************************
98  * Local prototypes
99  *****************************************************************************/
100 static int  GetFilenames  ( vlc_t *, int, char *[] );
101 static void Usage         ( vlc_t *, const char *psz_module_name );
102 static void ListModules   ( vlc_t * );
103 static void Version       ( void );
104 static void Build         ( void );
105
106 #ifndef WIN32
107 static void InitSignalHandler   ( void );
108 static void SimpleSignalHandler ( int i_signal );
109 static void FatalSignalHandler  ( int i_signal );
110 #endif
111
112 #ifdef WIN32
113 static void ShowConsole   ( void );
114 #endif
115
116 /*****************************************************************************
117  * vlc_create: allocate a vlc_t structure, and initialize libvlc if needed.
118  *****************************************************************************
119  * This function allocates a vlc_t structure and returns NULL in case of
120  * failure. Also, the thread system and the signal handlers are initialized.
121  *****************************************************************************/
122 vlc_t * vlc_create( void )
123 {
124     vlc_t * p_vlc = NULL;
125
126     /* Allocate the main structure */
127     p_vlc = vlc_object_create( p_vlc, VLC_OBJECT_ROOT );
128     if( p_vlc == NULL )
129     {
130         return NULL;
131     }
132
133     p_vlc->psz_object_name = "root";
134
135     p_vlc->p_global_lock = &global_lock;
136     p_vlc->pp_global_data = &p_global_data;
137
138     p_vlc->b_verbose = VLC_FALSE;
139     p_vlc->b_quiet = VLC_FALSE; /* FIXME: delay message queue output! */
140
141     /* Initialize the threads system */
142     vlc_threads_init( p_vlc );
143
144     /* Initialize mutexes */
145     vlc_mutex_init( p_vlc, &p_vlc->config_lock );
146     vlc_mutex_init( p_vlc, &p_vlc->structure_lock );
147
148     /* Set signal handling policy for all threads */
149 #ifndef WIN32
150     InitSignalHandler( );
151 #endif
152
153     /* Store our newly allocated structure in the global list */
154     vlc_mutex_lock( p_vlc->p_global_lock );
155     pp_vlc = realloc( pp_vlc, (i_vlc+1) * sizeof( vlc_t * ) );
156     pp_vlc[ i_vlc ] = p_vlc;
157     i_vlc++;
158     vlc_mutex_unlock( p_vlc->p_global_lock );
159
160     /* Update the handle status */
161     p_vlc->i_status = VLC_STATUS_CREATED;
162
163     return p_vlc;
164 }
165
166 /*****************************************************************************
167  * vlc_init: initialize a vlc_t structure.
168  *****************************************************************************
169  * This function initializes a previously allocated vlc_t structure:
170  *  - CPU detection
171  *  - gettext initialization
172  *  - message queue, module bank and playlist initialization
173  *  - configuration and commandline parsing
174  *****************************************************************************/
175 vlc_error_t vlc_init( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
176 {
177     char p_capabilities[200];
178     char *psz_module;
179     char *p_tmp;
180     module_t        *p_help_module;
181     playlist_t      *p_playlist;
182
183     /* Check that the handle is valid */
184     if( !p_vlc || p_vlc->i_status != VLC_STATUS_CREATED )
185     {
186         fprintf( stderr, "error: invalid status\n" );
187         return VLC_ESTATUS;
188     }
189
190     fprintf( stderr, COPYRIGHT_MESSAGE "\n" );
191
192     /* Guess what CPU we have */
193     p_vlc->i_cpu_capabilities = CPUCapabilities( p_vlc );
194
195     /*
196      * Support for gettext
197      */
198 #if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT )
199 #   if defined( HAVE_LOCALE_H ) && defined( HAVE_LC_MESSAGES )
200     if( !setlocale( LC_MESSAGES, "" ) )
201     {
202         fprintf( stderr, "warning: unsupported locale settings\n" );
203     }
204
205     setlocale( LC_CTYPE, "" );
206 #   endif
207
208     if( !bindtextdomain( PACKAGE, LOCALEDIR ) )
209     {
210         fprintf( stderr, "warning: no domain %s in directory %s\n",
211                  PACKAGE, LOCALEDIR );
212     }
213
214     textdomain( PACKAGE );
215 #endif
216
217     /*
218      * System specific initialization code
219      */
220     system_Init( p_vlc, &i_argc, ppsz_argv );
221
222     /*
223      * Initialize message queue
224      */
225     msg_Create( p_vlc );
226
227     /* Get the executable name (similar to the basename command) */
228     if( i_argc > 0 )
229     {
230         p_vlc->psz_object_name = p_tmp = ppsz_argv[ 0 ];
231         while( *p_tmp )
232         {
233             if( *p_tmp == '/' ) p_vlc->psz_object_name = ++p_tmp;
234             else ++p_tmp;
235         }
236     }
237     else
238     {
239         p_vlc->psz_object_name = "vlc";
240     }
241
242     /*
243      * Initialize the module bank and and load the configuration of the main
244      * module. We need to do this at this stage to be able to display a short
245      * help if required by the user. (short help == main module options)
246      */
247     module_InitBank( p_vlc );
248     module_LoadMain( p_vlc );
249
250     /* Hack: insert the help module here */
251     p_help_module = vlc_object_create( p_vlc, VLC_OBJECT_MODULE );
252     if( p_help_module == NULL )
253     {
254         module_EndBank( p_vlc );
255         msg_Destroy( p_vlc );
256         return VLC_EGENERIC;
257     }
258     p_help_module->psz_object_name = "help";
259     config_Duplicate( p_help_module, p_help_config );
260     p_help_module->next = p_vlc->module_bank.first;
261     p_vlc->module_bank.first = p_help_module;
262     /* End hack */
263
264     if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_TRUE ) )
265     {
266         p_vlc->module_bank.first = p_help_module->next;
267         config_Free( p_help_module );
268         vlc_object_destroy( p_help_module );
269         module_EndBank( p_vlc );
270         msg_Destroy( p_vlc );
271         return VLC_EGENERIC;
272     }
273
274     /* Check for short help option */
275     if( config_GetInt( p_vlc, "help" ) )
276     {
277         fprintf( stderr, _("Usage: %s [options] [parameters] [file]...\n"),
278                          p_vlc->psz_object_name );
279
280         Usage( p_vlc, "help" );
281         Usage( p_vlc, "main" );
282         p_vlc->module_bank.first = p_help_module->next;
283         config_Free( p_help_module );
284         vlc_object_destroy( p_help_module );
285         module_EndBank( p_vlc );
286         msg_Destroy( p_vlc );
287         return VLC_EEXIT;
288     }
289
290     /* Check for version option */
291     if( config_GetInt( p_vlc, "version" ) )
292     {
293         Version();
294         p_vlc->module_bank.first = p_help_module->next;
295         config_Free( p_help_module );
296         vlc_object_destroy( p_help_module );
297         module_EndBank( p_vlc );
298         msg_Destroy( p_vlc );
299         return VLC_EEXIT;
300     }
301
302     /* Check for build option */
303     if( config_GetInt( p_vlc, "build" ) )
304     {
305         Build();
306         p_vlc->module_bank.first = p_help_module->next;
307         config_Free( p_help_module );
308         vlc_object_destroy( p_help_module );
309         module_EndBank( p_vlc );
310         msg_Destroy( p_vlc );
311         return VLC_EEXIT;
312     }
313
314     /* Hack: remove the help module here */
315     p_vlc->module_bank.first = p_help_module->next;
316     /* End hack */
317
318     /*
319      * Load the builtins and plugins into the module_bank.
320      * We have to do it before config_Load*() because this also gets the
321      * list of configuration options exported by each module and loads their
322      * default values.
323      */
324     module_LoadBuiltins( p_vlc );
325     module_LoadPlugins( p_vlc );
326     msg_Dbg( p_vlc, "module bank initialized, found %i modules",
327                     p_vlc->module_bank.i_count );
328
329     /* Hack: insert the help module here */
330     p_help_module->next = p_vlc->module_bank.first;
331     p_vlc->module_bank.first = p_help_module;
332     /* End hack */
333
334     /* Check for help on modules */
335     if( (p_tmp = config_GetPsz( p_vlc, "module" )) )
336     {
337         Usage( p_vlc, p_tmp );
338         free( p_tmp );
339         p_vlc->module_bank.first = p_help_module->next;
340         config_Free( p_help_module );
341         vlc_object_destroy( p_help_module );
342         module_EndBank( p_vlc );
343         msg_Destroy( p_vlc );
344         return VLC_EGENERIC;
345     }
346
347     /* Check for long help option */
348     if( config_GetInt( p_vlc, "longhelp" ) )
349     {
350         Usage( p_vlc, NULL );
351         p_vlc->module_bank.first = p_help_module->next;
352         config_Free( p_help_module );
353         vlc_object_destroy( p_help_module );
354         module_EndBank( p_vlc );
355         msg_Destroy( p_vlc );
356         return VLC_EEXIT;
357     }
358
359     /* Check for module list option */
360     if( config_GetInt( p_vlc, "list" ) )
361     {
362         ListModules( p_vlc );
363         p_vlc->module_bank.first = p_help_module->next;
364         config_Free( p_help_module );
365         vlc_object_destroy( p_help_module );
366         module_EndBank( p_vlc );
367         msg_Destroy( p_vlc );
368         return VLC_EEXIT;
369     }
370
371     /* Hack: remove the help module here */
372     p_vlc->module_bank.first = p_help_module->next;
373     config_Free( p_help_module );
374     vlc_object_destroy( p_help_module );
375     /* End hack */
376
377     /*
378      * Override default configuration with config file settings
379      */
380     p_vlc->psz_homedir = config_GetHomeDir();
381     config_LoadConfigFile( p_vlc, NULL );
382
383     /*
384      * Override configuration with command line settings
385      */
386     if( config_LoadCmdLine( p_vlc, &i_argc, ppsz_argv, VLC_FALSE ) )
387     {
388 #ifdef WIN32
389         ShowConsole();
390         /* Pause the console because it's destroyed when we exit */
391         fprintf( stderr, "The command line options couldn't be loaded, check "
392                  "that they are valid.\nPress the RETURN key to continue..." );
393         getchar();
394 #endif
395         module_EndBank( p_vlc );
396         msg_Destroy( p_vlc );
397         return VLC_EGENERIC;
398     }
399
400
401     /*
402      * System specific configuration
403      */
404     system_Configure( p_vlc );
405
406     /* p_vlc inititalization. FIXME ? */
407     p_vlc->i_desync = config_GetInt( p_vlc, "desync" ) * (mtime_t)1000;
408     p_vlc->b_verbose = config_GetInt( p_vlc, "verbose" );
409     p_vlc->b_quiet = config_GetInt( p_vlc, "quiet" );
410     p_vlc->b_color = config_GetInt( p_vlc, "color" );
411     if( !config_GetInt( p_vlc, "mmx" ) )
412         p_vlc->i_cpu_capabilities &= ~CPU_CAPABILITY_MMX;
413     if( !config_GetInt( p_vlc, "3dn" ) )
414         p_vlc->i_cpu_capabilities &= ~CPU_CAPABILITY_3DNOW;
415     if( !config_GetInt( p_vlc, "mmxext" ) )
416         p_vlc->i_cpu_capabilities &= ~CPU_CAPABILITY_MMXEXT;
417     if( !config_GetInt( p_vlc, "sse" ) )
418         p_vlc->i_cpu_capabilities &= ~CPU_CAPABILITY_SSE;
419     if( !config_GetInt( p_vlc, "altivec" ) )
420         p_vlc->i_cpu_capabilities &= ~CPU_CAPABILITY_ALTIVEC;
421
422 #define PRINT_CAPABILITY( capability, string )                              \
423     if( p_vlc->i_cpu_capabilities & capability )                            \
424     {                                                                       \
425         strncat( p_capabilities, string " ",                                \
426                  sizeof(p_capabilities) - strlen(p_capabilities) );         \
427         p_capabilities[sizeof(p_capabilities) - 1] = '\0';                  \
428     }
429
430     p_capabilities[0] = '\0';
431     PRINT_CAPABILITY( CPU_CAPABILITY_486, "486" );
432     PRINT_CAPABILITY( CPU_CAPABILITY_586, "586" );
433     PRINT_CAPABILITY( CPU_CAPABILITY_PPRO, "Pentium Pro" );
434     PRINT_CAPABILITY( CPU_CAPABILITY_MMX, "MMX" );
435     PRINT_CAPABILITY( CPU_CAPABILITY_3DNOW, "3DNow!" );
436     PRINT_CAPABILITY( CPU_CAPABILITY_MMXEXT, "MMXEXT" );
437     PRINT_CAPABILITY( CPU_CAPABILITY_SSE, "SSE" );
438     PRINT_CAPABILITY( CPU_CAPABILITY_ALTIVEC, "AltiVec" );
439     PRINT_CAPABILITY( CPU_CAPABILITY_FPU, "FPU" );
440     msg_Dbg( p_vlc, "CPU has capabilities %s", p_capabilities );
441
442     /*
443      * Choose the best memcpy module
444      */
445     psz_module = config_GetPsz( p_vlc, "memcpy" );
446     p_vlc->p_memcpy_module =
447             module_Need( p_vlc, MODULE_CAPABILITY_MEMCPY, psz_module, NULL );
448     if( psz_module ) free( psz_module );
449     if( p_vlc->p_memcpy_module == NULL )
450     {
451         msg_Err( p_vlc, "no suitable memcpy module, using libc default" );
452         p_vlc->pf_memcpy = memcpy;
453     }
454     else
455     {
456         p_vlc->pf_memcpy = p_vlc->p_memcpy_module->p_functions
457                                   ->memcpy.functions.memcpy.pf_memcpy;
458     }
459
460     /*
461      * Initialize shared resources and libraries
462      */
463     if( config_GetInt( p_vlc, "network-channel" )
464          && network_ChannelCreate( p_vlc ) )
465     {
466         /* On error during Channels initialization, switch off channels */
467         msg_Err( p_vlc,
468                  "channels initialization failed, deactivating channels" );
469         config_PutInt( p_vlc, "network-channel", VLC_FALSE );
470     }
471
472     /* Update the handle status */
473     p_vlc->i_status = VLC_STATUS_STOPPED;
474
475 /* XXX XXX XXX XXX XXX XXX XXX XXX */
476 /* XXX XXX XXX XXX XXX XXX XXX XXX */
477 /* XXX XXX XXX XXX XXX XXX XXX XXX */
478     /*
479      * Initialize playlist and get commandline files
480      */
481     p_playlist = playlist_Create( p_vlc );
482     if( !p_playlist )
483     {
484         msg_Err( p_vlc, "playlist initialization failed" );
485         module_EndBank( p_vlc );
486         msg_Destroy( p_vlc );
487         return VLC_EGENERIC;
488     }
489
490     /*
491      * Get input filenames given as commandline arguments
492      */
493     GetFilenames( p_vlc, i_argc, ppsz_argv );
494 /* XXX XXX XXX XXX XXX XXX XXX XXX */
495 /* XXX XXX XXX XXX XXX XXX XXX XXX */
496 /* XXX XXX XXX XXX XXX XXX XXX XXX */
497
498     return VLC_SUCCESS;
499 }
500
501 /*****************************************************************************
502  * vlc_run: run vlc
503  *****************************************************************************
504  * XXX: This function opens an interface plugin and runs it. If b_block is set
505  * to 0, vlc_add_intf will return immediately and let the interface run in a
506  * separate thread. If b_block is set to 1, vlc_add_intf will continue until
507  * user requests to quit.
508  *****************************************************************************/
509 vlc_error_t vlc_run( vlc_t *p_vlc )
510 {
511     /* Check that the handle is valid */
512     if( !p_vlc || p_vlc->i_status != VLC_STATUS_STOPPED )
513     {
514         fprintf( stderr, "error: invalid status\n" );
515         return VLC_ESTATUS;
516     }
517
518     /* Update the handle status */
519     p_vlc->i_status = VLC_STATUS_RUNNING;
520
521     return VLC_SUCCESS;
522 }
523
524 /*****************************************************************************
525  * vlc_add_intf: add an interface
526  *****************************************************************************
527  * This function opens an interface plugin and runs it. If b_block is set
528  * to 0, vlc_add_intf will return immediately and let the interface run in a
529  * separate thread. If b_block is set to 1, vlc_add_intf will continue until
530  * user requests to quit.
531  *****************************************************************************/
532 vlc_error_t vlc_add_intf( vlc_t *p_vlc, char *psz_module, vlc_bool_t b_block )
533 {
534     vlc_error_t err;
535     intf_thread_t *p_intf;
536     char *psz_oldmodule = NULL;
537
538     /* Check that the handle is valid */
539     if( !p_vlc || p_vlc->i_status != VLC_STATUS_RUNNING )
540     {
541         fprintf( stderr, "error: invalid status\n" );
542         return VLC_ESTATUS;
543     }
544
545     if( psz_module )
546     {
547         psz_oldmodule = config_GetPsz( p_vlc, "intf" );
548         config_PutPsz( p_vlc, "intf", psz_module );
549     }
550
551     /* Try to create the interface */
552     p_intf = intf_Create( p_vlc );
553
554     if( psz_module )
555     {
556         config_PutPsz( p_vlc, "intf", psz_oldmodule );
557         if( psz_oldmodule )
558         {
559             free( psz_oldmodule );
560         }
561     }
562
563     if( p_intf == NULL )
564     {
565         msg_Err( p_vlc, "interface initialization failed" );
566         return VLC_EGENERIC;
567     }
568
569     /* Try to run the interface */
570     p_intf->b_block = b_block;
571     err = intf_RunThread( p_intf );
572     if( err )
573     {
574         intf_Destroy( p_intf );
575         return err;
576     }
577
578     return VLC_SUCCESS;
579 }
580
581 /*****************************************************************************
582  * vlc_stop: stop playing.
583  *****************************************************************************
584  * This function requests the interface threads to finish, waits for their
585  * termination, and destroys their structure.
586  *****************************************************************************/
587 vlc_error_t vlc_stop( vlc_t *p_vlc )
588 {
589     intf_thread_t *p_intf;
590     playlist_t    *p_playlist;
591     vout_thread_t *p_vout;
592     aout_thread_t *p_aout;
593
594     /* Check that the handle is valid */
595     if( !p_vlc || p_vlc->i_status != VLC_STATUS_RUNNING )
596     {
597         fprintf( stderr, "error: invalid status\n" );
598         return VLC_ESTATUS;
599     }
600
601     /*
602      * Ask the interfaces to stop and destroy them
603      */
604     msg_Dbg( p_vlc, "removing all interfaces" );
605     while( (p_intf = vlc_object_find( p_vlc, VLC_OBJECT_INTF, FIND_CHILD )) )
606     {
607         intf_StopThread( p_intf );
608         vlc_object_detach_all( p_intf );
609         vlc_object_release( p_intf );
610         intf_Destroy( p_intf );
611     }
612
613     /*
614      * Free playlists
615      */
616     msg_Dbg( p_vlc, "removing all playlists" );
617     while( (p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST,
618                                           FIND_CHILD )) )
619     {
620         vlc_object_detach_all( p_playlist );
621         vlc_object_release( p_playlist );
622         playlist_Destroy( p_playlist );
623     }
624
625     /*
626      * Free video outputs
627      */
628     msg_Dbg( p_vlc, "removing all video outputs" );
629     while( (p_vout = vlc_object_find( p_vlc, VLC_OBJECT_VOUT, FIND_CHILD )) )
630     {
631         vlc_object_detach_all( p_vout );
632         vlc_object_release( p_vout );
633         vout_DestroyThread( p_vout );
634     }
635
636     /*
637      * Free audio outputs
638      */
639     msg_Dbg( p_vlc, "removing all audio outputs" );
640     while( (p_aout = vlc_object_find( p_vlc, VLC_OBJECT_AOUT, FIND_CHILD )) )
641     {
642         vlc_object_detach_all( p_aout );
643         vlc_object_release( p_aout );
644         aout_DestroyThread( p_aout );
645     }
646
647     /* Update the handle status */
648     p_vlc->i_status = VLC_STATUS_STOPPED;
649
650     return VLC_SUCCESS;
651 }
652
653 /*****************************************************************************
654  * vlc_end: uninitialize everything.
655  *****************************************************************************
656  * This function uninitializes every vlc component that was activated in
657  * vlc_init: audio and video outputs, playlist, module bank and message queue.
658  *****************************************************************************/
659 vlc_error_t vlc_end( vlc_t *p_vlc )
660 {
661     /* Check that the handle is valid */
662     if( !p_vlc || p_vlc->i_status != VLC_STATUS_STOPPED )
663     {
664         fprintf( stderr, "error: invalid status\n" );
665         return VLC_ESTATUS;
666     }
667
668     /*
669      * Go back into channel 0 which is the network
670      */
671     if( config_GetInt( p_vlc, "network-channel" ) && p_vlc->p_channel )
672     {
673         network_ChannelJoin( p_vlc, COMMON_CHANNEL );
674     }
675
676     /*
677      * Free allocated memory
678      */
679     if( p_vlc->p_memcpy_module != NULL )
680     {
681         module_Unneed( p_vlc->p_memcpy_module );
682     }
683
684     free( p_vlc->psz_homedir );
685
686     /*
687      * Free module bank
688      */
689     module_EndBank( p_vlc );
690
691     /*
692      * System specific cleaning code
693      */
694     system_End( p_vlc );
695
696     /*
697      * Terminate messages interface and program
698      */
699     msg_Destroy( p_vlc );
700
701     /* Update the handle status */
702     p_vlc->i_status = VLC_STATUS_CREATED;
703
704     return VLC_SUCCESS;
705 }
706
707 /*****************************************************************************
708  * vlc_destroy: free allocated resources.
709  *****************************************************************************
710  * This function frees the previously allocated vlc_t structure.
711  *****************************************************************************/
712 vlc_error_t vlc_destroy( vlc_t *p_vlc )
713 {
714     int i_index;
715
716     /* Check that the handle is valid */
717     if( !p_vlc || p_vlc->i_status != VLC_STATUS_CREATED )
718     {
719         fprintf( stderr, "error: invalid status\n" );
720         return VLC_ESTATUS;
721     }
722
723     /* Update the handle status, just in case */
724     p_vlc->i_status = VLC_STATUS_NONE;
725
726     /* Remove our structure from the global list */
727     vlc_mutex_lock( p_vlc->p_global_lock );
728     for( i_index = 0 ; i_index < i_vlc ; i_index++ )
729     {
730         if( pp_vlc[ i_index ] == p_vlc )
731         {
732             break;
733         }
734     }
735
736     if( i_index == i_vlc )
737     {
738         fprintf( stderr, "error: trying to unregister %p which is not in "
739                          "the list\n", p_vlc );
740         vlc_mutex_unlock( p_vlc->p_global_lock );
741         vlc_object_destroy( p_vlc );
742         return VLC_EGENERIC;
743     }
744
745     for( i_index++ ; i_index < i_vlc ; i_index++ )
746     {
747         pp_vlc[ i_index - 1 ] = pp_vlc[ i_index ];
748     }
749
750     i_vlc--;
751     if( i_vlc )
752     {
753         pp_vlc = realloc( pp_vlc, i_vlc * sizeof( vlc_t * ) );
754     }
755     else
756     {
757         free( pp_vlc );
758         pp_vlc = NULL;
759     }
760     vlc_mutex_unlock( p_vlc->p_global_lock );
761
762     /* Stop thread system FIXME: last one out please shut the door! */
763     //vlc_threads_end( );
764
765     /* Destroy mutexes */
766     vlc_mutex_destroy( &p_vlc->structure_lock );
767     vlc_mutex_destroy( &p_vlc->config_lock );
768
769     vlc_object_destroy( p_vlc );
770
771     return VLC_SUCCESS;
772 }
773
774 vlc_status_t vlc_status( vlc_t *p_vlc )
775 {
776     if( !p_vlc )
777     {
778         return VLC_STATUS_NONE;
779     }
780
781     return p_vlc->i_status;
782 }
783
784 vlc_error_t vlc_add_target( vlc_t *p_vlc, char *psz_target )
785 {
786     playlist_t *p_playlist;
787
788     if( !p_vlc || ( p_vlc->i_status != VLC_STATUS_STOPPED
789                      && p_vlc->i_status != VLC_STATUS_RUNNING ) )
790     {
791         fprintf( stderr, "error: invalid status\n" );
792         return VLC_ESTATUS;
793     }
794
795     p_playlist = vlc_object_find( p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
796
797     if( p_playlist == NULL )
798     {
799         msg_Dbg( p_vlc, "no playlist present, creating one" );
800         p_playlist = playlist_Create( p_vlc );
801
802         if( p_playlist == NULL )
803         {
804             return VLC_EGENERIC;
805         }
806
807         vlc_object_yield( p_playlist );
808     }
809
810     playlist_Add( p_playlist, PLAYLIST_END, psz_target );
811
812     vlc_object_release( p_playlist );
813
814     return VLC_SUCCESS;
815 }
816
817 /* following functions are local */
818
819 /*****************************************************************************
820  * GetFilenames: parse command line options which are not flags
821  *****************************************************************************
822  * Parse command line for input files.
823  *****************************************************************************/
824 static int GetFilenames( vlc_t *p_vlc, int i_argc, char *ppsz_argv[] )
825 {
826     int i_opt;
827
828     /* We assume that the remaining parameters are filenames */
829     for( i_opt = optind; i_opt < i_argc; i_opt++ )
830     {
831         vlc_add_target( p_vlc, ppsz_argv[ i_opt ] );
832     }
833
834     return VLC_SUCCESS;
835 }
836
837 /*****************************************************************************
838  * Usage: print program usage
839  *****************************************************************************
840  * Print a short inline help. Message interface is initialized at this stage.
841  *****************************************************************************/
842 static void Usage( vlc_t *p_this, const char *psz_module_name )
843 {
844 #define FORMAT_STRING "      --%s%s%s%s%s%s%s %s%s\n"
845     /* option name -------------'     | | | |  | |
846      * <bra --------------------------' | | |  | |
847      * option type or "" ---------------' | |  | |
848      * ket> ------------------------------' |  | |
849      * padding spaces ----------------------'  | |
850      * comment --------------------------------' |
851      * comment suffix ---------------------------'
852      *
853      * The purpose of having bra and ket is that we might i18n them as well.
854      */
855 #define LINE_START 8
856 #define PADDING_SPACES 25
857     module_t *p_module;
858     module_config_t *p_item;
859     char psz_spaces[PADDING_SPACES+LINE_START+1];
860     char psz_format[sizeof(FORMAT_STRING)];
861
862     memset( psz_spaces, ' ', PADDING_SPACES+LINE_START );
863     psz_spaces[PADDING_SPACES+LINE_START] = '\0';
864
865     strcpy( psz_format, FORMAT_STRING );
866
867 #ifdef WIN32
868     ShowConsole();
869 #endif
870
871     /* Enumerate the config for each module */
872     for( p_module = p_this->p_vlc->module_bank.first ;
873          p_module != NULL ;
874          p_module = p_module->next )
875     {
876         vlc_bool_t b_help_module = !strcmp( "help", p_module->psz_object_name );
877
878         if( psz_module_name && strcmp( psz_module_name,
879                                        p_module->psz_object_name ) )
880         {
881             continue;
882         }
883
884         /* Ignore modules without config options */
885         if( !p_module->i_config_items )
886         {
887             continue;
888         }
889
890         /* Print module name */
891         fprintf( stderr, _("%s module options:\n\n"),
892                          p_module->psz_object_name );
893
894         for( p_item = p_module->p_config;
895              p_item->i_type != MODULE_CONFIG_HINT_END;
896              p_item++ )
897         {
898             char *psz_bra = NULL, *psz_type = NULL, *psz_ket = NULL;
899             char *psz_suf = "", *psz_prefix = NULL;
900             int i;
901
902             switch( p_item->i_type )
903             {
904             case MODULE_CONFIG_HINT_CATEGORY:
905                 fprintf( stderr, " %s\n", p_item->psz_text );
906                 break;
907
908             case MODULE_CONFIG_ITEM_STRING:
909             case MODULE_CONFIG_ITEM_FILE:
910             case MODULE_CONFIG_ITEM_MODULE: /* We could also have "=<" here */
911                 psz_bra = " <"; psz_type = _("string"); psz_ket = ">";
912                 break;
913             case MODULE_CONFIG_ITEM_INTEGER:
914                 psz_bra = " <"; psz_type = _("integer"); psz_ket = ">";
915                 break;
916             case MODULE_CONFIG_ITEM_FLOAT:
917                 psz_bra = " <"; psz_type = _("float"); psz_ket = ">";
918                 break;
919             case MODULE_CONFIG_ITEM_BOOL:
920                 psz_bra = ""; psz_type = ""; psz_ket = "";
921                 if( !b_help_module )
922                 {
923                     psz_suf = p_item->i_value ? _(" (default enabled)") :
924                                                 _(" (default disabled)");
925                 }
926                 break;
927             }
928
929             /* Add short option */
930             if( p_item->i_short )
931             {
932                 psz_format[2] = '-';
933                 psz_format[3] = p_item->i_short;
934                 psz_format[4] = ',';
935             }
936             else
937             {
938                 psz_format[2] = ' ';
939                 psz_format[3] = ' ';
940                 psz_format[4] = ' ';
941             }
942
943             if( psz_type )
944             {
945                 i = PADDING_SPACES - strlen( p_item->psz_name )
946                      - strlen( psz_bra ) - strlen( psz_type )
947                      - strlen( psz_ket ) - 1;
948                 if( p_item->i_type == MODULE_CONFIG_ITEM_BOOL
949                      && !b_help_module )
950                 {
951                     vlc_bool_t b_dash = VLC_FALSE;
952                     psz_prefix = p_item->psz_name;
953                     while( *psz_prefix )
954                     {
955                         if( *psz_prefix++ == '-' )
956                         {
957                             b_dash = VLC_TRUE;
958                             break;
959                         }
960                     }
961
962                     if( b_dash )
963                     {
964                         psz_prefix = ", --no-";
965                         i -= strlen( p_item->psz_name ) + strlen( ", --no-" );
966                     }
967                     else
968                     {
969                         psz_prefix = ", --no";
970                         i -= strlen( p_item->psz_name ) + strlen( ", --no" );
971                     }
972                 }
973
974                 if( i < 0 )
975                 {
976                     i = 0;
977                     psz_spaces[i] = '\n';
978                 }
979                 else
980                 {
981                     psz_spaces[i] = '\0';
982                 }
983
984                 if( p_item->i_type == MODULE_CONFIG_ITEM_BOOL &&
985                     !b_help_module )
986                 {
987                     fprintf( stderr, psz_format, p_item->psz_name, psz_prefix,
988                              p_item->psz_name, psz_bra, psz_type, psz_ket,
989                              psz_spaces, p_item->psz_text, psz_suf );
990                 }
991                 else
992                 {
993                     fprintf( stderr, psz_format, p_item->psz_name, "", "",
994                              psz_bra, psz_type, psz_ket, psz_spaces,
995                              p_item->psz_text, psz_suf );
996                 }
997                 psz_spaces[i] = ' ';
998             }
999         }
1000
1001         /* Yet another nasty hack.
1002          * Maybe we could use MODULE_CONFIG_ITEM_END to display tail messages
1003          * for each module?? */
1004         if( !strcmp( "main", p_module->psz_object_name ) )
1005         {
1006             fprintf( stderr, _("\nPlaylist items:"
1007                 "\n  *.mpg, *.vob                   plain MPEG-1/2 files"
1008                 "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]"
1009                 "\n                                 DVD device"
1010                 "\n  [vcd:][device][@[title][,[chapter]]"
1011                 "\n                                 VCD device"
1012                 "\n  udpstream:[@[<bind address>][:<bind port>]]"
1013                 "\n                                 UDP stream sent by VLS"
1014                 "\n  vlc:loop                       loop execution of the "
1015                       "playlist"
1016                 "\n  vlc:pause                      pause execution of "
1017                       "playlist items"
1018                 "\n  vlc:quit                       quit VLC"
1019                 "\n") );
1020         }
1021
1022         fprintf( stderr, "\n" );
1023
1024     }
1025
1026 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1027         fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1028         getchar();
1029 #endif
1030 }
1031
1032 /*****************************************************************************
1033  * ListModules: list the available modules with their description
1034  *****************************************************************************
1035  * Print a list of all available modules (builtins and plugins) and a short
1036  * description for each one.
1037  *****************************************************************************/
1038 static void ListModules( vlc_t *p_this )
1039 {
1040     module_t *p_module;
1041     char psz_spaces[22];
1042
1043     memset( psz_spaces, ' ', 22 );
1044
1045 #ifdef WIN32
1046     ShowConsole();
1047 #endif
1048
1049     /* Usage */
1050     fprintf( stderr, _("Usage: %s [options] [parameters] [file]...\n\n"),
1051                      p_this->p_vlc->psz_object_name );
1052
1053     fprintf( stderr, _("[module]              [description]\n") );
1054
1055     /* Enumerate each module */
1056     for( p_module = p_this->p_vlc->module_bank.first ;
1057          p_module != NULL ;
1058          p_module = p_module->next )
1059     {
1060         int i;
1061
1062         /* Nasty hack, but right now I'm too tired to think about a nice
1063          * solution */
1064         i = 22 - strlen( p_module->psz_object_name ) - 1;
1065         if( i < 0 ) i = 0;
1066         psz_spaces[i] = 0;
1067
1068         fprintf( stderr, "  %s%s %s\n", p_module->psz_object_name, psz_spaces,
1069                   p_module->psz_longname );
1070
1071         psz_spaces[i] = ' ';
1072
1073     }
1074
1075 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1076         fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1077         getchar();
1078 #endif
1079 }
1080
1081 /*****************************************************************************
1082  * Version: print complete program version
1083  *****************************************************************************
1084  * Print complete program version and build number.
1085  *****************************************************************************/
1086 static void Version( void )
1087 {
1088 #ifdef WIN32
1089     ShowConsole();
1090 #endif
1091
1092     fprintf( stderr, VERSION_MESSAGE "\n" );
1093     fprintf( stderr,
1094       _("This program comes with NO WARRANTY, to the extent permitted by "
1095         "law.\nYou may redistribute it under the terms of the GNU General "
1096         "Public License;\nsee the file named COPYING for details.\n"
1097         "Written by the VideoLAN team at Ecole Centrale, Paris.\n") );
1098
1099 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1100     fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1101     getchar();
1102 #endif
1103 }
1104
1105 /*****************************************************************************
1106  * Build: print information about the vlc build
1107  *****************************************************************************
1108  * Print the ./configure command line and other information.
1109  *****************************************************************************/
1110 static void Build( void )
1111 {
1112 #ifdef WIN32
1113     ShowConsole();
1114 #endif
1115
1116     fprintf( stderr, "configured with %s\n", CONFIGURE_LINE );
1117
1118 #ifdef WIN32        /* Pause the console because it's destroyed when we exit */
1119     fprintf( stderr, _("\nPress the RETURN key to continue...\n") );
1120     getchar();
1121 #endif
1122 }
1123
1124 /*****************************************************************************
1125  * ShowConsole: On Win32, create an output console for debug messages
1126  *****************************************************************************
1127  * This function is useful only on Win32.
1128  *****************************************************************************/
1129 #ifdef WIN32 /*  */
1130 static void ShowConsole( void )
1131 {
1132     AllocConsole();
1133     freopen( "CONOUT$", "w", stdout );
1134     freopen( "CONOUT$", "w", stderr );
1135     freopen( "CONIN$", "r", stdin );
1136     return;
1137 }
1138 #endif
1139
1140 #ifndef WIN32
1141 /*****************************************************************************
1142  * InitSignalHandler: system signal handler initialization
1143  *****************************************************************************
1144  * Set the signal handlers. SIGTERM is not intercepted, because we need at
1145  * at least a method to kill the program when all other methods failed, and
1146  * when we don't want to use SIGKILL.
1147  *****************************************************************************/
1148 static void InitSignalHandler( void )
1149 {
1150     /* Termination signals */
1151     signal( SIGINT,  FatalSignalHandler );
1152     signal( SIGHUP,  FatalSignalHandler );
1153     signal( SIGQUIT, FatalSignalHandler );
1154
1155     /* Other signals */
1156     signal( SIGALRM, SimpleSignalHandler );
1157     signal( SIGPIPE, SimpleSignalHandler );
1158 }
1159
1160 /*****************************************************************************
1161  * SimpleSignalHandler: system signal handler
1162  *****************************************************************************
1163  * This function is called when a non fatal signal is received by the program.
1164  *****************************************************************************/
1165 static void SimpleSignalHandler( int i_signal )
1166 {
1167     int i_index;
1168
1169     /* Acknowledge the signal received and warn all the p_vlc structures */
1170     vlc_mutex_lock( &global_lock );
1171     for( i_index = 0 ; i_index < i_vlc ; i_index++ )
1172     {
1173         msg_Warn( pp_vlc[ i_index ], "ignoring signal %d", i_signal );
1174     }
1175     vlc_mutex_unlock( &global_lock );
1176 }
1177
1178 /*****************************************************************************
1179  * FatalSignalHandler: system signal handler
1180  *****************************************************************************
1181  * This function is called when a fatal signal is received by the program.
1182  * It tries to end the program in a clean way.
1183  *****************************************************************************/
1184 static void FatalSignalHandler( int i_signal )
1185 {
1186     static mtime_t abort_time = 0;
1187     static volatile vlc_bool_t b_die = VLC_FALSE;
1188     int i_index;
1189
1190     /* Once a signal has been trapped, the termination sequence will be
1191      * armed and following signals will be ignored to avoid sending messages
1192      * to an interface having been destroyed */
1193
1194     vlc_mutex_lock( &global_lock );
1195     if( !b_die )
1196     {
1197         b_die = VLC_TRUE;
1198         abort_time = mdate();
1199
1200         /* Try to terminate everything - this is done by requesting the end of
1201          * all the p_vlc structures */
1202         for( i_index = 0 ; i_index < i_vlc ; i_index++ )
1203         {
1204             /* Acknowledge the signal received */
1205             msg_Err( pp_vlc[ i_index ], "signal %d received, exiting - do it "
1206                      "again in case vlc gets stuck", i_signal );
1207             pp_vlc[ i_index ]->b_die = VLC_TRUE;
1208         }
1209     }
1210     else if( mdate() > abort_time + 1000000 )
1211     {
1212         /* If user asks again 1 second later, die badly */
1213         signal( SIGINT,  SIG_IGN );
1214         signal( SIGHUP,  SIG_IGN );
1215         signal( SIGQUIT, SIG_IGN );
1216
1217         for( i_index = 0 ; i_index < i_vlc ; i_index++ )
1218         {
1219             msg_Err( pp_vlc[ i_index ], "user insisted too much, dying badly" );
1220         }
1221
1222         vlc_mutex_unlock( &global_lock );
1223         exit( 1 );
1224     }
1225
1226     vlc_mutex_unlock( &global_lock );
1227 }
1228 #endif
1229