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 * @ingroup lavu_frame 22 * reference-counted frame API 23 */ 24 25 #ifndef AVUTIL_FRAME_H 26 #define AVUTIL_FRAME_H 27 28 #include <stddef.h> 29 #include <stdint.h> 30 31 #include "avutil.h" 32 #include "buffer.h" 33 #include "dict.h" 34 #include "rational.h" 35 #include "samplefmt.h" 36 #include "pixfmt.h" 37 #include "version.h" 38 39 40 /** 41 * @defgroup lavu_frame AVFrame 42 * @ingroup lavu_data 43 * 44 * @{ 45 * AVFrame is an abstraction for reference-counted raw multimedia data. 46 */ 47 48 enum AVFrameSideDataType { 49 /** 50 * The data is the AVPanScan struct defined in libavcodec. 51 */ 52 AV_FRAME_DATA_PANSCAN, 53 /** 54 * ATSC A53 Part 4 Closed Captions. 55 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data. 56 * The number of bytes of CC data is AVFrameSideData.size. 57 */ 58 AV_FRAME_DATA_A53_CC, 59 /** 60 * Stereoscopic 3d metadata. 61 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h. 62 */ 63 AV_FRAME_DATA_STEREO3D, 64 /** 65 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h. 66 */ 67 AV_FRAME_DATA_MATRIXENCODING, 68 /** 69 * Metadata relevant to a downmix procedure. 70 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h. 71 */ 72 AV_FRAME_DATA_DOWNMIX_INFO, 73 /** 74 * ReplayGain information in the form of the AVReplayGain struct. 75 */ 76 AV_FRAME_DATA_REPLAYGAIN, 77 /** 78 * This side data contains a 3x3 transformation matrix describing an affine 79 * transformation that needs to be applied to the frame for correct 80 * presentation. 81 * 82 * See libavutil/display.h for a detailed description of the data. 83 */ 84 AV_FRAME_DATA_DISPLAYMATRIX, 85 /** 86 * Active Format Description data consisting of a single byte as specified 87 * in ETSI TS 101 154 using AVActiveFormatDescription enum. 88 */ 89 AV_FRAME_DATA_AFD, 90 /** 91 * Motion vectors exported by some codecs (on demand through the export_mvs 92 * flag set in the libavcodec AVCodecContext flags2 option). 93 * The data is the AVMotionVector struct defined in 94 * libavutil/motion_vector.h. 95 */ 96 AV_FRAME_DATA_MOTION_VECTORS, 97 /** 98 * Recommmends skipping the specified number of samples. This is exported 99 * only if the "skip_manual" AVOption is set in libavcodec. 100 * This has the same format as AV_PKT_DATA_SKIP_SAMPLES. 101 * @code 102 * u32le number of samples to skip from start of this packet 103 * u32le number of samples to skip from end of this packet 104 * u8 reason for start skip 105 * u8 reason for end skip (0=padding silence, 1=convergence) 106 * @endcode 107 */ 108 AV_FRAME_DATA_SKIP_SAMPLES, 109 /** 110 * This side data must be associated with an audio frame and corresponds to 111 * enum AVAudioServiceType defined in avcodec.h. 112 */ 113 AV_FRAME_DATA_AUDIO_SERVICE_TYPE, 114 /** 115 * Mastering display metadata associated with a video frame. The payload is 116 * an AVMasteringDisplayMetadata type and contains information about the 117 * mastering display color volume. 118 */ 119 AV_FRAME_DATA_MASTERING_DISPLAY_METADATA, 120 /** 121 * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer. 122 * This is set on the first frame of a GOP that has a temporal reference of 0. 123 */ 124 AV_FRAME_DATA_GOP_TIMECODE, 125 126 /** 127 * The data represents the AVSphericalMapping structure defined in 128 * libavutil/spherical.h. 129 */ 130 AV_FRAME_DATA_SPHERICAL, 131 132 /** 133 * Content light level (based on CTA-861.3). This payload contains data in 134 * the form of the AVContentLightMetadata struct. 135 */ 136 AV_FRAME_DATA_CONTENT_LIGHT_LEVEL, 137 138 /** 139 * The data contains an ICC profile as an opaque octet buffer following the 140 * format described by ISO 15076-1 with an optional name defined in the 141 * metadata key entry "name". 142 */ 143 AV_FRAME_DATA_ICC_PROFILE, 144 145 #if FF_API_FRAME_QP 146 /** 147 * Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA. 148 * The contents of this side data are undocumented and internal; use 149 * av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a 150 * meaningful way instead. 151 */ 152 AV_FRAME_DATA_QP_TABLE_PROPERTIES, 153 154 /** 155 * Raw QP table data. Its format is described by 156 * AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and 157 * av_frame_get_qp_table() to access this instead. 158 */ 159 AV_FRAME_DATA_QP_TABLE_DATA, 160 #endif 161 162 /** 163 * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t 164 * where the first uint32_t describes how many (1-3) of the other timecodes are used. 165 * The timecode format is described in the av_timecode_get_smpte_from_framenum() 166 * function in libavutil/timecode.c. 167 */ 168 AV_FRAME_DATA_S12M_TIMECODE, 169 170 /** 171 * HDR dynamic metadata associated with a video frame. The payload is 172 * an AVDynamicHDRPlus type and contains information for color 173 * volume transform - application 4 of SMPTE 2094-40:2016 standard. 174 */ 175 AV_FRAME_DATA_DYNAMIC_HDR_PLUS, 176 177 /** 178 * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of 179 * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size. 180 */ 181 AV_FRAME_DATA_REGIONS_OF_INTEREST, 182 183 /** 184 * Encoding parameters for a video frame, as described by AVVideoEncParams. 185 */ 186 AV_FRAME_DATA_VIDEO_ENC_PARAMS, 187 }; 188 189 enum AVActiveFormatDescription { 190 AV_AFD_SAME = 8, 191 AV_AFD_4_3 = 9, 192 AV_AFD_16_9 = 10, 193 AV_AFD_14_9 = 11, 194 AV_AFD_4_3_SP_14_9 = 13, 195 AV_AFD_16_9_SP_14_9 = 14, 196 AV_AFD_SP_4_3 = 15, 197 }; 198 199 200 /** 201 * Structure to hold side data for an AVFrame. 202 * 203 * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added 204 * to the end with a minor bump. 205 */ 206 typedef struct AVFrameSideData { 207 enum AVFrameSideDataType type; 208 uint8_t *data; 209 int size; 210 AVDictionary *metadata; 211 AVBufferRef *buf; 212 } AVFrameSideData; 213 214 /** 215 * Structure describing a single Region Of Interest. 216 * 217 * When multiple regions are defined in a single side-data block, they 218 * should be ordered from most to least important - some encoders are only 219 * capable of supporting a limited number of distinct regions, so will have 220 * to truncate the list. 221 * 222 * When overlapping regions are defined, the first region containing a given 223 * area of the frame applies. 224 */ 225 typedef struct AVRegionOfInterest { 226 /** 227 * Must be set to the size of this data structure (that is, 228 * sizeof(AVRegionOfInterest)). 229 */ 230 uint32_t self_size; 231 /** 232 * Distance in pixels from the top edge of the frame to the top and 233 * bottom edges and from the left edge of the frame to the left and 234 * right edges of the rectangle defining this region of interest. 235 * 236 * The constraints on a region are encoder dependent, so the region 237 * actually affected may be slightly larger for alignment or other 238 * reasons. 239 */ 240 int top; 241 int bottom; 242 int left; 243 int right; 244 /** 245 * Quantisation offset. 246 * 247 * Must be in the range -1 to +1. A value of zero indicates no quality 248 * change. A negative value asks for better quality (less quantisation), 249 * while a positive value asks for worse quality (greater quantisation). 250 * 251 * The range is calibrated so that the extreme values indicate the 252 * largest possible offset - if the rest of the frame is encoded with the 253 * worst possible quality, an offset of -1 indicates that this region 254 * should be encoded with the best possible quality anyway. Intermediate 255 * values are then interpolated in some codec-dependent way. 256 * 257 * For example, in 10-bit H.264 the quantisation parameter varies between 258 * -12 and 51. A typical qoffset value of -1/10 therefore indicates that 259 * this region should be encoded with a QP around one-tenth of the full 260 * range better than the rest of the frame. So, if most of the frame 261 * were to be encoded with a QP of around 30, this region would get a QP 262 * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). 263 * An extreme value of -1 would indicate that this region should be 264 * encoded with the best possible quality regardless of the treatment of 265 * the rest of the frame - that is, should be encoded at a QP of -12. 266 */ 267 AVRational qoffset; 268 } AVRegionOfInterest; 269 270 /** 271 * This structure describes decoded (raw) audio or video data. 272 * 273 * AVFrame must be allocated using av_frame_alloc(). Note that this only 274 * allocates the AVFrame itself, the buffers for the data must be managed 275 * through other means (see below). 276 * AVFrame must be freed with av_frame_free(). 277 * 278 * AVFrame is typically allocated once and then reused multiple times to hold 279 * different data (e.g. a single AVFrame to hold frames received from a 280 * decoder). In such a case, av_frame_unref() will free any references held by 281 * the frame and reset it to its original clean state before it 282 * is reused again. 283 * 284 * The data described by an AVFrame is usually reference counted through the 285 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf / 286 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at 287 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case, 288 * every single data plane must be contained in one of the buffers in 289 * AVFrame.buf or AVFrame.extended_buf. 290 * There may be a single buffer for all the data, or one separate buffer for 291 * each plane, or anything in between. 292 * 293 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added 294 * to the end with a minor bump. 295 * 296 * Fields can be accessed through AVOptions, the name string used, matches the 297 * C structure field name for fields accessible through AVOptions. The AVClass 298 * for AVFrame can be obtained from avcodec_get_frame_class() 299 */ 300 typedef struct AVFrame { 301 #define AV_NUM_DATA_POINTERS 8 302 /** 303 * pointer to the picture/channel planes. 304 * This might be different from the first allocated byte 305 * 306 * Some decoders access areas outside 0,0 - width,height, please 307 * see avcodec_align_dimensions2(). Some filters and swscale can read 308 * up to 16 bytes beyond the planes, if these filters are to be used, 309 * then 16 extra bytes must be allocated. 310 * 311 * NOTE: Except for hwaccel formats, pointers not needed by the format 312 * MUST be set to NULL. 313 */ 314 uint8_t *data[AV_NUM_DATA_POINTERS]; 315 316 /** 317 * For video, size in bytes of each picture line. 318 * For audio, size in bytes of each plane. 319 * 320 * For audio, only linesize[0] may be set. For planar audio, each channel 321 * plane must be the same size. 322 * 323 * For video the linesizes should be multiples of the CPUs alignment 324 * preference, this is 16 or 32 for modern desktop CPUs. 325 * Some code requires such alignment other code can be slower without 326 * correct alignment, for yet other it makes no difference. 327 * 328 * @note The linesize may be larger than the size of usable data -- there 329 * may be extra padding present for performance reasons. 330 */ 331 int linesize[AV_NUM_DATA_POINTERS]; 332 333 /** 334 * pointers to the data planes/channels. 335 * 336 * For video, this should simply point to data[]. 337 * 338 * For planar audio, each channel has a separate data pointer, and 339 * linesize[0] contains the size of each channel buffer. 340 * For packed audio, there is just one data pointer, and linesize[0] 341 * contains the total size of the buffer for all channels. 342 * 343 * Note: Both data and extended_data should always be set in a valid frame, 344 * but for planar audio with more channels that can fit in data, 345 * extended_data must be used in order to access all channels. 346 */ 347 uint8_t **extended_data; 348 349 /** 350 * @name Video dimensions 351 * Video frames only. The coded dimensions (in pixels) of the video frame, 352 * i.e. the size of the rectangle that contains some well-defined values. 353 * 354 * @note The part of the frame intended for display/presentation is further 355 * restricted by the @ref cropping "Cropping rectangle". 356 * @{ 357 */ 358 int width, height; 359 /** 360 * @} 361 */ 362 363 /** 364 * number of audio samples (per channel) described by this frame 365 */ 366 int nb_samples; 367 368 /** 369 * format of the frame, -1 if unknown or unset 370 * Values correspond to enum AVPixelFormat for video frames, 371 * enum AVSampleFormat for audio) 372 */ 373 int format; 374 375 /** 376 * 1 -> keyframe, 0-> not 377 */ 378 int key_frame; 379 380 /** 381 * Picture type of the frame. 382 */ 383 enum AVPictureType pict_type; 384 385 /** 386 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified. 387 */ 388 AVRational sample_aspect_ratio; 389 390 /** 391 * Presentation timestamp in time_base units (time when frame should be shown to user). 392 */ 393 int64_t pts; 394 395 #if FF_API_PKT_PTS 396 /** 397 * PTS copied from the AVPacket that was decoded to produce this frame. 398 * @deprecated use the pts field instead 399 */ 400 attribute_deprecated 401 int64_t pkt_pts; 402 #endif 403 404 /** 405 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used) 406 * This is also the Presentation time of this AVFrame calculated from 407 * only AVPacket.dts values without pts values. 408 */ 409 int64_t pkt_dts; 410 411 /** 412 * picture number in bitstream order 413 */ 414 int coded_picture_number; 415 /** 416 * picture number in display order 417 */ 418 int display_picture_number; 419 420 /** 421 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) 422 */ 423 int quality; 424 425 /** 426 * for some private data of the user 427 */ 428 void *opaque; 429 430 #if FF_API_ERROR_FRAME 431 /** 432 * @deprecated unused 433 */ 434 attribute_deprecated 435 uint64_t error[AV_NUM_DATA_POINTERS]; 436 #endif 437 438 /** 439 * When decoding, this signals how much the picture must be delayed. 440 * extra_delay = repeat_pict / (2*fps) 441 */ 442 int repeat_pict; 443 444 /** 445 * The content of the picture is interlaced. 446 */ 447 int interlaced_frame; 448 449 /** 450 * If the content is interlaced, is top field displayed first. 451 */ 452 int top_field_first; 453 454 /** 455 * Tell user application that palette has changed from previous frame. 456 */ 457 int palette_has_changed; 458 459 /** 460 * reordered opaque 64 bits (generally an integer or a double precision float 461 * PTS but can be anything). 462 * The user sets AVCodecContext.reordered_opaque to represent the input at 463 * that time, 464 * the decoder reorders values as needed and sets AVFrame.reordered_opaque 465 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque 466 */ 467 int64_t reordered_opaque; 468 469 /** 470 * Sample rate of the audio data. 471 */ 472 int sample_rate; 473 474 /** 475 * Channel layout of the audio data. 476 */ 477 uint64_t channel_layout; 478 479 /** 480 * AVBuffer references backing the data for this frame. If all elements of 481 * this array are NULL, then this frame is not reference counted. This array 482 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must 483 * also be non-NULL for all j < i. 484 * 485 * There may be at most one AVBuffer per data plane, so for video this array 486 * always contains all the references. For planar audio with more than 487 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in 488 * this array. Then the extra AVBufferRef pointers are stored in the 489 * extended_buf array. 490 */ 491 AVBufferRef *buf[AV_NUM_DATA_POINTERS]; 492 493 /** 494 * For planar audio which requires more than AV_NUM_DATA_POINTERS 495 * AVBufferRef pointers, this array will hold all the references which 496 * cannot fit into AVFrame.buf. 497 * 498 * Note that this is different from AVFrame.extended_data, which always 499 * contains all the pointers. This array only contains the extra pointers, 500 * which cannot fit into AVFrame.buf. 501 * 502 * This array is always allocated using av_malloc() by whoever constructs 503 * the frame. It is freed in av_frame_unref(). 504 */ 505 AVBufferRef **extended_buf; 506 /** 507 * Number of elements in extended_buf. 508 */ 509 int nb_extended_buf; 510 511 AVFrameSideData **side_data; 512 int nb_side_data; 513 514 /** 515 * @defgroup lavu_frame_flags AV_FRAME_FLAGS 516 * @ingroup lavu_frame 517 * Flags describing additional frame properties. 518 * 519 * @{ 520 */ 521 522 /** 523 * The frame data may be corrupted, e.g. due to decoding errors. 524 */ 525 #define AV_FRAME_FLAG_CORRUPT (1 << 0) 526 /** 527 * A flag to mark the frames which need to be decoded, but shouldn't be output. 528 */ 529 #define AV_FRAME_FLAG_DISCARD (1 << 2) 530 /** 531 * @} 532 */ 533 534 /** 535 * Frame flags, a combination of @ref lavu_frame_flags 536 */ 537 int flags; 538 539 /** 540 * MPEG vs JPEG YUV range. 541 * - encoding: Set by user 542 * - decoding: Set by libavcodec 543 */ 544 enum AVColorRange color_range; 545 546 enum AVColorPrimaries color_primaries; 547 548 enum AVColorTransferCharacteristic color_trc; 549 550 /** 551 * YUV colorspace type. 552 * - encoding: Set by user 553 * - decoding: Set by libavcodec 554 */ 555 enum AVColorSpace colorspace; 556 557 enum AVChromaLocation chroma_location; 558 559 /** 560 * frame timestamp estimated using various heuristics, in stream time base 561 * - encoding: unused 562 * - decoding: set by libavcodec, read by user. 563 */ 564 int64_t best_effort_timestamp; 565 566 /** 567 * reordered pos from the last AVPacket that has been input into the decoder 568 * - encoding: unused 569 * - decoding: Read by user. 570 */ 571 int64_t pkt_pos; 572 573 /** 574 * duration of the corresponding packet, expressed in 575 * AVStream->time_base units, 0 if unknown. 576 * - encoding: unused 577 * - decoding: Read by user. 578 */ 579 int64_t pkt_duration; 580 581 /** 582 * metadata. 583 * - encoding: Set by user. 584 * - decoding: Set by libavcodec. 585 */ 586 AVDictionary *metadata; 587 588 /** 589 * decode error flags of the frame, set to a combination of 590 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there 591 * were errors during the decoding. 592 * - encoding: unused 593 * - decoding: set by libavcodec, read by user. 594 */ 595 int decode_error_flags; 596 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1 597 #define FF_DECODE_ERROR_MISSING_REFERENCE 2 598 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4 599 #define FF_DECODE_ERROR_DECODE_SLICES 8 600 601 /** 602 * number of audio channels, only used for audio. 603 * - encoding: unused 604 * - decoding: Read by user. 605 */ 606 int channels; 607 608 /** 609 * size of the corresponding packet containing the compressed 610 * frame. 611 * It is set to a negative value if unknown. 612 * - encoding: unused 613 * - decoding: set by libavcodec, read by user. 614 */ 615 int pkt_size; 616 617 #if FF_API_FRAME_QP 618 /** 619 * QP table 620 */ 621 attribute_deprecated 622 int8_t *qscale_table; 623 /** 624 * QP store stride 625 */ 626 attribute_deprecated 627 int qstride; 628 629 attribute_deprecated 630 int qscale_type; 631 632 attribute_deprecated 633 AVBufferRef *qp_table_buf; 634 #endif 635 /** 636 * For hwaccel-format frames, this should be a reference to the 637 * AVHWFramesContext describing the frame. 638 */ 639 AVBufferRef *hw_frames_ctx; 640 641 /** 642 * AVBufferRef for free use by the API user. FFmpeg will never check the 643 * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when 644 * the frame is unreferenced. av_frame_copy_props() calls create a new 645 * reference with av_buffer_ref() for the target frame's opaque_ref field. 646 * 647 * This is unrelated to the opaque field, although it serves a similar 648 * purpose. 649 */ 650 AVBufferRef *opaque_ref; 651 652 /** 653 * @anchor cropping 654 * @name Cropping 655 * Video frames only. The number of pixels to discard from the the 656 * top/bottom/left/right border of the frame to obtain the sub-rectangle of 657 * the frame intended for presentation. 658 * @{ 659 */ 660 size_t crop_top; 661 size_t crop_bottom; 662 size_t crop_left; 663 size_t crop_right; 664 /** 665 * @} 666 */ 667 668 /** 669 * AVBufferRef for internal use by a single libav* library. 670 * Must not be used to transfer data between libraries. 671 * Has to be NULL when ownership of the frame leaves the respective library. 672 * 673 * Code outside the FFmpeg libs should never check or change the contents of the buffer ref. 674 * 675 * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced. 676 * av_frame_copy_props() calls create a new reference with av_buffer_ref() 677 * for the target frame's private_ref field. 678 */ 679 AVBufferRef *private_ref; 680 } AVFrame; 681 682 #if FF_API_FRAME_GET_SET 683 /** 684 * Accessors for some AVFrame fields. These used to be provided for ABI 685 * compatibility, and do not need to be used anymore. 686 */ 687 attribute_deprecated 688 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame); 689 attribute_deprecated 690 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val); 691 attribute_deprecated 692 int64_t av_frame_get_pkt_duration (const AVFrame *frame); 693 attribute_deprecated 694 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val); 695 attribute_deprecated 696 int64_t av_frame_get_pkt_pos (const AVFrame *frame); 697 attribute_deprecated 698 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val); 699 attribute_deprecated 700 int64_t av_frame_get_channel_layout (const AVFrame *frame); 701 attribute_deprecated 702 void av_frame_set_channel_layout (AVFrame *frame, int64_t val); 703 attribute_deprecated 704 int av_frame_get_channels (const AVFrame *frame); 705 attribute_deprecated 706 void av_frame_set_channels (AVFrame *frame, int val); 707 attribute_deprecated 708 int av_frame_get_sample_rate (const AVFrame *frame); 709 attribute_deprecated 710 void av_frame_set_sample_rate (AVFrame *frame, int val); 711 attribute_deprecated 712 AVDictionary *av_frame_get_metadata (const AVFrame *frame); 713 attribute_deprecated 714 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val); 715 attribute_deprecated 716 int av_frame_get_decode_error_flags (const AVFrame *frame); 717 attribute_deprecated 718 void av_frame_set_decode_error_flags (AVFrame *frame, int val); 719 attribute_deprecated 720 int av_frame_get_pkt_size(const AVFrame *frame); 721 attribute_deprecated 722 void av_frame_set_pkt_size(AVFrame *frame, int val); 723 #if FF_API_FRAME_QP 724 attribute_deprecated 725 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type); 726 attribute_deprecated 727 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type); 728 #endif 729 attribute_deprecated 730 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame); 731 attribute_deprecated 732 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val); 733 attribute_deprecated 734 enum AVColorRange av_frame_get_color_range(const AVFrame *frame); 735 attribute_deprecated 736 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val); 737 #endif 738 739 /** 740 * Get the name of a colorspace. 741 * @return a static string identifying the colorspace; can be NULL. 742 */ 743 const char *av_get_colorspace_name(enum AVColorSpace val); 744 745 /** 746 * Allocate an AVFrame and set its fields to default values. The resulting 747 * struct must be freed using av_frame_free(). 748 * 749 * @return An AVFrame filled with default values or NULL on failure. 750 * 751 * @note this only allocates the AVFrame itself, not the data buffers. Those 752 * must be allocated through other means, e.g. with av_frame_get_buffer() or 753 * manually. 754 */ 755 AVFrame *av_frame_alloc(void); 756 757 /** 758 * Free the frame and any dynamically allocated objects in it, 759 * e.g. extended_data. If the frame is reference counted, it will be 760 * unreferenced first. 761 * 762 * @param frame frame to be freed. The pointer will be set to NULL. 763 */ 764 void av_frame_free(AVFrame **frame); 765 766 /** 767 * Set up a new reference to the data described by the source frame. 768 * 769 * Copy frame properties from src to dst and create a new reference for each 770 * AVBufferRef from src. 771 * 772 * If src is not reference counted, new buffers are allocated and the data is 773 * copied. 774 * 775 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst), 776 * or newly allocated with av_frame_alloc() before calling this 777 * function, or undefined behavior will occur. 778 * 779 * @return 0 on success, a negative AVERROR on error 780 */ 781 int av_frame_ref(AVFrame *dst, const AVFrame *src); 782 783 /** 784 * Create a new frame that references the same data as src. 785 * 786 * This is a shortcut for av_frame_alloc()+av_frame_ref(). 787 * 788 * @return newly created AVFrame on success, NULL on error. 789 */ 790 AVFrame *av_frame_clone(const AVFrame *src); 791 792 /** 793 * Unreference all the buffers referenced by frame and reset the frame fields. 794 */ 795 void av_frame_unref(AVFrame *frame); 796 797 /** 798 * Move everything contained in src to dst and reset src. 799 * 800 * @warning: dst is not unreferenced, but directly overwritten without reading 801 * or deallocating its contents. Call av_frame_unref(dst) manually 802 * before calling this function to ensure that no memory is leaked. 803 */ 804 void av_frame_move_ref(AVFrame *dst, AVFrame *src); 805 806 /** 807 * Allocate new buffer(s) for audio or video data. 808 * 809 * The following fields must be set on frame before calling this function: 810 * - format (pixel format for video, sample format for audio) 811 * - width and height for video 812 * - nb_samples and channel_layout for audio 813 * 814 * This function will fill AVFrame.data and AVFrame.buf arrays and, if 815 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. 816 * For planar formats, one buffer will be allocated for each plane. 817 * 818 * @warning: if frame already has been allocated, calling this function will 819 * leak memory. In addition, undefined behavior can occur in certain 820 * cases. 821 * 822 * @param frame frame in which to store the new buffers. 823 * @param align Required buffer size alignment. If equal to 0, alignment will be 824 * chosen automatically for the current CPU. It is highly 825 * recommended to pass 0 here unless you know what you are doing. 826 * 827 * @return 0 on success, a negative AVERROR on error. 828 */ 829 int av_frame_get_buffer(AVFrame *frame, int align); 830 831 /** 832 * Check if the frame data is writable. 833 * 834 * @return A positive value if the frame data is writable (which is true if and 835 * only if each of the underlying buffers has only one reference, namely the one 836 * stored in this frame). Return 0 otherwise. 837 * 838 * If 1 is returned the answer is valid until av_buffer_ref() is called on any 839 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly). 840 * 841 * @see av_frame_make_writable(), av_buffer_is_writable() 842 */ 843 int av_frame_is_writable(AVFrame *frame); 844 845 /** 846 * Ensure that the frame data is writable, avoiding data copy if possible. 847 * 848 * Do nothing if the frame is writable, allocate new buffers and copy the data 849 * if it is not. 850 * 851 * @return 0 on success, a negative AVERROR on error. 852 * 853 * @see av_frame_is_writable(), av_buffer_is_writable(), 854 * av_buffer_make_writable() 855 */ 856 int av_frame_make_writable(AVFrame *frame); 857 858 /** 859 * Copy the frame data from src to dst. 860 * 861 * This function does not allocate anything, dst must be already initialized and 862 * allocated with the same parameters as src. 863 * 864 * This function only copies the frame data (i.e. the contents of the data / 865 * extended data arrays), not any other properties. 866 * 867 * @return >= 0 on success, a negative AVERROR on error. 868 */ 869 int av_frame_copy(AVFrame *dst, const AVFrame *src); 870 871 /** 872 * Copy only "metadata" fields from src to dst. 873 * 874 * Metadata for the purpose of this function are those fields that do not affect 875 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample 876 * aspect ratio (for video), but not width/height or channel layout. 877 * Side data is also copied. 878 */ 879 int av_frame_copy_props(AVFrame *dst, const AVFrame *src); 880 881 /** 882 * Get the buffer reference a given data plane is stored in. 883 * 884 * @param plane index of the data plane of interest in frame->extended_data. 885 * 886 * @return the buffer reference that contains the plane or NULL if the input 887 * frame is not valid. 888 */ 889 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane); 890 891 /** 892 * Add a new side data to a frame. 893 * 894 * @param frame a frame to which the side data should be added 895 * @param type type of the added side data 896 * @param size size of the side data 897 * 898 * @return newly added side data on success, NULL on error 899 */ 900 AVFrameSideData *av_frame_new_side_data(AVFrame *frame, 901 enum AVFrameSideDataType type, 902 int size); 903 904 /** 905 * Add a new side data to a frame from an existing AVBufferRef 906 * 907 * @param frame a frame to which the side data should be added 908 * @param type the type of the added side data 909 * @param buf an AVBufferRef to add as side data. The ownership of 910 * the reference is transferred to the frame. 911 * 912 * @return newly added side data on success, NULL on error. On failure 913 * the frame is unchanged and the AVBufferRef remains owned by 914 * the caller. 915 */ 916 AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame, 917 enum AVFrameSideDataType type, 918 AVBufferRef *buf); 919 920 /** 921 * @return a pointer to the side data of a given type on success, NULL if there 922 * is no side data with such type in this frame. 923 */ 924 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame, 925 enum AVFrameSideDataType type); 926 927 /** 928 * Remove and free all side data instances of the given type. 929 */ 930 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type); 931 932 933 /** 934 * Flags for frame cropping. 935 */ 936 enum { 937 /** 938 * Apply the maximum possible cropping, even if it requires setting the 939 * AVFrame.data[] entries to unaligned pointers. Passing unaligned data 940 * to FFmpeg API is generally not allowed, and causes undefined behavior 941 * (such as crashes). You can pass unaligned data only to FFmpeg APIs that 942 * are explicitly documented to accept it. Use this flag only if you 943 * absolutely know what you are doing. 944 */ 945 AV_FRAME_CROP_UNALIGNED = 1 << 0, 946 }; 947 948 /** 949 * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ 950 * crop_bottom fields. If cropping is successful, the function will adjust the 951 * data pointers and the width/height fields, and set the crop fields to 0. 952 * 953 * In all cases, the cropping boundaries will be rounded to the inherent 954 * alignment of the pixel format. In some cases, such as for opaque hwaccel 955 * formats, the left/top cropping is ignored. The crop fields are set to 0 even 956 * if the cropping was rounded or ignored. 957 * 958 * @param frame the frame which should be cropped 959 * @param flags Some combination of AV_FRAME_CROP_* flags, or 0. 960 * 961 * @return >= 0 on success, a negative AVERROR on error. If the cropping fields 962 * were invalid, AVERROR(ERANGE) is returned, and nothing is changed. 963 */ 964 int av_frame_apply_cropping(AVFrame *frame, int flags); 965 966 /** 967 * @return a string identifying the side data type 968 */ 969 const char *av_frame_side_data_name(enum AVFrameSideDataType type); 970 971 /** 972 * @} 973 */ 974 975 #endif /* AVUTIL_FRAME_H */ 976