modules/access/file.c

   1 /*****************************************************************************
   2  * file.c: file input (file: access plug-in)
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   9  *          Rémi Denis-Courmont <rem # videolan # org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc/vlc.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_input.h>
  36 #include <vlc_access.h>
  37 #include <vlc_interface.h>
  38
  39 #include <assert.h>
  40 #include <errno.h>
  41 #ifdef HAVE_SYS_TYPES_H
  42 #   include <sys/types.h>
  43 #endif
  44 #ifdef HAVE_SYS_STAT_H
  45 #   include <sys/stat.h>
  46 #endif
  47 #ifdef HAVE_FCNTL_H
  48 #   include <fcntl.h>
  49 #endif
  50
  51 #if defined( WIN32 ) && !defined( UNDER_CE )
  52 #   include <io.h>
  53 #   include <ctype.h>
  54 #else
  55 #   include <unistd.h>
  56 #   include <poll.h>
  57 #endif
  58
  59 #if defined( WIN32 ) && !defined( UNDER_CE )
  60 #   ifdef lseek
  61 #      undef lseek
  62 #   endif
  63 #   define lseek _lseeki64
  64 #elif defined( UNDER_CE )
  65 #   ifdef read
  66 #      undef read
  67 #   endif
  68 #   define read(a,b,c) fread(b,1,c,a)
  69 #   define close(a) fclose(a)
  70 #   ifdef lseek
  71 #      undef lseek
  72 #   endif
  73 #   define lseek fseek
  74 #endif
  75
  76 #include <vlc_charset.h>
  77
  78 /*****************************************************************************
  79  * Module descriptor
  80  *****************************************************************************/
  81 static int  Open ( vlc_object_t * );
  82 static void Close( vlc_object_t * );
  83
  84 #define CACHING_TEXT N_("Caching value in ms")
  85 #define CACHING_LONGTEXT N_( \
  86     "Caching value for files. This " \
  87     "value should be set in milliseconds." )
  88
  89 vlc_module_begin();
  90     set_description( N_("File input") );
  91     set_shortname( N_("File") );
  92     set_category( CAT_INPUT );
  93     set_subcategory( SUBCAT_INPUT_ACCESS );
  94     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true );
  95     add_obsolete_string( "file-cat" );
  96     set_capability( "access", 50 );
  97     add_shortcut( "file" );
  98     add_shortcut( "stream" );
  99     add_shortcut( "kfir" );
 100     set_callbacks( Open, Close );
 101 vlc_module_end();
 102
 103
 104 /*****************************************************************************
 105  * Exported prototypes
 106  *****************************************************************************/
 107 static int  Seek( access_t *, int64_t );
 108 static ssize_t Read( access_t *, uint8_t *, size_t );
 109 static int  Control( access_t *, int, va_list );
 110
 111 static int  open_file( access_t *, const char * );
 112
 113 struct access_sys_t
 114 {
 115     unsigned int i_nb_reads;
 116     bool   b_kfir;
 117
 118     int fd;
 119
 120     /* */
 121     bool b_seekable;
 122     bool b_pace_control;
 123 };
 124
 125 /*****************************************************************************
 126  * Open: open the file
 127  *****************************************************************************/
 128 static int Open( vlc_object_t *p_this )
 129 {
 130     access_t     *p_access = (access_t*)p_this;
 131     access_sys_t *p_sys;
 132
 133     bool    b_stdin = !strcmp (p_access->psz_path, "-");
 134
 135     /* Update default_pts to a suitable value for file access */
 136     var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 137
 138     STANDARD_READ_ACCESS_INIT;
 139     p_sys->i_nb_reads = 0;
 140     p_sys->b_kfir = false;
 141     int fd = p_sys->fd = -1;
 142
 143     if (!strcasecmp (p_access->psz_access, "stream"))
 144     {
 145         p_sys->b_seekable = false;
 146         p_sys->b_pace_control = false;
 147     }
 148     else if (!strcasecmp (p_access->psz_access, "kfir"))
 149     {
 150         p_sys->b_seekable = false;
 151         p_sys->b_pace_control = false;
 152         p_sys->b_kfir = true;
 153     }
 154     else
 155     {
 156         p_sys->b_seekable = true;
 157         p_sys->b_pace_control = true;
 158     }
 159
 160     /* Open file */
 161     msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
 162
 163     if (b_stdin)
 164         fd = dup (0);
 165     else
 166         fd = open_file (p_access, p_access->psz_path);
 167
 168 #ifdef HAVE_SYS_STAT_H
 169     struct stat st;
 170
 171     while (fd != -1)
 172     {
 173         if (fstat (fd, &st))
 174             msg_Err (p_access, "fstat(%d): %m", fd);
 175         else
 176         if (S_ISDIR (st.st_mode))
 177             /* The directory plugin takes care of that */
 178             msg_Dbg (p_access, "file is a directory, aborting");
 179         else
 180             break; // success
 181
 182         close (fd);
 183         fd = -1;
 184     }
 185 #endif
 186
 187     if (fd == -1)
 188     {
 189         free (p_sys);
 190         return VLC_EGENERIC;
 191     }
 192     p_sys->fd = fd;
 193
 194 #ifdef HAVE_SYS_STAT_H
 195     p_access->info.i_size = st.st_size;
 196     if (!S_ISREG (st.st_mode)
 197      && !S_ISBLK (st.st_mode)
 198      && !S_ISCHR (st.st_mode))
 199         p_sys->b_seekable = false;
 200 #else
 201     p_sys->b_seekable = !b_stdin;
 202 # warning File size not known!
 203 #endif
 204
 205     return VLC_SUCCESS;
 206 }
 207
 208 /*****************************************************************************
 209  * Close: close the target
 210  *****************************************************************************/
 211 static void Close (vlc_object_t * p_this)
 212 {
 213     access_t     *p_access = (access_t*)p_this;
 214     access_sys_t *p_sys = p_access->p_sys;
 215
 216     close (p_sys->fd);
 217     free (p_sys);
 218 }
 219
 220 /*****************************************************************************
 221  * Read: standard read on a file descriptor.
 222  *****************************************************************************/
 223 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 224 {
 225     access_sys_t *p_sys = p_access->p_sys;
 226     ssize_t i_ret;
 227     int fd = p_sys->fd;
 228
 229 #if !defined(WIN32) && !defined(UNDER_CE)
 230     if( !p_sys->b_pace_control )
 231     {
 232         if( !p_sys->b_kfir )
 233         {
 234             /* Find if some data is available. This won't work under Windows. */
 235             do
 236             {
 237                 struct pollfd ufd;
 238
 239                 if( p_access->b_die )
 240                     return 0;
 241
 242                 memset (&ufd, 0, sizeof (ufd));
 243                 ufd.fd = fd;
 244                 ufd.events = POLLIN;
 245
 246                 i_ret = poll (&ufd, 1, 500);
 247             }
 248             while (i_ret <= 0);
 249
 250             i_ret = read (fd, p_buffer, i_len);
 251         }
 252         else
 253         {
 254             /* b_kfir ; work around a buggy poll() driver implementation */
 255             while (((i_ret = read (fd, p_buffer, i_len)) == 0)
 256                 && !p_access->b_die)
 257             {
 258                 msleep( INPUT_ERROR_SLEEP );
 259             }
 260         }
 261     }
 262     else
 263 #endif /* WIN32 || UNDER_CE */
 264         /* b_pace_control || WIN32 */
 265         i_ret = read( fd, p_buffer, i_len );
 266
 267     if( i_ret < 0 )
 268     {
 269         switch (errno)
 270         {
 271             case EINTR:
 272             case EAGAIN:
 273                 break;
 274
 275             default:
 276                 msg_Err (p_access, "read failed (%m)");
 277                 intf_UserFatal (p_access, false, _("File reading failed"),
 278                                 _("VLC could not read the file."));
 279         }
 280
 281         /* Delay a bit to avoid consuming all the CPU. This is particularly
 282          * useful when reading from an unconnected FIFO. */
 283         msleep( INPUT_ERROR_SLEEP );
 284     }
 285
 286     p_sys->i_nb_reads++;
 287
 288 #ifdef HAVE_SYS_STAT_H
 289     if( p_access->info.i_size != 0 &&
 290         (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
 291     {
 292         struct stat st;
 293
 294         if ((fstat (fd, &st) == 0)
 295          && (p_access->info.i_size != st.st_size))
 296         {
 297             p_access->info.i_size = st.st_size;
 298             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 299         }
 300     }
 301 #endif
 302
 303     if( i_ret > 0 )
 304         p_access->info.i_pos += i_ret;
 305     else if( i_ret == 0 )
 306         p_access->info.b_eof = true;
 307
 308     return i_ret;
 309 }
 310
 311
 312 /*****************************************************************************
 313  * Seek: seek to a specific location in a file
 314  *****************************************************************************/
 315 static int Seek (access_t *p_access, int64_t i_pos)
 316 {
 317     p_access->info.i_pos = i_pos;
 318     p_access->info.b_eof = false;
 319
 320     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 321     return VLC_SUCCESS;
 322 }
 323
 324 /*****************************************************************************
 325  * Control:
 326  *****************************************************************************/
 327 static int Control( access_t *p_access, int i_query, va_list args )
 328 {
 329     access_sys_t *p_sys = p_access->p_sys;
 330     bool   *pb_bool;
 331     int          *pi_int;
 332     int64_t      *pi_64;
 333
 334     switch( i_query )
 335     {
 336         /* */
 337         case ACCESS_CAN_SEEK:
 338         case ACCESS_CAN_FASTSEEK:
 339             pb_bool = (bool*)va_arg( args, bool* );
 340             *pb_bool = p_sys->b_seekable;
 341             break;
 342
 343         case ACCESS_CAN_PAUSE:
 344         case ACCESS_CAN_CONTROL_PACE:
 345             pb_bool = (bool*)va_arg( args, bool* );
 346             *pb_bool = p_sys->b_pace_control;
 347             break;
 348
 349         /* */
 350         case ACCESS_GET_MTU:
 351             pi_int = (int*)va_arg( args, int * );
 352             *pi_int = 0;
 353             break;
 354
 355         case ACCESS_GET_PTS_DELAY:
 356             pi_64 = (int64_t*)va_arg( args, int64_t * );
 357             *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
 358             break;
 359
 360         /* */
 361         case ACCESS_SET_PAUSE_STATE:
 362             /* Nothing to do */
 363             break;
 364
 365         case ACCESS_GET_TITLE_INFO:
 366         case ACCESS_SET_TITLE:
 367         case ACCESS_SET_SEEKPOINT:
 368         case ACCESS_SET_PRIVATE_ID_STATE:
 369         case ACCESS_GET_META:
 370         case ACCESS_GET_PRIVATE_ID_STATE:
 371         case ACCESS_GET_CONTENT_TYPE:
 372             return VLC_EGENERIC;
 373
 374         default:
 375             msg_Warn( p_access, "unimplemented query %d in control", i_query );
 376             return VLC_EGENERIC;
 377
 378     }
 379     return VLC_SUCCESS;
 380 }
 381
 382 /*****************************************************************************
 383  * open_file: Opens a specific file
 384  *****************************************************************************/
 385 static int open_file (access_t *p_access, const char *path)
 386 {
 387 #if defined(WIN32)
 388     if (!strcasecmp (p_access->psz_access, "file")
 389       && ('/' == path[0]) && isalpha (path[1])
 390       && (':' == path[2]) && ('/' == path[3]))
 391         /* Explorer can open path such as file:/C:/ or file:///C:/
 392          * hence remove leading / if found */
 393         path++;
 394 #endif
 395
 396 #ifdef UNDER_CE
 397     p_sys->fd = utf8_fopen( path, "rb" );
 398     if ( !p_sys->fd )
 399     {
 400         msg_Err( p_access, "cannot open file %s", path );
 401         intf_UserFatal( p_access, false, _("File reading failed"),
 402                         _("VLC could not open the file \"%s\"."), path );
 403         return VLC_EGENERIC;
 404     }
 405
 406     fseek( p_sys->fd, 0, SEEK_END );
 407     p_access->info.i_size = ftell( p_sys->fd );
 408     p_access->info.i_update |= INPUT_UPDATE_SIZE;
 409     fseek( p_sys->fd, 0, SEEK_SET );
 410 #else
 411     int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
 412     if (fd == -1)
 413     {
 414         msg_Err (p_access, "cannot open file %s (%m)", path);
 415         intf_UserFatal (p_access, false, _("File reading failed"),
 416                         _("VLC could not open the file \"%s\"."), path);
 417         return -1;
 418     }
 419
 420 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
 421     /* We'd rather use any available memory for reading ahead
 422      * than for caching what we've already seen/heard */
 423     fcntl (fd, F_RDAHEAD, 1);
 424     fcntl (fd, F_NOCACHE, 1);
 425 # endif
 426 #endif
 427
 428     return fd;
 429 }