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
);
398 var_Create( p_libvlc
, "app-icon-name", VLC_VAR_STRING
);
399 var_SetString( p_libvlc
, "app-icon-name", PACKAGE_NAME
);
400 var_Create( p_libvlc
, "app-id", VLC_VAR_STRING
);
401 var_SetString( p_libvlc
, "app-id", "org.VideoLAN.VLC" );
402 var_Create( p_libvlc
, "app-version", VLC_VAR_STRING
);
403 var_SetString( p_libvlc
, "app-version", PACKAGE_VERSION
);
405 /* System specific configuration */
406 system_Configure( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
409 /* Initialize VLM if vlm-conf is specified */
410 psz_parser
= var_CreateGetNonEmptyString( p_libvlc
, "vlm-conf" );
413 priv
->p_vlm
= vlm_New( p_libvlc
);
415 msg_Err( p_libvlc
, "VLM initialization failed" );
421 * Load background interfaces
423 psz_modules
= var_CreateGetNonEmptyString( p_libvlc
, "extraintf" );
424 psz_control
= var_CreateGetNonEmptyString( p_libvlc
, "control" );
426 if( psz_modules
&& psz_control
)
429 if( asprintf( &psz_tmp
, "%s:%s", psz_modules
, psz_control
) != -1 )
432 psz_modules
= psz_tmp
;
435 else if( psz_control
)
438 psz_modules
= strdup( psz_control
);
441 psz_parser
= psz_modules
;
442 while ( psz_parser
&& *psz_parser
)
444 char *psz_module
, *psz_temp
;
445 psz_module
= psz_parser
;
446 psz_parser
= strchr( psz_module
, ':' );
452 if( asprintf( &psz_temp
, "%s,none", psz_module
) != -1)
454 intf_Create( p_libvlc
, psz_temp
);
461 if( var_InheritBool( p_libvlc
, "file-logging" )
463 && !var_InheritBool( p_libvlc
, "syslog" )
467 intf_Create( p_libvlc
, "logger,none" );
470 if( var_InheritBool( p_libvlc
, "syslog" ) )
472 char *logmode
= var_CreateGetNonEmptyString( p_libvlc
, "logmode" );
473 var_SetString( p_libvlc
, "logmode", "syslog" );
474 intf_Create( p_libvlc
, "logger,none" );
478 var_SetString( p_libvlc
, "logmode", logmode
);
481 var_Destroy( p_libvlc
, "logmode" );
485 if( var_InheritBool( p_libvlc
, "network-synchronisation") )
487 intf_Create( p_libvlc
, "netsync,none" );
491 var_Create( p_libvlc
, "drawable-view-top", VLC_VAR_INTEGER
);
492 var_Create( p_libvlc
, "drawable-view-left", VLC_VAR_INTEGER
);
493 var_Create( p_libvlc
, "drawable-view-bottom", VLC_VAR_INTEGER
);
494 var_Create( p_libvlc
, "drawable-view-right", VLC_VAR_INTEGER
);
495 var_Create( p_libvlc
, "drawable-clip-top", VLC_VAR_INTEGER
);
496 var_Create( p_libvlc
, "drawable-clip-left", VLC_VAR_INTEGER
);
497 var_Create( p_libvlc
, "drawable-clip-bottom", VLC_VAR_INTEGER
);
498 var_Create( p_libvlc
, "drawable-clip-right", VLC_VAR_INTEGER
);
499 var_Create( p_libvlc
, "drawable-nsobject", VLC_VAR_ADDRESS
);
501 #if defined (_WIN32) || defined (__OS2__)
502 var_Create( p_libvlc
, "drawable-hwnd", VLC_VAR_INTEGER
);
506 * Get input filenames given as commandline arguments.
507 * We assume that the remaining parameters are filenames
508 * and their input options.
510 GetFilenames( p_libvlc
, i_argc
- vlc_optind
, ppsz_argv
+ vlc_optind
);
513 * Get --open argument
515 psz_val
= var_InheritString( p_libvlc
, "open" );
516 if ( psz_val
!= NULL
)
518 playlist_AddExt( pl_Get(p_libvlc
), psz_val
, NULL
, PLAYLIST_INSERT
, 0,
519 -1, 0, NULL
, 0, true, pl_Unlocked
);
527 * Cleanup a libvlc instance. The instance is not completely deallocated
528 * \param p_libvlc the instance to clean
530 void libvlc_InternalCleanup( libvlc_int_t
*p_libvlc
)
532 libvlc_priv_t
*priv
= libvlc_priv (p_libvlc
);
534 /* Ask the interfaces to stop and destroy them */
535 msg_Dbg( p_libvlc
, "removing all interfaces" );
536 libvlc_Quit( p_libvlc
);
537 intf_DestroyAll( p_libvlc
);
540 /* Destroy VLM if created in libvlc_InternalInit */
543 vlm_Delete( priv
->p_vlm
);
547 /* Free playlist now, all threads are gone */
548 playlist_t
*p_playlist
= libvlc_priv (p_libvlc
)->p_playlist
;
549 if( p_playlist
!= NULL
)
550 playlist_Destroy( p_playlist
);
552 msg_Dbg( p_libvlc
, "removing stats" );
554 #if !defined( _WIN32 ) && !defined( __OS2__ )
555 char* psz_pidfile
= NULL
;
559 psz_pidfile
= var_CreateGetNonEmptyString( p_libvlc
, "pidfile" );
560 if( psz_pidfile
!= NULL
)
562 msg_Dbg( p_libvlc
, "removing pid file %s", psz_pidfile
);
563 if( unlink( psz_pidfile
) == -1 )
565 msg_Dbg( p_libvlc
, "removing pid file %s: %m",
573 vlc_DeinitActions( p_libvlc
, priv
->actions
);
575 /* Save the configuration */
576 if( !var_InheritBool( p_libvlc
, "ignore-config" ) )
577 config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc
) );
579 /* Free module bank. It is refcounted, so we call this each time */
580 module_EndBank (true);
581 vlc_LogDeinit (p_libvlc
);
582 #if defined(_WIN32) || defined(__OS2__)
588 * Destroy everything.
589 * This function requests the running threads to finish, waits for their
590 * termination, and destroys their structure.
591 * It stops the thread systems: no instance can run after this has run
592 * \param p_libvlc the instance to destroy
594 void libvlc_InternalDestroy( libvlc_int_t
*p_libvlc
)
596 libvlc_priv_t
*priv
= libvlc_priv( p_libvlc
);
598 vlc_ExitDestroy( &priv
->exit
);
600 assert( atomic_load(&(vlc_internals(p_libvlc
)->refs
)) == 1 );
601 vlc_object_release( p_libvlc
);
605 * Add an interface plugin and run it
607 int libvlc_InternalAddIntf( libvlc_int_t
*p_libvlc
, char const *psz_module
)
612 if( !psz_module
) /* requesting the default interface */
614 char *psz_interface
= var_CreateGetNonEmptyString( p_libvlc
, "intf" );
615 if( !psz_interface
) /* "intf" has not been set */
617 #if !defined( _WIN32 ) && !defined( __OS2__ )
620 * We prefer the dummy interface if none is specified. */
621 psz_module
= "dummy";
624 msg_Info( p_libvlc
, "%s",
625 _("Running vlc with the default interface. "
626 "Use 'cvlc' to use vlc without interface.") );
628 free( psz_interface
);
629 var_Destroy( p_libvlc
, "intf" );
632 /* Try to create the interface */
633 int ret
= intf_Create( p_libvlc
, psz_module
? psz_module
: "$intf" );
635 msg_Err( p_libvlc
, "interface \"%s\" initialization failed",
636 psz_module
? psz_module
: "default" );
640 /*****************************************************************************
641 * GetFilenames: parse command line options which are not flags
642 *****************************************************************************
643 * Parse command line for input files as well as their associated options.
644 * An option always follows its associated input and begins with a ":".
645 *****************************************************************************/
646 static void GetFilenames( libvlc_int_t
*p_vlc
, unsigned n
,
647 const char *const args
[] )
651 /* Count the input options */
652 unsigned i_options
= 0;
654 while( args
[--n
][0] == ':' )
659 msg_Warn( p_vlc
, "options %s without item", args
[n
] );
660 return; /* syntax!? */
665 if( strstr( args
[n
], "://" ) == NULL
)
667 mrl
= vlc_path2uri( args
[n
], NULL
);
672 playlist_AddExt( pl_Get( p_vlc
), (mrl
!= NULL
) ? mrl
: args
[n
], NULL
,
673 PLAYLIST_INSERT
, 0, -1, i_options
,
674 ( i_options
? &args
[n
+ 1] : NULL
),
675 VLC_INPUT_OPTION_TRUSTED
, true, pl_Unlocked
);