* file.c: file input (file: access plug-in)
*****************************************************************************
* Copyright (C) 2001-2006 the VideoLAN team
+ * Copyright © 2006-2007 Rémi Denis-Courmont
* $Id$
*
* Authors: Christophe Massiot <massiot@via.ecp.fr>
* Preamble
*****************************************************************************/
#include <vlc/vlc.h>
-#include <vlc/input.h>
+#include <vlc_input.h>
+#include <vlc_access.h>
+#include <vlc_interface.h>
-#include <stdlib.h>
-#include <string.h>
+#include <assert.h>
#include <errno.h>
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
# include <unistd.h>
# include <poll.h>
#endif
+#ifdef HAVE_MMAP
+# include <sys/mman.h>
+#endif
#if defined( WIN32 ) && !defined( UNDER_CE )
-/* stat() support for large files on win32 */
-# define stat _stati64
-# define fstat(a,b) _fstati64(a,b)
# ifdef lseek
# undef lseek
# endif
# define lseek fseek
#endif
-#include "charset.h"
+#include <vlc_charset.h>
/*****************************************************************************
* Module descriptor
set_category( CAT_INPUT );
set_subcategory( SUBCAT_INPUT_ACCESS );
add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
- add_string( "file-cat", NULL, NULL, CAT_TEXT, CAT_LONGTEXT, VLC_TRUE );
+ add_obsolete_string( "file-cat" );
set_capability( "access2", 50 );
add_shortcut( "file" );
add_shortcut( "stream" );
* Exported prototypes
*****************************************************************************/
static int Seek( access_t *, int64_t );
-static int Read( access_t *, uint8_t *, int );
+static ssize_t Read( access_t *, uint8_t *, size_t );
static int Control( access_t *, int, va_list );
+#ifdef HAVE_MMAP
+static block_t *mmapBlock( access_t * );
+#endif
-static int _OpenFile( access_t *, const char * );
-
-typedef struct
-{
- char *psz_name;
- int64_t i_size;
-
-} file_entry_t;
+static int open_file( access_t *, const char * );
struct access_sys_t
{
+ uint64_t pagemask;
unsigned int i_nb_reads;
vlc_bool_t b_kfir;
- /* Files list */
- int i_file;
- file_entry_t **file;
-
- /* Current file */
- int i_index;
-#ifndef UNDER_CE
- int fd;
- int fd_backup;
-#else
- FILE *fd;
- FILE *fd_backup;
-#endif
+ int fd;
/* */
vlc_bool_t b_seekable;
{
access_t *p_access = (access_t*)p_this;
access_sys_t *p_sys;
- char *psz_name = strdup( p_access->psz_path );
- char *psz;
-#ifdef HAVE_SYS_STAT_H
- struct stat stat_info;
-#endif
- file_entry_t * p_file;
- vlc_bool_t b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
+ vlc_bool_t b_stdin = !strcmp (p_access->psz_path, "-");
- if( !b_stdin )
- {
- if( psz_name[0] == '~' && psz_name[1] == '/' )
- {
- /* This is incomplete : we should also support the ~cmassiot/
- * syntax. */
- asprintf( &psz, "%s/%s", p_access->p_vlc->psz_homedir, psz_name + 2 );
- free( psz_name );
- psz_name = psz;
- }
-#if defined(WIN32)
- else if( !strcasecmp( p_access->psz_access, "file" )
- && ('/' == psz_name[0]) && psz_name[1]
- && (':' == psz_name[2]) && ('/' == psz_name[3]) )
- {
- /*
- ** explorer can open path such as file:/C:/ or file:///C:/...
- ** hence remove leading / if found
- */
- ++psz_name;
- }
-#endif
-
-#ifdef HAVE_SYS_STAT_H
- if( utf8_stat( psz_name, &stat_info ) )
- {
- msg_Warn( p_access, "%s: %s", psz_name, strerror( errno ) );
- free( psz_name );
- return VLC_EGENERIC;
- }
-#endif
- }
+ /* Update default_pts to a suitable value for file access */
+ var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
STANDARD_READ_ACCESS_INIT;
p_sys->i_nb_reads = 0;
p_sys->b_kfir = VLC_FALSE;
- p_sys->file = NULL;
- p_sys->i_file = 0;
- p_sys->i_index = 0;
-#ifndef UNDER_CE
- p_sys->fd = -1;
-#endif
+ int fd = p_sys->fd = -1;
- if( !strcasecmp( p_access->psz_access, "stream" ) )
+ if (!strcasecmp (p_access->psz_access, "stream"))
{
p_sys->b_seekable = VLC_FALSE;
p_sys->b_pace_control = VLC_FALSE;
}
- else if( !strcasecmp( p_access->psz_access, "kfir" ) )
+ else if (!strcasecmp (p_access->psz_access, "kfir"))
{
p_sys->b_seekable = VLC_FALSE;
p_sys->b_pace_control = VLC_FALSE;
}
else
{
- /* file:%s or %s */
+ p_sys->b_seekable = VLC_TRUE;
p_sys->b_pace_control = VLC_TRUE;
-
- if( b_stdin )
- {
- p_sys->b_seekable = VLC_FALSE;
- }
-#ifdef UNDER_CE
- else if( VLC_TRUE )
- {
- /* We'll update i_size after it's been opened */
- p_sys->b_seekable = VLC_TRUE;
- }
-#elif defined( HAVE_SYS_STAT_H )
- else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode) ||
- S_ISBLK(stat_info.st_mode) )
- {
- p_sys->b_seekable = VLC_TRUE;
- p_access->info.i_size = stat_info.st_size;
- }
- else if( S_ISFIFO(stat_info.st_mode)
-# if !defined( SYS_BEOS ) && !defined( WIN32 )
- || S_ISSOCK(stat_info.st_mode)
-# endif
- )
- {
- p_sys->b_seekable = VLC_FALSE;
- }
-#endif
- else
- {
- msg_Err( p_access, "unknown file type for `%s'", psz_name );
- return VLC_EGENERIC;
- }
}
- msg_Dbg( p_access, "opening file `%s'", psz_name );
+ /* Open file */
+ msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
- if( b_stdin )
- {
- p_sys->fd = 0;
- }
- else if( _OpenFile( p_access, psz_name ) )
+ if (b_stdin)
+ fd = dup (0);
+ else
+ fd = open_file (p_access, p_access->psz_path);
+
+#ifdef HAVE_SYS_STAT_H
+ struct stat st;
+
+ while (fd != -1)
{
- free( p_sys );
- free( psz_name );
- return VLC_EGENERIC;
+ if (fstat (fd, &st))
+ msg_Err (p_access, "fstat(%d): %m", fd);
+ else
+ if (S_ISDIR (st.st_mode))
+ /* The directory plugin takes care of that */
+ msg_Dbg (p_access, "file is a directory, aborting");
+ else
+ break; // success
+
+ close (fd);
+ fd = -1;
}
+#endif
- if( p_sys->b_seekable && !p_access->info.i_size )
+ if (fd == -1)
{
- /* FIXME that's bad because all others access will be probed */
- msg_Err( p_access, "file %s is empty, aborting", psz_name );
- free( p_sys );
- free( psz_name );
+ free (p_sys);
return VLC_EGENERIC;
}
+ p_sys->fd = fd;
- /* Update default_pts to a suitable value for file access */
- var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
+#ifdef HAVE_SYS_STAT_H
+ p_access->info.i_size = st.st_size;
+ if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
+ && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
+ p_sys->b_seekable = VLC_FALSE;
- /*
- * Get the additional list of files
- */
- p_file = malloc( sizeof(file_entry_t) );
- p_file->i_size = p_access->info.i_size;
- p_file->psz_name = psz_name;
- TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
+# ifdef HAVE_MMAP
+ p_sys->pagemask = sysconf (_SC_PAGE_SIZE) - 1;
- psz = var_CreateGetString( p_access, "file-cat" );
- if( *psz )
+ /* Autodetect mmap() support */
+ if (p_sys->b_pace_control && S_ISREG (st.st_mode) && (st.st_size > 0))
{
- char *psz_parser = psz_name = psz;
- int64_t i_size;
-
- while( psz_name && *psz_name )
+ void *addr = mmap (NULL, 1, PROT_READ, MAP_PRIVATE, fd, 0);
+ if (addr != MAP_FAILED)
{
- psz_parser = strchr( psz_name, ',' );
- if( psz_parser ) *psz_parser = 0;
-
- psz_name = strdup( psz_name );
- if( psz_name )
- {
- msg_Dbg( p_access, "adding file `%s'", psz_name );
- i_size = 0;
-
-#ifdef HAVE_SYS_STAT_H
- if( !stat( psz_name, &stat_info ) )
- {
- p_access->info.i_size += stat_info.st_size;
- i_size = stat_info.st_size;
- }
- else
- {
- msg_Dbg( p_access, "cannot stat() file `%s'", psz_name );
- }
+ /* Does the file system support mmap? */
+ munmap (addr, 1);
+ p_access->pf_read = NULL;
+ p_access->pf_block = mmapBlock;
+ msg_Dbg (p_this, "mmap enabled");
+ }
+ else
+ msg_Dbg (p_this, "mmap disabled (%m)");
+ }
+ else
+ msg_Dbg (p_this, "mmap disabled (non regular file)");
+# endif
+#else
+ p_sys->b_seekable = !b_stdin;
+# warning File size not known!
#endif
- p_file = malloc( sizeof(file_entry_t) );
- p_file->i_size = i_size;
- p_file->psz_name = psz_name;
- TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
- }
-
- psz_name = psz_parser;
- if( psz_name ) psz_name++;
- }
+ if (p_sys->b_seekable && (p_access->info.i_size == 0))
+ {
+ /* FIXME that's bad because all others access will be probed */
+ msg_Err (p_access, "file is empty, aborting");
+ Close (p_this);
+ return VLC_EGENERIC;
}
- free( psz );
return VLC_SUCCESS;
}
/*****************************************************************************
* Close: close the target
*****************************************************************************/
-static void Close( vlc_object_t * p_this )
+static void Close (vlc_object_t * p_this)
{
access_t *p_access = (access_t*)p_this;
access_sys_t *p_sys = p_access->p_sys;
- int i;
-
- close( p_sys->fd );
- for( i = 0; i < p_sys->i_file; i++ )
- {
- free( p_sys->file[i]->psz_name );
- free( p_sys->file[i] );
- }
- free( p_sys->file );
-
- free( p_sys );
+ close (p_sys->fd);
+ free (p_sys);
}
/*****************************************************************************
* Read: standard read on a file descriptor.
*****************************************************************************/
-static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
+static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
{
access_sys_t *p_sys = p_access->p_sys;
- int i_ret;
+ ssize_t i_ret;
+ int fd = p_sys->fd;
#if !defined(WIN32) && !defined(UNDER_CE)
if( !p_sys->b_pace_control )
return 0;
memset (&ufd, 0, sizeof (ufd));
- ufd.fd = p_sys->fd;
+ ufd.fd = fd;
ufd.events = POLLIN;
- i_ret = poll( &ufd, 1, 500 );
- if( i_ret == -1 )
- {
- if( errno != EINTR )
- {
- msg_Err( p_access, "poll error: %s",
- strerror( errno ) );
- return -1;
- }
- i_ret = 0;
- }
+ i_ret = poll (&ufd, 1, 500);
}
- while( i_ret == 0 );
+ while (i_ret <= 0);
- i_ret = read( p_sys->fd, p_buffer, i_len );
+ i_ret = read (fd, p_buffer, i_len);
}
else
{
/* b_kfir ; work around a buggy poll() driver implementation */
- while ( (i_ret = read( p_sys->fd, p_buffer, i_len )) == 0 &&
- !p_access->b_die )
+ while (((i_ret = read (fd, p_buffer, i_len)) == 0)
+ && !p_access->b_die)
{
msleep( INPUT_ERROR_SLEEP );
}
}
else
#endif /* WIN32 || UNDER_CE */
- {
/* b_pace_control || WIN32 */
- i_ret = read( p_sys->fd, p_buffer, i_len );
- }
+ i_ret = read( fd, p_buffer, i_len );
if( i_ret < 0 )
{
- if( errno != EINTR && errno != EAGAIN )
- msg_Err( p_access, "read failed (%s)", strerror(errno) );
+ switch (errno)
+ {
+ case EINTR:
+ case EAGAIN:
+ break;
+
+ default:
+ msg_Err (p_access, "read failed (%m)");
+ intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
+ _("VLC could not read the file."));
+ }
/* Delay a bit to avoid consuming all the CPU. This is particularly
* useful when reading from an unconnected FIFO. */
}
p_sys->i_nb_reads++;
+
#ifdef HAVE_SYS_STAT_H
if( p_access->info.i_size != 0 &&
(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
{
- struct stat stat_info;
- int i_file = p_sys->i_index;
+ struct stat st;
- if ( fstat( p_sys->fd, &stat_info ) == -1 )
+ if ((fstat (fd, &st) == 0)
+ && (p_access->info.i_size != st.st_size))
{
- msg_Warn( p_access, "couldn't stat again the file (%s)", strerror(errno) );
- }
- else if ( p_sys->file[i_file]->i_size != stat_info.st_size )
- {
- p_access->info.i_size += (stat_info.st_size - p_sys->file[i_file]->i_size );
- p_sys->file[i_file]->i_size = stat_info.st_size;
+ p_access->info.i_size = st.st_size;
p_access->info.i_update |= INPUT_UPDATE_SIZE;
}
}
#endif
- /* If we reached an EOF then switch to the next file in the list */
- if ( i_ret == 0 && p_sys->i_index + 1 < p_sys->i_file )
- {
- char *psz_name = p_sys->file[++p_sys->i_index]->psz_name;
- p_sys->fd_backup = p_sys->fd;
-
- msg_Dbg( p_access, "opening file `%s'", psz_name );
-
- if ( _OpenFile( p_access, psz_name ) )
- {
- p_sys->fd = p_sys->fd_backup;
- return 0;
- }
-
- close( p_sys->fd_backup );
-
- /* We have to read some data */
- return Read( p_access, p_buffer, i_len );
- }
-
if( i_ret > 0 )
p_access->info.i_pos += i_ret;
else if( i_ret == 0 )
return i_ret;
}
-/*****************************************************************************
- * Seek: seek to a specific location in a file
- *****************************************************************************/
-static int Seek( access_t *p_access, int64_t i_pos )
+#ifdef HAVE_MMAP
+# define MMAP_SIZE (1 << 20)
+
+static block_t *mmapBlock (access_t *p_access)
{
access_sys_t *p_sys = p_access->p_sys;
- int64_t i_size = 0;
- /* Check which file we need to access */
- if( p_sys->i_file > 1 )
+ const int flags = MAP_SHARED;
+ off_t offset = p_access->info.i_pos & ~p_sys->pagemask;
+ size_t align = p_access->info.i_pos & p_sys->pagemask;
+ size_t length = (MMAP_SIZE > p_sys->pagemask) ? MMAP_SIZE : (p_sys->pagemask + 1);
+ void *addr;
+
+#ifndef NDEBUG
+ int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
+ if (dbgpos != p_access->info.i_pos)
+ msg_Err (p_access, "position: 0x%08llx instead of 0x%08llx",
+ p_access->info.i_pos, dbgpos);
+#endif
+
+ if (p_access->info.i_pos >= p_access->info.i_size)
{
- int i;
- char *psz_name;
- p_sys->fd_backup = p_sys->fd;
+ /* End of file - check if file size changed... */
+ struct stat st;
- for( i = 0; i < p_sys->i_file - 1; i++ )
+ if ((fstat (p_sys->fd, &st) == 0)
+ && (st.st_size != p_access->info.i_size))
{
- if( i_pos < p_sys->file[i]->i_size + i_size )
- break;
- i_size += p_sys->file[i]->i_size;
+ p_access->info.i_size = st.st_size;
+ p_access->info.i_update |= INPUT_UPDATE_SIZE;
}
- psz_name = p_sys->file[i]->psz_name;
- msg_Dbg( p_access, "opening file `%s'", psz_name );
-
- if ( i != p_sys->i_index && !_OpenFile( p_access, psz_name ) )
+ /* Really at end of file then */
+ if (p_access->info.i_pos >= p_access->info.i_size)
{
- /* Close old file */
- close( p_sys->fd_backup );
- p_sys->i_index = i;
- }
- else
- {
- p_sys->fd = p_sys->fd_backup;
+ p_access->info.b_eof = VLC_TRUE;
+ msg_Dbg (p_access, "at end of memory mapped file");
+ return NULL;
}
}
- lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
+ if (offset + length > p_access->info.i_size)
+ /* Don't mmap beyond end of file */
+ length = p_access->info.i_size - offset;
- p_access->info.i_pos = i_pos;
- if( p_access->info.i_size < p_access->info.i_pos )
+ assert (offset <= p_access->info.i_pos); /* and */
+ assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
+ assert (offset < p_access->info.i_size); /* imply */
+ assert (length > 0);
+
+ addr = mmap (NULL, length, PROT_READ, flags, p_sys->fd, offset);
+ if (addr == MAP_FAILED)
{
- msg_Err( p_access, "seeking too far" );
- p_access->info.i_pos = p_access->info.i_size;
+ msg_Err (p_access, "memory mapping failed (%m)");
+ intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
+ _("VLC could not read the file."));
+ msleep( INPUT_ERROR_SLEEP );
+ return NULL;
}
- else if( p_access->info.i_pos < 0 )
+
+ p_access->info.i_pos = offset + length;
+
+ block_t *block = block_mmap_Alloc (addr, length);
+ if (block == NULL)
+ return NULL;
+
+ block->p_buffer += align;
+ block->i_buffer -= align;
+
+#ifndef NDEBUG
+ msg_Dbg (p_access, "mapped 0x%lx bytes at %p from offset 0x%lx",
+ (unsigned long)length, addr, (unsigned long)offset);
+
+ /* Compare normal I/O with memory mapping */
+ char *buf = malloc (block->i_buffer);
+ ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
+
+ if (i_read != (ssize_t)block->i_buffer)
+ msg_Err (p_access, "read %u instead of %u bytes", (unsigned)i_read,
+ (unsigned)block->i_buffer);
+ if (memcmp (buf, block->p_buffer, block->i_buffer))
+ msg_Err (p_access, "inconsistent data buffer");
+ free (buf);
+#endif
+
+ return block;
+}
+#endif
+
+/*****************************************************************************
+ * Seek: seek to a specific location in a file
+ *****************************************************************************/
+static int Seek (access_t *p_access, int64_t i_pos)
+{
+ /* FIXME: i_size should really be unsigned */
+ if ((uint64_t)i_pos > (uint64_t)p_access->info.i_size)
{
- msg_Err( p_access, "seeking too early" );
- p_access->info.i_pos = 0;
+ /* This should only happen with corrupted files.
+ * But it also seems to happen with buggy demuxes (ASF) */
+ msg_Err (p_access, "seeking too far (0x"I64Fx" / 0x"I64Fx")",
+ i_pos, p_access->info.i_size);
+ i_pos = p_access->info.i_size;
}
- /* Reset eof */
+
+ p_access->info.i_pos = i_pos;
p_access->info.b_eof = VLC_FALSE;
- /* FIXME */
+#if defined (HAVE_MMAP) && defined (NDEBUG)
+ if (p_access->pf_block == NULL)
+#endif
+ lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
return VLC_SUCCESS;
}
case ACCESS_SET_SEEKPOINT:
case ACCESS_SET_PRIVATE_ID_STATE:
case ACCESS_GET_META:
+ case ACCESS_GET_CONTENT_TYPE:
return VLC_EGENERIC;
default:
}
+static char *expand_path (const access_t *p_access, const char *path)
+{
+ if (strncmp (path, "~/", 2) == 0)
+ {
+ char *res;
+
+ // TODO: we should also support the ~cmassiot/ syntax
+ if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
+ return NULL;
+ return res;
+ }
+
+#if defined(WIN32)
+ if (!strcasecmp (p_access->psz_access, "file")
+ && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
+ // Explorer can open path such as file:/C:/ or file:///C:/
+ // hence remove leading / if found
+ return strdup (path + 1);
+#endif
+
+ return strdup (path);
+}
+
+
/*****************************************************************************
- * OpenFile: Opens a specific file
+ * open_file: Opens a specific file
*****************************************************************************/
-static int _OpenFile( access_t * p_access, const char * psz_name )
+static int open_file (access_t *p_access, const char *psz_name)
{
- access_sys_t *p_sys = p_access->p_sys;
+ char *path = expand_path (p_access, psz_name);
#ifdef UNDER_CE
- p_sys->fd = utf8_fopen( psz_name, "rb" );
+ p_sys->fd = utf8_fopen( path, "rb" );
if ( !p_sys->fd )
{
msg_Err( p_access, "cannot open file %s", psz_name );
+ intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
+ _("VLC could not open the file \"%s\"."), psz_name );
+ free (path);
return VLC_EGENERIC;
}
p_access->info.i_update |= INPUT_UPDATE_SIZE;
fseek( p_sys->fd, 0, SEEK_SET );
#else
- const char *psz_localname = ToLocale( psz_name );
- if( psz_localname == NULL )
+ int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
+ free (path);
+ if (fd == -1)
{
- msg_Err( p_access, "incorrect file name %s", psz_name );
- return VLC_EGENERIC;
+ msg_Err (p_access, "cannot open file %s (%m)", psz_name);
+ intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
+ _("VLC could not open the file \"%s\"."), psz_name);
+ return -1;
}
- // FIXME: support non-ANSI filenames on Win32
- p_sys->fd = open( psz_localname, O_NONBLOCK /*| O_LARGEFILE*/ );
- LocaleFree( psz_localname );
-
- if ( p_sys->fd == -1 )
- {
- msg_Err( p_access, "cannot open file %s (%s)", psz_name,
- strerror(errno) );
- return VLC_EGENERIC;
- }
-
-#if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
+# if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
/* We'd rather use any available memory for reading ahead
* than for caching what we've already seen/heard */
- fcntl(p_sys->fd, F_RDAHEAD, 1);
- fcntl(p_sys->fd, F_NOCACHE, 1);
-#endif
-
+ fcntl (fd, F_RDAHEAD, 1);
+ fcntl (fd, F_NOCACHE, 1);
+# endif
#endif
- return VLC_SUCCESS;
+ return fd;
}
projects / vlc / blobdiff