media.hpp

Go to the documentation of this file.

/*
  MEDIA.hpp  -  key abstraction: media-like assets

  Copyright (C)         Lumiera.org
    2008,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef ASSET_MEDIA_H
#define ASSET_MEDIA_H

#include "steam/asset.hpp"
#include "lib/time/timevalue.hpp"
#include "steam/mobject/mobject.hpp"
#include "steam/mobject/session/clip.hpp"
#include "lib/nocopy.hpp"




namespace steam {
namespace asset {
  
  class Clip;
  class Media;
  class MediaFactory;
  class ProcPatt;
  
  using lib::time::Duration;
  
  
  template<>
  class ID<Media> : public ID<Asset>
    {
    public:
      ID (HashVal id);
      ID (const Media&);
    };

    
    
  class Media : public Asset
    {
      string filename_;
      const Duration len_;
      
    public:
      using PMedia = lib::P<Media>;
      using PClipAsset  = lib::P<steam::asset::Clip>;
      using PProcPatt = lib::P<steam::asset::ProcPatt>;
      using PClip = mobject::Placement<mobject::session::Clip>;
     
      
      static MediaFactory create;
      const string& getFilename ()  const { return filename_; }
      
      virtual const ID<Media>& getID()  const    
        { 
          return static_cast<const ID<Media>& > (Asset::getID()); 
        }
      
      PProcPatt howtoProc ()  const;
      
      PClip createClip ();
      
      virtual Duration getLength ()  const;
      
      
    protected:
      Media (const Asset::Ident& idi, const string& file, Duration length) 
        : Asset(idi), filename_(file), len_(length) {}
      friend class MediaFactory;
      
      virtual PClipAsset getClipAsset ();
      
      virtual PMedia checkCompound ()  const;
      friend class steam::asset::Clip;    

    };
    
    
    // definition of ID<Media> ctors is possible now,
   //  after providing full definition of class Media

  inline ID<Media>::ID(HashVal id)         : ID<Asset> (id)            {};
  inline ID<Media>::ID(const Media& media) : ID<Asset> (media.getID()) {};
  
  
  
  
  class MediaFactory 
    : util::NonCopyable
    {
    public:
      typedef lib::P<Media> PType;
      
      PType operator() (Asset::Ident& key, const string& file="");
      PType operator() (const string& file, const Category& cat);
      PType operator() (const string& file, asset::Kind);
      
      PType operator() (Asset::Ident& key, const char* file);  
      PType operator() (const char* file, const Category& cat);
      PType operator() (const char* file, asset::Kind);
      
      lib::P<Clip>
      operator() (Media& mediaref);

    };

  LUMIERA_ERROR_DECLARE (PART_OF_COMPOUND);
    
    
    
    
}} // namespace steam::asset
#endif