4 * ***** BEGIN GPL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21 * All rights reserved.
23 * Contributor(s): Blender Foundation, 2002-2009, Xavier Thomas
25 * ***** END GPL LICENSE BLOCK *****
28 /** \file blender/editors/space_image/image_ops.c
38 #include "MEM_guardedalloc.h"
41 #include "BLI_blenlib.h"
42 #include "BLI_utildefines.h"
44 #include "DNA_object_types.h"
45 #include "DNA_node_types.h"
46 #include "DNA_packedFile_types.h"
47 #include "DNA_scene_types.h"
49 #include "BKE_colortools.h"
50 #include "BKE_context.h"
51 #include "BKE_image.h"
52 #include "BKE_global.h"
53 #include "BKE_library.h"
56 #include "BKE_packedFile.h"
57 #include "BKE_report.h"
58 #include "BKE_screen.h"
60 #include "IMB_imbuf.h"
61 #include "IMB_imbuf_types.h"
63 #include "RE_pipeline.h"
65 #include "RNA_access.h"
66 #include "RNA_define.h"
67 #include "RNA_enum_types.h"
70 #include "ED_render.h"
71 #include "ED_screen.h"
72 #include "ED_space_api.h"
73 #include "ED_uvedit.h"
76 #include "UI_interface.h"
77 #include "UI_resources.h"
78 #include "UI_view2d.h"
83 #include "image_intern.h"
85 /******************** view navigation utilities *********************/
87 static void sima_zoom_set(SpaceImage *sima, ARegion *ar, float zoom)
89 float oldzoom= sima->zoom;
94 if (sima->zoom > 0.1f && sima->zoom < 4.0f)
97 /* check zoom limits */
98 ED_space_image_size(sima, &width, &height);
101 height *= sima->zoom;
103 if((width < 4) && (height < 4))
105 else if((ar->winrct.xmax - ar->winrct.xmin) <= sima->zoom)
107 else if((ar->winrct.ymax - ar->winrct.ymin) <= sima->zoom)
111 static void sima_zoom_set_factor(SpaceImage *sima, ARegion *ar, float zoomfac)
113 sima_zoom_set(sima, ar, sima->zoom*zoomfac);
116 #if 0 // currently unused
117 static int image_poll(bContext *C)
119 return (CTX_data_edit_image(C) != NULL);
123 static int space_image_buffer_exists_poll(bContext *C)
125 SpaceImage *sima= CTX_wm_space_image(C);
126 if(sima && sima->spacetype==SPACE_IMAGE)
127 if(ED_space_image_has_buffer(sima))
132 static int space_image_file_exists_poll(bContext *C)
134 if(space_image_buffer_exists_poll(C)) {
135 Main *bmain= CTX_data_main(C);
136 SpaceImage *sima= CTX_wm_space_image(C);
142 ibuf= ED_space_image_acquire_buffer(sima, &lock);
144 BLI_strncpy(name, ibuf->name, FILE_MAX);
145 BLI_path_abs(name, bmain->name);
146 poll= (BLI_exists(name) && BLI_is_writable(name));
148 ED_space_image_release_buffer(sima, lock);
155 static int space_image_poll(bContext *C)
157 SpaceImage *sima= CTX_wm_space_image(C);
158 if(sima && sima->spacetype==SPACE_IMAGE && sima->image)
163 int space_image_main_area_poll(bContext *C)
165 SpaceImage *sima= CTX_wm_space_image(C);
166 // XXX ARegion *ar= CTX_wm_region(C);
169 return 1; // XXX (ar && ar->type->regionid == RGN_TYPE_WINDOW);
174 /********************** view pan operator *********************/
176 typedef struct ViewPanData {
182 static void view_pan_init(bContext *C, wmOperator *op, wmEvent *event)
184 SpaceImage *sima= CTX_wm_space_image(C);
187 op->customdata= vpd= MEM_callocN(sizeof(ViewPanData), "ImageViewPanData");
188 WM_cursor_modal(CTX_wm_window(C), BC_NSEW_SCROLLCURSOR);
194 vpd->event_type= event->type;
196 WM_event_add_modal_handler(C, op);
199 static void view_pan_exit(bContext *C, wmOperator *op, int cancel)
201 SpaceImage *sima= CTX_wm_space_image(C);
202 ViewPanData *vpd= op->customdata;
207 ED_region_tag_redraw(CTX_wm_region(C));
210 WM_cursor_restore(CTX_wm_window(C));
211 MEM_freeN(op->customdata);
214 static int view_pan_exec(bContext *C, wmOperator *op)
216 SpaceImage *sima= CTX_wm_space_image(C);
219 RNA_float_get_array(op->ptr, "offset", offset);
220 sima->xof += offset[0];
221 sima->yof += offset[1];
223 ED_region_tag_redraw(CTX_wm_region(C));
227 if(image_preview_active(curarea, NULL, NULL)) {
228 /* recalculates new preview rect */
229 scrarea_do_windraw(curarea);
230 image_preview_event(2);
234 return OPERATOR_FINISHED;
237 static int view_pan_invoke(bContext *C, wmOperator *op, wmEvent *event)
239 if (event->type == MOUSEPAN) {
240 SpaceImage *sima= CTX_wm_space_image(C);
243 offset[0]= (event->x - event->prevx)/sima->zoom;
244 offset[1]= (event->y - event->prevy)/sima->zoom;
245 RNA_float_set_array(op->ptr, "offset", offset);
247 view_pan_exec(C, op);
248 return OPERATOR_FINISHED;
251 view_pan_init(C, op, event);
252 return OPERATOR_RUNNING_MODAL;
256 static int view_pan_modal(bContext *C, wmOperator *op, wmEvent *event)
258 SpaceImage *sima= CTX_wm_space_image(C);
259 ViewPanData *vpd= op->customdata;
262 switch(event->type) {
266 offset[0]= (vpd->x - event->x)/sima->zoom;
267 offset[1]= (vpd->y - event->y)/sima->zoom;
268 RNA_float_set_array(op->ptr, "offset", offset);
269 view_pan_exec(C, op);
272 if(event->type==vpd->event_type && event->val==KM_RELEASE) {
273 view_pan_exit(C, op, 0);
274 return OPERATOR_FINISHED;
279 return OPERATOR_RUNNING_MODAL;
282 static int view_pan_cancel(bContext *C, wmOperator *op)
284 view_pan_exit(C, op, 1);
285 return OPERATOR_CANCELLED;
288 void IMAGE_OT_view_pan(wmOperatorType *ot)
291 ot->name= "View Pan";
292 ot->idname= "IMAGE_OT_view_pan";
295 ot->exec= view_pan_exec;
296 ot->invoke= view_pan_invoke;
297 ot->modal= view_pan_modal;
298 ot->cancel= view_pan_cancel;
299 ot->poll= space_image_main_area_poll;
302 ot->flag= OPTYPE_BLOCKING;
305 RNA_def_float_vector(ot->srna, "offset", 2, NULL, -FLT_MAX, FLT_MAX,
306 "Offset", "Offset in floating point units, 1.0 is the width and height of the image.", -FLT_MAX, FLT_MAX);
309 /********************** view zoom operator *********************/
311 typedef struct ViewZoomData {
317 static void view_zoom_init(bContext *C, wmOperator *op, wmEvent *event)
319 SpaceImage *sima= CTX_wm_space_image(C);
322 op->customdata= vpd= MEM_callocN(sizeof(ViewZoomData), "ImageViewZoomData");
323 WM_cursor_modal(CTX_wm_window(C), BC_NSEW_SCROLLCURSOR);
327 vpd->zoom= sima->zoom;
328 vpd->event_type= event->type;
330 WM_event_add_modal_handler(C, op);
333 static void view_zoom_exit(bContext *C, wmOperator *op, int cancel)
335 SpaceImage *sima= CTX_wm_space_image(C);
336 ViewZoomData *vpd= op->customdata;
339 sima->zoom= vpd->zoom;
340 ED_region_tag_redraw(CTX_wm_region(C));
343 WM_cursor_restore(CTX_wm_window(C));
344 MEM_freeN(op->customdata);
347 static int view_zoom_exec(bContext *C, wmOperator *op)
349 SpaceImage *sima= CTX_wm_space_image(C);
350 ARegion *ar= CTX_wm_region(C);
352 sima_zoom_set_factor(sima, ar, RNA_float_get(op->ptr, "factor"));
354 ED_region_tag_redraw(CTX_wm_region(C));
358 if(image_preview_active(curarea, NULL, NULL)) {
359 /* recalculates new preview rect */
360 scrarea_do_windraw(curarea);
361 image_preview_event(2);
365 return OPERATOR_FINISHED;
368 static int view_zoom_invoke(bContext *C, wmOperator *op, wmEvent *event)
370 if (event->type == MOUSEZOOM) {
371 SpaceImage *sima= CTX_wm_space_image(C);
372 ARegion *ar= CTX_wm_region(C);
375 factor= 1.0f + (event->x-event->prevx+event->y-event->prevy)/300.0f;
376 RNA_float_set(op->ptr, "factor", factor);
377 sima_zoom_set(sima, ar, sima->zoom*factor);
378 ED_region_tag_redraw(CTX_wm_region(C));
380 return OPERATOR_FINISHED;
383 view_zoom_init(C, op, event);
384 return OPERATOR_RUNNING_MODAL;
388 static int view_zoom_modal(bContext *C, wmOperator *op, wmEvent *event)
390 SpaceImage *sima= CTX_wm_space_image(C);
391 ARegion *ar= CTX_wm_region(C);
392 ViewZoomData *vpd= op->customdata;
395 switch(event->type) {
397 factor= 1.0f + (vpd->x-event->x+vpd->y-event->y)/300.0f;
398 RNA_float_set(op->ptr, "factor", factor);
399 sima_zoom_set(sima, ar, vpd->zoom*factor);
400 ED_region_tag_redraw(CTX_wm_region(C));
403 if(event->type==vpd->event_type && event->val==KM_RELEASE) {
404 view_zoom_exit(C, op, 0);
405 return OPERATOR_FINISHED;
410 return OPERATOR_RUNNING_MODAL;
413 static int view_zoom_cancel(bContext *C, wmOperator *op)
415 view_zoom_exit(C, op, 1);
416 return OPERATOR_CANCELLED;
419 void IMAGE_OT_view_zoom(wmOperatorType *ot)
422 ot->name= "View Zoom";
423 ot->idname= "IMAGE_OT_view_zoom";
426 ot->exec= view_zoom_exec;
427 ot->invoke= view_zoom_invoke;
428 ot->modal= view_zoom_modal;
429 ot->cancel= view_zoom_cancel;
430 ot->poll= space_image_main_area_poll;
433 ot->flag= OPTYPE_BLOCKING;
436 RNA_def_float(ot->srna, "factor", 0.0f, 0.0f, FLT_MAX,
437 "Factor", "Zoom factor, values higher than 1.0 zoom in, lower values zoom out.", -FLT_MAX, FLT_MAX);
440 /********************** NDOF operator *********************/
442 /* Combined pan/zoom from a 3D mouse device.
444 * "view" (not "paper") control -- user moves the viewpoint, not the image being viewed
445 * that explains the negative signs in the code below
448 static int view_ndof_invoke(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
450 if (event->type != NDOF_MOTION)
451 return OPERATOR_CANCELLED;
453 SpaceImage *sima= CTX_wm_space_image(C);
454 ARegion *ar= CTX_wm_region(C);
456 wmNDOFMotionData* ndof = (wmNDOFMotionData*) event->customdata;
459 /* tune these until it feels right */
460 const float zoom_sensitivity = 0.5f; // 50% per second (I think)
461 const float pan_sensitivity = 300.f; // screen pixels per second
463 float pan_x = pan_sensitivity * dt * ndof->tvec[0] / sima->zoom;
464 float pan_y = pan_sensitivity * dt * ndof->tvec[1] / sima->zoom;
466 /* "mouse zoom" factor = 1 + (dx + dy) / 300
467 * what about "ndof zoom" factor? should behave like this:
468 * at rest -> factor = 1
469 * move forward -> factor > 1
470 * move backward -> factor < 1
472 float zoom_factor = 1.f + zoom_sensitivity * dt * -ndof->tvec[2];
474 if (U.ndof_flag & NDOF_ZOOM_INVERT)
475 zoom_factor = -zoom_factor;
477 sima_zoom_set_factor(sima, ar, zoom_factor);
481 ED_region_tag_redraw(ar);
483 return OPERATOR_FINISHED;
487 void IMAGE_OT_view_ndof(wmOperatorType *ot)
490 ot->name= "NDOF Pan/Zoom";
491 ot->idname= "IMAGE_OT_view_ndof";
494 ot->invoke= view_ndof_invoke;
497 /********************** view all operator *********************/
499 /* Updates the fields of the View2D member of the SpaceImage struct.
500 * Default behavior is to reset the position of the image and set the zoom to 1
501 * If the image will not fit within the window rectangle, the zoom is adjusted */
503 static int view_all_exec(bContext *C, wmOperator *UNUSED(op))
507 float aspx, aspy, zoomx, zoomy, w, h;
511 sima= CTX_wm_space_image(C);
512 ar= CTX_wm_region(C);
514 ED_space_image_size(sima, &width, &height);
515 ED_space_image_aspect(sima, &aspx, &aspy);
520 /* check if the image will fit in the image with zoom==1 */
521 width = ar->winrct.xmax - ar->winrct.xmin + 1;
522 height = ar->winrct.ymax - ar->winrct.ymin + 1;
524 if((w >= width || h >= height) && (width > 0 && height > 0)) {
525 /* find the zoom value that will fit the image in the image space */
528 sima_zoom_set(sima, ar, 1.0f/power_of_2(1/MIN2(zoomx, zoomy)));
531 sima_zoom_set(sima, ar, 1.0f);
533 sima->xof= sima->yof= 0.0f;
535 ED_region_tag_redraw(CTX_wm_region(C));
537 return OPERATOR_FINISHED;
540 void IMAGE_OT_view_all(wmOperatorType *ot)
543 ot->name= "View All";
544 ot->idname= "IMAGE_OT_view_all";
547 ot->exec= view_all_exec;
548 ot->poll= space_image_main_area_poll;
551 /********************** view selected operator *********************/
553 static int view_selected_exec(bContext *C, wmOperator *UNUSED(op))
560 float size, min[2], max[2], d[2], aspx, aspy;
564 sima= CTX_wm_space_image(C);
565 ar= CTX_wm_region(C);
566 scene= (Scene*)CTX_data_scene(C);
567 obedit= CTX_data_edit_object(C);
569 ima= ED_space_image(sima);
570 ED_space_image_size(sima, &width, &height);
571 ED_image_aspect(ima, &aspx, &aspy);
577 if(!ED_uvedit_minmax(scene, ima, obedit, min, max))
578 return OPERATOR_CANCELLED;
580 /* adjust offset and zoom */
581 sima->xof= (int)(((min[0] + max[0])*0.5f - 0.5f)*width);
582 sima->yof= (int)(((min[1] + max[1])*0.5f - 0.5f)*height);
584 d[0]= max[0] - min[0];
585 d[1]= max[1] - min[1];
586 size= 0.5f*MAX2(d[0], d[1])*MAX2(width, height)/256.0f;
588 if(size<=0.01f) size= 0.01f;
589 sima_zoom_set(sima, ar, 0.7f/size);
591 ED_region_tag_redraw(CTX_wm_region(C));
593 return OPERATOR_FINISHED;
596 static int view_selected_poll(bContext *C)
598 return (space_image_main_area_poll(C) && ED_operator_uvedit(C));
601 void IMAGE_OT_view_selected(wmOperatorType *ot)
604 ot->name= "View Center";
605 ot->idname= "IMAGE_OT_view_selected";
608 ot->exec= view_selected_exec;
609 ot->poll= view_selected_poll;
612 /********************** view zoom in/out operator *********************/
614 static int view_zoom_in_exec(bContext *C, wmOperator *UNUSED(op))
616 SpaceImage *sima= CTX_wm_space_image(C);
617 ARegion *ar= CTX_wm_region(C);
619 sima_zoom_set_factor(sima, ar, 1.25f);
621 ED_region_tag_redraw(CTX_wm_region(C));
623 return OPERATOR_FINISHED;
626 void IMAGE_OT_view_zoom_in(wmOperatorType *ot)
629 ot->name= "View Zoom In";
630 ot->idname= "IMAGE_OT_view_zoom_in";
633 ot->exec= view_zoom_in_exec;
634 ot->poll= space_image_main_area_poll;
637 static int view_zoom_out_exec(bContext *C, wmOperator *UNUSED(op))
639 SpaceImage *sima= CTX_wm_space_image(C);
640 ARegion *ar= CTX_wm_region(C);
642 sima_zoom_set_factor(sima, ar, 0.8f);
644 ED_region_tag_redraw(CTX_wm_region(C));
646 return OPERATOR_FINISHED;
649 void IMAGE_OT_view_zoom_out(wmOperatorType *ot)
652 ot->name= "View Zoom Out";
653 ot->idname= "IMAGE_OT_view_zoom_out";
656 ot->exec= view_zoom_out_exec;
657 ot->poll= space_image_main_area_poll;
660 /********************** view zoom ratio operator *********************/
662 static int view_zoom_ratio_exec(bContext *C, wmOperator *op)
664 SpaceImage *sima= CTX_wm_space_image(C);
665 ARegion *ar= CTX_wm_region(C);
667 sima_zoom_set(sima, ar, RNA_float_get(op->ptr, "ratio"));
669 /* ensure pixel exact locations for draw */
670 sima->xof= (int)sima->xof;
671 sima->yof= (int)sima->yof;
675 if(image_preview_active(curarea, NULL, NULL)) {
676 /* recalculates new preview rect */
677 scrarea_do_windraw(curarea);
678 image_preview_event(2);
682 ED_region_tag_redraw(CTX_wm_region(C));
684 return OPERATOR_FINISHED;
687 void IMAGE_OT_view_zoom_ratio(wmOperatorType *ot)
690 ot->name= "View Zoom Ratio";
691 ot->idname= "IMAGE_OT_view_zoom_ratio";
694 ot->exec= view_zoom_ratio_exec;
695 ot->poll= space_image_main_area_poll;
698 RNA_def_float(ot->srna, "ratio", 0.0f, 0.0f, FLT_MAX,
699 "Ratio", "Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out.", -FLT_MAX, FLT_MAX);
702 /**************** load/replace/save callbacks ******************/
704 /* XXX make dynamic */
705 static const EnumPropertyItem image_file_type_items[] = {
706 {R_TARGA, "TARGA", 0, "Targa", ""},
707 {R_RAWTGA, "TARGA RAW", 0, "Targa Raw", ""},
708 {R_PNG, "PNG", 0, "PNG", ""},
710 {R_DDS, "DDS", 0, "DirectDraw Surface", ""},
712 {R_BMP, "BMP", 0, "BMP", ""},
713 {R_JPEG90, "JPEG", 0, "Jpeg", ""},
715 {R_JP2, "JPEG_2000", 0, "Jpeg 2000", ""},
717 {R_IRIS, "IRIS", 0, "Iris", ""},
719 {R_TIFF, "TIFF", 0, "Tiff", ""},
722 {R_RADHDR, "RADIANCE_HDR", 0, "Radiance HDR", ""},
725 {R_CINEON, "CINEON", 0, "Cineon", ""},
726 {R_DPX, "DPX", 0, "DPX", ""},
729 {R_OPENEXR, "OPENEXR", 0, "OpenEXR", ""},
730 /* saving sequences of multilayer won't work, they copy buffers */
731 /*if(ima->source==IMA_SRC_SEQUENCE && ima->type==IMA_TYPE_MULTILAYER);
733 {R_MULTILAYER, "MULTILAYER", 0, "MultiLayer", ""},
735 {0, NULL, 0, NULL, NULL}};
737 static void image_filesel(bContext *C, wmOperator *op, const char *path)
739 RNA_string_set(op->ptr, "filepath", path);
740 WM_event_add_fileselect(C, op);
743 /******************** open image operator ********************/
745 static void open_init(bContext *C, wmOperator *op)
747 PropertyPointerRNA *pprop;
749 op->customdata= pprop= MEM_callocN(sizeof(PropertyPointerRNA), "OpenPropertyPointerRNA");
750 uiIDContextProperty(C, &pprop->ptr, &pprop->prop);
753 static int open_cancel(bContext *UNUSED(C), wmOperator *op)
755 MEM_freeN(op->customdata);
756 op->customdata= NULL;
757 return OPERATOR_CANCELLED;
760 static int open_exec(bContext *C, wmOperator *op)
762 SpaceImage *sima= CTX_wm_space_image(C); /* XXX other space types can call */
763 Scene *scene= CTX_data_scene(C);
764 Object *obedit= CTX_data_edit_object(C);
765 ImageUser *iuser= NULL;
766 PropertyPointerRNA *pprop;
771 RNA_string_get(op->ptr, "filepath", str);
772 /* default to frame 1 if there's no scene in context */
776 ima= BKE_add_image_file(str);
779 if(op->customdata) MEM_freeN(op->customdata);
780 BKE_reportf(op->reports, RPT_ERROR, "Can't read: \"%s\", %s.", str, errno ? strerror(errno) : "Unsupported image format");
781 return OPERATOR_CANCELLED;
788 pprop= op->customdata;
791 /* when creating new ID blocks, use is already 1, but RNA
792 * pointer se also increases user, so this compensates it */
795 RNA_id_pointer_create(&ima->id, &idptr);
796 RNA_property_pointer_set(&pprop->ptr, pprop->prop, idptr);
797 RNA_property_update(C, &pprop->ptr, pprop->prop);
800 ED_space_image_set(C, sima, scene, obedit, ima);
804 Tex *tex= CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
805 if(tex && tex->type==TEX_IMAGE)
810 /* initialize because of new image */
817 /* XXX unpackImage frees image buffers */
818 ED_preview_kill_jobs(C);
820 BKE_image_signal(ima, iuser, IMA_SIGNAL_RELOAD);
821 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, ima);
823 MEM_freeN(op->customdata);
825 return OPERATOR_FINISHED;
828 static int open_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
830 SpaceImage *sima= CTX_wm_space_image(C); /* XXX other space types can call */
831 char *path=U.textudir;
839 Tex *tex= CTX_data_pointer_get_type(C, "texture", &RNA_Texture).data;
840 if(tex && tex->type==TEX_IMAGE)
848 if(!RNA_property_is_set(op->ptr, "relative_path"))
849 RNA_boolean_set(op->ptr, "relative_path", U.flag & USER_RELPATHS);
851 if(RNA_property_is_set(op->ptr, "filepath"))
852 return open_exec(C, op);
856 image_filesel(C, op, path);
858 return OPERATOR_RUNNING_MODAL;
861 /* called by other space types too */
862 void IMAGE_OT_open(wmOperatorType *ot)
865 ot->name= "Open Image";
866 ot->description= "Open image";
867 ot->idname= "IMAGE_OT_open";
871 ot->invoke= open_invoke;
872 ot->cancel= open_cancel;
875 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
878 WM_operator_properties_filesel(ot, FOLDERFILE|IMAGEFILE|MOVIEFILE, FILE_SPECIAL, FILE_OPENFILE, WM_FILESEL_FILEPATH|WM_FILESEL_RELPATH);
881 /******************** replace image operator ********************/
883 static int replace_exec(bContext *C, wmOperator *op)
885 SpaceImage *sima= CTX_wm_space_image(C);
889 return OPERATOR_CANCELLED;
891 RNA_string_get(op->ptr, "filepath", str);
892 BLI_strncpy(sima->image->name, str, sizeof(sima->image->name)); /* we cant do much if the str is longer then 240 :/ */
894 /* XXX unpackImage frees image buffers */
895 ED_preview_kill_jobs(C);
897 BKE_image_signal(sima->image, &sima->iuser, IMA_SIGNAL_RELOAD);
898 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, sima->image);
900 return OPERATOR_FINISHED;
903 static int replace_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
905 SpaceImage *sima= CTX_wm_space_image(C);
908 return OPERATOR_CANCELLED;
910 if(RNA_property_is_set(op->ptr, "filepath"))
911 return replace_exec(C, op);
913 if(!RNA_property_is_set(op->ptr, "relative_path"))
914 RNA_boolean_set(op->ptr, "relative_path", (strncmp(sima->image->name, "//", 2))==0);
916 image_filesel(C, op, sima->image->name);
918 return OPERATOR_RUNNING_MODAL;
921 void IMAGE_OT_replace(wmOperatorType *ot)
924 ot->name= "Replace Image";
925 ot->idname= "IMAGE_OT_replace";
928 ot->exec= replace_exec;
929 ot->invoke= replace_invoke;
930 ot->poll= space_image_poll;
933 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
936 WM_operator_properties_filesel(ot, FOLDERFILE|IMAGEFILE|MOVIEFILE, FILE_SPECIAL, FILE_OPENFILE, WM_FILESEL_FILEPATH|WM_FILESEL_RELPATH);
939 /******************** save image as operator ********************/
942 /* matching scene->r settings */
943 short planes, imtype, subimtype, quality;
944 char filepath[FILE_MAX]; /* keep absolute */
947 static void save_image_options_defaults(SaveImageOptions *simopts)
949 simopts->planes= R_PLANES24;
950 simopts->imtype= R_PNG;
951 simopts->subimtype= 0;
952 simopts->quality= 90;
953 simopts->filepath[0]= '\0';
956 static int save_image_options_init(SaveImageOptions *simopts, SpaceImage *sima, Scene *scene, const short guess_path)
959 ImBuf *ibuf= ED_space_image_acquire_buffer(sima, &lock);
962 Image *ima= sima->image;
963 RenderResult *rr= BKE_image_acquire_renderresult(scene, ima);
965 simopts->planes= ibuf->depth;
967 /* cant save multilayer sequence, ima->rr isn't valid for a specific frame */
968 if(rr && !(ima->source==IMA_SRC_SEQUENCE && ima->type==IMA_TYPE_MULTILAYER))
969 simopts->imtype= R_MULTILAYER;
970 else if(ima->type==IMA_TYPE_R_RESULT)
971 simopts->imtype= scene->r.imtype;
972 else if (ima->source == IMA_SRC_GENERATED)
973 simopts->imtype= R_PNG;
975 simopts->imtype= BKE_ftype_to_imtype(ibuf->ftype);
977 simopts->subimtype= scene->r.subimtype; /* XXX - this is lame, we need to make these available too! */
978 simopts->quality= ibuf->ftype & 0xff;
980 BLI_strncpy(simopts->filepath, ibuf->name, sizeof(simopts->filepath));
982 /* sanitize all settings */
984 /* unlikely but just incase */
985 if (ELEM3(simopts->planes, R_PLANESBW, R_PLANES24, R_PLANES32) == 0) {
986 simopts->planes= R_PLANES32;
989 /* some formats dont use quality so fallback to scenes quality */
990 if (simopts->quality == 0) {
991 simopts->quality= scene->r.quality;
994 /* check for empty path */
995 if(guess_path && simopts->filepath[0]==0) {
996 if ( (G.ima[0] == '/') && (G.ima[1] == '/') && (G.ima[2] == '\0') ) {
997 BLI_strncpy(simopts->filepath, "//untitled", FILE_MAX);
999 BLI_strncpy(simopts->filepath, G.ima, FILE_MAX);
1001 BLI_path_abs(simopts->filepath, G.main->name);
1004 BKE_image_release_renderresult(scene, ima);
1007 ED_space_image_release_buffer(sima, lock);
1009 return (ibuf != NULL);
1012 static void save_image_options_from_op(SaveImageOptions *simopts, wmOperator *op)
1014 if (RNA_property_is_set(op->ptr, "color_mode")) simopts->planes= RNA_enum_get(op->ptr, "color_mode");
1015 if (RNA_property_is_set(op->ptr, "file_format")) simopts->imtype= RNA_enum_get(op->ptr, "file_format");
1016 // if (RNA_property_is_set(op->ptr, "subimtype")) simopts->subimtype= RNA_enum_get(op->ptr, "subimtype"); // XXX
1017 if (RNA_property_is_set(op->ptr, "file_quality")) simopts->quality= RNA_int_get(op->ptr, "file_quality");
1019 if (RNA_property_is_set(op->ptr, "filepath")) RNA_string_get(op->ptr, "filepath", simopts->filepath);
1022 static void save_image_options_to_op(SaveImageOptions *simopts, wmOperator *op)
1024 RNA_enum_set(op->ptr, "color_mode", simopts->planes);
1025 RNA_enum_set(op->ptr, "file_format", simopts->imtype);
1026 // RNA_enum_set(op->ptr, "subimtype", simopts->subimtype);
1027 RNA_int_set(op->ptr, "file_quality", simopts->quality);
1029 RNA_string_set(op->ptr, "filepath", simopts->filepath);
1032 /* assumes name is FILE_MAX */
1033 /* ima->name and ibuf->name should end up the same */
1034 static void save_image_doit(bContext *C, SpaceImage *sima, wmOperator *op, SaveImageOptions *simopts, int do_newpath)
1036 Image *ima= ED_space_image(sima);
1038 ImBuf *ibuf= ED_space_image_acquire_buffer(sima, &lock);
1041 Main *bmain= CTX_data_main(C);
1042 const short relative= (RNA_struct_find_property(op->ptr, "relative_path") && RNA_boolean_get(op->ptr, "relative_path"));
1043 const short save_copy= (RNA_struct_find_property(op->ptr, "copy") && RNA_boolean_get(op->ptr, "copy"));
1046 /* old global to ensure a 2nd save goes to same dir */
1047 BLI_strncpy(G.ima, simopts->filepath, sizeof(G.ima));
1051 if(ima->type == IMA_TYPE_R_RESULT) {
1052 /* enforce user setting for RGB or RGBA, but skip BW */
1053 if(simopts->planes==R_PLANES32) {
1056 else if(simopts->planes==R_PLANES24) {
1061 /* TODO, better solution, if a 24bit image is painted onto it may contain alpha */
1062 if(ibuf->userflags & IB_BITMAPDIRTY) { /* it has been painted onto */
1063 /* checks each pixel, not ideal */
1064 ibuf->depth= BKE_alphatest_ibuf(ibuf) ? 32 : 24;
1068 if(simopts->imtype==R_MULTILAYER) {
1069 Scene *scene= CTX_data_scene(C);
1070 RenderResult *rr= BKE_image_acquire_renderresult(scene, ima);
1072 RE_WriteRenderResult(op->reports, rr, simopts->filepath, simopts->quality);
1076 BKE_report(op->reports, RPT_ERROR, "Did not write, no Multilayer Image");
1078 BKE_image_release_renderresult(scene, ima);
1080 else if (BKE_write_ibuf(ibuf, simopts->filepath, simopts->imtype, simopts->subimtype, simopts->quality)) {
1086 BLI_path_rel(simopts->filepath, bmain->name); /* only after saving */
1088 if(ibuf->name[0]==0) {
1089 BLI_strncpy(ibuf->name, simopts->filepath, sizeof(ibuf->name));
1090 BLI_strncpy(ima->name, simopts->filepath, sizeof(ima->name));
1095 BLI_strncpy(ima->name, simopts->filepath, sizeof(ima->name));
1096 BLI_strncpy(ibuf->name, simopts->filepath, sizeof(ibuf->name));
1099 ibuf->userflags &= ~IB_BITMAPDIRTY;
1102 if(ima->type==IMA_TYPE_R_RESULT) {
1103 ima->type= IMA_TYPE_IMAGE;
1105 /* workaround to ensure the render result buffer is no longer used
1106 * by this image, otherwise can crash when a new render result is
1108 if(ibuf->rect && !(ibuf->mall & IB_rect))
1109 imb_freerectImBuf(ibuf);
1110 if(ibuf->rect_float && !(ibuf->mall & IB_rectfloat))
1111 imb_freerectfloatImBuf(ibuf);
1112 if(ibuf->zbuf && !(ibuf->mall & IB_zbuf))
1113 IMB_freezbufImBuf(ibuf);
1114 if(ibuf->zbuf_float && !(ibuf->mall & IB_zbuffloat))
1115 IMB_freezbuffloatImBuf(ibuf);
1117 if( ELEM(ima->source, IMA_SRC_GENERATED, IMA_SRC_VIEWER)) {
1118 ima->source= IMA_SRC_FILE;
1119 ima->type= IMA_TYPE_IMAGE;
1124 BKE_reportf(op->reports, RPT_ERROR, "Couldn't write image: %s", simopts->filepath);
1128 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, sima->image);
1133 ED_space_image_release_buffer(sima, lock);
1136 static int save_as_exec(bContext *C, wmOperator *op)
1138 SpaceImage *sima= CTX_wm_space_image(C);
1139 SaveImageOptions simopts;
1141 /* just incase to initialize values,
1142 * these should be set on invoke or by the caller. */
1143 save_image_options_defaults(&simopts);
1144 save_image_options_from_op(&simopts, op);
1146 save_image_doit(C, sima, op, &simopts, TRUE);
1148 return OPERATOR_FINISHED;
1152 static int save_as_check(bContext *UNUSED(C), wmOperator *op)
1154 char filepath[FILE_MAX];
1155 RNA_string_get(op->ptr, "filepath", filepath);
1156 if(BKE_add_image_extension(filepath, RNA_enum_get(op->ptr, "file_format"))) {
1157 RNA_string_set(op->ptr, "filepath", filepath);
1163 static int save_as_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1165 SpaceImage *sima= CTX_wm_space_image(C);
1166 Image *ima = ED_space_image(sima);
1167 Scene *scene= CTX_data_scene(C);
1168 SaveImageOptions simopts;
1170 if(!RNA_property_is_set(op->ptr, "relative_path"))
1171 RNA_boolean_set(op->ptr, "relative_path", U.flag & USER_RELPATHS);
1173 if(RNA_property_is_set(op->ptr, "filepath"))
1174 return save_as_exec(C, op);
1176 if (save_image_options_init(&simopts, sima, scene, TRUE) == 0)
1177 return OPERATOR_CANCELLED;
1178 save_image_options_to_op(&simopts, op);
1180 /* enable save_copy by default for render results */
1181 if(ELEM(ima->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE) && !RNA_property_is_set(op->ptr, "copy")) {
1182 RNA_boolean_set(op->ptr, "copy", TRUE);
1185 // XXX note: we can give default menu enums to operator for this
1186 image_filesel(C, op, simopts.filepath);
1188 return OPERATOR_RUNNING_MODAL;
1191 void IMAGE_OT_save_as(wmOperatorType *ot)
1196 ot->name= "Save As Image";
1197 ot->idname= "IMAGE_OT_save_as";
1200 ot->exec= save_as_exec;
1201 ot->check= save_as_check;
1202 ot->invoke= save_as_invoke;
1203 ot->poll= space_image_buffer_exists_poll;
1206 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1210 /* format options */
1211 RNA_def_enum(ot->srna, "file_format", image_file_type_items, R_PNG, "File Type", "File type to save image as.");
1212 RNA_def_enum(ot->srna, "color_mode", image_color_mode_items, R_PLANES24, "Channels", "Image channels to save");
1213 prop= RNA_def_int(ot->srna, "file_quality", 90, 0, 100, "Quality", "", 0, 100);
1214 RNA_def_property_subtype(prop, PROP_PERCENTAGE);
1216 WM_operator_properties_filesel(ot, FOLDERFILE|IMAGEFILE|MOVIEFILE, FILE_SPECIAL, FILE_SAVE, WM_FILESEL_FILEPATH|WM_FILESEL_RELPATH);
1218 RNA_def_boolean(ot->srna, "copy", 0, "Copy", "Create a new image file without modifying the current image in blender");
1221 /******************** save image operator ********************/
1223 static int save_exec(bContext *C, wmOperator *op)
1225 SpaceImage *sima= CTX_wm_space_image(C);
1226 Scene *scene= CTX_data_scene(C);
1227 SaveImageOptions simopts;
1229 if (save_image_options_init(&simopts, sima, scene, FALSE) == 0)
1230 return OPERATOR_CANCELLED;
1231 save_image_options_from_op(&simopts, op);
1233 if (BLI_exists(simopts.filepath) && BLI_is_writable(simopts.filepath)) {
1234 save_image_doit(C, sima, op, &simopts, FALSE);
1237 BKE_reportf(op->reports, RPT_ERROR, "Can not save image, path '%s' is not writable.", simopts.filepath);
1238 return OPERATOR_CANCELLED;
1241 return OPERATOR_FINISHED;
1244 void IMAGE_OT_save(wmOperatorType *ot)
1247 ot->name= "Save Image";
1248 ot->idname= "IMAGE_OT_save";
1251 ot->exec= save_exec;
1252 ot->poll= space_image_file_exists_poll;
1255 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1258 /******************* save sequence operator ********************/
1260 static int save_sequence_exec(bContext *C, wmOperator *op)
1262 Main *bmain= CTX_data_main(C);
1263 SpaceImage *sima= CTX_wm_space_image(C);
1266 char di[FILE_MAX], fi[FILE_MAX];
1268 if(sima->image==NULL)
1269 return OPERATOR_CANCELLED;
1271 if(sima->image->source!=IMA_SRC_SEQUENCE) {
1272 BKE_report(op->reports, RPT_ERROR, "Can only save sequence on image sequences.");
1273 return OPERATOR_CANCELLED;
1276 if(sima->image->type==IMA_TYPE_MULTILAYER) {
1277 BKE_report(op->reports, RPT_ERROR, "Can't save multilayer sequences.");
1278 return OPERATOR_CANCELLED;
1282 for(ibuf= sima->image->ibufs.first; ibuf; ibuf= ibuf->next)
1283 if(ibuf->userflags & IB_BITMAPDIRTY)
1287 BKE_report(op->reports, RPT_WARNING, "No images have been changed.");
1288 return OPERATOR_CANCELLED;
1291 /* get a filename for menu */
1292 for(ibuf= sima->image->ibufs.first; ibuf; ibuf= ibuf->next)
1293 if(ibuf->userflags & IB_BITMAPDIRTY)
1296 BLI_strncpy(di, ibuf->name, FILE_MAX);
1297 BLI_splitdirstring(di, fi);
1299 BKE_reportf(op->reports, RPT_INFO, "%d Image(s) will be saved in %s", tot, di);
1301 for(ibuf= sima->image->ibufs.first; ibuf; ibuf= ibuf->next) {
1302 if(ibuf->userflags & IB_BITMAPDIRTY) {
1303 char name[FILE_MAX];
1304 BLI_strncpy(name, ibuf->name, sizeof(name));
1306 BLI_path_abs(name, bmain->name);
1308 if(0 == IMB_saveiff(ibuf, name, IB_rect | IB_zbuf | IB_zbuffloat)) {
1309 BKE_reportf(op->reports, RPT_ERROR, "Could not write image %s.", name);
1313 BKE_reportf(op->reports, RPT_INFO, "Saved: %s\n", ibuf->name);
1314 ibuf->userflags &= ~IB_BITMAPDIRTY;
1318 return OPERATOR_FINISHED;
1321 void IMAGE_OT_save_sequence(wmOperatorType *ot)
1324 ot->name= "Save Sequence";
1325 ot->idname= "IMAGE_OT_save_sequence";
1328 ot->exec= save_sequence_exec;
1329 ot->poll= space_image_buffer_exists_poll;
1332 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1335 /******************** reload image operator ********************/
1337 static int reload_exec(bContext *C, wmOperator *UNUSED(op))
1339 Image *ima= CTX_data_edit_image(C);
1340 SpaceImage *sima= CTX_wm_space_image(C);
1343 return OPERATOR_CANCELLED;
1345 /* XXX unpackImage frees image buffers */
1346 ED_preview_kill_jobs(C);
1349 BKE_image_signal(ima, (sima)? &sima->iuser: NULL, IMA_SIGNAL_RELOAD);
1351 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, ima);
1353 return OPERATOR_FINISHED;
1356 void IMAGE_OT_reload(wmOperatorType *ot)
1359 ot->name= "Reload Image";
1360 ot->idname= "IMAGE_OT_reload";
1363 ot->exec= reload_exec;
1366 ot->flag= OPTYPE_REGISTER; /* no undo, image buffer is not handled by undo */
1369 /********************** new image operator *********************/
1371 static int image_new_exec(bContext *C, wmOperator *op)
1377 PointerRNA ptr, idptr;
1379 char name[MAX_ID_NAME-2];
1381 int width, height, floatbuf, uvtestgrid, alpha;
1383 /* retrieve state */
1384 sima= CTX_wm_space_image(C);
1385 scene= (Scene*)CTX_data_scene(C);
1386 obedit= CTX_data_edit_object(C);
1388 RNA_string_get(op->ptr, "name", name);
1389 width= RNA_int_get(op->ptr, "width");
1390 height= RNA_int_get(op->ptr, "height");
1391 floatbuf= RNA_boolean_get(op->ptr, "float");
1392 uvtestgrid= RNA_boolean_get(op->ptr, "uv_test_grid");
1393 RNA_float_get_array(op->ptr, "color", color);
1394 alpha= RNA_boolean_get(op->ptr, "alpha");
1396 if (!floatbuf && scene->r.color_mgt_flag & R_COLOR_MANAGEMENT)
1397 linearrgb_to_srgb_v3_v3(color, color);
1402 ima = BKE_add_image_size(width, height, name, alpha ? 32 : 24, floatbuf, uvtestgrid, color);
1405 return OPERATOR_CANCELLED;
1408 uiIDContextProperty(C, &ptr, &prop);
1411 /* when creating new ID blocks, use is already 1, but RNA
1412 * pointer se also increases user, so this compensates it */
1415 RNA_id_pointer_create(&ima->id, &idptr);
1416 RNA_property_pointer_set(&ptr, prop, idptr);
1417 RNA_property_update(C, &ptr, prop);
1420 ED_space_image_set(C, sima, scene, obedit, ima);
1423 BKE_image_signal(ima, (sima)? &sima->iuser: NULL, IMA_SIGNAL_USER_NEW_IMAGE);
1425 return OPERATOR_FINISHED;
1428 /* XXX, Ton is not a fan of OK buttons but using this function to avoid undo/redo bug while in mesh-editmode, - campbell */
1429 static int image_new_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1431 return WM_operator_props_dialog_popup(C, op, 300, 100);
1435 void IMAGE_OT_new(wmOperatorType *ot)
1438 static float default_color[4]= {0.0f, 0.0f, 0.0f, 1.0f};
1441 ot->name= "New Image";
1442 ot->description= "Create a new image";
1443 ot->idname= "IMAGE_OT_new";
1446 ot->exec= image_new_exec;
1447 ot->invoke= image_new_invoke;
1450 ot->flag= OPTYPE_UNDO;
1453 RNA_def_string(ot->srna, "name", "untitled", MAX_ID_NAME-2, "Name", "Image datablock name.");
1454 RNA_def_int(ot->srna, "width", 1024, 1, INT_MAX, "Width", "Image width.", 1, 16384);
1455 RNA_def_int(ot->srna, "height", 1024, 1, INT_MAX, "Height", "Image height.", 1, 16384);
1456 prop= RNA_def_float_color(ot->srna, "color", 4, NULL, 0.0f, FLT_MAX, "Color", "Default fill color.", 0.0f, 1.0f);
1457 RNA_def_property_float_array_default(prop, default_color);
1458 RNA_def_boolean(ot->srna, "alpha", 1, "Alpha", "Create an image with an alpha channel.");
1459 RNA_def_boolean(ot->srna, "uv_test_grid", 0, "UV Test Grid", "Fill the image with a grid for UV map testing.");
1460 RNA_def_boolean(ot->srna, "float", 0, "32 bit Float", "Create image with 32 bit floating point bit depth.");
1463 /********************* invert operators *********************/
1465 static int image_invert_poll(bContext *C)
1467 Image *ima= CTX_data_edit_image(C);
1468 ImBuf *ibuf= BKE_image_get_ibuf(ima, NULL);
1475 static int image_invert_exec(bContext *C, wmOperator *op)
1477 Image *ima= CTX_data_edit_image(C);
1478 ImBuf *ibuf= BKE_image_get_ibuf(ima, NULL);
1480 // flags indicate if this channel should be inverted
1481 const short r= RNA_boolean_get(op->ptr, "invert_r");
1482 const short g= RNA_boolean_get(op->ptr, "invert_g");
1483 const short b= RNA_boolean_get(op->ptr, "invert_b");
1484 const short a= RNA_boolean_get(op->ptr, "invert_a");
1488 if( ibuf == NULL) // TODO: this should actually never happen, but does for render-results -> cleanup
1489 return OPERATOR_CANCELLED;
1491 /* TODO: make this into an IMB_invert_channels(ibuf,r,g,b,a) method!? */
1492 if (ibuf->rect_float) {
1494 float *fp = (float *) ibuf->rect_float;
1495 for( i = ibuf->x * ibuf->y; i > 0; i--, fp+=4 ) {
1496 if( r ) fp[0] = 1.0f - fp[0];
1497 if( g ) fp[1] = 1.0f - fp[1];
1498 if( b ) fp[2] = 1.0f - fp[2];
1499 if( a ) fp[3] = 1.0f - fp[3];
1503 IMB_rect_from_float(ibuf);
1506 else if(ibuf->rect) {
1508 char *cp = (char *) ibuf->rect;
1509 for( i = ibuf->x * ibuf->y; i > 0; i--, cp+=4 ) {
1510 if( r ) cp[0] = 255 - cp[0];
1511 if( g ) cp[1] = 255 - cp[1];
1512 if( b ) cp[2] = 255 - cp[2];
1513 if( a ) cp[3] = 255 - cp[3];
1517 return OPERATOR_CANCELLED;
1520 ibuf->userflags |= IB_BITMAPDIRTY;
1522 ibuf->userflags |= IB_MIPMAP_INVALID;
1524 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, ima);
1525 return OPERATOR_FINISHED;
1528 void IMAGE_OT_invert(wmOperatorType *ot)
1531 ot->name= "Invert Channels";
1532 ot->idname= "IMAGE_OT_invert";
1535 ot->exec= image_invert_exec;
1536 ot->poll= image_invert_poll;
1539 RNA_def_boolean(ot->srna, "invert_r", 0, "Red", "Invert Red Channel");
1540 RNA_def_boolean(ot->srna, "invert_g", 0, "Green", "Invert Green Channel");
1541 RNA_def_boolean(ot->srna, "invert_b", 0, "Blue", "Invert Blue Channel");
1542 RNA_def_boolean(ot->srna, "invert_a", 0, "Alpha", "Invert Alpha Channel");
1545 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1548 /********************* pack operator *********************/
1550 static int pack_test(bContext *C, wmOperator *op)
1552 Image *ima= CTX_data_edit_image(C);
1553 int as_png= RNA_boolean_get(op->ptr, "as_png");
1557 if(!as_png && ima->packedfile)
1560 if(ima->source==IMA_SRC_SEQUENCE || ima->source==IMA_SRC_MOVIE) {
1561 BKE_report(op->reports, RPT_ERROR, "Packing movies or image sequences not supported.");
1568 static int pack_exec(bContext *C, wmOperator *op)
1570 Image *ima= CTX_data_edit_image(C);
1571 ImBuf *ibuf= BKE_image_get_ibuf(ima, NULL);
1572 int as_png= RNA_boolean_get(op->ptr, "as_png");
1574 if(!pack_test(C, op))
1575 return OPERATOR_CANCELLED;
1577 if(!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
1578 BKE_report(op->reports, RPT_ERROR, "Can't pack edited image from disk, only as internal PNG.");
1579 return OPERATOR_CANCELLED;
1583 BKE_image_memorypack(ima);
1585 ima->packedfile= newPackedFile(op->reports, ima->name);
1587 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, ima);
1589 return OPERATOR_FINISHED;
1592 static int pack_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1594 Image *ima= CTX_data_edit_image(C);
1595 ImBuf *ibuf= BKE_image_get_ibuf(ima, NULL);
1598 int as_png= RNA_boolean_get(op->ptr, "as_png");
1600 if(!pack_test(C, op))
1601 return OPERATOR_CANCELLED;
1603 if(!as_png && (ibuf && (ibuf->userflags & IB_BITMAPDIRTY))) {
1604 pup= uiPupMenuBegin(C, "OK", ICON_QUESTION);
1605 layout= uiPupMenuLayout(pup);
1606 uiItemBooleanO(layout, "Can't pack edited image from disk. Pack as internal PNG?", ICON_NONE, op->idname, "as_png", 1);
1607 uiPupMenuEnd(C, pup);
1609 return OPERATOR_CANCELLED;
1612 return pack_exec(C, op);
1615 void IMAGE_OT_pack(wmOperatorType *ot)
1618 ot->name= "Pack Image";
1619 ot->description= "Pack an image as embedded data into the .blend file";
1620 ot->idname= "IMAGE_OT_pack";
1623 ot->exec= pack_exec;
1624 ot->invoke= pack_invoke;
1627 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1630 RNA_def_boolean(ot->srna, "as_png", 0, "Pack As PNG", "Pack image as lossless PNG.");
1633 /********************* unpack operator *********************/
1635 static int image_unpack_exec(bContext *C, wmOperator *op)
1637 Image *ima= CTX_data_edit_image(C);
1638 int method= RNA_enum_get(op->ptr, "method");
1640 /* find the suppplied image by name */
1641 if (RNA_property_is_set(op->ptr, "id")) {
1642 char imaname[MAX_ID_NAME-2];
1643 RNA_string_get(op->ptr, "id", imaname);
1644 ima = BLI_findstring(&CTX_data_main(C)->image, imaname, offsetof(ID, name) + 2);
1645 if (!ima) ima = CTX_data_edit_image(C);
1648 if(!ima || !ima->packedfile)
1649 return OPERATOR_CANCELLED;
1651 if(ima->source==IMA_SRC_SEQUENCE || ima->source==IMA_SRC_MOVIE) {
1652 BKE_report(op->reports, RPT_ERROR, "Unpacking movies or image sequences not supported.");
1653 return OPERATOR_CANCELLED;
1656 if(G.fileflags & G_AUTOPACK)
1657 BKE_report(op->reports, RPT_WARNING, "AutoPack is enabled, so image will be packed again on file save.");
1659 /* XXX unpackImage frees image buffers */
1660 ED_preview_kill_jobs(C);
1662 unpackImage(op->reports, ima, method);
1664 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, ima);
1666 return OPERATOR_FINISHED;
1669 static int image_unpack_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1671 Image *ima= CTX_data_edit_image(C);
1673 if(RNA_property_is_set(op->ptr, "id"))
1674 return image_unpack_exec(C, op);
1676 if(!ima || !ima->packedfile)
1677 return OPERATOR_CANCELLED;
1679 if(ima->source==IMA_SRC_SEQUENCE || ima->source==IMA_SRC_MOVIE) {
1680 BKE_report(op->reports, RPT_ERROR, "Unpacking movies or image sequences not supported.");
1681 return OPERATOR_CANCELLED;
1684 if(G.fileflags & G_AUTOPACK)
1685 BKE_report(op->reports, RPT_WARNING, "AutoPack is enabled, so image will be packed again on file save.");
1687 unpack_menu(C, "IMAGE_OT_unpack", ima->id.name+2, ima->name, "textures", ima->packedfile);
1689 return OPERATOR_FINISHED;
1692 void IMAGE_OT_unpack(wmOperatorType *ot)
1695 ot->name= "Unpack Image";
1696 ot->description= "Save an image packed in the .blend file to disk";
1697 ot->idname= "IMAGE_OT_unpack";
1700 ot->exec= image_unpack_exec;
1701 ot->invoke= image_unpack_invoke;
1704 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1707 RNA_def_enum(ot->srna, "method", unpack_method_items, PF_USE_LOCAL, "Method", "How to unpack.");
1708 RNA_def_string(ot->srna, "id", "", MAX_ID_NAME-2, "Image Name", "Image datablock name to unpack."); /* XXX, weark!, will fail with library, name collisions */
1711 /******************** sample image operator ********************/
1713 typedef struct ImageSampleInfo {
1732 static void sample_draw(const bContext *UNUSED(C), ARegion *ar, void *arg_info)
1734 ImageSampleInfo *info= arg_info;
1736 /* no color management needed for images (color_manage=0) */
1737 draw_image_info(ar, 0, info->channels, info->x, info->y, info->colp, info->colfp, info->zp, info->zfp);
1741 static void sample_apply(bContext *C, wmOperator *op, wmEvent *event)
1743 SpaceImage *sima= CTX_wm_space_image(C);
1744 ARegion *ar= CTX_wm_region(C);
1746 ImBuf *ibuf= ED_space_image_acquire_buffer(sima, &lock);
1747 ImageSampleInfo *info= op->customdata;
1751 ED_space_image_release_buffer(sima, lock);
1755 UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &fx, &fy);
1757 if(fx>=0.0f && fy>=0.0f && fx<1.0f && fy<1.0f) {
1760 int x= (int)(fx*ibuf->x), y= (int)(fy*ibuf->y);
1762 CLAMP(x, 0, ibuf->x-1);
1763 CLAMP(y, 0, ibuf->y-1);
1768 info->channels= ibuf->channels;
1776 cp= (char *)(ibuf->rect + y*ibuf->x + x);
1778 info->col[0]= cp[0];
1779 info->col[1]= cp[1];
1780 info->col[2]= cp[2];
1781 info->col[3]= cp[3];
1782 info->colp= info->col;
1784 info->colf[0]= (float)cp[0]/255.0f;
1785 info->colf[1]= (float)cp[1]/255.0f;
1786 info->colf[2]= (float)cp[2]/255.0f;
1787 info->colf[3]= (float)cp[3]/255.0f;
1788 info->colfp= info->colf;
1790 if(ibuf->rect_float) {
1791 fp= (ibuf->rect_float + (ibuf->channels)*(y*ibuf->x + x));
1793 info->colf[0]= fp[0];
1794 info->colf[1]= fp[1];
1795 info->colf[2]= fp[2];
1796 info->colf[3]= fp[3];
1797 info->colfp= info->colf;
1801 info->z= ibuf->zbuf[y*ibuf->x + x];
1804 if(ibuf->zbuf_float) {
1805 info->zf= ibuf->zbuf_float[y*ibuf->x + x];
1806 info->zfp= &info->zf;
1809 if(sima->cumap && ibuf->channels==4) {
1810 /* we reuse this callback for set curves point operators */
1811 if(RNA_struct_find_property(op->ptr, "point")) {
1812 int point= RNA_enum_get(op->ptr, "point");
1815 curvemapping_set_black_white(sima->cumap, NULL, info->colfp);
1816 if(ibuf->rect_float)
1817 curvemapping_do_ibuf(sima->cumap, ibuf);
1819 else if(point == 0) {
1820 curvemapping_set_black_white(sima->cumap, info->colfp, NULL);
1821 if(ibuf->rect_float)
1822 curvemapping_do_ibuf(sima->cumap, ibuf);
1827 // XXX node curve integration ..
1830 ScrArea *sa, *cur= curarea;
1832 node_curvemap_sample(fp); /* sends global to node editor */
1833 for(sa= G.curscreen->areabase.first; sa; sa= sa->next) {
1834 if(sa->spacetype==SPACE_NODE) {
1835 areawinset(sa->win);
1836 scrarea_do_windraw(sa);
1839 node_curvemap_sample(NULL); /* clears global in node editor */
1847 ED_space_image_release_buffer(sima, lock);
1848 ED_area_tag_redraw(CTX_wm_area(C));
1851 static void sample_exit(bContext *C, wmOperator *op)
1853 ImageSampleInfo *info= op->customdata;
1855 ED_region_draw_cb_exit(info->art, info->draw_handle);
1856 ED_area_tag_redraw(CTX_wm_area(C));
1860 static int sample_invoke(bContext *C, wmOperator *op, wmEvent *event)
1862 SpaceImage *sima= CTX_wm_space_image(C);
1863 ARegion *ar= CTX_wm_region(C);
1864 ImageSampleInfo *info;
1866 if(!ED_space_image_has_buffer(sima))
1867 return OPERATOR_CANCELLED;
1869 info= MEM_callocN(sizeof(ImageSampleInfo), "ImageSampleInfo");
1870 info->art= ar->type;
1871 info->draw_handle = ED_region_draw_cb_activate(ar->type, sample_draw, info, REGION_DRAW_POST_PIXEL);
1872 op->customdata= info;
1874 sample_apply(C, op, event);
1876 WM_event_add_modal_handler(C, op);
1878 return OPERATOR_RUNNING_MODAL;
1881 static int sample_modal(bContext *C, wmOperator *op, wmEvent *event)
1883 switch(event->type) {
1885 case RIGHTMOUSE: // XXX hardcoded
1887 return OPERATOR_CANCELLED;
1889 sample_apply(C, op, event);
1893 return OPERATOR_RUNNING_MODAL;
1896 static int sample_cancel(bContext *C, wmOperator *op)
1899 return OPERATOR_CANCELLED;
1902 void IMAGE_OT_sample(wmOperatorType *ot)
1905 ot->name= "Sample Color";
1906 ot->idname= "IMAGE_OT_sample";
1909 ot->invoke= sample_invoke;
1910 ot->modal= sample_modal;
1911 ot->cancel= sample_cancel;
1912 ot->poll= space_image_main_area_poll;
1915 ot->flag= OPTYPE_BLOCKING;
1918 /******************** sample line operator ********************/
1919 static int sample_line_exec(bContext *C, wmOperator *op)
1921 SpaceImage *sima= CTX_wm_space_image(C);
1922 ARegion *ar= CTX_wm_region(C);
1923 Scene *scene= CTX_data_scene(C);
1925 int x_start= RNA_int_get(op->ptr, "xstart");
1926 int y_start= RNA_int_get(op->ptr, "ystart");
1927 int x_end= RNA_int_get(op->ptr, "xend");
1928 int y_end= RNA_int_get(op->ptr, "yend");
1931 ImBuf *ibuf= ED_space_image_acquire_buffer(sima, &lock);
1932 Histogram *hist= &sima->sample_line_hist;
1934 float x1f, y1f, x2f, y2f;
1942 ED_space_image_release_buffer(sima, lock);
1943 return OPERATOR_CANCELLED;
1946 if (ibuf->channels < 3) {
1947 ED_space_image_release_buffer(sima, lock);
1948 return OPERATOR_CANCELLED;
1951 UI_view2d_region_to_view(&ar->v2d, x_start, y_start, &x1f, &y1f);
1952 UI_view2d_region_to_view(&ar->v2d, x_end, y_end, &x2f, &y2f);
1953 x1= 0.5f+ x1f*ibuf->x;
1954 x2= 0.5f+ x2f*ibuf->x;
1955 y1= 0.5f+ y1f*ibuf->y;
1956 y2= 0.5f+ y2f*ibuf->y;
1959 hist->x_resolution = 256;
1963 for (i=0; i<256; i++) {
1964 x= (int)(0.5f + x1 + (float)i*(x2-x1)/255.0f);
1965 y= (int)(0.5f + y1 + (float)i*(y2-y1)/255.0f);
1967 if (x<0 || y<0 || x>=ibuf->x || y>=ibuf->y) {
1968 hist->data_luma[i] = hist->data_r[i] = hist->data_g[i]= hist->data_b[i] = 0.0f;
1970 if (ibuf->rect_float) {
1971 fp= (ibuf->rect_float + (ibuf->channels)*(y*ibuf->x + x));
1973 if (scene->r.color_mgt_flag & R_COLOR_MANAGEMENT)
1974 linearrgb_to_srgb_v3_v3(rgb, fp);
1976 copy_v3_v3(rgb, fp);
1978 hist->data_r[i] = rgb[0];
1979 hist->data_g[i] = rgb[1];
1980 hist->data_b[i] = rgb[2];
1981 hist->data_luma[i] = (0.299f*rgb[0] + 0.587f*rgb[1] + 0.114f*rgb[2]);
1983 else if (ibuf->rect) {
1984 cp= (unsigned char *)(ibuf->rect + y*ibuf->x + x);
1985 hist->data_r[i] = (float)cp[0]/255.0f;
1986 hist->data_g[i] = (float)cp[1]/255.0f;
1987 hist->data_b[i] = (float)cp[2]/255.0f;
1988 hist->data_luma[i] = (0.299f*cp[0] + 0.587f*cp[1] + 0.114f*cp[2])/255;
1993 ED_space_image_release_buffer(sima, lock);
1995 ED_area_tag_redraw(CTX_wm_area(C));
1997 return OPERATOR_FINISHED;
2000 static int sample_line_invoke(bContext *C, wmOperator *op, wmEvent *event)
2002 SpaceImage *sima= CTX_wm_space_image(C);
2004 if(!ED_space_image_has_buffer(sima))
2005 return OPERATOR_CANCELLED;
2007 return WM_gesture_straightline_invoke(C, op, event);
2010 void IMAGE_OT_sample_line(wmOperatorType *ot)
2013 ot->name= "Sample Line";
2014 ot->idname= "IMAGE_OT_sample_line";
2017 ot->invoke= sample_line_invoke;
2018 ot->modal= WM_gesture_straightline_modal;
2019 ot->exec= sample_line_exec;
2020 ot->poll= space_image_main_area_poll;
2021 ot->cancel= WM_gesture_straightline_cancel;
2024 ot->flag= 0; /* no undo/register since this operates on the space */
2026 WM_operator_properties_gesture_straightline(ot, CURSOR_EDIT);
2029 /******************** set curve point operator ********************/
2031 void IMAGE_OT_curves_point_set(wmOperatorType *ot)
2033 static EnumPropertyItem point_items[]= {
2034 {0, "BLACK_POINT", 0, "Black Point", ""},
2035 {1, "WHITE_POINT", 0, "White Point", ""},
2036 {0, NULL, 0, NULL, NULL}};
2039 ot->name= "Set Curves Point";
2040 ot->idname= "IMAGE_OT_curves_point_set";
2043 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
2046 ot->invoke= sample_invoke;
2047 ot->modal= sample_modal;
2048 ot->cancel= sample_cancel;
2049 ot->poll= space_image_main_area_poll;
2052 RNA_def_enum(ot->srna, "point", point_items, 0, "Point", "Set black point or white point for curves.");
2055 /******************** record composite operator *********************/
2057 typedef struct RecordCompositeData {
2061 } RecordCompositeData;
2063 static int record_composite_apply(bContext *C, wmOperator *op)
2065 SpaceImage *sima= CTX_wm_space_image(C);
2066 RecordCompositeData *rcd= op->customdata;
2067 Scene *scene= CTX_data_scene(C);
2070 WM_timecursor(CTX_wm_window(C), scene->r.cfra);
2072 // XXX scene->nodetree->test_break= blender_test_break;
2073 // XXX scene->nodetree->test_break= NULL;
2075 BKE_image_all_free_anim_ibufs(scene->r.cfra);
2076 ntreeCompositTagAnimated(scene->nodetree);
2077 ntreeCompositExecTree(scene->nodetree, &scene->r, scene->r.cfra != rcd->old_cfra); /* 1 is no previews */
2079 ED_area_tag_redraw(CTX_wm_area(C));
2081 ibuf= BKE_image_get_ibuf(sima->image, &sima->iuser);
2082 /* save memory in flipbooks */
2084 imb_freerectfloatImBuf(ibuf);
2088 return (scene->r.cfra <= rcd->efra);
2091 static int record_composite_init(bContext *C, wmOperator *op)
2093 SpaceImage *sima= CTX_wm_space_image(C);
2094 Scene *scene= CTX_data_scene(C);
2095 RecordCompositeData *rcd;
2097 if(sima->iuser.frames < 2)
2099 if(scene->nodetree == NULL)
2102 op->customdata= rcd= MEM_callocN(sizeof(RecordCompositeData), "ImageRecordCompositeData");
2104 rcd->old_cfra= scene->r.cfra;
2105 rcd->sfra= sima->iuser.sfra;
2106 rcd->efra= sima->iuser.sfra + sima->iuser.frames-1;
2107 scene->r.cfra= rcd->sfra;
2112 static void record_composite_exit(bContext *C, wmOperator *op)
2114 Scene *scene= CTX_data_scene(C);
2115 SpaceImage *sima= CTX_wm_space_image(C);
2116 RecordCompositeData *rcd= op->customdata;
2118 scene->r.cfra= rcd->old_cfra;
2120 WM_cursor_restore(CTX_wm_window(C));
2123 WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), rcd->timer);
2125 WM_event_add_notifier(C, NC_IMAGE|NA_EDITED, sima->image);
2127 // XXX play_anim(0);
2128 // XXX allqueue(REDRAWNODE, 1);
2133 static int record_composite_exec(bContext *C, wmOperator *op)
2135 if(!record_composite_init(C, op))
2136 return OPERATOR_CANCELLED;
2138 while(record_composite_apply(C, op))
2141 record_composite_exit(C, op);
2143 return OPERATOR_FINISHED;
2146 static int record_composite_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
2148 RecordCompositeData *rcd;
2150 if(!record_composite_init(C, op))
2151 return OPERATOR_CANCELLED;
2153 rcd= op->customdata;
2154 rcd->timer= WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.0f);
2155 WM_event_add_modal_handler(C, op);
2157 if(!record_composite_apply(C, op))
2158 return OPERATOR_FINISHED;
2160 return OPERATOR_RUNNING_MODAL;
2163 static int record_composite_modal(bContext *C, wmOperator *op, wmEvent *event)
2165 RecordCompositeData *rcd= op->customdata;
2167 switch(event->type) {
2169 if(rcd->timer == event->customdata) {
2170 if(!record_composite_apply(C, op)) {
2171 record_composite_exit(C, op);
2172 return OPERATOR_FINISHED;
2177 record_composite_exit(C, op);
2178 return OPERATOR_FINISHED;
2181 return OPERATOR_RUNNING_MODAL;
2184 static int record_composite_cancel(bContext *C, wmOperator *op)
2186 record_composite_exit(C, op);
2187 return OPERATOR_CANCELLED;
2190 void IMAGE_OT_record_composite(wmOperatorType *ot)
2193 ot->name= "Record Composite";
2194 ot->idname= "IMAGE_OT_record_composite";
2197 ot->exec= record_composite_exec;
2198 ot->invoke= record_composite_invoke;
2199 ot->modal= record_composite_modal;
2200 ot->cancel= record_composite_cancel;
2201 ot->poll= space_image_buffer_exists_poll;
2204 /********************* cycle render slot operator *********************/
2206 static int cycle_render_slot_poll(bContext *C)
2208 Image *ima= CTX_data_edit_image(C);
2210 return (ima && ima->type == IMA_TYPE_R_RESULT);
2213 static int cycle_render_slot_exec(bContext *C, wmOperator *op)
2215 Image *ima= CTX_data_edit_image(C);
2216 int a, slot, cur= ima->render_slot;
2217 const short use_reverse= RNA_boolean_get(op->ptr, "reverse");
2219 for(a=1; a<IMA_MAX_RENDER_SLOT; a++) {
2220 slot= (cur + (use_reverse ? -a:a))%IMA_MAX_RENDER_SLOT;
2221 if(slot<0) slot+=IMA_MAX_RENDER_SLOT;
2223 if(ima->renders[slot] || slot == ima->last_render_slot) {
2224 ima->render_slot= slot;
2227 else if((slot - 1) == ima->last_render_slot && slot < IMA_MAX_RENDER_SLOT) {
2228 ima->render_slot= slot;
2233 if(a == IMA_MAX_RENDER_SLOT)
2234 ima->render_slot= ((cur == 1)? 0: 1);
2236 WM_event_add_notifier(C, NC_IMAGE|ND_DRAW, NULL);
2238 /* no undo push for browsing existing */
2239 if(ima->renders[ima->render_slot] || ima->render_slot==ima->last_render_slot)
2240 return OPERATOR_CANCELLED;
2242 return OPERATOR_FINISHED;
2245 void IMAGE_OT_cycle_render_slot(wmOperatorType *ot)
2248 ot->name= "Cycle Render Slot";
2249 ot->idname= "IMAGE_OT_cycle_render_slot";
2252 ot->exec= cycle_render_slot_exec;
2253 ot->poll= cycle_render_slot_poll;
2256 ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
2258 RNA_def_boolean(ot->srna, "reverse", 0, "Cycle in Reverse", "");
2261 /******************** TODO ********************/
2265 /* goes over all ImageUsers, and sets frame numbers if auto-refresh is set */
2267 void ED_image_update_frame(const Main *mainp, int cfra)
2269 wmWindowManager *wm;
2274 for(tex= mainp->tex.first; tex; tex= tex->id.next) {
2275 if(tex->type==TEX_IMAGE && tex->ima) {
2276 if(ELEM(tex->ima->source, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE)) {
2277 if(tex->iuser.flag & IMA_ANIM_ALWAYS)
2278 BKE_image_user_calc_frame(&tex->iuser, cfra, 0);
2283 /* image window, compo node users */
2284 for(wm=mainp->wm.first; wm; wm= wm->id.next) { /* only 1 wm */
2285 for(win= wm->windows.first; win; win= win->next) {
2287 for(sa= win->screen->areabase.first; sa; sa= sa->next) {
2288 if(sa->spacetype==SPACE_VIEW3D) {
2289 View3D *v3d= sa->spacedata.first;
2291 for(bgpic= v3d->bgpicbase.first; bgpic; bgpic= bgpic->next)
2292 if(bgpic->iuser.flag & IMA_ANIM_ALWAYS)
2293 BKE_image_user_calc_frame(&bgpic->iuser, cfra, 0);
2295 else if(sa->spacetype==SPACE_IMAGE) {
2296 SpaceImage *sima= sa->spacedata.first;
2297 if(sima->iuser.flag & IMA_ANIM_ALWAYS)
2298 BKE_image_user_calc_frame(&sima->iuser, cfra, 0);
2300 else if(sa->spacetype==SPACE_NODE) {
2301 SpaceNode *snode= sa->spacedata.first;
2302 if((snode->treetype==NTREE_COMPOSIT) && (snode->nodetree)) {
2304 for(node= snode->nodetree->nodes.first; node; node= node->next) {
2305 if(node->id && node->type==CMP_NODE_IMAGE) {
2306 Image *ima= (Image *)node->id;
2307 ImageUser *iuser= node->storage;
2308 if(ELEM(ima->source, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE))
2309 if(iuser->flag & IMA_ANIM_ALWAYS)
2310 BKE_image_user_calc_frame(iuser, cfra, 0);