1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28#ifndef MMAL_VC_OPAQUE_ALLOC_H
29#define MMAL_VC_OPAQUE_ALLOC_H
30
31
32#include <stdint.h>
33#include "interface/mmal/mmal.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39typedef uint32_t MMAL_OPAQUE_IMAGE_HANDLE_T;
40
41/** Allocate an opaque image on VideoCore.
42 *
43 * @return allocated handle, or zero if allocation failed.
44 */
45MMAL_OPAQUE_IMAGE_HANDLE_T mmal_vc_opaque_alloc(void);
46
47/** Allocate an opaque image on VideoCore, providing a description.
48 * @return allocated handle, or zero if allocation failed.
49 */
50MMAL_OPAQUE_IMAGE_HANDLE_T mmal_vc_opaque_alloc_desc(const char *description);
51
52/** Release an opaque image.
53 *
54 * @param handle handle allocated earlier
55 * @return MMAL_SUCCESS or error code if handle not found
56 */
57MMAL_STATUS_T mmal_vc_opaque_release(MMAL_OPAQUE_IMAGE_HANDLE_T h);
58
59/** Acquire an additional reference to an opaque image.
60 *
61 * @param handle handle allocated earlier
62 * @return MMAL_SUCCESS or error code if handle not found
63 */
64MMAL_STATUS_T mmal_vc_opaque_acquire(MMAL_OPAQUE_IMAGE_HANDLE_T h);
65
66
67#ifdef __cplusplus
68}
69#endif
70
71
72#endif
73
74