File: MediaFile.h

package info (click to toggle)
bzflag 2.0.13.20080902-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 27,564 kB
  • ctags: 34,716
  • sloc: cpp: 139,842; ansic: 14,510; sh: 10,715; makefile: 2,454; perl: 477; php: 428; python: 345; objc: 243; xml: 24
file content (107 lines) | stat: -rw-r--r-- 3,221 bytes parent folder | download
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
/* bzflag
 * Copyright (c) 1993 - 2008 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named LICENSE that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef BZF_MEDIA_FILE_H
#define BZF_MEDIA_FILE_H

#include "common.h"

/* system interface headers */
#include <string>

/* common interface headers */
#include "bzfio.h"


// if HALF_RATE_AUDIO defined then use half the normal audio sample
// rate (and downsample the audio files to match).  this reduces the
// demands on the system.
// #define HALF_RATE_AUDIO


/** This class is a base class for media files, which can be image files or
    audio files. */
class MediaFile {
public:
  /** Close the media file.  This does *not* destroy the stream. */
  virtual ~MediaFile();

  /** Read an image file.  Use delete[] to release the returned
      image.  Returns NULL on failure.  Images are stored RGBA,
      left to right, bottom to top. */
  static unsigned char* readImage(std::string filename,
				  int* width, int* height);

  // read a sound file.  use delete[] to release the returned
  // audio.  returns NULL on failure.  sounds are stored
  // left/right.
  //	static float*		readSound(const std::string& filename,
  //							int* numFrames, int* rate);

protected:
  MediaFile(std::istream*);

  /** Get the stream. */
  std::istream* getStream() const { return stream; }

  /** Return true if the stream is in a readable state. */
  bool isOkay() const;

  /** Utility method to read raw data. */
  void readRaw(void* buffer, uint32_t bytes);

  /** Utility method to skip data. */
  void skip(uint32_t bytes);

  /** Utility method to read a 2 byte little-endian number into host byte
      order. */
  uint16_t read16LE();
  /** Utility method to read a 2 byte big-endian number into host byte
      order. */
  uint16_t read16BE();
  /** Utility method to read a 4 byte little-endian number into host byte
      order. */
  uint32_t read32LE();
  /** Utility method to read a 4 byte big-endian number into host byte
      order. */
  uint32_t read32BE();

  /** Utility method to byte swap a little-endian 2 byte number in place
      into host byte order. Returns the byte swapped data. */
  static uint16_t swap16LE(uint16_t*);

  /** Utility method to byte swap a big-endian 2 byte number in place into
      host byte order. Returns the byte swapped data. */
  static uint16_t swap16BE(uint16_t*);

  /** Utility method to byte swap a little-endian 4 byte number in place
      into host byte order. Returns the byte swapped data. */
  static uint32_t swap32LE(uint32_t*);

  /** Utility method to byte swap a big-endian 4 byte number in place into
      host byte order. Returns the byte swapped data. */
  static uint32_t swap32BE(uint32_t*);

private:
  std::istream*			stream;
};

#endif

// Local Variables: ***
// mode:C++ ***
// tab-width: 8 ***
// c-basic-offset: 2 ***
// indent-tabs-mode: t ***
// End: ***
// ex: shiftwidth=2 tabstop=8