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 *****************************************************************************/
30 #include <vlc_common.h>
32 #include <vlc_input.h>
33 #include <vlc_access.h>
34 #include <vlc_dialog.h>
38 #include <sys/types.h>
39 #ifdef HAVE_SYS_STAT_H
40 # include <sys/stat.h>
45 #if defined (__linux__)
47 #ifdef HAVE_LINUX_MAGIC_H
48 # include <linux/magic.h>
50 #elif defined (HAVE_SYS_MOUNT_H)
51 # include <sys/param.h>
52 # include <sys/mount.h>
64 #if defined( WIN32 ) && !defined( UNDER_CE )
68 # define lseek _lseeki64
69 #elif defined( UNDER_CE )
70 /* FIXME the commandline on wince is a mess */
72 # define PathIsNetworkPathW(wpath) (! wcsncmp(wpath, L"\\\\", 2))
75 #include <vlc_charset.h>
80 unsigned int i_nb_reads;
90 static bool IsRemote (int fd)
95 if (fstatfs (fd, &stf))
98 #if defined(MNT_LOCAL)
99 return !(stf.f_flags & MNT_LOCAL);
102 # ifdef HAVE_LINUX_MAGIC_H
105 case AFS_SUPER_MAGIC:
106 case CODA_SUPER_MAGIC:
107 case NCP_SUPER_MAGIC:
108 case NFS_SUPER_MAGIC:
109 case SMB_SUPER_MAGIC:
110 case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
116 #else /* !HAVE_FSTATFS */
124 #ifndef HAVE_POSIX_FADVISE
125 # define posix_fadvise(fd, off, len, adv)
128 /*****************************************************************************
129 * Open: open the file
130 *****************************************************************************/
131 int Open( vlc_object_t *p_this )
133 access_t *p_access = (access_t*)p_this;
134 const char *path = p_access->psz_path;
136 bool is_remote = false;
142 if (!strcasecmp (p_access->psz_access, "fd"))
145 int oldfd = strtol (path, &end, 10);
151 lseek (fd, 0, SEEK_SET);
153 #ifdef HAVE_FDOPENDIR
154 else if (*end == '/' && end > path)
156 char *name = decode_URI_duplicate (end - 1);
157 if (name != NULL) /* TODO: ToLocale(), FD_CLOEXEC */
160 fd = openat (oldfd, name, O_RDONLY | O_NONBLOCK);
168 msg_Dbg (p_access, "opening file `%s'", path);
169 fd = utf8_open (path, O_RDONLY | O_NONBLOCK);
172 msg_Err (p_access, "cannot open file %s (%m)", path);
173 dialog_Fatal (p_access, _("File reading failed"),
174 _("VLC could not open the file \"%s\"."), path);
178 wchar_t wpath[MAX_PATH+1];
179 if (MultiByteToWideChar (CP_UTF8, 0, path, -1,
181 && PathIsNetworkPathW (wpath))
183 # define IsRemote( fd ) ((void)fd, is_remote)
192 msg_Err (p_access, "failed to read (%m)");
195 /* Directories can be opened and read from, but only readdir() knows
196 * how to parse the data. The directory plugin will do it. */
197 if (S_ISDIR (st.st_mode))
199 if (!strcasecmp (p_access->psz_access, "fd"))
200 goto error; /* fd:// not supported for directories yet */
201 #ifdef HAVE_FDOPENDIR
202 DIR *handle = fdopendir (fd);
204 goto error; /* Uh? */
205 return DirInit (p_access, handle);
207 msg_Dbg (p_access, "ignoring directory");
212 access_sys_t *p_sys = malloc (sizeof (*p_sys));
213 if (unlikely(p_sys == NULL))
215 access_InitFields (p_access);
216 p_access->pf_read = FileRead;
217 p_access->pf_block = NULL;
218 p_access->pf_control = FileControl;
219 p_access->pf_seek = FileSeek;
220 p_access->p_sys = p_sys;
221 p_sys->i_nb_reads = 0;
223 p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
225 p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
226 p_sys->b_pace_control = true;
228 if (S_ISREG (st.st_mode))
229 p_access->info.i_size = st.st_size;
230 else if (!S_ISBLK (st.st_mode))
232 p_access->pf_seek = NoSeek;
233 p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
236 if (p_access->pf_seek != NoSeek)
238 /* Demuxers will need the beginning of the file for probing. */
239 posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
240 /* In most cases, we only read the file once. */
241 posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
242 #if defined(HAVE_FCNTL)
243 /* We'd rather use any available memory for reading ahead
244 * than for caching what we've already seen/heard */
245 # if defined(F_RDAHEAD)
246 fcntl (fd, F_RDAHEAD, 1);
248 # if defined(F_NOCACHE)
249 fcntl (fd, F_NOCACHE, 1);
260 /*****************************************************************************
261 * Close: close the target
262 *****************************************************************************/
263 void Close (vlc_object_t * p_this)
265 access_t *p_access = (access_t*)p_this;
267 if (p_access->pf_read == NULL)
273 access_sys_t *p_sys = p_access->p_sys;
280 #include <vlc_network.h>
282 /*****************************************************************************
283 * Read: standard read on a file descriptor.
284 *****************************************************************************/
285 ssize_t FileRead( access_t *p_access, uint8_t *p_buffer, size_t i_len )
287 access_sys_t *p_sys = p_access->p_sys;
292 if (p_access->pf_seek == NoSeek)
293 i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
296 i_ret = read (fd, p_buffer, i_len);
307 msg_Err (p_access, "failed to read (%m)");
308 dialog_Fatal (p_access, _("File reading failed"), "%s",
309 _("VLC could not read the file."));
310 p_access->info.b_eof = true;
315 p_access->info.i_pos += i_ret;
317 p_access->info.b_eof = true;
321 if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
322 || (p_access->info.i_pos > p_access->info.i_size))
324 #ifdef HAVE_SYS_STAT_H
327 if ((fstat (fd, &st) == 0)
328 && (p_access->info.i_size != st.st_size))
330 p_access->info.i_size = st.st_size;
331 p_access->info.i_update |= INPUT_UPDATE_SIZE;
339 /*****************************************************************************
340 * Seek: seek to a specific location in a file
341 *****************************************************************************/
342 int FileSeek (access_t *p_access, uint64_t i_pos)
344 p_access->info.i_pos = i_pos;
345 p_access->info.b_eof = false;
347 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
351 int NoSeek (access_t *p_access, uint64_t i_pos)
354 (void) p_access; (void) i_pos;
358 /*****************************************************************************
360 *****************************************************************************/
361 int FileControl( access_t *p_access, int i_query, va_list args )
363 access_sys_t *p_sys = p_access->p_sys;
370 case ACCESS_CAN_SEEK:
371 case ACCESS_CAN_FASTSEEK:
372 pb_bool = (bool*)va_arg( args, bool* );
373 *pb_bool = (p_access->pf_seek != NoSeek);
376 case ACCESS_CAN_PAUSE:
377 case ACCESS_CAN_CONTROL_PACE:
378 pb_bool = (bool*)va_arg( args, bool* );
379 *pb_bool = p_sys->b_pace_control;
383 case ACCESS_GET_PTS_DELAY:
384 pi_64 = (int64_t*)va_arg( args, int64_t * );
385 *pi_64 = p_sys->caching * INT64_C(1000);
389 case ACCESS_SET_PAUSE_STATE:
393 case ACCESS_GET_TITLE_INFO:
394 case ACCESS_SET_TITLE:
395 case ACCESS_SET_SEEKPOINT:
396 case ACCESS_SET_PRIVATE_ID_STATE:
397 case ACCESS_GET_META:
398 case ACCESS_GET_PRIVATE_ID_STATE:
399 case ACCESS_GET_CONTENT_TYPE:
403 msg_Warn( p_access, "unimplemented query %d in control", i_query );