git.sesse.net Git - ffmpeg/blob - libavcodec/fits.h

   1 /*
   2  * FITS image format common prototypes and structures
   3  * Copyright (c) 2017 Paras Chadha
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_FITS_H
  23 #define AVCODEC_FITS_H
  24
  25 typedef enum FITSHeaderState {
  26     STATE_SIMPLE,
  27     STATE_XTENSION,
  28     STATE_BITPIX,
  29     STATE_NAXIS,
  30     STATE_NAXIS_N,
  31     STATE_PCOUNT,
  32     STATE_GCOUNT,
  33     STATE_REST,
  34 } FITSHeaderState;
  35
  36 /**
  37  * Structure to store the header keywords in FITS file
  38  */
  39 typedef struct FITSHeader {
  40     FITSHeaderState state;
  41     unsigned naxis_index;
  42     int bitpix;
  43     int64_t blank;
  44     int blank_found;
  45     int naxis;
  46     int naxisn[999];
  47     int pcount;
  48     int gcount;
  49     int groups;
  50     int rgb; /**< 1 if file contains RGB image, 0 otherwise */
  51     int image_extension;
  52     double bscale;
  53     double bzero;
  54     int data_min_found;
  55     double data_min;
  56     int data_max_found;
  57     double data_max;
  58 } FITSHeader;
  59
  60
  61 /**
  62  * Initialize a single header line
  63  * @param header pointer to the header
  64  * @param state current state of parsing the header
  65  * @return 0 if successful otherwise AVERROR_INVALIDDATA
  66  */
  67 int avpriv_fits_header_init(FITSHeader *header, FITSHeaderState state);
  68
  69 /**
  70  * Parse a single header line
  71  * @param avcl used in av_log
  72  * @param header pointer to the header
  73  * @param line one header line
  74  * @param metadata used to store metadata while decoding
  75  * @return 0 if successful otherwise AVERROR_INVALIDDATA
  76  */
  77 int avpriv_fits_header_parse_line(void *avcl, FITSHeader *header, const uint8_t line[80], AVDictionary ***metadata);
  78
  79 #endif /* AVCODEC_FITS_H */