FFmpeg
fitsdec.c
Go to the documentation of this file.
1 /*
2  * FITS demuxer
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 /**
23  * @file
24  * FITS demuxer.
25  */
26 
27 #include "libavutil/avassert.h"
28 #include "libavutil/intreadwrite.h"
29 #include "internal.h"
30 #include "libavutil/opt.h"
31 #include "libavcodec/fits.h"
32 #include "libavutil/bprint.h"
33 
34 #define FITS_BLOCK_SIZE 2880
35 
36 typedef struct FITSContext {
37  const AVClass *class;
40 } FITSContext;
41 
42 static int fits_probe(const AVProbeData *p)
43 {
44  const uint8_t *b = p->buf;
45  if (!memcmp(b, "SIMPLE = T", 30))
46  return AVPROBE_SCORE_MAX - 1;
47  return 0;
48 }
49 
51 {
52  AVStream *st;
53  FITSContext * fits = s->priv_data;
54 
55  st = avformat_new_stream(s, NULL);
56  if (!st)
57  return AVERROR(ENOMEM);
58 
61 
62  avpriv_set_pts_info(st, 64, fits->framerate.den, fits->framerate.num);
63  fits->first_image = 1;
64  return 0;
65 }
66 
67 /**
68  * Parses header and checks that the current HDU contains image or not
69  * It also stores the header in the avbuf and stores the size of data part in data_size
70  * @param s pointer to AVFormat Context
71  * @param fits pointer to FITSContext
72  * @param header pointer to FITSHeader
73  * @param avbuf pointer to AVBPrint to store the header
74  * @param data_size to store the size of data part
75  * @return 1 if image found, 0 if any other extension and AVERROR_INVALIDDATA otherwise
76  */
78  AVBPrint *avbuf, uint64_t *data_size)
79 {
80  int i, ret, image = 0;
81  char buf[FITS_BLOCK_SIZE] = { 0 };
82  int64_t buf_size = 0, size = 0, t;
83 
84  do {
85  ret = avio_read(s->pb, buf, FITS_BLOCK_SIZE);
86  if (ret < 0) {
87  return ret;
88  } else if (ret < FITS_BLOCK_SIZE) {
89  return AVERROR_INVALIDDATA;
90  }
91 
93  ret = 0;
94  buf_size = 0;
95  while(!ret && buf_size < FITS_BLOCK_SIZE) {
96  ret = avpriv_fits_header_parse_line(s, header, buf + buf_size, NULL);
97  buf_size += 80;
98  }
99  } while (!ret);
100  if (ret < 0)
101  return ret;
102 
103  image = fits->first_image || header->image_extension;
104  fits->first_image = 0;
105 
106  if (header->groups) {
107  image = 0;
108  if (header->naxis > 1)
109  size = 1;
110  } else if (header->naxis) {
111  size = header->naxisn[0];
112  } else {
113  image = 0;
114  }
115 
116  for (i = 1; i < header->naxis; i++) {
117  if(size && header->naxisn[i] > UINT64_MAX / size)
118  return AVERROR_INVALIDDATA;
119  size *= header->naxisn[i];
120  }
121 
122  if(header->pcount > UINT64_MAX - size)
123  return AVERROR_INVALIDDATA;
124  size += header->pcount;
125 
126  t = (abs(header->bitpix) >> 3) * ((int64_t) header->gcount);
127  if(size && t > INT64_MAX / size)
128  return AVERROR_INVALIDDATA;
129  size *= t;
130 
131  if (!size) {
132  image = 0;
133  } else {
134  if(FITS_BLOCK_SIZE - 1 > INT64_MAX - size)
135  return AVERROR_INVALIDDATA;
137  }
138  *data_size = size;
139  return image;
140 }
141 
143 {
144  int64_t pos, ret;
145  uint64_t size;
146  FITSContext *fits = s->priv_data;
148  AVBPrint avbuf;
149  char *buf;
150 
151  if (fits->first_image) {
153  } else {
155  }
156 
158  while ((ret = is_image(s, fits, &header, &avbuf, &size)) == 0) {
159  av_bprint_finalize(&avbuf, NULL);
160  pos = avio_skip(s->pb, size);
161  if (pos < 0)
162  return pos;
163 
166  }
167  if (ret < 0)
168  goto fail;
169 
170  if (!av_bprint_is_complete(&avbuf)) {
171  ret = AVERROR(ENOMEM);
172  goto fail;
173  }
174 
175  av_assert0(avbuf.len <= INT64_MAX && size <= INT64_MAX);
176  if (avbuf.len + size > INT_MAX - 80) {
178  goto fail;
179  }
180  // Header is sent with the first line removed...
181  ret = av_new_packet(pkt, avbuf.len - 80 + size);
182  if (ret < 0)
183  goto fail;
184 
185  pkt->stream_index = 0;
187 
188  ret = av_bprint_finalize(&avbuf, &buf);
189  if (ret < 0) {
190  return ret;
191  }
192 
193  memcpy(pkt->data, buf + 80, avbuf.len - 80);
194  pkt->size = avbuf.len - 80;
195  av_freep(&buf);
196  ret = avio_read(s->pb, pkt->data + pkt->size, size);
197  if (ret < 0)
198  return ret;
199 
200  pkt->size += ret;
201  pkt->duration = 1;
202 
203  return 0;
204 
205 fail:
206  av_bprint_finalize(&avbuf, NULL);
207  return ret;
208 }
209 
210 static const AVOption fits_options[] = {
211  { "framerate", "set the framerate", offsetof(FITSContext, framerate), AV_OPT_TYPE_VIDEO_RATE, {.str = "1"}, 0, INT_MAX, AV_OPT_FLAG_DECODING_PARAM},
212  { NULL },
213 };
214 
215 static const AVClass fits_demuxer_class = {
216  .class_name = "FITS demuxer",
217  .item_name = av_default_item_name,
218  .option = fits_options,
219  .version = LIBAVUTIL_VERSION_INT,
220  .category = AV_CLASS_CATEGORY_DEMUXER,
221 };
222 
224  .name = "fits",
225  .long_name = NULL_IF_CONFIG_SMALL("Flexible Image Transport System"),
226  .priv_data_size = sizeof(FITSContext),
230  .priv_class = &fits_demuxer_class,
232 };
AV_BPRINT_SIZE_UNLIMITED
#define AV_BPRINT_SIZE_UNLIMITED
fits_demuxer_class
static const AVClass fits_demuxer_class
Definition: fitsdec.c:215
av_bprint_is_complete
static int av_bprint_is_complete(const AVBPrint *buf)
Test if the print buffer is complete (not truncated).
Definition: bprint.h:218
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:51
av_bprint_init
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AV_OPT_TYPE_VIDEO_RATE
@ AV_OPT_TYPE_VIDEO_RATE
offset must point to AVRational
Definition: opt.h:238
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:480
FITSContext
Definition: fitsdec.c:43
AVPacket::data
uint8_t * data
Definition: packet.h:491
AVOption
AVOption.
Definition: opt.h:251
b
#define b
Definition: input.c:41
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:509
FITSContext::framerate
AVRational framerate
Definition: fitsdec.c:38
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:546
STATE_XTENSION
@ STATE_XTENSION
Definition: fits.h:31
fits.h
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:464
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:761
fits_options
static const AVOption fits_options[]
Definition: fitsdec.c:210
fail
#define fail()
Definition: checkasm.h:142
avpriv_fits_header_parse_line
int avpriv_fits_header_parse_line(void *avcl, FITSHeader *header, const uint8_t line[80], AVDictionary ***metadata)
Parse a single header line.
Definition: fits.c:113
fits_probe
static int fits_probe(const AVProbeData *p)
Definition: fitsdec.c:42
AVRational::num
int num
Numerator.
Definition: rational.h:59
ff_fits_demuxer
const AVInputFormat ff_fits_demuxer
Definition: fitsdec.c:223
avassert.h
pkt
AVPacket * pkt
Definition: movenc.c:59
AVInputFormat
Definition: avformat.h:549
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:41
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:98
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:554
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:454
is_image
static int64_t is_image(AVFormatContext *s, FITSContext *fits, FITSHeader *header, AVBPrint *avbuf, uint64_t *data_size)
Parses header and checks that the current HDU contains image or not It also stores the header in the ...
Definition: fitsdec.c:77
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
AV_CLASS_CATEGORY_DEMUXER
@ AV_CLASS_CATEGORY_DEMUXER
Definition: log.h:33
AVFormatContext
Format I/O context.
Definition: avformat.h:1115
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:864
framerate
float framerate
Definition: av1_levels.c:29
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:550
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AV_CODEC_ID_FITS
@ AV_CODEC_ID_FITS
Definition: codec_id.h:289
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:452
abs
#define abs(x)
Definition: cuda_runtime.h:35
fits_read_packet
static int fits_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: fitsdec.c:142
AVPacket::size
int size
Definition: packet.h:492
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:106
av_bprint_finalize
int av_bprint_finalize(AVBPrint *buf, char **ret_str)
Finalize a print buffer.
Definition: bprint.c:240
size
int size
Definition: twinvq_data.h:10344
fits_read_header
static int fits_read_header(AVFormatContext *s)
Definition: fitsdec.c:50
header
static const uint8_t header[24]
Definition: sdr2.c:67
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:497
avpriv_fits_header_init
int avpriv_fits_header_init(FITSHeader *header, FITSHeaderState state)
Initialize a single header line.
Definition: fits.c:31
bprint.h
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:245
STATE_SIMPLE
@ STATE_SIMPLE
Definition: fits.h:30
AV_OPT_FLAG_DECODING_PARAM
#define AV_OPT_FLAG_DECODING_PARAM
a generic parameter which can be set by the user for demuxing or decoding
Definition: opt.h:282
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:841
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
pos
unsigned int pos
Definition: spdifenc.c:413
FITSContext::first_image
int first_image
Definition: fitsdec.c:39
AVRational::den
int den
Denominator.
Definition: rational.h:60
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:659
FITSHeader
Structure to store the header keywords in FITS file.
Definition: fits.h:43
AVPacket::stream_index
int stream_index
Definition: packet.h:493
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:365
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:29
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
AVPacket
This structure stores compressed data.
Definition: packet.h:468
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
FITS_BLOCK_SIZE
#define FITS_BLOCK_SIZE
Definition: fitsdec.c:34
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
av_bprint_append_data
void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size)
Append data to a print buffer.
Definition: bprint.c:163