mirror of
https://github.com/ultravideo/uvg266.git
synced 2024-11-24 18:34:06 +00:00
947bae24f9
Add module information to all header files. Update all header file documentations to briefly say what they are, and to use the javadoc format so the brief actually gets included into the doxygen documentation. Remove \file from implementation files, in order to not repeat the info from the header files. Add files under strategies and tools to Doxygen and update the Doxygen settings to be just plain better. Make README be the main page of Doxygen documentation.
64 lines
1.8 KiB
C
64 lines
1.8 KiB
C
#ifndef KVAZAAR_INTERNAL_H_
|
|
#define KVAZAAR_INTERNAL_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/>.
|
|
****************************************************************************/
|
|
|
|
/**
|
|
* \ingroup Control
|
|
* \file
|
|
* \brief Definitions for opaque structs in kvazaar.h
|
|
*/
|
|
|
|
#include "kvazaar.h"
|
|
#include "input_frame_buffer.h"
|
|
|
|
// Forward declarations.
|
|
struct encoder_state_t;
|
|
struct encoder_control_t;
|
|
|
|
struct kvz_encoder {
|
|
struct encoder_control_t* control;
|
|
struct encoder_state_t* states;
|
|
unsigned num_encoder_states;
|
|
|
|
/**
|
|
* \brief Number of the current encoder state.
|
|
*
|
|
* The current state is the one that will be used for encoding the frame
|
|
* that is started next.
|
|
*/
|
|
unsigned cur_state_num;
|
|
|
|
/**
|
|
* \brief Number of the next encoder state to be finished.
|
|
*/
|
|
unsigned out_state_num;
|
|
|
|
/**
|
|
* \brief Buffer for input frames.
|
|
*/
|
|
input_frame_buffer_t input_buffer;
|
|
|
|
unsigned frames_started;
|
|
unsigned frames_done;
|
|
};
|
|
|
|
#endif // KVAZAAR_INTERNAL_H_
|