Used for reading PCM .wav files. More...
#include "wavAudioCursor.h"
Inheritance diagram for WavAudioCursor:
Public Member Functions | |
| WavAudioCursor (WavAudio *src, std::istream *stream) | |
| Reads the .wav header from the indicated stream. More... | |
| virtual | ~WavAudioCursor () |
| xxx More... | |
| virtual TypeHandle | force_init_type () |
| virtual TypeHandle | get_type () const |
| virtual void | read_samples (int n, int16_t *data) |
| Read audio samples from the stream. More... | |
| virtual void | seek (double offset) |
| Seeks to a target location. More... | |
 Public Member Functions inherited from MovieAudioCursor | |
| MovieAudioCursor (MovieAudio *src) | |
| This constructor returns a null audio stream — a stream of total silence, at 8000 samples per second. More... | |
| bool | aborted () const |
| int | audio_channels () const |
| int | audio_rate () const |
| bool | can_seek () const |
| bool | can_seek_fast () const |
| double | length () const |
| PT (MovieAudio) get_source() const | |
| void | read_samples (int n, Datagram *dg) |
| Read audio samples from the stream into a Datagram. More... | |
| std::string | read_samples (int n) |
| Read audio samples from the stream and returns them as a string. More... | |
| virtual int | ready () const |
| Returns the number of audio samples that are ready to read. More... | |
| void | skip_samples (int n) |
| double | tell () const |
| Public Member Functions inherited from TypedWritableReferenceCount | |
| TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
| virtual ReferenceCount * | as_reference_count () |
| Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
| void | operator= (const TypedWritableReferenceCount ©) |
| Public Member Functions inherited from TypedWritable | |
| TypedWritable (const TypedWritable ©) | |
| virtual int | complete_pointers (TypedWritable **p_list, BamReader *manager) |
| Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
| vector_uchar | encode_to_bam_stream () const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More... | |
| bool | encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
| virtual void | fillin (DatagramIterator &scan, BamReader *manager) |
| This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More... | |
| virtual void | finalize (BamReader *manager) |
| Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More... | |
| UpdateSeq | get_bam_modified () const |
| Returns the current bam_modified counter. More... | |
| void | mark_bam_modified () |
| Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
| void | operator= (const TypedWritable ©) |
| virtual bool | require_fully_complete () const |
| Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More... | |
| virtual void | update_bam_nested (BamWriter *manager) |
| Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More... | |
| virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
| Writes the contents of this object to the datagram for shipping out to a Bam file. More... | |
| Public Member Functions inherited from TypedObject | |
| TypedObject (const TypedObject ©)=default | |
| TypedObject * | as_typed_object () |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| const TypedObject * | as_typed_object () const |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| int | get_best_parent_from_Set (const std::set< int > &) const |
| int | get_type_index () const |
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
| bool | is_exact_type (TypeHandle handle) const |
| Returns true if the current object is the indicated type exactly. More... | |
| bool | is_of_type (TypeHandle handle) const |
| Returns true if the current object is or derives from the indicated type. More... | |
| TypedObject & | operator= (const TypedObject ©)=default |
| Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| WeakReferenceList * | get_weak_list () const |
| Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
| bool | has_weak_list () const |
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
| void | local_object () |
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
| void | ref () const |
| Explicitly increments the reference count. More... | |
| bool | ref_if_nonzero () const |
| Atomically increases the reference count of this object if it is not zero. More... | |
| bool | test_ref_count_integrity () const |
| Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
| bool | test_ref_count_nonzero () const |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
| virtual bool | unref () const |
| Explicitly decrements the reference count. More... | |
| WeakReferenceList * | weak_ref () |
| Adds the indicated PointerToVoid as a weak reference to this object. More... | |
| void | weak_unref () |
| Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from MovieAudioCursor | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from TypedWritableReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data |
| Static Public Member Functions inherited from TypedWritable | |
| static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr) |
| Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More... | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from TypedObject | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| This function is declared non-inline to work around a compiler bug in g++ 2.96. More... | |
| Static Public Member Functions inherited from ReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Public Attributes | |
| bool | _is_valid |
| Public Attributes inherited from TypedWritableReferenceCount | |
| static BamReader * | reader = nullptr) |
| Public Attributes inherited from TypedObject | |
| get_type | |
| Public Attributes inherited from ReferenceCount | |
| get_ref_count | |
| Returns the current reference count. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from TypedWritable | |
| static TypedWritable *const | Null = nullptr |
Detailed Description
Used for reading PCM .wav files.
Supported formats are linear PCM, IEEE float, A-law and mu-law.
Definition at line 27 of file wavAudioCursor.h.
Constructor & Destructor Documentation
◆ WavAudioCursor()
|
explicit |
Reads the .wav header from the indicated stream.
This leaves the read pointer positioned at the start of the data.
Definition at line 97 of file wavAudioCursor.cxx.
◆ ~WavAudioCursor()
|
virtual |
xxx
Definition at line 281 of file wavAudioCursor.cxx.
Member Function Documentation
◆ read_samples()
|
virtual |
Read audio samples from the stream.
N is the number of samples you wish to read. Your buffer must be equal in size to N * channels. Multiple-channel audio will be interleaved.
Reimplemented from MovieAudioCursor.
Definition at line 328 of file wavAudioCursor.cxx.
◆ seek()
|
virtual |
Seeks to a target location.
Afterward, the packet_time is guaranteed to be less than or equal to the specified time.
Reimplemented from MovieAudioCursor.
Definition at line 293 of file wavAudioCursor.cxx.
References StreamReader::skip_bytes().
The documentation for this class was generated from the following files:
- panda/src/movies/wavAudioCursor.h
- panda/src/movies/wavAudioCursor.cxx
