mmal_component_private.h

Go to the documentation of this file.

/*
Copyright (c) 2012, Broadcom Europe Ltd
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the copyright holder nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef MMAL_COMPONENT_PRIVATE_H
#define MMAL_COMPONENT_PRIVATE_H

#ifdef __cplusplus
extern "C" {
#endif

#define MMAL_VIDEO_DECODE  "video_decode"
#define MMAL_VIDEO_ENCODE  "video_encode"
#define MMAL_VIDEO_RENDER  "video_render"
#define MMAL_AUDIO_DECODE  "audio_decode"
#define MMAL_AUDIO_ENCODE  "audio_encode"
#define MMAL_AUDIO_RENDER  "audio_render"
#define MMAL_CAMERA        "camera"

#if defined(__GNUC__) && (__GNUC__ > 2)
# define MMAL_CONSTRUCTOR(func) void __attribute__((constructor,used)) func(void)
# define MMAL_DESTRUCTOR(func) void __attribute__((destructor,used)) func(void)
#else
# define MMAL_CONSTRUCTOR(func) void func(void)
# define MMAL_DESTRUCTOR(func) void func(void)
#endif

#include "mmal.h"
#include "mmal_component.h"

struct MMAL_COMPONENT_PRIVATE_T
{
   struct MMAL_COMPONENT_MODULE_T *module;

   MMAL_STATUS_T (*pf_enable)(MMAL_COMPONENT_T *component);
   MMAL_STATUS_T (*pf_disable)(MMAL_COMPONENT_T *component);
   MMAL_STATUS_T (*pf_destroy)(MMAL_COMPONENT_T *component);

   MMAL_POOL_T *event_pool;

   int refcount;
   int refcount_ports;

   int priority;
};

MMAL_STATUS_T mmal_component_parameter_set(MMAL_PORT_T *control_port,
                                           const MMAL_PARAMETER_HEADER_T *param);

MMAL_STATUS_T mmal_component_parameter_get(MMAL_PORT_T *control_port,
                                           MMAL_PARAMETER_HEADER_T *param);

MMAL_STATUS_T mmal_component_action_register(MMAL_COMPONENT_T *component,
                                             void (*pf_action)(MMAL_COMPONENT_T *));

MMAL_STATUS_T mmal_component_action_deregister(MMAL_COMPONENT_T *component);

MMAL_STATUS_T mmal_component_action_trigger(MMAL_COMPONENT_T *component);

MMAL_STATUS_T mmal_component_action_lock(MMAL_COMPONENT_T *component);

MMAL_STATUS_T mmal_component_action_unlock(MMAL_COMPONENT_T *component);

typedef MMAL_STATUS_T (*MMAL_COMPONENT_SUPPLIER_FUNCTION_T)(const char *name,
                                                            MMAL_COMPONENT_T *component);

MMAL_STATUS_T mmal_component_create_with_constructor(const char *name,
   MMAL_STATUS_T (*constructor)(const char *name, MMAL_COMPONENT_T *),
   struct MMAL_COMPONENT_MODULE_T *constructor_private,
   MMAL_COMPONENT_T **component);

void mmal_component_supplier_register(const char *prefix,
                                      MMAL_COMPONENT_SUPPLIER_FUNCTION_T create_fn);

#ifdef __cplusplus
}
#endif

#endif /* MMAL_COMPONENT_PRIVATE_H */