libavformat/file.c
de6d9b64
 /*
124e2884
  * buffered file I/O
19720f15
  * Copyright (c) 2001 Fabrice Bellard
de6d9b64
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
19720f15
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
de6d9b64
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
de6d9b64
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19720f15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
de6d9b64
  *
19720f15
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
de6d9b64
  */
245976da
 
 #include "libavutil/avstring.h"
51eb213d
 #include "libavutil/internal.h"
29a9b12b
 #include "libavutil/opt.h"
8be1c656
 #include "avformat.h"
1f4c62e8
 #if HAVE_DIRENT_H
d39a9b01
 #include <dirent.h>
1f4c62e8
 #endif
de6d9b64
 #include <fcntl.h>
f3be3597
 #if HAVE_IO_H
b507ebd1
 #include <io.h>
 #endif
f3be3597
 #if HAVE_UNISTD_H
8be1c656
 #include <unistd.h>
f3be3597
 #endif
5b33a553
 #include <sys/stat.h>
9e33b10f
 #include <stdlib.h>
a5e979f4
 #include "os_support.h"
c486dade
 #include "url.h"
de6d9b64
 
16c03f2e
 /* Some systems may not have S_ISFIFO */
 #ifndef S_ISFIFO
 #  ifdef S_IFIFO
 #    define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
 #  else
 #    define S_ISFIFO(m) 0
 #  endif
 #endif
de6d9b64
 
1f4c62e8
 /* Not available in POSIX.1-1996 */
 #ifndef S_ISLNK
 #  ifdef S_IFLNK
 #    define S_ISLNK(m) (((m) & S_IFLNK) == S_IFLNK)
 #  else
 #    define S_ISLNK(m) 0
 #  endif
 #endif
 
 /* Not available in POSIX.1-1996 */
 #ifndef S_ISSOCK
 #  ifdef S_IFSOCK
 #    define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 #  else
 #    define S_ISSOCK(m) 0
 #  endif
 #endif
 
de6d9b64
 /* standard file protocol */
 
0697d812
 typedef struct FileContext {
29a9b12b
     const AVClass *class;
0697d812
     int fd;
29a9b12b
     int trunc;
a8f17115
     int blocksize;
933dec0e
     int follow;
1f4c62e8
 #if HAVE_DIRENT_H
d39a9b01
     DIR *dir;
1f4c62e8
 #endif
0697d812
 } FileContext;
 
29a9b12b
 static const AVOption file_options[] = {
43ecec0f
     { "truncate", "truncate existing files on write", offsetof(FileContext, trunc), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
a8f17115
     { "blocksize", "set I/O operation maximum block size", offsetof(FileContext, blocksize), AV_OPT_TYPE_INT, { .i64 = INT_MAX }, 1, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
933dec0e
     { "follow", "Follow a file as it is being written", offsetof(FileContext, follow), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_DECODING_PARAM },
a8f17115
     { NULL }
 };
 
 static const AVOption pipe_options[] = {
     { "blocksize", "set I/O operation maximum block size", offsetof(FileContext, blocksize), AV_OPT_TYPE_INT, { .i64 = INT_MAX }, 1, INT_MAX, AV_OPT_FLAG_ENCODING_PARAM },
29a9b12b
     { NULL }
 };
 
 static const AVClass file_class = {
     .class_name = "file",
     .item_name  = av_default_item_name,
     .option     = file_options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
a8f17115
 static const AVClass pipe_class = {
     .class_name = "pipe",
     .item_name  = av_default_item_name,
     .option     = pipe_options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
defb0009
 static int file_read(URLContext *h, unsigned char *buf, int size)
 {
0697d812
     FileContext *c = h->priv_data;
88e7ea3e
     int ret;
a8f17115
     size = FFMIN(size, c->blocksize);
88e7ea3e
     ret = read(c->fd, buf, size);
933dec0e
     if (ret == 0 && c->follow)
         return AVERROR(EAGAIN);
c557718b
     if (ret == 0)
         return AVERROR_EOF;
e05f7ed5
     return (ret == -1) ? AVERROR(errno) : ret;
defb0009
 }
 
 static int file_write(URLContext *h, const unsigned char *buf, int size)
 {
0697d812
     FileContext *c = h->priv_data;
88e7ea3e
     int ret;
a8f17115
     size = FFMIN(size, c->blocksize);
88e7ea3e
     ret = write(c->fd, buf, size);
e05f7ed5
     return (ret == -1) ? AVERROR(errno) : ret;
defb0009
 }
 
 static int file_get_handle(URLContext *h)
 {
0697d812
     FileContext *c = h->priv_data;
     return c->fd;
defb0009
 }
 
8799541a
 static int file_check(URLContext *h, int mask)
 {
40792107
     int ret = 0;
77015443
     const char *filename = h->filename;
     av_strstart(filename, "file:", &filename);
 
     {
 #if HAVE_ACCESS && defined(R_OK)
     if (access(filename, F_OK) < 0)
8799541a
         return AVERROR(errno);
40792107
     if (mask&AVIO_FLAG_READ)
77015443
         if (access(filename, R_OK) >= 0)
40792107
             ret |= AVIO_FLAG_READ;
     if (mask&AVIO_FLAG_WRITE)
77015443
         if (access(filename, W_OK) >= 0)
40792107
             ret |= AVIO_FLAG_WRITE;
16ef48c3
 #else
     struct stat st;
37787f26
 #   ifndef _WIN32
77015443
     ret = stat(filename, &st);
37787f26
 #   else
     ret = win32_stat(filename, &st);
 #   endif
16ef48c3
     if (ret < 0)
         return AVERROR(errno);
 
     ret |= st.st_mode&S_IRUSR ? mask&AVIO_FLAG_READ  : 0;
     ret |= st.st_mode&S_IWUSR ? mask&AVIO_FLAG_WRITE : 0;
 #endif
77015443
     }
8799541a
     return ret;
 }
 
824a82d1
 static int file_delete(URLContext *h)
 {
 #if HAVE_UNISTD_H
     int ret;
     const char *filename = h->filename;
     av_strstart(filename, "file:", &filename);
 
     ret = rmdir(filename);
     if (ret < 0 && errno == ENOTDIR)
         ret = unlink(filename);
     if (ret < 0)
         return AVERROR(errno);
 
     return ret;
 #else
     return AVERROR(ENOSYS);
 #endif /* HAVE_UNISTD_H */
 }
 
 static int file_move(URLContext *h_src, URLContext *h_dst)
 {
     const char *filename_src = h_src->filename;
     const char *filename_dst = h_dst->filename;
     av_strstart(filename_src, "file:", &filename_src);
fddcd9e5
     av_strstart(filename_dst, "file:", &filename_dst);
824a82d1
 
     if (rename(filename_src, filename_dst) < 0)
         return AVERROR(errno);
 
     return 0;
 }
 
defb0009
 #if CONFIG_FILE_PROTOCOL
 
de6d9b64
 static int file_open(URLContext *h, const char *filename, int flags)
 {
0697d812
     FileContext *c = h->priv_data;
de6d9b64
     int access;
     int fd;
df531b0e
     struct stat st;
de6d9b64
 
f7d78f36
     av_strstart(filename, "file:", &filename);
a1dfc201
 
59d96941
     if (flags & AVIO_FLAG_WRITE && flags & AVIO_FLAG_READ) {
29a9b12b
         access = O_CREAT | O_RDWR;
         if (c->trunc)
             access |= O_TRUNC;
59d96941
     } else if (flags & AVIO_FLAG_WRITE) {
29a9b12b
         access = O_CREAT | O_WRONLY;
         if (c->trunc)
             access |= O_TRUNC;
de6d9b64
     } else {
         access = O_RDONLY;
     }
05d00e95
 #ifdef O_BINARY
8be1c656
     access |= O_BINARY;
 #endif
51eb213d
     fd = avpriv_open(filename, access, 0666);
fbf7e805
     if (fd == -1)
ec679173
         return AVERROR(errno);
0697d812
     c->fd = fd;
df531b0e
 
1fe6cb44
     h->is_streamed = !fstat(fd, &st) && S_ISFIFO(st.st_mode);
df531b0e
 
db9e87dd
     /* Buffer writes more than the default 32k to improve throughput especially
      * with networked file systems */
     if (!h->is_streamed && flags & AVIO_FLAG_WRITE)
         h->min_packet_size = h->max_packet_size = 262144;
 
de6d9b64
     return 0;
 }
 
 /* XXX: use llseek */
bc5c918e
 static int64_t file_seek(URLContext *h, int64_t pos, int whence)
de6d9b64
 {
0697d812
     FileContext *c = h->priv_data;
e04826c3
     int64_t ret;
4ed5ac50
 
5b33a553
     if (whence == AVSEEK_SIZE) {
         struct stat st;
4ed5ac50
         ret = fstat(c->fd, &st);
9b6f2c74
         return ret < 0 ? AVERROR(errno) : (S_ISFIFO(st.st_mode) ? 0 : st.st_size);
5b33a553
     }
4ed5ac50
 
     ret = lseek(c->fd, pos, whence);
 
     return ret < 0 ? AVERROR(errno) : ret;
de6d9b64
 }
 
 static int file_close(URLContext *h)
 {
0697d812
     FileContext *c = h->priv_data;
     return close(c->fd);
de6d9b64
 }
 
d39a9b01
 static int file_open_dir(URLContext *h)
 {
d65b9114
 #if HAVE_LSTAT
d39a9b01
     FileContext *c = h->priv_data;
 
     c->dir = opendir(h->filename);
     if (!c->dir)
         return AVERROR(errno);
 
     return 0;
1f4c62e8
 #else
     return AVERROR(ENOSYS);
d65b9114
 #endif /* HAVE_LSTAT */
d39a9b01
 }
 
 static int file_read_dir(URLContext *h, AVIODirEntry **next)
 {
d65b9114
 #if HAVE_LSTAT
d39a9b01
     FileContext *c = h->priv_data;
     struct dirent *dir;
     char *fullpath = NULL;
 
     *next = ff_alloc_dir_entry();
     if (!*next)
         return AVERROR(ENOMEM);
     do {
         errno = 0;
         dir = readdir(c->dir);
         if (!dir) {
             av_freep(next);
             return AVERROR(errno);
         }
     } while (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."));
 
     fullpath = av_append_path_component(h->filename, dir->d_name);
     if (fullpath) {
         struct stat st;
1f4c62e8
         if (!lstat(fullpath, &st)) {
             if (S_ISDIR(st.st_mode))
                 (*next)->type = AVIO_ENTRY_DIRECTORY;
             else if (S_ISFIFO(st.st_mode))
                 (*next)->type = AVIO_ENTRY_NAMED_PIPE;
             else if (S_ISCHR(st.st_mode))
                 (*next)->type = AVIO_ENTRY_CHARACTER_DEVICE;
             else if (S_ISBLK(st.st_mode))
                 (*next)->type = AVIO_ENTRY_BLOCK_DEVICE;
             else if (S_ISLNK(st.st_mode))
                 (*next)->type = AVIO_ENTRY_SYMBOLIC_LINK;
             else if (S_ISSOCK(st.st_mode))
                 (*next)->type = AVIO_ENTRY_SOCKET;
             else if (S_ISREG(st.st_mode))
                 (*next)->type = AVIO_ENTRY_FILE;
             else
                 (*next)->type = AVIO_ENTRY_UNKNOWN;
 
d39a9b01
             (*next)->group_id = st.st_gid;
             (*next)->user_id = st.st_uid;
             (*next)->size = st.st_size;
             (*next)->filemode = st.st_mode & 0777;
             (*next)->modification_timestamp = INT64_C(1000000) * st.st_mtime;
             (*next)->access_timestamp =  INT64_C(1000000) * st.st_atime;
             (*next)->status_change_timestamp = INT64_C(1000000) * st.st_ctime;
         }
         av_free(fullpath);
     }
 
     (*next)->name = av_strdup(dir->d_name);
     return 0;
1f4c62e8
 #else
     return AVERROR(ENOSYS);
d65b9114
 #endif /* HAVE_LSTAT */
d39a9b01
 }
 
 static int file_close_dir(URLContext *h)
 {
d65b9114
 #if HAVE_LSTAT
d39a9b01
     FileContext *c = h->priv_data;
     closedir(c->dir);
     return 0;
1f4c62e8
 #else
     return AVERROR(ENOSYS);
d65b9114
 #endif /* HAVE_LSTAT */
d39a9b01
 }
 
2758cded
 const URLProtocol ff_file_protocol = {
f35ff97f
     .name                = "file",
     .url_open            = file_open,
     .url_read            = file_read,
     .url_write           = file_write,
     .url_seek            = file_seek,
     .url_close           = file_close,
f0a80394
     .url_get_file_handle = file_get_handle,
31317656
     .url_check           = file_check,
824a82d1
     .url_delete          = file_delete,
     .url_move            = file_move,
0697d812
     .priv_data_size      = sizeof(FileContext),
29a9b12b
     .priv_data_class     = &file_class,
d39a9b01
     .url_open_dir        = file_open_dir,
     .url_read_dir        = file_read_dir,
     .url_close_dir       = file_close_dir,
efa98cdc
     .default_whitelist   = "file,crypto"
de6d9b64
 };
 
defb0009
 #endif /* CONFIG_FILE_PROTOCOL */
 
 #if CONFIG_PIPE_PROTOCOL
de6d9b64
 
 static int pipe_open(URLContext *h, const char *filename, int flags)
 {
0697d812
     FileContext *c = h->priv_data;
de6d9b64
     int fd;
fbcb0811
     char *final;
9e33b10f
     av_strstart(filename, "pipe:", &filename);
de6d9b64
 
9e33b10f
     fd = strtol(filename, &final, 10);
     if((filename == final) || *final ) {/* No digits found, or something like 10ab */
59d96941
         if (flags & AVIO_FLAG_WRITE) {
de79849e
             fd = 1;
         } else {
             fd = 0;
         }
9e33b10f
     }
b250f9c6
 #if HAVE_SETMODE
c43e7a66
     setmode(fd, O_BINARY);
 #endif
0697d812
     c->fd = fd;
f9a35124
     h->is_streamed = 1;
de6d9b64
     return 0;
 }
 
2758cded
 const URLProtocol ff_pipe_protocol = {
f35ff97f
     .name                = "pipe",
     .url_open            = pipe_open,
     .url_read            = file_read,
     .url_write           = file_write,
f0a80394
     .url_get_file_handle = file_get_handle,
31317656
     .url_check           = file_check,
0697d812
     .priv_data_size      = sizeof(FileContext),
a8f17115
     .priv_data_class     = &pipe_class,
efa98cdc
     .default_whitelist   = "crypto"
de6d9b64
 };
defb0009
 
 #endif /* CONFIG_PIPE_PROTOCOL */