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"
46 #include <stdio.h> /* sprintf() */
48 #include <stdlib.h> /* free() */
50 #include "config/vlc_getopt.h"
53 /* used for one-instance mode */
54 # include <dbus/dbus.h>
58 #include <vlc_media_library.h>
59 #include <vlc_playlist.h>
60 #include <vlc_interface.h>
62 #include <vlc_charset.h>
66 #include <vlc_modules.h>
69 #include "playlist/playlist_internal.h"
70 #include "misc/variables.h"
75 # include <libkern/OSAtomic.h>
80 /*****************************************************************************
81 * The evil global variables. We handle them with care, don't worry.
82 *****************************************************************************/
84 #if !defined(WIN32) && !defined(__OS2__)
85 static bool b_daemon = false;
88 /*****************************************************************************
90 *****************************************************************************/
91 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
94 * Allocate a libvlc instance, initialize global data if needed
95 * It also initializes the threading system
97 libvlc_int_t * libvlc_InternalCreate( void )
99 libvlc_int_t *p_libvlc;
102 /* Now that the thread system is initialized, we don't have much, but
103 * at least we have variables */
104 /* Allocate a libvlc instance object */
105 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
107 if( p_libvlc == NULL )
110 priv = libvlc_priv (p_libvlc);
111 priv->p_playlist = NULL;
113 priv->p_dialog_provider = NULL;
116 /* Initialize mutexes */
117 vlc_mutex_init( &priv->ml_lock );
118 vlc_ExitInit( &priv->exit );
124 * Initialize a libvlc instance
125 * This function initializes a previously allocated libvlc instance:
127 * - gettext initialization
128 * - message queue, module bank and playlist initialization
129 * - configuration and commandline parsing
131 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
132 const char *ppsz_argv[] )
134 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
135 char * psz_modules = NULL;
136 char * psz_parser = NULL;
137 char * psz_control = NULL;
140 /* System specific initialization code */
143 /* Initialize the module bank and load the configuration of the
144 * main module. We need to do this at this stage to be able to display
145 * a short help if required by the user. (short help == main module
149 /* Get command line options that affect module loading. */
150 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
152 module_EndBank (false);
156 vlc_LogInit (p_libvlc);
157 vlc_threads_setup (p_libvlc);
159 /* Load the builtins and plugins into the module_bank.
160 * We have to do it before config_Load*() because this also gets the
161 * list of configuration options exported by each module and loads their
163 size_t module_count = module_LoadPlugins (p_libvlc);
166 * Override default configuration with config file settings
168 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
170 if( var_InheritBool( p_libvlc, "reset-config" ) )
171 config_SaveConfigFile( p_libvlc ); /* Save default config */
173 config_LoadConfigFile( p_libvlc );
177 * Override configuration with command line settings
180 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
182 module_EndBank (true);
183 vlc_LogDeinit (p_libvlc);
188 * Support for gettext
190 #if defined( ENABLE_NLS ) \
191 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
192 vlc_bindtextdomain (PACKAGE_NAME);
194 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
195 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
197 if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
199 module_EndBank (true);
203 if( module_count <= 1 )
205 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
206 module_EndBank (true);
207 vlc_LogDeinit (p_libvlc);
212 /* Check for daemon mode */
213 if( var_InheritBool( p_libvlc, "daemon" ) )
215 char *psz_pidfile = NULL;
217 if( daemon( 1, 0) != 0 )
219 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
220 module_EndBank (true);
221 vlc_LogDeinit (p_libvlc);
226 /* lets check if we need to write the pidfile */
227 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
228 if( psz_pidfile != NULL )
231 pid_t i_pid = getpid ();
232 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
233 i_pid, psz_pidfile );
234 pidfile = vlc_fopen( psz_pidfile,"w" );
235 if( pidfile != NULL )
237 utf8_fprintf( pidfile, "%d", (int)i_pid );
242 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
250 /* FIXME: could be replaced by using Unix sockets */
253 #define MPRIS_APPEND "/org/mpris/MediaPlayer2/TrackList/Append"
254 #define MPRIS_BUS_NAME "org.mpris.MediaPlayer2.vlc"
255 #define MPRIS_OBJECT_PATH "/org/mpris/MediaPlayer2"
256 #define MPRIS_TRACKLIST_INTERFACE "org.mpris.MediaPlayer2.TrackList"
258 if( var_InheritBool( p_libvlc, "one-instance" )
259 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
260 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
262 for( int i = vlc_optind; i < i_argc; i++ )
263 if( ppsz_argv[i][0] == ':' )
265 msg_Err( p_libvlc, "item option %s incompatible with single instance",
270 /* Initialise D-Bus interface, check for other instances */
271 dbus_threads_init_default();
274 dbus_error_init( &err );
276 /* connect to the session bus */
277 DBusConnection *conn = dbus_bus_get( DBUS_BUS_SESSION, &err );
280 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
282 dbus_error_free( &err );
286 /* check if VLC is available on the bus
287 * if not: D-Bus control is not enabled on the other
288 * instance and we can't pass MRLs to it */
289 /* FIXME: This check is totally brain-dead and buggy. */
290 if( !dbus_bus_name_has_owner( conn, MPRIS_BUS_NAME, &err ) )
292 dbus_connection_unref( conn );
293 if( dbus_error_is_set( &err ) )
295 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
298 msg_Dbg( p_libvlc, "No media player running. Continuing normally." );
299 dbus_error_free( &err );
303 const dbus_bool_t play = !var_InheritBool( p_libvlc, "playlist-enqueue" );
305 msg_Warn( p_libvlc, "media player running. Exiting...");
306 for( int i = vlc_optind; i < i_argc; i++ )
308 DBusMessage *msg = dbus_message_new_method_call(
309 MPRIS_BUS_NAME, MPRIS_OBJECT_PATH, MPRIS_TRACKLIST_INTERFACE, "AddTrack" );
310 if( unlikely(msg == NULL) )
313 /* We need to resolve relative paths in this instance */
315 if( strstr( ppsz_argv[i], "://" ) )
316 mrl = strdup( ppsz_argv[i] );
318 mrl = vlc_path2uri( ppsz_argv[i], NULL );
321 dbus_message_unref( msg );
325 const char *after_track = MPRIS_APPEND;
328 if( !dbus_message_append_args( msg, DBUS_TYPE_STRING, &mrl,
329 DBUS_TYPE_OBJECT_PATH, &after_track,
330 DBUS_TYPE_BOOLEAN, &play,
331 DBUS_TYPE_INVALID ) )
333 dbus_message_unref( msg );
337 if( unlikely(msg == NULL) )
340 msg_Dbg( p_libvlc, "Adds %s to the running media player", mrl );
342 /* send message and get a handle for a reply */
343 DBusMessage *reply = dbus_connection_send_with_reply_and_block( conn, msg, -1,
345 dbus_message_unref( msg );
348 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
351 dbus_message_unref( reply );
353 /* we unreference the connection when we've finished with it */
354 dbus_connection_unref( conn );
358 #undef MPRIS_BUS_NAME
359 #undef MPRIS_OBJECT_PATH
360 #undef MPRIS_TRACKLIST_INTERFACE
364 vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
366 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
369 * Initialize hotkey handling
371 priv->actions = vlc_InitActions( p_libvlc );
373 /* Create a variable for showing the fullscreen interface */
374 var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
375 var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
377 /* Create a variable for the Boss Key */
378 var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
380 /* Create a variable for showing the main interface */
381 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
383 /* Create a variable for showing the right click menu */
384 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
386 /* variables for signalling creation of new files */
387 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
388 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
390 /* some default internal settings */
391 var_Create( p_libvlc, "window", VLC_VAR_STRING );
392 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
393 var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
395 /* System specific configuration */
396 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
398 #if defined(MEDIA_LIBRARY)
400 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
402 priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
405 msg_Err( p_libvlc, "ML initialization failed" );
416 /* Initialize VLM if vlm-conf is specified */
417 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
420 priv->p_vlm = vlm_New( p_libvlc );
422 msg_Err( p_libvlc, "VLM initialization failed" );
428 * Load background interfaces
430 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
431 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
433 if( psz_modules && psz_control )
436 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
439 psz_modules = psz_tmp;
442 else if( psz_control )
445 psz_modules = strdup( psz_control );
448 psz_parser = psz_modules;
449 while ( psz_parser && *psz_parser )
451 char *psz_module, *psz_temp;
452 psz_module = psz_parser;
453 psz_parser = strchr( psz_module, ':' );
459 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
461 intf_Create( p_libvlc, psz_temp );
468 if( var_InheritBool( p_libvlc, "file-logging" )
470 && !var_InheritBool( p_libvlc, "syslog" )
474 intf_Create( p_libvlc, "logger,none" );
477 if( var_InheritBool( p_libvlc, "syslog" ) )
479 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
480 var_SetString( p_libvlc, "logmode", "syslog" );
481 intf_Create( p_libvlc, "logger,none" );
485 var_SetString( p_libvlc, "logmode", logmode );
488 var_Destroy( p_libvlc, "logmode" );
492 if( var_InheritBool( p_libvlc, "network-synchronisation") )
494 intf_Create( p_libvlc, "netsync,none" );
498 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
499 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
500 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
501 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
502 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
503 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
504 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
505 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
506 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
508 #if defined (WIN32) || defined (__OS2__)
509 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
513 * Get input filenames given as commandline arguments.
514 * We assume that the remaining parameters are filenames
515 * and their input options.
517 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
520 * Get --open argument
522 psz_val = var_InheritString( p_libvlc, "open" );
523 if ( psz_val != NULL )
525 playlist_AddExt( pl_Get(p_libvlc), psz_val, NULL, PLAYLIST_INSERT, 0,
526 -1, 0, NULL, 0, true, pl_Unlocked );
534 * Cleanup a libvlc instance. The instance is not completely deallocated
535 * \param p_libvlc the instance to clean
537 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
539 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
541 /* Ask the interfaces to stop and destroy them */
542 msg_Dbg( p_libvlc, "removing all interfaces" );
543 libvlc_Quit( p_libvlc );
544 intf_DestroyAll( p_libvlc );
547 /* Destroy VLM if created in libvlc_InternalInit */
550 vlm_Delete( priv->p_vlm );
554 #if defined(MEDIA_LIBRARY)
555 media_library_t* p_ml = priv->p_ml;
558 ml_Destroy( VLC_OBJECT( p_ml ) );
559 vlc_object_release( p_ml );
560 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
564 /* Free playlist now, all threads are gone */
565 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
566 if( p_playlist != NULL )
567 playlist_Destroy( p_playlist );
569 msg_Dbg( p_libvlc, "removing stats" );
571 #if !defined( WIN32 ) && !defined( __OS2__ )
572 char* psz_pidfile = NULL;
576 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
577 if( psz_pidfile != NULL )
579 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
580 if( unlink( psz_pidfile ) == -1 )
582 msg_Dbg( p_libvlc, "removing pid file %s: %m",
590 vlc_DeinitActions( p_libvlc, priv->actions );
592 /* Save the configuration */
593 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
594 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
596 /* Free module bank. It is refcounted, so we call this each time */
597 module_EndBank (true);
598 vlc_LogDeinit (p_libvlc);
599 #if defined(WIN32) || defined(__OS2__)
605 * Destroy everything.
606 * This function requests the running threads to finish, waits for their
607 * termination, and destroys their structure.
608 * It stops the thread systems: no instance can run after this has run
609 * \param p_libvlc the instance to destroy
611 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
613 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
615 /* Destroy mutexes */
616 vlc_ExitDestroy( &priv->exit );
617 vlc_mutex_destroy( &priv->ml_lock );
619 assert( atomic_load(&(vlc_internals(p_libvlc)->refs)) == 1 );
620 vlc_object_release( p_libvlc );
624 * Add an interface plugin and run it
626 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
631 if( !psz_module ) /* requesting the default interface */
633 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
634 if( !psz_interface ) /* "intf" has not been set */
636 #if !defined( WIN32 ) && !defined( __OS2__ )
639 * We prefer the dummy interface if none is specified. */
640 psz_module = "dummy";
643 msg_Info( p_libvlc, "%s",
644 _("Running vlc with the default interface. "
645 "Use 'cvlc' to use vlc without interface.") );
647 free( psz_interface );
648 var_Destroy( p_libvlc, "intf" );
651 /* Try to create the interface */
652 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
654 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
655 psz_module ? psz_module : "default" );
659 /*****************************************************************************
660 * GetFilenames: parse command line options which are not flags
661 *****************************************************************************
662 * Parse command line for input files as well as their associated options.
663 * An option always follows its associated input and begins with a ":".
664 *****************************************************************************/
665 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
666 const char *const args[] )
670 /* Count the input options */
671 unsigned i_options = 0;
673 while( args[--n][0] == ':' )
678 msg_Warn( p_vlc, "options %s without item", args[n] );
679 return; /* syntax!? */
684 if( strstr( args[n], "://" ) == NULL )
686 mrl = vlc_path2uri( args[n], NULL );
691 playlist_AddExt( pl_Get( p_vlc ), (mrl != NULL) ? mrl : args[n], NULL,
692 PLAYLIST_INSERT, 0, -1, i_options,
693 ( i_options ? &args[n + 1] : NULL ),
694 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );