proc.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_H_
#define MEDIAPROCESSORS_SRC_PROC_H_

#include <stdarg.h>
#include <pthread.h>
#include <libmediaprocsutils/mem_utils.h>

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

/* Forward definitions */
typedef struct proc_if_s proc_if_t;
typedef struct log_ctx_s log_ctx_t;
typedef struct fifo_ctx_s fifo_ctx_t;
typedef struct fair_lock_s fair_lock_t;
typedef struct proc_frame_ctx_s proc_frame_ctx_t;
typedef struct interr_usleep_ctx_s interr_usleep_ctx_t;

#define CJSON_PRINT(CJSON_PTR)  cJSON_Print(CJSON_PTR)
//#define CJSON_PRINT(CJSON_PTR)    cJSON_PrintUnformatted(CJSON_PTR)

typedef enum {
    PROC_IPUT= 0,
    PROC_OPUT= 1,
    PROC_IO_NUM= 2
} proc_io_t;

typedef struct proc_ctx_s {
    const proc_if_t *proc_if;
    int proc_instance_index;
    pthread_mutex_t api_mutex;
     log_ctx_t *log_ctx;
    fifo_ctx_t *fifo_ctx_array[PROC_IO_NUM];
    fair_lock_t *fair_lock_io_array[PROC_IO_NUM];

    volatile uint32_t bitrate[PROC_IO_NUM];
    volatile uint32_t acc_io_bits[PROC_IO_NUM];
    pthread_mutex_t acc_io_bits_mutex[PROC_IO_NUM];


#define IPUT_PTS_ARRAY_SIZE 128
#define IPUT_PTS_VAL 0
#define IPUT_PTS_STC_VAL 1
    int64_t iput_pts_array[2][IPUT_PTS_ARRAY_SIZE];
    volatile int iput_pts_array_idx;


    volatile int64_t latency_avg_usec;
    volatile int64_t latency_max_usec;
    volatile int64_t latency_min_usec;
    volatile int64_t acc_latency_nsec;
    volatile int acc_latency_cnt;
    pthread_mutex_t latency_mutex;


    interr_usleep_ctx_t *interr_usleep_ctx;
    pthread_t stats_thread;

    volatile int flag_exit;
    pthread_t proc_thread;
    const void*(*start_routine)(void *);
} proc_ctx_t;

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

proc_ctx_t* proc_open(const proc_if_t *proc_if, const char *settings_str,
        int proc_instance_index, uint32_t fifo_ctx_maxsize[PROC_IO_NUM],
        log_ctx_t *log_ctx, va_list arg);

void proc_close(proc_ctx_t **ref_proc_ctx);

int proc_send_frame(proc_ctx_t *proc_ctx,
        const proc_frame_ctx_t *proc_frame_ctx);

int proc_recv_frame(proc_ctx_t *proc_ctx,
        proc_frame_ctx_t **ref_proc_frame_ctx);

int proc_opt(proc_ctx_t *proc_ctx, const char *tag, ...);

int proc_vopt(proc_ctx_t *proc_ctx, const char *tag, va_list arg);

/* **** Utilities ****
 * The following functions are available to be used by the specific
 * implementations of the processor, but are not part of the public processor
 * API.
 */

int proc_send_frame_default1(proc_ctx_t *proc_ctx,
        const proc_frame_ctx_t *proc_frame_ctx);

int proc_recv_frame_default1(proc_ctx_t *proc_ctx,
        proc_frame_ctx_t **ref_proc_frame_ctx);

void proc_stats_register_accumulated_latency(proc_ctx_t *proc_ctx,
        const int64_t oput_frame_pts);

#endif /* MEDIAPROCESSORS_SRC_PROC_H_ */