git.sesse.net Git - vlc/blob - 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_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_input.h>
  36 #include <vlc_access.h>
  37 #include <vlc_dialog.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 #if defined (__linux__)
  51 #   include <sys/vfs.h>
  52 #   include <linux/magic.h>
  53 #   define HAVE_FSTATFS 1
  54 #elif defined (HAVE_SYS_MOUNT_H)
  55 #   include <sys/mount.h>
  56 #   define HAVE_FSTATFS 1
  57 #endif
  58
  59 #if defined( WIN32 )
  60 #   include <io.h>
  61 #   include <ctype.h>
  62 #else
  63 #   include <unistd.h>
  64 #   include <poll.h>
  65 #endif
  66
  67 #if defined( WIN32 ) && !defined( UNDER_CE )
  68 #   ifdef lseek
  69 #      undef lseek
  70 #   endif
  71 #   define lseek _lseeki64
  72 #elif defined( UNDER_CE )
  73 /* FIXME the commandline on wince is a mess */
  74 # define dup(a) -1
  75 #endif
  76
  77 #include <vlc_charset.h>
  78
  79 /*****************************************************************************
  80  * Module descriptor
  81  *****************************************************************************/
  82 static int  Open ( vlc_object_t * );
  83 static void Close( vlc_object_t * );
  84
  85 #define CACHING_TEXT N_("Caching value (ms)")
  86 #define CACHING_LONGTEXT N_( \
  87     "Caching value for files, in milliseconds." )
  88
  89 #define NETWORK_CACHING_TEXT N_("Extra network caching value (ms)")
  90 #define NETWORK_CACHING_LONGTEXT N_( \
  91     "Supplementary caching value for remote files, in milliseconds." )
  92
  93 vlc_module_begin ()
  94     set_description( N_("File input") )
  95     set_shortname( N_("File") )
  96     set_category( CAT_INPUT )
  97     set_subcategory( SUBCAT_INPUT_ACCESS )
  98     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL,
  99                  CACHING_TEXT, CACHING_LONGTEXT, true )
 100         change_safe()
 101     add_integer( "network-caching", 3 * DEFAULT_PTS_DELAY / 1000, NULL,
 102                  NETWORK_CACHING_TEXT, NETWORK_CACHING_LONGTEXT, true )
 103         change_safe()
 104     add_obsolete_string( "file-cat" )
 105     set_capability( "access", 50 )
 106     add_shortcut( "file" )
 107     add_shortcut( "fd" )
 108     add_shortcut( "stream" )
 109     set_callbacks( Open, Close )
 110 vlc_module_end ()
 111
 112
 113 /*****************************************************************************
 114  * Exported prototypes
 115  *****************************************************************************/
 116 static int  Seek( access_t *, int64_t );
 117 static int  NoSeek( access_t *, int64_t );
 118 static ssize_t Read( access_t *, uint8_t *, size_t );
 119 static int  Control( access_t *, int, va_list );
 120
 121 static int  open_file( access_t *, const char * );
 122
 123 struct access_sys_t
 124 {
 125     unsigned int i_nb_reads;
 126
 127     int fd;
 128
 129     /* */
 130     unsigned caching;
 131     bool b_pace_control;
 132 };
 133
 134 static bool IsRemote (int fd)
 135 {
 136 #ifdef HAVE_FSTATFS
 137     struct statfs stf;
 138
 139     if (fstatfs (fd, &stf))
 140         return false;
 141
 142 #if defined(MNT_LOCAL)
 143     return !(stf.f_flags & MNT_LOCAL);
 144
 145 #elif defined (__linux__)
 146     switch (stf.f_type)
 147     {
 148         case AFS_SUPER_MAGIC:
 149         case CODA_SUPER_MAGIC:
 150         case NCP_SUPER_MAGIC:
 151         case NFS_SUPER_MAGIC:
 152         case SMB_SUPER_MAGIC:
 153         case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
 154             return true;
 155     }
 156     return false;
 157
 158 #endif
 159 #else /* !HAVE_FSTATFS */
 160     return false;
 161
 162 #endif
 163 }
 164
 165
 166 /*****************************************************************************
 167  * Open: open the file
 168  *****************************************************************************/
 169 static int Open( vlc_object_t *p_this )
 170 {
 171     access_t     *p_access = (access_t*)p_this;
 172     access_sys_t *p_sys;
 173
 174     STANDARD_READ_ACCESS_INIT;
 175     p_sys->i_nb_reads = 0;
 176     p_sys->b_pace_control = true;
 177
 178     /* Open file */
 179     int fd = -1;
 180
 181     if (!strcasecmp (p_access->psz_access, "fd"))
 182         fd = dup (atoi (p_access->psz_path));
 183     else if (!strcmp (p_access->psz_path, "-"))
 184         fd = dup (0);
 185     else
 186     {
 187         msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
 188         fd = open_file (p_access, p_access->psz_path);
 189     }
 190     if (fd == -1)
 191         goto error;
 192
 193 #ifdef HAVE_SYS_STAT_H
 194     struct stat st;
 195
 196     if (fstat (fd, &st))
 197     {
 198         msg_Err (p_access, "failed to read (%m)");
 199         goto error;
 200     }
 201     /* Directories can be opened and read from, but only readdir() knows
 202      * how to parse the data. The directory plugin will do it. */
 203     if (S_ISDIR (st.st_mode))
 204     {
 205         msg_Dbg (p_access, "ignoring directory");
 206         goto error;
 207     }
 208     if (S_ISREG (st.st_mode))
 209         p_access->info.i_size = st.st_size;
 210     else if (!S_ISBLK (st.st_mode))
 211     {
 212         p_access->pf_seek = NoSeek;
 213         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 214     }
 215 #else
 216 # warning File size not known!
 217 #endif
 218
 219     p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
 220     if (IsRemote(fd))
 221         p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
 222
 223     p_sys->fd = fd;
 224     return VLC_SUCCESS;
 225
 226 error:
 227     if (fd != -1)
 228         close (fd);
 229     free (p_sys);
 230     return VLC_EGENERIC;
 231 }
 232
 233 /*****************************************************************************
 234  * Close: close the target
 235  *****************************************************************************/
 236 static void Close (vlc_object_t * p_this)
 237 {
 238     access_t     *p_access = (access_t*)p_this;
 239     access_sys_t *p_sys = p_access->p_sys;
 240
 241     close (p_sys->fd);
 242     free (p_sys);
 243 }
 244
 245
 246 #include <vlc_network.h>
 247
 248 /*****************************************************************************
 249  * Read: standard read on a file descriptor.
 250  *****************************************************************************/
 251 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 252 {
 253     access_sys_t *p_sys = p_access->p_sys;
 254     int fd = p_sys->fd;
 255     ssize_t i_ret;
 256
 257 #ifndef WIN32
 258     if (p_access->pf_seek == NoSeek)
 259         i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 260     else
 261 #endif
 262         i_ret = read (fd, p_buffer, i_len);
 263
 264     if( i_ret < 0 )
 265     {
 266         switch (errno)
 267         {
 268             case EINTR:
 269             case EAGAIN:
 270                 break;
 271
 272             default:
 273                 msg_Err (p_access, "failed to read (%m)");
 274                 dialog_Fatal (p_access, _("File reading failed"), "%s",
 275                               _("VLC could not read the file."));
 276                 p_access->info.b_eof = true;
 277                 return 0;
 278         }
 279     }
 280     else if( i_ret > 0 )
 281         p_access->info.i_pos += i_ret;
 282     else
 283         p_access->info.b_eof = true;
 284
 285     p_sys->i_nb_reads++;
 286
 287 #ifdef HAVE_SYS_STAT_H
 288     if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
 289      || (p_access->info.i_pos > p_access->info.i_size))
 290     {
 291         struct stat st;
 292
 293         if ((fstat (fd, &st) == 0)
 294          && (p_access->info.i_size != st.st_size))
 295         {
 296             p_access->info.i_size = st.st_size;
 297             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 298         }
 299     }
 300 #endif
 301     return i_ret;
 302 }
 303
 304
 305 /*****************************************************************************
 306  * Seek: seek to a specific location in a file
 307  *****************************************************************************/
 308 static int Seek (access_t *p_access, int64_t i_pos)
 309 {
 310     p_access->info.i_pos = i_pos;
 311     p_access->info.b_eof = false;
 312
 313     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 314     return VLC_SUCCESS;
 315 }
 316
 317 static int NoSeek (access_t *p_access, int64_t i_pos)
 318 {
 319     /* assert(0); ?? */
 320     (void) p_access; (void) i_pos;
 321     return VLC_EGENERIC;
 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     int64_t *pi_64;
 332
 333     switch( i_query )
 334     {
 335         /* */
 336         case ACCESS_CAN_SEEK:
 337         case ACCESS_CAN_FASTSEEK:
 338             pb_bool = (bool*)va_arg( args, bool* );
 339             *pb_bool = (p_access->pf_seek != NoSeek);
 340             break;
 341
 342         case ACCESS_CAN_PAUSE:
 343         case ACCESS_CAN_CONTROL_PACE:
 344             pb_bool = (bool*)va_arg( args, bool* );
 345             *pb_bool = p_sys->b_pace_control;
 346             break;
 347
 348         /* */
 349         case ACCESS_GET_PTS_DELAY:
 350             pi_64 = (int64_t*)va_arg( args, int64_t * );
 351             *pi_64 = p_sys->caching * INT64_C(1000);
 352             break;
 353
 354         /* */
 355         case ACCESS_SET_PAUSE_STATE:
 356             /* Nothing to do */
 357             break;
 358
 359         case ACCESS_GET_TITLE_INFO:
 360         case ACCESS_SET_TITLE:
 361         case ACCESS_SET_SEEKPOINT:
 362         case ACCESS_SET_PRIVATE_ID_STATE:
 363         case ACCESS_GET_META:
 364         case ACCESS_GET_PRIVATE_ID_STATE:
 365         case ACCESS_GET_CONTENT_TYPE:
 366             return VLC_EGENERIC;
 367
 368         default:
 369             msg_Warn( p_access, "unimplemented query %d in control", i_query );
 370             return VLC_EGENERIC;
 371
 372     }
 373     return VLC_SUCCESS;
 374 }
 375
 376 /*****************************************************************************
 377  * open_file: Opens a specific file
 378  *****************************************************************************/
 379 static int open_file (access_t *p_access, const char *path)
 380 {
 381 #if defined(WIN32)
 382     if (!strcasecmp (p_access->psz_access, "file")
 383       && ('/' == path[0]) && isalpha (path[1])
 384       && (':' == path[2]) && ('/' == path[3]))
 385         /* Explorer can open path such as file:/C:/ or file:///C:/
 386          * hence remove leading / if found */
 387         path++;
 388 #endif
 389
 390     int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
 391     if (fd == -1)
 392     {
 393         msg_Err (p_access, "cannot open file %s (%m)", path);
 394         dialog_Fatal (p_access, _("File reading failed"),
 395                       _("VLC could not open the file \"%s\"."), path);
 396         return -1;
 397     }
 398
 399 #if defined(HAVE_FCNTL)
 400     /* We'd rather use any available memory for reading ahead
 401      * than for caching what we've already seen/heard */
 402 # if defined(F_RDAHEAD)
 403     fcntl (fd, F_RDAHEAD, 1);
 404 # endif
 405 # if defined(F_NOCACHE)
 406     fcntl (fd, F_NOCACHE, 1);
 407 # endif
 408 #endif
 409
 410     return fd;
 411 }