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