Merged changes in the trunk up to revision 54992.
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGReader.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/ffmpeg/AUD_FFMPEGReader.h
26  *  \ingroup audffmpeg
27  */
28
29
30 #ifndef __AUD_FFMPEGREADER_H__
31 #define __AUD_FFMPEGREADER_H__
32
33 #include "AUD_ConverterFunctions.h"
34 #include "AUD_IReader.h"
35 #include "AUD_Buffer.h"
36
37 #include <string>
38 #include <boost/shared_ptr.hpp>
39
40 struct AVCodecContext;
41 extern "C" {
42 #include <libavformat/avformat.h>
43 }
44
45 /**
46  * This class reads a sound file via ffmpeg.
47  * \warning Seeking may not be accurate! Moreover the position is updated after
48  *          a buffer reading call. So calling getPosition right after seek
49  *          normally results in a wrong value.
50  */
51 class AUD_FFMPEGReader : public AUD_IReader
52 {
53 private:
54         /**
55          * The current position in samples.
56          */
57         int m_position;
58
59         /**
60          * The specification of the audio data.
61          */
62         AUD_DeviceSpecs 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 AVIOContext to read the data from.
86          */
87         AVIOContext* m_aviocontext;
88
89         /**
90          * The stream ID in the file.
91          */
92         int m_stream;
93
94         /**
95          * Converter function.
96          */
97         AUD_convert_f m_convert;
98
99         /**
100          * The memory file to read from.
101          */
102         boost::shared_ptr<AUD_Buffer> m_membuffer;
103
104         /**
105          * The buffer to read with.
106          */
107         data_t* m_membuf;
108
109         /**
110          * Reading position of the buffer.
111          */
112         int64_t m_membufferpos;
113
114         /**
115          * Decodes a packet into the given buffer.
116          * \param packet The AVPacket to decode.
117          * \param buffer The target buffer.
118          * \return The count of read bytes.
119          */
120         int decode(AVPacket* packet, AUD_Buffer& buffer);
121
122         /**
123          * Initializes the object.
124          */
125         void init();
126
127         // hide copy constructor and operator=
128         AUD_FFMPEGReader(const AUD_FFMPEGReader&);
129         AUD_FFMPEGReader& operator=(const AUD_FFMPEGReader&);
130
131 public:
132         /**
133          * Creates a new reader.
134          * \param filename The path to the file to be read.
135          * \exception AUD_Exception Thrown if the file specified does not exist or
136          *            cannot be read with ffmpeg.
137          */
138         AUD_FFMPEGReader(std::string filename);
139
140         /**
141          * Creates a new reader.
142          * \param buffer The buffer to read from.
143          * \exception AUD_Exception Thrown if the buffer specified cannot be read
144          *                          with ffmpeg.
145          */
146         AUD_FFMPEGReader(boost::shared_ptr<AUD_Buffer> buffer);
147
148         /**
149          * Destroys the reader and closes the file.
150          */
151         virtual ~AUD_FFMPEGReader();
152
153         static int read_packet(void* opaque, uint8_t* buf, int buf_size);
154         static int64_t seek_packet(void* opaque, int64_t offset, int whence);
155
156         virtual bool isSeekable() const;
157         virtual void seek(int position);
158         virtual int getLength() const;
159         virtual int getPosition() const;
160         virtual AUD_Specs getSpecs() const;
161         virtual void read(int& length, bool& eos, sample_t* buffer);
162 };
163
164 #endif //__AUD_FFMPEGREADER_H__