Audio file loading backend libsndfile!
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * AudaSpace is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_FFMPEGREADER
27 #define AUD_FFMPEGREADER
28
29 #include "AUD_IReader.h"
30 #include "AUD_Reference.h"
31 class AUD_Buffer;
32
33 struct AVCodecContext;
34 extern "C" {
35 #include <libavformat/avformat.h>
36 }
37
38 /**
39  * This class reads a sound file via ffmpeg.
40  * \warning Seeking may not be accurate! Moreover the position is updated after
41  *          a buffer reading call. So calling getPosition right after seek
42  *          normally results in a wrong value.
43  * \warning Playback of an ogg with some outdated ffmpeg versions results in a
44  *          segfault on windows.
45  */
46 class AUD_FFMPEGReader : public AUD_IReader
47 {
48 private:
49         /**
50          * The current position in samples.
51          */
52         int m_position;
53
54         /**
55          * The playback buffer.
56          */
57         AUD_Buffer *m_buffer;
58
59         /**
60          * The specification of the audio data.
61          */
62         AUD_Specs m_specs;
63
64         /**
65          * The buffer for package reading.
66          */
67         AUD_Buffer *m_pkgbuf;
68
69         /**
70          * The count of samples still available from the last read package.
71          */
72         int m_pkgbuf_left;
73
74         /**
75          * The AVFormatContext structure for using ffmpeg.
76          */
77         AVFormatContext* m_formatCtx;
78
79         /**
80          * The AVCodecContext structure for using ffmpeg.
81          */
82         AVCodecContext* m_codecCtx;
83
84         /**
85          * The ByteIOContext to read the data from.
86          */
87         ByteIOContext* m_byteiocontext;
88
89         /**
90          * The stream ID in the file.
91          */
92         int m_stream;
93
94         /**
95          * The memory file to read from, only saved to keep the buffer alive.
96          */
97         AUD_Reference<AUD_Buffer> m_membuffer;
98
99         /**
100          * Decodes a packet into the given buffer.
101          * \param packet The AVPacket to decode.
102          * \param buffer The target buffer.
103          * \return The count of read bytes.
104          */
105         int decode(AVPacket* packet, AUD_Buffer* buffer);
106
107 public:
108         /**
109          * Creates a new reader.
110          * \param filename The path to the file to be read.
111          * \exception AUD_Exception Thrown if the file specified does not exist or
112          *            cannot be read with ffmpeg.
113          */
114         AUD_FFMPEGReader(const char* filename);
115
116         /**
117          * Creates a new reader.
118          * \param buffer The buffer to read from.
119          * \exception AUD_Exception Thrown if the buffer specified cannot be read
120          *                          with ffmpeg.
121          */
122         AUD_FFMPEGReader(AUD_Reference<AUD_Buffer> buffer);
123
124         /**
125          * Destroys the reader and closes the file.
126          */
127         virtual ~AUD_FFMPEGReader();
128
129         virtual bool isSeekable();
130         virtual void seek(int position);
131         virtual int getLength();
132         virtual int getPosition();
133         virtual AUD_Specs getSpecs();
134         virtual AUD_ReaderType getType();
135         virtual bool notify(AUD_Message &message);
136         virtual void read(int & length, sample_t* & buffer);
137 };
138
139 #endif //AUD_FFMPEGREADER