Merge pull request #4775 from jmarshallnz/empty_episode_playcount
[vuplus_xbmc] / xbmc / BackgroundInfoLoader.h
1 #pragma once
2
3 /*
4  *      Copyright (C) 2005-2013 Team XBMC
5  *      http://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, see
19  *  <http://www.gnu.org/licenses/>.
20  *
21  */
22
23 #include "threads/Thread.h"
24 #include "IProgressCallback.h"
25 #include "threads/CriticalSection.h"
26
27 #include <vector>
28 #include "boost/shared_ptr.hpp"
29
30 class CFileItem; typedef boost::shared_ptr<CFileItem> CFileItemPtr;
31 class CFileItemList;
32
33 class IBackgroundLoaderObserver
34 {
35 public:
36   virtual ~IBackgroundLoaderObserver() {}
37   virtual void OnItemLoaded(CFileItem* pItem) = 0;
38 };
39
40 class CBackgroundInfoLoader : public IRunnable
41 {
42 public:
43   CBackgroundInfoLoader();
44   virtual ~CBackgroundInfoLoader();
45
46   void Load(CFileItemList& items);
47   bool IsLoading();
48   virtual void Run();
49   void SetObserver(IBackgroundLoaderObserver* pObserver);
50   void SetProgressCallback(IProgressCallback* pCallback);
51   virtual bool LoadItem(CFileItem* pItem) { return false; };
52   virtual bool LoadItemCached(CFileItem* pItem) { return false; };
53   virtual bool LoadItemLookup(CFileItem* pItem) { return false; };
54
55   void StopThread(); // will actually stop the loader thread.
56   void StopAsync();  // will ask loader to stop as soon as possible, but not block
57
58 protected:
59   virtual void OnLoaderStart() {};
60   virtual void OnLoaderFinish() {};
61
62   CFileItemList *m_pVecItems;
63   std::vector<CFileItemPtr> m_vecItems; // FileItemList would delete the items and we only want to keep a reference.
64   CCriticalSection m_lock;
65
66   volatile bool m_bIsLoading;
67   volatile bool m_bStop;
68   CThread *m_thread;
69
70   IBackgroundLoaderObserver* m_pObserver;
71   IProgressCallback* m_pProgressCallback;
72 };
73