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>
75 #if !defined (WIN32) && !defined (__OS2__)
76 static bool IsRemote (int fd)
78 #if defined (HAVE_FSTATVFS) && defined (MNT_LOCAL)
81 if (fstatvfs (fd, &stf))
83 /* fstatvfs() is in POSIX, but MNT_LOCAL is not */
84 return !(stf.f_flag & MNT_LOCAL);
86 #elif defined (HAVE_LINUX_MAGIC_H)
89 if (fstatfs (fd, &stf))
92 switch ((unsigned long)stf.f_type)
95 case CODA_SUPER_MAGIC:
99 case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
110 # define IsRemote(fd,path) IsRemote(fd)
112 #else /* WIN32 || __OS2__ */
113 static bool IsRemote (const char *path)
115 # if !defined(__OS2__) && !defined(WINAPI_FAMILY_APP)
116 wchar_t *wpath = ToWide (path);
117 bool is_remote = (wpath != NULL && PathIsNetworkPathW (wpath));
121 return (! strncmp(path, "\\\\", 2));
124 # define IsRemote(fd,path) IsRemote(path)
127 #ifndef HAVE_POSIX_FADVISE
128 # define posix_fadvise(fd, off, len, adv)
131 static ssize_t FileRead (access_t *, uint8_t *, size_t);
132 static int FileSeek (access_t *, uint64_t);
133 static ssize_t StreamRead (access_t *, uint8_t *, size_t);
134 static int NoSeek (access_t *, uint64_t);
135 static int FileControl (access_t *, int, va_list);
137 /*****************************************************************************
138 * FileOpen: open the file
139 *****************************************************************************/
140 int FileOpen( vlc_object_t *p_this )
142 access_t *p_access = (access_t*)p_this;
147 if (!strcasecmp (p_access->psz_access, "fd"))
150 int oldfd = strtol (p_access->psz_location, &end, 10);
153 fd = vlc_dup (oldfd);
154 else if (*end == '/' && end > p_access->psz_location)
156 char *name = decode_URI_duplicate (end - 1);
160 fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
167 const char *path = p_access->psz_filepath;
169 if (unlikely(path == NULL))
171 msg_Dbg (p_access, "opening file `%s'", path);
172 fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
175 msg_Err (p_access, "cannot open file %s (%m)", path);
176 dialog_Fatal (p_access, _("File reading failed"),
177 _("VLC could not open the file \"%s\" (%m)."), path);
186 msg_Err (p_access, "failed to read (%m)");
191 int flags = fcntl (fd, F_GETFL);
192 if (S_ISFIFO (st.st_mode) || S_ISSOCK (st.st_mode))
193 /* Force non-blocking mode where applicable (fd://) */
196 /* Force blocking mode when not useful or not specified */
197 flags &= ~O_NONBLOCK;
198 fcntl (fd, F_SETFL, flags);
201 /* Directories can be opened and read from, but only readdir() knows
202 * how to parse the data. The directory plugin will do it. */
203 if (S_ISDIR (st.st_mode))
205 #ifdef HAVE_FDOPENDIR
206 DIR *handle = fdopendir (fd);
208 goto error; /* Uh? */
209 return DirInit (p_access, handle);
211 msg_Dbg (p_access, "ignoring directory");
216 access_sys_t *p_sys = malloc (sizeof (*p_sys));
217 if (unlikely(p_sys == NULL))
219 access_InitFields (p_access);
220 p_access->pf_block = NULL;
221 p_access->pf_control = FileControl;
222 p_access->p_sys = p_sys;
225 if (S_ISREG (st.st_mode) || S_ISBLK (st.st_mode))
227 p_access->pf_read = FileRead;
228 p_access->pf_seek = FileSeek;
229 p_access->info.i_size = st.st_size;
230 p_sys->b_pace_control = true;
232 /* Demuxers will need the beginning of the file for probing. */
233 posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
234 /* In most cases, we only read the file once. */
235 posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
237 fcntl (fd, F_RDAHEAD, 1);
240 fcntl (fd, F_NOCACHE, 0);
245 p_access->pf_read = StreamRead;
246 p_access->pf_seek = NoSeek;
247 p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
257 /*****************************************************************************
258 * FileClose: close the target
259 *****************************************************************************/
260 void FileClose (vlc_object_t * p_this)
262 access_t *p_access = (access_t*)p_this;
264 if (p_access->pf_read == NULL)
270 access_sys_t *p_sys = p_access->p_sys;
277 #include <vlc_network.h>
280 * Reads from a regular file.
282 static ssize_t FileRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
284 access_sys_t *p_sys = p_access->p_sys;
286 ssize_t val = read (fd, p_buffer, i_len);
297 msg_Err (p_access, "read error: %m");
298 dialog_Fatal (p_access, _("File reading failed"),
299 _("VLC could not read the file (%m)."));
303 p_access->info.i_pos += val;
304 p_access->info.b_eof = !val;
305 if (p_access->info.i_pos >= p_access->info.i_size)
309 if (fstat (fd, &st) == 0)
310 p_access->info.i_size = st.st_size;
316 /*****************************************************************************
317 * Seek: seek to a specific location in a file
318 *****************************************************************************/
319 static int FileSeek (access_t *p_access, uint64_t i_pos)
321 p_access->info.i_pos = i_pos;
322 p_access->info.b_eof = false;
324 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
329 * Reads from a non-seekable file.
331 static ssize_t StreamRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
333 access_sys_t *p_sys = p_access->p_sys;
336 #if !defined (WIN32) && !defined (__OS2__)
337 ssize_t val = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
339 ssize_t val = read (fd, p_buffer, i_len);
350 msg_Err (p_access, "read error: %m");
354 p_access->info.i_pos += val;
355 p_access->info.b_eof = !val;
359 static int NoSeek (access_t *p_access, uint64_t i_pos)
362 (void) p_access; (void) i_pos;
366 /*****************************************************************************
368 *****************************************************************************/
369 static int FileControl( access_t *p_access, int i_query, va_list args )
371 access_sys_t *p_sys = p_access->p_sys;
378 case ACCESS_CAN_SEEK:
379 case ACCESS_CAN_FASTSEEK:
380 pb_bool = (bool*)va_arg( args, bool* );
381 *pb_bool = (p_access->pf_seek != NoSeek);
384 case ACCESS_CAN_PAUSE:
385 case ACCESS_CAN_CONTROL_PACE:
386 pb_bool = (bool*)va_arg( args, bool* );
387 *pb_bool = p_sys->b_pace_control;
391 case ACCESS_GET_PTS_DELAY:
392 pi_64 = (int64_t*)va_arg( args, int64_t * );
393 if (IsRemote (p_sys->fd, p_access->psz_filepath))
394 *pi_64 = var_InheritInteger (p_access, "network-caching");
396 *pi_64 = var_InheritInteger (p_access, "file-caching");
401 case ACCESS_SET_PAUSE_STATE:
405 case ACCESS_GET_TITLE_INFO:
406 case ACCESS_SET_TITLE:
407 case ACCESS_SET_SEEKPOINT:
408 case ACCESS_SET_PRIVATE_ID_STATE:
409 case ACCESS_GET_META:
410 case ACCESS_GET_PRIVATE_ID_STATE:
411 case ACCESS_GET_CONTENT_TYPE:
415 msg_Warn( p_access, "unimplemented query %d in control", i_query );