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 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_input.h>
36 #include <vlc_access.h>
37 #include <vlc_dialog.h>
41 #ifdef HAVE_SYS_TYPES_H
42 # include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
50 #if defined (__linux__)
52 # include <linux/magic.h>
53 # define HAVE_FSTATFS 1
54 #elif defined (HAVE_SYS_MOUNT_H)
55 # include <sys/mount.h>
56 # define HAVE_FSTATFS 1
68 #if defined( WIN32 ) && !defined( UNDER_CE )
72 # define lseek _lseeki64
73 #elif defined( UNDER_CE )
74 /* FIXME the commandline on wince is a mess */
78 #include <vlc_charset.h>
80 /*****************************************************************************
82 *****************************************************************************/
83 static int Open ( vlc_object_t * );
84 static void Close( vlc_object_t * );
86 #define CACHING_TEXT N_("Caching value (ms)")
87 #define CACHING_LONGTEXT N_( \
88 "Caching value for files, in milliseconds." )
90 #define NETWORK_CACHING_TEXT N_("Extra network caching value (ms)")
91 #define NETWORK_CACHING_LONGTEXT N_( \
92 "Supplementary caching value for remote files, in milliseconds." )
95 set_description( N_("File input") )
96 set_shortname( N_("File") )
97 set_category( CAT_INPUT )
98 set_subcategory( SUBCAT_INPUT_ACCESS )
99 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL,
100 CACHING_TEXT, CACHING_LONGTEXT, true )
102 add_integer( "network-caching", 3 * DEFAULT_PTS_DELAY / 1000, NULL,
103 NETWORK_CACHING_TEXT, NETWORK_CACHING_LONGTEXT, true )
105 add_obsolete_string( "file-cat" )
106 set_capability( "access", 50 )
107 add_shortcut( "file" )
109 add_shortcut( "stream" )
110 set_callbacks( Open, Close )
114 /*****************************************************************************
115 * Exported prototypes
116 *****************************************************************************/
117 static int Seek( access_t *, int64_t );
118 static int NoSeek( access_t *, int64_t );
119 static ssize_t Read( access_t *, uint8_t *, size_t );
120 static int Control( access_t *, int, va_list );
122 static int open_file( access_t *, const char * );
126 unsigned int i_nb_reads;
135 static bool IsRemote (int fd)
140 if (fstatfs (fd, &stf))
143 #if defined(MNT_LOCAL)
144 return !(stf.f_flags & MNT_LOCAL);
146 #elif defined (__linux__)
149 case AFS_SUPER_MAGIC:
150 case CODA_SUPER_MAGIC:
151 case NCP_SUPER_MAGIC:
152 case NFS_SUPER_MAGIC:
153 case SMB_SUPER_MAGIC:
154 case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
160 #else /* !HAVE_FSTATFS */
167 #ifndef HAVE_POSIX_FADVISE
168 # define posix_fadvise(fd, off, len, adv) (0)
171 /*****************************************************************************
172 * Open: open the file
173 *****************************************************************************/
174 static int Open( vlc_object_t *p_this )
176 access_t *p_access = (access_t*)p_this;
179 wchar_t wpath[MAX_PATH+1];
180 bool is_remote = false;
183 STANDARD_READ_ACCESS_INIT;
184 p_sys->i_nb_reads = 0;
185 p_sys->b_pace_control = true;
190 if (!strcasecmp (p_access->psz_access, "fd"))
191 fd = dup (atoi (p_access->psz_path));
192 else if (!strcmp (p_access->psz_path, "-"))
196 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
197 fd = open_file (p_access, p_access->psz_path);
199 if (MultiByteToWideChar (CP_UTF8, 0, p_access->psz_path, -1,
201 && PathIsNetworkPathW (wpath))
203 # define IsRemote( fd ) ((void)fd, is_remote)
209 #ifdef HAVE_SYS_STAT_H
214 msg_Err (p_access, "failed to read (%m)");
217 /* Directories can be opened and read from, but only readdir() knows
218 * how to parse the data. The directory plugin will do it. */
219 if (S_ISDIR (st.st_mode))
221 msg_Dbg (p_access, "ignoring directory");
224 if (S_ISREG (st.st_mode))
225 p_access->info.i_size = st.st_size;
226 else if (!S_ISBLK (st.st_mode))
228 p_access->pf_seek = NoSeek;
229 p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
232 # warning File size not known!
235 p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
237 p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
241 if (p_access->pf_seek != NoSeek)
243 /* Demuxers will need the beginning of the file for probing. */
244 posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
245 /* In most cases, we only read the file once. */
246 posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
257 /*****************************************************************************
258 * Close: close the target
259 *****************************************************************************/
260 static void Close (vlc_object_t * p_this)
262 access_t *p_access = (access_t*)p_this;
263 access_sys_t *p_sys = p_access->p_sys;
270 #include <vlc_network.h>
272 /*****************************************************************************
273 * Read: standard read on a file descriptor.
274 *****************************************************************************/
275 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
277 access_sys_t *p_sys = p_access->p_sys;
282 if (p_access->pf_seek == NoSeek)
283 i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
286 i_ret = read (fd, p_buffer, i_len);
297 msg_Err (p_access, "failed to read (%m)");
298 dialog_Fatal (p_access, _("File reading failed"), "%s",
299 _("VLC could not read the file."));
300 p_access->info.b_eof = true;
305 p_access->info.i_pos += i_ret;
307 p_access->info.b_eof = true;
311 if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
312 || (p_access->info.i_pos > p_access->info.i_size))
314 #ifdef HAVE_SYS_STAT_H
317 if ((fstat (fd, &st) == 0)
318 && (p_access->info.i_size != st.st_size))
320 p_access->info.i_size = st.st_size;
321 p_access->info.i_update |= INPUT_UPDATE_SIZE;
324 /* Pre-fetch until the end (within memory limits) */
325 posix_fadvise (fd, p_access->info.i_pos, 0, POSIX_FADV_WILLNEED);
331 /*****************************************************************************
332 * Seek: seek to a specific location in a file
333 *****************************************************************************/
334 static int Seek (access_t *p_access, int64_t i_pos)
336 p_access->info.i_pos = i_pos;
337 p_access->info.b_eof = false;
339 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
343 static int NoSeek (access_t *p_access, int64_t i_pos)
346 (void) p_access; (void) i_pos;
350 /*****************************************************************************
352 *****************************************************************************/
353 static int Control( access_t *p_access, int i_query, va_list args )
355 access_sys_t *p_sys = p_access->p_sys;
362 case ACCESS_CAN_SEEK:
363 case ACCESS_CAN_FASTSEEK:
364 pb_bool = (bool*)va_arg( args, bool* );
365 *pb_bool = (p_access->pf_seek != NoSeek);
368 case ACCESS_CAN_PAUSE:
369 case ACCESS_CAN_CONTROL_PACE:
370 pb_bool = (bool*)va_arg( args, bool* );
371 *pb_bool = p_sys->b_pace_control;
375 case ACCESS_GET_PTS_DELAY:
376 pi_64 = (int64_t*)va_arg( args, int64_t * );
377 *pi_64 = p_sys->caching * INT64_C(1000);
381 case ACCESS_SET_PAUSE_STATE:
385 case ACCESS_GET_TITLE_INFO:
386 case ACCESS_SET_TITLE:
387 case ACCESS_SET_SEEKPOINT:
388 case ACCESS_SET_PRIVATE_ID_STATE:
389 case ACCESS_GET_META:
390 case ACCESS_GET_PRIVATE_ID_STATE:
391 case ACCESS_GET_CONTENT_TYPE:
395 msg_Warn( p_access, "unimplemented query %d in control", i_query );
402 /*****************************************************************************
403 * open_file: Opens a specific file
404 *****************************************************************************/
405 static int open_file (access_t *p_access, const char *path)
408 if (!strcasecmp (p_access->psz_access, "file")
409 && ('/' == path[0]) && isalpha (path[1])
410 && (':' == path[2]) && ('/' == path[3]))
411 /* Explorer can open path such as file:/C:/ or file:///C:/
412 * hence remove leading / if found */
416 int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
419 msg_Err (p_access, "cannot open file %s (%m)", path);
420 dialog_Fatal (p_access, _("File reading failed"),
421 _("VLC could not open the file \"%s\"."), path);
425 #if defined(HAVE_FCNTL)
426 /* We'd rather use any available memory for reading ahead
427 * than for caching what we've already seen/heard */
428 # if defined(F_RDAHEAD)
429 fcntl (fd, F_RDAHEAD, 1);
431 # if defined(F_NOCACHE)
432 fcntl (fd, F_NOCACHE, 1);