Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_image / image_ops.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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 Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation, 2002-2009, Xavier Thomas
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/space_image/image_ops.c
27  *  \ingroup spimage
28  */
29
30
31 #include <stddef.h>
32 #include <string.h>
33 #include <fcntl.h>
34 #include <stdlib.h>
35 #include <errno.h>
36 #ifndef WIN32
37 #  include <unistd.h>
38 #else
39 #  include <io.h>
40 #endif
41
42 #include "MEM_guardedalloc.h"
43
44 #include "BLI_math.h"
45 #include "BLI_blenlib.h"
46 #include "BLI_utildefines.h"
47 #include "BLI_string_utf8.h"
48
49 #include "BLT_translation.h"
50
51 #include "DNA_camera_types.h"
52 #include "DNA_object_types.h"
53 #include "DNA_node_types.h"
54 #include "DNA_packedFile_types.h"
55 #include "DNA_scene_types.h"
56 #include "DNA_screen_types.h"
57
58 #include "BKE_colortools.h"
59 #include "BKE_context.h"
60 #include "BKE_DerivedMesh.h"
61 #include "BKE_icons.h"
62 #include "BKE_image.h"
63 #include "BKE_global.h"
64 #include "BKE_library.h"
65 #include "BKE_main.h"
66 #include "BKE_packedFile.h"
67 #include "BKE_paint.h"
68 #include "BKE_report.h"
69 #include "BKE_screen.h"
70 #include "BKE_sound.h"
71 #include "BKE_scene.h"
72
73 #include "DEG_depsgraph.h"
74
75 #include "GPU_draw.h"
76
77 #include "IMB_colormanagement.h"
78 #include "IMB_imbuf.h"
79 #include "IMB_imbuf_types.h"
80 #include "IMB_moviecache.h"
81 #include "intern/openexr/openexr_multi.h"
82
83 #include "RE_pipeline.h"
84
85 #include "RNA_access.h"
86 #include "RNA_define.h"
87 #include "RNA_enum_types.h"
88
89 #include "ED_image.h"
90 #include "ED_mask.h"
91 #include "ED_paint.h"
92 #include "ED_render.h"
93 #include "ED_screen.h"
94 #include "ED_space_api.h"
95 #include "ED_uvedit.h"
96 #include "ED_util.h"
97
98 #include "UI_interface.h"
99 #include "UI_resources.h"
100 #include "UI_view2d.h"
101
102 #include "WM_api.h"
103 #include "WM_types.h"
104
105 #include "PIL_time.h"
106
107 #include "RE_engine.h"
108
109 #include "image_intern.h"
110
111 /******************** view navigation utilities *********************/
112
113 static void sima_zoom_set(SpaceImage *sima, ARegion *ar, float zoom, const float location[2])
114 {
115         float oldzoom = sima->zoom;
116         int width, height;
117
118         sima->zoom = zoom;
119
120         if (sima->zoom < 0.1f || sima->zoom > 4.0f) {
121                 /* check zoom limits */
122                 ED_space_image_get_size(sima, &width, &height);
123
124                 width *= sima->zoom;
125                 height *= sima->zoom;
126
127                 if ((width < 4) && (height < 4) && sima->zoom < oldzoom)
128                         sima->zoom = oldzoom;
129                 else if (BLI_rcti_size_x(&ar->winrct) <= sima->zoom)
130                         sima->zoom = oldzoom;
131                 else if (BLI_rcti_size_y(&ar->winrct) <= sima->zoom)
132                         sima->zoom = oldzoom;
133         }
134
135         if ((U.uiflag & USER_ZOOM_TO_MOUSEPOS) && location) {
136                 float aspx, aspy, w, h;
137
138                 ED_space_image_get_size(sima, &width, &height);
139                 ED_space_image_get_aspect(sima, &aspx, &aspy);
140
141                 w = width * aspx;
142                 h = height * aspy;
143
144                 sima->xof += ((location[0] - 0.5f) * w - sima->xof) * (sima->zoom - oldzoom) / sima->zoom;
145                 sima->yof += ((location[1] - 0.5f) * h - sima->yof) * (sima->zoom - oldzoom) / sima->zoom;
146         }
147 }
148
149 static void sima_zoom_set_factor(SpaceImage *sima, ARegion *ar, float zoomfac, const float location[2])
150 {
151         sima_zoom_set(sima, ar, sima->zoom * zoomfac, location);
152 }
153
154 /**
155  * Fits the view to the bounds exactly, caller should add margin if needed.
156  */
157 static void sima_zoom_set_from_bounds(SpaceImage *sima, ARegion *ar, const rctf *bounds)
158 {
159         int image_size[2];
160         float aspx, aspy;
161
162         ED_space_image_get_size(sima, &image_size[0], &image_size[1]);
163         ED_space_image_get_aspect(sima, &aspx, &aspy);
164
165         image_size[0] = image_size[0] * aspx;
166         image_size[1] = image_size[1] * aspy;
167
168         /* adjust offset and zoom */
169         sima->xof = roundf((BLI_rctf_cent_x(bounds) - 0.5f) * image_size[0]);
170         sima->yof = roundf((BLI_rctf_cent_y(bounds) - 0.5f) * image_size[1]);
171
172         float size_xy[2], size;
173         size_xy[0] = BLI_rcti_size_x(&ar->winrct) / (BLI_rctf_size_x(bounds) * image_size[0]);
174         size_xy[1] = BLI_rcti_size_y(&ar->winrct) / (BLI_rctf_size_y(bounds) * image_size[1]);
175
176         size = min_ff(size_xy[0], size_xy[1]);
177         CLAMP_MAX(size, 100.0f);
178
179         sima_zoom_set(sima, ar, size, NULL);
180 }
181
182 #if 0 // currently unused
183 static int image_poll(bContext *C)
184 {
185         return (CTX_data_edit_image(C) != NULL);
186 }
187 #endif
188
189 static int space_image_buffer_exists_poll(bContext *C)
190 {
191         SpaceImage *sima = CTX_wm_space_image(C);
192         if (sima && ED_space_image_has_buffer(sima)) {
193                 return true;
194         }
195         return false;
196 }
197
198 static int image_not_packed_poll(bContext *C)
199 {
200         SpaceImage *sima = CTX_wm_space_image(C);
201
202         /* Do not run 'replace' on packed images, it does not give user expected results at all. */
203         if (sima && sima->image && BLI_listbase_is_empty(&sima->image->packedfiles)) {
204                 return true;
205         }
206         return false;
207 }
208
209 static bool imbuf_format_writeable(const ImBuf *ibuf)
210 {
211         ImageFormatData im_format;
212         ImbFormatOptions options_dummy;
213         BKE_imbuf_to_image_format(&im_format, ibuf);
214         return (BKE_image_imtype_to_ftype(im_format.imtype, &options_dummy) == ibuf->ftype);
215 }
216
217 static int space_image_file_exists_poll(bContext *C)
218 {
219         if (space_image_buffer_exists_poll(C)) {
220                 Main *bmain = CTX_data_main(C);
221                 SpaceImage *sima = CTX_wm_space_image(C);
222                 ImBuf *ibuf;
223                 void *lock;
224                 bool ret = false;
225                 char name[FILE_MAX];
226
227                 ibuf = ED_space_image_acquire_buffer(sima, &lock);
228                 if (ibuf) {
229                         BLI_strncpy(name, ibuf->name, FILE_MAX);
230                         BLI_path_abs(name, bmain->name);
231
232                         if (BLI_exists(name) == false) {
233                                 CTX_wm_operator_poll_msg_set(C, "image file not found");
234                         }
235                         else if (!BLI_file_is_writable(name)) {
236                                 CTX_wm_operator_poll_msg_set(C, "image path can't be written to");
237                         }
238                         else if (!imbuf_format_writeable(ibuf)) {
239                                 CTX_wm_operator_poll_msg_set(C, "image format is read-only");
240                         }
241                         else {
242                                 ret = true;
243                         }
244                 }
245                 ED_space_image_release_buffer(sima, ibuf, lock);
246
247                 return ret;
248         }
249         return false;
250 }
251
252 #if 0  /* UNUSED */
253 static int space_image_poll(bContext *C)
254 {
255         SpaceImage *sima = CTX_wm_space_image(C);
256         if (sima && sima->image) {
257                 return true;
258         }
259         return false;
260 }
261 #endif
262
263 int space_image_main_region_poll(bContext *C)
264 {
265         SpaceImage *sima = CTX_wm_space_image(C);
266         /* XXX ARegion *ar = CTX_wm_region(C); */
267
268         if (sima) {
269                 return true;  /* XXX (ar && ar->type->regionid == RGN_TYPE_WINDOW); */
270         }
271         return false;
272 }
273
274 /* For IMAGE_OT_curves_point_set to avoid sampling when in uv smooth mode or editmode */
275 static int space_image_main_area_not_uv_brush_poll(bContext *C)
276 {
277         SpaceImage *sima = CTX_wm_space_image(C);
278         Scene *scene = CTX_data_scene(C);
279         ToolSettings *toolsettings = scene->toolsettings;
280
281         if (sima && !toolsettings->uvsculpt && (CTX_data_edit_object(C) == NULL)) {
282                 return 1;
283         }
284
285         return 0;
286 }
287
288 static int image_sample_poll(bContext *C)
289 {
290         SpaceImage *sima = CTX_wm_space_image(C);
291         if (sima) {
292                 Scene *scene = CTX_data_scene(C);
293                 Object *obedit = CTX_data_edit_object(C);
294                 ToolSettings *toolsettings = scene->toolsettings;
295
296                 if (obedit) {
297                         if (ED_space_image_show_uvedit(sima, obedit) && (toolsettings->use_uv_sculpt))
298                                 return false;
299                 }
300                 else if (sima->mode != SI_MODE_VIEW) {
301                         return false;
302                 }
303
304                 return space_image_main_region_poll(C);
305         }
306         else {
307                 return false;
308         }
309 }
310 /********************** view pan operator *********************/
311
312 typedef struct ViewPanData {
313         float x, y;
314         float xof, yof;
315         int event_type;
316 } ViewPanData;
317
318 static void image_view_pan_init(bContext *C, wmOperator *op, const wmEvent *event)
319 {
320         SpaceImage *sima = CTX_wm_space_image(C);
321         ViewPanData *vpd;
322
323         op->customdata = vpd = MEM_callocN(sizeof(ViewPanData), "ImageViewPanData");
324         WM_cursor_modal_set(CTX_wm_window(C), BC_NSEW_SCROLLCURSOR);
325
326         vpd->x = event->x;
327         vpd->y = event->y;
328         vpd->xof = sima->xof;
329         vpd->yof = sima->yof;
330         vpd->event_type = event->type;
331
332         WM_event_add_modal_handler(C, op);
333 }
334
335 static void image_view_pan_exit(bContext *C, wmOperator *op, bool cancel)
336 {
337         SpaceImage *sima = CTX_wm_space_image(C);
338         ViewPanData *vpd = op->customdata;
339
340         if (cancel) {
341                 sima->xof = vpd->xof;
342                 sima->yof = vpd->yof;
343                 ED_region_tag_redraw(CTX_wm_region(C));
344         }
345
346         WM_cursor_modal_restore(CTX_wm_window(C));
347         MEM_freeN(op->customdata);
348 }
349
350 static int image_view_pan_exec(bContext *C, wmOperator *op)
351 {
352         SpaceImage *sima = CTX_wm_space_image(C);
353         float offset[2];
354
355         RNA_float_get_array(op->ptr, "offset", offset);
356         sima->xof += offset[0];
357         sima->yof += offset[1];
358
359         ED_region_tag_redraw(CTX_wm_region(C));
360
361         /* XXX notifier? */
362 #if 0
363         if (image_preview_active(curarea, NULL, NULL)) {
364                 /* recalculates new preview rect */
365                 scrarea_do_windraw(curarea);
366                 image_preview_event(2);
367         }
368 #endif
369
370         return OPERATOR_FINISHED;
371 }
372
373 static int image_view_pan_invoke(bContext *C, wmOperator *op, const wmEvent *event)
374 {
375         if (event->type == MOUSEPAN) {
376                 SpaceImage *sima = CTX_wm_space_image(C);
377                 float offset[2];
378
379                 offset[0] = (event->prevx - event->x) / sima->zoom;
380                 offset[1] = (event->prevy - event->y) / sima->zoom;
381                 RNA_float_set_array(op->ptr, "offset", offset);
382
383                 image_view_pan_exec(C, op);
384                 return OPERATOR_FINISHED;
385         }
386         else {
387                 image_view_pan_init(C, op, event);
388                 return OPERATOR_RUNNING_MODAL;
389         }
390 }
391
392 static int image_view_pan_modal(bContext *C, wmOperator *op, const wmEvent *event)
393 {
394         SpaceImage *sima = CTX_wm_space_image(C);
395         ViewPanData *vpd = op->customdata;
396         float offset[2];
397
398         switch (event->type) {
399                 case MOUSEMOVE:
400                         sima->xof = vpd->xof;
401                         sima->yof = vpd->yof;
402                         offset[0] = (vpd->x - event->x) / sima->zoom;
403                         offset[1] = (vpd->y - event->y) / sima->zoom;
404                         RNA_float_set_array(op->ptr, "offset", offset);
405                         image_view_pan_exec(C, op);
406                         break;
407                 default:
408                         if (event->type == vpd->event_type && event->val == KM_RELEASE) {
409                                 image_view_pan_exit(C, op, false);
410                                 return OPERATOR_FINISHED;
411                         }
412                         break;
413         }
414
415         return OPERATOR_RUNNING_MODAL;
416 }
417
418 static void image_view_pan_cancel(bContext *C, wmOperator *op)
419 {
420         image_view_pan_exit(C, op, true);
421 }
422
423 void IMAGE_OT_view_pan(wmOperatorType *ot)
424 {
425         /* identifiers */
426         ot->name = "View Pan";
427         ot->idname = "IMAGE_OT_view_pan";
428         ot->description = "Pan the view";
429
430         /* api callbacks */
431         ot->exec = image_view_pan_exec;
432         ot->invoke = image_view_pan_invoke;
433         ot->modal = image_view_pan_modal;
434         ot->cancel = image_view_pan_cancel;
435         ot->poll = space_image_main_region_poll;
436
437         /* flags */
438         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_CURSOR | OPTYPE_LOCK_BYPASS;
439
440         /* properties */
441         RNA_def_float_vector(ot->srna, "offset", 2, NULL, -FLT_MAX, FLT_MAX,
442                              "Offset", "Offset in floating point units, 1.0 is the width and height of the image", -FLT_MAX, FLT_MAX);
443 }
444
445 /********************** view zoom operator *********************/
446
447 typedef struct ViewZoomData {
448         float origx, origy;
449         float zoom;
450         int event_type;
451         float location[2];
452
453         /* needed for continuous zoom */
454         wmTimer *timer;
455         double timer_lastdraw;
456
457         /* */
458         SpaceImage *sima;
459         ARegion *ar;
460 } ViewZoomData;
461
462 static void image_view_zoom_init(bContext *C, wmOperator *op, const wmEvent *event)
463 {
464         SpaceImage *sima = CTX_wm_space_image(C);
465         ARegion *ar = CTX_wm_region(C);
466         ViewZoomData *vpd;
467
468         op->customdata = vpd = MEM_callocN(sizeof(ViewZoomData), "ImageViewZoomData");
469         WM_cursor_modal_set(CTX_wm_window(C), BC_NSEW_SCROLLCURSOR);
470
471         vpd->origx = event->x;
472         vpd->origy = event->y;
473         vpd->zoom = sima->zoom;
474         vpd->event_type = event->type;
475
476         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &vpd->location[0], &vpd->location[1]);
477
478         if (U.viewzoom == USER_ZOOM_CONT) {
479                 /* needs a timer to continue redrawing */
480                 vpd->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.01f);
481                 vpd->timer_lastdraw = PIL_check_seconds_timer();
482         }
483
484         vpd->sima = sima;
485         vpd->ar = ar;
486
487         WM_event_add_modal_handler(C, op);
488 }
489
490 static void image_view_zoom_exit(bContext *C, wmOperator *op, bool cancel)
491 {
492         SpaceImage *sima = CTX_wm_space_image(C);
493         ViewZoomData *vpd = op->customdata;
494
495         if (cancel) {
496                 sima->zoom = vpd->zoom;
497                 ED_region_tag_redraw(CTX_wm_region(C));
498         }
499
500         if (vpd->timer)
501                 WM_event_remove_timer(CTX_wm_manager(C), vpd->timer->win, vpd->timer);
502
503         WM_cursor_modal_restore(CTX_wm_window(C));
504         MEM_freeN(op->customdata);
505 }
506
507 static int image_view_zoom_exec(bContext *C, wmOperator *op)
508 {
509         SpaceImage *sima = CTX_wm_space_image(C);
510         ARegion *ar = CTX_wm_region(C);
511
512         sima_zoom_set_factor(sima, ar, RNA_float_get(op->ptr, "factor"), NULL);
513
514         ED_region_tag_redraw(ar);
515
516         /* XXX notifier? */
517 #if 0
518         if (image_preview_active(curarea, NULL, NULL)) {
519                 /* recalculates new preview rect */
520                 scrarea_do_windraw(curarea);
521                 image_preview_event(2);
522         }
523 #endif
524
525         return OPERATOR_FINISHED;
526 }
527
528 enum {
529         VIEW_PASS = 0,
530         VIEW_APPLY,
531         VIEW_CONFIRM
532 };
533
534 static int image_view_zoom_invoke(bContext *C, wmOperator *op, const wmEvent *event)
535 {
536         if (event->type == MOUSEZOOM || event->type == MOUSEPAN) {
537                 SpaceImage *sima = CTX_wm_space_image(C);
538                 ARegion *ar = CTX_wm_region(C);
539                 float delta, factor, location[2];
540
541                 UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &location[0], &location[1]);
542
543                 delta = event->prevx - event->x + event->prevy - event->y;
544
545                 if (U.uiflag & USER_ZOOM_INVERT)
546                         delta *= -1;
547
548                 factor = 1.0f + delta / 300.0f;
549                 RNA_float_set(op->ptr, "factor", factor);
550                 sima_zoom_set(sima, ar, sima->zoom * factor, location);
551                 ED_region_tag_redraw(ar);
552
553                 return OPERATOR_FINISHED;
554         }
555         else {
556                 image_view_zoom_init(C, op, event);
557                 return OPERATOR_RUNNING_MODAL;
558         }
559 }
560
561 static void image_zoom_apply(ViewZoomData *vpd, wmOperator *op, const int x, const int y, const short viewzoom, const short zoom_invert)
562 {
563         float factor;
564
565         if (viewzoom == USER_ZOOM_CONT) {
566                 double time = PIL_check_seconds_timer();
567                 float time_step = (float)(time - vpd->timer_lastdraw);
568                 float fac;
569                 float zfac;
570
571                 if (U.uiflag & USER_ZOOM_HORIZ) {
572                         fac = (float)(x - vpd->origx);
573                 }
574                 else {
575                         fac = (float)(y - vpd->origy);
576                 }
577
578                 if (zoom_invert) {
579                         fac = -fac;
580                 }
581
582                 /* oldstyle zoom */
583                 zfac = 1.0f + ((fac / 20.0f) * time_step);
584                 vpd->timer_lastdraw = time;
585                 /* this is the final zoom, but instead make it into a factor */
586                 //zoom = vpd->sima->zoom * zfac;
587                 factor = (vpd->sima->zoom * zfac) / vpd->zoom;
588         }
589         else {
590                 /* for now do the same things for scale and dolly */
591                 float delta = x - vpd->origx + y - vpd->origy;
592
593                 if (zoom_invert)
594                         delta *= -1.0f;
595
596                 factor = 1.0f + delta / 300.0f;
597         }
598
599         RNA_float_set(op->ptr, "factor", factor);
600         sima_zoom_set(vpd->sima, vpd->ar, vpd->zoom * factor, vpd->location);
601         ED_region_tag_redraw(vpd->ar);
602 }
603
604 static int image_view_zoom_modal(bContext *C, wmOperator *op, const wmEvent *event)
605 {
606         ViewZoomData *vpd = op->customdata;
607         short event_code = VIEW_PASS;
608
609         /* execute the events */
610         if (event->type == TIMER && event->customdata == vpd->timer) {
611                 /* continuous zoom */
612                 event_code = VIEW_APPLY;
613         }
614         else if (event->type == MOUSEMOVE) {
615                 event_code = VIEW_APPLY;
616         }
617         else if (event->type == vpd->event_type && event->val == KM_RELEASE) {
618                 event_code = VIEW_CONFIRM;
619         }
620
621         if (event_code == VIEW_APPLY) {
622                 image_zoom_apply(vpd, op, event->x, event->y, U.viewzoom, (U.uiflag & USER_ZOOM_INVERT) != 0);
623         }
624         else if (event_code == VIEW_CONFIRM) {
625                 image_view_zoom_exit(C, op, false);
626                 return OPERATOR_FINISHED;
627         }
628
629         return OPERATOR_RUNNING_MODAL;
630 }
631
632 static void image_view_zoom_cancel(bContext *C, wmOperator *op)
633 {
634         image_view_zoom_exit(C, op, true);
635 }
636
637 void IMAGE_OT_view_zoom(wmOperatorType *ot)
638 {
639         PropertyRNA *prop;
640
641         /* identifiers */
642         ot->name = "View Zoom";
643         ot->idname = "IMAGE_OT_view_zoom";
644         ot->description = "Zoom in/out the image";
645
646         /* api callbacks */
647         ot->exec = image_view_zoom_exec;
648         ot->invoke = image_view_zoom_invoke;
649         ot->modal = image_view_zoom_modal;
650         ot->cancel = image_view_zoom_cancel;
651         ot->poll = space_image_main_region_poll;
652
653         /* flags */
654         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_CURSOR | OPTYPE_LOCK_BYPASS;
655
656         /* properties */
657         prop = RNA_def_float(ot->srna, "factor", 0.0f, -FLT_MAX, FLT_MAX, "Factor",
658                              "Zoom factor, values higher than 1.0 zoom in, lower values zoom out", -FLT_MAX, FLT_MAX);
659         RNA_def_property_flag(prop, PROP_HIDDEN);
660 }
661
662 #ifdef WITH_INPUT_NDOF
663 /********************** NDOF operator *********************/
664
665 /* Combined pan/zoom from a 3D mouse device.
666  * Z zooms, XY pans
667  * "view" (not "paper") control -- user moves the viewpoint, not the image being viewed
668  * that explains the negative signs in the code below
669  */
670
671 static int image_view_ndof_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
672 {
673         if (event->type != NDOF_MOTION)
674                 return OPERATOR_CANCELLED;
675         else {
676                 SpaceImage *sima = CTX_wm_space_image(C);
677                 ARegion *ar = CTX_wm_region(C);
678                 float pan_vec[3];
679
680                 const wmNDOFMotionData *ndof = event->customdata;
681                 const float speed = NDOF_PIXELS_PER_SECOND;
682
683                 WM_event_ndof_pan_get(ndof, pan_vec, true);
684
685                 mul_v2_fl(pan_vec, (speed * ndof->dt) / sima->zoom);
686                 pan_vec[2] *= -ndof->dt;
687
688                 sima_zoom_set_factor(sima, ar, 1.0f + pan_vec[2], NULL);
689                 sima->xof += pan_vec[0];
690                 sima->yof += pan_vec[1];
691
692                 ED_region_tag_redraw(ar);
693
694                 return OPERATOR_FINISHED;
695         }
696 }
697
698 void IMAGE_OT_view_ndof(wmOperatorType *ot)
699 {
700         /* identifiers */
701         ot->name = "NDOF Pan/Zoom";
702         ot->idname = "IMAGE_OT_view_ndof";
703         ot->description = "Use a 3D mouse device to pan/zoom the view";
704
705         /* api callbacks */
706         ot->invoke = image_view_ndof_invoke;
707         ot->poll = space_image_main_region_poll;
708
709         /* flags */
710         ot->flag = OPTYPE_LOCK_BYPASS;
711 }
712 #endif /* WITH_INPUT_NDOF */
713
714 /********************** view all operator *********************/
715
716 /* Updates the fields of the View2D member of the SpaceImage struct.
717  * Default behavior is to reset the position of the image and set the zoom to 1
718  * If the image will not fit within the window rectangle, the zoom is adjusted */
719
720 static int image_view_all_exec(bContext *C, wmOperator *op)
721 {
722         SpaceImage *sima;
723         ARegion *ar;
724         float aspx, aspy, zoomx, zoomy, w, h;
725         int width, height;
726         const bool fit_view = RNA_boolean_get(op->ptr, "fit_view");
727
728         /* retrieve state */
729         sima = CTX_wm_space_image(C);
730         ar = CTX_wm_region(C);
731
732         ED_space_image_get_size(sima, &width, &height);
733         ED_space_image_get_aspect(sima, &aspx, &aspy);
734
735         w = width * aspx;
736         h = height * aspy;
737
738         /* check if the image will fit in the image with (zoom == 1) */
739         width  = BLI_rcti_size_x(&ar->winrct) + 1;
740         height = BLI_rcti_size_y(&ar->winrct) + 1;
741
742         if (fit_view) {
743                 const int margin = 5; /* margin from border */
744
745                 zoomx = (float) width / (w + 2 * margin);
746                 zoomy = (float) height / (h + 2 * margin);
747
748                 sima_zoom_set(sima, ar, min_ff(zoomx, zoomy), NULL);
749         }
750         else {
751                 if ((w >= width || h >= height) && (width > 0 && height > 0)) {
752                         zoomx = (float) width / w;
753                         zoomy = (float) height / h;
754
755                         /* find the zoom value that will fit the image in the image space */
756                         sima_zoom_set(sima, ar, 1.0f / power_of_2(1.0f / min_ff(zoomx, zoomy)), NULL);
757                 }
758                 else
759                         sima_zoom_set(sima, ar, 1.0f, NULL);
760         }
761
762         sima->xof = sima->yof = 0.0f;
763
764         ED_region_tag_redraw(ar);
765
766         return OPERATOR_FINISHED;
767 }
768
769 void IMAGE_OT_view_all(wmOperatorType *ot)
770 {
771         PropertyRNA *prop;
772
773         /* identifiers */
774         ot->name = "View All";
775         ot->idname = "IMAGE_OT_view_all";
776         ot->description = "View the entire image";
777
778         /* api callbacks */
779         ot->exec = image_view_all_exec;
780         ot->poll = space_image_main_region_poll;
781
782         /* flags */
783         ot->flag = OPTYPE_LOCK_BYPASS;
784
785         /* properties */
786         prop = RNA_def_boolean(ot->srna, "fit_view", 0, "Fit View", "Fit frame to the viewport");
787         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
788 }
789
790 /********************** view selected operator *********************/
791
792 static int image_view_selected_exec(bContext *C, wmOperator *UNUSED(op))
793 {
794         SpaceImage *sima;
795         ARegion *ar;
796         Scene *scene;
797         ViewLayer *view_layer;
798         Object *obedit;
799         Image *ima;
800
801         /* retrieve state */
802         sima = CTX_wm_space_image(C);
803         ar = CTX_wm_region(C);
804         scene = CTX_data_scene(C);
805         view_layer = CTX_data_view_layer(C);
806         obedit = CTX_data_edit_object(C);
807
808         ima = ED_space_image(sima);
809
810         /* get bounds */
811         float min[2], max[2];
812         if (ED_space_image_show_uvedit(sima, obedit)) {
813                 if (!ED_uvedit_minmax(scene, ima, obedit, min, max)) {
814                         return OPERATOR_CANCELLED;
815                 }
816         }
817         else if (ED_space_image_check_show_maskedit(sima, view_layer)) {
818                 if (!ED_mask_selected_minmax(C, min, max)) {
819                         return OPERATOR_CANCELLED;
820                 }
821         }
822         rctf bounds = {
823             .xmin = min[0], .ymin = min[1],
824             .xmax = max[0], .ymax = max[1],
825         };
826
827         /* add some margin */
828         BLI_rctf_scale(&bounds, 1.4f);
829
830         sima_zoom_set_from_bounds(sima, ar, &bounds);
831
832         ED_region_tag_redraw(ar);
833
834         return OPERATOR_FINISHED;
835 }
836
837 static int image_view_selected_poll(bContext *C)
838 {
839         return (space_image_main_region_poll(C) && (ED_operator_uvedit(C) || ED_operator_mask(C)));
840 }
841
842 void IMAGE_OT_view_selected(wmOperatorType *ot)
843 {
844         /* identifiers */
845         ot->name = "View Center";
846         ot->idname = "IMAGE_OT_view_selected";
847         ot->description = "View all selected UVs";
848
849         /* api callbacks */
850         ot->exec = image_view_selected_exec;
851         ot->poll = image_view_selected_poll;
852 }
853
854 /********************** view zoom in/out operator *********************/
855
856 static int image_view_zoom_in_exec(bContext *C, wmOperator *op)
857 {
858         SpaceImage *sima = CTX_wm_space_image(C);
859         ARegion *ar = CTX_wm_region(C);
860         float location[2];
861
862         RNA_float_get_array(op->ptr, "location", location);
863
864         sima_zoom_set_factor(sima, ar, powf(2.0f, 1.0f / 3.0f), location);
865
866         ED_region_tag_redraw(ar);
867
868         return OPERATOR_FINISHED;
869 }
870
871 static int image_view_zoom_in_invoke(bContext *C, wmOperator *op, const wmEvent *event)
872 {
873         ARegion *ar = CTX_wm_region(C);
874         float location[2];
875
876         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &location[0], &location[1]);
877         RNA_float_set_array(op->ptr, "location", location);
878
879         return image_view_zoom_in_exec(C, op);
880 }
881
882 void IMAGE_OT_view_zoom_in(wmOperatorType *ot)
883 {
884         PropertyRNA *prop;
885
886         /* identifiers */
887         ot->name = "View Zoom In";
888         ot->idname = "IMAGE_OT_view_zoom_in";
889         ot->description = "Zoom in the image (centered around 2D cursor)";
890
891         /* api callbacks */
892         ot->invoke = image_view_zoom_in_invoke;
893         ot->exec = image_view_zoom_in_exec;
894         ot->poll = space_image_main_region_poll;
895
896         /* flags */
897         ot->flag = OPTYPE_LOCK_BYPASS;
898
899         /* properties */
900         prop = RNA_def_float_vector(ot->srna, "location", 2, NULL, -FLT_MAX, FLT_MAX,
901                                     "Location", "Cursor location in screen coordinates", -10.0f, 10.0f);
902         RNA_def_property_flag(prop, PROP_HIDDEN);
903 }
904
905 static int image_view_zoom_out_exec(bContext *C, wmOperator *op)
906 {
907         SpaceImage *sima = CTX_wm_space_image(C);
908         ARegion *ar = CTX_wm_region(C);
909         float location[2];
910
911         RNA_float_get_array(op->ptr, "location", location);
912
913         sima_zoom_set_factor(sima, ar, powf(0.5f, 1.0f / 3.0f), location);
914
915         ED_region_tag_redraw(ar);
916
917         return OPERATOR_FINISHED;
918 }
919
920 static int image_view_zoom_out_invoke(bContext *C, wmOperator *op, const wmEvent *event)
921 {
922         ARegion *ar = CTX_wm_region(C);
923         float location[2];
924
925         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &location[0], &location[1]);
926         RNA_float_set_array(op->ptr, "location", location);
927
928         return image_view_zoom_out_exec(C, op);
929 }
930
931 void IMAGE_OT_view_zoom_out(wmOperatorType *ot)
932 {
933         PropertyRNA *prop;
934
935         /* identifiers */
936         ot->name = "View Zoom Out";
937         ot->idname = "IMAGE_OT_view_zoom_out";
938         ot->description = "Zoom out the image (centered around 2D cursor)";
939
940         /* api callbacks */
941         ot->invoke = image_view_zoom_out_invoke;
942         ot->exec = image_view_zoom_out_exec;
943         ot->poll = space_image_main_region_poll;
944
945         /* flags */
946         ot->flag = OPTYPE_LOCK_BYPASS;
947
948         /* properties */
949         prop = RNA_def_float_vector(ot->srna, "location", 2, NULL, -FLT_MAX, FLT_MAX,
950                                     "Location", "Cursor location in screen coordinates", -10.0f, 10.0f);
951         RNA_def_property_flag(prop, PROP_HIDDEN);
952 }
953
954 /********************** view zoom ratio operator *********************/
955
956 static int image_view_zoom_ratio_exec(bContext *C, wmOperator *op)
957 {
958         SpaceImage *sima = CTX_wm_space_image(C);
959         ARegion *ar = CTX_wm_region(C);
960
961         sima_zoom_set(sima, ar, RNA_float_get(op->ptr, "ratio"), NULL);
962
963         /* ensure pixel exact locations for draw */
964         sima->xof = (int)sima->xof;
965         sima->yof = (int)sima->yof;
966
967         /* XXX notifier? */
968 #if 0
969         if (image_preview_active(curarea, NULL, NULL)) {
970                 /* recalculates new preview rect */
971                 scrarea_do_windraw(curarea);
972                 image_preview_event(2);
973         }
974 #endif
975
976         ED_region_tag_redraw(ar);
977
978         return OPERATOR_FINISHED;
979 }
980
981 void IMAGE_OT_view_zoom_ratio(wmOperatorType *ot)
982 {
983         /* identifiers */
984         ot->name = "View Zoom Ratio";
985         ot->idname = "IMAGE_OT_view_zoom_ratio";
986         ot->description = "Set zoom ratio of the view";
987
988         /* api callbacks */
989         ot->exec = image_view_zoom_ratio_exec;
990         ot->poll = space_image_main_region_poll;
991
992         /* flags */
993         ot->flag = OPTYPE_LOCK_BYPASS;
994
995         /* properties */
996         RNA_def_float(ot->srna, "ratio", 0.0f, -FLT_MAX, FLT_MAX,
997                       "Ratio", "Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out", -FLT_MAX, FLT_MAX);
998 }
999
1000 /********************** view border-zoom operator *********************/
1001
1002 static int image_view_zoom_border_exec(bContext *C, wmOperator *op)
1003 {
1004         SpaceImage *sima = CTX_wm_space_image(C);
1005         ARegion *ar = CTX_wm_region(C);
1006         rctf bounds;
1007         const bool zoom_in = !RNA_boolean_get(op->ptr, "zoom_out");
1008
1009         WM_operator_properties_border_to_rctf(op, &bounds);
1010
1011         UI_view2d_region_to_view_rctf(&ar->v2d, &bounds, &bounds);
1012
1013         const struct {
1014                 float xof;
1015                 float yof;
1016                 float zoom;
1017         } sima_view_prev = {
1018                 .xof = sima->xof,
1019                 .yof = sima->yof,
1020                 .zoom = sima->zoom,
1021         };
1022
1023         sima_zoom_set_from_bounds(sima, ar, &bounds);
1024
1025         /* zoom out */
1026         if (!zoom_in) {
1027                 sima->xof = sima_view_prev.xof + (sima->xof - sima_view_prev.xof);
1028                 sima->yof = sima_view_prev.yof + (sima->yof - sima_view_prev.yof);
1029                 sima->zoom = sima_view_prev.zoom * (sima_view_prev.zoom / sima->zoom);
1030         }
1031
1032         ED_region_tag_redraw(ar);
1033
1034         return OPERATOR_FINISHED;
1035 }
1036
1037 void IMAGE_OT_view_zoom_border(wmOperatorType *ot)
1038 {
1039         /* identifiers */
1040         ot->name = "Zoom to Border";
1041         ot->description = "Zoom in the view to the nearest item contained in the border";
1042         ot->idname = "IMAGE_OT_view_zoom_border";
1043
1044         /* api callbacks */
1045         ot->invoke = WM_gesture_border_invoke;
1046         ot->exec = image_view_zoom_border_exec;
1047         ot->modal = WM_gesture_border_modal;
1048         ot->cancel = WM_gesture_border_cancel;
1049
1050         ot->poll = space_image_main_region_poll;
1051
1052         /* rna */
1053         WM_operator_properties_gesture_border_zoom(ot);
1054 }
1055
1056 /**************** load/replace/save callbacks ******************/
1057 static void image_filesel(bContext *C, wmOperator *op, const char *path)
1058 {
1059         RNA_string_set(op->ptr, "filepath", path);
1060         WM_event_add_fileselect(C, op);
1061 }
1062
1063 /******************** open image operator ********************/
1064
1065 typedef struct ImageOpenData {
1066         PropertyPointerRNA pprop;
1067         ImageUser *iuser;
1068         ImageFormatData im_format;
1069 } ImageOpenData;
1070
1071 typedef struct ImageFrameRange {
1072         struct ImageFrameRange *next, *prev;
1073         ListBase frames;
1074         /**  The full path of the first file in the list of image files */
1075         char filepath[FILE_MAX];
1076 } ImageFrameRange;
1077
1078 typedef struct ImageFrame {
1079         struct ImageFrame *next, *prev;
1080         int framenr;
1081 } ImageFrame;
1082
1083 static void image_open_init(bContext *C, wmOperator *op)
1084 {
1085         ImageOpenData *iod;
1086         op->customdata = iod = MEM_callocN(sizeof(ImageOpenData), __func__);
1087         iod->iuser = CTX_data_pointer_get_type(C, "image_user", &RNA_ImageUser).data;
1088         UI_context_active_but_prop_get_templateID(C, &iod->pprop.ptr, &iod->pprop.prop);
1089 }
1090
1091 static void image_open_cancel(bContext *UNUSED(C), wmOperator *op)
1092 {
1093         MEM_freeN(op->customdata);
1094         op->customdata = NULL;
1095 }
1096
1097 /**
1098  * \brief Get a list of frames from the list of image files matching the first file name sequence pattern
1099  * \param ptr [in] the RNA pointer containing the "directory" entry and "files" collection
1100  * \param frames_all [out] the list of frame numbers found in the files matching the first one by name
1101  */
1102 static void image_sequence_get_frame_ranges(PointerRNA *ptr, ListBase *frames_all)
1103 {
1104         char dir[FILE_MAXDIR];
1105         const bool do_frame_range = RNA_boolean_get(ptr, "use_sequence_detection");
1106         ImageFrameRange *frame_range = NULL;
1107
1108         RNA_string_get(ptr, "directory", dir);
1109         RNA_BEGIN (ptr, itemptr, "files")
1110         {
1111                 char base_head[FILE_MAX], base_tail[FILE_MAX];
1112                 char head[FILE_MAX], tail[FILE_MAX];
1113                 unsigned short digits;
1114                 char *filename = RNA_string_get_alloc(&itemptr, "name", NULL, 0);
1115                 ImageFrame *frame = MEM_callocN(sizeof(ImageFrame), "image_frame");
1116
1117                 /* use the first file in the list as base filename */
1118                 frame->framenr = BLI_stringdec(filename, head, tail, &digits);
1119
1120                 /* still in the same sequence */
1121                 if (do_frame_range &&
1122                     (frame_range != NULL) &&
1123                     (STREQLEN(base_head, head, FILE_MAX)) &&
1124                     (STREQLEN(base_tail, tail, FILE_MAX)))
1125                 {
1126                         /* pass */
1127                 }
1128                 else {
1129                         /* start a new frame range */
1130                         frame_range = MEM_callocN(sizeof(*frame_range), __func__);
1131                         BLI_join_dirfile(frame_range->filepath, sizeof(frame_range->filepath), dir, filename);
1132                         BLI_addtail(frames_all, frame_range);
1133
1134                         BLI_strncpy(base_head, head, sizeof(base_head));
1135                         BLI_strncpy(base_tail, tail, sizeof(base_tail));
1136                 }
1137
1138                 BLI_addtail(&frame_range->frames, frame);
1139                 MEM_freeN(filename);
1140         }
1141         RNA_END
1142 }
1143
1144 static int image_cmp_frame(const void *a, const void *b)
1145 {
1146         const ImageFrame *frame_a = a;
1147         const ImageFrame *frame_b = b;
1148
1149         if (frame_a->framenr < frame_b->framenr) return -1;
1150         if (frame_a->framenr > frame_b->framenr) return 1;
1151         return 0;
1152 }
1153
1154 /**
1155  * Return the start (offset) and the length of the sequence of continuous frames in the list of frames
1156  *
1157  * \param frames: [in] the list of frame numbers, as a side-effect the list is sorted.
1158  * \param ofs: [out] offset the first frame number in the sequence.
1159  * \return the number of contiguous frames in the sequence
1160  */
1161 static int image_sequence_get_len(ListBase *frames, int *ofs)
1162 {
1163         ImageFrame *frame;
1164
1165         BLI_listbase_sort(frames, image_cmp_frame);
1166
1167         frame = frames->first;
1168         if (frame) {
1169                 int frame_curr = frame->framenr;
1170                 (*ofs) = frame_curr;
1171                 while (frame && (frame->framenr == frame_curr)) {
1172                         frame_curr++;
1173                         frame = frame->next;
1174                 }
1175                 return frame_curr - (*ofs);
1176         }
1177         *ofs = 0;
1178         return 0;
1179 }
1180
1181 static Image *image_open_single(
1182         wmOperator *op, const char *filepath, const char *relbase,
1183         bool is_relative_path, bool use_multiview, int frame_seq_len)
1184 {
1185         bool exists = false;
1186         Image *ima = NULL;
1187
1188         errno = 0;
1189         ima = BKE_image_load_exists_ex(filepath, &exists);
1190
1191         if (!ima) {
1192                 if (op->customdata) MEM_freeN(op->customdata);
1193                 BKE_reportf(op->reports, RPT_ERROR, "Cannot read '%s': %s",
1194                             filepath, errno ? strerror(errno) : TIP_("unsupported image format"));
1195                 return NULL;
1196         }
1197
1198         if (!exists) {
1199                 /* only image path after save, never ibuf */
1200                 if (is_relative_path) {
1201                         BLI_path_rel(ima->name, relbase);
1202                 }
1203
1204                 /* handle multiview images */
1205                 if (use_multiview) {
1206                         ImageOpenData *iod = op->customdata;
1207                         ImageFormatData *imf = &iod->im_format;
1208
1209                         ima->flag |= IMA_USE_VIEWS;
1210                         ima->views_format = imf->views_format;
1211                         *ima->stereo3d_format = imf->stereo3d_format;
1212                 }
1213                 else {
1214                         ima->flag &= ~IMA_USE_VIEWS;
1215                         BKE_image_free_views(ima);
1216                 }
1217
1218                 if ((frame_seq_len > 1) && (ima->source == IMA_SRC_FILE)) {
1219                         ima->source = IMA_SRC_SEQUENCE;
1220                 }
1221         }
1222
1223         return ima;
1224 }
1225
1226
1227 static int image_open_exec(bContext *C, wmOperator *op)
1228 {
1229         Main *bmain = CTX_data_main(C);
1230         ScrArea *sa = CTX_wm_area(C);
1231         Scene *scene = CTX_data_scene(C);
1232         Object *obedit = CTX_data_edit_object(C);
1233         ImageUser *iuser = NULL;
1234         ImageOpenData *iod = op->customdata;
1235         PointerRNA idptr;
1236         Image *ima = NULL;
1237         char filepath[FILE_MAX];
1238         int frame_seq_len = 0;
1239         int frame_ofs = 1;
1240
1241         const bool is_relative_path = RNA_boolean_get(op->ptr, "relative_path");
1242         const bool use_multiview    = RNA_boolean_get(op->ptr, "use_multiview");
1243
1244         if (!op->customdata)
1245                 image_open_init(C, op);
1246
1247         RNA_string_get(op->ptr, "filepath", filepath);
1248
1249         if (RNA_struct_property_is_set(op->ptr, "directory") &&
1250             RNA_struct_property_is_set(op->ptr, "files"))
1251         {
1252                 bool was_relative = BLI_path_is_rel(filepath);
1253                 ListBase frame_ranges_all;
1254
1255                 BLI_listbase_clear(&frame_ranges_all);
1256                 image_sequence_get_frame_ranges(op->ptr, &frame_ranges_all);
1257                 for (ImageFrameRange *frame_range = frame_ranges_all.first; frame_range; frame_range = frame_range->next) {
1258                         int frame_range_ofs;
1259                         int frame_range_seq_len = image_sequence_get_len(&frame_range->frames, &frame_range_ofs);
1260                         BLI_freelistN(&frame_range->frames);
1261
1262                         char filepath_range[FILE_MAX];
1263                         BLI_strncpy(filepath_range, frame_range->filepath, sizeof(filepath_range));
1264
1265                         if (was_relative) {
1266                                 BLI_path_rel(filepath_range, bmain->name);
1267                         }
1268
1269                         Image *ima_range = image_open_single(
1270                                  op, filepath_range, bmain->name,
1271                                  is_relative_path, use_multiview, frame_range_seq_len);
1272
1273                         /* take the first image */
1274                         if ((ima == NULL) && ima_range) {
1275                                 ima = ima_range;
1276                                 frame_seq_len = frame_range_seq_len;
1277                                 frame_ofs = frame_range_ofs;
1278                         }
1279                 }
1280                 BLI_freelistN(&frame_ranges_all);
1281         }
1282         else {
1283                 /* for drag & drop etc. */
1284                 ima = image_open_single(
1285                         op, filepath, bmain->name,
1286                         is_relative_path, use_multiview, 1);
1287         }
1288
1289         if (ima == NULL) {
1290                 return OPERATOR_CANCELLED;
1291         }
1292
1293         /* hook into UI */
1294         iod = op->customdata;
1295
1296         if (iod->pprop.prop) {
1297                 /* when creating new ID blocks, use is already 1, but RNA
1298                  * pointer use also increases user, so this compensates it */
1299                 id_us_min(&ima->id);
1300
1301                 RNA_id_pointer_create(&ima->id, &idptr);
1302                 RNA_property_pointer_set(&iod->pprop.ptr, iod->pprop.prop, idptr);
1303                 RNA_property_update(C, &iod->pprop.ptr, iod->pprop.prop);
1304         }
1305
1306         if (iod->iuser) {
1307                 iuser = iod->iuser;
1308         }
1309         else if (sa && sa->spacetype == SPACE_IMAGE) {
1310                 SpaceImage *sima = sa->spacedata.first;
1311                 ED_space_image_set(sima, scene, obedit, ima);
1312                 iuser = &sima->iuser;
1313         }
1314         else {
1315                 Tex *tex = CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
1316                 if (tex && tex->type == TEX_IMAGE) {
1317                         iuser = &tex->iuser;
1318                 }
1319
1320                 if (iuser == NULL) {
1321                         Camera *cam = CTX_data_pointer_get_type(C, "camera", &RNA_Camera).data;
1322                         if (cam) {
1323                                 for (CameraBGImage *bgpic = cam->bg_images.first; bgpic; bgpic = bgpic->next) {
1324                                         if (bgpic->ima == ima) {
1325                                                 iuser = &bgpic->iuser;
1326                                                 break;
1327                                         }
1328                                 }
1329                         }
1330                 }
1331         }
1332
1333         /* initialize because of new image */
1334         if (iuser) {
1335                 iuser->frames = frame_seq_len;
1336                 iuser->sfra = 1;
1337                 iuser->framenr = 1;
1338                 if (ima->source == IMA_SRC_MOVIE) {
1339                         iuser->offset = 0;
1340                 }
1341                 else {
1342                         iuser->offset = frame_ofs - 1;
1343                 }
1344                 iuser->fie_ima = 2;
1345                 iuser->scene = scene;
1346                 BKE_image_init_imageuser(ima, iuser);
1347         }
1348
1349         /* XXX unpackImage frees image buffers */
1350         ED_preview_kill_jobs(CTX_wm_manager(C), bmain);
1351
1352         BKE_image_signal(ima, iuser, IMA_SIGNAL_RELOAD);
1353         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
1354
1355         MEM_freeN(op->customdata);
1356
1357         return OPERATOR_FINISHED;
1358 }
1359
1360 static int image_open_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1361 {
1362         SpaceImage *sima = CTX_wm_space_image(C); /* XXX other space types can call */
1363         const char *path = U.textudir;
1364         Image *ima = NULL;
1365         Scene *scene = CTX_data_scene(C);
1366
1367         if (sima) {
1368                 ima = sima->image;
1369         }
1370
1371         if (ima == NULL) {
1372                 Tex *tex = CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
1373                 if (tex && tex->type == TEX_IMAGE)
1374                         ima = tex->ima;
1375         }
1376
1377         if (ima == NULL) {
1378                 PointerRNA ptr;
1379                 PropertyRNA *prop;
1380
1381                 /* hook into UI */
1382                 UI_context_active_but_prop_get_templateID(C, &ptr, &prop);
1383
1384                 if (prop) {
1385                         PointerRNA oldptr;
1386                         Image *oldima;
1387
1388                         oldptr = RNA_property_pointer_get(&ptr, prop);
1389                         oldima = (Image *)oldptr.id.data;
1390                         /* unlikely to fail but better avoid strange crash */
1391                         if (oldima && GS(oldima->id.name) == ID_IM) {
1392                                 ima = oldima;
1393                         }
1394                 }
1395         }
1396
1397         if (ima)
1398                 path = ima->name;
1399
1400         if (RNA_struct_property_is_set(op->ptr, "filepath"))
1401                 return image_open_exec(C, op);
1402
1403         image_open_init(C, op);
1404
1405         /* show multiview save options only if scene has multiviews */
1406         PropertyRNA *prop;
1407         prop = RNA_struct_find_property(op->ptr, "show_multiview");
1408         RNA_property_boolean_set(op->ptr, prop, (scene->r.scemode & R_MULTIVIEW) != 0);
1409
1410         image_filesel(C, op, path);
1411
1412         return OPERATOR_RUNNING_MODAL;
1413 }
1414
1415 static bool image_open_draw_check_prop(PointerRNA *UNUSED(ptr), PropertyRNA *prop)
1416 {
1417         const char *prop_id = RNA_property_identifier(prop);
1418
1419         return !(STREQ(prop_id, "filepath") ||
1420                  STREQ(prop_id, "directory") ||
1421                  STREQ(prop_id, "filename")
1422                  );
1423 }
1424
1425 static void image_open_draw(bContext *UNUSED(C), wmOperator *op)
1426 {
1427         uiLayout *layout = op->layout;
1428         ImageOpenData *iod = op->customdata;
1429         ImageFormatData *imf = &iod->im_format;
1430         PointerRNA imf_ptr, ptr;
1431
1432         /* main draw call */
1433         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
1434         uiDefAutoButsRNA(layout, &ptr, image_open_draw_check_prop, UI_BUT_LABEL_ALIGN_NONE, false);
1435
1436         /* image template */
1437         RNA_pointer_create(NULL, &RNA_ImageFormatSettings, imf, &imf_ptr);
1438
1439         /* multiview template */
1440         if (RNA_boolean_get(op->ptr, "show_multiview"))
1441                 uiTemplateImageFormatViews(layout, &imf_ptr, op->ptr);
1442 }
1443
1444 /* called by other space types too */
1445 void IMAGE_OT_open(wmOperatorType *ot)
1446 {
1447         /* identifiers */
1448         ot->name = "Open Image";
1449         ot->description = "Open image";
1450         ot->idname = "IMAGE_OT_open";
1451
1452         /* api callbacks */
1453         ot->exec = image_open_exec;
1454         ot->invoke = image_open_invoke;
1455         ot->cancel = image_open_cancel;
1456         ot->ui = image_open_draw;
1457
1458         /* flags */
1459         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1460
1461         /* properties */
1462         WM_operator_properties_filesel(
1463                 ot, FILE_TYPE_FOLDER | FILE_TYPE_IMAGE | FILE_TYPE_MOVIE, FILE_SPECIAL, FILE_OPENFILE,
1464                 WM_FILESEL_FILEPATH | WM_FILESEL_DIRECTORY | WM_FILESEL_FILES | WM_FILESEL_RELPATH,
1465                 FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
1466
1467         RNA_def_boolean(ot->srna, "use_sequence_detection", true, "Detect Sequences",
1468                         "Automatically detect animated sequences in selected images (based on file names)");
1469 }
1470
1471 /******************** Match movie length operator ********************/
1472 static int image_match_len_exec(bContext *C, wmOperator *UNUSED(op))
1473 {
1474         Scene *scene = CTX_data_scene(C);
1475         Image *ima = CTX_data_pointer_get_type(C, "edit_image", &RNA_Image).data;
1476         ImageUser *iuser = CTX_data_pointer_get_type(C, "edit_image_user", &RNA_ImageUser).data;
1477
1478         if (!ima || !iuser) {
1479                 /* Try to get a Texture, or a SpaceImage from context... */
1480                 SpaceImage *sima = CTX_wm_space_image(C);
1481                 Tex *tex = CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
1482                 if (tex && tex->type == TEX_IMAGE) {
1483                         ima = tex->ima;
1484                         iuser = &tex->iuser;
1485                 }
1486                 else if (sima) {
1487                         ima = sima->image;
1488                         iuser = &sima->iuser;
1489                 }
1490
1491         }
1492
1493         if (!ima || !iuser || !BKE_image_has_anim(ima))
1494                 return OPERATOR_CANCELLED;
1495
1496         struct anim *anim = ((ImageAnim *)ima->anims.first)->anim;
1497         if (!anim)
1498                 return OPERATOR_CANCELLED;
1499         iuser->frames = IMB_anim_get_duration(anim, IMB_TC_RECORD_RUN);
1500         BKE_image_user_frame_calc(iuser, scene->r.cfra, 0);
1501
1502         return OPERATOR_FINISHED;
1503 }
1504
1505 /* called by other space types too */
1506 void IMAGE_OT_match_movie_length(wmOperatorType *ot)
1507 {
1508         /* identifiers */
1509         ot->name = "Match Movie Length";
1510         ot->description = "Set image's user's length to the one of this video";
1511         ot->idname = "IMAGE_OT_match_movie_length";
1512
1513         /* api callbacks */
1514         ot->exec = image_match_len_exec;
1515
1516         /* flags */
1517         ot->flag = OPTYPE_REGISTER | OPTYPE_INTERNAL/* | OPTYPE_UNDO */; /* Don't think we need undo for that. */
1518 }
1519
1520 /******************** replace image operator ********************/
1521
1522 static int image_replace_exec(bContext *C, wmOperator *op)
1523 {
1524         SpaceImage *sima = CTX_wm_space_image(C);
1525         char str[FILE_MAX];
1526
1527         if (!sima->image)
1528                 return OPERATOR_CANCELLED;
1529
1530         RNA_string_get(op->ptr, "filepath", str);
1531
1532         /* we cant do much if the str is longer then FILE_MAX :/ */
1533         BLI_strncpy(sima->image->name, str, sizeof(sima->image->name));
1534
1535         if (sima->image->source == IMA_SRC_GENERATED) {
1536                 sima->image->source = IMA_SRC_FILE;
1537                 BKE_image_signal(sima->image, &sima->iuser, IMA_SIGNAL_SRC_CHANGE);
1538         }
1539
1540         if (BLI_testextensie_array(str, imb_ext_movie))
1541                 sima->image->source = IMA_SRC_MOVIE;
1542         else
1543                 sima->image->source = IMA_SRC_FILE;
1544
1545         /* XXX unpackImage frees image buffers */
1546         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
1547
1548         BKE_icon_changed(BKE_icon_id_ensure(&sima->image->id));
1549         BKE_image_signal(sima->image, &sima->iuser, IMA_SIGNAL_RELOAD);
1550         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, sima->image);
1551
1552         return OPERATOR_FINISHED;
1553 }
1554
1555 static int image_replace_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1556 {
1557         SpaceImage *sima = CTX_wm_space_image(C);
1558
1559         if (!sima->image)
1560                 return OPERATOR_CANCELLED;
1561
1562         if (RNA_struct_property_is_set(op->ptr, "filepath"))
1563                 return image_replace_exec(C, op);
1564
1565         if (!RNA_struct_property_is_set(op->ptr, "relative_path"))
1566                 RNA_boolean_set(op->ptr, "relative_path", BLI_path_is_rel(sima->image->name));
1567
1568         image_filesel(C, op, sima->image->name);
1569
1570         return OPERATOR_RUNNING_MODAL;
1571 }
1572
1573 void IMAGE_OT_replace(wmOperatorType *ot)
1574 {
1575         /* identifiers */
1576         ot->name = "Replace Image";
1577         ot->idname = "IMAGE_OT_replace";
1578         ot->description = "Replace current image by another one from disk";
1579
1580         /* api callbacks */
1581         ot->exec = image_replace_exec;
1582         ot->invoke = image_replace_invoke;
1583         ot->poll = image_not_packed_poll;
1584
1585         /* flags */
1586         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1587
1588         /* properties */
1589         WM_operator_properties_filesel(
1590                 ot, FILE_TYPE_FOLDER | FILE_TYPE_IMAGE | FILE_TYPE_MOVIE, FILE_SPECIAL, FILE_OPENFILE,
1591                 WM_FILESEL_FILEPATH | WM_FILESEL_RELPATH, FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
1592 }
1593
1594 /******************** save image as operator ********************/
1595
1596 typedef struct {
1597         /* matching scene->r settings */
1598         //short planes, imtype, subimtype, quality;
1599         ImageFormatData im_format;
1600         char filepath[FILE_MAX]; /* keep absolute */
1601 } SaveImageOptions;
1602
1603 static void save_image_options_defaults(SaveImageOptions *simopts)
1604 {
1605         BKE_imformat_defaults(&simopts->im_format);
1606         simopts->filepath[0] = '\0';
1607 }
1608
1609 static char imtype_best_depth(ImBuf *ibuf, const char imtype)
1610 {
1611         const char depth_ok = BKE_imtype_valid_depths(imtype);
1612
1613         if (ibuf->rect_float) {
1614                 if (depth_ok & R_IMF_CHAN_DEPTH_32) return R_IMF_CHAN_DEPTH_32;
1615                 if (depth_ok & R_IMF_CHAN_DEPTH_24) return R_IMF_CHAN_DEPTH_24;
1616                 if (depth_ok & R_IMF_CHAN_DEPTH_16) return R_IMF_CHAN_DEPTH_16;
1617                 if (depth_ok & R_IMF_CHAN_DEPTH_12) return R_IMF_CHAN_DEPTH_12;
1618                 return R_IMF_CHAN_DEPTH_8;
1619         }
1620         else {
1621                 if (depth_ok & R_IMF_CHAN_DEPTH_8) return R_IMF_CHAN_DEPTH_8;
1622                 if (depth_ok & R_IMF_CHAN_DEPTH_12) return R_IMF_CHAN_DEPTH_12;
1623                 if (depth_ok & R_IMF_CHAN_DEPTH_16) return R_IMF_CHAN_DEPTH_16;
1624                 if (depth_ok & R_IMF_CHAN_DEPTH_24) return R_IMF_CHAN_DEPTH_24;
1625                 if (depth_ok & R_IMF_CHAN_DEPTH_32) return R_IMF_CHAN_DEPTH_32;
1626                 return R_IMF_CHAN_DEPTH_8; /* fallback, should not get here */
1627         }
1628 }
1629
1630 static int save_image_options_init(Main *bmain, SaveImageOptions *simopts, SpaceImage *sima, Scene *scene,
1631                                    const bool guess_path, const bool save_as_render)
1632 {
1633         void *lock;
1634         ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
1635
1636         if (ibuf) {
1637                 Image *ima = sima->image;
1638                 bool is_depth_set = false;
1639
1640                 if (ELEM(ima->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE)) {
1641                         /* imtype */
1642                         simopts->im_format = scene->r.im_format;
1643                         is_depth_set = true;
1644                         if (!BKE_image_is_multiview(ima)) {
1645                                 /* In case multiview is disabled, render settings would be invalid for render result in this area. */
1646                                 simopts->im_format.stereo3d_format = *ima->stereo3d_format;
1647                                 simopts->im_format.views_format = ima->views_format;
1648                         }
1649                 }
1650                 else {
1651                         if (ima->source == IMA_SRC_GENERATED) {
1652                                 simopts->im_format.imtype = R_IMF_IMTYPE_PNG;
1653                                 simopts->im_format.compress = ibuf->foptions.quality;
1654                                 simopts->im_format.planes = ibuf->planes;
1655                         }
1656                         else {
1657                                 BKE_imbuf_to_image_format(&simopts->im_format, ibuf);
1658                         }
1659
1660                         /* use the multiview image settings as the default */
1661                         simopts->im_format.stereo3d_format = *ima->stereo3d_format;
1662                         simopts->im_format.views_format = ima->views_format;
1663                 }
1664
1665                 //simopts->subimtype = scene->r.subimtype; /* XXX - this is lame, we need to make these available too! */
1666
1667                 BLI_strncpy(simopts->filepath, ibuf->name, sizeof(simopts->filepath));
1668
1669                 /* sanitize all settings */
1670
1671                 /* unlikely but just in case */
1672                 if (ELEM(simopts->im_format.planes, R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA) == 0) {
1673                         simopts->im_format.planes = R_IMF_PLANES_RGBA;
1674                 }
1675
1676                 /* depth, account for float buffer and format support */
1677                 if (is_depth_set == false) {
1678                         simopts->im_format.depth = imtype_best_depth(ibuf, simopts->im_format.imtype);
1679                 }
1680
1681                 /* some formats don't use quality so fallback to scenes quality */
1682                 if (simopts->im_format.quality == 0) {
1683                         simopts->im_format.quality = scene->r.im_format.quality;
1684                 }
1685
1686                 /* check for empty path */
1687                 if (guess_path && simopts->filepath[0] == 0) {
1688                         const bool is_prev_save = !STREQ(G.ima, "//");
1689                         if (save_as_render) {
1690                                 if (is_prev_save) {
1691                                         BLI_strncpy(simopts->filepath, G.ima, sizeof(simopts->filepath));
1692                                 }
1693                                 else {
1694                                         BLI_strncpy(simopts->filepath, "//untitled", sizeof(simopts->filepath));
1695                                         BLI_path_abs(simopts->filepath, bmain->name);
1696                                 }
1697                         }
1698                         else {
1699                                 BLI_snprintf(simopts->filepath, sizeof(simopts->filepath), "//%s", ima->id.name + 2);
1700                                 BLI_path_abs(simopts->filepath, is_prev_save ? G.ima : bmain->name);
1701                         }
1702                 }
1703
1704                 /* color management */
1705                 BKE_color_managed_display_settings_copy(&simopts->im_format.display_settings, &scene->display_settings);
1706                 BKE_color_managed_view_settings_copy(&simopts->im_format.view_settings, &scene->view_settings);
1707         }
1708
1709         ED_space_image_release_buffer(sima, ibuf, lock);
1710
1711         return (ibuf != NULL);
1712 }
1713
1714 static void save_image_options_from_op(Main *bmain, SaveImageOptions *simopts, wmOperator *op)
1715 {
1716         if (op->customdata) {
1717                 BKE_color_managed_view_settings_free(&simopts->im_format.view_settings);
1718
1719                 simopts->im_format = *(ImageFormatData *)op->customdata;
1720         }
1721
1722         if (RNA_struct_property_is_set(op->ptr, "filepath")) {
1723                 RNA_string_get(op->ptr, "filepath", simopts->filepath);
1724                 BLI_path_abs(simopts->filepath, bmain->name);
1725         }
1726 }
1727
1728 static void save_image_options_to_op(SaveImageOptions *simopts, wmOperator *op)
1729 {
1730         if (op->customdata) {
1731                 BKE_color_managed_view_settings_free(&((ImageFormatData *)op->customdata)->view_settings);
1732
1733                 *(ImageFormatData *)op->customdata = simopts->im_format;
1734         }
1735
1736         RNA_string_set(op->ptr, "filepath", simopts->filepath);
1737 }
1738
1739 static void save_image_post(
1740         wmOperator *op, ImBuf *ibuf, Image *ima, int ok, int save_copy,
1741         const char *relbase, int relative, int do_newpath, const char *filepath)
1742 {
1743         if (ok) {
1744                 if (!save_copy) {
1745                         ColorManagedColorspaceSettings old_colorspace_settings;
1746
1747                         if (do_newpath) {
1748                                 BLI_strncpy(ibuf->name, filepath, sizeof(ibuf->name));
1749                                 BLI_strncpy(ima->name, filepath, sizeof(ima->name));
1750                         }
1751
1752                         ibuf->userflags &= ~IB_BITMAPDIRTY;
1753
1754                         /* change type? */
1755                         if (ima->type == IMA_TYPE_R_RESULT) {
1756                                 ima->type = IMA_TYPE_IMAGE;
1757
1758                                 /* workaround to ensure the render result buffer is no longer used
1759                                  * by this image, otherwise can crash when a new render result is
1760                                  * created. */
1761                                 if (ibuf->rect && !(ibuf->mall & IB_rect))
1762                                         imb_freerectImBuf(ibuf);
1763                                 if (ibuf->rect_float && !(ibuf->mall & IB_rectfloat))
1764                                         imb_freerectfloatImBuf(ibuf);
1765                                 if (ibuf->zbuf && !(ibuf->mall & IB_zbuf))
1766                                         IMB_freezbufImBuf(ibuf);
1767                                 if (ibuf->zbuf_float && !(ibuf->mall & IB_zbuffloat))
1768                                         IMB_freezbuffloatImBuf(ibuf);
1769                         }
1770                         if (ELEM(ima->source, IMA_SRC_GENERATED, IMA_SRC_VIEWER)) {
1771                                 ima->source = IMA_SRC_FILE;
1772                                 ima->type = IMA_TYPE_IMAGE;
1773                         }
1774
1775                         /* only image path, never ibuf */
1776                         if (relative) {
1777                                 BLI_path_rel(ima->name, relbase); /* only after saving */
1778                         }
1779
1780                         BKE_color_managed_colorspace_settings_copy(&old_colorspace_settings,
1781                                                                    &ima->colorspace_settings);
1782                         IMB_colormanagment_colorspace_from_ibuf_ftype(&ima->colorspace_settings, ibuf);
1783                         if (!BKE_color_managed_colorspace_settings_equals(&old_colorspace_settings,
1784                                                                           &ima->colorspace_settings))
1785                         {
1786                                 BKE_image_signal(ima, NULL, IMA_SIGNAL_COLORMANAGE);
1787                         }
1788                 }
1789         }
1790         else {
1791                 BKE_reportf(op->reports, RPT_ERROR, "Could not write image: %s", strerror(errno));
1792         }
1793 }
1794
1795 static void save_imbuf_post(ImBuf *ibuf, ImBuf *colormanaged_ibuf)
1796 {
1797         if (colormanaged_ibuf != ibuf) {
1798                 /* This guys might be modified by image buffer write functions,
1799                  * need to copy them back from color managed image buffer to an
1800                  * original one, so file type of image is being properly updated.
1801                  */
1802                 ibuf->ftype = colormanaged_ibuf->ftype;
1803                 ibuf->foptions = colormanaged_ibuf->foptions;
1804                 ibuf->planes = colormanaged_ibuf->planes;
1805
1806                 IMB_freeImBuf(colormanaged_ibuf);
1807         }
1808 }
1809
1810 /**
1811  * \return success.
1812  * \note ``ima->name`` and ``ibuf->name`` should end up the same.
1813  * \note for multiview the first ``ibuf`` is important to get the settings.
1814  */
1815 static bool save_image_doit(bContext *C, SpaceImage *sima, wmOperator *op, SaveImageOptions *simopts, bool do_newpath)
1816 {
1817         Image *ima = ED_space_image(sima);
1818         void *lock;
1819         ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
1820         Scene *scene;
1821         RenderResult *rr = NULL;
1822         bool ok = false;
1823
1824         WM_cursor_wait(1);
1825
1826         if (ibuf) {
1827                 ImBuf *colormanaged_ibuf = NULL;
1828                 const char *relbase = ID_BLEND_PATH(CTX_data_main(C), &ima->id);
1829                 const bool relative = (RNA_struct_find_property(op->ptr, "relative_path") && RNA_boolean_get(op->ptr, "relative_path"));
1830                 const bool save_copy = (RNA_struct_find_property(op->ptr, "copy") && RNA_boolean_get(op->ptr, "copy"));
1831                 const bool save_as_render = (RNA_struct_find_property(op->ptr, "save_as_render") && RNA_boolean_get(op->ptr, "save_as_render"));
1832                 ImageFormatData *imf = &simopts->im_format;
1833
1834                 /* old global to ensure a 2nd save goes to same dir */
1835                 BLI_strncpy(G.ima, simopts->filepath, sizeof(G.ima));
1836
1837                 if (ima->type == IMA_TYPE_R_RESULT) {
1838                         /* enforce user setting for RGB or RGBA, but skip BW */
1839                         if (simopts->im_format.planes == R_IMF_PLANES_RGBA) {
1840                                 ibuf->planes = R_IMF_PLANES_RGBA;
1841                         }
1842                         else if (simopts->im_format.planes == R_IMF_PLANES_RGB) {
1843                                 ibuf->planes = R_IMF_PLANES_RGB;
1844                         }
1845                 }
1846                 else {
1847                         /* TODO, better solution, if a 24bit image is painted onto it may contain alpha */
1848                         if ((simopts->im_format.planes == R_IMF_PLANES_RGBA) &&
1849                             /* it has been painted onto */
1850                             (ibuf->userflags & IB_BITMAPDIRTY))
1851                         {
1852                                 /* checks each pixel, not ideal */
1853                                 ibuf->planes = BKE_imbuf_alpha_test(ibuf) ? R_IMF_PLANES_RGBA : R_IMF_PLANES_RGB;
1854                         }
1855                 }
1856
1857                 /* we need renderresult for exr and rendered multiview */
1858                 scene = CTX_data_scene(C);
1859                 rr = BKE_image_acquire_renderresult(scene, ima);
1860                 bool is_mono = rr ? BLI_listbase_count_at_most(&rr->views, 2) < 2 : BLI_listbase_count_at_most(&ima->views, 2) < 2;
1861                 bool is_exr_rr = rr && ELEM(imf->imtype, R_IMF_IMTYPE_OPENEXR, R_IMF_IMTYPE_MULTILAYER) && RE_HasFloatPixels(rr);
1862
1863                 /* error handling */
1864                 if (!rr) {
1865                         if (imf->imtype == R_IMF_IMTYPE_MULTILAYER) {
1866                                 BKE_report(op->reports, RPT_ERROR, "Did not write, no Multilayer Image");
1867                                 goto cleanup;
1868                         }
1869                 }
1870                 else {
1871                         if (imf->views_format == R_IMF_VIEWS_STEREO_3D) {
1872                                 if (!BKE_image_is_stereo(ima)) {
1873                                         BKE_reportf(op->reports, RPT_ERROR, "Did not write, the image doesn't have a \"%s\" and \"%s\" views",
1874                                                    STEREO_LEFT_NAME, STEREO_RIGHT_NAME);
1875                                         goto cleanup;
1876                                 }
1877
1878                                 /* it shouldn't ever happen*/
1879                                 if ((BLI_findstring(&rr->views, STEREO_LEFT_NAME, offsetof(RenderView, name)) == NULL) ||
1880                                     (BLI_findstring(&rr->views, STEREO_RIGHT_NAME, offsetof(RenderView, name)) == NULL))
1881                                 {
1882                                         BKE_reportf(op->reports, RPT_ERROR, "Did not write, the image doesn't have a \"%s\" and \"%s\" views",
1883                                                    STEREO_LEFT_NAME, STEREO_RIGHT_NAME);
1884                                         goto cleanup;
1885                                 }
1886                         }
1887                         BKE_imbuf_stamp_info(rr, ibuf);
1888                 }
1889
1890                 /* fancy multiview OpenEXR */
1891                 if (imf->views_format == R_IMF_VIEWS_MULTIVIEW && is_exr_rr) {
1892                         /* save render result */
1893                         ok = RE_WriteRenderResult(op->reports, rr, simopts->filepath, imf, NULL, sima->iuser.layer);
1894                         save_image_post(op, ibuf, ima, ok, true, relbase, relative, do_newpath, simopts->filepath);
1895                         ED_space_image_release_buffer(sima, ibuf, lock);
1896                 }
1897                 /* regular mono pipeline */
1898                 else if (is_mono) {
1899                         if (is_exr_rr) {
1900                                 ok = RE_WriteRenderResult(op->reports, rr, simopts->filepath, imf, NULL, -1);
1901                         }
1902                         else {
1903                                 colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(ibuf, save_as_render, true, &imf->view_settings, &imf->display_settings, imf);
1904                                 ok = BKE_imbuf_write_as(colormanaged_ibuf, simopts->filepath, imf, save_copy);
1905                                 save_imbuf_post(ibuf, colormanaged_ibuf);
1906                         }
1907                         save_image_post(op, ibuf, ima, ok, (is_exr_rr ? true : save_copy), relbase, relative, do_newpath, simopts->filepath);
1908                         ED_space_image_release_buffer(sima, ibuf, lock);
1909                 }
1910                 /* individual multiview images */
1911                 else if (imf->views_format == R_IMF_VIEWS_INDIVIDUAL) {
1912                         int i;
1913                         unsigned char planes = ibuf->planes;
1914                         const int totviews = (rr ? BLI_listbase_count(&rr->views) : BLI_listbase_count(&ima->views));
1915
1916                         if (!is_exr_rr) {
1917                                 ED_space_image_release_buffer(sima, ibuf, lock);
1918                         }
1919
1920                         for (i = 0; i < totviews; i++) {
1921                                 char filepath[FILE_MAX];
1922                                 bool ok_view = false;
1923                                 const char *view = rr ? ((RenderView *) BLI_findlink(&rr->views, i))->name :
1924                                                         ((ImageView *) BLI_findlink(&ima->views, i))->name;
1925
1926                                 if (is_exr_rr) {
1927                                         BKE_scene_multiview_view_filepath_get(&scene->r, simopts->filepath, view, filepath);
1928                                         ok_view = RE_WriteRenderResult(op->reports, rr, filepath, imf, view, -1);
1929                                         save_image_post(op, ibuf, ima, ok_view, true, relbase, relative, do_newpath, filepath);
1930                                 }
1931                                 else {
1932                                         /* copy iuser to get the correct ibuf for this view */
1933                                         ImageUser iuser = sima->iuser;
1934                                         iuser.view = i;
1935                                         iuser.flag &= ~IMA_SHOW_STEREO;
1936
1937                                         if (rr)
1938                                                 BKE_image_multilayer_index(rr, &iuser);
1939                                         else
1940                                                 BKE_image_multiview_index(ima, &iuser);
1941
1942                                         ibuf = BKE_image_acquire_ibuf(sima->image, &iuser, &lock);
1943                                         ibuf->planes = planes;
1944
1945                                         BKE_scene_multiview_view_filepath_get(&scene->r, simopts->filepath, view, filepath);
1946
1947                                         colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(ibuf, save_as_render, true, &imf->view_settings, &imf->display_settings, imf);
1948                                         ok_view = BKE_imbuf_write_as(colormanaged_ibuf, filepath, &simopts->im_format, save_copy);
1949                                         save_imbuf_post(ibuf, colormanaged_ibuf);
1950                                         save_image_post(op, ibuf, ima, ok_view, true, relbase, relative, do_newpath, filepath);
1951                                         BKE_image_release_ibuf(sima->image, ibuf, lock);
1952                                 }
1953                                 ok &= ok_view;
1954                         }
1955
1956                         if (is_exr_rr) {
1957                                 ED_space_image_release_buffer(sima, ibuf, lock);
1958                         }
1959                 }
1960                 /* stereo (multiview) images */
1961                 else if (simopts->im_format.views_format == R_IMF_VIEWS_STEREO_3D) {
1962                         if (imf->imtype == R_IMF_IMTYPE_MULTILAYER) {
1963                                 ok = RE_WriteRenderResult(op->reports, rr, simopts->filepath, imf, NULL, -1);
1964                                 save_image_post(op, ibuf, ima, ok, true, relbase, relative, do_newpath, simopts->filepath);
1965                                 ED_space_image_release_buffer(sima, ibuf, lock);
1966                         }
1967                         else {
1968                                 ImBuf *ibuf_stereo[2] = {NULL};
1969
1970                                 unsigned char planes = ibuf->planes;
1971                                 const char *names[2] = {STEREO_LEFT_NAME, STEREO_RIGHT_NAME};
1972                                 int i;
1973
1974                                 /* we need to get the specific per-view buffers */
1975                                 ED_space_image_release_buffer(sima, ibuf, lock);
1976
1977                                 for (i = 0; i < 2; i ++) {
1978                                         ImageUser iuser = sima->iuser;
1979                                         iuser.flag &= ~IMA_SHOW_STEREO;
1980
1981                                         if (rr) {
1982                                                 int id = BLI_findstringindex(&rr->views, names[i], offsetof(RenderView, name));
1983                                                 iuser.view = id;
1984                                                 BKE_image_multilayer_index(rr, &iuser);
1985                                         }
1986                                         else {
1987                                                 iuser.view = i;
1988                                                 BKE_image_multiview_index(ima, &iuser);
1989                                         }
1990
1991                                         ibuf = BKE_image_acquire_ibuf(sima->image, &iuser, &lock);
1992
1993                                         if (ibuf == NULL) {
1994                                                 BKE_report(op->reports, RPT_ERROR, "Did not write, unexpected error when saving stereo image");
1995                                                 goto cleanup;
1996                                         }
1997
1998                                         ibuf->planes = planes;
1999
2000                                         /* color manage the ImBuf leaving it ready for saving */
2001                                         colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(ibuf, save_as_render, true,
2002                                                                                                 &imf->view_settings, &imf->display_settings, imf);
2003
2004                                         BKE_imbuf_write_prepare(colormanaged_ibuf, imf);
2005                                         IMB_prepare_write_ImBuf(IMB_isfloat(colormanaged_ibuf), colormanaged_ibuf);
2006
2007                                         /* duplicate buffer to prevent locker issue when using render result */
2008                                         ibuf_stereo[i] = IMB_dupImBuf(colormanaged_ibuf);
2009
2010                                         save_imbuf_post(ibuf, colormanaged_ibuf);
2011                                         BKE_image_release_ibuf(sima->image, ibuf, lock);
2012                                 }
2013
2014                                 ibuf = IMB_stereo3d_ImBuf(imf, ibuf_stereo[0], ibuf_stereo[1]);
2015
2016                                 /* save via traditional path */
2017                                 ok = BKE_imbuf_write_as(ibuf, simopts->filepath, imf, save_copy);
2018
2019                                 IMB_freeImBuf(ibuf);
2020
2021                                 for (i = 0; i < 2; i ++) {
2022                                         IMB_freeImBuf(ibuf_stereo[i]);
2023                                 }
2024                         }
2025                 }
2026
2027                 WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, sima->image);
2028
2029         }
2030         else {
2031 cleanup:
2032                 ED_space_image_release_buffer(sima, ibuf, lock);
2033         }
2034
2035         if (rr) {
2036                 BKE_image_release_renderresult(scene, ima);
2037         }
2038
2039         WM_cursor_wait(0);
2040
2041         return ok;
2042 }
2043
2044 static void image_save_as_free(wmOperator *op)
2045 {
2046         if (op->customdata) {
2047                 ImageFormatData *im_format = (ImageFormatData *)op->customdata;
2048                 BKE_color_managed_view_settings_free(&im_format->view_settings);
2049
2050                 MEM_freeN(op->customdata);
2051                 op->customdata = NULL;
2052         }
2053 }
2054
2055 static int image_save_as_exec(bContext *C, wmOperator *op)
2056 {
2057         Main *bmain = CTX_data_main(C);
2058         SpaceImage *sima = CTX_wm_space_image(C);
2059         SaveImageOptions simopts;
2060
2061         save_image_options_defaults(&simopts);
2062
2063         /* just in case to initialize values,
2064          * these should be set on invoke or by the caller. */
2065         save_image_options_init(bmain, &simopts, sima, CTX_data_scene(C), false, false);
2066
2067         save_image_options_from_op(bmain, &simopts, op);
2068
2069         save_image_doit(C, sima, op, &simopts, true);
2070
2071         image_save_as_free(op);
2072         return OPERATOR_FINISHED;
2073 }
2074
2075
2076 static bool image_save_as_check(bContext *UNUSED(C), wmOperator *op)
2077 {
2078         ImageFormatData *imf = op->customdata;
2079         return WM_operator_filesel_ensure_ext_imtype(op, imf);
2080 }
2081
2082 static int image_save_as_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2083 {
2084         Main *bmain = CTX_data_main(C);
2085         SpaceImage *sima = CTX_wm_space_image(C);
2086         Image *ima = ED_space_image(sima);
2087         Scene *scene = CTX_data_scene(C);
2088         SaveImageOptions simopts;
2089         PropertyRNA *prop;
2090         const bool save_as_render = ((ima->source == IMA_SRC_VIEWER) || (ima->flag & IMA_VIEW_AS_RENDER));
2091
2092         if (RNA_struct_property_is_set(op->ptr, "filepath"))
2093                 return image_save_as_exec(C, op);
2094
2095         save_image_options_defaults(&simopts);
2096
2097         if (save_image_options_init(bmain, &simopts, sima, scene, true, save_as_render) == 0)
2098                 return OPERATOR_CANCELLED;
2099         save_image_options_to_op(&simopts, op);
2100
2101         /* enable save_copy by default for render results */
2102         if (ELEM(ima->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE) && !RNA_struct_property_is_set(op->ptr, "copy")) {
2103                 RNA_boolean_set(op->ptr, "copy", true);
2104         }
2105
2106         RNA_boolean_set(op->ptr, "save_as_render", save_as_render);
2107
2108         op->customdata = MEM_mallocN(sizeof(simopts.im_format), __func__);
2109         memcpy(op->customdata, &simopts.im_format, sizeof(simopts.im_format));
2110
2111         /* show multiview save options only if image has multiviews */
2112         prop = RNA_struct_find_property(op->ptr, "show_multiview");
2113         RNA_property_boolean_set(op->ptr, prop, BKE_image_is_multiview(ima));
2114         prop = RNA_struct_find_property(op->ptr, "use_multiview");
2115         RNA_property_boolean_set(op->ptr, prop, BKE_image_is_multiview(ima));
2116
2117         image_filesel(C, op, simopts.filepath);
2118
2119         return OPERATOR_RUNNING_MODAL;
2120 }
2121
2122 static void image_save_as_cancel(bContext *UNUSED(C), wmOperator *op)
2123 {
2124         image_save_as_free(op);
2125 }
2126
2127 static bool image_save_as_draw_check_prop(PointerRNA *ptr, PropertyRNA *prop)
2128 {
2129         const char *prop_id = RNA_property_identifier(prop);
2130
2131         return !(STREQ(prop_id, "filepath") ||
2132                  STREQ(prop_id, "directory") ||
2133                  STREQ(prop_id, "filename") ||
2134                  /* when saving a copy, relative path has no effect */
2135                  ((STREQ(prop_id, "relative_path")) && RNA_boolean_get(ptr, "copy"))
2136                  );
2137 }
2138
2139 static void image_save_as_draw(bContext *UNUSED(C), wmOperator *op)
2140 {
2141         uiLayout *layout = op->layout;
2142         ImageFormatData *imf = op->customdata;
2143         PointerRNA imf_ptr, ptr;
2144         const bool is_multiview = RNA_boolean_get(op->ptr, "show_multiview");
2145
2146         /* image template */
2147         RNA_pointer_create(NULL, &RNA_ImageFormatSettings, imf, &imf_ptr);
2148         uiTemplateImageSettings(layout, &imf_ptr, false);
2149
2150         /* main draw call */
2151         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
2152         uiDefAutoButsRNA(layout, &ptr, image_save_as_draw_check_prop, UI_BUT_LABEL_ALIGN_NONE, false);
2153
2154         /* multiview template */
2155         if (is_multiview)
2156                 uiTemplateImageFormatViews(layout, &imf_ptr, op->ptr);
2157 }
2158
2159 static int image_save_as_poll(bContext *C)
2160 {
2161         if (space_image_buffer_exists_poll(C)) {
2162                 if (G.is_rendering) {
2163                         /* no need to NULL check here */
2164                         SpaceImage *sima = CTX_wm_space_image(C);
2165                         Image *ima = ED_space_image(sima);
2166
2167                         if (ima->source == IMA_SRC_VIEWER) {
2168                                 CTX_wm_operator_poll_msg_set(C, "can't save image while rendering");
2169                                 return false;
2170                         }
2171                 }
2172                 return true;
2173         }
2174         return false;
2175 }
2176
2177 void IMAGE_OT_save_as(wmOperatorType *ot)
2178 {
2179         /* identifiers */
2180         ot->name = "Save As Image";
2181         ot->idname = "IMAGE_OT_save_as";
2182         ot->description = "Save the image with another name and/or settings";
2183
2184         /* api callbacks */
2185         ot->exec = image_save_as_exec;
2186         ot->check = image_save_as_check;
2187         ot->invoke = image_save_as_invoke;
2188         ot->cancel = image_save_as_cancel;
2189         ot->ui = image_save_as_draw;
2190         ot->poll = image_save_as_poll;
2191
2192         /* flags */
2193         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2194
2195         /* properties */
2196         RNA_def_boolean(ot->srna, "save_as_render", 0, "Save As Render", "Apply render part of display transform when saving byte image");
2197         RNA_def_boolean(ot->srna, "copy", 0, "Copy", "Create a new image file without modifying the current image in blender");
2198
2199         WM_operator_properties_filesel(
2200                 ot, FILE_TYPE_FOLDER | FILE_TYPE_IMAGE | FILE_TYPE_MOVIE, FILE_SPECIAL, FILE_SAVE,
2201                 WM_FILESEL_FILEPATH | WM_FILESEL_RELPATH, FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
2202 }
2203
2204 /******************** save image operator ********************/
2205
2206 static int image_save_exec(bContext *C, wmOperator *op)
2207 {
2208         Main *bmain = CTX_data_main(C);
2209         SpaceImage *sima = CTX_wm_space_image(C);
2210         Scene *scene = CTX_data_scene(C);
2211         SaveImageOptions simopts;
2212
2213         save_image_options_defaults(&simopts);
2214         if (save_image_options_init(bmain, &simopts, sima, scene, false, false) == 0)
2215                 return OPERATOR_CANCELLED;
2216         save_image_options_from_op(bmain, &simopts, op);
2217
2218         if (BLI_exists(simopts.filepath) && BLI_file_is_writable(simopts.filepath)) {
2219                 if (save_image_doit(C, sima, op, &simopts, false)) {
2220                         /* report since this can be called from key-shortcuts */
2221                         BKE_reportf(op->reports, RPT_INFO, "Saved Image '%s'", simopts.filepath);
2222                 }
2223         }
2224         else {
2225                 BKE_reportf(op->reports, RPT_ERROR, "Cannot save image, path '%s' is not writable", simopts.filepath);
2226                 return OPERATOR_CANCELLED;
2227         }
2228
2229         return OPERATOR_FINISHED;
2230 }
2231
2232 void IMAGE_OT_save(wmOperatorType *ot)
2233 {
2234         /* identifiers */
2235         ot->name = "Save Image";
2236         ot->idname = "IMAGE_OT_save";
2237         ot->description = "Save the image with current name and settings";
2238
2239         /* api callbacks */
2240         ot->exec = image_save_exec;
2241         ot->poll = space_image_file_exists_poll;
2242
2243         /* flags */
2244         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2245 }
2246
2247 /******************* save sequence operator ********************/
2248
2249 static int image_save_sequence_exec(bContext *C, wmOperator *op)
2250 {
2251         Main *bmain = CTX_data_main(C);
2252         SpaceImage *sima = CTX_wm_space_image(C);
2253         ImBuf *ibuf, *first_ibuf = NULL;
2254         int tot = 0;
2255         char di[FILE_MAX];
2256         struct MovieCacheIter *iter;
2257
2258         if (sima->image == NULL)
2259                 return OPERATOR_CANCELLED;
2260
2261         if (sima->image->source != IMA_SRC_SEQUENCE) {
2262                 BKE_report(op->reports, RPT_ERROR, "Can only save sequence on image sequences");
2263                 return OPERATOR_CANCELLED;
2264         }
2265
2266         if (sima->image->type == IMA_TYPE_MULTILAYER) {
2267                 BKE_report(op->reports, RPT_ERROR, "Cannot save multilayer sequences");
2268                 return OPERATOR_CANCELLED;
2269         }
2270
2271         /* get total dirty buffers and first dirty buffer which is used for menu */
2272         ibuf = NULL;
2273         if (sima->image->cache != NULL) {
2274                 iter = IMB_moviecacheIter_new(sima->image->cache);
2275                 while (!IMB_moviecacheIter_done(iter)) {
2276                         ibuf = IMB_moviecacheIter_getImBuf(iter);
2277                         if (ibuf->userflags & IB_BITMAPDIRTY) {
2278                                 if (first_ibuf == NULL) {
2279                                         first_ibuf = ibuf;
2280                                 }
2281                                 tot++;
2282                         }
2283                         IMB_moviecacheIter_step(iter);
2284                 }
2285                 IMB_moviecacheIter_free(iter);
2286         }
2287
2288         if (tot == 0) {
2289                 BKE_report(op->reports, RPT_WARNING, "No images have been changed");
2290                 return OPERATOR_CANCELLED;
2291         }
2292
2293         /* get a filename for menu */
2294         BLI_split_dir_part(first_ibuf->name, di, sizeof(di));
2295         BKE_reportf(op->reports, RPT_INFO, "%d image(s) will be saved in %s", tot, di);
2296
2297         iter = IMB_moviecacheIter_new(sima->image->cache);
2298         while (!IMB_moviecacheIter_done(iter)) {
2299                 ibuf = IMB_moviecacheIter_getImBuf(iter);
2300
2301                 if (ibuf->userflags & IB_BITMAPDIRTY) {
2302                         char name[FILE_MAX];
2303                         BLI_strncpy(name, ibuf->name, sizeof(name));
2304
2305                         BLI_path_abs(name, bmain->name);
2306
2307                         if (0 == IMB_saveiff(ibuf, name, IB_rect | IB_zbuf | IB_zbuffloat)) {
2308                                 BKE_reportf(op->reports, RPT_ERROR, "Could not write image: %s", strerror(errno));
2309                                 break;
2310                         }
2311
2312                         BKE_reportf(op->reports, RPT_INFO, "Saved %s", ibuf->name);
2313                         ibuf->userflags &= ~IB_BITMAPDIRTY;
2314                 }
2315
2316                 IMB_moviecacheIter_step(iter);
2317         }
2318         IMB_moviecacheIter_free(iter);
2319
2320         return OPERATOR_FINISHED;
2321 }
2322
2323 void IMAGE_OT_save_sequence(wmOperatorType *ot)
2324 {
2325         /* identifiers */
2326         ot->name = "Save Sequence";
2327         ot->idname = "IMAGE_OT_save_sequence";
2328         ot->description = "Save a sequence of images";
2329
2330         /* api callbacks */
2331         ot->exec = image_save_sequence_exec;
2332         ot->poll = space_image_buffer_exists_poll;
2333
2334         /* flags */
2335         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2336 }
2337
2338 /******************** reload image operator ********************/
2339
2340 static int image_reload_exec(bContext *C, wmOperator *UNUSED(op))
2341 {
2342         Image *ima = CTX_data_edit_image(C);
2343         SpaceImage *sima = CTX_wm_space_image(C);
2344
2345         if (!ima)
2346                 return OPERATOR_CANCELLED;
2347
2348         /* XXX unpackImage frees image buffers */
2349         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
2350
2351         // XXX other users?
2352         BKE_image_signal(ima, (sima) ? &sima->iuser : NULL, IMA_SIGNAL_RELOAD);
2353         DEG_id_tag_update(&ima->id, 0);
2354
2355         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
2356
2357         return OPERATOR_FINISHED;
2358 }
2359
2360 void IMAGE_OT_reload(wmOperatorType *ot)
2361 {
2362         /* identifiers */
2363         ot->name = "Reload Image";
2364         ot->idname = "IMAGE_OT_reload";
2365         ot->description = "Reload current image from disk";
2366
2367         /* api callbacks */
2368         ot->exec = image_reload_exec;
2369
2370         /* flags */
2371         ot->flag = OPTYPE_REGISTER; /* no undo, image buffer is not handled by undo */
2372 }
2373
2374 /********************** new image operator *********************/
2375 #define IMA_DEF_NAME N_("Untitled")
2376
2377 enum {
2378         GEN_CONTEXT_NONE = 0,
2379         GEN_CONTEXT_PAINT_CANVAS = 1,
2380         GEN_CONTEXT_PAINT_STENCIL = 2
2381 };
2382
2383 static int image_new_exec(bContext *C, wmOperator *op)
2384 {
2385         SpaceImage *sima;
2386         Scene *scene;
2387         Object *obedit;
2388         Image *ima;
2389         Main *bmain;
2390         PointerRNA ptr, idptr;
2391         PropertyRNA *prop;
2392         char name_buffer[MAX_ID_NAME - 2];
2393         const char *name;
2394         float color[4];
2395         int width, height, floatbuf, gen_type, alpha;
2396         int gen_context;
2397         int stereo3d;
2398
2399         /* retrieve state */
2400         sima = CTX_wm_space_image(C);
2401         scene = CTX_data_scene(C);
2402         obedit = CTX_data_edit_object(C);
2403         bmain = CTX_data_main(C);
2404
2405         prop = RNA_struct_find_property(op->ptr, "name");
2406         RNA_property_string_get(op->ptr, prop, name_buffer);
2407         if (!RNA_property_is_set(op->ptr, prop)) {
2408                 /* Default value, we can translate! */
2409                 name = DATA_(name_buffer);
2410         }
2411         else {
2412                 name = name_buffer;
2413         }
2414         width = RNA_int_get(op->ptr, "width");
2415         height = RNA_int_get(op->ptr, "height");
2416         floatbuf = RNA_boolean_get(op->ptr, "float");
2417         gen_type = RNA_enum_get(op->ptr, "generated_type");
2418         RNA_float_get_array(op->ptr, "color", color);
2419         alpha = RNA_boolean_get(op->ptr, "alpha");
2420         gen_context = RNA_enum_get(op->ptr, "gen_context");
2421         stereo3d = RNA_boolean_get(op->ptr, "use_stereo_3d");
2422
2423         if (!alpha)
2424                 color[3] = 1.0f;
2425
2426         ima = BKE_image_add_generated(bmain, width, height, name, alpha ? 32 : 24, floatbuf, gen_type, color, stereo3d);
2427
2428         if (!ima)
2429                 return OPERATOR_CANCELLED;
2430
2431         /* hook into UI */
2432         UI_context_active_but_prop_get_templateID(C, &ptr, &prop);
2433
2434         if (prop) {
2435                 /* when creating new ID blocks, use is already 1, but RNA
2436                  * pointer use also increases user, so this compensates it */
2437                 id_us_min(&ima->id);
2438
2439                 RNA_id_pointer_create(&ima->id, &idptr);
2440                 RNA_property_pointer_set(&ptr, prop, idptr);
2441                 RNA_property_update(C, &ptr, prop);
2442         }
2443         else if (sima) {
2444                 ED_space_image_set(sima, scene, obedit, ima);
2445         }
2446         else if (gen_context == GEN_CONTEXT_PAINT_CANVAS) {
2447                 bScreen *sc;
2448                 Object *ob = CTX_data_active_object(C);
2449
2450                 if (scene->toolsettings->imapaint.canvas)
2451                         id_us_min(&scene->toolsettings->imapaint.canvas->id);
2452                 scene->toolsettings->imapaint.canvas = ima;
2453
2454                 for (sc = bmain->screen.first; sc; sc = sc->id.next) {
2455                         ScrArea *sa;
2456                         for (sa = sc->areabase.first; sa; sa = sa->next) {
2457                                 SpaceLink *sl;
2458                                 for (sl = sa->spacedata.first; sl; sl = sl->next) {
2459                                         if (sl->spacetype == SPACE_IMAGE) {
2460                                                 SpaceImage *sima_other = (SpaceImage *)sl;
2461
2462                                                 if (!sima_other->pin) {
2463                                                         ED_space_image_set(sima_other, scene, obedit, ima);
2464                                                 }
2465                                         }
2466                                 }
2467                         }
2468                 }
2469                 BKE_paint_proj_mesh_data_check(scene, ob, NULL, NULL, NULL, NULL);
2470                 WM_event_add_notifier(C, NC_SCENE | ND_TOOLSETTINGS, NULL);
2471         }
2472         else if (gen_context == GEN_CONTEXT_PAINT_STENCIL) {
2473                 Object *ob = CTX_data_active_object(C);
2474                 if (scene->toolsettings->imapaint.stencil)
2475                         id_us_min(&scene->toolsettings->imapaint.stencil->id);
2476                 scene->toolsettings->imapaint.stencil = ima;
2477                 BKE_paint_proj_mesh_data_check(scene, ob, NULL, NULL, NULL, NULL);
2478                 WM_event_add_notifier(C, NC_SCENE | ND_TOOLSETTINGS, NULL);
2479         }
2480         else {
2481                 Tex *tex = CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
2482                 if (tex && tex->type == TEX_IMAGE) {
2483                         if (tex->ima)
2484                                 id_us_min(&tex->ima->id);
2485                         tex->ima = ima;
2486                         ED_area_tag_redraw(CTX_wm_area(C));
2487                 }
2488         }
2489
2490         BKE_image_signal(ima, (sima) ? &sima->iuser : NULL, IMA_SIGNAL_USER_NEW_IMAGE);
2491
2492         WM_event_add_notifier(C, NC_IMAGE | NA_ADDED, ima);
2493
2494         return OPERATOR_FINISHED;
2495 }
2496
2497 /* XXX, Ton is not a fan of OK buttons but using this function to avoid undo/redo bug while in mesh-editmode, - campbell */
2498 /* XXX Note: the WM_operator_props_dialog_popup() doesn't work for UI_context_active_but_prop_get_templateID(), image is not being that way */
2499 static int image_new_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2500 {
2501         /* Better for user feedback. */
2502         RNA_string_set(op->ptr, "name", DATA_(IMA_DEF_NAME));
2503         return WM_operator_props_dialog_popup(C, op, 15 * UI_UNIT_X, 5 * UI_UNIT_Y);
2504 }
2505
2506 static void image_new_draw(bContext *UNUSED(C), wmOperator *op)
2507 {
2508         uiLayout *split, *col[2];
2509         uiLayout *layout = op->layout;
2510         PointerRNA ptr;
2511 #if 0
2512         Scene *scene = CTX_data_scene(C);
2513         const bool is_multiview = (scene->r.scemode & R_MULTIVIEW) != 0;
2514 #endif
2515
2516         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
2517
2518         /* copy of WM_operator_props_dialog_popup() layout */
2519
2520         split = uiLayoutSplit(layout, 0.5f, false);
2521         col[0] = uiLayoutColumn(split, false);
2522         col[1] = uiLayoutColumn(split, false);
2523
2524         uiItemL(col[0], IFACE_("Name"), ICON_NONE);
2525         uiItemR(col[1], &ptr, "name", 0, "", ICON_NONE);
2526
2527         uiItemL(col[0], IFACE_("Width"), ICON_NONE);
2528         uiItemR(col[1], &ptr, "width", 0, "", ICON_NONE);
2529
2530         uiItemL(col[0], IFACE_("Height"), ICON_NONE);
2531         uiItemR(col[1], &ptr, "height", 0, "", ICON_NONE);
2532
2533         uiItemL(col[0], IFACE_("Color"), ICON_NONE);
2534         uiItemR(col[1], &ptr, "color", 0, "", ICON_NONE);
2535
2536         uiItemL(col[0], "", ICON_NONE);
2537         uiItemR(col[1], &ptr, "alpha", 0, NULL, ICON_NONE);
2538
2539         uiItemL(col[0], IFACE_("Generated Type"), ICON_NONE);
2540         uiItemR(col[1], &ptr, "generated_type", 0, "", ICON_NONE);
2541
2542         uiItemL(col[0], "", ICON_NONE);
2543         uiItemR(col[1], &ptr, "float", 0, NULL, ICON_NONE);
2544
2545 #if 0
2546         if (is_multiview) {
2547                 uiItemL(col[0], "", ICON_NONE);
2548                 uiItemR(col[1], &ptr, "use_stereo_3d", 0, NULL, ICON_NONE);
2549         }
2550 #endif
2551 }
2552
2553 void IMAGE_OT_new(wmOperatorType *ot)
2554 {
2555         PropertyRNA *prop;
2556         static float default_color[4] = {0.0f, 0.0f, 0.0f, 1.0f};
2557
2558         static const EnumPropertyItem gen_context_items[] = {
2559                 {GEN_CONTEXT_NONE, "NONE", 0, "None", ""},
2560                 {GEN_CONTEXT_PAINT_CANVAS, "PAINT_CANVAS", 0, "Paint Canvas", ""},
2561                 {GEN_CONTEXT_PAINT_STENCIL, "PAINT_STENCIL", 0, "Paint Stencil", ""},
2562                 {0, NULL, 0, NULL, NULL}
2563         };
2564
2565         /* identifiers */
2566         ot->name = "New Image";
2567         ot->description = "Create a new image";
2568         ot->idname = "IMAGE_OT_new";
2569
2570         /* api callbacks */
2571         ot->exec = image_new_exec;
2572         ot->invoke = image_new_invoke;
2573         ot->ui = image_new_draw;
2574
2575         /* flags */
2576         ot->flag = OPTYPE_UNDO;
2577
2578         /* properties */
2579         RNA_def_string(ot->srna, "name", IMA_DEF_NAME, MAX_ID_NAME - 2, "Name", "Image data-block name");
2580         prop = RNA_def_int(ot->srna, "width", 1024, 1, INT_MAX, "Width", "Image width", 1, 16384);
2581         RNA_def_property_subtype(prop, PROP_PIXEL);
2582         prop = RNA_def_int(ot->srna, "height", 1024, 1, INT_MAX, "Height", "Image height", 1, 16384);
2583         RNA_def_property_subtype(prop, PROP_PIXEL);
2584         prop = RNA_def_float_color(ot->srna, "color", 4, NULL, 0.0f, FLT_MAX, "Color", "Default fill color", 0.0f, 1.0f);
2585         RNA_def_property_subtype(prop, PROP_COLOR_GAMMA);
2586         RNA_def_property_float_array_default(prop, default_color);
2587         RNA_def_boolean(ot->srna, "alpha", 1, "Alpha", "Create an image with an alpha channel");
2588         RNA_def_enum(ot->srna, "generated_type", rna_enum_image_generated_type_items, IMA_GENTYPE_BLANK,
2589                      "Generated Type", "Fill the image with a grid for UV map testing");
2590         RNA_def_boolean(ot->srna, "float", 0, "32 bit Float", "Create image with 32 bit floating point bit depth");
2591         prop = RNA_def_enum(ot->srna, "gen_context", gen_context_items, 0, "Gen Context", "Generation context");
2592         RNA_def_property_flag(prop, PROP_HIDDEN);
2593         prop = RNA_def_boolean(ot->srna, "use_stereo_3d", 0, "Stereo 3D", "Create an image with left and right views");
2594         RNA_def_property_flag(prop, PROP_SKIP_SAVE | PROP_HIDDEN);
2595 }
2596
2597 #undef IMA_DEF_NAME
2598
2599 /********************* invert operators *********************/
2600
2601 static int image_invert_poll(bContext *C)
2602 {
2603         Image *ima = CTX_data_edit_image(C);
2604
2605         return BKE_image_has_ibuf(ima, NULL);
2606 }
2607
2608 static int image_invert_exec(bContext *C, wmOperator *op)
2609 {
2610         Image *ima = CTX_data_edit_image(C);
2611         ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
2612         SpaceImage *sima = CTX_wm_space_image(C);
2613         /* undo is supported only on image paint mode currently */
2614         bool support_undo = ((sima != NULL) && (sima->mode == SI_MODE_PAINT));
2615
2616         /* flags indicate if this channel should be inverted */
2617         const bool r = RNA_boolean_get(op->ptr, "invert_r");
2618         const bool g = RNA_boolean_get(op->ptr, "invert_g");
2619         const bool b = RNA_boolean_get(op->ptr, "invert_b");
2620         const bool a = RNA_boolean_get(op->ptr, "invert_a");
2621
2622         size_t i;
2623
2624         if (ibuf == NULL)  /* TODO: this should actually never happen, but does for render-results -> cleanup */
2625                 return OPERATOR_CANCELLED;
2626
2627         if (support_undo) {
2628                 ED_image_undo_push_begin(op->type->name);
2629                 /* not strictly needed, because we only imapaint_dirty_region to invalidate all tiles
2630                  * but better do this right in case someone copies this for a tool that uses partial redraw better */
2631                 ED_imapaint_clear_partial_redraw();
2632                 ED_imapaint_dirty_region(ima, ibuf, 0, 0, ibuf->x, ibuf->y, false);
2633         }
2634         /* TODO: make this into an IMB_invert_channels(ibuf,r,g,b,a) method!? */
2635         if (ibuf->rect_float) {
2636
2637                 float *fp = (float *) ibuf->rect_float;
2638                 for (i = ((size_t)ibuf->x) * ibuf->y; i > 0; i--, fp += 4) {
2639                         if (r) fp[0] = 1.0f - fp[0];
2640                         if (g) fp[1] = 1.0f - fp[1];
2641                         if (b) fp[2] = 1.0f - fp[2];
2642                         if (a) fp[3] = 1.0f - fp[3];
2643                 }
2644
2645                 if (ibuf->rect) {
2646                         IMB_rect_from_float(ibuf);
2647                 }
2648         }
2649         else if (ibuf->rect) {
2650
2651                 char *cp = (char *) ibuf->rect;
2652                 for (i = ((size_t)ibuf->x) * ibuf->y; i > 0; i--, cp += 4) {
2653                         if (r) cp[0] = 255 - cp[0];
2654                         if (g) cp[1] = 255 - cp[1];
2655                         if (b) cp[2] = 255 - cp[2];
2656                         if (a) cp[3] = 255 - cp[3];
2657                 }
2658         }
2659         else {
2660                 BKE_image_release_ibuf(ima, ibuf, NULL);
2661                 return OPERATOR_CANCELLED;
2662         }
2663
2664         ibuf->userflags |= IB_BITMAPDIRTY | IB_DISPLAY_BUFFER_INVALID;
2665
2666         if (ibuf->mipmap[0])
2667                 ibuf->userflags |= IB_MIPMAP_INVALID;
2668
2669         if (support_undo) {
2670                 ED_image_undo_push_end();
2671         }
2672
2673         /* force GPU reupload, all image is invalid */
2674         GPU_free_image(ima);
2675
2676         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
2677
2678         BKE_image_release_ibuf(ima, ibuf, NULL);
2679
2680         return OPERATOR_FINISHED;
2681 }
2682
2683 void IMAGE_OT_invert(wmOperatorType *ot)
2684 {
2685         PropertyRNA *prop;
2686
2687         /* identifiers */
2688         ot->name = "Invert Channels";
2689         ot->idname = "IMAGE_OT_invert";
2690         ot->description = "Invert image's channels";
2691
2692         /* api callbacks */
2693         ot->exec = image_invert_exec;
2694         ot->poll = image_invert_poll;
2695
2696         /* properties */
2697         prop = RNA_def_boolean(ot->srna, "invert_r", 0, "Red", "Invert Red Channel");
2698         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2699         prop = RNA_def_boolean(ot->srna, "invert_g", 0, "Green", "Invert Green Channel");
2700         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2701         prop = RNA_def_boolean(ot->srna, "invert_b", 0, "Blue", "Invert Blue Channel");
2702         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2703         prop = RNA_def_boolean(ot->srna, "invert_a", 0, "Alpha", "Invert Alpha Channel");
2704         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2705
2706         /* flags */
2707         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2708 }
2709
2710 /********************* pack operator *********************/
2711
2712 static bool image_pack_test(bContext *C, wmOperator *op)
2713 {
2714         Image *ima = CTX_data_edit_image(C);
2715         const bool as_png = RNA_boolean_get(op->ptr, "as_png");
2716
2717         if (!ima)
2718                 return 0;
2719         if (!as_png && BKE_image_has_packedfile(ima))
2720                 return 0;
2721
2722         if (ima->source == IMA_SRC_SEQUENCE || ima->source == IMA_SRC_MOVIE) {
2723                 BKE_report(op->reports, RPT_ERROR, "Packing movies or image sequences not supported");
2724                 return 0;
2725         }
2726
2727         return 1;
2728 }
2729
2730 static int image_pack_exec(bContext *C, wmOperator *op)
2731 {
2732         struct Main *bmain = CTX_data_main(C);
2733         Image *ima = CTX_data_edit_image(C);
2734         ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
2735         const bool as_png = RNA_boolean_get(op->ptr, "as_png");
2736
2737         if (!image_pack_test(C, op))
2738                 return OPERATOR_CANCELLED;
2739
2740         if (!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
2741                 BKE_report(op->reports, RPT_ERROR, "Cannot pack edited image from disk, only as internal PNG");
2742                 return OPERATOR_CANCELLED;
2743         }
2744
2745         if (as_png)
2746                 BKE_image_memorypack(ima);
2747         else
2748                 BKE_image_packfiles(op->reports, ima, ID_BLEND_PATH(bmain, &ima->id));
2749
2750         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
2751
2752         BKE_image_release_ibuf(ima, ibuf, NULL);
2753
2754         return OPERATOR_FINISHED;
2755 }
2756
2757 static int image_pack_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2758 {
2759         Image *ima = CTX_data_edit_image(C);
2760         ImBuf *ibuf;
2761         uiPopupMenu *pup;
2762         uiLayout *layout;
2763         const bool as_png = RNA_boolean_get(op->ptr, "as_png");
2764
2765         if (!image_pack_test(C, op))
2766                 return OPERATOR_CANCELLED;
2767
2768         ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
2769
2770         if (!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
2771                 pup = UI_popup_menu_begin(C, IFACE_("OK"), ICON_QUESTION);
2772                 layout = UI_popup_menu_layout(pup);
2773                 uiItemBooleanO(layout, IFACE_("Can't pack edited image from disk, pack as internal PNG?"), ICON_NONE,
2774                                op->idname, "as_png", 1);
2775                 UI_popup_menu_end(C, pup);
2776
2777                 BKE_image_release_ibuf(ima, ibuf, NULL);
2778
2779                 return OPERATOR_INTERFACE;
2780         }
2781
2782         BKE_image_release_ibuf(ima, ibuf, NULL);
2783
2784         return image_pack_exec(C, op);
2785 }
2786
2787 void IMAGE_OT_pack(wmOperatorType *ot)
2788 {
2789         /* identifiers */
2790         ot->name = "Pack Image";
2791         ot->description = "Pack an image as embedded data into the .blend file";
2792         ot->idname = "IMAGE_OT_pack";
2793
2794         /* api callbacks */
2795         ot->exec = image_pack_exec;
2796         ot->invoke = image_pack_invoke;
2797
2798         /* flags */
2799         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2800
2801         /* properties */
2802         RNA_def_boolean(ot->srna, "as_png", 0, "Pack As PNG", "Pack image as lossless PNG");
2803 }
2804
2805 /********************* unpack operator *********************/
2806
2807 static int image_unpack_exec(bContext *C, wmOperator *op)
2808 {
2809         Image *ima = CTX_data_edit_image(C);
2810         int method = RNA_enum_get(op->ptr, "method");
2811
2812         /* find the suppplied image by name */
2813         if (RNA_struct_property_is_set(op->ptr, "id")) {
2814                 char imaname[MAX_ID_NAME - 2];
2815                 RNA_string_get(op->ptr, "id", imaname);
2816                 ima = BLI_findstring(&CTX_data_main(C)->image, imaname, offsetof(ID, name) + 2);
2817                 if (!ima) ima = CTX_data_edit_image(C);
2818         }
2819
2820         if (!ima || !BKE_image_has_packedfile(ima))
2821                 return OPERATOR_CANCELLED;
2822
2823         if (ima->source == IMA_SRC_SEQUENCE || ima->source == IMA_SRC_MOVIE) {
2824                 BKE_report(op->reports, RPT_ERROR, "Unpacking movies or image sequences not supported");
2825                 return OPERATOR_CANCELLED;
2826         }
2827
2828         if (G.fileflags & G_AUTOPACK)
2829                 BKE_report(op->reports, RPT_WARNING, "AutoPack is enabled, so image will be packed again on file save");
2830
2831         /* XXX unpackImage frees image buffers */
2832         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
2833
2834         unpackImage(CTX_data_main(C), op->reports, ima, method);
2835
2836         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
2837
2838         return OPERATOR_FINISHED;
2839 }
2840
2841 static int image_unpack_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
2842 {
2843         Image *ima = CTX_data_edit_image(C);
2844
2845         if (RNA_struct_property_is_set(op->ptr, "id"))
2846                 return image_unpack_exec(C, op);
2847
2848         if (!ima || !BKE_image_has_packedfile(ima))
2849                 return OPERATOR_CANCELLED;
2850
2851         if (ima->source == IMA_SRC_SEQUENCE || ima->source == IMA_SRC_MOVIE) {
2852                 BKE_report(op->reports, RPT_ERROR, "Unpacking movies or image sequences not supported");
2853                 return OPERATOR_CANCELLED;
2854         }
2855
2856         if (G.fileflags & G_AUTOPACK)
2857                 BKE_report(op->reports, RPT_WARNING, "AutoPack is enabled, so image will be packed again on file save");
2858
2859         unpack_menu(C, "IMAGE_OT_unpack", ima->id.name + 2, ima->name, "textures", BKE_image_has_packedfile(ima) ? ((ImagePackedFile *)ima->packedfiles.first)->packedfile : NULL);
2860
2861         return OPERATOR_FINISHED;
2862 }
2863
2864 void IMAGE_OT_unpack(wmOperatorType *ot)
2865 {
2866         /* identifiers */
2867         ot->name = "Unpack Image";
2868         ot->description = "Save an image packed in the .blend file to disk";
2869         ot->idname = "IMAGE_OT_unpack";
2870
2871         /* api callbacks */
2872         ot->exec = image_unpack_exec;
2873         ot->invoke = image_unpack_invoke;
2874
2875         /* flags */
2876         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
2877
2878         /* properties */
2879         RNA_def_enum(ot->srna, "method", rna_enum_unpack_method_items, PF_USE_LOCAL, "Method", "How to unpack");
2880         RNA_def_string(ot->srna, "id", NULL, MAX_ID_NAME - 2, "Image Name", "Image data-block name to unpack"); /* XXX, weark!, will fail with library, name collisions */
2881 }
2882
2883 /******************** sample image operator ********************/
2884
2885 typedef struct ImageSampleInfo {
2886         ARegionType *art;
2887         void *draw_handle;
2888         int x, y;
2889         int channels;
2890
2891         unsigned char col[4];
2892         float colf[4];
2893         float linearcol[4];
2894         int z;
2895         float zf;
2896
2897         unsigned char *colp;
2898         const float *colfp;
2899         int *zp;
2900         float *zfp;
2901
2902         bool draw;
2903         bool color_manage;
2904         int use_default_view;
2905 } ImageSampleInfo;
2906
2907 static void image_sample_draw(const bContext *C, ARegion *ar, void *arg_info)
2908 {
2909         ImageSampleInfo *info = arg_info;
2910         if (info->draw) {
2911                 Scene *scene = CTX_data_scene(C);
2912
2913                 ED_image_draw_info(scene, ar, info->color_manage, info->use_default_view, info->channels,
2914                                    info->x, info->y, info->colp, info->colfp, info->linearcol, info->zp, info->zfp);
2915         }
2916 }
2917
2918 /* Returns color in linear space, matching ED_space_node_color_sample(). */
2919 bool ED_space_image_color_sample(SpaceImage *sima, ARegion *ar, int mval[2], float r_col[3])
2920 {
2921         void *lock;
2922         ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
2923         float fx, fy;
2924         bool ret = false;
2925
2926         if (ibuf == NULL) {
2927                 ED_space_image_release_buffer(sima, ibuf, lock);
2928                 return false;
2929         }
2930
2931         UI_view2d_region_to_view(&ar->v2d, mval[0], mval[1], &fx, &fy);
2932
2933         if (fx >= 0.0f && fy >= 0.0f && fx < 1.0f && fy < 1.0f) {
2934                 const float *fp;
2935                 unsigned char *cp;
2936                 int x = (int)(fx * ibuf->x), y = (int)(fy * ibuf->y);
2937
2938                 CLAMP(x, 0, ibuf->x - 1);
2939                 CLAMP(y, 0, ibuf->y - 1);
2940
2941                 if (ibuf->rect_float) {
2942                         fp = (ibuf->rect_float + (ibuf->channels) * (y * ibuf->x + x));
2943                         copy_v3_v3(r_col, fp);
2944                         ret = true;
2945                 }
2946                 else if (ibuf->rect) {
2947                         cp = (unsigned char *)(ibuf->rect + y * ibuf->x + x);
2948                         rgb_uchar_to_float(r_col, cp);
2949                         IMB_colormanagement_colorspace_to_scene_linear_v3(r_col, ibuf->rect_colorspace);
2950                         ret = true;
2951                 }
2952         }
2953
2954         ED_space_image_release_buffer(sima, ibuf, lock);
2955         return ret;
2956 }
2957
2958 static void image_sample_apply(bContext *C, wmOperator *op, const wmEvent *event)
2959 {
2960         SpaceImage *sima = CTX_wm_space_image(C);
2961         ARegion *ar = CTX_wm_region(C);
2962         void *lock;
2963         ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
2964         ImageSampleInfo *info = op->customdata;
2965         float fx, fy;
2966         Scene *scene = CTX_data_scene(C);
2967         CurveMapping *curve_mapping = scene->view_settings.curve_mapping;
2968
2969         if (ibuf == NULL) {
2970                 ED_space_image_release_buffer(sima, ibuf, lock);
2971                 info->draw = false;
2972                 return;
2973         }
2974
2975         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &fx, &fy);
2976
2977         if (fx >= 0.0f && fy >= 0.0f && fx < 1.0f && fy < 1.0f) {
2978                 const float *fp;
2979                 unsigned char *cp;
2980                 int x = (int)(fx * ibuf->x), y = (int)(fy * ibuf->y);
2981                 Image *image = ED_space_image(sima);
2982
2983                 CLAMP(x, 0, ibuf->x - 1);
2984                 CLAMP(y, 0, ibuf->y - 1);
2985
2986                 info->x = x;
2987                 info->y = y;
2988                 info->draw = true;
2989                 info->channels = ibuf->channels;
2990
2991                 info->colp = NULL;
2992                 info->colfp = NULL;
2993                 info->zp = NULL;
2994                 info->zfp = NULL;
2995
2996                 info->use_default_view = (image->flag & IMA_VIEW_AS_RENDER) ? false : true;
2997
2998                 if (ibuf->rect) {
2999                         cp = (unsigned char *)(ibuf->rect + y * ibuf->x + x);
3000
3001                         info->col[0] = cp[0];
3002                         info->col[1] = cp[1];
3003                         info->col[2] = cp[2];
3004                         info->col[3] = cp[3];
3005                         info->colp = info->col;
3006
3007                         info->colf[0] = (float)cp[0] / 255.0f;
3008                         info->colf[1] = (float)cp[1] / 255.0f;
3009                         info->colf[2] = (float)cp[2] / 255.0f;
3010                         info->colf[3] = (float)cp[3] / 255.0f;
3011                         info->colfp = info->colf;
3012
3013                         copy_v4_v4(info->linearcol, info->colf);
3014                         IMB_colormanagement_colorspace_to_scene_linear_v4(info->linearcol, false, ibuf->rect_colorspace);
3015
3016                         info->color_manage = true;
3017                 }
3018                 if (ibuf->rect_float) {
3019                         fp = (ibuf->rect_float + (ibuf->channels) * (y * ibuf->x + x));
3020
3021                         if (ibuf->channels == 4) {
3022                                 info->colf[0] = fp[0];
3023                                 info->colf[1] = fp[1];
3024                                 info->colf[2] = fp[2];
3025                                 info->colf[3] = fp[3];
3026                         }
3027                         else if (ibuf->channels == 3) {
3028                                 info->colf[0] = fp[0];
3029                                 info->colf[1] = fp[1];
3030                                 info->colf[2] = fp[2];
3031                                 info->colf[3] = 1.0f;
3032                         }
3033                         else {
3034                                 info->colf[0] = fp[0];
3035                                 info->colf[1] = fp[0];
3036                                 info->colf[2] = fp[0];
3037                                 info->colf[3] = 1.0f;
3038                         }
3039                         info->colfp = info->colf;
3040
3041                         copy_v4_v4(info->linearcol, info->colf);
3042
3043                         info->color_manage = true;
3044                 }
3045
3046                 if (ibuf->zbuf) {
3047                         info->z = ibuf->zbuf[y * ibuf->x + x];
3048                         info->zp = &info->z;
3049                         if (ibuf->zbuf == (int *)ibuf->rect) {
3050                                 info->colp = NULL;
3051                         }
3052                 }
3053                 if (ibuf->zbuf_float) {
3054                         info->zf = ibuf->zbuf_float[y * ibuf->x + x];
3055                         info->zfp = &info->zf;
3056                         if (ibuf->zbuf_float == ibuf->rect_float) {
3057                                 info->colfp = NULL;
3058                         }
3059                 }
3060
3061                 if (curve_mapping && ibuf->channels == 4) {
3062                         /* we reuse this callback for set curves point operators */
3063                         if (RNA_struct_find_property(op->ptr, "point")) {
3064                                 int point = RNA_enum_get(op->ptr, "point");
3065
3066                                 if (point == 1) {
3067                                         curvemapping_set_black_white(curve_mapping, NULL, info->linearcol);
3068                                 }
3069                                 else if (point == 0) {
3070                                         curvemapping_set_black_white(curve_mapping, info->linearcol, NULL);
3071                                 }
3072                                 WM_event_add_notifier(C, NC_WINDOW, NULL);
3073                         }
3074                 }
3075
3076                 // XXX node curve integration ..
3077 #if 0
3078                 {
3079                         ScrArea *sa, *cur = curarea;
3080
3081                         node_curvemap_sample(fp);   /* sends global to node editor */
3082                         for (sa = G.curscreen->areabase.first; sa; sa = sa->next) {
3083                                 if (sa->spacetype == SPACE_NODE) {
3084                                         areawinset(sa->win);
3085                                         scrarea_do_windraw(sa);
3086                                 }
3087                         }
3088                         node_curvemap_sample(NULL);     /* clears global in node editor */
3089                         curarea = cur;
3090                 }
3091 #endif
3092         }
3093         else {
3094                 info->draw = 0;
3095         }
3096
3097         ED_space_image_release_buffer(sima, ibuf, lock);
3098         ED_area_tag_redraw(CTX_wm_area(C));
3099 }
3100
3101 static void image_sample_exit(bContext *C, wmOperator *op)
3102 {
3103         ImageSampleInfo *info = op->customdata;
3104
3105         ED_region_draw_cb_exit(info->art, info->draw_handle);
3106         ED_area_tag_redraw(CTX_wm_area(C));
3107         MEM_freeN(info);
3108 }
3109
3110 static int image_sample_invoke(bContext *C, wmOperator *op, const wmEvent *event)
3111 {
3112         SpaceImage *sima = CTX_wm_space_image(C);
3113         ARegion *ar = CTX_wm_region(C);
3114         ImageSampleInfo *info;
3115
3116         if (ar->regiontype == RGN_TYPE_WINDOW) {
3117                 if (event->mval[1] <= 16 && ED_space_image_show_cache(sima)) {
3118                         return OPERATOR_PASS_THROUGH;
3119                 }
3120         }
3121
3122         if (!ED_space_image_has_buffer(sima))
3123                 return OPERATOR_CANCELLED;
3124
3125         info = MEM_callocN(sizeof(ImageSampleInfo), "ImageSampleInfo");
3126         info->art = ar->type;
3127         info->draw_handle = ED_region_draw_cb_activate(ar->type, image_sample_draw, info, REGION_DRAW_POST_PIXEL);
3128         op->customdata = info;
3129
3130         image_sample_apply(C, op, event);
3131
3132         WM_event_add_modal_handler(C, op);
3133
3134         return OPERATOR_RUNNING_MODAL;
3135 }
3136
3137 static int image_sample_modal(bContext *C, wmOperator *op, const wmEvent *event)
3138 {
3139         switch (event->type) {
3140                 case LEFTMOUSE:
3141                 case RIGHTMOUSE: // XXX hardcoded
3142                         if (event->val == KM_RELEASE) {
3143                                 image_sample_exit(C, op);
3144                                 return OPERATOR_CANCELLED;
3145                         }
3146                         break;
3147                 case MOUSEMOVE:
3148                         image_sample_apply(C, op, event);
3149                         break;
3150         }
3151
3152         return OPERATOR_RUNNING_MODAL;
3153 }
3154
3155 static void image_sample_cancel(bContext *C, wmOperator *op)
3156 {
3157         image_sample_exit(C, op);
3158 }
3159
3160 void IMAGE_OT_sample(wmOperatorType *ot)
3161 {
3162         /* identifiers */
3163         ot->name = "Sample Color";
3164         ot->idname = "IMAGE_OT_sample";
3165         ot->description = "Use mouse to sample a color in current image";
3166
3167         /* api callbacks */
3168         ot->invoke = image_sample_invoke;
3169         ot->modal = image_sample_modal;
3170         ot->cancel = image_sample_cancel;
3171         ot->poll = image_sample_poll;
3172
3173         /* flags */
3174         ot->flag = OPTYPE_BLOCKING;
3175 }
3176
3177 /******************** sample line operator ********************/
3178 static int image_sample_line_exec(bContext *C, wmOperator *op)
3179 {
3180         SpaceImage *sima = CTX_wm_space_image(C);
3181         ARegion *ar = CTX_wm_region(C);
3182         Scene *scene = CTX_data_scene(C);
3183
3184         int x_start = RNA_int_get(op->ptr, "xstart");
3185         int y_start = RNA_int_get(op->ptr, "ystart");
3186         int x_end = RNA_int_get(op->ptr, "xend");
3187         int y_end = RNA_int_get(op->ptr, "yend");
3188
3189         void *lock;
3190         ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
3191         Histogram *hist = &sima->sample_line_hist;
3192
3193         float x1f, y1f, x2f, y2f;
3194
3195         if (ibuf == NULL) {
3196                 ED_space_image_release_buffer(sima, ibuf, lock);
3197                 return OPERATOR_CANCELLED;
3198         }
3199         /* hmmmm */
3200         if (ibuf->channels < 3) {
3201                 ED_space_image_release_buffer(sima, ibuf, lock);
3202                 return OPERATOR_CANCELLED;
3203         }
3204
3205         UI_view2d_region_to_view(&ar->v2d, x_start, y_start, &x1f, &y1f);
3206         UI_view2d_region_to_view(&ar->v2d, x_end, y_end, &x2f, &y2f);
3207
3208         hist->co[0][0] = x1f;
3209         hist->co[0][1] = y1f;
3210         hist->co[1][0] = x2f;
3211         hist->co[1][1] = y2f;
3212
3213         /* enable line drawing */
3214         hist->flag |= HISTO_FLAG_SAMPLELINE;
3215
3216         BKE_histogram_update_sample_line(hist, ibuf, &scene->view_settings, &scene->display_settings);
3217
3218         /* reset y zoom */
3219         hist->ymax = 1.0f;
3220
3221         ED_space_image_release_buffer(sima, ibuf, lock);
3222
3223         ED_area_tag_redraw(CTX_wm_area(C));
3224
3225         return OPERATOR_FINISHED;
3226 }
3227
3228 static int image_sample_line_invoke(bContext *C, wmOperator *op, const wmEvent *event)
3229 {
3230         SpaceImage *sima = CTX_wm_space_image(C);
3231
3232         Histogram *hist = &sima->sample_line_hist;
3233         hist->flag &= ~HISTO_FLAG_SAMPLELINE;
3234
3235         if (!ED_space_image_has_buffer(sima))
3236                 return OPERATOR_CANCELLED;
3237
3238         return WM_gesture_straightline_invoke(C, op, event);
3239 }
3240
3241 void IMAGE_OT_sample_line(wmOperatorType *ot)
3242 {
3243         /* identifiers */
3244         ot->name = "Sample Line";
3245         ot->idname = "IMAGE_OT_sample_line";
3246         ot->description = "Sample a line and show it in Scope panels";
3247
3248         /* api callbacks */
3249         ot->invoke = image_sample_line_invoke;
3250         ot->modal = WM_gesture_straightline_modal;
3251         ot->exec = image_sample_line_exec;
3252         ot->poll = space_image_main_region_poll;
3253         ot->cancel = WM_gesture_straightline_cancel;
3254
3255         /* flags */
3256         ot->flag = 0; /* no undo/register since this operates on the space */
3257
3258         WM_operator_properties_gesture_straightline(ot, CURSOR_EDIT);
3259 }
3260
3261 /******************** set curve point operator ********************/
3262
3263 void IMAGE_OT_curves_point_set(wmOperatorType *ot)
3264 {
3265         static const EnumPropertyItem point_items[] = {
3266                 {0, "BLACK_POINT", 0, "Black Point", ""},
3267                 {1, "WHITE_POINT", 0, "White Point", ""},
3268                 {0, NULL, 0, NULL, NULL}
3269         };
3270
3271         /* identifiers */