NdkImageReader.h revision 3e49be17d8c8c53f50bb0d39affbbc36f6a12488 
1/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/**
18 * @addtogroup Media Camera
19 * @{
20 */
21
22/**
23 * @file NdkImageReader.h
24 */
25
26/*
27 * This file defines an NDK API.
28 * Do not remove methods.
29 * Do not change method signatures.
30 * Do not change the value of constants.
31 * Do not change the size of any of the classes defined in here.
32 * Do not reference types that are not part of the NDK.
33 * Do not #include files that aren't part of the NDK.
34 */
35
36#ifndef _NDK_IMAGE_READER_H
37#define _NDK_IMAGE_READER_H
38
39#include <android/native_window.h>
40#include "NdkMediaError.h"
41#include "NdkImage.h"
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47typedef struct AImageReader AImageReader;
48
49media_status_t AImageReader_new(
50        int32_t width, int32_t height, int32_t format, int32_t maxImages,
51        /*out*/AImageReader** reader);
52
53// Return all images acquired from this AImageReader back to system and delete
54// the AImageReader instance from memory
55// Do NOT use `reader` after this call
56void AImageReader_delete(AImageReader* reader);
57
58// Do NOT call ANativeWindow_release on the output. Just use AImageReader_delete.
59media_status_t AImageReader_getWindow(AImageReader*, /*out*/ANativeWindow** window);
60
61media_status_t AImageReader_getWidth(const AImageReader* reader, /*out*/int32_t* width);
62media_status_t AImageReader_getHeight(const AImageReader* reader, /*out*/int32_t* height);
63media_status_t AImageReader_getFormat(const AImageReader* reader, /*out*/int32_t* format);
64media_status_t AImageReader_getMaxImages(const AImageReader* reader, /*out*/int32_t* maxImages);
65
66media_status_t AImageReader_acquireNextImage(AImageReader* reader, /*out*/AImage** image);
67
68media_status_t AImageReader_acquireLatestImage(AImageReader* reader, /*out*/AImage** image);
69
70// The callback happens on one dedicated thread per AImageReader instance
71// It's okay to use AImageReader_*/AImage_* APIs within the callback
72typedef void (*AImageReader_ImageCallback)(void* context, AImageReader* reader);
73
74typedef struct AImageReader_ImageListener {
75    void*                      context; // optional application context.
76    AImageReader_ImageCallback onImageAvailable;
77} AImageReader_ImageListener;
78
79media_status_t AImageReader_setImageListener(
80        AImageReader* reader, AImageReader_ImageListener* listener);
81
82#ifdef __cplusplus
83} // extern "C"
84#endif
85
86#endif //_NDK_IMAGE_READER_H
87
88/** @} */
89