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