/******************************************************************************
 *    (c)2008-2009 Broadcom Corporation
 *
 * This program is the proprietary software of Broadcom Corporation and/or its licensors,
 * and may only be used, duplicated, modified or distributed pursuant to the terms and
 * conditions of a separate, written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
 * no license (express or implied), right to use, or waiver of any kind with respect to the
 * Software, and Broadcom expressly reserves all rights in and to the Software and all
 * intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
 * HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
 * NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.
 *
 * Except as expressly set forth in the Authorized License,
 *
 * 1.     This program, including its structure, sequence and organization, constitutes the valuable trade
 * secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of Broadcom integrated circuit products.
 *
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 * AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 * THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
 * LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
 * OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
 * USE OR PERFORMANCE OF THE SOFTWARE.
 *
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
 * LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
 * EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
 * USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
 * ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
 * LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
 * ANY LIMITED REMEDY.
 *
 * $brcm_Workfile:  $
 * $brcm_Revision:  $
 * $brcm_Date:  $
 *
 * Module Description:
 *
 * Manage application settings like volume, channel map, etc.
 *
 * Revision History:
 *
 * Created: 09/28/2009 by Jeff Fisher
 *
 * $brcm_Log:  $
 * 
 *
 *****************************************************************************/
#ifndef BAPP_SETTINGS_H__
#define BAPP_SETTINGS_H__

#include "bapp_types.h"
#define MAX_CH_NAME_CHARS 		32
#define MAX_CHANNELS            256
#define RRT_BUF_LEN        		(1024 + 188)

#define MAX_RRT_DIM				128
#define MAX_RRT_VAL				16
/* 
 * Structure defining a unit of data storage
 */
typedef struct bapp_ch_t
{
    unsigned int major      : 10;
    unsigned int minor      : 10;
    unsigned int freq_idx   : 8;
    unsigned int psi        : 1;
    unsigned int pcr_pid    : 13;
    unsigned int video_pid  : 13;
    unsigned int has_lang   : 3;
	unsigned int hidden     : 1;
    unsigned short audio_pid[3];
    unsigned short ch_name[MAX_CH_NAME_CHARS];
}bapp_ch_t;

/**
Summary:
	main application reference obtained bapp_open
**/
typedef struct bapp_settings_t
{
    unsigned int sound                 : 2;
    unsigned int picture               : 1;
    unsigned int language              : 2;
    unsigned int auto_power            : 2;
    unsigned int wiz_completed         : 1;
    unsigned int ratings_lock          : 2;
    unsigned int ratings_tv            : 18;
    unsigned int ratings_movies        : 7;
    unsigned int content_d             : 1;
    unsigned int content_l             : 1;
    unsigned int content_s             : 1;
    unsigned int content_v             : 1;
	unsigned int captions_basic        : 4;
	unsigned int captions_font         : 3;
	unsigned int captions_font_size    : 2;
	unsigned int captions_font_style   : 2;
	unsigned int captions_font_color   : 4;
	unsigned int captions_font_opacity : 3;
	unsigned int captions_back_color   : 4;
	unsigned int captions_back_opacity : 3;
	unsigned int captions_edge_color   : 4;
	unsigned int captions_edge_type    : 3;
	unsigned int auto_power_off        : 1;
	unsigned int rrt_status            : 2;
	unsigned int time_zone	           : 4;
	unsigned int dst	               : 1;
    unsigned int cur_ch_num            : 8;
    unsigned int audio_vol             : 7;
	unsigned int last_rrt_id           : 16;
    unsigned int pin                   : 32;
    unsigned char num_channels;
    unsigned short ratings_rrt[MAX_RRT_DIM];
    unsigned char rrt[RRT_BUF_LEN];
    bapp_ch_t ch[MAX_CHANNELS];
}bapp_settings_t;

#ifdef __cplusplus
extern "C" {
#endif

/**
Summary:
	Initialize settings to default values.
**/

bapp_result_t bapp_settings_init(bapp_settings_t *p_settings);


/**
Summary:
	Save the settings.
**/
bapp_result_t bapp_settings_save(bapp_settings_t *p_settings);

/**
Summary:
	Load the settings.
**/
bapp_result_t bapp_settings_load(bapp_settings_t *p_settings);

#ifdef __cplusplus
}
#endif

#endif /* BAPP_SETTINGS_H__ */