FFmpeg
hnm.c
Go to the documentation of this file.
1 /*
2  * Cryo Interactive Entertainment HNM4 demuxer
3  *
4  * Copyright (c) 2012 David Kment
5  *
6  * This file is part of FFmpeg .
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg ; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include <inttypes.h>
24 
25 #include "libavutil/intreadwrite.h"
26 #include "avformat.h"
27 #include "internal.h"
28 
29 #define HNM4_TAG MKTAG('H', 'N', 'M', '4')
30 
31 #define HNM4_SAMPLE_RATE 22050
32 #define HNM4_FRAME_FPS 24
33 
34 #define HNM4_CHUNK_ID_PL 19536
35 #define HNM4_CHUNK_ID_IZ 23113
36 #define HNM4_CHUNK_ID_IU 21833
37 #define HNM4_CHUNK_ID_SD 17491
38 
39 typedef struct Hnm4DemuxContext {
41  uint16_t width;
42  uint16_t height;
43  uint32_t filesize;
44  uint32_t frames;
45  uint32_t taboffset;
46  uint16_t bits;
47  uint16_t channels;
48  uint32_t framesize;
49  uint32_t currentframe;
50  int64_t pts;
54 
55 static int hnm_probe(const AVProbeData *p)
56 {
57  if (p->buf_size < 4)
58  return 0;
59 
60  // check for HNM4 header.
61  // currently only HNM v4/v4A is supported
62  if (AV_RL32(&p->buf[0]) == HNM4_TAG)
63  return AVPROBE_SCORE_MAX;
64 
65  return 0;
66 }
67 
69 {
70  Hnm4DemuxContext *hnm = s->priv_data;
71  AVIOContext *pb = s->pb;
72  AVStream *vst;
73  int ret;
74 
75  /* default context members */
76  hnm->pts = 0;
77  av_init_packet(&hnm->vpkt);
78  hnm->vpkt.data = NULL;
79  hnm->vpkt.size = 0;
80 
81  hnm->superchunk_remaining = 0;
82 
83  avio_skip(pb, 8);
84  hnm->width = avio_rl16(pb);
85  hnm->height = avio_rl16(pb);
86  hnm->filesize = avio_rl32(pb);
87  hnm->frames = avio_rl32(pb);
88  hnm->taboffset = avio_rl32(pb);
89  hnm->bits = avio_rl16(pb);
90  hnm->channels = avio_rl16(pb);
91  hnm->framesize = avio_rl32(pb);
92  avio_skip(pb, 32);
93 
94  hnm->currentframe = 0;
95 
96  if (hnm->width < 256 || hnm->width > 640 ||
97  hnm->height < 150 || hnm->height > 480) {
99  "invalid resolution: %ux%u\n", hnm->width, hnm->height);
100  return AVERROR_INVALIDDATA;
101  }
102 
103  // TODO: find a better way to detect HNM4A
104  if (hnm->width == 640)
105  hnm->version = 0x4a;
106  else
107  hnm->version = 0x40;
108 
109  if (!(vst = avformat_new_stream(s, NULL)))
110  return AVERROR(ENOMEM);
111 
114  vst->codecpar->codec_tag = 0;
115  vst->codecpar->width = hnm->width;
116  vst->codecpar->height = hnm->height;
117  if ((ret = ff_alloc_extradata(vst->codecpar, 1)) < 0)
118  return ret;
119 
120  vst->codecpar->extradata[0] = hnm->version;
121 
122  vst->start_time = 0;
123 
124  avpriv_set_pts_info(vst, 33, 1, HNM4_FRAME_FPS);
125 
126  return 0;
127 }
128 
130 {
131  Hnm4DemuxContext *hnm = s->priv_data;
132  AVIOContext *pb = s->pb;
133  int ret = 0;
134 
135  uint32_t superchunk_size, chunk_size;
136  uint16_t chunk_id;
137 
138  if (hnm->currentframe == hnm->frames || pb->eof_reached)
139  return AVERROR_EOF;
140 
141  if (hnm->superchunk_remaining == 0) {
142  /* parse next superchunk */
143  superchunk_size = avio_rl24(pb);
144  avio_skip(pb, 1);
145 
146  hnm->superchunk_remaining = superchunk_size - 4;
147  }
148 
149  chunk_size = avio_rl24(pb);
150  avio_skip(pb, 1);
151  chunk_id = avio_rl16(pb);
152  avio_skip(pb, 2);
153 
154  if (chunk_size > hnm->superchunk_remaining || !chunk_size) {
155  av_log(s, AV_LOG_ERROR,
156  "invalid chunk size: %"PRIu32", offset: %"PRId64"\n",
157  chunk_size, avio_tell(pb));
158  avio_skip(pb, hnm->superchunk_remaining - 8);
159  hnm->superchunk_remaining = 0;
160  }
161 
162  switch (chunk_id) {
163  case HNM4_CHUNK_ID_PL:
164  case HNM4_CHUNK_ID_IZ:
165  case HNM4_CHUNK_ID_IU:
166  avio_seek(pb, -8, SEEK_CUR);
167  ret += av_get_packet(pb, pkt, chunk_size);
168  hnm->superchunk_remaining -= chunk_size;
169  if (chunk_id == HNM4_CHUNK_ID_IZ || chunk_id == HNM4_CHUNK_ID_IU)
170  hnm->currentframe++;
171  break;
172 
173  case HNM4_CHUNK_ID_SD:
174  avio_skip(pb, chunk_size - 8);
175  hnm->superchunk_remaining -= chunk_size;
176  break;
177 
178  default:
179  av_log(s, AV_LOG_WARNING, "unknown chunk found: %"PRIu16", offset: %"PRId64"\n",
180  chunk_id, avio_tell(pb));
181  avio_skip(pb, chunk_size - 8);
182  hnm->superchunk_remaining -= chunk_size;
183  break;
184  }
185 
186  return ret;
187 }
188 
190 {
191  Hnm4DemuxContext *hnm = s->priv_data;
192 
193  if (hnm->vpkt.size > 0)
194  av_packet_unref(&hnm->vpkt);
195 
196  return 0;
197 }
198 
200  .name = "hnm",
201  .long_name = NULL_IF_CONFIG_SMALL("Cryo HNM v4"),
202  .priv_data_size = sizeof(Hnm4DemuxContext),
208 };
#define NULL
Definition: coverity.c:32
#define AVFMT_NOBINSEARCH
Format does not allow to fall back on binary search via read_timestamp.
Definition: avformat.h:468
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
uint8_t version
Definition: hnm.c:40
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4943
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:4036
static int hnm_probe(const AVProbeData *p)
Definition: hnm.c:55
int size
Definition: avcodec.h:1534
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
static AVPacket pkt
#define HNM4_TAG
Definition: hnm.c:29
AVPacket vpkt
Definition: hnm.c:52
int64_t pts
Definition: hnm.c:50
uint16_t bits
Definition: hnm.c:46
Format I/O context.
Definition: avformat.h:1353
uint32_t frames
Definition: hnm.c:44
uint16_t channels
Definition: hnm.c:47
uint8_t
int width
Video only.
Definition: avcodec.h:4102
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4524
static int hnm_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: hnm.c:129
uint8_t * data
Definition: avcodec.h:1533
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define HNM4_CHUNK_ID_IZ
Definition: hnm.c:35
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:308
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
#define av_log(a,...)
#define HNM4_FRAME_FPS
Definition: hnm.c:32
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:767
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:4032
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:444
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0...
Definition: utils.c:3323
uint32_t superchunk_remaining
Definition: hnm.c:51
uint32_t taboffset
Definition: hnm.c:45
AVInputFormat ff_hnm_demuxer
Definition: hnm.c:199
#define s(width, name)
Definition: cbs_vp9.c:257
static int hnm_read_header(AVFormatContext *s)
Definition: hnm.c:68
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
static int hnm_read_close(AVFormatContext *s)
Definition: hnm.c:189
uint32_t framesize
Definition: hnm.c:48
AVIOContext * pb
I/O context.
Definition: avformat.h:1395
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:600
#define AVFMT_NOGENSEARCH
Format does not allow to fall back on generic search.
Definition: avformat.h:469
#define HNM4_CHUNK_ID_PL
Definition: hnm.c:34
uint16_t height
Definition: hnm.c:42
#define HNM4_CHUNK_ID_IU
Definition: hnm.c:36
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
uint16_t width
Definition: hnm.c:41
uint32_t filesize
Definition: hnm.c:43
#define flags(name, subs,...)
Definition: cbs_av1.c:564
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
uint32_t currentframe
Definition: hnm.c:49
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:751
Main libavformat public API header.
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base...
Definition: avformat.h:915
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:33
#define AVFMT_NO_BYTE_SEEK
Format does not allow seeking by bytes.
Definition: avformat.h:470
int eof_reached
true if was unable to read due to error or eof
Definition: avio.h:239
void * priv_data
Format private data.
Definition: avformat.h:1381
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:4050
#define HNM4_CHUNK_ID_SD
Definition: hnm.c:37
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:4040
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:759
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
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1510