proc_if.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 2018 Rafael Antoniello
 *
 * This file is part of MediaProcessors.
 *
 * MediaProcessors is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MediaProcessors is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MediaProcessors. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MEDIAPROCESSORS_SRC_PROC_IF_H_
#define MEDIAPROCESSORS_SRC_PROC_IF_H_

#include <sys/types.h>
#include <inttypes.h>
#include <stdarg.h>

/* **** Definitions **** */

/* Forward definitions */
typedef struct proc_ctx_s proc_ctx_t;
typedef struct proc_if_s proc_if_t;
typedef struct log_ctx_s log_ctx_t;
typedef struct fifo_ctx_s fifo_ctx_t;

#define PROC_FRAME_MAX_WIDTH    4096

#define PROC_FRAME_MAX_HEIGHT   4096

typedef enum proc_sample_fmt_enum {
    PROC_IF_FMT_UNDEF= 0,   
    PROC_IF_FMT_YUV420P,    
    //PROC_IF_FMT_RGB24,        ///< Packed RGB 8:8:8 with 24bpp (video) //Reserved for future use
    PROC_IF_FMT_S16,        
    PROC_IF_FMT_S16P,       
} proc_sample_fmt_t;

typedef struct proc_sample_fmt_lut_s {
    int id;
    char desc[256];
} proc_sample_fmt_lut_t;

typedef struct proc_frame_ctx_s {
#define PROC_FRAME_NUM_DATA_POINTERS 8

    uint8_t *data;
    const uint8_t *p_data[PROC_FRAME_NUM_DATA_POINTERS];
    int linesize[PROC_FRAME_NUM_DATA_POINTERS];
    size_t width[PROC_FRAME_NUM_DATA_POINTERS];
    size_t height[PROC_FRAME_NUM_DATA_POINTERS];
    int proc_sample_fmt;
    int proc_sampling_rate;
    int64_t pts;
    int64_t dts;
    int es_id;
} proc_frame_ctx_t;

typedef enum proc_if_rest_fmt_enum {
    PROC_IF_REST_FMT_CHAR,   
    PROC_IF_REST_FMT_CJSON, 
    PROC_IF_REST_FMT_BINARY, 
    PROC_IF_REST_FMT_ENUM_MAX
} proc_if_rest_fmt_t;

typedef struct proc_if_s {
    const char *proc_name;
    const char *proc_type;
    const char *proc_mime;
    uint64_t flag_proc_features;
#define PROC_FEATURE_BITRATE 1 //< Implements i/o bitrate statistics.
#define PROC_FEATURE_REGISTER_PTS 2 //< Implements i/o PTS statistics
#define PROC_FEATURE_LATENCY 4 //< Implements latency statistics.

    proc_ctx_t* (*open)(const proc_if_t *proc_if, const char *settings_str,
            log_ctx_t *log_ctx, va_list arg);
    void (*close)(proc_ctx_t **ref_proc_ctx);
    int (*send_frame)(proc_ctx_t *proc_ctx,
            const proc_frame_ctx_t *proc_frame_ctx);
    int (*send_frame_nodup)(proc_ctx_t *proc_ctx,
            proc_frame_ctx_t **ref_proc_frame_ctx);
    int (*recv_frame)(proc_ctx_t *proc_ctx,
            proc_frame_ctx_t **ref_proc_frame_ctx);
    int (*unblock)(proc_ctx_t *proc_ctx);
    int (*rest_put)(proc_ctx_t *proc_ctx, const char *str);
    int (*rest_get)(proc_ctx_t *proc_ctx, const proc_if_rest_fmt_t rest_fmt,
            void **ref_reponse);
    int (*process_frame)(proc_ctx_t *proc_ctx, fifo_ctx_t *fifo_ctx_iput,
            fifo_ctx_t *fifo_ctx_oput);
    int (*opt)(proc_ctx_t *proc_ctx, const char *tag, va_list arg);
    void* (*iput_fifo_elem_opaque_dup)(const proc_frame_ctx_t* proc_frame_ctx);
    void (*iput_fifo_elem_opaque_release)(void **ref_t);
    proc_frame_ctx_t* (*oput_fifo_elem_opaque_dup)(const void *t);
} proc_if_t;

/* **** Prototypes **** */

extern const proc_sample_fmt_lut_t proc_sample_fmt_lut[];

proc_frame_ctx_t* proc_frame_ctx_allocate();

proc_frame_ctx_t* proc_frame_ctx_dup(
        const proc_frame_ctx_t *proc_frame_ctx_arg);

void proc_frame_ctx_release(proc_frame_ctx_t **ref_proc_frame_ctx);

proc_if_t* proc_if_allocate();

proc_if_t* proc_if_dup(const proc_if_t *proc_if_arg);

int proc_if_cmp(const proc_if_t* proc_if1, const proc_if_t* proc_if2);

void proc_if_release(proc_if_t **ref_proc_if);

#endif /* MEDIAPROCESSORS_SRC_PROC_IF_H_ */