Add explanatory comments to the #endif part of multiple inclusion guards.
[mplayer/greg.git] / stream / cache2.c
blob40f0503b2e4df51f67d6bcaee59b4108ec394ddf
1 #include "config.h"
3 // Initial draft of my new cache system...
4 // Note it runs in 2 processes (using fork()), but doesn't requires locking!!
5 // TODO: seeking, data consistency checking
7 #define READ_USLEEP_TIME 10000
8 #define FILL_USLEEP_TIME 50000
9 #define PREFILL_SLEEP_TIME 200
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <string.h>
14 #include <signal.h>
15 #include <sys/types.h>
16 #include <unistd.h>
18 #include "osdep/timer.h"
19 #ifndef WIN32
20 #include <sys/wait.h>
21 #include "osdep/shmem.h"
22 #else
23 #include <windows.h>
24 static DWORD WINAPI ThreadProc(void* s);
25 #endif
27 #include "mp_msg.h"
28 #include "help_mp.h"
30 #include "stream.h"
31 #include "input/input.h"
32 extern int use_gui;
34 int stream_fill_buffer(stream_t *s);
35 int stream_seek_long(stream_t *s,off_t pos);
37 typedef struct {
38 // constats:
39 unsigned char *buffer; // base pointer of the alllocated buffer memory
40 int buffer_size; // size of the alllocated buffer memory
41 int sector_size; // size of a single sector (2048/2324)
42 int back_size; // we should keep back_size amount of old bytes for backward seek
43 int fill_limit; // we should fill buffer only if space>=fill_limit
44 int seek_limit; // keep filling cache if distanse is less that seek limit
45 // filler's pointers:
46 int eof;
47 off_t min_filepos; // buffer contain only a part of the file, from min-max pos
48 off_t max_filepos;
49 off_t offset; // filepos <-> bufferpos offset value (filepos of the buffer's first byte)
50 // reader's pointers:
51 off_t read_filepos;
52 // commands/locking:
53 // int seek_lock; // 1 if we will seek/reset buffer, 2 if we are ready for cmd
54 // int fifo_flag; // 1 if we should use FIFO to notice cache about buffer reads.
55 // callback
56 stream_t* stream;
57 } cache_vars_t;
59 static int min_fill=0;
61 int cache_fill_status=0;
63 void cache_stats(cache_vars_t* s){
64 int newb=s->max_filepos-s->read_filepos; // new bytes in the buffer
65 mp_msg(MSGT_CACHE,MSGL_INFO,"0x%06X [0x%06X] 0x%06X ",(int)s->min_filepos,(int)s->read_filepos,(int)s->max_filepos);
66 mp_msg(MSGT_CACHE,MSGL_INFO,"%3d %% (%3d%%)\n",100*newb/s->buffer_size,100*min_fill/s->buffer_size);
69 int cache_read(cache_vars_t* s,unsigned char* buf,int size){
70 int total=0;
71 while(size>0){
72 int pos,newb,len;
74 //printf("CACHE2_READ: 0x%X <= 0x%X <= 0x%X \n",s->min_filepos,s->read_filepos,s->max_filepos);
76 if(s->read_filepos>=s->max_filepos || s->read_filepos<s->min_filepos){
77 // eof?
78 if(s->eof) break;
79 // waiting for buffer fill...
80 usec_sleep(READ_USLEEP_TIME); // 10ms
81 continue; // try again...
84 newb=s->max_filepos-s->read_filepos; // new bytes in the buffer
85 if(newb<min_fill) min_fill=newb; // statistics...
87 // printf("*** newb: %d bytes ***\n",newb);
89 pos=s->read_filepos - s->offset;
90 if(pos<0) pos+=s->buffer_size; else
91 if(pos>=s->buffer_size) pos-=s->buffer_size;
93 if(newb>s->buffer_size-pos) newb=s->buffer_size-pos; // handle wrap...
94 if(newb>size) newb=size;
96 // check:
97 if(s->read_filepos<s->min_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"Ehh. s->read_filepos<s->min_filepos !!! Report bug...\n");
99 // len=write(mem,newb)
100 //printf("Buffer read: %d bytes\n",newb);
101 memcpy(buf,&s->buffer[pos],newb);
102 buf+=newb;
103 len=newb;
104 // ...
106 s->read_filepos+=len;
107 size-=len;
108 total+=len;
111 cache_fill_status=(s->max_filepos-s->read_filepos)/(s->buffer_size / 100);
112 return total;
115 int cache_fill(cache_vars_t* s){
116 int back,back2,newb,space,len,pos;
117 off_t read=s->read_filepos;
119 if(read<s->min_filepos || read>s->max_filepos){
120 // seek...
121 mp_msg(MSGT_CACHE,MSGL_DBG2,"Out of boundaries... seeking to 0x%"PRIX64" \n",(int64_t)read);
122 // streaming: drop cache contents only if seeking backward or too much fwd:
123 if(s->stream->type!=STREAMTYPE_STREAM ||
124 read<s->min_filepos || read>=s->max_filepos+s->seek_limit)
126 s->offset= // FIXME!?
127 s->min_filepos=s->max_filepos=read; // drop cache content :(
128 if(s->stream->eof) stream_reset(s->stream);
129 stream_seek(s->stream,read);
130 mp_msg(MSGT_CACHE,MSGL_DBG2,"Seek done. new pos: 0x%"PRIX64" \n",(int64_t)stream_tell(s->stream));
134 // calc number of back-bytes:
135 back=read - s->min_filepos;
136 if(back<0) back=0; // strange...
137 if(back>s->back_size) back=s->back_size;
139 // calc number of new bytes:
140 newb=s->max_filepos - read;
141 if(newb<0) newb=0; // strange...
143 // calc free buffer space:
144 space=s->buffer_size - (newb+back);
146 // calc bufferpos:
147 pos=s->max_filepos - s->offset;
148 if(pos>=s->buffer_size) pos-=s->buffer_size; // wrap-around
150 if(space<s->fill_limit){
151 // printf("Buffer is full (%d bytes free, limit: %d)\n",space,s->fill_limit);
152 return 0; // no fill...
155 // printf("### read=0x%X back=%d newb=%d space=%d pos=%d\n",read,back,newb,space,pos);
157 // reduce space if needed:
158 if(space>s->buffer_size-pos) space=s->buffer_size-pos;
160 // if(space>32768) space=32768; // limit one-time block size
161 if(space>4*s->sector_size) space=4*s->sector_size;
163 // if(s->seek_lock) return 0; // FIXME
165 #if 1
166 // back+newb+space <= buffer_size
167 back2=s->buffer_size-(space+newb); // max back size
168 if(s->min_filepos<(read-back2)) s->min_filepos=read-back2;
169 #else
170 s->min_filepos=read-back; // avoid seeking-back to temp area...
171 #endif
173 // ....
174 //printf("Buffer fill: %d bytes of %d\n",space,s->buffer_size);
175 //len=stream_fill_buffer(s->stream);
176 //memcpy(&s->buffer[pos],s->stream->buffer,len); // avoid this extra copy!
177 // ....
178 len=stream_read(s->stream,&s->buffer[pos],space);
179 if(!len) s->eof=1;
181 s->max_filepos+=len;
182 if(pos+len>=s->buffer_size){
183 // wrap...
184 s->offset+=s->buffer_size;
187 return len;
191 cache_vars_t* cache_init(int size,int sector){
192 int num;
193 #ifndef WIN32
194 cache_vars_t* s=shmem_alloc(sizeof(cache_vars_t));
195 #else
196 cache_vars_t* s=malloc(sizeof(cache_vars_t));
197 #endif
198 if(s==NULL) return NULL;
200 memset(s,0,sizeof(cache_vars_t));
201 num=size/sector;
202 if(num < 16){
203 num = 16;
204 }//32kb min_size
205 s->buffer_size=num*sector;
206 s->sector_size=sector;
207 #ifndef WIN32
208 s->buffer=shmem_alloc(s->buffer_size);
209 #else
210 s->buffer=malloc(s->buffer_size);
211 #endif
213 if(s->buffer == NULL){
214 #ifndef WIN32
215 shmem_free(s,sizeof(cache_vars_t));
216 #else
217 free(s);
218 #endif
219 return NULL;
222 s->fill_limit=8*sector;
223 s->back_size=s->buffer_size/2;
224 return s;
227 void cache_uninit(stream_t *s) {
228 cache_vars_t* c = s->cache_data;
229 if(!s->cache_pid) return;
230 #ifndef WIN32
231 kill(s->cache_pid,SIGKILL);
232 waitpid(s->cache_pid,NULL,0);
233 #else
234 TerminateThread((HANDLE)s->cache_pid,0);
235 free(c->stream);
236 #endif
237 if(!c) return;
238 #ifndef WIN32
239 shmem_free(c->buffer,c->buffer_size);
240 shmem_free(s->cache_data,sizeof(cache_vars_t));
241 #else
242 free(c->buffer);
243 free(s->cache_data);
244 #endif
247 static void exit_sighandler(int x){
248 // close stream
249 exit(0);
252 int stream_enable_cache(stream_t *stream,int size,int min,int seek_limit){
253 int ss = stream->sector_size ? stream->sector_size : STREAM_BUFFER_SIZE;
254 cache_vars_t* s;
256 if (stream->type==STREAMTYPE_STREAM && stream->fd < 0) {
257 // The stream has no 'fd' behind it, so is non-cacheable
258 mp_msg(MSGT_CACHE,MSGL_STATUS,"\rThis stream is non-cacheable\n");
259 return 1;
262 s=cache_init(size,ss);
263 if(s == NULL) return 0;
264 stream->cache_data=s;
265 s->stream=stream; // callback
266 s->seek_limit=seek_limit;
269 //make sure that we won't wait from cache_fill
270 //more data than it is alowed to fill
271 if (s->seek_limit > s->buffer_size - s->fill_limit ){
272 s->seek_limit = s->buffer_size - s->fill_limit;
274 if (min > s->buffer_size - s->fill_limit) {
275 min = s->buffer_size - s->fill_limit;
278 #ifndef WIN32
279 if((stream->cache_pid=fork())){
280 #else
282 DWORD threadId;
283 stream_t* stream2=malloc(sizeof(stream_t));
284 memcpy(stream2,s->stream,sizeof(stream_t));
285 s->stream=stream2;
286 stream->cache_pid = CreateThread(NULL,0,ThreadProc,s,0,&threadId);
287 #endif
288 // wait until cache is filled at least prefill_init %
289 mp_msg(MSGT_CACHE,MSGL_V,"CACHE_PRE_INIT: %"PRId64" [%"PRId64"] %"PRId64" pre:%d eof:%d \n",
290 (int64_t)s->min_filepos,(int64_t)s->read_filepos,(int64_t)s->max_filepos,min,s->eof);
291 while(s->read_filepos<s->min_filepos || s->max_filepos-s->read_filepos<min){
292 mp_msg(MSGT_CACHE,MSGL_STATUS,MSGTR_CacheFill,
293 100.0*(float)(s->max_filepos-s->read_filepos)/(float)(s->buffer_size),
294 (int64_t)s->max_filepos-s->read_filepos
296 if(s->eof) break; // file is smaller than prefill size
297 if(mp_input_check_interrupt(PREFILL_SLEEP_TIME))
298 return 0;
300 mp_msg(MSGT_CACHE,MSGL_STATUS,"\n");
301 return 1; // parent exits
304 #ifdef WIN32
306 static DWORD WINAPI ThreadProc(void*s){
307 #endif
309 #ifdef HAVE_NEW_GUI
310 use_gui = 0; // mp_msg may not use gui stuff in forked code
311 #endif
312 // cache thread mainloop:
313 signal(SIGTERM,exit_sighandler); // kill
314 while(1){
315 if(!cache_fill((cache_vars_t*)s)){
316 usec_sleep(FILL_USLEEP_TIME); // idle
318 // cache_stats(s->cache_data);
322 int cache_stream_fill_buffer(stream_t *s){
323 int len;
324 if(s->eof){ s->buf_pos=s->buf_len=0; return 0; }
325 if(!s->cache_pid) return stream_fill_buffer(s);
327 // cache_stats(s->cache_data);
329 if(s->pos!=((cache_vars_t*)s->cache_data)->read_filepos) mp_msg(MSGT_CACHE,MSGL_ERR,"!!! read_filepos differs!!! report this bug...\n");
331 len=cache_read(s->cache_data,s->buffer, ((cache_vars_t*)s->cache_data)->sector_size);
332 //printf("cache_stream_fill_buffer->read -> %d\n",len);
334 if(len<=0){ s->eof=1; s->buf_pos=s->buf_len=0; return 0; }
335 s->buf_pos=0;
336 s->buf_len=len;
337 s->pos+=len;
338 // printf("[%d]",len);fflush(stdout);
339 return len;
343 int cache_stream_seek_long(stream_t *stream,off_t pos){
344 cache_vars_t* s;
345 off_t newpos;
346 if(!stream->cache_pid) return stream_seek_long(stream,pos);
348 s=stream->cache_data;
349 // s->seek_lock=1;
351 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);
353 newpos=pos/s->sector_size; newpos*=s->sector_size; // align
354 stream->pos=s->read_filepos=newpos;
355 s->eof=0; // !!!!!!!
357 cache_stream_fill_buffer(stream);
359 pos-=newpos;
360 if(pos>=0 && pos<=stream->buf_len){
361 stream->buf_pos=pos; // byte position in sector
362 return 1;
365 // stream->buf_pos=stream->buf_len=0;
366 // return 1;
368 mp_msg(MSGT_CACHE,MSGL_V,"cache_stream_seek: WARNING! Can't seek to 0x%"PRIX64" !\n",(int64_t)(pos+newpos));
369 return 0;