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 work with concatdec, hls
30 #include "libavutil/avassert.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/error.h"
33 #include "libavutil/fifo.h"
34 #include "libavutil/log.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/thread.h"
44 #define BUFFER_CAPACITY (4 * 1024 * 1024)
45 #define READ_BACK_CAPACITY (4 * 1024 * 1024)
46 #define SHORT_SEEK_THRESHOLD (256 * 1024)
48 typedef struct RingBuffer
51 int read_back_capacity
;
56 typedef struct Context
{
74 pthread_cond_t cond_wakeup_main
;
75 pthread_cond_t cond_wakeup_background
;
76 pthread_mutex_t mutex
;
77 pthread_t async_buffer_thread
;
80 AVIOInterruptCB interrupt_callback
;
83 static int ring_init(RingBuffer
*ring
, unsigned int capacity
, int read_back_capacity
)
85 memset(ring
, 0, sizeof(RingBuffer
));
86 ring
->fifo
= av_fifo_alloc2(capacity
+ read_back_capacity
, 1, 0);
88 return AVERROR(ENOMEM
);
90 ring
->read_back_capacity
= read_back_capacity
;
94 static void ring_destroy(RingBuffer
*ring
)
96 av_fifo_freep2(&ring
->fifo
);
99 static void ring_reset(RingBuffer
*ring
)
101 av_fifo_reset2(ring
->fifo
);
105 static int ring_size(RingBuffer
*ring
)
107 return av_fifo_can_read(ring
->fifo
) - ring
->read_pos
;
110 static int ring_space(RingBuffer
*ring
)
112 return av_fifo_can_write(ring
->fifo
);
115 static int ring_read(RingBuffer
*ring
, void *dest
, int buf_size
)
119 av_assert2(buf_size
<= ring_size(ring
));
121 ret
= av_fifo_peek(ring
->fifo
, dest
, buf_size
, ring
->read_pos
);
122 ring
->read_pos
+= buf_size
;
124 if (ring
->read_pos
> ring
->read_back_capacity
) {
125 av_fifo_drain2(ring
->fifo
, ring
->read_pos
- ring
->read_back_capacity
);
126 ring
->read_pos
= ring
->read_back_capacity
;
132 static int wrapped_url_read(void *src
, void *dst
, size_t *size
)
135 Context
*c
= h
->priv_data
;
138 ret
= ffurl_read(c
->inner
, dst
, *size
);
139 *size
= ret
> 0 ? ret
: 0;
140 c
->inner_io_error
= ret
< 0 ? ret
: 0;
142 return c
->inner_io_error
;
145 static int ring_write(RingBuffer
*ring
, URLContext
*h
, size_t size
)
149 av_assert2(size
<= ring_space(ring
));
150 ret
= av_fifo_write_from_cb(ring
->fifo
, wrapped_url_read
, h
, &size
);
157 static int ring_size_of_read_back(RingBuffer
*ring
)
159 return ring
->read_pos
;
162 static int ring_drain(RingBuffer
*ring
, int offset
)
164 av_assert2(offset
>= -ring_size_of_read_back(ring
));
165 av_assert2(offset
<= ring_size(ring
));
166 ring
->read_pos
+= offset
;
170 static int async_check_interrupt(void *arg
)
173 Context
*c
= h
->priv_data
;
175 if (c
->abort_request
)
178 if (ff_check_interrupt(&c
->interrupt_callback
))
179 c
->abort_request
= 1;
181 return c
->abort_request
;
184 static void *async_buffer_task(void *arg
)
187 Context
*c
= h
->priv_data
;
188 RingBuffer
*ring
= &c
->ring
;
193 int fifo_space
, to_copy
;
195 pthread_mutex_lock(&c
->mutex
);
196 if (async_check_interrupt(h
)) {
197 c
->io_eof_reached
= 1;
198 c
->io_error
= AVERROR_EXIT
;
199 pthread_cond_signal(&c
->cond_wakeup_main
);
200 pthread_mutex_unlock(&c
->mutex
);
204 if (c
->seek_request
) {
205 seek_ret
= ffurl_seek(c
->inner
, c
->seek_pos
, c
->seek_whence
);
207 c
->io_eof_reached
= 0;
212 c
->seek_completed
= 1;
213 c
->seek_ret
= seek_ret
;
217 pthread_cond_signal(&c
->cond_wakeup_main
);
218 pthread_mutex_unlock(&c
->mutex
);
222 fifo_space
= ring_space(ring
);
223 if (c
->io_eof_reached
|| fifo_space
<= 0) {
224 pthread_cond_signal(&c
->cond_wakeup_main
);
225 pthread_cond_wait(&c
->cond_wakeup_background
, &c
->mutex
);
226 pthread_mutex_unlock(&c
->mutex
);
229 pthread_mutex_unlock(&c
->mutex
);
231 to_copy
= FFMIN(4096, fifo_space
);
232 ret
= ring_write(ring
, h
, to_copy
);
234 pthread_mutex_lock(&c
->mutex
);
236 c
->io_eof_reached
= 1;
237 if (c
->inner_io_error
< 0)
238 c
->io_error
= c
->inner_io_error
;
241 pthread_cond_signal(&c
->cond_wakeup_main
);
242 pthread_mutex_unlock(&c
->mutex
);
248 static int async_open(URLContext
*h
, const char *arg
, int flags
, AVDictionary
**options
)
250 Context
*c
= h
->priv_data
;
252 AVIOInterruptCB interrupt_callback
= {.callback
= async_check_interrupt
, .opaque
= h
};
254 av_strstart(arg
, "async:", &arg
);
256 ret
= ring_init(&c
->ring
, BUFFER_CAPACITY
, READ_BACK_CAPACITY
);
260 /* wrap interrupt callback */
261 c
->interrupt_callback
= h
->interrupt_callback
;
262 ret
= ffurl_open_whitelist(&c
->inner
, arg
, flags
, &interrupt_callback
, options
, h
->protocol_whitelist
, h
->protocol_blacklist
, h
);
264 av_log(h
, AV_LOG_ERROR
, "ffurl_open failed : %s, %s\n", av_err2str(ret
), arg
);
268 c
->logical_size
= ffurl_size(c
->inner
);
269 h
->is_streamed
= c
->inner
->is_streamed
;
271 ret
= pthread_mutex_init(&c
->mutex
, NULL
);
274 av_log(h
, AV_LOG_ERROR
, "pthread_mutex_init failed : %s\n", av_err2str(ret
));
278 ret
= pthread_cond_init(&c
->cond_wakeup_main
, NULL
);
281 av_log(h
, AV_LOG_ERROR
, "pthread_cond_init failed : %s\n", av_err2str(ret
));
282 goto cond_wakeup_main_fail
;
285 ret
= pthread_cond_init(&c
->cond_wakeup_background
, NULL
);
288 av_log(h
, AV_LOG_ERROR
, "pthread_cond_init failed : %s\n", av_err2str(ret
));
289 goto cond_wakeup_background_fail
;
292 ret
= pthread_create(&c
->async_buffer_thread
, NULL
, async_buffer_task
, h
);
295 av_log(h
, AV_LOG_ERROR
, "pthread_create failed : %s\n", av_err2str(ret
));
302 pthread_cond_destroy(&c
->cond_wakeup_background
);
303 cond_wakeup_background_fail
:
304 pthread_cond_destroy(&c
->cond_wakeup_main
);
305 cond_wakeup_main_fail
:
306 pthread_mutex_destroy(&c
->mutex
);
308 ffurl_closep(&c
->inner
);
310 ring_destroy(&c
->ring
);
315 static int async_close(URLContext
*h
)
317 Context
*c
= h
->priv_data
;
320 pthread_mutex_lock(&c
->mutex
);
321 c
->abort_request
= 1;
322 pthread_cond_signal(&c
->cond_wakeup_background
);
323 pthread_mutex_unlock(&c
->mutex
);
325 ret
= pthread_join(c
->async_buffer_thread
, NULL
);
327 av_log(h
, AV_LOG_ERROR
, "pthread_join(): %s\n", av_err2str(ret
));
329 pthread_cond_destroy(&c
->cond_wakeup_background
);
330 pthread_cond_destroy(&c
->cond_wakeup_main
);
331 pthread_mutex_destroy(&c
->mutex
);
332 ffurl_closep(&c
->inner
);
333 ring_destroy(&c
->ring
);
338 static int async_read_internal(URLContext
*h
, void *dest
, int size
)
340 Context
*c
= h
->priv_data
;
341 RingBuffer
*ring
= &c
->ring
;
342 int read_complete
= !dest
;
346 pthread_mutex_lock(&c
->mutex
);
348 while (to_read
> 0) {
349 int fifo_size
, to_copy
;
350 if (async_check_interrupt(h
)) {
354 fifo_size
= ring_size(ring
);
355 to_copy
= FFMIN(to_read
, fifo_size
);
357 ring_read(ring
, dest
, to_copy
);
359 dest
= (uint8_t *)dest
+ to_copy
;
360 c
->logical_pos
+= to_copy
;
362 ret
= size
- to_read
;
364 if (to_read
<= 0 || !read_complete
)
366 } else if (c
->io_eof_reached
) {
375 pthread_cond_signal(&c
->cond_wakeup_background
);
376 pthread_cond_wait(&c
->cond_wakeup_main
, &c
->mutex
);
379 pthread_cond_signal(&c
->cond_wakeup_background
);
380 pthread_mutex_unlock(&c
->mutex
);
385 static int async_read(URLContext
*h
, unsigned char *buf
, int size
)
387 return async_read_internal(h
, buf
, size
);
390 static int64_t async_seek(URLContext
*h
, int64_t pos
, int whence
)
392 Context
*c
= h
->priv_data
;
393 RingBuffer
*ring
= &c
->ring
;
395 int64_t new_logical_pos
;
397 int fifo_size_of_read_back
;
399 if (whence
== AVSEEK_SIZE
) {
400 av_log(h
, AV_LOG_TRACE
, "async_seek: AVSEEK_SIZE: %"PRId64
"\n", (int64_t)c
->logical_size
);
401 return c
->logical_size
;
402 } else if (whence
== SEEK_CUR
) {
403 av_log(h
, AV_LOG_TRACE
, "async_seek: %"PRId64
"\n", pos
);
404 new_logical_pos
= pos
+ c
->logical_pos
;
405 } else if (whence
== SEEK_SET
){
406 av_log(h
, AV_LOG_TRACE
, "async_seek: %"PRId64
"\n", pos
);
407 new_logical_pos
= pos
;
409 return AVERROR(EINVAL
);
411 if (new_logical_pos
< 0)
412 return AVERROR(EINVAL
);
414 fifo_size
= ring_size(ring
);
415 fifo_size_of_read_back
= ring_size_of_read_back(ring
);
416 if (new_logical_pos
== c
->logical_pos
) {
417 /* current position */
418 return c
->logical_pos
;
419 } else if ((new_logical_pos
>= (c
->logical_pos
- fifo_size_of_read_back
)) &&
420 (new_logical_pos
< (c
->logical_pos
+ fifo_size
+ SHORT_SEEK_THRESHOLD
))) {
421 int pos_delta
= (int)(new_logical_pos
- c
->logical_pos
);
423 av_log(h
, AV_LOG_TRACE
, "async_seek: fask_seek %"PRId64
" from %d dist:%d/%d\n",
424 new_logical_pos
, (int)c
->logical_pos
,
425 (int)(new_logical_pos
- c
->logical_pos
), fifo_size
);
428 // fast seek forwards
429 async_read_internal(h
, NULL
, pos_delta
);
431 // fast seek backwards
432 ring_drain(ring
, pos_delta
);
433 c
->logical_pos
= new_logical_pos
;
436 return c
->logical_pos
;
437 } else if (c
->logical_size
<= 0) {
439 return AVERROR(EINVAL
);
440 } else if (new_logical_pos
> c
->logical_size
) {
442 return AVERROR(EINVAL
);
445 pthread_mutex_lock(&c
->mutex
);
448 c
->seek_pos
= new_logical_pos
;
449 c
->seek_whence
= SEEK_SET
;
450 c
->seek_completed
= 0;
454 if (async_check_interrupt(h
)) {
458 if (c
->seek_completed
) {
459 if (c
->seek_ret
>= 0)
460 c
->logical_pos
= c
->seek_ret
;
464 pthread_cond_signal(&c
->cond_wakeup_background
);
465 pthread_cond_wait(&c
->cond_wakeup_main
, &c
->mutex
);
468 pthread_mutex_unlock(&c
->mutex
);
473 #define OFFSET(x) offsetof(Context, x)
474 #define D AV_OPT_FLAG_DECODING_PARAM
476 static const AVOption options
[] = {
483 static const AVClass async_context_class
= {
484 .class_name
= "Async",
485 .item_name
= av_default_item_name
,
487 .version
= LIBAVUTIL_VERSION_INT
,
490 const URLProtocol ff_async_protocol
= {
492 .url_open2
= async_open
,
493 .url_read
= async_read
,
494 .url_seek
= async_seek
,
495 .url_close
= async_close
,
496 .priv_data_size
= sizeof(Context
),
497 .priv_data_class
= &async_context_class
,
502 #define TEST_SEEK_POS (1536)
503 #define TEST_STREAM_SIZE (2048)
505 typedef struct TestContext
{
508 int64_t logical_size
;
514 static int async_test_open(URLContext
*h
, const char *arg
, int flags
, AVDictionary
**options
)
516 TestContext
*c
= h
->priv_data
;
518 c
->logical_size
= TEST_STREAM_SIZE
;
522 static int async_test_close(URLContext
*h
)
527 static int async_test_read(URLContext
*h
, unsigned char *buf
, int size
)
529 TestContext
*c
= h
->priv_data
;
533 if (c
->opt_read_error
)
534 return c
->opt_read_error
;
536 if (c
->logical_pos
>= c
->logical_size
)
539 for (i
= 0; i
< size
; ++i
) {
540 buf
[i
] = c
->logical_pos
& 0xFF;
545 if (c
->logical_pos
>= c
->logical_size
)
552 static int64_t async_test_seek(URLContext
*h
, int64_t pos
, int whence
)
554 TestContext
*c
= h
->priv_data
;
555 int64_t new_logical_pos
;
557 if (whence
== AVSEEK_SIZE
) {
558 return c
->logical_size
;
559 } else if (whence
== SEEK_CUR
) {
560 new_logical_pos
= pos
+ c
->logical_pos
;
561 } else if (whence
== SEEK_SET
){
562 new_logical_pos
= pos
;
564 return AVERROR(EINVAL
);
566 if (new_logical_pos
< 0)
567 return AVERROR(EINVAL
);
569 c
->logical_pos
= new_logical_pos
;
570 return new_logical_pos
;
573 #define OFFSET(x) offsetof(TestContext, x)
574 #define D AV_OPT_FLAG_DECODING_PARAM
576 static const AVOption async_test_options
[] = {
577 { "async-test-read-error", "cause read fail",
578 OFFSET(opt_read_error
), AV_OPT_TYPE_INT
, { .i64
= 0 }, INT_MIN
, INT_MAX
, .flags
= D
},
585 static const AVClass async_test_context_class
= {
586 .class_name
= "Async-Test",
587 .item_name
= av_default_item_name
,
588 .option
= async_test_options
,
589 .version
= LIBAVUTIL_VERSION_INT
,
592 const URLProtocol ff_async_test_protocol
= {
593 .name
= "async-test",
594 .url_open2
= async_test_open
,
595 .url_read
= async_test_read
,
596 .url_seek
= async_test_seek
,
597 .url_close
= async_test_close
,
598 .priv_data_size
= sizeof(TestContext
),
599 .priv_data_class
= &async_test_context_class
,
604 URLContext
*h
= NULL
;
610 unsigned char buf
[4096];
611 AVDictionary
*opts
= NULL
;
613 ffurl_register_protocol(&ff_async_protocol
);
614 ffurl_register_protocol(&ff_async_test_protocol
);
619 ret
= ffurl_open_whitelist(&h
, "async:async-test:", AVIO_FLAG_READ
,
620 NULL
, NULL
, NULL
, NULL
, NULL
);
621 printf("open: %d\n", ret
);
623 size
= ffurl_size(h
);
624 printf("size: %"PRId64
"\n", size
);
626 pos
= ffurl_seek(h
, 0, SEEK_CUR
);
629 ret
= ffurl_read(h
, buf
, sizeof(buf
));
630 if (ret
== AVERROR_EOF
) {
631 printf("read-error: AVERROR_EOF at %"PRId64
"\n", ffurl_seek(h
, 0, SEEK_CUR
));
637 printf("read-error: %d at %"PRId64
"\n", ret
, ffurl_seek(h
, 0, SEEK_CUR
));
640 for (i
= 0; i
< ret
; ++i
) {
641 if (buf
[i
] != (pos
& 0xFF)) {
642 printf("read-mismatch: actual %d, expecting %d, at %"PRId64
"\n",
643 (int)buf
[i
], (int)(pos
& 0xFF), pos
);
652 printf("read: %"PRId64
"\n", read_len
);
657 ret
= ffurl_read(h
, buf
, 1);
658 printf("read: %d\n", ret
);
660 pos
= ffurl_seek(h
, TEST_SEEK_POS
, SEEK_SET
);
661 printf("seek: %"PRId64
"\n", pos
);
665 ret
= ffurl_read(h
, buf
, sizeof(buf
));
666 if (ret
== AVERROR_EOF
)
671 printf("read-error: %d at %"PRId64
"\n", ret
, ffurl_seek(h
, 0, SEEK_CUR
));
674 for (i
= 0; i
< ret
; ++i
) {
675 if (buf
[i
] != (pos
& 0xFF)) {
676 printf("read-mismatch: actual %d, expecting %d, at %"PRId64
"\n",
677 (int)buf
[i
], (int)(pos
& 0xFF), pos
);
686 printf("read: %"PRId64
"\n", read_len
);
688 ret
= ffurl_read(h
, buf
, 1);
689 printf("read: %d\n", ret
);
695 av_dict_set_int(&opts
, "async-test-read-error", -10000, 0);
696 ret
= ffurl_open_whitelist(&h
, "async:async-test:", AVIO_FLAG_READ
,
697 NULL
, &opts
, NULL
, NULL
, NULL
);
698 printf("open: %d\n", ret
);
700 ret
= ffurl_read(h
, buf
, 1);
701 printf("read: %d\n", ret
);