NdkImageReader.h revision c360382bf257d815b2a411152485d3c3b37a9f46 
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 * This file defines an NDK API.
19 * Do not remove methods.
20 * Do not change method signatures.
21 * Do not change the value of constants.
22 * Do not change the size of any of the classes defined in here.
23 * Do not reference types that are not part of the NDK.
24 * Do not #include files that aren't part of the NDK.
25 */
26
27#ifndef _NDK_IMAGE_READER_H
28#define _NDK_IMAGE_READER_H
29
30#include <android/native_window.h>
31#include "NdkMediaError.h"
32#include "NdkImage.h"
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38typedef struct AImageReader AImageReader;
39
40media_status_t AImageReader_new(
41        int32_t width, int32_t height, int32_t format, int32_t maxImages,
42        /*out*/AImageReader** reader);
43
44// Return all images acquired from this AImageReader back to system and delete
45// the AImageReader instance from memory
46// Do NOT use `reader` after this call
47void AImageReader_delete(AImageReader* reader);
48
49// Do NOT call ANativeWindow_release on the output. Just use AImageReader_delete.
50media_status_t AImageReader_getWindow(AImageReader*, /*out*/ANativeWindow** window);
51
52media_status_t AImageReader_getWidth(const AImageReader* reader, /*out*/int32_t* width);
53media_status_t AImageReader_getHeight(const AImageReader* reader, /*out*/int32_t* height);
54media_status_t AImageReader_getFormat(const AImageReader* reader, /*out*/int32_t* format);
55media_status_t AImageReader_getMaxImages(const AImageReader* reader, /*out*/int32_t* maxImages);
56
57media_status_t AImageReader_acquireNextImage(AImageReader* reader, /*out*/AImage** image);
58
59media_status_t AImageReader_acquireLatestImage(AImageReader* reader, /*out*/AImage** image);
60
61// The callback happens on one dedicated thread per AImageReader instance
62// It's okay to use AImageReader_*/AImage_* APIs within the callback
63typedef void (*AImageReader_ImageCallback)(void* context, AImageReader* reader);
64
65typedef struct AImageReader_ImageListener {
66    void*                      context; // optional application context.
67    AImageReader_ImageCallback onImageAvailable;
68} AImageReader_ImageListener;
69
70media_status_t AImageReader_setImageListener(
71        AImageReader* reader, AImageReader_ImageListener* listener);
72
73#ifdef __cplusplus
74} // extern "C"
75#endif
76
77#endif //_NDK_IMAGE_READER_H
78