1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <vlc/input.h>
32 #ifdef HAVE_SYS_TYPES_H
33 # include <sys/types.h>
35 #ifdef HAVE_SYS_TIME_H
36 # include <sys/time.h>
38 #ifdef HAVE_SYS_STAT_H
39 # include <sys/stat.h>
50 #elif defined( WIN32 ) && !defined( UNDER_CE )
54 /* stat() support for large files on win32 */
55 #if defined( WIN32 ) && !defined( UNDER_CE )
57 #define fstat(a,b) _fstati64(a,b)
61 # define close(a) CloseHandle((HANDLE)a)
64 /*****************************************************************************
66 *****************************************************************************/
67 static int Open ( vlc_object_t * );
68 static void Close( vlc_object_t * );
70 #define CACHING_TEXT N_("Caching value in ms")
71 #define CACHING_LONGTEXT N_( \
72 "Allows you to modify the default caching value for file streams. This " \
73 "value should be set in millisecond units." )
74 #define CAT_TEXT N_("Concatenate with additional files")
75 #define CAT_LONGTEXT N_( \
76 "Allows you to play split files as if they were part of a unique file. " \
77 "Specify a comma-separated list of files." )
80 set_description( _("Standard filesystem file input") );
81 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
82 add_string( "file-cat", NULL, NULL, CAT_TEXT, CAT_LONGTEXT, VLC_TRUE );
83 set_capability( "access2", 50 );
84 add_shortcut( "file" );
85 add_shortcut( "stream" );
86 add_shortcut( "kfir" );
87 set_callbacks( Open, Close );
91 /*****************************************************************************
93 *****************************************************************************/
94 static int Seek( access_t *, int64_t );
95 static int Read( access_t *, uint8_t *, int );
96 static int Control( access_t *, int, va_list );
98 static int _OpenFile( access_t *, char * );
109 unsigned int i_nb_reads;
121 vlc_bool_t b_seekable;
122 vlc_bool_t b_pace_control;
125 /*****************************************************************************
126 * Open: open the file
127 *****************************************************************************/
128 static int Open( vlc_object_t *p_this )
130 access_t *p_access = (access_t*)p_this;
132 char *psz_name = p_access->psz_path;
135 #ifdef HAVE_SYS_STAT_H
137 struct stat stat_info;
141 file_entry_t * p_file;
144 b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
146 #ifdef HAVE_SYS_STAT_H
147 if( !b_stdin && (i_stat = stat( psz_name, &stat_info )) == (-1) )
149 msg_Warn( p_access, "cannot stat() file `%s' (%s)",
150 psz_name, strerror(errno));
155 p_access->pf_read = Read;
156 p_access->pf_block = NULL;
157 p_access->pf_seek = Seek;
158 p_access->pf_control = Control;
159 p_access->info.i_update = 0;
160 p_access->info.i_size = 0;
161 p_access->info.i_pos = 0;
162 p_access->info.b_eof = VLC_FALSE;
163 p_access->info.i_title = 0;
164 p_access->info.i_seekpoint = 0;
165 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
166 p_sys->i_nb_reads = 0;
167 p_sys->b_kfir = VLC_FALSE;
173 if( !strcasecmp( p_access->psz_access, "stream" ) )
175 p_sys->b_seekable = VLC_FALSE;
176 p_sys->b_pace_control = VLC_FALSE;
178 else if( !strcasecmp( p_access->psz_access, "kfir" ) )
180 p_sys->b_seekable = VLC_FALSE;
181 p_sys->b_pace_control = VLC_FALSE;
182 p_sys->b_kfir = VLC_TRUE;
187 p_sys->b_pace_control = VLC_TRUE;
191 p_sys->b_seekable = VLC_FALSE;
196 /* We'll update i_size after it's been opened */
197 p_sys->b_seekable = VLC_TRUE;
199 #elif defined( HAVE_SYS_STAT_H )
200 else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode) ||
201 S_ISBLK(stat_info.st_mode) )
203 p_sys->b_seekable = VLC_TRUE;
204 p_access->info.i_size = stat_info.st_size;
206 else if( S_ISFIFO(stat_info.st_mode)
207 # if !defined( SYS_BEOS ) && !defined( WIN32 )
208 || S_ISSOCK(stat_info.st_mode)
212 p_sys->b_seekable = VLC_FALSE;
217 msg_Err( p_access, "unknown file type for `%s'", psz_name );
222 msg_Dbg( p_access, "opening file `%s'", psz_name );
228 else if( _OpenFile( p_access, psz_name ) )
234 if( p_sys->b_seekable && !p_access->info.i_size )
236 /* FIXME that's bad because all others access will be probed */
237 msg_Err( p_access, "file %s is empty, aborting", psz_name );
242 /* Update default_pts to a suitable value for file access */
243 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
246 * Get the additional list of files
248 p_file = malloc( sizeof(file_entry_t) );
249 p_file->i_size = p_access->info.i_size;
250 p_file->psz_name = strdup( psz_name );
251 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
253 psz = var_CreateGetString( p_access, "file-cat" );
256 char *psz_parser = psz_name = psz;
259 while( psz_name && *psz_name )
261 psz_parser = strchr( psz_name, ',' );
262 if( psz_parser ) *psz_parser = 0;
264 psz_name = strdup( psz_name );
267 msg_Dbg( p_access, "adding file `%s'", psz_name );
269 #ifdef HAVE_SYS_STAT_H
270 if( !stat( psz_name, &stat_info ) )
272 p_access->info.i_size += stat_info.st_size;
273 i_size = stat_info.st_size;
277 msg_Dbg( p_access, "cannot stat() file `%s'", psz_name );
281 p_file = malloc( sizeof(file_entry_t) );
282 p_file->i_size = i_size;
283 p_file->psz_name = psz_name;
285 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
288 psz_name = psz_parser;
289 if( psz_name ) psz_name++;
297 /*****************************************************************************
298 * Close: close the target
299 *****************************************************************************/
300 static void Close( vlc_object_t * p_this )
302 access_t *p_access = (access_t*)p_this;
303 access_sys_t *p_sys = p_access->p_sys;
308 for( i = 0; i < p_sys->i_file; i++ )
310 free( p_sys->file[i]->psz_name );
311 free( p_sys->file[i] );
318 /*****************************************************************************
319 * Read: standard read on a file descriptor.
320 *****************************************************************************/
321 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
323 access_sys_t *p_sys = p_access->p_sys;
327 if( !ReadFile( (HANDLE)p_sys->fd, p_buffer, i_len, (LPDWORD)&i_ret, NULL ) )
333 if( !p_sys->b_pace_control )
337 /* Find if some data is available. This won't work under Windows. */
338 struct timeval timeout;
341 /* Initialize file descriptor set */
343 FD_SET( p_sys->fd, &fds );
345 /* We'll wait 0.5 second if nothing happens */
347 timeout.tv_usec = 500000;
349 /* Find if some data is available */
350 while( (i_ret = select( p_sys->fd + 1, &fds, NULL, NULL, &timeout )) == 0
351 || (i_ret < 0 && errno == EINTR) )
354 FD_SET( p_sys->fd, &fds );
356 timeout.tv_usec = 500000;
358 if( p_access->b_die )
364 msg_Err( p_access, "select error (%s)", strerror(errno) );
368 i_ret = read( p_sys->fd, p_buffer, i_len );
372 /* b_kfir ; work around a buggy poll() driver implementation */
373 while ( (i_ret = read( p_sys->fd, p_buffer, i_len )) == 0 && !p_access->b_die )
375 msleep( INPUT_ERROR_SLEEP );
382 /* b_pace_control || WIN32 */
383 i_ret = read( p_sys->fd, p_buffer, i_len );
389 if( errno != EINTR && errno != EAGAIN )
390 msg_Err( p_access, "read failed (%s)", strerror(errno) );
392 /* Delay a bit to avoid consuming all the CPU. This is particularly
393 * useful when reading from an unconnected FIFO. */
394 msleep( INPUT_ERROR_SLEEP );
398 #ifdef HAVE_SYS_STAT_H
399 if( p_access->info.i_size != 0 && (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
401 struct stat stat_info;
402 int i_file = p_sys->i_index;
404 if ( fstat( p_sys->fd, &stat_info ) == -1 )
406 msg_Warn( p_access, "couldn't stat again the file (%s)", strerror(errno) );
408 else if ( p_sys->file[i_file]->i_size != stat_info.st_size )
410 p_access->info.i_size += (stat_info.st_size - p_sys->file[i_file]->i_size );
411 p_access->info.i_update |= INPUT_UPDATE_SIZE;
416 /* If we reached an EOF then switch to the next file in the list */
417 if ( i_ret == 0 && p_sys->i_index + 1 < p_sys->i_file )
420 char *psz_name = p_sys->file[++p_sys->i_index]->psz_name;
422 msg_Dbg( p_access, "opening file `%s'", psz_name );
424 if ( _OpenFile( p_access, psz_name ) )
432 /* We have to read some data */
433 return Read( p_access, p_buffer, i_len );
437 p_access->info.i_pos += i_ret;
438 else if( i_ret == 0 )
439 p_access->info.b_eof = VLC_TRUE;
444 /*****************************************************************************
445 * Seek: seek to a specific location in a file
446 *****************************************************************************/
447 static int Seek( access_t *p_access, int64_t i_pos )
449 access_sys_t *p_sys = p_access->p_sys;
452 /* Check which file we need to access */
453 if( p_sys->i_file > 1 )
459 for( i = 0; i < p_sys->i_file - 1; i++ )
461 if( i_pos < p_sys->file[i]->i_size + i_size )
463 i_size += p_sys->file[i]->i_size;
465 psz_name = p_sys->file[i]->psz_name;
467 msg_Dbg( p_access, "opening file `%s'", psz_name );
469 if ( i != p_sys->i_index && !_OpenFile( p_access, psz_name ) )
481 #if defined( WIN32 ) && !defined( UNDER_CE )
482 _lseeki64( p_sys->fd, i_pos - i_size, SEEK_SET );
484 lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
487 p_access->info.i_pos = i_pos;
488 if( p_access->info.i_size < p_access->info.i_pos )
490 msg_Err( p_access, "seeking too far" );
491 p_access->info.i_pos = p_access->info.i_size;
493 else if( p_access->info.i_pos < 0 )
495 msg_Err( p_access, "seeking too early" );
496 p_access->info.i_pos = 0;
499 p_access->info.b_eof = VLC_FALSE;
506 /*****************************************************************************
508 *****************************************************************************/
509 static int Control( access_t *p_access, int i_query, va_list args )
511 access_sys_t *p_sys = p_access->p_sys;
519 case ACCESS_CAN_SEEK:
520 case ACCESS_CAN_FASTSEEK:
521 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
522 *pb_bool = p_sys->b_seekable;
525 case ACCESS_CAN_PAUSE:
526 case ACCESS_CAN_CONTROL_PACE:
527 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
528 *pb_bool = p_sys->b_pace_control;
533 pi_int = (int*)va_arg( args, int * );
537 case ACCESS_GET_PTS_DELAY:
538 pi_64 = (int64_t*)va_arg( args, int64_t * );
539 *pi_64 = (int64_t)var_GetInteger( p_access, "file-caching" ) * I64C(1000);
542 case ACCESS_SET_PAUSE_STATE:
546 case ACCESS_GET_TITLE_INFO:
547 case ACCESS_SET_TITLE:
548 case ACCESS_SET_SEEKPOINT:
549 case ACCESS_SET_PRIVATE_ID_STATE:
553 msg_Err( p_access, "unimplemented query in control" );
561 /*****************************************************************************
562 * OpenFile: Opens a specific file
563 *****************************************************************************/
564 static int _OpenFile( access_t * p_access, char * psz_name )
566 access_sys_t *p_sys = p_access->p_sys;
569 wchar_t psz_filename[MAX_PATH];
570 MultiByteToWideChar( CP_ACP, 0, psz_name, -1, psz_filename, MAX_PATH );
573 (int)CreateFile( psz_filename, GENERIC_READ, FILE_SHARE_READ,
574 NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL );
576 if ( (HANDLE)p_sys->fd == INVALID_HANDLE_VALUE )
578 msg_Err( p_access, "cannot open file %s", psz_name );
581 p_access->info.i_size =
582 GetFileSize( (HANDLE)p_access_data->i_handle, NULL );
583 p_access->info.i_update |= INPUT_UPDATE_SIZE;
586 p_sys->fd = open( psz_name, O_NONBLOCK /*| O_LARGEFILE*/ );
587 if ( p_sys->fd == -1 )
589 msg_Err( p_access, "cannot open file %s (%s)", psz_name,