libavcodec/dirac.h

   1 /*
   2  * Copyright (C) 2007 Marco Gerards <marco@gnu.org>
   3  * Copyright (C) 2009 David Conrad
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * Libav is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef AVCODEC_DIRAC_H
  23 #define AVCODEC_DIRAC_H
  24
  25 /**
  26  * @file
  27  * Interface to Dirac Decoder/Encoder
  28  * @author Marco Gerards <marco@gnu.org>
  29  */
  30
  31 #include "avcodec.h"
  32
  33 typedef struct AVDiracSeqHeader {
  34     unsigned width;
  35     unsigned height;
  36     uint8_t chroma_format;          ///< 0: 444  1: 422  2: 420
  37
  38     uint8_t interlaced;
  39     uint8_t top_field_first;
  40
  41     uint8_t frame_rate_index;       ///< index into dirac_frame_rate[]
  42     uint8_t aspect_ratio_index;     ///< index into dirac_aspect_ratio[]
  43
  44     uint16_t clean_width;
  45     uint16_t clean_height;
  46     uint16_t clean_left_offset;
  47     uint16_t clean_right_offset;
  48
  49     uint8_t pixel_range_index;      ///< index into dirac_pixel_range_presets[]
  50     uint8_t color_spec_index;       ///< index into dirac_color_spec_presets[]
  51
  52     int profile;
  53     int level;
  54
  55     AVRational framerate;
  56     AVRational sample_aspect_ratio;
  57
  58     enum AVPixelFormat pix_fmt;
  59     enum AVColorRange color_range;
  60     enum AVColorPrimaries color_primaries;
  61     enum AVColorTransferCharacteristic color_trc;
  62     enum AVColorSpace colorspace;
  63 } AVDiracSeqHeader;
  64
  65 /**
  66  * Parse a Dirac sequence header.
  67  *
  68  * @param dsh this function will allocate and fill an AVDiracSeqHeader struct
  69  *            and write it into this pointer. The caller must free it with
  70  *            av_free().
  71  * @param buf the data buffer
  72  * @param buf_size the size of the data buffer in bytes
  73  * @param log_ctx if non-NULL, this function will log errors here
  74  * @return 0 on success, a negative AVERROR code on failure
  75  */
  76 int av_dirac_parse_sequence_header(AVDiracSeqHeader **dsh,
  77                                    const uint8_t *buf, size_t buf_size,
  78                                    void *log_ctx);
  79
  80 #endif /* AVCODEC_DIRAC_H */