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;
133 char * psz_name = p_access->psz_path;
135 #ifdef HAVE_SYS_STAT_H
137 struct stat stat_info;
142 file_entry_t * p_file;
145 b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
147 #ifdef HAVE_SYS_STAT_H
148 if( !b_stdin && (i_stat = stat( psz_name, &stat_info )) == (-1) )
150 msg_Warn( p_access, "cannot stat() file `%s' (%s)",
151 psz_name, strerror(errno));
156 p_access->pf_read = Read;
157 p_access->pf_block = NULL;
158 p_access->pf_seek = Seek;
159 p_access->pf_control = Control;
160 p_access->info.i_update = 0;
161 p_access->info.i_size = 0;
162 p_access->info.i_pos = 0;
163 p_access->info.b_eof = VLC_FALSE;
164 p_access->info.i_title = 0;
165 p_access->info.i_seekpoint = 0;
166 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
167 p_sys->i_nb_reads = 0;
168 p_sys->b_kfir = VLC_FALSE;
174 if( !strcasecmp( p_access->psz_access, "stream" ) )
176 p_sys->b_seekable = VLC_FALSE;
177 p_sys->b_pace_control = VLC_FALSE;
179 else if( !strcasecmp( p_access->psz_access, "kfir" ) )
181 p_sys->b_seekable = VLC_FALSE;
182 p_sys->b_pace_control = VLC_FALSE;
183 p_sys->b_kfir = VLC_TRUE;
188 p_sys->b_pace_control = VLC_TRUE;
192 p_sys->b_seekable = VLC_FALSE;
197 /* We'll update i_size after it's been opened */
198 p_sys->b_seekable = VLC_TRUE;
200 #elif defined( HAVE_SYS_STAT_H )
201 else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode) ||
202 S_ISBLK(stat_info.st_mode) )
204 p_sys->b_seekable = VLC_TRUE;
205 p_access->info.i_size = stat_info.st_size;
207 else if( S_ISFIFO(stat_info.st_mode)
208 # if !defined( SYS_BEOS ) && !defined( WIN32 )
209 || S_ISSOCK(stat_info.st_mode)
213 p_sys->b_seekable = VLC_FALSE;
218 msg_Err( p_access, "unknown file type for `%s'", psz_name );
223 msg_Dbg( p_access, "opening file `%s'", psz_name );
229 else if( _OpenFile( p_access, psz_name ) )
235 if( p_sys->b_seekable && !p_access->info.i_size )
237 /* FIXME that's bad because all others access will be probed */
238 msg_Err( p_access, "file %s is empty, aborting", psz_name );
243 /* Update default_pts to a suitable value for file access */
244 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
247 * Get the additional list of files
249 p_file = malloc( sizeof(file_entry_t) );
250 p_file->i_size = p_access->info.i_size;
251 p_file->psz_name = strdup( psz_name );
252 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
254 var_Create( p_access, "file-cat", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
255 var_Get( p_access, "file-cat", &val );
257 if( *val.psz_string )
259 char *psz_parser = psz_name = val.psz_string;
262 while( psz_name && *psz_name )
264 psz_parser = strchr( psz_name, ',' );
265 if( psz_parser ) *psz_parser = 0;
267 psz_name = strdup( psz_name );
270 msg_Dbg( p_access, "adding file `%s'", psz_name );
272 #ifdef HAVE_SYS_STAT_H
273 if( !stat( psz_name, &stat_info ) )
275 p_access->info.i_size += stat_info.st_size;
276 i_size = stat_info.st_size;
280 msg_Dbg( p_access, "cannot stat() file `%s'", psz_name );
284 p_file = malloc( sizeof(file_entry_t) );
285 p_file->i_size = i_size;
286 p_file->psz_name = psz_name;
288 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
291 psz_name = psz_parser;
292 if( psz_name ) psz_name++;
295 free( val.psz_string );
300 /*****************************************************************************
301 * Close: close the target
302 *****************************************************************************/
303 static void Close( vlc_object_t * p_this )
305 access_t *p_access = (access_t*)p_this;
306 access_sys_t *p_sys = p_access->p_sys;
311 for( i = 0; i < p_sys->i_file; i++ )
313 free( p_sys->file[i]->psz_name );
314 free( p_sys->file[i] );
321 /*****************************************************************************
322 * Read: standard read on a file descriptor.
323 *****************************************************************************/
324 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
326 access_sys_t *p_sys = p_access->p_sys;
330 if( !ReadFile( (HANDLE)p_sys->fd, p_buffer, i_len, (LPDWORD)&i_ret, NULL ) )
336 if( !p_sys->b_pace_control )
340 /* Find if some data is available. This won't work under Windows. */
341 struct timeval timeout;
344 /* Initialize file descriptor set */
346 FD_SET( p_sys->fd, &fds );
348 /* We'll wait 0.5 second if nothing happens */
350 timeout.tv_usec = 500000;
352 /* Find if some data is available */
353 while( (i_ret = select( p_sys->fd + 1, &fds, NULL, NULL, &timeout )) == 0
354 || (i_ret < 0 && errno == EINTR) )
357 FD_SET( p_sys->fd, &fds );
359 timeout.tv_usec = 500000;
361 if( p_access->b_die )
367 msg_Err( p_access, "select error (%s)", strerror(errno) );
371 i_ret = read( p_sys->fd, p_buffer, i_len );
375 /* b_kfir ; work around a buggy poll() driver implementation */
376 while ( (i_ret = read( p_sys->fd, p_buffer, i_len )) == 0 && !p_access->b_die )
378 msleep( INPUT_ERROR_SLEEP );
385 /* b_pace_control || WIN32 */
386 i_ret = read( p_sys->fd, p_buffer, i_len );
392 if( errno != EINTR && errno != EAGAIN )
393 msg_Err( p_access, "read failed (%s)", strerror(errno) );
395 /* Delay a bit to avoid consuming all the CPU. This is particularly
396 * useful when reading from an unconnected FIFO. */
397 msleep( INPUT_ERROR_SLEEP );
401 #ifdef HAVE_SYS_STAT_H
402 if( p_access->info.i_size != 0 && (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
404 struct stat stat_info;
405 int i_file = p_sys->i_index;
407 if ( fstat( p_sys->fd, &stat_info ) == -1 )
409 msg_Warn( p_access, "couldn't stat again the file (%s)", strerror(errno) );
411 else if ( p_sys->file[i_file]->i_size != stat_info.st_size )
413 p_access->info.i_size += (stat_info.st_size - p_sys->file[i_file]->i_size );
414 p_access->info.i_update |= INPUT_UPDATE_SIZE;
419 /* If we reached an EOF then switch to the next file in the list */
420 if ( i_ret == 0 && p_sys->i_index + 1 < p_sys->i_file )
423 char *psz_name = p_sys->file[++p_sys->i_index]->psz_name;
425 msg_Dbg( p_access, "opening file `%s'", psz_name );
427 if ( _OpenFile( p_access, psz_name ) )
435 /* We have to read some data */
436 return Read( p_access, p_buffer, i_len );
440 p_access->info.i_pos += i_ret;
441 else if( i_ret == 0 )
442 p_access->info.b_eof = VLC_TRUE;
447 /*****************************************************************************
448 * Seek: seek to a specific location in a file
449 *****************************************************************************/
450 static int Seek( access_t *p_access, int64_t i_pos )
452 access_sys_t *p_sys = p_access->p_sys;
455 /* Check which file we need to access */
456 if( p_sys->i_file > 1 )
462 for( i = 0; i < p_sys->i_file - 1; i++ )
464 if( i_pos < p_sys->file[i]->i_size + i_size )
466 i_size += p_sys->file[i]->i_size;
468 psz_name = p_sys->file[i]->psz_name;
470 msg_Dbg( p_access, "opening file `%s'", psz_name );
472 if ( i != p_sys->i_index && !_OpenFile( p_access, psz_name ) )
484 #if defined( WIN32 ) && !defined( UNDER_CE )
485 _lseeki64( p_sys->fd, i_pos - i_size, SEEK_SET );
487 lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
490 p_access->info.i_pos = i_pos;
491 if( p_access->info.i_size < p_access->info.i_pos )
493 msg_Err( p_access, "seeking too far" );
494 p_access->info.i_pos = p_access->info.i_size;
496 else if( p_access->info.i_pos < 0 )
498 msg_Err( p_access, "seeking too early" );
499 p_access->info.i_pos = 0;
502 p_access->info.b_eof = VLC_FALSE;
509 /*****************************************************************************
511 *****************************************************************************/
512 static int Control( access_t *p_access, int i_query, va_list args )
514 access_sys_t *p_sys = p_access->p_sys;
523 case ACCESS_CAN_SEEK:
524 case ACCESS_CAN_FASTSEEK:
525 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
526 *pb_bool = p_sys->b_seekable;
529 case ACCESS_CAN_PAUSE:
530 case ACCESS_CAN_CONTROL_PACE:
531 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
532 *pb_bool = p_sys->b_pace_control;
537 pi_int = (int*)va_arg( args, int * );
541 case ACCESS_GET_PTS_DELAY:
542 pi_64 = (int64_t*)va_arg( args, int64_t * );
543 var_Get( p_access, "file-caching", &val );
544 *pi_64 = val.i_int * 1000;
547 case ACCESS_SET_PAUSE_STATE:
551 case ACCESS_GET_TITLE_INFO:
552 case ACCESS_SET_TITLE:
553 case ACCESS_SET_SEEKPOINT:
554 case ACCESS_SET_PRIVATE_ID_STATE:
558 msg_Err( p_access, "unimplemented query in control" );
566 /*****************************************************************************
567 * OpenFile: Opens a specific file
568 *****************************************************************************/
569 static int _OpenFile( access_t * p_access, char * psz_name )
571 access_sys_t *p_sys = p_access->p_sys;
574 wchar_t psz_filename[MAX_PATH];
575 MultiByteToWideChar( CP_ACP, 0, psz_name, -1, psz_filename, MAX_PATH );
578 (int)CreateFile( psz_filename, GENERIC_READ, FILE_SHARE_READ,
579 NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL );
581 if ( (HANDLE)p_sys->fd == INVALID_HANDLE_VALUE )
583 msg_Err( p_access, "cannot open file %s", psz_name );
586 p_access->info.i_size =
587 GetFileSize( (HANDLE)p_access_data->i_handle, NULL );
588 p_access->info.i_update |= INPUT_UPDATE_SIZE;
591 p_sys->fd = open( psz_name, O_NONBLOCK /*| O_LARGEFILE*/ );
592 if ( p_sys->fd == -1 )
594 msg_Err( p_access, "cannot open file %s (%s)", psz_name,