file.c 13.4 KB
Newer Older
1
2
3
/*****************************************************************************
 * file.c: file input (file: access plug-in)
 *****************************************************************************
4
 * Copyright (C) 2001-2006 the VideoLAN team
5
 * Copyright © 2006 Rémi Denis-Courmont
gbazin's avatar
gbazin committed
6
 * $Id$
7
8
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9
 *          Rémi Denis-Courmont <rem # videolan # org>
10
11
12
13
14
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
15
 *
16
17
18
19
20
21
22
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24
25
26
27
28
29
30
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <vlc/vlc.h>
#include <vlc/input.h>
31
#include <vlc_interaction.h>
32

33
34
#include <stdlib.h>
#include <string.h>
35
#include <errno.h>
36
37
38
39
40
41
42
43
44
45
#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
#ifdef HAVE_SYS_STAT_H
#   include <sys/stat.h>
#endif
#ifdef HAVE_FCNTL_H
#   include <fcntl.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
46
47
48
#if defined( WIN32 ) && !defined( UNDER_CE )
#   include <io.h>
#else
49
#   include <unistd.h>
50
#   include <poll.h>
51
52
#endif

gbazin's avatar
   
gbazin committed
53
#if defined( WIN32 ) && !defined( UNDER_CE )
54
/* fstat() support for large files on win32 */
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#   define fstat(a,b) _fstati64(a,b)
#   ifdef lseek
#      undef lseek
#   endif
#   define lseek _lseeki64
#elif defined( UNDER_CE )
#   ifdef read
#      undef read
#   endif
#   define read(a,b,c) fread(b,1,c,a)
#   define close(a) fclose(a)
#   ifdef lseek
#      undef lseek
#   endif
#   define lseek fseek
gbazin's avatar
gbazin committed
70
71
#endif

72
73
#include "charset.h"

74
75
76
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
77
78
79
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );

Christophe Massiot's avatar
Christophe Massiot committed
80
#define CACHING_TEXT N_("Caching value in ms")
gbazin's avatar
   
gbazin committed
81
#define CACHING_LONGTEXT N_( \
82
    "Caching value for files. This " \
zorglub's avatar
zorglub committed
83
    "value should be set in milliseconds." )
gbazin's avatar
gbazin committed
84
85
#define CAT_TEXT N_("Concatenate with additional files")
#define CAT_LONGTEXT N_( \
zorglub's avatar
zorglub committed
86
87
    "Play split files as if they were part of a unique file. " \
    "You need to specify a comma-separated list of files." )
gbazin's avatar
   
gbazin committed
88

89
vlc_module_begin();
zorglub's avatar
zorglub committed
90
    set_description( _("File input") );
zorglub's avatar
zorglub committed
91
    set_shortname( _("File") );
zorglub's avatar
zorglub committed
92
93
    set_category( CAT_INPUT );
    set_subcategory( SUBCAT_INPUT_ACCESS );
94
    add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
95
    add_deprecated( "file-cat", VLC_TRUE );
96
    set_capability( "access2", 50 );
97
98
    add_shortcut( "file" );
    add_shortcut( "stream" );
99
    add_shortcut( "kfir" );
100
101
    set_callbacks( Open, Close );
vlc_module_end();
102
103


104
/*****************************************************************************
105
 * Exported prototypes
106
 *****************************************************************************/
107
108
109
110
static int  Seek( access_t *, int64_t );
static int  Read( access_t *, uint8_t *, int );
static int  Control( access_t *, int, va_list );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
111
static int  open_file( access_t *, const char * );
gbazin's avatar
gbazin committed
112

113
struct access_sys_t
114
{
115
116
    unsigned int i_nb_reads;
    vlc_bool_t   b_kfir;
gbazin's avatar
gbazin committed
117

118
    int fd;
gbazin's avatar
gbazin committed
119

120
121
122
123
    /* */
    vlc_bool_t b_seekable;
    vlc_bool_t b_pace_control;
};
124

125
126
127
128
129
/*****************************************************************************
 * Open: open the file
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
130
131
132
    access_t     *p_access = (access_t*)p_this;
    access_sys_t *p_sys;

133
    vlc_bool_t    b_stdin = !strcmp (p_access->psz_path, "-");
134

135
136
    /* Update default_pts to a suitable value for file access */
    var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
137

138
    STANDARD_READ_ACCESS_INIT;
139
140
    p_sys->i_nb_reads = 0;
    p_sys->b_kfir = VLC_FALSE;
141
    int fd = p_sys->fd = -1;
142

143
    if (!strcasecmp (p_access->psz_access, "stream"))
144
    {
145
146
        p_sys->b_seekable = VLC_FALSE;
        p_sys->b_pace_control = VLC_FALSE;
147
    }
148
    else if (!strcasecmp (p_access->psz_access, "kfir"))
149
    {
150
151
152
        p_sys->b_seekable = VLC_FALSE;
        p_sys->b_pace_control = VLC_FALSE;
        p_sys->b_kfir = VLC_TRUE;
153
    }
154
155
    else
    {
156
        p_sys->b_seekable = VLC_TRUE;
157
        p_sys->b_pace_control = VLC_TRUE;
158
    }
159

160
161
    /* Open file */
    msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
162

163
164
165
166
    if (b_stdin)
        fd = dup (0);
    else
        fd = open_file (p_access, p_access->psz_path);
167

168
169
#ifdef HAVE_SYS_STAT_H
    struct stat st;
gbazin's avatar
gbazin committed
170

171
    while (fd != -1)
gbazin's avatar
gbazin committed
172
    {
173
174
        if (fstat (fd, &st))
            msg_Err (p_access, "fstat(%d): %s", fd, strerror (errno));
175
        else
176
177
178
179
180
        if (S_ISDIR (st.st_mode))
            /* The directory plugin takes care of that */
            msg_Dbg (p_access, "file is a directory, aborting");
        else
            break; // success
gbazin's avatar
gbazin committed
181

182
183
184
        close (fd);
        fd = -1;
    }
185
#endif
gbazin's avatar
gbazin committed
186

187
188
189
190
191
192
    if (fd == -1)
    {
        free (p_sys);
        return VLC_EGENERIC;
    }
    p_sys->fd = fd;
193
194

#ifdef HAVE_SYS_STAT_H
195
196
197
198
    p_access->info.i_size = st.st_size;
    if (!S_ISREG (st.st_mode) && !S_ISBLK (st.st_mode)
     && (!S_ISCHR (st.st_mode) || (st.st_size == 0)))
        p_sys->b_seekable = VLC_FALSE;
199
#else
200
    p_sys->b_seekable = !b_stdin;
201
202
#endif

203
    if (p_sys->b_seekable && (p_access->info.i_size == 0))
204
205
    {
        /* FIXME that's bad because all others access will be probed */
206
        msg_Err (p_access, "file is empty, aborting");
207
208
        Close (p_this);
        return VLC_EGENERIC;
gbazin's avatar
gbazin committed
209
210
    }

211
    return VLC_SUCCESS;
212
213
214
}

/*****************************************************************************
215
 * Close: close the target
216
 *****************************************************************************/
217
static void Close (vlc_object_t * p_this)
218
{
219
220
    access_t     *p_access = (access_t*)p_this;
    access_sys_t *p_sys = p_access->p_sys;
221

222
    close (p_sys->fd);
223
    free (p_sys);
224
225
226
227
228
}

/*****************************************************************************
 * Read: standard read on a file descriptor.
 *****************************************************************************/
229
static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
230
{
231
232
    access_sys_t *p_sys = p_access->p_sys;
    int i_ret;
233
    int fd = p_sys->fd;
234

235
#if !defined(WIN32) && !defined(UNDER_CE)
236
    if( !p_sys->b_pace_control )
237
    {
238
        if( !p_sys->b_kfir )
239
        {
240
            /* Find if some data is available. This won't work under Windows. */
241
            do
242
            {
243
                struct pollfd ufd;
244

245
                if( p_access->b_die )
246
247
                    return 0;

248
                memset (&ufd, 0, sizeof (ufd));
249
                ufd.fd = fd;
250
251
                ufd.events = POLLIN;

252
                i_ret = poll (&ufd, 1, 500);
253
            }
254
            while (i_ret <= 0);
255

256
            i_ret = read (fd, p_buffer, i_len);
257
258
        }
        else
259
        {
260
            /* b_kfir ; work around a buggy poll() driver implementation */
261
262
            while (((i_ret = read (fd, p_buffer, i_len)) == 0)
                && !p_access->b_die)
263
            {
264
                msleep( INPUT_ERROR_SLEEP );
265
            }
266
267
        }
    }
268
    else
269
#endif /* WIN32 || UNDER_CE */
270
        /* b_pace_control || WIN32 */
271
        i_ret = read( fd, p_buffer, i_len );
272

273
274
    if( i_ret < 0 )
    {
275
        switch (errno)
276
        {
277
278
279
280
281
282
283
284
285
            case EINTR:
            case EAGAIN:
                break;

            default:
                msg_Err (p_access, "read failed (%s)", strerror (errno));
                intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
                                _("VLC could not read file \"%s\"."),
                                strerror (errno));
286
        }
287
288
289
290

        /* Delay a bit to avoid consuming all the CPU. This is particularly
         * useful when reading from an unconnected FIFO. */
        msleep( INPUT_ERROR_SLEEP );
291
    }
292
293

    p_sys->i_nb_reads++;
294

295
#ifdef HAVE_SYS_STAT_H
296
297
    if( p_access->info.i_size != 0 &&
        (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
298
    {
299
        struct stat st;
gbazin's avatar
gbazin committed
300

301
        if ((fstat (fd, &st) == 0)
302
         && (p_access->info.i_size != st.st_size))
303
        {
304
            p_access->info.i_size = st.st_size;
305
            p_access->info.i_update |= INPUT_UPDATE_SIZE;
306
307
308
309
        }
    }
#endif

310
311
312
313
314
    if( i_ret > 0 )
        p_access->info.i_pos += i_ret;
    else if( i_ret == 0 )
        p_access->info.b_eof = VLC_TRUE;

315
316
317
318
319
320
    return i_ret;
}

/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
321
static int Seek (access_t *p_access, int64_t i_pos)
322
{
323
    access_sys_t *p_sys = p_access->p_sys;
gbazin's avatar
gbazin committed
324

325
    if (i_pos > p_access->info.i_size)
gbazin's avatar
gbazin committed
326
    {
327
328
        msg_Err (p_access, "seeking too far");
        i_pos = p_access->info.i_pos = p_access->info.i_size;
gbazin's avatar
gbazin committed
329
    }
330
    else if (i_pos < 0)
331
    {
332
333
        msg_Err (p_access, "seeking too early");
        i_pos = p_access->info.i_pos = 0;
334
    }
335
336
337
338
339

    p_access->info.i_pos = i_pos;
    p_access->info.b_eof = VLC_FALSE;

    /* Determine which file we need to access */
340
    lseek (p_sys->fd, i_pos, SEEK_SET);
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Control:
 *****************************************************************************/
static int Control( access_t *p_access, int i_query, va_list args )
{
    access_sys_t *p_sys = p_access->p_sys;
    vlc_bool_t   *pb_bool;
    int          *pi_int;
    int64_t      *pi_64;

    switch( i_query )
355
    {
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
            *pb_bool = p_sys->b_seekable;
            break;

        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
            *pb_bool = p_sys->b_pace_control;
            break;

        /* */
        case ACCESS_GET_MTU:
            pi_int = (int*)va_arg( args, int * );
            *pi_int = 0;
            break;

        case ACCESS_GET_PTS_DELAY:
            pi_64 = (int64_t*)va_arg( args, int64_t * );
377
            *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
378
            break;
379

380
381
382
383
384
385
386
387
        /* */
        case ACCESS_SET_PAUSE_STATE:
            /* Nothing to do */
            break;

        case ACCESS_GET_TITLE_INFO:
        case ACCESS_SET_TITLE:
        case ACCESS_SET_SEEKPOINT:
388
        case ACCESS_SET_PRIVATE_ID_STATE:
389
        case ACCESS_GET_META:
390
391
392
            return VLC_EGENERIC;

        default:
393
            msg_Warn( p_access, "unimplemented query in control" );
394
395
            return VLC_EGENERIC;

396
    }
397
    return VLC_SUCCESS;
398
399
}

400

401
402
static char *expand_path (const access_t *p_access, const char *path)
{
Rafaël Carré's avatar
Rafaël Carré committed
403
    if (strncmp (path, "~/", 2) == 0)
404
405
406
407
408
409
410
411
412
413
    {
        char *res;

         // TODO: we should also support the ~cmassiot/ syntax
         if (asprintf (&res, "%s/%s", p_access->p_libvlc->psz_homedir, path + 2) == -1)
             return NULL;
         return res;
    }

#if defined(WIN32)
Rafaël Carré's avatar
Rafaël Carré committed
414
    if (!strcasecmp (p_access->psz_access, "file")
415
416
417
418
419
420
421
422
423
424
      && ('/' == path[0]) && path[1] && (':' == path[2]) && ('/' == path[3]))
        // Explorer can open path such as file:/C:/ or file:///C:/
        // hence remove leading / if found
        return strdup (path + 1);
#endif

    return strdup (path);
}


gbazin's avatar
gbazin committed
425
/*****************************************************************************
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
426
 * open_file: Opens a specific file
gbazin's avatar
gbazin committed
427
 *****************************************************************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
428
static int open_file (access_t *p_access, const char *psz_name)
gbazin's avatar
gbazin committed
429
{
430
    char *path = expand_path (p_access, psz_name);
gbazin's avatar
gbazin committed
431
432

#ifdef UNDER_CE
433
    p_sys->fd = utf8_fopen( path, "rb" );
434
    if ( !p_sys->fd )
gbazin's avatar
gbazin committed
435
    {
436
        msg_Err( p_access, "cannot open file %s", psz_name );
437
438
        intf_UserFatal( p_access, VLC_FALSE, _("File reading failed"), 
                        _("VLC could not open file \"%s\"."), psz_name );
439
        free (path);
gbazin's avatar
gbazin committed
440
441
        return VLC_EGENERIC;
    }
442
443
444

    fseek( p_sys->fd, 0, SEEK_END );
    p_access->info.i_size = ftell( p_sys->fd );
445
    p_access->info.i_update |= INPUT_UPDATE_SIZE;
446
    fseek( p_sys->fd, 0, SEEK_SET );
gbazin's avatar
gbazin committed
447
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
448
    int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
449
    if (fd == -1)
gbazin's avatar
gbazin committed
450
    {
451
452
453
        msg_Err (p_access, "cannot open file %s (%s)", psz_name,
                 strerror (errno));
        intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"), 
454
                        _("VLC could not open file \"%s\" (%s)."),
455
456
                        psz_name, strerror (errno));
        return -1;
gbazin's avatar
gbazin committed
457
    }
458

459
# if defined(HAVE_FCNTL_H) && defined(F_FDAHEAD) && defined(F_NOCACHE)
460
461
    /* We'd rather use any available memory for reading ahead
     * than for caching what we've already seen/heard */
462
463
464
    fcntl (fd, F_RDAHEAD, 1);
    fcntl (fd, F_NOCACHE, 1);
# endif
gbazin's avatar
gbazin committed
465
466
#endif

467
    return fd;
gbazin's avatar
gbazin committed
468
}