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