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 static int  open_file( access_t *, const char * );
 125
 126 struct access_sys_t
 127 {
 128     unsigned int i_nb_reads;
 129
 130     int fd;
 131
 132     /* */
 133     unsigned caching;
 134     bool b_pace_control;
 135 };
 136
 137 static bool IsRemote (int fd)
 138 {
 139 #ifdef HAVE_FSTATFS
 140     struct statfs stf;
 141
 142     if (fstatfs (fd, &stf))
 143         return false;
 144
 145 #if defined(MNT_LOCAL)
 146     return !(stf.f_flags & MNT_LOCAL);
 147
 148 #else
 149 #   ifdef HAVE_LINUX_MAGIC_H
 150     switch (stf.f_type)
 151     {
 152         case AFS_SUPER_MAGIC:
 153         case CODA_SUPER_MAGIC:
 154         case NCP_SUPER_MAGIC:
 155         case NFS_SUPER_MAGIC:
 156         case SMB_SUPER_MAGIC:
 157         case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
 158             return true;
 159     }
 160     return false;
 161 #   endif
 162 #endif
 163 #else /* !HAVE_FSTATFS */
 164     (void)fd;
 165     return false;
 166
 167 #endif
 168 }
 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 #ifdef WIN32
 182     wchar_t wpath[MAX_PATH+1];
 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 (p_access->psz_path));
 195     else if (!strcmp (p_access->psz_path, "-"))
 196         fd = dup (0);
 197     else
 198     {
 199         msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
 200         fd = open_file (p_access, p_access->psz_path);
 201 #ifdef WIN32
 202         if (MultiByteToWideChar (CP_UTF8, 0, p_access->psz_path, -1,
 203                                  wpath, MAX_PATH)
 204          && PathIsNetworkPathW (wpath))
 205             is_remote = true;
 206 # define IsRemote( fd ) ((void)fd, is_remote)
 207 #endif
 208     }
 209     if (fd == -1)
 210         goto error;
 211
 212 #ifdef HAVE_SYS_STAT_H
 213     struct stat st;
 214
 215     if (fstat (fd, &st))
 216     {
 217         msg_Err (p_access, "failed to read (%m)");
 218         goto error;
 219     }
 220     /* Directories can be opened and read from, but only readdir() knows
 221      * how to parse the data. The directory plugin will do it. */
 222     if (S_ISDIR (st.st_mode))
 223     {
 224         msg_Dbg (p_access, "ignoring directory");
 225         goto error;
 226     }
 227     if (S_ISREG (st.st_mode))
 228         p_access->info.i_size = st.st_size;
 229     else if (!S_ISBLK (st.st_mode))
 230     {
 231         p_access->pf_seek = NoSeek;
 232         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 233     }
 234 #else
 235 # warning File size not known!
 236 #endif
 237
 238     p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
 239     if (IsRemote(fd))
 240         p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
 241
 242     p_sys->fd = fd;
 243
 244     if (p_access->pf_seek != NoSeek)
 245     {
 246         /* Demuxers will need the beginning of the file for probing. */
 247         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
 248         /* In most cases, we only read the file once. */
 249         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
 250     }
 251     return VLC_SUCCESS;
 252
 253 error:
 254     if (fd != -1)
 255         close (fd);
 256     free (p_sys);
 257     return VLC_EGENERIC;
 258 }
 259
 260 /*****************************************************************************
 261  * Close: close the target
 262  *****************************************************************************/
 263 static void Close (vlc_object_t * p_this)
 264 {
 265     access_t     *p_access = (access_t*)p_this;
 266     access_sys_t *p_sys = p_access->p_sys;
 267
 268     close (p_sys->fd);
 269     free (p_sys);
 270 }
 271
 272
 273 #include <vlc_network.h>
 274
 275 /*****************************************************************************
 276  * Read: standard read on a file descriptor.
 277  *****************************************************************************/
 278 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 279 {
 280     access_sys_t *p_sys = p_access->p_sys;
 281     int fd = p_sys->fd;
 282     ssize_t i_ret;
 283
 284 #ifndef WIN32
 285     if (p_access->pf_seek == NoSeek)
 286         i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 287     else
 288 #endif
 289         i_ret = read (fd, p_buffer, i_len);
 290
 291     if( i_ret < 0 )
 292     {
 293         switch (errno)
 294         {
 295             case EINTR:
 296             case EAGAIN:
 297                 break;
 298
 299             default:
 300                 msg_Err (p_access, "failed to read (%m)");
 301                 dialog_Fatal (p_access, _("File reading failed"), "%s",
 302                               _("VLC could not read the file."));
 303                 p_access->info.b_eof = true;
 304                 return 0;
 305         }
 306     }
 307     else if( i_ret > 0 )
 308         p_access->info.i_pos += i_ret;
 309     else
 310         p_access->info.b_eof = true;
 311
 312     p_sys->i_nb_reads++;
 313
 314     if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
 315      || (p_access->info.i_pos > p_access->info.i_size))
 316     {
 317 #ifdef HAVE_SYS_STAT_H
 318         struct stat st;
 319
 320         if ((fstat (fd, &st) == 0)
 321          && (p_access->info.i_size != st.st_size))
 322         {
 323             p_access->info.i_size = st.st_size;
 324             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 325         }
 326 #endif
 327     }
 328     return i_ret;
 329 }
 330
 331
 332 /*****************************************************************************
 333  * Seek: seek to a specific location in a file
 334  *****************************************************************************/
 335 static int Seek (access_t *p_access, int64_t i_pos)
 336 {
 337     p_access->info.i_pos = i_pos;
 338     p_access->info.b_eof = false;
 339
 340     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 341     return VLC_SUCCESS;
 342 }
 343
 344 static int NoSeek (access_t *p_access, int64_t i_pos)
 345 {
 346     /* assert(0); ?? */
 347     (void) p_access; (void) i_pos;
 348     return VLC_EGENERIC;
 349 }
 350
 351 /*****************************************************************************
 352  * Control:
 353  *****************************************************************************/
 354 static int Control( access_t *p_access, int i_query, va_list args )
 355 {
 356     access_sys_t *p_sys = p_access->p_sys;
 357     bool    *pb_bool;
 358     int64_t *pi_64;
 359
 360     switch( i_query )
 361     {
 362         /* */
 363         case ACCESS_CAN_SEEK:
 364         case ACCESS_CAN_FASTSEEK:
 365             pb_bool = (bool*)va_arg( args, bool* );
 366             *pb_bool = (p_access->pf_seek != NoSeek);
 367             break;
 368
 369         case ACCESS_CAN_PAUSE:
 370         case ACCESS_CAN_CONTROL_PACE:
 371             pb_bool = (bool*)va_arg( args, bool* );
 372             *pb_bool = p_sys->b_pace_control;
 373             break;
 374
 375         /* */
 376         case ACCESS_GET_PTS_DELAY:
 377             pi_64 = (int64_t*)va_arg( args, int64_t * );
 378             *pi_64 = p_sys->caching * INT64_C(1000);
 379             break;
 380
 381         /* */
 382         case ACCESS_SET_PAUSE_STATE:
 383             /* Nothing to do */
 384             break;
 385
 386         case ACCESS_GET_TITLE_INFO:
 387         case ACCESS_SET_TITLE:
 388         case ACCESS_SET_SEEKPOINT:
 389         case ACCESS_SET_PRIVATE_ID_STATE:
 390         case ACCESS_GET_META:
 391         case ACCESS_GET_PRIVATE_ID_STATE:
 392         case ACCESS_GET_CONTENT_TYPE:
 393             return VLC_EGENERIC;
 394
 395         default:
 396             msg_Warn( p_access, "unimplemented query %d in control", i_query );
 397             return VLC_EGENERIC;
 398
 399     }
 400     return VLC_SUCCESS;
 401 }
 402
 403 /*****************************************************************************
 404  * open_file: Opens a specific file
 405  *****************************************************************************/
 406 static int open_file (access_t *p_access, const char *path)
 407 {
 408 #if defined(WIN32)
 409     if (!strcasecmp (p_access->psz_access, "file")
 410       && ('/' == path[0]) && isalpha (path[1])
 411       && (':' == path[2]) && ('/' == path[3]))
 412         /* Explorer can open path such as file:/C:/ or file:///C:/
 413          * hence remove leading / if found */
 414         path++;
 415 #endif
 416
 417     int fd = utf8_open (path, O_RDONLY | O_NONBLOCK);
 418     if (fd == -1)
 419     {
 420         msg_Err (p_access, "cannot open file %s (%m)", path);
 421         dialog_Fatal (p_access, _("File reading failed"),
 422                       _("VLC could not open the file \"%s\"."), path);
 423         return -1;
 424     }
 425
 426 #if defined(HAVE_FCNTL)
 427     /* We'd rather use any available memory for reading ahead
 428      * than for caching what we've already seen/heard */
 429 # if defined(F_RDAHEAD)
 430     fcntl (fd, F_RDAHEAD, 1);
 431 # endif
 432 # if defined(F_NOCACHE)
 433     fcntl (fd, F_NOCACHE, 1);
 434 # endif
 435 #endif
 436
 437     return fd;
 438 }