1 #include <creaImageIOMultiThreadImageReader.h>
2 #include <creaImageIOImageReader.h>
4 #include <creaImageIOSystem.h>
6 #include <creaImageIOGimmick.h>
13 //=====================================================================
14 void MultiThreadImageReaderUser::MultiThreadImageReaderSendEvent
15 ( const std::string& filename,
19 wxMutexLocker lock(mMultiThreadImageReaderUserMutex);
21 this->OnMultiThreadImageReaderEvent(filename,type,image);
23 //=====================================================================
25 //=====================================================================
26 class ThreadedImageReader: public wxThread
29 ThreadedImageReader(MultiThreadImageReader* tir) :
30 mMultiThreadImageReader(tir)
36 vtkImageData* Read(const std::string& filename);
40 void operator()(ThreadedImageReader* p)
45 friend struct deleter;
50 MultiThreadImageReader* mMultiThreadImageReader;
54 //=====================================================================
57 //=====================================================================
58 MultiThreadImageReader::MultiThreadImageReader(int number_of_threads)
59 : //mDoNotSignal(false),
64 // std::cout << "#### MultiThreadImageReader::MultiThreadImageReader("
65 // << " #threads= " << number_of_threads <<" )"<<std::endl;
69 for (int i=0; i<number_of_threads; i++)
71 //ThreadedImageReader* t = new ThreadedImageReader(this);
72 boost::shared_ptr<ThreadedImageReader> t(new ThreadedImageReader(this), ThreadedImageReader::deleter());
73 mThreadedImageReaderList.push_back(t);
74 std::cout << " ===> Thread "<<i
75 <<" successfully added"<< std::endl;
77 mNumberOfThreadedReadersRunning = 0;
79 mQueue.set(mComparator);
82 // no thread : alloc self reader
83 // if (number_of_threads==0)
85 mReader = new ImageReader();
88 //=====================================================================
91 //=====================================================================
92 bool MultiThreadImageReader::Start()
95 // std::cout << "#### MultiThreadImageReader::Start()"
97 if (mNumberOfThreadedReadersRunning > 0) return true;
99 ThreadedImageReaderListType::iterator i;
100 for (i =mThreadedImageReaderList.begin();
101 i!=mThreadedImageReaderList.end();
105 if ( (*i)->Run() != wxTHREAD_NO_ERROR )
107 std::cout << "ERROR starting a thread"<< std::endl;
112 std::cout << " ===> Thread "<<(*i)->GetCurrentId()
113 <<" successfully created"<< std::endl;
117 wxMutexLocker locker(GetMultiThreadImageReaderUserMutex());
118 // std::cout << "EO Start : #Threads running = "
119 // << mNumberOfThreadedReadersRunning<<std::endl;
123 //=====================================================================
125 //=====================================================================
126 void MultiThreadImageReader::Stop()
128 // std::cout << "#### MultiThreadImageReader::Stop()"
130 // std::cout << "Sending stop order to the threads..."<<std::endl;
133 ThreadedImageReaderListType::iterator i;
134 for (i =mThreadedImageReaderList.begin();
135 i!=mThreadedImageReaderList.end();
137 { std::cout << " ===> Thread "<<(*i)->GetCurrentId()
138 <<" successfully stopped"<< std::endl;
145 mThreadedImageReaderList.clear();
146 // Wait a little to be sure that all threads have stopped
147 // A better way to do this ?
148 // wxMilliSleep(1000);
149 // New method : the threads generate a stop event when they have finished
150 // We wait until all threads have stopped
151 // std::cout << "Waiting for stop signals..."<<std::endl;
158 wxMutexLocker locker(GetMultiThreadImageReaderUserMutex());
159 // std::cout << "#Threads running = "
160 // << mNumberOfThreadedReadersRunning<<std::endl;
161 // Break if all readers have stopped
162 if (mNumberOfThreadedReadersRunning <= 0)
169 // std::cout << "All threads stopped : OK "<<std::endl;
171 ImageMapType::iterator j;
172 for (j =mImages.begin();
182 //=====================================================================
184 //=====================================================================
185 MultiThreadImageReader::~MultiThreadImageReader()
187 // std::cout << "#### MultiThreadImageReader::~MultiThreadImageReader()"
190 if (mReader) delete mReader;
191 mThreadedImageReaderList.clear();
193 //=====================================================================
195 //=====================================================================
196 void MultiThreadImageReader::UpdateUnloadPriority(ImageToLoadPtr p,
199 // not in unload queue : ciao
200 if (p->UnloadIndex()<0) return;
201 int old_prio = p->GetPriority();
202 if (priority > old_prio)
204 p->SetPriority(priority);
205 mUnloadQueue.downsort(p->UnloadIndex());
207 else if ( old_prio > priority )
209 p->SetPriority(priority);
210 mUnloadQueue.upsort(p->UnloadIndex());
213 //=====================================================================
215 //=====================================================================
216 void MultiThreadImageReader::Request( MultiThreadImageReaderUser* user,
217 const std::string& filename,
220 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
222 if (mNumberOfThreadedReadersRunning==0)
223 // if (mThreadedImageReaderList.size()==0)
225 // no detached reader : use self reader
226 ImageToLoad itl(user,filename);
227 ImageMapType::iterator i = mImages.find(&itl);
228 if (i!=mImages.end())
230 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
232 if (pitl->GetImage() != 0)
236 UpdateUnloadPriority(pitl,priority);
237 SignalImageRead(pitl,false);
238 return; // pitl->GetImage();
241 ImageToLoadPtr pitl = new ImageToLoad(user,filename,0);
243 pitl->SetImage(mReader->ReadImage(filename));
244 UpdateUnloadPriority(pitl,priority);
245 SignalImageRead(pitl,true);
246 // return pitl->GetImage();
250 ImageToLoad itl(user,filename);
251 ImageMapType::iterator i = mImages.find(&itl);
252 if (i!=mImages.end())
255 if (i->first->GetImage() != 0)
257 // Already read : ok :signal the user
258 UpdateUnloadPriority(i->first,priority);
259 SignalImageRead(i->first,false);
262 /// Already requested : change the priority
263 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
264 pitl->SetPriority(priority);
266 if (pitl->Index()>=0)
269 mQueue.upsort(pitl->Index());
271 // Not read but not in queue = being read = ok
279 // Never requested before or unloaded
280 ImageToLoadPtr pitl = new ImageToLoad(user,filename,priority);
285 //=====================================================================
287 //=====================================================================
288 void MultiThreadImageReader::OnMultiThreadImageReaderEvent
289 (const std::string& filename,
290 MultiThreadImageReaderUser::EventType e,
293 if ((e==MultiThreadImageReaderUser::ImageLoaded) &&
294 (filename == mRequestedFilename))
296 mRequestedImage = image;
298 else if (e==MultiThreadImageReaderUser::ThreadedReaderStarted)
300 mNumberOfThreadedReadersRunning++;
301 // std::cout << "#TR=" << mNumberOfThreadedReadersRunning << std::endl;
303 else if (e==MultiThreadImageReaderUser::ThreadedReaderStopped)
306 mNumberOfThreadedReadersRunning--;
307 // std::cout << "#TR=" << mNumberOfThreadedReadersRunning << std::endl;
310 //=====================================================================
312 //=====================================================================
313 vtkImageData* MultiThreadImageReader::GetImage(const std::string& filename)
316 // std::cout << "** MultiThreadImageReader::GetImage('"<<filename<<"')"
321 // wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
323 // std::cout << "** MultiThreadImageReader::GetImage('"<<filename
327 // if (mNumberOfThreadedReadersRunning==0)
328 // if (mThreadedImageReaderList.size()==0)
331 ImageToLoad itl(this,filename);
332 ImageMapType::iterator i = mImages.find(&itl);
333 if (i!=mImages.end())
335 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
337 if (pitl->GetImage() != 0)
340 UpdateUnloadPriority(pitl,
341 GetMaximalPriorityWithoutLocking()+1);
342 return pitl->GetImage();
345 ImageToLoadPtr pitl = new ImageToLoad(this,filename,0);
347 pitl->SetImage(mReader->ReadImage(filename));
348 UpdateUnloadPriority(pitl,
349 GetMaximalPriorityWithoutLocking()+1);
350 return pitl->GetImage();
354 mRequestedFilename = filename;
356 ImageToLoad itl(this,filename);
357 ImageMapType::iterator i = mImages.find(&itl);
358 if (i!=mImages.end())
360 // Already inserted in queue
361 if (i->first->GetImage() != 0)
363 // Already read : ok : return it
364 return i->first->GetImage();
366 /// Already requested : change the priority
367 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
368 pitl->SetPriority( GetMaximalPriorityWithoutLocking() + 1 );
369 pitl->SetUser( this );
371 if (pitl->Index()>=0)
374 mQueue.upsort(pitl->Index());
376 // Not read but not in queue = being read = ok
379 pitl->SetUser( this );
385 // Never requested before or unloaded
386 ImageToLoadPtr pitl =
387 new ImageToLoad(this,filename,
388 GetMaximalPriorityWithoutLocking() + 1);
396 // std::cout << "Waiting..."<<std::endl;
399 // Waiting that it is read
403 // std::cout << n++ << std::endl;
407 // wxMutexLocker lock(mMutex);
408 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex());
409 if (mRequestedImage!=0)
411 return mRequestedImage;
420 //=====================================================================
422 //=====================================================================
423 void MultiThreadImageReader::SignalImageRead(ImageToLoadPtr p,
427 // std::cout << "MultiThreadImageReader::SignalImageRead" <<std::endl;
428 // std::cout << "this="<<this <<std::endl;
429 // std::cout << "user="<<p->GetUser() <<std::endl;
431 if ( p->GetUser() == this )
432 GetMultiThreadImageReaderUserMutex().Unlock();
434 p->GetUser()->MultiThreadImageReaderSendEvent
436 MultiThreadImageReaderUser::ImageLoaded,
440 AN ATTEMPT TO UNLOAD OLDEST IMAGE IF EXCEEDED A CERTAIN MEMORY QUOTA
444 GimmickMessage(5,"Image '"<<p->GetFilename()<<"' read"<<std::endl);
446 // wxMutexLocker lock(GetMultiThreadImageReaderUserMutex());
448 mUnloadQueue.insert(p);
449 p->GetImage()->UpdateInformation();
450 p->GetImage()->PropagateUpdateExtent();
451 long ImMem = p->GetImage()->GetEstimatedMemorySize();
454 GimmickMessage(5,"==> Image in memory = "<<mUnloadQueue.size()<<std::endl);
455 GimmickMessage(5,"==> Total mem = "<<mTotalMem<<" Ko"<<std::endl);
459 while (mTotalMem > mTotalMemMax)
462 " ! Exceeded max of "
463 << mTotalMemMax << " Ko : unloading oldest image ... "
465 if ( mUnloadQueue.size() <= 1 )
468 " Only one image : cannot load AND unload it !!"
473 ImageToLoadPtr unload = mUnloadQueue.remove_top();
474 MultiThreadImageReaderUser* user = unload->GetUser();
477 if ((user!=0)&&(user!=this))
479 user->GetMultiThreadImageReaderUserMutex().Lock();
483 std::string filename = unload->GetFilename();
485 GimmickMessage(5,"'" << filename << "'" << std::endl);
486 mTotalMem -= unload->GetImage()->GetEstimatedMemorySize();
488 GimmickMessage(5," ==> Total mem = "<<mTotalMem<<" Ko "<<std::endl);
492 // std::cout << "unlock..."<<std::endl;
493 // user->GetMultiThreadImageReaderUserMutex().Unlock();
494 // std::cout << "event"<<std::endl;
495 user->MultiThreadImageReaderSendEvent
497 MultiThreadImageReaderUser::ImageUnloaded,
499 // std::cout << "event ok"<<std::endl;
502 if (unload->Index()>=0)
504 // GimmickMessage(5,"still in queue"<<std::endl);
506 unload->Index() = -1;
509 ImageMapType::iterator it = mImages.find(unload);
510 if (it!=mImages.end())
514 // std::cout << "delete..."<<std::endl;
516 // std::cout << "delete ok."<<std::endl;
520 //=====================================================================
522 //=====================================================================
523 int MultiThreadImageReader::GetMaximalPriority()
525 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
526 return GetMaximalPriorityWithoutLocking();
528 //=====================================================================
531 //=====================================================================
532 int MultiThreadImageReader::GetMaximalPriorityWithoutLocking()
537 max = mQueue.top()->GetPriority();
539 if (mUnloadQueue.size()>0)
541 int max2 = mUnloadQueue.top()->GetPriority();
542 if (max2>max) max=max2;
546 //=====================================================================
549 //=====================================================================
550 //=====================================================================
551 //=====================================================================
552 //=====================================================================
554 //=====================================================================
555 void* ThreadedImageReader::Entry()
557 // std::cout << "### Thread "<<GetCurrentId()<<"::Entry()"
560 mMultiThreadImageReader->MultiThreadImageReaderSendEvent
562 MultiThreadImageReaderUser::ThreadedReaderStarted,
565 // While was not deleted
566 while (!TestDestroy())
568 //std::cout << "### Thread "<<GetCurrentId()<<" still alive" << std::endl;
571 mMultiThreadImageReader->MultiThreadImageReaderEventLock();
574 if (mMultiThreadImageReader->mQueue.size()>0)
576 MultiThreadImageReader::ImageToLoadPtr i =
577 mMultiThreadImageReader->mQueue.remove_top();
579 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock();
583 // std::cout << "### Thread "<<GetCurrentId()<<" : reading '"
584 // << i->GetFilename() << "'" << std::endl;
587 vtkImageData* im = Read(i->GetFilename());
589 // Store it in the map
590 mMultiThreadImageReader->MultiThreadImageReaderEventLock();
592 MultiThreadImageReader::ImageToLoad itl(0,i->GetFilename());
593 MultiThreadImageReader::ImageMapType::iterator it =
594 mMultiThreadImageReader->mImages.find(&itl);
595 MultiThreadImageReader::ImageToLoadPtr
596 pitl = const_cast<MultiThreadImageReader::ImageToLoadPtr>
599 mMultiThreadImageReader->SignalImageRead(pitl,true);//i->GetFilename());
600 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock(); //mMutex.Unlock();
602 // std::cout << "### Thread "<<GetCurrentId()<<" : reading '"
603 // << i->GetFilename() << "' : DONE" << std::endl;
608 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock();
610 // Wait a little to avoid blocking
614 // std::cout << "### Thread "<<GetCurrentId()<<" stopping"
619 //=====================================================================
621 //=====================================================================
622 void ThreadedImageReader::OnExit()
624 mMultiThreadImageReader->MultiThreadImageReaderSendEvent
626 MultiThreadImageReaderUser::ThreadedReaderStopped,
629 //=====================================================================
631 //=====================================================================
632 vtkImageData* ThreadedImageReader::Read(const std::string& filename)
634 return mReader.ReadImage(filename);
636 //=====================================================================
638 } // namespace creaImageIO