IMediaUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: wtislar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IMediaUtils_h__
#define __IMediaUtils_h__

#include "IPMUnknown.h"
#include "IMediaAdornmentInfo.h"
#include "IMediaAttributes.h"
#include "IURIData.h"

#include "MediaID.h"
#include "UIDList.h"
#include "Utils.h"

class PMRect;
class ILinkResource;
class ILinkManager;
class IHierarchy;
class IMediaReadFormat;
class MediaLocation;

class IMediaUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMEDIAUTILS };
 
 virtual ErrorCode AddAdornments( IDataBase * db, UID itemUID, IMediaAdornmentInfo *info ) = 0;

 virtual ErrorCode AddMediaPIToGraphicFrame( IDataBase * db, UID mediaUID, UID frameUID, bool16 alignComponents = kFalse ) = 0;

 virtual ErrorCode AlignMediaComponents( UIDRef mediaRef ) = 0;

 virtual bool16 CanConvertToMediaFrame( UIDRef candidateRef ) = 0;

 virtual ErrorCode ChangeMediaLocation( UIDRef mediaRef, const MediaLocation & newLocation = MediaLocation(), IMediaReadFormat * readFormat = nil, bool16 customPosterFromMedia = kFalse, bool16 preservePoster = kFalse ) = 0;

 virtual ErrorCode ChangePoster( UIDRef mediaRef,
 IMediaAttributes::PosterType newPosterType,
 const IDFile * posterImageFile = nil,
 IPMStream * posterFromMediaStream = nil,
 bool16 customPosterFromMedia = kFalse,
 int32 posterTime = 0,
 bool setUndoable=false) = 0;

 virtual ErrorCode ChangePoster( UIDRef mediaRef, IMediaAttributes::PosterType newPosterType, IPMStream * imageStream ) = 0;


 virtual ErrorCode CreateMediaPageItem( ClassID classID, IDataBase * db, UID frameUID, UID & outMediaUID ) = 0;

 virtual ErrorCode CreateMediaPageItem( ClassID classID, IDataBase * db, UID frameUID, PMRect bounds, UID & outMediaUID ) = 0;

 virtual ErrorCode CreateMediaWithDefaultPoster(ClassID mediaClassID, IDataBase * db, UID & outMediaUID, const ClassID formatClassID = kInvalidClass, IPMStream * mediaImportStream = nil, IURIData* uriData=nil) = 0;

 virtual IPMStream * CreatePosterLoResReadStream( UIDRef mediaRef ) = 0;

 virtual PMString ExtractMediaName( const MediaLocation & loc ) = 0;

 virtual UID FindMediaUID( UIDRef & rootUIDRef ) = 0;

 virtual UIDRef GetMediaContentRef( const UIDRef & mediaRef ) = 0;

 virtual UID GetMediaParentUID( IDataBase * db, UID mediaUID ) = 0;

 virtual UID GetParentGraphicFrameUID( const UIDRef & mediaRef ) = 0;

 virtual bool16 HasAdornments( UID itemUID, IDataBase * db, IMediaAdornmentInfo *info ) = 0;

 virtual void InvalidateMediaFrameCaches( IDataBase * db, UID mediaUID ) = 0;

 virtual bool16 IsMediaItem( ClassID classID, UID itemUID, IDataBase * db ) = 0;
 
 virtual bool16 GetExportableMediaFile( UIDRef mediaRef, IDFile & outFile /*, todo: specify export format*/ ) = 0;

 virtual bool16 GetExportableMediaURL(UIDRef const &mediaRef, PMString &url) const = 0;
 
 enum MediaFormatType {
 kAudio = 0,
 kVideo,
 kUnknown
 };

 virtual bool GetInstalledVideoSkins(K2Vector<IDFile> &skins) const = 0;
 
 virtual bool ResolveSkinNameToFile(PMString const &skin, IDFile &file) const = 0;

 virtual bool IsLegacyMediaItem(UIDRef mediaRef) const = 0;

 virtual IMediaReadFormat* FindMediaReadFormatForClassID( ClassID readFormatClassID ) = 0;

 virtual IMediaReadFormat* FindMediaReadFormatForLocation( const MediaLocation & loc ) = 0;
 
 virtual IMediaReadFormat* FindMediaReadFormatForStream( MediaType mediaType, IPMStream* iPMStream ) = 0;
 
 virtual ErrorCode CanAccess( const MediaLocation & loc, const MediaType mediaType ) = 0;
 
 virtual ErrorCode SchedulePlaceMediaFromURL( UIDRef mediaRef, const MediaLocation & loc, bool preserveExistingPoster = false, bool allowDecoding = true ) = 0;
 
 virtual ErrorCode SchedulePosterFromMedia( UIDRef mediaRef ) = 0;

 virtual bool IsFlashOnlyMedia(ILinkResource* iResource) = 0;

 virtual void GoToAPERemovalURL() = 0;

 virtual ErrorCode ChangeFlashFormatExtension(UID resourceUID, ILinkManager* iLinkMgr) = 0;

 virtual bool HasUnsupportedExtension(ILinkResource * iResource) = 0;

};

#endif // __IMediaUtils_h__