vdr  1.7.31
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Static Private Attributes | Friends | List of all members
cOsdProvider Class Reference

#include <osd.h>

Public Member Functions

 cOsdProvider (void)
virtual ~cOsdProvider ()
 cOsdProvider (void)
virtual ~cOsdProvider ()

Static Public Member Functions

static cOsdNewOsd (int Left, int Top, uint Level=OSD_LEVEL_DEFAULT)
static void UpdateOsdSize (bool Force=false)
static bool SupportsTrueColor (void)
static int StoreImage (const cImage &Image)
static void DropImage (int ImageHandle)
static void Shutdown (void)
static cOsdNewOsd (int Left, int Top, uint Level=OSD_LEVEL_DEFAULT)
static void UpdateOsdSize (bool Force=false)
static bool SupportsTrueColor (void)
static int StoreImage (const cImage &Image)
static void DropImage (int ImageHandle)
static void Shutdown (void)

Protected Member Functions

virtual cOsdCreateOsd (int Left, int Top, uint Level)=0
virtual bool ProvidesTrueColor (void)
virtual int StoreImageData (const cImage &Image)
virtual void DropImageData (int ImageHandle)
virtual cOsdCreateOsd (int Left, int Top, uint Level)=0
virtual bool ProvidesTrueColor (void)
virtual int StoreImageData (const cImage &Image)
virtual void DropImageData (int ImageHandle)

Static Protected Member Functions

static const cImageGetImageData (int ImageHandle)
static const cImageGetImageData (int ImageHandle)

Static Private Attributes

static cOsdProviderosdProvider = NULL
static int oldWidth = 0
static int oldHeight = 0
static double oldAspect = 1.0
static cImageimages [MAXOSDIMAGES] = { NULL }

Friends

class cPixmapMemory

Detailed Description

Definition at line 938 of file include/vdr/osd.h.

Constructor & Destructor Documentation

cOsdProvider::cOsdProvider ( void  )

Definition at line 1961 of file osd.c.

References osdProvider.

cOsdProvider::~cOsdProvider ( )
virtual

Definition at line 1967 of file osd.c.

References osdProvider.

cOsdProvider::cOsdProvider ( void  )
virtual cOsdProvider::~cOsdProvider ( )
virtual

Member Function Documentation

virtual cOsd* cOsdProvider::CreateOsd ( int  Left,
int  Top,
uint  Level 
)
protectedpure virtual

Returns a pointer to a newly created cOsd object, which will be located at the given coordinates.

Implemented in cHdffOsdProvider, and cDvbOsdProvider.

Referenced by NewOsd().

virtual cOsd* cOsdProvider::CreateOsd ( int  Left,
int  Top,
uint  Level 
)
protectedpure virtual

Returns a pointer to a newly created cOsd object, which will be located at the given coordinates.

Implemented in cHdffOsdProvider, and cDvbOsdProvider.

void cOsdProvider::DropImage ( int  ImageHandle)
static

Drops the image referenced by the given ImageHandle.

If ImageHandle has an invalid value, nothing happens.

Definition at line 2063 of file osd.c.

References DropImageData(), and osdProvider.

static void cOsdProvider::DropImage ( int  ImageHandle)
static

Drops the image referenced by the given ImageHandle.

If ImageHandle has an invalid value, nothing happens.

void cOsdProvider::DropImageData ( int  ImageHandle)
protectedvirtual

Drops the image data referenced by ImageHandle.

Definition at line 2039 of file osd.c.

References images, LOCK_PIXMAPS, and MAXOSDIMAGES.

Referenced by DropImage().

virtual void cOsdProvider::DropImageData ( int  ImageHandle)
protectedvirtual

Drops the image data referenced by ImageHandle.

static const cImage* cOsdProvider::GetImageData ( int  ImageHandle)
staticprotected

Gets the image data referenced by ImageHandle.

const cImage * cOsdProvider::GetImageData ( int  ImageHandle)
staticprotected

Gets the image data referenced by ImageHandle.

Definition at line 2048 of file osd.c.

References images, LOCK_PIXMAPS, and MAXOSDIMAGES.

Referenced by cPixmapMemory::DrawImage().

static cOsd* cOsdProvider::NewOsd ( int  Left,
int  Top,
uint  Level = OSD_LEVEL_DEFAULT 
)
static

Returns a pointer to a newly created cOsd object, which will be located at the given coordinates.

When the cOsd object is no longer needed, the caller must delete it. If the OSD is already in use, or there is no OSD provider, a dummy OSD is returned so that the caller may always use the returned pointer without having to check it every time it is accessed.

cOsd * cOsdProvider::NewOsd ( int  Left,
int  Top,
uint  Level = OSD_LEVEL_DEFAULT 
)
static
virtual bool cOsdProvider::ProvidesTrueColor ( void  )
inlineprotectedvirtual

Returns true if this OSD provider is able to handle a true color OSD.

Reimplemented in cHdffOsdProvider.

Definition at line 950 of file include/vdr/osd.h.

Referenced by SupportsTrueColor().

virtual bool cOsdProvider::ProvidesTrueColor ( void  )
inlineprotectedvirtual

Returns true if this OSD provider is able to handle a true color OSD.

Reimplemented in cHdffOsdProvider.

Definition at line 950 of file osd.h.

void cOsdProvider::Shutdown ( void  )
static

Shuts down the OSD provider facility by deleting the current OSD provider.

Definition at line 2069 of file osd.c.

References osdProvider.

Referenced by main().

static void cOsdProvider::Shutdown ( void  )
static

Shuts down the OSD provider facility by deleting the current OSD provider.

int cOsdProvider::StoreImage ( const cImage Image)
static

Stores the given Image for later use with DrawImage() on an OSD or pixmap.

The returned number is a handle that must be used when referencing this image in a call to DrawImage() or DropImage(). The image data is copied, so any later changes to Image will have no effect on the stored image. A derived class may be able to copy frequently used images to some space where they can be retrieved faster than using a cImage in each call. If this is not a true color OSD, or if the image data can't be stored for any reason, this function returns 0 and nothing is stored.

Definition at line 2056 of file osd.c.

References osdProvider, and StoreImageData().

static int cOsdProvider::StoreImage ( const cImage Image)
static

Stores the given Image for later use with DrawImage() on an OSD or pixmap.

The returned number is a handle that must be used when referencing this image in a call to DrawImage() or DropImage(). The image data is copied, so any later changes to Image will have no effect on the stored image. A derived class may be able to copy frequently used images to some space where they can be retrieved faster than using a cImage in each call. If this is not a true color OSD, or if the image data can't be stored for any reason, this function returns 0 and nothing is stored.

virtual int cOsdProvider::StoreImageData ( const cImage Image)
protectedvirtual

Copies the given Image and returns a handle for later reference.

A derived class can implement its own image storing mechanism by reimplementing this function as well as DropImageData(). The base class implementation simply copies the image data to allow plugins to always use this interface, no matter if the actual device provides support for storing image data or not. The handles returned by the default implementation are positive integers. A derived class might want to use negative integers as handles, so that it can fall back to using the base class image storing mechanism if, e.g., it runs out of memory.

int cOsdProvider::StoreImageData ( const cImage Image)
protectedvirtual

Copies the given Image and returns a handle for later reference.

A derived class can implement its own image storing mechanism by reimplementing this function as well as DropImageData(). The base class implementation simply copies the image data to allow plugins to always use this interface, no matter if the actual device provides support for storing image data or not. The handles returned by the default implementation are positive integers. A derived class might want to use negative integers as handles, so that it can fall back to using the base class image storing mechanism if, e.g., it runs out of memory.

Definition at line 2027 of file osd.c.

References images, LOCK_PIXMAPS, and MAXOSDIMAGES.

Referenced by StoreImage().

static bool cOsdProvider::SupportsTrueColor ( void  )
static

Returns true if the current OSD provider is able to handle a true color OSD.

bool cOsdProvider::SupportsTrueColor ( void  )
static

Returns true if the current OSD provider is able to handle a true color OSD.

Definition at line 2017 of file osd.c.

References esyslog, osdProvider, and ProvidesTrueColor().

Referenced by cPluginOsddemo::MainMenuAction().

static void cOsdProvider::UpdateOsdSize ( bool  Force = false)
static

Inquires the actual size of the video display and adjusts the OSD and font sizes accordingly.

If Force is true, all settings are recalculated, even if the video resolution hasn't changed since the last call to this function.

void cOsdProvider::UpdateOsdSize ( bool  Force = false)
static

Inquires the actual size of the video display and adjusts the OSD and font sizes accordingly.

If Force is true, all settings are recalculated, even if the video resolution hasn't changed since the last call to this function.

Definition at line 1992 of file osd.c.

References DoubleEqual(), dsyslog, fontFix, cSetup::FontFix, cSetup::FontFixSize, cSetup::FontFixSizeP, fontOsd, cSetup::FontOsd, cSetup::FontOsdSize, cSetup::FontOsdSizeP, cSetup::FontSml, cSetup::FontSmlSize, cSetup::FontSmlSizeP, cDevice::GetOsdSize(), min(), oldAspect, oldHeight, oldWidth, cSetup::OSDAspect, cSetup::OSDHeight, cSetup::OSDHeightP, cSetup::OSDLeft, cSetup::OSDLeftP, cSetup::OSDTop, cSetup::OSDTopP, cSetup::OSDWidth, cSetup::OSDWidthP, cDevice::PrimaryDevice(), cFont::SetFont(), and Setup.

Referenced by main(), cMenuSetupOSD::ProcessKey(), cMenuSetupPlugins::ProcessKey(), and cMenuSetupBase::Store().

Friends And Related Function Documentation

cPixmapMemory
friend

Definition at line 939 of file include/vdr/osd.h.

Member Data Documentation

static cImage * cOsdProvider::images = { NULL }
staticprivate

Definition at line 945 of file include/vdr/osd.h.

Referenced by DropImageData(), GetImageData(), and StoreImageData().

static double cOsdProvider::oldAspect = 1.0
staticprivate

Definition at line 944 of file include/vdr/osd.h.

Referenced by UpdateOsdSize().

static int cOsdProvider::oldHeight = 0
staticprivate

Definition at line 943 of file include/vdr/osd.h.

Referenced by UpdateOsdSize().

static int cOsdProvider::oldWidth = 0
staticprivate

Definition at line 942 of file include/vdr/osd.h.

Referenced by UpdateOsdSize().

static cOsdProvider * cOsdProvider::osdProvider = NULL
staticprivate

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