Merge commit '045654f422e74be8ed09a0819d39051d67633a09'
authorMichael Niedermayer <michaelni@gmx.at>
Fri, 17 Jan 2014 14:05:17 +0000 (15:05 +0100)
committerMichael Niedermayer <michaelni@gmx.at>
Fri, 17 Jan 2014 14:05:24 +0000 (15:05 +0100)
* commit '045654f422e74be8ed09a0819d39051d67633a09':
  doxy: Document better the available AVFrame flags

Merged-by: Michael Niedermayer <michaelni@gmx.at>
1  2 
libavutil/frame.h

@@@ -422,104 -391,14 +429,107 @@@ typedef struct AVFrame 
   * The frame data may be corrupted, e.g. due to decoding errors.
   */
  #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
+ /**
+  * @}
+  */
  
      /**
-      * Frame flags, a combination of AV_FRAME_FLAG_*
+      * Frame flags, a combination of @ref lavu_frame_flags
       */
      int flags;
 +
 +    /**
 +     * frame timestamp estimated using various heuristics, in stream time base
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_best_effort_timestamp(frame)
 +     * - encoding: unused
 +     * - decoding: set by libavcodec, read by user.
 +     */
 +    int64_t best_effort_timestamp;
 +
 +    /**
 +     * reordered pos from the last AVPacket that has been input into the decoder
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_pkt_pos(frame)
 +     * - encoding: unused
 +     * - decoding: Read by user.
 +     */
 +    int64_t pkt_pos;
 +
 +    /**
 +     * duration of the corresponding packet, expressed in
 +     * AVStream->time_base units, 0 if unknown.
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_pkt_duration(frame)
 +     * - encoding: unused
 +     * - decoding: Read by user.
 +     */
 +    int64_t pkt_duration;
 +
 +    /**
 +     * metadata.
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_metadata(frame)
 +     * - encoding: Set by user.
 +     * - decoding: Set by libavcodec.
 +     */
 +    AVDictionary *metadata;
 +
 +    /**
 +     * decode error flags of the frame, set to a combination of
 +     * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
 +     * were errors during the decoding.
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_decode_error_flags(frame)
 +     * - encoding: unused
 +     * - decoding: set by libavcodec, read by user.
 +     */
 +    int decode_error_flags;
 +#define FF_DECODE_ERROR_INVALID_BITSTREAM   1
 +#define FF_DECODE_ERROR_MISSING_REFERENCE   2
 +
 +    /**
 +     * number of audio channels, only used for audio.
 +     * Code outside libavcodec should access this field using:
 +     * av_frame_get_channels(frame)
 +     * - encoding: unused
 +     * - decoding: Read by user.
 +     */
 +    int channels;
 +
 +    /**
 +     * size of the corresponding packet containing the compressed
 +     * frame. It must be accessed using av_frame_get_pkt_size() and
 +     * av_frame_set_pkt_size().
 +     * It is set to a negative value if unknown.
 +     * - encoding: unused
 +     * - decoding: set by libavcodec, read by user.
 +     */
 +    int pkt_size;
 +
 +    /**
 +     * YUV colorspace type.
 +     * It must be accessed using av_frame_get_colorspace() and
 +     * av_frame_set_colorspace().
 +     * - encoding: Set by user
 +     * - decoding: Set by libavcodec
 +     */
 +    enum AVColorSpace colorspace;
 +
 +    /**
 +     * MPEG vs JPEG YUV range.
 +     * It must be accessed using av_frame_get_color_range() and
 +     * av_frame_set_color_range().
 +     * - encoding: Set by user
 +     * - decoding: Set by libavcodec
 +     */
 +    enum AVColorRange color_range;
 +
 +
 +    /**
 +     * Not to be accessed directly from outside libavutil
 +     */
 +    AVBufferRef *qp_table_buf;
  } AVFrame;
  
  /**