FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cache.c
Go to the documentation of this file.
1 /*
2  * Input cache protocol.
3  * Copyright (c) 2011,2014 Michael Niedermayer
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  * Based on file.c by Fabrice Bellard
22  */
23 
24 /**
25  * @TODO
26  * support keeping files
27  * support filling with a background thread
28  */
29 
30 #include "libavutil/avassert.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/file.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/tree.h"
35 #include "avformat.h"
36 #include <fcntl.h>
37 #if HAVE_IO_H
38 #include <io.h>
39 #endif
40 #if HAVE_UNISTD_H
41 #include <unistd.h>
42 #endif
43 #include <sys/stat.h>
44 #include <stdlib.h>
45 #include "os_support.h"
46 #include "url.h"
47 
48 typedef struct CacheEntry {
49  int64_t logical_pos;
50  int64_t physical_pos;
51  int size;
52 } CacheEntry;
53 
54 typedef struct Context {
55  AVClass *class;
56  int fd;
57  struct AVTreeNode *root;
58  int64_t logical_pos;
59  int64_t cache_pos;
60  int64_t inner_pos;
61  int64_t end;
66 } Context;
67 
68 static int cmp(void *key, const void *node)
69 {
70  return (*(int64_t *) key) - ((const CacheEntry *) node)->logical_pos;
71 }
72 
73 static int cache_open(URLContext *h, const char *arg, int flags, AVDictionary **options)
74 {
75  char *buffername;
76  Context *c= h->priv_data;
77 
78  av_strstart(arg, "cache:", &arg);
79 
80  c->fd = av_tempfile("ffcache", &buffername, 0, h);
81  if (c->fd < 0){
82  av_log(h, AV_LOG_ERROR, "Failed to create tempfile\n");
83  return c->fd;
84  }
85 
86  unlink(buffername);
87  av_freep(&buffername);
88 
89  return ffurl_open(&c->inner, arg, flags, &h->interrupt_callback, options);
90 }
91 
92 static int add_entry(URLContext *h, const unsigned char *buf, int size)
93 {
94  Context *c= h->priv_data;
95  int64_t pos = -1;
96  int ret;
97  CacheEntry *entry = NULL, *next[2] = {NULL, NULL};
98  CacheEntry *entry_ret;
99  struct AVTreeNode *node = NULL;
100 
101  //FIXME avoid lseek
102  pos = lseek(c->fd, 0, SEEK_END);
103  if (pos < 0) {
104  ret = AVERROR(errno);
105  av_log(h, AV_LOG_ERROR, "seek in cache failed\n");
106  goto fail;
107  }
108  c->cache_pos = pos;
109 
110  ret = write(c->fd, buf, size);
111  if (ret < 0) {
112  ret = AVERROR(errno);
113  av_log(h, AV_LOG_ERROR, "write in cache failed\n");
114  goto fail;
115  }
116  c->cache_pos += ret;
117 
118  entry = av_tree_find(c->root, &c->logical_pos, cmp, (void**)next);
119 
120  if (!entry)
121  entry = next[0];
122 
123  if (!entry ||
124  entry->logical_pos + entry->size != c->logical_pos ||
125  entry->physical_pos + entry->size != pos
126  ) {
127  entry = av_malloc(sizeof(*entry));
128  node = av_tree_node_alloc();
129  if (!entry || !node) {
130  ret = AVERROR(ENOMEM);
131  goto fail;
132  }
133  entry->logical_pos = c->logical_pos;
134  entry->physical_pos = pos;
135  entry->size = ret;
136 
137  entry_ret = av_tree_insert(&c->root, entry, cmp, &node);
138  if (entry_ret && entry_ret != entry) {
139  ret = -1;
140  av_log(h, AV_LOG_ERROR, "av_tree_insert failed\n");
141  goto fail;
142  }
143  } else
144  entry->size += ret;
145 
146  return 0;
147 fail:
148  //we could truncate the file to pos here if pos >=0 but ftruncate isn't available in VS so
149  //for simplicty we just leave the file a bit larger
150  av_free(entry);
151  av_free(node);
152  return ret;
153 }
154 
155 static int cache_read(URLContext *h, unsigned char *buf, int size)
156 {
157  Context *c= h->priv_data;
158  CacheEntry *entry, *next[2] = {NULL, NULL};
159  int r;
160 
161  entry = av_tree_find(c->root, &c->logical_pos, cmp, (void**)next);
162 
163  if (!entry)
164  entry = next[0];
165 
166  if (entry) {
167  int64_t in_block_pos = c->logical_pos - entry->logical_pos;
168  av_assert0(entry->logical_pos <= c->logical_pos);
169  if (in_block_pos < entry->size) {
170  int64_t physical_target = entry->physical_pos + in_block_pos;
171 
172  if (c->cache_pos != physical_target) {
173  r = lseek(c->fd, physical_target, SEEK_SET);
174  } else
175  r = c->cache_pos;
176 
177  if (r >= 0) {
178  c->cache_pos = r;
179  r = read(c->fd, buf, FFMIN(size, entry->size - in_block_pos));
180  }
181 
182  if (r > 0) {
183  c->cache_pos += r;
184  c->logical_pos += r;
185  c->cache_hit ++;
186  return r;
187  }
188  }
189  }
190 
191  // Cache miss or some kind of fault with the cache
192 
193  if (c->logical_pos != c->inner_pos) {
194  r = ffurl_seek(c->inner, c->logical_pos, SEEK_SET);
195  if (r<0) {
196  av_log(h, AV_LOG_ERROR, "Failed to perform internal seek\n");
197  return r;
198  }
199  c->inner_pos = r;
200  }
201 
202  r = ffurl_read(c->inner, buf, size);
203  if (r == 0 && size>0) {
204  c->is_true_eof = 1;
205  av_assert0(c->end >= c->logical_pos);
206  }
207  if (r<=0)
208  return r;
209  c->inner_pos += r;
210 
211  c->cache_miss ++;
212 
213  add_entry(h, buf, r);
214  c->logical_pos += r;
215  c->end = FFMAX(c->end, c->logical_pos);
216 
217  return r;
218 }
219 
220 static int64_t cache_seek(URLContext *h, int64_t pos, int whence)
221 {
222  Context *c= h->priv_data;
223  int64_t ret;
224 
225  if (whence == AVSEEK_SIZE) {
226  pos= ffurl_seek(c->inner, pos, whence);
227  if(pos <= 0){
228  pos= ffurl_seek(c->inner, -1, SEEK_END);
229  if (ffurl_seek(c->inner, c->inner_pos, SEEK_SET) < 0)
230  av_log(h, AV_LOG_ERROR, "Inner protocol failed to seekback end : %"PRId64"\n", pos);
231  }
232  if (pos > 0)
233  c->is_true_eof = 1;
234  c->end = FFMAX(c->end, pos);
235  return pos;
236  }
237 
238  if (whence == SEEK_CUR) {
239  whence = SEEK_SET;
240  pos += c->logical_pos;
241  } else if (whence == SEEK_END && c->is_true_eof) {
242 resolve_eof:
243  whence = SEEK_SET;
244  pos += c->end;
245  }
246 
247  if (whence == SEEK_SET && pos >= 0 && pos < c->end) {
248  //Seems within filesize, assume it will not fail.
249  c->logical_pos = pos;
250  return pos;
251  }
252 
253  //cache miss
254  ret= ffurl_seek(c->inner, pos, whence);
255  if ((whence == SEEK_SET && pos >= c->logical_pos ||
256  whence == SEEK_END && pos <= 0) && ret < 0) {
257  if ( (whence == SEEK_SET && c->read_ahead_limit >= pos - c->logical_pos)
258  || c->read_ahead_limit < 0) {
259  uint8_t tmp[32768];
260  while (c->logical_pos < pos || whence == SEEK_END) {
261  int size = sizeof(tmp);
262  if (whence == SEEK_SET)
263  size = FFMIN(sizeof(tmp), pos - c->logical_pos);
264  ret = cache_read(h, tmp, size);
265  if (ret == 0 && whence == SEEK_END) {
267  goto resolve_eof;
268  }
269  if (ret < 0) {
270  return ret;
271  }
272  }
273  return c->logical_pos;
274  }
275  }
276 
277  if (ret >= 0) {
278  c->logical_pos = ret;
279  c->end = FFMAX(c->end, ret);
280  }
281 
282  return ret;
283 }
284 
286 {
287  Context *c= h->priv_data;
288 
289  av_log(h, AV_LOG_INFO, "Statistics, cache hits:%"PRId64" cache misses:%"PRId64"\n",
290  c->cache_hit, c->cache_miss);
291 
292  close(c->fd);
293  ffurl_close(c->inner);
294  av_tree_destroy(c->root);
295 
296  return 0;
297 }
298 
299 #define OFFSET(x) offsetof(Context, x)
300 #define D AV_OPT_FLAG_DECODING_PARAM
301 
302 static const AVOption options[] = {
303  { "read_ahead_limit", "Amount in bytes that may be read ahead when seeking isn't supported, -1 for unlimited", OFFSET(read_ahead_limit), AV_OPT_TYPE_INT, { .i64 = 65536 }, -1, INT_MAX, D },
304  {NULL},
305 };
306 
307 static const AVClass cache_context_class = {
308  .class_name = "Cache",
309  .item_name = av_default_item_name,
310  .option = options,
311  .version = LIBAVUTIL_VERSION_INT,
312 };
313 
315  .name = "cache",
316  .url_open2 = cache_open,
317  .url_read = cache_read,
318  .url_seek = cache_seek,
319  .url_close = cache_close,
320  .priv_data_size = sizeof(Context),
321  .priv_data_class = &cache_context_class,
322 };
Definition: cache.c:54
#define NULL
Definition: coverity.c:32
int64_t inner_pos
Definition: cache.c:60
AVOption.
Definition: opt.h:255
support keeping files support filling with a background thread
Definition: cache.c:48
#define LIBAVUTIL_VERSION_INT
Definition: version.h:62
struct AVTreeNode * root
Definition: cache.c:57
AVIOInterruptCB interrupt_callback
Definition: url.h:48
static const AVClass cache_context_class
Definition: cache.c:307
static const AVOption options[]
Definition: cache.c:302
URLContext * inner
Definition: cache.c:63
struct AVTreeNode * av_tree_node_alloc(void)
Allocate an AVTreeNode.
Definition: tree.c:34
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
void * av_tree_find(const AVTreeNode *t, void *key, int(*cmp)(void *key, const void *b), void *next[2])
Definition: tree.c:39
uint8_t
#define av_malloc(s)
AVOptions.
A tree container.
miscellaneous OS support macros and functions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:67
int64_t cache_hit
Definition: cache.c:64
int size
Definition: cache.c:51
URLProtocol ff_cache_protocol
Definition: cache.c:314
int64_t end
Definition: cache.c:61
int read_ahead_limit
Definition: cache.c:65
Misc file utilities.
ptrdiff_t size
Definition: opengl_enc.c:101
int64_t cache_miss
Definition: cache.c:64
#define av_log(a,...)
void av_tree_destroy(AVTreeNode *t)
Definition: tree.c:146
void * av_tree_insert(AVTreeNode **tp, void *key, int(*cmp)(void *key, const void *b), AVTreeNode **next)
Insert or remove an element.
Definition: tree.c:59
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int64_t logical_pos
Definition: cache.c:58
int fd
Definition: cache.c:56
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
const char * r
Definition: vf_curves.c:107
const char * arg
Definition: jacosubdec.c:66
simple assert() macros that are a bit more flexible than ISO C assert().
#define FFMAX(a, b)
Definition: common.h:64
static int cache_open(URLContext *h, const char *arg, int flags, AVDictionary **options)
Definition: cache.c:73
static int cmp(void *key, const void *node)
Definition: cache.c:68
static int cache_close(URLContext *h)
Definition: cache.c:285
#define FFMIN(a, b)
Definition: common.h:66
ret
Definition: avfilter.c:974
int64_t logical_pos
Definition: cache.c:49
#define D
Definition: cache.c:300
#define OFFSET(x)
Definition: cache.c:299
static int64_t cache_seek(URLContext *h, int64_t pos, int whence)
Definition: cache.c:220
int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx)
Wrapper to work around the lack of mkstemp() on mingw.
Definition: file.c:140
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
void * buf
Definition: avisynth_c.h:553
Definition: url.h:39
static int cache_read(URLContext *h, unsigned char *buf, int size)
Definition: cache.c:155
Describe the class of an AVClass context structure.
Definition: log.h:67
void * priv_data
Definition: url.h:42
const char * name
Definition: url.h:53
static int flags
Definition: cpu.c:47
int ffurl_close(URLContext *h)
Definition: avio.c:392
int av_strstart(const char *str, const char *pfx, const char **ptr)
Return non-zero if pfx is a prefix of str.
Definition: avstring.c:34
Main libavformat public API header.
int64_t cache_pos
Definition: cache.c:59
int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
Change the position that will be used by the next read/write operation on the resource accessed by h...
Definition: avio.c:360
int ffurl_open(URLContext **puc, const char *filename, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options)
Create an URLContext for accessing to the resource indicated by url, and open it. ...
Definition: avio.c:272
static double c[64]
#define AVSEEK_SIZE
Passing this as the "whence" parameter to a seek function causes it to return the filesize without se...
Definition: avio.h:364
#define av_free(p)
int64_t physical_pos
Definition: cache.c:50
static int add_entry(URLContext *h, const unsigned char *buf, int size)
Definition: cache.c:92
#define av_freep(p)
unbuffered private I/O API
int ffurl_read(URLContext *h, unsigned char *buf, int size)
Read up to size bytes from the resource accessed by h, and store the read bytes in buf...
Definition: avio.c:333
int is_true_eof
Definition: cache.c:62