Panda3D
vorbisAudio.h
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file vorbisAudio.h
10  * @author rdb
11  * @date 2013-08-23
12  */
13 
14 #ifndef VORBISAUDIO_H
15 #define VORBISAUDIO_H
16 
17 #include "pandabase.h"
18 #include "movieAudio.h"
19 
20 #ifdef HAVE_VORBIS
21 
22 class VorbisAudioCursor;
23 
24 /**
25  * Interfaces with the libvorbisfile library to implement decoding of Ogg
26  * Vorbis audio files.
27  */
28 class EXPCL_PANDA_MOVIES VorbisAudio : public MovieAudio {
29 PUBLISHED:
30  VorbisAudio(const Filename &name);
31  virtual ~VorbisAudio();
32  virtual PT(MovieAudioCursor) open();
33 
34  static PT(MovieAudio) make(const Filename &name);
35 
36 private:
37  friend class VorbisAudioCursor;
38 
39 public:
40  static TypeHandle get_class_type() {
41  return _type_handle;
42  }
43  static void init_type() {
44  TypedWritableReferenceCount::init_type();
45  register_type(_type_handle, "VorbisAudio",
46  MovieAudio::get_class_type());
47  }
48  virtual TypeHandle get_type() const {
49  return get_class_type();
50  }
51  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
52 
53 private:
54  static TypeHandle _type_handle;
55 };
56 
57 #include "vorbisAudio.I"
58 
59 #endif // HAVE_VORBIS
60 
61 #endif // VORBISAUDIO_H
void register_type(TypeHandle &type_handle, const std::string &name)
This inline function is just a convenient way to call TypeRegistry::register_type(),...
Definition: register_type.I:22
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
The name of a file, such as a texture file or an Egg file.
Definition: filename.h:39
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
A MovieAudio is actually any source that provides a sequence of audio samples.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:81
A MovieAudio is actually any source that provides a sequence of audio samples.
Definition: movieAudio.h:44