yop.c
Go to the documentation of this file.
1 /*
2  * Psygnosis YOP demuxer
3  *
4  * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11@gmail.com>
5  * derived from the code by
6  * Copyright (C) 2009 Thomas P. Higdon <thomas.p.higdon@gmail.com>
7  *
8  * This file is part of Libav.
9  *
10  * Libav is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * Libav is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with Libav; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 
25 #include "libavutil/intreadwrite.h"
26 #include "avformat.h"
27 #include "internal.h"
28 
29 typedef struct yop_dec_context {
31 
32  int odd_frame;
37 
38 static int yop_probe(AVProbeData *probe_packet)
39 {
40  if (AV_RB16(probe_packet->buf) == AV_RB16("YO") &&
41  probe_packet->buf[6] &&
42  probe_packet->buf[7] &&
43  !(probe_packet->buf[8] & 1) &&
44  !(probe_packet->buf[10] & 1))
45  return AVPROBE_SCORE_MAX * 3 / 4;
46 
47  return 0;
48 }
49 
51 {
52  YopDecContext *yop = s->priv_data;
53  AVIOContext *pb = s->pb;
54 
55  AVCodecContext *audio_dec, *video_dec;
56  AVStream *audio_stream, *video_stream;
57 
58  int frame_rate, ret;
59 
60  audio_stream = avformat_new_stream(s, NULL);
61  video_stream = avformat_new_stream(s, NULL);
62 
63  // Extra data that will be passed to the decoder
64  video_stream->codec->extradata_size = 8;
65 
66  video_stream->codec->extradata = av_mallocz(video_stream->codec->extradata_size +
68 
69  if (!video_stream->codec->extradata)
70  return AVERROR(ENOMEM);
71 
72  // Audio
73  audio_dec = audio_stream->codec;
74  audio_dec->codec_type = AVMEDIA_TYPE_AUDIO;
75  audio_dec->codec_id = CODEC_ID_ADPCM_IMA_WS;
76  audio_dec->channels = 1;
77  audio_dec->sample_rate = 22050;
78 
79  // Video
80  video_dec = video_stream->codec;
81  video_dec->codec_type = AVMEDIA_TYPE_VIDEO;
82  video_dec->codec_id = CODEC_ID_YOP;
83 
84  avio_skip(pb, 6);
85 
86  frame_rate = avio_r8(pb);
87  yop->frame_size = avio_r8(pb) * 2048;
88  video_dec->width = avio_rl16(pb);
89  video_dec->height = avio_rl16(pb);
90 
91  video_stream->sample_aspect_ratio = (AVRational){1, 2};
92 
93  ret = avio_read(pb, video_dec->extradata, 8);
94  if (ret < 8)
95  return ret < 0 ? ret : AVERROR_EOF;
96 
97  yop->palette_size = video_dec->extradata[0] * 3 + 4;
98  yop->audio_block_length = AV_RL16(video_dec->extradata + 6);
99 
100  // 1840 samples per frame, 1 nibble per sample; hence 1840/2 = 920
101  if (yop->audio_block_length < 920 ||
102  yop->audio_block_length + yop->palette_size >= yop->frame_size) {
103  av_log(s, AV_LOG_ERROR, "YOP has invalid header\n");
104  return AVERROR_INVALIDDATA;
105  }
106 
107  avio_seek(pb, 2048, SEEK_SET);
108 
109  avpriv_set_pts_info(video_stream, 32, 1, frame_rate);
110 
111  return 0;
112 }
113 
115 {
116  YopDecContext *yop = s->priv_data;
117  AVIOContext *pb = s->pb;
118 
119  int ret;
120  int actual_video_data_size = yop->frame_size -
121  yop->audio_block_length - yop->palette_size;
122 
123  yop->video_packet.stream_index = 1;
124 
125  if (yop->video_packet.data) {
126  *pkt = yop->video_packet;
127  yop->video_packet.data = NULL;
128  yop->video_packet.size = 0;
129  pkt->data[0] = yop->odd_frame;
130  pkt->flags |= AV_PKT_FLAG_KEY;
131  yop->odd_frame ^= 1;
132  return pkt->size;
133  }
134  ret = av_new_packet(&yop->video_packet,
135  yop->frame_size - yop->audio_block_length);
136  if (ret < 0)
137  return ret;
138 
139  yop->video_packet.pos = avio_tell(pb);
140 
141  ret = avio_read(pb, yop->video_packet.data, yop->palette_size);
142  if (ret < 0) {
143  goto err_out;
144  }else if (ret < yop->palette_size) {
145  ret = AVERROR_EOF;
146  goto err_out;
147  }
148 
149  ret = av_get_packet(pb, pkt, 920);
150  if (ret < 0)
151  goto err_out;
152 
153  // Set position to the start of the frame
154  pkt->pos = yop->video_packet.pos;
155 
156  avio_skip(pb, yop->audio_block_length - ret);
157 
158  ret = avio_read(pb, yop->video_packet.data + yop->palette_size,
159  actual_video_data_size);
160  if (ret < 0)
161  goto err_out;
162  else if (ret < actual_video_data_size)
163  av_shrink_packet(&yop->video_packet, yop->palette_size + ret);
164 
165  // Arbitrarily return the audio data first
166  return yop->audio_block_length;
167 
168 err_out:
169  av_free_packet(&yop->video_packet);
170  return ret;
171 }
172 
174 {
175  YopDecContext *yop = s->priv_data;
176  av_free_packet(&yop->video_packet);
177  return 0;
178 }
179 
180 static int yop_read_seek(AVFormatContext *s, int stream_index,
181  int64_t timestamp, int flags)
182 {
183  YopDecContext *yop = s->priv_data;
184  int64_t frame_pos, pos_min, pos_max;
185  int frame_count;
186 
187  av_free_packet(&yop->video_packet);
188 
189  if (!stream_index)
190  return -1;
191 
192  pos_min = s->data_offset;
193  pos_max = avio_size(s->pb) - yop->frame_size;
194  frame_count = (pos_max - pos_min) / yop->frame_size;
195 
196  timestamp = FFMAX(0, FFMIN(frame_count, timestamp));
197 
198  frame_pos = timestamp * yop->frame_size + pos_min;
199  yop->odd_frame = timestamp & 1;
200 
201  avio_seek(s->pb, frame_pos, SEEK_SET);
202  return 0;
203 }
204 
206  .name = "yop",
207  .long_name = NULL_IF_CONFIG_SMALL("Psygnosis YOP Format"),
208  .priv_data_size = sizeof(YopDecContext),
214  .extensions = "yop",
216 };
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:154
Bytestream IO Context.
Definition: avio.h:68
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
int64_t avio_size(AVIOContext *s)
Get the filesize.
Definition: aviobuf.c:281
AV_WL32 AV_WL24 AV_WL16 AV_WB32 AV_WB24 AV_RB16
Definition: bytestream.h:89
static int yop_read_close(AVFormatContext *s)
Definition: yop.c:173
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:933
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the pts for a given stream.
Definition: utils.c:3828
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:60
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:148
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:716
int size
Definition: avcodec.h:909
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:211
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:954
int64_t data_offset
offset of the first packet
Definition: avformat.h:1163
static int yop_read_header(AVFormatContext *s, AVFormatParameters *ap)
Definition: yop.c:50
int audio_block_length
Definition: yop.c:34
void av_shrink_packet(AVPacket *pkt, int size)
Reduce packet size, correctly zeroing padding.
Definition: avpacket.c:79
Format I/O context.
Definition: avformat.h:863
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1387
int odd_frame
Definition: yop.c:32
static int read_header(FFV1Context *f)
Definition: ffv1.c:1513
uint8_t * data
Definition: avcodec.h:908
static int flags
Definition: log.c:34
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:151
#define AVERROR_EOF
End of file.
Definition: error.h:51
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:140
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:269
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:492
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:652
#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:191
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:140
AVStream * avformat_new_stream(AVFormatContext *s, AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2776
#define FFMAX(a, b)
Definition: common.h:53
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:914
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:632
AVCodecContext * codec
codec context
Definition: avformat.h:623
static int yop_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: yop.c:114
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:341
static int yop_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: yop.c:180
struct AVRational AVRational
rational number numerator/denominator
#define FFMIN(a, b)
Definition: common.h:55
int frame_size
Definition: yop.c:33
int width
picture width / height.
Definition: avcodec.h:1408
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: avio.h:483
static int read_probe(AVProbeData *p)
Definition: img2.c:185
AVInputFormat ff_yop_demuxer
Definition: yop.c:205
static int frame_count
Stream structure.
Definition: avformat.h:620
NULL
Definition: eval.c:50
AVPacket video_packet
Definition: yop.c:30
enum AVMediaType codec_type
Definition: avcodec.h:1574
int sample_rate
samples per second
Definition: avcodec.h:1456
AVIOContext * pb
Definition: avformat.h:896
main external API structure.
Definition: avcodec.h:1329
static int yop_probe(AVProbeData *probe_packet)
Definition: yop.c:38
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:111
int extradata_size
Definition: avcodec.h:1388
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:109
#define AVFMT_GENERIC_INDEX
Use generic index building code.
Definition: avformat.h:376
#define FF_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:497
int palette_size
Definition: yop.c:35
This structure contains the data a format has to probe a file.
Definition: avformat.h:339
#define AVPROBE_SCORE_MAX
maximum score, half of that is used for file-extension-based detection
Definition: avformat.h:345
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:722
Main libavformat public API header.
AV_WL32 AV_WL24 AV_RL16
Definition: bytestream.h:89
static AVRational frame_rate
Definition: ffmpeg.c:137
int channels
number of audio channels
Definition: avcodec.h:1457
void * priv_data
Format private data.
Definition: avformat.h:883
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:460
struct YopDecContext YopDecContext
enum CodecID codec_id
Definition: avcodec.h:1575