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   // limit one-time block size
 216   if(space>4*s->sector_size) space=4*s->sector_size;
 217
 218 #if 1
 219   // back+newb+space <= buffer_size
 220   back2=s->buffer_size-(space+newb); // max back size
 221   if(s->min_filepos<(read-back2)) s->min_filepos=read-back2;
 222 #else
 223   s->min_filepos=read-back; // avoid seeking-back to temp area...
 224 #endif
 225
 226   len=stream_read(s->stream,&s->buffer[pos],space);
 227   s->eof= !len;
 228
 229   s->max_filepos+=len;
 230   if(pos+len>=s->buffer_size){
 231       // wrap...
 232       s->offset+=s->buffer_size;
 233   }
 234
 235   return len;
 236
 237 }
 238
 239 static int cache_execute_control(cache_vars_t *s) {
 240   static unsigned last;
 241   int quit = s->control == -2;
 242   if (quit || !s->stream->control) {
 243     s->stream_time_length = 0;
 244     s->control_new_pos = 0;
 245     s->control_res = STREAM_UNSUPPORTED;
 246     s->control = -1;
 247     return !quit;
 248   }
 249   if (GetTimerMS() - last > 99) {
 250     double len;
 251     if (s->stream->control(s->stream, STREAM_CTRL_GET_TIME_LENGTH, &len) == STREAM_OK)
 252       s->stream_time_length = len;
 253     else
 254       s->stream_time_length = 0;
 255     last = GetTimerMS();
 256   }
 257   if (s->control == -1) return 1;
 258   switch (s->control) {
 259     case STREAM_CTRL_GET_CURRENT_TIME:
 260     case STREAM_CTRL_SEEK_TO_TIME:
 261     case STREAM_CTRL_GET_ASPECT_RATIO:
 262       s->control_res = s->stream->control(s->stream, s->control, &s->control_double_arg);
 263       break;
 264     case STREAM_CTRL_SEEK_TO_CHAPTER:
 265     case STREAM_CTRL_GET_NUM_CHAPTERS:
 266     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 267     case STREAM_CTRL_GET_NUM_ANGLES:
 268     case STREAM_CTRL_GET_ANGLE:
 269     case STREAM_CTRL_SET_ANGLE:
 270       s->control_res = s->stream->control(s->stream, s->control, &s->control_uint_arg);
 271       break;
 272     default:
 273       s->control_res = STREAM_UNSUPPORTED;
 274       break;
 275   }
 276   s->control_new_pos = s->stream->pos;
 277   s->control = -1;
 278   return 1;
 279 }
 280
 281 static void *shared_alloc(int size) {
 282 #if FORKED_CACHE
 283     return shmem_alloc(size);
 284 #else
 285     return malloc(size);
 286 #endif
 287 }
 288
 289 static void shared_free(void *ptr, int size) {
 290 #if FORKED_CACHE
 291     shmem_free(ptr, size);
 292 #else
 293     free(ptr);
 294 #endif
 295 }
 296
 297 static cache_vars_t* cache_init(int size,int sector){
 298   int num;
 299   cache_vars_t* s=shared_alloc(sizeof(cache_vars_t));
 300   if(s==NULL) return NULL;
 301
 302   memset(s,0,sizeof(cache_vars_t));
 303   num=size/sector;
 304   if(num < 16){
 305      num = 16;
 306   }//32kb min_size
 307   s->buffer_size=num*sector;
 308   s->sector_size=sector;
 309   s->buffer=shared_alloc(s->buffer_size);
 310
 311   if(s->buffer == NULL){
 312     shared_free(s, sizeof(cache_vars_t));
 313     return NULL;
 314   }
 315
 316   s->fill_limit=8*sector;
 317   s->back_size=s->buffer_size/2;
 318   return s;
 319 }
 320
 321 void cache_uninit(stream_t *s) {
 322   cache_vars_t* c = s->cache_data;
 323   if(s->cache_pid) {
 324 #if !FORKED_CACHE
 325     cache_do_control(s, -2, NULL);
 326 #else
 327     kill(s->cache_pid,SIGKILL);
 328     waitpid(s->cache_pid,NULL,0);
 329 #endif
 330     s->cache_pid = 0;
 331   }
 332   if(!c) return;
 333   shared_free(c->buffer, c->buffer_size);
 334   c->buffer = NULL;
 335   c->stream = NULL;
 336   shared_free(s->cache_data, sizeof(cache_vars_t));
 337   s->cache_data = NULL;
 338 }
 339
 340 static void exit_sighandler(int x){
 341   // close stream
 342   exit(0);
 343 }
 344
 345 static void dummy_sighandler(int x) {
 346 }
 347
 348 /**
 349  * Main loop of the cache process or thread.
 350  */
 351 static void cache_mainloop(cache_vars_t *s) {
 352     int sleep_count = 0;
 353 #if FORKED_CACHE
 354     struct sigaction sa = { .sa_handler = SIG_IGN };
 355     sigaction(SIGUSR1, &sa, NULL);
 356 #endif
 357     do {
 358         if (!cache_fill(s)) {
 359 #if FORKED_CACHE
 360             // Let signal wake us up, we cannot leave this
 361             // enabled since we do not handle EINTR in most places.
 362             // This might need extra code to work on BSD.
 363             sa.sa_handler = dummy_sighandler;
 364             sigaction(SIGUSR1, &sa, NULL);
 365 #endif
 366             if (sleep_count < INITIAL_FILL_USLEEP_COUNT) {
 367                 sleep_count++;
 368                 usec_sleep(INITIAL_FILL_USLEEP_TIME);
 369             } else
 370                 usec_sleep(FILL_USLEEP_TIME); // idle
 371 #if FORKED_CACHE
 372             sa.sa_handler = SIG_IGN;
 373             sigaction(SIGUSR1, &sa, NULL);
 374 #endif
 375         } else
 376             sleep_count = 0;
 377     } while (cache_execute_control(s));
 378 }
 379
 380 /**
 381  * \return 1 on success, 0 if the function was interrupted and -1 on error
 382  */
 383 int stream_enable_cache(stream_t *stream,int size,int min,int seek_limit){
 384   int ss = stream->sector_size ? stream->sector_size : STREAM_BUFFER_SIZE;
 385   int res = -1;
 386   cache_vars_t* s;
 387
 388   if (stream->flags & STREAM_NON_CACHEABLE) {
 389     mp_msg(MSGT_CACHE,MSGL_STATUS,"\rThis stream is non-cacheable\n");
 390     return 1;
 391   }
 392
 393   s=cache_init(size,ss);
 394   if(s == NULL) return -1;
 395   stream->cache_data=s;
 396   s->stream=stream; // callback
 397   s->seek_limit=seek_limit;
 398
 399
 400   //make sure that we won't wait from cache_fill
 401   //more data than it is allowed to fill
 402   if (s->seek_limit > s->buffer_size - s->fill_limit ){
 403      s->seek_limit = s->buffer_size - s->fill_limit;
 404   }
 405   if (min > s->buffer_size - s->fill_limit) {
 406      min = s->buffer_size - s->fill_limit;
 407   }
 408   // to make sure we wait for the cache process/thread to be active
 409   // before continuing
 410   if (min <= 0)
 411     min = 1;
 412
 413 #if FORKED_CACHE
 414   if((stream->cache_pid=fork())){
 415     if ((pid_t)stream->cache_pid == -1)
 416       stream->cache_pid = 0;
 417 #else
 418   {
 419     stream_t* stream2=malloc(sizeof(stream_t));
 420     memcpy(stream2,s->stream,sizeof(stream_t));
 421     s->stream=stream2;
 422 #if defined(__MINGW32__)
 423     stream->cache_pid = _beginthread( ThreadProc, 0, s );
 424 #elif defined(__OS2__)
 425     stream->cache_pid = _beginthread( ThreadProc, NULL, 256 * 1024, s );
 426 #else
 427     {
 428     pthread_t tid;
 429     pthread_create(&tid, NULL, ThreadProc, s);
 430     stream->cache_pid = 1;
 431     }
 432 #endif
 433 #endif
 434     if (!stream->cache_pid) {
 435         mp_msg(MSGT_CACHE, MSGL_ERR,
 436                "Starting cache process/thread failed: %s.\n", strerror(errno));
 437         goto err_out;
 438     }
 439     // wait until cache is filled at least prefill_init %
 440     mp_msg(MSGT_CACHE,MSGL_V,"CACHE_PRE_INIT: %"PRId64" [%"PRId64"] %"PRId64"  pre:%d  eof:%d  \n",
 441         (int64_t)s->min_filepos,(int64_t)s->read_filepos,(int64_t)s->max_filepos,min,s->eof);
 442     while(s->read_filepos<s->min_filepos || s->max_filepos-s->read_filepos<min){
 443         mp_tmsg(MSGT_CACHE,MSGL_STATUS,"\rCache fill: %5.2f%% (%"PRId64" bytes)   ",
 444             100.0*(float)(s->max_filepos-s->read_filepos)/(float)(s->buffer_size),
 445             (int64_t)s->max_filepos-s->read_filepos
 446         );
 447         if(s->eof) break; // file is smaller than prefill size
 448         if(stream_check_interrupt(PREFILL_SLEEP_TIME)) {
 449           res = 0;
 450           goto err_out;
 451         }
 452     }
 453     mp_msg(MSGT_CACHE,MSGL_STATUS,"\n");
 454     return 1; // parent exits
 455
 456 err_out:
 457     cache_uninit(stream);
 458     return res;
 459   }
 460
 461 #if FORKED_CACHE
 462   signal(SIGTERM,exit_sighandler); // kill
 463   cache_mainloop(s);
 464   // make sure forked code never leaves this function
 465   exit(0);
 466 #endif
 467 }
 468
 469 #if !FORKED_CACHE
 470 #if defined(__MINGW32__) || defined(__OS2__)
 471 static void ThreadProc( void *s ){
 472   cache_mainloop(s);
 473   _endthread();
 474 }
 475 #else
 476 static void *ThreadProc( void *s ){
 477   cache_mainloop(s);
 478   return NULL;
 479 }
 480 #endif
 481 #endif
 482
 483 int cache_stream_fill_buffer(stream_t *s){
 484   int len;
 485   int sector_size;
 486   if(!s->cache_pid) return stream_fill_buffer(s);
 487
 488   if(s->pos!=((cache_vars_t*)s->cache_data)->read_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"!!! read_filepos differs!!! report this bug...\n");
 489   sector_size = ((cache_vars_t*)s->cache_data)->sector_size;
 490   if (sector_size > STREAM_MAX_SECTOR_SIZE) {
 491     mp_msg(MSGT_CACHE, MSGL_ERR, "Sector size %i larger than maximum %i\n", sector_size, STREAM_MAX_SECTOR_SIZE);
 492     sector_size = STREAM_MAX_SECTOR_SIZE;
 493   }
 494
 495   len=cache_read(s->cache_data,s->buffer, sector_size);
 496   //printf("cache_stream_fill_buffer->read -> %d\n",len);
 497
 498   if(len<=0){ s->eof=1; s->buf_pos=s->buf_len=0; return 0; }
 499   s->eof=0;
 500   s->buf_pos=0;
 501   s->buf_len=len;
 502   s->pos+=len;
 503 //  printf("[%d]",len);fflush(stdout);
 504   if (s->capture_file)
 505     stream_capture_do(s);
 506   return len;
 507
 508 }
 509
 510 int cache_stream_seek_long(stream_t *stream,off_t pos){
 511   cache_vars_t* s;
 512   off_t newpos;
 513   if(!stream->cache_pid) return stream_seek_long(stream,pos);
 514
 515   s=stream->cache_data;
 516 //  s->seek_lock=1;
 517
 518   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);
 519
 520   newpos=pos/s->sector_size; newpos*=s->sector_size; // align
 521   stream->pos=s->read_filepos=newpos;
 522   s->eof=0; // !!!!!!!
 523   cache_wakeup(stream);
 524
 525   cache_stream_fill_buffer(stream);
 526
 527   pos-=newpos;
 528   if(pos>=0 && pos<=stream->buf_len){
 529     stream->buf_pos=pos; // byte position in sector
 530     return 1;
 531   }
 532
 533 //  stream->buf_pos=stream->buf_len=0;
 534 //  return 1;
 535
 536   mp_msg(MSGT_CACHE,MSGL_V,"cache_stream_seek: WARNING! Can't seek to 0x%"PRIX64" !\n",(int64_t)(pos+newpos));
 537   return 0;
 538 }
 539
 540 int cache_do_control(stream_t *stream, int cmd, void *arg) {
 541   int sleep_count = 0;
 542   cache_vars_t* s = stream->cache_data;
 543   switch (cmd) {
 544     case STREAM_CTRL_SEEK_TO_TIME:
 545       s->control_double_arg = *(double *)arg;
 546       s->control = cmd;
 547       break;
 548     case STREAM_CTRL_SEEK_TO_CHAPTER:
 549     case STREAM_CTRL_SET_ANGLE:
 550       s->control_uint_arg = *(unsigned *)arg;
 551       s->control = cmd;
 552       break;
 553 // the core might call these every frame, they are too slow for this...
 554     case STREAM_CTRL_GET_TIME_LENGTH:
 555 //    case STREAM_CTRL_GET_CURRENT_TIME:
 556       *(double *)arg = s->stream_time_length;
 557       return s->stream_time_length ? STREAM_OK : STREAM_UNSUPPORTED;
 558     case STREAM_CTRL_GET_NUM_CHAPTERS:
 559     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 560     case STREAM_CTRL_GET_ASPECT_RATIO:
 561     case STREAM_CTRL_GET_NUM_ANGLES:
 562     case STREAM_CTRL_GET_ANGLE:
 563     case -2:
 564       s->control = cmd;
 565       break;
 566     default:
 567       return STREAM_UNSUPPORTED;
 568   }
 569   cache_wakeup(stream);
 570   while (s->control != -1) {
 571     if (sleep_count++ == 1000)
 572       mp_msg(MSGT_CACHE, MSGL_WARN, "Cache not responding!\n");
 573     if (stream_check_interrupt(CONTROL_SLEEP_TIME)) {
 574       s->eof = 1;
 575       return STREAM_UNSUPPORTED;
 576     }
 577   }
 578   switch (cmd) {
 579     case STREAM_CTRL_GET_TIME_LENGTH:
 580     case STREAM_CTRL_GET_CURRENT_TIME:
 581     case STREAM_CTRL_GET_ASPECT_RATIO:
 582       *(double *)arg = s->control_double_arg;
 583       break;
 584     case STREAM_CTRL_GET_NUM_CHAPTERS:
 585     case STREAM_CTRL_GET_CURRENT_CHAPTER:
 586     case STREAM_CTRL_GET_NUM_ANGLES:
 587     case STREAM_CTRL_GET_ANGLE:
 588       *(unsigned *)arg = s->control_uint_arg;
 589       break;
 590     case STREAM_CTRL_SEEK_TO_CHAPTER:
 591     case STREAM_CTRL_SEEK_TO_TIME:
 592     case STREAM_CTRL_SET_ANGLE:
 593       if (s->control_res != STREAM_UNSUPPORTED)
 594           stream->pos = s->read_filepos = s->control_new_pos;
 595       break;
 596   }
 597   return s->control_res;
 598 }