1 /*****************************************************************************
2 * libvlc.c: libvlc instances creation and deletion, interfaces handling
3 *****************************************************************************
4 * Copyright (C) 1998-2008 VLC authors and VideoLAN
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * RĂ©mi Denis-Courmont <rem # videolan : org>
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.
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.
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 *****************************************************************************/
29 * This file contains functions to create and destroy libvlc instances
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
40 #include "../lib/libvlc_internal.h"
41 #include <vlc_input.h>
43 #include "modules/modules.h"
44 #include "config/configuration.h"
45 #include "playlist/preparser.h"
47 #include <stdio.h> /* sprintf() */
49 #include <stdlib.h> /* free() */
52 #include "config/vlc_getopt.h"
54 #include <vlc_playlist.h>
55 #include <vlc_interface.h>
57 #include <vlc_charset.h>
58 #include <vlc_dialog.h>
59 #include <vlc_keystore.h>
63 #include <vlc_modules.h>
66 #include "playlist/playlist_internal.h"
67 #include "misc/variables.h"
73 /*****************************************************************************
75 *****************************************************************************/
76 static void GetFilenames ( libvlc_int_t
*, unsigned, const char *const [] );
79 * Allocate a blank libvlc instance, also setting the exit handler.
80 * Vlc's threading system must have been initialized first
82 libvlc_int_t
* libvlc_InternalCreate( void )
84 libvlc_int_t
*p_libvlc
;
87 /* Allocate a libvlc instance object */
88 p_libvlc
= (vlc_custom_create
)( NULL
, sizeof (*priv
), "libvlc" );
89 if( p_libvlc
== NULL
)
92 priv
= libvlc_priv (p_libvlc
);
93 priv
->playlist
= NULL
;
96 vlc_ExitInit( &priv
->exit
);
102 * Initialize a libvlc instance
103 * This function initializes a previously allocated libvlc instance:
105 * - gettext initialization
106 * - message queue, module bank and playlist initialization
107 * - configuration and commandline parsing
109 int libvlc_InternalInit( libvlc_int_t
*p_libvlc
, int i_argc
,
110 const char *ppsz_argv
[] )
112 libvlc_priv_t
*priv
= libvlc_priv (p_libvlc
);
113 char * psz_modules
= NULL
;
114 char * psz_parser
= NULL
;
115 char * psz_control
= NULL
;
117 int i_ret
= VLC_EGENERIC
;
119 /* System specific initialization code */
122 vlc_LogPreinit(p_libvlc
);
124 /* Initialize the module bank and load the configuration of the
125 * core module. We need to do this at this stage to be able to display
126 * a short help if required by the user. (short help == core module
130 /* Get command line options that affect module loading. */
131 if( config_LoadCmdLine( p_libvlc
, i_argc
, ppsz_argv
, NULL
) )
133 module_EndBank (false);
137 vlc_threads_setup (p_libvlc
);
139 /* Load the builtins and plugins into the module_bank.
140 * We have to do it before config_Load*() because this also gets the
141 * list of configuration options exported by each module and loads their
143 size_t module_count
= module_LoadPlugins (p_libvlc
);
146 * Override default configuration with config file settings
148 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
150 if( var_InheritBool( p_libvlc
, "reset-config" ) )
151 config_SaveConfigFile( p_libvlc
); /* Save default config */
153 config_LoadConfigFile( p_libvlc
);
157 * Override configuration with command line settings
160 if( config_LoadCmdLine( p_libvlc
, i_argc
, ppsz_argv
, &vlc_optind
) )
163 vlc_LogInit(p_libvlc
);
166 * Support for gettext
168 #if defined( ENABLE_NLS ) \
169 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
170 vlc_bindtextdomain (PACKAGE_NAME
);
172 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
173 msg_Dbg( p_libvlc
, "translation test: code is \"%s\"", _("C") );
175 if (config_PrintHelp (VLC_OBJECT(p_libvlc
)))
177 libvlc_InternalCleanup (p_libvlc
);
181 if( module_count
<= 1 )
183 msg_Err( p_libvlc
, "No plugins found! Check your VLC installation.");
189 /* Check for daemon mode */
190 if( var_InheritBool( p_libvlc
, "daemon" ) )
192 if( daemon( 1, 0) != 0 )
194 msg_Err( p_libvlc
, "Unable to fork vlc to daemon mode" );
198 /* lets check if we need to write the pidfile */
199 char *pidfile
= var_InheritString( p_libvlc
, "pidfile" );
200 if( pidfile
!= NULL
)
202 FILE *stream
= vlc_fopen( pidfile
, "w" );
205 fprintf( stream
, "%d", (int)getpid() );
207 msg_Dbg( p_libvlc
, "written PID file %s", pidfile
);
210 msg_Err( p_libvlc
, "cannot write PID file %s: %s",
211 pidfile
, vlc_strerror_c(errno
) );
217 var_Create( p_libvlc
, "pidfile", VLC_VAR_STRING
);
218 var_SetString( p_libvlc
, "pidfile", "" );
224 if( libvlc_InternalDialogInit( p_libvlc
) != VLC_SUCCESS
)
226 if( libvlc_InternalKeystoreInit( p_libvlc
) != VLC_SUCCESS
)
227 msg_Warn( p_libvlc
, "memory keystore init failed" );
229 vlc_CPU_dump( VLC_OBJECT(p_libvlc
) );
231 priv
->b_stats
= var_InheritBool( p_libvlc
, "stats" );
234 * Initialize hotkey handling
236 priv
->actions
= vlc_InitActions( p_libvlc
);
243 priv
->parser
= playlist_preparser_New(VLC_OBJECT(p_libvlc
));
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 );
251 /* Create a variable for the Boss Key */
252 var_Create( p_libvlc
, "intf-boss", VLC_VAR_VOID
);
254 /* Create a variable for showing the main interface */
255 var_Create( p_libvlc
, "intf-show", VLC_VAR_BOOL
);
257 /* Create a variable for showing the right click menu */
258 var_Create( p_libvlc
, "intf-popupmenu", VLC_VAR_BOOL
);
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
);
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
);
283 /* System specific configuration */
284 system_Configure( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
287 /* Initialize VLM if vlm-conf is specified */
288 psz_parser
= var_CreateGetNonEmptyString( p_libvlc
, "vlm-conf" );
291 priv
->p_vlm
= vlm_New( p_libvlc
);
293 msg_Err( p_libvlc
, "VLM initialization failed" );
299 * Load background interfaces
301 psz_modules
= var_CreateGetNonEmptyString( p_libvlc
, "extraintf" );
302 psz_control
= var_CreateGetNonEmptyString( p_libvlc
, "control" );
304 if( psz_modules
&& psz_control
)
307 if( asprintf( &psz_tmp
, "%s:%s", psz_modules
, psz_control
) != -1 )
310 psz_modules
= psz_tmp
;
313 else if( psz_control
)
316 psz_modules
= strdup( psz_control
);
319 psz_parser
= psz_modules
;
320 while ( psz_parser
&& *psz_parser
)
322 char *psz_module
, *psz_temp
;
323 psz_module
= psz_parser
;
324 psz_parser
= strchr( psz_module
, ':' );
330 if( asprintf( &psz_temp
, "%s,none", psz_module
) != -1)
332 libvlc_InternalAddIntf( p_libvlc
, psz_temp
);
339 if( var_InheritBool( p_libvlc
, "network-synchronisation") )
340 libvlc_InternalAddIntf( p_libvlc
, "netsync,none" );
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
);
355 * Get input filenames given as commandline arguments.
356 * We assume that the remaining parameters are filenames
357 * and their input options.
359 GetFilenames( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
362 * Get --open argument
364 psz_val
= var_InheritString( p_libvlc
, "open" );
365 if ( psz_val
!= NULL
)
367 intf_InsertItem( p_libvlc
, psz_val
, 0, NULL
, 0 );
374 libvlc_InternalCleanup( p_libvlc
);
379 * Cleanup a libvlc instance. The instance is not completely deallocated
380 * \param p_libvlc the instance to clean
382 void libvlc_InternalCleanup( libvlc_int_t
*p_libvlc
)
384 libvlc_priv_t
*priv
= libvlc_priv (p_libvlc
);
386 if (priv
->parser
!= NULL
)
387 playlist_preparser_Deactivate(priv
->parser
);
389 /* Ask the interfaces to stop and destroy them */
390 msg_Dbg( p_libvlc
, "removing all interfaces" );
391 intf_DestroyAll( p_libvlc
);
393 libvlc_InternalDialogClean( p_libvlc
);
394 libvlc_InternalKeystoreClean( p_libvlc
);
397 /* Destroy VLM if created in libvlc_InternalInit */
400 vlm_Delete( priv
->p_vlm
);
404 #if !defined( _WIN32 ) && !defined( __OS2__ )
405 char *pidfile
= var_InheritString( p_libvlc
, "pidfile" );
406 if( pidfile
!= NULL
)
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
) );
416 if (priv
->parser
!= NULL
)
417 playlist_preparser_Delete(priv
->parser
);
419 vlc_DeinitActions( p_libvlc
, priv
->actions
);
421 /* Save the configuration */
422 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
423 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc
) );
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__)
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
440 void libvlc_InternalDestroy( libvlc_int_t
*p_libvlc
)
442 libvlc_priv_t
*priv
= libvlc_priv( p_libvlc
);
444 vlc_ExitDestroy( &priv
->exit
);
446 assert( atomic_load(&(vlc_internals(p_libvlc
)->refs
)) == 1 );
447 vlc_object_release( p_libvlc
);
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 *****************************************************************************/
456 static void GetFilenames( libvlc_int_t
*p_vlc
, unsigned n
,
457 const char *const args
[] )
461 /* Count the input options */
462 unsigned i_options
= 0;
464 while( args
[--n
][0] == ':' )
469 msg_Warn( p_vlc
, "options %s without item", args
[n
] );
470 return; /* syntax!? */
475 if( strstr( args
[n
], "://" ) == NULL
)
477 mrl
= vlc_path2uri( args
[n
], NULL
);
482 intf_InsertItem( p_vlc
, (mrl
!= NULL
) ? mrl
: args
[n
], i_options
,
483 ( i_options
? &args
[n
+ 1] : NULL
),
484 VLC_INPUT_OPTION_TRUSTED
);
490 * Requests extraction of the meta data for an input item (a.k.a. preparsing).
491 * The actual extraction is asynchronous. It can be cancelled with
492 * libvlc_MetadataCancel()
494 int libvlc_MetadataRequest(libvlc_int_t
*libvlc
, input_item_t
*item
,
495 input_item_meta_request_option_t i_options
,
496 int timeout
, void *id
)
498 libvlc_priv_t
*priv
= libvlc_priv(libvlc
);
500 if (unlikely(priv
->parser
== NULL
))
503 vlc_mutex_lock( &item
->lock
);
504 if( item
->i_preparse_depth
== 0 )
505 item
->i_preparse_depth
= 1;
506 if( i_options
& META_REQUEST_OPTION_DO_INTERACT
)
507 item
->b_preparse_interact
= true;
508 vlc_mutex_unlock( &item
->lock
);
509 playlist_preparser_Push( priv
->parser
, item
, i_options
, timeout
, id
);
514 * Requests retrieving/downloading art for an input item.
515 * The retrieval is performed asynchronously.
517 int libvlc_ArtRequest(libvlc_int_t
*libvlc
, input_item_t
*item
,
518 input_item_meta_request_option_t i_options
)
520 libvlc_priv_t
*priv
= libvlc_priv(libvlc
);
522 if (unlikely(priv
->parser
== NULL
))
525 playlist_preparser_fetcher_Push(priv
->parser
, item
, i_options
);
530 * Cancels extraction of the meta data for an input item.
532 * This does nothing if the input item is already processed or if it was not
533 * added with libvlc_MetadataRequest()
535 void libvlc_MetadataCancel(libvlc_int_t
*libvlc
, void *id
)
537 libvlc_priv_t
*priv
= libvlc_priv(libvlc
);
539 if (unlikely(priv
->parser
== NULL
))
542 playlist_preparser_Cancel(priv
->parser
, id
);