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 #include <vlc/vlc.h>
  30 #include <vlc_input.h>
  31 #include <vlc_access.h>
  32 #include <vlc_interface.h>
  33
  34 #include <assert.h>
  35 #include <errno.h>
  36 #ifdef HAVE_SYS_TYPES_H
  37 #   include <sys/types.h>
  38 #endif
  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
  46 #if defined( WIN32 ) && !defined( UNDER_CE )
  47 #   include <io.h>
  48 #else
  49 #   include <unistd.h>
  50 #   include <poll.h>
  51 #endif
  52 #ifdef HAVE_MMAP
  53 #   include <sys/mman.h>
  54 #endif
  55
  56 #if defined( WIN32 ) && !defined( UNDER_CE )
  57 #   ifdef lseek
  58 #      undef lseek
  59 #   endif
  60 #   define lseek _lseeki64
  61 #elif defined( UNDER_CE )
  62 #   ifdef read
  63 #      undef read
  64 #   endif
  65 #   define read(a,b,c) fread(b,1,c,a)
  66 #   define close(a) fclose(a)
  67 #   ifdef lseek
  68 #      undef lseek
  69 #   endif
  70 #   define lseek fseek
  71 #endif
  72
  73 #include <vlc_charset.h>
  74
  75 /*****************************************************************************
  76  * Module descriptor
  77  *****************************************************************************/
  78 static int  Open ( vlc_object_t * );
  79 static void Close( vlc_object_t * );
  80
  81 #define CACHING_TEXT N_("Caching value in ms")
  82 #define CACHING_LONGTEXT N_( \
  83     "Caching value for files. This " \
  84     "value should be set in milliseconds." )
  85 #define CAT_TEXT N_("Concatenate with additional files")
  86 #define CAT_LONGTEXT N_( \
  87     "Play split files as if they were part of a unique file. " \
  88     "You need to specify a comma-separated list of files." )
  89
  90 vlc_module_begin();
  91     set_description( _("File input") );
  92     set_shortname( _("File") );
  93     set_category( CAT_INPUT );
  94     set_subcategory( SUBCAT_INPUT_ACCESS );
  95     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
  96     add_obsolete_string( "file-cat" );
  97     set_capability( "access2", 50 );
  98     add_shortcut( "file" );
  99     add_shortcut( "stream" );
 100     add_shortcut( "kfir" );
 101     set_callbacks( Open, Close );
 102 vlc_module_end();
 103
 104
 105 /*****************************************************************************
 106  * Exported prototypes
 107  *****************************************************************************/
 108 static int  Seek( access_t *, int64_t );
 109 static ssize_t Read( access_t *, uint8_t *, size_t );
 110 static int  Control( access_t *, int, va_list );
 111 #ifdef HAVE_MMAP
 112 static block_t *mmapBlock( access_t * );
 113 #endif
 114
 115 static int  open_file( access_t *, const char * );
 116
 117 struct access_sys_t
 118 {
 119     uint64_t     pagemask;
 120     unsigned int i_nb_reads;
 121     vlc_bool_t   b_kfir;
 122
 123     int fd;
 124
 125     /* */
 126     vlc_bool_t b_seekable;
 127     vlc_bool_t b_pace_control;
 128 };
 129
 130 /*****************************************************************************
 131  * Open: open the file
 132  *****************************************************************************/
 133 static int Open( vlc_object_t *p_this )
 134 {
 135     access_t     *p_access = (access_t*)p_this;
 136     access_sys_t *p_sys;
 137
 138     vlc_bool_t    b_stdin = !strcmp (p_access->psz_path, "-");
 139
 140     /* Update default_pts to a suitable value for file access */
 141     var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 142
 143     STANDARD_READ_ACCESS_INIT;
 144     p_sys->i_nb_reads = 0;
 145     p_sys->b_kfir = VLC_FALSE;
 146     int fd = p_sys->fd = -1;
 147
 148     if (!strcasecmp (p_access->psz_access, "stream"))
 149     {
 150         p_sys->b_seekable = VLC_FALSE;
 151         p_sys->b_pace_control = VLC_FALSE;
 152     }
 153     else if (!strcasecmp (p_access->psz_access, "kfir"))
 154     {
 155         p_sys->b_seekable = VLC_FALSE;
 156         p_sys->b_pace_control = VLC_FALSE;
 157         p_sys->b_kfir = VLC_TRUE;
 158     }
 159     else
 160     {
 161         p_sys->b_seekable = VLC_TRUE;
 162         p_sys->b_pace_control = VLC_TRUE;
 163     }
 164
 165     /* Open file */
 166     msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
 167
 168     if (b_stdin)
 169         fd = dup (0);
 170     else
 171         fd = open_file (p_access, p_access->psz_path);
 172
 173 #ifdef HAVE_SYS_STAT_H
 174     struct stat st;
 175
 176     while (fd != -1)
 177     {
 178         if (fstat (fd, &st))
 179             msg_Err (p_access, "fstat(%d): %m", fd);
 180         else
 181         if (S_ISDIR (st.st_mode))
 182             /* The directory plugin takes care of that */
 183             msg_Dbg (p_access, "file is a directory, aborting");
 184         else
 185             break; // success
 186
 187         close (fd);
 188         fd = -1;
 189     }
 190 #endif
 191
 192     if (fd == -1)
 193     {
 194         free (p_sys);
 195         return VLC_EGENERIC;
 196     }
 197     p_sys->fd = fd;
 198
 199 #ifdef HAVE_SYS_STAT_H
 200     p_access->info.i_size = st.st_size;
 201     if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
 202      && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
 203         p_sys->b_seekable = VLC_FALSE;
 204
 205 # ifdef HAVE_MMAP
 206     p_sys->pagemask = sysconf (_SC_PAGE_SIZE) - 1;
 207
 208     /* Autodetect mmap() support */
 209     if (p_sys->b_pace_control && S_ISREG (st.st_mode) && (st.st_size > 0))
 210     {
 211         /* TODO: Do not allow PROT_WRITE, we should not need it.
 212          * However, this far, "block" ownership seems such that whoever
 213          * "receives" a block can freely modify its content. Hence we _may_
 214          * need PROT_WRITE not to default memory protection.
 215          * NOTE: With MAP_PRIVATE, changes are not committed to the underlying
 216          * file, write open permission is not required.
 217          */
 218         void *addr = mmap (NULL, 1, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
 219         if (addr != MAP_FAILED)
 220         {
 221             /* Does the file system support mmap? */
 222             munmap (addr, 1);
 223             p_access->pf_read = NULL;
 224             p_access->pf_block = mmapBlock;
 225             msg_Dbg (p_this, "mmap enabled");
 226         }
 227         else
 228             msg_Dbg (p_this, "mmap disabled (%m)");
 229     }
 230     else
 231         msg_Dbg (p_this, "mmap disabled (non regular file)");
 232 # endif
 233 #else
 234     p_sys->b_seekable = !b_stdin;
 235 # warning File size not known!
 236 #endif
 237
 238     if (p_sys->b_seekable && (p_access->info.i_size == 0))
 239     {
 240         /* FIXME that's bad because all others access will be probed */
 241         msg_Err (p_access, "file is empty, aborting");
 242         Close (p_this);
 243         return VLC_EGENERIC;
 244     }
 245
 246     return VLC_SUCCESS;
 247 }
 248
 249 /*****************************************************************************
 250  * Close: close the target
 251  *****************************************************************************/
 252 static void Close (vlc_object_t * p_this)
 253 {
 254     access_t     *p_access = (access_t*)p_this;
 255     access_sys_t *p_sys = p_access->p_sys;
 256
 257     close (p_sys->fd);
 258     free (p_sys);
 259 }
 260
 261 /*****************************************************************************
 262  * Read: standard read on a file descriptor.
 263  *****************************************************************************/
 264 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 265 {
 266     access_sys_t *p_sys = p_access->p_sys;
 267     ssize_t i_ret;
 268     int fd = p_sys->fd;
 269
 270 #if !defined(WIN32) && !defined(UNDER_CE)
 271     if( !p_sys->b_pace_control )
 272     {
 273         if( !p_sys->b_kfir )
 274         {
 275             /* Find if some data is available. This won't work under Windows. */
 276             do
 277             {
 278                 struct pollfd ufd;
 279
 280                 if( p_access->b_die )
 281                     return 0;
 282
 283                 memset (&ufd, 0, sizeof (ufd));
 284                 ufd.fd = fd;
 285                 ufd.events = POLLIN;
 286
 287                 i_ret = poll (&ufd, 1, 500);
 288             }
 289             while (i_ret <= 0);
 290
 291             i_ret = read (fd, p_buffer, i_len);
 292         }
 293         else
 294         {
 295             /* b_kfir ; work around a buggy poll() driver implementation */
 296             while (((i_ret = read (fd, p_buffer, i_len)) == 0)
 297                 && !p_access->b_die)
 298             {
 299                 msleep( INPUT_ERROR_SLEEP );
 300             }
 301         }
 302     }
 303     else
 304 #endif /* WIN32 || UNDER_CE */
 305         /* b_pace_control || WIN32 */
 306         i_ret = read( fd, p_buffer, i_len );
 307
 308     if( i_ret < 0 )
 309     {
 310         switch (errno)
 311         {
 312             case EINTR:
 313             case EAGAIN:
 314                 break;
 315
 316             default:
 317                 msg_Err (p_access, "read failed (%m)");
 318                 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
 319                                 _("VLC could not read the file."));
 320         }
 321
 322         /* Delay a bit to avoid consuming all the CPU. This is particularly
 323          * useful when reading from an unconnected FIFO. */
 324         msleep( INPUT_ERROR_SLEEP );
 325     }
 326
 327     p_sys->i_nb_reads++;
 328
 329 #ifdef HAVE_SYS_STAT_H
 330     if( p_access->info.i_size != 0 &&
 331         (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
 332     {
 333         struct stat st;
 334
 335         if ((fstat (fd, &st) == 0)
 336          && (p_access->info.i_size != st.st_size))
 337         {
 338             p_access->info.i_size = st.st_size;
 339             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 340         }
 341     }
 342 #endif
 343
 344     if( i_ret > 0 )
 345         p_access->info.i_pos += i_ret;
 346     else if( i_ret == 0 )
 347         p_access->info.b_eof = VLC_TRUE;
 348
 349     return i_ret;
 350 }
 351
 352 #ifdef HAVE_MMAP
 353 # define MMAP_SIZE (1 << 20)
 354
 355 static block_t *mmapBlock (access_t *p_access)
 356 {
 357     access_sys_t *p_sys = p_access->p_sys;
 358
 359     const int flags = MAP_SHARED;
 360     off_t offset = p_access->info.i_pos & ~p_sys->pagemask;
 361     size_t align = p_access->info.i_pos & p_sys->pagemask;
 362     size_t length = (MMAP_SIZE > p_sys->pagemask) ? MMAP_SIZE : (p_sys->pagemask + 1);
 363     void *addr;
 364
 365 #ifndef NDEBUG
 366     int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
 367     if (dbgpos != p_access->info.i_pos)
 368         msg_Err (p_access, "position: 0x%08llx instead of 0x%08llx",
 369                  p_access->info.i_pos, dbgpos);
 370 #endif
 371
 372     if (p_access->info.i_pos >= p_access->info.i_size)
 373     {
 374         /* End of file - check if file size changed... */
 375         struct stat st;
 376
 377         if ((fstat (p_sys->fd, &st) == 0)
 378          && (st.st_size != p_access->info.i_size))
 379         {
 380             p_access->info.i_size = st.st_size;
 381             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 382         }
 383
 384         /* Really at end of file then */
 385         if (p_access->info.i_pos >= p_access->info.i_size)
 386         {
 387             p_access->info.b_eof = VLC_TRUE;
 388             msg_Dbg (p_access, "at end of memory mapped file");
 389             return NULL;
 390         }
 391     }
 392
 393     if (offset + length > p_access->info.i_size)
 394         /* Don't mmap beyond end of file */
 395         length = p_access->info.i_size - offset;
 396
 397     assert (offset <= p_access->info.i_pos);               /* and */
 398     assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
 399     assert (offset < p_access->info.i_size);               /* imply */
 400     assert (length > 0);
 401
 402     addr = mmap (NULL, length, PROT_READ, flags, p_sys->fd, offset);
 403     if (addr == MAP_FAILED)
 404     {
 405         msg_Err (p_access, "memory mapping failed (%m)");
 406         intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
 407                         _("VLC could not read the file."));
 408         msleep( INPUT_ERROR_SLEEP );
 409         return NULL;
 410     }
 411
 412     p_access->info.i_pos = offset + length;
 413
 414     block_t *block = block_mmap_Alloc (addr, length);
 415     if (block == NULL)
 416         return NULL;
 417
 418     block->p_buffer += align;
 419     block->i_buffer -= align;
 420
 421 #ifndef NDEBUG
 422     msg_Dbg (p_access, "mapped 0x%lx bytes at %p from offset 0x%lx",
 423              (unsigned long)length, addr, (unsigned long)offset);
 424
 425     /* Compare normal I/O with memory mapping */
 426     char *buf = malloc (block->i_buffer);
 427     ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
 428
 429     if (i_read != (ssize_t)block->i_buffer)
 430         msg_Err (p_access, "read %u instead of %u bytes", (unsigned)i_read,
 431                  (unsigned)block->i_buffer);
 432     if (memcmp (buf, block->p_buffer, block->i_buffer))
 433         msg_Err (p_access, "inconsistent data buffer");
 434     free (buf);
 435 #endif
 436
 437     return block;
 438 }
 439 #endif
 440
 441 /*****************************************************************************
 442  * Seek: seek to a specific location in a file
 443  *****************************************************************************/
 444 static int Seek (access_t *p_access, int64_t i_pos)
 445 {
 446     /* FIXME: i_size should really be unsigned */
 447     if ((uint64_t)i_pos > (uint64_t)p_access->info.i_size)
 448     {
 449         /* This should only happen with corrupted files.
 450          * But it also seems to happen with buggy demuxes (ASF) */
 451         msg_Err (p_access, "seeking too far (0x"I64Fx" / 0x"I64Fx")",
 452                  i_pos, p_access->info.i_size);
 453         i_pos = p_access->info.i_size;
 454     }
 455
 456     p_access->info.i_pos = i_pos;
 457     p_access->info.b_eof = VLC_FALSE;
 458
 459 #if defined (HAVE_MMAP) && defined (NDEBUG)
 460     if (p_access->pf_block == NULL)
 461 #endif
 462         lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 463     return VLC_SUCCESS;
 464 }
 465
 466 /*****************************************************************************
 467  * Control:
 468  *****************************************************************************/
 469 static int Control( access_t *p_access, int i_query, va_list args )
 470 {
 471     access_sys_t *p_sys = p_access->p_sys;
 472     vlc_bool_t   *pb_bool;
 473     int          *pi_int;
 474     int64_t      *pi_64;
 475
 476     switch( i_query )
 477     {
 478         /* */
 479         case ACCESS_CAN_SEEK:
 480         case ACCESS_CAN_FASTSEEK:
 481             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 482             *pb_bool = p_sys->b_seekable;
 483             break;
 484
 485         case ACCESS_CAN_PAUSE:
 486         case ACCESS_CAN_CONTROL_PACE:
 487             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 488             *pb_bool = p_sys->b_pace_control;
 489             break;
 490
 491         /* */
 492         case ACCESS_GET_MTU:
 493             pi_int = (int*)va_arg( args, int * );
 494             *pi_int = 0;
 495             break;
 496
 497         case ACCESS_GET_PTS_DELAY:
 498             pi_64 = (int64_t*)va_arg( args, int64_t * );
 499             *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
 500             break;
 501
 502         /* */
 503         case ACCESS_SET_PAUSE_STATE:
 504             /* Nothing to do */
 505             break;
 506
 507         case ACCESS_GET_TITLE_INFO:
 508         case ACCESS_SET_TITLE:
 509         case ACCESS_SET_SEEKPOINT:
 510         case ACCESS_SET_PRIVATE_ID_STATE:
 511         case ACCESS_GET_META:
 512         case ACCESS_GET_CONTENT_TYPE:
 513             return VLC_EGENERIC;
 514
 515         default:
 516             msg_Warn( p_access, "unimplemented query in control" );
 517             return VLC_EGENERIC;
 518
 519     }
 520     return VLC_SUCCESS;
 521 }
 522
 523
 524 static char *expand_path (const access_t *p_access, const char *path)
 525 {
 526     if (strncmp (path, "~/", 2) == 0)
 527     {
 528         char *res;
 529
 530          // TODO: we should also support the ~cmassiot/ syntax
 531          if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
 532              return NULL;
 533          return res;
 534     }
 535
 536 #if defined(WIN32)
 537     if (!strcasecmp (p_access->psz_access, "file")
 538       && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
 539         // Explorer can open path such as file:/C:/ or file:///C:/
 540         // hence remove leading / if found
 541         return strdup (path + 1);
 542 #endif
 543
 544     return strdup (path);
 545 }
 546
 547
 548 /*****************************************************************************
 549  * open_file: Opens a specific file
 550  *****************************************************************************/
 551 static int open_file (access_t *p_access, const char *psz_name)
 552 {
 553     char *path = expand_path (p_access, psz_name);
 554
 555 #ifdef UNDER_CE
 556     p_sys->fd = utf8_fopen( path, "rb" );
 557     if ( !p_sys->fd )
 558     {
 559         msg_Err( p_access, "cannot open file %s", psz_name );
 560         intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
 561                         _("VLC could not open the file \"%s\"."), psz_name );
 562         free (path);
 563         return VLC_EGENERIC;
 564     }
 565
 566     fseek( p_sys->fd, 0, SEEK_END );
 567     p_access->info.i_size = ftell( p_sys->fd );
 568     p_access->info.i_update |= INPUT_UPDATE_SIZE;
 569     fseek( p_sys->fd, 0, SEEK_SET );
 570 #else
 571     int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
 572     free (path);
 573     if (fd == -1)
 574     {
 575         msg_Err (p_access, "cannot open file %s (%m)", psz_name);
 576         intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
 577                         _("VLC could not open the file \"%s\"."), psz_name);
 578         return -1;
 579     }
 580
 581 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
 582     /* We'd rather use any available memory for reading ahead
 583      * than for caching what we've already seen/heard */
 584     fcntl (fd, F_RDAHEAD, 1);
 585     fcntl (fd, F_NOCACHE, 1);
 586 # endif
 587 #endif
 588
 589     return fd;
 590 }