98553b64a88c2a06ac463d540fd31b12f12013db
[vlc.git] / modules / access / file.c
1 /*****************************************************************************
2  * file.c: file input (file: access plug-in)
3  *****************************************************************************
4  * Copyright (C) 2001, 2002 VideoLAN
5  * $Id: file.c,v 1.14 2003/03/24 17:15:29 gbazin Exp $
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  * 
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <vlc/vlc.h>
28 #include <vlc/input.h>
29
30 #include <stdlib.h>
31 #include <string.h>
32 #ifdef HAVE_SYS_TYPES_H
33 #   include <sys/types.h>
34 #endif
35 #ifdef HAVE_SYS_STAT_H
36 #   include <sys/stat.h>
37 #endif
38 #ifdef HAVE_ERRNO_H
39 #   include <errno.h>
40 #endif
41 #ifdef HAVE_FCNTL_H
42 #   include <fcntl.h>
43 #endif
44
45 #ifdef HAVE_UNISTD_H
46 #   include <unistd.h>
47 #elif defined( WIN32 ) && !defined( UNDER_CE )
48 #   include <io.h>
49 #endif
50
51 #if defined( WIN32 ) && !defined( UNDER_CE )
52 #   ifdef lseek
53 #       undef lseek
54 #   endif
55 #   define lseek _lseeki64
56 #endif
57 /*****************************************************************************
58  * Exported prototypes
59  *****************************************************************************/
60 static int     Open   ( vlc_object_t * );
61 static void    Close  ( vlc_object_t * );
62
63 static void    Seek   ( input_thread_t *, off_t );
64 static ssize_t Read   ( input_thread_t *, byte_t *, size_t );
65
66 /*****************************************************************************
67  * Module descriptor
68  *****************************************************************************/
69 #define CACHING_TEXT N_("caching value in ms")
70 #define CACHING_LONGTEXT N_( \
71     "Allows you to modify the default caching value for file streams. This " \
72     "value should be set in miliseconds units." )
73
74 vlc_module_begin();
75     set_description( _("Standard filesystem file reading") );
76     add_category_hint( N_("file"), NULL, VLC_TRUE );
77     add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
78     set_capability( "access", 50 );
79     add_shortcut( "file" );
80     add_shortcut( "stream" );
81     set_callbacks( Open, Close );
82 vlc_module_end();
83  
84 /*****************************************************************************
85  * _input_socket_t: private access plug-in data, modified to add private
86  *                  fields
87  *****************************************************************************/
88 typedef struct _input_socket_s
89 {
90     input_socket_t      _socket;
91
92     unsigned int        i_nb_reads;
93 } _input_socket_t;
94
95 /*****************************************************************************
96  * Open: open the file
97  *****************************************************************************/
98 static int Open( vlc_object_t *p_this )
99 {
100     input_thread_t *    p_input = (input_thread_t *)p_this;
101     char *              psz_name = p_input->psz_name;
102 #ifdef HAVE_SYS_STAT_H
103     int                 i_stat;
104     struct stat         stat_info;                                              
105 #endif
106     _input_socket_t *   p_access_data;
107     vlc_bool_t          b_stdin;
108
109     p_input->i_mtu = 0;
110
111     b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
112
113 #ifdef HAVE_SYS_STAT_H
114     if( !b_stdin && (i_stat = stat( psz_name, &stat_info )) == (-1) )
115     {
116 #   ifdef HAVE_ERRNO_H
117         msg_Warn( p_input, "cannot stat() file `%s' (%s)",
118                   psz_name, strerror(errno));
119 #   else
120         msg_Warn( p_input, "cannot stat() file `%s'", psz_name );
121 #   endif
122         return VLC_EGENERIC;
123     }
124 #endif
125
126     p_input->pf_read = Read;
127     p_input->pf_set_program = input_SetProgram;
128     p_input->pf_set_area = NULL;
129     p_input->pf_seek = Seek;
130
131     vlc_mutex_lock( &p_input->stream.stream_lock );
132
133     if( *p_input->psz_access && !strncmp( p_input->psz_access, "stream", 7 ) )
134     {
135         /* stream:%s */
136         p_input->stream.b_pace_control = 0;
137         p_input->stream.b_seekable = 0;
138         p_input->stream.p_selected_area->i_size = 0;
139     }
140     else
141     {
142         /* file:%s or %s */
143         p_input->stream.b_pace_control = 1;
144
145         if( b_stdin )
146         {
147             p_input->stream.b_seekable = 0;
148             p_input->stream.p_selected_area->i_size = 0;
149         }
150 #ifdef UNDER_CE
151         else if( VLC_TRUE )
152         {
153             /* We'll update i_size after it's been opened */
154             p_input->stream.b_seekable = 1;
155         }
156 #elif defined( HAVE_SYS_STAT_H )
157         else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode)
158                   || S_ISBLK(stat_info.st_mode) )
159         {
160             p_input->stream.b_seekable = 1;
161             p_input->stream.p_selected_area->i_size = stat_info.st_size;
162         }
163         else if( S_ISFIFO(stat_info.st_mode)
164 #   if !defined( SYS_BEOS ) && !defined( WIN32 )
165                   || S_ISSOCK(stat_info.st_mode)
166 #   endif
167                )
168         {
169             p_input->stream.b_seekable = 0;
170             p_input->stream.p_selected_area->i_size = 0;
171         }
172 #endif
173         else
174         {
175             vlc_mutex_unlock( &p_input->stream.stream_lock );
176             msg_Err( p_input, "unknown file type for `%s'", psz_name );
177             return VLC_EGENERIC;
178         }
179     }
180  
181     p_input->stream.p_selected_area->i_tell = 0;
182     p_input->stream.i_method = INPUT_METHOD_FILE;
183     vlc_mutex_unlock( &p_input->stream.stream_lock );
184  
185     msg_Dbg( p_input, "opening file `%s'", psz_name );
186     p_access_data = malloc( sizeof(_input_socket_t) );
187     p_input->p_access_data = (void *)p_access_data;
188     if( p_access_data == NULL )
189     {
190         msg_Err( p_input, "out of memory" );
191         return VLC_ENOMEM;
192     }
193
194     p_access_data->i_nb_reads = 0;
195     if( b_stdin )
196     {
197         p_access_data->_socket.i_handle = 0;
198     }
199     else
200     {
201 #ifdef UNDER_CE
202         wchar_t psz_filename[MAX_PATH];
203         MultiByteToWideChar( CP_ACP, 0, psz_name, -1, psz_filename, MAX_PATH );
204
205         p_access_data->_socket.i_handle = (int)CreateFile( psz_filename,
206             GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 
207             FILE_ATTRIBUTE_NORMAL, NULL );
208
209         if( (HANDLE)p_access_data->_socket.i_handle == INVALID_HANDLE_VALUE )
210         {
211             msg_Err( p_input, "cannot open file %s", psz_name );
212             free( p_access_data );
213             return VLC_EGENERIC;
214         }
215         p_input->stream.p_selected_area->i_size =
216                 GetFileSize( (HANDLE)p_access_data->_socket.i_handle, NULL );
217 #else
218         p_access_data->_socket.i_handle = open( psz_name,
219                                                 O_NONBLOCK /*| O_LARGEFILE*/ );
220         if( p_access_data->_socket.i_handle == -1 )
221         {
222 #   ifdef HAVE_ERRNO_H
223             msg_Err( p_input, "cannot open file %s (%s)", psz_name,
224                               strerror(errno) );
225 #   else
226             msg_Err( p_input, "cannot open file %s", psz_name );
227 #   endif
228             free( p_access_data );
229             return VLC_EGENERIC;
230         }
231 #endif
232     }
233
234     if ( p_input->stream.b_seekable
235           && !p_input->stream.p_selected_area->i_size )
236     {
237         msg_Err( p_input, "file %s is empty, aborting", psz_name );
238         free( p_access_data );
239         return VLC_EGENERIC;
240     }
241
242     /* Update default_pts to a suitable value for file access */
243     p_input->i_pts_delay = config_GetInt( p_input, "file-caching" ) * 1000;
244
245     return VLC_SUCCESS;
246 }
247
248 /*****************************************************************************
249  * Close: close the target
250  *****************************************************************************/
251 static void Close( vlc_object_t * p_this )
252 {
253     input_thread_t * p_input = (input_thread_t *)p_this;
254     input_socket_t * p_access_data = (input_socket_t *)p_input->p_access_data;
255
256     msg_Info( p_input, "closing `%s/%s://%s'", 
257               p_input->psz_access, p_input->psz_demux, p_input->psz_name );
258  
259 #ifdef UNDER_CE
260     CloseHandle( (HANDLE)p_access_data->i_handle );
261 #else
262     close( p_access_data->i_handle );
263 #endif
264
265     free( p_access_data );
266 }
267
268 /*****************************************************************************
269  * Read: standard read on a file descriptor.
270  *****************************************************************************/
271 static ssize_t Read( input_thread_t * p_input, byte_t * p_buffer, size_t i_len )
272 {
273     _input_socket_t * p_access_data = (_input_socket_t *)p_input->p_access_data;
274     ssize_t i_ret;
275  
276 #ifdef UNDER_CE
277     if( !ReadFile( (HANDLE)p_access_data->_socket.i_handle, p_buffer, i_len,
278                    (LPDWORD)&i_ret, NULL ) )
279     {
280         i_ret = -1;
281     }
282 #else
283     i_ret = read( p_access_data->_socket.i_handle, p_buffer, i_len );
284 #endif
285
286     if( i_ret < 0 )
287     {
288 #ifdef HAVE_ERRNO_H
289         if ( errno != EINTR && errno != EAGAIN )
290             msg_Err( p_input, "read failed (%s)", strerror(errno) );
291 #else
292         msg_Err( p_input, "read failed" );
293 #endif
294
295         /* Delay a bit to avoid consuming all the CPU. This is particularly
296          * useful when reading from an unconnected FIFO. */
297         msleep( INPUT_ERROR_SLEEP );
298     }
299  
300     p_access_data->i_nb_reads++;
301 #ifdef HAVE_SYS_STAT_H
302     if ( p_input->stream.p_selected_area->i_size != 0
303             && (p_access_data->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
304     {
305         struct stat stat_info;
306         if ( fstat( p_access_data->_socket.i_handle, &stat_info ) == -1 )
307         {
308 #   ifdef HAVE_ERRNO_H
309             msg_Warn( p_input, "couldn't stat again the file (%s)",
310                       strerror(errno) );
311 #   else
312             msg_Warn( p_input, "couldn't stat again the file" );
313 #   endif
314         }
315         else if ( p_input->stream.p_selected_area->i_size != stat_info.st_size )
316         {
317             p_input->stream.p_selected_area->i_size = stat_info.st_size;
318             p_input->stream.b_changed = 1;
319         }
320     }
321 #endif
322
323     return i_ret;
324 }
325
326 /*****************************************************************************
327  * Seek: seek to a specific location in a file
328  *****************************************************************************/
329 static void Seek( input_thread_t * p_input, off_t i_pos )
330 {
331 #define S p_input->stream
332     input_socket_t * p_access_data = (input_socket_t *)p_input->p_access_data;
333
334     lseek( p_access_data->i_handle, i_pos, SEEK_SET );
335
336     vlc_mutex_lock( &S.stream_lock );
337     S.p_selected_area->i_tell = i_pos;
338     if( S.p_selected_area->i_tell > S.p_selected_area->i_size )
339     {
340         msg_Err( p_input, "seeking too far" );
341         S.p_selected_area->i_tell = S.p_selected_area->i_size;
342     }
343     else if( S.p_selected_area->i_tell < 0 )
344     {
345         msg_Err( p_input, "seeking too early" );
346         S.p_selected_area->i_tell = 0;
347     }
348     vlc_mutex_unlock( &S.stream_lock );
349 #undef S
350 }
351