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