1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2006 VLC authors and VideoLAN
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 it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
32 #include <sys/types.h>
36 # include <sys/statvfs.h>
37 # if defined (HAVE_SYS_MOUNT_H)
38 # include <sys/param.h>
39 # include <sys/mount.h>
42 #ifdef HAVE_LINUX_MAGIC_H
44 # include <linux/magic.h>
56 #include <vlc_common.h>
58 #include <vlc_input.h>
59 #include <vlc_access.h>
60 #include <vlc_dialog.h>
62 # include <vlc_charset.h>
69 unsigned int i_nb_reads;
77 #if !defined (WIN32) && !defined (__OS2__)
78 static bool IsRemote (int fd)
80 #if defined (HAVE_FSTATVFS) && defined (MNT_LOCAL)
83 if (fstatvfs (fd, &stf))
85 /* fstatvfs() is in POSIX, but MNT_LOCAL is not */
86 return !(stf.f_flag & MNT_LOCAL);
88 #elif defined (HAVE_LINUX_MAGIC_H)
91 if (fstatfs (fd, &stf))
94 switch ((unsigned long)stf.f_type)
97 case CODA_SUPER_MAGIC:
100 case SMB_SUPER_MAGIC:
101 case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
112 # define IsRemote(fd,path) IsRemote(fd)
114 #else /* WIN32 || __OS2__ */
115 static bool IsRemote (const char *path)
117 # if !defined(__OS2__)
118 wchar_t *wpath = ToWide (path);
119 bool is_remote = (wpath != NULL && PathIsNetworkPathW (wpath));
123 return (! strncmp(path, "\\\\", 2));
126 # define IsRemote(fd,path) IsRemote(path)
129 #ifndef HAVE_POSIX_FADVISE
130 # define posix_fadvise(fd, off, len, adv)
133 static ssize_t FileRead (access_t *, uint8_t *, size_t);
134 static int FileSeek (access_t *, uint64_t);
135 static ssize_t StreamRead (access_t *, uint8_t *, size_t);
136 static int NoSeek (access_t *, uint64_t);
137 static int FileControl (access_t *, int, va_list);
139 /*****************************************************************************
140 * FileOpen: open the file
141 *****************************************************************************/
142 int FileOpen( vlc_object_t *p_this )
144 access_t *p_access = (access_t*)p_this;
149 if (!strcasecmp (p_access->psz_access, "fd"))
152 int oldfd = strtol (p_access->psz_location, &end, 10);
155 fd = vlc_dup (oldfd);
156 else if (*end == '/' && end > p_access->psz_location)
158 char *name = decode_URI_duplicate (end - 1);
162 fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
169 const char *path = p_access->psz_filepath;
171 if (unlikely(path == NULL))
173 msg_Dbg (p_access, "opening file `%s'", path);
174 fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
177 msg_Err (p_access, "cannot open file %s (%m)", path);
178 dialog_Fatal (p_access, _("File reading failed"),
179 _("VLC could not open the file \"%s\". (%m)"), path);
188 msg_Err (p_access, "failed to read (%m)");
193 int flags = fcntl (fd, F_GETFL);
194 if (S_ISFIFO (st.st_mode) || S_ISSOCK (st.st_mode))
195 /* Force non-blocking mode where applicable (fd://) */
198 /* Force blocking mode when not useful or not specified */
199 flags &= ~O_NONBLOCK;
200 fcntl (fd, F_SETFL, flags);
203 /* Directories can be opened and read from, but only readdir() knows
204 * how to parse the data. The directory plugin will do it. */
205 if (S_ISDIR (st.st_mode))
207 #ifdef HAVE_FDOPENDIR
208 DIR *handle = fdopendir (fd);
210 goto error; /* Uh? */
211 return DirInit (p_access, handle);
213 msg_Dbg (p_access, "ignoring directory");
218 access_sys_t *p_sys = malloc (sizeof (*p_sys));
219 if (unlikely(p_sys == NULL))
221 access_InitFields (p_access);
222 p_access->pf_block = NULL;
223 p_access->pf_control = FileControl;
224 p_access->p_sys = p_sys;
225 p_sys->i_nb_reads = 0;
228 if (S_ISREG (st.st_mode) || S_ISBLK (st.st_mode))
230 p_access->pf_read = FileRead;
231 p_access->pf_seek = FileSeek;
232 p_access->info.i_size = st.st_size;
233 p_sys->b_pace_control = true;
235 /* Demuxers will need the beginning of the file for probing. */
236 posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
237 /* In most cases, we only read the file once. */
238 posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
239 #if defined(HAVE_FCNTL)
240 /* We'd rather use any available memory for reading ahead
241 * than for caching what we've already seen/heard */
242 # if defined(F_RDAHEAD)
243 fcntl (fd, F_RDAHEAD, 1);
245 # if defined(F_NOCACHE)
246 fcntl (fd, F_NOCACHE, 1);
252 p_access->pf_read = StreamRead;
253 p_access->pf_seek = NoSeek;
254 p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
264 /*****************************************************************************
265 * FileClose: close the target
266 *****************************************************************************/
267 void FileClose (vlc_object_t * p_this)
269 access_t *p_access = (access_t*)p_this;
271 if (p_access->pf_read == NULL)
277 access_sys_t *p_sys = p_access->p_sys;
284 #include <vlc_network.h>
287 * Reads from a regular file.
289 static ssize_t FileRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
291 access_sys_t *p_sys = p_access->p_sys;
293 ssize_t val = read (fd, p_buffer, i_len);
304 msg_Err (p_access, "read error: %m");
305 dialog_Fatal (p_access, _("File reading failed"),
306 _("VLC could not read the file (%m)."));
310 p_access->info.i_pos += val;
311 p_access->info.b_eof = !val;
315 if (!(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS)
316 || (p_access->info.i_pos > p_access->info.i_size))
320 if ((fstat (fd, &st) == 0)
321 && (p_access->info.i_size != (uint64_t)st.st_size))
323 p_access->info.i_size = st.st_size;
324 p_access->info.i_update |= INPUT_UPDATE_SIZE;
331 /*****************************************************************************
332 * Seek: seek to a specific location in a file
333 *****************************************************************************/
334 static int FileSeek (access_t *p_access, uint64_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);
344 * Reads from a non-seekable file.
346 static ssize_t StreamRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
348 access_sys_t *p_sys = p_access->p_sys;
351 #if !defined (WIN32) && !defined (__OS2__)
352 ssize_t val = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
354 ssize_t val = read (fd, p_buffer, i_len);
365 msg_Err (p_access, "read error: %m");
369 p_access->info.i_pos += val;
370 p_access->info.b_eof = !val;
374 static int NoSeek (access_t *p_access, uint64_t i_pos)
377 (void) p_access; (void) i_pos;
381 /*****************************************************************************
383 *****************************************************************************/
384 static int FileControl( access_t *p_access, int i_query, va_list args )
386 access_sys_t *p_sys = p_access->p_sys;
393 case ACCESS_CAN_SEEK:
394 case ACCESS_CAN_FASTSEEK:
395 pb_bool = (bool*)va_arg( args, bool* );
396 *pb_bool = (p_access->pf_seek != NoSeek);
399 case ACCESS_CAN_PAUSE:
400 case ACCESS_CAN_CONTROL_PACE:
401 pb_bool = (bool*)va_arg( args, bool* );
402 *pb_bool = p_sys->b_pace_control;
406 case ACCESS_GET_PTS_DELAY:
407 pi_64 = (int64_t*)va_arg( args, int64_t * );
408 if (IsRemote (p_sys->fd, p_access->psz_filepath))
409 *pi_64 = var_InheritInteger (p_access, "network-caching");
411 *pi_64 = var_InheritInteger (p_access, "file-caching");
416 case ACCESS_SET_PAUSE_STATE:
420 case ACCESS_GET_TITLE_INFO:
421 case ACCESS_SET_TITLE:
422 case ACCESS_SET_SEEKPOINT:
423 case ACCESS_SET_PRIVATE_ID_STATE:
424 case ACCESS_GET_META:
425 case ACCESS_GET_PRIVATE_ID_STATE:
426 case ACCESS_GET_CONTENT_TYPE:
430 msg_Warn( p_access, "unimplemented query %d in control", i_query );