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 static void cache_wakeup(stream_t *s)
  99 {
 100 #if FORKED_CACHE
 101   // signal process to wake up immediately
 102   kill(s->cache_pid, SIGUSR1);
 103 #endif
 104 }
 105
 106 static int cache_read(cache_vars_t *s, unsigned char *buf, int size)
 107 {
 108   int total=0;
 109   int sleep_count = 0;
 110   int last_max = s->max_filepos;
 111   while(size>0){
 112     int pos,newb,len;
 113
 114   //printf("CACHE2_READ: 0x%X <= 0x%X <= 0x%X  \n",s->min_filepos,s->read_filepos,s->max_filepos);
 115
 116     if(s->read_filepos>=s->max_filepos || s->read_filepos<s->min_filepos){
 117         // eof?
 118         if(s->eof) break;
 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");
 122         } else {
 123             last_max = s->max_filepos;
 124             sleep_count = 0;
 125         }
 126         // waiting for buffer fill...
 127         if (stream_check_interrupt(READ_SLEEP_TIME)) {
 128             s->eof = 1;
 129             break;
 130         }
 131         continue; // try again...
 132     }
 133     sleep_count = 0;
 134
 135     newb=s->max_filepos-s->read_filepos; // new bytes in the buffer
 136     if(newb<min_fill) min_fill=newb; // statistics...
 137
 138 //    printf("*** newb: %d bytes ***\n",newb);
 139
 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;
 143
 144     if(newb>s->buffer_size-pos) newb=s->buffer_size-pos; // handle wrap...
 145     if(newb>size) newb=size;
 146
 147     // check:
 148     if(s->read_filepos<s->min_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"Ehh. s->read_filepos<s->min_filepos !!! Report bug...\n");
 149
 150     // len=write(mem,newb)
 151     //printf("Buffer read: %d bytes\n",newb);
 152     memcpy(buf,&s->buffer[pos],newb);
 153     buf+=newb;
 154     len=newb;
 155     // ...
 156
 157     s->read_filepos+=len;
 158     size-=len;
 159     total+=len;
 160
 161   }
 162   return total;
 163 }
 164
 165 static int cache_fill(cache_vars_t *s)
 166 {
 167   int back,back2,newb,space,len,pos;
 168   off_t read=s->read_filepos;
 169   int read_chunk;
 170
 171   if(read<s->min_filepos || read>s->max_filepos){
 172       // seek...
 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)
 179       {
 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));
 185       }
 186   }
 187
 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;
 192
 193   // calc number of new bytes:
 194   newb=s->max_filepos - read;
 195   if(newb<0) newb=0; // strange...
 196
 197   // calc free buffer space:
 198   space=s->buffer_size - (newb+back);
 199
 200   // calc bufferpos:
 201   pos=s->max_filepos - s->offset;
 202   if(pos>=s->buffer_size) pos-=s->buffer_size; // wrap-around
 203
 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...
 207   }
 208
 209 //  printf("### read=0x%X  back=%d  newb=%d  space=%d  pos=%d\n",read,back,newb,space,pos);
 210
 211   // reduce space if needed:
 212   if(space>s->buffer_size-pos) space=s->buffer_size-pos;
 213
 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);
 218
 219 #if 1
 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;
 223 #else
 224   s->min_filepos=read-back; // avoid seeking-back to temp area...
 225 #endif
 226
 227   len = stream_read_internal(s->stream, &s->buffer[pos], space);
 228   s->eof= !len;
 229
 230   s->max_filepos+=len;
 231   if(pos+len>=s->buffer_size){
 232       // wrap...
 233       s->offset+=s->buffer_size;
 234   }
 235
 236   return len;
 237
 238 }
 239
 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;
 247     s->control = -1;
 248     return !quit;
 249   }
 250   if (GetTimerMS() - last > 99) {
 251     double len;
 252     if (s->stream->control(s->stream, STREAM_CTRL_GET_TIME_LENGTH, &len) == STREAM_OK)
 253       s->stream_time_length = len;
 254     else
 255       s->stream_time_length = 0;
 256     last = GetTimerMS();
 257   }
 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);
 264       break;
 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);
 272       break;
 273     default:
 274       s->control_res = STREAM_UNSUPPORTED;
 275       break;
 276   }
 277   s->control_new_pos = s->stream->pos;
 278   s->control = -1;
 279   return 1;
 280 }
 281
 282 static void *shared_alloc(int size) {
 283 #if FORKED_CACHE
 284     return shmem_alloc(size);
 285 #else
 286     return malloc(size);
 287 #endif
 288 }
 289
 290 static void shared_free(void *ptr, int size) {
 291 #if FORKED_CACHE
 292     shmem_free(ptr, size);
 293 #else
 294     free(ptr);
 295 #endif
 296 }
 297
 298 static cache_vars_t* cache_init(int size,int sector){
 299   int num;
 300   cache_vars_t* s=shared_alloc(sizeof(cache_vars_t));
 301   if(s==NULL) return NULL;
 302
 303   memset(s,0,sizeof(cache_vars_t));
 304   num=size/sector;
 305   if(num < 16){
 306      num = 16;
 307   }//32kb min_size
 308   s->buffer_size=num*sector;
 309   s->sector_size=sector;
 310   s->buffer=shared_alloc(s->buffer_size);
 311
 312   if(s->buffer == NULL){
 313     shared_free(s, sizeof(cache_vars_t));
 314     return NULL;
 315   }
 316
 317   s->fill_limit=8*sector;
 318   s->back_size=s->buffer_size/2;
 319   return s;
 320 }
 321
 322 void cache_uninit(stream_t *s) {
 323   cache_vars_t* c = s->cache_data;
 324   if(s->cache_pid) {
 325 #if !FORKED_CACHE
 326     cache_do_control(s, -2, NULL);
 327 #else
 328     kill(s->cache_pid,SIGKILL);
 329     waitpid(s->cache_pid,NULL,0);
 330 #endif
 331     s->cache_pid = 0;
 332   }
 333   if(!c) return;
 334   shared_free(c->buffer, c->buffer_size);
 335   c->buffer = NULL;
 336   c->stream = NULL;
 337   shared_free(s->cache_data, sizeof(cache_vars_t));
 338   s->cache_data = NULL;
 339 }
 340
 341 static void exit_sighandler(int x){
 342   // close stream
 343   exit(0);
 344 }
 345
 346 static void dummy_sighandler(int x) {
 347 }
 348
 349 /**
 350  * Main loop of the cache process or thread.
 351  */
 352 static void cache_mainloop(cache_vars_t *s) {
 353     int sleep_count = 0;
 354 #if FORKED_CACHE
 355     struct sigaction sa = { .sa_handler = SIG_IGN };
 356     sigaction(SIGUSR1, &sa, NULL);
 357 #endif
 358     do {
 359         if (!cache_fill(s)) {
 360 #if FORKED_CACHE
 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);
 366 #endif
 367             if (sleep_count < INITIAL_FILL_USLEEP_COUNT) {
 368                 sleep_count++;
 369                 usec_sleep(INITIAL_FILL_USLEEP_TIME);
 370             } else
 371                 usec_sleep(FILL_USLEEP_TIME); // idle
 372 #if FORKED_CACHE
 373             sa.sa_handler = SIG_IGN;
 374             sigaction(SIGUSR1, &sa, NULL);
 375 #endif
 376         } else
 377             sleep_count = 0;
 378     } while (cache_execute_control(s));
 379 }
 380
 381 /**
 382  * \return 1 on success, 0 if the function was interrupted and -1 on error
 383  */
 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;
 386   int res = -1;
 387   cache_vars_t* s;
 388
 389   if (stream->flags & STREAM_NON_CACHEABLE) {
 390     mp_msg(MSGT_CACHE,MSGL_STATUS,"\rThis stream is non-cacheable\n");
 391     return 1;
 392   }
 393
 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;
 399
 400
 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;
 405   }
 406   if (min > s->buffer_size - s->fill_limit) {
 407      min = s->buffer_size - s->fill_limit;
 408   }
 409   // to make sure we wait for the cache process/thread to be active
 410   // before continuing
 411   if (min <= 0)
 412     min = 1;
 413
 414 #if FORKED_CACHE
 415   if((stream->cache_pid=fork())){
 416     if ((pid_t)stream->cache_pid == -1)
 417       stream->cache_pid = 0;
 418 #else
 419   {
 420     stream_t* stream2=malloc(sizeof(stream_t));
 421     memcpy(stream2,s->stream,sizeof(stream_t));
 422     s->stream=stream2;
 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 );
 427 #else
 428     {
 429     pthread_t tid;
 430     pthread_create(&tid, NULL, ThreadProc, s);
 431     stream->cache_pid = 1;
 432     }
 433 #endif
 434 #endif
 435     if (!stream->cache_pid) {
 436         mp_msg(MSGT_CACHE, MSGL_ERR,
 437                "Starting cache process/thread failed: %s.\n", strerror(errno));
 438         goto err_out;
 439     }
 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
 447         );
 448         if(s->eof) break; // file is smaller than prefill size
 449         if(stream_check_interrupt(PREFILL_SLEEP_TIME)) {
 450           res = 0;
 451           goto err_out;
 452         }
 453     }
 454     mp_msg(MSGT_CACHE,MSGL_STATUS,"\n");
 455     return 1; // parent exits
 456
 457 err_out:
 458     cache_uninit(stream);
 459     return res;
 460   }
 461
 462 #if FORKED_CACHE
 463   signal(SIGTERM,exit_sighandler); // kill
 464   cache_mainloop(s);
 465   // make sure forked code never leaves this function
 466   exit(0);
 467 #endif
 468 }
 469
 470 #if !FORKED_CACHE
 471 #if defined(__MINGW32__) || defined(__OS2__)
 472 static void ThreadProc( void *s ){
 473   cache_mainloop(s);
 474   _endthread();
 475 }
 476 #else
 477 static void *ThreadProc( void *s ){
 478   cache_mainloop(s);
 479   return NULL;
 480 }
 481 #endif
 482 #endif
 483
 484 int cache_stream_fill_buffer(stream_t *s){
 485   int len;
 486   int sector_size;
 487   if(!s->cache_pid) return stream_fill_buffer(s);
 488
 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;
 494   }
 495
 496   len=cache_read(s->cache_data,s->buffer, sector_size);
 497   //printf("cache_stream_fill_buffer->read -> %d\n",len);
 498
 499   if(len<=0){ s->eof=1; s->buf_pos=s->buf_len=0; return 0; }
 500   s->eof=0;
 501   s->buf_pos=0;
 502   s->buf_len=len;
 503   s->pos+=len;
 504 //  printf("[%d]",len);fflush(stdout);
 505   if (s->capture_file)
 506     stream_capture_do(s);
 507   return len;
 508
 509 }
 510
 511 int cache_fill_status(stream_t *s) {
 512   cache_vars_t *cv;
 513   if (!s || !s->cache_data)
 514     return -1;
 515   cv = s->cache_data;
 516   return (cv->max_filepos-cv->read_filepos)/(cv->buffer_size / 100);
 517 }
 518
 519 int cache_stream_seek_long(stream_t *stream,off_t pos){
 520   cache_vars_t* s;
 521   off_t newpos;
 522   if(!stream->cache_pid) return stream_seek_long(stream,pos);
 523
 524   s=stream->cache_data;
 525 //  s->seek_lock=1;
 526
 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);
 528
 529   newpos=pos/s->sector_size; newpos*=s->sector_size; // align
 530   stream->pos=s->read_filepos=newpos;
 531   s->eof=0; // !!!!!!!
 532   cache_wakeup(stream);
 533
 534   cache_stream_fill_buffer(stream);
 535
 536   pos-=newpos;
 537   if(pos>=0 && pos<=stream->buf_len){
 538     stream->buf_pos=pos; // byte position in sector
 539     return 1;
 540   }
 541
 542 //  stream->buf_pos=stream->buf_len=0;
 543 //  return 1;
 544
 545   mp_msg(MSGT_CACHE,MSGL_V,"cache_stream_seek: WARNING! Can't seek to 0x%"PRIX64" !\n",(int64_t)(pos+newpos));
 546   return 0;
 547 }
 548
 549 int cache_do_control(stream_t *stream, int cmd, void *arg) {
 550   int sleep_count = 0;
 551   cache_vars_t* s = stream->cache_data;
 552   switch (cmd) {
 553     case STREAM_CTRL_SEEK_TO_TIME:
 554       s->control_double_arg = *(double *)arg;
 555       s->control = cmd;
 556       break;
 557     case STREAM_CTRL_SEEK_TO_CHAPTER:
 558     case STREAM_CTRL_SET_ANGLE:
 559       s->control_uint_arg = *(unsigned *)arg;
 560       s->control = cmd;
 561       break;
 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:
 572     case -2:
 573       s->control = cmd;
 574       break;
 575     default:
 576       return STREAM_UNSUPPORTED;
 577   }
 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)) {
 583       s->eof = 1;
 584       return STREAM_UNSUPPORTED;
 585     }
 586   }
 587   switch (cmd) {
 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;
 592       break;
 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;
 598       break;
 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;
 604       break;
 605   }
 606   return s->control_res;
 607 }