Inheritance diagram for com::avpkit::core::Stream:

Collaboration diagram for com::avpkit::core::Stream:

[legend]

Public Member Functions
virtual Direction	getDirection ()
	Get the Direction this stream is pointing in. More...

virtual int	getIndex ()
	Get the relative position this stream has in the hosting IContainer object. More...

virtual int	getId ()
	Return a container format specific id for this stream. More...

virtual IStreamCoder *	getStreamCoder ()
	Get the StreamCoder than can manipulate this stream. More...

virtual IRational *	getFrameRate ()
	Get the (sometimes estimated) frame rate of this container. More...

virtual IRational *	getTimeBase ()
	The time base in which all timestamps (e.g. More...

virtual int64_t	getStartTime ()
	Return the start time, in getTimeBase() units, when this stream started. More...

virtual int64_t	getDuration ()
	Return the duration, in getTimeBase() units, of this stream, or Global#NO_PTS if unknown. More...

virtual int64_t	getCurrentDts ()
	The current Decompression Time Stamp that will be used on this stream, in getTimeBase() units. More...

virtual int	getNumIndexEntries ()
	Get the number of index entries in this stream. More...

virtual int64_t	getNumFrames ()
	Returns the number of encoded frames if known. More...

virtual void	setTimeBase (IRational *)

virtual void	setFrameRate (IRational *)

virtual int	containerClosed (Container *container)

virtual int32_t	acquire ()
	Internal Only. More...

virtual int32_t	release ()
	Internal Only. More...

virtual IRational *	getSampleAspectRatio ()
	Added in 1.17. More...

virtual void	setSampleAspectRatio (IRational *newRatio)
	Sets the sample aspect ratio. More...

virtual const char *	getLanguage ()
	Get the 4-character language setting for this stream. More...

virtual void	setLanguage (const char *language)
	Set the 4-character language setting for this stream. More...

virtual IContainer *	getContainer ()
	Get the underlying container for this stream, or null if AVPKit doesn't know. More...

virtual IStream::ParseType	getParseType ()
	Get how the decoding codec should parse data from this stream. More...

virtual void	setParseType (ParseType type)
	Set the parse type the decoding codec should use. More...

virtual int	setBitstreamFilter (const char *name)
	Set a bitstream filter on this stream. More...

virtual int32_t	setStreamCoder (IStreamCoder *coder)
	Sets the stream coder to use for this stream. More...

virtual AVStream *	getAVStream ()

virtual AVBSFContext *	getAVBsfContext ()

virtual IMetaData *	getMetaData ()
	Get the IMetaData for this object, or null if none. More...

virtual void	setMetaData (IMetaData *metaData)
	Set the IMetaData on this object, overriding any previous meta data. More...

virtual int32_t	stampOutputPacket (IPacket *packet)
	Takes a packet destined for this stream, and stamps the stream index, and converts the time stamp to the correct units (adjusting for rounding errors between stream conversions). More...

virtual int32_t	setStreamCoder (IStreamCoder *newCoder, bool assumeOnlyStream)
	Sets the stream coder to use for this stream. More...

virtual IIndexEntry *	findTimeStampEntryInIndex (int64_t wantedTimeStamp, int32_t flags)
	Search for the given time stamp in the key-frame index for this IStream. More...

virtual int32_t	findTimeStampPositionInIndex (int64_t wantedTimeStamp, int32_t flags)
	Search for the given time stamp in the key-frame index for this IStream. More...

virtual IIndexEntry *	getIndexEntry (int32_t position)
	Get the IIndexEntry at the given position in this IStream object's index. More...

virtual int32_t	addIndexEntry (IIndexEntry *entry)
	Adds an index entry into the stream's sorted index list. More...

void	setId (int32_t id)
	Set the format-specific stream id. More...

Public Member Functions inherited from com::avpkit::ferry::RefCounted
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 Stream *	make (Container container, AVStream , Direction direction, const AVCodec *)

Additional Inherited Members
Public Types inherited from com::avpkit::core::IStream
enum	Direction { INBOUND , OUTBOUND }
	The direction this stream is going (based on the container). More...

enum	ParseType { PARSE_NONE , PARSE_FULL , PARSE_HEADERS , PARSE_TIMESTAMPS , PARSE_FULL_ONCE , PARSE_FULL_RAW }
	What types of parsing can we do on a call to IContainer#readNextPacket(IPacket). More...

typedef enum com::avpkit::core::IStream::Direction	Direction
	The direction this stream is going (based on the container). More...

typedef enum com::avpkit::core::IStream::ParseType	ParseType
	What types of parsing can we do on a call to IContainer#readNextPacket(IPacket).

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 36 of file Stream.h.

Member Function Documentation

◆ acquire()

int32_t com::avpkit::core::Stream::acquire ( )

virtual

Internal Only.

DO NOT USE FROM JAVA.

Acquire a reference to this object. This increments the native internal ref count in native code by +1.

This method is called internally by Ferry in Java, and you should not call it without knowing what you are doing. But if you do call it, make sure you call release() once for each call you make to this method.

Returns: The refcount after the acquire. Note due to multi-threaded issues, you should not rely on this value, as it may change before the method returns to you.

Reimplemented from com::avpkit::ferry::RefCounted.

Definition at line 204 of file Stream.cpp.

   {
     int retval = 0;
     retval = RefCounted::acquire();
     VS_LOG_TRACE("Acquired %p: %d", this, retval);
     return retval;
   }

References com::avpkit::ferry::RefCounted::acquire().

◆ addIndexEntry()

int32_t com::avpkit::core::Stream::addIndexEntry ( IIndexEntry * entry )

virtual

Adds an index entry into the stream's sorted index list.

Updates the entry if the list already contains it.

Parameters

entry The entry to add.

Returns: >=0 on success; <0 on error.

Since: 3.4

Implements com::avpkit::core::IStream.

Definition at line 507 of file Stream.cpp.

   {
     if (!entry)
       return -1;
     if (!mStream)
       return -1;
     return av_add_index_entry(mStream,
         entry->getPosition(),
         entry->getTimeStamp(),
         entry->getSize(),
         entry->getMinDistance(),
         entry->getFlags());
   }

References com::avpkit::core::IIndexEntry::getFlags(), com::avpkit::core::IIndexEntry::getMinDistance(), com::avpkit::core::IIndexEntry::getPosition(), com::avpkit::core::IIndexEntry::getSize(), and com::avpkit::core::IIndexEntry::getTimeStamp().

◆ findTimeStampEntryInIndex()

IIndexEntry * com::avpkit::core::Stream::findTimeStampEntryInIndex	(	int64_t	wantedTimeStamp,
		int32_t	flags
	)

virtual

Search for the given time stamp in the key-frame index for this IStream.

Not all IContainerFormat implementations maintain key frame indexes, but if they have one, then this method searches in the IStream index to quickly find the byte-offset of the nearest key-frame to the given time stamp.

Parameters

wantedTimeStamp	the time stamp wanted, in the stream's time base units.
flags	A bitmask of the `SEEK_FLAG_*` flags, or 0 to turn all flags off. If IContainer#SEEK_FLAG_BACKWARDS then the returned index will correspond to the time stamp which is <= the requested one (not supported by all demuxers). If IContainer#SEEK_FLAG_BACKWARDS is not set then it will be >=. if IContainer#SEEK_FLAG_ANY seek to any frame, only keyframes otherwise (not supported by all demuxers).

Returns: The IIndexEntry for the nearest appropriate timestamp in the index, or null if it can't be found.

Since: 3.4

Implements com::avpkit::core::IStream.

Definition at line 465 of file Stream.cpp.

   {
     int32_t index = findTimeStampPositionInIndex(wantedTimeStamp, flags);
     // getIndexEntry will check for a negative index and return null if so
     return getIndexEntry(index);
   }

References findTimeStampPositionInIndex(), and getIndexEntry().

◆ findTimeStampPositionInIndex()

int32_t com::avpkit::core::Stream::findTimeStampPositionInIndex	(	int64_t	wantedTimeStamp,
		int32_t	flags
	)

virtual

Search for the given time stamp in the key-frame index for this IStream.

Not all IContainerFormat implementations maintain key frame indexes, but if they have one, then this method searches in the IStream index to quickly find the index entry position of the nearest key-frame to the given time stamp.

Parameters

wantedTimeStamp	the time stamp wanted, in the stream's time base units.
flags	A bitmask of the `SEEK_FLAG_*` flags, or 0 to turn all flags off. If IContainer#SEEK_FLAG_BACKWARDS then the returned index will correspond to the time stamp which is <= the requested one (not supported by all demuxers). If IContainer#SEEK_FLAG_BACKWARDS is not set then it will be >=. if IContainer#SEEK_FLAG_ANY seek to any frame, only keyframes otherwise (not supported by all demuxers).

Returns: The position in this IStream index, or -1 if it cannot be found or an index is not maintained.

See also: #getIndexEntry(int)

Since: 3.4

Implements com::avpkit::core::IStream.

Definition at line 472 of file Stream.cpp.

   {
     int retval = -1;
     if (mStream) {
       retval = av_index_search_timestamp(
           mStream,
           wantedTimeStamp,
           flags);
     }
     return retval;
   }

Referenced by findTimeStampEntryInIndex().

◆ getContainer()

IContainer * com::avpkit::core::Stream::getContainer ( )

virtual

Get the underlying container for this stream, or null if AVPKit doesn't know.

Returns: the container, or null if we don't know.

Implements com::avpkit::core::IStream.

Definition at line 269 of file Stream.cpp.

   {
     // add ref for caller
     VS_REF_ACQUIRE(mContainer);
     return mContainer;
   }

◆ getCurrentDts()

int64_t com::avpkit::core::Stream::getCurrentDts ( )

virtual

The current Decompression Time Stamp that will be used on this stream, in getTimeBase() units.

Returns: The current Decompression Time Stamp that will be used on this stream.

Implements com::avpkit::core::IStream.

Definition at line 178 of file Stream.cpp.

   {
     return (mStream ? mStream->cur_dts : Global::NO_PTS);
   }

References com::avpkit::core::Global::NO_PTS.

◆ getDirection()

virtual Direction com::avpkit::core::Stream::getDirection ( )

inlinevirtual

Get the Direction this stream is pointing in.

Returns: The direction of this stream.

Implements com::avpkit::core::IStream.

Definition at line 42 of file Stream.h.

42 { return mDirection; }

◆ getDuration()

int64_t com::avpkit::core::Stream::getDuration ( )

virtual

Return the duration, in getTimeBase() units, of this stream, or Global#NO_PTS if unknown.

Returns: The duration (in getTimeBase units) of this stream, if known.

Implements com::avpkit::core::IStream.

Definition at line 172 of file Stream.cpp.

   {
     return (mStream ? mStream->duration : Global::NO_PTS);
   }

References com::avpkit::core::Global::NO_PTS.

◆ getFrameRate()

IRational * com::avpkit::core::Stream::getFrameRate ( )

virtual

Get the (sometimes estimated) frame rate of this container.

For variable frame-rate containers (they do exist) this is just an approimation. Better to use getTimeBase().

For contant frame-rate containers, this will be 1 / ( getTimeBase() )

Returns: The frame-rate of this container.

Implements com::avpkit::core::IStream.

Definition at line 125 of file Stream.cpp.

   {
     IRational * result = 0;
     if (mStream)
     {
       AVRational f = av_guess_frame_rate(NULL, mStream, NULL);  
       result = Rational::make(&f);
     }
     return result;
   }

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

◆ getId()

int com::avpkit::core::Stream::getId ( )

virtual

Return a container format specific id for this stream.

Returns: The (container format specific) id of this stream.

Implements com::avpkit::core::IStream.

Definition at line 107 of file Stream.cpp.

   {
     return (mStream ? mStream->id : -1);
   }

◆ getIndex()

int com::avpkit::core::Stream::getIndex ( )

virtual

Get the relative position this stream has in the hosting IContainer object.

Returns: The Index within the Container of this stream.

Implements com::avpkit::core::IStream.

Definition at line 101 of file Stream.cpp.

   {
     return (mStream ? mStream->index : -1);
   }

Referenced by stampOutputPacket().

◆ getIndexEntry()

IIndexEntry * com::avpkit::core::Stream::getIndexEntry ( int32_t position )

virtual

Get the IIndexEntry at the given position in this IStream object's index.

Not all IContainerFormat types maintain IStream indexes, but if they do, this method can return those entries.

Do not modify the IContainer this stream is from between calls to this method and getNumIndexEntries() as indexes may be compacted while processing.

Parameters

position The position in the index table.

Since: 3.4

Implements com::avpkit::core::IStream.

Definition at line 486 of file Stream.cpp.

   {
     IIndexEntry* retval = 0;
     if (mStream->index_entries
         && index >= 0
         && index < mStream->nb_index_entries)
     {
       AVIndexEntry* entry = &(mStream->index_entries[index]);
       if (entry) {
         retval = IIndexEntry::make(
             entry->pos,
             entry->timestamp,
             entry->flags,
             entry->size,
             entry->min_distance
         );
       }
     }
     return retval;
   }

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

Referenced by findTimeStampEntryInIndex().

◆ getLanguage()

const char * com::avpkit::core::Stream::getLanguage ( )

virtual

Get the 4-character language setting for this stream.

This will return null if no setting. When calling from C++, callers must ensure that the IStream outlives the value returned.

Implements com::avpkit::core::IStream.

Definition at line 248 of file Stream.cpp.

   {
     const char*retval = 0;
     com::avpkit::ferry::RefPointer<IMetaData> metaData = getMetaData();
     if (metaData) {
       retval = metaData->getValue("language", IMetaData::METADATA_NONE);
     }
     return retval;
   }

References getMetaData(), and com::avpkit::core::IMetaData::METADATA_NONE.

◆ getMetaData()

IMetaData * com::avpkit::core::Stream::getMetaData ( )

virtual

Get the IMetaData for this object, or null if none.

If the IContainer or IStream object that this IMetaData came from was opened for reading, then changes via IMetaData#setValue(String, String) will have no effect on the underlying media.

If the IContainer or IStream object that this IMetaData came from was opened for writing, then changes via IMetaData#setValue(String, String) will have no effect after IContainer#writeHeader() is called.

Returns: the IMetaData.

Since: 3.1

Implements com::avpkit::core::IStream.

Definition at line 368 of file Stream.cpp.

   {
     if (!mMetaData && mStream)
     {
       if (mDirection == IStream::OUTBOUND)
         mMetaData = MetaData::make(&mStream->metadata);
       else
         // make a read-only copy so when libav deletes the
         // input version we don't delete our copy
         mMetaData = MetaData::make(mStream->metadata);
     }
     return mMetaData.get();
   }

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

Referenced by getLanguage(), setLanguage(), and setMetaData().

◆ getNumFrames()

int64_t com::avpkit::core::Stream::getNumFrames ( )

virtual

Returns the number of encoded frames if known.

Note that frames here means encoded frames, which can consist of many encoded audio samples, or an encoded video frame.

Returns: The number of frames (encoded) in this stream.

Implements com::avpkit::core::IStream.

Definition at line 184 of file Stream.cpp.

   {
     return (mStream ? mStream->nb_frames : 0);
   }

◆ getNumIndexEntries()

int com::avpkit::core::Stream::getNumIndexEntries ( )

virtual

Get the number of index entries in this stream.

Returns: The number of index entries in this stream.

See also: #getIndexEntry(int)

Implements com::avpkit::core::IStream.

Definition at line 189 of file Stream.cpp.

   {
     return (mStream ? mStream->nb_index_entries : 0);
   }

◆ getParseType()

IStream::ParseType com::avpkit::core::Stream::getParseType ( )

virtual

Get how the decoding codec should parse data from this stream.

Returns: the parse type.

Since: 3.0

Implements com::avpkit::core::IStream.

Definition at line 320 of file Stream.cpp.

   {
     if (mStream) {
       return (IStream::ParseType)mStream->need_parsing;
     } else {
       return IStream::PARSE_NONE;
     }
   }

◆ getSampleAspectRatio()

IRational * com::avpkit::core::Stream::getSampleAspectRatio ( )

virtual

Added in 1.17.

Gets the sample aspect ratio.

Returns: The sample aspect ratio.

Implements com::avpkit::core::IStream.

Definition at line 222 of file Stream.cpp.

   {
     IRational* retval = 0;
     if (mStream)
     {
       retval = IRational::make(
           mStream->sample_aspect_ratio.num,
           mStream->sample_aspect_ratio.den);
     }
     return retval;
   }

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

◆ getStartTime()

int64_t com::avpkit::core::Stream::getStartTime ( )

virtual

Return the start time, in getTimeBase() units, when this stream started.

Returns: The start time.

Implements com::avpkit::core::IStream.

Definition at line 166 of file Stream.cpp.

   {
     return (mStream ? mStream->start_time : Global::NO_PTS);
   }

References com::avpkit::core::Global::NO_PTS.

◆ getStreamCoder()

IStreamCoder * com::avpkit::core::Stream::getStreamCoder ( )

virtual

Get the StreamCoder than can manipulate this stream.

If the stream is an INBOUND stream, then the StreamCoder can do a IStreamCoder::DECODE. IF this stream is an OUTBOUND stream, then the StreamCoder can do all IStreamCoder::ENCODE methods.

Returns: The StreamCoder assigned to this object.

Implements com::avpkit::core::IStream.

Definition at line 113 of file Stream.cpp.

   {
     StreamCoder *retval = 0;
  
     // acquire a reference for the caller
     retval = mCoder;
     VS_REF_ACQUIRE(retval);
  
     return retval;
   }

◆ getTimeBase()

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

virtual

The time base in which all timestamps (e.g.

Presentation Time Stamp (PTS) and Decompression Time Stamp (DTS)) are represented. For example if the time base is 1/1000, then the difference between a PTS of 1 and a PTS of 2 is 1 millisecond. If the timebase is 1/1, then the difference between a PTS of 1 and a PTS of 2 is 1 second.

Returns: The time base of this stream.

Implements com::avpkit::core::IStream.

Definition at line 137 of file Stream.cpp.

   {
     IRational * result = 0;
     if (mStream)
     {
       result = Rational::make(&mStream->time_base);
     }
     return result;
   }

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

Referenced by stampOutputPacket().

◆ release()

int32_t com::avpkit::core::Stream::release ( )

virtual

Internal Only.

DO NOT USE FROM JAVA.

This decrements the native internal ref count by -1; the object is destroyed if its ref count reaches zero.

This method is called internally by Ferry in Java, and you should not call it without knowing what you are doing. But if you do call it, make sure you had previously called acquire() once for each call to release() you make.

Returns: The ref count after the release. Note due to multi-threaded issues, you should not rely on this value, as it may change before the method returns to you.

Reimplemented from com::avpkit::ferry::RefCounted.

Definition at line 213 of file Stream.cpp.

   {
     int retval = 0;
     retval = RefCounted::release();
     VS_LOG_TRACE("Released %p: %d", this, retval);
     return retval;
   }

References com::avpkit::ferry::RefCounted::release().

◆ setBitstreamFilter()

int com::avpkit::core::Stream::setBitstreamFilter ( const char * name )

virtual

Set a bitstream filter on this stream.

Parameters

name	The name of bitstream filter

Since: 6.0

Implements com::avpkit::core::IStream.

Definition at line 338 of file Stream.cpp.

   {
     
     int ret = -1;
     if (mStream) {
         if (!mBsfContext) {
             const AVBitStreamFilter* filter = av_bsf_get_by_name(name);
             if (filter) {
                 if (ret = av_bsf_alloc(filter, &mBsfContext) == 0) {
                     if (ret = avcodec_parameters_copy(mBsfContext->par_in, mStream->codecpar) >= 0) {
       mBsfContext->time_base_in = mStream->time_base;
                         if (ret = av_bsf_init(mBsfContext) < 0) {
         VS_LOG_ERROR("BSF INIT FAIL");
         av_bsf_free(&mBsfContext);
         return ret;
       }    
       VS_LOG_ERROR("BSF OK");
                     }
                 }
             }
  
         } else {
             VS_LOG_ERROR("Bistream filter already set on this stream");
         }
     }
     
     return ret;
   }

◆ setId()

void com::avpkit::core::Stream::setId ( int32_t id )

virtual

Set the format-specific stream id.

Parameters

id	The id to set.

See also: getId()

Since: 5.0

Implements com::avpkit::core::IStream.

Definition at line 522 of file Stream.cpp.

   {
     if (!mStream)
       return;
     mStream->id = aId;
   }

Referenced by com::avpkit::core::Container::addNewStream().

◆ setLanguage()

void com::avpkit::core::Stream::setLanguage ( const char * language )

virtual

Set the 4-character language setting for this stream.

If a string longer than 4 characters is passed in, only the first 4 characters is copied.

Parameters

language The new language setting. null is equivalent to the empty string. strings longer than 4 characters will be truncated to first 4 characters.

Implements com::avpkit::core::IStream.

Definition at line 259 of file Stream.cpp.

   {
     com::avpkit::ferry::RefPointer<IMetaData> metaData = getMetaData();
     if (metaData) {
       metaData->setValue("language", aNewValue);
     }
     return;
   }

References getMetaData().

◆ setMetaData()

void com::avpkit::core::Stream::setMetaData ( IMetaData * data )

virtual

Set the IMetaData on this object, overriding any previous meta data.

You should call this method on writable containers and before you call IContainer#writeHeader, as it probably won't do anything after that.

See also: getMetaData()

Since: 3.1

Implements com::avpkit::core::IStream.

Definition at line 383 of file Stream.cpp.

   {
     MetaData* data = dynamic_cast<MetaData*>(getMetaData());
     if (data) {
       data->copy(copy);
       // release for the get above
       data->release();
     }
     return;
   }

References com::avpkit::core::MetaData::copy(), getMetaData(), and com::avpkit::ferry::RefCounted::release().

◆ setParseType()

void com::avpkit::core::Stream::setParseType ( ParseType type )

virtual

Set the parse type the decoding codec should use.

Set to ParseType#PARSE_NONE if you don't want any parsing to be done.

Warning: do not set this flag unless you know what you're doing, and do not set after you've started decoding.

Parameters

type	The type to set.

Since: 3.0

Implements com::avpkit::core::IStream.

Definition at line 330 of file Stream.cpp.

   {
     if (mStream) {
       mStream->need_parsing = (enum AVStreamParseType)type;
     }
   }

◆ setSampleAspectRatio()

void com::avpkit::core::Stream::setSampleAspectRatio ( IRational * newRatio )

virtual

Sets the sample aspect ratio.

Parameters

newRatio The new ratio.

Implements com::avpkit::core::IStream.

Definition at line 235 of file Stream.cpp.

   {
     if (aNewValue && mStream)
     {
       mStream->sample_aspect_ratio.num =
         aNewValue->getNumerator();
       mStream->sample_aspect_ratio.den =
         aNewValue->getDenominator();
     }
     return;
   }

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

◆ setStreamCoder() [1/2]

int32_t com::avpkit::core::Stream::setStreamCoder ( IStreamCoder * newCoder )

virtual

Sets the stream coder to use for this stream.

This method will only cause a change if the IStreamCoder currently set on this IStream is not open. Otherwise the call is ignore and an error is returned.

Parameters

newCoder The new stream coder to use.

Returns: >= 0 on success; < 0 on error.

Implements com::avpkit::core::IStream.

Definition at line 277 of file Stream.cpp.

   {
     return setStreamCoder(coder, true);
   }

Referenced by com::avpkit::core::Container::addNewStream().

◆ setStreamCoder() [2/2]

int32_t com::avpkit::core::Stream::setStreamCoder	(	IStreamCoder *	newCoder,
		bool	assumeOnlyStream
	)

virtual

Sets the stream coder to use for this stream.

This method will only cause a change if the IStreamCoder currently set on this IStream is not open. Otherwise the call is ignored and an error is returned.

Parameters

newCoder	The new stream coder to use.
assumeOnlyStream	If true then this IStream will notify the IStreamCoder that it is the only stream and the IStreamCoder may use it to determine time stamps to output packets with. If false then the IStreamCoder does not support automatic stamping of packets with stream index IDs and users must call stampOutputPacket(IPacket) themselves.

Returns: >= 0 on success; < 0 on error.

Since: 3.2

Implements com::avpkit::core::IStream.

Definition at line 282 of file Stream.cpp.

   {
     int32_t retval = -1;
     try
     {
       if (mCoder && mCoder->isOpen())
         throw std::runtime_error("cannot call setStreamCoder when current coder is open");
       
       if (!aCoder)
         throw std::runtime_error("cannot set to a null stream coder");
  
       StreamCoder *coder = dynamic_cast<StreamCoder*>(aCoder);
       if (!coder)
         throw std::runtime_error("IStreamCoder is not of expected underlying C++ type");
  
       // Close the old stream coder
       if (mCoder)
       {
         mCoder->streamClosed(this);
       }
  
       if (coder->setStream(this, assumeOnlyStream) < 0)
         throw std::runtime_error("IStreamCoder doesn't like this stream");
  
       VS_REF_RELEASE(mCoder);
       mCoder = coder;
       VS_REF_ACQUIRE(mCoder);
       retval = 0;
     }
     catch (std::exception & e)
     {
       VS_LOG_ERROR("Error: %s", e.what());
       retval = -1;
     }
     return retval;
   }

References com::avpkit::core::StreamCoder::isOpen().

◆ stampOutputPacket()

int32_t com::avpkit::core::Stream::stampOutputPacket ( IPacket * packet )

virtual

Takes a packet destined for this stream, and stamps the stream index, and converts the time stamp to the correct units (adjusting for rounding errors between stream conversions).

Parameters

packet to stamp

Returns: >= 0 on success; <0 on failure.

Since: 3.2

Implements com::avpkit::core::IStream.

Definition at line 395 of file Stream.cpp.

   {
     if (!packet)
       return -1;
  
 //    VS_LOG_DEBUG("input:  duration: %lld; dts: %lld; pts: %lld;",
 //        packet->getDuration(), packet->getDts(), packet->getPts());
  
     // Always just reset this; cheaper than checking if it's
     // already set
     packet->setStreamIndex(this->getIndex());
     
     com::avpkit::ferry::RefPointer<IRational> thisBase = getTimeBase();
     com::avpkit::ferry::RefPointer<IRational> packetBase = packet->getTimeBase();
     if (!thisBase || !packetBase)
       return -1;
     if (thisBase->compareTo(packetBase.value()) == 0) {
 //      VS_LOG_DEBUG("Same timebase: %d/%d vs %d/%d",
 //          thisBase->getNumerator(), thisBase->getDenominator(),
 //          packetBase->getNumerator(), packetBase->getDenominator());
       // it's already got the right time values
       return 0;
     }
     
     int64_t duration = packet->getDuration();
     int64_t dts = packet->getDts();
     int64_t pts = packet->getPts();
     
     if (duration >= 0)
       duration = thisBase->rescale(duration, packetBase.value(),
           IRational::ROUND_DOWN);
     
     if (pts != Global::NO_PTS)
     {
       pts = thisBase->rescale(pts, packetBase.value(), IRational::ROUND_DOWN);
     }
     if (dts != Global::NO_PTS)
     {
       dts = thisBase->rescale(dts, packetBase.value(), IRational::ROUND_DOWN);
       if (mLastDts != Global::NO_PTS && dts == mLastDts)
       {
         // adjust for rounding; we never want to insert a frame that
         // is not monotonically increasing.  Note we only do this if
         // we're off by one; that's because we ROUND_DOWN and then assume
         // that can be off by at most one.  If we're off by more than one
         // then it's really an error on the person muxing to this stream.
         dts = mLastDts+1;
         // and round up pts
         if (pts != Global::NO_PTS)
           ++pts;
         // and if after all that adjusting, pts is less than dts
         // let dts win.
         if (pts == Global::NO_PTS || pts < dts)
           pts = dts;
       }
       mLastDts = dts;
     }
     
 //    VS_LOG_DEBUG("output: duration: %lld; dts: %lld; pts: %lld;",
 //        duration, dts, pts);
     packet->setDuration(duration);
     packet->setPts(pts);
     packet->setDts(dts);
     packet->setTimeBase(thisBase.value());
 //    VS_LOG_DEBUG("Reset timebase: %d/%d",
 //        thisBase->getNumerator(), thisBase->getDenominator());
     return 0;
   }

References com::avpkit::core::IPacket::getDts(), com::avpkit::core::IPacket::getDuration(), getIndex(), com::avpkit::core::IPacket::getPts(), getTimeBase(), com::avpkit::core::IMediaData::getTimeBase(), com::avpkit::core::Global::NO_PTS, com::avpkit::core::IPacket::setDts(), com::avpkit::core::IPacket::setDuration(), com::avpkit::core::IPacket::setPts(), com::avpkit::core::IPacket::setStreamIndex(), com::avpkit::core::IMediaData::setTimeBase(), and com::avpkit::ferry::RefPointer< T >::value().

Referenced by com::avpkit::core::Container::writePacket().

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ acquire()

◆ addIndexEntry()

◆ findTimeStampEntryInIndex()

◆ findTimeStampPositionInIndex()

◆ getContainer()

◆ getCurrentDts()

◆ getDirection()

◆ getDuration()

◆ getFrameRate()

◆ getId()

◆ getIndex()

◆ getIndexEntry()

◆ getLanguage()

◆ getMetaData()

◆ getNumFrames()

◆ getNumIndexEntries()

◆ getParseType()

◆ getSampleAspectRatio()

◆ getStartTime()

◆ getStreamCoder()

◆ getTimeBase()

◆ release()

◆ setBitstreamFilter()

◆ setId()

◆ setLanguage()

◆ setMetaData()

◆ setParseType()

◆ setSampleAspectRatio()

◆ setStreamCoder() [1/2]

◆ setStreamCoder() [2/2]

◆ stampOutputPacket()