1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 VLC authors and VideoLAN
5 * $Id: 25f7c7d6d2e83d70b576e07e2fd501997dea5c47 $
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
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU Lesser General Public License as published by
15 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
22 *
23 * You should have received a copy of the GNU Lesser General Public License
24 * along with this program; if not, write to the Free Software Foundation,
25 * 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 "../lib/libvlc_internal.h"
41 #include <vlc_input.h>
42
43 #include "modules/modules.h"
44 #include "config/configuration.h"
45 #include "playlist/preparser.h"
46
47 #include <stdio.h> /* sprintf() */
48 #include <string.h>
49 #include <stdlib.h> /* free() */
50 #include <errno.h>
51
52 #include "config/vlc_getopt.h"
53
54 #include <vlc_playlist.h>
55 #include <vlc_interface.h>
56
57 #include <vlc_actions.h>
58 #include <vlc_charset.h>
59 #include <vlc_dialog.h>
60 #include <vlc_keystore.h>
61 #include <vlc_fs.h>
62 #include <vlc_cpu.h>
63 #include <vlc_url.h>
64 #include <vlc_modules.h>
65
66 #include "libvlc.h"
67 #include "playlist/playlist_internal.h"
68 #include "misc/variables.h"
69
70 #include <vlc_vlm.h>
71
72 #include <assert.h>
73
74 /*****************************************************************************
75 * Local prototypes
76 *****************************************************************************/
77 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
78
79 /**
80 * Allocate a blank libvlc instance, also setting the exit handler.
81 * Vlc's threading system must have been initialized first
82 */
libvlc_InternalCreate(void)83 libvlc_int_t * libvlc_InternalCreate( void )
84 {
85 libvlc_int_t *p_libvlc;
86 libvlc_priv_t *priv;
87
88 /* Allocate a libvlc instance object */
89 p_libvlc = (vlc_custom_create)( NULL, sizeof (*priv), "libvlc" );
90 if( p_libvlc == NULL )
91 return NULL;
92
93 priv = libvlc_priv (p_libvlc);
94 priv->playlist = NULL;
95 priv->p_vlm = NULL;
96
97 vlc_ExitInit( &priv->exit );
98
99 return p_libvlc;
100 }
101
102 /**
103 * Initialize a libvlc instance
104 * This function initializes a previously allocated libvlc instance:
105 * - CPU detection
106 * - gettext initialization
107 * - message queue, module bank and playlist initialization
108 * - configuration and commandline parsing
109 */
libvlc_InternalInit(libvlc_int_t * p_libvlc,int i_argc,const char * ppsz_argv[])110 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
111 const char *ppsz_argv[] )
112 {
113 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
114 char * psz_modules = NULL;
115 char * psz_parser = NULL;
116 char * psz_control = NULL;
117 char *psz_val;
118 int i_ret = VLC_EGENERIC;
119
120 /* System specific initialization code */
121 system_Init();
122
123 vlc_LogPreinit(p_libvlc);
124
125 /* Initialize the module bank and load the configuration of the
126 * core module. We need to do this at this stage to be able to display
127 * a short help if required by the user. (short help == core module
128 * options) */
129 module_InitBank ();
130
131 /* Get command line options that affect module loading. */
132 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
133 {
134 module_EndBank (false);
135 return VLC_EGENERIC;
136 }
137
138 vlc_threads_setup (p_libvlc);
139
140 /* Load the builtins and plugins into the module_bank.
141 * We have to do it before config_Load*() because this also gets the
142 * list of configuration options exported by each module and loads their
143 * default values. */
144 size_t module_count = module_LoadPlugins (p_libvlc);
145
146 /*
147 * Override default configuration with config file settings
148 */
149 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
150 {
151 if( var_InheritBool( p_libvlc, "reset-config" ) )
152 config_SaveConfigFile( p_libvlc ); /* Save default config */
153 else
154 config_LoadConfigFile( p_libvlc );
155 }
156
157 /*
158 * Override configuration with command line settings
159 */
160 int vlc_optind;
161 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
162 goto error;
163
164 vlc_LogInit(p_libvlc);
165
166 /*
167 * Support for gettext
168 */
169 #if defined( ENABLE_NLS ) \
170 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
171 vlc_bindtextdomain (PACKAGE_NAME);
172 #endif
173 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
174 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
175
176 if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
177 {
178 libvlc_InternalCleanup (p_libvlc);
179 exit(0);
180 }
181
182 if( module_count <= 1 )
183 {
184 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
185 i_ret = VLC_ENOMOD;
186 goto error;
187 }
188
189 #ifdef HAVE_DAEMON
190 /* Check for daemon mode */
191 if( var_InheritBool( p_libvlc, "daemon" ) )
192 {
193 if( daemon( 1, 0) != 0 )
194 {
195 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
196 goto error;
197 }
198
199 /* lets check if we need to write the pidfile */
200 char *pidfile = var_InheritString( p_libvlc, "pidfile" );
201 if( pidfile != NULL )
202 {
203 FILE *stream = vlc_fopen( pidfile, "w" );
204 if( stream != NULL )
205 {
206 fprintf( stream, "%d", (int)getpid() );
207 fclose( stream );
208 msg_Dbg( p_libvlc, "written PID file %s", pidfile );
209 }
210 else
211 msg_Err( p_libvlc, "cannot write PID file %s: %s",
212 pidfile, vlc_strerror_c(errno) );
213 free( pidfile );
214 }
215 }
216 else
217 {
218 var_Create( p_libvlc, "pidfile", VLC_VAR_STRING );
219 var_SetString( p_libvlc, "pidfile", "" );
220 }
221 #endif
222
223 i_ret = VLC_ENOMEM;
224
225 if( libvlc_InternalDialogInit( p_libvlc ) != VLC_SUCCESS )
226 goto error;
227 if( libvlc_InternalKeystoreInit( p_libvlc ) != VLC_SUCCESS )
228 msg_Warn( p_libvlc, "memory keystore init failed" );
229
230 vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
231
232 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
233
234 /*
235 * Initialize hotkey handling
236 */
237 if( libvlc_InternalActionsInit( p_libvlc ) != VLC_SUCCESS )
238 goto error;
239
240 /*
241 * Meta data handling
242 */
243 priv->parser = playlist_preparser_New(VLC_OBJECT(p_libvlc));
244 if( !priv->parser )
245 goto error;
246
247 /* Create a variable for showing the fullscreen interface */
248 var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
249 var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
250
251 /* Create a variable for the Boss Key */
252 var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
253
254 /* Create a variable for showing the main interface */
255 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
256
257 /* Create a variable for showing the right click menu */
258 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
259
260 /* variables for signalling creation of new files */
261 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
262 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
263
264 /* some default internal settings */
265 var_Create( p_libvlc, "window", VLC_VAR_STRING );
266 /* NOTE: Because the playlist and interfaces start before this function
267 * returns control to the application (DESIGN BUG!), all these variables
268 * must be created (in place of libvlc_new()) and set to VLC defaults
269 * (in place of VLC main()) *here*. */
270 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
271 var_SetString( p_libvlc, "user-agent",
272 "VLC media player (LibVLC "VERSION")" );
273 var_Create( p_libvlc, "http-user-agent", VLC_VAR_STRING );
274 var_SetString( p_libvlc, "http-user-agent",
275 "VLC/"PACKAGE_VERSION" LibVLC/"PACKAGE_VERSION );
276 var_Create( p_libvlc, "app-icon-name", VLC_VAR_STRING );
277 var_SetString( p_libvlc, "app-icon-name", PACKAGE_NAME );
278 var_Create( p_libvlc, "app-id", VLC_VAR_STRING );
279 var_SetString( p_libvlc, "app-id", "org.VideoLAN.VLC" );
280 var_Create( p_libvlc, "app-version", VLC_VAR_STRING );
281 var_SetString( p_libvlc, "app-version", PACKAGE_VERSION );
282
283 /* System specific configuration */
284 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
285
286 #ifdef ENABLE_VLM
287 /* Initialize VLM if vlm-conf is specified */
288 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
289 if( psz_parser )
290 {
291 priv->p_vlm = vlm_New( p_libvlc );
292 if( !priv->p_vlm )
293 msg_Err( p_libvlc, "VLM initialization failed" );
294 }
295 free( psz_parser );
296 #endif
297
298 /*
299 * Load background interfaces
300 */
301 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
302 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
303
304 if( psz_modules && psz_control )
305 {
306 char* psz_tmp;
307 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
308 {
309 free( psz_modules );
310 psz_modules = psz_tmp;
311 }
312 }
313 else if( psz_control )
314 {
315 free( psz_modules );
316 psz_modules = strdup( psz_control );
317 }
318
319 psz_parser = psz_modules;
320 while ( psz_parser && *psz_parser )
321 {
322 char *psz_module, *psz_temp;
323 psz_module = psz_parser;
324 psz_parser = strchr( psz_module, ':' );
325 if ( psz_parser )
326 {
327 *psz_parser = '\0';
328 psz_parser++;
329 }
330 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
331 {
332 libvlc_InternalAddIntf( p_libvlc, psz_temp );
333 free( psz_temp );
334 }
335 }
336 free( psz_modules );
337 free( psz_control );
338
339 if( var_InheritBool( p_libvlc, "network-synchronisation") )
340 libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
341
342 #ifdef __APPLE__
343 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
344 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
345 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
346 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
347 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
348 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
349 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
350 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
351 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
352 #endif
353
354 /*
355 * Get input filenames given as commandline arguments.
356 * We assume that the remaining parameters are filenames
357 * and their input options.
358 */
359 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
360
361 /*
362 * Get --open argument
363 */
364 psz_val = var_InheritString( p_libvlc, "open" );
365 if ( psz_val != NULL )
366 {
367 intf_InsertItem( p_libvlc, psz_val, 0, NULL, 0 );
368 free( psz_val );
369 }
370
371 return VLC_SUCCESS;
372
373 error:
374 libvlc_InternalCleanup( p_libvlc );
375 return i_ret;
376 }
377
378 /**
379 * Cleanup a libvlc instance. The instance is not completely deallocated
380 * \param p_libvlc the instance to clean
381 */
libvlc_InternalCleanup(libvlc_int_t * p_libvlc)382 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
383 {
384 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
385
386 if (priv->parser != NULL)
387 playlist_preparser_Deactivate(priv->parser);
388
389 /* Ask the interfaces to stop and destroy them */
390 msg_Dbg( p_libvlc, "removing all interfaces" );
391 intf_DestroyAll( p_libvlc );
392
393 libvlc_InternalDialogClean( p_libvlc );
394 libvlc_InternalKeystoreClean( p_libvlc );
395
396 #ifdef ENABLE_VLM
397 /* Destroy VLM if created in libvlc_InternalInit */
398 if( priv->p_vlm )
399 {
400 vlm_Delete( priv->p_vlm );
401 }
402 #endif
403
404 #if !defined( _WIN32 ) && !defined( __OS2__ )
405 char *pidfile = var_InheritString( p_libvlc, "pidfile" );
406 if( pidfile != NULL )
407 {
408 msg_Dbg( p_libvlc, "removing PID file %s", pidfile );
409 if( unlink( pidfile ) )
410 msg_Warn( p_libvlc, "cannot remove PID file %s: %s",
411 pidfile, vlc_strerror_c(errno) );
412 free( pidfile );
413 }
414 #endif
415
416 if (priv->parser != NULL)
417 playlist_preparser_Delete(priv->parser);
418
419 libvlc_InternalActionsClean( p_libvlc );
420
421 /* Save the configuration */
422 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
423 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
424
425 /* Free module bank. It is refcounted, so we call this each time */
426 vlc_LogDeinit (p_libvlc);
427 module_EndBank (true);
428 #if defined(_WIN32) || defined(__OS2__)
429 system_End( );
430 #endif
431 }
432
433 /**
434 * Destroy everything.
435 * This function requests the running threads to finish, waits for their
436 * termination, and destroys their structure.
437 * It stops the thread systems: no instance can run after this has run
438 * \param p_libvlc the instance to destroy
439 */
libvlc_InternalDestroy(libvlc_int_t * p_libvlc)440 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
441 {
442 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
443
444 vlc_ExitDestroy( &priv->exit );
445
446 assert( atomic_load(&(vlc_internals(p_libvlc)->refs)) == 1 );
447 vlc_object_release( p_libvlc );
448 }
449
450 /*****************************************************************************
451 * GetFilenames: parse command line options which are not flags
452 *****************************************************************************
453 * Parse command line for input files as well as their associated options.
454 * An option always follows its associated input and begins with a ":".
455 *****************************************************************************/
GetFilenames(libvlc_int_t * p_vlc,unsigned n,const char * const args[])456 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
457 const char *const args[] )
458 {
459 while( n > 0 )
460 {
461 /* Count the input options */
462 unsigned i_options = 0;
463
464 while( args[--n][0] == ':' )
465 {
466 i_options++;
467 if( n == 0 )
468 {
469 msg_Warn( p_vlc, "options %s without item", args[n] );
470 return; /* syntax!? */
471 }
472 }
473
474 char *mrl = NULL;
475 if( strstr( args[n], "://" ) == NULL )
476 {
477 mrl = vlc_path2uri( args[n], NULL );
478 if( !mrl )
479 continue;
480 }
481
482 intf_InsertItem( p_vlc, (mrl != NULL) ? mrl : args[n], i_options,
483 ( i_options ? &args[n + 1] : NULL ),
484 VLC_INPUT_OPTION_TRUSTED );
485 free( mrl );
486 }
487 }
488
vlc_MetadataRequest(libvlc_int_t * libvlc,input_item_t * item,input_item_meta_request_option_t i_options,int timeout,void * id)489 int vlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
490 input_item_meta_request_option_t i_options,
491 int timeout, void *id)
492 {
493 libvlc_priv_t *priv = libvlc_priv(libvlc);
494
495 if (unlikely(priv->parser == NULL))
496 return VLC_ENOMEM;
497
498 if( i_options & META_REQUEST_OPTION_DO_INTERACT )
499 {
500 vlc_mutex_lock( &item->lock );
501 item->b_preparse_interact = true;
502 vlc_mutex_unlock( &item->lock );
503 }
504 playlist_preparser_Push( priv->parser, item, i_options, timeout, id );
505 return VLC_SUCCESS;
506
507 }
508
509 /**
510 * Requests extraction of the meta data for an input item (a.k.a. preparsing).
511 * The actual extraction is asynchronous. It can be cancelled with
512 * libvlc_MetadataCancel()
513 */
libvlc_MetadataRequest(libvlc_int_t * libvlc,input_item_t * item,input_item_meta_request_option_t i_options,int timeout,void * id)514 int libvlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
515 input_item_meta_request_option_t i_options,
516 int timeout, void *id)
517 {
518 libvlc_priv_t *priv = libvlc_priv(libvlc);
519
520 if (unlikely(priv->parser == NULL))
521 return VLC_ENOMEM;
522
523 vlc_mutex_lock( &item->lock );
524 if( item->i_preparse_depth == 0 )
525 item->i_preparse_depth = 1;
526 if( i_options & META_REQUEST_OPTION_DO_INTERACT )
527 item->b_preparse_interact = true;
528 vlc_mutex_unlock( &item->lock );
529 playlist_preparser_Push( priv->parser, item, i_options, timeout, id );
530 return VLC_SUCCESS;
531 }
532
533 /**
534 * Requests retrieving/downloading art for an input item.
535 * The retrieval is performed asynchronously.
536 */
libvlc_ArtRequest(libvlc_int_t * libvlc,input_item_t * item,input_item_meta_request_option_t i_options)537 int libvlc_ArtRequest(libvlc_int_t *libvlc, input_item_t *item,
538 input_item_meta_request_option_t i_options)
539 {
540 libvlc_priv_t *priv = libvlc_priv(libvlc);
541
542 if (unlikely(priv->parser == NULL))
543 return VLC_ENOMEM;
544
545 playlist_preparser_fetcher_Push(priv->parser, item, i_options);
546 return VLC_SUCCESS;
547 }
548
549 /**
550 * Cancels extraction of the meta data for an input item.
551 *
552 * This does nothing if the input item is already processed or if it was not
553 * added with libvlc_MetadataRequest()
554 */
libvlc_MetadataCancel(libvlc_int_t * libvlc,void * id)555 void libvlc_MetadataCancel(libvlc_int_t *libvlc, void *id)
556 {
557 libvlc_priv_t *priv = libvlc_priv(libvlc);
558
559 if (unlikely(priv->parser == NULL))
560 return;
561
562 playlist_preparser_Cancel(priv->parser, id);
563 }
564