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