ifilespec.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2025 Global Graphics Software Ltd. All rights reserved.
 */

 
#ifndef IFILESPEC_H
#define IFILESPEC_H
 
#include <edl/edltypes.h>
#include <edl/edlstring.h>
#include <edl/iedlobject.h>
#include <edl/edlstream.h>
#include <edl/edlvector.h>
 
_BEGIN_EDL_NAMESPACE

class IFileSpec : public IEDLObject
{
  public:

    typedef enum
    {
        eFileSpecExternal,    
        eFileSpecEmbedded,    
        eFileSpecUrl          
    } eFileSpecType;

    virtual eFileSpecType getFileSpecType() const = 0;
};
 
 
DECL_SMART_PTR(IFileSpec);
#define edlobj2IFileSpec(src) edl_cast((IFileSpec *)NULL, src)
typedef CEDLVector<IFileSpecPtr> CFileSpecVect;

class IFileSpecAsEmbeddedData : public IFileSpec
{
#define IFileSpecAsEmbeddedDataClassID 0x363ca3a4, 0xa2b548e1, 0xb4246b67, 0xf7a5b7dc
  public:

    typedef enum
    {
        eAFRNone,               
        eAFRSource,             
        eAFRData,               
        eAFRAlternative,        
        eAFRSupplement,         
        eAFREncryptedPayload,   
                                //   user if the PDF processor has the cryptographic filter needed to decrypt the document.
        eAFRFormData,           
        eAFRSchema,             
                                //   schema associated with a metadata stream).
        eAFRUnspecified         
    } eAFRelationship;

    class Data : public CClassParams
    {
      public:
        Data() : fileSize(0), afRelationship(eAFRNone) {}
        EDLSysString      fileName;
        EDLSysString      description;
        EDLSysString      mimeType;
        EDLSysString      checksum;
        EDLSysString      creationDate;
        EDLSysString      modificationDate;
        uint64            fileSize;
        IRAInputStreamPtr fileDataStream;
        eAFRelationship   afRelationship;
    };

    static const CClassID &classID()
    {
        static CClassID id(IFileSpecAsEmbeddedDataClassID);
        return id;
    };

    virtual bool getFileName(EDLSysString &fileName) const = 0;

    virtual bool setFileName(const EDLSysString &fileName) = 0;

    virtual bool getDescription(EDLSysString &description) const = 0;

    virtual bool setDescription(const EDLSysString &description) = 0;

    virtual bool getMimeType(EDLSysString &mimeType) const = 0;

    virtual bool setMimeType(const EDLSysString &mimeType) = 0;

    virtual bool getCreationDate(EDLSysString &date) const = 0;

    virtual bool setCreationDate(const EDLSysString &date) = 0;

    virtual bool getModificationDate(EDLSysString &date) const = 0;

    virtual bool setModificationDate(const EDLSysString &date) = 0;

    virtual uint64 getFileSize() const = 0;

    virtual bool setFileSize(uint64 fileSize) = 0;

    virtual bool getChecksum(EDLSysString &checksum) const = 0;

    virtual bool setChecksum(const EDLSysString &checksum) = 0;

    virtual bool getFileDataStream(IRAInputStreamPtr &stream) const = 0;

    virtual bool setFileDataStream(const IRAInputStreamPtr &stream) = 0;

    virtual eAFRelationship getAFRelationship() = 0;

    virtual void setAFRelationship(eAFRelationship afRelationship) = 0;
 
};
 
DECL_SMART_PTR(IFileSpecAsEmbeddedData);
#define edlobj2IFileSpecAsEmbeddedData(src) edl_cast((IFileSpecAsEmbeddedData *)NULL, src)
 
typedef CEDLVector<IFileSpecAsEmbeddedDataPtr> CFileSpecAsEmbeddedDataVect;
 
class IFileSpecAsFileReference : public IFileSpec
{
#define IFileSpecAsFileReferenceClassID 0xa5f832aa, 0x385544ad, 0xae875b19, 0x23204e25
  public:
 
    class Data : public CClassParams
    {
      public:
        EDLSysString strFileSpec;
    };

    static const CClassID &classID()
    {
        static CClassID id(IFileSpecAsFileReferenceClassID);
        return id;
    };

    virtual bool getFileSpec (EDLSysString &strFileSpec) const = 0;

    virtual bool setFileSpec (const EDLSysString &strFileSpec) = 0;
 
 

    static EDL_API bool resolveToURI(EDLSysString &strUri, const EDLSysString &strFileSpec, bool &resolved, const EDLString &strDocumentDir, bool allowNetworkLookup = false);

    static EDL_API bool convertURIToFileSpecString(EDLSysString &strFileSpec, const EDLSysString &strUri);
 
};
DECL_SMART_PTR(IFileSpecAsFileReference);
#define edlobj2IFileSpecAsFileReference(src) edl_cast((IFileSpecAsFileReference *)NULL, src)
 
 
class IFileSpecAsUrl : public IFileSpec
{
#define IFileSpecAsUrlClassID 0x00f5e473, 0x571c4A5B, 0xae78305a, 0xdB714e41
  public:
 
    class Data : public CClassParams
    {
      public:
        EDLSysString url;
    };

    static const CClassID &classID()
    {
        static CClassID id(IFileSpecAsUrlClassID);
        return id;
    };

    virtual EDLSysString getUrl() const = 0;

    virtual void setUrl(const EDLSysString &url) = 0;
};
DECL_SMART_PTR(IFileSpecAsUrl);
#define edlobj2IFileSpecAsUrl(src) edl_cast((IFileSpecAsUrl *)NULL, src)
 
_END_EDL_NAMESPACE
 
#endif // IFILESPEC_H