1 /*****************************************************************************
2 * file.c: file input (file: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2006 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 *****************************************************************************/
30 #include <vlc_input.h>
31 #include <vlc_access.h>
32 #include <vlc_interface.h>
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
39 # include <sys/stat.h>
45 #if defined( WIN32 ) && !defined( UNDER_CE )
52 #if defined( WIN32 ) && !defined( UNDER_CE )
56 # define lseek _lseeki64
57 #elif defined( UNDER_CE )
61 # define read(a,b,c) fread(b,1,c,a)
62 # define close(a) fclose(a)
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." )
81 #define CAT_TEXT N_("Concatenate with additional files")
82 #define CAT_LONGTEXT N_( \
83 "Play split files as if they were part of a unique file. " \
84 "You need to specify a comma-separated list of files." )
87 set_description( _("File input") );
88 set_shortname( _("File") );
89 set_category( CAT_INPUT );
90 set_subcategory( SUBCAT_INPUT_ACCESS );
91 add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
92 add_obsolete_string( "file-cat" );
93 set_capability( "access2", 50 );
94 add_shortcut( "file" );
95 add_shortcut( "stream" );
96 add_shortcut( "kfir" );
97 set_callbacks( Open, Close );
101 /*****************************************************************************
102 * Exported prototypes
103 *****************************************************************************/
104 static int Seek( access_t *, int64_t );
105 static int Read( access_t *, uint8_t *, int );
106 static int Control( access_t *, int, va_list );
108 static int open_file( access_t *, const char * );
112 unsigned int i_nb_reads;
118 vlc_bool_t b_seekable;
119 vlc_bool_t b_pace_control;
122 /*****************************************************************************
123 * Open: open the file
124 *****************************************************************************/
125 static int Open( vlc_object_t *p_this )
127 access_t *p_access = (access_t*)p_this;
130 vlc_bool_t b_stdin = !strcmp (p_access->psz_path, "-");
132 /* Update default_pts to a suitable value for file access */
133 var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
135 STANDARD_READ_ACCESS_INIT;
136 p_sys->i_nb_reads = 0;
137 p_sys->b_kfir = VLC_FALSE;
138 int fd = p_sys->fd = -1;
140 if (!strcasecmp (p_access->psz_access, "stream"))
142 p_sys->b_seekable = VLC_FALSE;
143 p_sys->b_pace_control = VLC_FALSE;
145 else if (!strcasecmp (p_access->psz_access, "kfir"))
147 p_sys->b_seekable = VLC_FALSE;
148 p_sys->b_pace_control = VLC_FALSE;
149 p_sys->b_kfir = VLC_TRUE;
153 p_sys->b_seekable = VLC_TRUE;
154 p_sys->b_pace_control = VLC_TRUE;
158 msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
163 fd = open_file (p_access, p_access->psz_path);
165 #ifdef HAVE_SYS_STAT_H
171 msg_Err (p_access, "fstat(%d): %s", fd, strerror (errno));
173 if (S_ISDIR (st.st_mode))
174 /* The directory plugin takes care of that */
175 msg_Dbg (p_access, "file is a directory, aborting");
191 #ifdef HAVE_SYS_STAT_H
192 p_access->info.i_size = st.st_size;
193 if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
194 && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
195 p_sys->b_seekable = VLC_FALSE;
197 p_sys->b_seekable = !b_stdin;
198 # warning File size not known!
201 if (p_sys->b_seekable && (p_access->info.i_size == 0))
203 /* FIXME that's bad because all others access will be probed */
204 msg_Err (p_access, "file is empty, aborting");
212 /*****************************************************************************
213 * Close: close the target
214 *****************************************************************************/
215 static void Close (vlc_object_t * p_this)
217 access_t *p_access = (access_t*)p_this;
218 access_sys_t *p_sys = p_access->p_sys;
224 /*****************************************************************************
225 * Read: standard read on a file descriptor.
226 *****************************************************************************/
227 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
229 access_sys_t *p_sys = p_access->p_sys;
233 #if !defined(WIN32) && !defined(UNDER_CE)
234 if( !p_sys->b_pace_control )
238 /* Find if some data is available. This won't work under Windows. */
243 if( p_access->b_die )
246 memset (&ufd, 0, sizeof (ufd));
250 i_ret = poll (&ufd, 1, 500);
254 i_ret = read (fd, p_buffer, i_len);
258 /* b_kfir ; work around a buggy poll() driver implementation */
259 while (((i_ret = read (fd, p_buffer, i_len)) == 0)
262 msleep( INPUT_ERROR_SLEEP );
267 #endif /* WIN32 || UNDER_CE */
268 /* b_pace_control || WIN32 */
269 i_ret = read( fd, p_buffer, i_len );
280 msg_Err (p_access, "read failed (%s)", strerror (errno));
281 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
282 _("VLC could not read file \"%s\"."),
286 /* Delay a bit to avoid consuming all the CPU. This is particularly
287 * useful when reading from an unconnected FIFO. */
288 msleep( INPUT_ERROR_SLEEP );
293 #ifdef HAVE_SYS_STAT_H
294 if( p_access->info.i_size != 0 &&
295 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
299 if ((fstat (fd, &st) == 0)
300 && (p_access->info.i_size != st.st_size))
302 p_access->info.i_size = st.st_size;
303 p_access->info.i_update |= INPUT_UPDATE_SIZE;
309 p_access->info.i_pos += i_ret;
310 else if( i_ret == 0 )
311 p_access->info.b_eof = VLC_TRUE;
316 /*****************************************************************************
317 * Seek: seek to a specific location in a file
318 *****************************************************************************/
319 static int Seek (access_t *p_access, int64_t i_pos)
321 if (i_pos > p_access->info.i_size)
323 msg_Err (p_access, "seeking too far");
324 i_pos = p_access->info.i_size;
328 msg_Err (p_access, "seeking too early");
332 p_access->info.i_pos = i_pos;
333 p_access->info.b_eof = VLC_FALSE;
335 /* Determine which file we need to access */
336 lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
340 /*****************************************************************************
342 *****************************************************************************/
343 static int Control( access_t *p_access, int i_query, va_list args )
345 access_sys_t *p_sys = p_access->p_sys;
353 case ACCESS_CAN_SEEK:
354 case ACCESS_CAN_FASTSEEK:
355 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
356 *pb_bool = p_sys->b_seekable;
359 case ACCESS_CAN_PAUSE:
360 case ACCESS_CAN_CONTROL_PACE:
361 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
362 *pb_bool = p_sys->b_pace_control;
367 pi_int = (int*)va_arg( args, int * );
371 case ACCESS_GET_PTS_DELAY:
372 pi_64 = (int64_t*)va_arg( args, int64_t * );
373 *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
377 case ACCESS_SET_PAUSE_STATE:
381 case ACCESS_GET_TITLE_INFO:
382 case ACCESS_SET_TITLE:
383 case ACCESS_SET_SEEKPOINT:
384 case ACCESS_SET_PRIVATE_ID_STATE:
385 case ACCESS_GET_META:
389 msg_Warn( p_access, "unimplemented query in control" );
397 static char *expand_path (const access_t *p_access, const char *path)
399 if (strncmp (path, "~/", 2) == 0)
403 // TODO: we should also support the ~cmassiot/ syntax
404 if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
410 if (!strcasecmp (p_access->psz_access, "file")
411 && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
412 // Explorer can open path such as file:/C:/ or file:///C:/
413 // hence remove leading / if found
414 return strdup (path + 1);
417 return strdup (path);
421 /*****************************************************************************
422 * open_file: Opens a specific file
423 *****************************************************************************/
424 static int open_file (access_t *p_access, const char *psz_name)
426 char *path = expand_path (p_access, psz_name);
429 p_sys->fd = utf8_fopen( path, "rb" );
432 msg_Err( p_access, "cannot open file %s", psz_name );
433 intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"),
434 _("VLC could not open file \"%s\"."), psz_name );
439 fseek( p_sys->fd, 0, SEEK_END );
440 p_access->info.i_size = ftell( p_sys->fd );
441 p_access->info.i_update |= INPUT_UPDATE_SIZE;
442 fseek( p_sys->fd, 0, SEEK_SET );
444 int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
448 msg_Err (p_access, "cannot open file %s (%s)", psz_name,
450 intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
451 _("VLC could not open file \"%s\" (%s)."),
452 psz_name, strerror (errno));
456 # if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
457 /* We'd rather use any available memory for reading ahead
458 * than for caching what we've already seen/heard */
459 fcntl (fd, F_RDAHEAD, 1);
460 fcntl (fd, F_NOCACHE, 1);