You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

367 lines
12KB

  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. * @file
  20. * common internal api header.
  21. */
  22. #ifndef AVCODEC_INTERNAL_H
  23. #define AVCODEC_INTERNAL_H
  24. #include <stdint.h>
  25. #include "libavutil/buffer.h"
  26. #include "libavutil/channel_layout.h"
  27. #include "libavutil/mathematics.h"
  28. #include "libavutil/pixfmt.h"
  29. #include "avcodec.h"
  30. #include "config.h"
  31. /**
  32. * The codec does not modify any global variables in the init function,
  33. * allowing to call the init function without locking any global mutexes.
  34. */
  35. #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
  36. /**
  37. * The codec allows calling the close function for deallocation even if
  38. * the init function returned a failure. Without this capability flag, a
  39. * codec does such cleanup internally when returning failures from the
  40. * init function and does not expect the close function to be called at
  41. * all.
  42. */
  43. #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
  44. /**
  45. * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
  46. * AVFrame.pkt_dts manually. If the flag is set, utils.c won't overwrite
  47. * this field. If it's unset, utils.c tries to guess the pkt_dts field
  48. * from the input AVPacket.
  49. */
  50. #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
  51. /**
  52. * The decoder extracts and fills its parameters even if the frame is
  53. * skipped due to the skip_frame setting.
  54. */
  55. #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
  56. #ifdef TRACE
  57. # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
  58. #else
  59. # define ff_tlog(ctx, ...) do { } while(0)
  60. #endif
  61. #if !FF_API_QUANT_BIAS
  62. #define FF_DEFAULT_QUANT_BIAS 999999
  63. #endif
  64. #define FF_SANE_NB_CHANNELS 64U
  65. #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
  66. #if HAVE_SIMD_ALIGN_32
  67. # define STRIDE_ALIGN 32
  68. #elif HAVE_SIMD_ALIGN_16
  69. # define STRIDE_ALIGN 16
  70. #else
  71. # define STRIDE_ALIGN 8
  72. #endif
  73. typedef struct FramePool {
  74. /**
  75. * Pools for each data plane. For audio all the planes have the same size,
  76. * so only pools[0] is used.
  77. */
  78. AVBufferPool *pools[4];
  79. /*
  80. * Pool parameters
  81. */
  82. int format;
  83. int width, height;
  84. int stride_align[AV_NUM_DATA_POINTERS];
  85. int linesize[4];
  86. int planes;
  87. int channels;
  88. int samples;
  89. } FramePool;
  90. typedef struct AVCodecInternal {
  91. /**
  92. * Whether the parent AVCodecContext is a copy of the context which had
  93. * init() called on it.
  94. * This is used by multithreading - shared tables and picture pointers
  95. * should be freed from the original context only.
  96. */
  97. int is_copy;
  98. /**
  99. * Whether to allocate progress for frame threading.
  100. *
  101. * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
  102. * then progress will be allocated in ff_thread_get_buffer(). The frames
  103. * then MUST be freed with ff_thread_release_buffer().
  104. *
  105. * If the codec does not need to call the progress functions (there are no
  106. * dependencies between the frames), it should leave this at 0. Then it can
  107. * decode straight to the user-provided frames (which the user will then
  108. * free with av_frame_unref()), there is no need to call
  109. * ff_thread_release_buffer().
  110. */
  111. int allocate_progress;
  112. /**
  113. * An audio frame with less than required samples has been submitted and
  114. * padded with silence. Reject all subsequent frames.
  115. */
  116. int last_audio_frame;
  117. AVFrame *to_free;
  118. FramePool *pool;
  119. void *thread_ctx;
  120. /**
  121. * Current packet as passed into the decoder, to avoid having to pass the
  122. * packet into every function.
  123. */
  124. const AVPacket *pkt;
  125. /**
  126. * temporary buffer used for encoders to store their bitstream
  127. */
  128. uint8_t *byte_buffer;
  129. unsigned int byte_buffer_size;
  130. void *frame_thread_encoder;
  131. /**
  132. * Number of audio samples to skip at the start of the next decoded frame
  133. */
  134. int skip_samples;
  135. /**
  136. * hwaccel-specific private data
  137. */
  138. void *hwaccel_priv_data;
  139. /**
  140. * checks API usage: after codec draining, flush is required to resume operation
  141. */
  142. int draining;
  143. /**
  144. * buffers for using new encode/decode API through legacy API
  145. */
  146. AVPacket *buffer_pkt;
  147. int buffer_pkt_valid; // encoding: packet without data can be valid
  148. AVFrame *buffer_frame;
  149. int draining_done;
  150. int showed_multi_packet_warning;
  151. int skip_samples_multiplier;
  152. } AVCodecInternal;
  153. struct AVCodecDefault {
  154. const uint8_t *key;
  155. const uint8_t *value;
  156. };
  157. extern const uint8_t ff_log2_run[41];
  158. /**
  159. * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
  160. * If there is no such matching pair then size is returned.
  161. */
  162. int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
  163. unsigned int avpriv_toupper4(unsigned int x);
  164. /**
  165. * does needed setup of pkt_pts/pos and such for (re)get_buffer();
  166. */
  167. int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
  168. void ff_color_frame(AVFrame *frame, const int color[4]);
  169. extern volatile int ff_avcodec_locked;
  170. int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
  171. int ff_unlock_avcodec(const AVCodec *codec);
  172. int avpriv_lock_avformat(void);
  173. int avpriv_unlock_avformat(void);
  174. /**
  175. * Maximum size in bytes of extradata.
  176. * This value was chosen such that every bit of the buffer is
  177. * addressable by a 32-bit signed integer as used by get_bits.
  178. */
  179. #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
  180. /**
  181. * Check AVPacket size and/or allocate data.
  182. *
  183. * Encoders supporting AVCodec.encode2() can use this as a convenience to
  184. * ensure the output packet data is large enough, whether provided by the user
  185. * or allocated in this function.
  186. *
  187. * @param avctx the AVCodecContext of the encoder
  188. * @param avpkt the AVPacket
  189. * If avpkt->data is already set, avpkt->size is checked
  190. * to ensure it is large enough.
  191. * If avpkt->data is NULL, a new buffer is allocated.
  192. * avpkt->size is set to the specified size.
  193. * All other AVPacket fields will be reset with av_init_packet().
  194. * @param size the minimum required packet size
  195. * @param min_size This is a hint to the allocation algorithm, which indicates
  196. * to what minimal size the caller might later shrink the packet
  197. * to. Encoders often allocate packets which are larger than the
  198. * amount of data that is written into them as the exact amount is
  199. * not known at the time of allocation. min_size represents the
  200. * size a packet might be shrunk to by the caller. Can be set to
  201. * 0. setting this roughly correctly allows the allocation code
  202. * to choose between several allocation strategies to improve
  203. * speed slightly.
  204. * @return non negative on success, negative error code on failure
  205. */
  206. int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
  207. attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
  208. /**
  209. * Rescale from sample rate to AVCodecContext.time_base.
  210. */
  211. static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
  212. int64_t samples)
  213. {
  214. if(samples == AV_NOPTS_VALUE)
  215. return AV_NOPTS_VALUE;
  216. return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
  217. avctx->time_base);
  218. }
  219. /**
  220. * 2^(x) for integer x
  221. * @return correctly rounded float
  222. */
  223. static av_always_inline float ff_exp2fi(int x) {
  224. /* Normal range */
  225. if (-126 <= x && x <= 128)
  226. return av_int2float((x+127) << 23);
  227. /* Too large */
  228. else if (x > 128)
  229. return INFINITY;
  230. /* Subnormal numbers */
  231. else if (x > -150)
  232. return av_int2float(1 << (x+149));
  233. /* Negligibly small */
  234. else
  235. return 0;
  236. }
  237. /**
  238. * Get a buffer for a frame. This is a wrapper around
  239. * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
  240. * directly.
  241. */
  242. int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
  243. /**
  244. * Identical in function to av_frame_make_writable(), except it uses
  245. * ff_get_buffer() to allocate the buffer when needed.
  246. */
  247. int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
  248. int ff_thread_can_start_frame(AVCodecContext *avctx);
  249. int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
  250. /**
  251. * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
  252. * calling the function and then restoring again. Assumes the mutex is
  253. * already locked
  254. */
  255. int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
  256. /**
  257. * Finalize buf into extradata and set its size appropriately.
  258. */
  259. int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
  260. const uint8_t *avpriv_find_start_code(const uint8_t *p,
  261. const uint8_t *end,
  262. uint32_t *state);
  263. int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
  264. /**
  265. * Check that the provided frame dimensions are valid and set them on the codec
  266. * context.
  267. */
  268. int ff_set_dimensions(AVCodecContext *s, int width, int height);
  269. /**
  270. * Check that the provided sample aspect ratio is valid and set it on the codec
  271. * context.
  272. */
  273. int ff_set_sar(AVCodecContext *avctx, AVRational sar);
  274. /**
  275. * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
  276. */
  277. int ff_side_data_update_matrix_encoding(AVFrame *frame,
  278. enum AVMatrixEncoding matrix_encoding);
  279. /**
  280. * Select the (possibly hardware accelerated) pixel format.
  281. * This is a wrapper around AVCodecContext.get_format() and should be used
  282. * instead of calling get_format() directly.
  283. */
  284. int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
  285. /**
  286. * Set various frame properties from the codec context / packet data.
  287. */
  288. int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
  289. /**
  290. * Add a CPB properties side data to an encoding context.
  291. */
  292. AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
  293. int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
  294. /**
  295. * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
  296. *
  297. * @param frame Raw frame to get A53 side data from
  298. * @param prefix_len Number of bytes to allocate before SEI message
  299. * @param data Pointer to a variable to store allocated memory
  300. * Upon return the variable will hold NULL on error or if frame has no A53 info.
  301. * Otherwise it will point to prefix_len uninitialized bytes followed by
  302. * *sei_size SEI message
  303. * @param sei_size Pointer to a variable to store generated SEI message length
  304. * @return Zero on success, negative error code on failure
  305. */
  306. int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
  307. void **data, size_t *sei_size);
  308. #endif /* AVCODEC_INTERNAL_H */