File: ani.h

package info (click to toggle)
scummvm 2.9.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 450,268 kB
  • sloc: cpp: 4,297,604; asm: 28,322; python: 12,901; sh: 11,219; java: 8,477; xml: 7,843; perl: 2,633; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (136 lines) | stat: -rw-r--r-- 3,967 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef IMAGE_ANI_H
#define IMAGE_ANI_H

#include "common/array.h"
#include "common/types.h"
#include "common/func.h"

namespace Common {

class SeekableReadStream;
struct IFFChunk;

} // End of namespace Common

namespace Graphics {

class Cursor;
struct Surface;

} // End of namespace Graphics

namespace Image {

class AniDecoder {
public:
	struct Metadata {
		Metadata();

		uint32 numFrames;	// Number of images
		uint32 numSteps;	// Number of frames (use the FrameDef to determine which frame)
		uint32 width;
		uint32 height;
		uint32 bitCount;
		uint32 numPlanes;
		uint32 perFrameDelay;
		bool haveSeqData;
		bool isCURFormat;
	};

	struct FrameDef {
		FrameDef();

		uint32 imageIndex;
		uint32 delay;	// In 1/60 sec
	};

	AniDecoder();
	~AniDecoder();

	bool open(Common::SeekableReadStream &stream, DisposeAfterUse::Flag = DisposeAfterUse::NO);
	void close();

	const Metadata &getMetadata() const;
	FrameDef getSequenceFrame(uint sequenceIndex) const;

	/**
	 * Opens a substream for an image.  If the metadata field
	 * "isCURFormat" is set, you can pass the stream to IcoCurDecoder to
	 * read it.  Otherwise, you must determine the format.  The stream
	 * is valid for as long as the stream used to construct the AniDecoder
	 * is valid.
	 * 
	 * @param imageIndex The index of the image in the ANI file.
	 * @return A substream for the image.
	 */
	Common::SeekableReadStream *openImageStream(uint imageIndex) const;

private:
	struct RIFFContainerDef {
		uint32 id;
		uint32 size;
	};

	struct RIFFChunkDef {
		uint32 id;
		uint32 size;
	};

	struct FrameDataRange {
		uint32 pos;
		uint32 size;
	};

	typedef Common::Functor2<const RIFFContainerDef &, Common::SeekableReadStream &, bool> RIFFContainerParseFunc_t;
	typedef Common::Functor2<const RIFFChunkDef &, Common::SeekableReadStream &, bool> RIFFChunkParseFunc_t;

	bool load();

	static bool parseRIFFChunks(Common::SeekableReadStream &stream, const RIFFChunkParseFunc_t &callback);
	static bool parseRIFFContainer(Common::SeekableReadStream &stream, const RIFFChunkDef &chunkDef, const RIFFContainerParseFunc_t &callback);

	bool parseTopLevelChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);
	bool parseTopLevelContainer(const RIFFContainerDef &container, Common::SeekableReadStream &stream);

	bool parseSecondLevelChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);

	bool parseListContainer(const RIFFContainerDef &container, Common::SeekableReadStream &stream);

	bool parseAnimHeaderChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);
	bool parseSeqChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);
	bool parseRateChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);
	bool parseIconChunk(const RIFFChunkDef &chunk, Common::SeekableReadStream &stream);

	Metadata _metadata;
	Common::Array<uint32> _rateData;
	Common::Array<uint32> _seqData;
	Common::Array<FrameDataRange> _frameDataLocations;

	Common::SeekableReadStream *_stream;
	DisposeAfterUse::Flag _disposeAfterUse;
};

} // End of namespace Image

#endif