Miam-Player  0.8.0
A nice music player
QtAV::SubtitleProcessor Class Referenceabstract

#include <SubtitleProcessor.h>

Public Member Functions

 SubtitleProcessor ()
 
virtual ~SubtitleProcessor ()
 
virtual SubtitleProcessorId id () const =0
 
virtual QString name () const =0
 
virtual QStringList supportedTypes () const =0
 supportedTypes More...
 
virtual bool process (QIODevice *dev)=0
 process process subtitle from QIODevice. More...
 
virtual bool process (const QString &path)
 process default behavior is calling process(QFile*) More...
 
virtual QList< SubtitleFrameframes () const =0
 timestamps call this after process(). More...
 
virtual bool canRender () const
 
virtual bool processHeader (const QByteArray &codec, const QByteArray &data)
 
virtual SubtitleFrame processLine (const QByteArray &data, qreal pts=-1, qreal duration=0)=0
 
virtual QString getText (qreal pts) const =0
 
virtual QImage getImage (qreal pts, QRect *boundingRect=0)
 
virtual SubImageSet getSubImages (qreal pts, QRect *boundingRect=0)
 
void setFrameSize (int width, int height)
 
QSize frameSize () const
 
int frameWidth () const
 
int frameHeight () const
 
virtual void setFontFile (const QString &file)
 
virtual void setFontsDir (const QString &dir)
 
virtual void setFontFileForced (bool force)
 

Static Public Member Functions

static void registerAll ()
 
template<class C >
static bool Register (SubtitleProcessorId id, const char *name)
 
static SubtitleProcessorcreate (SubtitleProcessorId id)
 
static SubtitleProcessorcreate (const char *name="FFmpeg")
 
static SubtitleProcessorIdnext (SubtitleProcessorId *id=0)
 next More...
 
static const char * name (SubtitleProcessorId id)
 
static SubtitleProcessorId id (const char *name)
 

Protected Member Functions

virtual void onFrameSizeChanged (int width, int height)
 

Constructor & Destructor Documentation

QtAV::SubtitleProcessor::SubtitleProcessor ( )
virtual QtAV::SubtitleProcessor::~SubtitleProcessor ( )
inlinevirtual

Member Function Documentation

virtual bool QtAV::SubtitleProcessor::canRender ( ) const
inlinevirtual
static SubtitleProcessor* QtAV::SubtitleProcessor::create ( SubtitleProcessorId  id)
static
static SubtitleProcessor* QtAV::SubtitleProcessor::create ( const char *  name = "FFmpeg")
static
int QtAV::SubtitleProcessor::frameHeight ( ) const
virtual QList<SubtitleFrame> QtAV::SubtitleProcessor::frames ( ) const
pure virtual

timestamps call this after process().

SubtitleFrame.text must be set

Returns
QSize QtAV::SubtitleProcessor::frameSize ( ) const
int QtAV::SubtitleProcessor::frameWidth ( ) const
virtual QImage QtAV::SubtitleProcessor::getImage ( qreal  pts,
QRect *  boundingRect = 0 
)
virtual
virtual SubImageSet QtAV::SubtitleProcessor::getSubImages ( qreal  pts,
QRect *  boundingRect = 0 
)
virtual
virtual QString QtAV::SubtitleProcessor::getText ( qreal  pts) const
pure virtual
virtual SubtitleProcessorId QtAV::SubtitleProcessor::id ( ) const
pure virtual
static SubtitleProcessorId QtAV::SubtitleProcessor::id ( const char *  name)
static
virtual QString QtAV::SubtitleProcessor::name ( ) const
pure virtual
static const char* QtAV::SubtitleProcessor::name ( SubtitleProcessorId  id)
static
static SubtitleProcessorId* QtAV::SubtitleProcessor::next ( SubtitleProcessorId id = 0)
static

next

Parameters
idNULL to get the first id address
Returns
address of id or NULL if not found/end
virtual void QtAV::SubtitleProcessor::onFrameSizeChanged ( int  width,
int  height 
)
protectedvirtual
virtual bool QtAV::SubtitleProcessor::process ( QIODevice *  dev)
pure virtual

process process subtitle from QIODevice.

Parameters
devdev is open and you don't have to close it
Returns
false if failed or does not supports iodevice, e.g. does not support sequential device
virtual bool QtAV::SubtitleProcessor::process ( const QString &  path)
virtual

process default behavior is calling process(QFile*)

Parameters
path
Returns
false if failed or does not support file
virtual bool QtAV::SubtitleProcessor::processHeader ( const QByteArray &  codec,
const QByteArray &  data 
)
inlinevirtual
virtual SubtitleFrame QtAV::SubtitleProcessor::processLine ( const QByteArray &  data,
qreal  pts = -1,
qreal  duration = 0 
)
pure virtual
template<class C >
static bool QtAV::SubtitleProcessor::Register ( SubtitleProcessorId  id,
const char *  name 
)
inlinestatic
static void QtAV::SubtitleProcessor::registerAll ( )
static
virtual void QtAV::SubtitleProcessor::setFontFile ( const QString &  file)
inlinevirtual
virtual void QtAV::SubtitleProcessor::setFontFileForced ( bool  force)
inlinevirtual
virtual void QtAV::SubtitleProcessor::setFontsDir ( const QString &  dir)
inlinevirtual
void QtAV::SubtitleProcessor::setFrameSize ( int  width,
int  height 
)
virtual QStringList QtAV::SubtitleProcessor::supportedTypes ( ) const
pure virtual

supportedTypes

Returns
a list of supported suffixes. e.g. [ "ass", "ssa", "srt" ] used to find subtitle files with given suffixes

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