* 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_interaction.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.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 <fcntl.h>
#endif
-#if defined( WIN32 ) && !defined( UNDER_CE )
+#if defined( WIN32 )
# include <io.h>
+# include <ctype.h>
#else
# include <unistd.h>
# include <poll.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 _lseeki64
#elif defined( UNDER_CE )
-# ifdef read
-# undef read
-# endif
-# define read(a,b,c) fread(b,1,c,a)
-# define close(a) fclose(a)
-# ifdef lseek
-# undef lseek
-# endif
-# define lseek fseek
+/* FIXME the commandline on wince is a mess */
+# define dup(a) -1
#endif
-#include "charset.h"
+#include <vlc_charset.h>
/*****************************************************************************
* Module descriptor
#define CACHING_LONGTEXT N_( \
"Caching value for files. This " \
"value should be set in milliseconds." )
-#define CAT_TEXT N_("Concatenate with additional files")
-#define CAT_LONGTEXT N_( \
- "Play split files as if they were part of a unique file. " \
- "You need to specify a comma-separated list of files." )
-
-vlc_module_begin();
- set_description( _("File input") );
- set_shortname( _("File") );
- 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 );
- set_capability( "access2", 50 );
- add_shortcut( "file" );
- add_shortcut( "stream" );
- add_shortcut( "kfir" );
- set_callbacks( Open, Close );
-vlc_module_end();
+
+vlc_module_begin ()
+ set_description( N_("File input") )
+ set_shortname( N_("File") )
+ set_category( CAT_INPUT )
+ set_subcategory( SUBCAT_INPUT_ACCESS )
+ add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
+ add_obsolete_string( "file-cat" )
+ set_capability( "access", 50 )
+ add_shortcut( "file" )
+ add_shortcut( "stream" )
+ set_callbacks( Open, Close )
+vlc_module_end ()
/*****************************************************************************
* Exported prototypes
*****************************************************************************/
static int Seek( access_t *, int64_t );
-static int Read( access_t *, uint8_t *, int );
+static int NoSeek( access_t *, int64_t );
+static ssize_t Read( access_t *, uint8_t *, size_t );
static int Control( access_t *, int, va_list );
-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
{
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;
- vlc_bool_t b_pace_control;
+ bool b_pace_control;
};
/*****************************************************************************
{
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';
-
- 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
- */
- strcpy( psz_name, p_access->psz_path + 1 );
- }
-#endif
+ bool b_stdin = !strcmp (p_access->psz_path, "-");
-#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
- 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" ) )
- {
- p_sys->b_seekable = VLC_FALSE;
- p_sys->b_pace_control = VLC_FALSE;
- p_sys->b_kfir = VLC_TRUE;
- }
+ if (!strcasecmp (p_access->psz_access, "stream"))
+ p_sys->b_pace_control = false;
else
- {
- /* file:%s or %s */
- p_sys->b_pace_control = VLC_TRUE;
+ p_sys->b_pace_control = 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 );
- intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
- _("\"%s\"'s file type is unknown."),
- psz_name );
- free( psz_name );
- return VLC_EGENERIC;
- }
- }
+ /* Open file */
+ msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
- msg_Dbg( p_access, "opening file `%s'", psz_name );
+ int fd = -1;
+ if (b_stdin)
+ fd = dup (0);
+ else
+ fd = open_file (p_access, p_access->psz_path);
+ if (fd == -1)
+ goto error;
- if( b_stdin )
- {
- p_sys->fd = 0;
- }
- else if( _OpenFile( p_access, psz_name ) )
- {
- free( p_sys );
- free( psz_name );
- return VLC_EGENERIC;
- }
+#ifdef HAVE_SYS_STAT_H
+ struct stat st;
- if( p_sys->b_seekable && !p_access->info.i_size )
+ if (fstat (fd, &st))
{
- /* 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 );
- return VLC_EGENERIC;
+ msg_Err (p_access, "failed to read (%m)");
+ goto error;
}
-
- /* Update default_pts to a suitable value for file access */
- var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-
- /*
- * 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 );
-
- psz = var_CreateGetString( p_access, "file-cat" );
- if( *psz )
+ /* Directories can be opened and read from, but only readdir() knows
+ * how to parse the data. The directory plugin will do it. */
+ if (S_ISDIR (st.st_mode))
{
- char *psz_parser = psz_name = psz;
- int64_t i_size;
-
- while( psz_name && *psz_name )
- {
- 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 );
- }
-#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++;
- }
+ msg_Dbg (p_access, "ignoring directory");
+ goto error;
}
- free( psz );
+ if (S_ISREG (st.st_mode))
+ p_access->info.i_size = st.st_size;
+ else if (!S_ISBLK (st.st_mode))
+ p_access->pf_seek = NoSeek;
+#else
+ if (b_stdin)
+ p_access->pf_seek = NoSeek;
+# warning File size not known!
+#endif
+ p_sys->fd = fd;
return VLC_SUCCESS;
+
+error:
+ if (fd != -1)
+ close (fd);
+ free (p_sys);
+ return VLC_EGENERIC;
}
/*****************************************************************************
* 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 );
+ close (p_sys->fd);
+ free (p_sys);
+}
- 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 );
-}
+#include <vlc_network.h>
/*****************************************************************************
* 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;
+ int fd = p_sys->fd;
+ ssize_t i_ret;
-#if !defined(WIN32) && !defined(UNDER_CE)
- if( !p_sys->b_pace_control )
- {
- if( !p_sys->b_kfir )
- {
- /* Find if some data is available. This won't work under Windows. */
- do
- {
- struct pollfd ufd;
-
- if( p_access->b_die )
- return 0;
-
- memset (&ufd, 0, sizeof (ufd));
- ufd.fd = p_sys->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;
- }
- }
- while( i_ret == 0 );
-
- i_ret = read( p_sys->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 )
- {
- msleep( INPUT_ERROR_SLEEP );
- }
- }
- }
+#ifndef WIN32
+ if (p_access->pf_seek == NoSeek)
+ i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
else
-#endif /* WIN32 || UNDER_CE */
- {
- /* b_pace_control || WIN32 */
- i_ret = read( p_sys->fd, p_buffer, i_len );
- }
+#endif
+ i_ret = read (fd, p_buffer, i_len);
if( i_ret < 0 )
{
- if( errno != EINTR && errno != EAGAIN )
+ switch (errno)
{
- msg_Err( p_access, "read failed (%s)", strerror(errno) );
- intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
- _("VLC could not read file \"%s\"."),
- strerror(errno) );
- }
+ case EINTR:
+ case EAGAIN:
+ break;
- /* Delay a bit to avoid consuming all the CPU. This is particularly
- * useful when reading from an unconnected FIFO. */
- msleep( INPUT_ERROR_SLEEP );
+ default:
+ msg_Err (p_access, "failed to read (%m)");
+ intf_UserFatal (p_access, false, _("File reading failed"),
+ _("VLC could not read the file."));
+ p_access->info.b_eof = true;
+ return 0;
+ }
}
+ else if( i_ret > 0 )
+ p_access->info.i_pos += i_ret;
+ else
+ p_access->info.b_eof = true;
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 )
- p_access->info.b_eof = VLC_TRUE;
-
return i_ret;
}
+
/*****************************************************************************
* Seek: seek to a specific location in a file
*****************************************************************************/
-static int Seek( access_t *p_access, int64_t i_pos )
+static int Seek (access_t *p_access, int64_t i_pos)
{
- 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 )
- {
- int i;
- char *psz_name;
- p_sys->fd_backup = p_sys->fd;
-
- for( i = 0; i < p_sys->i_file - 1; i++ )
- {
- if( i_pos < p_sys->file[i]->i_size + i_size )
- break;
- i_size += p_sys->file[i]->i_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 ) )
- {
- /* Close old file */
- close( p_sys->fd_backup );
- p_sys->i_index = i;
- }
- else
- {
- p_sys->fd = p_sys->fd_backup;
- }
- }
-
- lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
-
p_access->info.i_pos = i_pos;
- if( p_access->info.i_size < p_access->info.i_pos )
- {
- msg_Err( p_access, "seeking too far" );
- p_access->info.i_pos = p_access->info.i_size;
- }
- else if( p_access->info.i_pos < 0 )
- {
- msg_Err( p_access, "seeking too early" );
- p_access->info.i_pos = 0;
- }
- /* Reset eof */
- p_access->info.b_eof = VLC_FALSE;
+ p_access->info.b_eof = false;
- /* FIXME */
+ lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
return VLC_SUCCESS;
}
+static int NoSeek (access_t *p_access, int64_t i_pos)
+{
+ /* assert(0); ?? */
+ (void) p_access; (void) i_pos;
+ return VLC_EGENERIC;
+}
+
/*****************************************************************************
* Control:
*****************************************************************************/
static int Control( access_t *p_access, int i_query, va_list args )
{
access_sys_t *p_sys = p_access->p_sys;
- vlc_bool_t *pb_bool;
- int *pi_int;
- int64_t *pi_64;
+ bool *pb_bool;
+ int64_t *pi_64;
switch( i_query )
{
/* */
case ACCESS_CAN_SEEK:
case ACCESS_CAN_FASTSEEK:
- pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
- *pb_bool = p_sys->b_seekable;
+ pb_bool = (bool*)va_arg( args, bool* );
+ *pb_bool = (p_access->pf_seek != NoSeek);
break;
case ACCESS_CAN_PAUSE:
case ACCESS_CAN_CONTROL_PACE:
- pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
+ pb_bool = (bool*)va_arg( args, bool* );
*pb_bool = p_sys->b_pace_control;
break;
/* */
- case ACCESS_GET_MTU:
- pi_int = (int*)va_arg( args, int * );
- *pi_int = 0;
- break;
-
case ACCESS_GET_PTS_DELAY:
pi_64 = (int64_t*)va_arg( args, int64_t * );
- *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
+ *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
break;
/* */
case ACCESS_SET_SEEKPOINT:
case ACCESS_SET_PRIVATE_ID_STATE:
case ACCESS_GET_META:
+ case ACCESS_GET_PRIVATE_ID_STATE:
+ case ACCESS_GET_CONTENT_TYPE:
return VLC_EGENERIC;
default:
- msg_Warn( p_access, "unimplemented query in control" );
+ msg_Warn( p_access, "unimplemented query %d in control", i_query );
return VLC_EGENERIC;
}
return VLC_SUCCESS;
}
-
/*****************************************************************************
- * 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 *path)
{
- access_sys_t *p_sys = p_access->p_sys;
-
-#ifdef UNDER_CE
- p_sys->fd = utf8_fopen( psz_name, "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 file \"%s\"."), psz_name );
- return VLC_EGENERIC;
- }
-
- fseek( p_sys->fd, 0, SEEK_END );
- p_access->info.i_size = ftell( p_sys->fd );
- 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 )
- {
- msg_Err( p_access, "incorrect file name %s", psz_name );
- return VLC_EGENERIC;
- }
-
- // FIXME: support non-ANSI filenames on Win32
- p_sys->fd = open( psz_localname, O_NONBLOCK /*| O_LARGEFILE*/ );
- LocaleFree( psz_localname );
+#if defined(WIN32)
+ if (!strcasecmp (p_access->psz_access, "file")
+ && ('/' == path[0]) && isalpha (path[1])
+ && (':' == path[2]) && ('/' == path[3]))
+ /* Explorer can open path such as file:/C:/ or file:///C:/
+ * hence remove leading / if found */
+ path++;
+#endif
- if ( p_sys->fd == -1 )
+ int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
+ if (fd == -1)
{
- msg_Err( p_access, "cannot open file %s (%s)", psz_name,
- strerror(errno) );
- intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
- _("VLC could not open file \"%s\" (%s)."),
- psz_name, strerror(errno) );
- return VLC_EGENERIC;
+ msg_Err (p_access, "cannot open file %s (%m)", path);
+ intf_UserFatal (p_access, false, _("File reading failed"),
+ _("VLC could not open the file \"%s\"."), path);
+ return -1;
}
-#if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
+#if defined(HAVE_FCNTL)
/* 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
-
+# if defined(F_RDAHEAD)
+ fcntl (fd, F_RDAHEAD, 1);
+# endif
+# if defined(F_NOCACHE)
+ fcntl (fd, F_NOCACHE, 1);
+# endif
#endif
- return VLC_SUCCESS;
+ return fd;
}