3D Audio GSoC:
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 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 General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/ffmpeg/AUD_FFMPEGReader.h
28  *  \ingroup audffmpeg
29  */
30
31
32 #ifndef AUD_FFMPEGREADER
33 #define AUD_FFMPEGREADER
34
35 #include "AUD_ConverterFunctions.h"
36 #include "AUD_IReader.h"
37 #include "AUD_Reference.h"
38 #include "AUD_Buffer.h"
39
40 #include <string>
41
42 struct AVCodecContext;
43 extern "C" {
44 #include <libavformat/avformat.h>
45 }
46
47 /**
48  * This class reads a sound file via ffmpeg.
49  * \warning Seeking may not be accurate! Moreover the position is updated after
50  *          a buffer reading call. So calling getPosition right after seek
51  *          normally results in a wrong value.
52  */
53 class AUD_FFMPEGReader : public AUD_IReader
54 {
55 private:
56         /**
57          * The current position in samples.
58          */
59         int m_position;
60
61         /**
62          * The specification of the audio data.
63          */
64         AUD_DeviceSpecs m_specs;
65
66         /**
67          * The buffer for package reading.
68          */
69         AUD_Buffer m_pkgbuf;
70
71         /**
72          * The count of samples still available from the last read package.
73          */
74         int m_pkgbuf_left;
75
76         /**
77          * The AVFormatContext structure for using ffmpeg.
78          */
79         AVFormatContext* m_formatCtx;
80
81         /**
82          * The AVCodecContext structure for using ffmpeg.
83          */
84         AVCodecContext* m_codecCtx;
85
86         /**
87          * The AVIOContext to read the data from.
88          */
89         AVIOContext* m_aviocontext;
90
91         /**
92          * The stream ID in the file.
93          */
94         int m_stream;
95
96         /**
97          * Converter function.
98          */
99         AUD_convert_f m_convert;
100
101         /**
102          * The memory file to read from.
103          */
104         AUD_Reference<AUD_Buffer> m_membuffer;
105
106         /**
107          * The buffer to read with.
108          */
109         data_t* m_membuf;
110
111         /**
112          * Reading position of the buffer.
113          */
114         int64_t m_membufferpos;
115
116         /**
117          * Decodes a packet into the given buffer.
118          * \param packet The AVPacket to decode.
119          * \param buffer The target buffer.
120          * \return The count of read bytes.
121          */
122         int decode(AVPacket* packet, AUD_Buffer& buffer);
123
124         /**
125          * Initializes the object.
126          */
127         void init();
128
129         // hide copy constructor and operator=
130         AUD_FFMPEGReader(const AUD_FFMPEGReader&);
131         AUD_FFMPEGReader& operator=(const AUD_FFMPEGReader&);
132
133 public:
134         /**
135          * Creates a new reader.
136          * \param filename The path to the file to be read.
137          * \exception AUD_Exception Thrown if the file specified does not exist or
138          *            cannot be read with ffmpeg.
139          */
140         AUD_FFMPEGReader(std::string filename);
141
142         /**
143          * Creates a new reader.
144          * \param buffer The buffer to read from.
145          * \exception AUD_Exception Thrown if the buffer specified cannot be read
146          *                          with ffmpeg.
147          */
148         AUD_FFMPEGReader(AUD_Reference<AUD_Buffer> buffer);
149
150         /**
151          * Destroys the reader and closes the file.
152          */
153         virtual ~AUD_FFMPEGReader();
154
155         static int read_packet(void* opaque, uint8_t* buf, int buf_size);
156         static int64_t seek_packet(void* opaque, int64_t offset, int whence);
157
158         virtual bool isSeekable() const;
159         virtual void seek(int position);
160         virtual int getLength() const;
161         virtual int getPosition() const;
162         virtual AUD_Specs getSpecs() const;
163         virtual void read(int& length, bool& eos, sample_t* buffer);
164 };
165
166 #endif //AUD_FFMPEGREADER