FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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(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 
74  /* default context members */
75  hnm->pts = 0;
76  av_init_packet(&hnm->vpkt);
77  hnm->vpkt.data = NULL;
78  hnm->vpkt.size = 0;
79 
80  hnm->superchunk_remaining = 0;
81 
82  avio_skip(pb, 8);
83  hnm->width = avio_rl16(pb);
84  hnm->height = avio_rl16(pb);
85  hnm->filesize = avio_rl32(pb);
86  hnm->frames = avio_rl32(pb);
87  hnm->taboffset = avio_rl32(pb);
88  hnm->bits = avio_rl16(pb);
89  hnm->channels = avio_rl16(pb);
90  hnm->framesize = avio_rl32(pb);
91  avio_skip(pb, 32);
92 
93  hnm->currentframe = 0;
94 
95  if (hnm->width < 256 || hnm->width > 640 ||
96  hnm->height < 150 || hnm->height > 480) {
98  "invalid resolution: %ux%u\n", hnm->width, hnm->height);
99  return AVERROR_INVALIDDATA;
100  }
101 
102  // TODO: find a better way to detect HNM4A
103  if (hnm->width == 640)
104  hnm->version = 0x4a;
105  else
106  hnm->version = 0x40;
107 
108  if (!(vst = avformat_new_stream(s, NULL)))
109  return AVERROR(ENOMEM);
110 
113  vst->codec->codec_tag = 0;
114  vst->codec->width = hnm->width;
115  vst->codec->height = hnm->height;
116  vst->codec->extradata = av_mallocz(1);
117 
118  vst->codec->extradata_size = 1;
119  memcpy(vst->codec->extradata, &hnm->version, 1);
120 
121  vst->start_time = 0;
122 
123  avpriv_set_pts_info(vst, 33, 1, HNM4_FRAME_FPS);
124 
125  return 0;
126 }
127 
129 {
130  Hnm4DemuxContext *hnm = s->priv_data;
131  AVIOContext *pb = s->pb;
132  int ret = 0;
133 
134  uint32_t superchunk_size, chunk_size;
135  uint16_t chunk_id;
136 
137  if (hnm->currentframe == hnm->frames || pb->eof_reached)
138  return AVERROR_EOF;
139 
140  if (hnm->superchunk_remaining == 0) {
141  /* parse next superchunk */
142  superchunk_size = avio_rl24(pb);
143  avio_skip(pb, 1);
144 
145  hnm->superchunk_remaining = superchunk_size - 4;
146  }
147 
148  chunk_size = avio_rl24(pb);
149  avio_skip(pb, 1);
150  chunk_id = avio_rl16(pb);
151  avio_skip(pb, 2);
152 
153  if (chunk_size > hnm->superchunk_remaining || !chunk_size) {
154  av_log(s, AV_LOG_ERROR,
155  "invalid chunk size: %"PRIu32", offset: %"PRId64"\n",
156  chunk_size, avio_tell(pb));
157  avio_skip(pb, hnm->superchunk_remaining - 8);
158  hnm->superchunk_remaining = 0;
159  }
160 
161  switch (chunk_id) {
162  case HNM4_CHUNK_ID_PL:
163  case HNM4_CHUNK_ID_IZ:
164  case HNM4_CHUNK_ID_IU:
165  avio_seek(pb, -8, SEEK_CUR);
166  ret += av_get_packet(pb, pkt, chunk_size);
167  hnm->superchunk_remaining -= chunk_size;
168  if (chunk_id == HNM4_CHUNK_ID_IZ || chunk_id == HNM4_CHUNK_ID_IU)
169  hnm->currentframe++;
170  break;
171 
172  case HNM4_CHUNK_ID_SD:
173  avio_skip(pb, chunk_size - 8);
174  hnm->superchunk_remaining -= chunk_size;
175  break;
176 
177  default:
178  av_log(s, AV_LOG_WARNING, "unknown chunk found: %"PRIu16", offset: %"PRId64"\n",
179  chunk_id, avio_tell(pb));
180  avio_skip(pb, chunk_size - 8);
181  hnm->superchunk_remaining -= chunk_size;
182  break;
183  }
184 
185  return ret;
186 }
187 
189 {
190  Hnm4DemuxContext *hnm = s->priv_data;
191 
192  if (hnm->vpkt.size > 0)
193  av_free_packet(&hnm->vpkt);
194 
195  return 0;
196 }
197 
199  .name = "hnm",
200  .long_name = NULL_IF_CONFIG_SMALL("Cryo HNM v4"),
201  .priv_data_size = sizeof(Hnm4DemuxContext),
207 };
#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:478
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:111
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:280
uint8_t version
Definition: hnm.c:40
static int hnm_probe(AVProbeData *p)
Definition: hnm.c:55
#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:4083
int size
Definition: avcodec.h:1424
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:204
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:277
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:1273
uint32_t frames
Definition: hnm.c:44
uint16_t channels
Definition: hnm.c:47
uint8_t
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1617
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:3749
static int hnm_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: hnm.c:128
uint8_t * data
Definition: avcodec.h:1423
#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:244
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:390
#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:659
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:175
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:861
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:451
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
uint32_t superchunk_remaining
Definition: hnm.c:51
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
int width
picture width / height.
Definition: avcodec.h:1681
uint32_t taboffset
Definition: hnm.c:45
AVInputFormat ff_hnm_demuxer
Definition: hnm.c:198
static int hnm_read_header(AVFormatContext *s)
Definition: hnm.c:68
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:623
Stream structure.
Definition: avformat.h:842
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:188
enum AVMediaType codec_type
Definition: avcodec.h:1510
enum AVCodecID codec_id
Definition: avcodec.h:1519
uint32_t framesize
Definition: hnm.c:48
AVIOContext * pb
I/O context.
Definition: avformat.h:1315
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition: avcodec.h:1534
#define AVFMT_NOGENSEARCH
Format does not allow to fall back on generic search.
Definition: avformat.h:479
#define HNM4_CHUNK_ID_PL
Definition: hnm.c:34
int extradata_size
Definition: avcodec.h:1618
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:448
uint16_t width
Definition: hnm.c:41
uint32_t filesize
Definition: hnm.c:43
static int flags
Definition: cpu.c:47
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
uint32_t currentframe
Definition: hnm.c:49
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:643
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:894
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
Definition: avpacket.c:49
#define AVFMT_NO_BYTE_SEEK
Format does not allow seeking by bytes.
Definition: avformat.h:480
int eof_reached
true if eof reached
Definition: avio.h:139
void * priv_data
Format private data.
Definition: avformat.h:1301
#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:628
unsigned int avio_rl24(AVIOContext *s)
Definition: aviobuf.c:651
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1400
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:252