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  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Rémi Denis-Courmont <rem # videolan # org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <vlc/vlc.h>
  29 #include <vlc/input.h>
  30
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <errno.h>
  34 #ifdef HAVE_SYS_TYPES_H
  35 #   include <sys/types.h>
  36 #endif
  37 #ifdef HAVE_SYS_STAT_H
  38 #   include <sys/stat.h>
  39 #endif
  40 #ifdef HAVE_FCNTL_H
  41 #   include <fcntl.h>
  42 #endif
  43
  44 #if defined( WIN32 ) && !defined( UNDER_CE )
  45 #   include <io.h>
  46 #else
  47 #   include <unistd.h>
  48 #   include <poll.h>
  49 #endif
  50
  51 #if defined( WIN32 ) && !defined( UNDER_CE )
  52 /* stat() support for large files on win32 */
  53 #   define stat _stati64
  54 #   define fstat(a,b) _fstati64(a,b)
  55 #   ifdef lseek
  56 #      undef lseek
  57 #   endif
  58 #   define lseek _lseeki64
  59 #elif defined( UNDER_CE )
  60 #   ifdef read
  61 #      undef read
  62 #   endif
  63 #   define read(a,b,c) fread(b,1,c,a)
  64 #   define close(a) fclose(a)
  65 #   ifdef lseek
  66 #      undef lseek
  67 #   endif
  68 #   define lseek fseek
  69 #endif
  70
  71 #include "charset.h"
  72
  73 /*****************************************************************************
  74  * Module descriptor
  75  *****************************************************************************/
  76 static int  Open ( vlc_object_t * );
  77 static void Close( vlc_object_t * );
  78
  79 #define CACHING_TEXT N_("Caching value in ms")
  80 #define CACHING_LONGTEXT N_( \
  81     "Caching value for files. This " \
  82     "value should be set in milliseconds." )
  83 #define CAT_TEXT N_("Concatenate with additional files")
  84 #define CAT_LONGTEXT N_( \
  85     "Play split files as if they were part of a unique file. " \
  86     "You need to specify a comma-separated list of files." )
  87
  88 vlc_module_begin();
  89     set_description( _("File input") );
  90     set_shortname( _("File") );
  91     set_category( CAT_INPUT );
  92     set_subcategory( SUBCAT_INPUT_ACCESS );
  93     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
  94     add_string( "file-cat", NULL, NULL, CAT_TEXT, CAT_LONGTEXT, VLC_TRUE );
  95     set_capability( "access2", 50 );
  96     add_shortcut( "file" );
  97     add_shortcut( "stream" );
  98     add_shortcut( "kfir" );
  99     set_callbacks( Open, Close );
 100 vlc_module_end();
 101
 102
 103 /*****************************************************************************
 104  * Exported prototypes
 105  *****************************************************************************/
 106 static int  Seek( access_t *, int64_t );
 107 static int  Read( access_t *, uint8_t *, int );
 108 static int  Control( access_t *, int, va_list );
 109
 110 static int  _OpenFile( access_t *, const char * );
 111
 112 typedef struct
 113 {
 114     char     *psz_name;
 115     int64_t  i_size;
 116
 117 } file_entry_t;
 118
 119 struct access_sys_t
 120 {
 121     unsigned int i_nb_reads;
 122     vlc_bool_t   b_kfir;
 123
 124     /* Files list */
 125     int          i_file;
 126     file_entry_t **file;
 127
 128     /* Current file */
 129     int  i_index;
 130 #ifndef UNDER_CE
 131     int  fd;
 132     int  fd_backup;
 133 #else
 134     FILE *fd;
 135     FILE *fd_backup;
 136 #endif
 137
 138     /* */
 139     vlc_bool_t b_seekable;
 140     vlc_bool_t b_pace_control;
 141 };
 142
 143 /*****************************************************************************
 144  * Open: open the file
 145  *****************************************************************************/
 146 static int Open( vlc_object_t *p_this )
 147 {
 148     access_t     *p_access = (access_t*)p_this;
 149     access_sys_t *p_sys;
 150     char *psz_name = strdup( p_access->psz_path );
 151     char *psz;
 152
 153 #ifdef HAVE_SYS_STAT_H
 154     struct stat         stat_info;
 155 #endif
 156     file_entry_t *      p_file;
 157     vlc_bool_t          b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
 158
 159     if( !b_stdin )
 160     {
 161         if( psz_name[0] == '~' && psz_name[1] == '/' )
 162         {
 163             /* This is incomplete : we should also support the ~cmassiot/
 164              * syntax. */
 165             asprintf( &psz, "%s/%s", p_access->p_vlc->psz_homedir, psz_name + 2 );
 166             free( psz_name );
 167             psz_name = psz;
 168         }
 169 #if defined(WIN32)
 170         else if( !strcasecmp( p_access->psz_access, "file" )
 171                 && ('/' == psz_name[0]) && psz_name[1]
 172                 && (':' == psz_name[2]) && ('/' == psz_name[3]) )
 173         {
 174             /*
 175             ** explorer can open path such as file:/C:/ or file:///C:/...
 176             ** hence remove leading / if found
 177             */
 178             ++psz_name;
 179         }
 180 #endif
 181
 182 #ifdef HAVE_SYS_STAT_H
 183         if( utf8_stat( psz_name, &stat_info ) )
 184         {
 185             msg_Warn( p_access, "%s: %s", psz_name, strerror( errno ) );
 186             free( psz_name );
 187             return VLC_EGENERIC;
 188         }
 189 #endif
 190     }
 191
 192     STANDARD_READ_ACCESS_INIT;
 193     p_sys->i_nb_reads = 0;
 194     p_sys->b_kfir = VLC_FALSE;
 195     p_sys->file = NULL;
 196     p_sys->i_file = 0;
 197     p_sys->i_index = 0;
 198 #ifndef UNDER_CE
 199     p_sys->fd = -1;
 200 #endif
 201
 202     if( !strcasecmp( p_access->psz_access, "stream" ) )
 203     {
 204         p_sys->b_seekable = VLC_FALSE;
 205         p_sys->b_pace_control = VLC_FALSE;
 206     }
 207     else if( !strcasecmp( p_access->psz_access, "kfir" ) )
 208     {
 209         p_sys->b_seekable = VLC_FALSE;
 210         p_sys->b_pace_control = VLC_FALSE;
 211         p_sys->b_kfir = VLC_TRUE;
 212     }
 213     else
 214     {
 215         /* file:%s or %s */
 216         p_sys->b_pace_control = VLC_TRUE;
 217
 218         if( b_stdin )
 219         {
 220             p_sys->b_seekable = VLC_FALSE;
 221         }
 222 #ifdef UNDER_CE
 223         else if( VLC_TRUE )
 224         {
 225             /* We'll update i_size after it's been opened */
 226             p_sys->b_seekable = VLC_TRUE;
 227         }
 228 #elif defined( HAVE_SYS_STAT_H )
 229         else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode) ||
 230                  S_ISBLK(stat_info.st_mode) )
 231         {
 232             p_sys->b_seekable = VLC_TRUE;
 233             p_access->info.i_size = stat_info.st_size;
 234         }
 235         else if( S_ISFIFO(stat_info.st_mode)
 236 #   if !defined( SYS_BEOS ) && !defined( WIN32 )
 237                   || S_ISSOCK(stat_info.st_mode)
 238 #   endif
 239                )
 240         {
 241             p_sys->b_seekable = VLC_FALSE;
 242         }
 243 #endif
 244         else
 245         {
 246             msg_Err( p_access, "unknown file type for `%s'", psz_name );
 247             return VLC_EGENERIC;
 248         }
 249     }
 250
 251     msg_Dbg( p_access, "opening file `%s'", psz_name );
 252
 253     if( b_stdin )
 254     {
 255         p_sys->fd = 0;
 256     }
 257     else if( _OpenFile( p_access, psz_name ) )
 258     {
 259         free( p_sys );
 260         free( psz_name );
 261         return VLC_EGENERIC;
 262     }
 263
 264     if( p_sys->b_seekable && !p_access->info.i_size )
 265     {
 266         /* FIXME that's bad because all others access will be probed */
 267         msg_Err( p_access, "file %s is empty, aborting", psz_name );
 268         free( p_sys );
 269         free( psz_name );
 270         return VLC_EGENERIC;
 271     }
 272
 273     /* Update default_pts to a suitable value for file access */
 274     var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 275
 276     /*
 277      * Get the additional list of files
 278      */
 279     p_file = malloc( sizeof(file_entry_t) );
 280     p_file->i_size = p_access->info.i_size;
 281     p_file->psz_name = psz_name;
 282     TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
 283
 284     psz = var_CreateGetString( p_access, "file-cat" );
 285     if( *psz )
 286     {
 287         char *psz_parser = psz_name = psz;
 288         int64_t i_size;
 289
 290         while( psz_name && *psz_name )
 291         {
 292             psz_parser = strchr( psz_name, ',' );
 293             if( psz_parser ) *psz_parser = 0;
 294
 295             psz_name = strdup( psz_name );
 296             if( psz_name )
 297             {
 298                 msg_Dbg( p_access, "adding file `%s'", psz_name );
 299                 i_size = 0;
 300
 301 #ifdef HAVE_SYS_STAT_H
 302                 if( !stat( psz_name, &stat_info ) )
 303                 {
 304                     p_access->info.i_size += stat_info.st_size;
 305                     i_size = stat_info.st_size;
 306                 }
 307                 else
 308                 {
 309                     msg_Dbg( p_access, "cannot stat() file `%s'", psz_name );
 310                 }
 311 #endif
 312                 p_file = malloc( sizeof(file_entry_t) );
 313                 p_file->i_size = i_size;
 314                 p_file->psz_name = psz_name;
 315
 316                 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
 317             }
 318
 319             psz_name = psz_parser;
 320             if( psz_name ) psz_name++;
 321         }
 322     }
 323     free( psz );
 324
 325     return VLC_SUCCESS;
 326 }
 327
 328 /*****************************************************************************
 329  * Close: close the target
 330  *****************************************************************************/
 331 static void Close( vlc_object_t * p_this )
 332 {
 333     access_t     *p_access = (access_t*)p_this;
 334     access_sys_t *p_sys = p_access->p_sys;
 335     int i;
 336
 337     close( p_sys->fd );
 338
 339     for( i = 0; i < p_sys->i_file; i++ )
 340     {
 341         free( p_sys->file[i]->psz_name );
 342         free( p_sys->file[i] );
 343     }
 344     free( p_sys->file );
 345
 346     free( p_sys );
 347 }
 348
 349 /*****************************************************************************
 350  * Read: standard read on a file descriptor.
 351  *****************************************************************************/
 352 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
 353 {
 354     access_sys_t *p_sys = p_access->p_sys;
 355     int i_ret;
 356
 357 #if !defined(WIN32) && !defined(UNDER_CE)
 358     if( !p_sys->b_pace_control )
 359     {
 360         if( !p_sys->b_kfir )
 361         {
 362             /* Find if some data is available. This won't work under Windows. */
 363             do
 364             {
 365                 struct pollfd ufd;
 366
 367                 if( p_access->b_die )
 368                     return 0;
 369
 370                 memset (&ufd, 0, sizeof (ufd));
 371                 ufd.fd = p_sys->fd;
 372                 ufd.events = POLLIN;
 373
 374                 i_ret = poll( &ufd, 1, 500 );
 375                 if( i_ret == -1 )
 376                 {
 377                     if( errno != EINTR )
 378                     {
 379                         msg_Err( p_access, "poll error: %s",
 380                                  strerror( errno ) );
 381                         return -1;
 382                     }
 383                     i_ret = 0;
 384                 }
 385             }
 386             while( i_ret == 0 );
 387
 388             i_ret = read( p_sys->fd, p_buffer, i_len );
 389         }
 390         else
 391         {
 392             /* b_kfir ; work around a buggy poll() driver implementation */
 393             while ( (i_ret = read( p_sys->fd, p_buffer, i_len )) == 0 &&
 394                     !p_access->b_die )
 395             {
 396                 msleep( INPUT_ERROR_SLEEP );
 397             }
 398         }
 399     }
 400     else
 401 #endif /* WIN32 || UNDER_CE */
 402     {
 403         /* b_pace_control || WIN32 */
 404         i_ret = read( p_sys->fd, p_buffer, i_len );
 405     }
 406
 407     if( i_ret < 0 )
 408     {
 409         if( errno != EINTR && errno != EAGAIN )
 410             msg_Err( p_access, "read failed (%s)", strerror(errno) );
 411
 412         /* Delay a bit to avoid consuming all the CPU. This is particularly
 413          * useful when reading from an unconnected FIFO. */
 414         msleep( INPUT_ERROR_SLEEP );
 415     }
 416
 417     p_sys->i_nb_reads++;
 418 #ifdef HAVE_SYS_STAT_H
 419     if( p_access->info.i_size != 0 &&
 420         (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
 421     {
 422         struct stat stat_info;
 423         int i_file = p_sys->i_index;
 424
 425         if ( fstat( p_sys->fd, &stat_info ) == -1 )
 426         {
 427             msg_Warn( p_access, "couldn't stat again the file (%s)", strerror(errno) );
 428         }
 429         else if ( p_sys->file[i_file]->i_size != stat_info.st_size )
 430         {
 431             p_access->info.i_size += (stat_info.st_size - p_sys->file[i_file]->i_size );
 432             p_sys->file[i_file]->i_size = stat_info.st_size;
 433             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 434         }
 435     }
 436 #endif
 437
 438     /* If we reached an EOF then switch to the next file in the list */
 439     if ( i_ret == 0 && p_sys->i_index + 1 < p_sys->i_file )
 440     {
 441         char *psz_name = p_sys->file[++p_sys->i_index]->psz_name;
 442         p_sys->fd_backup = p_sys->fd;
 443
 444         msg_Dbg( p_access, "opening file `%s'", psz_name );
 445
 446         if ( _OpenFile( p_access, psz_name ) )
 447         {
 448             p_sys->fd = p_sys->fd_backup;
 449             return 0;
 450         }
 451
 452         close( p_sys->fd_backup );
 453
 454         /* We have to read some data */
 455         return Read( p_access, p_buffer, i_len );
 456     }
 457
 458     if( i_ret > 0 )
 459         p_access->info.i_pos += i_ret;
 460     else if( i_ret == 0 )
 461         p_access->info.b_eof = VLC_TRUE;
 462
 463     return i_ret;
 464 }
 465
 466 /*****************************************************************************
 467  * Seek: seek to a specific location in a file
 468  *****************************************************************************/
 469 static int Seek( access_t *p_access, int64_t i_pos )
 470 {
 471     access_sys_t *p_sys = p_access->p_sys;
 472     int64_t i_size = 0;
 473
 474     /* Check which file we need to access */
 475     if( p_sys->i_file > 1 )
 476     {
 477         int i;
 478         char *psz_name;
 479         p_sys->fd_backup = p_sys->fd;
 480
 481         for( i = 0; i < p_sys->i_file - 1; i++ )
 482         {
 483             if( i_pos < p_sys->file[i]->i_size + i_size )
 484                 break;
 485             i_size += p_sys->file[i]->i_size;
 486         }
 487         psz_name = p_sys->file[i]->psz_name;
 488
 489         msg_Dbg( p_access, "opening file `%s'", psz_name );
 490
 491         if ( i != p_sys->i_index && !_OpenFile( p_access, psz_name ) )
 492         {
 493             /* Close old file */
 494             close( p_sys->fd_backup );
 495             p_sys->i_index = i;
 496         }
 497         else
 498         {
 499             p_sys->fd = p_sys->fd_backup;
 500         }
 501     }
 502
 503     lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
 504
 505     p_access->info.i_pos = i_pos;
 506     if( p_access->info.i_size < p_access->info.i_pos )
 507     {
 508         msg_Err( p_access, "seeking too far" );
 509         p_access->info.i_pos = p_access->info.i_size;
 510     }
 511     else if( p_access->info.i_pos < 0 )
 512     {
 513         msg_Err( p_access, "seeking too early" );
 514         p_access->info.i_pos = 0;
 515     }
 516     /* Reset eof */
 517     p_access->info.b_eof = VLC_FALSE;
 518
 519     /* FIXME */
 520     return VLC_SUCCESS;
 521 }
 522
 523 /*****************************************************************************
 524  * Control:
 525  *****************************************************************************/
 526 static int Control( access_t *p_access, int i_query, va_list args )
 527 {
 528     access_sys_t *p_sys = p_access->p_sys;
 529     vlc_bool_t   *pb_bool;
 530     int          *pi_int;
 531     int64_t      *pi_64;
 532
 533     switch( i_query )
 534     {
 535         /* */
 536         case ACCESS_CAN_SEEK:
 537         case ACCESS_CAN_FASTSEEK:
 538             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 539             *pb_bool = p_sys->b_seekable;
 540             break;
 541
 542         case ACCESS_CAN_PAUSE:
 543         case ACCESS_CAN_CONTROL_PACE:
 544             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 545             *pb_bool = p_sys->b_pace_control;
 546             break;
 547
 548         /* */
 549         case ACCESS_GET_MTU:
 550             pi_int = (int*)va_arg( args, int * );
 551             *pi_int = 0;
 552             break;
 553
 554         case ACCESS_GET_PTS_DELAY:
 555             pi_64 = (int64_t*)va_arg( args, int64_t * );
 556             *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
 557             break;
 558
 559         /* */
 560         case ACCESS_SET_PAUSE_STATE:
 561             /* Nothing to do */
 562             break;
 563
 564         case ACCESS_GET_TITLE_INFO:
 565         case ACCESS_SET_TITLE:
 566         case ACCESS_SET_SEEKPOINT:
 567         case ACCESS_SET_PRIVATE_ID_STATE:
 568         case ACCESS_GET_META:
 569             return VLC_EGENERIC;
 570
 571         default:
 572             msg_Warn( p_access, "unimplemented query in control" );
 573             return VLC_EGENERIC;
 574
 575     }
 576     return VLC_SUCCESS;
 577 }
 578
 579
 580 /*****************************************************************************
 581  * OpenFile: Opens a specific file
 582  *****************************************************************************/
 583 static int _OpenFile( access_t * p_access, const char * psz_name )
 584 {
 585     access_sys_t *p_sys = p_access->p_sys;
 586
 587 #ifdef UNDER_CE
 588     p_sys->fd = utf8_fopen( psz_name, "rb" );
 589     if ( !p_sys->fd )
 590     {
 591         msg_Err( p_access, "cannot open file %s", psz_name );
 592         return VLC_EGENERIC;
 593     }
 594
 595     fseek( p_sys->fd, 0, SEEK_END );
 596     p_access->info.i_size = ftell( p_sys->fd );
 597     p_access->info.i_update |= INPUT_UPDATE_SIZE;
 598     fseek( p_sys->fd, 0, SEEK_SET );
 599 #else
 600     const char *psz_localname = ToLocale( psz_name );
 601     if( psz_localname == NULL )
 602     {
 603         msg_Err( p_access, "incorrect file name %s", psz_name );
 604         return VLC_EGENERIC;
 605     }
 606
 607     // FIXME: support non-ANSI filenames on Win32
 608     p_sys->fd = open( psz_localname, O_NONBLOCK /*| O_LARGEFILE*/ );
 609     LocaleFree( psz_localname );
 610
 611     if ( p_sys->fd == -1 )
 612     {
 613         msg_Err( p_access, "cannot open file %s (%s)", psz_name,
 614                  strerror(errno) );
 615         return VLC_EGENERIC;
 616     }
 617
 618 #if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
 619     /* We'd rather use any available memory for reading ahead
 620      * than for caching what we've already seen/heard */
 621     fcntl(p_sys->fd, F_RDAHEAD, 1);
 622     fcntl(p_sys->fd, F_NOCACHE, 1);
 623 #endif
 624
 625 #endif
 626
 627     return VLC_SUCCESS;
 628 }