summaryrefslogtreecommitdiffstats
path: root/libvideoeditor/osal/inc/M4OSA_FileReaderRam.h
blob: 04801925027a4646331806d31d9ecbfb20d0ba36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * Copyright (C) 2004-2011 NXP Software
 * Copyright (C) 2011 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 ******************************************************************************
 * @file         M4OSA_FileReaderRam.h
 * @ingroup      OSAL
 * @note         This file implements functions to read a "file" stored in RAM.
 ******************************************************************************
*/



#ifndef M4OSA_FILEREADERRAM_H
#define M4OSA_FILEREADERRAM_H

#include "M4OSA_FileReader.h"

/**
 ******************************************************************************
 * structure    M4FI_FileReaderRam_Descriptor
 * @brief        This structure defines the File descriptor (public)
 * @note        This structure is used to store the pointer to the data in memory
 * @note        and its size
 ******************************************************************************
*/
typedef struct
{
    M4OSA_MemAddr8    pFileDesc;    /* Pointer on file data */
    M4OSA_Int32        dataSize;    /* Size of data */
} M4OSA_FileReaderRam_Descriptor;

#ifdef __cplusplus
extern "C"
{
#endif

/* reader API : RAM functions */
M4OSA_ERR M4OSA_fileReadRamOpen( M4OSA_Context* context,
                                 M4OSA_Void* fileDescriptor,
                                 M4OSA_UInt32 fileModeAccess );
M4OSA_ERR M4OSA_fileReadRamData( M4OSA_Context context,
                                 M4OSA_MemAddr8 buffer,
                                 M4OSA_UInt32* size );
M4OSA_ERR M4OSA_fileReadRamSeek( M4OSA_Context context,
                                 M4OSA_FileSeekAccessMode seekMode,
                                 M4OSA_FilePosition* position );
M4OSA_ERR M4OSA_fileReadRamClose( M4OSA_Context context );
M4OSA_ERR M4OSA_fileReadRamGetOption( M4OSA_Context context,
                                      M4OSA_FileReadOptionID optionID,
                                      M4OSA_DataOption *optionValue );
M4OSA_ERR M4OSA_fileReadRamSetOption( M4OSA_Context context,
                                      M4OSA_FileReadOptionID optionID,
                                      M4OSA_DataOption optionValue );


#ifdef __cplusplus
}
#endif

#endif   /*M4OSA_FILEREADERRAM_H*/