== FFMPEG ==
[blender-staging.git] / source / gameengine / VideoTexture / VideoFFmpeg.h
1 /* $Id$
2 -----------------------------------------------------------------------------
3 This source file is part of VideoTexture library
4
5 Copyright (c) 2007 The Zdeno Ash Miklas
6
7 This program is free software; you can redistribute it and/or modify it under
8 the terms of the GNU Lesser General Public License as published by the Free Software
9 Foundation; either version 2 of the License, or (at your option) any later
10 version.
11
12 This program is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License along with
17 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
18 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
19 http://www.gnu.org/copyleft/lesser.txt.
20 -----------------------------------------------------------------------------
21 */
22
23 /** \file VideoFFmpeg.h
24  *  \ingroup bgevideotex
25  */
26  
27 #if !defined VIDEOFFMPEG_H
28 #define VIDEOFFMPEG_H
29
30 #ifdef WITH_FFMPEG
31 extern "C" {
32 #undef __cplusplus
33 #include <pthread.h>
34 #include <libavformat/avformat.h>
35 #include <libavcodec/avcodec.h>
36 #include <libavutil/rational.h>
37 #if (LIBAVFORMAT_VERSION_MAJOR > 52) || ((LIBAVFORMAT_VERSION_MAJOR >= 52) && (LIBAVFORMAT_VERSION_MINOR >= 101))
38 #include <libavutil/parseutils.h>
39 #endif
40 #include <libswscale/swscale.h>
41 #include "DNA_listBase.h"
42 #include "BLI_threads.h"
43 #include "BLI_blenlib.h"
44 #define __cplusplus
45 }
46
47
48 #if LIBAVFORMAT_VERSION_INT < (49 << 16)
49 #define FFMPEG_OLD_FRAME_RATE 1
50 #else
51 #define FFMPEG_CODEC_IS_POINTER 1
52 #endif
53
54 #if LIBAVFORMAT_VERSION_INT >= (52 << 16)
55 #define FFMPEG_PB_IS_POINTER 1
56 #endif
57
58 #ifdef FFMPEG_CODEC_IS_POINTER
59 static inline AVCodecContext* get_codec_from_stream(AVStream* stream)
60 {
61         return stream->codec;
62 }
63 #else
64 static inline AVCodecContext* get_codec_from_stream(AVStream* stream)
65 {
66         return &stream->codec;
67 }
68 #endif
69
70 #include "VideoBase.h"
71
72 #define CACHE_FRAME_SIZE        10
73 #define CACHE_PACKET_SIZE       30
74
75 // type VideoFFmpeg declaration
76 class VideoFFmpeg : public VideoBase
77 {
78 public:
79         /// constructor
80         VideoFFmpeg (HRESULT * hRslt);
81         /// destructor
82         virtual ~VideoFFmpeg ();
83
84         /// set initial parameters
85         void initParams (short width, short height, float rate, bool image=false);
86         /// open video/image file
87         virtual void openFile (char * file);
88         /// open video capture device
89         virtual void openCam (char * driver, short camIdx);
90
91         /// release video source
92         virtual bool release (void);
93
94         /// play video
95         virtual bool play (void);
96         /// pause video
97         virtual bool pause (void);
98         /// stop video
99         virtual bool stop (void);
100         /// set play range
101         virtual void setRange (double start, double stop);
102         /// set frame rate
103         virtual void setFrameRate (float rate);
104         // some specific getters and setters
105         int getPreseek(void) { return m_preseek; }
106         void setPreseek(int preseek) { if (preseek >= 0) m_preseek = preseek; }
107         bool getDeinterlace(void) { return m_deinterlace; }
108         void setDeinterlace(bool deinterlace) { m_deinterlace = deinterlace; }
109         char *getImageName(void) { return (m_isImage) ? m_imageName.Ptr() : NULL; }
110
111 protected:
112         // format and codec information
113         AVCodec *m_codec;
114         AVFormatContext *m_formatCtx;
115         AVCodecContext *m_codecCtx;
116         // raw frame extracted from video file
117         AVFrame *m_frame;
118         // deinterlaced frame if codec requires it
119         AVFrame *m_frameDeinterlaced;
120         // decoded RGB24 frame if codec requires it
121         AVFrame *m_frameRGB;
122         // conversion from raw to RGB is done with sws_scale
123         struct SwsContext *m_imgConvertCtx;
124         // should the codec be deinterlaced?
125         bool m_deinterlace;
126         // number of frame of preseek
127         int m_preseek;
128         // order number of stream holding the video in format context
129         int m_videoStream;
130
131         // the actual frame rate
132         double m_baseFrameRate;
133
134         /// last displayed frame
135         long m_lastFrame;
136
137         /// end of file reached
138         bool m_eof;
139
140         /// flag to indicate that time is coming from application
141         bool m_externTime;
142
143         /// current file pointer position in file expressed in frame number
144         long m_curPosition;
145
146         /// time of video play start
147         double m_startTime;
148
149         /// width of capture in pixel
150         short m_captWidth;
151         
152         /// height of capture in pixel
153         short m_captHeight;
154
155         /// frame rate of capture in frames per seconds
156         float m_captRate;
157
158         /// is file an image?
159         bool m_isImage;
160
161         /// is image loading done in a separate thread?
162         bool m_isThreaded;
163
164         /// is streaming or camera?
165         bool m_isStreaming;
166
167         /// keep last image name
168         STR_String m_imageName;
169
170         /// image calculation
171         virtual void calcImage (unsigned int texId, double ts);
172
173         /// set actual position
174         void setPositions (void);
175
176         /// get actual framerate
177         double actFrameRate (void) { return m_frameRate * m_baseFrameRate; }
178
179         /// common function to video file and capture
180         int openStream(const char *filename, AVInputFormat *inputFormat, AVFormatParameters *formatParams);
181
182         /// check if a frame is available and load it in pFrame, return true if a frame could be retrieved
183         AVFrame* grabFrame(long frame);
184
185         /// in case of caching, put the frame back in free queue
186         void releaseFrame(AVFrame* frame);
187
188         /// start thread to load the video file/capture/stream 
189         bool startCache();
190         void stopCache();
191
192 private:
193         typedef struct {
194                 Link link;
195                 long framePosition;
196                 AVFrame *frame;
197         } CacheFrame;
198         typedef struct {
199                 Link link;
200                 AVPacket packet;
201         } CachePacket;
202
203         bool m_stopThread;
204         bool m_cacheStarted;
205         ListBase m_thread;
206         ListBase m_frameCacheBase;      // list of frames that are ready
207         ListBase m_frameCacheFree;      // list of frames that are unused
208         ListBase m_packetCacheBase;     // list of packets that are ready for decoding
209         ListBase m_packetCacheFree;     // list of packets that are unused
210         pthread_mutex_t m_cacheMutex;
211
212         AVFrame *allocFrameRGB();
213         static void *cacheThread(void *);
214 };
215
216 inline VideoFFmpeg * getFFmpeg (PyImage * self) 
217 {
218         return static_cast<VideoFFmpeg*>(self->m_image); 
219 }
220
221 #endif  //WITH_FFMPEG
222
223 #endif