source/classes/inc/mh5video.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 _MH5VIDEO_H
#define _MH5VIDEO_H

/*---includes for this file--------------------------------------------------*/

#include "mh5presentable.h"
#include "mh5stream.h"

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

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

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

typedef struct
{
   /* Base class */
   MHEG5Visible visible;

   /* Engine data */
   MHEG5Bool scaleSet;
   MHEG5Int xScale;
   MHEG5Int yScale;

   /* Internal attributes */
   MHEG5Int xOffset;
   MHEG5Int yOffset;

   /* above attributes are common with bitmap class - and need the same positions */

   MHEG5Bool terminationFreeze;
   MHEG5Int componentTag;

   MHEG5Stream *parent;
} MHEG5Video;


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

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

void MHEG5videoInit(MHEG5Video *video);


void MHEG5videoFree(MHEG5Video *video);

/*
   Internal behaviours
 */
void MHEG5videoPrepare(MHEG5Video *video);

void MHEG5videoActivate(MHEG5Video *video);

void MHEG5videoDeactivate(MHEG5Video *video);

void MHEG5videoDestruct(MHEG5Video *video);

/*
   Actions
 */

MHEG5ErrorCode MHEG5scaleVideo(MHEG5Root *target, MHEG5GList *params);

MHEG5ErrorCode MHEG5setVideoDecodeOffset(MHEG5Root *target, MHEG5GList *params);

MHEG5ErrorCode MHEG5getVideoDecodeOffset(MHEG5Root *target, MHEG5GList *params);


/*
   Debug
 */

#ifdef MH5PRINTOUT

void MHEG5videoPrint(MHEG5Video *video, char *out);

#endif  /* #ifdef MH5PRINTOUT */

#endif /*_MH5VIDEO_H*/