com::avpkit::core::Property Class Reference

A wrapper for an FFMPEG AVOption value. More...

#include <Property.h>

Inheritance diagram for com::avpkit::core::Property:

Collaboration diagram for com::avpkit::core::Property:

Public Member Functions
virtual const char *	getName ()
	IProperty implementation.
virtual const char *	getHelp ()
	Get the (English) help string for this property. More...
virtual const char *	getUnit ()
	Get any sub-unit this option or constant belongs to. More...
virtual Type	getType ()
	Get the underlying native type of this property. More...
virtual int64_t	getDefault ()
	Get the default setting this flag would have it not set. More...
virtual double	getDefaultAsDouble ()
	Get the default setting this flag would have it not set. More...
virtual int32_t	getFlags ()
	Get any set flags (a bitmask) for this option. More...
virtual int32_t	getNumFlagSettings ()
	If this IProperty is of the type Type#PROPERTY_FLAGS, this method will tell you how many different flag settings it takes. More...
virtual IProperty *	getFlagConstant (int32_t position)
	If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag. More...
virtual IProperty *	getFlagConstant (const char *name)
	If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag. More...
Public Member Functions inherited from com::avpkit::ferry::RefCounted
virtual int32_t	acquire ()
	Internal Only. More...
virtual int32_t	release ()
	Internal Only. More...
virtual RefCounted *	copyReference ()
	Create a new Java object that refers to the same native object. More...
virtual int32_t	getCurrentRefCount ()
	Return the current reference count on this object. More...
void	setJavaAllocator (void *allocator)
	This method is public but not part of the standard API. More...
void *	getJavaAllocator ()
	This method is public but not part of the standard API. More...

Static Public Member Functions
static Property *	make (const AVOption *start, const AVOption *option)
static int32_t	getNumProperties (void *context)
	For internal use. More...
static IProperty *	getPropertyMetaData (void *context, int32_t propertyNo)
	Returns the metadata for the numbered property. More...
static IProperty *	getPropertyMetaData (void *context, const char *name)
	Returns the metadata for the named property. More...
static int32_t	setProperty (void *context, const char *name, const char *value)
	Looks up the property 'name' in 'context' and sets the value of the property to 'value'. More...
static int32_t	setProperty (void *context, const char *name, double value)
	Looks up the property 'name' in 'context' and sets the value of the property to 'value'. More...
static int32_t	setProperty (void *context, const char *name, int64_t value)
	Looks up the property 'name' in 'context' and sets the value of the property to 'value'. More...
static int32_t	setProperty (void *context, const char *name, bool value)
	Looks up the property 'name' in 'context' and sets the value of the property to 'value'. More...
static int32_t	setProperty (void *context, const char *name, IRational *value)
	Looks up the property 'name' in 'context' and sets the value of the property to 'value'. More...
static char *	getPropertyAsString (void *context, const char *name)
	Gets the value of this property, and returns as a new[]ed string. More...
static double	getPropertyAsDouble (void *context, const char *name)
	Gets the value of this property, and returns as a double;. More...
static int64_t	getPropertyAsLong (void *context, const char *name)
	Gets the value of this property, and returns as an long;. More...
static IRational *	getPropertyAsRational (void *context, const char *name)
	Gets the value of this property, and returns as an IRational;. More...
static bool	getPropertyAsBoolean (void *context, const char *name)
	Gets the value of this property, and returns as a boolean. More...
static int32_t	setProperty (void *context, IMetaData *valuesToSet, IMetaData *valuesNotFound)
	Sets all properties in valuesToSet on object context. More...

Additional Inherited Members
Public Types inherited from com::avpkit::core::IProperty
enum	Type {   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 }
	The different type of options that are supported by AVPKit. More...
enum	Flags {   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) }
enum	Search { PROPERTY_SEARCH_DEFAULT =0x0000 , PROPERTY_SEARCH_CHILDREN =0x0001 }
	How to search options when looking for different values. More...
Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.
Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.
void *	mAllocator
	Not part of public API.

Detailed Description

A wrapper for an FFMPEG AVOption value.

Definition at line 35 of file Property.h.

Member Function Documentation

getDefault()

int64_t com::avpkit::core::Property::getDefault ( )

virtual

Get the default setting this flag would have it not set.

Returns

the default

Implements com::avpkit::core::IProperty.

Definition at line 96 of file Property.cpp.

  {
    return (int64_t)getDefaultAsDouble();
  }

References getDefaultAsDouble().

getDefaultAsDouble()

double com::avpkit::core::Property::getDefaultAsDouble ( )

virtual

Get the default setting this flag would have it not set.

Returns

the default

Implements com::avpkit::core::IProperty.

Definition at line 102 of file Property.cpp.

  {
    return mOption ? mOption->default_val.dbl: 0.0;
  }

Referenced by getDefault().

getFlagConstant() [1/2]

IProperty * com::avpkit::core::Property::getFlagConstant ( const char *  name )

virtual

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag.

Parameters

name	The name of the constant.

Returns

An IProperty object for the flag setting, or null if not available.

Implements com::avpkit::core::IProperty.

Definition at line 383 of file Property.cpp.

  {
    IProperty *retval = 0;
    try
    {
      if (getType() != IProperty::PROPERTY_FLAGS)
        throw std::runtime_error("flag is not of type PROPERTY_FLAGS");
      
      // now, iterate through all options, counting all CONSTS that belong
      // to the same unit as this option
      const char* unit = getUnit();
      if (!unit || !*unit)
        throw std::runtime_error("flag doesn't have a unit setting, so can't tell what constants");
 
      AVClass fakeClass;
      fakeClass.class_name="AVPKitFakeClass";
      fakeClass.item_name = fakeContextToName;
      fakeClass.option = mOptionStart;
      
      const AVOption* last = 0;
      last = av_opt_find(&fakeClass, aName, unit, 0, 0);
      if (last)
      {
        if (last->type == AV_OPT_TYPE_CONST)
        {
          retval = Property::make(av_opt_next(&fakeClass, 0), last);
        }
      }
 
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

References getType(), and getUnit().

getFlagConstant() [2/2]

IProperty * com::avpkit::core::Property::getFlagConstant ( int32_t  position )

virtual

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will give you another IProperty representing a constant setting for that flag.

Parameters

position

The position number for the flag; Must be in range 0 <= position <= getNumFlagSettings().

Returns

An IProperty object for the flag setting, or null if not available.

Implements com::avpkit::core::IProperty.

Definition at line 332 of file Property.cpp.

  {
    IProperty *retval = 0;
    try
    {
      if (getType() != IProperty::PROPERTY_FLAGS)
        throw std::runtime_error("flag is not of type PROPERTY_FLAGS");
      
      // now, iterate through all options, counting all CONSTS that belong
      // to the same unit as this option
      const char* unit = getUnit();
      if (!unit || !*unit)
        throw std::runtime_error("flag doesn't have a unit setting, so can't tell what constants");
      
      // Create a fake class 
      AVClass fakeClass;
      fakeClass.class_name="AVPKitFakeClass";
      fakeClass.item_name = fakeContextToName;
      fakeClass.option = mOptionStart;
      AVClass *fakeClassPtr = &fakeClass;
      
      const AVOption* last = 0;
      int32_t constNo = -1;
      do
      {
        last = av_opt_next(&fakeClassPtr, last);
        if (last &&
            last->unit &&
            last->type == AV_OPT_TYPE_CONST &&
            strcmp(unit, last->unit)==0)
        {
          // count in the same was as getNumFlagSettings,
          // and then return if the position is equal
          ++constNo;
          if (constNo == position)
          {
            retval = Property::make(av_opt_next(&fakeClassPtr, 0), last);
          }
        }
      } while(last);
      
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

References getType(), and getUnit().

getFlags()

int32_t com::avpkit::core::Property::getFlags ( )

virtual

Get any set flags (a bitmask) for this option.

Returns

the flags

Implements com::avpkit::core::IProperty.

Definition at line 108 of file Property.cpp.

  {
    return mOption ? mOption->flags : 0;
  }

getHelp()

const char * com::avpkit::core::Property::getHelp ( )

virtual

Get the (English) help string for this property.

Returns

the help string

Implements com::avpkit::core::IProperty.

Definition at line 78 of file Property.cpp.

  {
    return mOption ? mOption->help : 0;
  }

getNumFlagSettings()

int32_t com::avpkit::core::Property::getNumFlagSettings ( )

virtual

If this IProperty is of the type Type#PROPERTY_FLAGS, this method will tell you how many different flag settings it takes.

Returns

Number of flag settings, or <0 if not a FLAGS value

Implements com::avpkit::core::IProperty.

Definition at line 292 of file Property.cpp.

  {
    int32_t retval = 0;
    try {
      if (getType() != IProperty::PROPERTY_FLAGS)
        throw std::runtime_error("flag is not of type PROPERTY_FLAGS");
      
      // now, iterate through all options, counting all CONSTS that belong
      // to the same unit as this option
      const char* unit = getUnit();
      if (!unit || !*unit)
        throw std::runtime_error("flag doesn't have a unit setting, so can't tell what constants");
      
      // Create a fake class 
      AVClass fakeClass;
      fakeClass.class_name="AVPKitFakeClass";
      fakeClass.item_name = fakeContextToName;
      fakeClass.option = mOptionStart;
      AVClass *fakeClassPtr = &fakeClass;
      
      const AVOption* last = 0;
      do
      {
        last = av_opt_next(&fakeClassPtr, last);
        if (last &&
            last->unit &&
            last->type == AV_OPT_TYPE_CONST &&
            strcmp(unit, last->unit)==0)
          ++retval;
      } while(last);
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = -1;
    }
    return retval;
  }

References getType(), and getUnit().

getNumProperties()

int32_t com::avpkit::core::Property::getNumProperties ( void *  context )

static

For internal use.

Returns the total number of settable properties on this object

Parameters

context

AVClass to search for options in

Returns

total number of options (not including constant definitions)

Definition at line 114 of file Property.cpp.

  {
    int32_t retval=0;
    const AVOption* last = 0;
    if (aContext)
    {
      do {
        last = av_opt_next(aContext, last);
        if (last)
        {
          if (last->type != AV_OPT_TYPE_CONST)
            ++retval;
        }
      } while (last);
    }
    return retval;
  }

getPropertyAsBoolean()

bool com::avpkit::core::Property::getPropertyAsBoolean ( void *  context, const char *  name  )

static

Gets the value of this property, and returns as a boolean.

Parameters

context	AVClass context to search for option in.
name	name of option

Returns

boolean value of property, or false on error.

Definition at line 491 of file Property.cpp.

  {
    return (bool) getPropertyAsLong(aContext, aName);
  }

References getPropertyAsLong().

getPropertyAsDouble()

double com::avpkit::core::Property::getPropertyAsDouble ( void *  context, const char *  name  )

static

Gets the value of this property, and returns as a double;.

Parameters

context	AVClass context to search for option in.
name	name of option

Returns

double value of property, or 0 on error.

Definition at line 422 of file Property.cpp.

  {
    double retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
      
      if (av_opt_get_double(aContext, aName, 0, &retval) < 0)
        throw std::runtime_error("error getting property as double");
 
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = 0;
    }
    return retval;
  }

getPropertyAsLong()

int64_t com::avpkit::core::Property::getPropertyAsLong ( void *  context, const char *  name  )

static

Gets the value of this property, and returns as an long;.

Parameters

context	AVClass context to search for option in.
name	name of option

Returns

long value of property, or 0 on error.

Definition at line 446 of file Property.cpp.

  {
    int64_t retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
      av_opt_get_int(aContext, aName, 0, &retval);
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = 0;
    }
    return retval;
  }

Referenced by getPropertyAsBoolean().

getPropertyAsRational()

IRational * com::avpkit::core::Property::getPropertyAsRational ( void *  context, const char *  name  )

static

Gets the value of this property, and returns as an IRational;.

Parameters

context	AVClass context to search for option in.
name	name of option

Returns

long value of property, or 0 on error.

Definition at line 467 of file Property.cpp.

  {
    IRational *retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
      AVRational value;
      av_opt_get_q(aContext, aName, 0, &value);
      retval = IRational::make(value.num, value.den);
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

References com::avpkit::core::IRational::make().

getPropertyAsString()

char * com::avpkit::core::Property::getPropertyAsString ( void *  context, const char *  name  )

static

Gets the value of this property, and returns as a new[]ed string.

Caller must call delete[] on string.

Parameters

context	AVClass context to search for option in.
name	name of option

Returns

string version of option value (caller must call delete[]) or null on error.

Definition at line 238 of file Property.cpp.

  {
    char* retval = 0;
    char *value = 0;
 
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
 
      // we don't allow a string value longer than this.  This is
      // actually safe because this buffer is only used for non-string options
      if (av_opt_get(aContext, aName, 0, (uint8_t**)&value) < 0)
          throw std::runtime_error("could not get property");
      
      if (value)
      {
        // let's make a copy of the data
        int32_t valLen = strlen(value);
        if (valLen > 0)
        {
          retval = (char*)malloc((valLen+1)*sizeof(char));
          if (!retval)
            throw std::bad_alloc();
          
          // copy the data
          strncpy(retval, value, valLen+1);
        }
      }
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      if (retval)
        free(retval);
      retval = 0;
    }
    if (value)
      av_free(value);
 
    // NOTE: Caller must call free() on returned value; we mean it!
    return retval;
 
  }

getPropertyMetaData() [1/2]

IProperty * com::avpkit::core::Property::getPropertyMetaData ( void *  context, const char *  name  )

static

Returns the metadata for the named property.

Parameters

context	AVClass to search for options in
name	The property number in the options list.

Returns

the meta data for this property, or null if not found

Definition at line 170 of file Property.cpp.

  {
    IProperty *retval = 0;
    const AVOption* last = 0;
 
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName || !*aName)
        throw std::runtime_error("no property name passed in");
      
      last = av_opt_find(aContext, aName, 0, 0, 0);
      if (last)
      {
        if (last->type != AV_OPT_TYPE_CONST)
        {
          retval = Property::make(av_opt_next(aContext, 0), last);
        }
      }
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }    
    return retval;
  }

getPropertyMetaData() [2/2]

IProperty * com::avpkit::core::Property::getPropertyMetaData ( void *  context, int32_t  propertyNo  )

static

Returns the metadata for the numbered property.

Note that a property number is guaranteed to stay constant during this run of AVPKit, but the property number may change if the process restarts.

Parameters

context	AVClass to search for options in
propertyNo	The property number in the options list.

Returns

the meta data for this property, or null if not found

Definition at line 133 of file Property.cpp.

  {
    IProperty *retval = 0;
    const AVOption* last = 0;
 
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
 
      int32_t optionNo=-1;
      do {
        last = av_opt_next(aContext, last);
        if (last)
        {
          if (last->type != AV_OPT_TYPE_CONST)
          {
            ++optionNo;
            // now see if this option position matches the property asked for
            if (optionNo == aPropertyNo)
            {
              retval = Property::make(av_opt_next(aContext, 0), last);
              break;
            }
          }
        }
      } while (last);
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }    
    return retval;
  }

getType()

IProperty::Type com::avpkit::core::Property::getType ( )

virtual

Get the underlying native type of this property.

Returns

the type

Implements com::avpkit::core::IProperty.

Definition at line 90 of file Property.cpp.

  {
    return mOption ? (IProperty::Type) mOption->type : IProperty::PROPERTY_UNKNOWN;
  }

Referenced by getFlagConstant(), and getNumFlagSettings().

getUnit()

const char * com::avpkit::core::Property::getUnit ( )

virtual

Get any sub-unit this option or constant belongs to.

Returns

the unit, or null if none.

Implements com::avpkit::core::IProperty.

Definition at line 84 of file Property.cpp.

  {
    return mOption ? mOption->unit : 0;
  }

Referenced by getFlagConstant(), and getNumFlagSettings().

setProperty() [1/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, const char *  name, bool  value  )

static

Looks up the property 'name' in 'context' and sets the value of the property to 'value'.

Parameters

context	AVClass to search for option in.
name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Definition at line 540 of file Property.cpp.

  {
    return setProperty(aContext, aName, (int64_t)value);
  }

References setProperty().

setProperty() [2/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, const char *  name, const char *  value  )

static

Looks up the property 'name' in 'context' and sets the value of the property to 'value'.

Parameters

context	AVClass to search for option in.
name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Definition at line 201 of file Property.cpp.

  {
    int32_t retval = -1;
 
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
 
      void * target=0;
      const AVOption *o = av_opt_find2(aContext, aName, 0, PROPERTY_SEARCH_CHILDREN, 1, &target);
      if (o) {
        AVClass *c = *(AVClass**)target;
        (void) c;
        VS_LOG_TRACE("Found option \"%s\" with help: %s; in unit: %s; object type: %s; instance name: %s",
          o->name,
          o->help,
          o->unit,
          c->class_name,
          c->item_name(aContext));
      }
      VS_LOG_TRACE("Setting %s to %s", aName, aValue);
      retval = av_opt_set(aContext, aName, aValue, PROPERTY_SEARCH_CHILDREN);
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = -1;
    }
 
    return retval;
  }

References com::avpkit::core::IProperty::PROPERTY_SEARCH_CHILDREN.

Referenced by setProperty().

setProperty() [3/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, const char *  name, double  value  )

static

Looks up the property 'name' in 'context' and sets the value of the property to 'value'.

Parameters

context	AVClass to search for option in.
name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Definition at line 497 of file Property.cpp.

  {
    int32_t retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
      retval = av_opt_set_double(aContext, aName, value, PROPERTY_SEARCH_CHILDREN);
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = -1;
    }
    return retval;
  }

References com::avpkit::core::IProperty::PROPERTY_SEARCH_CHILDREN.

setProperty() [4/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, const char *  name, int64_t  value  )

static

Looks up the property 'name' in 'context' and sets the value of the property to 'value'.

Parameters

context	AVClass to search for option in.
name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Definition at line 518 of file Property.cpp.

  {
    int32_t retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
   
      retval = av_opt_set_int(aContext, aName, value, PROPERTY_SEARCH_CHILDREN);
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = -1;
    }
    return retval;
  }

References com::avpkit::core::IProperty::PROPERTY_SEARCH_CHILDREN.

setProperty() [5/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, const char *  name, IRational *  value  )

static

Looks up the property 'name' in 'context' and sets the value of the property to 'value'.

Parameters

context	AVClass to search for option in.
name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Definition at line 546 of file Property.cpp.

  {
    int32_t retval = 0;
    try
    {
      if (!aContext)
        throw std::runtime_error("no context passed in");
      
      if (!aName  || !*aName)
        throw std::runtime_error("empty property name passed to setProperty");
      
      if (!value)
        throw std::runtime_error("no rational value passed in");
   
      AVRational rational;
      rational.num = value->getNumerator();
      rational.den = value->getDenominator();
      retval = av_opt_set_q(aContext, aName, rational, PROPERTY_SEARCH_CHILDREN);
    }
    catch (std::exception &e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      retval = -1;
    }
    return retval;
  }

References com::avpkit::core::IRational::getDenominator(), com::avpkit::core::IRational::getNumerator(), and com::avpkit::core::IProperty::PROPERTY_SEARCH_CHILDREN.

setProperty() [6/6]

int32_t com::avpkit::core::Property::setProperty ( void *  context, IMetaData *  valuesToSet, IMetaData *  valuesNotFound  )

static

Sets all properties in valuesToSet on object context.

Parameters

context	AVClass context to set options on
valuesToSet	The set of key-value pairs to try to set
valuesNotFound	If non null will contain all key-values pairs in valuesToSet that were not found in context.

Returns

0 on success; <0 on failure

Since

5.0

Definition at line 574 of file Property.cpp.

  {
    int32_t retval =-1;
    AVDictionary *tmp = 0;
    MetaData* valuesToSet = dynamic_cast<MetaData*>(aValuesToSet);
    MetaData* valuesNotFound = dynamic_cast<MetaData*>(aValuesNotFound);
    AVDictionary *orig = valuesToSet ? valuesToSet->getDictionary() : 0;
 
    try {
      if (!aContext)
        throw std::runtime_error("no context passed in");
 
      if (orig)
        av_dict_copy(&tmp, orig, 0);
 
      // try setting the values.
      retval = av_opt_set_dict(aContext, &tmp);
      if (retval < 0)
        throw std::runtime_error("failed to set options on context");
 
      if (valuesNotFound)
        retval = valuesNotFound->copy(tmp);
      av_dict_free(&tmp);
      retval = 0;
    } catch (std::exception &e) {
      av_dict_free(&tmp);
      retval = -1;
    }
    return retval;
  }

References com::avpkit::core::MetaData::copy(), and com::avpkit::core::MetaData::getDictionary().

---

The documentation for this class was generated from the following files:

• csrc/com/avpkit/core/Property.h
• csrc/com/avpkit/core/Property.cpp