== 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
35 #include "ffmpeg_compat.h"
36
37 #include "DNA_listBase.h"
38 #include "BLI_threads.h"
39 #include "BLI_blenlib.h"
40 #define __cplusplus
41 }
42
43 #if LIBAVFORMAT_VERSION_INT < (49 << 16)
44 #define FFMPEG_OLD_FRAME_RATE 1
45 #else
46 #define FFMPEG_CODEC_IS_POINTER 1
47 #endif
48
49 #if LIBAVFORMAT_VERSION_INT >= (52 << 16)
50 #define FFMPEG_PB_IS_POINTER 1
51 #endif
52
53 #ifdef FFMPEG_CODEC_IS_POINTER
54 static inline AVCodecContext* get_codec_from_stream(AVStream* stream)
55 {
56         return stream->codec;
57 }
58 #else
59 static inline AVCodecContext* get_codec_from_stream(AVStream* stream)
60 {
61         return &stream->codec;
62 }
63 #endif
64
65 #include "VideoBase.h"
66
67 #define CACHE_FRAME_SIZE        10
68 #define CACHE_PACKET_SIZE       30
69
70 // type VideoFFmpeg declaration
71 class VideoFFmpeg : public VideoBase
72 {
73 public:
74         /// constructor
75         VideoFFmpeg (HRESULT * hRslt);
76         /// destructor
77         virtual ~VideoFFmpeg ();
78
79         /// set initial parameters
80         void initParams (short width, short height, float rate, bool image=false);
81         /// open video/image file
82         virtual void openFile (char * file);
83         /// open video capture device
84         virtual void openCam (char * driver, short camIdx);
85
86         /// release video source
87         virtual bool release (void);
88
89         /// play video
90         virtual bool play (void);
91         /// pause video
92         virtual bool pause (void);
93         /// stop video
94         virtual bool stop (void);
95         /// set play range
96         virtual void setRange (double start, double stop);
97         /// set frame rate
98         virtual void setFrameRate (float rate);
99         // some specific getters and setters
100         int getPreseek(void) { return m_preseek; }
101         void setPreseek(int preseek) { if (preseek >= 0) m_preseek = preseek; }
102         bool getDeinterlace(void) { return m_deinterlace; }
103         void setDeinterlace(bool deinterlace) { m_deinterlace = deinterlace; }
104         char *getImageName(void) { return (m_isImage) ? m_imageName.Ptr() : NULL; }
105
106 protected:
107         // format and codec information
108         AVCodec *m_codec;
109         AVFormatContext *m_formatCtx;
110         AVCodecContext *m_codecCtx;
111         // raw frame extracted from video file
112         AVFrame *m_frame;
113         // deinterlaced frame if codec requires it
114         AVFrame *m_frameDeinterlaced;
115         // decoded RGB24 frame if codec requires it
116         AVFrame *m_frameRGB;
117         // conversion from raw to RGB is done with sws_scale
118         struct SwsContext *m_imgConvertCtx;
119         // should the codec be deinterlaced?
120         bool m_deinterlace;
121         // number of frame of preseek
122         int m_preseek;
123         // order number of stream holding the video in format context
124         int m_videoStream;
125
126         // the actual frame rate
127         double m_baseFrameRate;
128
129         /// last displayed frame
130         long m_lastFrame;
131
132         /// end of file reached
133         bool m_eof;
134
135         /// flag to indicate that time is coming from application
136         bool m_externTime;
137
138         /// current file pointer position in file expressed in frame number
139         long m_curPosition;
140
141         /// time of video play start
142         double m_startTime;
143
144         /// width of capture in pixel
145         short m_captWidth;
146         
147         /// height of capture in pixel
148         short m_captHeight;
149
150         /// frame rate of capture in frames per seconds
151         float m_captRate;
152
153         /// is file an image?
154         bool m_isImage;
155
156         /// is image loading done in a separate thread?
157         bool m_isThreaded;
158
159         /// is streaming or camera?
160         bool m_isStreaming;
161
162         /// keep last image name
163         STR_String m_imageName;
164
165         /// image calculation
166         virtual void calcImage (unsigned int texId, double ts);
167
168         /// set actual position
169         void setPositions (void);
170
171         /// get actual framerate
172         double actFrameRate (void) { return m_frameRate * m_baseFrameRate; }
173
174         /// common function to video file and capture
175         int openStream(const char *filename, AVInputFormat *inputFormat, AVFormatParameters *formatParams);
176
177         /// check if a frame is available and load it in pFrame, return true if a frame could be retrieved
178         AVFrame* grabFrame(long frame);
179
180         /// in case of caching, put the frame back in free queue
181         void releaseFrame(AVFrame* frame);
182
183         /// start thread to load the video file/capture/stream 
184         bool startCache();
185         void stopCache();
186
187 private:
188         typedef struct {
189                 Link link;
190                 long framePosition;
191                 AVFrame *frame;
192         } CacheFrame;
193         typedef struct {
194                 Link link;
195                 AVPacket packet;
196         } CachePacket;
197
198         bool m_stopThread;
199         bool m_cacheStarted;
200         ListBase m_thread;
201         ListBase m_frameCacheBase;      // list of frames that are ready
202         ListBase m_frameCacheFree;      // list of frames that are unused
203         ListBase m_packetCacheBase;     // list of packets that are ready for decoding
204         ListBase m_packetCacheFree;     // list of packets that are unused
205         pthread_mutex_t m_cacheMutex;
206
207         AVFrame *allocFrameRGB();
208         static void *cacheThread(void *);
209 };
210
211 inline VideoFFmpeg * getFFmpeg (PyImage * self) 
212 {
213         return static_cast<VideoFFmpeg*>(self->m_image); 
214 }
215
216 #endif  //WITH_FFMPEG
217
218 #endif