]> git.sesse.net Git - vlc/blobdiff - modules/access/file.c
Don't leak unused audio and video blocks when closing.
[vlc] / modules / access / file.c
index 98553b64a88c2a06ac463d540fd31b12f12013db..59f6c6790ed81aa00b2e6a67ed5814f0c4251993 100644 (file)
@@ -1,16 +1,18 @@
 /*****************************************************************************
  * file.c: file input (file: access plug-in)
  *****************************************************************************
- * Copyright (C) 2001, 2002 VideoLAN
- * $Id: file.c,v 1.14 2003/03/24 17:15:29 gbazin Exp $
+ * Copyright (C) 2001-2006 the VideoLAN team
+ * Copyright © 2006-2007 Rémi Denis-Courmont
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
+ *          Rémi Denis-Courmont <rem # videolan # org>
  *
  * 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.
- * 
+ *
  * 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
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
- *****************************************************************************/
-
-/*****************************************************************************
- * Preamble
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/input.h>
 
-#include <stdlib.h>
-#include <string.h>
-#ifdef HAVE_SYS_TYPES_H
-#   include <sys/types.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
 #endif
+
+#include <vlc_common.h>
+#include "fs.h"
+#include <vlc_input.h>
+#include <vlc_access.h>
+#include <vlc_dialog.h>
+
+#include <assert.h>
+#include <errno.h>
+#include <sys/types.h>
 #ifdef HAVE_SYS_STAT_H
 #   include <sys/stat.h>
 #endif
-#ifdef HAVE_ERRNO_H
-#   include <errno.h>
-#endif
 #ifdef HAVE_FCNTL_H
 #   include <fcntl.h>
 #endif
+#ifdef HAVE_FSTATVFS
+#   include <sys/statvfs.h>
+#   if defined (HAVE_SYS_MOUNT_H)
+#      include <sys/param.h>
+#      include <sys/mount.h>
+#   endif
+#endif
+#ifdef HAVE_LINUX_MAGIC_H
+#   include <sys/vfs.h>
+#   include <linux/magic.h>
+#endif
 
-#ifdef HAVE_UNISTD_H
-#   include <unistd.h>
-#elif defined( WIN32 ) && !defined( UNDER_CE )
+#if defined( WIN32 )
 #   include <io.h>
+#   include <ctype.h>
+#   include <shlwapi.h>
+#else
+#   include <unistd.h>
 #endif
+#include <dirent.h>
 
 #if defined( WIN32 ) && !defined( UNDER_CE )
 #   ifdef lseek
-#       undef lseek
+#      undef lseek
 #   endif
 #   define lseek _lseeki64
+#elif defined( UNDER_CE )
+/* FIXME the commandline on wince is a mess */
+# define PathIsNetworkPathW(wpath) (! wcsncmp(wpath, L"\\\\", 2))
 #endif
-/*****************************************************************************
- * Exported prototypes
- *****************************************************************************/
-static int     Open   ( vlc_object_t * );
-static void    Close  ( vlc_object_t * );
 
-static void    Seek   ( input_thread_t *, off_t );
-static ssize_t Read   ( input_thread_t *, byte_t *, size_t );
+#include <vlc_fs.h>
+#include <vlc_url.h>
 
-/*****************************************************************************
- * Module descriptor
- *****************************************************************************/
-#define CACHING_TEXT N_("caching value in ms")
-#define CACHING_LONGTEXT N_( \
-    "Allows you to modify the default caching value for file streams. This " \
-    "value should be set in miliseconds units." )
-
-vlc_module_begin();
-    set_description( _("Standard filesystem file reading") );
-    add_category_hint( N_("file"), NULL, VLC_TRUE );
-    add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
-    set_capability( "access", 50 );
-    add_shortcut( "file" );
-    add_shortcut( "stream" );
-    set_callbacks( Open, Close );
-vlc_module_end();
-/*****************************************************************************
- * _input_socket_t: private access plug-in data, modified to add private
- *                  fields
- *****************************************************************************/
-typedef struct _input_socket_s
+struct access_sys_t
 {
-    input_socket_t      _socket;
+    unsigned int i_nb_reads;
 
-    unsigned int        i_nb_reads;
-} _input_socket_t;
+    int fd;
 
-/*****************************************************************************
- * Open: open the file
- *****************************************************************************/
-static int Open( vlc_object_t *p_this )
+    /* */
+    unsigned caching;
+    bool b_pace_control;
+};
+
+#ifndef WIN32
+static bool IsRemote (int fd)
 {
-    input_thread_t *    p_input = (input_thread_t *)p_this;
-    char *              psz_name = p_input->psz_name;
-#ifdef HAVE_SYS_STAT_H
-    int                 i_stat;
-    struct stat         stat_info;                                              
-#endif
-    _input_socket_t *   p_access_data;
-    vlc_bool_t          b_stdin;
+#if defined (HAVE_FSTATVFS) && defined (MNT_LOCAL)
+    struct statvfs stf;
 
-    p_input->i_mtu = 0;
+    if (fstatvfs (fd, &stf))
+        return false;
+    /* fstatvfs() is in POSIX, but MNT_LOCAL is not */
+    return !(stf.f_flag & MNT_LOCAL);
 
-    b_stdin = psz_name[0] == '-' && psz_name[1] == '\0';
+#elif defined (HAVE_LINUX_MAGIC_H)
+    struct statfs stf;
 
-#ifdef HAVE_SYS_STAT_H
-    if( !b_stdin && (i_stat = stat( psz_name, &stat_info )) == (-1) )
+    if (fstatfs (fd, &stf))
+        return false;
+
+    switch ((unsigned long)stf.f_type)
     {
-#   ifdef HAVE_ERRNO_H
-        msg_Warn( p_input, "cannot stat() file `%s' (%s)",
-                  psz_name, strerror(errno));
-#   else
-        msg_Warn( p_input, "cannot stat() file `%s'", psz_name );
-#   endif
-        return VLC_EGENERIC;
+        case AFS_SUPER_MAGIC:
+        case CODA_SUPER_MAGIC:
+        case NCP_SUPER_MAGIC:
+        case NFS_SUPER_MAGIC:
+        case SMB_SUPER_MAGIC:
+        case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
+            return true;
     }
+    return false;
+
+#else
+    (void)fd;
+    return false;
+
+#endif
+}
 #endif
 
-    p_input->pf_read = Read;
-    p_input->pf_set_program = input_SetProgram;
-    p_input->pf_set_area = NULL;
-    p_input->pf_seek = Seek;
+#ifndef HAVE_POSIX_FADVISE
+# define posix_fadvise(fd, off, len, adv)
+#endif
 
-    vlc_mutex_lock( &p_input->stream.stream_lock );
+/*****************************************************************************
+ * Open: open the file
+ *****************************************************************************/
+int Open( vlc_object_t *p_this )
+{
+    access_t     *p_access = (access_t*)p_this;
+#ifdef WIN32
+    bool is_remote = false;
+#endif
+
+    /* Open file */
+    int fd = -1;
 
-    if( *p_input->psz_access && !strncmp( p_input->psz_access, "stream", 7 ) )
+    if (!strcasecmp (p_access->psz_access, "fd"))
     {
-        /* stream:%s */
-        p_input->stream.b_pace_control = 0;
-        p_input->stream.b_seekable = 0;
-        p_input->stream.p_selected_area->i_size = 0;
+        char *end;
+        int oldfd = strtol (p_access->psz_location, &end, 10);
+
+        if (*end == '\0')
+            fd = vlc_dup (oldfd);
+        else if (*end == '/' && end > p_access->psz_location)
+        {
+            char *name = decode_URI_duplicate (end - 1);
+            if (name != NULL)
+            {
+                name[0] = '.';
+                fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
+                free (name);
+            }
+        }
     }
     else
     {
-        /* file:%s or %s */
-        p_input->stream.b_pace_control = 1;
+        const char *path = p_access->psz_filepath;
 
-        if( b_stdin )
-        {
-            p_input->stream.b_seekable = 0;
-            p_input->stream.p_selected_area->i_size = 0;
-        }
-#ifdef UNDER_CE
-        else if( VLC_TRUE )
+        msg_Dbg (p_access, "opening file `%s'", path);
+        fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
+        if (fd == -1)
         {
-            /* We'll update i_size after it's been opened */
-            p_input->stream.b_seekable = 1;
-        }
-#elif defined( HAVE_SYS_STAT_H )
-        else if( S_ISREG(stat_info.st_mode) || S_ISCHR(stat_info.st_mode)
-                  || S_ISBLK(stat_info.st_mode) )
-        {
-            p_input->stream.b_seekable = 1;
-            p_input->stream.p_selected_area->i_size = stat_info.st_size;
-        }
-        else if( S_ISFIFO(stat_info.st_mode)
-#   if !defined( SYS_BEOS ) && !defined( WIN32 )
-                  || S_ISSOCK(stat_info.st_mode)
-#   endif
-               )
-        {
-            p_input->stream.b_seekable = 0;
-            p_input->stream.p_selected_area->i_size = 0;
+            msg_Err (p_access, "cannot open file %s (%m)", path);
+            dialog_Fatal (p_access, _("File reading failed"),
+                          _("VLC could not open the file \"%s\"."), path);
         }
+
+#ifdef WIN32
+        wchar_t wpath[MAX_PATH+1];
+        if (MultiByteToWideChar (CP_UTF8, 0, path, -1,
+                                 wpath, MAX_PATH)
+         && PathIsNetworkPathW (wpath))
+            is_remote = true;
+# define IsRemote( fd ) ((void)fd, is_remote)
 #endif
-        else
-        {
-            vlc_mutex_unlock( &p_input->stream.stream_lock );
-            msg_Err( p_input, "unknown file type for `%s'", psz_name );
-            return VLC_EGENERIC;
-        }
-    }
-    p_input->stream.p_selected_area->i_tell = 0;
-    p_input->stream.i_method = INPUT_METHOD_FILE;
-    vlc_mutex_unlock( &p_input->stream.stream_lock );
-    msg_Dbg( p_input, "opening file `%s'", psz_name );
-    p_access_data = malloc( sizeof(_input_socket_t) );
-    p_input->p_access_data = (void *)p_access_data;
-    if( p_access_data == NULL )
-    {
-        msg_Err( p_input, "out of memory" );
-        return VLC_ENOMEM;
     }
+    if (fd == -1)
+        return VLC_EGENERIC;
 
-    p_access_data->i_nb_reads = 0;
-    if( b_stdin )
+    struct stat st;
+    if (fstat (fd, &st))
     {
-        p_access_data->_socket.i_handle = 0;
+        msg_Err (p_access, "failed to read (%m)");
+        goto error;
     }
-    else
+    /* Directories can be opened and read from, but only readdir() knows
+     * how to parse the data. The directory plugin will do it. */
+    if (S_ISDIR (st.st_mode))
     {
-#ifdef UNDER_CE
-        wchar_t psz_filename[MAX_PATH];
-        MultiByteToWideChar( CP_ACP, 0, psz_name, -1, psz_filename, MAX_PATH );
-
-        p_access_data->_socket.i_handle = (int)CreateFile( psz_filename,
-            GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 
-            FILE_ATTRIBUTE_NORMAL, NULL );
-
-        if( (HANDLE)p_access_data->_socket.i_handle == INVALID_HANDLE_VALUE )
-        {
-            msg_Err( p_input, "cannot open file %s", psz_name );
-            free( p_access_data );
-            return VLC_EGENERIC;
-        }
-        p_input->stream.p_selected_area->i_size =
-                GetFileSize( (HANDLE)p_access_data->_socket.i_handle, NULL );
+#ifdef HAVE_FDOPENDIR
+        DIR *handle = fdopendir (fd);
+        if (handle == NULL)
+            goto error; /* Uh? */
+        return DirInit (p_access, handle);
 #else
-        p_access_data->_socket.i_handle = open( psz_name,
-                                                O_NONBLOCK /*| O_LARGEFILE*/ );
-        if( p_access_data->_socket.i_handle == -1 )
-        {
-#   ifdef HAVE_ERRNO_H
-            msg_Err( p_input, "cannot open file %s (%s)", psz_name,
-                              strerror(errno) );
-#   else
-            msg_Err( p_input, "cannot open file %s", psz_name );
-#   endif
-            free( p_access_data );
-            return VLC_EGENERIC;
-        }
+        msg_Dbg (p_access, "ignoring directory");
+        goto error;
 #endif
     }
 
-    if ( p_input->stream.b_seekable
-          && !p_input->stream.p_selected_area->i_size )
+    access_sys_t *p_sys = malloc (sizeof (*p_sys));
+    if (unlikely(p_sys == NULL))
+        goto error;
+    access_InitFields (p_access);
+    p_access->pf_read = FileRead;
+    p_access->pf_block = NULL;
+    p_access->pf_control = FileControl;
+    p_access->pf_seek = FileSeek;
+    p_access->p_sys = p_sys;
+    p_sys->i_nb_reads = 0;
+    p_sys->fd = fd;
+    p_sys->caching = var_InheritInteger (p_access, "file-caching");
+    if (IsRemote(fd))
+        p_sys->caching += var_InheritInteger (p_access, "network-caching");
+    p_sys->b_pace_control = true;
+
+    if (S_ISREG (st.st_mode))
+        p_access->info.i_size = st.st_size;
+    else if (!S_ISBLK (st.st_mode))
     {
-        msg_Err( p_input, "file %s is empty, aborting", psz_name );
-        free( p_access_data );
-        return VLC_EGENERIC;
+        p_access->pf_seek = NoSeek;
+        p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
     }
 
-    /* Update default_pts to a suitable value for file access */
-    p_input->i_pts_delay = config_GetInt( p_input, "file-caching" ) * 1000;
-
+    if (p_access->pf_seek != NoSeek)
+    {
+        /* Demuxers will need the beginning of the file for probing. */
+        posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
+        /* In most cases, we only read the file once. */
+        posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
+#if defined(HAVE_FCNTL)
+        /* We'd rather use any available memory for reading ahead
+         * than for caching what we've already seen/heard */
+# if defined(F_RDAHEAD)
+        fcntl (fd, F_RDAHEAD, 1);
+# endif
+# if defined(F_NOCACHE)
+        fcntl (fd, F_NOCACHE, 1);
+# endif
+#endif
+    }
     return VLC_SUCCESS;
+
+error:
+    close (fd);
+    return VLC_EGENERIC;
 }
 
 /*****************************************************************************
  * Close: close the target
  *****************************************************************************/
-static void Close( vlc_object_t * p_this )
+void Close (vlc_object_t * p_this)
 {
-    input_thread_t * p_input = (input_thread_t *)p_this;
-    input_socket_t * p_access_data = (input_socket_t *)p_input->p_access_data;
-
-    msg_Info( p_input, "closing `%s/%s://%s'", 
-              p_input->psz_access, p_input->psz_demux, p_input->psz_name );
-#ifdef UNDER_CE
-    CloseHandle( (HANDLE)p_access_data->i_handle );
-#else
-    close( p_access_data->i_handle );
-#endif
+    access_t     *p_access = (access_t*)p_this;
 
-    free( p_access_data );
+    if (p_access->pf_read == NULL)
+    {
+        DirClose (p_this);
+        return;
+    }
+
+    access_sys_t *p_sys = p_access->p_sys;
+
+    close (p_sys->fd);
+    free (p_sys);
 }
 
+
+#include <vlc_network.h>
+
 /*****************************************************************************
  * Read: standard read on a file descriptor.
  *****************************************************************************/
-static ssize_t Read( input_thread_t * p_input, byte_t * p_buffer, size_t i_len )
+ssize_t FileRead( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 {
-    _input_socket_t * p_access_data = (_input_socket_t *)p_input->p_access_data;
+    access_sys_t *p_sys = p_access->p_sys;
+    int fd = p_sys->fd;
     ssize_t i_ret;
-#ifdef UNDER_CE
-    if( !ReadFile( (HANDLE)p_access_data->_socket.i_handle, p_buffer, i_len,
-                   (LPDWORD)&i_ret, NULL ) )
-    {
-        i_ret = -1;
-    }
-#else
-    i_ret = read( p_access_data->_socket.i_handle, p_buffer, i_len );
-#endif
 
-    if( i_ret < 0 )
-    {
-#ifdef HAVE_ERRNO_H
-        if ( errno != EINTR && errno != EAGAIN )
-            msg_Err( p_input, "read failed (%s)", strerror(errno) );
-#else
-        msg_Err( p_input, "read failed" );
+#ifndef WIN32
+    if (p_access->pf_seek == NoSeek)
+        i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
+    else
 #endif
+        i_ret = read (fd, p_buffer, i_len);
 
-        /* Delay a bit to avoid consuming all the CPU. This is particularly
-         * useful when reading from an unconnected FIFO. */
-        msleep( INPUT_ERROR_SLEEP );
-    }
-    p_access_data->i_nb_reads++;
-#ifdef HAVE_SYS_STAT_H
-    if ( p_input->stream.p_selected_area->i_size != 0
-            && (p_access_data->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
+    if( i_ret < 0 )
     {
-        struct stat stat_info;
-        if ( fstat( p_access_data->_socket.i_handle, &stat_info ) == -1 )
+        switch (errno)
         {
-#   ifdef HAVE_ERRNO_H
-            msg_Warn( p_input, "couldn't stat again the file (%s)",
-                      strerror(errno) );
-#   else
-            msg_Warn( p_input, "couldn't stat again the file" );
-#   endif
+            case EINTR:
+            case EAGAIN:
+                break;
+
+            default:
+                msg_Err (p_access, "failed to read (%m)");
+                dialog_Fatal (p_access, _("File reading failed"), "%s",
+                              _("VLC could not read the file."));
+                p_access->info.b_eof = true;
+                return 0;
         }
-        else if ( p_input->stream.p_selected_area->i_size != stat_info.st_size )
+    }
+    else if( i_ret > 0 )
+        p_access->info.i_pos += i_ret;
+    else
+        p_access->info.b_eof = true;
+
+    p_sys->i_nb_reads++;
+
+    if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
+     || (p_access->info.i_pos > p_access->info.i_size))
+    {
+#ifdef HAVE_SYS_STAT_H
+        struct stat st;
+
+        if ((fstat (fd, &st) == 0)
+         && (p_access->info.i_size != (uint64_t)st.st_size))
         {
-            p_input->stream.p_selected_area->i_size = stat_info.st_size;
-            p_input->stream.b_changed = 1;
+            p_access->info.i_size = st.st_size;
+            p_access->info.i_update |= INPUT_UPDATE_SIZE;
         }
-    }
 #endif
-
+    }
     return i_ret;
 }
 
+
 /*****************************************************************************
  * Seek: seek to a specific location in a file
  *****************************************************************************/
-static void Seek( input_thread_t * p_input, off_t i_pos )
+int FileSeek (access_t *p_access, uint64_t i_pos)
+{
+    p_access->info.i_pos = i_pos;
+    p_access->info.b_eof = false;
+
+    lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
+    return VLC_SUCCESS;
+}
+
+int NoSeek (access_t *p_access, uint64_t i_pos)
 {
-#define S p_input->stream
-    input_socket_t * p_access_data = (input_socket_t *)p_input->p_access_data;
+    /* assert(0); ?? */
+    (void) p_access; (void) i_pos;
+    return VLC_EGENERIC;
+}
 
-    lseek( p_access_data->i_handle, i_pos, SEEK_SET );
+/*****************************************************************************
+ * Control:
+ *****************************************************************************/
+int FileControl( access_t *p_access, int i_query, va_list args )
+{
+    access_sys_t *p_sys = p_access->p_sys;
+    bool    *pb_bool;
+    int64_t *pi_64;
 
-    vlc_mutex_lock( &S.stream_lock );
-    S.p_selected_area->i_tell = i_pos;
-    if( S.p_selected_area->i_tell > S.p_selected_area->i_size )
+    switch( i_query )
     {
-        msg_Err( p_input, "seeking too far" );
-        S.p_selected_area->i_tell = S.p_selected_area->i_size;
-    }
-    else if( S.p_selected_area->i_tell < 0 )
-    {
-        msg_Err( p_input, "seeking too early" );
-        S.p_selected_area->i_tell = 0;
+        /* */
+        case ACCESS_CAN_SEEK:
+        case ACCESS_CAN_FASTSEEK:
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = (p_access->pf_seek != NoSeek);
+            break;
+
+        case ACCESS_CAN_PAUSE:
+        case ACCESS_CAN_CONTROL_PACE:
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = p_sys->b_pace_control;
+            break;
+
+        /* */
+        case ACCESS_GET_PTS_DELAY:
+            pi_64 = (int64_t*)va_arg( args, int64_t * );
+            *pi_64 = p_sys->caching * INT64_C(1000);
+            break;
+
+        /* */
+        case ACCESS_SET_PAUSE_STATE:
+            /* Nothing to do */
+            break;
+
+        case ACCESS_GET_TITLE_INFO:
+        case ACCESS_SET_TITLE:
+        case ACCESS_SET_SEEKPOINT:
+        case ACCESS_SET_PRIVATE_ID_STATE:
+        case ACCESS_GET_META:
+        case ACCESS_GET_PRIVATE_ID_STATE:
+        case ACCESS_GET_CONTENT_TYPE:
+            return VLC_EGENERIC;
+
+        default:
+            msg_Warn( p_access, "unimplemented query %d in control", i_query );
+            return VLC_EGENERIC;
+
     }
-    vlc_mutex_unlock( &S.stream_lock );
-#undef S
+    return VLC_SUCCESS;
 }
-