Remove redumdant fcntl() calls
[vlc.git] / 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 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_input.h>
36 #include <vlc_access.h>
37 #include <vlc_interface.h>
38
39 #include <assert.h>
40 #include <errno.h>
41 #ifdef HAVE_SYS_TYPES_H
42 #   include <sys/types.h>
43 #endif
44 #ifdef HAVE_SYS_STAT_H
45 #   include <sys/stat.h>
46 #endif
47 #ifdef HAVE_FCNTL_H
48 #   include <fcntl.h>
49 #endif
50
51 #if defined( WIN32 )
52 #   include <io.h>
53 #   include <ctype.h>
54 #else
55 #   include <unistd.h>
56 #   include <poll.h>
57 #endif
58
59 #if defined( WIN32 ) && !defined( UNDER_CE )
60 #   ifdef lseek
61 #      undef lseek
62 #   endif
63 #   define lseek _lseeki64
64 #elif defined( UNDER_CE )
65 /* FIXME the commandline on wince is a mess */
66 # define dup(a) -1
67 #endif
68
69 #include <vlc_charset.h>
70
71 /*****************************************************************************
72  * Module descriptor
73  *****************************************************************************/
74 static int  Open ( vlc_object_t * );
75 static void Close( vlc_object_t * );
76
77 #define CACHING_TEXT N_("Caching value in ms")
78 #define CACHING_LONGTEXT N_( \
79     "Caching value for files. This " \
80     "value should be set in milliseconds." )
81
82 vlc_module_begin ()
83     set_description( N_("File input") )
84     set_shortname( N_("File") )
85     set_category( CAT_INPUT )
86     set_subcategory( SUBCAT_INPUT_ACCESS )
87     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
88     add_obsolete_string( "file-cat" )
89     set_capability( "access", 50 )
90     add_shortcut( "file" )
91     add_shortcut( "stream" )
92     set_callbacks( Open, Close )
93 vlc_module_end ()
94
95
96 /*****************************************************************************
97  * Exported prototypes
98  *****************************************************************************/
99 static int  Seek( access_t *, int64_t );
100 static ssize_t Read( access_t *, uint8_t *, size_t );
101 static int  Control( access_t *, int, va_list );
102
103 static int  open_file( access_t *, const char * );
104
105 struct access_sys_t
106 {
107     unsigned int i_nb_reads;
108
109     int fd;
110
111     /* */
112     bool b_seekable;
113     bool b_pace_control;
114 };
115
116 /*****************************************************************************
117  * Open: open the file
118  *****************************************************************************/
119 static int Open( vlc_object_t *p_this )
120 {
121     access_t     *p_access = (access_t*)p_this;
122     access_sys_t *p_sys;
123
124     bool    b_stdin = !strcmp (p_access->psz_path, "-");
125
126     /* Update default_pts to a suitable value for file access */
127     var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
128
129     STANDARD_READ_ACCESS_INIT;
130     p_sys->i_nb_reads = 0;
131     int fd = p_sys->fd = -1;
132
133     if (!strcasecmp (p_access->psz_access, "stream"))
134     {
135         p_sys->b_seekable = false;
136         p_sys->b_pace_control = false;
137     }
138     else
139     {
140         p_sys->b_seekable = true;
141         p_sys->b_pace_control = true;
142     }
143
144     /* Open file */
145     msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
146
147     if (b_stdin)
148         fd = dup (0);
149     else
150         fd = open_file (p_access, p_access->psz_path);
151
152 #ifdef HAVE_SYS_STAT_H
153     struct stat st;
154
155     while (fd != -1)
156     {
157         if (fstat (fd, &st))
158             msg_Err (p_access, "fstat(%d): %m", fd);
159         else
160         if (S_ISDIR (st.st_mode))
161             /* The directory plugin takes care of that */
162             msg_Dbg (p_access, "file is a directory, aborting");
163         else
164             break; // success
165
166         close (fd);
167         fd = -1;
168     }
169 #endif
170
171     if (fd == -1)
172     {
173         free (p_sys);
174         return VLC_EGENERIC;
175     }
176     p_sys->fd = fd;
177
178 #ifdef HAVE_SYS_STAT_H
179     p_access->info.i_size = st.st_size;
180     if (!S_ISREG (st.st_mode))
181         p_sys->b_seekable = false;
182 #else
183     p_sys->b_seekable = !b_stdin;
184 # warning File size not known!
185 #endif
186
187     return VLC_SUCCESS;
188 }
189
190 /*****************************************************************************
191  * Close: close the target
192  *****************************************************************************/
193 static void Close (vlc_object_t * p_this)
194 {
195     access_t     *p_access = (access_t*)p_this;
196     access_sys_t *p_sys = p_access->p_sys;
197
198     close (p_sys->fd);
199     free (p_sys);
200 }
201
202
203 #include <vlc_network.h>
204
205 /*****************************************************************************
206  * Read: standard read on a file descriptor.
207  *****************************************************************************/
208 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
209 {
210     access_sys_t *p_sys = p_access->p_sys;
211     int fd = p_sys->fd;
212     ssize_t i_ret;
213
214 #ifndef WIN32
215     i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
216 #else
217     i_ret = read (fd, p_buffer, i_len);
218 #endif
219
220     if( i_ret < 0 )
221     {
222         switch (errno)
223         {
224             case EINTR:
225             case EAGAIN:
226                 break;
227
228             default:
229                 msg_Err (p_access, "read failed (%m)");
230                 intf_UserFatal (p_access, false, _("File reading failed"),
231                                 _("VLC could not read the file."));
232                 p_access->info.b_eof = true;
233                 return 0;
234         }
235     }
236     else if( i_ret > 0 )
237         p_access->info.i_pos += i_ret;
238     else
239         p_access->info.b_eof = true;
240
241     p_sys->i_nb_reads++;
242
243 #ifdef HAVE_SYS_STAT_H
244     if( p_access->info.i_size != 0 &&
245         (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
246     {
247         struct stat st;
248
249         if ((fstat (fd, &st) == 0)
250          && (p_access->info.i_size != st.st_size))
251         {
252             p_access->info.i_size = st.st_size;
253             p_access->info.i_update |= INPUT_UPDATE_SIZE;
254         }
255     }
256 #endif
257     return i_ret;
258 }
259
260
261 /*****************************************************************************
262  * Seek: seek to a specific location in a file
263  *****************************************************************************/
264 static int Seek (access_t *p_access, int64_t i_pos)
265 {
266     p_access->info.i_pos = i_pos;
267     p_access->info.b_eof = false;
268
269     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
270     return VLC_SUCCESS;
271 }
272
273 /*****************************************************************************
274  * Control:
275  *****************************************************************************/
276 static int Control( access_t *p_access, int i_query, va_list args )
277 {
278     access_sys_t *p_sys = p_access->p_sys;
279     bool    *pb_bool;
280     int64_t *pi_64;
281
282     switch( i_query )
283     {
284         /* */
285         case ACCESS_CAN_SEEK:
286         case ACCESS_CAN_FASTSEEK:
287             pb_bool = (bool*)va_arg( args, bool* );
288             *pb_bool = p_sys->b_seekable;
289             break;
290
291         case ACCESS_CAN_PAUSE:
292         case ACCESS_CAN_CONTROL_PACE:
293             pb_bool = (bool*)va_arg( args, bool* );
294             *pb_bool = p_sys->b_pace_control;
295             break;
296
297         /* */
298         case ACCESS_GET_PTS_DELAY:
299             pi_64 = (int64_t*)va_arg( args, int64_t * );
300             *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
301             break;
302
303         /* */
304         case ACCESS_SET_PAUSE_STATE:
305             /* Nothing to do */
306             break;
307
308         case ACCESS_GET_TITLE_INFO:
309         case ACCESS_SET_TITLE:
310         case ACCESS_SET_SEEKPOINT:
311         case ACCESS_SET_PRIVATE_ID_STATE:
312         case ACCESS_GET_META:
313         case ACCESS_GET_PRIVATE_ID_STATE:
314         case ACCESS_GET_CONTENT_TYPE:
315             return VLC_EGENERIC;
316
317         default:
318             msg_Warn( p_access, "unimplemented query %d in control", i_query );
319             return VLC_EGENERIC;
320
321     }
322     return VLC_SUCCESS;
323 }
324
325 /*****************************************************************************
326  * open_file: Opens a specific file
327  *****************************************************************************/
328 static int open_file (access_t *p_access, const char *path)
329 {
330 #if defined(WIN32)
331     if (!strcasecmp (p_access->psz_access, "file")
332       && ('/' == path[0]) && isalpha (path[1])
333       && (':' == path[2]) && ('/' == path[3]))
334         /* Explorer can open path such as file:/C:/ or file:///C:/
335          * hence remove leading / if found */
336         path++;
337 #endif
338
339     int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
340     if (fd == -1)
341     {
342         msg_Err (p_access, "cannot open file %s (%m)", path);
343         intf_UserFatal (p_access, false, _("File reading failed"),
344                         _("VLC could not open the file \"%s\"."), path);
345         return -1;
346     }
347
348 #if defined(HAVE_FCNTL)
349     /* We'd rather use any available memory for reading ahead
350      * than for caching what we've already seen/heard */
351 # if defined(F_RDAHEAD)
352     fcntl (fd, F_RDAHEAD, 1);
353 # endif
354 # if defined(F_NOCACHE)
355     fcntl (fd, F_NOCACHE, 1);
356 # endif
357 #endif
358
359     return fd;
360 }