1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2004 the VideoLAN team
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>
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h>
36 #ifdef HAVE_SYS_TIME_H
37 # include <sys/time.h>
39 #ifdef HAVE_SYS_STAT_H
40 # include <sys/stat.h>
48 #elif defined( WIN32 ) && !defined( UNDER_CE )
52 #if defined( WIN32 ) && !defined( UNDER_CE )
53 /* stat() support for large files on win32 */
54 # define stat _stati64
55 # define fstat(a,b) _fstati64(a,b)
59 # define lseek _lseeki64
60 #elif defined( UNDER_CE )
64 # define read(a,b,c) fread(b,1,c,a)
65 # define close(a) fclose(a)
74 /*****************************************************************************
76 *****************************************************************************/
77 static int Open ( vlc_object_t * );
78 static void Close( vlc_object_t * );
80 #define CACHING_TEXT N_("Caching value in ms")
81 #define CACHING_LONGTEXT N_( \
82 "Allows you to modify the default caching value for file streams. This " \
83 "value should be set in millisecond units." )
84 #define CAT_TEXT N_("Concatenate with additional files")
85 #define CAT_LONGTEXT N_( \
86 "Allows you to play split files as if they were part of a unique file. " \
87 "Specify a comma-separated list of files." )
90 set_description( _("Standard filesystem file input") );
91 set_shortname( _("File") );
92 set_category( CAT_INPUT );
93 set_subcategory( SUBCAT_INPUT_ACCESS );
94 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
95 add_string( "file-cat", NULL, NULL, CAT_TEXT, CAT_LONGTEXT, VLC_TRUE );
96 set_capability( "access2", 50 );
97 add_shortcut( "file" );
98 add_shortcut( "stream" );
99 add_shortcut( "kfir" );
100 set_callbacks( Open, Close );
104 /*****************************************************************************
105 * Exported prototypes
106 *****************************************************************************/
107 static int Seek( access_t *, int64_t );
108 static int Read( access_t *, uint8_t *, int );
109 static int Control( access_t *, int, va_list );
111 static int _OpenFile( access_t *, const char * );
122 unsigned int i_nb_reads;
140 vlc_bool_t b_seekable;
141 vlc_bool_t b_pace_control;
144 /*****************************************************************************
145 * Open: open the file
146 *****************************************************************************/
147 static int Open( vlc_object_t *p_this )
149 access_t *p_access = (access_t*)p_this;
151 char *psz_name = p_access->psz_path;
154 #ifdef HAVE_SYS_STAT_H
156 struct stat stat_info;
160 file_entry_t * p_file;
163 b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
165 #ifdef HAVE_SYS_STAT_H
166 if( !b_stdin && (i_stat = stat( psz_name, &stat_info )) == (-1) )
168 msg_Warn( p_access, "cannot stat() file `%s' (%s)",
169 psz_name, strerror(errno));
174 p_access->pf_read = Read;
175 p_access->pf_block = NULL;
176 p_access->pf_seek = Seek;
177 p_access->pf_control = Control;
178 p_access->info.i_update = 0;
179 p_access->info.i_size = 0;
180 p_access->info.i_pos = 0;
181 p_access->info.b_eof = VLC_FALSE;
182 p_access->info.i_title = 0;
183 p_access->info.i_seekpoint = 0;
184 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
185 p_sys->i_nb_reads = 0;
186 p_sys->b_kfir = VLC_FALSE;
194 if( !strcasecmp( p_access->psz_access, "stream" ) )
196 p_sys->b_seekable = VLC_FALSE;
197 p_sys->b_pace_control = VLC_FALSE;
199 else if( !strcasecmp( p_access->psz_access, "kfir" ) )
201 p_sys->b_seekable = VLC_FALSE;
202 p_sys->b_pace_control = VLC_FALSE;
203 p_sys->b_kfir = VLC_TRUE;
208 p_sys->b_pace_control = VLC_TRUE;
212 p_sys->b_seekable = VLC_FALSE;
217 /* We'll update i_size after it's been opened */
218 p_sys->b_seekable = VLC_TRUE;
220 #elif defined( HAVE_SYS_STAT_H )
221 else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode) ||
222 S_ISBLK(stat_info.st_mode) )
224 p_sys->b_seekable = VLC_TRUE;
225 p_access->info.i_size = stat_info.st_size;
227 else if( S_ISFIFO(stat_info.st_mode)
228 # if !defined( SYS_BEOS ) && !defined( WIN32 )
229 || S_ISSOCK(stat_info.st_mode)
233 p_sys->b_seekable = VLC_FALSE;
238 msg_Err( p_access, "unknown file type for `%s'", psz_name );
243 msg_Dbg( p_access, "opening file `%s'", psz_name );
249 else if( _OpenFile( p_access, psz_name ) )
255 if( p_sys->b_seekable && !p_access->info.i_size )
257 /* FIXME that's bad because all others access will be probed */
258 msg_Err( p_access, "file %s is empty, aborting", psz_name );
263 /* Update default_pts to a suitable value for file access */
264 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
267 * Get the additional list of files
269 p_file = malloc( sizeof(file_entry_t) );
270 p_file->i_size = p_access->info.i_size;
271 p_file->psz_name = strdup( psz_name );
272 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
274 psz = var_CreateGetString( p_access, "file-cat" );
277 char *psz_parser = psz_name = psz;
280 while( psz_name && *psz_name )
282 psz_parser = strchr( psz_name, ',' );
283 if( psz_parser ) *psz_parser = 0;
285 psz_name = strdup( psz_name );
288 msg_Dbg( p_access, "adding file `%s'", psz_name );
291 #ifdef HAVE_SYS_STAT_H
292 if( !stat( psz_name, &stat_info ) )
294 p_access->info.i_size += stat_info.st_size;
295 i_size = stat_info.st_size;
299 msg_Dbg( p_access, "cannot stat() file `%s'", psz_name );
302 p_file = malloc( sizeof(file_entry_t) );
303 p_file->i_size = i_size;
304 p_file->psz_name = psz_name;
306 TAB_APPEND( p_sys->i_file, p_sys->file, p_file );
309 psz_name = psz_parser;
310 if( psz_name ) psz_name++;
318 /*****************************************************************************
319 * Close: close the target
320 *****************************************************************************/
321 static void Close( vlc_object_t * p_this )
323 access_t *p_access = (access_t*)p_this;
324 access_sys_t *p_sys = p_access->p_sys;
329 for( i = 0; i < p_sys->i_file; i++ )
331 free( p_sys->file[i]->psz_name );
332 free( p_sys->file[i] );
339 /*****************************************************************************
340 * Read: standard read on a file descriptor.
341 *****************************************************************************/
342 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
344 access_sys_t *p_sys = p_access->p_sys;
347 #if !defined(WIN32) && !defined(UNDER_CE)
348 if( !p_sys->b_pace_control )
352 /* Find if some data is available. This won't work under Windows. */
353 struct timeval timeout;
356 /* Initialize file descriptor set */
358 FD_SET( p_sys->fd, &fds );
360 /* We'll wait 0.5 second if nothing happens */
362 timeout.tv_usec = 500000;
364 /* Find if some data is available */
365 while( (i_ret = select( p_sys->fd + 1, &fds, NULL, NULL, &timeout )) == 0
366 || (i_ret < 0 && errno == EINTR) )
369 FD_SET( p_sys->fd, &fds );
371 timeout.tv_usec = 500000;
373 if( p_access->b_die )
379 msg_Err( p_access, "select error (%s)", strerror(errno) );
383 i_ret = read( p_sys->fd, p_buffer, i_len );
387 /* b_kfir ; work around a buggy poll() driver implementation */
388 while ( (i_ret = read( p_sys->fd, p_buffer, i_len )) == 0 &&
391 msleep( INPUT_ERROR_SLEEP );
396 #endif /* WIN32 || UNDER_CE */
398 /* b_pace_control || WIN32 */
399 i_ret = read( p_sys->fd, p_buffer, i_len );
404 if( errno != EINTR && errno != EAGAIN )
405 msg_Err( p_access, "read failed (%s)", strerror(errno) );
407 /* Delay a bit to avoid consuming all the CPU. This is particularly
408 * useful when reading from an unconnected FIFO. */
409 msleep( INPUT_ERROR_SLEEP );
413 #ifdef HAVE_SYS_STAT_H
414 if( p_access->info.i_size != 0 &&
415 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
417 struct stat stat_info;
418 int i_file = p_sys->i_index;
420 if ( fstat( p_sys->fd, &stat_info ) == -1 )
422 msg_Warn( p_access, "couldn't stat again the file (%s)", strerror(errno) );
424 else if ( p_sys->file[i_file]->i_size != stat_info.st_size )
426 p_access->info.i_size += (stat_info.st_size - p_sys->file[i_file]->i_size );
427 p_sys->file[i_file]->i_size = stat_info.st_size;
428 p_access->info.i_update |= INPUT_UPDATE_SIZE;
433 /* If we reached an EOF then switch to the next file in the list */
434 if ( i_ret == 0 && p_sys->i_index + 1 < p_sys->i_file )
436 char *psz_name = p_sys->file[++p_sys->i_index]->psz_name;
437 p_sys->fd_backup = p_sys->fd;
439 msg_Dbg( p_access, "opening file `%s'", psz_name );
441 if ( _OpenFile( p_access, psz_name ) )
443 p_sys->fd = p_sys->fd_backup;
447 close( p_sys->fd_backup );
449 /* We have to read some data */
450 return Read( p_access, p_buffer, i_len );
454 p_access->info.i_pos += i_ret;
455 else if( i_ret == 0 )
456 p_access->info.b_eof = VLC_TRUE;
461 /*****************************************************************************
462 * Seek: seek to a specific location in a file
463 *****************************************************************************/
464 static int Seek( access_t *p_access, int64_t i_pos )
466 access_sys_t *p_sys = p_access->p_sys;
469 /* Check which file we need to access */
470 if( p_sys->i_file > 1 )
474 p_sys->fd_backup = p_sys->fd;
476 for( i = 0; i < p_sys->i_file - 1; i++ )
478 if( i_pos < p_sys->file[i]->i_size + i_size )
480 i_size += p_sys->file[i]->i_size;
482 psz_name = p_sys->file[i]->psz_name;
484 msg_Dbg( p_access, "opening file `%s'", psz_name );
486 if ( i != p_sys->i_index && !_OpenFile( p_access, psz_name ) )
489 close( p_sys->fd_backup );
494 p_sys->fd = p_sys->fd_backup;
498 lseek( p_sys->fd, i_pos - i_size, SEEK_SET );
500 p_access->info.i_pos = i_pos;
501 if( p_access->info.i_size < p_access->info.i_pos )
503 msg_Err( p_access, "seeking too far" );
504 p_access->info.i_pos = p_access->info.i_size;
506 else if( p_access->info.i_pos < 0 )
508 msg_Err( p_access, "seeking too early" );
509 p_access->info.i_pos = 0;
512 p_access->info.b_eof = VLC_FALSE;
518 /*****************************************************************************
520 *****************************************************************************/
521 static int Control( access_t *p_access, int i_query, va_list args )
523 access_sys_t *p_sys = p_access->p_sys;
531 case ACCESS_CAN_SEEK:
532 case ACCESS_CAN_FASTSEEK:
533 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
534 *pb_bool = p_sys->b_seekable;
537 case ACCESS_CAN_PAUSE:
538 case ACCESS_CAN_CONTROL_PACE:
539 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
540 *pb_bool = p_sys->b_pace_control;
545 pi_int = (int*)va_arg( args, int * );
549 case ACCESS_GET_PTS_DELAY:
550 pi_64 = (int64_t*)va_arg( args, int64_t * );
551 *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
555 case ACCESS_SET_PAUSE_STATE:
559 case ACCESS_GET_TITLE_INFO:
560 case ACCESS_SET_TITLE:
561 case ACCESS_SET_SEEKPOINT:
562 case ACCESS_SET_PRIVATE_ID_STATE:
563 case ACCESS_GET_META:
567 msg_Warn( p_access, "unimplemented query in control" );
575 /*****************************************************************************
576 * OpenFile: Opens a specific file
577 *****************************************************************************/
578 static int _OpenFile( access_t * p_access, const char * psz_name )
580 access_sys_t *p_sys = p_access->p_sys;
581 const char *psz_localname;
583 psz_localname = ToLocale( psz_name );
586 p_sys->fd = fopen( psz_localname, "rb" );
587 LocaleFree( psz_localname );
590 msg_Err( p_access, "cannot open file %s", psz_name );
594 fseek( p_sys->fd, 0, SEEK_END );
595 p_access->info.i_size = ftell( p_sys->fd );
596 p_access->info.i_update |= INPUT_UPDATE_SIZE;
597 fseek( p_sys->fd, 0, SEEK_SET );
600 p_sys->fd = open( psz_localname, O_NONBLOCK /*| O_LARGEFILE*/ );
601 LocaleFree( psz_localname );
602 if ( p_sys->fd == -1 )
604 msg_Err( p_access, "cannot open file %s (%s)", psz_name,