Inheritance diagram for com::avpkit::core::ContainerFormat:

Collaboration diagram for com::avpkit::core::ContainerFormat:

[legend]

Public Member Functions
virtual int32_t	setInputFormat (const char *shortName)
	Sets the input format for this container. More...

virtual int32_t	setOutputFormat (const char shortName, const char url, const char *mimeType)
	Sets the output format for this container. More...

virtual const char *	getInputFormatShortName ()
	Get the short name for the input format. More...

virtual const char *	getInputFormatLongName ()
	Get the long name for the input format. More...

virtual const char *	getOutputFormatShortName ()
	Get the short name for the output format. More...

virtual const char *	getOutputFormatLongName ()
	Get the long name for the output format. More...

virtual const char *	getOutputFormatMimeType ()
	Get the mime type for the output format. More...

AVInputFormat *	getInputFormat ()

AVOutputFormat *	getOutputFormat ()

void	setInputFormat (AVInputFormat *)

void	setOutputFormat (AVOutputFormat *)

virtual int32_t	getInputFlags ()
	Get the input flags associated with this object. More...

virtual void	setInputFlags (int32_t newFlags)
	Set the input flags to use with this object. More...

virtual bool	getInputFlag (Flags flag)
	Get the input setting for the specified flag. More...

virtual void	setInputFlag (Flags flag, bool value)
	Set the input flag. More...

virtual int32_t	getOutputFlags ()
	Get the output flags associated with this object. More...

virtual void	setOutputFlags (int32_t newFlags)
	Set the output flags to use with this object. More...

virtual bool	getOutputFlag (Flags flag)
	Get the output setting for the specified flag. More...

virtual void	setOutputFlag (Flags flag, bool value)
	Set the output flag. More...

virtual bool	isOutput ()
	Is this an output container format? More...

virtual bool	isInput ()
	Is this an input container format? More...

virtual const char *	getOutputExtensions ()
	Get the filename extensions that this output format prefers (most common first). More...

virtual ICodec::ID	getOutputDefaultAudioCodec ()
	Get the default audio codec this container prefers, if known. More...

virtual ICodec::ID	getOutputDefaultVideoCodec ()
	Get the default video codec this container prefers, if known. More...

virtual ICodec::ID	getOutputDefaultSubtitleCodec ()
	Get the default subtitle codec this container prefers, if known. More...

virtual int32_t	getOutputNumCodecsSupported ()
	Gets the number of different codecs this container can include for encoding. More...

virtual ICodec::ID	getOutputCodecID (int32_t index)
	Queries for a supported codec id from the list of codecs that can be encoded into this ContainerFormat. More...

virtual int32_t	getOutputCodecTag (int32_t index)
	Queries for a supported codec tag from the list of codecs that can be encoded into this ContainerFormat. More...

virtual int32_t	getOutputCodecTag (ICodec::ID id)
	Get the 4-byte tag the container would output for the given codec id. More...

virtual bool	isCodecSupportedForOutput (ICodec::ID id)
	Returns true if this container format can output media encoded with the given codec. 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...

Additional Inherited Members
Public Types inherited from com::avpkit::core::IContainerFormat
enum	Flags { FLAG_NOFILE =0x0001 , FLAG_NEEDNUMBER = 0x0002 , FLAG_SHOW_IDS =0x0008 , FLAG_RAWPICTURE =0x0020 , FLAG_GLOBALHEADER =0x0040 , FLAG_NOTIMESTAMPS =0x0080 , FLAG_GENERIC_INDEX =0x0100 , FLAG_TS_DISCONT =0x0200 }

Static Public Member Functions inherited from com::avpkit::core::IContainerFormat
static IContainerFormat *	make ()
	Create a new IContainerFormat object. More...

static int32_t	getNumInstalledInputFormats ()
	Get the number of input formats this install can demultiplex (read) from. More...

static IContainerFormat *	getInstalledInputFormat (int32_t index)
	Return an object for the input format at the given index. More...

static int32_t	getNumInstalledOutputFormats ()
	Get the number of output formats this install can multiplex (write) to. More...

static IContainerFormat *	getInstalledOutputFormat (int32_t index)
	Return an object for the output format at the given index. More...

Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.

Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.

void *	mAllocator
	Not part of public API.

Detailed Description

Definition at line 29 of file ContainerFormat.h.

Member Function Documentation

◆ getInputFlag()

bool com::avpkit::core::ContainerFormat::getInputFlag ( Flags flag )

virtual

Get the input 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::IContainerFormat.

Definition at line 136 of file ContainerFormat.cpp.

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

◆ getInputFlags()

int32_t com::avpkit::core::ContainerFormat::getInputFlags ( )

virtual

Get the input flags associated with this object.

Returns: The (compacted) value of all flags set.

Implements com::avpkit::core::IContainerFormat.

Definition at line 123 of file ContainerFormat.cpp.

   {
     return (mInputFormat ? mInputFormat->flags : 0);
   }

◆ getInputFormatLongName()

const char * com::avpkit::core::ContainerFormat::getInputFormatLongName ( )

virtual

Get the long name for the input format.

Returns: The long name for the input format, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 82 of file ContainerFormat.cpp.

   {
     return (mInputFormat ? mInputFormat->long_name : 0);
   }

◆ getInputFormatShortName()

const char * com::avpkit::core::ContainerFormat::getInputFormatShortName ( )

virtual

Get the short name for the input format.

Returns: The short name for the input format, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 77 of file ContainerFormat.cpp.

   {
     return (mInputFormat ? mInputFormat->name : 0);
   }

◆ getOutputCodecID()

ICodec::ID com::avpkit::core::ContainerFormat::getOutputCodecID ( int32_t index )

virtual

Queries for a supported codec id from the list of codecs that can be encoded into this ContainerFormat.

Parameters

index The index in our lookup table. Index >= 0 and < getOutputNumCodecsSupported(). Index values may change between releases, so always query.

Returns: The codec id at this position, or ICodec.ID#CODEC_ID_NONE if there is none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 268 of file ContainerFormat.cpp.

   {
     if (index < 0)
       return ICodec::AV_CODEC_ID_NONE;
  
     const struct AVCodecTag * const*tags = mOutputFormat->codec_tag;
     if (!tags)
       return ICodec::AV_CODEC_ID_NONE;
  
     int numCodecs = 0;
  
     for(int i = 0;
         tags[i];
         i++)
     {
       for(
           const struct AVCodecTag * tag = tags[i];
           tag && tag->id != ICodec::AV_CODEC_ID_NONE;
           ++tag, ++numCodecs)
       {
         if (numCodecs == index)
           return (ICodec::ID)tag->id;
       }
     }
     return ICodec::AV_CODEC_ID_NONE;
   }

◆ getOutputCodecTag() [1/2]

int32_t com::avpkit::core::ContainerFormat::getOutputCodecTag ( ICodec::ID id )

virtual

Get the 4-byte tag the container would output for the given codec id.

Parameters

id	the codec you are about

Returns: the 4-byte codec tag, or 0 if that id is not supported.

Implements com::avpkit::core::IContainerFormat.

Definition at line 330 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat)
       return 0;
     return (int32_t)av_codec_get_tag(mOutputFormat->codec_tag,
         (enum AVCodecID)id);
     
   }

◆ getOutputCodecTag() [2/2]

int32_t com::avpkit::core::ContainerFormat::getOutputCodecTag ( int32_t index )

virtual

Queries for a supported codec tag from the list of codecs that can be encoded into this ContainerFormat.

Tags are 4-byte values that are often used as markers in a container format for a codec type.

Parameters

index The index in our lookup table. Index >= 0 and < getOutputNumCodecsSupported(). Index values may change between releases, so always query.

Returns: The codec id tag this position, or 0 if there is none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 296 of file ContainerFormat.cpp.

   {
     if (index < 0)
       return ICodec::AV_CODEC_ID_NONE;
  
     const struct AVCodecTag * const*tags = mOutputFormat->codec_tag;
     if (!tags)
       return ICodec::AV_CODEC_ID_NONE;
  
     int numCodecs = 0;
  
     for(int i = 0;
         tags[i];
         i++)
     {
       for(
           const struct AVCodecTag * tag = tags[i];
           tag && tag->id != ICodec::AV_CODEC_ID_NONE;
           ++tag, ++numCodecs)
       {
         if (numCodecs == index)
           return tag->tag;
       }
     }
     return ICodec::AV_CODEC_ID_NONE;
   }

Referenced by isCodecSupportedForOutput().

◆ getOutputDefaultAudioCodec()

ICodec::ID com::avpkit::core::ContainerFormat::getOutputDefaultAudioCodec ( )

virtual

Get the default audio codec this container prefers, if known.

Returns: the default audio codec id, or ICodec.ID#CODEC_ID_NONE if unknown.

Implements com::avpkit::core::IContainerFormat.

Definition at line 219 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat)
       return ICodec::AV_CODEC_ID_NONE;
     return (ICodec::ID)mOutputFormat->audio_codec;
   }

◆ getOutputDefaultSubtitleCodec()

ICodec::ID com::avpkit::core::ContainerFormat::getOutputDefaultSubtitleCodec ( )

virtual

Get the default subtitle codec this container prefers, if known.

Returns: the default subtitle codec id, or ICodec.ID#CODEC_ID_NONE if unknown.

Implements com::avpkit::core::IContainerFormat.

Definition at line 235 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat)
       return ICodec::AV_CODEC_ID_NONE;
     return (ICodec::ID)mOutputFormat->subtitle_codec;
   }

◆ getOutputDefaultVideoCodec()

ICodec::ID com::avpkit::core::ContainerFormat::getOutputDefaultVideoCodec ( )

virtual

Get the default video codec this container prefers, if known.

Returns: the default video codec id, or ICodec.ID#CODEC_ID_NONE if unknown.

Implements com::avpkit::core::IContainerFormat.

Definition at line 227 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat)
       return ICodec::AV_CODEC_ID_NONE;
     return (ICodec::ID)mOutputFormat->video_codec;
   }

◆ getOutputExtensions()

const char * com::avpkit::core::ContainerFormat::getOutputExtensions ( )

virtual

Get the filename extensions that this output format prefers (most common first).

Returns: a command separated string of output extensions, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 210 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat || !mOutputFormat->extensions ||
         !*mOutputFormat->extensions)
       return 0;
     return mOutputFormat->extensions;
   }

◆ getOutputFlag()

bool com::avpkit::core::ContainerFormat::getOutputFlag ( Flags flag )

virtual

Get the output 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::IContainerFormat.

Definition at line 174 of file ContainerFormat.cpp.

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

◆ getOutputFlags()

int32_t com::avpkit::core::ContainerFormat::getOutputFlags ( )

virtual

Get the output flags associated with this object.

Returns: The (compacted) value of all flags set.

Implements com::avpkit::core::IContainerFormat.

Definition at line 161 of file ContainerFormat.cpp.

   {
     return (mOutputFormat ? mOutputFormat->flags : 0);
   }

◆ getOutputFormatLongName()

const char * com::avpkit::core::ContainerFormat::getOutputFormatLongName ( )

virtual

Get the long name for the output format.

Returns: The long name for the output format, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 92 of file ContainerFormat.cpp.

   {
     return (mOutputFormat ? mOutputFormat->long_name : 0);
   }

◆ getOutputFormatMimeType()

const char * com::avpkit::core::ContainerFormat::getOutputFormatMimeType ( )

virtual

Get the mime type for the output format.

Returns: The mime type for the output format, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 97 of file ContainerFormat.cpp.

   {
     return (mOutputFormat ? mOutputFormat->mime_type : 0);
   }

◆ getOutputFormatShortName()

const char * com::avpkit::core::ContainerFormat::getOutputFormatShortName ( )

virtual

Get the short name for the output format.

Returns: The short name for the output format, or null if none.

Implements com::avpkit::core::IContainerFormat.

Definition at line 87 of file ContainerFormat.cpp.

   {
     return (mOutputFormat ? mOutputFormat->name : 0);
   }

◆ getOutputNumCodecsSupported()

int32_t com::avpkit::core::ContainerFormat::getOutputNumCodecsSupported ( )

virtual

Gets the number of different codecs this container can include for encoding.

This can be used as an upper bound when using the getOutputCodecID(int) and getOutputCodecTag(int) methods to dynamically query the actual codecs.

Returns: The total number of different codec types that can be encoded into this container format.

Implements com::avpkit::core::IContainerFormat.

Definition at line 243 of file ContainerFormat.cpp.

   {
     if (!mOutputFormat)
       return 0;
     
     const struct AVCodecTag * const*tags = mOutputFormat->codec_tag;
     if (!tags)
       return 0;
  
     int numCodecs = 0;
  
     for(int i = 0;
         tags[i];
         i++)
     {
       for(const struct AVCodecTag * tag = tags[i];
           tag && tag->id != ICodec::AV_CODEC_ID_NONE;
           ++tag)
       {
         ++numCodecs;
       }
     }
     return numCodecs;
   }

◆ isCodecSupportedForOutput()

bool com::avpkit::core::ContainerFormat::isCodecSupportedForOutput ( ICodec::ID id )

virtual

Returns true if this container format can output media encoded with the given codec.

Parameters

id	the codec you care about.

Returns: true if the codec can be put in this output container; false otherwise.

Implements com::avpkit::core::IContainerFormat.

Definition at line 324 of file ContainerFormat.cpp.

   {
     return getOutputCodecTag(id);
   }

References getOutputCodecTag().

◆ isInput()

bool com::avpkit::core::ContainerFormat::isInput ( )

virtual

Is this an input container format?

Returns: true if input; false it not

Implements com::avpkit::core::IContainerFormat.

Definition at line 204 of file ContainerFormat.cpp.

   {
     return mInputFormat;
   }

◆ isOutput()

bool com::avpkit::core::ContainerFormat::isOutput ( )

virtual

Is this an output container format?

Returns: true if output; false it not

Implements com::avpkit::core::IContainerFormat.

Definition at line 198 of file ContainerFormat.cpp.

   {
     return mOutputFormat;
   }

◆ setInputFlag()

void com::avpkit::core::ContainerFormat::setInputFlag	(	Flags	flag,
		bool	value
	)

virtual

Set the input flag.

Parameters

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

Implements com::avpkit::core::IContainerFormat.

Definition at line 145 of file ContainerFormat.cpp.

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

◆ setInputFlags()

void com::avpkit::core::ContainerFormat::setInputFlags ( int32_t newFlags )

virtual

Set the input 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::IContainerFormat.

Definition at line 129 of file ContainerFormat.cpp.

   {
     if (mInputFormat)
       mInputFormat->flags = newFlags;
   }

◆ setInputFormat()

int32_t com::avpkit::core::ContainerFormat::setInputFormat ( const char * shortName )

virtual

Sets the input format for this container.

Parameters

shortName The short name for this container (using FFMPEG's short name).

Returns: >= 0 on success. < 0 if shortName cannot be found.

Implements com::avpkit::core::IContainerFormat.

Definition at line 51 of file ContainerFormat.cpp.

   {
     if (shortName && *shortName)
     {
       mInputFormat = av_find_input_format(shortName);
     } else {
       mInputFormat = NULL;
     }
     return (mInputFormat == NULL ? -1 : 0);
   }

Referenced by com::avpkit::core::Container::getContainerFormat(), and com::avpkit::core::IContainerFormat::getInstalledInputFormat().

◆ setOutputFlag()

void com::avpkit::core::ContainerFormat::setOutputFlag	(	Flags	flag,
		bool	value
	)

virtual

Set the output flag.

Parameters

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

Implements com::avpkit::core::IContainerFormat.

Definition at line 183 of file ContainerFormat.cpp.

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

◆ setOutputFlags()

void com::avpkit::core::ContainerFormat::setOutputFlags ( int32_t newFlags )

virtual

Set the output 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::IContainerFormat.

Definition at line 167 of file ContainerFormat.cpp.

   {
     if (mOutputFormat)
       mOutputFormat->flags = newFlags;
   }

◆ setOutputFormat()

int32_t com::avpkit::core::ContainerFormat::setOutputFormat	(	const char *	shortName,
		const char *	url,
		const char *	mimeType
	)

virtual

Sets the output format for this container.

We'll look at the shortName, url and mimeType and try to guess a valid output container format.

Parameters

shortName	The short name for this container (using FFMPEG's short name).
url	The URL for this container.
mimeType	The mime type for this container.

Returns: >= 0 on success. < 0 if we cannot find a good container.

Implements com::avpkit::core::IContainerFormat.

Definition at line 62 of file ContainerFormat.cpp.

   {
     if ((shortName && *shortName) ||
         (url && *url) ||
         (mimeType && *mimeType))
     {
       mOutputFormat = av_guess_format(shortName, url, mimeType);
     } else {
       mOutputFormat = NULL;
     }
     return (mOutputFormat == NULL ? -1 : 0);
   }

Referenced by com::avpkit::core::Container::getContainerFormat(), and com::avpkit::core::IContainerFormat::getInstalledOutputFormat().

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getInputFlag()

◆ getInputFlags()

◆ getInputFormatLongName()

◆ getInputFormatShortName()

◆ getOutputCodecID()

◆ getOutputCodecTag() [1/2]

◆ getOutputCodecTag() [2/2]

◆ getOutputDefaultAudioCodec()

◆ getOutputDefaultSubtitleCodec()

◆ getOutputDefaultVideoCodec()

◆ getOutputExtensions()

◆ getOutputFlag()

◆ getOutputFlags()

◆ getOutputFormatLongName()

◆ getOutputFormatMimeType()

◆ getOutputFormatShortName()

◆ getOutputNumCodecsSupported()

◆ isCodecSupportedForOutput()

◆ isInput()

◆ isOutput()

◆ setInputFlag()

◆ setInputFlags()

◆ setInputFormat()

◆ setOutputFlag()

◆ setOutputFlags()

◆ setOutputFormat()