Undo revision 23130 which was a merge with 2.5, a messy one because I did something...
[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 class AUD_Buffer;
31 struct AVCodecContext;
32 extern "C" {
33 #include <libavformat/avformat.h>
34 }
35
36 /**
37  * This class reads a sound file via ffmpeg.
38  * \warning Seeking may not be accurate! Moreover the position is updated after
39  *          a buffer reading call. So calling getPosition right after seek
40  *          normally results in a wrong value.
41  * \warning Playback of an ogg with some outdated ffmpeg versions results in a
42  *          segfault on windows.
43  */
44 class AUD_FFMPEGReader : public AUD_IReader
45 {
46 private:
47         /**
48          * The current position in samples.
49          */
50         int m_position;
51
52         /**
53          * The playback buffer.
54          */
55         AUD_Buffer *m_buffer;
56
57         /**
58          * The specification of the audio data.
59          */
60         AUD_Specs m_specs;
61
62         /**
63          * The buffer for package reading.
64          */
65         AUD_Buffer *m_pkgbuf;
66
67         /**
68          * The count of samples still available from the last read package.
69          */
70         int m_pkgbuf_left;
71
72         /**
73          * The AVFormatContext structure for using ffmpeg.
74          */
75         AVFormatContext* m_formatCtx;
76
77         /**
78          * The AVCodecContext structure for using ffmpeg.
79          */
80         AVCodecContext* m_codecCtx;
81
82         /**
83          * The ByteIOContext to read the data from.
84          */
85         ByteIOContext* m_byteiocontext;
86
87         /**
88          * The stream ID in the file.
89          */
90         int m_stream;
91
92         /**
93          * Decodes a packet into the given buffer.
94          * \param packet The AVPacket to decode.
95          * \param buffer The target buffer.
96          * \return The count of read bytes.
97          */
98         int decode(AVPacket* packet, AUD_Buffer* buffer);
99
100 public:
101         /**
102          * Creates a new reader.
103          * \param filename The path to the file to be read.
104          * \exception AUD_Exception Thrown if the file specified does not exist or
105          *            cannot be read with ffmpeg.
106          */
107         AUD_FFMPEGReader(const char* filename);
108
109         /**
110          * Creates a new reader.
111          * \param buffer The buffer to read from.
112          * \param size The size of the buffer.
113          * \exception AUD_Exception Thrown if the buffer specified cannot be read
114          *                          with ffmpeg.
115          */
116         AUD_FFMPEGReader(unsigned char* buffer, int size);
117
118         /**
119          * Destroys the reader and closes the file.
120          */
121         virtual ~AUD_FFMPEGReader();
122
123         virtual bool isSeekable();
124         virtual void seek(int position);
125         virtual int getLength();
126         virtual int getPosition();
127         virtual AUD_Specs getSpecs();
128         virtual AUD_ReaderType getType();
129         virtual bool notify(AUD_Message &message);
130         virtual void read(int & length, sample_t* & buffer);
131 };
132
133 #endif //AUD_FFMPEGREADER