pixdesc.h 4.69 KB
Newer Older
1
/*
2
 * pixel format descriptor
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * Copyright (c) 2009 Michael Niedermayer <michaelni@gmx.at>
 *
 * 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
 */

#include <inttypes.h>

#include "libavutil/intreadwrite.h"

typedef struct AVComponentDescriptor{
    uint16_t plane        :2;            ///< which of the 4 planes contains the component
28 29 30 31 32 33 34 35 36 37 38 39

    /**
     * Number of elements between 2 horizontally consecutive pixels minus 1.
     * Elements are bits for bitstream formats, bytes otherwise.
     */
    uint16_t step_minus1  :3;

    /**
     * Number of elements before the component of the first pixel plus 1.
     * Elements are bits for bitstream formats, bytes otherwise.
     */
    uint16_t offset_plus1 :3;
40
    uint16_t shift        :3;            ///< number of least significant bits that must be shifted away to get the value
41 42 43
    uint16_t depth_minus1 :4;            ///< number of bits in the component minus 1
}AVComponentDescriptor;

Michael Niedermayer's avatar
Michael Niedermayer committed
44
/**
45
 * Descriptor that unambiguously describes how the bits of a pixel are
Michael Niedermayer's avatar
Michael Niedermayer committed
46 47 48
 * stored in the up to 4 data planes of an image. It also stores the
 * subsampling factors and number of components.
 *
49 50 51
 * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
 *       and all the YUV variants) AVPixFmtDescriptor just stores how values
 *       are stored not what these values represent.
Michael Niedermayer's avatar
Michael Niedermayer committed
52
 */
53
typedef struct AVPixFmtDescriptor{
54
    const char *name;
55 56 57
    uint8_t nb_channels;        ///< The number of components each pixel has, (1-4)

    /**
58 59 60 61
     * Amount to shift the luma width right to find the chroma width.
     * For YV12 this is 1 for example.
     * chroma_width = -((-luma_width) >> log2_chroma_w)
     * The note above is needed to ensure rounding up.
62 63 64 65
     */
    uint8_t log2_chroma_w;      ///< chroma_width = -((-luma_width )>>log2_chroma_w)

    /**
66 67 68 69
     * Amount to shift the luma height right to find the chroma height.
     * For YV12 this is 1 for example.
     * chroma_height= -((-luma_height) >> log2_chroma_h)
     * The note above is needed to ensure rounding up.
70 71 72
     */
    uint8_t log2_chroma_h;
    uint8_t flags;
73
    AVComponentDescriptor comp[4]; ///< parameters that describe how pixels are packed
74 75
}AVPixFmtDescriptor;

76
#define PIX_FMT_BE        1 ///< big-endian
Stefano Sabatini's avatar
Stefano Sabatini committed
77
#define PIX_FMT_PAL       2 ///< Pixel format has a palette in data[1], values are indexes in this palette.
78
#define PIX_FMT_BITSTREAM 4 ///< All values of a component are bit-wise packed end to end.
79

80 81 82 83
/**
 * The array of all the pixel format descriptors.
 */
extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
84

Stefano Sabatini's avatar
Stefano Sabatini committed
85 86 87 88 89 90 91 92 93 94 95 96
/**
 * Reads a line from an image, and writes to \p dst the values of the
 * pixel format component \p c.
 *
 * @param data the array containing the pointers to the planes of the image
 * @param linesizes the array containing the linesizes of the image
 * @param desc the pixel format descriptor for the image
 * @param x the horizontal coordinate of the first pixel to read
 * @param y the vertical coordinate of the first pixel to read
 * @param w the width of the line to read, that is the number of
 * values to write to \p dst
 */
97
static inline void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w)
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
{
    AVComponentDescriptor comp= desc->comp[c];
    int plane= comp.plane;
    int depth= comp.depth_minus1+1;
    int mask = (1<<depth)-1;
    int shift= comp.shift;
    int step = comp.step_minus1+1;
    int flags= desc->flags;
    const uint8_t *p= data[plane]+y*linesize[plane] + x * step + comp.offset_plus1 - 1;

    //FIXME initial x in case of PIX_FMT_BITSTREAM is wrong

    while(w--){
        int val;
        if(flags & PIX_FMT_BE) val= AV_RB16(p);
        else                   val= AV_RL16(p);
        val = (val>>shift) & mask;
        if(flags & PIX_FMT_PAL)
            val= data[1][4*val + c];
        if(flags & PIX_FMT_BITSTREAM){
            shift-=depth;
            while(shift<0){
                shift+=8;
                p++;
            }
        }else
            p+= step;
        *dst++= val;
    }
}