1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2006-2007 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_access.h>
32 #include <vlc_interface.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 # include <sys/mman.h>
56 #if defined( WIN32 ) && !defined( UNDER_CE )
60 # define lseek _lseeki64
61 #elif defined( UNDER_CE )
65 # define read(a,b,c) fread(b,1,c,a)
66 # define close(a) fclose(a)
73 #include <vlc_charset.h>
75 /*****************************************************************************
77 *****************************************************************************/
78 static int Open ( vlc_object_t * );
79 static void Close( vlc_object_t * );
81 #define CACHING_TEXT N_("Caching value in ms")
82 #define CACHING_LONGTEXT N_( \
83 "Caching value for files. This " \
84 "value should be set in milliseconds." )
85 #define CAT_TEXT N_("Concatenate with additional files")
86 #define CAT_LONGTEXT N_( \
87 "Play split files as if they were part of a unique file. " \
88 "You need to specify a comma-separated list of files." )
91 set_description( _("File input") );
92 set_shortname( _("File") );
93 set_category( CAT_INPUT );
94 set_subcategory( SUBCAT_INPUT_ACCESS );
95 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
96 add_obsolete_string( "file-cat" );
97 set_capability( "access2", 50 );
98 add_shortcut( "file" );
99 add_shortcut( "stream" );
100 add_shortcut( "kfir" );
101 set_callbacks( Open, Close );
105 /*****************************************************************************
106 * Exported prototypes
107 *****************************************************************************/
108 static int Seek( access_t *, int64_t );
109 static ssize_t Read( access_t *, uint8_t *, size_t );
110 static int Control( access_t *, int, va_list );
112 static block_t *mmapBlock( access_t * );
115 static int open_file( access_t *, const char * );
120 unsigned int i_nb_reads;
126 vlc_bool_t b_seekable;
127 vlc_bool_t b_pace_control;
130 /*****************************************************************************
131 * Open: open the file
132 *****************************************************************************/
133 static int Open( vlc_object_t *p_this )
135 access_t *p_access = (access_t*)p_this;
138 vlc_bool_t b_stdin = !strcmp (p_access->psz_path, "-");
140 /* Update default_pts to a suitable value for file access */
141 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
143 STANDARD_READ_ACCESS_INIT;
144 p_sys->i_nb_reads = 0;
145 p_sys->b_kfir = VLC_FALSE;
146 int fd = p_sys->fd = -1;
148 if (!strcasecmp (p_access->psz_access, "stream"))
150 p_sys->b_seekable = VLC_FALSE;
151 p_sys->b_pace_control = VLC_FALSE;
153 else if (!strcasecmp (p_access->psz_access, "kfir"))
155 p_sys->b_seekable = VLC_FALSE;
156 p_sys->b_pace_control = VLC_FALSE;
157 p_sys->b_kfir = VLC_TRUE;
161 p_sys->b_seekable = VLC_TRUE;
162 p_sys->b_pace_control = VLC_TRUE;
166 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
171 fd = open_file (p_access, p_access->psz_path);
173 #ifdef HAVE_SYS_STAT_H
179 msg_Err (p_access, "fstat(%d): %m", fd);
181 if (S_ISDIR (st.st_mode))
182 /* The directory plugin takes care of that */
183 msg_Dbg (p_access, "file is a directory, aborting");
199 #ifdef HAVE_SYS_STAT_H
200 p_access->info.i_size = st.st_size;
201 if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
202 && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
203 p_sys->b_seekable = VLC_FALSE;
206 p_sys->pagemask = sysconf (_SC_PAGE_SIZE) - 1;
208 /* Autodetect mmap() support */
209 if (p_sys->b_pace_control && S_ISREG (st.st_mode) && (st.st_size > 0))
211 /* TODO: Do not allow PROT_WRITE, we should not need it.
212 * However, this far, "block" ownership seems such that whoever
213 * "receives" a block can freely modify its content. Hence we _may_
214 * need PROT_WRITE not to default memory protection.
215 * NOTE: With MAP_PRIVATE, changes are not committed to the underlying
216 * file, write open permission is not required.
218 void *addr = mmap (NULL, 1, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
219 if (addr != MAP_FAILED)
221 /* Does the file system support mmap? */
223 p_access->pf_read = NULL;
224 p_access->pf_block = mmapBlock;
225 msg_Dbg (p_this, "mmap enabled");
228 msg_Dbg (p_this, "mmap disabled (%m)");
231 msg_Dbg (p_this, "mmap disabled (non regular file)");
234 p_sys->b_seekable = !b_stdin;
235 # warning File size not known!
238 if (p_sys->b_seekable && (p_access->info.i_size == 0))
240 /* FIXME that's bad because all others access will be probed */
241 msg_Err (p_access, "file is empty, aborting");
249 /*****************************************************************************
250 * Close: close the target
251 *****************************************************************************/
252 static void Close (vlc_object_t * p_this)
254 access_t *p_access = (access_t*)p_this;
255 access_sys_t *p_sys = p_access->p_sys;
261 /*****************************************************************************
262 * Read: standard read on a file descriptor.
263 *****************************************************************************/
264 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
266 access_sys_t *p_sys = p_access->p_sys;
270 #if !defined(WIN32) && !defined(UNDER_CE)
271 if( !p_sys->b_pace_control )
275 /* Find if some data is available. This won't work under Windows. */
280 if( p_access->b_die )
283 memset (&ufd, 0, sizeof (ufd));
287 i_ret = poll (&ufd, 1, 500);
291 i_ret = read (fd, p_buffer, i_len);
295 /* b_kfir ; work around a buggy poll() driver implementation */
296 while (((i_ret = read (fd, p_buffer, i_len)) == 0)
299 msleep( INPUT_ERROR_SLEEP );
304 #endif /* WIN32 || UNDER_CE */
305 /* b_pace_control || WIN32 */
306 i_ret = read( fd, p_buffer, i_len );
317 msg_Err (p_access, "read failed (%m)");
318 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
319 _("VLC could not read the file."));
322 /* Delay a bit to avoid consuming all the CPU. This is particularly
323 * useful when reading from an unconnected FIFO. */
324 msleep( INPUT_ERROR_SLEEP );
329 #ifdef HAVE_SYS_STAT_H
330 if( p_access->info.i_size != 0 &&
331 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
335 if ((fstat (fd, &st) == 0)
336 && (p_access->info.i_size != st.st_size))
338 p_access->info.i_size = st.st_size;
339 p_access->info.i_update |= INPUT_UPDATE_SIZE;
345 p_access->info.i_pos += i_ret;
346 else if( i_ret == 0 )
347 p_access->info.b_eof = VLC_TRUE;
353 # define MMAP_SIZE (1 << 20)
355 static block_t *mmapBlock (access_t *p_access)
357 access_sys_t *p_sys = p_access->p_sys;
359 const int flags = MAP_SHARED;
360 off_t offset = p_access->info.i_pos & ~p_sys->pagemask;
361 size_t align = p_access->info.i_pos & p_sys->pagemask;
362 size_t length = (MMAP_SIZE > p_sys->pagemask) ? MMAP_SIZE : (p_sys->pagemask + 1);
366 int64_t dbgpos = lseek (p_sys->fd, 0, SEEK_CUR);
367 if (dbgpos != p_access->info.i_pos)
368 msg_Err (p_access, "position: 0x%08llx instead of 0x%08llx",
369 p_access->info.i_pos, dbgpos);
372 if (p_access->info.i_pos >= p_access->info.i_size)
374 /* End of file - check if file size changed... */
377 if ((fstat (p_sys->fd, &st) == 0)
378 && (st.st_size != p_access->info.i_size))
380 p_access->info.i_size = st.st_size;
381 p_access->info.i_update |= INPUT_UPDATE_SIZE;
384 /* Really at end of file then */
385 if (p_access->info.i_pos >= p_access->info.i_size)
387 p_access->info.b_eof = VLC_TRUE;
388 msg_Dbg (p_access, "at end of memory mapped file");
393 if (offset + length > p_access->info.i_size)
394 /* Don't mmap beyond end of file */
395 length = p_access->info.i_size - offset;
397 assert (offset <= p_access->info.i_pos); /* and */
398 assert (p_access->info.i_pos < p_access->info.i_size); /* imply */
399 assert (offset < p_access->info.i_size); /* imply */
402 addr = mmap (NULL, length, PROT_READ, flags, p_sys->fd, offset);
403 if (addr == MAP_FAILED)
405 msg_Err (p_access, "memory mapping failed (%m)");
406 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
407 _("VLC could not read the file."));
408 msleep( INPUT_ERROR_SLEEP );
412 p_access->info.i_pos = offset + length;
414 block_t *block = block_mmap_Alloc (addr, length);
418 block->p_buffer += align;
419 block->i_buffer -= align;
422 msg_Dbg (p_access, "mapped 0x%lx bytes at %p from offset 0x%lx",
423 (unsigned long)length, addr, (unsigned long)offset);
425 /* Compare normal I/O with memory mapping */
426 char *buf = malloc (block->i_buffer);
427 ssize_t i_read = read (p_sys->fd, buf, block->i_buffer);
429 if (i_read != (ssize_t)block->i_buffer)
430 msg_Err (p_access, "read %u instead of %u bytes", (unsigned)i_read,
431 (unsigned)block->i_buffer);
432 if (memcmp (buf, block->p_buffer, block->i_buffer))
433 msg_Err (p_access, "inconsistent data buffer");
441 /*****************************************************************************
442 * Seek: seek to a specific location in a file
443 *****************************************************************************/
444 static int Seek (access_t *p_access, int64_t i_pos)
446 /* FIXME: i_size should really be unsigned */
447 if ((uint64_t)i_pos > (uint64_t)p_access->info.i_size)
449 /* This should only happen with corrupted files.
450 * But it also seems to happen with buggy demuxes (ASF) */
451 msg_Err (p_access, "seeking too far (0x"I64Fx" / 0x"I64Fx")",
452 i_pos, p_access->info.i_size);
453 i_pos = p_access->info.i_size;
456 p_access->info.i_pos = i_pos;
457 p_access->info.b_eof = VLC_FALSE;
459 #if defined (HAVE_MMAP) && defined (NDEBUG)
460 if (p_access->pf_block == NULL)
462 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
466 /*****************************************************************************
468 *****************************************************************************/
469 static int Control( access_t *p_access, int i_query, va_list args )
471 access_sys_t *p_sys = p_access->p_sys;
479 case ACCESS_CAN_SEEK:
480 case ACCESS_CAN_FASTSEEK:
481 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
482 *pb_bool = p_sys->b_seekable;
485 case ACCESS_CAN_PAUSE:
486 case ACCESS_CAN_CONTROL_PACE:
487 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
488 *pb_bool = p_sys->b_pace_control;
493 pi_int = (int*)va_arg( args, int * );
497 case ACCESS_GET_PTS_DELAY:
498 pi_64 = (int64_t*)va_arg( args, int64_t * );
499 *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
503 case ACCESS_SET_PAUSE_STATE:
507 case ACCESS_GET_TITLE_INFO:
508 case ACCESS_SET_TITLE:
509 case ACCESS_SET_SEEKPOINT:
510 case ACCESS_SET_PRIVATE_ID_STATE:
511 case ACCESS_GET_META:
512 case ACCESS_GET_CONTENT_TYPE:
516 msg_Warn( p_access, "unimplemented query in control" );
524 static char *expand_path (const access_t *p_access, const char *path)
526 if (strncmp (path, "~/", 2) == 0)
530 // TODO: we should also support the ~cmassiot/ syntax
531 if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
537 if (!strcasecmp (p_access->psz_access, "file")
538 && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
539 // Explorer can open path such as file:/C:/ or file:///C:/
540 // hence remove leading / if found
541 return strdup (path + 1);
544 return strdup (path);
548 /*****************************************************************************
549 * open_file: Opens a specific file
550 *****************************************************************************/
551 static int open_file (access_t *p_access, const char *psz_name)
553 char *path = expand_path (p_access, psz_name);
556 p_sys->fd = utf8_fopen( path, "rb" );
559 msg_Err( p_access, "cannot open file %s", psz_name );
560 intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
561 _("VLC could not open the file \"%s\"."), psz_name );
566 fseek( p_sys->fd, 0, SEEK_END );
567 p_access->info.i_size = ftell( p_sys->fd );
568 p_access->info.i_update |= INPUT_UPDATE_SIZE;
569 fseek( p_sys->fd, 0, SEEK_SET );
571 int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
575 msg_Err (p_access, "cannot open file %s (%m)", psz_name);
576 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
577 _("VLC could not open the file \"%s\"."), psz_name);
581 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
582 /* We'd rather use any available memory for reading ahead
583 * than for caching what we've already seen/heard */
584 fcntl (fd, F_RDAHEAD, 1);
585 fcntl (fd, F_NOCACHE, 1);