anbox-platform-sdk  1.23.0
Anbox Platform SDK API documentation
anbox::VideoDecoder Class Referenceabstract

Provides access to a video decoder which will be used by both Anbox and the Android instance for hardware accelerated video decoding. More...

#include <video_decoder.h>

+ Collaboration diagram for anbox::VideoDecoder:

Public Member Functions

 VideoDecoder ()=default
 
virtual ~VideoDecoder ()=default
 
 VideoDecoder (const VideoDecoder &)=delete
 
VideoDecoderoperator= (const VideoDecoder &)=delete
 
virtual int configure (const AnboxVideoDecoderConfig &config)=0
 Configure the video decoder with the given spec. More...
 
virtual int flush ()=0
 Flush all pending frames to the decoder for decoding. More...
 
virtual uint64_t decode_frame (const AnboxVideoFrame *frame, int64_t pts)=0
 Decode the given frame with its presentation timestamp. More...
 
virtual int retrieve_image (AnboxVideoImage *img)=0
 Retrieve the latest decoded image from the video decoder. More...
 

Detailed Description

Provides access to a video decoder which will be used by both Anbox and the Android instance for hardware accelerated video decoding.

Definition at line 29 of file video_decoder.h.

Constructor & Destructor Documentation

◆ VideoDecoder() [1/2]

anbox::VideoDecoder::VideoDecoder ( )
default

◆ ~VideoDecoder()

virtual anbox::VideoDecoder::~VideoDecoder ( )
virtualdefault

◆ VideoDecoder() [2/2]

anbox::VideoDecoder::VideoDecoder ( const VideoDecoder )
delete

Member Function Documentation

◆ configure()

virtual int anbox::VideoDecoder::configure ( const AnboxVideoDecoderConfig config)
pure virtual

Configure the video decoder with the given spec.

Parameters
configconfiguration for the video decoder
Returns
0 on success, an error code otherwise

◆ decode_frame()

virtual uint64_t anbox::VideoDecoder::decode_frame ( const AnboxVideoFrame frame,
int64_t  pts 
)
pure virtual

Decode the given frame with its presentation timestamp.

Parameters
framethe frame to decode
ptspresentation timestamp of the frame in milliseconds
Returns
Number of bytes submitted to the decoder

◆ flush()

virtual int anbox::VideoDecoder::flush ( )
pure virtual

Flush all pending frames to the decoder for decoding.

Returns
0 on success, an error code otherwise

◆ operator=()

VideoDecoder& anbox::VideoDecoder::operator= ( const VideoDecoder )
delete

◆ retrieve_image()

virtual int anbox::VideoDecoder::retrieve_image ( AnboxVideoImage img)
pure virtual

Retrieve the latest decoded image from the video decoder.

Parameters
imgstructure holding information about the returned image
Returns
0 on success, an error code otherwise

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