lib/libUPnP/Platinum/Source/Extras/PltMetadataHandler.h

   1 /*****************************************************************
   2 |
   3 |   Platinum - Metadata Handler
   4 |
   5 | Copyright (c) 2004-2010, Plutinosoft, LLC.
   6 | All rights reserved.
   7 | http://www.plutinosoft.com
   8 |
   9 | This program is free software; you can redistribute it and/or
  10 | modify it under the terms of the GNU General Public License
  11 | as published by the Free Software Foundation; either version 2
  12 | of the License, or (at your option) any later version.
  13 |
  14 | OEMs, ISVs, VARs and other distributors that combine and
  15 | distribute commercially licensed software with Platinum software
  16 | and do not wish to distribute the source code for the commercially
  17 | licensed software under version 2, or (at your option) any later
  18 | version, of the GNU General Public License (the "GPL") must enter
  19 | into a commercial license agreement with Plutinosoft, LLC.
  20 | licensing@plutinosoft.com
  21 |
  22 | This program is distributed in the hope that it will be useful,
  23 | but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 | GNU General Public License for more details.
  26 |
  27 | You should have received a copy of the GNU General Public License
  28 | along with this program; see the file LICENSE.txt. If not, write to
  29 | the Free Software Foundation, Inc.,
  30 | 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  31 | http://www.gnu.org/licenses/gpl-2.0.html
  32 |
  33 ****************************************************************/
  34
  35 #ifndef _PLT_METADATA_HANDLER_H_
  36 #define _PLT_METADATA_HANDLER_H_
  37
  38 /*----------------------------------------------------------------------
  39 |   includes
  40 +---------------------------------------------------------------------*/
  41 #include "Neptune.h"
  42
  43 /*----------------------------------------------------------------------
  44 |   PLT_MetadataHandler class
  45 +---------------------------------------------------------------------*/
  46 class PLT_MetadataHandler
  47 {
  48 public:
  49     virtual ~PLT_MetadataHandler() {}
  50
  51     // metadata overridables
  52     virtual bool HandleExtension(const char* extension) = 0;
  53     virtual NPT_Result  Load(NPT_InputStream&  stream,
  54                              NPT_TimeInterval  sleeptime = NPT_TimeInterval(.01),
  55                              NPT_TimeInterval  timeout = NPT_TimeInterval(30.)) = 0;
  56     virtual NPT_Result  Save(NPT_OutputStream& stream,
  57                              NPT_TimeInterval  sleeptime = NPT_TimeInterval(.01),
  58                              NPT_TimeInterval  timeout = NPT_TimeInterval(30.)) = 0;
  59
  60     virtual const char* GetLicenseData(NPT_String& licenseData) = 0;
  61     virtual NPT_Result  GetCoverArtData(char*& caData, int& len) = 0;
  62     virtual const char* GetContentID(NPT_String& value) = 0;
  63     virtual const char* GetTitle(NPT_String& value) = 0;
  64     virtual const char* GetDescription(NPT_String& value) = 0;
  65     virtual NPT_Result  GetDuration(NPT_UInt32& seconds) = 0;
  66     virtual const char* GetProtection(NPT_String& protection) = 0;
  67     virtual NPT_Result  GetYear(NPT_Size& year) = 0;
  68
  69     // helper functions
  70     virtual NPT_Result  Load(const char* filename);
  71     virtual NPT_Result  Save(const char* filename);
  72 };
  73
  74 /*----------------------------------------------------------------------
  75 |   PLT_MetadataHandlerFinder
  76 +---------------------------------------------------------------------*/
  77 class PLT_MetadataHandlerFinder
  78 {
  79 public:
  80     // methods
  81     PLT_MetadataHandlerFinder(const char* extension) : m_Extension(extension) {}
  82     bool operator()(PLT_MetadataHandler* const & handler) const {
  83         return handler->HandleExtension(m_Extension) ? true : false;
  84     }
  85
  86 private:
  87     // members
  88     NPT_String m_Extension;
  89 };
  90
  91 #endif /* _PLT_METADATA_HANDLER_H_ */