avutil.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. /*
  2. * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef AVUTIL_AVUTIL_H
  21. #define AVUTIL_AVUTIL_H
  22. /**
  23. * @file
  24. * @ingroup lavu
  25. * Convenience header that includes @ref lavu "libavutil"'s core.
  26. */
  27. /**
  28. * @mainpage
  29. *
  30. * @section ffmpeg_intro Introduction
  31. *
  32. * This document describes the usage of the different libraries
  33. * provided by FFmpeg.
  34. *
  35. * @li @ref libavc "libavcodec" encoding/decoding library
  36. * @li @ref lavfi "libavfilter" graph-based frame editing library
  37. * @li @ref libavf "libavformat" I/O and muxing/demuxing library
  38. * @li @ref lavd "libavdevice" special devices muxing/demuxing library
  39. * @li @ref lavu "libavutil" common utility library
  40. * @li @ref lswr "libswresample" audio resampling, format conversion and mixing
  41. * @li @ref lpp "libpostproc" post processing library
  42. * @li @ref libsws "libswscale" color conversion and scaling library
  43. *
  44. * @section ffmpeg_versioning Versioning and compatibility
  45. *
  46. * Each of the FFmpeg libraries contains a version.h header, which defines a
  47. * major, minor and micro version number with the
  48. * <em>LIBRARYNAME_VERSION_{MAJOR,MINOR,MICRO}</em> macros. The major version
  49. * number is incremented with backward incompatible changes - e.g. removing
  50. * parts of the public API, reordering public struct members, etc. The minor
  51. * version number is incremented for backward compatible API changes or major
  52. * new features - e.g. adding a new public function or a new decoder. The micro
  53. * version number is incremented for smaller changes that a calling program
  54. * might still want to check for - e.g. changing behavior in a previously
  55. * unspecified situation.
  56. *
  57. * FFmpeg guarantees backward API and ABI compatibility for each library as long
  58. * as its major version number is unchanged. This means that no public symbols
  59. * will be removed or renamed. Types and names of the public struct members and
  60. * values of public macros and enums will remain the same (unless they were
  61. * explicitly declared as not part of the public API). Documented behavior will
  62. * not change.
  63. *
  64. * In other words, any correct program that works with a given FFmpeg snapshot
  65. * should work just as well without any changes with any later snapshot with the
  66. * same major versions. This applies to both rebuilding the program against new
  67. * FFmpeg versions or to replacing the dynamic FFmpeg libraries that a program
  68. * links against.
  69. *
  70. * However, new public symbols may be added and new members may be appended to
  71. * public structs whose size is not part of public ABI (most public structs in
  72. * FFmpeg). New macros and enum values may be added. Behavior in undocumented
  73. * situations may change slightly (and be documented). All those are accompanied
  74. * by an entry in doc/APIchanges and incrementing either the minor or micro
  75. * version number.
  76. */
  77. /**
  78. * @defgroup lavu libavutil
  79. * Common code shared across all FFmpeg libraries.
  80. *
  81. * @note
  82. * libavutil is designed to be modular. In most cases, in order to use the
  83. * functions provided by one component of libavutil you must explicitly include
  84. * the specific header containing that feature. If you are only using
  85. * media-related components, you could simply include libavutil/avutil.h, which
  86. * brings in most of the "core" components.
  87. *
  88. * @{
  89. *
  90. * @defgroup lavu_crypto Crypto and Hashing
  91. *
  92. * @{
  93. * @}
  94. *
  95. * @defgroup lavu_math Mathematics
  96. * @{
  97. *
  98. * @}
  99. *
  100. * @defgroup lavu_string String Manipulation
  101. *
  102. * @{
  103. *
  104. * @}
  105. *
  106. * @defgroup lavu_mem Memory Management
  107. *
  108. * @{
  109. *
  110. * @}
  111. *
  112. * @defgroup lavu_data Data Structures
  113. * @{
  114. *
  115. * @}
  116. *
  117. * @defgroup lavu_audio Audio related
  118. *
  119. * @{
  120. *
  121. * @}
  122. *
  123. * @defgroup lavu_error Error Codes
  124. *
  125. * @{
  126. *
  127. * @}
  128. *
  129. * @defgroup lavu_log Logging Facility
  130. *
  131. * @{
  132. *
  133. * @}
  134. *
  135. * @defgroup lavu_misc Other
  136. *
  137. * @{
  138. *
  139. * @defgroup preproc_misc Preprocessor String Macros
  140. *
  141. * @{
  142. *
  143. * @}
  144. *
  145. * @defgroup version_utils Library Version Macros
  146. *
  147. * @{
  148. *
  149. * @}
  150. */
  151. /**
  152. * @addtogroup lavu_ver
  153. * @{
  154. */
  155. /**
  156. * Return the LIBAVUTIL_VERSION_INT constant.
  157. */
  158. unsigned avutil_version(void);
  159. /**
  160. * Return an informative version string. This usually is the actual release
  161. * version number or a git commit description. This string has no fixed format
  162. * and can change any time. It should never be parsed by code.
  163. */
  164. const char *av_version_info(void);
  165. /**
  166. * Return the libavutil build-time configuration.
  167. */
  168. const char *avutil_configuration(void);
  169. /**
  170. * Return the libavutil license.
  171. */
  172. const char *avutil_license(void);
  173. /**
  174. * @}
  175. */
  176. /**
  177. * @addtogroup lavu_media Media Type
  178. * @brief Media Type
  179. */
  180. enum AVMediaType {
  181. AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA
  182. AVMEDIA_TYPE_VIDEO,
  183. AVMEDIA_TYPE_AUDIO,
  184. AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous
  185. AVMEDIA_TYPE_SUBTITLE,
  186. AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse
  187. AVMEDIA_TYPE_NB
  188. };
  189. /**
  190. * Return a string describing the media_type enum, NULL if media_type
  191. * is unknown.
  192. */
  193. const char *av_get_media_type_string(enum AVMediaType media_type);
  194. /**
  195. * @defgroup lavu_const Constants
  196. * @{
  197. *
  198. * @defgroup lavu_enc Encoding specific
  199. *
  200. * @note those definition should move to avcodec
  201. * @{
  202. */
  203. #define FF_LAMBDA_SHIFT 7
  204. #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
  205. #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
  206. #define FF_LAMBDA_MAX (256*128-1)
  207. #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
  208. /**
  209. * @}
  210. * @defgroup lavu_time Timestamp specific
  211. *
  212. * FFmpeg internal timebase and timestamp definitions
  213. *
  214. * @{
  215. */
  216. /**
  217. * @brief Undefined timestamp value
  218. *
  219. * Usually reported by demuxer that work on containers that do not provide
  220. * either pts or dts.
  221. */
  222. #define AV_NOPTS_VALUE ((int64_t)UINT64_C(0x8000000000000000))
  223. /**
  224. * Internal time base represented as integer
  225. */
  226. #define AV_TIME_BASE 1000000
  227. /**
  228. * Internal time base represented as fractional value
  229. */
  230. #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
  231. /**
  232. * @}
  233. * @}
  234. * @defgroup lavu_picture Image related
  235. *
  236. * AVPicture types, pixel formats and basic image planes manipulation.
  237. *
  238. * @{
  239. */
  240. enum AVPictureType {
  241. AV_PICTURE_TYPE_NONE = 0, ///< Undefined
  242. AV_PICTURE_TYPE_I, ///< Intra
  243. AV_PICTURE_TYPE_P, ///< Predicted
  244. AV_PICTURE_TYPE_B, ///< Bi-dir predicted
  245. AV_PICTURE_TYPE_S, ///< S(GMC)-VOP MPEG-4
  246. AV_PICTURE_TYPE_SI, ///< Switching Intra
  247. AV_PICTURE_TYPE_SP, ///< Switching Predicted
  248. AV_PICTURE_TYPE_BI, ///< BI type
  249. };
  250. /**
  251. * Return a single letter to describe the given picture type
  252. * pict_type.
  253. *
  254. * @param[in] pict_type the picture type @return a single character
  255. * representing the picture type, '?' if pict_type is unknown
  256. */
  257. char av_get_picture_type_char(enum AVPictureType pict_type);
  258. /**
  259. * @}
  260. */
  261. #include "common.h"
  262. #include "error.h"
  263. #include "rational.h"
  264. #include "version.h"
  265. #include "macros.h"
  266. #include "mathematics.h"
  267. #include "log.h"
  268. #include "pixfmt.h"
  269. /**
  270. * Return x default pointer in case p is NULL.
  271. */
  272. static inline void *av_x_if_null(const void *p, const void *x)
  273. {
  274. return (void *)(intptr_t)(p ? p : x);
  275. }
  276. /**
  277. * Compute the length of an integer list.
  278. *
  279. * @param elsize size in bytes of each list element (only 1, 2, 4 or 8)
  280. * @param term list terminator (usually 0 or -1)
  281. * @param list pointer to the list
  282. * @return length of the list, in elements, not counting the terminator
  283. */
  284. unsigned av_int_list_length_for_size(unsigned elsize,
  285. const void *list, uint64_t term) av_pure;
  286. /**
  287. * Compute the length of an integer list.
  288. *
  289. * @param term list terminator (usually 0 or -1)
  290. * @param list pointer to the list
  291. * @return length of the list, in elements, not counting the terminator
  292. */
  293. #define av_int_list_length(list, term) \
  294. av_int_list_length_for_size(sizeof(*(list)), list, term)
  295. /**
  296. * Open a file using a UTF-8 filename.
  297. * The API of this function matches POSIX fopen(), errors are returned through
  298. * errno.
  299. */
  300. FILE *av_fopen_utf8(const char *path, const char *mode);
  301. /**
  302. * Return the fractional representation of the internal time base.
  303. */
  304. AVRational av_get_time_base_q(void);
  305. /**
  306. * @}
  307. * @}
  308. */
  309. #endif /* AVUTIL_AVUTIL_H */