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_playlist.h>
59 #include <vlc_interface.h>
61 #include <vlc_charset.h>
65 #include <vlc_modules.h>
68 #include "playlist/playlist_internal.h"
69 #include "misc/variables.h"
74 # include <libkern/OSAtomic.h>
79 /*****************************************************************************
80 * The evil global variables. We handle them with care, don't worry.
81 *****************************************************************************/
83 #if !defined(_WIN32) && !defined(__OS2__)
84 static bool b_daemon = false;
87 /*****************************************************************************
89 *****************************************************************************/
90 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
93 * Allocate a libvlc instance, initialize global data if needed
94 * It also initializes the threading system
96 libvlc_int_t * libvlc_InternalCreate( void )
98 libvlc_int_t *p_libvlc;
101 /* Now that the thread system is initialized, we don't have much, but
102 * at least we have variables */
103 /* Allocate a libvlc instance object */
104 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
106 if( p_libvlc == NULL )
109 priv = libvlc_priv (p_libvlc);
110 priv->p_playlist = NULL;
111 priv->p_dialog_provider = NULL;
114 vlc_ExitInit( &priv->exit );
120 * Initialize a libvlc instance
121 * This function initializes a previously allocated libvlc instance:
123 * - gettext initialization
124 * - message queue, module bank and playlist initialization
125 * - configuration and commandline parsing
127 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
128 const char *ppsz_argv[] )
130 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
131 char * psz_modules = NULL;
132 char * psz_parser = NULL;
133 char * psz_control = NULL;
136 /* System specific initialization code */
139 /* Initialize the module bank and load the configuration of the
140 * main module. We need to do this at this stage to be able to display
141 * a short help if required by the user. (short help == main module
145 /* Get command line options that affect module loading. */
146 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
148 module_EndBank (false);
152 vlc_LogInit (p_libvlc);
153 vlc_threads_setup (p_libvlc);
155 /* Load the builtins and plugins into the module_bank.
156 * We have to do it before config_Load*() because this also gets the
157 * list of configuration options exported by each module and loads their
159 size_t module_count = module_LoadPlugins (p_libvlc);
162 * Override default configuration with config file settings
164 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
166 if( var_InheritBool( p_libvlc, "reset-config" ) )
167 config_SaveConfigFile( p_libvlc ); /* Save default config */
169 config_LoadConfigFile( p_libvlc );
173 * Override configuration with command line settings
176 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
178 module_EndBank (true);
179 vlc_LogDeinit (p_libvlc);
184 * Support for gettext
186 #if defined( ENABLE_NLS ) \
187 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
188 vlc_bindtextdomain (PACKAGE_NAME);
190 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
191 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
193 if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
195 module_EndBank (true);
199 if( module_count <= 1 )
201 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
202 module_EndBank (true);
203 vlc_LogDeinit (p_libvlc);
208 /* Check for daemon mode */
209 if( var_InheritBool( p_libvlc, "daemon" ) )
211 char *psz_pidfile = NULL;
213 if( daemon( 1, 0) != 0 )
215 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
216 module_EndBank (true);
217 vlc_LogDeinit (p_libvlc);
222 /* lets check if we need to write the pidfile */
223 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
224 if( psz_pidfile != NULL )
227 pid_t i_pid = getpid ();
228 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
229 i_pid, psz_pidfile );
230 pidfile = vlc_fopen( psz_pidfile,"w" );
231 if( pidfile != NULL )
233 utf8_fprintf( pidfile, "%d", (int)i_pid );
238 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
246 /* FIXME: could be replaced by using Unix sockets */
249 #define MPRIS_APPEND "/org/mpris/MediaPlayer2/TrackList/Append"
250 #define MPRIS_BUS_NAME "org.mpris.MediaPlayer2.vlc"
251 #define MPRIS_OBJECT_PATH "/org/mpris/MediaPlayer2"
252 #define MPRIS_TRACKLIST_INTERFACE "org.mpris.MediaPlayer2.TrackList"
254 if( var_InheritBool( p_libvlc, "one-instance" )
255 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
256 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
258 for( int i = vlc_optind; i < i_argc; i++ )
259 if( ppsz_argv[i][0] == ':' )
261 msg_Err( p_libvlc, "item option %s incompatible with single instance",
266 /* Initialise D-Bus interface, check for other instances */
267 dbus_threads_init_default();
270 dbus_error_init( &err );
272 /* connect to the session bus */
273 DBusConnection *conn = dbus_bus_get( DBUS_BUS_SESSION, &err );
276 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
278 dbus_error_free( &err );
282 /* check if VLC is available on the bus
283 * if not: D-Bus control is not enabled on the other
284 * instance and we can't pass MRLs to it */
285 /* FIXME: This check is totally brain-dead and buggy. */
286 if( !dbus_bus_name_has_owner( conn, MPRIS_BUS_NAME, &err ) )
288 dbus_connection_unref( conn );
289 if( dbus_error_is_set( &err ) )
291 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
294 msg_Dbg( p_libvlc, "No media player running. Continuing normally." );
295 dbus_error_free( &err );
299 const dbus_bool_t play = !var_InheritBool( p_libvlc, "playlist-enqueue" );
301 msg_Warn( p_libvlc, "media player running. Exiting...");
302 for( int i = vlc_optind; i < i_argc; i++ )
304 DBusMessage *msg = dbus_message_new_method_call(
305 MPRIS_BUS_NAME, MPRIS_OBJECT_PATH, MPRIS_TRACKLIST_INTERFACE, "AddTrack" );
306 if( unlikely(msg == NULL) )
309 /* We need to resolve relative paths in this instance */
311 if( strstr( ppsz_argv[i], "://" ) )
312 mrl = strdup( ppsz_argv[i] );
314 mrl = vlc_path2uri( ppsz_argv[i], NULL );
317 dbus_message_unref( msg );
321 const char *after_track = MPRIS_APPEND;
324 if( !dbus_message_append_args( msg, DBUS_TYPE_STRING, &mrl,
325 DBUS_TYPE_OBJECT_PATH, &after_track,
326 DBUS_TYPE_BOOLEAN, &play,
327 DBUS_TYPE_INVALID ) )
329 dbus_message_unref( msg );
333 if( unlikely(msg == NULL) )
336 msg_Dbg( p_libvlc, "Adds %s to the running media player", mrl );
338 /* send message and get a handle for a reply */
339 DBusMessage *reply = dbus_connection_send_with_reply_and_block( conn, msg, -1,
341 dbus_message_unref( msg );
344 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
347 dbus_message_unref( reply );
349 /* we unreference the connection when we've finished with it */
350 dbus_connection_unref( conn );
354 #undef MPRIS_BUS_NAME
355 #undef MPRIS_OBJECT_PATH
356 #undef MPRIS_TRACKLIST_INTERFACE
360 vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
362 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
365 * Initialize hotkey handling
367 priv->actions = vlc_InitActions( p_libvlc );
369 /* Create a variable for showing the fullscreen interface */
370 var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
371 var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
373 /* Create a variable for the Boss Key */
374 var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
376 /* Create a variable for showing the main interface */
377 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
379 /* Create a variable for showing the right click menu */
380 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
382 /* variables for signalling creation of new files */
383 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
384 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
386 /* some default internal settings */
387 var_Create( p_libvlc, "window", VLC_VAR_STRING );
388 /* NOTE: Because the playlist and interfaces start before this function
389 * returns control to the application (DESIGN BUG!), all these variables
390 * must be created (in place of libvlc_new()) and set to VLC defaults
391 * (in place of VLC main()) *here*. */
392 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
393 var_SetString( p_libvlc, "user-agent",
394 "VLC media player (LibVLC "VERSION")" );
395 var_Create( p_libvlc, "http-user-agent", VLC_VAR_STRING );
396 var_SetString( p_libvlc, "http-user-agent",
397 "VLC/"PACKAGE_VERSION" LibVLC/"PACKAGE_VERSION );
399 /* System specific configuration */
400 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
403 /* Initialize VLM if vlm-conf is specified */
404 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
407 priv->p_vlm = vlm_New( p_libvlc );
409 msg_Err( p_libvlc, "VLM initialization failed" );
415 * Load background interfaces
417 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
418 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
420 if( psz_modules && psz_control )
423 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
426 psz_modules = psz_tmp;
429 else if( psz_control )
432 psz_modules = strdup( psz_control );
435 psz_parser = psz_modules;
436 while ( psz_parser && *psz_parser )
438 char *psz_module, *psz_temp;
439 psz_module = psz_parser;
440 psz_parser = strchr( psz_module, ':' );
446 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
448 intf_Create( p_libvlc, psz_temp );
455 if( var_InheritBool( p_libvlc, "file-logging" )
457 && !var_InheritBool( p_libvlc, "syslog" )
461 intf_Create( p_libvlc, "logger,none" );
464 if( var_InheritBool( p_libvlc, "syslog" ) )
466 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
467 var_SetString( p_libvlc, "logmode", "syslog" );
468 intf_Create( p_libvlc, "logger,none" );
472 var_SetString( p_libvlc, "logmode", logmode );
475 var_Destroy( p_libvlc, "logmode" );
479 if( var_InheritBool( p_libvlc, "network-synchronisation") )
481 intf_Create( p_libvlc, "netsync,none" );
485 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
486 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
487 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
488 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
489 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
490 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
491 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
492 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
493 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
495 #if defined (_WIN32) || defined (__OS2__)
496 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
500 * Get input filenames given as commandline arguments.
501 * We assume that the remaining parameters are filenames
502 * and their input options.
504 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
507 * Get --open argument
509 psz_val = var_InheritString( p_libvlc, "open" );
510 if ( psz_val != NULL )
512 playlist_AddExt( pl_Get(p_libvlc), psz_val, NULL, PLAYLIST_INSERT, 0,
513 -1, 0, NULL, 0, true, pl_Unlocked );
521 * Cleanup a libvlc instance. The instance is not completely deallocated
522 * \param p_libvlc the instance to clean
524 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
526 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
528 /* Ask the interfaces to stop and destroy them */
529 msg_Dbg( p_libvlc, "removing all interfaces" );
530 libvlc_Quit( p_libvlc );
531 intf_DestroyAll( p_libvlc );
534 /* Destroy VLM if created in libvlc_InternalInit */
537 vlm_Delete( priv->p_vlm );
541 /* Free playlist now, all threads are gone */
542 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
543 if( p_playlist != NULL )
544 playlist_Destroy( p_playlist );
546 msg_Dbg( p_libvlc, "removing stats" );
548 #if !defined( _WIN32 ) && !defined( __OS2__ )
549 char* psz_pidfile = NULL;
553 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
554 if( psz_pidfile != NULL )
556 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
557 if( unlink( psz_pidfile ) == -1 )
559 msg_Dbg( p_libvlc, "removing pid file %s: %m",
567 vlc_DeinitActions( p_libvlc, priv->actions );
569 /* Save the configuration */
570 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
571 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
573 /* Free module bank. It is refcounted, so we call this each time */
574 module_EndBank (true);
575 vlc_LogDeinit (p_libvlc);
576 #if defined(_WIN32) || defined(__OS2__)
582 * Destroy everything.
583 * This function requests the running threads to finish, waits for their
584 * termination, and destroys their structure.
585 * It stops the thread systems: no instance can run after this has run
586 * \param p_libvlc the instance to destroy
588 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
590 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
592 vlc_ExitDestroy( &priv->exit );
594 assert( atomic_load(&(vlc_internals(p_libvlc)->refs)) == 1 );
595 vlc_object_release( p_libvlc );
599 * Add an interface plugin and run it
601 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
606 if( !psz_module ) /* requesting the default interface */
608 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
609 if( !psz_interface ) /* "intf" has not been set */
611 #if !defined( _WIN32 ) && !defined( __OS2__ )
614 * We prefer the dummy interface if none is specified. */
615 psz_module = "dummy";
618 msg_Info( p_libvlc, "%s",
619 _("Running vlc with the default interface. "
620 "Use 'cvlc' to use vlc without interface.") );
622 free( psz_interface );
623 var_Destroy( p_libvlc, "intf" );
626 /* Try to create the interface */
627 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
629 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
630 psz_module ? psz_module : "default" );
634 /*****************************************************************************
635 * GetFilenames: parse command line options which are not flags
636 *****************************************************************************
637 * Parse command line for input files as well as their associated options.
638 * An option always follows its associated input and begins with a ":".
639 *****************************************************************************/
640 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
641 const char *const args[] )
645 /* Count the input options */
646 unsigned i_options = 0;
648 while( args[--n][0] == ':' )
653 msg_Warn( p_vlc, "options %s without item", args[n] );
654 return; /* syntax!? */
659 if( strstr( args[n], "://" ) == NULL )
661 mrl = vlc_path2uri( args[n], NULL );
666 playlist_AddExt( pl_Get( p_vlc ), (mrl != NULL) ? mrl : args[n], NULL,
667 PLAYLIST_INSERT, 0, -1, i_options,
668 ( i_options ? &args[n + 1] : NULL ),
669 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );