LCOV - code coverage report
Current view: top level - libavcodec - internal.h (source / functions) Hit Total Coverage
Test: coverage.info Lines: 6 12 50.0 %
Date: 2018-05-20 11:54:08 Functions: 2 2 100.0 %

          Line data    Source code
       1             : /*
       2             :  * This file is part of FFmpeg.
       3             :  *
       4             :  * FFmpeg is free software; you can redistribute it and/or
       5             :  * modify it under the terms of the GNU Lesser General Public
       6             :  * License as published by the Free Software Foundation; either
       7             :  * version 2.1 of the License, or (at your option) any later version.
       8             :  *
       9             :  * FFmpeg is distributed in the hope that it will be useful,
      10             :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      12             :  * Lesser General Public License for more details.
      13             :  *
      14             :  * You should have received a copy of the GNU Lesser General Public
      15             :  * License along with FFmpeg; if not, write to the Free Software
      16             :  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
      17             :  */
      18             : 
      19             : /**
      20             :  * @file
      21             :  * common internal api header.
      22             :  */
      23             : 
      24             : #ifndef AVCODEC_INTERNAL_H
      25             : #define AVCODEC_INTERNAL_H
      26             : 
      27             : #include <stdint.h>
      28             : 
      29             : #include "libavutil/buffer.h"
      30             : #include "libavutil/channel_layout.h"
      31             : #include "libavutil/mathematics.h"
      32             : #include "libavutil/pixfmt.h"
      33             : #include "avcodec.h"
      34             : #include "config.h"
      35             : 
      36             : /**
      37             :  * The codec does not modify any global variables in the init function,
      38             :  * allowing to call the init function without locking any global mutexes.
      39             :  */
      40             : #define FF_CODEC_CAP_INIT_THREADSAFE        (1 << 0)
      41             : /**
      42             :  * The codec allows calling the close function for deallocation even if
      43             :  * the init function returned a failure. Without this capability flag, a
      44             :  * codec does such cleanup internally when returning failures from the
      45             :  * init function and does not expect the close function to be called at
      46             :  * all.
      47             :  */
      48             : #define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)
      49             : /**
      50             :  * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
      51             :  * AVFrame.pkt_dts manually. If the flag is set, decode.c won't overwrite
      52             :  * this field. If it's unset, decode.c tries to guess the pkt_dts field
      53             :  * from the input AVPacket.
      54             :  */
      55             : #define FF_CODEC_CAP_SETS_PKT_DTS           (1 << 2)
      56             : /**
      57             :  * The decoder extracts and fills its parameters even if the frame is
      58             :  * skipped due to the skip_frame setting.
      59             :  */
      60             : #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM  (1 << 3)
      61             : /**
      62             :  * The decoder sets the cropping fields in the output frames manually.
      63             :  * If this cap is set, the generic code will initialize output frame
      64             :  * dimensions to coded rather than display values.
      65             :  */
      66             : #define FF_CODEC_CAP_EXPORTS_CROPPING       (1 << 4)
      67             : /**
      68             :  * Codec initializes slice-based threading with a main function
      69             :  */
      70             : #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF    (1 << 5)
      71             : 
      72             : #ifdef TRACE
      73             : #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
      74             : #else
      75             : #   define ff_tlog(ctx, ...) do { } while(0)
      76             : #endif
      77             : 
      78             : 
      79             : #define FF_DEFAULT_QUANT_BIAS 999999
      80             : 
      81             : #define FF_QSCALE_TYPE_MPEG1 0
      82             : #define FF_QSCALE_TYPE_MPEG2 1
      83             : #define FF_QSCALE_TYPE_H264  2
      84             : #define FF_QSCALE_TYPE_VP56  3
      85             : 
      86             : #define FF_SANE_NB_CHANNELS 64U
      87             : 
      88             : #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
      89             : 
      90             : #if HAVE_SIMD_ALIGN_64
      91             : #   define STRIDE_ALIGN 64 /* AVX-512 */
      92             : #elif HAVE_SIMD_ALIGN_32
      93             : #   define STRIDE_ALIGN 32
      94             : #elif HAVE_SIMD_ALIGN_16
      95             : #   define STRIDE_ALIGN 16
      96             : #else
      97             : #   define STRIDE_ALIGN 8
      98             : #endif
      99             : 
     100             : typedef struct FramePool {
     101             :     /**
     102             :      * Pools for each data plane. For audio all the planes have the same size,
     103             :      * so only pools[0] is used.
     104             :      */
     105             :     AVBufferPool *pools[4];
     106             : 
     107             :     /*
     108             :      * Pool parameters
     109             :      */
     110             :     int format;
     111             :     int width, height;
     112             :     int stride_align[AV_NUM_DATA_POINTERS];
     113             :     int linesize[4];
     114             :     int planes;
     115             :     int channels;
     116             :     int samples;
     117             : } FramePool;
     118             : 
     119             : typedef struct DecodeSimpleContext {
     120             :     AVPacket *in_pkt;
     121             :     AVFrame  *out_frame;
     122             : } DecodeSimpleContext;
     123             : 
     124             : typedef struct DecodeFilterContext {
     125             :     AVBSFContext **bsfs;
     126             :     int         nb_bsfs;
     127             : } DecodeFilterContext;
     128             : 
     129             : typedef struct AVCodecInternal {
     130             :     /**
     131             :      * Whether the parent AVCodecContext is a copy of the context which had
     132             :      * init() called on it.
     133             :      * This is used by multithreading - shared tables and picture pointers
     134             :      * should be freed from the original context only.
     135             :      */
     136             :     int is_copy;
     137             : 
     138             :     /**
     139             :      * Whether to allocate progress for frame threading.
     140             :      *
     141             :      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
     142             :      * then progress will be allocated in ff_thread_get_buffer(). The frames
     143             :      * then MUST be freed with ff_thread_release_buffer().
     144             :      *
     145             :      * If the codec does not need to call the progress functions (there are no
     146             :      * dependencies between the frames), it should leave this at 0. Then it can
     147             :      * decode straight to the user-provided frames (which the user will then
     148             :      * free with av_frame_unref()), there is no need to call
     149             :      * ff_thread_release_buffer().
     150             :      */
     151             :     int allocate_progress;
     152             : 
     153             :     /**
     154             :      * An audio frame with less than required samples has been submitted and
     155             :      * padded with silence. Reject all subsequent frames.
     156             :      */
     157             :     int last_audio_frame;
     158             : 
     159             :     AVFrame *to_free;
     160             : 
     161             :     FramePool *pool;
     162             : 
     163             :     void *thread_ctx;
     164             : 
     165             :     DecodeSimpleContext ds;
     166             :     DecodeFilterContext filter;
     167             : 
     168             :     /**
     169             :      * Properties (timestamps+side data) extracted from the last packet passed
     170             :      * for decoding.
     171             :      */
     172             :     AVPacket *last_pkt_props;
     173             : 
     174             :     /**
     175             :      * temporary buffer used for encoders to store their bitstream
     176             :      */
     177             :     uint8_t *byte_buffer;
     178             :     unsigned int byte_buffer_size;
     179             : 
     180             :     void *frame_thread_encoder;
     181             : 
     182             :     /**
     183             :      * Number of audio samples to skip at the start of the next decoded frame
     184             :      */
     185             :     int skip_samples;
     186             : 
     187             :     /**
     188             :      * hwaccel-specific private data
     189             :      */
     190             :     void *hwaccel_priv_data;
     191             : 
     192             :     /**
     193             :      * checks API usage: after codec draining, flush is required to resume operation
     194             :      */
     195             :     int draining;
     196             : 
     197             :     /**
     198             :      * buffers for using new encode/decode API through legacy API
     199             :      */
     200             :     AVPacket *buffer_pkt;
     201             :     int buffer_pkt_valid; // encoding: packet without data can be valid
     202             :     AVFrame *buffer_frame;
     203             :     int draining_done;
     204             :     /* set to 1 when the caller is using the old decoding API */
     205             :     int compat_decode;
     206             :     int compat_decode_warned;
     207             :     /* this variable is set by the decoder internals to signal to the old
     208             :      * API compat wrappers the amount of data consumed from the last packet */
     209             :     size_t compat_decode_consumed;
     210             :     /* when a partial packet has been consumed, this stores the remaining size
     211             :      * of the packet (that should be submitted in the next decode call */
     212             :     size_t compat_decode_partial_size;
     213             :     AVFrame *compat_decode_frame;
     214             : 
     215             :     int showed_multi_packet_warning;
     216             : 
     217             :     int skip_samples_multiplier;
     218             : 
     219             :     /* to prevent infinite loop on errors when draining */
     220             :     int nb_draining_errors;
     221             : } AVCodecInternal;
     222             : 
     223             : struct AVCodecDefault {
     224             :     const uint8_t *key;
     225             :     const uint8_t *value;
     226             : };
     227             : 
     228             : extern const uint8_t ff_log2_run[41];
     229             : 
     230             : /**
     231             :  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
     232             :  * If there is no such matching pair then size is returned.
     233             :  */
     234             : int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
     235             : 
     236             : unsigned int avpriv_toupper4(unsigned int x);
     237             : 
     238             : void ff_color_frame(AVFrame *frame, const int color[4]);
     239             : 
     240             : /**
     241             :  * Maximum size in bytes of extradata.
     242             :  * This value was chosen such that every bit of the buffer is
     243             :  * addressable by a 32-bit signed integer as used by get_bits.
     244             :  */
     245             : #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
     246             : 
     247             : /**
     248             :  * Check AVPacket size and/or allocate data.
     249             :  *
     250             :  * Encoders supporting AVCodec.encode2() can use this as a convenience to
     251             :  * ensure the output packet data is large enough, whether provided by the user
     252             :  * or allocated in this function.
     253             :  *
     254             :  * @param avctx   the AVCodecContext of the encoder
     255             :  * @param avpkt   the AVPacket
     256             :  *                If avpkt->data is already set, avpkt->size is checked
     257             :  *                to ensure it is large enough.
     258             :  *                If avpkt->data is NULL, a new buffer is allocated.
     259             :  *                avpkt->size is set to the specified size.
     260             :  *                All other AVPacket fields will be reset with av_init_packet().
     261             :  * @param size    the minimum required packet size
     262             :  * @param min_size This is a hint to the allocation algorithm, which indicates
     263             :  *                to what minimal size the caller might later shrink the packet
     264             :  *                to. Encoders often allocate packets which are larger than the
     265             :  *                amount of data that is written into them as the exact amount is
     266             :  *                not known at the time of allocation. min_size represents the
     267             :  *                size a packet might be shrunk to by the caller. Can be set to
     268             :  *                0. setting this roughly correctly allows the allocation code
     269             :  *                to choose between several allocation strategies to improve
     270             :  *                speed slightly.
     271             :  * @return        non negative on success, negative error code on failure
     272             :  */
     273             : int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
     274             : 
     275             : attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
     276             : 
     277             : /**
     278             :  * Rescale from sample rate to AVCodecContext.time_base.
     279             :  */
     280      304104 : static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
     281             :                                                         int64_t samples)
     282             : {
     283      304104 :     if(samples == AV_NOPTS_VALUE)
     284           0 :         return AV_NOPTS_VALUE;
     285      304104 :     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
     286             :                         avctx->time_base);
     287             : }
     288             : 
     289             : /**
     290             :  * 2^(x) for integer x
     291             :  * @return correctly rounded float
     292             :  */
     293      179564 : static av_always_inline float ff_exp2fi(int x) {
     294             :     /* Normal range */
     295      179564 :     if (-126 <= x && x <= 128)
     296      179564 :         return av_int2float((x+127) << 23);
     297             :     /* Too large */
     298           0 :     else if (x > 128)
     299           0 :         return INFINITY;
     300             :     /* Subnormal numbers */
     301           0 :     else if (x > -150)
     302           0 :         return av_int2float(1 << (x+149));
     303             :     /* Negligibly small */
     304             :     else
     305           0 :         return 0;
     306             : }
     307             : 
     308             : /**
     309             :  * Get a buffer for a frame. This is a wrapper around
     310             :  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
     311             :  * directly.
     312             :  */
     313             : int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
     314             : 
     315             : /**
     316             :  * Identical in function to av_frame_make_writable(), except it uses
     317             :  * ff_get_buffer() to allocate the buffer when needed.
     318             :  */
     319             : int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
     320             : 
     321             : int ff_thread_can_start_frame(AVCodecContext *avctx);
     322             : 
     323             : int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
     324             : 
     325             : /**
     326             :  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
     327             :  * calling the function and then restoring again. Assumes the mutex is
     328             :  * already locked
     329             :  */
     330             : int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
     331             : 
     332             : /**
     333             :  * Finalize buf into extradata and set its size appropriately.
     334             :  */
     335             : int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
     336             : 
     337             : const uint8_t *avpriv_find_start_code(const uint8_t *p,
     338             :                                       const uint8_t *end,
     339             :                                       uint32_t *state);
     340             : 
     341             : int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
     342             : 
     343             : /**
     344             :  * Check that the provided frame dimensions are valid and set them on the codec
     345             :  * context.
     346             :  */
     347             : int ff_set_dimensions(AVCodecContext *s, int width, int height);
     348             : 
     349             : /**
     350             :  * Check that the provided sample aspect ratio is valid and set it on the codec
     351             :  * context.
     352             :  */
     353             : int ff_set_sar(AVCodecContext *avctx, AVRational sar);
     354             : 
     355             : /**
     356             :  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
     357             :  */
     358             : int ff_side_data_update_matrix_encoding(AVFrame *frame,
     359             :                                         enum AVMatrixEncoding matrix_encoding);
     360             : 
     361             : /**
     362             :  * Select the (possibly hardware accelerated) pixel format.
     363             :  * This is a wrapper around AVCodecContext.get_format() and should be used
     364             :  * instead of calling get_format() directly.
     365             :  *
     366             :  * The list of pixel formats must contain at least one valid entry, and is
     367             :  * terminated with AV_PIX_FMT_NONE.  If it is possible to decode to software,
     368             :  * the last entry in the list must be the most accurate software format.
     369             :  * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
     370             :  * must be set before calling this function.
     371             :  */
     372             : int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
     373             : 
     374             : /**
     375             :  * Set various frame properties from the codec context / packet data.
     376             :  */
     377             : int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
     378             : 
     379             : /**
     380             :  * Add a CPB properties side data to an encoding context.
     381             :  */
     382             : AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
     383             : 
     384             : int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
     385             : 
     386             : /**
     387             :  * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
     388             :  *
     389             :  * @param frame      Raw frame to get A53 side data from
     390             :  * @param prefix_len Number of bytes to allocate before SEI message
     391             :  * @param data       Pointer to a variable to store allocated memory
     392             :  *                   Upon return the variable will hold NULL on error or if frame has no A53 info.
     393             :  *                   Otherwise it will point to prefix_len uninitialized bytes followed by
     394             :  *                   *sei_size SEI message
     395             :  * @param sei_size   Pointer to a variable to store generated SEI message length
     396             :  * @return           Zero on success, negative error code on failure
     397             :  */
     398             : int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
     399             :                      void **data, size_t *sei_size);
     400             : 
     401             : /**
     402             :  * Get an estimated video bitrate based on frame size, frame rate and coded
     403             :  * bits per pixel.
     404             :  */
     405             : int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
     406             : 
     407             : #if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
     408             : #    define av_export_avcodec __declspec(dllimport)
     409             : #else
     410             : #    define av_export_avcodec
     411             : #endif
     412             : 
     413             : #endif /* AVCODEC_INTERNAL_H */

Generated by: LCOV version 1.13