Merge branch 'master' of git@github.com:xbmc/xbmc
[vuplus_xbmc] / xbmc / BackgroundInfoLoader.h
1 #pragma once
2
3 /*
4  *      Copyright (C) 2005-2008 Team XBMC
5  *      http://www.xbmc.org
6  *
7  *  This Program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2, or (at your option)
10  *  any later version.
11  *
12  *  This Program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with XBMC; see the file COPYING.  If not, write to
19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20  *  http://www.gnu.org/copyleft/gpl.html
21  *
22  */
23
24 #include "threads/Thread.h"
25 #include "IProgressCallback.h"
26 #include "threads/CriticalSection.h"
27
28 #include <vector>
29 #include "boost/shared_ptr.hpp"
30
31 class CFileItem; typedef boost::shared_ptr<CFileItem> CFileItemPtr;
32 class CFileItemList;
33
34 class IBackgroundLoaderObserver
35 {
36 public:
37   virtual ~IBackgroundLoaderObserver() {}
38   virtual void OnItemLoaded(CFileItem* pItem) = 0;
39 };
40
41 class CBackgroundInfoLoader : public IRunnable
42 {
43 public:
44   CBackgroundInfoLoader(int nThreads=-1);
45   virtual ~CBackgroundInfoLoader();
46
47   void Load(CFileItemList& items);
48   bool IsLoading();
49   virtual void Run();
50   void SetObserver(IBackgroundLoaderObserver* pObserver);
51   void SetProgressCallback(IProgressCallback* pCallback);
52   virtual bool LoadItem(CFileItem* pItem) { return false; };
53
54   void StopThread(); // will actually stop all worker threads.
55   void StopAsync();  // will ask loader to stop as soon as possible, but not block
56
57   void SetNumOfWorkers(int nThreads); // -1 means auto compute num of required threads
58
59 protected:
60   virtual void OnLoaderStart() {};
61   virtual void OnLoaderFinish() {};
62
63   CFileItemList *m_pVecItems;
64   std::vector<CFileItemPtr> m_vecItems; // FileItemList would delete the items and we only want to keep a reference.
65   CCriticalSection m_lock;
66
67   bool m_bStartCalled;
68   volatile bool m_bStop;
69   int  m_nRequestedThreads;
70   int  m_nActiveThreads;
71
72   IBackgroundLoaderObserver* m_pObserver;
73   IProgressCallback* m_pProgressCallback;
74
75   std::vector<CThread *> m_workers;
76 };
77