include/dvb_video.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2012 Ocean Blue Software Ltd
 *
 * 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 _DVB_VIDEO_H
#define _DVB_VIDEO_H

#include "techtype.h"
#include "dvblocator.h"
#include "osdtype.h"
#include "vtctype.h"
#include "mherrors.h"

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

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

/* Video freeze options */
typedef enum
{
   /* Freeze video display, continuously displaying the current or a subsequent
    * video frame.
    */
   VIDEO_FREEZE,

   /* Unfreeze video display - resume normal video decoding and display */
   VIDEO_UNFREEZE
} E_VideoState;

/* Widescreen alignment (where 16:9 video is played within 4:3 scene) */
typedef enum
{
   MHEG5_ALIGNMENT_NONE,
   MHEG5_ALIGNMENT_CENTRE_CUT_OUT,
   MHEG5_ALIGNMENT_LETTERBOX
} E_VideoAlignment;

/* Subtitle hide / show options */
typedef enum
{
   /* Hide subtitles */
   MHEG5_DVB_SUBTITLE_HIDE,

   /* Show subtitles */
   MHEG5_DVB_SUBTITLE_SHOW
} E_DvbSubtitleShowState;


/* Subtitle freeze / unfreeze enumeration */
typedef enum
{
   /* Freeze subtitles */
   MHEG5_DVB_SUBTITLE_FREEZE,

   /* Unfreeze subtitles */
   MHEG5_DVB_SUBTITLE_UNFREEZE
} E_DvbSubtitleFreezeState;


/* Video encoding used in iframe/video */
typedef enum
{
   VIDEO_ENC_MPEG2,  /* see reference [1] - section 14.8.1 under "MPEG stills" */

   VIDEO_ENC_H_264   /* see reference [1] - section 14.14.1 under "H.264/AVC stills" */
} E_VideoEncoding;

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

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

E_MhegErr DVB_MhegVideoPlayDefault(void);


E_MhegErr DVB_MhegVideoPlayStream(S_DvbComponent *pDvbComponent);


E_MhegErr DVB_MhegVideoStopStream(void);


E_MhegErr DVB_MhegVideoPlayIFrame( U8BIT *pVideoData,
   U32BIT dataLength,
   E_VideoEncoding encoding );

E_MhegErr DVB_MhegVideoStopIFrame(void);


E_MhegErr DVB_MhegVideoSetUpdating(E_VideoState displayState);


E_MhegErr DVB_MhegSubtitleSetVisibility(E_DvbSubtitleShowState showState);

BOOLEAN DVB_MhegGetSubtitlePref(void);

U8BIT DVB_MhegPrefSubtitleLangs(U32BIT *langs,U8BIT max);


#ifdef INCLUDE_FREESAT

E_MhegErr DVB_MhegDecodeImagePlaneIFrame( U8BIT *pVideoData,
   U32BIT dataLength,
   E_VideoEncoding encoding );


E_MhegErr DVB_MhegImagePlaneIFrameStop(void);

#endif /*INCLUDE_FREESAT*/

/*!**************************************************************************
 * @brief   Set Mheg scaling resolution for video
 * @param   width - width resolution
 * @param   height - height resolution
 * @return  None
 ****************************************************************************/
void DVB_MhegSetScalingResolution(U16BIT width, U16BIT height);

/*!**************************************************************************
 * @brief   Set Mheg video scaling
 * @param   scaling - scaling transformation (offset, size)
 * @return  None
 ****************************************************************************/
void DVB_MhegSetVideoScaling(S_RECTANGLE *scaling);

/*!**************************************************************************
 * @brief   Set display aspect ratio
 * @param   aspect - display aspect ratio
 * @return  None
 ****************************************************************************/
void DVB_MhegSetAspectRatio(E_ASPECT_RATIO aspect);

/*!**************************************************************************
 * @brief   Get display aspect ratio
 * @return  display aspect ratio
 ****************************************************************************/
E_ASPECT_RATIO DVB_MhegGetDisplayAspectRatio(void);

E_FORMAT_CONVERSION DVB_MhegGetDecoderFormatConversion(void);

void DVB_MhegSetVideoAlignment(E_VIDEO_ASPECT_MODE mode);

#endif /* _DVB_VIDEO_H */