Files
test2/source/blender/windowmanager/intern/wm_stereo.c
Dalai Felinto d5f1b9c222 Multi-View and Stereo 3D
Official Documentation:
http://www.blender.org/manual/render/workflows/multiview.html

Implemented Features
====================
Builtin Stereo Camera
* Convergence Mode
* Interocular Distance
* Convergence Distance
* Pivot Mode

Viewport
* Cameras
* Plane
* Volume

Compositor
* View Switch Node
* Image Node Multi-View OpenEXR support

Sequencer
* Image/Movie Strips 'Use Multiview'

UV/Image Editor
* Option to see Multi-View images in Stereo-3D or its individual images
* Save/Open Multi-View (OpenEXR, Stereo3D, individual views) images

I/O
* Save/Open Multi-View (OpenEXR, Stereo3D, individual views) images

Scene Render Views
* Ability to have an arbitrary number of views in the scene

Missing Bits
============
First rule of Multi-View bug report: If something is not working as it should *when Views is off* this is a severe bug, do mention this in the report.

Second rule is, if something works *when Views is off* but doesn't (or crashes) when *Views is on*, this is a important bug. Do mention this in the report.

Everything else is likely small todos, and may wait until we are sure none of the above is happening.

Apart from that there are those known issues:
* Compositor Image Node poorly working for Multi-View OpenEXR
(this was working prefectly before the 'Use Multi-View' functionality)
* Selecting camera from Multi-View when looking from camera is problematic
* Animation Playback (ctrl+F11) doesn't support stereo formats
* Wrong filepath when trying to play back animated scene
* Viewport Rendering doesn't support Multi-View
* Overscan Rendering
* Fullscreen display modes need to warn the user
* Object copy should be aware of views suffix

Acknowledgments
===============
* Francesco Siddi for the help with the original feature specs and design
* Brecht Van Lommel for the original review of the code and design early on
* Blender Foundation for the Development Fund to support the project wrap up

Final patch reviewers:
* Antony Riakiotakis (psy-fi)
* Campbell Barton (ideasman42)
* Julian Eisel (Severin)
* Sergey Sharybin (nazgul)
* Thomas Dinged (dingto)

Code contributors of the original branch in github:
* Alexey Akishin
* Gabriel Caraballo
2015-04-06 10:40:12 -03:00

535 lines
14 KiB
C

/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2015 by Blender Foundation
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): Dalai Felinto
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/windowmanager/intern/wm_stereo.c
* \ingroup wm
*/
#include <stdlib.h>
#include <string.h>
#include "DNA_listBase.h"
#include "RNA_access.h"
#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_rect.h"
#include "BLI_utildefines.h"
#include "BIF_gl.h"
#include "BKE_context.h"
#include "BKE_global.h"
#include "BKE_report.h"
#include "GHOST_C-api.h"
#include "ED_screen.h"
#include "GPU_glew.h"
#include "WM_api.h"
#include "WM_types.h"
#include "wm.h"
#include "wm_draw.h" /* wmDrawTriple */
#include "wm_window.h"
#include "UI_interface.h"
#include "UI_resources.h"
static void wm_method_draw_stereo3d_pageflip(wmWindow *win)
{
wmDrawData *drawdata;
int view;
for (view = 0; view < 2; view ++) {
drawdata = BLI_findlink(&win->drawdata, (view * 2) + 1);
if (view == STEREO_LEFT_ID)
glDrawBuffer(GL_BACK_LEFT);
else //STEREO_RIGHT_ID
glDrawBuffer(GL_BACK_RIGHT);
wm_triple_draw_textures(win, drawdata->triple, 1.0f);
}
}
static GLuint left_interlace_mask[32];
static GLuint right_interlace_mask[32];
static enum eStereo3dInterlaceType interlace_prev_type = -1;
static char interlace_prev_swap = -1;
static void wm_interlace_masks_create(wmWindow *win)
{
GLuint pattern;
char i;
bool swap = (win->stereo3d_format->flag & S3D_INTERLACE_SWAP) != 0;
enum eStereo3dInterlaceType interlace_type = win->stereo3d_format->interlace_type;
if (interlace_prev_type == interlace_type && interlace_prev_swap == swap)
return;
switch (interlace_type) {
case S3D_INTERLACE_ROW:
pattern = 0x00000000;
pattern = swap ? ~pattern : pattern;
for (i = 0; i < 32; i += 2) {
left_interlace_mask[i] = pattern;
right_interlace_mask[i] = ~pattern;
}
for (i = 1; i < 32; i += 2) {
left_interlace_mask[i] = ~pattern;
right_interlace_mask[i] = pattern;
}
break;
case S3D_INTERLACE_COLUMN:
pattern = 0x55555555;
pattern = swap ? ~pattern : pattern;
for (i = 0; i < 32; i++) {
left_interlace_mask[i] = pattern;
right_interlace_mask[i] = ~pattern;
}
break;
case S3D_INTERLACE_CHECKERBOARD:
default:
pattern = 0x55555555;
pattern = swap ? ~pattern : pattern;
for (i = 0; i < 32; i += 2) {
left_interlace_mask[i] = pattern;
right_interlace_mask[i] = ~pattern;
}
for (i = 1; i < 32; i += 2) {
left_interlace_mask[i] = ~pattern;
right_interlace_mask[i] = pattern;
}
break;
}
interlace_prev_type = interlace_type;
interlace_prev_swap = swap;
}
static void wm_method_draw_stereo3d_interlace(wmWindow *win)
{
wmDrawData *drawdata;
int view;
wm_interlace_masks_create(win);
for (view = 0; view < 2; view ++) {
drawdata = BLI_findlink(&win->drawdata, (view * 2) + 1);
glEnable(GL_POLYGON_STIPPLE);
glPolygonStipple(view ? (GLubyte *) right_interlace_mask : (GLubyte *) left_interlace_mask);
wm_triple_draw_textures(win, drawdata->triple, 1.0f);
glDisable(GL_POLYGON_STIPPLE);
}
}
static void wm_method_draw_stereo3d_anaglyph(wmWindow *win)
{
wmDrawData *drawdata;
int view, bit;
for (view = 0; view < 2; view ++) {
drawdata = BLI_findlink(&win->drawdata, (view * 2) + 1);
bit = view + 1;
switch (win->stereo3d_format->anaglyph_type) {
case S3D_ANAGLYPH_REDCYAN:
glColorMask((1&bit) ? GL_TRUE : GL_FALSE,
(2&bit) ? GL_TRUE : GL_FALSE,
(2&bit) ? GL_TRUE : GL_FALSE,
GL_FALSE);
break;
case S3D_ANAGLYPH_GREENMAGENTA:
glColorMask((2&bit) ? GL_TRUE : GL_FALSE,
(1&bit) ? GL_TRUE : GL_FALSE,
(2&bit) ? GL_TRUE : GL_FALSE,
GL_FALSE);
break;
case S3D_ANAGLYPH_YELLOWBLUE:
glColorMask((1&bit) ? GL_TRUE : GL_FALSE,
(1&bit) ? GL_TRUE : GL_FALSE,
(2&bit) ? GL_TRUE : GL_FALSE,
GL_FALSE);
break;
}
wm_triple_draw_textures(win, drawdata->triple, 1.0f);
glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
}
}
static void wm_method_draw_stereo3d_sidebyside(wmWindow *win)
{
wmDrawData *drawdata;
wmDrawTriple *triple;
float halfx, halfy, ratiox, ratioy;
int x, y, offx, offy;
float alpha = 1.0f;
int view;
int soffx;
bool cross_eyed = (win->stereo3d_format->flag & S3D_SIDEBYSIDE_CROSSEYED) != 0;
for (view = 0; view < 2; view ++) {
drawdata = BLI_findlink(&win->drawdata, (view * 2) + 1);
triple = drawdata->triple;
soffx = WM_window_pixels_x(win) * 0.5f;
if (view == STEREO_LEFT_ID) {
if (!cross_eyed)
soffx = 0;
}
else { //RIGHT_LEFT_ID
if (cross_eyed)
soffx = 0;
}
glEnable(triple->target);
for (y = 0, offy = 0; y < triple->ny; offy += triple->y[y], y++) {
for (x = 0, offx = 0; x < triple->nx; offx += triple->x[x], x++) {
const int sizex = triple->x[x];
const int sizey = triple->y[y];
/* wmOrtho for the screen has this same offset */
ratiox = sizex;
ratioy = sizey;
halfx = GLA_PIXEL_OFS;
halfy = GLA_PIXEL_OFS;
/* texture rectangle has unnormalized coordinates */
if (triple->target == GL_TEXTURE_2D) {
ratiox /= triple->x[x];
ratioy /= triple->y[y];
halfx /= triple->x[x];
halfy /= triple->y[y];
}
glBindTexture(triple->target, triple->bind[x + y * triple->nx]);
glColor4f(1.0f, 1.0f, 1.0f, alpha);
glBegin(GL_QUADS);
glTexCoord2f(halfx, halfy);
glVertex2f(soffx + (offx * 0.5f), offy);
glTexCoord2f(ratiox + halfx, halfy);
glVertex2f(soffx + ((offx + sizex) * 0.5f), offy);
glTexCoord2f(ratiox + halfx, ratioy + halfy);
glVertex2f(soffx + ((offx + sizex) * 0.5f), offy + sizey);
glTexCoord2f(halfx, ratioy + halfy);
glVertex2f(soffx + (offx * 0.5f), offy + sizey);
glEnd();
}
}
glBindTexture(triple->target, 0);
glDisable(triple->target);
glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
}
}
static void wm_method_draw_stereo3d_topbottom(wmWindow *win)
{
wmDrawData *drawdata;
wmDrawTriple *triple;
float halfx, halfy, ratiox, ratioy;
int x, y, offx, offy;
float alpha = 1.0f;
int view;
int soffy;
for (view = 0; view < 2; view ++) {
drawdata = BLI_findlink(&win->drawdata, (view * 2) + 1);
triple = drawdata->triple;
if (view == STEREO_LEFT_ID) {
soffy = WM_window_pixels_y(win) * 0.5f;
}
else { /* STEREO_RIGHT_ID */
soffy = 0;
}
glEnable(triple->target);
for (y = 0, offy = 0; y < triple->ny; offy += triple->y[y], y++) {
for (x = 0, offx = 0; x < triple->nx; offx += triple->x[x], x++) {
const int sizex = triple->x[x];
const int sizey = triple->y[y];
/* wmOrtho for the screen has this same offset */
ratiox = sizex;
ratioy = sizey;
halfx = GLA_PIXEL_OFS;
halfy = GLA_PIXEL_OFS;
/* texture rectangle has unnormalized coordinates */
if (triple->target == GL_TEXTURE_2D) {
ratiox /= triple->x[x];
ratioy /= triple->y[y];
halfx /= triple->x[x];
halfy /= triple->y[y];
}
glBindTexture(triple->target, triple->bind[x + y * triple->nx]);
glColor4f(1.0f, 1.0f, 1.0f, alpha);
glBegin(GL_QUADS);
glTexCoord2f(halfx, halfy);
glVertex2f(offx, soffy + (offy * 0.5f));
glTexCoord2f(ratiox + halfx, halfy);
glVertex2f(offx + sizex, soffy + (offy * 0.5f));
glTexCoord2f(ratiox + halfx, ratioy + halfy);
glVertex2f(offx + sizex, soffy + ((offy + sizey) * 0.5f));
glTexCoord2f(halfx, ratioy + halfy);
glVertex2f(offx, soffy + ((offy + sizey) * 0.5f));
glEnd();
}
}
glBindTexture(triple->target, 0);
glDisable(triple->target);
glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
}
}
void wm_method_draw_stereo3d(const bContext *UNUSED(C), wmWindow *win)
{
switch (win->stereo3d_format->display_mode) {
case S3D_DISPLAY_ANAGLYPH:
wm_method_draw_stereo3d_anaglyph(win);
break;
case S3D_DISPLAY_INTERLACE:
wm_method_draw_stereo3d_interlace(win);
break;
case S3D_DISPLAY_PAGEFLIP:
wm_method_draw_stereo3d_pageflip(win);
break;
case S3D_DISPLAY_SIDEBYSIDE:
wm_method_draw_stereo3d_sidebyside(win);
break;
case S3D_DISPLAY_TOPBOTTOM:
wm_method_draw_stereo3d_topbottom(win);
break;
default:
break;
}
}
static bool wm_stereo3d_is_fullscreen_required(eStereoDisplayMode stereo_display)
{
return ELEM(stereo_display,
S3D_DISPLAY_SIDEBYSIDE,
S3D_DISPLAY_TOPBOTTOM,
S3D_DISPLAY_PAGEFLIP);
}
bool WM_stereo3d_enabled(wmWindow *win, bool skip_stereo3d_check)
{
bScreen *screen = win->screen;
if ((skip_stereo3d_check == false) && (ED_screen_stereo3d_required(screen) == false))
return false;
if (wm_stereo3d_is_fullscreen_required(win->stereo3d_format->display_mode))
return WM_window_is_fullscreen(win);
return true;
}
/************************** Stereo 3D operator **********************************/
typedef struct Stereo3dData {
Stereo3dFormat stereo3d_format;
} Stereo3dData;
static bool wm_stereo3d_set_properties(bContext *C, wmOperator *op)
{
wmWindow *win = CTX_wm_window(C);
Stereo3dFormat *s3d = win->stereo3d_format;
PropertyRNA *prop;
bool is_set = false;
prop = RNA_struct_find_property(op->ptr, "display_mode");
if (RNA_property_is_set(op->ptr, prop)) {
s3d->display_mode = RNA_property_enum_get(op->ptr, prop);
is_set = true;
}
prop = RNA_struct_find_property(op->ptr, "anaglyph_type");
if (RNA_property_is_set(op->ptr, prop)) {
s3d->anaglyph_type = RNA_property_enum_get(op->ptr, prop);
is_set = true;
}
prop = RNA_struct_find_property(op->ptr, "interlace_type");
if (RNA_property_is_set(op->ptr, prop)) {
s3d->interlace_type = RNA_property_enum_get(op->ptr, prop);
is_set = true;
}
prop = RNA_struct_find_property(op->ptr, "use_interlace_swap");
if (RNA_property_is_set(op->ptr, prop)) {
if (RNA_property_boolean_get(op->ptr, prop))
s3d->flag |= S3D_INTERLACE_SWAP;
else
s3d->flag &= ~S3D_INTERLACE_SWAP;
is_set = true;
}
prop = RNA_struct_find_property(op->ptr, "use_sidebyside_crosseyed");
if (RNA_property_is_set(op->ptr, prop)) {
if (RNA_property_boolean_get(op->ptr, prop))
s3d->flag |= S3D_SIDEBYSIDE_CROSSEYED;
else
s3d->flag &= ~S3D_SIDEBYSIDE_CROSSEYED;
is_set = true;
}
return is_set;
}
static void wm_stereo3d_set_init(bContext *C, wmOperator *op)
{
Stereo3dData *s3dd;
wmWindow *win = CTX_wm_window(C);
op->customdata = s3dd = MEM_callocN(sizeof(Stereo3dData), __func__);
/* store the original win stereo 3d settings in case of cancel */
s3dd->stereo3d_format = *win->stereo3d_format;
}
int wm_stereo3d_set_exec(bContext *C, wmOperator *op)
{
wmWindowManager *wm = CTX_wm_manager(C);
wmWindow *win = CTX_wm_window(C);
const bool is_fullscreen = WM_window_is_fullscreen(win);
if (G.background)
return OPERATOR_CANCELLED;
/* pagelfip requires a new window to be created with the proper OS flags */
if (win->stereo3d_format->display_mode == S3D_DISPLAY_PAGEFLIP) {
if (wm_window_duplicate_exec(C, op) == OPERATOR_FINISHED) {
wm_window_close(C, wm, win);
win = wm->windows.last;
}
else {
BKE_reportf(op->reports, RPT_ERROR,
"Fail to create a window compatible with time sequential (page-flip) display method");
return OPERATOR_CANCELLED;
}
}
if (wm_stereo3d_is_fullscreen_required(win->stereo3d_format->display_mode)) {
if (!is_fullscreen) {
wm_window_fullscreen_toggle_exec(C, op);
}
}
if (op->customdata) {
MEM_freeN(op->customdata);
}
WM_event_add_notifier(C, NC_WINDOW, NULL);
return OPERATOR_FINISHED;
}
int wm_stereo3d_set_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
{
wm_stereo3d_set_init(C, op);
if (wm_stereo3d_set_properties(C, op))
return wm_stereo3d_set_exec(C, op);
else
return WM_operator_props_dialog_popup(C, op, 250, 100);
}
void wm_stereo3d_set_draw(bContext *C, wmOperator *op)
{
wmWindow *win = CTX_wm_window(C);
Stereo3dFormat *stereo3d_format;
PointerRNA stereo3d_format_ptr;
uiLayout *layout = op->layout;
uiLayout *col;
stereo3d_format = win->stereo3d_format;
RNA_pointer_create(NULL, &RNA_Stereo3dDisplay, stereo3d_format, &stereo3d_format_ptr);
col = uiLayoutColumn(layout, false);
uiItemR(col, &stereo3d_format_ptr, "display_mode", 0, NULL, ICON_NONE);
switch (stereo3d_format->display_mode) {
case S3D_DISPLAY_ANAGLYPH:
{
uiItemR(col, &stereo3d_format_ptr, "anaglyph_type", 0, NULL, ICON_NONE);
break;
}
case S3D_DISPLAY_INTERLACE:
{
uiItemR(col, &stereo3d_format_ptr, "interlace_type", 0, NULL, ICON_NONE);
uiItemR(col, &stereo3d_format_ptr, "use_interlace_swap", 0, NULL, ICON_NONE);
break;
}
case S3D_DISPLAY_SIDEBYSIDE:
{
uiItemR(col, &stereo3d_format_ptr, "use_sidebyside_crosseyed", 0, NULL, ICON_NONE);
/* fall-through */
}
case S3D_DISPLAY_PAGEFLIP:
case S3D_DISPLAY_TOPBOTTOM:
default:
{
break;
}
}
}
void wm_stereo3d_set_cancel(bContext *C, wmOperator *op)
{
Stereo3dData *s3dd = op->customdata;
wmWindow *win = CTX_wm_window(C);
/* roll back to the original */
if (win) {
*win->stereo3d_format = s3dd->stereo3d_format;
}
MEM_freeN(op->customdata);
op->customdata = NULL;
}