[Scummvm-cvs-logs] SF.net SVN: scummvm:[46127] scummvm/trunk
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Tue Nov 24 23:08:35 CET 2009
Revision: 46127
http://scummvm.svn.sourceforge.net/scummvm/?rev=46127&view=rev
Author: fingolfin
Date: 2009-11-24 22:08:34 +0000 (Tue, 24 Nov 2009)
Log Message:
-----------
Fix incorrectly placed doxygen comments; replace Common::ID2string by Common::tag2string
Modified Paths:
--------------
scummvm/trunk/common/iff_container.h
scummvm/trunk/engines/kyra/script.cpp
scummvm/trunk/engines/kyra/script_tim.cpp
scummvm/trunk/graphics/iff.cpp
scummvm/trunk/graphics/iff.h
scummvm/trunk/graphics/video/dxa_decoder.h
scummvm/trunk/graphics/video/flic_decoder.h
scummvm/trunk/graphics/video/smk_decoder.h
Modified: scummvm/trunk/common/iff_container.h
===================================================================
--- scummvm/trunk/common/iff_container.h 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/common/iff_container.h 2009-11-24 22:08:34 UTC (rev 46127)
@@ -143,9 +143,6 @@
/* 8SVX Voice8Header */
-char * ID2string(Common::IFF_ID id);
-
-
/**
* Represents a IFF chunk available to client code.
*
Modified: scummvm/trunk/engines/kyra/script.cpp
===================================================================
--- scummvm/trunk/engines/kyra/script.cpp 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/engines/kyra/script.cpp 2009-11-24 22:08:34 UTC (rev 46127)
@@ -96,7 +96,7 @@
break;
default:
- warning("Unexpected chunk '%s' of size %d found in file '%s'", Common::ID2string(chunk._type), chunk._size, _filename);
+ warning("Unexpected chunk '%s' of size %d found in file '%s'", Common::tag2string(chunk._type).c_str(), chunk._size, _filename);
}
return false;
Modified: scummvm/trunk/engines/kyra/script_tim.cpp
===================================================================
--- scummvm/trunk/engines/kyra/script_tim.cpp 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/engines/kyra/script_tim.cpp 2009-11-24 22:08:34 UTC (rev 46127)
@@ -141,7 +141,7 @@
break;
default:
- warning("Unexpected chunk '%s' of size %d found in file '%s'", Common::ID2string(chunk._type), chunk._size, _filename);
+ warning("Unexpected chunk '%s' of size %d found in file '%s'", Common::tag2string(chunk._type).c_str(), chunk._size, _filename);
}
return false;
Modified: scummvm/trunk/graphics/iff.cpp
===================================================================
--- scummvm/trunk/graphics/iff.cpp 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/graphics/iff.cpp 2009-11-24 22:08:34 UTC (rev 46127)
@@ -27,25 +27,6 @@
#include "common/util.h"
-
-namespace Common {
-
-// this really belongs to iff_container.cpp, but we don't want
-// to put only this in a source file
-char *ID2string(Common::IFF_ID id) {
- static char str[] = "abcd";
-
- str[0] = (char)(id >> 24 & 0xff);
- str[1] = (char)(id >> 16 & 0xff);
- str[2] = (char)(id >> 8 & 0xff);
- str[3] = (char)(id >> 0 & 0xff);
-
- return str;
-}
-
-}
-
-
namespace Graphics {
void BMHD::load(Common::ReadStream *stream) {
@@ -154,6 +135,26 @@
}
+// handles PBM subtype of IFF FORM files
+//
+struct PBMDecoder {
+ /**
+ * PBM header data, necessary for loadBitmap()
+ */
+ Graphics::BMHD _header;
+
+ /**
+ * Fills the _header member from the given stream.
+ */
+ void loadHeader(Common::ReadStream *stream);
+
+ /**
+ * Loads and unpacks the PBM bitmap data from the stream into the buffer.
+ * The functions assumes the buffer is large enough to contain all data.
+ */
+ void loadBitmap(byte *buffer, Common::ReadStream *stream);
+};
+
void PBMDecoder::loadHeader(Common::ReadStream *stream) {
_header.load(stream);
}
@@ -266,5 +267,4 @@
return dataSize - left;
}
-
-}
+} // End of namespace Graphics
Modified: scummvm/trunk/graphics/iff.h
===================================================================
--- scummvm/trunk/graphics/iff.h 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/graphics/iff.h 2009-11-24 22:08:34 UTC (rev 46127)
@@ -22,7 +22,7 @@
* $Id$
*/
-/**
+/*
* Bitmap decoder used in engines:
* - parallaction
* - saga
@@ -104,40 +104,23 @@
-
-// handles PBM subtype of IFF FORM files
-//
-struct PBMDecoder {
- /**
- * PBM header data, necessary for loadBitmap()
- */
- Graphics::BMHD _header;
-
- /**
- * Fills the _header member from the given stream.
- */
- void loadHeader(Common::ReadStream *stream);
-
- /**
- * Loads and unpacks the PBM bitmap data from the stream into the buffer.
- * The functions assumes the buffer is large enough to contain all data.
- */
- void loadBitmap(byte *buffer, Common::ReadStream *stream);
-};
-
+/**
+ * Handles PBM subtype of IFF FORM files
+ */
void decodePBM(Common::ReadStream &input, Surface &surface, byte *colors);
-/*
- PackBits is a RLE compression algorithm introduced
- by Apple. It is also used to encode ILBM and PBM
- subtypes of IFF files, and some flavours of TIFF.
-
- As there is no compression across row boundaries
- in the above formats, read() will extract a *new*
- line on each call, discarding any alignment or
- padding.
-*/
+/**
+ * Decode a given PackBits encoded stream.
+ *
+ * PackBits is an RLE compression algorithm introduced by Apple. It is also
+ * used to encode ILBM and PBM subtypes of IFF files, and some flavours of
+ * TIFF.
+ *
+ * As there is no compression across row boundaries in the above formats,
+ * read() will extract a *new* line on each call, discarding any alignment
+ * or padding.
+ */
class PackBitsReadStream : public Common::ReadStream {
protected:
@@ -152,6 +135,6 @@
uint32 read(void *dataPtr, uint32 dataSize);
};
-}
+} // End of namespace Graphics
#endif
Modified: scummvm/trunk/graphics/video/dxa_decoder.h
===================================================================
--- scummvm/trunk/graphics/video/dxa_decoder.h 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/graphics/video/dxa_decoder.h 2009-11-24 22:08:34 UTC (rev 46127)
@@ -23,13 +23,6 @@
*
*/
-/**
- * Video decoder used in engines:
- * - agos
- * - sword1
- * - sword2
- */
-
#ifndef GRAPHICS_VIDEO_DXA_PLAYER_H
#define GRAPHICS_VIDEO_DXA_PLAYER_H
@@ -37,6 +30,14 @@
namespace Graphics {
+/**
+ * Decoder for DXA videos.
+ *
+ * Video decoder used in engines:
+ * - agos
+ * - sword1
+ * - sword2
+ */
class DXADecoder : public VideoDecoder {
public:
DXADecoder();
Modified: scummvm/trunk/graphics/video/flic_decoder.h
===================================================================
--- scummvm/trunk/graphics/video/flic_decoder.h 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/graphics/video/flic_decoder.h 2009-11-24 22:08:34 UTC (rev 46127)
@@ -23,11 +23,6 @@
*
*/
-/**
- * Video decoder used in engines:
- * - tucker
- */
-
#ifndef GRAPHICS_VIDEO_FlicDecoder_H
#define GRAPHICS_VIDEO_FlicDecoder_H
@@ -41,6 +36,12 @@
namespace Graphics {
+/**
+ *
+ * Decoder for DXA videos.
+ * Video decoder used in engines:
+ * - tucker
+ */
class FlicDecoder : public VideoDecoder {
public:
FlicDecoder();
Modified: scummvm/trunk/graphics/video/smk_decoder.h
===================================================================
--- scummvm/trunk/graphics/video/smk_decoder.h 2009-11-24 14:18:46 UTC (rev 46126)
+++ scummvm/trunk/graphics/video/smk_decoder.h 2009-11-24 22:08:34 UTC (rev 46127)
@@ -23,19 +23,6 @@
*
*/
-/**
- * Video decoder used in engines:
- * - agos
- * - saga
- * - scumm (he)
- * - sword1
- * - sword2
- */
-
-// Based on http://wiki.multimedia.cx/index.php?title=Smacker
-// and the FFmpeg Smacker decoder (libavcodec/smacker.c), revision 16143
-// http://svn.ffmpeg.org/ffmpeg/trunk/libavcodec/smacker.c?revision=16143&view=markup
-
#ifndef GRAPHICS_VIDEO_SMK_PLAYER_H
#define GRAPHICS_VIDEO_SMK_PLAYER_H
@@ -51,7 +38,18 @@
class BigHuffmanTree;
/**
- * Implementation of a Smacker v2/v4 video decoder
+ * Decoder for Smacker v2/v4 videos.
+ *
+ * Based on http://wiki.multimedia.cx/index.php?title=Smacker
+ * and the FFmpeg Smacker decoder (libavcodec/smacker.c), revision 16143
+ * http://svn.ffmpeg.org/ffmpeg/trunk/libavcodec/smacker.c?revision=16143&view=markup
+ *
+ * Video decoder used in engines:
+ * - agos
+ * - saga
+ * - scumm (he)
+ * - sword1
+ * - sword2
*/
class SmackerDecoder : public VideoDecoder {
public:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list