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  * \warning Playback of an ogg with some outdated ffmpeg versions results in a
53  *          segfault on windows.
54  */
55 class AUD_FFMPEGReader : public AUD_IReader
56 {
57 private:
58         /**
59          * The current position in samples.
60          */
61         int m_position;
62
63         /**
64          * The specification of the audio data.
65          */
66         AUD_DeviceSpecs m_specs;
67
68         /**
69          * The buffer for package reading.
70          */
71         AUD_Buffer m_pkgbuf;
72
73         /**
74          * The count of samples still available from the last read package.
75          */
76         int m_pkgbuf_left;
77
78         /**
79          * The AVFormatContext structure for using ffmpeg.
80          */
81         AVFormatContext* m_formatCtx;
82
83         /**
84          * The AVCodecContext structure for using ffmpeg.
85          */
86         AVCodecContext* m_codecCtx;
87
88         /**
89          * The AVIOContext to read the data from.
90          */
91         AVIOContext* m_aviocontext;
92
93         /**
94          * The stream ID in the file.
95          */
96         int m_stream;
97
98         /**
99          * Converter function.
100          */
101         AUD_convert_f m_convert;
102
103         /**
104          * The memory file to read from.
105          */
106         AUD_Reference<AUD_Buffer> m_membuffer;
107
108         /**
109          * The buffer to read with.
110          */
111         data_t* m_membuf;
112
113         /**
114          * Reading position of the buffer.
115          */
116         int64_t m_membufferpos;
117
118         /**
119          * Decodes a packet into the given buffer.
120          * \param packet The AVPacket to decode.
121          * \param buffer The target buffer.
122          * \return The count of read bytes.
123          */
124         int decode(AVPacket* packet, AUD_Buffer& buffer);
125
126         /**
127          * Initializes the object.
128          */
129         void init();
130
131         // hide copy constructor and operator=
132         AUD_FFMPEGReader(const AUD_FFMPEGReader&);
133         AUD_FFMPEGReader& operator=(const AUD_FFMPEGReader&);
134
135 public:
136         /**
137          * Creates a new reader.
138          * \param filename The path to the file to be read.
139          * \exception AUD_Exception Thrown if the file specified does not exist or
140          *            cannot be read with ffmpeg.
141          */
142         AUD_FFMPEGReader(std::string filename);
143
144         /**
145          * Creates a new reader.
146          * \param buffer The buffer to read from.
147          * \exception AUD_Exception Thrown if the buffer specified cannot be read
148          *                          with ffmpeg.
149          */
150         AUD_FFMPEGReader(AUD_Reference<AUD_Buffer> buffer);
151
152         /**
153          * Destroys the reader and closes the file.
154          */
155         virtual ~AUD_FFMPEGReader();
156
157         static int read_packet(void* opaque, uint8_t* buf, int buf_size);
158         static int64_t seek_packet(void* opaque, int64_t offset, int whence);
159
160         virtual bool isSeekable() const;
161         virtual void seek(int position);
162         virtual int getLength() const;
163         virtual int getPosition() const;
164         virtual AUD_Specs getSpecs() const;
165         virtual void read(int& length, bool& eos, sample_t* buffer);
166 };
167
168 #endif //AUD_FFMPEGREADER