copy of docs from 2.4x for python modules that have been kept
[blender.git] / source / blender / blenkernel / intern / writeavi.c
1 /**
2  * Functions for writing avi-format files.
3  * Added interface for generic movie support (ton)
4  *
5  * $Id$
6  *
7  * ***** BEGIN GPL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): Robert Wenzlaff
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  * 
32  */
33
34 #include <string.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_scene_types.h"
39
40 #include "BLI_blenlib.h"
41
42 #include "BKE_global.h"
43 #include "BKE_report.h"
44 #include "BKE_utildefines.h"
45 #include "BKE_writeavi.h"
46 #include "AVI_avi.h"
47
48 /* callbacks */
49 static int start_avi(Scene *scene, RenderData *rd, int rectx, int recty, ReportList *reports);
50 static void end_avi(void);
51 static int append_avi(RenderData *rd, int frame, int *pixels, int rectx, int recty, ReportList *reports);
52 static void filepath_avi(char *string, RenderData *rd);
53
54 /* ********************** general blender movie support ***************************** */
55
56 #ifdef WITH_QUICKTIME
57 #include "quicktime_export.h"
58 #endif
59
60 #ifdef WITH_FFMPEG
61 #include "BKE_writeffmpeg.h"
62 #endif
63
64 #include "BKE_writeframeserver.h"
65
66 bMovieHandle *BKE_get_movie_handle(int imtype)
67 {
68         static bMovieHandle mh;
69         
70         /* set the default handle, as builtin */
71         mh.start_movie= start_avi;
72         mh.append_movie= append_avi;
73         mh.end_movie= end_avi;
74         mh.get_next_frame = NULL;
75         mh.get_movie_path = filepath_avi;
76         
77         /* do the platform specific handles */
78 #ifdef __sgi
79         if (imtype == R_MOVIE) {
80                 
81         }
82 #endif
83 #if defined(_WIN32) && !defined(FREE_WINDOWS)
84         if (imtype == R_AVICODEC) {             
85                 //XXX mh.start_movie= start_avi_codec;
86                 //XXX mh.append_movie= append_avi_codec;
87                 //XXX mh.end_movie= end_avi_codec;
88         }
89 #endif
90 #ifdef WITH_QUICKTIME
91         if (imtype == R_QUICKTIME) {
92                 mh.start_movie= start_qt;
93                 mh.append_movie= append_qt;
94                 mh.end_movie= end_qt;
95                 mh.get_movie_path = filepath_qt;
96         }
97 #endif
98 #ifdef WITH_FFMPEG
99         if (ELEM4(imtype, R_FFMPEG, R_H264, R_XVID, R_THEORA)) {
100                 mh.start_movie = start_ffmpeg;
101                 mh.append_movie = append_ffmpeg;
102                 mh.end_movie = end_ffmpeg;
103                 mh.get_movie_path = filepath_ffmpeg;
104         }
105 #endif
106         if (imtype == R_FRAMESERVER) {
107                 mh.start_movie = start_frameserver;
108                 mh.append_movie = append_frameserver;
109                 mh.end_movie = end_frameserver;
110                 mh.get_next_frame = frameserver_loop;
111         }
112         
113         return &mh;
114 }
115
116 /* ****************************************************************** */
117
118
119 static AviMovie *avi=NULL;
120 static int sframe;
121
122 static void filepath_avi (char *string, RenderData *rd)
123 {
124         char txt[64];
125
126         if (string==0) return;
127
128         strcpy(string, rd->pic);
129         BLI_convertstringcode(string, G.sce);
130
131         BLI_make_existing_file(string);
132
133         if (BLI_strcasecmp(string + strlen(string) - 4, ".avi")) {
134                 sprintf(txt, "%04d_%04d.avi", (rd->sfra) , (rd->efra) );
135                 strcat(string, txt);
136         }
137 }
138
139 static int start_avi(Scene *scene, RenderData *rd, int rectx, int recty, ReportList *reports)
140 {
141         int x, y;
142         char name[256];
143         AviFormat format;
144         int quality;
145         double framerate;
146         
147         filepath_avi(name, rd);
148
149         sframe = (rd->sfra);
150         x = rectx;
151         y = recty;
152
153         quality= rd->quality;
154         framerate= (double) rd->frs_sec / (double) rd->frs_sec_base;
155         
156         avi = MEM_mallocN (sizeof(AviMovie), "avimovie");
157
158         /* RPW 11-21-2002 
159          if (rd->imtype != AVI_FORMAT_MJPEG) format = AVI_FORMAT_AVI_RGB;
160         */
161         if (rd->imtype != R_AVIJPEG ) format = AVI_FORMAT_AVI_RGB;
162         else format = AVI_FORMAT_MJPEG;
163
164         if (AVI_open_compress (name, avi, 1, format) != AVI_ERROR_NONE) {
165                 BKE_report(reports, RPT_ERROR, "Cannot open or start AVI movie file.");
166                 MEM_freeN (avi);
167                 avi = NULL;
168                 return 0;
169         }
170                         
171         AVI_set_compress_option (avi, AVI_OPTION_TYPE_MAIN, 0, AVI_OPTION_WIDTH, &x);
172         AVI_set_compress_option (avi, AVI_OPTION_TYPE_MAIN, 0, AVI_OPTION_HEIGHT, &y);
173         AVI_set_compress_option (avi, AVI_OPTION_TYPE_MAIN, 0, AVI_OPTION_QUALITY, &quality);           
174         AVI_set_compress_option (avi, AVI_OPTION_TYPE_MAIN, 0, AVI_OPTION_FRAMERATE, &framerate);
175
176         avi->interlace= 0;
177         avi->odd_fields= 0;
178 /*      avi->interlace= rd->mode & R_FIELDS; */
179 /*      avi->odd_fields= (rd->mode & R_ODDFIELD)?1:0; */
180         
181         printf("Created avi: %s\n", name);
182         return 1;
183 }
184
185 static int append_avi(RenderData *rd, int frame, int *pixels, int rectx, int recty, ReportList *reports)
186 {
187         unsigned int *rt1, *rt2, *rectot;
188         int x, y;
189         char *cp, rt;
190         
191         if (avi == NULL)
192                 return 0;
193
194         /* note that libavi free's the buffer... stupid interface - zr */
195         rectot= MEM_mallocN(rectx*recty*sizeof(int), "rectot");
196         rt1= rectot;
197         rt2= (unsigned int*)pixels + (recty-1)*rectx;
198         /* flip y and convert to abgr */
199         for (y=0; y < recty; y++, rt1+= rectx, rt2-= rectx) {
200                 memcpy (rt1, rt2, rectx*sizeof(int));
201                 
202                 cp= (char *)rt1;
203                 for(x= rectx; x>0; x--) {
204                         rt= cp[0];
205                         cp[0]= cp[3];
206                         cp[3]= rt;
207                         rt= cp[1];
208                         cp[1]= cp[2];
209                         cp[2]= rt;
210                         cp+= 4;
211                 }
212         }
213         
214         AVI_write_frame (avi, (frame-sframe), AVI_FORMAT_RGB32, rectot, rectx*recty*4);
215 //      printf ("added frame %3d (frame %3d in avi): ", frame, frame-sframe);
216
217         return 1;
218 }
219
220 void end_avi(void)
221 {
222         if (avi == NULL) return;
223
224         AVI_close_compress (avi);
225         MEM_freeN (avi);
226         avi= NULL;
227 }
228
229 /* similar to BKE_makepicstring() */
230 void BKE_makeanimstring(char *string, RenderData *rd)
231 {
232         bMovieHandle *mh= BKE_get_movie_handle(rd->imtype);
233         if(mh->get_movie_path)
234                 mh->get_movie_path(string, rd);
235         else
236                 string[0]= '\0';
237 }