/*
  * Mpeg video formats-related defines and utility functions
  *

  * This file is part of FFmpeg.

  *

  * FFmpeg is free software; you can redistribute it and/or

  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *

  * FFmpeg is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public

  * License along with FFmpeg; if not, write to the Free Software

  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVCODEC_MPEGUTILS_H
 #define AVCODEC_MPEGUTILS_H
 

 #include <stdint.h>
 
 #include "libavutil/frame.h"
 
 #include "avcodec.h"

 #include "version.h"
 

 /**
  * Return value for header parsers if frame is not coded.
  * */
 #define FRAME_SKIPPED 100

 /* picture type */
 #define PICT_TOP_FIELD     1
 #define PICT_BOTTOM_FIELD  2
 #define PICT_FRAME         3
 
 /**
  * Value of Picture.reference when Picture is not a reference picture, but
  * is held for delayed output.
  */
 #define DELAYED_PIC_REF 4
 

 #define MAX_MB_BYTES    (30 * 16 * 16 * 3 / 8 + 120)
 #define MAX_FCODE        7

 
 /* MB types */
 #if !FF_API_MB_TYPE
 #define MB_TYPE_INTRA4x4   (1 <<  0)
 #define MB_TYPE_INTRA16x16 (1 <<  1) // FIXME H.264-specific
 #define MB_TYPE_INTRA_PCM  (1 <<  2) // FIXME H.264-specific
 #define MB_TYPE_16x16      (1 <<  3)
 #define MB_TYPE_16x8       (1 <<  4)
 #define MB_TYPE_8x16       (1 <<  5)
 #define MB_TYPE_8x8        (1 <<  6)
 #define MB_TYPE_INTERLACED (1 <<  7)
 #define MB_TYPE_DIRECT2    (1 <<  8) // FIXME
 #define MB_TYPE_ACPRED     (1 <<  9)
 #define MB_TYPE_GMC        (1 << 10)
 #define MB_TYPE_SKIP       (1 << 11)
 #define MB_TYPE_P0L0       (1 << 12)
 #define MB_TYPE_P1L0       (1 << 13)
 #define MB_TYPE_P0L1       (1 << 14)
 #define MB_TYPE_P1L1       (1 << 15)
 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 #define MB_TYPE_QUANT      (1 << 16)
 #define MB_TYPE_CBP        (1 << 17)
 #endif
 
 #define MB_TYPE_INTRA    MB_TYPE_INTRA4x4 // default mb_type if there is just one type
 
 #define IS_INTRA4x4(a)   ((a) & MB_TYPE_INTRA4x4)
 #define IS_INTRA16x16(a) ((a) & MB_TYPE_INTRA16x16)
 #define IS_PCM(a)        ((a) & MB_TYPE_INTRA_PCM)
 #define IS_INTRA(a)      ((a) & 7)
 #define IS_INTER(a)      ((a) & (MB_TYPE_16x16 | MB_TYPE_16x8 | \
                                  MB_TYPE_8x16  | MB_TYPE_8x8))
 #define IS_SKIP(a)       ((a) & MB_TYPE_SKIP)
 #define IS_INTRA_PCM(a)  ((a) & MB_TYPE_INTRA_PCM)
 #define IS_INTERLACED(a) ((a) & MB_TYPE_INTERLACED)
 #define IS_DIRECT(a)     ((a) & MB_TYPE_DIRECT2)
 #define IS_GMC(a)        ((a) & MB_TYPE_GMC)
 #define IS_16X16(a)      ((a) & MB_TYPE_16x16)
 #define IS_16X8(a)       ((a) & MB_TYPE_16x8)
 #define IS_8X16(a)       ((a) & MB_TYPE_8x16)
 #define IS_8X8(a)        ((a) & MB_TYPE_8x8)
 #define IS_SUB_8X8(a)    ((a) & MB_TYPE_16x16) // note reused
 #define IS_SUB_8X4(a)    ((a) & MB_TYPE_16x8)  // note reused
 #define IS_SUB_4X8(a)    ((a) & MB_TYPE_8x16)  // note reused
 #define IS_SUB_4X4(a)    ((a) & MB_TYPE_8x8)   // note reused
 #define IS_ACPRED(a)     ((a) & MB_TYPE_ACPRED)
 #define IS_QUANT(a)      ((a) & MB_TYPE_QUANT)
 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0 << ((part) + 2 * (list))))
 
 // does this mb use listX, note does not work if subMBs
 #define USES_LIST(a, list) ((a) & ((MB_TYPE_P0L0 | MB_TYPE_P1L0) << (2 * (list))))
 
 #define HAS_CBP(a)       ((a) & MB_TYPE_CBP)
 
 /* MB types for encoding */
 #define CANDIDATE_MB_TYPE_INTRA      (1 <<  0)
 #define CANDIDATE_MB_TYPE_INTER      (1 <<  1)
 #define CANDIDATE_MB_TYPE_INTER4V    (1 <<  2)
 #define CANDIDATE_MB_TYPE_SKIPPED    (1 <<  3)
 
 #define CANDIDATE_MB_TYPE_DIRECT     (1 <<  4)
 #define CANDIDATE_MB_TYPE_FORWARD    (1 <<  5)
 #define CANDIDATE_MB_TYPE_BACKWARD   (1 <<  6)
 #define CANDIDATE_MB_TYPE_BIDIR      (1 <<  7)
 
 #define CANDIDATE_MB_TYPE_INTER_I    (1 <<  8)
 #define CANDIDATE_MB_TYPE_FORWARD_I  (1 <<  9)
 #define CANDIDATE_MB_TYPE_BACKWARD_I (1 << 10)
 #define CANDIDATE_MB_TYPE_BIDIR_I    (1 << 11)
 
 #define CANDIDATE_MB_TYPE_DIRECT0    (1 << 12)
 

 #define INPLACE_OFFSET 16

 enum OutputFormat {
     FMT_MPEG1,
     FMT_H261,
     FMT_H263,
     FMT_MJPEG,
 };
 
 

 /**
  * Draw a horizontal band if supported.
  *
  * @param h is the normal height, this will be reduced automatically if needed
  */
 void ff_draw_horiz_band(AVCodecContext *avctx, AVFrame *cur, AVFrame *last,
                         int y, int h, int picture_structure, int first_field,
                         int low_delay);
 

 #endif /* AVCODEC_MPEGUTILS_H */