Video Codec

Class: kodi::addon::CInstanceVideoCodec

Video codec add-on instance More...

Modules
	Definitions, structures and enumerators
	Video codec add-on general variables

Functions
	kodi::addon::CInstanceVideoCodec::CInstanceVideoCodec (KODI_HANDLE instance, const std::string &kodiVersion="")
	Video codec class constructor used to support multiple instance types. More...
	kodi::addon::CInstanceVideoCodec::~CInstanceVideoCodec () override=default
	Destructor. More...
virtual bool	kodi::addon::CInstanceVideoCodec::Open (const kodi::addon::VideoCodecInitdata &initData)
	Open the decoder, returns true on success. More...
virtual bool	kodi::addon::CInstanceVideoCodec::Reconfigure (const kodi::addon::VideoCodecInitdata &initData)
	Reconfigure the decoder, returns true on success. More...
virtual bool	kodi::addon::CInstanceVideoCodec::AddData (const DEMUX_PACKET &packet)
	add data, decoder has to consume the entire packet More...
virtual VIDEOCODEC_RETVAL	kodi::addon::CInstanceVideoCodec::GetPicture (VIDEOCODEC_PICTURE &picture)
	GetPicture controls decoding. More...
virtual const char *	kodi::addon::CInstanceVideoCodec::GetName ()
	should return codecs name More...
virtual void	kodi::addon::CInstanceVideoCodec::Reset ()
	Reset the decoder. More...
bool	kodi::addon::CInstanceVideoCodec::GetFrameBuffer (VIDEOCODEC_PICTURE &picture)
	AddonToKodi interface. More...
void	kodi::addon::CInstanceVideoCodec::ReleaseFrameBuffer (void *buffer)
	Release the with GetFrameBuffer() given framebuffer. More...

Detailed Description

Class: kodi::addon::CInstanceVideoCodec

Video codec add-on instance

This is an addon instance class to add an additional video decoder to Kodi using addon.

This means that either a new type of decoding can be introduced to an input stream add-on that requires special types of decoding.

When using the inputstream addon, class InputstreamInfo to cpp_kodi_addon_inputstream_Defs_Info is used to declare that the decoder stored in the addon is used.

Note

At the moment this can only be used together with input stream addons, independent use as a codec addon is not yet possible.

Include the header #include <kodi/addon-instance/VideoCodec.h> to use this class.

---

Example: This as an example when used together with kodi::addon::CInstanceInputStream.

#include <kodi/addon-instance/Inputstream.h>
#include <kodi/addon-instance/VideoCodec.h>
 
class CMyVideoCodec : public kodi::addon::CInstanceVideoCodec
{
public:
  CMyVideoCodec(KODI_HANDLE instance, CMyInputstream* inputstream);
  ...
 
private:
  CMyInputstream* m_inputstream;
};
 
CMyVideoCodec::CMyVideoCodec(KODI_HANDLE instance,
                             const std::string& version,
                             CMyInputstream* inputstream)
  : kodi::addon::CInstanceVideoCodec(instance, version),
    m_inputstream(inputstream)
{
  ...
}
...
 
//----------------------------------------------------------------------
 
class CMyInputstream : public kodi::addon::CInstanceInputStream
{
public:
  CMyInputstream(KODI_HANDLE instance, const std::string& kodiVersion);
 
  ADDON_STATUS CreateInstance(int instanceType,
                              std::string instanceID,
                              KODI_HANDLE instance,
                              const std::string& version,
                              KODI_HANDLE& addonInstance) override;
  ...
};
 
CMyInputstream::CMyInputstream(KODI_HANDLE instance, const std::string& kodiVersion)
  : kodi::addon::CInstanceInputStream(instance, kodiVersion)
{
  ...
}
 
ADDON_STATUS CMyInputstream::CreateInstance(int instanceType,
                                            std::string instanceID,
                                            KODI_HANDLE instance,
                                            const std::string& version,
                                            KODI_HANDLE& addonInstance)
{
  if (instanceType == ADDON_INSTANCE_VIDEOCODEC)
  {
    addonInstance = new CMyVideoCodec(instance, version, this);
    return ADDON_STATUS_OK;
  }
  return ADDON_STATUS_NOT_IMPLEMENTED;
}
 
...
 
//----------------------------------------------------------------------
 
class CMyAddon : public kodi::addon::CAddonBase
{
public:
  CMyAddon() { }
  ADDON_STATUS CreateInstance(int instanceType,
                              std::string instanceID,
                              KODI_HANDLE instance,
                              const std::string& version,
                              KODI_HANDLE& addonInstance) override;
};
 
// If you use only one instance in your add-on, can be instanceType and
// instanceID ignored
ADDON_STATUS CMyAddon::CreateInstance(int instanceType,
                                      std::string instanceID,
                                      KODI_HANDLE instance,
                                      const std::string& version,
                                      KODI_HANDLE& addonInstance)
{
  if (instanceType == ADDON_INSTANCE_INPUTSTREAM)
  {
    kodi::Log(ADDON_LOG_NOTICE, "Creating my Inputstream");
    addonInstance = new CMyInputstream(instance, version);
    return ADDON_STATUS_OK;
  }
  else if (...)
  {
    ...
  }
  return ADDON_STATUS_UNKNOWN;
}
 
ADDONCREATOR(CMyAddon)

The destruction of the example class CMyInputstream is called from Kodi's header. Manually deleting the add-on instance is not required.

Function Documentation

AddData()

virtual bool kodi::addon::CInstanceVideoCodec::AddData ( const DEMUX_PACKET &  packet )

inlinevirtual

add data, decoder has to consume the entire packet

Parameters

[in]

packet

Data to process for decode

Returns

true if the packet was consumed or if resubmitting it is useless

CInstanceVideoCodec()

kodi::addon::CInstanceVideoCodec::CInstanceVideoCodec ( KODI_HANDLE  instance, const std::string &  kodiVersion = ""  )

inlineexplicit

Video codec class constructor used to support multiple instance types.

Parameters

[in]	instance	The instance value given to kodi::addon::CAddonBase::CreateInstance(...), or by a inputstream instance if them declared as parent.
[in]	kodiVersion	[opt] Version used in Kodi for this instance, to allow compatibility to older Kodi versions.

GetFrameBuffer()

bool kodi::addon::CInstanceVideoCodec::GetFrameBuffer ( VIDEOCODEC_PICTURE &  picture )

inline

AddonToKodi interface.

All picture members can be expected to be set correctly except decodedData and pts.

GetFrameBuffer has to set decodedData to a valid memory address and return true.

Parameters

[out]

picture

The buffer, or unmodified if false is returned

Returns

In case buffer allocation fails, it return false.

Note

If this returns true, buffer must be freed using ReleaseFrameBuffer().

Remarks

Only called from addon itself

GetName()

virtual const char * kodi::addon::CInstanceVideoCodec::GetName ( )

inlinevirtual

should return codecs name

Returns

Codec name

GetPicture()

virtual VIDEOCODEC_RETVAL kodi::addon::CInstanceVideoCodec::GetPicture ( VIDEOCODEC_PICTURE &  picture )

inlinevirtual

GetPicture controls decoding.

Player calls it on every cycle it can signal a picture, request a buffer, or return none, if nothing applies the data is valid until the next GetPicture return VC_PICTURE

Parameters

[in,out]

Structure

which contains the necessary data

Returns

The with VIDEOCODEC_RETVAL return values

Open()

virtual bool kodi::addon::CInstanceVideoCodec::Open ( const kodi::addon::VideoCodecInitdata &  initData )

inlinevirtual

Open the decoder, returns true on success.

Decoders not capable of running multiple instances should return false in case there is already a instance open.

Parameters

[in]

initData

Video codec init data

Returns

true if successfully done

---

The following table contains values that can be set with class VideoCodecInitdata :

Name	Type	Get call
Codec type	VIDEOCODEC_TYPE	GetCodecType
Codec profile	STREAMCODEC_PROFILE	GetCodecProfile
Video formats	std::vector<VIDEOCODEC_FORMAT>	GetVideoFormats
Width	uint32_t	GetWidth
Height	uint32_t	GetHeight
Extra data	const uint8_t*	GetExtraData
Extra data size	unsigned int	GetExtraDataSize
Crypto session	kodi::addon::StreamCryptoSession	GetCryptoSession

Reconfigure()

virtual bool kodi::addon::CInstanceVideoCodec::Reconfigure ( const kodi::addon::VideoCodecInitdata &  initData )

inlinevirtual

Reconfigure the decoder, returns true on success.

Decoders not capable of running multiple instances may be capable of reconfiguring the running instance. If Reconfigure returns false, player will close / open the decoder

Parameters

[in]

initData

Video codec reconfigure data

Returns

true if successfully done

ReleaseFrameBuffer()

void kodi::addon::CInstanceVideoCodec::ReleaseFrameBuffer ( void *  buffer )

inline

Release the with GetFrameBuffer() given framebuffer.

Parameters

[in]

handle

the on VIDEOCODEC_PICTURE::videoBufferHandle defined buffer handle

Remarks

Only called from addon itself

Reset()

virtual void kodi::addon::CInstanceVideoCodec::Reset ( )

inlinevirtual

Reset the decoder.

~CInstanceVideoCodec()

kodi::addon::CInstanceVideoCodec::~CInstanceVideoCodec ( )

overridedefault

Destructor.