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>
51 #if defined( WIN32 ) && !defined( UNDER_CE )
59 #if defined( WIN32 ) && !defined( UNDER_CE )
63 # define lseek _lseeki64
64 #elif defined( UNDER_CE )
68 # define read(a,b,c) fread(b,1,c,a)
69 # define close(a) fclose(a)
76 #include <vlc_charset.h>
78 /*****************************************************************************
80 *****************************************************************************/
81 static int Open ( vlc_object_t * );
82 static void Close( vlc_object_t * );
84 #define CACHING_TEXT N_("Caching value in ms")
85 #define CACHING_LONGTEXT N_( \
86 "Caching value for files. This " \
87 "value should be set in milliseconds." )
90 set_description( N_("File input") );
91 set_shortname( N_("File") );
92 set_category( CAT_INPUT );
93 set_subcategory( SUBCAT_INPUT_ACCESS );
94 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true );
95 add_obsolete_string( "file-cat" );
96 set_capability( "access", 50 );
97 add_shortcut( "file" );
98 add_shortcut( "stream" );
99 add_shortcut( "kfir" );
100 set_callbacks( Open, Close );
104 /*****************************************************************************
105 * Exported prototypes
106 *****************************************************************************/
107 static int Seek( access_t *, int64_t );
108 static ssize_t Read( access_t *, uint8_t *, size_t );
109 static int Control( access_t *, int, va_list );
111 static int open_file( access_t *, const char * );
115 unsigned int i_nb_reads;
125 /*****************************************************************************
126 * Open: open the file
127 *****************************************************************************/
128 static int Open( vlc_object_t *p_this )
130 access_t *p_access = (access_t*)p_this;
133 bool b_stdin = !strcmp (p_access->psz_path, "-");
135 /* Update default_pts to a suitable value for file access */
136 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
138 STANDARD_READ_ACCESS_INIT;
139 p_sys->i_nb_reads = 0;
140 p_sys->b_kfir = false;
141 int fd = p_sys->fd = -1;
143 if (!strcasecmp (p_access->psz_access, "stream"))
145 p_sys->b_seekable = false;
146 p_sys->b_pace_control = false;
148 else if (!strcasecmp (p_access->psz_access, "kfir"))
150 p_sys->b_seekable = false;
151 p_sys->b_pace_control = false;
152 p_sys->b_kfir = true;
156 p_sys->b_seekable = true;
157 p_sys->b_pace_control = true;
161 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
166 fd = open_file (p_access, p_access->psz_path);
168 #ifdef HAVE_SYS_STAT_H
174 msg_Err (p_access, "fstat(%d): %m", fd);
176 if (S_ISDIR (st.st_mode))
177 /* The directory plugin takes care of that */
178 msg_Dbg (p_access, "file is a directory, aborting");
194 #ifdef HAVE_SYS_STAT_H
195 p_access->info.i_size = st.st_size;
196 if (!S_ISREG (st.st_mode))
197 p_sys->b_seekable = false;
199 p_sys->b_seekable = !b_stdin;
200 # warning File size not known!
206 /*****************************************************************************
207 * Close: close the target
208 *****************************************************************************/
209 static void Close (vlc_object_t * p_this)
211 access_t *p_access = (access_t*)p_this;
212 access_sys_t *p_sys = p_access->p_sys;
218 /*****************************************************************************
219 * Read: standard read on a file descriptor.
220 *****************************************************************************/
221 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
223 access_sys_t *p_sys = p_access->p_sys;
227 #if !defined(WIN32) && !defined(UNDER_CE)
228 if( !p_sys->b_pace_control )
232 /* Find if some data is available. This won't work under Windows. */
237 if( p_access->b_die )
240 memset (&ufd, 0, sizeof (ufd));
244 i_ret = poll (&ufd, 1, 500);
248 i_ret = read (fd, p_buffer, i_len);
252 /* b_kfir ; work around a buggy poll() driver implementation */
253 while (((i_ret = read (fd, p_buffer, i_len)) == 0)
256 msleep( INPUT_ERROR_SLEEP );
261 #endif /* WIN32 || UNDER_CE */
262 /* b_pace_control || WIN32 */
263 i_ret = read( fd, p_buffer, i_len );
274 msg_Err (p_access, "read failed (%m)");
275 intf_UserFatal (p_access, false, _("File reading failed"),
276 _("VLC could not read the file."));
279 /* Delay a bit to avoid consuming all the CPU. This is particularly
280 * useful when reading from an unconnected FIFO. */
281 msleep( INPUT_ERROR_SLEEP );
286 #ifdef HAVE_SYS_STAT_H
287 if( p_access->info.i_size != 0 &&
288 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
292 if ((fstat (fd, &st) == 0)
293 && (p_access->info.i_size != st.st_size))
295 p_access->info.i_size = st.st_size;
296 p_access->info.i_update |= INPUT_UPDATE_SIZE;
302 p_access->info.i_pos += i_ret;
303 else if( i_ret == 0 )
304 p_access->info.b_eof = true;
310 /*****************************************************************************
311 * Seek: seek to a specific location in a file
312 *****************************************************************************/
313 static int Seek (access_t *p_access, int64_t i_pos)
315 p_access->info.i_pos = i_pos;
316 p_access->info.b_eof = false;
318 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
322 /*****************************************************************************
324 *****************************************************************************/
325 static int Control( access_t *p_access, int i_query, va_list args )
327 access_sys_t *p_sys = p_access->p_sys;
335 case ACCESS_CAN_SEEK:
336 case ACCESS_CAN_FASTSEEK:
337 pb_bool = (bool*)va_arg( args, bool* );
338 *pb_bool = p_sys->b_seekable;
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;
349 pi_int = (int*)va_arg( args, int * );
353 case ACCESS_GET_PTS_DELAY:
354 pi_64 = (int64_t*)va_arg( args, int64_t * );
355 *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
359 case ACCESS_SET_PAUSE_STATE:
363 case ACCESS_GET_TITLE_INFO:
364 case ACCESS_SET_TITLE:
365 case ACCESS_SET_SEEKPOINT:
366 case ACCESS_SET_PRIVATE_ID_STATE:
367 case ACCESS_GET_META:
368 case ACCESS_GET_PRIVATE_ID_STATE:
369 case ACCESS_GET_CONTENT_TYPE:
373 msg_Warn( p_access, "unimplemented query %d in control", i_query );
380 /*****************************************************************************
381 * open_file: Opens a specific file
382 *****************************************************************************/
383 static int open_file (access_t *p_access, const char *path)
386 if (!strcasecmp (p_access->psz_access, "file")
387 && ('/' == path[0]) && isalpha (path[1])
388 && (':' == path[2]) && ('/' == path[3]))
389 /* Explorer can open path such as file:/C:/ or file:///C:/
390 * hence remove leading / if found */
395 p_sys->fd = utf8_fopen( path, "rb" );
398 msg_Err( p_access, "cannot open file %s", path );
399 intf_UserFatal( p_access, false, _("File reading failed"),
400 _("VLC could not open the file \"%s\"."), path );
404 fseek( p_sys->fd, 0, SEEK_END );
405 p_access->info.i_size = ftell( p_sys->fd );
406 p_access->info.i_update |= INPUT_UPDATE_SIZE;
407 fseek( p_sys->fd, 0, SEEK_SET );
409 int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
412 msg_Err (p_access, "cannot open file %s (%m)", path);
413 intf_UserFatal (p_access, false, _("File reading failed"),
414 _("VLC could not open the file \"%s\"."), path);
418 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
419 /* We'd rather use any available memory for reading ahead
420 * than for caching what we've already seen/heard */
421 fcntl (fd, F_RDAHEAD, 1);
422 fcntl (fd, F_NOCACHE, 1);