uvg266/src/kvazaar.h
Arttu Ylä-Outinen 7e20e62cc7 Make kvazaar_encode consume one frame on each call.
- Replaces read_one_frame by encoder_feed_frame.
- Adds field "prepared" to encoderstate_t to indicate that
  encoder_next_frame has been called.
- Input frames are read in the main function and passed to
  encoder_encode.
2015-07-02 16:28:40 +03:00

119 lines
3.7 KiB
C

#ifndef KVAZAAR_H_
#define KVAZAAR_H_
/*****************************************************************************
* This file is part of Kvazaar HEVC encoder.
*
* Copyright (C) 2013-2015 Tampere University of Technology and others (see
* COPYING file).
*
* Kvazaar 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 2.1 of the License, or (at your
* option) any later version.
*
* Kvazaar 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 General Public License along
* with Kvazaar. If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/
/**
* \file
* \brief This file defines the public API of Kvazaar when used as a library.
*/
#include <stddef.h>
#include <stdint.h>
#include "kvazaar_version.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct config_t kvz_cfg;
typedef struct encoder_state_t encoder_state_t;
typedef union bitstream_t kvz_payload;
typedef struct encoder_control_t encoder_control_t;
typedef struct image_t kvz_picture;
#define BIT_DEPTH 8
#if BIT_DEPTH == 8
typedef uint8_t pixel_t;
#else
typedef uint16_t pixel_t;
#endif
/**
* \brief Struct which contains all picture data
*/
typedef struct image_t {
pixel_t *fulldata; //!< \brief Allocated buffer (only used in the base_image)
pixel_t *y; //!< \brief Pointer to luma pixel array.
pixel_t *u; //!< \brief Pointer to chroma U pixel array.
pixel_t *v; //!< \brief Pointer to chroma V pixel array.
pixel_t *data[3]; //!< \brief Alternate access method to same data.
int32_t width; //!< \brief Luma pixel array width.
int32_t height; //!< \brief Luma pixel array height.
int32_t stride; //!< \brief Luma pixel array width for the full picture (should be used as stride)
struct image_t * base_image; //!< \brief Pointer to the image to which the pixels belong
int32_t refcount; //!< \brief Number of references to the picture
} image_t;
/**
* Main datastructure representing one instance of the encoder.
* - encoder_open
* - encoder_close
*/
typedef struct kvz_encoder {
encoder_control_t* control;
encoder_state_t* states;
unsigned num_encoder_states;
unsigned cur_state_num;
unsigned frames_started;
unsigned frames_done;
size_t bitstream_length;
} kvz_encoder;
typedef struct kvz_api {
kvz_cfg * (*config_alloc)(void);
int (*config_destroy)(kvz_cfg *);
int (*config_init)(kvz_cfg *);
int (*config_parse)(kvz_cfg *, const char *name, const char *value);
kvz_encoder * (*encoder_open)(kvz_cfg *);
void (*encoder_close)(kvz_encoder *);
// \brief Encode one picture.
// \param encoder Encoder
// \param pic_in Input frame
// \param pic_out Returns the reconstructed picture.
// \param payload Bitstream for writing the encoded data
// \return 1 on success, 0 on error.
int (*encoder_encode)(kvz_encoder *encoder, kvz_picture *pic_in, kvz_picture **pic_out, kvz_payload *payload);
} kvz_api;
// Append API version to the getters name to prevent linking against incompatible versions.
#define KVZ_API_CONCAT(func, version) func ## _apiv ## version
#define KVZ_API_EXPAND_VERSION(func, version) KVZ_API_CONCAT(func, version)
#define kvz_api_get KVZ_API_EXPAND_VERSION(kvz_api_get, KVZ_API_VERSION)
const kvz_api* kvz_api_get(int bit_depth);
#ifdef __cplusplus
}
#endif
#endif // KVAZAAR_H_