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