mh5display.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MHEG5DISPLAY_H
#define _MHEG5DISPLAY_H

/*---includes for this file--------------------------------------------------*/
#include "mh5visible.h"
#include "mh5bitmap.h"
#include "mh5lineart.h"
#include "mh5rectangle.h"
#include "mh5stream.h"
#include "mh5audio.h"
#include "mh5video.h"
#include "mh5rtgraphics.h"

/*---Constant and macro definitions for public use---------------------------*/

/*displayHide does same thing as displayShow - marks area of OSD for updating*/
#define MHEG5displayShow(v)   MHEG5displayVisUpd(v, 0)
#define MHEG5displayHide(v)   MHEG5displayVisUpd(v, 1)
#define MHEG5displayRedraw(v) if ((v)->ingredient.root.runningStatus) MHEG5displayVisUpd(v, 2);

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

void MHEG5ForceStreamUpdate(void);
void MHEG5displayClear(void);
void MHEG5displayVisUpd(MHEG5Visible *visible, U8BIT upd);
void MHEG5displayShowAll(void);
void MHEG5displayResume(void);
void MHEG5groupClearImages( MHEG5Root *group );
void MHEG5groupRedraw( MHEG5Root *group );

#ifdef INCLUDE_FREESAT

void MHEG5displayImagePlaneStop(void);
#endif

void MHEG5displayUpdate(void);


void MHEG5displayLockStreams(void);


void MHEG5displayUnlockStreams(void);


OSDColor MHEG5displayColour(MHEG5Colour *colour);

/*
     Stream Functions
 */
void MHEG5displayAudioPlay(MHEG5Audio *audio);


void MHEG5displayAudioStop(void);


/*
     Volume Control
 */
void MHEG5displaySetVolume(MHEG5Int volume);


void MHEG5displayVideoPlay(MHEG5Video *video);


void MHEG5displayVideoStop(void);


void MHEG5displayStreamPlay(MHEG5Stream *stream);


void MHEG5displayStreamStop(MHEG5Stream *stream);


void MHEG5displayIFrameStart(MHEG5Bitmap *bitmap);


void MHEG5displayIFrameStop(void);

void MHEG5displayResetStreamDecoders(BOOLEAN update);


void MHEG5displayVideoPositionUpdate(void);

#ifdef MHEG5_STREAM_TRICK_MODES

void MHEG5displaySkipTo(MHEG5Root *item, MHEG5Int pos);

#endif  /* #ifdef MHEG5_STREAM_TRICK_MODES */

#ifdef INCLUDE_SURFACE_THRESHOLD

void MHEG5displaySetSurfaceThreshold(S32BIT pixels);
#endif  /* INCLUDE_SURFACE_THRESHOLD */

/*
   Send Stream notification
 */
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(void);

#ifdef _MOVINGCURSOR_

/* Moving  Cursor
 */
void MHEG5displayMouseMove(MHEG5Int mx, MHEG5Int my);

#endif  /* #ifdef _MOVINGCURSOR_ */

#endif /*_MHEG5DISPLAY_H*/