video_input.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer
00021 * Copyright (C) 2012 - 2014 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**
00024 * @file  video_input.h
00025 * @brief   $Module: CLibCommon $ $PublicVersion: 1.00 $ (=CLIB_VERSION)
00026 * $Rev: 47 $
00027 * $Date:: 2014-01-06 18:18:48 +0900#$
00028 * - Description: V-Sync porting layer
00029 */
00030 
00031 #ifndef  VIDEO_INPUT_H
00032 #define  VIDEO_INPUT_H
00033 
00034 /******************************************************************************
00035 Includes   <System Includes> , "Project Includes"
00036 ******************************************************************************/
00037 #include  "video_input_typedef.h "
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif /* __cplusplus */
00042 
00043 
00044 /******************************************************************************
00045 Typedef definitions
00046 ******************************************************************************/
00047 /* In "video_input_typedef.h" */
00048 
00049 /******************************************************************************
00050 Macro definitions
00051 ******************************************************************************/
00052 /* In "video_input_typedef.h" */
00053 
00054 /******************************************************************************
00055 Variable Externs
00056 ******************************************************************************/
00057 /* In "video_input_typedef.h" */
00058 
00059 /******************************************************************************
00060 Functions Prototypes
00061 ******************************************************************************/
00062 
00063 
00064 /**
00065 * @brief   R_VIDEO_INPUT_InitConst
00066 *
00067 * @param   self video_input_t
00068 * @return  None
00069 */
00070 void  R_VIDEO_INPUT_InitConst( video_input_t *const  self );
00071 
00072 
00073 /**
00074 * @brief   R_VIDEO_INPUT_Initialize
00075 *
00076 * @param   self video_input_t
00077 * @param   in_out_Config Configuration
00078 * @return  Error Code. 0=No Error.
00079 *
00080 * @par Description
00081 *    "R_WINDOW_SURFACES_SwapBuffers" must be called after calling this
00082 *    function for showing video layer.
00083 *    Set "window_surfaces_config_t::background_mode" = "BACKGROUND_MODE_VIDEO_INTERLACE"
00084 */
00085 errnum_t  R_VIDEO_INPUT_Initialize( video_input_t *const  self,
00086                                     video_input_config_t *in_out_Config );
00087 
00088 
00089 /**
00090 * @brief   R_VIDEO_INPUT_Finalize
00091 *
00092 * @param   self video_input_t
00093 * @param   e Errors that have occurred. No error = 0
00094 * @return  Error code or e, 0 = successful and input e=0
00095 */
00096 errnum_t  R_VIDEO_INPUT_Finalize( video_input_t *const  self, errnum_t e );
00097 
00098 
00099 #ifdef __cplusplus
00100 }  /* extern "C" */
00101 #endif /* __cplusplus */
00102 
00103 #endif