mh5display.h File Reference

Implement generic MHEG5-display functions - independent from the OSD These are generic functions used by the MHEG5 engine to manage it's display. These functions are the direct API between the |OSD| and the MHEG5-classes. More...

#include "mh5visible.h"
#include "mh5bitmap.h"
#include "mh5lineart.h"
#include "mh5rectangle.h"
#include "mh5stream.h"
#include "mh5audio.h"
#include "mh5video.h"
#include "mh5application.h"

Go to the source code of this file.

Macros
#define	MHEG5displayShow(v)   MHEG5displayVisUpd(v, 0)
#define	MHEG5displayHide(v)   MHEG5displayVisUpd(v, 1)
#define	MHEG5displayRedraw(v)   if ((v)->ingredient.root.runningStatus) MHEG5displayVisUpd(v, 2);

Functions
void	MHEG5displayClear (void)
	<Function description>=""> More...
void	MHEG5displayVisUpd (MHEG5Visible *visible, U8BIT upd)
void	MHEG5displayShowAll (void)
	Redisplay all active visible objects. AKD: Optimised 12/5/99. More...
void	MHEG5displayResume (void)
void	MHEG5displayPause (void)
void	MHEG5groupClearImages (MHEG5Root *group)
void	MHEG5groupRedraw (MHEG5Root *group)
void	MHEG5displayUpdate (void)
	Update the display, redrawing any visible objects that are in the dirty rectangle. More...
void	MHEG5displayLockStreams (void)
	Lock streams, disallow any stream updates. More...
void	MHEG5displayUnlockStreams (void)
	Unlock streams, allow stream updates. More...
OSDColor	MHEG5displayColour (MHEG5Colour *colour)
	Convert Generic Colour value to OSD specific value. If the generic colour is encoded as a string it is converted to an OSD representation. The OSD representation is then cached as an integer value. More...
void	MHEG5displayAudioPlay (MHEG5Audio *audio)
	Begin playback of the specified audio object. More...
void	MHEG5displayAudioStop (void)
	Stops playback of the audio media decoder. More...
void	MHEG5displaySetVolume (MHEG5Int volume)
	Volume Control. More...
void	MHEG5displayVideoPlay (MHEG5Video *video)
	Begin playback of the specified video object. More...
void	MHEG5displayVideoStop (void)
	Stops playback of the video media decoder. More...
void	MHEG5displayStreamPlay (MHEG5Stream *stream)
	Begin playback of all active components in the specifed stream object. More...
void	MHEG5displayStreamStop (MHEG5Stream *stream)
	Stops playback of all active component of the specified stream object. More...
void	MHEG5displayIFrameStart (MHEG5Bitmap *bitmap)
	Start displaying an I-Frame. More...
void	MHEG5displayIFrameStop (void)
	Stop displaying an I-Frame. More...
void	MHEG5displayResetStreamDecoders (BOOLEAN update)
	Reset all media decoders to default values. This is used when the MHEG-5 engine is terminated, or the last application quits. More...
void	MHEG5displayVideoPositionUpdate (void)
void	MHEG5notifyVideoStarted (void)
void	MHEG5notifyVideoStopped (void)
void	MHEG5notifyAudioStarted (BOOLEAN isClip)
void	MHEG5notifyAudioStopped (BOOLEAN isClip)
void	MHEG5displayVideoDestroy (MHEG5Video *video)
void	MHEG5displayAudioDestroy (MHEG5Audio *audio)
void	MHEG5displayIframeDestroy (MHEG5Bitmap *iframe)
void	MHEG5displayStreamUpdate (MHEG5Application *application)
void	MHEG5displayRefreshAudioStream (void)
void	MHEG5displayRefreshStreams (U16BIT service_id)
void	MHEG5displayRefreshDefaultAudio (U16BIT service_id)
U16BIT	MHEG5GetVideoSid (void)
U16BIT	MHEG5GetAudioSid (void)

Detailed Description

Implement generic MHEG5-display functions - independent from the OSD These are generic functions used by the MHEG5 engine to manage it's display. These functions are the direct API between the |OSD| and the MHEG5-classes.

Date

05/02/2002

Author

R.Freeman

Definition in file mh5display.h.

Macro Definition Documentation

#define MHEG5displayHide

(

v

)

MHEG5displayVisUpd(v, 1)

Definition at line 46 of file mh5display.h.

#define MHEG5displayRedraw

(

v

)

if ((v)->ingredient.root.runningStatus) MHEG5displayVisUpd(v, 2);

Definition at line 47 of file mh5display.h.

#define MHEG5displayShow

(

v

)

MHEG5displayVisUpd(v, 0)

Definition at line 45 of file mh5display.h.

Function Documentation

void MHEG5displayAudioDestroy

(

MHEG5Audio *

audio

)

Definition at line 2581 of file mh5display.c.

void MHEG5displayAudioPlay

(

MHEG5Audio *

audio

)

Begin playback of the specified audio object.

Parameters

audio

Audio object to play

Returns

void

Definition at line 2150 of file mh5display.c.

void MHEG5displayAudioStop

(

void

)

Stops playback of the audio media decoder.

Returns

void

Parameters

immediate

Stop media decoder immediately, else wait until the next time that the display is updated.

Returns

void

Definition at line 2450 of file mh5display.c.

void MHEG5displayClear

(

void

)

<Function description>="">

Returns

<Return value>="">

<Return value>=""> Clear the Display.to the desktop colour

void

Definition at line 220 of file mh5display.c.

OSDColor MHEG5displayColour

(

MHEG5Colour *

colour

)

Convert Generic Colour value to OSD specific value. If the generic colour is encoded as a string it is converted to an OSD representation. The OSD representation is then cached as an integer value.

Parameters

colour

Generic colour value. This describes the colour as either a string or integer value.

Returns

OSDColor representation of the colour

Definition at line 256 of file mh5display.c.

void MHEG5displayIframeDestroy

(

MHEG5Bitmap *

iframe

)

Definition at line 2600 of file mh5display.c.

void MHEG5displayIFrameStart

(

MHEG5Bitmap *

bitmap

)

Start displaying an I-Frame.

Parameters

bitmap

Pointer to bitmap object

Returns

void

Definition at line 2614 of file mh5display.c.

void MHEG5displayIFrameStop

(

void

)

Stop displaying an I-Frame.

Returns

void

Definition at line 2717 of file mh5display.c.

void MHEG5displayLockStreams

(

void

)

Lock streams, disallow any stream updates.

Returns

void

Definition at line 2954 of file mh5display.c.

void MHEG5displayPause

(

void

)

Definition at line 1422 of file mh5display.c.

void MHEG5displayRefreshAudioStream

(

void

)

void MHEG5displayRefreshDefaultAudio

(

U16BIT

service_id

)

Definition at line 2376 of file mh5display.c.

void MHEG5displayRefreshStreams

(

U16BIT

service_id

)

Definition at line 2362 of file mh5display.c.

void MHEG5displayResetStreamDecoders

(

BOOLEAN

update

)

Reset all media decoders to default values. This is used when the MHEG-5 engine is terminated, or the last application quits.

Returns

void

Definition at line 2909 of file mh5display.c.

void MHEG5displayResume

(

void

)

Definition at line 1395 of file mh5display.c.

void MHEG5displaySetVolume

(

MHEG5Int

volume

)

Volume Control.

Parameters

MHEG5Int

volume

Returns

void

Definition at line 2974 of file mh5display.c.

void MHEG5displayShowAll

(

void

)

Redisplay all active visible objects. AKD: Optimised 12/5/99.

Returns

void

Definition at line 1362 of file mh5display.c.

void MHEG5displayStreamPlay

(

MHEG5Stream *

stream

)

Begin playback of all active components in the specifed stream object.

Parameters

stream

Stream object to play components of

Returns

void

Definition at line 2399 of file mh5display.c.

void MHEG5displayStreamStop

(

MHEG5Stream *

stream

)

Stops playback of all active component of the specified stream object.

Parameters

stream

Stream object to stop playing component of.

Returns

void

Parameters

stream	Stream object to stop playing component of.
immediate	Stop media decoders immediately, else wait until the next time that the display is updated.

Returns

void

Definition at line 2487 of file mh5display.c.

void MHEG5displayStreamUpdate

(

MHEG5Application *

application

)

Definition at line 1997 of file mh5display.c.

void MHEG5displayUnlockStreams

(

void

)

Unlock streams, allow stream updates.

Returns

void

Definition at line 2963 of file mh5display.c.

void MHEG5displayUpdate

(

void

)

Update the display, redrawing any visible objects that are in the dirty rectangle.

Parameters

visible

Visible object to redraw

Returns

void

Definition at line 2035 of file mh5display.c.

void MHEG5displayVideoDestroy

(

MHEG5Video *

video

)

Definition at line 2590 of file mh5display.c.

void MHEG5displayVideoPlay

(

MHEG5Video *

video

)

Begin playback of the specified video object.

Parameters

video

Video object to play

Returns

void

Definition at line 2273 of file mh5display.c.

void MHEG5displayVideoPositionUpdate

(

void

)

Definition at line 2729 of file mh5display.c.

void MHEG5displayVideoStop

(

void

)

Stops playback of the video media decoder.

Returns

void

Parameters

immediate

Stop media decoder immediately, else wait until the next time that the display is updated.

Returns

void

Definition at line 2468 of file mh5display.c.

void MHEG5displayVisUpd	(	MHEG5Visible *	visible,
		U8BIT	upd
	)

Definition at line 736 of file mh5display.c.

U16BIT MHEG5GetAudioSid

(

void

)

Definition at line 2357 of file mh5display.c.

U16BIT MHEG5GetVideoSid

(

void

)

Definition at line 2352 of file mh5display.c.

void MHEG5groupClearImages

(

MHEG5Root *

group

)

Definition at line 1451 of file mh5display.c.

void MHEG5groupRedraw

(

MHEG5Root *

group

)

Definition at line 1485 of file mh5display.c.

void MHEG5notifyAudioStarted

(

BOOLEAN

isClip

)

Definition at line 2820 of file mh5display.c.

void MHEG5notifyAudioStopped

(

BOOLEAN

isClip

)

Definition at line 2864 of file mh5display.c.

void MHEG5notifyVideoStarted

(

void

)

Definition at line 2734 of file mh5display.c.

void MHEG5notifyVideoStopped

(

void

)

Definition at line 2772 of file mh5display.c.