# SPDX-FileCopyrightText: 2018-2023 Blender Authors # # SPDX-License-Identifier: GPL-2.0-or-later import bpy from bpy.types import Menu, Panel, UIList from bl_ui.utils import PresetPanel from bpy.app.translations import ( contexts as i18n_contexts, pgettext_iface as iface_, ) class RENDER_PT_format_presets(PresetPanel, Panel): bl_label = "Format Presets" preset_subdir = "render" preset_operator = "script.execute_preset" preset_add_operator = "render.preset_add" class RENDER_PT_ffmpeg_presets(PresetPanel, Panel): bl_label = "FFmpeg Presets" preset_subdir = "ffmpeg" preset_operator = "script.python_file_run" class RENDER_MT_framerate_presets(Menu): bl_label = "Frame Rate Presets" preset_subdir = "framerate" preset_operator = "script.execute_preset" draw = Menu.draw_preset class RENDER_MT_pixeldensity_presets(Menu): bl_label = "Pixel Density Presets" preset_subdir = "pixel_density" preset_operator = "script.execute_preset" draw = Menu.draw_preset class RenderOutputButtonsPanel: bl_space_type = 'PROPERTIES' bl_region_type = 'WINDOW' bl_context = "output" # COMPAT_ENGINES must be defined in each subclass, external engines can add themselves here @classmethod def poll(cls, context): return (context.engine in cls.COMPAT_ENGINES) class RENDER_PT_format(RenderOutputButtonsPanel, Panel): bl_label = "Format" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } _frame_rate_args_prev = None _preset_class = None def draw_header_preset(self, _context): RENDER_PT_format_presets.draw_panel_header(self.layout) @staticmethod def _draw_framerate_label(*args): # avoids re-creating text string each draw if RENDER_PT_format._frame_rate_args_prev == args: return RENDER_PT_format._frame_rate_ret fps, fps_base, preset_label = args if fps_base == 1.0: fps_rate = round(fps) else: fps_rate = round(fps / fps_base, 2) # TODO: Change the following to iterate over existing presets custom_framerate = (fps_rate not in {6, 8, 12, 23.98, 24, 25, 29.97, 30, 50, 59.94, 60, 120, 240}) if custom_framerate is True: fps_label_text = iface_("Custom ({:.4g} fps)").format(fps_rate) show_framerate = True else: fps_label_text = iface_("{:.4g} fps").format(fps_rate) show_framerate = (preset_label == "Custom") RENDER_PT_format._frame_rate_args_prev = args RENDER_PT_format._frame_rate_ret = args = (fps_label_text, show_framerate) return args @staticmethod def draw_framerate(layout, rd): if RENDER_PT_format._preset_class is None: RENDER_PT_format._preset_class = bpy.types.RENDER_MT_framerate_presets args = rd.fps, rd.fps_base, RENDER_PT_format._preset_class.bl_label fps_label_text, show_framerate = RENDER_PT_format._draw_framerate_label(*args) layout.menu("RENDER_MT_framerate_presets", text=fps_label_text) if show_framerate: col = layout.column(align=True) col.prop(rd, "fps") col.prop(rd, "fps_base", text="Base") def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False # No animation. rd = context.scene.render col = layout.column(align=True) col.prop(rd, "resolution_x", text="Resolution X") col.prop(rd, "resolution_y", text="Y") col.prop(rd, "resolution_percentage", text="%") col = layout.column(align=True) col.prop(rd, "pixel_aspect_x", text="Aspect X") col.prop(rd, "pixel_aspect_y", text="Y") col = layout.column(align=True) col.prop(rd, "use_border") sub = col.column(align=True) sub.active = rd.use_border sub.prop(rd, "use_crop_to_border") col = layout.column(heading="Frame Rate") self.draw_framerate(col, rd) class RENDER_PT_frame_range(RenderOutputButtonsPanel, Panel): bl_label = "Frame Range" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False # No animation. scene = context.scene col = layout.column(align=True) col.prop(scene, "frame_start", text="Frame Start") col.prop(scene, "frame_end", text="End") col.prop(scene, "frame_step", text="Step") class RENDER_PT_time_stretching(RenderOutputButtonsPanel, Panel): bl_label = "Time Stretching" bl_parent_id = "RENDER_PT_frame_range" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False # No animation. rd = context.scene.render col = layout.column(align=True) col.prop(rd, "frame_map_old", text="Old", text_ctxt=i18n_contexts.time) col.prop(rd, "frame_map_new", text="New", text_ctxt=i18n_contexts.time) class RENDER_PT_post_processing(RenderOutputButtonsPanel, Panel): bl_label = "Post Processing" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): layout = self.layout layout.use_property_split = True rd = context.scene.render col = layout.column(heading="Pipeline") col.prop(rd, "use_compositing") col.prop(rd, "use_sequencer") layout.prop(rd, "dither_intensity", text="Dither", slider=True) class RENDER_PT_stamp(RenderOutputButtonsPanel, Panel): bl_label = "Metadata" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False # No animation. rd = context.scene.render if rd.use_sequencer: layout.prop(rd, "metadata_input") col = layout.column(heading="Include") col.prop(rd, "use_stamp_date", text="Date") col.prop(rd, "use_stamp_time", text="Time") col.prop(rd, "use_stamp_render_time", text="Render Time") col.prop(rd, "use_stamp_frame", text="Frame") col.prop(rd, "use_stamp_frame_range", text="Frame Range") col.prop(rd, "use_stamp_memory", text="Memory") col.prop(rd, "use_stamp_hostname", text="Hostname") col.prop(rd, "use_stamp_camera", text="Camera") col.prop(rd, "use_stamp_lens", text="Lens") col.prop(rd, "use_stamp_scene", text="Scene") col.prop(rd, "use_stamp_marker", text="Marker") col.prop(rd, "use_stamp_filename", text="Filename") if rd.use_sequencer: col.prop(rd, "use_stamp_sequencer_strip", text="Strip Name") class RENDER_PT_stamp_note(RenderOutputButtonsPanel, Panel): bl_label = "Note" bl_parent_id = "RENDER_PT_stamp" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw_header(self, context): rd = context.scene.render self.layout.prop(rd, "use_stamp_note", text="") def draw(self, context): layout = self.layout rd = context.scene.render layout.active = rd.use_stamp_note layout.prop(rd, "stamp_note_text", text="") class RENDER_PT_stamp_burn(RenderOutputButtonsPanel, Panel): bl_label = "Burn Into Image" bl_parent_id = "RENDER_PT_stamp" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw_header(self, context): rd = context.scene.render self.layout.prop(rd, "use_stamp", text="") def draw(self, context): layout = self.layout rd = context.scene.render layout.use_property_split = True col = layout.column() col.active = rd.use_stamp col.prop(rd, "stamp_font_size", text="Font Size") col.column().prop(rd, "stamp_foreground", slider=True) col.column().prop(rd, "stamp_background", slider=True) col.prop(rd, "use_stamp_labels", text="Include Labels") class RENDER_PT_output(RenderOutputButtonsPanel, Panel): bl_label = "Output" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): layout = self.layout layout.use_property_split = False layout.use_property_decorate = False # No animation. rd = context.scene.render image_settings = rd.image_settings layout.prop(rd, "filepath", text="") layout.use_property_split = True col = layout.column(heading="Saving") col.prop(rd, "use_file_extension") col.prop(rd, "use_render_cache") layout.template_image_settings(image_settings, color_management=False) if not rd.is_movie_format: col = layout.column(heading="Image Sequence") col.prop(rd, "use_overwrite") col.prop(rd, "use_placeholder") class RENDER_PT_output_views(RenderOutputButtonsPanel, Panel): bl_label = "Views" bl_parent_id = "RENDER_PT_output" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } @classmethod def poll(cls, context): rd = context.scene.render return rd.use_multiview def draw(self, context): layout = self.layout layout.use_property_split = False layout.use_property_decorate = False # No animation. rd = context.scene.render layout.template_image_views(rd.image_settings) class RENDER_PT_output_color_management(RenderOutputButtonsPanel, Panel): bl_label = "Color Management" bl_options = {'DEFAULT_CLOSED'} bl_parent_id = "RENDER_PT_output" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw(self, context): scene = context.scene image_settings = scene.render.image_settings layout = self.layout layout.use_property_split = True layout.use_property_decorate = False # No animation. layout.row().prop(image_settings, "color_management", text=" ", expand=True) flow = layout.grid_flow(row_major=True, columns=0, even_columns=False, even_rows=False, align=True) if image_settings.color_management == 'OVERRIDE': owner = image_settings else: owner = scene flow.enabled = False col = flow.column() if image_settings.has_linear_colorspace: if hasattr(owner, "linear_colorspace_settings"): col.prop(owner.linear_colorspace_settings, "name", text="Color Space") else: col.prop(owner.display_settings, "display_device") col.separator() col.template_colormanaged_view_settings(owner, "view_settings") class RENDER_PT_output_pixel_density(RenderOutputButtonsPanel, Panel): bl_label = "Pixel Density" bl_options = {'DEFAULT_CLOSED'} bl_parent_id = "RENDER_PT_output" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } _pixel_density_args_prev = None _preset_class = None @staticmethod def _draw_pixeldensity_label(*args): # Avoids re-creating text string each draw. if RENDER_PT_output_pixel_density._pixel_density_args_prev == args: return RENDER_PT_output_pixel_density._pixel_density_ret ppm_base, preset_label = args # NOTE: `as_float_32` is needed because Blender stores this value as a 32bit float. # Which won't match Python's 64bit float. def as_float_32(f): from struct import pack, unpack return unpack("f", pack("f", f))[0] # NOTE: Values here are duplicated from presets, ideally this could be avoided. unit_name = { as_float_32(0.0254): iface_("Inch"), as_float_32(0.01): iface_("Centimeter"), as_float_32(1.0): iface_("Meter"), }.get(ppm_base) if unit_name is None: pixeldensity_label_text = iface_("Custom") show_pixeldensity = True else: pixeldensity_label_text = iface_("Pixels/{:s}").format(unit_name) show_pixeldensity = (preset_label == "Custom") RENDER_PT_output_pixel_density._pixel_density_args_prev = args RENDER_PT_output_pixel_density._pixel_density_ret = args = (pixeldensity_label_text, show_pixeldensity) return args @staticmethod def draw_pixeldensity(layout, rd): if RENDER_PT_output_pixel_density._preset_class is None: RENDER_PT_output_pixel_density._preset_class = bpy.types.RENDER_MT_pixeldensity_presets args = rd.ppm_base, RENDER_PT_output_pixel_density._preset_class.bl_label pixeldensity_label_text, show_pixeldensity = RENDER_PT_output_pixel_density._draw_pixeldensity_label(*args) layout.prop(rd, "ppm_factor", text="Pixels") row = layout.split(factor=0.4) row.alignment = 'RIGHT' row.label(text="Unit") row.menu("RENDER_MT_pixeldensity_presets", text=pixeldensity_label_text) if show_pixeldensity: col = layout.column(align=True) col.prop(rd, "ppm_base", text="Base") def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False scene = context.scene rd = scene.render self.draw_pixeldensity(layout, rd) class RENDER_PT_encoding(RenderOutputButtonsPanel, Panel): bl_label = "Encoding" bl_parent_id = "RENDER_PT_output" bl_options = {'DEFAULT_CLOSED'} COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } def draw_header_preset(self, _context): RENDER_PT_ffmpeg_presets.draw_panel_header(self.layout) @classmethod def poll(cls, context): rd = context.scene.render return rd.image_settings.file_format in {'FFMPEG', 'XVID', 'H264', 'THEORA'} def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False rd = context.scene.render ffmpeg = rd.ffmpeg layout.prop(rd.ffmpeg, "format") layout.prop(ffmpeg, "use_autosplit") class RENDER_PT_encoding_video(RenderOutputButtonsPanel, Panel): bl_label = "Video" bl_parent_id = "RENDER_PT_encoding" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } @classmethod def poll(cls, context): rd = context.scene.render return rd.image_settings.file_format in {'FFMPEG', 'XVID', 'H264', 'THEORA'} def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False self.draw_vcodec(context) def draw_vcodec(self, context): """Video codec options.""" layout = self.layout ffmpeg = context.scene.render.ffmpeg needs_codec = ffmpeg.format in { 'AVI', 'QUICKTIME', 'MKV', 'OGG', 'MPEG4', 'WEBM', } if needs_codec: layout.prop(ffmpeg, "codec") if needs_codec and ffmpeg.codec == 'NONE': return image_settings = context.scene.render.image_settings if image_settings.color_management == 'OVERRIDE': display_settings = image_settings.display_settings view_settings = image_settings.view_settings else: display_settings = context.scene.display_settings view_settings = context.scene.view_settings # HDR compatibility if view_settings.is_hdr and (not needs_codec or ffmpeg.codec not in {'H265', 'AV1'}): layout.label(text="HDR needs H.265 or AV1", icon='ERROR') # Color depth. List of codecs needs to be in sync with # `IMB_ffmpeg_valid_bit_depths` in source code. use_bpp = needs_codec and ffmpeg.codec in {'H264', 'H265', 'AV1', 'PRORES', 'FFV1'} if use_bpp: layout.prop(image_settings, "color_depth", expand=True) # HDR compatibility if view_settings.is_hdr and image_settings.color_depth not in {'10', '12'}: layout.label(text="HDR needs 10 or 12 bits", icon='ERROR') # Color space split = layout.split(factor=0.4) col = split.column() col.alignment = 'RIGHT' col.label(text="Color Space") col = split.column() row = col.row() row.enabled = False row.prop(display_settings, "display_device", text="") if ffmpeg.codec == 'DNXHD': layout.prop(ffmpeg, "use_lossless_output") if ffmpeg.codec == 'PRORES': layout.prop(ffmpeg, "ffmpeg_prores_profile") # Output quality use_crf = needs_codec and ffmpeg.codec in { 'H264', 'H265', 'MPEG4', 'WEBM', 'AV1', } if use_crf: layout.prop(ffmpeg, "constant_rate_factor") if (ffmpeg.constant_rate_factor == 'CUSTOM'): layout.prop(ffmpeg, "custom_constant_rate_factor") use_encoding_speed = needs_codec and ffmpeg.codec not in {'DNXHD', 'FFV1', 'HUFFYUV', 'PNG', 'PRORES', 'QTRLE'} use_bitrate = needs_codec and ffmpeg.codec not in {'FFV1', 'HUFFYUV', 'PNG', 'PRORES', 'QTRLE'} use_min_max_bitrate = ffmpeg.codec not in {'DNXHD'} use_gop = needs_codec and ffmpeg.codec not in {'DNXHD', 'HUFFYUV', 'PNG', 'PRORES'} use_b_frames = needs_codec and use_gop and ffmpeg.codec not in {'FFV1', 'QTRLE'} # Encoding speed if use_encoding_speed: layout.prop(ffmpeg, "ffmpeg_preset") # I-frames if use_gop: layout.prop(ffmpeg, "gopsize") # B-Frames if use_b_frames: row = layout.row(align=True, heading="Max B-frames") row.prop(ffmpeg, "use_max_b_frames", text="") sub = row.row(align=True) sub.active = ffmpeg.use_max_b_frames sub.prop(ffmpeg, "max_b_frames", text="") if (not use_crf or ffmpeg.constant_rate_factor == 'NONE') and use_bitrate: col = layout.column() sub = col.column(align=True) sub.prop(ffmpeg, "video_bitrate") if use_min_max_bitrate: sub.prop(ffmpeg, "minrate", text="Minimum") sub.prop(ffmpeg, "maxrate", text="Maximum") col.prop(ffmpeg, "buffersize", text="Buffer") col.separator() col.prop(ffmpeg, "muxrate", text="Mux Rate") col.prop(ffmpeg, "packetsize", text="Mux Packet Size") class RENDER_PT_encoding_audio(RenderOutputButtonsPanel, Panel): bl_label = "Audio" bl_parent_id = "RENDER_PT_encoding" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } @classmethod def poll(cls, context): rd = context.scene.render return rd.image_settings.file_format in {'FFMPEG', 'XVID', 'H264', 'THEORA'} def draw(self, context): layout = self.layout layout.use_property_split = True layout.use_property_decorate = False rd = context.scene.render ffmpeg = rd.ffmpeg if ffmpeg.format != 'MP3': layout.prop(ffmpeg, "audio_codec", text="Audio Codec") if ffmpeg.audio_codec != 'NONE': layout.prop(ffmpeg, "audio_channels") layout.prop(ffmpeg, "audio_mixrate", text="Sample Rate") if ffmpeg.audio_codec not in {'FLAC', 'PCM'}: layout.prop(ffmpeg, "audio_bitrate") layout.prop(ffmpeg, "audio_volume", slider=True) class RENDER_UL_renderviews(UIList): def draw_item(self, _context, layout, _data, item, icon, _active_data, _active_propname, index): view = item if view.name in {"left", "right"}: layout.label(text=view.name, icon_value=icon - (not view.use)) else: layout.prop(view, "name", text="", index=index, icon_value=icon, emboss=False) layout.prop(view, "use", text="", index=index) class RENDER_PT_stereoscopy(RenderOutputButtonsPanel, Panel): bl_label = "Stereoscopy" COMPAT_ENGINES = { 'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH', } bl_options = {'DEFAULT_CLOSED'} def draw_header(self, context): rd = context.scene.render self.layout.prop(rd, "use_multiview", text="") def draw(self, context): layout = self.layout scene = context.scene rd = scene.render rv = rd.views.active layout.active = rd.use_multiview basic_stereo = rd.views_format == 'STEREO_3D' row = layout.row() layout.row().prop(rd, "views_format", expand=True) if basic_stereo: row = layout.row() row.template_list("RENDER_UL_renderviews", "name", rd, "stereo_views", rd.views, "active_index", rows=2) row = layout.row() row.use_property_split = True row.use_property_decorate = False row.prop(rv, "file_suffix") else: row = layout.row() row.template_list("RENDER_UL_renderviews", "name", rd, "views", rd.views, "active_index", rows=2) col = row.column(align=True) col.operator("scene.render_view_add", icon='ADD', text="") col.operator("scene.render_view_remove", icon='REMOVE', text="") row = layout.row() row.use_property_split = True row.use_property_decorate = False row.prop(rv, "camera_suffix") classes = ( RENDER_PT_format_presets, RENDER_PT_ffmpeg_presets, RENDER_MT_framerate_presets, RENDER_MT_pixeldensity_presets, RENDER_PT_format, RENDER_PT_frame_range, RENDER_PT_time_stretching, RENDER_PT_stereoscopy, RENDER_PT_output, RENDER_PT_output_views, RENDER_PT_output_color_management, RENDER_PT_output_pixel_density, RENDER_PT_encoding, RENDER_PT_encoding_video, RENDER_PT_encoding_audio, RENDER_PT_stamp, RENDER_PT_stamp_note, RENDER_PT_stamp_burn, RENDER_UL_renderviews, RENDER_PT_post_processing, ) if __name__ == "__main__": # only for live edit. from bpy.utils import register_class for cls in classes: register_class(cls)