mh5dispBttnRT.c

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
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include <string.h>

#include "mh5application.h"
#include "mh5base.h"
#include "mh5display.h"
#include "mh5classes.h"
#include "mh5queue.h"
#include "mh5object.h"
#include "mh5final.h"
#include "mh5drawtext.h"
#include "mg_api.h"
#include "mh5memory.h"
#include "mh5profile.h"
#include "mh5streamevent.h"
#include "mh5debug.h"
#include "mh5dvpos.h"
#include "tmcolor.h"
#include "mh5dispBttnRT.h"

/*---constant definitions for this file--------------------------------------*/

#define MAX(a, b)   (((a) > (b)) ? (a) : (b))
#define MIN(a, b)   (((a) < (b)) ? (a) : (b))


/*---local typedef structs for this file-------------------------------------*/

/*---local (static) variable declarations for this file----------------------*/
#ifndef MHEG5PROFILE_UK1_06

/* Flag to indicate whether an RTGraphics object is currently playing */
static MHEG5Bool rtgraphicsPlaying = MHEG5FALSE;
/* Flag to indicate whether the current RTGraphics object is frozen */
static MHEG5Bool rtgraphicsFreeze = MHEG5FALSE;

/* Multiplex reference for the currently playing RTGraphics object, and a flag
 * to indicate that this has been updated.
 */
static S_DvbLocator rtgraphicsMultiplexReference;
static MHEG5Bool rtgraphicsMultiplexReferenceChanged;

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

void OSDrtgraphicsPlay(S_DvbLocator *multiplexReference,
   MHEG5Bool terminating)
{
   INFO_PRINT(("OSDrtgraphicsPlay((0x%x 0x%x 0x%x 0x%x))\n", multiplexReference->originalNetworkId, multiplexReference->transportStreamId, multiplexReference->serviceId, multiplexReference->componentTag));
}

void OSDrtgraphicsFreeze(void)
{
   INFO_PRINT(("OSDrtgraphicsFreeze()\n"));
}

void OSDrtgraphicsStop(void)
{
   INFO_PRINT(("OSDrtgraphicsStop()\n"));
}

static void OSDdisplayRectangle(int x,
   int y,
   int width,
   int height,
   int lineWidth,
   int lineStyle,
   OSDColor lineColour,
   OSDColor fillColour)
{
   const S_REGION overlap = {0, 0, 720, 576};
   MG_OSDdisplayRectangle( &overlap, x, y, width, height, lineWidth, lineColour, fillColour);
}

/*
     Generic Display Part
 */

void MHEG5displayLineart(int x1, int y1, int boxX1, int boxY1, int boxX2, int boxY2,
   MHEG5Bool bbbox, MHEG5Int lineWidth, MHEG5Int lineStyle,
   MHEG5Colour *refLineColour, MHEG5Colour *refFillColour)
{
   OSDColor lineColour, fillColour;

   lineColour = MHEG5displayColour(refLineColour);
   fillColour = MHEG5displayColour(refFillColour);

   if (bbbox)
      OSDdisplayRectangle(boxX1, boxY1, boxX2 - boxX1, boxY2 - boxY1, lineWidth, lineStyle, lineColour, fillColour);
/*
     ToDo: What shall be displayed here ?
 */
}

void MHEG5displayHotspot(MHEG5Visible *visible, int x1, int y1, int x2, int y2)
{
   MHEG5Colour backgroundColour;
   MHEG5Colour *pBorderColour = NULL;

   if (((MHEG5Button *)visible)->selectionStatus)
   {
      if (((MHEG5Button *) visible)->buttonColour.type == MHEG5NONE)
      {
         pBorderColour = &(MHEG5getCurrentApplication()->buttonRefColour);
      }
      else
      {
         pBorderColour = &((MHEG5Button *) visible)->buttonColour;
      }
   }
   else if (((MHEG5Button *)visible)->interactible.highlightStatus &&
            ((MHEG5Button *)visible)->interactible.engineResp)
   {
      if (((MHEG5Button *) visible)->interactible.highlightRefColour.type == MHEG5NONE)
      {
         pBorderColour = &(MHEG5getCurrentApplication()->highlightRefColour);
      }
      else
      {
         pBorderColour = &((MHEG5Button *) visible)->interactible.highlightRefColour;
      }
   }

   if (pBorderColour)
   {
      MHEG5genericSet(&backgroundColour, FULLY_TRANSPARENT);

      MHEG5displayLineart(visible->position[0], visible->position[1], x1, y1, x2, y2,
         MHEG5TRUE,
         2, MHEG_LINE_STYLE_SOLID,
         pBorderColour, &backgroundColour);
   }
}

void MHEG5displayPushbutton(MHEG5Visible *visible, int x1, int y1, int x2, int y2)
{
   MHEG5Button *button = (MHEG5Button *)visible;
   MHEG5Pushbutton *pushbutton = (MHEG5Pushbutton *)visible;
   unsigned char black[4], white[4];
   MHEG5Colour *pButtonColour;
   MHEG5Colour *pHighlightRefColour;

   if (button->buttonColour.type == MHEG5NONE)
   {
      pButtonColour = &(MHEG5getCurrentApplication()->buttonRefColour);
   }
   else
   {
      pButtonColour = &button->buttonColour;
   }

   if (button->interactible.highlightRefColour.type == MHEG5NONE)
   {
      pHighlightRefColour = &(MHEG5getCurrentApplication()->highlightRefColour);
   }
   else
   {
      pHighlightRefColour = &button->interactible.highlightRefColour;
   }

   white[3] = black[3] = 0;
   white[0] = white[1] = white[2] = 200;
   black[0] = black[1] = black[2] = 50;

   /* Draw background of the button */
   OSDdisplayRectangle(visible->position[0], visible->position[1],
      visible->boxSize[0], visible->boxSize[1],
      1, MHEG_LINE_STYLE_SOLID, MHEG5displayColour(pButtonColour),
      MHEG5displayColour(pButtonColour));

   if (pushbutton->label.len > 0)
   {
      MHEG5Text *text;

      text = (MHEG5Text *)MHEG5getMem(sizeof(MHEG5Text));
      if (text != 0)
      {
         memset(text, 0, sizeof(MHEG5Text));
         ((MHEG5Root *))text->class = MHEG5TEXT;

         text->visible.boxSize[0] = visible->boxSize[0];
         text->visible.boxSize[1] = visible->boxSize[1];
         text->visible.position[0] = visible->position[0];
         text->visible.position[1] = visible->position[1];

         text->fontAttributes = MHEG5stringCopyChr("plain.24.28.0");
         text->horizontalJustification = HJUSTIFICATION_CENTRE;
         text->verticalJustification = VJUSTIFICATION_CENTRE;

         if (pushbutton->characterSet == 0)
         {
            pushbutton->characterSet = MHEG5getCurrentApplication()->characterSet;
            if (pushbutton->characterSet == 0)
            {
               pushbutton->characterSet = 10;
            }
         }
         text->characterSet = pushbutton->characterSet;

         MHEG5genericSet(&text->textColour, RGBT(0, 0, 0, 0));
         MHEG5genericSet(&text->backgroundColour, FULLY_TRANSPARENT );
         MHEG5textContentAdapt(text, pushbutton->label.data, pushbutton->label.len);
         MHEG5drawText((MHEG5Text *)visible);
         MHEG5textDestruct(text);
         MHEG5textFree(text);
         MHEG5freeMem(text);
      }
   }

   if (((MHEG5Button *)visible)->selectionStatus)
   {
      OSDdisplayRectangle(visible->position[0], visible->position[1],
         visible->boxSize[0], 3,
         1, MHEG_LINE_STYLE_SOLID,
         OSDgetColour((char *)black, 4), OSDgetColour((char *)black, 4));
      OSDdisplayRectangle(visible->position[0], visible->position[1],
         3, visible->boxSize[1],
         1, MHEG_LINE_STYLE_SOLID,
         OSDgetColour((char *)black, 4), OSDgetColour((char *)black, 4));
      OSDdisplayRectangle(visible->position[0] + visible->boxSize[0] - 3, visible->position[1],
         3, visible->boxSize[1],
         1, MHEG_LINE_STYLE_SOLID,
         OSDgetColour((char *)white, 4), OSDgetColour((char *)white, 4));
      OSDdisplayRectangle(visible->position[0], visible->position[1] + visible->boxSize[1] - 3,
         visible->boxSize[0], 3,
         1, MHEG_LINE_STYLE_SOLID,
         OSDgetColour((char *)white, 4), OSDgetColour((char *)white, 4));
      return;
   }
   if (((MHEG5Button *)visible)->interactible.highlightStatus &&
       ((MHEG5Button *)visible)->interactible.engineResp)
   {
      OSDdisplayRectangle(visible->position[0], visible->position[1],
         visible->boxSize[0], 3,
         1, MHEG_LINE_STYLE_SOLID,
         MHEG5displayColour(pHighlightRefColour),
         MHEG5displayColour(pHighlightRefColour));
      OSDdisplayRectangle(visible->position[0], visible->position[1],
         3, visible->boxSize[1],
         1, MHEG_LINE_STYLE_SOLID,
         MHEG5displayColour(pHighlightRefColour),
         MHEG5displayColour(pHighlightRefColour));
      OSDdisplayRectangle(visible->position[0] + visible->boxSize[0] - 3, visible->position[1],
         3, visible->boxSize[1],
         1, MHEG_LINE_STYLE_SOLID,
         MHEG5displayColour(pHighlightRefColour),
         MHEG5displayColour(pHighlightRefColour));
      OSDdisplayRectangle(visible->position[0], visible->position[1] + visible->boxSize[1] - 3,
         visible->boxSize[0], 3,
         1, MHEG_LINE_STYLE_SOLID,
         MHEG5displayColour(pHighlightRefColour),
         MHEG5displayColour(pHighlightRefColour));
      return;
   }
   OSDdisplayRectangle(visible->position[0], visible->position[1],
      visible->boxSize[0], 3,
      1, MHEG_LINE_STYLE_SOLID, OSDgetColour((char *)white, 4), OSDgetColour((char *)white, 4));
   OSDdisplayRectangle(visible->position[0], visible->position[1],
      3, visible->boxSize[1],
      1, MHEG_LINE_STYLE_SOLID, OSDgetColour((char *)white, 4), OSDgetColour((char *)white, 4));
   OSDdisplayRectangle(visible->position[0] + visible->boxSize[0] - 3, visible->position[1],
      3, visible->boxSize[1],
      1, MHEG_LINE_STYLE_SOLID, OSDgetColour((char *)black, 4), OSDgetColour((char *)black, 4));
   OSDdisplayRectangle(visible->position[0], visible->position[1] + visible->boxSize[1] - 3,
      visible->boxSize[0], 3,
      1, MHEG_LINE_STYLE_SOLID, OSDgetColour((char *)black, 4), OSDgetColour((char *)black, 4));
}

void MHEG5displaySwitchbutton(MHEG5Visible *visible, int x1, int y1, int x2, int y2)
{
   MHEG5Switchbutton *switchbutton = (MHEG5Switchbutton *)visible;
   MHEG5Text *text;
   MHEG5Button *button = (MHEG5Button *)visible;
   MHEG5Pushbutton *pushbutton = (MHEG5Pushbutton *)visible;
   void *canvas;
   int h = y2 - y1;
   MHEG5Colour *pButtonColour;
   MHEG5Colour *pHighlightRefColour;

   if (switchbutton->style == MHEG5PUSHBUTTONS)
   {
      MHEG5displayPushbutton(visible, x1, y1, x2, y2);
      return;
   }

   if (((MHEG5Button *) visible)->buttonColour.type == MHEG5NONE)
   {
      pButtonColour = &(MHEG5getCurrentApplication()->buttonRefColour);
   }
   else
   {
      pButtonColour = &((MHEG5Button *) visible)->buttonColour;
   }

   if (button->interactible.highlightRefColour.type == MHEG5NONE)
   {
      pHighlightRefColour = &(MHEG5getCurrentApplication()->highlightRefColour);
   }
   else
   {
      pHighlightRefColour = &button->interactible.highlightRefColour;
   }

   if (h < 0)
   {
      h = 0;
   }

   /* Draw the button lable */
   text = (MHEG5Text *)MHEG5getMem(sizeof(MHEG5Text));
   if (text != 0)
   {
      memset(text, 0, sizeof(MHEG5Text));
      ((MHEG5Root *))text->class = MHEG5TEXT;

      text->visible.boxSize[0] = visible->boxSize[0] - visible->boxSize[1];
      text->visible.boxSize[1] = visible->boxSize[1];
      text->visible.position[0] = visible->position[0] + visible->boxSize[1];
      text->visible.position[1] = visible->position[1];

      text->fontAttributes = MHEG5stringCopyChr("plain.24.28.0");
      text->horizontalJustification = HJUSTIFICATION_START;
      text->verticalJustification = VJUSTIFICATION_CENTRE;

      if (pushbutton->characterSet == 0)
      {
         pushbutton->characterSet = MHEG5getCurrentApplication()->characterSet;
         if (pushbutton->characterSet == 0)
         {
            pushbutton->characterSet = 10;
         }
      }
      text->characterSet = pushbutton->characterSet;

      MHEG5genericSet(&text->textColour, RGBT(0, 0, 0, 0));
      MHEG5genericCopy(&text->backgroundColour, pButtonColour);
      if (pushbutton->label.len > 0)
      {
         MHEG5textContentAdapt(text, pushbutton->label.data, pushbutton->label.len);
      }
      MHEG5drawText((MHEG5Text *)visible);
      MHEG5textDestruct(text);
      MHEG5textFree(text);
      MHEG5freeMem(text);
   }

   canvas = OSDinitDynamicLineart(h, h, 1, 0,
         MHEG5displayColour(pHighlightRefColour),
         MHEG5displayColour(pButtonColour));
   if (!canvas)
      return;
   if (switchbutton->style == MHEG5RADIOBUTTON)
   {
      /* Draw the radio button outer circle, depending on the highlight status */
      if (((MHEG5Button *)visible)->interactible.highlightStatus &&
          ((MHEG5Button *)visible)->interactible.engineResp)
      {
         OSDdrawEllipse(canvas, 3, 3, h - 6, h - 6, 6,
            MHEG5displayColour(pHighlightRefColour),
            MHEG5displayColour(pButtonColour));
      }
      else
      {
         OSDdrawEllipse(canvas, 4, 4, h - 8, h - 8, 3,
            MHEG5displayColour(pHighlightRefColour),
            MHEG5displayColour(pButtonColour));
      }

      /* If selected, draw a centre circle */
      if (((MHEG5Button *)visible)->selectionStatus)
      {
         OSDdrawEllipse(canvas, 8, 8, h - 16, h - 16, 0,
            MHEG5displayColour(pHighlightRefColour),
            MHEG5displayColour(pHighlightRefColour));
      }
   }
   else
   {
      if (((MHEG5Button *)visible)->interactible.highlightStatus &&
          ((MHEG5Button *)visible)->interactible.engineResp)
      {
         OSDdrawRectangle(canvas, 4, 4, h - 4, h - 4, 6,
            MHEG5displayColour(pHighlightRefColour),
            MHEG5displayColour(pButtonColour));
      }
      else
      {
         OSDdrawRectangle(canvas, 4, 4, h - 4, h - 4, 3,
            MHEG5displayColour(pHighlightRefColour),
            MHEG5displayColour(pButtonColour));
      }
      if (((MHEG5Button *)visible)->selectionStatus)
      {
         OSDdrawDrawLine(canvas, 4, 4, h - 4, h - 4, 3,
            MHEG5displayColour(pHighlightRefColour));
         OSDdrawDrawLine(canvas, 4, h - 4, h - 4, 4, 3,
            MHEG5displayColour(pHighlightRefColour));
      }
   }
   OSDdisplayDynamicLineart(canvas, x1, y1);
   OSDfreeDynamicLineart(canvas);
}

void MHEG5displayRTGraphics(MHEG5RTGraphics *rtgraphics, int x1, int y1, int x2, int y2)
{
   int rtX1, rtY1, rtX2, rtY2;

   /* Calculate the video window */
   rtX1 = rtgraphics->visible.position[0];
   rtY1 = rtgraphics->visible.position[1];
   rtX2 = rtgraphics->visible.position[0] + rtgraphics->visible.boxSize[0];
   rtY2 = rtgraphics->visible.position[1] + rtgraphics->visible.boxSize[1];

   /* Clip top left and bottom right to clipping rectangle */
   rtX1 = MAX(x1, rtX1);
   rtY1 = MAX(y1, rtY1);
   rtX2 = MIN(x2, rtX2);
   rtY2 = MIN(y2, rtY2);

   OSDdisplayVideo(rtX1, rtY1, rtX2 - rtX1, rtY2 - rtY1);
}

void MHEG5displayRtgraphicsPlay(MHEG5RTGraphics *rtgraphics)
{
   assert(rtgraphics);

   rtgraphicsPlaying = MHEG5TRUE;

   if (rtgraphics->parent->speed[0] == 0)
   {
      rtgraphicsFreeze = MHEG5TRUE;
   }
   else
   {
      MHEG5Int componentTag = MHEG5streamGetComponentTag((MHEG5Ingredient *)rtgraphics);

      rtgraphicsFreeze = MHEG5FALSE;

      /* Extract the multiplex reference from the stream. The componentTag
       * is extracted from the rtgraphics object to reference a specific
       * component within the multiplex.
       */
      if ((rtgraphicsMultiplexReference.serviceId != rtgraphics->parent->multiplexRef.serviceId) ||
          (rtgraphicsMultiplexReference.originalNetworkId != rtgraphics->parent->multiplexRef.originalNetworkId) ||
          (rtgraphicsMultiplexReference.transportStreamId != rtgraphics->parent->multiplexRef.transportStreamId) ||
          (rtgraphicsMultiplexReference.componentTag != componentTag))
      {
         rtgraphicsMultiplexReference.originalNetworkId = rtgraphics->parent->multiplexRef.originalNetworkId;
         rtgraphicsMultiplexReference.transportStreamId = rtgraphics->parent->multiplexRef.transportStreamId;
         rtgraphicsMultiplexReference.serviceId = rtgraphics->parent->multiplexRef.serviceId;
         rtgraphicsMultiplexReference.componentTag = componentTag;

         /* Indicate that we have updated the rtgraphics multiplex reference */
         MHEG5streamSetCurrentService((MHEG5Ingredient *)rtgraphics,
            &rtgraphicsMultiplexReference);
         rtgraphicsMultiplexReferenceChanged = MHEG5TRUE;
      }
   }
}

void MHEG5displayRtGraphicsReset(void)
{
   /* Switch subtitles on when MHEG-5 is not running */
   rtgraphicsPlaying = MHEG5TRUE;
   rtgraphicsFreeze = MHEG5FALSE;
   memset(&rtgraphicsMultiplexReference, 0, sizeof(rtgraphicsMultiplexReference));
}

void MHEG5displayRtGraphicsUpdate( MHEG5Bool terminating, MHEG5Bool fullScreen )
{
   static MHEG5Bool lastRtgraphicsPlaying = MHEG5TRUE;
   static MHEG5Bool lastRtgraphicsFreeze = MHEG5FALSE;
   MHEG5Bool newRtgraphicsPlaying;

   /* RTGraphics playing state, freeze state, and selected stream */
   newRtgraphicsPlaying = rtgraphicsPlaying;
   if (!fullScreen)
   {
      /* Disable RTGraphics when we are scaled to 1/4 screen */
      newRtgraphicsPlaying = MHEG5FALSE;
   }

   if ((lastRtgraphicsPlaying != newRtgraphicsPlaying) ||
       (lastRtgraphicsFreeze != rtgraphicsFreeze) ||
       rtgraphicsMultiplexReferenceChanged)
   {
      if (newRtgraphicsPlaying)
      {
         if (rtgraphicsFreeze)
         {
            OSDrtgraphicsFreeze();
         }
         else
         {
            OSDrtgraphicsPlay(&rtgraphicsMultiplexReference, terminating);
         }
      }
      else
      {
         OSDrtgraphicsStop();
      }

      lastRtgraphicsPlaying = newRtgraphicsPlaying;
      lastRtgraphicsFreeze = rtgraphicsFreeze;
      rtgraphicsMultiplexReferenceChanged = MHEG5FALSE;
   }
}

void MHEG5displayRtgraphicsStop(MHEG5Bool immediate)
{
   rtgraphicsPlaying = MHEG5FALSE;

   if (immediate)
   {
      MHEG5displayRtGraphicsUpdate(MHEG5TRUE, MHEG5TRUE);
   }
}

#endif /* !MHEG5PROFILE_UK1_06 */