file.c 13.1 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
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <vlc/vlc.h>
zorglub's avatar
zorglub committed
30
31
32
#include <vlc_input.h>
#include <vlc_access.h>
#include <vlc_interface.h>
33

34
#include <errno.h>
35
36
37
38
39
40
41
42
43
44
#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
45
46
47
#if defined( WIN32 ) && !defined( UNDER_CE )
#   include <io.h>
#else
48
#   include <unistd.h>
49
#   include <poll.h>
50
51
#endif

gbazin's avatar
   
gbazin committed
52
#if defined( WIN32 ) && !defined( UNDER_CE )
53
54
55
56
57
58
59
60
61
62
63
64
65
66
#   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
67
68
#endif

zorglub's avatar
zorglub committed
69
#include <vlc_charset.h>
70

71
72
73
/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
74
75
76
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );

Christophe Massiot's avatar
Christophe Massiot committed
77
#define CACHING_TEXT N_("Caching value in ms")
gbazin's avatar
   
gbazin committed
78
#define CACHING_LONGTEXT N_( \
79
    "Caching value for files. This " \
zorglub's avatar
zorglub committed
80
    "value should be set in milliseconds." )
gbazin's avatar
gbazin committed
81
82
#define CAT_TEXT N_("Concatenate with additional files")
#define CAT_LONGTEXT N_( \
zorglub's avatar
zorglub committed
83
84
    "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
85

86
vlc_module_begin();
zorglub's avatar
zorglub committed
87
    set_description( _("File input") );
zorglub's avatar
zorglub committed
88
    set_shortname( _("File") );
zorglub's avatar
zorglub committed
89
90
    set_category( CAT_INPUT );
    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
95
    add_shortcut( "file" );
    add_shortcut( "stream" );
96
    add_shortcut( "kfir" );
97
98
    set_callbacks( Open, Close );
vlc_module_end();
99
100


101
/*****************************************************************************
102
 * Exported prototypes
103
 *****************************************************************************/
104
105
106
107
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
108
static int  open_file( access_t *, const char * );
gbazin's avatar
gbazin committed
109

110
struct access_sys_t
111
{
112
113
    unsigned int i_nb_reads;
    vlc_bool_t   b_kfir;
gbazin's avatar
gbazin committed
114

115
    int fd;
gbazin's avatar
gbazin committed
116

117
118
119
120
    /* */
    vlc_bool_t b_seekable;
    vlc_bool_t b_pace_control;
};
121

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

130
    vlc_bool_t    b_stdin = !strcmp (p_access->psz_path, "-");
131

132
133
    /* Update default_pts to a suitable value for file access */
    var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
134

135
    STANDARD_READ_ACCESS_INIT;
136
137
    p_sys->i_nb_reads = 0;
    p_sys->b_kfir = VLC_FALSE;
138
    int fd = p_sys->fd = -1;
139

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

157
158
    /* Open file */
    msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
159

160
161
162
163
    if (b_stdin)
        fd = dup (0);
    else
        fd = open_file (p_access, p_access->psz_path);
164

165
#ifdef HAVE_SYS_STAT_H
166
    struct stat st;
gbazin's avatar
gbazin committed
167

168
    while (fd != -1)
gbazin's avatar
gbazin committed
169
    {
170
        if (fstat (fd, &st))
171
            msg_Err (p_access, "fstat(%d): %m", fd);
172
        else
173
174
175
176
177
        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
178

179
180
181
        close (fd);
        fd = -1;
    }
182
#endif
gbazin's avatar
gbazin committed
183

184
185
186
187
188
189
    if (fd == -1)
    {
        free (p_sys);
        return VLC_EGENERIC;
    }
    p_sys->fd = fd;
190
191

#ifdef HAVE_SYS_STAT_H
192
193
194
195
    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;
196
#else
197
    p_sys->b_seekable = !b_stdin;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
198
# warning File size not known!
199
200
#endif

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

209
    return VLC_SUCCESS;
210
211
212
}

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

220
    close (p_sys->fd);
221
    free (p_sys);
222
223
224
225
226
}

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

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

243
                if( p_access->b_die )
244
245
                    return 0;

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

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

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

271
272
    if( i_ret < 0 )
    {
273
        switch (errno)
274
        {
275
276
277
278
279
            case EINTR:
            case EAGAIN:
                break;

            default:
280
                msg_Err (p_access, "read failed (%m)");
281
                intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
282
                                _("VLC could not read the file."));
283
        }
284
285
286
287

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

    p_sys->i_nb_reads++;
291

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

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

307
308
309
310
311
    if( i_ret > 0 )
        p_access->info.i_pos += i_ret;
    else if( i_ret == 0 )
        p_access->info.b_eof = VLC_TRUE;

312
313
314
315
316
317
    return i_ret;
}

/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
318
static int Seek (access_t *p_access, int64_t i_pos)
319
{
320
    if (i_pos > p_access->info.i_size)
gbazin's avatar
gbazin committed
321
    {
322
        msg_Err (p_access, "seeking too far");
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
323
        i_pos = p_access->info.i_size;
gbazin's avatar
gbazin committed
324
    }
325
    else if (i_pos < 0)
326
    {
327
        msg_Err (p_access, "seeking too early");
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
328
        i_pos = 0;
329
    }
330
331
332
333
334

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

    /* Determine which file we need to access */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
335
    lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
336
337
338
339
340
341
342
343
344
345
346
347
348
349
    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 )
350
    {
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
        /* */
        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 * );
372
            *pi_64 = var_GetInteger( p_access, "file-caching" ) * I64C(1000);
373
            break;
374

375
376
377
378
379
380
381
382
        /* */
        case ACCESS_SET_PAUSE_STATE:
            /* Nothing to do */
            break;

        case ACCESS_GET_TITLE_INFO:
        case ACCESS_SET_TITLE:
        case ACCESS_SET_SEEKPOINT:
383
        case ACCESS_SET_PRIVATE_ID_STATE:
384
        case ACCESS_GET_META:
385
        case ACCESS_GET_CONTENT_TYPE:
386
387
388
            return VLC_EGENERIC;

        default:
389
            msg_Warn( p_access, "unimplemented query in control" );
390
391
            return VLC_EGENERIC;

392
    }
393
    return VLC_SUCCESS;
394
395
}

396

397
398
static char *expand_path (const access_t *p_access, const char *path)
{
Rafaël Carré's avatar
Rafaël Carré committed
399
    if (strncmp (path, "~/", 2) == 0)
400
401
402
403
404
405
406
407
408
409
    {
        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
410
    if (!strcasecmp (p_access->psz_access, "file")
411
412
413
414
415
416
417
418
419
420
      && ('/' == 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
421
/*****************************************************************************
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
422
 * open_file: Opens a specific file
gbazin's avatar
gbazin committed
423
 *****************************************************************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
424
static int open_file (access_t *p_access, const char *psz_name)
gbazin's avatar
gbazin committed
425
{
426
    char *path = expand_path (p_access, psz_name);
gbazin's avatar
gbazin committed
427
428

#ifdef UNDER_CE
429
    p_sys->fd = utf8_fopen( path, "rb" );
430
    if ( !p_sys->fd )
gbazin's avatar
gbazin committed
431
    {
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 the file \"%s\"."), psz_name );
435
        free (path);
gbazin's avatar
gbazin committed
436
437
        return VLC_EGENERIC;
    }
438
439
440

    fseek( p_sys->fd, 0, SEEK_END );
    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 );
gbazin's avatar
gbazin committed
443
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
444
    int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
445
    free (path);
446
    if (fd == -1)
gbazin's avatar
gbazin committed
447
    {
448
        msg_Err (p_access, "cannot open file %s (%m)", psz_name);
449
        intf_UserFatal (p_access, VLC_FALSE, _("File reading failed"),
450
                        _("VLC could not open the file \"%s\"."), psz_name);
451
        return -1;
gbazin's avatar
gbazin committed
452
    }
453

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

462
    return fd;
gbazin's avatar
gbazin committed
463
}