DAFFReader.h

Go to the documentation of this file.

/*
 * -------------------------------------------------------------------------------------
 *
 *  OpenDAFF - A free, open source software package for directional audio data
 *  Copyright 2016 Institute of Technical Acoustics, RWTH Aachen University
 *  OpenDAFF is distributed under the Apache License Version 2.0.
 *
 *  ------------------------------------------------------------------------------------
 *
 */
#ifndef IW_DAFF_READER
#define IW_DAFF_READER

#include <DAFFDefs.h>
#include <string>

// Forward declarations
class DAFFContent;
class DAFFMetadata;
class DAFFProperties;


class DAFF_API DAFFReader
{
public:

    static DAFFReader* create();

    inline virtual ~DAFFReader() {};


    // --= File handling =--

    virtual bool isFileOpened() const = 0;


    virtual int openFile( const std::string& sFilePath ) = 0;


    virtual void closeFile() = 0;

    virtual std::string getFilename() const = 0;


    // --= Serialization methods =--

    virtual int deserialize( char* pDAFFDataBuffer ) = 0;

    virtual bool isValid() const=0;


    // --= Properties =--

    virtual int getFileFormatVersion() const = 0;

    virtual int getContentType() const = 0;

    virtual DAFFContent* getContent() const = 0;

    virtual const DAFFMetadata* getMetadata() const = 0;

    virtual DAFFProperties* getProperties() const = 0;


    // --= Utility & helper methods =--

    virtual std::string toString() const = 0;
};

#endif // IW_DAFF_READER