2 * This file is part of MPlayer.
4 * MPlayer is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * MPlayer is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 // Initial draft of my new cache system...
22 // Note it runs in 2 processes (using fork()), but doesn't require locking!!
23 // TODO: seeking, data consistency checking
25 #define READ_SLEEP_TIME 10
26 // These defines are used to reduce the cost of many successive
27 // seeks (e.g. when a file has no index) by spinning quickly at first.
28 #define INITIAL_FILL_USLEEP_TIME 1000
29 #define INITIAL_FILL_USLEEP_COUNT 10
30 #define FILL_USLEEP_TIME 50000
31 #define PREFILL_SLEEP_TIME 200
32 #define CONTROL_SLEEP_TIME 0
38 #include <sys/types.h>
42 #include "libavutil/avutil.h"
43 #include "osdep/shmem.h"
44 #include "osdep/timer.h"
45 #if defined(__MINGW32__)
47 static void ThreadProc( void *s
);
48 #elif defined(__OS2__)
51 static void ThreadProc( void *s
);
52 #elif defined(PTHREAD_CACHE)
54 static void *ThreadProc(void *s
);
57 #define FORKED_CACHE 1
60 #define FORKED_CACHE 0
70 unsigned char *buffer
; // base pointer of the allocated buffer memory
71 int buffer_size
; // size of the allocated buffer memory
72 int sector_size
; // size of a single sector (2048/2324)
73 int back_size
; // we should keep back_size amount of old bytes for backward seek
74 int fill_limit
; // we should fill buffer only if space>=fill_limit
75 int seek_limit
; // keep filling cache if distance is less that seek limit
78 off_t min_filepos
; // buffer contain only a part of the file, from min-max pos
80 off_t offset
; // filepos <-> bufferpos offset value (filepos of the buffer's first byte)
84 // int seek_lock; // 1 if we will seek/reset buffer, 2 if we are ready for cmd
85 // int fifo_flag; // 1 if we should use FIFO to notice cache about buffer reads.
89 volatile unsigned control_uint_arg
;
90 volatile double control_double_arg
;
91 volatile int control_res
;
92 volatile off_t control_new_pos
;
93 volatile double stream_time_length
;
96 static int min_fill
=0;
98 static void cache_wakeup(stream_t
*s
)
101 // signal process to wake up immediately
102 kill(s
->cache_pid
, SIGUSR1
);
106 static int cache_read(cache_vars_t
*s
, unsigned char *buf
, int size
)
110 int last_max
= s
->max_filepos
;
114 //printf("CACHE2_READ: 0x%X <= 0x%X <= 0x%X \n",s->min_filepos,s->read_filepos,s->max_filepos);
116 if(s
->read_filepos
>=s
->max_filepos
|| s
->read_filepos
<s
->min_filepos
){
119 if (s
->max_filepos
== last_max
) {
120 if (sleep_count
++ == 10)
121 mp_msg(MSGT_CACHE
, MSGL_WARN
, "Cache not filling, consider increasing -cache and/or -cache-min!\n");
123 last_max
= s
->max_filepos
;
126 // waiting for buffer fill...
127 if (stream_check_interrupt(READ_SLEEP_TIME
)) {
131 continue; // try again...
135 newb
=s
->max_filepos
-s
->read_filepos
; // new bytes in the buffer
136 if(newb
<min_fill
) min_fill
=newb
; // statistics...
138 // printf("*** newb: %d bytes ***\n",newb);
140 pos
=s
->read_filepos
- s
->offset
;
141 if(pos
<0) pos
+=s
->buffer_size
; else
142 if(pos
>=s
->buffer_size
) pos
-=s
->buffer_size
;
144 if(newb
>s
->buffer_size
-pos
) newb
=s
->buffer_size
-pos
; // handle wrap...
145 if(newb
>size
) newb
=size
;
148 if(s
->read_filepos
<s
->min_filepos
) mp_msg(MSGT_CACHE
,MSGL_ERR
,"Ehh. s->read_filepos<s->min_filepos !!! Report bug...\n");
150 // len=write(mem,newb)
151 //printf("Buffer read: %d bytes\n",newb);
152 memcpy(buf
,&s
->buffer
[pos
],newb
);
157 s
->read_filepos
+=len
;
165 static int cache_fill(cache_vars_t
*s
)
167 int back
,back2
,newb
,space
,len
,pos
;
168 off_t read
=s
->read_filepos
;
171 if(read
<s
->min_filepos
|| read
>s
->max_filepos
){
173 mp_msg(MSGT_CACHE
,MSGL_DBG2
,"Out of boundaries... seeking to 0x%"PRIX64
" \n",(int64_t)read
);
174 // drop cache contents only if seeking backward or too much fwd.
175 // This is also done for on-disk files, since it loses the backseek cache.
176 // That in turn can cause major bandwidth increase and performance
177 // issues with e.g. mov or badly interleaved files
178 if(read
<s
->min_filepos
|| read
>=s
->max_filepos
+s
->seek_limit
)
180 s
->offset
= // FIXME!?
181 s
->min_filepos
=s
->max_filepos
=read
; // drop cache content :(
182 if(s
->stream
->eof
) stream_reset(s
->stream
);
183 stream_seek_internal(s
->stream
,read
);
184 mp_msg(MSGT_CACHE
,MSGL_DBG2
,"Seek done. new pos: 0x%"PRIX64
" \n",(int64_t)stream_tell(s
->stream
));
188 // calc number of back-bytes:
189 back
=read
- s
->min_filepos
;
190 if(back
<0) back
=0; // strange...
191 if(back
>s
->back_size
) back
=s
->back_size
;
193 // calc number of new bytes:
194 newb
=s
->max_filepos
- read
;
195 if(newb
<0) newb
=0; // strange...
197 // calc free buffer space:
198 space
=s
->buffer_size
- (newb
+back
);
201 pos
=s
->max_filepos
- s
->offset
;
202 if(pos
>=s
->buffer_size
) pos
-=s
->buffer_size
; // wrap-around
204 if(space
<s
->fill_limit
){
205 // printf("Buffer is full (%d bytes free, limit: %d)\n",space,s->fill_limit);
206 return 0; // no fill...
209 // printf("### read=0x%X back=%d newb=%d space=%d pos=%d\n",read,back,newb,space,pos);
211 // reduce space if needed:
212 if(space
>s
->buffer_size
-pos
) space
=s
->buffer_size
-pos
;
214 // limit one-time block size
215 read_chunk
= s
->stream
->read_chunk
;
216 if (!read_chunk
) read_chunk
= 4*s
->sector_size
;
217 space
= FFMIN(space
, read_chunk
);
220 // back+newb+space <= buffer_size
221 back2
=s
->buffer_size
-(space
+newb
); // max back size
222 if(s
->min_filepos
<(read
-back2
)) s
->min_filepos
=read
-back2
;
224 s
->min_filepos
=read
-back
; // avoid seeking-back to temp area...
227 len
= stream_read_internal(s
->stream
, &s
->buffer
[pos
], space
);
231 if(pos
+len
>=s
->buffer_size
){
233 s
->offset
+=s
->buffer_size
;
240 static int cache_execute_control(cache_vars_t
*s
) {
241 static unsigned last
;
242 int quit
= s
->control
== -2;
243 if (quit
|| !s
->stream
->control
) {
244 s
->stream_time_length
= 0;
245 s
->control_new_pos
= 0;
246 s
->control_res
= STREAM_UNSUPPORTED
;
250 if (GetTimerMS() - last
> 99) {
252 if (s
->stream
->control(s
->stream
, STREAM_CTRL_GET_TIME_LENGTH
, &len
) == STREAM_OK
)
253 s
->stream_time_length
= len
;
255 s
->stream_time_length
= 0;
258 if (s
->control
== -1) return 1;
259 switch (s
->control
) {
260 case STREAM_CTRL_GET_CURRENT_TIME
:
261 case STREAM_CTRL_SEEK_TO_TIME
:
262 case STREAM_CTRL_GET_ASPECT_RATIO
:
263 s
->control_res
= s
->stream
->control(s
->stream
, s
->control
, &s
->control_double_arg
);
265 case STREAM_CTRL_SEEK_TO_CHAPTER
:
266 case STREAM_CTRL_GET_NUM_CHAPTERS
:
267 case STREAM_CTRL_GET_CURRENT_CHAPTER
:
268 case STREAM_CTRL_GET_NUM_ANGLES
:
269 case STREAM_CTRL_GET_ANGLE
:
270 case STREAM_CTRL_SET_ANGLE
:
271 s
->control_res
= s
->stream
->control(s
->stream
, s
->control
, &s
->control_uint_arg
);
274 s
->control_res
= STREAM_UNSUPPORTED
;
277 s
->control_new_pos
= s
->stream
->pos
;
282 static void *shared_alloc(int size
) {
284 return shmem_alloc(size
);
290 static void shared_free(void *ptr
, int size
) {
292 shmem_free(ptr
, size
);
298 static cache_vars_t
* cache_init(int size
,int sector
){
300 cache_vars_t
* s
=shared_alloc(sizeof(cache_vars_t
));
301 if(s
==NULL
) return NULL
;
303 memset(s
,0,sizeof(cache_vars_t
));
308 s
->buffer_size
=num
*sector
;
309 s
->sector_size
=sector
;
310 s
->buffer
=shared_alloc(s
->buffer_size
);
312 if(s
->buffer
== NULL
){
313 shared_free(s
, sizeof(cache_vars_t
));
317 s
->fill_limit
=8*sector
;
318 s
->back_size
=s
->buffer_size
/2;
322 void cache_uninit(stream_t
*s
) {
323 cache_vars_t
* c
= s
->cache_data
;
326 cache_do_control(s
, -2, NULL
);
328 kill(s
->cache_pid
,SIGKILL
);
329 waitpid(s
->cache_pid
,NULL
,0);
334 shared_free(c
->buffer
, c
->buffer_size
);
337 shared_free(s
->cache_data
, sizeof(cache_vars_t
));
338 s
->cache_data
= NULL
;
341 static void exit_sighandler(int x
){
346 static void dummy_sighandler(int x
) {
350 * Main loop of the cache process or thread.
352 static void cache_mainloop(cache_vars_t
*s
) {
355 struct sigaction sa
= { .sa_handler
= SIG_IGN
};
356 sigaction(SIGUSR1
, &sa
, NULL
);
359 if (!cache_fill(s
)) {
361 // Let signal wake us up, we cannot leave this
362 // enabled since we do not handle EINTR in most places.
363 // This might need extra code to work on BSD.
364 sa
.sa_handler
= dummy_sighandler
;
365 sigaction(SIGUSR1
, &sa
, NULL
);
367 if (sleep_count
< INITIAL_FILL_USLEEP_COUNT
) {
369 usec_sleep(INITIAL_FILL_USLEEP_TIME
);
371 usec_sleep(FILL_USLEEP_TIME
); // idle
373 sa
.sa_handler
= SIG_IGN
;
374 sigaction(SIGUSR1
, &sa
, NULL
);
378 } while (cache_execute_control(s
));
382 * \return 1 on success, 0 if the function was interrupted and -1 on error
384 int stream_enable_cache(stream_t
*stream
,int size
,int min
,int seek_limit
){
385 int ss
= stream
->sector_size
? stream
->sector_size
: STREAM_BUFFER_SIZE
;
389 if (stream
->flags
& STREAM_NON_CACHEABLE
) {
390 mp_msg(MSGT_CACHE
,MSGL_STATUS
,"\rThis stream is non-cacheable\n");
394 s
=cache_init(size
,ss
);
395 if(s
== NULL
) return -1;
396 stream
->cache_data
=s
;
397 s
->stream
=stream
; // callback
398 s
->seek_limit
=seek_limit
;
401 //make sure that we won't wait from cache_fill
402 //more data than it is allowed to fill
403 if (s
->seek_limit
> s
->buffer_size
- s
->fill_limit
){
404 s
->seek_limit
= s
->buffer_size
- s
->fill_limit
;
406 if (min
> s
->buffer_size
- s
->fill_limit
) {
407 min
= s
->buffer_size
- s
->fill_limit
;
409 // to make sure we wait for the cache process/thread to be active
415 if((stream
->cache_pid
=fork())){
416 if ((pid_t
)stream
->cache_pid
== -1)
417 stream
->cache_pid
= 0;
420 stream_t
* stream2
=malloc(sizeof(stream_t
));
421 memcpy(stream2
,s
->stream
,sizeof(stream_t
));
423 #if defined(__MINGW32__)
424 stream
->cache_pid
= _beginthread( ThreadProc
, 0, s
);
425 #elif defined(__OS2__)
426 stream
->cache_pid
= _beginthread( ThreadProc
, NULL
, 256 * 1024, s
);
430 pthread_create(&tid
, NULL
, ThreadProc
, s
);
431 stream
->cache_pid
= 1;
435 if (!stream
->cache_pid
) {
436 mp_msg(MSGT_CACHE
, MSGL_ERR
,
437 "Starting cache process/thread failed: %s.\n", strerror(errno
));
440 // wait until cache is filled at least prefill_init %
441 mp_msg(MSGT_CACHE
,MSGL_V
,"CACHE_PRE_INIT: %"PRId64
" [%"PRId64
"] %"PRId64
" pre:%d eof:%d \n",
442 (int64_t)s
->min_filepos
,(int64_t)s
->read_filepos
,(int64_t)s
->max_filepos
,min
,s
->eof
);
443 while(s
->read_filepos
<s
->min_filepos
|| s
->max_filepos
-s
->read_filepos
<min
){
444 mp_tmsg(MSGT_CACHE
,MSGL_STATUS
,"\rCache fill: %5.2f%% (%"PRId64
" bytes) ",
445 100.0*(float)(s
->max_filepos
-s
->read_filepos
)/(float)(s
->buffer_size
),
446 (int64_t)s
->max_filepos
-s
->read_filepos
448 if(s
->eof
) break; // file is smaller than prefill size
449 if(stream_check_interrupt(PREFILL_SLEEP_TIME
)) {
454 mp_msg(MSGT_CACHE
,MSGL_STATUS
,"\n");
455 return 1; // parent exits
458 cache_uninit(stream
);
463 signal(SIGTERM
,exit_sighandler
); // kill
465 // make sure forked code never leaves this function
471 #if defined(__MINGW32__) || defined(__OS2__)
472 static void ThreadProc( void *s
){
477 static void *ThreadProc( void *s
){
484 int cache_stream_fill_buffer(stream_t
*s
){
487 if(!s
->cache_pid
) return stream_fill_buffer(s
);
489 if(s
->pos
!=((cache_vars_t
*)s
->cache_data
)->read_filepos
) mp_msg(MSGT_CACHE
,MSGL_ERR
,"!!! read_filepos differs!!! report this bug...\n");
490 sector_size
= ((cache_vars_t
*)s
->cache_data
)->sector_size
;
491 if (sector_size
> STREAM_MAX_SECTOR_SIZE
) {
492 mp_msg(MSGT_CACHE
, MSGL_ERR
, "Sector size %i larger than maximum %i\n", sector_size
, STREAM_MAX_SECTOR_SIZE
);
493 sector_size
= STREAM_MAX_SECTOR_SIZE
;
496 len
=cache_read(s
->cache_data
,s
->buffer
, sector_size
);
497 //printf("cache_stream_fill_buffer->read -> %d\n",len);
499 if(len
<=0){ s
->eof
=1; s
->buf_pos
=s
->buf_len
=0; return 0; }
504 // printf("[%d]",len);fflush(stdout);
506 stream_capture_do(s
);
511 int cache_fill_status(stream_t
*s
) {
513 if (!s
|| !s
->cache_data
)
516 return (cv
->max_filepos
-cv
->read_filepos
)/(cv
->buffer_size
/ 100);
519 int cache_stream_seek_long(stream_t
*stream
,off_t pos
){
522 if(!stream
->cache_pid
) return stream_seek_long(stream
,pos
);
524 s
=stream
->cache_data
;
527 mp_msg(MSGT_CACHE
,MSGL_DBG2
,"CACHE2_SEEK: 0x%"PRIX64
" <= 0x%"PRIX64
" (0x%"PRIX64
") <= 0x%"PRIX64
" \n",s
->min_filepos
,pos
,s
->read_filepos
,s
->max_filepos
);
529 newpos
=pos
/s
->sector_size
; newpos
*=s
->sector_size
; // align
530 stream
->pos
=s
->read_filepos
=newpos
;
532 cache_wakeup(stream
);
534 cache_stream_fill_buffer(stream
);
537 if(pos
>=0 && pos
<=stream
->buf_len
){
538 stream
->buf_pos
=pos
; // byte position in sector
542 // stream->buf_pos=stream->buf_len=0;
545 mp_msg(MSGT_CACHE
,MSGL_V
,"cache_stream_seek: WARNING! Can't seek to 0x%"PRIX64
" !\n",(int64_t)(pos
+newpos
));
549 int cache_do_control(stream_t
*stream
, int cmd
, void *arg
) {
551 cache_vars_t
* s
= stream
->cache_data
;
553 case STREAM_CTRL_SEEK_TO_TIME
:
554 s
->control_double_arg
= *(double *)arg
;
557 case STREAM_CTRL_SEEK_TO_CHAPTER
:
558 case STREAM_CTRL_SET_ANGLE
:
559 s
->control_uint_arg
= *(unsigned *)arg
;
562 // the core might call these every frame, they are too slow for this...
563 case STREAM_CTRL_GET_TIME_LENGTH
:
564 // case STREAM_CTRL_GET_CURRENT_TIME:
565 *(double *)arg
= s
->stream_time_length
;
566 return s
->stream_time_length
? STREAM_OK
: STREAM_UNSUPPORTED
;
567 case STREAM_CTRL_GET_NUM_CHAPTERS
:
568 case STREAM_CTRL_GET_CURRENT_CHAPTER
:
569 case STREAM_CTRL_GET_ASPECT_RATIO
:
570 case STREAM_CTRL_GET_NUM_ANGLES
:
571 case STREAM_CTRL_GET_ANGLE
:
576 return STREAM_UNSUPPORTED
;
578 cache_wakeup(stream
);
579 while (s
->control
!= -1) {
580 if (sleep_count
++ == 1000)
581 mp_msg(MSGT_CACHE
, MSGL_WARN
, "Cache not responding!\n");
582 if (stream_check_interrupt(CONTROL_SLEEP_TIME
)) {
584 return STREAM_UNSUPPORTED
;
588 case STREAM_CTRL_GET_TIME_LENGTH
:
589 case STREAM_CTRL_GET_CURRENT_TIME
:
590 case STREAM_CTRL_GET_ASPECT_RATIO
:
591 *(double *)arg
= s
->control_double_arg
;
593 case STREAM_CTRL_GET_NUM_CHAPTERS
:
594 case STREAM_CTRL_GET_CURRENT_CHAPTER
:
595 case STREAM_CTRL_GET_NUM_ANGLES
:
596 case STREAM_CTRL_GET_ANGLE
:
597 *(unsigned *)arg
= s
->control_uint_arg
;
599 case STREAM_CTRL_SEEK_TO_CHAPTER
:
600 case STREAM_CTRL_SEEK_TO_TIME
:
601 case STREAM_CTRL_SET_ANGLE
:
602 if (s
->control_res
!= STREAM_UNSUPPORTED
)
603 stream
->pos
= s
->read_filepos
= s
->control_new_pos
;
606 return s
->control_res
;