libcamera3/common/ExynosCameraNode.h

/*
 * Copyright 2017, Samsung Electronics Co. LTD
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed toggle an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*!
 * \file      ExynosCameraNode.h
 * \brief     hearder file for ExynosCameraNode
 * \author    Pilsun Jang(pilsun.jang@samsung.com)
 * \date      2013/6/27
 *
 */

#ifndef EXYNOS_CAMERA_NODE_H__
#define EXYNOS_CAMERA_NODE_H__

#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <signal.h>
#include <sys/mman.h>
#include <sys/time.h>
#include <sys/ioctl.h>
#include <sys/poll.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <utils/threads.h>

#include <videodev2.h>
#include <videodev2_exynos_camera.h>
#include <linux/vt.h>

#include <utils/RefBase.h>
#include <utils/String8.h>
#include <utils/List.h>
#include <utils/Log.h>
#include "cutils/properties.h"
#include <hardware/exynos/ion.h>

#include "exynos_format.h"
#include "ExynosCameraObject.h"
#include "ExynosCameraBuffer.h"
#include "ExynosRect.h"
/* #include "ExynosFrame.h" */
#include "ExynosCameraAutoTimer.h"

#include "ExynosJpegEncoderForCamera.h"
#include "exynos_v4l2.h"

#include "fimc-is-metadata.h"

/* #include "ExynosCameraState.h" */
#include "ExynosCameraConfig.h"

using namespace android;

namespace android {
/* #define EXYNOS_CAMERA_NODE_TRACE */
/* #define EXYNOS_CAMERA_NODE_TRACE_Q_DURATION */
/* #define EXYNOS_CAMERA_NODE_TRACE_DQ_DURATION */

#ifdef EXYNOS_CAMERA_NODE_TRACE
#define EXYNOS_CAMERA_NODE_IN()   CLOGD("IN...m_nodeState[%d]", m_nodeState)
#define EXYNOS_CAMERA_NODE_OUT()  CLOGD("OUT..m_nodeState[%d]", m_nodeState)
#else
#define EXYNOS_CAMERA_NODE_IN()   ((void *)0)
#define EXYNOS_CAMERA_NODE_OUT()  ((void *)0)
#endif

/* ExynosCameraNode
 *
 * ingroup Exynos
 */

/*
 * Mapping table
 *
 * |------------------------------------------------------------------
 * | ExynosCamera        | ExynosCameraNode             | Driver IOCTL
 * |------------------------------------------------------------------
 * | setSize()           | setSize() - NONE             | S_FMT
 * | setColorFormat()    | setColorFormat() - NONE      | S_FMT
 * | setBufferType()     | setBufferTyoe() - NONE       | S_FMT
 * | prepare()           | prepare() - m_setInput()     | S_INPUT
 * |                     | prepare() - m_setFmt()       | S_FMT
 * | reqBuffer()         | reqBuffer() - m_reqBuf()     | REQ_BUF
 * | queryBuffer()       | queryBuffer() - m_queryBuf() | QUERY_BUF
 * | setBuffer()         | setBuffer() - m_qBuf()       | Q_BUF
 * | getBuffer()         | getBuffer() - m_qBuf()       | Q_BUF
 * | putBuffer()         | putBuffer() - m_dqBuf()      | DQ_BUF
 * | start()             | start() - m_streamOn()       | STREAM_ON
 * | polling()           | polling() - m_poll()         | POLL
 * |------------------------------------------------------------------
 * | setBufferRef()      |                              |
 * | getSize()           |                              |
 * | getColorFormat()    |                              |
 * | getBufferType()     |                              |
 * |------------------------------------------------------------------
 *
 */

enum node_request_state {
    NODE_REQUEST_STATE_BASE = 0,
    NODE_REQUEST_STATE_READY,
    NODE_REQUEST_STATE_QBUF_BLOCK,
    NODE_REQUEST_STATE_QBUF_DONE,
    NODE_REQUEST_STATE_DQBUF_BLOCK,
    NODE_REQUEST_STATE_DQBUF_DONE,
    NODE_REQUEST_STATE_STOPPED,
    NODE_REQUEST_STATE_INVALID
};

enum EXYNOS_CAMERA_NODE_LOCATION{
    NODE_LOCATION_SRC= 0,
    NODE_LOCATION_DST
};

enum NODE_TYPE {
    INVALID_NODE        = -1,
    OUTPUT_NODE         = 0,    /* Node for output  device */
    OUTPUT_NODE_1       = OUTPUT_NODE,    /* Node for output  device */
    OUTPUT_NODE_2,
    OUTPUT_NODE_3,
    OUTPUT_NODE_4,
    OUTPUT_NODE_5,
    MAX_OUTPUT_NODE,
    CAPTURE_NODE,               /* deprecated enum */
    SUB_NODE,                   /* deprecated enum */

    /* MCPipe CAPTURE NODE */
    CAPTURE_NODE_1 = CAPTURE_NODE, /* MCPipe use CAPTURE_NODE_X. so, this start from OUTPUT_NODE + 1 */
    CAPTURE_NODE_2,
    CAPTURE_NODE_3,
    CAPTURE_NODE_4,
    CAPTURE_NODE_5,
    CAPTURE_NODE_6,
    CAPTURE_NODE_7,
    CAPTURE_NODE_8,
    CAPTURE_NODE_9,
    CAPTURE_NODE_10,
    CAPTURE_NODE_11,
    CAPTURE_NODE_12,
    CAPTURE_NODE_13,
    CAPTURE_NODE_14,
    CAPTURE_NODE_15,
    CAPTURE_NODE_16,
    CAPTURE_NODE_17,
    CAPTURE_NODE_18,
    CAPTURE_NODE_19,
    CAPTURE_NODE_20,
    CAPTURE_NODE_21,
    CAPTURE_NODE_22,
    CAPTURE_NODE_23,
    MAX_CAPTURE_NODE,

    /* OTF NODE */
    OTF_NODE_BASE,
    OTF_NODE_1,
    OTF_NODE_2,
    OTF_NODE_3,
    OTF_NODE_4,
    OTF_NODE_5,
    OTF_NODE_6,
    OTF_NODE_7,
    MAX_OTF_NODE,

    MAX_NODE
};

class ExynosCameraNodeRequest {
public:
    /* Constructor */
    ExynosCameraNodeRequest();
    /* Destructor */
    virtual ~ExynosCameraNodeRequest();

    void setState(enum node_request_state state);
    enum node_request_state getState(void);

    void setRequest(unsigned int requestCount);
    unsigned int getRequest(void);

private:
    unsigned int            m_requestCount;
    enum node_request_state m_requestState;
};

#define NODE_PREPARE_SIZE (1)
#define NODE_PREPARE_FORMAT (2)
#define NODE_PREPARE_BUFFER_TYPE (3)
#define NODE_PREPARE_BUFFER_REF (4)
#define NODE_PREPARE_COMPLETE (NODE_PREPARE_SIZE | \
        NODE_PREPARE_FORMAT | \
        NODE_PREPARE_BUFFER_TYPE | \
        NODE_PREPARE_BUFFER_REF)

#define NODE_INIT_NEGATIVE_VALUE -1
#define NODE_INIT_ZERO_VALUE 0

class ExynosCameraNode : public ExynosCameraObject {
public:
    enum EXYNOS_CAMERA_NODE_TYPE {
        NODE_TYPE_BASE = 0,
        NODE_TYPE_DUMMY = 999,
        NODE_TYPE_MAX,
    };

    enum EXYNOS_CAMERA_NODE_STATE {
        NODE_STATE_BASE = 0,
        NODE_STATE_NONE,
        NODE_STATE_CREATED,
        NODE_STATE_OPENED,
        NODE_STATE_IN_PREPARE,
        NODE_STATE_RUNNING,
        NODE_STATE_DESTROYED,
        NODE_STATE_MAX
    };

public:
    /* Constructor */
    ExynosCameraNode();
    /* Destructor */
    virtual ~ExynosCameraNode();

    /* Create the instance */
    virtual status_t create();
    /* Create the instance */
    virtual status_t create(const char *nodeName);
    /* Create the instance */
    virtual status_t create(const char *nodeName, int cameraId);
    /* Create the instance */
    virtual status_t create(const char *nodeName, const char *nodeAlias);
    /* Create the instance */
    virtual status_t create(const char *nodeName, int cameraId, int fd);
    /* Create the instance */
    virtual status_t create(const char *nodeName,
                            int cameraId,
                            enum EXYNOS_CAMERA_NODE_LOCATION location,
                            void *module = NULL);

    /* Destroy the instance */
    virtual status_t destroy(void);

    /* open Node */
    virtual status_t open(int videoNodeNum);
    /* open Node */
    virtual status_t open(int videoNodeNum, int operationMode);
    /* close Node */
    virtual status_t close(void);
    /* check Node Opened */
    virtual bool     flagOpened(void);
    /* get file descriptor */
    virtual status_t getFd(int *fd);
    /* get Jpeg Encoder */
    virtual status_t getInternalModule(void **module);
    /* get video Num */
    virtual int      getNodeNum(void);

    /* set v4l2 color format */
    virtual status_t setColorFormat(int v4l2Colorformat, int planesCount,
                        enum YUV_RANGE yuvRange = YUV_FULL_RANGE, camera_pixel_size pixelSize = CAMERA_PIXEL_SIZE_8BIT);
    /* get v4l2 color format */
    virtual status_t getColorFormat(int *v4l2Colorformat, int *planesCount, enum YUV_RANGE *yuvRange = NULL);

    /* set size */
    virtual status_t setQuality(int quality);
    virtual status_t setQuality(const unsigned char qtable[]);

    /* set size */
    virtual status_t setSize(int w, int h);
    /* get size */
    virtual status_t getSize(int *w, int *h);

    /* set id */
    virtual status_t setId(int id);

    /* set memory info */
    virtual status_t setBufferType(
                int bufferCount,
                enum v4l2_buf_type type,
                enum v4l2_memory bufferMemoryType);
    /* get memory info */
    virtual status_t getBufferType(
                int *bufferCount,
                enum v4l2_buf_type *type,
                enum v4l2_memory *bufferMemoryType);

    /* query buffer */
    virtual status_t queryBuf(void);
    /* request buffers */
    virtual status_t reqBuffers(void);
    /* clear buffers */
    virtual status_t clrBuffers(void);
    /* check buffers */
    virtual unsigned int reqBuffersCount(void);

    /* set id */
    virtual status_t setControl(unsigned int id, int value);
    virtual status_t getControl(unsigned int id, int *value);

    virtual status_t setExtControl(struct v4l2_ext_controls *ctrl);

    /* polling */
    virtual status_t polling(void);

    /* setInput */
    virtual status_t setInput(int sensorId);
    /* getInput */
    virtual int      getInput(void);
    /* resetInput */
    virtual int      resetInput(void);

    /* setCrop */
    virtual status_t setCrop(enum v4l2_buf_type type, int x, int y, int w, int h);

    /* setFormat */
    virtual status_t setFormat(void);
    virtual status_t setFormat(unsigned int bytesPerPlane[]);

    /* set capture information */
    virtual status_t setExifInfo(exif_attribute_t *exifInfo);
    virtual status_t setDebugInfo(debug_attribute_t *debugInfo);

    /* startNode */
    virtual status_t start(void);
    /* stopNode */
    virtual status_t stop(void);

    /* Check if the instance was created */
    virtual bool isCreated(void);
    /* Check if it start */
    virtual bool isStarted(void);

    /* prepare Buffers */
    virtual status_t prepareBuffer(ExynosCameraBuffer *buf);

    /* putBuffer */
    virtual status_t putBuffer(ExynosCameraBuffer *buf);
    virtual status_t mapBuffer(ExynosCameraBuffer *buf);

    /* getBuffer */
    virtual status_t getBuffer(ExynosCameraBuffer *buf, int *dqIndex);

    /* dump the object info */
    virtual void dump(void);
    /* dump state info */
    virtual void dumpState(void);
    /* dump queue info */
    virtual void dumpQueue(void);

    /* set param */
    virtual int setParam(struct v4l2_streamparm *stream_parm);
    virtual void removeItemBufferQ();

protected:
    /* get pixel format */
    int  m_pixelDepth(void);
    /* check whether queued on index */
    bool m_getFlagQ(int index);
    /* set queue flag on index */
    bool m_setFlagQ(int index, bool toggle);
    /* polling */
    int m_polling(void);

    /* stream on */
    int m_streamOn(void);
    /* stream off */
    int m_streamOff(void);

    /* set input */
    int m_setInput(int id);
    /* set format */
    int m_setFmt(void);
    /* req buf */
    int m_reqBuffers(int *reqCount);
    /* clear buf */
    int m_clrBuffers(int *reqCount);
    /* set crop */
    int m_setCrop(int v4l2BufType, ExynosRect *rect);
    /* set contorl */
    int m_setControl(unsigned int id, int value);
    /* get contorl */
    int m_getControl(unsigned int id, int *value);
    /* set ext control */
    int m_setExtControl(struct v4l2_ext_controls *ctrl);

    /* qbuf from src, with metaBuf */
    int m_qBuf(ExynosCameraBuffer *buf);
    int m_mBuf(ExynosCameraBuffer *buf);

    /* dqbuf */
    int m_dqBuf(ExynosCameraBuffer *buf, int *dqIndex);

    /* Buffer trace */
    status_t m_putBufferQ(ExynosCameraBuffer *buf, int *qindex);
    status_t m_getBufferQ(ExynosCameraBuffer *buf, int *dqindex);
    bool m_isExistBufferQ(ExynosCameraBuffer *buf);
    void m_printBufferQ();
    void m_removeItemBufferQ();
    int  m_YUV_RANGE_2_V4L2_COLOR_RANGE(enum YUV_RANGE yuvRange);
    enum YUV_RANGE m_V4L2_COLOR_RANGE_2_YUV_RANGE(int v4l2ColorRange);

    /*
     * thoes member value should be declare in private
     * but we declare in publuc to support backward compatibility
     */
public:

protected:
    ExynosCameraNodeRequest m_nodeRequest;

    bool                m_flagStart;
    bool                m_flagCreate;

    char                m_alias[EXYNOS_CAMERA_NAME_STR_SIZE];

    int                 m_sensorId;
    int                 m_fd;
    int                 m_videoNodeNum;
    struct v4l2_format  m_v4l2Format;
    struct v4l2_requestbuffers m_v4l2ReqBufs;
    struct v4l2_crop    m_crop;

    bool                m_flagQ[VIDEO_MAX_FRAME];
    Mutex               m_qLock;

    bool                m_flagStreamOn;
    /* for reprocessing */
    bool                m_flagDup;

    int                 m_paramState;

    mutable Mutex       m_nodeStateLock;
    mutable Mutex       m_nodeActionLock;

    Mutex               m_queueBufferListLock;
    ExynosCameraBuffer  m_queueBufferList[MAX_BUFFERS];

/*    ExynosCameraState m_nodeStateMgr; */
    int  m_nodeState;

    enum EXYNOS_CAMERA_NODE_TYPE m_nodeType;
    List<int>           m_dummyIndexQ;

#ifdef EXYNOS_CAMERA_NODE_TRACE_Q_DURATION
    ExynosCameraDurationTimer m_qTimer;
#endif

#ifdef EXYNOS_CAMERA_NODE_TRACE_DQ_DURATION
    ExynosCameraDurationTimer m_dqTimer;
#endif
};

};
#endif /* EXYNOS_CAMERA_NODE_H__ */