5765ce7e482c0ddc40e68e79104b80535c3fed7c
[ffmpeg.git] / libavformat / file.c
1 /*
2  * buffered file I/O
3  * Copyright (c) 2001 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "libavutil/avstring.h"
23 #include "libavutil/internal.h"
24 #include "libavutil/opt.h"
25 #include "avformat.h"
26 #if HAVE_DIRENT_H
27 #include <dirent.h>
28 #endif
29 #include <fcntl.h>
30 #if HAVE_IO_H
31 #include <io.h>
32 #endif
33 #if HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36 #include <sys/stat.h>
37 #include <stdlib.h>
38 #include "os_support.h"
39 #include "url.h"
40
41 /* Some systems may not have S_ISFIFO */
42 #ifndef S_ISFIFO
43 #  ifdef S_IFIFO
44 #    define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
45 #  else
46 #    define S_ISFIFO(m) 0
47 #  endif
48 #endif
49
50 /* Not available in POSIX.1-1996 */
51 #ifndef S_ISLNK
52 #  ifdef S_IFLNK
53 #    define S_ISLNK(m) (((m) & S_IFLNK) == S_IFLNK)
54 #  else
55 #    define S_ISLNK(m) 0
56 #  endif
57 #endif
58
59 /* Not available in POSIX.1-1996 */
60 #ifndef S_ISSOCK
61 #  ifdef S_IFSOCK
62 #    define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
63 #  else
64 #    define S_ISSOCK(m) 0
65 #  endif
66 #endif
67
68 /* standard file protocol */
69
70 typedef struct FileContext {
71     const AVClass *class;
72     int fd;
73     int trunc;
74     int blocksize;
75     int follow;
76 #if HAVE_DIRENT_H
77     DIR *dir;
78 #endif
79 } FileContext;
80
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 },
85     { NULL }
86 };
87
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 },
90     { NULL }
91 };
92
93 static const AVClass file_class = {
94     .class_name = "file",
95     .item_name  = av_default_item_name,
96     .option     = file_options,
97     .version    = LIBAVUTIL_VERSION_INT,
98 };
99
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,
105 };
106
107 static int file_read(URLContext *h, unsigned char *buf, int size)
108 {
109     FileContext *c = h->priv_data;
110     int ret;
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;
116 }
117
118 static int file_write(URLContext *h, const unsigned char *buf, int size)
119 {
120     FileContext *c = h->priv_data;
121     int ret;
122     size = FFMIN(size, c->blocksize);
123     ret = write(c->fd, buf, size);
124     return (ret == -1) ? AVERROR(errno) : ret;
125 }
126
127 static int file_get_handle(URLContext *h)
128 {
129     FileContext *c = h->priv_data;
130     return c->fd;
131 }
132
133 static int file_check(URLContext *h, int mask)
134 {
135     int ret = 0;
136     const char *filename = h->filename;
137     av_strstart(filename, "file:", &filename);
138
139     {
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;
149 #else
150     struct stat st;
151     ret = stat(filename, &st);
152     if (ret < 0)
153         return AVERROR(errno);
154
155     ret |= st.st_mode&S_IRUSR ? mask&AVIO_FLAG_READ  : 0;
156     ret |= st.st_mode&S_IWUSR ? mask&AVIO_FLAG_WRITE : 0;
157 #endif
158     }
159     return ret;
160 }
161
162 static int file_delete(URLContext *h)
163 {
164 #if HAVE_UNISTD_H
165     int ret;
166     const char *filename = h->filename;
167     av_strstart(filename, "file:", &filename);
168
169     ret = rmdir(filename);
170     if (ret < 0 && errno == ENOTDIR)
171         ret = unlink(filename);
172     if (ret < 0)
173         return AVERROR(errno);
174
175     return ret;
176 #else
177     return AVERROR(ENOSYS);
178 #endif /* HAVE_UNISTD_H */
179 }
180
181 static int file_move(URLContext *h_src, URLContext *h_dst)
182 {
183     const char *filename_src = h_src->filename;
184     const char *filename_dst = h_dst->filename;
185     av_strstart(filename_src, "file:", &filename_src);
186     av_strstart(filename_dst, "file:", &filename_dst);
187
188     if (rename(filename_src, filename_dst) < 0)
189         return AVERROR(errno);
190
191     return 0;
192 }
193
194 #if CONFIG_FILE_PROTOCOL
195
196 static int file_open(URLContext *h, const char *filename, int flags)
197 {
198     FileContext *c = h->priv_data;
199     int access;
200     int fd;
201     struct stat st;
202
203     av_strstart(filename, "file:", &filename);
204
205     if (flags & AVIO_FLAG_WRITE && flags & AVIO_FLAG_READ) {
206         access = O_CREAT | O_RDWR;
207         if (c->trunc)
208             access |= O_TRUNC;
209     } else if (flags & AVIO_FLAG_WRITE) {
210         access = O_CREAT | O_WRONLY;
211         if (c->trunc)
212             access |= O_TRUNC;
213     } else {
214         access = O_RDONLY;
215     }
216 #ifdef O_BINARY
217     access |= O_BINARY;
218 #endif
219     fd = avpriv_open(filename, access, 0666);
220     if (fd == -1)
221         return AVERROR(errno);
222     c->fd = fd;
223
224     h->is_streamed = !fstat(fd, &st) && S_ISFIFO(st.st_mode);
225
226     return 0;
227 }
228
229 /* XXX: use llseek */
230 static int64_t file_seek(URLContext *h, int64_t pos, int whence)
231 {
232     FileContext *c = h->priv_data;
233     int64_t ret;
234
235     if (whence == AVSEEK_SIZE) {
236         struct stat st;
237         ret = fstat(c->fd, &st);
238         return ret < 0 ? AVERROR(errno) : (S_ISFIFO(st.st_mode) ? 0 : st.st_size);
239     }
240
241     ret = lseek(c->fd, pos, whence);
242
243     return ret < 0 ? AVERROR(errno) : ret;
244 }
245
246 static int file_close(URLContext *h)
247 {
248     FileContext *c = h->priv_data;
249     return close(c->fd);
250 }
251
252 static int file_open_dir(URLContext *h)
253 {
254 #if HAVE_LSTAT
255     FileContext *c = h->priv_data;
256
257     c->dir = opendir(h->filename);
258     if (!c->dir)
259         return AVERROR(errno);
260
261     return 0;
262 #else
263     return AVERROR(ENOSYS);
264 #endif /* HAVE_LSTAT */
265 }
266
267 static int file_read_dir(URLContext *h, AVIODirEntry **next)
268 {
269 #if HAVE_LSTAT
270     FileContext *c = h->priv_data;
271     struct dirent *dir;
272     char *fullpath = NULL;
273
274     *next = ff_alloc_dir_entry();
275     if (!*next)
276         return AVERROR(ENOMEM);
277     do {
278         errno = 0;
279         dir = readdir(c->dir);
280         if (!dir) {
281             av_freep(next);
282             return AVERROR(errno);
283         }
284     } while (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."));
285
286     fullpath = av_append_path_component(h->filename, dir->d_name);
287     if (fullpath) {
288         struct stat st;
289         if (!lstat(fullpath, &st)) {
290             if (S_ISDIR(st.st_mode))
291                 (*next)->type = AVIO_ENTRY_DIRECTORY;
292             else if (S_ISFIFO(st.st_mode))
293                 (*next)->type = AVIO_ENTRY_NAMED_PIPE;
294             else if (S_ISCHR(st.st_mode))
295                 (*next)->type = AVIO_ENTRY_CHARACTER_DEVICE;
296             else if (S_ISBLK(st.st_mode))
297                 (*next)->type = AVIO_ENTRY_BLOCK_DEVICE;
298             else if (S_ISLNK(st.st_mode))
299                 (*next)->type = AVIO_ENTRY_SYMBOLIC_LINK;
300             else if (S_ISSOCK(st.st_mode))
301                 (*next)->type = AVIO_ENTRY_SOCKET;
302             else if (S_ISREG(st.st_mode))
303                 (*next)->type = AVIO_ENTRY_FILE;
304             else
305                 (*next)->type = AVIO_ENTRY_UNKNOWN;
306
307             (*next)->group_id = st.st_gid;
308             (*next)->user_id = st.st_uid;
309             (*next)->size = st.st_size;
310             (*next)->filemode = st.st_mode & 0777;
311             (*next)->modification_timestamp = INT64_C(1000000) * st.st_mtime;
312             (*next)->access_timestamp =  INT64_C(1000000) * st.st_atime;
313             (*next)->status_change_timestamp = INT64_C(1000000) * st.st_ctime;
314         }
315         av_free(fullpath);
316     }
317
318     (*next)->name = av_strdup(dir->d_name);
319     return 0;
320 #else
321     return AVERROR(ENOSYS);
322 #endif /* HAVE_LSTAT */
323 }
324
325 static int file_close_dir(URLContext *h)
326 {
327 #if HAVE_LSTAT
328     FileContext *c = h->priv_data;
329     closedir(c->dir);
330     return 0;
331 #else
332     return AVERROR(ENOSYS);
333 #endif /* HAVE_LSTAT */
334 }
335
336 const URLProtocol ff_file_protocol = {
337     .name                = "file",
338     .url_open            = file_open,
339     .url_read            = file_read,
340     .url_write           = file_write,
341     .url_seek            = file_seek,
342     .url_close           = file_close,
343     .url_get_file_handle = file_get_handle,
344     .url_check           = file_check,
345     .url_delete          = file_delete,
346     .url_move            = file_move,
347     .priv_data_size      = sizeof(FileContext),
348     .priv_data_class     = &file_class,
349     .url_open_dir        = file_open_dir,
350     .url_read_dir        = file_read_dir,
351     .url_close_dir       = file_close_dir,
352     .default_whitelist   = "file,crypto"
353 };
354
355 #endif /* CONFIG_FILE_PROTOCOL */
356
357 #if CONFIG_PIPE_PROTOCOL
358
359 static int pipe_open(URLContext *h, const char *filename, int flags)
360 {
361     FileContext *c = h->priv_data;
362     int fd;
363     char *final;
364     av_strstart(filename, "pipe:", &filename);
365
366     fd = strtol(filename, &final, 10);
367     if((filename == final) || *final ) {/* No digits found, or something like 10ab */
368         if (flags & AVIO_FLAG_WRITE) {
369             fd = 1;
370         } else {
371             fd = 0;
372         }
373     }
374 #if HAVE_SETMODE
375     setmode(fd, O_BINARY);
376 #endif
377     c->fd = fd;
378     h->is_streamed = 1;
379     return 0;
380 }
381
382 const URLProtocol ff_pipe_protocol = {
383     .name                = "pipe",
384     .url_open            = pipe_open,
385     .url_read            = file_read,
386     .url_write           = file_write,
387     .url_get_file_handle = file_get_handle,
388     .url_check           = file_check,
389     .priv_data_size      = sizeof(FileContext),
390     .priv_data_class     = &pipe_class,
391     .default_whitelist   = "crypto"
392 };
393
394 #endif /* CONFIG_PIPE_PROTOCOL */