src/libvlc.c

   1 /*****************************************************************************
   2  * libvlc.c: libvlc instances creation and deletion, interfaces handling
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   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>
  12  *
  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.
  17  *
  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.
  22  *
  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  *****************************************************************************/
  27
  28 /** \file
  29  * This file contains functions to create and destroy libvlc instances
  30  */
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #include <vlc_common.h>
  40 #include "../lib/libvlc_internal.h"
  41 #include <vlc_input.h>
  42
  43 #include "modules/modules.h"
  44 #include "config/configuration.h"
  45 #include "playlist/preparser.h"
  46
  47 #include <stdio.h>                                              /* sprintf() */
  48 #include <string.h>
  49 #include <stdlib.h>                                                /* free() */
  50 #include <errno.h>
  51
  52 #include "config/vlc_getopt.h"
  53
  54 #include <vlc_playlist.h>
  55 #include <vlc_interface.h>
  56
  57 #include <vlc_actions.h>
  58 #include <vlc_charset.h>
  59 #include <vlc_dialog.h>
  60 #include <vlc_keystore.h>
  61 #include <vlc_fs.h>
  62 #include <vlc_cpu.h>
  63 #include <vlc_url.h>
  64 #include <vlc_modules.h>
  65
  66 #include "libvlc.h"
  67 #include "playlist/playlist_internal.h"
  68 #include "misc/variables.h"
  69
  70 #include <vlc_vlm.h>
  71
  72 #include <assert.h>
  73
  74 /*****************************************************************************
  75  * Local prototypes
  76  *****************************************************************************/
  77 static void GetFilenames  ( libvlc_int_t *, unsigned, const char *const [] );
  78
  79 /**
  80  * Allocate a blank libvlc instance, also setting the exit handler.
  81  * Vlc's threading system must have been initialized first
  82  */
  83 libvlc_int_t * libvlc_InternalCreate( void )
  84 {
  85     libvlc_int_t *p_libvlc;
  86     libvlc_priv_t *priv;
  87
  88     /* Allocate a libvlc instance object */
  89     p_libvlc = (vlc_custom_create)( NULL, sizeof (*priv), "libvlc" );
  90     if( p_libvlc == NULL )
  91         return NULL;
  92
  93     priv = libvlc_priv (p_libvlc);
  94     priv->playlist = NULL;
  95     priv->p_vlm = NULL;
  96
  97     vlc_ExitInit( &priv->exit );
  98
  99     return p_libvlc;
 100 }
 101
 102 /**
 103  * Initialize a libvlc instance
 104  * This function initializes a previously allocated libvlc instance:
 105  *  - CPU detection
 106  *  - gettext initialization
 107  *  - message queue, module bank and playlist initialization
 108  *  - configuration and commandline parsing
 109  */
 110 int libvlc_InternalInit( libvlc_int_t *p_libvlc, int i_argc,
 111                          const char *ppsz_argv[] )
 112 {
 113     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
 114     char *       psz_modules = NULL;
 115     char *       psz_parser = NULL;
 116     char *       psz_control = NULL;
 117     char        *psz_val;
 118     int          i_ret = VLC_EGENERIC;
 119
 120     /* System specific initialization code */
 121     system_Init();
 122
 123     vlc_LogPreinit(p_libvlc);
 124
 125     /* Initialize the module bank and load the configuration of the
 126      * core module. We need to do this at this stage to be able to display
 127      * a short help if required by the user. (short help == core module
 128      * options) */
 129     module_InitBank ();
 130
 131     /* Get command line options that affect module loading. */
 132     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, NULL ) )
 133     {
 134         module_EndBank (false);
 135         return VLC_EGENERIC;
 136     }
 137
 138     vlc_threads_setup (p_libvlc);
 139
 140     /* Load the builtins and plugins into the module_bank.
 141      * We have to do it before config_Load*() because this also gets the
 142      * list of configuration options exported by each module and loads their
 143      * default values. */
 144     module_LoadPlugins (p_libvlc);
 145
 146     /*
 147      * Override default configuration with config file settings
 148      */
 149     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
 150     {
 151         if( var_InheritBool( p_libvlc, "reset-config" ) )
 152             config_SaveConfigFile( p_libvlc ); /* Save default config */
 153         else
 154             config_LoadConfigFile( p_libvlc );
 155     }
 156
 157     /*
 158      * Override configuration with command line settings
 159      */
 160     int vlc_optind;
 161     if( config_LoadCmdLine( p_libvlc, i_argc, ppsz_argv, &vlc_optind ) )
 162         goto error;
 163
 164     vlc_LogInit(p_libvlc);
 165
 166     /*
 167      * Support for gettext
 168      */
 169 #if defined( ENABLE_NLS ) \
 170      && ( defined( HAVE_GETTEXT ) || defined( HAVE_INCLUDED_GETTEXT ) )
 171     vlc_bindtextdomain (PACKAGE_NAME);
 172 #endif
 173     /*xgettext: Translate "C" to the language code: "fr", "en_GB", "nl", "ru"... */
 174     msg_Dbg( p_libvlc, "translation test: code is \"%s\"", _("C") );
 175
 176     if (config_PrintHelp (VLC_OBJECT(p_libvlc)))
 177     {
 178         libvlc_InternalCleanup (p_libvlc);
 179         exit(0);
 180     }
 181
 182 #ifdef HAVE_DAEMON
 183     /* Check for daemon mode */
 184     if( var_InheritBool( p_libvlc, "daemon" ) )
 185     {
 186         if( daemon( 1, 0) != 0 )
 187         {
 188             msg_Err( p_libvlc, "Unable to fork vlc to daemon mode" );
 189             goto error;
 190         }
 191
 192         /* lets check if we need to write the pidfile */
 193         char *pidfile = var_InheritString( p_libvlc, "pidfile" );
 194         if( pidfile != NULL )
 195         {
 196             FILE *stream = vlc_fopen( pidfile, "w" );
 197             if( stream != NULL )
 198             {
 199                 fprintf( stream, "%d", (int)getpid() );
 200                 fclose( stream );
 201                 msg_Dbg( p_libvlc, "written PID file %s", pidfile );
 202             }
 203             else
 204                 msg_Err( p_libvlc, "cannot write PID file %s: %s",
 205                          pidfile, vlc_strerror_c(errno) );
 206             free( pidfile );
 207         }
 208     }
 209     else
 210     {
 211         var_Create( p_libvlc, "pidfile", VLC_VAR_STRING );
 212         var_SetString( p_libvlc, "pidfile", "" );
 213     }
 214 #endif
 215
 216     i_ret = VLC_ENOMEM;
 217
 218     if( libvlc_InternalDialogInit( p_libvlc ) != VLC_SUCCESS )
 219         goto error;
 220     if( libvlc_InternalKeystoreInit( p_libvlc ) != VLC_SUCCESS )
 221         msg_Warn( p_libvlc, "memory keystore init failed" );
 222
 223     vlc_CPU_dump( VLC_OBJECT(p_libvlc) );
 224
 225     /*
 226      * Initialize hotkey handling
 227      */
 228     if( libvlc_InternalActionsInit( p_libvlc ) != VLC_SUCCESS )
 229         goto error;
 230
 231     /*
 232      * Meta data handling
 233      */
 234     priv->parser = playlist_preparser_New(VLC_OBJECT(p_libvlc));
 235     if( !priv->parser )
 236         goto error;
 237
 238     /* Create a variable for showing the fullscreen interface */
 239     var_Create( p_libvlc, "intf-toggle-fscontrol", VLC_VAR_BOOL );
 240     var_SetBool( p_libvlc, "intf-toggle-fscontrol", true );
 241
 242     /* Create a variable for the Boss Key */
 243     var_Create( p_libvlc, "intf-boss", VLC_VAR_VOID );
 244
 245     /* Create a variable for showing the main interface */
 246     var_Create( p_libvlc, "intf-show", VLC_VAR_BOOL );
 247
 248     /* Create a variable for showing the right click menu */
 249     var_Create( p_libvlc, "intf-popupmenu", VLC_VAR_BOOL );
 250
 251     /* variables for signalling creation of new files */
 252     var_Create( p_libvlc, "snapshot-file", VLC_VAR_STRING );
 253     var_Create( p_libvlc, "record-file", VLC_VAR_STRING );
 254
 255     /* some default internal settings */
 256     var_Create( p_libvlc, "window", VLC_VAR_STRING );
 257     /* NOTE: Because the playlist and interfaces start before this function
 258      * returns control to the application (DESIGN BUG!), all these variables
 259      * must be created (in place of libvlc_new()) and set to VLC defaults
 260      * (in place of VLC main()) *here*. */
 261     var_Create( p_libvlc, "user-agent", VLC_VAR_STRING );
 262     var_SetString( p_libvlc, "user-agent",
 263                    "VLC media player (LibVLC "VERSION")" );
 264     var_Create( p_libvlc, "http-user-agent", VLC_VAR_STRING );
 265     var_SetString( p_libvlc, "http-user-agent",
 266                    "VLC/"PACKAGE_VERSION" LibVLC/"PACKAGE_VERSION );
 267     var_Create( p_libvlc, "app-icon-name", VLC_VAR_STRING );
 268     var_SetString( p_libvlc, "app-icon-name", PACKAGE_NAME );
 269     var_Create( p_libvlc, "app-id", VLC_VAR_STRING );
 270     var_SetString( p_libvlc, "app-id", "org.VideoLAN.VLC" );
 271     var_Create( p_libvlc, "app-version", VLC_VAR_STRING );
 272     var_SetString( p_libvlc, "app-version", PACKAGE_VERSION );
 273
 274     /* System specific configuration */
 275     system_Configure( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
 276
 277 #ifdef ENABLE_VLM
 278     /* Initialize VLM if vlm-conf is specified */
 279     psz_parser = var_CreateGetNonEmptyString( p_libvlc, "vlm-conf" );
 280     if( psz_parser )
 281     {
 282         priv->p_vlm = vlm_New( p_libvlc );
 283         if( !priv->p_vlm )
 284             msg_Err( p_libvlc, "VLM initialization failed" );
 285     }
 286     free( psz_parser );
 287 #endif
 288
 289     /*
 290      * Load background interfaces
 291      */
 292     psz_modules = var_CreateGetNonEmptyString( p_libvlc, "extraintf" );
 293     psz_control = var_CreateGetNonEmptyString( p_libvlc, "control" );
 294
 295     if( psz_modules && psz_control )
 296     {
 297         char* psz_tmp;
 298         if( asprintf( &psz_tmp, "%s:%s", psz_modules, psz_control ) != -1 )
 299         {
 300             free( psz_modules );
 301             psz_modules = psz_tmp;
 302         }
 303     }
 304     else if( psz_control )
 305     {
 306         free( psz_modules );
 307         psz_modules = strdup( psz_control );
 308     }
 309
 310     psz_parser = psz_modules;
 311     while ( psz_parser && *psz_parser )
 312     {
 313         char *psz_module, *psz_temp;
 314         psz_module = psz_parser;
 315         psz_parser = strchr( psz_module, ':' );
 316         if ( psz_parser )
 317         {
 318             *psz_parser = '\0';
 319             psz_parser++;
 320         }
 321         if( asprintf( &psz_temp, "%s,none", psz_module ) != -1)
 322         {
 323             libvlc_InternalAddIntf( p_libvlc, psz_temp );
 324             free( psz_temp );
 325         }
 326     }
 327     free( psz_modules );
 328     free( psz_control );
 329
 330     if( var_InheritBool( p_libvlc, "network-synchronisation") )
 331         libvlc_InternalAddIntf( p_libvlc, "netsync,none" );
 332
 333 #ifdef __APPLE__
 334     var_Create( p_libvlc, "drawable-view-top", VLC_VAR_INTEGER );
 335     var_Create( p_libvlc, "drawable-view-left", VLC_VAR_INTEGER );
 336     var_Create( p_libvlc, "drawable-view-bottom", VLC_VAR_INTEGER );
 337     var_Create( p_libvlc, "drawable-view-right", VLC_VAR_INTEGER );
 338     var_Create( p_libvlc, "drawable-clip-top", VLC_VAR_INTEGER );
 339     var_Create( p_libvlc, "drawable-clip-left", VLC_VAR_INTEGER );
 340     var_Create( p_libvlc, "drawable-clip-bottom", VLC_VAR_INTEGER );
 341     var_Create( p_libvlc, "drawable-clip-right", VLC_VAR_INTEGER );
 342     var_Create( p_libvlc, "drawable-nsobject", VLC_VAR_ADDRESS );
 343 #endif
 344
 345     /*
 346      * Get input filenames given as commandline arguments.
 347      * We assume that the remaining parameters are filenames
 348      * and their input options.
 349      */
 350     GetFilenames( p_libvlc, i_argc - vlc_optind, ppsz_argv + vlc_optind );
 351
 352     /*
 353      * Get --open argument
 354      */
 355     psz_val = var_InheritString( p_libvlc, "open" );
 356     if ( psz_val != NULL )
 357     {
 358         intf_InsertItem( p_libvlc, psz_val, 0, NULL, 0 );
 359         free( psz_val );
 360     }
 361
 362     return VLC_SUCCESS;
 363
 364 error:
 365     libvlc_InternalCleanup( p_libvlc );
 366     return i_ret;
 367 }
 368
 369 /**
 370  * Cleanup a libvlc instance. The instance is not completely deallocated
 371  * \param p_libvlc the instance to clean
 372  */
 373 void libvlc_InternalCleanup( libvlc_int_t *p_libvlc )
 374 {
 375     libvlc_priv_t *priv = libvlc_priv (p_libvlc);
 376
 377     if (priv->parser != NULL)
 378         playlist_preparser_Deactivate(priv->parser);
 379
 380     /* Ask the interfaces to stop and destroy them */
 381     msg_Dbg( p_libvlc, "removing all interfaces" );
 382     intf_DestroyAll( p_libvlc );
 383
 384     libvlc_InternalDialogClean( p_libvlc );
 385     libvlc_InternalKeystoreClean( p_libvlc );
 386
 387 #ifdef ENABLE_VLM
 388     /* Destroy VLM if created in libvlc_InternalInit */
 389     if( priv->p_vlm )
 390     {
 391         vlm_Delete( priv->p_vlm );
 392     }
 393 #endif
 394
 395 #if !defined( _WIN32 ) && !defined( __OS2__ )
 396     char *pidfile = var_InheritString( p_libvlc, "pidfile" );
 397     if( pidfile != NULL )
 398     {
 399         msg_Dbg( p_libvlc, "removing PID file %s", pidfile );
 400         if( unlink( pidfile ) )
 401             msg_Warn( p_libvlc, "cannot remove PID file %s: %s",
 402                       pidfile, vlc_strerror_c(errno) );
 403         free( pidfile );
 404     }
 405 #endif
 406
 407     if (priv->parser != NULL)
 408         playlist_preparser_Delete(priv->parser);
 409
 410     libvlc_InternalActionsClean( p_libvlc );
 411
 412     /* Save the configuration */
 413     if( !var_InheritBool( p_libvlc, "ignore-config" ) )
 414         config_AutoSaveConfigFile( VLC_OBJECT(p_libvlc) );
 415
 416     /* Free module bank. It is refcounted, so we call this each time  */
 417     vlc_LogDeinit (p_libvlc);
 418     module_EndBank (true);
 419 #if defined(_WIN32) || defined(__OS2__)
 420     system_End( );
 421 #endif
 422 }
 423
 424 /**
 425  * Destroy everything.
 426  * This function requests the running threads to finish, waits for their
 427  * termination, and destroys their structure.
 428  * It stops the thread systems: no instance can run after this has run
 429  * \param p_libvlc the instance to destroy
 430  */
 431 void libvlc_InternalDestroy( libvlc_int_t *p_libvlc )
 432 {
 433     libvlc_priv_t *priv = libvlc_priv( p_libvlc );
 434
 435     vlc_ExitDestroy( &priv->exit );
 436
 437     assert( atomic_load(&(vlc_internals(p_libvlc)->refs)) == 1 );
 438     vlc_object_release( p_libvlc );
 439 }
 440
 441 /*****************************************************************************
 442  * GetFilenames: parse command line options which are not flags
 443  *****************************************************************************
 444  * Parse command line for input files as well as their associated options.
 445  * An option always follows its associated input and begins with a ":".
 446  *****************************************************************************/
 447 static void GetFilenames( libvlc_int_t *p_vlc, unsigned n,
 448                           const char *const args[] )
 449 {
 450     while( n > 0 )
 451     {
 452         /* Count the input options */
 453         unsigned i_options = 0;
 454
 455         while( args[--n][0] == ':' )
 456         {
 457             i_options++;
 458             if( n == 0 )
 459             {
 460                 msg_Warn( p_vlc, "options %s without item", args[n] );
 461                 return; /* syntax!? */
 462             }
 463         }
 464
 465         char *mrl = NULL;
 466         if( strstr( args[n], "://" ) == NULL )
 467         {
 468             mrl = vlc_path2uri( args[n], NULL );
 469             if( !mrl )
 470                 continue;
 471         }
 472
 473         intf_InsertItem( p_vlc, (mrl != NULL) ? mrl : args[n], i_options,
 474                          ( i_options ? &args[n + 1] : NULL ),
 475                          VLC_INPUT_OPTION_TRUSTED );
 476         free( mrl );
 477     }
 478 }
 479
 480 /**
 481  * Requests extraction of the meta data for an input item (a.k.a. preparsing).
 482  * The actual extraction is asynchronous. It can be cancelled with
 483  * libvlc_MetadataCancel()
 484  */
 485 int libvlc_MetadataRequest(libvlc_int_t *libvlc, input_item_t *item,
 486                            input_item_meta_request_option_t i_options,
 487                            int timeout, void *id)
 488 {
 489     libvlc_priv_t *priv = libvlc_priv(libvlc);
 490
 491     if (unlikely(priv->parser == NULL))
 492         return VLC_ENOMEM;
 493
 494     vlc_mutex_lock( &item->lock );
 495     if( item->i_preparse_depth == 0 )
 496         item->i_preparse_depth = 1;
 497     if( i_options & META_REQUEST_OPTION_DO_INTERACT )
 498         item->b_preparse_interact = true;
 499     vlc_mutex_unlock( &item->lock );
 500     playlist_preparser_Push( priv->parser, item, i_options, timeout, id );
 501     return VLC_SUCCESS;
 502 }
 503
 504 /**
 505  * Requests retrieving/downloading art for an input item.
 506  * The retrieval is performed asynchronously.
 507  */
 508 int libvlc_ArtRequest(libvlc_int_t *libvlc, input_item_t *item,
 509                       input_item_meta_request_option_t i_options)
 510 {
 511     libvlc_priv_t *priv = libvlc_priv(libvlc);
 512
 513     if (unlikely(priv->parser == NULL))
 514         return VLC_ENOMEM;
 515
 516     playlist_preparser_fetcher_Push(priv->parser, item, i_options);
 517     return VLC_SUCCESS;
 518 }
 519
 520 /**
 521  * Cancels extraction of the meta data for an input item.
 522  *
 523  * This does nothing if the input item is already processed or if it was not
 524  * added with libvlc_MetadataRequest()
 525  */
 526 void libvlc_MetadataCancel(libvlc_int_t *libvlc, void *id)
 527 {
 528     libvlc_priv_t *priv = libvlc_priv(libvlc);
 529
 530     if (unlikely(priv->parser == NULL))
 531         return;
 532
 533     playlist_preparser_Cancel(priv->parser, id);
 534 }