stream/cache2.c

   1 /*
   2  * This file is part of MPlayer.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  17  */
  18
  19 #include "config.h"
  20
  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
  24
  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
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <signal.h>
  38 #include <sys/types.h>
  39 #include <unistd.h>
  40 #include <errno.h>
  41
  42 #include "libavutil/avutil.h"
  43 #include "osdep/shmem.h"
  44 #include "osdep/timer.h"
  45 #if defined(__MINGW32__)
  46 #include <windows.h>
  47 static void ThreadProc( void *s );
  48 #elif defined(__OS2__)
  49 #define INCL_DOS
  50 #include <os2.h>
  51 static void ThreadProc( void *s );
  52 #elif defined(PTHREAD_CACHE)
  53 #include <pthread.h>
  54 static void *ThreadProc(void *s);
  55 #else
  56 #include <sys/wait.h>
  57 #define FORKED_CACHE 1
  58 #endif
  59 #ifndef FORKED_CACHE
  60 #define FORKED_CACHE 0
  61 #endif
  62
  63 #include "mp_msg.h"
  64
  65 #include "stream.h"
  66 #include "cache2.h"
  67
  68 typedef struct {
  69   // constats:
  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
  76   // filler's pointers:
  77   int eof;
  78   off_t min_filepos; // buffer contain only a part of the file, from min-max pos
  79   off_t max_filepos;
  80   off_t offset;      // filepos <-> bufferpos  offset value (filepos of the buffer's first byte)
  81   // reader's pointers:
  82   off_t read_filepos;
  83   // commands/locking:
  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.
  86   // callback
  87   stream_t* stream;
  88   volatile int control;
  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;
  94 } cache_vars_t;
  95
  96 static int min_fill=0;
  97
  98 int cache_fill_status=0;
  99
 100 static void cache_wakeup(stream_t *s)
 101 {
 102 #if FORKED_CACHE
 103   // signal process to wake up immediately
 104   kill(s->cache_pid, SIGUSR1);
 105 #endif
 106 }
 107
 108 static int cache_read(cache_vars_t *s, unsigned char *buf, int size)
 109 {
 110   int total=0;
 111   int sleep_count = 0;
 112   int last_max = s->max_filepos;
 113   while(size>0){
 114     int pos,newb,len;
 115
 116   //printf("CACHE2_READ: 0x%X <= 0x%X <= 0x%X  \n",s->min_filepos,s->read_filepos,s->max_filepos);
 117
 118     if(s->read_filepos>=s->max_filepos || s->read_filepos<s->min_filepos){
 119         // eof?
 120         if(s->eof) break;
 121         if (s->max_filepos == last_max) {
 122             if (sleep_count++ == 10)
 123                 mp_msg(MSGT_CACHE, MSGL_WARN, "Cache not filling!\n");
 124         } else {
 125             last_max = s->max_filepos;
 126             sleep_count = 0;
 127         }
 128         // waiting for buffer fill...
 129         if (stream_check_interrupt(READ_SLEEP_TIME)) {
 130             s->eof = 1;
 131             break;
 132         }
 133         continue; // try again...
 134     }
 135     sleep_count = 0;
 136
 137     newb=s->max_filepos-s->read_filepos; // new bytes in the buffer
 138     if(newb<min_fill) min_fill=newb; // statistics...
 139
 140 //    printf("*** newb: %d bytes ***\n",newb);
 141
 142     pos=s->read_filepos - s->offset;
 143     if(pos<0) pos+=s->buffer_size; else
 144     if(pos>=s->buffer_size) pos-=s->buffer_size;
 145
 146     if(newb>s->buffer_size-pos) newb=s->buffer_size-pos; // handle wrap...
 147     if(newb>size) newb=size;
 148
 149     // check:
 150     if(s->read_filepos<s->min_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"Ehh. s->read_filepos<s->min_filepos !!! Report bug...\n");
 151
 152     // len=write(mem,newb)
 153     //printf("Buffer read: %d bytes\n",newb);
 154     memcpy(buf,&s->buffer[pos],newb);
 155     buf+=newb;
 156     len=newb;
 157     // ...
 158
 159     s->read_filepos+=len;
 160     size-=len;
 161     total+=len;
 162
 163   }
 164   cache_fill_status=(s->max_filepos-s->read_filepos)/(s->buffer_size / 100);
 165   return total;
 166 }
 167
 168 static int cache_fill(cache_vars_t *s)
 169 {
 170   int back,back2,newb,space,len,pos;
 171   off_t read=s->read_filepos;
 172   int read_chunk;
 173
 174   if(read<s->min_filepos || read>s->max_filepos){
 175       // seek...
 176       mp_msg(MSGT_CACHE,MSGL_DBG2,"Out of boundaries... seeking to 0x%"PRIX64"  \n",(int64_t)read);
 177       // drop cache contents only if seeking backward or too much fwd.
 178       // This is also done for on-disk files, since it loses the backseek cache.
 179       // That in turn can cause major bandwidth increase and performance
 180       // issues with e.g. mov or badly interleaved files
 181       if(read<s->min_filepos || read>=s->max_filepos+s->seek_limit)
 182       {
 183         s->offset= // FIXME!?
 184         s->min_filepos=s->max_filepos=read; // drop cache content :(
 185         if(s->stream->eof) stream_reset(s->stream);
 186         stream_seek_internal(s->stream,read);
 187         mp_msg(MSGT_CACHE,MSGL_DBG2,"Seek done. new pos: 0x%"PRIX64"  \n",(int64_t)stream_tell(s->stream));
 188       }
 189   }
 190
 191   // calc number of back-bytes:
 192   back=read - s->min_filepos;
 193   if(back<0) back=0; // strange...
 194   if(back>s->back_size) back=s->back_size;
 195
 196   // calc number of new bytes:
 197   newb=s->max_filepos - read;
 198   if(newb<0) newb=0; // strange...
 199
 200   // calc free buffer space:
 201   space=s->buffer_size - (newb+back);
 202
 203   // calc bufferpos:
 204   pos=s->max_filepos - s->offset;
 205   if(pos>=s->buffer_size) pos-=s->buffer_size; // wrap-around
 206
 207   if(space<s->fill_limit){
 208 //    printf("Buffer is full (%d bytes free, limit: %d)\n",space,s->fill_limit);
 209     return 0; // no fill...
 210   }
 211
 212 //  printf("### read=0x%X  back=%d  newb=%d  space=%d  pos=%d\n",read,back,newb,space,pos);
 213
 214   // reduce space if needed:
 215   if(space>s->buffer_size-pos) space=s->buffer_size-pos;
 216
 217   // limit one-time block size
 218   read_chunk = s->stream->read_chunk;
 219   if (!read_chunk) read_chunk = 4*s->sector_size;
 220   space = FFMIN(space, read_chunk);
 221
 222 #if 1
 223   // back+newb+space <= buffer_size
 224   back2=s->buffer_size-(space+newb); // max back size
 225   if(s->min_filepos<(read-back2)) s->min_filepos=read-back2;
 226 #else
 227   s->min_filepos=read-back; // avoid seeking-back to temp area...
 228 #endif
 229
 230   len = stream_read_internal(s->stream, &s->buffer[pos], space);
 231   s->eof= !len;
 232
 233   s->max_filepos+=len;
 234   if(pos+len>=s->buffer_size){
 235       // wrap...
 236       s->offset+=s->buffer_size;
 237   }
 238
 239   return len;
 240
 241 }
 242
 243 static int cache_execute_control(cache_vars_t *s) {
 244   static unsigned last;
 245   int quit = s->control == -2;
 246   if (quit || !s->stream->control) {
 247     s->stream_time_length = 0;
 248     s->control_new_pos = 0;
 249     s->control_res = STREAM_UNSUPPORTED;
 250     s->control = -1;
 251     return !quit;
 252   }
 253   if (GetTimerMS() - last > 99) {
 254     double len;
 255     if (s->stream->control(s->stream, STREAM_CTRL_GET_TIME_LENGTH, &len) == STREAM_OK)
 256       s->stream_time_length = len;
 257     else
 258       s->stream_time_length = 0;
 259     last = GetTimerMS();
 260   }
 261   if (s->control == -1) return 1;
 262   switch (s->control) {
 263     case STREAM_CTRL_GET_CURRENT_TIME:
 264     case STREAM_CTRL_SEEK_TO_TIME:
 265     case STREAM_CTRL_GET_ASPECT_RATIO:
 266       s->control_res = s->stream->control(s->stream, s->control, &s->control_double_arg);
 267       break;
 268     case STREAM_CTRL_SEEK_TO_CHAPTER:
 269     case STREAM_CTRL_GET_NUM_CHAPTERS:
 270     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 271     case STREAM_CTRL_GET_NUM_ANGLES:
 272     case STREAM_CTRL_GET_ANGLE:
 273     case STREAM_CTRL_SET_ANGLE:
 274       s->control_res = s->stream->control(s->stream, s->control, &s->control_uint_arg);
 275       break;
 276     default:
 277       s->control_res = STREAM_UNSUPPORTED;
 278       break;
 279   }
 280   s->control_new_pos = s->stream->pos;
 281   s->control = -1;
 282   return 1;
 283 }
 284
 285 static void *shared_alloc(int size) {
 286 #if FORKED_CACHE
 287     return shmem_alloc(size);
 288 #else
 289     return malloc(size);
 290 #endif
 291 }
 292
 293 static void shared_free(void *ptr, int size) {
 294 #if FORKED_CACHE
 295     shmem_free(ptr, size);
 296 #else
 297     free(ptr);
 298 #endif
 299 }
 300
 301 static cache_vars_t* cache_init(int size,int sector){
 302   int num;
 303   cache_vars_t* s=shared_alloc(sizeof(cache_vars_t));
 304   if(s==NULL) return NULL;
 305
 306   memset(s,0,sizeof(cache_vars_t));
 307   num=size/sector;
 308   if(num < 16){
 309      num = 16;
 310   }//32kb min_size
 311   s->buffer_size=num*sector;
 312   s->sector_size=sector;
 313   s->buffer=shared_alloc(s->buffer_size);
 314
 315   if(s->buffer == NULL){
 316     shared_free(s, sizeof(cache_vars_t));
 317     return NULL;
 318   }
 319
 320   s->fill_limit=8*sector;
 321   s->back_size=s->buffer_size/2;
 322   return s;
 323 }
 324
 325 void cache_uninit(stream_t *s) {
 326   cache_vars_t* c = s->cache_data;
 327   if(s->cache_pid) {
 328 #if !FORKED_CACHE
 329     cache_do_control(s, -2, NULL);
 330 #else
 331     kill(s->cache_pid,SIGKILL);
 332     waitpid(s->cache_pid,NULL,0);
 333 #endif
 334     s->cache_pid = 0;
 335   }
 336   if(!c) return;
 337   shared_free(c->buffer, c->buffer_size);
 338   c->buffer = NULL;
 339   c->stream = NULL;
 340   shared_free(s->cache_data, sizeof(cache_vars_t));
 341   s->cache_data = NULL;
 342 }
 343
 344 static void exit_sighandler(int x){
 345   // close stream
 346   exit(0);
 347 }
 348
 349 static void dummy_sighandler(int x) {
 350 }
 351
 352 /**
 353  * Main loop of the cache process or thread.
 354  */
 355 static void cache_mainloop(cache_vars_t *s) {
 356     int sleep_count = 0;
 357 #if FORKED_CACHE
 358     struct sigaction sa = { .sa_handler = SIG_IGN };
 359     sigaction(SIGUSR1, &sa, NULL);
 360 #endif
 361     do {
 362         if (!cache_fill(s)) {
 363 #if FORKED_CACHE
 364             // Let signal wake us up, we cannot leave this
 365             // enabled since we do not handle EINTR in most places.
 366             // This might need extra code to work on BSD.
 367             sa.sa_handler = dummy_sighandler;
 368             sigaction(SIGUSR1, &sa, NULL);
 369 #endif
 370             if (sleep_count < INITIAL_FILL_USLEEP_COUNT) {
 371                 sleep_count++;
 372                 usec_sleep(INITIAL_FILL_USLEEP_TIME);
 373             } else
 374                 usec_sleep(FILL_USLEEP_TIME); // idle
 375 #if FORKED_CACHE
 376             sa.sa_handler = SIG_IGN;
 377             sigaction(SIGUSR1, &sa, NULL);
 378 #endif
 379         } else
 380             sleep_count = 0;
 381     } while (cache_execute_control(s));
 382 }
 383
 384 /**
 385  * \return 1 on success, 0 if the function was interrupted and -1 on error
 386  */
 387 int stream_enable_cache(stream_t *stream,int size,int min,int seek_limit){
 388   int ss = stream->sector_size ? stream->sector_size : STREAM_BUFFER_SIZE;
 389   int res = -1;
 390   cache_vars_t* s;
 391
 392   if (stream->flags & STREAM_NON_CACHEABLE) {
 393     mp_msg(MSGT_CACHE,MSGL_STATUS,"\rThis stream is non-cacheable\n");
 394     return 1;
 395   }
 396
 397   s=cache_init(size,ss);
 398   if(s == NULL) return -1;
 399   stream->cache_data=s;
 400   s->stream=stream; // callback
 401   s->seek_limit=seek_limit;
 402
 403
 404   //make sure that we won't wait from cache_fill
 405   //more data than it is allowed to fill
 406   if (s->seek_limit > s->buffer_size - s->fill_limit ){
 407      s->seek_limit = s->buffer_size - s->fill_limit;
 408   }
 409   if (min > s->buffer_size - s->fill_limit) {
 410      min = s->buffer_size - s->fill_limit;
 411   }
 412   // to make sure we wait for the cache process/thread to be active
 413   // before continuing
 414   if (min <= 0)
 415     min = 1;
 416
 417 #if FORKED_CACHE
 418   if((stream->cache_pid=fork())){
 419     if ((pid_t)stream->cache_pid == -1)
 420       stream->cache_pid = 0;
 421 #else
 422   {
 423     stream_t* stream2=malloc(sizeof(stream_t));
 424     memcpy(stream2,s->stream,sizeof(stream_t));
 425     s->stream=stream2;
 426 #if defined(__MINGW32__)
 427     stream->cache_pid = _beginthread( ThreadProc, 0, s );
 428 #elif defined(__OS2__)
 429     stream->cache_pid = _beginthread( ThreadProc, NULL, 256 * 1024, s );
 430 #else
 431     {
 432     pthread_t tid;
 433     pthread_create(&tid, NULL, ThreadProc, s);
 434     stream->cache_pid = 1;
 435     }
 436 #endif
 437 #endif
 438     if (!stream->cache_pid) {
 439         mp_msg(MSGT_CACHE, MSGL_ERR,
 440                "Starting cache process/thread failed: %s.\n", strerror(errno));
 441         goto err_out;
 442     }
 443     // wait until cache is filled at least prefill_init %
 444     mp_msg(MSGT_CACHE,MSGL_V,"CACHE_PRE_INIT: %"PRId64" [%"PRId64"] %"PRId64"  pre:%d  eof:%d  \n",
 445         (int64_t)s->min_filepos,(int64_t)s->read_filepos,(int64_t)s->max_filepos,min,s->eof);
 446     while(s->read_filepos<s->min_filepos || s->max_filepos-s->read_filepos<min){
 447         mp_tmsg(MSGT_CACHE,MSGL_STATUS,"\rCache fill: %5.2f%% (%"PRId64" bytes)   ",
 448             100.0*(float)(s->max_filepos-s->read_filepos)/(float)(s->buffer_size),
 449             (int64_t)s->max_filepos-s->read_filepos
 450         );
 451         if(s->eof) break; // file is smaller than prefill size
 452         if(stream_check_interrupt(PREFILL_SLEEP_TIME)) {
 453           res = 0;
 454           goto err_out;
 455         }
 456     }
 457     mp_msg(MSGT_CACHE,MSGL_STATUS,"\n");
 458     return 1; // parent exits
 459
 460 err_out:
 461     cache_uninit(stream);
 462     return res;
 463   }
 464
 465 #if FORKED_CACHE
 466   signal(SIGTERM,exit_sighandler); // kill
 467   cache_mainloop(s);
 468   // make sure forked code never leaves this function
 469   exit(0);
 470 #endif
 471 }
 472
 473 #if !FORKED_CACHE
 474 #if defined(__MINGW32__) || defined(__OS2__)
 475 static void ThreadProc( void *s ){
 476   cache_mainloop(s);
 477   _endthread();
 478 }
 479 #else
 480 static void *ThreadProc( void *s ){
 481   cache_mainloop(s);
 482   return NULL;
 483 }
 484 #endif
 485 #endif
 486
 487 int cache_stream_fill_buffer(stream_t *s){
 488   int len;
 489   int sector_size;
 490   if(!s->cache_pid) return stream_fill_buffer(s);
 491
 492   if(s->pos!=((cache_vars_t*)s->cache_data)->read_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"!!! read_filepos differs!!! report this bug...\n");
 493   sector_size = ((cache_vars_t*)s->cache_data)->sector_size;
 494   if (sector_size > STREAM_MAX_SECTOR_SIZE) {
 495     mp_msg(MSGT_CACHE, MSGL_ERR, "Sector size %i larger than maximum %i\n", sector_size, STREAM_MAX_SECTOR_SIZE);
 496     sector_size = STREAM_MAX_SECTOR_SIZE;
 497   }
 498
 499   len=cache_read(s->cache_data,s->buffer, sector_size);
 500   //printf("cache_stream_fill_buffer->read -> %d\n",len);
 501
 502   if(len<=0){ s->eof=1; s->buf_pos=s->buf_len=0; return 0; }
 503   s->eof=0;
 504   s->buf_pos=0;
 505   s->buf_len=len;
 506   s->pos+=len;
 507 //  printf("[%d]",len);fflush(stdout);
 508   if (s->capture_file)
 509     stream_capture_do(s);
 510   return len;
 511
 512 }
 513
 514 int cache_stream_seek_long(stream_t *stream,off_t pos){
 515   cache_vars_t* s;
 516   off_t newpos;
 517   if(!stream->cache_pid) return stream_seek_long(stream,pos);
 518
 519   s=stream->cache_data;
 520 //  s->seek_lock=1;
 521
 522   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);
 523
 524   newpos=pos/s->sector_size; newpos*=s->sector_size; // align
 525   stream->pos=s->read_filepos=newpos;
 526   s->eof=0; // !!!!!!!
 527   cache_wakeup(stream);
 528
 529   cache_stream_fill_buffer(stream);
 530
 531   pos-=newpos;
 532   if(pos>=0 && pos<=stream->buf_len){
 533     stream->buf_pos=pos; // byte position in sector
 534     return 1;
 535   }
 536
 537 //  stream->buf_pos=stream->buf_len=0;
 538 //  return 1;
 539
 540   mp_msg(MSGT_CACHE,MSGL_V,"cache_stream_seek: WARNING! Can't seek to 0x%"PRIX64" !\n",(int64_t)(pos+newpos));
 541   return 0;
 542 }
 543
 544 int cache_do_control(stream_t *stream, int cmd, void *arg) {
 545   int sleep_count = 0;
 546   cache_vars_t* s = stream->cache_data;
 547   switch (cmd) {
 548     case STREAM_CTRL_SEEK_TO_TIME:
 549       s->control_double_arg = *(double *)arg;
 550       s->control = cmd;
 551       break;
 552     case STREAM_CTRL_SEEK_TO_CHAPTER:
 553     case STREAM_CTRL_SET_ANGLE:
 554       s->control_uint_arg = *(unsigned *)arg;
 555       s->control = cmd;
 556       break;
 557 // the core might call these every frame, they are too slow for this...
 558     case STREAM_CTRL_GET_TIME_LENGTH:
 559 //    case STREAM_CTRL_GET_CURRENT_TIME:
 560       *(double *)arg = s->stream_time_length;
 561       return s->stream_time_length ? STREAM_OK : STREAM_UNSUPPORTED;
 562     case STREAM_CTRL_GET_NUM_CHAPTERS:
 563     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 564     case STREAM_CTRL_GET_ASPECT_RATIO:
 565     case STREAM_CTRL_GET_NUM_ANGLES:
 566     case STREAM_CTRL_GET_ANGLE:
 567     case -2:
 568       s->control = cmd;
 569       break;
 570     default:
 571       return STREAM_UNSUPPORTED;
 572   }
 573   cache_wakeup(stream);
 574   while (s->control != -1) {
 575     if (sleep_count++ == 1000)
 576       mp_msg(MSGT_CACHE, MSGL_WARN, "Cache not responding!\n");
 577     if (stream_check_interrupt(CONTROL_SLEEP_TIME)) {
 578       s->eof = 1;
 579       return STREAM_UNSUPPORTED;
 580     }
 581   }
 582   switch (cmd) {
 583     case STREAM_CTRL_GET_TIME_LENGTH:
 584     case STREAM_CTRL_GET_CURRENT_TIME:
 585     case STREAM_CTRL_GET_ASPECT_RATIO:
 586       *(double *)arg = s->control_double_arg;
 587       break;
 588     case STREAM_CTRL_GET_NUM_CHAPTERS:
 589     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 590     case STREAM_CTRL_GET_NUM_ANGLES:
 591     case STREAM_CTRL_GET_ANGLE:
 592       *(unsigned *)arg = s->control_uint_arg;
 593       break;
 594     case STREAM_CTRL_SEEK_TO_CHAPTER:
 595     case STREAM_CTRL_SEEK_TO_TIME:
 596     case STREAM_CTRL_SET_ANGLE:
 597       if (s->control_res != STREAM_UNSUPPORTED)
 598           stream->pos = s->read_filepos = s->control_new_pos;
 599       break;
 600   }
 601   return s->control_res;
 602 }