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>
74 #include "playlist/playlist_internal.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;
119 priv->i_verbose = 3; /* initial value until config is loaded */
120 #if defined( HAVE_ISATTY ) && !defined( WIN32 )
121 priv->b_color = isatty( STDERR_FILENO ); /* 2 is for stderr */
123 priv->b_color = false;
126 /* Initialize mutexes */
127 vlc_mutex_init( &priv->ml_lock );
128 vlc_ExitInit( &priv->exit );
134 * Initialize a libvlc instance
135 * This function initializes a previously allocated libvlc instance:
137 * - gettext initialization
138 * - message queue, module bank and playlist initialization
139 * - configuration and commandline parsing
141 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
142 const char *ppsz_argv[] )
144 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
145 char * psz_modules = NULL;
146 char * psz_parser = NULL;
147 char * psz_control = NULL;
148 playlist_t *p_playlist = NULL;
151 /* System specific initialization code */
154 /* Initialize the module bank and load the configuration of the
155 * main module. We need to do this at this stage to be able to display
156 * a short help if required by the user. (short help == main module
160 /* Get command line options that affect module loading. */
161 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
163 module_EndBank (false);
166 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
168 /* Find verbosity from VLC_VERBOSE environment variable */
170 char *env = getenv( "VLC_VERBOSE" );
172 priv->i_verbose = atoi( env );
175 /* Announce who we are (TODO: only first instance?) */
176 msg_Dbg( p_libvlc, "VLC media player - %s", VERSION_MESSAGE );
177 msg_Dbg( p_libvlc, "%s", COPYRIGHT_MESSAGE );
178 msg_Dbg( p_libvlc, "revision %s", psz_vlc_changeset );
179 msg_Dbg( p_libvlc, "configured with %s", CONFIGURE_LINE );
181 /* Load the builtins and plugins into the module_bank.
182 * We have to do it before config_Load*() because this also gets the
183 * list of configuration options exported by each module and loads their
185 size_t module_count = module_LoadPlugins (p_libvlc);
188 * Override default configuration with config file settings
190 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
192 if( var_InheritBool( p_libvlc, "reset-config" ) )
193 config_SaveConfigFile( p_libvlc ); /* Save default config */
195 config_LoadConfigFile( p_libvlc );
199 * Override configuration with command line settings
202 if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
205 MessageBox (NULL, TEXT("The command line options could not be parsed.\n"
206 "Make sure they are valid."), TEXT("VLC media player"),
209 module_EndBank (true);
212 priv->i_verbose = var_InheritInteger( p_libvlc, "verbose" );
215 * Support for gettext
217 #if defined( ENABLE_NLS ) \
218 && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
219 vlc_bindtextdomain (PACKAGE_NAME);
221 /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
222 msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
224 if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
226 module_EndBank (true);
227 return VLC_EEXITSUCCESS;
230 if( module_count <= 1 )
232 msg_Err( p_libvlc, "No plugins found! Check your VLC installation.");
233 module_EndBank (true);
238 /* Check for daemon mode */
239 if( var_InheritBool( p_libvlc, "daemon" ) )
241 char *psz_pidfile = NULL;
243 if( daemon( 1, 0) != 0 )
245 msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
246 module_EndBank (true);
251 /* lets check if we need to write the pidfile */
252 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
253 if( psz_pidfile != NULL )
256 pid_t i_pid = getpid ();
257 msg_Dbg( p_libvlc, "PID is %d, writing it to %s",
258 i_pid, psz_pidfile );
259 pidfile = vlc_fopen( psz_pidfile,"w" );
260 if( pidfile != NULL )
262 utf8_fprintf( pidfile, "%d", (int)i_pid );
267 msg_Err( p_libvlc, "cannot open pid file for writing: %s (%m)",
275 /* FIXME: could be replaced by using Unix sockets */
278 #define MPRIS_APPEND "/org/mpris/MediaPlayer2/TrackList/Append"
279 #define MPRIS_BUS_NAME "org.mpris.MediaPlayer2.vlc"
280 #define MPRIS_OBJECT_PATH "/org/mpris/MediaPlayer2"
281 #define MPRIS_TRACKLIST_INTERFACE "org.mpris.MediaPlayer2.TrackList"
283 dbus_threads_init_default();
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 /* Initialise D-Bus interface, check for other instances */
290 DBusConnection *p_conn = NULL;
291 DBusError dbus_error;
293 dbus_error_init( &dbus_error );
295 /* connect to the session bus */
296 p_conn = dbus_bus_get( DBUS_BUS_SESSION, &dbus_error );
299 msg_Err( p_libvlc, "Failed to connect to D-Bus session daemon: %s",
300 dbus_error.message );
301 dbus_error_free( &dbus_error );
305 /* check if VLC is available on the bus
306 * if not: D-Bus control is not enabled on the other
307 * instance and we can't pass MRLs to it */
308 if( !dbus_bus_name_has_owner( p_conn, MPRIS_BUS_NAME, &dbus_error ) )
310 if( dbus_error_is_set( &dbus_error ) )
312 msg_Err( p_libvlc, "D-Bus error: %s", dbus_error.message );
313 dbus_error_free( &dbus_error );
316 msg_Dbg( p_libvlc, "No Media Player is running. "
317 "Continuing normally." );
322 DBusMessage* p_dbus_msg = NULL;
323 DBusMessageIter dbus_args;
324 DBusPendingCall* p_dbus_pending = NULL;
327 msg_Warn( p_libvlc, "Another Media Player is running. Exiting");
329 for( i_input = vlc_optind; i_input < i_argc;i_input++ )
331 /* Skip input options, we can't pass them through D-Bus */
332 if( ppsz_argv[i_input][0] == ':' )
334 msg_Warn( p_libvlc, "Ignoring option %s",
335 ppsz_argv[i_input] );
339 /* We need to resolve relative paths in this instance */
341 if( strstr( psz_mrl, "://" ) )
342 psz_mrl = strdup( ppsz_argv[i_input] );
344 psz_mrl = vlc_path2uri( ppsz_argv[i_input], NULL );
345 const char *psz_after_track = MPRIS_APPEND;
347 if( psz_mrl == NULL )
349 msg_Dbg( p_libvlc, "Adds %s to the running Media Player",
352 p_dbus_msg = dbus_message_new_method_call(
353 MPRIS_BUS_NAME, MPRIS_OBJECT_PATH,
354 MPRIS_TRACKLIST_INTERFACE, "AddTrack" );
356 if ( NULL == p_dbus_msg )
358 msg_Err( p_libvlc, "D-Bus problem" );
364 dbus_message_iter_init_append( p_dbus_msg, &dbus_args );
365 if ( !dbus_message_iter_append_basic( &dbus_args,
366 DBUS_TYPE_STRING, &psz_mrl ) )
368 dbus_message_unref( p_dbus_msg );
374 if( !dbus_message_iter_append_basic( &dbus_args,
375 DBUS_TYPE_OBJECT_PATH, &psz_after_track ) )
377 dbus_message_unref( p_dbus_msg );
382 if( var_InheritBool( p_libvlc, "playlist-enqueue" ) )
385 if ( !dbus_message_iter_append_basic( &dbus_args,
386 DBUS_TYPE_BOOLEAN, &b_play ) )
388 dbus_message_unref( p_dbus_msg );
392 /* send message and get a handle for a reply */
393 if ( !dbus_connection_send_with_reply ( p_conn,
394 p_dbus_msg, &p_dbus_pending, -1 ) )
396 msg_Err( p_libvlc, "D-Bus problem" );
397 dbus_message_unref( p_dbus_msg );
401 if ( NULL == p_dbus_pending )
403 msg_Err( p_libvlc, "D-Bus problem" );
404 dbus_message_unref( p_dbus_msg );
407 dbus_connection_flush( p_conn );
408 dbus_message_unref( p_dbus_msg );
409 /* block until we receive a reply */
410 dbus_pending_call_block( p_dbus_pending );
411 dbus_pending_call_unref( p_dbus_pending );
412 } /* processes all command line MRLs */
418 /* we unreference the connection when we've finished with it */
419 if( p_conn ) dbus_connection_unref( p_conn );
423 #undef MPRIS_BUS_NAME
424 #undef MPRIS_OBJECT_PATH
425 #undef MPRIS_TRACKLIST_INTERFACE
430 * Message queue options
432 /* Last chance to set the verbosity. Once we start interfaces and other
433 * threads, verbosity becomes read-only. */
434 var_Create( p_libvlc, "verbose", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
435 if( var_InheritBool( p_libvlc, "quiet" ) )
437 var_SetInteger( p_libvlc, "verbose", -1 );
438 priv->i_verbose = -1;
440 vlc_threads_setup( p_libvlc );
443 priv->b_color = var_InheritBool( p_libvlc, "color" );
445 vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
446 vlc_object_set_name( p_libvlc, "main" );
448 priv->b_stats = var_InheritBool( p_libvlc, "stats" );
451 * Initialize hotkey handling
453 priv->actions = vlc_InitActions( p_libvlc );
455 /* Create a variable for showing the fullscreen interface */
456 var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
457 var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
459 /* Create a variable for the Boss Key */
460 var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
462 /* Create a variable for showing the main interface */
463 var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
465 /* Create a variable for showing the right click menu */
466 var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
468 /* variables for signalling creation of new files */
469 var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
470 var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
472 /* some default internal settings */
473 var_Create( p_libvlc, "window", VLC_VAR_STRING );
474 var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
475 var_SetString( p_libvlc, "user-agent", "(LibVLC "VERSION")" );
477 /* Initialize playlist and get commandline files */
478 p_playlist = playlist_Create( VLC_OBJECT(p_libvlc) );
481 msg_Err( p_libvlc, "playlist initialization failed" );
482 module_EndBank (true);
486 /* System specific configuration */
487 system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
489 #if defined(MEDIA_LIBRARY)
491 if( var_GetBool( p_libvlc, "load-media-library-on-startup" ) )
493 priv->p_ml = ml_Create( VLC_OBJECT( p_libvlc ), NULL );
496 msg_Err( p_libvlc, "ML initialization failed" );
506 /* Add service discovery modules */
507 psz_modules = var_InheritString( p_libvlc, "services-discovery" );
510 char *p = psz_modules, *m;
511 while( ( m = strsep( &p, " :," ) ) != NULL )
512 playlist_ServicesDiscoveryAdd( p_playlist, m );
517 /* Initialize VLM if vlm-conf is specified */
518 psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
521 priv->p_vlm = vlm_New( p_libvlc );
523 msg_Err( p_libvlc, "VLM initialization failed" );
529 * Load background interfaces
531 psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
532 psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
534 if( psz_modules && psz_control )
537 if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
540 psz_modules = psz_tmp;
543 else if( psz_control )
546 psz_modules = strdup( psz_control );
549 psz_parser = psz_modules;
550 while ( psz_parser && *psz_parser )
552 char *psz_module, *psz_temp;
553 psz_module = psz_parser;
554 psz_parser = strchr( psz_module, ':' );
560 if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
562 intf_Create( p_libvlc, psz_temp );
570 * Always load the hotkeys interface if it exists
572 intf_Create( p_libvlc, "hotkeys,none" );
574 if( var_InheritBool( p_libvlc, "file-logging" )
576 && !var_InheritBool( p_libvlc, "syslog" )
580 intf_Create( p_libvlc, "logger,none" );
583 if( var_InheritBool( p_libvlc, "syslog" ) )
585 char *logmode = var_CreateGetNonEmptyString( p_libvlc, "logmode" );
586 var_SetString( p_libvlc, "logmode", "syslog" );
587 intf_Create( p_libvlc, "logger,none" );
591 var_SetString( p_libvlc, "logmode", logmode );
594 var_Destroy( p_libvlc, "logmode" );
598 if( var_InheritBool( p_libvlc, "network-synchronisation") )
600 intf_Create( p_libvlc, "netsync,none" );
604 var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
605 var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
606 var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
607 var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
608 var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
609 var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
610 var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
611 var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
612 var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
614 #if defined (WIN32) || defined (__OS2__)
615 var_Create( p_libvlc, "drawable-hwnd", VLC_VAR_INTEGER );
619 * Get input filenames given as commandline arguments.
620 * We assume that the remaining parameters are filenames
621 * and their input options.
623 GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
626 * Get --open argument
628 psz_val = var_InheritString( p_libvlc, "open" );
629 if ( psz_val != NULL )
631 playlist_AddExt( p_playlist, psz_val, NULL, PLAYLIST_INSERT, 0,
632 -1, 0, NULL, 0, true, pl_Unlocked );
640 * Cleanup a libvlc instance. The instance is not completely deallocated
641 * \param p_libvlc the instance to clean
643 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
645 libvlc_priv_t *priv = libvlc_priv (p_libvlc);
646 playlist_t *p_playlist = libvlc_priv (p_libvlc)->p_playlist;
648 /* Deactivate the playlist */
649 msg_Dbg( p_libvlc, "deactivating the playlist" );
650 pl_Deactivate( p_libvlc );
652 /* Remove all services discovery */
653 msg_Dbg( p_libvlc, "removing all services discovery tasks" );
654 playlist_ServicesDiscoveryKillAll( p_playlist );
656 /* Ask the interfaces to stop and destroy them */
657 msg_Dbg( p_libvlc, "removing all interfaces" );
658 libvlc_Quit( p_libvlc );
659 intf_DestroyAll( p_libvlc );
662 /* Destroy VLM if created in libvlc_InternalInit */
665 vlm_Delete( priv->p_vlm );
669 #if defined(MEDIA_LIBRARY)
670 media_library_t* p_ml = priv->p_ml;
673 ml_Destroy( VLC_OBJECT( p_ml ) );
674 vlc_object_release( p_ml );
675 libvlc_priv(p_playlist->p_libvlc)->p_ml = NULL;
679 /* Free playlist now, all threads are gone */
680 playlist_Destroy( p_playlist );
682 msg_Dbg( p_libvlc, "removing stats" );
684 #if !defined( WIN32 ) && !defined( __OS2__ )
685 char* psz_pidfile = NULL;
689 psz_pidfile = var_CreateGetNonEmptyString( p_libvlc, "pidfile" );
690 if( psz_pidfile != NULL )
692 msg_Dbg( p_libvlc, "removing pid file %s", psz_pidfile );
693 if( unlink( psz_pidfile ) == -1 )
695 msg_Dbg( p_libvlc, "removing pid file %s: %m",
703 /* Save the configuration */
704 if( !var_InheritBool( p_libvlc, "ignore-config" ) )
705 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
707 /* Free module bank. It is refcounted, so we call this each time */
708 module_EndBank (true);
710 vlc_DeinitActions( p_libvlc, priv->actions );
717 * Destroy everything.
718 * This function requests the running threads to finish, waits for their
719 * termination, and destroys their structure.
720 * It stops the thread systems: no instance can run after this has run
721 * \param p_libvlc the instance to destroy
723 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
725 libvlc_priv_t *priv = libvlc_priv( p_libvlc );
727 /* Destroy mutexes */
728 vlc_ExitDestroy( &priv->exit );
729 vlc_mutex_destroy( &priv->ml_lock );
731 #ifndef NDEBUG /* Hack to dump leaked objects tree */
732 if( vlc_internals( p_libvlc )->i_refcount > 1 )
733 while( vlc_internals( p_libvlc )->i_refcount > 0 )
734 vlc_object_release( p_libvlc );
737 assert( vlc_internals( p_libvlc )->i_refcount == 1 );
738 vlc_object_release( p_libvlc );
742 * Add an interface plugin and run it
744 int libvlc_InternalAddIntf( libvlc_int_t *p_libvlc, char const *psz_module )
749 if( !psz_module ) /* requesting the default interface */
751 char *psz_interface = var_CreateGetNonEmptyString( p_libvlc, "intf" );
752 if( !psz_interface ) /* "intf" has not been set */
754 #if !defined( WIN32 ) && !defined( __OS2__ )
757 * We prefer the dummy interface if none is specified. */
758 psz_module = "dummy";
761 msg_Info( p_libvlc, "%s",
762 _("Running vlc with the default interface. "
763 "Use 'cvlc' to use vlc without interface.") );
765 free( psz_interface );
766 var_Destroy( p_libvlc, "intf" );
769 /* Try to create the interface */
770 int ret = intf_Create( p_libvlc, psz_module ? psz_module : "$intf" );
772 msg_Err( p_libvlc, "interface \"%s\" initialization failed",
773 psz_module ? psz_module : "default" );
777 /*****************************************************************************
778 * GetFilenames: parse command line options which are not flags
779 *****************************************************************************
780 * Parse command line for input files as well as their associated options.
781 * An option always follows its associated input and begins with a ":".
782 *****************************************************************************/
783 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
784 const char *const args[] )
788 /* Count the input options */
789 unsigned i_options = 0;
791 while( args[--n][0] == ':' )
796 msg_Warn( p_vlc, "options %s without item", args[n] );
797 return; /* syntax!? */
802 if( strstr( args[n], "://" ) == NULL )
804 mrl = vlc_path2uri( args[n], NULL );
809 playlist_AddExt( pl_Get( p_vlc ), (mrl != NULL) ? mrl : args[n], NULL,
810 PLAYLIST_INSERT, 0, -1, i_options,
811 ( i_options ? &args[n + 1] : NULL ),
812 VLC_INPUT_OPTION_TRUSTED, true, pl_Unlocked );