2 * Input async protocol.
3 * Copyright (c) 2015 Zhang Rui <bbcallen@gmail.com>
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
21 * Based on libavformat/cache.c by Michael Niedermayer
27 * support backward short seek
28 * support work with concatdec, hls
31 #include "libavutil/avassert.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/error.h"
34 #include "libavutil/fifo.h"
35 #include "libavutil/log.h"
36 #include "libavutil/opt.h"
45 #define BUFFER_CAPACITY (4 * 1024 * 1024)
46 #define SHORT_SEEK_THRESHOLD (256 * 1024)
48 typedef struct Context {
65 pthread_cond_t cond_wakeup_main;
66 pthread_cond_t cond_wakeup_background;
67 pthread_mutex_t mutex;
68 pthread_t async_buffer_thread;
71 AVIOInterruptCB interrupt_callback;
74 static int async_check_interrupt(void *arg)
77 Context *c = h->priv_data;
82 if (ff_check_interrupt(&c->interrupt_callback))
85 return c->abort_request;
88 static void *async_buffer_task(void *arg)
91 Context *c = h->priv_data;
92 AVFifoBuffer *fifo = c->fifo;
96 int fifo_space, to_copy;
98 if (async_check_interrupt(h)) {
99 c->io_eof_reached = 1;
100 c->io_error = AVERROR_EXIT;
104 if (c->seek_request) {
105 pthread_mutex_lock(&c->mutex);
107 ret = ffurl_seek(c->inner, c->seek_pos, c->seek_whence);
109 c->io_eof_reached = 1;
112 c->io_eof_reached = 0;
116 c->seek_completed = 1;
122 pthread_cond_signal(&c->cond_wakeup_main);
123 pthread_mutex_unlock(&c->mutex);
127 fifo_space = av_fifo_space(fifo);
128 if (c->io_eof_reached || fifo_space <= 0) {
129 pthread_mutex_lock(&c->mutex);
130 pthread_cond_signal(&c->cond_wakeup_main);
131 pthread_cond_wait(&c->cond_wakeup_background, &c->mutex);
132 pthread_mutex_unlock(&c->mutex);
136 to_copy = FFMIN(4096, fifo_space);
137 ret = av_fifo_generic_write(fifo, c->inner, to_copy, (void *)ffurl_read);
139 c->io_eof_reached = 1;
145 pthread_mutex_lock(&c->mutex);
146 pthread_cond_signal(&c->cond_wakeup_main);
147 pthread_mutex_unlock(&c->mutex);
153 static int async_open(URLContext *h, const char *arg, int flags, AVDictionary **options)
155 Context *c = h->priv_data;
157 AVIOInterruptCB interrupt_callback = {.callback = async_check_interrupt, .opaque = h};
159 av_strstart(arg, "async:", &arg);
161 c->fifo = av_fifo_alloc(BUFFER_CAPACITY);
163 ret = AVERROR(ENOMEM);
167 /* wrap interrupt callback */
168 c->interrupt_callback = h->interrupt_callback;
169 ret = ffurl_open(&c->inner, arg, flags, &interrupt_callback, options);
171 av_log(h, AV_LOG_ERROR, "ffurl_open failed : %s, %s\n", strerror(ret), arg);
175 c->logical_size = ffurl_size(c->inner);
176 h->is_streamed = c->inner->is_streamed;
178 ret = pthread_mutex_init(&c->mutex, NULL);
180 av_log(h, AV_LOG_ERROR, "pthread_mutex_init failed : %s\n", strerror(ret));
184 ret = pthread_cond_init(&c->cond_wakeup_main, NULL);
186 av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
187 goto cond_wakeup_main_fail;
190 ret = pthread_cond_init(&c->cond_wakeup_background, NULL);
192 av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
193 goto cond_wakeup_background_fail;
196 ret = pthread_create(&c->async_buffer_thread, NULL, async_buffer_task, h);
198 av_log(h, AV_LOG_ERROR, "pthread_create failed : %s\n", strerror(ret));
205 pthread_cond_destroy(&c->cond_wakeup_background);
206 cond_wakeup_background_fail:
207 pthread_cond_destroy(&c->cond_wakeup_main);
208 cond_wakeup_main_fail:
209 pthread_mutex_destroy(&c->mutex);
211 ffurl_close(c->inner);
213 av_fifo_freep(&c->fifo);
218 static int async_close(URLContext *h)
220 Context *c = h->priv_data;
223 pthread_mutex_lock(&c->mutex);
224 c->abort_request = 1;
225 pthread_cond_signal(&c->cond_wakeup_background);
226 pthread_mutex_unlock(&c->mutex);
228 ret = pthread_join(c->async_buffer_thread, NULL);
230 av_log(h, AV_LOG_ERROR, "pthread_join(): %s\n", strerror(ret));
232 pthread_cond_destroy(&c->cond_wakeup_background);
233 pthread_cond_destroy(&c->cond_wakeup_main);
234 pthread_mutex_destroy(&c->mutex);
235 ffurl_close(c->inner);
236 av_fifo_freep(&c->fifo);
241 static int async_read_internal(URLContext *h, void *dest, int size, int read_complete,
242 void (*func)(void*, void*, int))
244 Context *c = h->priv_data;
245 AVFifoBuffer *fifo = c->fifo;
249 pthread_mutex_lock(&c->mutex);
251 while (to_read > 0) {
252 int fifo_size, to_copy;
253 if (async_check_interrupt(h)) {
257 fifo_size = av_fifo_size(fifo);
258 to_copy = FFMIN(to_read, fifo_size);
260 av_fifo_generic_read(fifo, dest, to_copy, func);
262 dest = (uint8_t *)dest + to_copy;
263 c->logical_pos += to_copy;
265 ret = size - to_read;
267 if (to_read <= 0 || !read_complete)
269 } else if (c->io_eof_reached) {
274 pthread_cond_signal(&c->cond_wakeup_background);
275 pthread_cond_wait(&c->cond_wakeup_main, &c->mutex);
278 pthread_cond_signal(&c->cond_wakeup_background);
279 pthread_mutex_unlock(&c->mutex);
284 static int async_read(URLContext *h, unsigned char *buf, int size)
286 return async_read_internal(h, buf, size, 0, NULL);
289 static void fifo_do_not_copy_func(void* dest, void* src, int size) {
293 static int64_t async_seek(URLContext *h, int64_t pos, int whence)
295 Context *c = h->priv_data;
296 AVFifoBuffer *fifo = c->fifo;
298 int64_t new_logical_pos;
301 if (whence == AVSEEK_SIZE) {
302 av_log(h, AV_LOG_TRACE, "async_seek: AVSEEK_SIZE: %"PRId64"\n", (int64_t)c->logical_size);
303 return c->logical_size;
304 } else if (whence == SEEK_CUR) {
305 av_log(h, AV_LOG_TRACE, "async_seek: %"PRId64"\n", pos);
306 new_logical_pos = pos + c->logical_pos;
307 } else if (whence == SEEK_SET){
308 av_log(h, AV_LOG_TRACE, "async_seek: %"PRId64"\n", pos);
309 new_logical_pos = pos;
311 return AVERROR(EINVAL);
313 if (new_logical_pos < 0)
314 return AVERROR(EINVAL);
316 fifo_size = av_fifo_size(fifo);
317 if (new_logical_pos == c->logical_pos) {
318 /* current position */
319 return c->logical_pos;
320 } else if ((new_logical_pos > c->logical_pos) &&
321 (new_logical_pos < (c->logical_pos + fifo_size + SHORT_SEEK_THRESHOLD))) {
323 av_log(h, AV_LOG_TRACE, "async_seek: fask_seek %"PRId64" from %d dist:%d/%d\n",
324 new_logical_pos, (int)c->logical_pos,
325 (int)(new_logical_pos - c->logical_pos), fifo_size);
326 async_read_internal(h, NULL, new_logical_pos - c->logical_pos, 1, fifo_do_not_copy_func);
327 return c->logical_pos;
328 } else if (c->logical_size <= 0) {
330 return AVERROR(EINVAL);
331 } else if (new_logical_pos > c->logical_size) {
333 return AVERROR(EINVAL);
336 pthread_mutex_lock(&c->mutex);
339 c->seek_pos = new_logical_pos;
340 c->seek_whence = SEEK_SET;
341 c->seek_completed = 0;
345 if (async_check_interrupt(h)) {
349 if (c->seek_completed) {
350 if (c->seek_ret >= 0)
351 c->logical_pos = c->seek_ret;
355 pthread_cond_signal(&c->cond_wakeup_background);
356 pthread_cond_wait(&c->cond_wakeup_main, &c->mutex);
359 pthread_mutex_unlock(&c->mutex);
364 #define OFFSET(x) offsetof(Context, x)
365 #define D AV_OPT_FLAG_DECODING_PARAM
367 static const AVOption options[] = {
371 static const AVClass async_context_class = {
372 .class_name = "Async",
373 .item_name = av_default_item_name,
375 .version = LIBAVUTIL_VERSION_INT,
378 URLProtocol ff_async_protocol = {
380 .url_open2 = async_open,
381 .url_read = async_read,
382 .url_seek = async_seek,
383 .url_close = async_close,
384 .priv_data_size = sizeof(Context),
385 .priv_data_class = &async_context_class,
390 #define TEST_SEEK_POS (1536)
391 #define TEST_STREAM_SIZE (2048)
393 typedef struct TestContext {
399 static int async_test_open(URLContext *h, const char *arg, int flags, AVDictionary **options)
401 TestContext *c = h->priv_data;
403 c->logical_size = TEST_STREAM_SIZE;
407 static int async_test_close(URLContext *h)
412 static int async_test_read(URLContext *h, unsigned char *buf, int size)
414 TestContext *c = h->priv_data;
418 if (c->logical_pos >= c->logical_size)
421 for (i = 0; i < size; ++i) {
422 buf[i] = c->logical_pos & 0xFF;
427 if (c->logical_pos >= c->logical_size)
434 static int64_t async_test_seek(URLContext *h, int64_t pos, int whence)
436 TestContext *c = h->priv_data;
437 int64_t new_logical_pos;
439 if (whence == AVSEEK_SIZE) {
440 return c->logical_size;
441 } else if (whence == SEEK_CUR) {
442 new_logical_pos = pos + c->logical_pos;
443 } else if (whence == SEEK_SET){
444 new_logical_pos = pos;
446 return AVERROR(EINVAL);
448 if (new_logical_pos < 0)
449 return AVERROR(EINVAL);
451 c->logical_pos = new_logical_pos;
452 return new_logical_pos;
455 static const AVClass async_test_context_class = {
456 .class_name = "Async-Test",
457 .item_name = av_default_item_name,
458 .version = LIBAVUTIL_VERSION_INT,
461 URLProtocol ff_async_test_protocol = {
462 .name = "async-test",
463 .url_open2 = async_test_open,
464 .url_read = async_test_read,
465 .url_seek = async_test_seek,
466 .url_close = async_test_close,
467 .priv_data_size = sizeof(TestContext),
468 .priv_data_class = &async_test_context_class,
473 URLContext *h = NULL;
479 unsigned char buf[4096];
481 ffurl_register_protocol(&ff_async_protocol);
482 ffurl_register_protocol(&ff_async_test_protocol);
484 ret = ffurl_open(&h, "async:async-test:", AVIO_FLAG_READ, NULL, NULL);
485 printf("open: %d\n", ret);
487 size = ffurl_size(h);
488 printf("size: %"PRId64"\n", size);
490 pos = ffurl_seek(h, 0, SEEK_CUR);
493 ret = ffurl_read(h, buf, sizeof(buf));
494 if (ret == AVERROR_EOF) {
495 printf("read-error: AVERROR_EOF at %"PRId64"\n", ffurl_seek(h, 0, SEEK_CUR));
501 printf("read-error: %d at %"PRId64"\n", ret, ffurl_seek(h, 0, SEEK_CUR));
504 for (i = 0; i < ret; ++i) {
505 if (buf[i] != (pos & 0xFF)) {
506 printf("read-mismatch: actual %d, expecting %d, at %"PRId64"\n",
507 (int)buf[i], (int)(pos & 0xFF), pos);
516 printf("read: %"PRId64"\n", read_len);
518 ret = ffurl_read(h, buf, 1);
519 printf("read: %d\n", ret);
521 pos = ffurl_seek(h, TEST_SEEK_POS, SEEK_SET);
522 printf("seek: %"PRId64"\n", pos);
526 ret = ffurl_read(h, buf, sizeof(buf));
527 if (ret == AVERROR_EOF)
532 printf("read-error: %d at %"PRId64"\n", ret, ffurl_seek(h, 0, SEEK_CUR));
535 for (i = 0; i < ret; ++i) {
536 if (buf[i] != (pos & 0xFF)) {
537 printf("read-mismatch: actual %d, expecting %d, at %"PRId64"\n",
538 (int)buf[i], (int)(pos & 0xFF), pos);
547 printf("read: %"PRId64"\n", read_len);
549 ret = ffurl_read(h, buf, 1);
550 printf("read: %d\n", ret);