Inheritance diagram for com::avpkit::core::MediaDataWrapper:

[legend]

Collaboration diagram for com::avpkit::core::MediaDataWrapper:

[legend]

Public Member Functions
virtual int64_t	getTimeStamp ()
	Get the time stamp of this object in getTimeBase() units. More...

virtual void	setTimeStamp (int64_t aTimeStamp)
	Set the time stamp for this object in getTimeBase() units. More...

virtual IRational *	getTimeBase ()
	Get the time base that time stamps of this object are represented in. More...

virtual void	setTimeBase (IRational *aBase)
	Set the time base that time stamps of this object are represented in. More...

virtual com::avpkit::ferry::IBuffer *	getData ()
	Get any underlying raw data available for this object. More...

virtual int32_t	getSize ()
	Get the size in bytes of the raw data available for this object. More...

virtual bool	isKey ()
	Is this object a key object? i.e. More...

virtual IMediaData *	get ()
	Return the object being wrapped. More...

virtual void	wrap (IMediaData *aObj)
	Set an object to wrap, or null to release the old object. More...

virtual void	setKey (bool aIsKey)
	Allows you to reset whether the wrapper things this is key or not. More...

virtual IMediaData *	unwrap ()
	Gets the non IMediaDataWrapper object ultimately wrapped in this wrapper, or null if there isn't one. More...

virtual void	setData (com::avpkit::ferry::IBuffer *)
	Sets the underlying buffer used by this object. 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 MediaDataWrapper *	make (IMediaData *obj)
	Create a new IMediaDataWrapper that wraps a given object. More...

Static Public Member Functions inherited from com::avpkit::core::IMediaDataWrapper
static IMediaDataWrapper *	make (IMediaData *obj)
	Create a new IMediaDataWrapper object that wraps the given obj. More...

Additional Inherited Members
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

Definition at line 28 of file MediaDataWrapper.h.

Member Function Documentation

◆ get()

IMediaData * com::avpkit::core::MediaDataWrapper::get ( )

virtual

Return the object being wrapped.

Returns: the wrapped object

Implements com::avpkit::core::IMediaDataWrapper.

Definition at line 159 of file MediaDataWrapper.cpp.

 {
   return mWrapped.get();
 }

◆ getData()

IBuffer * com::avpkit::core::MediaDataWrapper::getData ( )

virtual

Get any underlying raw data available for this object.

Returns: The raw data, or null if not accessible.

Implements com::avpkit::core::IMediaData.

Definition at line 77 of file MediaDataWrapper.cpp.

 {
   IBuffer* retval=0;
   // forward to wrapped object
   if (mWrapped)
   {
     retval = mWrapped->getData();
   }
   return retval;
 }

◆ getSize()

int32_t com::avpkit::core::MediaDataWrapper::getSize ( )

virtual

Get the size in bytes of the raw data available for this object.

Returns: the size in bytes, or -1 if it cannot be computed.

Implements com::avpkit::core::IMediaData.

Definition at line 89 of file MediaDataWrapper.cpp.

 {
   int retval = -1;
   // forward to wrapped object
   if (mWrapped)
   {
     retval = mWrapped->getSize();
   }
   return retval;
 }

◆ getTimeBase()

IRational * com::avpkit::core::MediaDataWrapper::getTimeBase ( )

virtual

Get the time base that time stamps of this object are represented in.

Caller must release the returned value.

Returns: the time base.

Implements com::avpkit::core::IMediaData.

Definition at line 65 of file MediaDataWrapper.cpp.

 {
   return mTimeBase.get();
 }

◆ getTimeStamp()

int64_t com::avpkit::core::MediaDataWrapper::getTimeStamp ( )

virtual

Get the time stamp of this object in getTimeBase() units.

Returns: the time stamp

Implements com::avpkit::core::IMediaData.

Definition at line 53 of file MediaDataWrapper.cpp.

 {
   return mTimeStamp;
 }

◆ isKey()

bool com::avpkit::core::MediaDataWrapper::isKey ( )

virtual

Is this object a key object? i.e.

it can be interpreted without needing any other media objects

Returns: true if it's a key, false if not

Implements com::avpkit::core::IMediaData.

Definition at line 101 of file MediaDataWrapper.cpp.

 {
   return mIsKey;
 }

◆ make()

MediaDataWrapper * com::avpkit::core::MediaDataWrapper::make ( IMediaData * obj )

static

Create a new IMediaDataWrapper that wraps a given object.

Parameters

obj	The object to wrap. Can be null.

Returns: a new object, or null if we cannot allocate one.

Definition at line 42 of file MediaDataWrapper.cpp.

 {
   MediaDataWrapper* retval = make();
   if (retval)
   {
     retval->wrap(obj);
   }
   return retval;
 }

References wrap().

Referenced by com::avpkit::core::IMediaDataWrapper::make().

◆ setData()

void com::avpkit::core::MediaDataWrapper::setData ( com::avpkit::ferry::IBuffer * buffer )

virtual

Sets the underlying buffer used by this object.

This is an advanced method and is not recommended for use by those who don't fully understand how IBuffers work. Implementations of IMediaData may behave in undefined ways if the buffer you pass in is not big enough for what you ask them to do (e.g. they may discard your buffer and allocate a larger one if they need more space). It is up to the caller to ensure the buffer passed in is large enough, and is not simultaneously in use by another part of the system.

Parameters

buffer The buffer to set. If null, this method is ignored.

Implements com::avpkit::core::IMediaData.

Definition at line 152 of file MediaDataWrapper.cpp.

 {
   if (mWrapped)
     mWrapped->setData(buffer);
 }

◆ setKey()

void com::avpkit::core::MediaDataWrapper::setKey ( bool aIsKey )

virtual

Allows you to reset whether the wrapper things this is key or not.

Note the underlying wrapped object will continue to keep it's prior setting.

Parameters

aIsKey The new key value.

Implements com::avpkit::core::IMediaDataWrapper.

Definition at line 107 of file MediaDataWrapper.cpp.

 {
   mIsKey = aIsKey;
 }

◆ setTimeBase()

void com::avpkit::core::MediaDataWrapper::setTimeBase ( IRational * aBase )

virtual

Set the time base that time stamps of this object are represented in.

Parameters

aBase the new time base. If null an exception is thrown.

Implements com::avpkit::core::IMediaData.

Definition at line 71 of file MediaDataWrapper.cpp.

 {
   mTimeBase.reset(aBase, true);
 }

◆ setTimeStamp()

void com::avpkit::core::MediaDataWrapper::setTimeStamp ( int64_t aTimeStamp )

virtual

Set the time stamp for this object in getTimeBase() units.

Parameters

aTimeStamp The time stamp

Implements com::avpkit::core::IMediaData.

Definition at line 59 of file MediaDataWrapper.cpp.

 {
   mTimeStamp = aTimeStamp;
 }

◆ unwrap()

IMediaData * com::avpkit::core::MediaDataWrapper::unwrap ( )

virtual

Gets the non IMediaDataWrapper object ultimately wrapped in this wrapper, or null if there isn't one.

Returns: The non IMediaDataWrapper object ultimately wrapped

Implements com::avpkit::core::IMediaDataWrapper.

Definition at line 165 of file MediaDataWrapper.cpp.

 {
   RefPointer<IMediaData> unwrapped = get();
   
   // as long unwrapped points to an IMediaDataWrapper, then unwrap
   while(unwrapped && dynamic_cast<IMediaDataWrapper*>(unwrapped.value()))
     unwrapped = (dynamic_cast<IMediaDataWrapper*>(unwrapped.value()))->get();
   return unwrapped.get();
 }

References com::avpkit::ferry::RefPointer< T >::get(), and com::avpkit::ferry::RefPointer< T >::value().

◆ wrap()

void com::avpkit::core::MediaDataWrapper::wrap ( IMediaData * aObj )

virtual

Set an object to wrap, or null to release the old object.

Parameters

aObj	The object to wrap; null just releases the last object

Implements com::avpkit::core::IMediaDataWrapper.

Definition at line 113 of file MediaDataWrapper.cpp.

 {
   IMediaDataWrapper* wrapper=dynamic_cast<IMediaDataWrapper*>(aObj);
   // loop detection to make sure we're not wrapping ourselves.
   if (wrapper) {
     RefPointer<IMediaData> obj;
     IMediaDataWrapper *me = static_cast<IMediaDataWrapper*>(this);
     do
     {
       if (wrapper == me)
         break;
       obj = wrapper->get();
     } while (0 != (wrapper = dynamic_cast<IMediaDataWrapper*>(obj.value())));
     
     if (wrapper == me)
     {
       VS_LOG_ERROR("Attempted to wrap an object that ultimately wraps itself.  Ignoring");
       // we're wrapping ourselves
       return;
     }
   }
   mWrapped.reset(aObj, true);
   if (aObj)
   {
     setTimeStamp(aObj->getTimeStamp());
     IRational *base = aObj->getTimeBase();
     setTimeBase(base);
     VS_REF_RELEASE(base);
     setKey(aObj->isKey());
   }
   else
   {
     setTimeStamp(Global::NO_PTS);
     setTimeBase(0);
     setKey(true);
   }
 }

References com::avpkit::core::IMediaDataWrapper::get(), com::avpkit::core::IMediaData::getTimeBase(), com::avpkit::core::IMediaData::getTimeStamp(), com::avpkit::core::IMediaData::isKey(), com::avpkit::core::Global::NO_PTS, and com::avpkit::ferry::RefPointer< T >::value().

Referenced by make().

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

csrc/com/avpkit/core/MediaDataWrapper.h
csrc/com/avpkit/core/MediaDataWrapper.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get()

◆ getData()

◆ getSize()

◆ getTimeBase()

◆ getTimeStamp()

◆ isKey()

◆ make()

◆ setData()

◆ setKey()

◆ setTimeBase()

◆ setTimeStamp()

◆ unwrap()

◆ wrap()