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