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 # include <unistd.h> /* isatty() */
57 /* used for one-instance mode */
58 # include <dbus/dbus.h>
62 #include <vlc_media_library.h>
63 #include <vlc_playlist.h>
64 #include <vlc_interface.h>
66 #include <vlc_charset.h>
70 #include <vlc_modules.h>
73 #include "playlist/playlist_internal.h"
74 #include "misc/variables.h"
79 # include <libkern/OSAtomic.h>
84 /*****************************************************************************
85 * The evil global variables. We handle them with care, don't worry.
86 *****************************************************************************/
88 #if !defined(WIN32) && !defined(__OS2__)
89 static bool b_daemon = false;
92 /*****************************************************************************
94 *****************************************************************************/
95 static void GetFilenames ( libvlc_int_t *, unsigned, const char *const [] );
98 * Allocate a libvlc instance, initialize global data if needed
99 * It also initializes the threading system
101 libvlc_int_t * libvlc_InternalCreate( void )
103 libvlc_int_t *p_libvlc;
106 /* Now that the thread system is initialized, we don't have much, but
107 * at least we have variables */
108 /* Allocate a libvlc instance object */
109 p_libvlc = vlc_custom_create( (vlc_object_t *)NULL, sizeof (*priv),
111 if( p_libvlc == NULL )
114 priv = libvlc_priv (p_libvlc);
115 priv->p_playlist = NULL;
117 priv->p_dialog_provider = NULL;
120 /* Initialize mutexes */
121 vlc_mutex_init( &priv->ml_lock );
122 vlc_ExitInit( &priv->exit );
128 * Initialize a libvlc instance
129 * This function initializes a previously allocated libvlc instance:
131 * - gettext initialization
132 * - message queue, module bank and playlist initialization
133 * - configuration and commandline parsing
135 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
136 const char *ppsz_argv[] )
138 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
139 char * psz_modules = NULL;
140 char * psz_parser = NULL;
141 char * psz_control = NULL;
144 /* System specific initialization code */
147 /* Initialize the module bank and load the configuration of the
148 * main module. We need to do this at this stage to be able to display
149 * a short help if required by the user. (short help == main module
153 /* Get command line options that affect module loading. */
154 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
156 module_EndBank (false);
161 * Message queue options (read-only afterwards)
163 #if defined (HAVE_ISATTY) && !defined (WIN32)
164 if (isatty (STDERR_FILENO))
165 priv->b_color = var_InheritBool (p_libvlc, "color");
168 priv->b_color = false;
170 priv->i_verbose = var_InheritInteger (p_libvlc, "verbose");
171 psz_val = getenv ("VLC_VERBOSE");
173 priv->i_verbose = atoi (psz_val);
175 if (var_InheritBool (p_libvlc, "quiet"))
177 var_Create (p_libvlc, "verbose", VLC_VAR_INTEGER);
178 var_SetInteger (p_libvlc, "verbose", -1);
179 priv->i_verbose = -1;
182 /* Announce who we are (TODO: only first instance?) */
183 msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
184 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
185 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
186 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
187 vlc_threads_setup (p_libvlc);
189 /* Load the builtins and plugins into the module_bank.
190 * We have to do it before config_Load*() because this also gets the
191 * list of configuration options exported by each module and loads their
193 size_t module_count = module_LoadPlugins (p_libvlc);
196 * Override default configuration with config file settings
198 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
200 if( var_InheritBool( p_libvlc, "reset-config" ) )
201 config_SaveConfigFile( p_libvlc ); /* Save default config */
203 config_LoadConfigFile( p_libvlc );
207 * Override configuration with command line settings
210 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
212 module_EndBank (true);
217 * Support for gettext
219 #if defined( ENABLE_NLS ) \
220 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
221 vlc_bindtextdomain (PACKAGE_NAME);
223 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
224 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
226 if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
228 module_EndBank (true);
232 if( module_count <= 1 )
234 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
235 module_EndBank (true);
240 /* Check for daemon mode */
241 if( var_InheritBool( p_libvlc, "daemon" ) )
243 char *psz_pidfile = NULL;
245 if( daemon( 1, 0) != 0 )
247 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
248 module_EndBank (true);
253 /* lets check if we need to write the pidfile */
254 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
255 if( psz_pidfile != NULL )
258 pid_t i_pid = getpid ();
259 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
260 i_pid, psz_pidfile );
261 pidfile = vlc_fopen( psz_pidfile,"w" );
262 if( pidfile != NULL )
264 utf8_fprintf( pidfile, "%d", (int)i_pid );
269 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
277 /* FIXME: could be replaced by using Unix sockets */
280 #define MPRIS_APPEND "/org/mpris/MediaPlayer2/TrackList/Append"
281 #define MPRIS_BUS_NAME "org.mpris.MediaPlayer2.vlc"
282 #define MPRIS_OBJECT_PATH "/org/mpris/MediaPlayer2"
283 #define MPRIS_TRACKLIST_INTERFACE "org.mpris.MediaPlayer2.TrackList"
285 if( var_InheritBool( p_libvlc, "one-instance" )
286 || ( var_InheritBool( p_libvlc, "one-instance-when-started-from-file" )
287 && var_InheritBool( p_libvlc, "started-from-file" ) ) )
289 for( int i = vlc_optind; i < i_argc; i++ )
290 if( ppsz_argv[i][0] == ':' )
292 msg_Err( p_libvlc, "item option %s incompatible with single instance",
297 /* Initialise D-Bus interface, check for other instances */
298 dbus_threads_init_default();
301 dbus_error_init( &err );
303 /* connect to the session bus */
304 DBusConnection *conn = dbus_bus_get( DBUS_BUS_SESSION, &err );
307 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
309 dbus_error_free( &err );
313 /* check if VLC is available on the bus
314 * if not: D-Bus control is not enabled on the other
315 * instance and we can't pass MRLs to it */
316 /* FIXME: This check is totally brain-dead and buggy. */
317 if( !dbus_bus_name_has_owner( conn, MPRIS_BUS_NAME, &err ) )
319 dbus_connection_unref( conn );
320 if( dbus_error_is_set( &err ) )
322 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
325 msg_Dbg( p_libvlc, "No media player running. Continuing normally." );
326 dbus_error_free( &err );
330 const dbus_bool_t play = !var_InheritBool( p_libvlc, "playlist-enqueue" );
332 msg_Warn( p_libvlc, "media player running. Exiting...");
333 for( int i = vlc_optind; i < i_argc; i++ )
335 DBusMessage *msg = dbus_message_new_method_call(
336 MPRIS_BUS_NAME, MPRIS_OBJECT_PATH, MPRIS_TRACKLIST_INTERFACE, "AddTrack" );
337 if( unlikely(msg == NULL) )
340 /* We need to resolve relative paths in this instance */
342 if( strstr( ppsz_argv[i], "://" ) )
343 mrl = strdup( ppsz_argv[i] );
345 mrl = vlc_path2uri( ppsz_argv[i], NULL );
348 dbus_message_unref( msg );
352 const char *after_track = MPRIS_APPEND;
355 if( !dbus_message_append_args( msg, DBUS_TYPE_STRING, &mrl,
356 DBUS_TYPE_OBJECT_PATH, &after_track,
357 DBUS_TYPE_BOOLEAN, &play,
358 DBUS_TYPE_INVALID ) )
360 dbus_message_unref( msg );
364 if( unlikely(msg == NULL) )
367 msg_Dbg( p_libvlc, "Adds %s to the running media player", mrl );
369 /* send message and get a handle for a reply */
370 DBusMessage *reply = dbus_connection_send_with_reply_and_block( conn, msg, -1,
372 dbus_message_unref( msg );
375 msg_Err( p_libvlc, "D-Bus error: %s", err.message );
378 dbus_message_unref( reply );
380 /* we unreference the connection when we've finished with it */
381 dbus_connection_unref( conn );
385 #undef MPRIS_BUS_NAME
386 #undef MPRIS_OBJECT_PATH
387 #undef MPRIS_TRACKLIST_INTERFACE
391 vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
392 vlc_object_set_name( p_libvlc, "main" );
394 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
397 * Initialize hotkey handling
399 priv->actions = vlc_InitActions( p_libvlc );
401 /* Create a variable for showing the fullscreen interface */
402 var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
403 var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
405 /* Create a variable for the Boss Key */
406 var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
408 /* Create a variable for showing the main interface */
409 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
411 /* Create a variable for showing the right click menu */
412 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
414 /* variables for signalling creation of new files */
415 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
416 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
418 /* some default internal settings */
419 var_Create( p_libvlc, "window", VLC_VAR_STRING );
420 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
421 var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
423 /* System specific configuration */
424 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
426 #if defined(MEDIA_LIBRARY)
428 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
430 priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
433 msg_Err( p_libvlc, "ML initialization failed" );
444 /* Initialize VLM if vlm-conf is specified */
445 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
448 priv->p_vlm = vlm_New( p_libvlc );
450 msg_Err( p_libvlc, "VLM initialization failed" );
456 * Load background interfaces
458 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
459 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
461 if( psz_modules && psz_control )
464 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
467 psz_modules = psz_tmp;
470 else if( psz_control )
473 psz_modules = strdup( psz_control );
476 psz_parser = psz_modules;
477 while ( psz_parser && *psz_parser )
479 char *psz_module, *psz_temp;
480 psz_module = psz_parser;
481 psz_parser = strchr( psz_module, ':' );
487 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
489 intf_Create( p_libvlc, psz_temp );
496 if( var_InheritBool( p_libvlc, "file-logging" )
498 && !var_InheritBool( p_libvlc, "syslog" )
502 intf_Create( p_libvlc, "logger,none" );
505 if( var_InheritBool( p_libvlc, "syslog" ) )
507 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
508 var_SetString( p_libvlc, "logmode", "syslog" );
509 intf_Create( p_libvlc, "logger,none" );
513 var_SetString( p_libvlc, "logmode", logmode );
516 var_Destroy( p_libvlc, "logmode" );
520 if( var_InheritBool( p_libvlc, "network-synchronisation") )
522 intf_Create( p_libvlc, "netsync,none" );
526 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
527 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
528 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
529 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
530 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
531 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
532 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
533 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
534 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
536 #if defined (WIN32) || defined (__OS2__)
537 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
541 * Get input filenames given as commandline arguments.
542 * We assume that the remaining parameters are filenames
543 * and their input options.
545 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
548 * Get --open argument
550 psz_val = var_InheritString( p_libvlc, "open" );
551 if ( psz_val != NULL )
553 playlist_AddExt( pl_Get(p_libvlc), psz_val, NULL, PLAYLIST_INSERT, 0,
554 -1, 0, NULL, 0, true, pl_Unlocked );
562 * Cleanup a libvlc instance. The instance is not completely deallocated
563 * \param p_libvlc the instance to clean
565 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
567 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
569 /* Ask the interfaces to stop and destroy them */
570 msg_Dbg( p_libvlc, "removing all interfaces" );
571 libvlc_Quit( p_libvlc );
572 intf_DestroyAll( p_libvlc );
575 /* Destroy VLM if created in libvlc_InternalInit */
578 vlm_Delete( priv->p_vlm );
582 #if defined(MEDIA_LIBRARY)
583 media_library_t* p_ml = priv->p_ml;
586 ml_Destroy( VLC_OBJECT( p_ml ) );
587 vlc_object_release( p_ml );
588 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
592 /* Free playlist now, all threads are gone */
593 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
594 if( p_playlist != NULL )
595 playlist_Destroy( p_playlist );
597 msg_Dbg( p_libvlc, "removing stats" );
599 #if !defined( WIN32 ) && !defined( __OS2__ )
600 char* psz_pidfile = NULL;
604 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
605 if( psz_pidfile != NULL )
607 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
608 if( unlink( psz_pidfile ) == -1 )
610 msg_Dbg( p_libvlc, "removing pid file %s: %m",
618 /* Save the configuration */
619 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
620 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
622 /* Free module bank. It is refcounted, so we call this each time */
623 module_EndBank (true);
625 vlc_DeinitActions( p_libvlc, priv->actions );
626 #if defined(WIN32) || defined(__OS2__)
632 * Destroy everything.
633 * This function requests the running threads to finish, waits for their
634 * termination, and destroys their structure.
635 * It stops the thread systems: no instance can run after this has run
636 * \param p_libvlc the instance to destroy
638 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
640 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
642 /* Destroy mutexes */
643 vlc_ExitDestroy( &priv->exit );
644 vlc_mutex_destroy( &priv->ml_lock );
646 assert( atomic_load(&(vlc_internals(p_libvlc)->refs)) == 1 );
647 vlc_object_release( p_libvlc );
651 * Add an interface plugin and run it
653 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
658 if( !psz_module ) /* requesting the default interface */
660 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
661 if( !psz_interface ) /* "intf" has not been set */
663 #if !defined( WIN32 ) && !defined( __OS2__ )
666 * We prefer the dummy interface if none is specified. */
667 psz_module = "dummy";
670 msg_Info( p_libvlc, "%s",
671 _("Running vlc with the default interface. "
672 "Use 'cvlc' to use vlc without interface.") );
674 free( psz_interface );
675 var_Destroy( p_libvlc, "intf" );
678 /* Try to create the interface */
679 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
681 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
682 psz_module ? psz_module : "default" );
686 /*****************************************************************************
687 * GetFilenames: parse command line options which are not flags
688 *****************************************************************************
689 * Parse command line for input files as well as their associated options.
690 * An option always follows its associated input and begins with a ":".
691 *****************************************************************************/
692 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
693 const char *const args[] )
697 /* Count the input options */
698 unsigned i_options = 0;
700 while( args[--n][0] == ':' )
705 msg_Warn( p_vlc, "options %s without item", args[n] );
706 return; /* syntax!? */
711 if( strstr( args[n], "://" ) == NULL )
713 mrl = vlc_path2uri( args[n], NULL );
718 playlist_AddExt( pl_Get( p_vlc ), (mrl != NULL) ? mrl : args[n], NULL,
719 PLAYLIST_INSERT, 0, -1, i_options,
720 ( i_options ? &args[n + 1] : NULL ),
721 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );