3 * Copyright (c) 2001 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/avstring.h"
23 #include "libavutil/internal.h"
24 #include "libavutil/opt.h"
38 #include "os_support.h"
41 /* Some systems may not have S_ISFIFO */
44 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
46 # define S_ISFIFO(m) 0
50 /* Not available in POSIX.1-1996 */
53 # define S_ISLNK(m) (((m) & S_IFLNK) == S_IFLNK)
59 /* Not available in POSIX.1-1996 */
62 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
64 # define S_ISSOCK(m) 0
68 /* standard file protocol */
70 typedef struct FileContext {
81 static const AVOption file_options[] = {
82 { "truncate", "truncate existing files on write", offsetof(FileContext, trunc), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
83 { "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 },
84 { "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 },
88 static const AVOption pipe_options[] = {
89 { "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 },
93 static const AVClass file_class = {
95 .item_name = av_default_item_name,
96 .option = file_options,
97 .version = LIBAVUTIL_VERSION_INT,
100 static const AVClass pipe_class = {
101 .class_name = "pipe",
102 .item_name = av_default_item_name,
103 .option = pipe_options,
104 .version = LIBAVUTIL_VERSION_INT,
107 static int file_read(URLContext *h, unsigned char *buf, int size)
109 FileContext *c = h->priv_data;
111 size = FFMIN(size, c->blocksize);
112 ret = read(c->fd, buf, size);
113 if (ret == 0 && c->follow)
114 return AVERROR(EAGAIN);
115 return (ret == -1) ? AVERROR(errno) : ret;
118 static int file_write(URLContext *h, const unsigned char *buf, int size)
120 FileContext *c = h->priv_data;
122 size = FFMIN(size, c->blocksize);
123 ret = write(c->fd, buf, size);
124 return (ret == -1) ? AVERROR(errno) : ret;
127 static int file_get_handle(URLContext *h)
129 FileContext *c = h->priv_data;
133 static int file_check(URLContext *h, int mask)
136 const char *filename = h->filename;
137 av_strstart(filename, "file:", &filename);
140 #if HAVE_ACCESS && defined(R_OK)
141 if (access(filename, F_OK) < 0)
142 return AVERROR(errno);
143 if (mask&AVIO_FLAG_READ)
144 if (access(filename, R_OK) >= 0)
145 ret |= AVIO_FLAG_READ;
146 if (mask&AVIO_FLAG_WRITE)
147 if (access(filename, W_OK) >= 0)
148 ret |= AVIO_FLAG_WRITE;
152 ret = stat(filename, &st);
154 ret = win32_stat(filename, &st);
157 return AVERROR(errno);
159 ret |= st.st_mode&S_IRUSR ? mask&AVIO_FLAG_READ : 0;
160 ret |= st.st_mode&S_IWUSR ? mask&AVIO_FLAG_WRITE : 0;
166 static int file_delete(URLContext *h)
170 const char *filename = h->filename;
171 av_strstart(filename, "file:", &filename);
173 ret = rmdir(filename);
174 if (ret < 0 && errno == ENOTDIR)
175 ret = unlink(filename);
177 return AVERROR(errno);
181 return AVERROR(ENOSYS);
182 #endif /* HAVE_UNISTD_H */
185 static int file_move(URLContext *h_src, URLContext *h_dst)
187 const char *filename_src = h_src->filename;
188 const char *filename_dst = h_dst->filename;
189 av_strstart(filename_src, "file:", &filename_src);
190 av_strstart(filename_dst, "file:", &filename_dst);
192 if (rename(filename_src, filename_dst) < 0)
193 return AVERROR(errno);
198 #if CONFIG_FILE_PROTOCOL
200 static int file_open(URLContext *h, const char *filename, int flags)
202 FileContext *c = h->priv_data;
207 av_strstart(filename, "file:", &filename);
209 if (flags & AVIO_FLAG_WRITE && flags & AVIO_FLAG_READ) {
210 access = O_CREAT | O_RDWR;
213 } else if (flags & AVIO_FLAG_WRITE) {
214 access = O_CREAT | O_WRONLY;
223 fd = avpriv_open(filename, access, 0666);
225 return AVERROR(errno);
228 h->is_streamed = !fstat(fd, &st) && S_ISFIFO(st.st_mode);
233 /* XXX: use llseek */
234 static int64_t file_seek(URLContext *h, int64_t pos, int whence)
236 FileContext *c = h->priv_data;
239 if (whence == AVSEEK_SIZE) {
241 ret = fstat(c->fd, &st);
242 return ret < 0 ? AVERROR(errno) : (S_ISFIFO(st.st_mode) ? 0 : st.st_size);
245 ret = lseek(c->fd, pos, whence);
247 return ret < 0 ? AVERROR(errno) : ret;
250 static int file_close(URLContext *h)
252 FileContext *c = h->priv_data;
256 static int file_open_dir(URLContext *h)
259 FileContext *c = h->priv_data;
261 c->dir = opendir(h->filename);
263 return AVERROR(errno);
267 return AVERROR(ENOSYS);
268 #endif /* HAVE_LSTAT */
271 static int file_read_dir(URLContext *h, AVIODirEntry **next)
274 FileContext *c = h->priv_data;
276 char *fullpath = NULL;
278 *next = ff_alloc_dir_entry();
280 return AVERROR(ENOMEM);
283 dir = readdir(c->dir);
286 return AVERROR(errno);
288 } while (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."));
290 fullpath = av_append_path_component(h->filename, dir->d_name);
293 if (!lstat(fullpath, &st)) {
294 if (S_ISDIR(st.st_mode))
295 (*next)->type = AVIO_ENTRY_DIRECTORY;
296 else if (S_ISFIFO(st.st_mode))
297 (*next)->type = AVIO_ENTRY_NAMED_PIPE;
298 else if (S_ISCHR(st.st_mode))
299 (*next)->type = AVIO_ENTRY_CHARACTER_DEVICE;
300 else if (S_ISBLK(st.st_mode))
301 (*next)->type = AVIO_ENTRY_BLOCK_DEVICE;
302 else if (S_ISLNK(st.st_mode))
303 (*next)->type = AVIO_ENTRY_SYMBOLIC_LINK;
304 else if (S_ISSOCK(st.st_mode))
305 (*next)->type = AVIO_ENTRY_SOCKET;
306 else if (S_ISREG(st.st_mode))
307 (*next)->type = AVIO_ENTRY_FILE;
309 (*next)->type = AVIO_ENTRY_UNKNOWN;
311 (*next)->group_id = st.st_gid;
312 (*next)->user_id = st.st_uid;
313 (*next)->size = st.st_size;
314 (*next)->filemode = st.st_mode & 0777;
315 (*next)->modification_timestamp = INT64_C(1000000) * st.st_mtime;
316 (*next)->access_timestamp = INT64_C(1000000) * st.st_atime;
317 (*next)->status_change_timestamp = INT64_C(1000000) * st.st_ctime;
322 (*next)->name = av_strdup(dir->d_name);
325 return AVERROR(ENOSYS);
326 #endif /* HAVE_LSTAT */
329 static int file_close_dir(URLContext *h)
332 FileContext *c = h->priv_data;
336 return AVERROR(ENOSYS);
337 #endif /* HAVE_LSTAT */
340 const URLProtocol ff_file_protocol = {
342 .url_open = file_open,
343 .url_read = file_read,
344 .url_write = file_write,
345 .url_seek = file_seek,
346 .url_close = file_close,
347 .url_get_file_handle = file_get_handle,
348 .url_check = file_check,
349 .url_delete = file_delete,
350 .url_move = file_move,
351 .priv_data_size = sizeof(FileContext),
352 .priv_data_class = &file_class,
353 .url_open_dir = file_open_dir,
354 .url_read_dir = file_read_dir,
355 .url_close_dir = file_close_dir,
356 .default_whitelist = "file,crypto"
359 #endif /* CONFIG_FILE_PROTOCOL */
361 #if CONFIG_PIPE_PROTOCOL
363 static int pipe_open(URLContext *h, const char *filename, int flags)
365 FileContext *c = h->priv_data;
368 av_strstart(filename, "pipe:", &filename);
370 fd = strtol(filename, &final, 10);
371 if((filename == final) || *final ) {/* No digits found, or something like 10ab */
372 if (flags & AVIO_FLAG_WRITE) {
379 setmode(fd, O_BINARY);
386 const URLProtocol ff_pipe_protocol = {
388 .url_open = pipe_open,
389 .url_read = file_read,
390 .url_write = file_write,
391 .url_get_file_handle = file_get_handle,
392 .url_check = file_check,
393 .priv_data_size = sizeof(FileContext),
394 .priv_data_class = &pipe_class,
395 .default_whitelist = "crypto"
398 #endif /* CONFIG_PIPE_PROTOCOL */