stbcc.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2020 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright (c) 2020 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
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef _STBCC_H
#define _STBCC_H

#include "techtype.h"
#include "stbhwav.h"

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

/*---Enumerations for public use-----------------------------------------------*/
typedef enum
{
   CC_FONT_STYLE_DEFAULT                = 0,
   CC_FONT_STYLE_MONOSPACE_SERIFS       = 1,
   CC_FONT_STYLE_PROPORTIONAL_SERIFS    = 2,
   CC_FONT_STYLE_MONOSPACE_NO_SERIFS    = 3,
   CC_FONT_STYLE_PROPORTIONAL_NO_SERIFS = 4,
   CC_FONT_STYLE_CASUAL                 = 5,
   CC_FONT_STYLE_CURSIVE                = 6,
   CC_FONT_STYLE_SMALL_CAPITALS         = 7,
   CC_FONT_STYLE_BROADCAST              = 255      /* Use broadcast font style */
} E_CC_FONT_STYLE;

typedef enum
{
   CC_TEXT_SIZE_SMALL      = 0,
   CC_TEXT_SIZE_STANDARD   = 1,
   CC_TEXT_SIZE_LARGE      = 2,
   CC_TEXT_SIZE_BROADCAST  = 3   /* Use broadcast text size */
} E_CC_TEXT_SIZE;


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

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

void STB_CCInitialise(void);

void STB_CCSetDisplayInfo(E_STB_AV_ASPECT_RATIO tv_aspect_ratio, U16BIT screen_width, U16BIT screen_height);

void STB_CCSetFont(E_CC_FONT_STYLE font_style, U8BIT *font_data, U32BIT font_size);

void STB_CCSetUserFontStyle(E_CC_FONT_STYLE font_style);

E_CC_FONT_STYLE STB_CCGetUserFontStyle(void);

void STB_CCSetUserTextSize(E_CC_TEXT_SIZE text_size);

E_CC_TEXT_SIZE STB_CCGetUserTextSize(void);

BOOLEAN STB_CCStart(U8BIT path, BOOLEAN digital_cc, U8BIT caption_service_number);

void STB_CCEnable(BOOLEAN enable);

void STB_CCStop(U8BIT path);

void STB_CCStatus(BOOLEAN *started, BOOLEAN *enabled);

#endif /*  _STBCC_H */