| 1 | /*************************************************************************** |
|---|
| 2 | * Copyright (c) 2003-2006, Broadcom Corporation |
|---|
| 3 | * All Rights Reserved |
|---|
| 4 | * Confidential Property of Broadcom Corporation |
|---|
| 5 | * |
|---|
| 6 | * THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE |
|---|
| 7 | * AGREEMENT BETWEEN THE USER AND BROADCOM. YOU HAVE NO RIGHT TO USE OR |
|---|
| 8 | * EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT. |
|---|
| 9 | * |
|---|
| 10 | * $brcm_Workfile: $ |
|---|
| 11 | * $brcm_Revision: $ |
|---|
| 12 | * $brcm_Date: $ |
|---|
| 13 | * |
|---|
| 14 | * Module Description: |
|---|
| 15 | * |
|---|
| 16 | * Revision History: |
|---|
| 17 | * |
|---|
| 18 | * $brcm_Log: $ |
|---|
| 19 | * |
|---|
| 20 | ***************************************************************************/ |
|---|
| 21 | |
|---|
| 22 | #ifndef BSETTOP_H__ |
|---|
| 23 | #define BSETTOP_H__ |
|---|
| 24 | |
|---|
| 25 | #include "bsettop_types.h" |
|---|
| 26 | #include "bsettop_pcm.h" |
|---|
| 27 | #include "bsettop_stream.h" |
|---|
| 28 | #include "bsettop_decode.h" |
|---|
| 29 | #include "bsettop_display.h" |
|---|
| 30 | #include "bsettop_graphics.h" |
|---|
| 31 | #include "bsettop_user_io.h" |
|---|
| 32 | #include "bsettop_decode_audio.h" |
|---|
| 33 | |
|---|
| 34 | /*=******************************** |
|---|
| 35 | Universal include file for the Settop API. |
|---|
| 36 | |
|---|
| 37 | In order to call any function from the Settop API from your application, |
|---|
| 38 | you should include this and only this file. |
|---|
| 39 | ***********************************/ |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | #ifdef __cplusplus |
|---|
| 43 | extern "C" |
|---|
| 44 | { |
|---|
| 45 | #endif |
|---|
| 46 | |
|---|
| 47 | /* |
|---|
| 48 | Summary: |
|---|
| 49 | Use the BSETTOP_VERSION macro and ignore this type. |
|---|
| 50 | */ |
|---|
| 51 | typedef unsigned bsettop_version; |
|---|
| 52 | |
|---|
| 53 | /* |
|---|
| 54 | Summary: |
|---|
| 55 | Version macro which must be passed to bsettop_init(). |
|---|
| 56 | */ |
|---|
| 57 | #define BSETTOP_VERSION ((bsettop_version)0x0038) |
|---|
| 58 | |
|---|
| 59 | /* |
|---|
| 60 | Summary: |
|---|
| 61 | Initializes the settop API. |
|---|
| 62 | |
|---|
| 63 | Description: |
|---|
| 64 | Required before any other call. If you don't call it, some key functions will fail; |
|---|
| 65 | others will succeed but will result in undefined behavior. |
|---|
| 66 | |
|---|
| 67 | Use the BSETTOP_VERSION macro to pass the correct version. This verifies |
|---|
| 68 | at run-time that the correct shared library is being used. |
|---|
| 69 | */ |
|---|
| 70 | |
|---|
| 71 | bresult bsettop_init(bsettop_version version); |
|---|
| 72 | |
|---|
| 73 | |
|---|
| 74 | /* |
|---|
| 75 | Summary: |
|---|
| 76 | Releases resources |
|---|
| 77 | |
|---|
| 78 | Description: |
|---|
| 79 | This function is used to release resources allocated during bsettop_init. |
|---|
| 80 | User should call this function before exit from an application. |
|---|
| 81 | */ |
|---|
| 82 | |
|---|
| 83 | void bsettop_uninit(void); |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | /* |
|---|
| 87 | Summary: |
|---|
| 88 | Perform periodic power monitoring functions |
|---|
| 89 | */ |
|---|
| 90 | |
|---|
| 91 | void bsettop_pvt(void); |
|---|
| 92 | |
|---|
| 93 | #ifdef __cplusplus |
|---|
| 94 | } |
|---|
| 95 | #endif |
|---|
| 96 | |
|---|
| 97 | #endif /* BSETTOP_H__ */ |
|---|
