IProperty.h

/*******************************************************************************
 * Copyright (c) 2024, 2026, Olivier Ayache.  All rights reserved.
 *
 * This file is part of AVPKit.
 *
 * AVPKit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AVPKit 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with AVPKit.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
 
#ifndef IPROPERTY_H_
#define IPROPERTY_H_
 
#include <com/avpkit/core/AVPKit.h>
#include <com/avpkit/ferry/RefCounted.h>
#include <com/avpkit/core/IMetaData.h>
namespace com { namespace avpkit { namespace core {
  class VS_API_AVPKIT IProperty : public com::avpkit::ferry::RefCounted
  {
  public:
    typedef enum {
        PROPERTY_FLAGS,
        PROPERTY_INT,
        PROPERTY_INT64,
        PROPERTY_DOUBLE,
        PROPERTY_FLOAT,
        PROPERTY_STRING,
        PROPERTY_RATIONAL,
        PROPERTY_BINARY,  
        PROPERTY_DICT,
        PROPERTY_UINT64,
        PROPERTY_CONST,
        PROPERTY_IMAGE_SIZE, 
        PROPERTY_PIXEL_FMT,
        PROPERTY_SAMPLE_FMT,
        PROPERTY_VIDEO_RATE, 
        PROPERTY_DURATION,
        PROPERTY_COLOR,
        PROPERTY_CHANNEL_LAYOUT,
        PROPERTY_BOOL,
        PROPERTY_UNKNOWN=-1,
    } Type;
 
    typedef enum {
      FLAG_ENCODING_PARAM=1,
      FLAG_DECODING_PARAM=2,
      FLAG_METADATA=4,
      FLAG_AUDIO_PARAM=8,
      FLAG_VIDEO_PARAM=16,
      FLAG_SUBTITLE_PARAM=32,
      FLAG_EXPORT=64,
      FLAG_READONLY=128,
      FLAG_FILTERING_PARAM=(1<<16)
    } Flags;
    
    typedef enum {
        PROPERTY_SEARCH_DEFAULT=0x0000,
        PROPERTY_SEARCH_CHILDREN=0x0001,
    } Search;
 
    virtual const char *getName()=0;
    
    virtual const char *getHelp()=0;
    
    virtual const char *getUnit()=0;
    
    virtual Type getType()=0;
    
    virtual int32_t getFlags()=0;
 
    virtual int64_t getDefault()=0;
    
    virtual double getDefaultAsDouble()=0;
    
    virtual int32_t getNumFlagSettings()=0;
    
    virtual IProperty *getFlagConstant(int32_t position)=0;
 
    virtual IProperty *getFlagConstant(const char *name)=0;
 
  protected:
    IProperty();
    virtual ~IProperty();
    
  };
 
}}}
#endif /* IPROPERTY_H_ */