platform/inc/stbhwmediaplayer.h

Go to the documentation of this file.

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

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

/*---Enumerations for public use-----------------------------------------------*/
typedef enum
{
   STB_MP_STATE_STOPPED = 0,
   STB_MP_STATE_PLAYING,
   STB_MP_STATE_PAUSED,
   STB_MP_STATE_CONNECTING,
   STB_MP_STATE_BUFFERING,
   STB_MP_STATE_FINISHED,
   STB_MP_STATE_ERROR
} E_STB_MP_STATE;

typedef enum
{
   STB_MP_COMPONENT_VIDEO = 0,
   STB_MP_COMPONENT_AUDIO,
   STB_MP_COMPONENT_SUBTITLE,
   STB_MP_COMPONENT_ALL
} E_STB_MP_COMPONENT_TYPE;

typedef enum
{
   STB_MP_NO_ERROR = -1,              /* no error */
   STB_MP_FORMAT_NOT_SUPPORTED = 0,   /* 0 - A/V format not supported */
   STB_MP_CONNECTION_ERROR,           /* 1 - cannot connect to server or connection lost.*/
   STB_MP_UNDEFINED,                  /* 2 - unidentified error */
   STB_MP_NO_RESOURCES,               /* 3 – insufficient resources */
   STB_MP_CORRUPT,                    /* 4 – content corrupt or invalid */
   STB_MP_NOT_AVAILABLE,              /* 5 – content not available */
   STB_MP_NOT_AVAILABLE_POSITION,     /* 6 – content not available at given position */
   STB_MP_BLOCKED                     /* 7 - content blocked due to parental control */
} E_STB_MP_ERROR;

/*---Global type defs for public use-------------------------------------------*/
typedef struct
{
   U8BIT component_tag;
   U16BIT pid;
   E_STB_MP_COMPONENT_TYPE type;
   union
   {
      struct
      {
         E_STB_AV_AUDIO_CODEC encoding;
         U32BIT lang_code;
         U8BIT num_channels;
         BOOLEAN audio_description;
      } audio;
      struct
      {
         E_STB_AV_VIDEO_CODEC encoding;
         BOOLEAN hd;
         U8BIT frame_rate;
         E_STB_AV_ASPECT_RATIO aspect_ratio;
      } video;
      struct
      {
         U32BIT lang_code;
         BOOLEAN hearing_impaired;
      } subtitle;
   } av;
   BOOLEAN encrypted;
   BOOLEAN active;
} S_STB_MP_COMPONENT_DETAILS;

typedef void (*STB_MP_CALLBACK)(void *handle, E_STB_MP_STATE state);

typedef struct
{
   BOOLEAN cache; /* If TRUE, the media player is supposed to load the file and play it from memory */
   S32BIT loops; /* Number of times the file has to be played, -1 means infinite */
} S_STB_MP_START_PARAMS;

/*---Global Function prototypes for public use---------------------------------*/
void* STB_MPInit(U8BIT *source_url);

E_HW_STATUS STB_MPStart(void *handle, S_STB_MP_START_PARAMS *params);

E_HW_STATUS STB_MPPause(void *handle);

E_HW_STATUS STB_MPResume(void *handle);

E_HW_STATUS STB_MPResize(void *handle, S_RECTANGLE *rect);

E_HW_STATUS STB_MPStop(void *handle);

void STB_MPExit(void *handle);

E_HW_STATUS STB_MPGetTimes(void *handle, U32BIT *begin, U32BIT *current, U32BIT *end);

void STB_MPRegisterCallback(void *handle, STB_MP_CALLBACK callback);

E_HW_STATUS STB_MPSeek(void *handle, U32BIT position);

E_HW_STATUS STB_MPObtainComponentList(void *handle, E_STB_MP_COMPONENT_TYPE type,
   U32BIT *num_ptr, S_STB_MP_COMPONENT_DETAILS **list_ptr);

void STB_MPReleaseComponentList(void *handle, S_STB_MP_COMPONENT_DETAILS *list_ptr);

E_HW_STATUS STB_MPSelectComponent(void *handle, S_STB_MP_COMPONENT_DETAILS *component);

E_HW_STATUS STB_MPUnselectComponent(void *handle, S_STB_MP_COMPONENT_DETAILS *component);

E_STB_MP_ERROR STB_MPGetError(void *handle);

#endif /*  _STBHWMEDIAPLAYER_H */

/******************************************************************************
 * End of file
 ******************************************************************************/