1 #include <creaImageIOMultiThreadImageReader.h>
2 #include <creaImageIOImageReader.h>
4 #include <creaImageIOSystem.h>
10 //=====================================================================
11 void MultiThreadImageReaderUser::MultiThreadImageReaderSendEvent
12 ( const std::string& filename,
16 wxMutexLocker lock(mMultiThreadImageReaderUserMutex);
18 this->OnMultiThreadImageReaderEvent(filename,type,image);
20 //=====================================================================
22 //=====================================================================
23 class ThreadedImageReader: public wxThread
26 ThreadedImageReader(MultiThreadImageReader* tir) :
27 mMultiThreadImageReader(tir)
33 vtkImageData* Read(const std::string& filename);
37 void operator()(ThreadedImageReader* p)
42 friend struct deleter;
47 MultiThreadImageReader* mMultiThreadImageReader;
52 //=====================================================================
55 //=====================================================================
56 MultiThreadImageReader::MultiThreadImageReader(int number_of_threads)
57 : //mDoNotSignal(false),
62 // std::cout << "#### MultiThreadImageReader::MultiThreadImageReader("
63 // << " #threads= " << number_of_threads <<" )"<<std::endl;
66 for (int i=0; i<number_of_threads; i++)
68 //ThreadedImageReader* t = new ThreadedImageReader(this);
69 boost::shared_ptr<ThreadedImageReader> t(new ThreadedImageReader(this), ThreadedImageReader::deleter());
70 mThreadedImageReaderList.push_back(t);
71 std::cout << " ===> Thread "<<i
72 <<" successfully added"<< std::endl;
74 mNumberOfThreadedReadersRunning = 0;
76 mQueue.set(mComparator);
79 // no thread : alloc self reader
80 // if (number_of_threads==0)
82 mReader = new ImageReader();
85 //=====================================================================
88 //=====================================================================
89 bool MultiThreadImageReader::Start()
92 // std::cout << "#### MultiThreadImageReader::Start()"
94 if (mNumberOfThreadedReadersRunning > 0) return true;
96 ThreadedImageReaderListType::iterator i;
97 for (i =mThreadedImageReaderList.begin();
98 i!=mThreadedImageReaderList.end();
102 if ( (*i)->Run() != wxTHREAD_NO_ERROR )
104 std::cout << "ERROR starting a thread"<< std::endl;
109 std::cout << " ===> Thread "<<(*i)->GetCurrentId()
110 <<" successfully created"<< std::endl;
114 wxMutexLocker locker(GetMultiThreadImageReaderUserMutex());
115 // std::cout << "EO Start : #Threads running = "
116 // << mNumberOfThreadedReadersRunning<<std::endl;
120 //=====================================================================
122 //=====================================================================
123 void MultiThreadImageReader::Stop()
125 // std::cout << "#### MultiThreadImageReader::Stop()"
127 // std::cout << "Sending stop order to the threads..."<<std::endl;
129 ThreadedImageReaderListType::iterator i;
130 for (i =mThreadedImageReaderList.begin();
131 i!=mThreadedImageReaderList.end();
133 { std::cout << " ===> Thread "<<(*i)->GetCurrentId()
134 <<" successfully stopped"<< std::endl;
140 // mThreadedImageReaderList.clear();
141 // Wait a little to be sure that all threads have stopped
142 // A better way to do this ?
143 // wxMilliSleep(1000);
144 // New method : the threads generate a stop event when they have finished
145 // We wait until all threads have stopped
146 // std::cout << "Waiting for stop signals..."<<std::endl;
153 wxMutexLocker locker(GetMultiThreadImageReaderUserMutex());
154 // std::cout << "#Threads running = "
155 // << mNumberOfThreadedReadersRunning<<std::endl;
156 // Break if all readers have stopped
157 if (mNumberOfThreadedReadersRunning <= 0)
164 // std::cout << "All threads stopped : OK "<<std::endl;
166 ImageMapType::iterator j;
167 for (j =mImages.begin();
176 //=====================================================================
178 //=====================================================================
179 MultiThreadImageReader::~MultiThreadImageReader()
181 // std::cout << "#### MultiThreadImageReader::~MultiThreadImageReader()"
184 if (mReader) delete mReader;
185 mThreadedImageReaderList.clear();
187 //=====================================================================
189 //=====================================================================
190 void MultiThreadImageReader::UpdateUnloadPriority(ImageToLoadPtr p,
193 // not in unload queue : ciao
194 if (p->UnloadIndex()<0) return;
195 int old_prio = p->GetPriority();
196 if (priority > old_prio)
198 p->SetPriority(priority);
199 mUnloadQueue.downsort(p->UnloadIndex());
201 else if ( old_prio > priority )
203 p->SetPriority(priority);
204 mUnloadQueue.upsort(p->UnloadIndex());
207 //=====================================================================
209 //=====================================================================
210 void MultiThreadImageReader::Request( MultiThreadImageReaderUser* user,
211 const std::string& filename,
214 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
216 if (mNumberOfThreadedReadersRunning==0)
217 // if (mThreadedImageReaderList.size()==0)
219 // no detached reader : use self reader
220 ImageToLoad itl(user,filename);
221 ImageMapType::iterator i = mImages.find(&itl);
222 if (i!=mImages.end())
224 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
226 if (pitl->GetImage() != 0)
230 UpdateUnloadPriority(pitl,priority);
231 SignalImageRead(pitl,false);
232 return; // pitl->GetImage();
235 ImageToLoadPtr pitl = new ImageToLoad(user,filename,0);
237 pitl->SetImage(mReader->ReadImage(filename));
238 UpdateUnloadPriority(pitl,priority);
239 SignalImageRead(pitl,true);
240 // return pitl->GetImage();
245 ImageToLoad itl(user,filename);
246 ImageMapType::iterator i = mImages.find(&itl);
247 if (i!=mImages.end())
250 if (i->first->GetImage() != 0)
252 // Already read : ok :signal the user
253 UpdateUnloadPriority(i->first,priority);
254 SignalImageRead(i->first,false);
257 /// Already requested : change the priority
258 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
259 pitl->SetPriority(priority);
261 if (pitl->Index()>=0)
264 mQueue.upsort(pitl->Index());
266 // Not read but not in queue = being read = ok
274 // Never requested before or unloaded
275 ImageToLoadPtr pitl = new ImageToLoad(user,filename,priority);
280 //=====================================================================
282 //=====================================================================
283 void MultiThreadImageReader::OnMultiThreadImageReaderEvent
284 (const std::string& filename,
285 MultiThreadImageReaderUser::EventType e,
288 if ((e==MultiThreadImageReaderUser::ImageLoaded) &&
289 (filename == mRequestedFilename))
291 mRequestedImage = image;
293 else if (e==MultiThreadImageReaderUser::ThreadedReaderStarted)
295 mNumberOfThreadedReadersRunning++;
296 // std::cout << "#TR=" << mNumberOfThreadedReadersRunning << std::endl;
298 else if (e==MultiThreadImageReaderUser::ThreadedReaderStopped)
301 mNumberOfThreadedReadersRunning--;
302 // std::cout << "#TR=" << mNumberOfThreadedReadersRunning << std::endl;
305 //=====================================================================
307 //=====================================================================
308 vtkImageData* MultiThreadImageReader::GetImage(const std::string& filename)
311 // std::cout << "** MultiThreadImageReader::GetImage('"<<filename<<"')"
316 // wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
318 // std::cout << "** MultiThreadImageReader::GetImage('"<<filename
322 // if (mNumberOfThreadedReadersRunning==0)
323 // if (mThreadedImageReaderList.size()==0)
326 ImageToLoad itl(this,filename);
327 ImageMapType::iterator i = mImages.find(&itl);
328 if (i!=mImages.end())
330 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
332 if (pitl->GetImage() != 0)
335 UpdateUnloadPriority(pitl,
336 GetMaximalPriorityWithoutLocking()+1);
337 return pitl->GetImage();
340 ImageToLoadPtr pitl = new ImageToLoad(this,filename,0);
342 pitl->SetImage(mReader->ReadImage(filename));
343 UpdateUnloadPriority(pitl,
344 GetMaximalPriorityWithoutLocking()+1);
345 return pitl->GetImage();
349 mRequestedFilename = filename;
351 ImageToLoad itl(this,filename);
352 ImageMapType::iterator i = mImages.find(&itl);
353 if (i!=mImages.end())
355 // Already inserted in queue
356 if (i->first->GetImage() != 0)
358 // Already read : ok : return it
359 return i->first->GetImage();
361 /// Already requested : change the priority
362 ImageToLoadPtr pitl = const_cast<ImageToLoadPtr>(i->first);
363 pitl->SetPriority( GetMaximalPriorityWithoutLocking() + 1 );
364 pitl->SetUser( this );
366 if (pitl->Index()>=0)
369 mQueue.upsort(pitl->Index());
371 // Not read but not in queue = being read = ok
374 pitl->SetUser( this );
380 // Never requested before or unloaded
381 ImageToLoadPtr pitl =
382 new ImageToLoad(this,filename,
383 GetMaximalPriorityWithoutLocking() + 1);
391 // std::cout << "Waiting..."<<std::endl;
394 // Waiting that it is read
398 // std::cout << n++ << std::endl;
402 // wxMutexLocker lock(mMutex);
403 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex());
404 if (mRequestedImage!=0)
406 return mRequestedImage;
415 //=====================================================================
417 //=====================================================================
418 void MultiThreadImageReader::SignalImageRead(ImageToLoadPtr p,
422 // std::cout << "MultiThreadImageReader::SignalImageRead" <<std::endl;
423 // std::cout << "this="<<this <<std::endl;
424 // std::cout << "user="<<p->GetUser() <<std::endl;
426 if ( p->GetUser() == this )
427 GetMultiThreadImageReaderUserMutex().Unlock();
429 p->GetUser()->MultiThreadImageReaderSendEvent
431 MultiThreadImageReaderUser::ImageLoaded,
435 AN ATTEMPT TO UNLOAD OLDEST IMAGE IF EXCEEDED A CERTAIN MEMORY QUOTA
439 GimmickMessage(5,"Image '"<<p->GetFilename()<<"' read"<<std::endl);
441 // wxMutexLocker lock(GetMultiThreadImageReaderUserMutex());
443 mUnloadQueue.insert(p);
444 p->GetImage()->UpdateInformation();
445 p->GetImage()->PropagateUpdateExtent();
446 long ImMem = p->GetImage()->GetEstimatedMemorySize();
449 GimmickMessage(5,"==> Image in memory = "<<mUnloadQueue.size()<<std::endl);
450 GimmickMessage(5,"==> Total mem = "<<mTotalMem<<" Ko"<<std::endl);
454 while (mTotalMem > mTotalMemMax)
457 " ! Exceeded max of "
458 << mTotalMemMax << " Ko : unloading oldest image ... "
460 if ( mUnloadQueue.size() <= 1 )
463 " Only one image : cannot load AND unload it !!"
468 ImageToLoadPtr unload = mUnloadQueue.remove_top();
469 MultiThreadImageReaderUser* user = unload->GetUser();
472 if ((user!=0)&&(user!=this))
474 user->GetMultiThreadImageReaderUserMutex().Lock();
478 std::string filename = unload->GetFilename();
480 GimmickMessage(5,"'" << filename << "'" << std::endl);
481 mTotalMem -= unload->GetImage()->GetEstimatedMemorySize();
483 GimmickMessage(5," ==> Total mem = "<<mTotalMem<<" Ko "<<std::endl);
488 // std::cout << "unlock..."<<std::endl;
489 // user->GetMultiThreadImageReaderUserMutex().Unlock();
490 // std::cout << "event"<<std::endl;
491 user->MultiThreadImageReaderSendEvent
493 MultiThreadImageReaderUser::ImageUnloaded,
495 // std::cout << "event ok"<<std::endl;
499 if (unload->Index()>=0)
501 // GimmickMessage(5,"still in queue"<<std::endl);
503 unload->Index() = -1;
506 ImageMapType::iterator it = mImages.find(unload);
507 if (it!=mImages.end())
511 // std::cout << "delete..."<<std::endl;
513 // std::cout << "delete ok."<<std::endl;
519 //=====================================================================
521 //=====================================================================
522 int MultiThreadImageReader::GetMaximalPriority()
524 wxMutexLocker lock(GetMultiThreadImageReaderUserMutex()); //mMutex);
525 return GetMaximalPriorityWithoutLocking();
527 //=====================================================================
530 //=====================================================================
531 int MultiThreadImageReader::GetMaximalPriorityWithoutLocking()
536 max = mQueue.top()->GetPriority();
538 if (mUnloadQueue.size()>0)
540 int max2 = mUnloadQueue.top()->GetPriority();
541 if (max2>max) max=max2;
545 //=====================================================================
548 //=====================================================================
549 //=====================================================================
550 //=====================================================================
551 //=====================================================================
553 //=====================================================================
554 void* ThreadedImageReader::Entry()
556 // std::cout << "### Thread "<<GetCurrentId()<<"::Entry()"
559 mMultiThreadImageReader->MultiThreadImageReaderSendEvent
561 MultiThreadImageReaderUser::ThreadedReaderStarted,
564 // While was not deleted
565 while (!TestDestroy())
567 //std::cout << "### Thread "<<GetCurrentId()<<" still alive" << std::endl;
570 mMultiThreadImageReader->MultiThreadImageReaderEventLock();
573 if (mMultiThreadImageReader->mQueue.size()>0)
575 MultiThreadImageReader::ImageToLoadPtr i =
576 mMultiThreadImageReader->mQueue.remove_top();
578 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock();
582 // std::cout << "### Thread "<<GetCurrentId()<<" : reading '"
583 // << i->GetFilename() << "'" << std::endl;
586 vtkImageData* im = Read(i->GetFilename());
588 // Store it in the map
589 mMultiThreadImageReader->MultiThreadImageReaderEventLock();
591 MultiThreadImageReader::ImageToLoad itl(0,i->GetFilename());
592 MultiThreadImageReader::ImageMapType::iterator it =
593 mMultiThreadImageReader->mImages.find(&itl);
594 MultiThreadImageReader::ImageToLoadPtr
595 pitl = const_cast<MultiThreadImageReader::ImageToLoadPtr>
598 mMultiThreadImageReader->SignalImageRead(pitl,true);//i->GetFilename());
599 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock(); //mMutex.Unlock();
601 // std::cout << "### Thread "<<GetCurrentId()<<" : reading '"
602 // << i->GetFilename() << "' : DONE" << std::endl;
607 mMultiThreadImageReader->MultiThreadImageReaderEventUnlock();
609 // Wait a little to avoid blocking
613 // std::cout << "### Thread "<<GetCurrentId()<<" stopping"
618 //=====================================================================
620 //=====================================================================
621 void ThreadedImageReader::OnExit()
623 mMultiThreadImageReader->MultiThreadImageReaderSendEvent
625 MultiThreadImageReaderUser::ThreadedReaderStopped,
628 //=====================================================================
630 //=====================================================================
631 vtkImageData* ThreadedImageReader::Read(const std::string& filename)
633 return mReader.ReadImage(filename);
635 //=====================================================================
637 } // namespace creaImageIO