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_EVENTS_PRIVATE_H
29#define MMAL_EVENTS_PRIVATE_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35#include "mmal_events.h"
36
37/** Send an error event through the component's control port.
38 * The error event data will be the MMAL_STATUS_T passed in.
39 *
40 * @param component component to receive the error event.
41 * @param status the error status to be sent.
42 * @return MMAL_SUCCESS or an error if the event could not be sent.
43 */
44MMAL_STATUS_T mmal_event_error_send(MMAL_COMPONENT_T *component, MMAL_STATUS_T status);
45
46/** Send an eos event through a specific port.
47 *
48 * @param port port to receive the error event.
49 * @return MMAL_SUCCESS or an error if the event could not be sent.
50 */
51MMAL_STATUS_T mmal_event_eos_send(MMAL_PORT_T *port);
52
53/** Forward an event onto an output port.
54 * This will allocate a new event buffer on the output port, make a copy
55 * of the event buffer which will then be forwarded.
56 *
57 * @event event to forward.
58 * @param port port to forward event to.
59 * @return MMAL_SUCCESS or an error if the event could not be forwarded.
60 */
61MMAL_STATUS_T mmal_event_forward(MMAL_BUFFER_HEADER_T *event, MMAL_PORT_T *port);
62
63#ifdef __cplusplus
64}
65#endif
66
67#endif /* MMAL_EVENTS_PRIVATE_H */
68