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 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
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>
41 #ifdef HAVE_SYS_TYPES_H
42 # include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
59 #if defined( WIN32 ) && !defined( UNDER_CE )
63 # define lseek _lseeki64
64 #elif defined( UNDER_CE )
65 /* FIXME the commandline on wince is a mess */
69 #include <vlc_charset.h>
71 /*****************************************************************************
73 *****************************************************************************/
74 static int Open ( vlc_object_t * );
75 static void Close( vlc_object_t * );
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." )
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 )
96 /*****************************************************************************
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 );
103 static int open_file( access_t *, const char * );
107 unsigned int i_nb_reads;
116 /*****************************************************************************
117 * Open: open the file
118 *****************************************************************************/
119 static int Open( vlc_object_t *p_this )
121 access_t *p_access = (access_t*)p_this;
124 bool b_stdin = !strcmp (p_access->psz_path, "-");
126 /* Update default_pts to a suitable value for file access */
127 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
129 STANDARD_READ_ACCESS_INIT;
130 p_sys->i_nb_reads = 0;
132 if (!strcasecmp (p_access->psz_access, "stream"))
134 p_sys->b_seekable = false;
135 p_sys->b_pace_control = false;
139 p_sys->b_seekable = true;
140 p_sys->b_pace_control = true;
144 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
150 fd = open_file (p_access, p_access->psz_path);
154 #ifdef HAVE_SYS_STAT_H
159 msg_Err (p_access, "failed to read (%m)");
162 /* Directories can be opened and read from, but only readdir() knows
163 * how to parse the data. The directory plugin will do it. */
164 if (S_ISDIR (st.st_mode))
166 msg_Dbg (p_access, "ignoring directory");
170 p_access->info.i_size = st.st_size;
171 if (!S_ISREG (st.st_mode))
172 p_sys->b_seekable = false;
174 p_sys->b_seekable = !b_stdin;
175 # warning File size not known!
188 /*****************************************************************************
189 * Close: close the target
190 *****************************************************************************/
191 static void Close (vlc_object_t * p_this)
193 access_t *p_access = (access_t*)p_this;
194 access_sys_t *p_sys = p_access->p_sys;
201 #include <vlc_network.h>
203 /*****************************************************************************
204 * Read: standard read on a file descriptor.
205 *****************************************************************************/
206 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
208 access_sys_t *p_sys = p_access->p_sys;
213 i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
215 i_ret = read (fd, p_buffer, i_len);
227 msg_Err (p_access, "failed to read (%m)");
228 intf_UserFatal (p_access, false, _("File reading failed"),
229 _("VLC could not read the file."));
230 p_access->info.b_eof = true;
235 p_access->info.i_pos += i_ret;
237 p_access->info.b_eof = true;
241 #ifdef HAVE_SYS_STAT_H
242 if( p_access->info.i_size != 0 &&
243 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
247 if ((fstat (fd, &st) == 0)
248 && (p_access->info.i_size != st.st_size))
250 p_access->info.i_size = st.st_size;
251 p_access->info.i_update |= INPUT_UPDATE_SIZE;
259 /*****************************************************************************
260 * Seek: seek to a specific location in a file
261 *****************************************************************************/
262 static int Seek (access_t *p_access, int64_t i_pos)
264 p_access->info.i_pos = i_pos;
265 p_access->info.b_eof = false;
267 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
271 /*****************************************************************************
273 *****************************************************************************/
274 static int Control( access_t *p_access, int i_query, va_list args )
276 access_sys_t *p_sys = p_access->p_sys;
283 case ACCESS_CAN_SEEK:
284 case ACCESS_CAN_FASTSEEK:
285 pb_bool = (bool*)va_arg( args, bool* );
286 *pb_bool = p_sys->b_seekable;
289 case ACCESS_CAN_PAUSE:
290 case ACCESS_CAN_CONTROL_PACE:
291 pb_bool = (bool*)va_arg( args, bool* );
292 *pb_bool = p_sys->b_pace_control;
296 case ACCESS_GET_PTS_DELAY:
297 pi_64 = (int64_t*)va_arg( args, int64_t * );
298 *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
302 case ACCESS_SET_PAUSE_STATE:
306 case ACCESS_GET_TITLE_INFO:
307 case ACCESS_SET_TITLE:
308 case ACCESS_SET_SEEKPOINT:
309 case ACCESS_SET_PRIVATE_ID_STATE:
310 case ACCESS_GET_META:
311 case ACCESS_GET_PRIVATE_ID_STATE:
312 case ACCESS_GET_CONTENT_TYPE:
316 msg_Warn( p_access, "unimplemented query %d in control", i_query );
323 /*****************************************************************************
324 * open_file: Opens a specific file
325 *****************************************************************************/
326 static int open_file (access_t *p_access, const char *path)
329 if (!strcasecmp (p_access->psz_access, "file")
330 && ('/' == path[0]) && isalpha (path[1])
331 && (':' == path[2]) && ('/' == path[3]))
332 /* Explorer can open path such as file:/C:/ or file:///C:/
333 * hence remove leading / if found */
337 int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
340 msg_Err (p_access, "cannot open file %s (%m)", path);
341 intf_UserFatal (p_access, false, _("File reading failed"),
342 _("VLC could not open the file \"%s\"."), path);
346 #if defined(HAVE_FCNTL)
347 /* We'd rather use any available memory for reading ahead
348 * than for caching what we've already seen/heard */
349 # if defined(F_RDAHEAD)
350 fcntl (fd, F_RDAHEAD, 1);
352 # if defined(F_NOCACHE)
353 fcntl (fd, F_NOCACHE, 1);