1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2006 Rémi Denis-Courmont
8 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * Rémi Denis-Courmont <rem # videolan # org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
30 #include <vlc/input.h>
31 #include <vlc_interaction.h>
36 #ifdef HAVE_SYS_TYPES_H
37 # include <sys/types.h>
39 #ifdef HAVE_SYS_STAT_H
40 # include <sys/stat.h>
46 #if defined( WIN32 ) && !defined( UNDER_CE )
53 #if defined( WIN32 ) && !defined( UNDER_CE )
54 /* fstat() support for large files on win32 */
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 "Caching value for files. This " \
83 "value should be set in milliseconds." )
84 #define CAT_TEXT N_("Concatenate with additional files")
85 #define CAT_LONGTEXT N_( \
86 "Play split files as if they were part of a unique file. " \
87 "You need to specify a comma-separated list of files." )
90 set_description( _("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 open_file( access_t *, const char * );
115 unsigned int i_nb_reads;
127 vlc_bool_t b_seekable;
128 vlc_bool_t b_pace_control;
131 /*****************************************************************************
132 * Open: open the file
133 *****************************************************************************/
134 static int Open( vlc_object_t *p_this )
136 access_t *p_access = (access_t*)p_this;
140 vlc_bool_t b_stdin = !strcmp (p_access->psz_path, "-");
142 /* Update default_pts to a suitable value for file access */
143 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
145 STANDARD_READ_ACCESS_INIT;
146 p_sys->i_nb_reads = 0;
147 p_sys->b_kfir = VLC_FALSE;
151 if (!strcasecmp (p_access->psz_access, "stream"))
153 p_sys->b_seekable = VLC_FALSE;
154 p_sys->b_pace_control = VLC_FALSE;
156 else if (!strcasecmp (p_access->psz_access, "kfir"))
158 p_sys->b_seekable = VLC_FALSE;
159 p_sys->b_pace_control = VLC_FALSE;
160 p_sys->b_kfir = VLC_TRUE;
164 /* returns early if psz_path is a directory */
165 #ifdef HAVE_SYS_STAT_H
166 struct stat stat_info;
168 if( utf8_stat( p_access->psz_path, &stat_info ) )
170 msg_Warn( p_access, "%s: %s", p_access->psz_path,
174 if S_ISDIR(stat_info.st_mode)
176 msg_Warn( p_access, "%s is a directory", p_access->psz_path );
181 p_sys->b_seekable = VLC_TRUE;
182 p_sys->b_pace_control = VLC_TRUE;
186 /* Count number of files */
187 catlist = var_CreateGetString (p_access, "file-cat");
196 for (const char *ptr = catlist; ptr != NULL; p_sys->filec++)
198 ptr = strchr (ptr, ',');
204 p_sys->filev = calloc (p_sys->filec, sizeof (p_sys->filev[0]));
205 if (p_sys->filev == NULL)
212 p_sys->sizev = calloc (p_sys->filec, sizeof (p_sys->sizev[0]));
213 if (p_sys->sizev == NULL)
222 char *filename = catlist;
223 for (unsigned i = 0; i < p_sys->filec; i++)
229 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
234 fd = open_file (p_access, p_access->psz_path);
238 assert (filename != NULL);
240 char *ptr = strchr (filename, ',');
244 msg_Dbg (p_access, "opening additionnal file `%s'", filename);
245 fd = open_file (p_access, filename);
249 #ifdef HAVE_SYS_STAT_H
252 if ((fd != -1) && fstat (fd, &st))
254 msg_Err (p_access, "fstat(%d): %s", fd, strerror (errno));
267 p_sys->filev[i] = fd;
269 #ifdef HAVE_SYS_STAT_H
270 p_sys->sizev[i] = st.st_size;
271 p_access->info.i_size += st.st_size;
273 if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
274 && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
275 // If one file is not seekable, the concatenation is not either
276 p_sys->b_seekable = VLC_FALSE;
278 p_sys->b_seekable = !b_stdin;
285 if (p_sys->b_seekable && !p_access->info.i_size)
287 /* FIXME that's bad because all others access will be probed */
288 msg_Err (p_access, "file %s is empty, aborting", p_access->psz_path);
296 /*****************************************************************************
297 * Close: close the target
298 *****************************************************************************/
299 static void Close (vlc_object_t * p_this)
301 access_t *p_access = (access_t*)p_this;
302 access_sys_t *p_sys = p_access->p_sys;
304 for (unsigned i = 0; i < p_sys->filec; i++)
305 close (p_sys->filev[i]);
312 /*****************************************************************************
313 * Read: standard read on a file descriptor.
314 *****************************************************************************/
315 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
317 access_sys_t *p_sys = p_access->p_sys;
319 int fd = p_sys->filev[p_sys->filep];
321 #if !defined(WIN32) && !defined(UNDER_CE)
322 if( !p_sys->b_pace_control )
326 /* Find if some data is available. This won't work under Windows. */
331 if( p_access->b_die )
334 memset (&ufd, 0, sizeof (ufd));
338 i_ret = poll (&ufd, 1, 500);
342 i_ret = read (fd, p_buffer, i_len);
346 /* b_kfir ; work around a buggy poll() driver implementation */
347 while (((i_ret = read (fd, p_buffer, i_len)) == 0)
350 msleep( INPUT_ERROR_SLEEP );
355 #endif /* WIN32 || UNDER_CE */
356 /* b_pace_control || WIN32 */
357 i_ret = read( fd, p_buffer, i_len );
368 msg_Err (p_access, "read failed (%s)", strerror (errno));
369 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
370 _("VLC could not read file \"%s\"."),
374 /* Delay a bit to avoid consuming all the CPU. This is particularly
375 * useful when reading from an unconnected FIFO. */
376 msleep( INPUT_ERROR_SLEEP );
381 #ifdef HAVE_SYS_STAT_H
382 if( p_access->info.i_size != 0 &&
383 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
386 int i = p_sys->filep;
388 if ((fstat (fd, &st) == 0)
389 && (p_sys->sizev[i] != st.st_size))
391 p_access->info.i_size += st.st_size - p_sys->sizev[i];
392 p_sys->sizev[i] = st.st_size;
393 p_access->info.i_update |= INPUT_UPDATE_SIZE;
398 /* If we reached an EOF then switch to the next file in the list */
401 if (++p_sys->filep < p_sys->filec)
402 /* We have to read some data */
403 return Read (p_access, p_buffer, i_len);
409 p_access->info.i_pos += i_ret;
410 else if( i_ret == 0 )
411 p_access->info.b_eof = VLC_TRUE;
416 /*****************************************************************************
417 * Seek: seek to a specific location in a file
418 *****************************************************************************/
419 static int Seek (access_t *p_access, int64_t i_pos)
421 access_sys_t *p_sys = p_access->p_sys;
423 if (p_access->info.i_size < p_access->info.i_pos)
425 msg_Err (p_access, "seeking too far");
426 i_pos = p_access->info.i_pos = p_access->info.i_size;
428 else if (p_access->info.i_pos < 0)
430 msg_Err (p_access, "seeking too early");
431 i_pos = p_access->info.i_pos = 0;
434 p_access->info.i_pos = i_pos;
435 p_access->info.b_eof = VLC_FALSE;
437 /* Determine which file we need to access */
439 assert (p_sys->filec > 0);
441 while (i_pos > p_sys->sizev[i])
443 i_pos -= p_sys->sizev[i++];
444 assert (i < p_sys->filec);
448 lseek (p_sys->filev[i], i_pos, SEEK_SET);
452 /*****************************************************************************
454 *****************************************************************************/
455 static int Control( access_t *p_access, int i_query, va_list args )
457 access_sys_t *p_sys = p_access->p_sys;
465 case ACCESS_CAN_SEEK:
466 case ACCESS_CAN_FASTSEEK:
467 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
468 *pb_bool = p_sys->b_seekable;
471 case ACCESS_CAN_PAUSE:
472 case ACCESS_CAN_CONTROL_PACE:
473 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
474 *pb_bool = p_sys->b_pace_control;
479 pi_int = (int*)va_arg( args, int * );
483 case ACCESS_GET_PTS_DELAY:
484 pi_64 = (int64_t*)va_arg( args, int64_t * );
485 *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
489 case ACCESS_SET_PAUSE_STATE:
493 case ACCESS_GET_TITLE_INFO:
494 case ACCESS_SET_TITLE:
495 case ACCESS_SET_SEEKPOINT:
496 case ACCESS_SET_PRIVATE_ID_STATE:
497 case ACCESS_GET_META:
501 msg_Warn( p_access, "unimplemented query in control" );
509 static char *expand_path (const access_t *p_access, const char *path)
511 if (strncmp (path, "~/", 2) == 0)
515 // TODO: we should also support the ~cmassiot/ syntax
516 if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
522 if (!strcasecmp (p_access->psz_access, "file")
523 && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
524 // Explorer can open path such as file:/C:/ or file:///C:/
525 // hence remove leading / if found
526 return strdup (path + 1);
529 return strdup (path);
533 /*****************************************************************************
534 * open_file: Opens a specific file
535 *****************************************************************************/
536 static int open_file (access_t *p_access, const char *psz_name)
538 char *path = expand_path (p_access, psz_name);
541 p_sys->fd = utf8_fopen( path, "rb" );
544 msg_Err( p_access, "cannot open file %s", psz_name );
545 intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
546 _("VLC could not open file \"%s\"."), psz_name );
551 fseek( p_sys->fd, 0, SEEK_END );
552 p_access->info.i_size = ftell( p_sys->fd );
553 p_access->info.i_update |= INPUT_UPDATE_SIZE;
554 fseek( p_sys->fd, 0, SEEK_SET );
556 const char *psz_localname = ToLocale (path);
557 if (psz_localname == NULL)
559 msg_Err (p_access, "incorrect file name %s", psz_name);
564 // FIXME: support non-ANSI filenames on Win32
565 int fd = open (path, O_NONBLOCK /*| O_LARGEFILE*/);
566 LocaleFree (psz_localname);
571 msg_Err (p_access, "cannot open file %s (%s)", psz_name,
573 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
574 _("VLC could not open file \"%s\" (%s)."),
575 psz_name, strerror (errno));
579 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
580 /* We'd rather use any available memory for reading ahead
581 * than for caching what we've already seen/heard */
582 fcntl (fd, F_RDAHEAD, 1);
583 fcntl (fd, F_NOCACHE, 1);