diff options
author | Brecht Van Lommel <brechtvanlommel@gmail.com> | 2018-11-02 03:56:41 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2018-11-02 03:58:56 +0300 |
commit | 86b2f8ef38c0cbcc355f19b49b3f7a085bfda69a (patch) | |
tree | 9e4a74a60d7d89e1aa6230df391012473dabef1e /release/scripts/startup/bl_ui/properties_output.py | |
parent | 2d6a10615d823d2537eed5a91d3bc24df9aa2106 (diff) |
UI: add render output tab to properties editor
Diffstat (limited to 'release/scripts/startup/bl_ui/properties_output.py')
-rw-r--r-- | release/scripts/startup/bl_ui/properties_output.py | 524 |
1 files changed, 524 insertions, 0 deletions
diff --git a/release/scripts/startup/bl_ui/properties_output.py b/release/scripts/startup/bl_ui/properties_output.py new file mode 100644 index 00000000000..b85cd9de04a --- /dev/null +++ b/release/scripts/startup/bl_ui/properties_output.py @@ -0,0 +1,524 @@ +# ##### BEGIN GPL LICENSE BLOCK ##### + +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +# +# ##### END GPL LICENSE BLOCK ##### + +# <pep8 compliant> +import bpy +from bpy.types import Menu, Panel, UIList +from bl_operators.presets import PresetMenu + + +class RENDER_PT_presets(PresetMenu): + bl_label = "Render Presets" + preset_subdir = "render" + preset_operator = "script.execute_preset" + preset_add_operator = "render.preset_add" + + +class RENDER_PT_ffmpeg_presets(PresetMenu): + 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 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_dimensions(RenderOutputButtonsPanel, Panel): + bl_label = "Dimensions" + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + _frame_rate_args_prev = None + _preset_class = None + + def draw_header_preset(self, context): + RENDER_PT_presets.draw_panel_header(self.layout) + + @staticmethod + def _draw_framerate_label(*args): + # avoids re-creating text string each draw + if RENDER_PT_dimensions._frame_rate_args_prev == args: + return RENDER_PT_dimensions._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 {23.98, 24, 25, 29.97, 30, 50, 59.94, 60}) + + if custom_framerate is True: + fps_label_text = f"Custom ({fps_rate!r} fps)" + show_framerate = True + else: + fps_label_text = f"{fps_rate!r} fps" + show_framerate = (preset_label == "Custom") + + RENDER_PT_dimensions._frame_rate_args_prev = args + RENDER_PT_dimensions._frame_rate_ret = args = (fps_label_text, show_framerate) + return args + + @staticmethod + def draw_framerate(layout, sub, rd): + if RENDER_PT_dimensions._preset_class is None: + RENDER_PT_dimensions._preset_class = bpy.types.RENDER_MT_framerate_presets + + args = rd.fps, rd.fps_base, RENDER_PT_dimensions._preset_class.bl_label + fps_label_text, show_framerate = RENDER_PT_dimensions._draw_framerate_label(*args) + + sub.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. + + scene = context.scene + rd = 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", text="Border") + sub = col.column(align=True) + sub.active = rd.use_border + sub.prop(rd, "use_crop_to_border", text="Crop") + + 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") + + col = layout.split() + col.alignment = 'RIGHT' + col.label(text="Frame Rate") + self.draw_framerate(layout, col, rd) + + +class RENDER_PT_frame_remapping(RenderOutputButtonsPanel, Panel): + bl_label = "Time Remapping" + bl_parent_id = "RENDER_PT_dimensions" + bl_options = {'DEFAULT_CLOSED'} + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + 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") + col.prop(rd, "frame_map_new", text="New") + + +class RENDER_PT_post_processing(RenderOutputButtonsPanel, Panel): + bl_label = "Post Processing" + bl_options = {'DEFAULT_CLOSED'} + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + def draw(self, context): + layout = self.layout + layout.use_property_split = True + + rd = context.scene.render + + flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=False) + col = flow.column() + col.prop(rd, "use_compositing") + col = flow.column() + 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_OPENGL'} + + def draw(self, context): + layout = self.layout + layout.use_property_split = True + layout.use_property_decorate = False # No animation. + + rd = context.scene.render + + flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=False) + + col = flow.column() + col.prop(rd, "use_stamp_date", text="Date") + col = flow.column() + col.prop(rd, "use_stamp_time", text="Time") + + col = flow.column() + col.prop(rd, "use_stamp_render_time", text="Render Time") + col = flow.column() + col.prop(rd, "use_stamp_frame", text="Frame") + col = flow.column() + col.prop(rd, "use_stamp_frame_range", text="Frame Range") + col = flow.column() + col.prop(rd, "use_stamp_memory", text="Memory") + + col = flow.column() + col.prop(rd, "use_stamp_camera", text="Camera") + col = flow.column() + col.prop(rd, "use_stamp_lens", text="Lens") + + col = flow.column() + col.prop(rd, "use_stamp_scene", text="Scene") + col = flow.column() + col.prop(rd, "use_stamp_marker", text="Marker") + + col = flow.column() + col.prop(rd, "use_stamp_filename", text="Filename") + + col = flow.column() + col.prop(rd, "use_stamp_sequencer_strip", text="Strip Name") + + if rd.use_sequencer: + col = flow.column() + col.prop(rd, "use_stamp_strip_meta", text="Use Strip Metadata") + + +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_OPENGL'} + + 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_OPENGL'} + + 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.prop(rd, "use_stamp_labels", text="Draw Labels") + col.column().prop(rd, "stamp_foreground", slider=True) + col.column().prop(rd, "stamp_background", slider=True) + + +class RENDER_PT_output(RenderOutputButtonsPanel, Panel): + bl_label = "Output" + bl_options = {'DEFAULT_CLOSED'} + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + 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 + + flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=False) + + col = flow.column() + col.active = not rd.is_movie_format + col.prop(rd, "use_overwrite") + col = flow.column() + col.active = not rd.is_movie_format + col.prop(rd, "use_placeholder") + col = flow.column() + col.prop(rd, "use_file_extension") + col = flow.column() + col.prop(rd, "use_render_cache") + + layout.template_image_settings(image_settings, color_management=False) + + +class RENDER_PT_output_views(RenderOutputButtonsPanel, Panel): + bl_label = "Views" + bl_parent_id = "RENDER_PT_output" + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + @classmethod + def poll(self, 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_encoding(RenderOutputButtonsPanel, Panel): + bl_label = "Encoding" + bl_parent_id = "RENDER_PT_output" + bl_options = {'DEFAULT_CLOSED'} + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + + 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_OPENGL'} + + @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'} + if needs_codec: + layout.prop(ffmpeg, "codec") + + if needs_codec and ffmpeg.codec == 'NONE': + return + + if ffmpeg.codec in {'DNXHD'}: + layout.prop(ffmpeg, "use_lossless_output") + + # Output quality + use_crf = needs_codec and ffmpeg.codec in {'H264', 'MPEG4', 'WEBM'} + if use_crf: + layout.prop(ffmpeg, "constant_rate_factor") + + # Encoding speed + layout.prop(ffmpeg, "ffmpeg_preset") + # I-frames + layout.prop(ffmpeg, "gopsize") + # B-Frames + split = layout.split(factor=0.5) + split.prop(ffmpeg, "use_max_b_frames", text="Max B-frames") + pbox = split.column() + pbox.prop(ffmpeg, "max_b_frames", text="") + pbox.enabled = ffmpeg.use_max_b_frames + + if not use_crf or ffmpeg.constant_rate_factor == 'NONE': + col = layout.column() + + sub = col.column(align=True) + sub.prop(ffmpeg, "video_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_OPENGL'} + + @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_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 self.layout_type in {'DEFAULT', 'COMPACT'}: + 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) + + elif self.layout_type == 'GRID': + layout.alignment = 'CENTER' + layout.label(text="", icon_value=icon + (not view.use)) + + +class RENDER_PT_stereoscopy(RenderOutputButtonsPanel, Panel): + bl_label = "Stereoscopy" + COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_OPENGL'} + 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() + 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.label(text="File Suffix:") + row.prop(rv, "file_suffix", text="") + + 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.label(text="Camera Suffix:") + row.prop(rv, "camera_suffix", text="") + + +classes = ( + RENDER_PT_presets, + RENDER_PT_ffmpeg_presets, + RENDER_MT_framerate_presets, + RENDER_PT_dimensions, + RENDER_PT_frame_remapping, + RENDER_PT_post_processing, + RENDER_PT_output, + RENDER_PT_output_views, + 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_stereoscopy, +) + +if __name__ == "__main__": # only for live edit. + from bpy.utils import register_class + for cls in classes: + register_class(cls) |