4 * Copyright (C) 2011 Adam Williams <broadcast at earthling dot net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "arraylist.h"
26 #include "bcbitmap.inc"
28 #include "bcpbuffer.inc"
29 #include "bctexture.inc"
30 #include "bcwindowbase.inc"
31 #include "bccmodels.h"
32 #include "bccmodels.h"
35 class PngReadFunction;
38 // Maximum number of prev or next effects to be pushed onto the stacks.
39 #define MAX_STACK_ELEMENTS 255
42 // Scene graph for 3D models
43 // Defined by the subclass
48 virtual ~VFrameScene();
56 // Create new frame with shared data if *data is nonzero.
57 // Pass 0 to *data & -1 to shmid if private data is desired.
61 long bytes_per_line = -1);
62 VFrame(unsigned char *data,
66 int color_model /* = BC_RGBA8888 */,
67 long bytes_per_line /* = -1 */);
68 VFrame(unsigned char *data, // 0
75 int color_model, /* = BC_RGBA8888 */
76 long bytes_per_line /* = -1 */);
77 VFrame(BC_Bitmap *bitmap,
83 // Create a frame with the png image
84 VFrame(unsigned char *png_data);
85 VFrame(unsigned char *png_data, long image_size);
86 VFrame(VFrame &vframe);
87 // Create new frame for compressed data.
91 friend class PngReadFunction;
93 // Return 1 if the colormodel and dimensions are the same
95 int equivalent(VFrame *src, int test_stacks = 0);
97 // Reallocate a frame without deleting the class
99 unsigned char *data, // Data if shared
100 int shmid, // shmid if IPC -1 if not
101 long y_offset, // plane offsets if shared YUV
107 long bytes_per_line); // -1 if unused
109 void set_memory(unsigned char *data,
114 void set_memory(BC_Bitmap *bitmap);
116 void set_compressed_memory(unsigned char *data,
121 // Read a PNG into the frame with alpha
122 int read_png(const unsigned char *data);
123 int read_png(const unsigned char *data, long image_size);
124 // Write a PNG for debugging
125 int write_png(const char *path);
127 // if frame points to the same data as this return 1
128 int equals(VFrame *frame);
129 // Test if frame already matches parameters
130 int params_match(int w, int h, int color_model);
131 // Test if data values in the frame match
132 int data_matches(VFrame *frame);
134 // long set_shm_offset(long offset);
135 // long get_shm_offset();
136 int get_shmid() { return shmid; }
137 void set_use_shm(int value) { use_shm = value; }
138 int get_use_shm() { return use_shm; }
140 // direct copy with no alpha
141 int copy_from(VFrame *frame);
142 // BC_CModels::transfer
143 int transfer_from(VFrame *frame, int bg_color=0);
146 int allocate_compressed_data(long bytes);
148 // Sequence number. -1 means invalid. Passing frames to the encoder is
149 // asynchronous. The sequence number must be preserved in the image itself
150 // to encode discontinuous frames.
151 long get_number() { return sequence_number; }
152 void set_number(long number) { sequence_number = number; }
154 int get_color_model() { return color_model; }
155 // Get the data pointer
156 unsigned char* get_data() { return data; }
157 long get_compressed_allocated() { return compressed_allocated; }
158 long get_compressed_size() { return compressed_size; }
159 void set_compressed_size(long size) { compressed_size = size; }
160 double get_timestamp() { return timestamp; }
161 void set_timestamp(double time) { timestamp = time; }
163 // return an array of pointers to rows
164 unsigned char** get_rows() { return rows; }
165 int get_memory_usage();
167 int get_w() { return w; }
168 int get_h() { return h; }
169 int get_w_fixed() { return w - 1; }
170 int get_h_fixed() { return h - 1; }
171 unsigned char *get_y() { return y; }
172 unsigned char *get_u() { return u; }
173 unsigned char *get_v() { return v; }
174 // return rgba planes
175 unsigned char *get_r() { return y; }
176 unsigned char *get_g() { return u; }
177 unsigned char *get_b() { return v; }
178 unsigned char *get_a() { return a; }
179 void set_a(unsigned char *ap) { a = ap; }
181 static int get_scale_tables(int *column_table, int *row_table,
182 int in_x1, int in_y1, int in_x2, int in_y2,
183 int out_x1, int out_y1, int out_x2, int out_y2);
184 int get_bytes_per_pixel() { return bytes_per_pixel; }
185 long get_bytes_per_line();
186 int get_memory_type();
190 static int calculate_bytes_per_pixel(int colormodel);
191 // Get size + 4 for assembly language
192 static long calculate_data_size(int w, int h,
193 int bytes_per_line = -1, int color_model = BC_RGB888);
194 // Get size of uncompressed frame buffer without extra 4 bytes
195 long get_data_size();
202 // Convenience storage.
203 // Returns -1 if not set.
204 int get_field2_offset();
205 int set_field2_offset(int value);
206 // Set keyframe status
207 void set_keyframe(int value);
209 // Overlay src onto this with blending and translation of input.
210 // Source and this must have alpha
211 void overlay(VFrame *src, int out_x1, int out_y1);
213 // If the opengl state is RAM, transfer image from RAM to the texture
214 // referenced by this frame.
215 // If the opengl state is TEXTURE, do nothing.
216 // If the opengl state is SCREEN, switch the current drawable to the pbuffer and
217 // transfer the image to the texture with screen_to_texture.
218 // The opengl state is changed to TEXTURE.
219 // If no textures exist, textures are created.
220 // If the textures already exist, they are reused.
221 // Textures are resized to match the current dimensions.
222 // Must be called from a synchronous opengl thread after enable_opengl.
225 // Transfer from PBuffer to RAM. Only used after Playback3D::overlay_sync
228 // Transfer contents of current pbuffer to texture,
229 // creating a new texture if necessary.
230 // Coordinates are the coordinates in the drawable to copy.
231 void screen_to_texture(int x = -1, int y = -1, int w = -1, int h = -1);
233 // Transfer contents of texture to the current drawable.
234 // Just calls the vertex functions but doesn't initialize.
235 // The coordinates are relative to the VFrame size and flipped to make
236 // the texture upright.
237 // The default coordinates are the size of the VFrame.
238 // flip_y flips the texture in the vertical direction and only used when
239 // writing to the final surface.
240 void draw_texture(float in_x1, float in_y1, float in_x2, float in_y2,
241 float out_x1, float out_y1, float out_x2, float out_y2,
243 // Draw the texture using the frame's size as the input and output coordinates.
244 void draw_texture(int flip_y = 0);
254 // ================================ OpenGL functions ===========================
255 // Defined in vframe3d.C
256 // Location of working image if OpenGL playback
257 int get_opengl_state();
258 void set_opengl_state(int value);
264 // OpenGL image is in RAM
266 // OpenGL image is in texture
268 // OpenGL image is composited in PBuffer or back buffer
273 int get_texture_id();
274 void set_texture_id(int id);
275 // Get window ID the texture is bound to
279 int get_texture_components();
282 // Binds the opengl context to this frame's PBuffer
283 void enable_opengl();
285 // Clears the pbuffer with the right values depending on YUV
286 void clear_pbuffer();
289 BC_PBuffer* get_pbuffer();
291 // Bind the frame's texture to GL_TEXTURE_2D and enable it.
292 // If a texture_unit is supplied, the texture unit is made active
293 // and the commands are run in the right sequence to
294 // initialize it to our preferred specifications.
295 void bind_texture(int texture_unit = -1);
299 // Create a frustum with 0,0 in the upper left and w,-h in the bottom right.
300 // Set preferred opengl settings.
301 static void init_screen(int w, int h);
302 // Calls init_screen with the current frame's dimensions.
305 // Compiles and links the shaders into a program.
306 // Adds the program with put_shader.
307 // Returns the program handle.
308 // Requires a null terminated argument list of shaders to link together.
309 // At least one shader argument must have a main() function. make_shader
310 // replaces all the main() functions with unique functions and calls them in
311 // sequence, so multiple independant shaders can be linked.
312 // x is a placeholder for va_arg and should be 0.
313 static unsigned int make_shader(int x, ...);
314 static void dump_shader(int shader_id);
316 // Because OpenGL is faster if multiple effects are combined, we need
317 // to provide ways for effects to aggregate.
318 // The prev_effect is the object providing the data to read_frame.
319 // The next_effect is the object which called read_frame.
320 // Push and pop are only called from Cinelerra internals, so
321 // if an object calls read_frame with a temporary, the stack before and after
322 // the temporary is lost.
323 void push_prev_effect(const char *name);
324 void pop_prev_effect();
325 void push_next_effect(const char *name);
326 void pop_next_effect();
327 // These are called by plugins to determine aggregation.
328 // They access any member of the stack based on the number argument.
329 // next effect 0 is the one that called read_frame most recently.
330 // prev effect 0 is the one that filled our call to read_frame.
331 const char* get_next_effect(int number = 0);
332 const char* get_prev_effect(int number = 0);
334 // It isn't enough to know the name of the neighboring effects.
335 // Relevant configuration parameters must be passed on.
336 BC_Hash* get_params();
338 // get/set read status -1/err, 0/noxfer, 1/ok
339 int get_status() { return status; }
340 void set_status(int v) { status = v; }
342 // Compare stacks and params from 2 images and return 1 if equal.
343 int equal_stacks(VFrame *src);
345 // Copy stacks and params from another frame
346 // Replaces the stacks with the src stacks but only updates the params.
347 void copy_stacks(VFrame *src);
348 // Updates the params with values from src
349 void copy_params(VFrame *src);
351 // This clears the stacks and the param table
354 void draw_rect(int x1, int y1, int x2, int y2);
355 void draw_line(int x1, int y1, int x2, int y2);
356 void draw_pixel(int x, int y);
357 void draw_arrow(int x1, int y1, int x2, int y2);
360 // Not integrated with shmem because that only affects codecs
361 VFrameScene* get_scene();
369 // Shared memory utils
370 static int filefork_size();
372 void to_filefork(unsigned char *buffer);
374 void from_filefork(unsigned char *buffer);
379 // Not integrated with shmem because that only affects codecs
382 // Create a PBuffer matching this frame's dimensions and to be
383 // referenced by this frame. Does nothing if the pbuffer already exists.
384 // If the frame is resized, the PBuffer is deleted.
385 // Called by enable_opengl.
386 // This allows PBuffers, textures, and bitmaps to travel through the entire
387 // rendering chain without requiring the user to manage a lot of objects.
388 // Must be called from a synchronous opengl thread after enable_opengl.
389 void create_pbuffer();
391 int clear_objects(int do_opengl);
392 int reset_parameters(int do_opengl);
393 void create_row_pointers();
394 int allocate_data(unsigned char *data,
402 long bytes_per_line);
404 // Convenience storage
414 // Data pointer is pointing to someone else's buffer.
416 // ID of shared memory if using IPC.
417 // The 1st 1 after reboot is 0.
419 // Local setting for shm usage
421 // If not set by user, is calculated from color_model
426 // Pointers to the start of each row
427 unsigned char **rows;
428 // One of the #defines
430 // Allocated space for compressed data
431 long compressed_allocated;
432 // Size of stored compressed image
433 long compressed_size;
434 // Pointers to yuv / rgb planes
435 unsigned char *y, *u, *v;
439 // Pointer to alpha plane
441 // Dimensions of frame
443 // Info for reading png images
444 const unsigned char *image;
447 // For writing discontinuous frames in background rendering
448 long sequence_number;
450 // read status of input frame -1/err, 0/noxfr, 1/ok
454 // State of the current texture
456 // State of the current PBuffer
459 // Location of working image if OpenGL playback
462 ArrayList<char*> prev_effects;
463 ArrayList<char*> next_effects;