45206f4df4e37e01ff2ba2024af27b08abe2cb10
[ffmpeg.git] / compat / avisynth / avisynth_c.h
1 // Avisynth C Interface Version 0.20
2 // Copyright 2003 Kevin Atkinson
3
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17 // MA 02110-1301 USA, or visit
18 // http://www.gnu.org/copyleft/gpl.html .
19 //
20 // As a special exception, I give you permission to link to the
21 // Avisynth C interface with independent modules that communicate with
22 // the Avisynth C interface solely through the interfaces defined in
23 // avisynth_c.h, regardless of the license terms of these independent
24 // modules, and to copy and distribute the resulting combined work
25 // under terms of your choice, provided that every copy of the
26 // combined work is accompanied by a complete copy of the source code
27 // of the Avisynth C interface and Avisynth itself (with the version
28 // used to produce the combined work), being distributed under the
29 // terms of the GNU General Public License plus this exception.  An
30 // independent module is a module which is not derived from or based
31 // on Avisynth C Interface, such as 3rd-party filters, import and
32 // export plugins, or graphical user interfaces.
33
34 // NOTE: this is a partial update of the Avisynth C interface to recognize
35 // new color spaces added in Avisynth 2.60. By no means is this document
36 // completely Avisynth 2.60 compliant.
37
38 #ifndef __AVISYNTH_C__
39 #define __AVISYNTH_C__
40
41 #include "avs/config.h"
42 #include "avs/capi.h"
43 #include "avs/types.h"
44
45
46 /////////////////////////////////////////////////////////////////////
47 //
48 // Constants
49 //
50
51 #ifndef __AVISYNTH_6_H__
52 enum { AVISYNTH_INTERFACE_VERSION = 6 };
53 #endif
54
55 enum {AVS_SAMPLE_INT8  = 1<<0,
56       AVS_SAMPLE_INT16 = 1<<1,
57       AVS_SAMPLE_INT24 = 1<<2,
58       AVS_SAMPLE_INT32 = 1<<3,
59       AVS_SAMPLE_FLOAT = 1<<4};
60
61 enum {AVS_PLANAR_Y=1<<0,
62       AVS_PLANAR_U=1<<1,
63       AVS_PLANAR_V=1<<2,
64       AVS_PLANAR_ALIGNED=1<<3,
65       AVS_PLANAR_Y_ALIGNED=AVS_PLANAR_Y|AVS_PLANAR_ALIGNED,
66       AVS_PLANAR_U_ALIGNED=AVS_PLANAR_U|AVS_PLANAR_ALIGNED,
67       AVS_PLANAR_V_ALIGNED=AVS_PLANAR_V|AVS_PLANAR_ALIGNED,
68       AVS_PLANAR_A=1<<4,
69       AVS_PLANAR_R=1<<5,
70       AVS_PLANAR_G=1<<6,
71       AVS_PLANAR_B=1<<7,
72       AVS_PLANAR_A_ALIGNED=AVS_PLANAR_A|AVS_PLANAR_ALIGNED,
73       AVS_PLANAR_R_ALIGNED=AVS_PLANAR_R|AVS_PLANAR_ALIGNED,
74       AVS_PLANAR_G_ALIGNED=AVS_PLANAR_G|AVS_PLANAR_ALIGNED,
75       AVS_PLANAR_B_ALIGNED=AVS_PLANAR_B|AVS_PLANAR_ALIGNED};
76
77   // Colorspace properties.
78 enum {AVS_CS_BGR = 1<<28,
79       AVS_CS_YUV = 1<<29,
80       AVS_CS_INTERLEAVED = 1<<30,
81       AVS_CS_PLANAR = 1<<31,
82
83       AVS_CS_SHIFT_SUB_WIDTH   = 0,
84       AVS_CS_SHIFT_SUB_HEIGHT  = 8,
85       AVS_CS_SHIFT_SAMPLE_BITS = 16,
86
87       AVS_CS_SUB_WIDTH_MASK    = 7 << AVS_CS_SHIFT_SUB_WIDTH,
88       AVS_CS_SUB_WIDTH_1       = 3 << AVS_CS_SHIFT_SUB_WIDTH, // YV24
89       AVS_CS_SUB_WIDTH_2       = 0 << AVS_CS_SHIFT_SUB_WIDTH, // YV12, I420, YV16
90       AVS_CS_SUB_WIDTH_4       = 1 << AVS_CS_SHIFT_SUB_WIDTH, // YUV9, YV411
91
92       AVS_CS_VPLANEFIRST       = 1 << 3, // YV12, YV16, YV24, YV411, YUV9
93       AVS_CS_UPLANEFIRST       = 1 << 4, // I420
94
95       AVS_CS_SUB_HEIGHT_MASK   = 7 << AVS_CS_SHIFT_SUB_HEIGHT,
96       AVS_CS_SUB_HEIGHT_1      = 3 << AVS_CS_SHIFT_SUB_HEIGHT, // YV16, YV24, YV411
97       AVS_CS_SUB_HEIGHT_2      = 0 << AVS_CS_SHIFT_SUB_HEIGHT, // YV12, I420
98       AVS_CS_SUB_HEIGHT_4      = 1 << AVS_CS_SHIFT_SUB_HEIGHT, // YUV9
99
100       AVS_CS_SAMPLE_BITS_MASK  = 7 << AVS_CS_SHIFT_SAMPLE_BITS,
101       AVS_CS_SAMPLE_BITS_8     = 0 << AVS_CS_SHIFT_SAMPLE_BITS,
102       AVS_CS_SAMPLE_BITS_16    = 1 << AVS_CS_SHIFT_SAMPLE_BITS,
103       AVS_CS_SAMPLE_BITS_32    = 2 << AVS_CS_SHIFT_SAMPLE_BITS,
104
105       AVS_CS_PLANAR_MASK       = AVS_CS_PLANAR | AVS_CS_INTERLEAVED | AVS_CS_YUV | AVS_CS_BGR | AVS_CS_SAMPLE_BITS_MASK | AVS_CS_SUB_HEIGHT_MASK | AVS_CS_SUB_WIDTH_MASK,
106       AVS_CS_PLANAR_FILTER     = ~( AVS_CS_VPLANEFIRST | AVS_CS_UPLANEFIRST )};
107
108   // Specific colorformats
109 enum {
110   AVS_CS_UNKNOWN = 0,
111   AVS_CS_BGR24 = 1<<0 | AVS_CS_BGR | AVS_CS_INTERLEAVED,
112   AVS_CS_BGR32 = 1<<1 | AVS_CS_BGR | AVS_CS_INTERLEAVED,
113   AVS_CS_YUY2 = 1<<2 | AVS_CS_YUV | AVS_CS_INTERLEAVED,
114   //  AVS_CS_YV12  = 1<<3  Reserved
115   //  AVS_CS_I420  = 1<<4  Reserved
116   AVS_CS_RAW32 = 1<<5 | AVS_CS_INTERLEAVED,
117
118   AVS_CS_YV24  = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_VPLANEFIRST | AVS_CS_SUB_HEIGHT_1 | AVS_CS_SUB_WIDTH_1,  // YVU 4:4:4 planar
119   AVS_CS_YV16  = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_VPLANEFIRST | AVS_CS_SUB_HEIGHT_1 | AVS_CS_SUB_WIDTH_2,  // YVU 4:2:2 planar
120   AVS_CS_YV12  = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_VPLANEFIRST | AVS_CS_SUB_HEIGHT_2 | AVS_CS_SUB_WIDTH_2,  // YVU 4:2:0 planar
121   AVS_CS_I420  = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_UPLANEFIRST | AVS_CS_SUB_HEIGHT_2 | AVS_CS_SUB_WIDTH_2,  // YUV 4:2:0 planar
122   AVS_CS_IYUV  = AVS_CS_I420,
123   AVS_CS_YV411 = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_VPLANEFIRST | AVS_CS_SUB_HEIGHT_1 | AVS_CS_SUB_WIDTH_4,  // YVU 4:1:1 planar
124   AVS_CS_YUV9  = AVS_CS_PLANAR | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8 | AVS_CS_VPLANEFIRST | AVS_CS_SUB_HEIGHT_4 | AVS_CS_SUB_WIDTH_4,  // YVU 4:1:0 planar
125   AVS_CS_Y8    = AVS_CS_PLANAR | AVS_CS_INTERLEAVED | AVS_CS_YUV | AVS_CS_SAMPLE_BITS_8                                              // Y   4:0:0 planar
126 };
127
128 enum {
129   AVS_IT_BFF = 1<<0,
130   AVS_IT_TFF = 1<<1,
131   AVS_IT_FIELDBASED = 1<<2};
132
133 enum {
134   AVS_FILTER_TYPE=1,
135   AVS_FILTER_INPUT_COLORSPACE=2,
136   AVS_FILTER_OUTPUT_TYPE=9,
137   AVS_FILTER_NAME=4,
138   AVS_FILTER_AUTHOR=5,
139   AVS_FILTER_VERSION=6,
140   AVS_FILTER_ARGS=7,
141   AVS_FILTER_ARGS_INFO=8,
142   AVS_FILTER_ARGS_DESCRIPTION=10,
143   AVS_FILTER_DESCRIPTION=11};
144
145 enum {  //SUBTYPES
146   AVS_FILTER_TYPE_AUDIO=1,
147   AVS_FILTER_TYPE_VIDEO=2,
148   AVS_FILTER_OUTPUT_TYPE_SAME=3,
149   AVS_FILTER_OUTPUT_TYPE_DIFFERENT=4};
150
151 enum {
152   // New 2.6 explicitly defined cache hints.
153   AVS_CACHE_NOTHING=10, // Do not cache video.
154   AVS_CACHE_WINDOW=11, // Hard protect upto X frames within a range of X from the current frame N.
155   AVS_CACHE_GENERIC=12, // LRU cache upto X frames.
156   AVS_CACHE_FORCE_GENERIC=13, // LRU cache upto X frames, override any previous CACHE_WINDOW.
157
158   AVS_CACHE_GET_POLICY=30, // Get the current policy.
159   AVS_CACHE_GET_WINDOW=31, // Get the current window h_span.
160   AVS_CACHE_GET_RANGE=32, // Get the current generic frame range.
161
162   AVS_CACHE_AUDIO=50, // Explicitly do cache audio, X byte cache.
163   AVS_CACHE_AUDIO_NOTHING=51, // Explicitly do not cache audio.
164   AVS_CACHE_AUDIO_NONE=52, // Audio cache off (auto mode), X byte intial cache.
165   AVS_CACHE_AUDIO_AUTO=53, // Audio cache on (auto mode), X byte intial cache.
166
167   AVS_CACHE_GET_AUDIO_POLICY=70, // Get the current audio policy.
168   AVS_CACHE_GET_AUDIO_SIZE=71, // Get the current audio cache size.
169
170   AVS_CACHE_PREFETCH_FRAME=100, // Queue request to prefetch frame N.
171   AVS_CACHE_PREFETCH_GO=101, // Action video prefetches.
172
173   AVS_CACHE_PREFETCH_AUDIO_BEGIN=120, // Begin queue request transaction to prefetch audio (take critical section).
174   AVS_CACHE_PREFETCH_AUDIO_STARTLO=121, // Set low 32 bits of start.
175   AVS_CACHE_PREFETCH_AUDIO_STARTHI=122, // Set high 32 bits of start.
176   AVS_CACHE_PREFETCH_AUDIO_COUNT=123, // Set low 32 bits of length.
177   AVS_CACHE_PREFETCH_AUDIO_COMMIT=124, // Enqueue request transaction to prefetch audio (release critical section).
178   AVS_CACHE_PREFETCH_AUDIO_GO=125, // Action audio prefetches.
179
180   AVS_CACHE_GETCHILD_CACHE_MODE=200, // Cache ask Child for desired video cache mode.
181   AVS_CACHE_GETCHILD_CACHE_SIZE=201, // Cache ask Child for desired video cache size.
182   AVS_CACHE_GETCHILD_AUDIO_MODE=202, // Cache ask Child for desired audio cache mode.
183   AVS_CACHE_GETCHILD_AUDIO_SIZE=203, // Cache ask Child for desired audio cache size.
184
185   AVS_CACHE_GETCHILD_COST=220, // Cache ask Child for estimated processing cost.
186     AVS_CACHE_COST_ZERO=221, // Child response of zero cost (ptr arithmetic only).
187     AVS_CACHE_COST_UNIT=222, // Child response of unit cost (less than or equal 1 full frame blit).
188     AVS_CACHE_COST_LOW=223, // Child response of light cost. (Fast)
189     AVS_CACHE_COST_MED=224, // Child response of medium cost. (Real time)
190     AVS_CACHE_COST_HI=225, // Child response of heavy cost. (Slow)
191
192   AVS_CACHE_GETCHILD_THREAD_MODE=240, // Cache ask Child for thread safetyness.
193     AVS_CACHE_THREAD_UNSAFE=241, // Only 1 thread allowed for all instances. 2.5 filters default!
194     AVS_CACHE_THREAD_CLASS=242, // Only 1 thread allowed for each instance. 2.6 filters default!
195     AVS_CACHE_THREAD_SAFE=243, //  Allow all threads in any instance.
196     AVS_CACHE_THREAD_OWN=244, // Safe but limit to 1 thread, internally threaded.
197
198   AVS_CACHE_GETCHILD_ACCESS_COST=260, // Cache ask Child for preferred access pattern.
199     AVS_CACHE_ACCESS_RAND=261, // Filter is access order agnostic.
200     AVS_CACHE_ACCESS_SEQ0=262, // Filter prefers sequential access (low cost)
201     AVS_CACHE_ACCESS_SEQ1=263, // Filter needs sequential access (high cost)
202   };
203
204 #ifdef BUILDING_AVSCORE
205 struct AVS_ScriptEnvironment {
206         IScriptEnvironment * env;
207         const char * error;
208         AVS_ScriptEnvironment(IScriptEnvironment * e = 0)
209                 : env(e), error(0) {}
210 };
211 #endif
212
213 typedef struct AVS_Clip AVS_Clip;
214 typedef struct AVS_ScriptEnvironment AVS_ScriptEnvironment;
215
216 /////////////////////////////////////////////////////////////////////
217 //
218 // AVS_VideoInfo
219 //
220
221 // AVS_VideoInfo is layed out identicly to VideoInfo
222 typedef struct AVS_VideoInfo {
223   int width, height;    // width=0 means no video
224   unsigned fps_numerator, fps_denominator;
225   int num_frames;
226
227   int pixel_type;
228
229   int audio_samples_per_second;   // 0 means no audio
230   int sample_type;
231   INT64 num_audio_samples;
232   int nchannels;
233
234   // Imagetype properties
235
236   int image_type;
237 } AVS_VideoInfo;
238
239 // useful functions of the above
240 AVSC_INLINE int avs_has_video(const AVS_VideoInfo * p)
241         { return (p->width!=0); }
242
243 AVSC_INLINE int avs_has_audio(const AVS_VideoInfo * p)
244         { return (p->audio_samples_per_second!=0); }
245
246 AVSC_INLINE int avs_is_rgb(const AVS_VideoInfo * p)
247         { return !!(p->pixel_type&AVS_CS_BGR); }
248
249 AVSC_INLINE int avs_is_rgb24(const AVS_VideoInfo * p)
250         { return (p->pixel_type&AVS_CS_BGR24)==AVS_CS_BGR24; } // Clear out additional properties
251
252 AVSC_INLINE int avs_is_rgb32(const AVS_VideoInfo * p)
253         { return (p->pixel_type & AVS_CS_BGR32) == AVS_CS_BGR32 ; }
254
255 AVSC_INLINE int avs_is_yuv(const AVS_VideoInfo * p)
256         { return !!(p->pixel_type&AVS_CS_YUV ); }
257
258 AVSC_INLINE int avs_is_yuy2(const AVS_VideoInfo * p)
259         { return (p->pixel_type & AVS_CS_YUY2) == AVS_CS_YUY2; }
260
261 AVSC_API(int, avs_is_yv24)(const AVS_VideoInfo * p);
262
263 AVSC_API(int, avs_is_yv16)(const AVS_VideoInfo * p);
264
265 AVSC_API(int, avs_is_yv12)(const AVS_VideoInfo * p) ;
266
267 AVSC_API(int, avs_is_yv411)(const AVS_VideoInfo * p);
268
269 AVSC_API(int, avs_is_y8)(const AVS_VideoInfo * p);
270
271 AVSC_INLINE int avs_is_property(const AVS_VideoInfo * p, int property)
272         { return ((p->image_type & property)==property ); }
273
274 AVSC_INLINE int avs_is_planar(const AVS_VideoInfo * p)
275         { return !!(p->pixel_type & AVS_CS_PLANAR); }
276
277 AVSC_API(int, avs_is_color_space)(const AVS_VideoInfo * p, int c_space);
278
279 AVSC_INLINE int avs_is_field_based(const AVS_VideoInfo * p)
280         { return !!(p->image_type & AVS_IT_FIELDBASED); }
281
282 AVSC_INLINE int avs_is_parity_known(const AVS_VideoInfo * p)
283         { return ((p->image_type & AVS_IT_FIELDBASED)&&(p->image_type & (AVS_IT_BFF | AVS_IT_TFF))); }
284
285 AVSC_INLINE int avs_is_bff(const AVS_VideoInfo * p)
286         { return !!(p->image_type & AVS_IT_BFF); }
287
288 AVSC_INLINE int avs_is_tff(const AVS_VideoInfo * p)
289         { return !!(p->image_type & AVS_IT_TFF); }
290
291 AVSC_API(int, avs_get_plane_width_subsampling)(const AVS_VideoInfo * p, int plane);
292
293 AVSC_API(int, avs_get_plane_height_subsampling)(const AVS_VideoInfo * p, int plane);
294
295
296 AVSC_API(int, avs_bits_per_pixel)(const AVS_VideoInfo * p);
297
298 AVSC_API(int, avs_bytes_from_pixels)(const AVS_VideoInfo * p, int pixels);
299
300 AVSC_API(int, avs_row_size)(const AVS_VideoInfo * p, int plane);
301
302 AVSC_API(int, avs_bmp_size)(const AVS_VideoInfo * vi);
303
304 AVSC_INLINE int avs_samples_per_second(const AVS_VideoInfo * p)
305         { return p->audio_samples_per_second; }
306
307
308 AVSC_INLINE int avs_bytes_per_channel_sample(const AVS_VideoInfo * p)
309 {
310     switch (p->sample_type) {
311       case AVS_SAMPLE_INT8:  return sizeof(signed char);
312       case AVS_SAMPLE_INT16: return sizeof(signed short);
313       case AVS_SAMPLE_INT24: return 3;
314       case AVS_SAMPLE_INT32: return sizeof(signed int);
315       case AVS_SAMPLE_FLOAT: return sizeof(float);
316       default: return 0;
317     }
318 }
319 AVSC_INLINE int avs_bytes_per_audio_sample(const AVS_VideoInfo * p)
320         { return p->nchannels*avs_bytes_per_channel_sample(p);}
321
322 AVSC_INLINE INT64 avs_audio_samples_from_frames(const AVS_VideoInfo * p, INT64 frames)
323         { return ((INT64)(frames) * p->audio_samples_per_second * p->fps_denominator / p->fps_numerator); }
324
325 AVSC_INLINE int avs_frames_from_audio_samples(const AVS_VideoInfo * p, INT64 samples)
326         { return (int)(samples * (INT64)p->fps_numerator / (INT64)p->fps_denominator / (INT64)p->audio_samples_per_second); }
327
328 AVSC_INLINE INT64 avs_audio_samples_from_bytes(const AVS_VideoInfo * p, INT64 bytes)
329         { return bytes / avs_bytes_per_audio_sample(p); }
330
331 AVSC_INLINE INT64 avs_bytes_from_audio_samples(const AVS_VideoInfo * p, INT64 samples)
332         { return samples * avs_bytes_per_audio_sample(p); }
333
334 AVSC_INLINE int avs_audio_channels(const AVS_VideoInfo * p)
335         { return p->nchannels; }
336
337 AVSC_INLINE int avs_sample_type(const AVS_VideoInfo * p)
338         { return p->sample_type;}
339
340 // useful mutator
341 AVSC_INLINE void avs_set_property(AVS_VideoInfo * p, int property)
342         { p->image_type|=property; }
343
344 AVSC_INLINE void avs_clear_property(AVS_VideoInfo * p, int property)
345         { p->image_type&=~property; }
346
347 AVSC_INLINE void avs_set_field_based(AVS_VideoInfo * p, int isfieldbased)
348         { if (isfieldbased) p->image_type|=AVS_IT_FIELDBASED; else p->image_type&=~AVS_IT_FIELDBASED; }
349
350 AVSC_INLINE void avs_set_fps(AVS_VideoInfo * p, unsigned numerator, unsigned denominator)
351 {
352     unsigned x=numerator, y=denominator;
353     while (y) {   // find gcd
354       unsigned t = x%y; x = y; y = t;
355     }
356     p->fps_numerator = numerator/x;
357     p->fps_denominator = denominator/x;
358 }
359
360 AVSC_INLINE int avs_is_same_colorspace(AVS_VideoInfo * x, AVS_VideoInfo * y)
361 {
362         return (x->pixel_type == y->pixel_type)
363                 || (avs_is_yv12(x) && avs_is_yv12(y));
364 }
365
366 /////////////////////////////////////////////////////////////////////
367 //
368 // AVS_VideoFrame
369 //
370
371 // VideoFrameBuffer holds information about a memory block which is used
372 // for video data.  For efficiency, instances of this class are not deleted
373 // when the refcount reaches zero; instead they're stored in a linked list
374 // to be reused.  The instances are deleted when the corresponding AVS
375 // file is closed.
376
377 // AVS_VideoFrameBuffer is layed out identicly to VideoFrameBuffer
378 // DO NOT USE THIS STRUCTURE DIRECTLY
379 typedef struct AVS_VideoFrameBuffer {
380   BYTE * data;
381   int data_size;
382   // sequence_number is incremented every time the buffer is changed, so
383   // that stale views can tell they're no longer valid.
384   volatile long sequence_number;
385
386   volatile long refcount;
387 } AVS_VideoFrameBuffer;
388
389 // VideoFrame holds a "window" into a VideoFrameBuffer.
390
391 // AVS_VideoFrame is layed out identicly to IVideoFrame
392 // DO NOT USE THIS STRUCTURE DIRECTLY
393 typedef struct AVS_VideoFrame {
394   volatile long refcount;
395   AVS_VideoFrameBuffer * vfb;
396   int offset, pitch, row_size, height, offsetU, offsetV, pitchUV;  // U&V offsets are from top of picture.
397   int row_sizeUV, heightUV;
398 } AVS_VideoFrame;
399
400 // Access functions for AVS_VideoFrame
401 AVSC_API(int, avs_get_pitch_p)(const AVS_VideoFrame * p, int plane);
402
403 AVSC_INLINE int avs_get_pitch(const AVS_VideoFrame * p) {
404         return avs_get_pitch_p(p, 0);}
405
406 AVSC_API(int, avs_get_row_size_p)(const AVS_VideoFrame * p, int plane);
407
408 AVSC_INLINE int avs_get_row_size(const AVS_VideoFrame * p) {
409         return p->row_size; }
410
411 AVSC_API(int, avs_get_height_p)(const AVS_VideoFrame * p, int plane);
412
413 AVSC_INLINE int avs_get_height(const AVS_VideoFrame * p) {
414         return p->height;}
415
416 AVSC_API(const BYTE *, avs_get_read_ptr_p)(const AVS_VideoFrame * p, int plane);
417
418 AVSC_INLINE const BYTE* avs_get_read_ptr(const AVS_VideoFrame * p) {
419         return avs_get_read_ptr_p(p, 0);}
420
421 AVSC_API(int, avs_is_writable)(const AVS_VideoFrame * p);
422
423 AVSC_API(BYTE *, avs_get_write_ptr_p)(const AVS_VideoFrame * p, int plane);
424
425 AVSC_INLINE BYTE* avs_get_write_ptr(const AVS_VideoFrame * p) {
426         return avs_get_write_ptr_p(p, 0);}
427
428 AVSC_API(void, avs_release_video_frame)(AVS_VideoFrame *);
429 // makes a shallow copy of a video frame
430 AVSC_API(AVS_VideoFrame *, avs_copy_video_frame)(AVS_VideoFrame *);
431
432 #ifndef AVSC_NO_DECLSPEC
433 AVSC_INLINE void avs_release_frame(AVS_VideoFrame * f)
434   {avs_release_video_frame(f);}
435 AVSC_INLINE AVS_VideoFrame * avs_copy_frame(AVS_VideoFrame * f)
436   {return avs_copy_video_frame(f);}
437 #endif
438
439 /////////////////////////////////////////////////////////////////////
440 //
441 // AVS_Value
442 //
443
444 // Treat AVS_Value as a fat pointer.  That is use avs_copy_value
445 // and avs_release_value appropiaty as you would if AVS_Value was
446 // a pointer.
447
448 // To maintain source code compatibility with future versions of the
449 // avisynth_c API don't use the AVS_Value directly.  Use the helper
450 // functions below.
451
452 // AVS_Value is layed out identicly to AVSValue
453 typedef struct AVS_Value AVS_Value;
454 struct AVS_Value {
455   short type;  // 'a'rray, 'c'lip, 'b'ool, 'i'nt, 'f'loat, 's'tring, 'v'oid, or 'l'ong
456                // for some function e'rror
457   short array_size;
458   union {
459     void * clip; // do not use directly, use avs_take_clip
460     char boolean;
461     int integer;
462     float floating_pt;
463     const char * string;
464     const AVS_Value * array;
465   } d;
466 };
467
468 // AVS_Value should be initilized with avs_void.
469 // Should also set to avs_void after the value is released
470 // with avs_copy_value.  Consider it the equalvent of setting
471 // a pointer to NULL
472 static const AVS_Value avs_void = {'v'};
473
474 AVSC_API(void, avs_copy_value)(AVS_Value * dest, AVS_Value src);
475 AVSC_API(void, avs_release_value)(AVS_Value);
476
477 AVSC_INLINE int avs_defined(AVS_Value v) { return v.type != 'v'; }
478 AVSC_INLINE int avs_is_clip(AVS_Value v) { return v.type == 'c'; }
479 AVSC_INLINE int avs_is_bool(AVS_Value v) { return v.type == 'b'; }
480 AVSC_INLINE int avs_is_int(AVS_Value v) { return v.type == 'i'; }
481 AVSC_INLINE int avs_is_float(AVS_Value v) { return v.type == 'f' || v.type == 'i'; }
482 AVSC_INLINE int avs_is_string(AVS_Value v) { return v.type == 's'; }
483 AVSC_INLINE int avs_is_array(AVS_Value v) { return v.type == 'a'; }
484 AVSC_INLINE int avs_is_error(AVS_Value v) { return v.type == 'e'; }
485
486 AVSC_API(AVS_Clip *, avs_take_clip)(AVS_Value, AVS_ScriptEnvironment *);
487 AVSC_API(void, avs_set_to_clip)(AVS_Value *, AVS_Clip *);
488
489 AVSC_INLINE int avs_as_bool(AVS_Value v)
490         { return v.d.boolean; }
491 AVSC_INLINE int avs_as_int(AVS_Value v)
492         { return v.d.integer; }
493 AVSC_INLINE const char * avs_as_string(AVS_Value v)
494         { return avs_is_error(v) || avs_is_string(v) ? v.d.string : 0; }
495 AVSC_INLINE double avs_as_float(AVS_Value v)
496         { return avs_is_int(v) ? v.d.integer : v.d.floating_pt; }
497 AVSC_INLINE const char * avs_as_error(AVS_Value v)
498         { return avs_is_error(v) ? v.d.string : 0; }
499 AVSC_INLINE const AVS_Value * avs_as_array(AVS_Value v)
500         { return v.d.array; }
501 AVSC_INLINE int avs_array_size(AVS_Value v)
502         { return avs_is_array(v) ? v.array_size : 1; }
503 AVSC_INLINE AVS_Value avs_array_elt(AVS_Value v, int index)
504         { return avs_is_array(v) ? v.d.array[index] : v; }
505
506 // only use these functions on an AVS_Value that does not already have
507 // an active value.  Remember, treat AVS_Value as a fat pointer.
508 AVSC_INLINE AVS_Value avs_new_value_bool(int v0)
509         { AVS_Value v; v.type = 'b'; v.d.boolean = v0 == 0 ? 0 : 1; return v; }
510 AVSC_INLINE AVS_Value avs_new_value_int(int v0)
511         { AVS_Value v; v.type = 'i'; v.d.integer = v0; return v; }
512 AVSC_INLINE AVS_Value avs_new_value_string(const char * v0)
513         { AVS_Value v; v.type = 's'; v.d.string = v0; return v; }
514 AVSC_INLINE AVS_Value avs_new_value_float(float v0)
515         { AVS_Value v; v.type = 'f'; v.d.floating_pt = v0; return v;}
516 AVSC_INLINE AVS_Value avs_new_value_error(const char * v0)
517         { AVS_Value v; v.type = 'e'; v.d.string = v0; return v; }
518 #ifndef AVSC_NO_DECLSPEC
519 AVSC_INLINE AVS_Value avs_new_value_clip(AVS_Clip * v0)
520         { AVS_Value v; avs_set_to_clip(&v, v0); return v; }
521 #endif
522 AVSC_INLINE AVS_Value avs_new_value_array(AVS_Value * v0, int size)
523         { AVS_Value v; v.type = 'a'; v.d.array = v0; v.array_size = size; return v; }
524
525 /////////////////////////////////////////////////////////////////////
526 //
527 // AVS_Clip
528 //
529
530 AVSC_API(void, avs_release_clip)(AVS_Clip *);
531 AVSC_API(AVS_Clip *, avs_copy_clip)(AVS_Clip *);
532
533 AVSC_API(const char *, avs_clip_get_error)(AVS_Clip *); // return 0 if no error
534
535 AVSC_API(const AVS_VideoInfo *, avs_get_video_info)(AVS_Clip *);
536
537 AVSC_API(int, avs_get_version)(AVS_Clip *);
538
539 AVSC_API(AVS_VideoFrame *, avs_get_frame)(AVS_Clip *, int n);
540 // The returned video frame must be released with avs_release_video_frame
541
542 AVSC_API(int, avs_get_parity)(AVS_Clip *, int n);
543 // return field parity if field_based, else parity of first field in frame
544
545 AVSC_API(int, avs_get_audio)(AVS_Clip *, void * buf,
546                              INT64 start, INT64 count);
547 // start and count are in samples
548
549 AVSC_API(int, avs_set_cache_hints)(AVS_Clip *,
550                                    int cachehints, int frame_range);
551
552 // This is the callback type used by avs_add_function
553 typedef AVS_Value (AVSC_CC * AVS_ApplyFunc)
554                         (AVS_ScriptEnvironment *, AVS_Value args, void * user_data);
555
556 typedef struct AVS_FilterInfo AVS_FilterInfo;
557 struct AVS_FilterInfo
558 {
559   // these members should not be modified outside of the AVS_ApplyFunc callback
560   AVS_Clip * child;
561   AVS_VideoInfo vi;
562   AVS_ScriptEnvironment * env;
563   AVS_VideoFrame * (AVSC_CC * get_frame)(AVS_FilterInfo *, int n);
564   int (AVSC_CC * get_parity)(AVS_FilterInfo *, int n);
565   int (AVSC_CC * get_audio)(AVS_FilterInfo *, void * buf,
566                                   INT64 start, INT64 count);
567   int (AVSC_CC * set_cache_hints)(AVS_FilterInfo *, int cachehints,
568                                         int frame_range);
569   void (AVSC_CC * free_filter)(AVS_FilterInfo *);
570
571   // Should be set when ever there is an error to report.
572   // It is cleared before any of the above methods are called
573   const char * error;
574   // this is to store whatever and may be modified at will
575   void * user_data;
576 };
577
578 // Create a new filter
579 // fi is set to point to the AVS_FilterInfo so that you can
580 //   modify it once it is initilized.
581 // store_child should generally be set to true.  If it is not
582 //    set than ALL methods (the function pointers) must be defined
583 // If it is set than you do not need to worry about freeing the child
584 //    clip.
585 AVSC_API(AVS_Clip *, avs_new_c_filter)(AVS_ScriptEnvironment * e,
586                                        AVS_FilterInfo * * fi,
587                                        AVS_Value child, int store_child);
588
589 /////////////////////////////////////////////////////////////////////
590 //
591 // AVS_ScriptEnvironment
592 //
593
594 // For GetCPUFlags.  These are backwards-compatible with those in VirtualDub.
595 enum {
596                                 /* slowest CPU to support extension */
597   AVS_CPU_FORCE        = 0x01,   // N/A
598   AVS_CPU_FPU          = 0x02,   // 386/486DX
599   AVS_CPU_MMX          = 0x04,   // P55C, K6, PII
600   AVS_CPU_INTEGER_SSE  = 0x08,   // PIII, Athlon
601   AVS_CPU_SSE          = 0x10,   // PIII, Athlon XP/MP
602   AVS_CPU_SSE2         = 0x20,   // PIV, Hammer
603   AVS_CPU_3DNOW        = 0x40,   // K6-2
604   AVS_CPU_3DNOW_EXT    = 0x80,   // Athlon
605   AVS_CPU_X86_64       = 0xA0,   // Hammer (note: equiv. to 3DNow + SSE2,
606                                  // which only Hammer will have anyway)
607   AVS_CPUF_SSE3       = 0x100,   //  PIV+, K8 Venice
608   AVS_CPUF_SSSE3      = 0x200,   //  Core 2
609   AVS_CPUF_SSE4       = 0x400,   //  Penryn, Wolfdale, Yorkfield
610   AVS_CPUF_SSE4_1     = 0x400,
611 //AVS_CPUF_AVX        = 0x800,   //  Sandy Bridge, Bulldozer
612   AVS_CPUF_SSE4_2    = 0x1000,   //  Nehalem
613 //AVS_CPUF_AVX2      = 0x2000,   //  Haswell
614 //AVS_CPUF_AVX512    = 0x4000,   //  Knights Landing
615 };
616
617
618 AVSC_API(const char *, avs_get_error)(AVS_ScriptEnvironment *); // return 0 if no error
619
620 AVSC_API(int, avs_get_cpu_flags)(AVS_ScriptEnvironment *);
621 AVSC_API(int, avs_check_version)(AVS_ScriptEnvironment *, int version);
622
623 AVSC_API(char *, avs_save_string)(AVS_ScriptEnvironment *, const char* s, int length);
624 AVSC_API(char *, avs_sprintf)(AVS_ScriptEnvironment *, const char * fmt, ...);
625
626 AVSC_API(char *, avs_vsprintf)(AVS_ScriptEnvironment *, const char * fmt, void* val);
627  // note: val is really a va_list; I hope everyone typedefs va_list to a pointer
628
629 AVSC_API(int, avs_add_function)(AVS_ScriptEnvironment *,
630                                 const char * name, const char * params,
631                                 AVS_ApplyFunc apply, void * user_data);
632
633 AVSC_API(int, avs_function_exists)(AVS_ScriptEnvironment *, const char * name);
634
635 AVSC_API(AVS_Value, avs_invoke)(AVS_ScriptEnvironment *, const char * name,
636                                AVS_Value args, const char** arg_names);
637 // The returned value must be be released with avs_release_value
638
639 AVSC_API(AVS_Value, avs_get_var)(AVS_ScriptEnvironment *, const char* name);
640 // The returned value must be be released with avs_release_value
641
642 AVSC_API(int, avs_set_var)(AVS_ScriptEnvironment *, const char* name, AVS_Value val);
643
644 AVSC_API(int, avs_set_global_var)(AVS_ScriptEnvironment *, const char* name, const AVS_Value val);
645
646 //void avs_push_context(AVS_ScriptEnvironment *, int level=0);
647 //void avs_pop_context(AVS_ScriptEnvironment *);
648
649 AVSC_API(AVS_VideoFrame *, avs_new_video_frame_a)(AVS_ScriptEnvironment *,
650                                           const AVS_VideoInfo * vi, int align);
651 // align should be at least 16
652
653 #ifndef AVSC_NO_DECLSPEC
654 AVSC_INLINE
655 AVS_VideoFrame * avs_new_video_frame(AVS_ScriptEnvironment * env,
656                                      const AVS_VideoInfo * vi)
657   {return avs_new_video_frame_a(env,vi,FRAME_ALIGN);}
658
659 AVSC_INLINE
660 AVS_VideoFrame * avs_new_frame(AVS_ScriptEnvironment * env,
661                                const AVS_VideoInfo * vi)
662   {return avs_new_video_frame_a(env,vi,FRAME_ALIGN);}
663 #endif
664
665
666 AVSC_API(int, avs_make_writable)(AVS_ScriptEnvironment *, AVS_VideoFrame * * pvf);
667
668 AVSC_API(void, avs_bit_blt)(AVS_ScriptEnvironment *, BYTE* dstp, int dst_pitch, const BYTE* srcp, int src_pitch, int row_size, int height);
669
670 typedef void (AVSC_CC *AVS_ShutdownFunc)(void* user_data, AVS_ScriptEnvironment * env);
671 AVSC_API(void, avs_at_exit)(AVS_ScriptEnvironment *, AVS_ShutdownFunc function, void * user_data);
672
673 AVSC_API(AVS_VideoFrame *, avs_subframe)(AVS_ScriptEnvironment *, AVS_VideoFrame * src, int rel_offset, int new_pitch, int new_row_size, int new_height);
674 // The returned video frame must be be released
675
676 AVSC_API(int, avs_set_memory_max)(AVS_ScriptEnvironment *, int mem);
677
678 AVSC_API(int, avs_set_working_dir)(AVS_ScriptEnvironment *, const char * newdir);
679
680 // avisynth.dll exports this; it's a way to use it as a library, without
681 // writing an AVS script or without going through AVIFile.
682 AVSC_API(AVS_ScriptEnvironment *, avs_create_script_environment)(int version);
683
684 // this symbol is the entry point for the plugin and must
685 // be defined
686 AVSC_EXPORT
687 const char * AVSC_CC avisynth_c_plugin_init(AVS_ScriptEnvironment* env);
688
689
690 AVSC_API(void, avs_delete_script_environment)(AVS_ScriptEnvironment *);
691
692
693 AVSC_API(AVS_VideoFrame *, avs_subframe_planar)(AVS_ScriptEnvironment *, AVS_VideoFrame * src, int rel_offset, int new_pitch, int new_row_size, int new_height, int rel_offsetU, int rel_offsetV, int new_pitchUV);
694 // The returned video frame must be be released
695
696 #ifdef AVSC_NO_DECLSPEC
697 // use LoadLibrary and related functions to dynamically load Avisynth instead of declspec(dllimport)
698 /*
699   The following functions needs to have been declared, probably from windows.h
700
701   void* malloc(size_t)
702   void free(void*);
703
704   HMODULE LoadLibrary(const char*);
705   void* GetProcAddress(HMODULE, const char*);
706   FreeLibrary(HMODULE);
707 */
708
709
710 typedef struct AVS_Library AVS_Library;
711
712 #define AVSC_DECLARE_FUNC(name) name##_func name
713
714 struct AVS_Library {
715   HMODULE handle;
716
717   AVSC_DECLARE_FUNC(avs_add_function);
718   AVSC_DECLARE_FUNC(avs_at_exit);
719   AVSC_DECLARE_FUNC(avs_bit_blt);
720   AVSC_DECLARE_FUNC(avs_check_version);
721   AVSC_DECLARE_FUNC(avs_clip_get_error);
722   AVSC_DECLARE_FUNC(avs_copy_clip);
723   AVSC_DECLARE_FUNC(avs_copy_value);
724   AVSC_DECLARE_FUNC(avs_copy_video_frame);
725   AVSC_DECLARE_FUNC(avs_create_script_environment);
726   AVSC_DECLARE_FUNC(avs_delete_script_environment);
727   AVSC_DECLARE_FUNC(avs_function_exists);
728   AVSC_DECLARE_FUNC(avs_get_audio);
729   AVSC_DECLARE_FUNC(avs_get_cpu_flags);
730   AVSC_DECLARE_FUNC(avs_get_frame);
731   AVSC_DECLARE_FUNC(avs_get_parity);
732   AVSC_DECLARE_FUNC(avs_get_var);
733   AVSC_DECLARE_FUNC(avs_get_version);
734   AVSC_DECLARE_FUNC(avs_get_video_info);
735   AVSC_DECLARE_FUNC(avs_invoke);
736   AVSC_DECLARE_FUNC(avs_make_writable);
737   AVSC_DECLARE_FUNC(avs_new_c_filter);
738   AVSC_DECLARE_FUNC(avs_new_video_frame_a);
739   AVSC_DECLARE_FUNC(avs_release_clip);
740   AVSC_DECLARE_FUNC(avs_release_value);
741   AVSC_DECLARE_FUNC(avs_release_video_frame);
742   AVSC_DECLARE_FUNC(avs_save_string);
743   AVSC_DECLARE_FUNC(avs_set_cache_hints);
744   AVSC_DECLARE_FUNC(avs_set_global_var);
745   AVSC_DECLARE_FUNC(avs_set_memory_max);
746   AVSC_DECLARE_FUNC(avs_set_to_clip);
747   AVSC_DECLARE_FUNC(avs_set_var);
748   AVSC_DECLARE_FUNC(avs_set_working_dir);
749   AVSC_DECLARE_FUNC(avs_sprintf);
750   AVSC_DECLARE_FUNC(avs_subframe);
751   AVSC_DECLARE_FUNC(avs_subframe_planar);
752   AVSC_DECLARE_FUNC(avs_take_clip);
753   AVSC_DECLARE_FUNC(avs_vsprintf);
754
755   AVSC_DECLARE_FUNC(avs_get_error);
756   AVSC_DECLARE_FUNC(avs_is_yv24);
757   AVSC_DECLARE_FUNC(avs_is_yv16);
758   AVSC_DECLARE_FUNC(avs_is_yv12);
759   AVSC_DECLARE_FUNC(avs_is_yv411);
760   AVSC_DECLARE_FUNC(avs_is_y8);
761   AVSC_DECLARE_FUNC(avs_is_color_space);
762
763   AVSC_DECLARE_FUNC(avs_get_plane_width_subsampling);
764   AVSC_DECLARE_FUNC(avs_get_plane_height_subsampling);
765   AVSC_DECLARE_FUNC(avs_bits_per_pixel);
766   AVSC_DECLARE_FUNC(avs_bytes_from_pixels);
767   AVSC_DECLARE_FUNC(avs_row_size);
768   AVSC_DECLARE_FUNC(avs_bmp_size);
769   AVSC_DECLARE_FUNC(avs_get_pitch_p);
770   AVSC_DECLARE_FUNC(avs_get_row_size_p);
771   AVSC_DECLARE_FUNC(avs_get_height_p);
772   AVSC_DECLARE_FUNC(avs_get_read_ptr_p);
773   AVSC_DECLARE_FUNC(avs_is_writable);
774   AVSC_DECLARE_FUNC(avs_get_write_ptr_p);
775 };
776
777 #undef AVSC_DECLARE_FUNC
778
779
780 AVSC_INLINE AVS_Library * avs_load_library() {
781   AVS_Library *library = (AVS_Library *)malloc(sizeof(AVS_Library));
782   if (library == NULL)
783     return NULL;
784   library->handle = LoadLibrary("avisynth");
785   if (library->handle == NULL)
786     goto fail;
787
788 #define __AVSC_STRINGIFY(x) #x
789 #define AVSC_STRINGIFY(x) __AVSC_STRINGIFY(x)
790 #define AVSC_LOAD_FUNC(name) {\
791   library->name = (name##_func) GetProcAddress(library->handle, AVSC_STRINGIFY(name));\
792   if (library->name == NULL)\
793     goto fail;\
794 }
795
796   AVSC_LOAD_FUNC(avs_add_function);
797   AVSC_LOAD_FUNC(avs_at_exit);
798   AVSC_LOAD_FUNC(avs_bit_blt);
799   AVSC_LOAD_FUNC(avs_check_version);
800   AVSC_LOAD_FUNC(avs_clip_get_error);
801   AVSC_LOAD_FUNC(avs_copy_clip);
802   AVSC_LOAD_FUNC(avs_copy_value);
803   AVSC_LOAD_FUNC(avs_copy_video_frame);
804   AVSC_LOAD_FUNC(avs_create_script_environment);
805   AVSC_LOAD_FUNC(avs_delete_script_environment);
806   AVSC_LOAD_FUNC(avs_function_exists);
807   AVSC_LOAD_FUNC(avs_get_audio);
808   AVSC_LOAD_FUNC(avs_get_cpu_flags);
809   AVSC_LOAD_FUNC(avs_get_frame);
810   AVSC_LOAD_FUNC(avs_get_parity);
811   AVSC_LOAD_FUNC(avs_get_var);
812   AVSC_LOAD_FUNC(avs_get_version);
813   AVSC_LOAD_FUNC(avs_get_video_info);
814   AVSC_LOAD_FUNC(avs_invoke);
815   AVSC_LOAD_FUNC(avs_make_writable);
816   AVSC_LOAD_FUNC(avs_new_c_filter);
817   AVSC_LOAD_FUNC(avs_new_video_frame_a);
818   AVSC_LOAD_FUNC(avs_release_clip);
819   AVSC_LOAD_FUNC(avs_release_value);
820   AVSC_LOAD_FUNC(avs_release_video_frame);
821   AVSC_LOAD_FUNC(avs_save_string);
822   AVSC_LOAD_FUNC(avs_set_cache_hints);
823   AVSC_LOAD_FUNC(avs_set_global_var);
824   AVSC_LOAD_FUNC(avs_set_memory_max);
825   AVSC_LOAD_FUNC(avs_set_to_clip);
826   AVSC_LOAD_FUNC(avs_set_var);
827   AVSC_LOAD_FUNC(avs_set_working_dir);
828   AVSC_LOAD_FUNC(avs_sprintf);
829   AVSC_LOAD_FUNC(avs_subframe);
830   AVSC_LOAD_FUNC(avs_subframe_planar);
831   AVSC_LOAD_FUNC(avs_take_clip);
832   AVSC_LOAD_FUNC(avs_vsprintf);
833
834   AVSC_LOAD_FUNC(avs_get_error);
835   AVSC_LOAD_FUNC(avs_is_yv24);
836   AVSC_LOAD_FUNC(avs_is_yv16);
837   AVSC_LOAD_FUNC(avs_is_yv12);
838   AVSC_LOAD_FUNC(avs_is_yv411);
839   AVSC_LOAD_FUNC(avs_is_y8);
840   AVSC_LOAD_FUNC(avs_is_color_space);
841
842   AVSC_LOAD_FUNC(avs_get_plane_width_subsampling);
843   AVSC_LOAD_FUNC(avs_get_plane_height_subsampling);
844   AVSC_LOAD_FUNC(avs_bits_per_pixel);
845   AVSC_LOAD_FUNC(avs_bytes_from_pixels);
846   AVSC_LOAD_FUNC(avs_row_size);
847   AVSC_LOAD_FUNC(avs_bmp_size);
848   AVSC_LOAD_FUNC(avs_get_pitch_p);
849   AVSC_LOAD_FUNC(avs_get_row_size_p);
850   AVSC_LOAD_FUNC(avs_get_height_p);
851   AVSC_LOAD_FUNC(avs_get_read_ptr_p);
852   AVSC_LOAD_FUNC(avs_is_writable);
853   AVSC_LOAD_FUNC(avs_get_write_ptr_p);
854
855 #undef __AVSC_STRINGIFY
856 #undef AVSC_STRINGIFY
857 #undef AVSC_LOAD_FUNC
858
859   return library;
860
861 fail:
862   free(library);
863   return NULL;
864 }
865
866 AVSC_INLINE void avs_free_library(AVS_Library *library) {
867   if (library == NULL)
868     return;
869   FreeLibrary(library->handle);
870   free(library);
871 }
872 #endif
873
874 #endif