com::avpkit::core::Container Class Reference

Inheritance diagram for com::avpkit::core::Container:

Collaboration diagram for com::avpkit::core::Container:

Public Member Functions
virtual int32_t	setInputBufferLength (int32_t size)
	Set the buffer length AVPKit will suggest to FFMPEG for reading inputs. More...
virtual int32_t	getInputBufferLength ()
	Return the input buffer length. More...
virtual bool	isOpened ()
	Is this container opened? More...
virtual bool	isHeaderWritten ()
	Has a header been successfully written? More...
virtual int32_t	open (const char *url, Type type, IContainerFormat *pContainerFormat)
	Open this container and make it ready for reading or writing. More...
virtual int32_t	open (const char *url, Type type, IContainerFormat *pContainerFormat, bool, bool)
	Open this container and make it ready for reading or writing, optionally reading as far into the container as necessary to find all streams. More...
virtual IStreamCoder::CodecStandardsCompliance	getStandardsCompliance ()
	Gets the current level of standards compliance. More...
virtual int32_t	setStandardsCompliance (IStreamCoder::CodecStandardsCompliance compliance)
	Set the level of standards compliance. More...
virtual IContainerFormat *	getContainerFormat ()
	Returns the IContainerFormat object being used for this IContainer, or null if the IContainer doesn't yet know. More...
virtual Type	getType ()
	Find out the type of this container. More...
virtual int32_t	close ()
virtual int32_t	close (bool)
	Close the container. More...
virtual int32_t	getNumStreams ()
	The number of streams in this container. More...
virtual Stream *	getStream (int32_t position)
	Get the stream at the given position. More...
virtual Stream *	addNewStream (int32_t id)
virtual int32_t	readNextPacket (IPacket *packet)
	Reads the next packet into the IPacket. More...
virtual int32_t	writePacket (IPacket *packet, bool forceInterleave)
	Writes the contents of the packet to the container. More...
virtual int32_t	writePacket (IPacket *packet)
	Writes the contents of the packet to the container, but make sure the packets are interleaved. More...
virtual int32_t	writeHeader ()
	Adds a header, if needed, for this container. More...
virtual int32_t	writeTrailer ()
	Adds a trailer, if needed, for this container. More...
AVFormatContext *	getFormatContext ()
virtual int32_t	queryStreamMetaData ()
	Attempts to read all the meta data in this stream, potentially by reading ahead and decoding packets. More...
virtual int32_t	seekKeyFrame (int streamIndex, int64_t timestamp, int32_t flags)
virtual int64_t	getDuration ()
	Gets the duration, if known, of this container. More...
virtual int64_t	getStartTime ()
	Get the starting timestamp in microseconds of the first packet of the earliest stream in this container. More...
virtual int64_t	getFileSize ()
	Get the file size in bytes of this container. More...
virtual int32_t	getBitRate ()
	Get the calculated overall bit rate of this file. More...
virtual int32_t	setPreload (int32_t preload)
	@Deprecated use setProperty instead. More...
virtual int32_t	getPreload ()
	@Deprecated use getPropertyAsLong instead. More...
virtual int32_t	setMaxDelay (int32_t maxdelay)
	Sets the max delay for the AVFormatContext.max_delay property. More...
virtual int32_t	getMaxDelay ()
	Gets the AVFormatContext.max_delay property if possible. More...
virtual int32_t	getNumProperties ()
	Returns the total number of settable properties on this object. More...
virtual IProperty *	getPropertyMetaData (int32_t propertyNo)
	Returns the name of the numbered property. More...
virtual IProperty *	getPropertyMetaData (const char *name)
	Returns the name of the numbered property. More...
virtual int32_t	setProperty (const char *name, const char *value)
	Sets a property on this Object. More...
virtual int32_t	setProperty (const char *name, double value)
	Looks up the property 'name' and sets the value of the property to 'value'. More...
virtual int32_t	setProperty (const char *name, int64_t value)
	Looks up the property 'name' and sets the value of the property to 'value'. More...
virtual int32_t	setProperty (const char *name, bool value)
	Looks up the property 'name' and sets the value of the property to 'value'. More...
virtual int32_t	setProperty (const char *name, IRational *value)
	Looks up the property 'name' and sets the value of the property to 'value'. More...
virtual char *	getPropertyAsString (const char *name)
	Gets a property on this Object. More...
virtual double	getPropertyAsDouble (const char *name)
	Gets the value of this property, and returns as a double;. More...
virtual int64_t	getPropertyAsLong (const char *name)
	Gets the value of this property, and returns as an long;. More...
virtual IRational *	getPropertyAsRational (const char *name)
	Gets the value of this property, and returns as an IRational;. More...
virtual bool	getPropertyAsBoolean (const char *name)
	Gets the value of this property, and returns as a boolean. More...
virtual int32_t	getFlags ()
	Get the flags associated with this object. More...
virtual void	setFlags (int32_t newFlags)
	Set the flags to use with this object. More...
virtual bool	getFlag (Flags flag)
	Get the setting for the specified flag. More...
virtual void	setFlag (Flags flag, bool value)
	Set the flag. More...
virtual const char *	getURL ()
	Get the URL the IContainer was opened with. More...
virtual int32_t	flushPackets ()
	Flush all packets to output. More...
virtual int32_t	getReadRetryCount ()
	Get the number of times IContainer#readNextPacket(IPacket) will retry a read if it gets a IError.Type#ERROR_AGAIN value back. More...
virtual void	setReadRetryCount (int32_t count)
	Sets the read retry count. More...
virtual bool	canStreamsBeAddedDynamically ()
	Can streams be added dynamically to this container? More...
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	createSDPData (com::avpkit::ferry::IBuffer *buffer)
	Fills the given buffer with a null-terminated ASCII set of bytes representing SDP data that is suitable for use with an RTSP-based system. More...
virtual int32_t	setForcedAudioCodec (ICodec::ID id)
	Forces the IContainer to assume all audio streams are encoded with the given audio codec when demuxing. More...
virtual int32_t	setForcedVideoCodec (ICodec::ID id)
	Forces the IContainer to assume all video streams are encoded with the given video codec when demuxing. More...
virtual int32_t	setForcedSubtitleCodec (ICodec::ID id)
	Forces the IContainer to assume all subtitle streams are encoded with the given subtitle codec when demuxing. More...
virtual int32_t	seekKeyFrame (int32_t streamIndex, int64_t minTimeStamp, int64_t targetTimeStamp, int64_t maxTimeStamp, int32_t flags)
	EXPERIMENTAL - Seeks to timestamp in the container. More...
virtual Stream *	addNewStream (ICodec::ID id)
	Add a new stream that will use the given codec. More...
virtual Stream *	addNewStream (ICodec *codec)
	Add a new stream that will use the given codec. More...
virtual Stream *	addNewStream (IStreamCoder *coder)
	Add a new stream that will use the given StreamCoder. More...
virtual ContainerFormat *	getFormat ()
	Get the IContainerFormat that is used by this IContainer. More...
virtual int32_t	setFormat (IContainerFormat *format)
	Set the IContainerFormat to use with this IContainer. More...
virtual int32_t	setProperty (IMetaData *valuesToSet, IMetaData *valuesNotFound)
virtual int32_t	open (const char *url, Type type, IContainerFormat *pContainerFormat, bool, bool, IMetaData *, IMetaData *)
	Open this container and make it ready for reading or writing, optionally reading as far into the container as necessary to find all streams. More...
int32_t	setCustomIOProtocol (io::URLProtocolHandlerFactory *factory)
Public Member Functions inherited from com::avpkit::core::IContainer
virtual int32_t	seekKeyFrame (int32_t streamIndex, int64_t timestamp, int32_t flags)=0
	Seeks to the key frame at (or the first one after) the given timestamp. 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 Container *	make (IContainerFormat *format)
Static Public Member Functions inherited from com::avpkit::core::IContainer
static IContainer *	make ()
	Create a new container object. More...
static IContainer *	make (IContainerFormat *format)
	Create a new IContainer and call setFormat(IContainerFormat) on it immediately. More...

Additional Inherited Members
Public Types inherited from com::avpkit::core::IContainer
enum	Type { READ , WRITE }
	The different types of Containers AVPKit supports. More...
enum	Flags {   FLAG_GENPTS =0x0001 , FLAG_IGNIDX =0x0002 , FLAG_NONBLOCK =0x0004 , FLAG_IGNDTS =0x0008 ,   FLAG_NOFILLIN =0x0010 , FLAG_NOPARSE =0x0020 , FLAG_NOBUFFER =0x0040 , FLAG_CUSTOM_IO =0x0080 ,   FLAG_DISCARD_CORRUPT =0x0100 , FLAG_FLUSH_PACKETS =0x0200 , FLAG_BITEXACT =0x0400 , FLAG_MP4A_LATM =0x8000 ,   FLAG_SORT_DTS =0x10000 , FLAG_PRIV_OPT =0x20000 , FLAG_KEEP_SIDE_DATA =0x40000 , FLAG_FAST_SEEK =0x80000 ,   FLAG_SHORTEST =0x100000 , FLAG_AUTO_BSF =0x200000 }
typedef enum com::avpkit::core::IContainer::Type	Type
	The different types of Containers AVPKit supports. More...
typedef enum com::avpkit::core::IContainer::Flags	Flags
Static Public Attributes inherited from com::avpkit::core::IContainer
static const int32_t	SEEK_FLAG_BACKWARDS =1
	Flag; Seek backwards.
static const int32_t	SEEK_FLAG_BYTE =2
	Flag; Use bytes instead of time stamps for seeking.
static const int32_t	SEEK_FLAG_ANY =4
	Flag; Seek to any frame, even non-keyframes.
static const int32_t	SEEK_FLAG_FRAME =8
	Flag; Seek based on frame number instead of time stamps.
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 40 of file Container.h.

Member Function Documentation

addNewStream() [1/4]

Stream * com::avpkit::core::Container::addNewStream ( ICodec *  codec )

virtual

Add a new stream that will use the given codec.

Parameters

codec

The codec that will be used to insert packets.

Returns

An IStream for the new stream on success, or null on failure.

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 1508 of file Container.cpp.

  {
    Codec* codec = static_cast<Codec*>(aCodec);
    Stream *retval=0;
    try
    {
      const AVCodec* avCodec = codec ? codec->getAVCodec() : 0;
 
      if (!mFormatContext)
        throw std::runtime_error("no format context");
 
      if (!isOpened())
        throw std::runtime_error("attempted to add stream to "
            " unopened container");
 
      if (isHeaderWritten())
        throw std::runtime_error("cannot add stream after header is written"
            );
 
      AVStream * stream=0;
      stream = avformat_new_stream(mFormatContext, avCodec);
 
 
      if (!stream)
        throw std::runtime_error("could not allocate stream");
 
      RefPointer<Stream>* p = new RefPointer<Stream>(
          Stream::make(this, stream, IStream::OUTBOUND, avCodec)
      );
      if (!p) throw std::bad_alloc();
      if (*p)
      {
        mStreams.push_back(p);
        mNumStreams++;
        retval = p->get(); // acquire for caller
      }
      else
      {
        delete p;
        throw std::bad_alloc();
      }
    } catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

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

addNewStream() [2/4]

Stream * com::avpkit::core::Container::addNewStream ( ICodec::ID  id )

virtual

Add a new stream that will use the given codec.

Parameters

id	The id for the codec used to insert packets. If you are adding an arbitrary data stream, use ICodec.ID#AV_CODEC_ID_NONE, otherwise use the ID of the code type you plan to use.

Returns

An IStream for the new stream on success, or null on failure.

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 1485 of file Container.cpp.

  {
    Stream* retval=0;
    RefPointer<ICodec> codec;
    try
    {
      codec = ICodec::findEncodingCodec(id);
 
      if (!codec) {
        VS_LOG_ERROR("Could not find encoding codec: %d", id);
        throw std::runtime_error("Could not find encoding codec");
      }
      retval = addNewStream(codec.value());
    }
    catch (std::exception & e)
    {
      VS_LOG_DEBUG("Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

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

addNewStream() [3/4]

Stream * com::avpkit::core::Container::addNewStream ( int32_t  id )

virtual

Deprecated:

Use addNewStream(ICodec.ID) instead.

Creates a new stream in this container and returns it.

Parameters

id	A format-dependent id for this stream.

Returns

A new stream.

Implements com::avpkit::core::IContainer.

Definition at line 1587 of file Container.cpp.

  {
    Stream *retval=0;
    retval = addNewStream((ICodec*)0);
    if (retval)
      retval->setId(id);
    return retval;
  }

References com::avpkit::core::Stream::setId().

addNewStream() [4/4]

Stream * com::avpkit::core::Container::addNewStream ( IStreamCoder *  coder )

virtual

Add a new stream that will use the given StreamCoder.

The StreamCoder passed in MUST contain the IStreamCoder#getExtraData that was used to encode the packet.

Parameters

coder

The IStreamCoder that contains the meta-information needed for decoding the packets that will be muexed into this stream.

Returns

An IStream for the new stream on success, or null on failure.

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 1558 of file Container.cpp.

  {
    Stream *retval=0;
    StreamCoder * coder = static_cast<StreamCoder*>(aCoder);
    RefPointer<ICodec> codec;
    try
    {
      if (!coder)
        throw std::runtime_error("must pass non-null coder");
      codec = coder->getCodec();
      if (!codec)
        throw std::runtime_error("StreamCoder has no attached Codec");
 
      retval = this->addNewStream(codec.value());
      if (retval)
      {
        if (retval->setStreamCoder(coder) < 0)
          throw std::runtime_error("Could not set StreamCoder on stream");
      }
 
    } catch (std::exception & e)
    {
      VS_LOG_DEBUG("addNewStream Error: %s", e.what());
      VS_REF_RELEASE(retval);
    }
    return retval;
  }

References com::avpkit::core::StreamCoder::getCodec(), com::avpkit::core::Stream::setStreamCoder(), and com::avpkit::ferry::RefPointer< T >::value().

canStreamsBeAddedDynamically()

bool com::avpkit::core::Container::canStreamsBeAddedDynamically ( )

virtual

Can streams be added dynamically to this container?

Returns

true if streams can be added dynamically

Implements com::avpkit::core::IContainer.

Definition at line 1379 of file Container.cpp.

  {
    if (mFormatContext)
      return mFormatContext->ctx_flags & AVFMTCTX_NOHEADER;
    return false;
  }

close()

int32_t com::avpkit::core::Container::close ( bool  dangling )

virtual

Close the container.

open() must have been called first, or else an error is returned.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

If this method exits because of an interruption, all resources will be closed anyway.

Returns

>= 0 on success; < 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 649 of file Container.cpp.

  {
    int32_t retval = -1;
    mMetaData.reset();
 
    if (mFormatContext && mIsOpened)
    {
      VS_ASSERT(mNumStreams == mStreams.size(),
          "unexpected number of streams");
 
      if (mNeedTrailerWrite)
      {
        if (dangling)
          // don't actually write the trailer when dangling; we could
          // block on that, which could occur inside a finalizer thread
          // or other unexpected thread
          VS_LOG_ERROR("Disposing of dangling container but could not write trailer");
        else {
          VS_LOG_DEBUG("Writing dangling trailer");
          (void) this->writeTrailer();
        }
        mNeedTrailerWrite = false;
      }
      mOpenCoders.clear();
 
      while(mStreams.size() > 0)
      {
        RefPointer<Stream> * stream=mStreams.back();
        
        VS_ASSERT(stream && *stream, "no stream?");
        if (stream && *stream) {
          (*stream)->containerClosed(this);
          delete stream;
        }      
        mStreams.pop_back();
      }
      mNumStreams = 0;
 
      // we need to remember the avio context
      AVIOContext* pb = mFormatContext->pb;
 
      if (this->getType() == READ)
        avformat_close_input(&mFormatContext);
 
      if (mCustomIOHandler) {
        retval = mCustomIOHandler->url_close();
        if (!mFormatContext) {
          if (pb)
            av_freep(&pb->buffer);
          av_free(pb);
        }
      } else if (this->getType() != READ)
        retval = avio_close(pb);
      else
        retval = 0;
 
      resetContext();
      mIsOpened = false;
      mIsMetaDataQueried=false;
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

createSDPData()

int32_t com::avpkit::core::Container::createSDPData ( com::avpkit::ferry::IBuffer *  buffer )

virtual

Fills the given buffer with a null-terminated ASCII set of bytes representing SDP data that is suitable for use with an RTSP-based system.

This method only works if AVPKit is linking against a version of FFmpeg that supports RTSP.

Parameters

buffer

the com.avpkit.ferry.IBuffer object to fill with data.

Returns

the number of bytes written, including the terminating 0 byte, or < 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1413 of file Container.cpp.

  {
    if (!mFormatContext)
      return -1;
    if (!buffer)
      return -1;
    
    int32_t bufSize = buffer->getBufferSize();
    if (bufSize <= 0)
      return -1;
    
    char* bytes = static_cast<char*>(buffer->getBytes(0, bufSize));
    if (!bytes)
      return -1;
    
    bytes[0] = 0;
    // null terminate the buffer to ensure strlen below doesn't
    // overrun
    bytes[bufSize-1]=0;
    int32_t ret = av_sdp_create(&mFormatContext, 1, bytes, bufSize-1);
 
    if (ret < 0)
    {
      VS_LOG_INFO("Could not create SDP file: %d", ret);
      return ret;
    }
    // Otherwise, we have to figure out the length, including the 
    // terminating null
    ret = strlen(bytes)+1;
    return ret;
  }

References com::avpkit::ferry::IBuffer::getBufferSize(), and com::avpkit::ferry::IBuffer::getBytes().

flushPackets()

int32_t com::avpkit::core::Container::flushPackets ( )

virtual

Flush all packets to output.

Will only work on IContainer.Type#WRITE containers.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Returns

>= 0 on success; <0 on error

Implements com::avpkit::core::IContainer.

Definition at line 1299 of file Container.cpp.

  {
    int32_t retval = -1;
    try
    {
      if (this->getType() != WRITE)
        throw std::runtime_error("cannot write packet to read only container");
 
      if (!mFormatContext)
        throw std::runtime_error("no format context allocated");
 
      // Do the flush
      if (!(mFormatContext->oformat->flags & AVFMT_NOFILE)) {
        avio_flush(mFormatContext->pb);
      }
      retval = 0;
    }
    catch (std::exception & e)
    {
      VS_LOG_ERROR("Error: %s", e.what());
      retval = -1;
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

getBitRate()

int32_t com::avpkit::core::Container::getBitRate ( )

virtual

Get the calculated overall bit rate of this file.

This will only return a valid value if the container is non-streamed and supports seek.

Returns

The overall bit rate in bytes per second, or <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1113 of file Container.cpp.

  {
    int32_t retval = -1;
    queryStreamMetaData();
    if (mFormatContext)
      retval = mFormatContext->bit_rate;
    return retval;
  }

getContainerFormat()

IContainerFormat * com::avpkit::core::Container::getContainerFormat ( )

virtual

Returns the IContainerFormat object being used for this IContainer, or null if the IContainer doesn't yet know.

Returns

the IContainerFormat object, or null.

Implements com::avpkit::core::IContainer.

Definition at line 405 of file Container.cpp.

  {
    ContainerFormat *retval = ContainerFormat::make();
    if (retval)
    {
      if (mFormatContext)
      {
        if (mFormatContext->iformat)
          retval->setInputFormat(mFormatContext->iformat);
        if (mFormatContext->oformat)
          retval->setOutputFormat(mFormatContext->oformat);
      }
    }
    return retval;
  }

References com::avpkit::core::ContainerFormat::setInputFormat(), and com::avpkit::core::ContainerFormat::setOutputFormat().

getDuration()

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

virtual

Gets the duration, if known, of this container.

This will only work for non-streamable containers where IContainer can calculate the container size.

Returns

The duration, or Global#NO_PTS if not known.

Implements com::avpkit::core::IContainer.

Definition at line 1077 of file Container.cpp.

  {
    int64_t retval = Global::NO_PTS;
    queryStreamMetaData();
    if (mFormatContext)
      retval = mFormatContext->duration;
    return retval;
  }

getFileSize()

int64_t com::avpkit::core::Container::getFileSize ( )

virtual

Get the file size in bytes of this container.

This will only return a valid value if the container is non-streamed and supports seek.

Returns

The file size in bytes, or <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1097 of file Container.cpp.

  {
    int64_t retval = -1;
    queryStreamMetaData();
    if (mFormatContext) {
      if (mFormatContext->iformat && mFormatContext->iformat->flags & AVFMT_NOFILE)
        retval = 0;
      else {
        retval = avio_size(mFormatContext->pb);
        retval = FFMAX(0, retval);
      }
    }
    return retval;
  }

getFlag()

bool com::avpkit::core::Container::getFlag ( Flags  flag )

virtual

Get the setting for the specified flag.

Parameters

flag	The flag you want to find the setting for

Returns

0 for false; non-zero for true

Implements com::avpkit::core::IContainer.

Definition at line 1267 of file Container.cpp.

  {
    bool result = false;
    if (mFormatContext)
      result = mFormatContext->flags& flag;
    return result;
  }

getFlags()

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

virtual

Get the flags associated with this object.

Returns

The (compacted) value of all flags set.

Implements com::avpkit::core::IContainer.

Definition at line 1248 of file Container.cpp.

  {
    int32_t flags = (mFormatContext ? mFormatContext->flags : 0);
    // remove custom io if set
    flags &= ~(AVFMT_FLAG_CUSTOM_IO);
    return flags;
  }

getFormat()

virtual ContainerFormat* com::avpkit::core::Container::getFormat ( )

inlinevirtual

Get the IContainerFormat that is used by this IContainer.

Returns

The format, or null if none is set yet.

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 141 of file Container.h.

{ return mFormat.get(); };

getInputBufferLength()

int32_t com::avpkit::core::Container::getInputBufferLength ( )

virtual

Return the input buffer length.

Returns

The input buffer length AVPKit's told FFMPEG to assume. 0 means FFMPEG should choose it's own size (and it'll probably be 32768).

Implements com::avpkit::core::IContainer.

Definition at line 252 of file Container.cpp.

  {
    return mInputBufferLength;
  }

getMaxDelay()

int32_t com::avpkit::core::Container::getMaxDelay ( )

virtual

Gets the AVFormatContext.max_delay property if possible.

Returns

The max delay, error code otherwise.

Since

4.0

Implements com::avpkit::core::IContainer.

Definition at line 1153 of file Container.cpp.

  {
    int32_t retval = -1;
    if (mFormatContext)
      retval = mFormatContext->max_delay;
    return retval;
  }

getMetaData()

IMetaData * com::avpkit::core::Container::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.

Implements com::avpkit::core::IContainer.

Definition at line 1387 of file Container.cpp.

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

getNumProperties()

int32_t com::avpkit::core::Container::getNumProperties ( )

virtual

Returns the total number of settable properties on this object.

Returns

total number of options (not including constant definitions)

Implements com::avpkit::core::IContainer.

Definition at line 1162 of file Container.cpp.

  {
    return Property::getNumProperties(mFormatContext);
  }

getNumStreams()

int32_t com::avpkit::core::Container::getNumStreams ( )

virtual

The number of streams in this container.

If opened in IContainer.Type#READ mode, this will query the stream and find out how many streams are in it.

If opened in IContainer.Type#WRITE mode, this will return the number of streams the caller has added to date.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Returns

The number of streams in this container.

Implements com::avpkit::core::IContainer.

Definition at line 629 of file Container.cpp.

  {
    int32_t retval = 0;
    if (mFormatContext)
    {
      if (mFormatContext->nb_streams != mNumStreams)
        setupAllInputStreams();
      retval = mFormatContext->nb_streams;
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

getPreload()

int32_t com::avpkit::core::Container::getPreload ( )

virtual

@Deprecated use getPropertyAsLong instead.

The amount container will attemtp to preload.

Returns

The amount to preload, error code otherwise.

Implements com::avpkit::core::IContainer.

Definition at line 1130 of file Container.cpp.

  {
    VS_LOG_WARN("Deprecated and will be removed; does nothing now.");
    return -1;
  }

getPropertyAsBoolean()

bool com::avpkit::core::Container::getPropertyAsBoolean ( const char *  name )

virtual

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

Parameters

name	name of option

Returns

boolean value of property, or false on error.

Implements com::avpkit::core::IContainer.

Definition at line 1242 of file Container.cpp.

  {
    return Property::getPropertyAsBoolean(mFormatContext, aName);
  }

getPropertyAsDouble()

double com::avpkit::core::Container::getPropertyAsDouble ( const char *  name )

virtual

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

Parameters

name	name of option

Returns

double value of property, or 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1224 of file Container.cpp.

  {
    return Property::getPropertyAsDouble(mFormatContext, aName);
  }

getPropertyAsLong()

int64_t com::avpkit::core::Container::getPropertyAsLong ( const char *  name )

virtual

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

Parameters

name	name of option

Returns

long value of property, or 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1230 of file Container.cpp.

  {
    return Property::getPropertyAsLong(mFormatContext, aName);
  }

getPropertyAsRational()

IRational * com::avpkit::core::Container::getPropertyAsRational ( const char *  name )

virtual

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

Parameters

name	name of option

Returns

long value of property, or 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1236 of file Container.cpp.

  {
    return Property::getPropertyAsRational(mFormatContext, aName);
  }

getPropertyAsString()

char * com::avpkit::core::Container::getPropertyAsString ( const char *  name )

virtual

Gets a property on this Object.

Note for C++ callers; you must free the returned array with delete[] in order to avoid a memory leak. If you call from Java or any other language, you don't need to worry about this.

Parameters

name	property name

Returns

an string copy of the option value, or null if the option doesn't exist.

Implements com::avpkit::core::IContainer.

Definition at line 1218 of file Container.cpp.

  {
    return Property::getPropertyAsString(mFormatContext, aName);
  }

getPropertyMetaData() [1/2]

IProperty * com::avpkit::core::Container::getPropertyMetaData ( const char *  name )

virtual

Returns the name of the numbered property.

Parameters

name	The property name.

Returns

an IProperty value for this properties meta-data

Implements com::avpkit::core::IContainer.

Definition at line 1174 of file Container.cpp.

  {
    return Property::getPropertyMetaData(mFormatContext, name);
  }

getPropertyMetaData() [2/2]

IProperty * com::avpkit::core::Container::getPropertyMetaData ( int32_t  propertyNo )

virtual

Returns the name of the numbered property.

Parameters

propertyNo

The property number in the options list.

Returns

an IProperty value for this properties meta-data

Implements com::avpkit::core::IContainer.

Definition at line 1168 of file Container.cpp.

  {
    return Property::getPropertyMetaData(mFormatContext, propertyNo);
  }

getReadRetryCount()

int32_t com::avpkit::core::Container::getReadRetryCount ( )

virtual

Get the number of times IContainer#readNextPacket(IPacket) will retry a read if it gets a IError.Type#ERROR_AGAIN value back.

Defaults to 1 times. <0 means it will keep retrying indefinitely.

Returns

the read retry count

Implements com::avpkit::core::IContainer.

Definition at line 1326 of file Container.cpp.

  {
    return mReadRetryCount;
  }

getStandardsCompliance()

IStreamCoder::CodecStandardsCompliance com::avpkit::core::Container::getStandardsCompliance ( )

virtual

Gets the current level of standards compliance.

Returns

The level of standards compliance.

See also

CodecStandardsCompliance

Since

5.7

Implements com::avpkit::core::IContainer.

Definition at line 387 of file Container.cpp.

  {
      return mFormatContext ? (IStreamCoder::CodecStandardsCompliance) mFormatContext->strict_std_compliance : IStreamCoder::COMPLIANCE_NORMAL;
  }

getStartTime()

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

virtual

Get the starting timestamp in microseconds of the first packet of the earliest stream in this container.

This will only return value values either either (a) for non-streamable containers where IContainer can calculate the container size or (b) after IContainer has actually read the first packet from a streamable source.

Returns

The starting timestamp in microseconds, or Global#NO_PTS if not known.

Implements com::avpkit::core::IContainer.

Definition at line 1087 of file Container.cpp.

  {
    int64_t retval = Global::NO_PTS;
    queryStreamMetaData();
    if (mFormatContext)
      retval = mFormatContext->start_time;
    return retval;
  }

getStream()

Stream * com::avpkit::core::Container::getStream ( int32_t  streamIndex )

virtual

Get the stream at the given position.

Parameters

streamIndex

the index of this stream in the container

Returns

The stream at that position in the container, or null if none there.

Implements com::avpkit::core::IContainer.

Definition at line 714 of file Container.cpp.

  {
    Stream *retval = 0;
    if (mFormatContext)
    {
      if (mFormatContext->nb_streams != mNumStreams)
        setupAllInputStreams();
 
      if (position < mNumStreams)
      {
        // will acquire for caller.
        retval = (*mStreams.at(position)).get();
      }
    }
    return retval;
  }

getType()

IContainer::Type com::avpkit::core::Container::getType ( )

virtual

Find out the type of this container.

Returns

The Type of this container.
IContainer.Type#READ if not yet opened.

Implements com::avpkit::core::IContainer.

Definition at line 622 of file Container.cpp.

  {
    return (!mFormatContext ? READ :
        (mFormatContext->oformat ? WRITE: READ));
  }

getURL()

const char * com::avpkit::core::Container::getURL ( )

virtual

Get the URL the IContainer was opened with.

May return null if unknown.

Returns

the URL opened, or null.

Implements com::avpkit::core::IContainer.

Definition at line 1293 of file Container.cpp.

  {
    return mFormatContext && *mFormatContext->filename ? mFormatContext->filename : 0;
  }

isHeaderWritten()

bool com::avpkit::core::Container::isHeaderWritten ( )

virtual

Has a header been successfully written?

Returns

true if yes, false if no.

Implements com::avpkit::core::IContainer.

Definition at line 264 of file Container.cpp.

  {
    return (mIsOpened && mNeedTrailerWrite);
  }

isOpened()

bool com::avpkit::core::Container::isOpened ( )

virtual

Is this container opened?

Returns

true if opened; false if not.

Implements com::avpkit::core::IContainer.

Definition at line 258 of file Container.cpp.

  {
    return mIsOpened;
  }

open() [1/3]

int32_t com::avpkit::core::Container::open ( const char *  url, Type  type, IContainerFormat *  pContainerFormat  )

virtual

Open this container and make it ready for reading or writing.

The caller must call close() when done, but if not, the IContainer will eventually close them later but warn to the logging system.

This just forwards to open(String, Type, IContainerFormat, boolean, boolean) passing false for aStreamsCanBeAddedDynamically, and true for aLookForAllStreams.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

url	The resource to open; The format of this string is any url that FFMPEG supports (including additional protocols if added through the core.io library).
type	The type of this container.
pContainerFormat	A pointer to a ContainerFormat object specifying the format of this container, or 0 (NULL) if you want us to guess.

Returns

>= 0 on success; < 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 270 of file Container.cpp.

  {
    return open(url, type, pContainerFormat, false, true);
  }

open() [2/3]

int32_t com::avpkit::core::Container::open ( const char *  url, Type  type, IContainerFormat *  pContainerFormat, bool  aStreamsCanBeAddedDynamically, bool  aQueryStreamMetaData  )

virtual

Open this container and make it ready for reading or writing, optionally reading as far into the container as necessary to find all streams.

The caller must call close() when done, but if not, the IContainer will eventually close them later but warn to the logging system.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

url	The resource to open; The format of this string is any url that FFMPEG supports (including additional protocols if added through the core.io library).
type	The type of this container.
pContainerFormat	A pointer to a ContainerFormat object specifying the format of this container, or 0 (NULL) if you want us to guess.
aStreamsCanBeAddedDynamically	If true, open() will expect that new streams can be added at any time, even after the format header has been read.
aQueryStreamMetaData	If true, open() will call queryStreamMetaData() on this container, which will potentially block until it has ready enough data to find all streams in a container. If false, it will only block to read a minimal header for this container format.

Returns

>= 0 on success; < 0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 277 of file Container.cpp.

  {
    return open(url, type, pContainerFormat,
      aStreamsCanBeAddedDynamically, aLookForAllStreams,
      NULL, NULL);
  }

open() [3/3]

int32_t com::avpkit::core::Container::open ( const char *  url, Type  type, IContainerFormat *  containerFormat, bool  streamsCanBeAddedDynamically, bool  queryStreamMetaData, IMetaData *  options, IMetaData *  optionsNotSet  )

virtual

Open this container and make it ready for reading or writing, optionally reading as far into the container as necessary to find all streams.

The caller must call close() when done, but if not, the IContainer will eventually close them later but warn to the logging system.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

url	The resource to open; The format of this string is any url that FFMPEG supports (including additional protocols if added through the core.io library).
type	The type of this container.
containerFormat	A pointer to a ContainerFormat object specifying the format of this container, or 0 (NULL) if you want us to guess.
streamsCanBeAddedDynamically	If true, open() will expect that new streams can be added at any time, even after the format header has been read.
queryStreamMetaData	If true, open() will call queryStreamMetaData() on this container, which will potentially block until it has ready enough data to find all streams in a container. If false, it will only block to read a minimal header for this container format.
options	If not null, a set of key-value pairs that will be set on the container immediately the format is determined. Some options cannot be set (especially for input containers) until the system has a chance to parse what data is in the file.
optionsNotSet	If not null, on return this IMetaData object will be cleared out, and replace with any key/value pairs that were in options but could not be set on this IContainer.

Returns

>= 0 on success; < 0 on error.

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 287 of file Container.cpp.

  {
    AVDictionary *tmp= NULL;
 
    int32_t retval = -1;
 
    // reset if an open is called before a close.
    reset();
    if (!mFormatContext)
    {
      // always reset to a new one
      mFormatContext = avformat_alloc_context();
      if (!mFormatContext)
        throw std::bad_alloc();
    }
 
    if (pContainerFormat)
      setFormat(pContainerFormat);
    
    // Set up thread interrupt handling.
    mFormatContext->interrupt_callback.callback = Global::avioInterruptCB;
    mFormatContext->interrupt_callback.opaque = this;
 
    // Let's check for custom IO
    mCustomIOHandler = URLProtocolManager::findHandler(
        url,
        type == WRITE ? URLProtocolHandler::URL_WRONLY_MODE : URLProtocolHandler::URL_RDONLY_MODE,
            0);
    if (mCustomIOHandler) {
      if (mInputBufferLength <= 0)
        // default to 4k
        mInputBufferLength = 4096;
      // free and realloc the input buffer length
      uint8_t* buffer = (uint8_t*)av_malloc(mInputBufferLength);
      if (!buffer)
        throw std::bad_alloc();
 
      // we will allocate ourselves an io context; ownership of buffer passes here.
      mFormatContext->pb = avio_alloc_context(
          buffer,
          mInputBufferLength,
          type == WRITE ? 1 : 0,
          mCustomIOHandler,
          Container_url_read,
          Container_url_write,
          mCustomIOHandler->url_seekflags(url,0) == URLProtocolHandler::SK_NOT_SEEKABLE ? NULL : Container_url_seek);//Container_url_seek is necessary for some media (mov format)
      if (!mFormatContext->pb)
        av_freep(&buffer);
    }
    // set up our options
    if (aOptions) {
      MetaData* options = static_cast<MetaData*>(aOptions);
      if (!options)
        throw std::runtime_error("um, this shouldn't ever happen");
      // make a copy of the data returned
      av_dict_copy(&tmp, options->getDictionary(), 0);
    }
    if (url && *url)
    {
      if (type == WRITE)
      {
        retval = openOutputURL(url,
            aStreamsCanBeAddedDynamically, &tmp);
      } else if (type == READ)
      {
        retval = openInputURL(url,
            aStreamsCanBeAddedDynamically, aLookForAllStreams, &tmp);
      }
      else
      {
        VS_ASSERT(false, "Invalid type for open");
        retval = -1;
      }
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    if (aUnsetOptions) {
      MetaData* unsetOptions = static_cast<MetaData*>(aUnsetOptions);
      if (!unsetOptions)
        throw std::runtime_error("a little part of me just died inside");
      unsetOptions->copy(tmp);
    }
    if (tmp)
      av_dict_free(&tmp);
    return retval;
  }

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

queryStreamMetaData()

int32_t com::avpkit::core::Container::queryStreamMetaData ( )

virtual

Attempts to read all the meta data in this stream, potentially by reading ahead and decoding packets.

Any packets this method reads ahead will be cached and correctly returned when you read packets, but this method can be non-blocking potentially until end of container to get all meta data. Take care when you call it.

After this method is called, other meta data methods like getDuration() should work.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Returns

>= 0 on success; <0 on failure.

Implements com::avpkit::core::IContainer.

Definition at line 999 of file Container.cpp.

  {
    int retval = -1;
    if (mIsOpened)
    {
      if (!mIsMetaDataQueried)
      {
        retval = avformat_find_stream_info(mFormatContext, NULL);
        // for shits and giggles, dump the ffmpeg output
        //av_dump_format(mFormatContext, 0, (mFormatContext ? mFormatContext->filename :0), 0);
        mIsMetaDataQueried = true;
      } else {
        retval = 0;
      }
 
      if (retval >= 0 && mFormatContext->nb_streams > 0)
      {
        setupAllInputStreams();
      } else {
        VS_LOG_WARN("Could not find streams in input container");
      }
    }
    else
    {
      VS_LOG_WARN("Attempt to queryStreamMetaData but container is not open");
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

readNextPacket()

int32_t com::avpkit::core::Container::readNextPacket ( IPacket *  packet )

virtual

Reads the next packet into the IPacket.

This method will release any buffers currently held by this packet and allocate new ones.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

packet

[In/Out] The packet the IContainer will read into.

Returns

0 if successful, or <0 if not.

Implements com::avpkit::core::IContainer.

Definition at line 732 of file Container.cpp.

  {
    int32_t retval = -1;
    Packet* pkt = static_cast<Packet*>(ipkt);
    if (mFormatContext && pkt)
    {
    
    bool useBsf = false;
                
//      pkt->reset();
      int32_t numReads=0;
      do
      {
        retval = av_read_frame(mFormatContext,
            mPacket);
        ++numReads;
        
        if (retval == 0) {
            Stream* stream = this->getStream(mPacket->stream_index);
            AVBSFContext* bsfContext = stream->getAVBsfContext();
            VS_REF_RELEASE(stream);
            if (bsfContext) {
                useBsf = true;
                if (retval = av_bsf_send_packet(bsfContext, mPacket) == 0) {
                    retval = av_bsf_receive_packet(bsfContext, mBsfPacket);
                }
            } 
        }
      }
      while (retval == AVERROR(EAGAIN) &&
          (mReadRetryCount < 0 || numReads <= mReadRetryCount));
 
      if (retval >= 0) 
        if (!useBsf) {
          pkt->wrapAVPacket(mPacket);    
        } else {
          pkt->wrapAVPacket(mBsfPacket);
        }
        av_packet_unref(mPacket);
        av_packet_unref(mBsfPacket);
 
//      // Get a pointer to the wrapped packet
//      packet = pkt->getAVPacket();
      // and dump it's contents
      VS_LOG_TRACE("read-packet: %lld, %lld, %d, %d, %d, %lld, %lld: %p",
          pkt->getDts(),
          pkt->getPts(),
          pkt->getFlags(),
          pkt->getStreamIndex(),
          pkt->getSize(),
          pkt->getDuration(),
          pkt->getPosition(),
          pkt->getAVPacket()->data);
      
      // and let's try to set the packet time base if known
      if (pkt->getStreamIndex() >= 0)
      {
        RefPointer<IStream> stream = this->getStream(pkt->getStreamIndex());
        if (stream)
        {
          RefPointer<IRational> streamBase = stream->getTimeBase();
          if (streamBase)
          {
            pkt->setTimeBase(streamBase.value());
          }
        }
      }
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

References com::avpkit::core::Packet::getDts(), com::avpkit::core::Packet::getDuration(), com::avpkit::core::Packet::getFlags(), com::avpkit::core::Packet::getPosition(), com::avpkit::core::Packet::getPts(), com::avpkit::core::Packet::getSize(), com::avpkit::core::Packet::getStreamIndex(), com::avpkit::core::Packet::setTimeBase(), and com::avpkit::ferry::RefPointer< T >::value().

seekKeyFrame()

int32_t com::avpkit::core::Container::seekKeyFrame ( int32_t  streamIndex, int64_t  minTimeStamp, int64_t  targetTimeStamp, int64_t  maxTimeStamp, int32_t  flags  )

virtual

EXPERIMENTAL - Seeks to timestamp in the container.

Seeking will be done so that the point from which all active streams can be presented successfully will be closest to targetTimeStamp and within minTimeStamp/maxTimeStamp.

If flags contain SEEK_FLAG_BYTE, then all time stamps are in bytes and are the file position (this may not be supported by all demuxers). If flags contain SEEK_FLAG_FRAME, then all time stamps are in frames in the stream with streamIndex (this may not be supported by all demuxers). Otherwise all time stamps are in units of the stream selected by stream_index or if stream_index is -1, in microseconds. If flags contain SEEK_FLAG_ANY, then non-keyframes are treated as keyframes (this may not be supported by all demuxers). If flags contain SEEK_FLAG_BACKWARDS, then we will attempt to search backwards in the container (this may not be supported by all demuxers and file protocols).

This is part of the new seek API which is still under construction. It may change in future AVPKit versions.

Parameters

streamIndex	index of the stream which is used as time base reference
minTimeStamp	smallest acceptable time stamp.
targetTimeStamp	target time stamp.
maxTimeStamp	largest acceptable time stamp.
flags	A bitmask of the SEEK_FLAG_* flags, or 0 to turn all flags off.

Returns

>=0 on success, error code otherwise

Since

3.4

Implements com::avpkit::core::IContainer.

Definition at line 1051 of file Container.cpp.

  {
    int32_t retval = -1;
 
    if (mIsOpened)
    {
      if (streamIndex >= (int32_t)mNumStreams)
        VS_LOG_WARN("Attempt to seek on streamIndex %d but only %d streams known about in container",
            streamIndex, mNumStreams);
      else
        retval = avformat_seek_file(mFormatContext, streamIndex,
            minTimeStamp,
            targetTimeStamp,
            maxTimeStamp,
            flags);
    }
    else
    {
      VS_LOG_WARN("Attempt to seekKeyFrame but container is not open");
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

setFlag()

void com::avpkit::core::Container::setFlag ( Flags  flag, bool  value  )

virtual

Set the flag.

Parameters

flag	The flag to set
value	The value to set it to (true or false)

Implements com::avpkit::core::IContainer.

Definition at line 1276 of file Container.cpp.

  {
    if (mFormatContext)
    {
      if (value)
      {
        mFormatContext->flags |= flag;
      }
      else
      {
        mFormatContext->flags &= (~flag);
      }
    }
 
  }

setFlags()

void com::avpkit::core::Container::setFlags ( int32_t  newFlags )

virtual

Set the flags to use with this object.

All values must be ORed (|) together.

See also

Flags

Parameters

newFlags

The new set flags for this codec.

Implements com::avpkit::core::IContainer.

Definition at line 1257 of file Container.cpp.

  {
    if (mFormatContext) {
      mFormatContext->flags = newFlags;
      // force custom io
      mFormatContext->flags |= AVFMT_FLAG_CUSTOM_IO;
    }
  }

setForcedAudioCodec()

int32_t com::avpkit::core::Container::setForcedAudioCodec ( ICodec::ID  id )

virtual

Forces the IContainer to assume all audio streams are encoded with the given audio codec when demuxing.

Parameters

id	The codec id

Returns

< 0 on error (e.g. not an audio codec); >= 0 on success.

Since

3.3

Implements com::avpkit::core::IContainer.

Definition at line 1446 of file Container.cpp.

  {
    int32_t retval=-1;
    if (mFormatContext && id != ICodec::AV_CODEC_ID_NONE)
    {
      RefPointer<ICodec> codec = ICodec::findDecodingCodec(id);
      if (codec && codec->getType() == ICodec::CODEC_TYPE_AUDIO)
        mFormatContext->audio_codec_id = (enum AVCodecID) id;
    }
    return retval;
  }

setForcedSubtitleCodec()

int32_t com::avpkit::core::Container::setForcedSubtitleCodec ( ICodec::ID  id )

virtual

Forces the IContainer to assume all subtitle streams are encoded with the given subtitle codec when demuxing.

Parameters

id	The codec id

Returns

< 0 on error (e.g. not an subtitle codec); >= 0 on success.

Since

3.3

Implements com::avpkit::core::IContainer.

Definition at line 1472 of file Container.cpp.

  {
    int32_t retval=-1;
    if (mFormatContext && id != ICodec::AV_CODEC_ID_NONE)
    {
      RefPointer<ICodec> codec = ICodec::findDecodingCodec(id);
      if (codec && codec->getType() == ICodec::CODEC_TYPE_SUBTITLE)
        mFormatContext->subtitle_codec_id = (enum AVCodecID) id;
    }
    return retval;
  }

setForcedVideoCodec()

int32_t com::avpkit::core::Container::setForcedVideoCodec ( ICodec::ID  id )

virtual

Forces the IContainer to assume all video streams are encoded with the given video codec when demuxing.

Parameters

id	The codec id

Returns

< 0 on error (e.g. not an video codec); >= 0 on success.

Since

3.3

Implements com::avpkit::core::IContainer.

Definition at line 1459 of file Container.cpp.

  {
    int32_t retval=-1;
    if (mFormatContext && id != ICodec::AV_CODEC_ID_NONE)
    {
      RefPointer<ICodec> codec = ICodec::findDecodingCodec(id);
      if (codec && codec->getType() == ICodec::CODEC_TYPE_VIDEO)
        mFormatContext->video_codec_id = (enum AVCodecID) id;
    }
    return retval;
  }

setFormat()

int32_t com::avpkit::core::Container::setFormat ( IContainerFormat *  format )

virtual

Set the IContainerFormat to use with this IContainer.

If called when the IContainer is opened, or if previously called with a non-null value, an error is returned and no action is taken.

Parameters

format

The format to use return 0 on success; <0 on failure

Since

5.0

Implements com::avpkit::core::IContainer.

Definition at line 1338 of file Container.cpp.

  {
    int32_t retval = -1;
    ContainerFormat* format = static_cast<ContainerFormat*>(aFormat);
    try {
      if (!format)
        throw std::runtime_error("no format set");
 
      if (!mFormatContext)
        throw std::runtime_error("no underlying AVFormatContext");
      if (mFormatContext->iformat || mFormatContext->oformat)
        throw std::runtime_error("format already set on this IContainer; cannot be reset");
      if (mIsOpened)
        throw std::runtime_error("container already opened");
 
      AVOutputFormat* oformat = format->getOutputFormat();
      AVInputFormat* iformat = format->getInputFormat();
 
      if (!iformat && !oformat)
        throw std::runtime_error("no input or output format set");
 
      // iformat, if set, always wins
      if (iformat) {
        mFormatContext->iformat = iformat;
        mFormatContext->oformat = 0;
      } else {
        // throw away the old context and use the new to get the correct options set up
        resetContext();
        mFormatContext = 0;
        if (avformat_alloc_output_context2(&mFormatContext, oformat, 0, 0)<0)
          throw std::runtime_error("could not allocate output context");
      }
      mFormat.reset(format, true);
      retval = 0;
    } catch (std::exception &e)
    {
      retval = -1;
    }
    return retval;
  }

setInputBufferLength()

int32_t com::avpkit::core::Container::setInputBufferLength ( int32_t  size )

virtual

Set the buffer length AVPKit will suggest to FFMPEG for reading inputs.

If called when a IContainer is open, the call is ignored and -1 is returned.

Parameters

size	The suggested buffer size.

Returns

size on success; <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 236 of file Container.cpp.

  {
    int32_t retval = -1;
    if (mIsOpened)
    {
      VS_LOG_WARN("Attempting to set input buffer length while file is opened; ignoring");
    }
    else
    {
      mInputBufferLength = size;
      retval = size;
    }
    return retval;
  }

setMaxDelay()

int32_t com::avpkit::core::Container::setMaxDelay ( int32_t  maxdelay )

virtual

Sets the max delay for the AVFormatContext.max_delay property.

Parameters

maxdelay

maximum delay for container

Returns

>= 0 on success, error code otherwise

Since

4.0

Implements com::avpkit::core::IContainer.

Definition at line 1137 of file Container.cpp.

  {
    int32_t retval = -1;
    if (mIsOpened || !mFormatContext)
    {
      VS_LOG_WARN("Attempting to set max delay while file is opened; ignoring");
    }
    else
    {
      mFormatContext->max_delay = maxdelay;
      retval = maxdelay;
    }
    return retval;
  }

setMetaData()

void com::avpkit::core::Container::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()

Implements com::avpkit::core::IContainer.

Definition at line 1401 of file Container.cpp.

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

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

setPreload()

int32_t com::avpkit::core::Container::setPreload ( int32_t  preload )

virtual

@Deprecated use setProperty instead.

If the container has not already been opened, sets the AVFormatContext.preload property which can be useful in some circumstances such as when dealing with mpeg formats.

Parameters

preload

amount to preload

Returns

>= 0 on success, error code otherwise

Since

4.0

Implements com::avpkit::core::IContainer.

Definition at line 1123 of file Container.cpp.

  {
    VS_LOG_WARN("Deprecated and will be removed; does nothing now.");
    return -1;
  }

setProperty() [1/5]

int32_t com::avpkit::core::Container::setProperty ( const char *  name, bool  value  )

virtual

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

Parameters

name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1204 of file Container.cpp.

  {
    return Property::setProperty(mFormatContext, aName, aValue);
  }

setProperty() [2/5]

int32_t com::avpkit::core::Container::setProperty ( const char *  name, const char *  value  )

virtual

Sets a property on this Object.

All AVOptions supported by the underlying AVClass are supported.

Parameters

name	The property name. For example "b" for bit-rate.
value	The value of the property.

Returns

>= 0 if the property was successfully set; <0 on error

Implements com::avpkit::core::IContainer.

Definition at line 1186 of file Container.cpp.

  {
    return Property::setProperty(mFormatContext, aName, aValue);
  }

setProperty() [3/5]

int32_t com::avpkit::core::Container::setProperty ( const char *  name, double  value  )

virtual

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

Parameters

name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1192 of file Container.cpp.

  {
    return Property::setProperty(mFormatContext, aName, aValue);
  }

setProperty() [4/5]

int32_t com::avpkit::core::Container::setProperty ( const char *  name, int64_t  value  )

virtual

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

Parameters

name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1198 of file Container.cpp.

  {
    return Property::setProperty(mFormatContext, aName, aValue);
  }

setProperty() [5/5]

int32_t com::avpkit::core::Container::setProperty ( const char *  name, IRational *  value  )

virtual

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

Parameters

name	name of option
value	Value of option

Returns

>= 0 on success; <0 on error.

Implements com::avpkit::core::IContainer.

Definition at line 1211 of file Container.cpp.

  {
    return Property::setProperty(mFormatContext, aName, aValue);
  }

setReadRetryCount()

void com::avpkit::core::Container::setReadRetryCount ( int32_t  count )

virtual

Sets the read retry count.

See also

getReadRetryCount()

Parameters

count

The read retry count. <0 means keep trying.

Implements com::avpkit::core::IContainer.

Definition at line 1332 of file Container.cpp.

  {
    mReadRetryCount = aCount;
  }

setStandardsCompliance()

int32_t com::avpkit::core::Container::setStandardsCompliance ( IStreamCoder::CodecStandardsCompliance  compliance )

virtual

Set the level of standards compliance.

Only paid attention to before the code is opened.

Parameters

compliance

The desired compliance level to set

Returns

0 on success; non-zero on failure

See also

CodecStandardsCompliance

Since

5.7

Implements com::avpkit::core::IContainer.

Definition at line 393 of file Container.cpp.

  {
      if (mFormatContext)
      {
          mFormatContext->strict_std_compliance = compliance;
          return 0;
      }
      return -1;
  }

writeHeader()

int32_t com::avpkit::core::Container::writeHeader ( )

virtual

Adds a header, if needed, for this container.

Call this AFTER you've added all streams you want to add, opened all IStreamCoders for those streams (with proper configuration) and before you write the first frame. If you attempt to write a header but haven't opened all codecs, this method will log a warning, and your output file will likely be corrupt.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Returns

0 if successful. < 0 if not. Always -1 if this is a READ container.

Implements com::avpkit::core::IContainer.

Definition at line 883 of file Container.cpp.

  {
    int32_t retval = -1;
    try {
      if (this->getType() != WRITE)
        throw std::runtime_error("cannot write packet to read only container");
 
      if (!mFormatContext)
        throw std::runtime_error("no format context allocated");
 
#ifdef VS_DEBUG
      // for shits and giggles, dump the ffmpeg output
      // dump_format(mFormatContext, 0, (mFormatContext ? mFormatContext->filename :0), 1);
#endif // VS_DEBUG
 
      // now we're going to walk through and record each open stream coder.
      // this is needed to catch a potential error on writeTrailer().
      mOpenCoders.clear();
      int numStreams = getNumStreams();
      if (numStreams < 0 && 
          !(mFormatContext->ctx_flags & AVFMTCTX_NOHEADER))
        throw std::runtime_error("no streams added to container");
      
      if (numStreams == 0)
      {
        RefPointer<IContainerFormat> format = getContainerFormat();
        if (format)
        {
          const char *shortName = format->getOutputFormatShortName();
          if (shortName && !strcmp(shortName, "mp3"))
            throw std::runtime_error("no streams added to mp3 container");
        }
      }
      for(int i = 0; i < numStreams; i++)
      {
        RefPointer<IStream> stream = this->getStream(i);
        if (stream)
        {
          RefPointer<IStreamCoder> coder = stream->getStreamCoder();
          if (coder)
          {
            if (coder->isOpen())
              // add to our open list
              mOpenCoders.push_back(coder);
            else
              VS_LOG_TRACE("writing Header for container, but at least one codec (%d) is not opened first", i);
          }
        }
      }
      retval = avformat_write_header(mFormatContext,0);
      if (retval < 0)
        throw std::runtime_error("could not write header for container");
 
      // force a flush.
      if (!(mFormatContext->oformat->flags & AVFMT_NOFILE)) {
        avio_flush(mFormatContext->pb);
      }
      // and remember that a writeTrailer is needed
      mNeedTrailerWrite = true;
    }
    catch (std::exception & e)
    {
      VS_LOG_ERROR("Error: %s", e.what());
      retval = -1;
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

writePacket() [1/2]

int32_t com::avpkit::core::Container::writePacket ( IPacket *  packet )

virtual

Writes the contents of the packet to the container, but make sure the packets are interleaved.

This means the IContainer may have to queue up packets from one stream while waiting for packets from another.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

packet

[In] The packet to write out.

Returns

# of bytes written if successful, or <0 if not.

Implements com::avpkit::core::IContainer.

Definition at line 804 of file Container.cpp.

  {
    return writePacket(ipkt, true);
  }

writePacket() [2/2]

int32_t com::avpkit::core::Container::writePacket ( IPacket *  packet, bool  forceInterleave  )

virtual

Writes the contents of the packet to the container.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Parameters

packet	[In] The packet to write out.
forceInterleave	[In] If true, then this IContainer will make sure all packets are interleaved by DTS (even across streams in a container). If false, the IContainer won't, and it's up to the caller to interleave if necessary.

Returns

# of bytes written if successful, or <0 if not.

Implements com::avpkit::core::IContainer.

Definition at line 809 of file Container.cpp.

  {
    int32_t retval = -1;
    Packet *pkt = static_cast<Packet*>(ipkt);
    try
    {
      if (this->getType() != WRITE)
        throw std::runtime_error("cannot write packet to read only container");
      
      if (!mFormatContext)
        throw std::logic_error("no format context");
 
      if (!pkt)
        throw std::runtime_error("cannot write missing packet");
 
      if (!pkt->isComplete())
        throw std::runtime_error("cannot write incomplete packet");
 
//      if (!pkt->getSize())
//        throw std::runtime_error("cannot write empty packet");
 
      if (!mNeedTrailerWrite)
        throw std::runtime_error("container has not written header yet");
 
      int32_t pktIndex = pkt->getStreamIndex();
      
      if ((uint32_t)pktIndex >= mNumStreams)
        throw std::runtime_error("packet being written to stream that doesn't exist");
 
      RefPointer<Stream> *streamPtr = mStreams.at(pktIndex);
      if (!streamPtr || !*streamPtr)
        throw std::runtime_error("no stream set up for this packet");
      
      Stream* stream = streamPtr->value();
 
      // Create a new packet that wraps the input data; this
      // just copies meta-data
      RefPointer<Packet> outPacket = Packet::make(pkt, false);
      // Stamp it with the stream data
      if (stream->stampOutputPacket(outPacket.value()) <0)
        throw std::runtime_error("could not stamp output packet");
      
      AVPacket *packet = 0;
      packet = outPacket->getAVPacket();
      if (!packet || !packet->data)
        throw std::runtime_error("no data in packet");
      
      /*
      VS_LOG_DEBUG("write-packet: %lld, %lld, %d, %d, %d, %lld, %lld: %p",
          pkt->getDts(),
          pkt->getPts(),
          pkt->getFlags(),
          pkt->getStreamIndex(),
          pkt->getSize(),
          pkt->getDuration(),
          pkt->getPosition(),
          packet->data);
          */
          
      if (forceInterleave)
        retval =  av_interleaved_write_frame(mFormatContext, packet);
      else
        retval = av_write_frame(mFormatContext, packet);
    }
    catch (std::exception & e)
    {
      VS_LOG_ERROR("Error: %s", e.what());
      retval = -1;
    }
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

References com::avpkit::core::Packet::getStreamIndex(), com::avpkit::core::Packet::isComplete(), com::avpkit::core::Stream::stampOutputPacket(), and com::avpkit::ferry::RefPointer< T >::value().

writeTrailer()

int32_t com::avpkit::core::Container::writeTrailer ( )

virtual

Adds a trailer, if needed, for this container.

Call this AFTER you've written all data you're going to write to this container but BEFORE you call IStreamCoder#close() on your IStreamCoder objects.

You must call writeHeader() before you call this (and if you don't, the IContainer will warn loudly and not actually write the trailer).

If you have closed any of the IStreamCoder objects that were open when you called writeHeader(), then this method will fail.

If the current thread is interrupted while this blocking method is running the method will return with a negative value. To check if the method exited because of an interruption pass the return value to IError#make(int) and then check IError#getType() to see if it is IError.Type#ERROR_INTERRUPTED.

Returns

0 if successful. < 0 if not. Always <0 if this is a READ container.

Implements com::avpkit::core::IContainer.

Definition at line 952 of file Container.cpp.

  {
    int32_t retval = -1;
    try
    {
      if (this->getType() != WRITE)
        throw std::runtime_error("cannot write packet to read only container");
 
      if (!mFormatContext)
        throw std::runtime_error("no format context allocated");
 
      if (mNeedTrailerWrite)
      {
        while(mOpenCoders.size()>0)
        {
          RefPointer<IStreamCoder> coder = mOpenCoders.front();
          mOpenCoders.pop_front();
          if (!coder->isOpen())
          {
            mOpenCoders.clear();
            throw std::runtime_error("attempt to write trailer, but at least one used codec already closed");
          }
        }
        retval = av_write_trailer(mFormatContext);
        if (retval == 0)
        {
          if (!(mFormatContext->oformat->flags & AVFMT_NOFILE)) {
            avio_flush(mFormatContext->pb);
          }
        }
      } else {
        VS_LOG_WARN("writeTrailer() with no matching call to writeHeader()");
      }
    }
    catch (std::exception & e)
    {
      VS_LOG_ERROR("Error: %s", e.what());
      retval = -1;
    }
    // regardless of whether or not the write trailer succeeded, since
    // an attempt has occurred, we shouldn't call it twice.
    mNeedTrailerWrite = false;
    AVPKIT_CHECK_INTERRUPT(retval);
    return retval;
  }

---

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

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