]> git.sesse.net Git - vlc/blob - modules/access/file.c
file: initialize access_t after the open operation is succesful
[vlc] / modules / access / file.c
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
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Rémi Denis-Courmont <rem # videolan # org>
10  *
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.
15  *
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.
20  *
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  *****************************************************************************/
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <vlc_common.h>
31 #include "fs.h"
32 #include <vlc_input.h>
33 #include <vlc_access.h>
34 #include <vlc_dialog.h>
35
36 #include <assert.h>
37 #include <errno.h>
38 #ifdef HAVE_SYS_TYPES_H
39 #   include <sys/types.h>
40 #endif
41 #ifdef HAVE_SYS_STAT_H
42 #   include <sys/stat.h>
43 #endif
44 #ifdef HAVE_FCNTL_H
45 #   include <fcntl.h>
46 #endif
47 #if defined (__linux__)
48 #   include <sys/vfs.h>
49 #ifdef HAVE_LINUX_MAGIC_H
50 #   include <linux/magic.h>
51 #endif
52 #elif defined (HAVE_SYS_MOUNT_H)
53 #   include <sys/param.h>
54 #   include <sys/mount.h>
55 #endif
56
57 #if defined( WIN32 )
58 #   include <io.h>
59 #   include <ctype.h>
60 #   include <shlwapi.h>
61 #else
62 #   include <unistd.h>
63 #   include <poll.h>
64 #endif
65
66 #if defined( WIN32 ) && !defined( UNDER_CE )
67 #   ifdef lseek
68 #      undef lseek
69 #   endif
70 #   define lseek _lseeki64
71 #elif defined( UNDER_CE )
72 /* FIXME the commandline on wince is a mess */
73 # define dup(a) -1
74 # define PathIsNetworkPathW(wpath) (! wcsncmp(wpath, L"\\\\", 2))
75 #endif
76
77 #include <vlc_charset.h>
78
79 struct access_sys_t
80 {
81     unsigned int i_nb_reads;
82
83     int fd;
84
85     /* */
86     unsigned caching;
87     bool b_pace_control;
88 };
89
90 #ifndef WIN32
91 static bool IsRemote (int fd)
92 {
93 #ifdef HAVE_FSTATFS
94     struct statfs stf;
95
96     if (fstatfs (fd, &stf))
97         return false;
98
99 #if defined(MNT_LOCAL)
100     return !(stf.f_flags & MNT_LOCAL);
101
102 #else
103 #   ifdef HAVE_LINUX_MAGIC_H
104     switch (stf.f_type)
105     {
106         case AFS_SUPER_MAGIC:
107         case CODA_SUPER_MAGIC:
108         case NCP_SUPER_MAGIC:
109         case NFS_SUPER_MAGIC:
110         case SMB_SUPER_MAGIC:
111         case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
112             return true;
113     }
114     return false;
115 #   endif
116 #endif
117 #else /* !HAVE_FSTATFS */
118     (void)fd;
119     return false;
120
121 #endif
122 }
123 #endif
124
125 #ifndef HAVE_POSIX_FADVISE
126 # define posix_fadvise(fd, off, len, adv)
127 #endif
128
129 /*****************************************************************************
130  * Open: open the file
131  *****************************************************************************/
132 int Open( vlc_object_t *p_this )
133 {
134     access_t     *p_access = (access_t*)p_this;
135     const char   *path = p_access->psz_path;
136 #ifdef WIN32
137     bool is_remote = false;
138 #endif
139
140     /* Open file */
141     int fd = -1;
142
143     if (!strcasecmp (p_access->psz_access, "fd"))
144         fd = dup (atoi (path));
145     else if (!strcmp (path, "-"))
146         fd = dup (0);
147     else
148     {
149         msg_Dbg (p_access, "opening file `%s'", path);
150         fd = utf8_open (path, O_RDONLY | O_NONBLOCK);
151         if (fd == -1)
152         {
153             msg_Err (p_access, "cannot open file %s (%m)", path);
154             dialog_Fatal (p_access, _("File reading failed"),
155                           _("VLC could not open the file \"%s\"."), path);
156         }
157
158 #ifdef WIN32
159         wchar_t wpath[MAX_PATH+1];
160         if (MultiByteToWideChar (CP_UTF8, 0, path, -1,
161                                  wpath, MAX_PATH)
162          && PathIsNetworkPathW (wpath))
163             is_remote = true;
164 # define IsRemote( fd ) ((void)fd, is_remote)
165 #endif
166     }
167     if (fd == -1)
168         return VLC_EGENERIC;
169
170     struct stat st;
171     if (fstat (fd, &st))
172     {
173         msg_Err (p_access, "failed to read (%m)");
174         goto error;
175     }
176     /* Directories can be opened and read from, but only readdir() knows
177      * how to parse the data. The directory plugin will do it. */
178     if (S_ISDIR (st.st_mode))
179     {
180         msg_Dbg (p_access, "ignoring directory");
181         goto error;
182     }
183
184     access_sys_t *p_sys = malloc (sizeof (*p_sys));
185     if (unlikely(p_sys == NULL))
186         goto error;
187     access_InitFields (p_access);
188     p_access->pf_read = FileRead;
189     p_access->pf_block = NULL;
190     p_access->pf_control = FileControl;
191     p_access->pf_seek = FileSeek;
192     p_access->p_sys = p_sys;
193     p_sys->i_nb_reads = 0;
194     p_sys->fd = fd;
195     p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
196     if (IsRemote(fd))
197         p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
198     p_sys->b_pace_control = true;
199
200     if (S_ISREG (st.st_mode))
201         p_access->info.i_size = st.st_size;
202     else if (!S_ISBLK (st.st_mode))
203     {
204         p_access->pf_seek = NoSeek;
205         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
206     }
207
208     if (p_access->pf_seek != NoSeek)
209     {
210         /* Demuxers will need the beginning of the file for probing. */
211         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
212         /* In most cases, we only read the file once. */
213         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
214 #if defined(HAVE_FCNTL)
215         /* We'd rather use any available memory for reading ahead
216          * than for caching what we've already seen/heard */
217 # if defined(F_RDAHEAD)
218         fcntl (fd, F_RDAHEAD, 1);
219 # endif
220 # if defined(F_NOCACHE)
221         fcntl (fd, F_NOCACHE, 1);
222 # endif
223 #endif
224     }
225     return VLC_SUCCESS;
226
227 error:
228     close (fd);
229     return VLC_EGENERIC;
230 }
231
232 /*****************************************************************************
233  * Close: close the target
234  *****************************************************************************/
235 void Close (vlc_object_t * p_this)
236 {
237     access_t     *p_access = (access_t*)p_this;
238     access_sys_t *p_sys = p_access->p_sys;
239
240     close (p_sys->fd);
241     free (p_sys);
242 }
243
244
245 #include <vlc_network.h>
246
247 /*****************************************************************************
248  * Read: standard read on a file descriptor.
249  *****************************************************************************/
250 ssize_t FileRead( access_t *p_access, uint8_t *p_buffer, size_t i_len )
251 {
252     access_sys_t *p_sys = p_access->p_sys;
253     int fd = p_sys->fd;
254     ssize_t i_ret;
255
256 #ifndef WIN32
257     if (p_access->pf_seek == NoSeek)
258         i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
259     else
260 #endif
261         i_ret = read (fd, p_buffer, i_len);
262
263     if( i_ret < 0 )
264     {
265         switch (errno)
266         {
267             case EINTR:
268             case EAGAIN:
269                 break;
270
271             default:
272                 msg_Err (p_access, "failed to read (%m)");
273                 dialog_Fatal (p_access, _("File reading failed"), "%s",
274                               _("VLC could not read the file."));
275                 p_access->info.b_eof = true;
276                 return 0;
277         }
278     }
279     else if( i_ret > 0 )
280         p_access->info.i_pos += i_ret;
281     else
282         p_access->info.b_eof = true;
283
284     p_sys->i_nb_reads++;
285
286     if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
287      || (p_access->info.i_pos > p_access->info.i_size))
288     {
289 #ifdef HAVE_SYS_STAT_H
290         struct stat st;
291
292         if ((fstat (fd, &st) == 0)
293          && (p_access->info.i_size != st.st_size))
294         {
295             p_access->info.i_size = st.st_size;
296             p_access->info.i_update |= INPUT_UPDATE_SIZE;
297         }
298 #endif
299     }
300     return i_ret;
301 }
302
303
304 /*****************************************************************************
305  * Seek: seek to a specific location in a file
306  *****************************************************************************/
307 int FileSeek (access_t *p_access, int64_t i_pos)
308 {
309     p_access->info.i_pos = i_pos;
310     p_access->info.b_eof = false;
311
312     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
313     return VLC_SUCCESS;
314 }
315
316 int NoSeek (access_t *p_access, int64_t i_pos)
317 {
318     /* assert(0); ?? */
319     (void) p_access; (void) i_pos;
320     return VLC_EGENERIC;
321 }
322
323 /*****************************************************************************
324  * Control:
325  *****************************************************************************/
326 int FileControl( access_t *p_access, int i_query, va_list args )
327 {
328     access_sys_t *p_sys = p_access->p_sys;
329     bool    *pb_bool;
330     int64_t *pi_64;
331
332     switch( i_query )
333     {
334         /* */
335         case ACCESS_CAN_SEEK:
336         case ACCESS_CAN_FASTSEEK:
337             pb_bool = (bool*)va_arg( args, bool* );
338             *pb_bool = (p_access->pf_seek != NoSeek);
339             break;
340
341         case ACCESS_CAN_PAUSE:
342         case ACCESS_CAN_CONTROL_PACE:
343             pb_bool = (bool*)va_arg( args, bool* );
344             *pb_bool = p_sys->b_pace_control;
345             break;
346
347         /* */
348         case ACCESS_GET_PTS_DELAY:
349             pi_64 = (int64_t*)va_arg( args, int64_t * );
350             *pi_64 = p_sys->caching * INT64_C(1000);
351             break;
352
353         /* */
354         case ACCESS_SET_PAUSE_STATE:
355             /* Nothing to do */
356             break;
357
358         case ACCESS_GET_TITLE_INFO:
359         case ACCESS_SET_TITLE:
360         case ACCESS_SET_SEEKPOINT:
361         case ACCESS_SET_PRIVATE_ID_STATE:
362         case ACCESS_GET_META:
363         case ACCESS_GET_PRIVATE_ID_STATE:
364         case ACCESS_GET_CONTENT_TYPE:
365             return VLC_EGENERIC;
366
367         default:
368             msg_Warn( p_access, "unimplemented query %d in control", i_query );
369             return VLC_EGENERIC;
370
371     }
372     return VLC_SUCCESS;
373 }