/*
 * Copyright (C) 2008, British Broadcasting Corporation
 * All Rights Reserved.
 *
 * Author: Philip de Nier
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the British Broadcasting Corporation nor the names
 *       of its contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef MXFPP_GENERICSOUNDESSENCEDESCRIPTOR_BASE_H_
#define MXFPP_GENERICSOUNDESSENCEDESCRIPTOR_BASE_H_



#include <libMXF++/metadata/FileDescriptor.h>


namespace mxfpp
{


class GenericSoundEssenceDescriptorBase : public FileDescriptor
{
public:
    friend class MetadataSetFactory<GenericSoundEssenceDescriptorBase>;
    static const mxfKey setKey;

public:
    GenericSoundEssenceDescriptorBase(HeaderMetadata *headerMetadata);
    virtual ~GenericSoundEssenceDescriptorBase();


   // getters

   bool haveAudioSamplingRate() const;
   mxfRational getAudioSamplingRate() const;
   bool haveLocked() const;
   bool getLocked() const;
   bool haveAudioRefLevel() const;
   int8_t getAudioRefLevel() const;
   bool haveElectroSpatialFormulation() const;
   uint8_t getElectroSpatialFormulation() const;
   bool haveChannelCount() const;
   uint32_t getChannelCount() const;
   bool haveQuantizationBits() const;
   uint32_t getQuantizationBits() const;
   bool haveDialNorm() const;
   int8_t getDialNorm() const;
   bool haveSoundEssenceCompression() const;
   mxfUL getSoundEssenceCompression() const;


   // setters

   void setAudioSamplingRate(mxfRational value);
   void setLocked(bool value);
   void setAudioRefLevel(int8_t value);
   void setElectroSpatialFormulation(uint8_t value);
   void setChannelCount(uint32_t value);
   void setQuantizationBits(uint32_t value);
   void setDialNorm(int8_t value);
   void setSoundEssenceCompression(mxfUL value);


protected:
    GenericSoundEssenceDescriptorBase(HeaderMetadata *headerMetadata, ::MXFMetadataSet *cMetadataSet);
};


};


#endif
