Skip to main content

Keyframe Pro Documentation

Release Notes

Version History

v1.15.2 (January 22, 2023)

  • Fixed - Houdini generated pngs have decode errors
  • Fixed - VP9 multi-pass encoded files cause a crash
  • Added - Option to disable viewport context menu
  • Image sequence load time improvements
  • Updated ffmpeg version

v1.15.1 (April 6, 2021)

  • Added - Build timeline from cmd line args
  • Fixed - Ignore scaling env variables set by external apps (e.g. Maya)
  • Fixed - Signed and notarized builds (macOS)
  • Fixed - Outdated text
  • Updated Qt version
  • Updated ffmpeg version

v1.14.8 (December 3, 2020)

  • Updated Qt version

v1.14.6 (September 22, 2020)

  • Fixed - Playing two files with same length in A/B viewers may pause after several loops
  • Fixed - Bookmarks may be moved/lost after replacing a missing source

v1.14.4 (June 30, 2020)

  • Fixed - Swapping A/B timelines should be seamless
  • Fixed - Crash launching Maya Tools on macOS Catalina
  • Fixed - Incorrect context-menu displayed on static frame annotation button

v1.14.2 (April 23, 2020)

  • Added - Support for static (held) annotations

v1.14.1 (March 4, 2020)

  • Added - Export to .mov file format
  • Added - Export to .wav file format (audio only)
  • Added - Export option to exclude audio from output
  • Added - Additional default export options to Preferences dialog
  • Added - Client API support for new export options
  • Added - Annotation Text Tool text input dialog
  • Added - Option in preferences to switch between text tool input format
  • Fixed - Improve text tool support for unicode characters
  • Fixed - Incorrect annotation tool size on startup
  • Fixed - Make hardware accelerated playback the default on clean install
  • Updated Qt version
  • Updated ffmpeg version

v1.12.1 (December 12, 2019)

  • Added - Maya Tools (Sync Maya to Keyframe Pro's current time)

v1.11.1 (November 5, 2019)

  • Added - Alternate mouse zoom controls (Ctrl+Shift+MMB drag)
  • Added - Zoom hotkeys
  • Added - Export image sequences in JPEG format (snapshot)
  • Added - File format parameter to Advanced Snapshot command in Client API
  • Fixed - Endless mouse scrub fails in specific monitor configurations (Windows)
  • Fixed - Windows installer has some hardcoded paths
  • Fixed - Crash on loop (CS5 exported video)
  • Fixed - Export and snapshot dialogs open all white (no widgets visible)
  • Fixed - Console window geometry not restored
  • Updated Qt version

v1.10.2 (September 30, 2019)

  • Fixed - Implemented performance tweaks
  • Fixed - Opening .bmk file may set incorrect playback range in edge case
  • Updated preferences dialog

v1.10.1 (June 26, 2019)

  • Added - Playback smoothing
  • Fixed - (macOS) Tap to click unreliable on some macbook touchpads
  • Updated Qt version (All)

v1.9.1 (April 17, 2019)

  • General performance improvements
  • Updated ffmpeg version (All)
  • Updated Qt version (Windows)
  • Updated to Visual Studio 2017 (Windows)

v1.8.1 (March 13, 2019)

  • Added - Pan and zoom functionality (Zoom - Ctrl+Mouse Wheel, Pan - Ctrl+MMB drag)
  • Added - Pan and zoom controls to the Timeline Properties view
  • Added - Save/Load pan and zoom state in Project file
  • Added - Hotkeys to toggle and reset pan/zoom ('\' and 'Ctrl+\' respectively)
  • Added - Option in Preferences to turn off pan/zoom enabled on project load
  • Added - Option in Preferences to disable pan/zoom mouse controls
  • Fixed - Range layout in Timeline Properties view
  • Fixed - Maya to Keyframe Pro - Turning sync off fails (under very specific conditions)

v1.7.4 (February 19, 2019)

  • Added - "Open New Instance" of player to main menu (Windows)
  • Updated - Moved step/scrub loop and lock to range options to main menu (and added hotkeys)
  • Fixed - Empty hotkeys should be removed when user assigns first shortcut
  • Fixed - Incorrect application text

v1.7.2 (January 22, 2019)

  • Fixed - Path limit is less than Windows path limit (in certain scenarios)

v1.7.1 (December 2, 2018)

  • Added - Rectangle annotation tool
  • Added - Import project functionality (File->Import Project)
  • Added - New Client API command: import_project
  • Added - Hotkeys to increase/decrease the current annotation tool size
  • Fixed - Exported frame rate may be incorrect when timeline has mix of audio and no audio clips

v1.6.4 (November 16, 2018)

  • Added - Support for mxf extension
  • Added - File associations for new types

v1.6.2 (October 10, 2018)

  • Added - Support for mts extension
  • Fixed - Advanced snapshot doesn't support the "single" snapshot type

v1.6.1 (September 21, 2018)

  • Added - Stepped Mode Playback (Bookmarks Only)
  • Added - Maya to Keyframe Pro - Frame multiplier option when synced
  • Fixed - Maya generated tiff files appear "squished"
  • Fixed - Maya to Keyframe Pro - Playblasted image sequences fail to load

v1.5.2 (July 19, 2018)

  • Fixed sidebar dock widgets not being hidden correctly
  • Rolled back to previous Qt version

v1.5.1 (June 26, 2018)

  • Added EXR support to software renderer
  • Added option to show confirm dialog when closing application
  • Added hotkeys to play forwards/backwards at normal speed (resets playback speed)
  • General performance improvements
  • Improved seek times
  • Improved codec support
  • Fixed user supplied EXR files not loading
  • Updated Qt version
  • Updated ffmpeg version

v1.4.8 (May 25, 2018)

  • Updated - Annotation line drawing algorithm
  • Added - Double size menu item
  • Fixed - "Show in Folder" should select the file in Explorer/Finder

v1.4.7 (February 8, 2018)

  • Added - Set swap interval parameter (OpenGL)
  • Fixed - Mutex during frame update can negatively affect performance
  • Fixed - Unnecessary timeline draw calls can negatively affect performance
  • Fixed - macOS - Crash on startup if shared memory is not accessible
  • Fixed - Audio will not play if channel layout is not explicitly set by encoder

v1.4.5 (January 22, 2018)

  • Added - Hotkeys to toggle annotation ghosting
  • Fixed - Export - Ignore range flag not repected if annotation flag enabled
  • Fixed - Snapshot - "All frames" option ignored when a range is defined
  • Fixed - Image sequences with uppercase extensions fail to load
  • Updated - Preferences dialog button focus
  • Updated - About dialog text

v1.4.4 (December 18, 2017)

  • Fixed - Rare crash caused by cache logic error

v1.4.3 (November 27, 2017)

  • Fixed - macOS - "Open with" (or double-click) to open launches player but doesn't load media (only affects OpenGL mode)
  • Fixed - Autoplay on app launch doesn't work if "Set default timeline active in new project" is enabled

v1.4.2 (November 6, 2017)

  • Fixed - Keyframe Pro performance may be slower than Keyframe MP

v1.4.1 (November 3, 2017)

  • Added - API - Query bookmarks/annotations
  • Added - API - Export
  • Added - API - Advanced snapshot
  • Added - API - Save annotations to PNG
  • Updated - Qt version (macOS)
  • Performance - Modified task priorities
  • Performance - Removed unnecessary image processing operations
  • Fixed - API - Python 3 compatibility
  • Fixed - API - Client disconnecting during extended blocking operation may crash application
  • Fixed - API - Server not closing existing socket when new client connection occurs
  • Fixed - Current row not highlighted when preferences dialog opened

v1.3.8 (October 16, 2017)

  • Updated - Qt version (Windows)
  • Fixed - Menus fall behind main window when "Always on Top" enabled (Windows)

v1.3.7 (September 5, 2017)

  • Added - Option to lock frame step/scrub to the current range
  • Performance - Improved seek speed
  • Fixed - Multi-step looping not working
  • Fixed - Actual fps display can be "noisy"
  • Fixed - Possible off-by-one error in timeline display

v1.3.6 (September 1, 2017)

  • Added - Option to lock frame step/scrub looping to the current range
  • Added - Option for the default timeline to always be made active on a new project
  • Updated - Qt version
  • Fixed - Global timeline displays incorrect expected fps if video frame rate is greater than 60
  • Fixed - Global timeline may incorrectly display zero as the actual playback fps in special case
  • Fixed - Annotations not displayed after opening project file if stroke width was set to zero
  • Fixed - Enforce a minimum width for each annotation tool
  • Fixed - Unable to cycle bookmarks that were loaded from a project file

v1.3.5 (August 3, 2017)

  • Added - Support for non-square pixels
  • Added - Automatically resolve relative export output paths if output directory is set
  • Added - Option to disable resolving relative export output paths
  • Updated - Always add a default timeline on startup (unless disabled in preferences)
  • Updated - Increased default audio buffer duration
  • Fixed - Frames with negative start/end times should be discarded
  • Fixed - Timeline UI may display incorrect frame number after seeking (edge case)
  • Fixed - Timeline UI may display incorrect frame after setting a bookmark (edge case)
  • Fixed - Reserve part of cache size for audio only
  • Fixed - Minimum cache size not enforced on startup
  • Fixed - Additional details should be added to export logs

v1.3.4 (June 26, 2017)

  • Added - Windows installer file associations
  • Added - Option to display only annotations
  • Added - Alternate display type for more accurate ghosted annotations
  • Fixed - Rare case where Maya 2013 playblast fails to completely cache
  • Fixed - macOS - Window geometry not restored on startup if "Always on Top" enabled

v1.3.2 (June 6, 2017)

  • Added - User configurable temp directory path
  • Added - Environment variable for temp directory path (KEYFRAME_PRO_TEMP_DIR)
  • Updated - Qt version
  • Fixed - Double-clicking to open files with non-ascii filename may fail in some cases
  • Fixed - macOS - Right-clicking the annotation bar may display incorrect context menu
  • Fixed - macOS - Some labels/tooltips using Windows specific text
  • Fixed - Maya To Keyframe Pro - Temp directory error occurs if not cached and Keyframe Pro is not open

v1.3.1 (April 25, 2017)

  • Added - macOS support
  • Added - macOS support for Client API and Maya to Keyframe Pro script
  • Added - Software renderer
  • Added - Preference to switch between hardware/software rendering
  • Updated - Qt version
  • Updated - ffmpeg version
  • Fixed - Player controls showing incorrect play state using specific import scenario
  • Fixed - Incorrect annotation display off state using specific import scenario
  • Fixed - Duplicate hotkey assignment in defaults
  • Fixed - Incorrect duration (seconds) displayed in media info
  • Fixed - Maya To Keyframe Pro - Errors when a playblast is interrupted using Esc key
  • Fixed - Maya To Keyframe Pro - Sync should be disabled in UI if player is closed
  • Fixed - Maya To Keyframe Pro - Error is displayed when querying the current viewer index

v1.2.9 (April 17, 2017)

  • Fixed - Some media files fail to correctly export with annotations

v1.2.8 (April 10, 2017)

  • Added - Environment variable for ffmpeg path (KEYFRAME_PRO_FFMPEG)
  • Fixed - Incorrect actual size displayed in media info dialog
  • Fixed - Logic error in audio decoder
  • RFE - Increased max volume to 150%

v1.2.7 (March 8, 2017)

  • Fixed - Export with annotations fails if spaces in intermediate directory path

v1.2.6 (March 1, 2017)

  • Added - Option to display frames relative to range start in global and range timelines
  • Added - Display global frames in left column of global timeline when in Frame (Range) display mode
  • Added - Support for opening Keyframe MP project files
  • Fixed - Some PNG sequences fail to load
  • Fixed - "Save As" dialog displayed under window when in fullscreen mode
  • Fixed - Incorrect timecode displayed in range timeline
  • Fixed - Dropping multiple media files on the viewer should only set the last file active
  • Fixed - Dropping multiple files on the viewer should prioritize the first project file in the list (and ignore other files)

v1.2.4 (February 15, 2017)

  • Fixed - Rare crash when playing media for an extended duration
  • Fixed - Incorrect shortcut name

v1.2.2 (February 9, 2017)

  • Fixed - Snapshot fails if directory does not exist
  • Fixed - HiDPI should not affect the viewer size
  • Fixed - Snapshots created on a HiDPI monitor have a scaled resolution

v1.2.1 (February 8, 2017)

  • Added - Export with annotations (beta)
  • Added - Export A/B split views (beta)
  • Added - Default preferences for annotation and viewer layout export
  • Added - Cut, copy and paste bookmarks (including annotations)
  • Added - Multi-step forwards and backwards
  • Added - Highlight the current element in the timeline list view (optional)
  • Fixed - Global timeline incorrectly displayed after deleting an element in active timeline
  • Fixed - Audio scrub should be muted when exporting snapshots
  • Fixed - 'B' Viewer may be one frame behind 'A' in some cases
  • Client API - Added 'from_range_start' parameter to set_frame
  • Maya To Keyframe Pro - Reduced the number of api calls on time change when synced

v1.1.6 (January 24, 2017)

  • Fixed - Cache error on older mpeg1 files
  • Fixed - Annotation ghosting is limited to the current range
  • Fixed - Performace - Redundant opening and closing of source input file
  • Fixed - Unexpected frame rate for media files exported from Quicktime Pro with multiple sources of different frame rates
  • Fixed - Client API - Export temp directory returned instead of user temp directory
  • Fixed - Client API - get/set frame and range should return 0 if an active timeline is not set

v1.1.5 (January 18, 2017)

  • Fixed - Decode error with some PNG image files
  • Fixed - JPG images of irregular size may not display correctly

v1.1.4 (January 13, 2017)

  • Added - Client API play, pause and is_autoplay methods
  • Fixed - MayaToKeyframePro doesn't respect autoplay when playblasting
  • Fixed - MayaToKeyframePro doesn't support image sequence playblasts
  • Fixed - Viewers may overlap when using a vertical viewer layout

v1.1.3 (January 9, 2017)

  • Fixed - High memory usage when a timeline contains many sources

v1.1.2 (January 5, 2017)

  • Added - Supported image sequences file formats
  • Added - Support for Maya image sequence playblasts
  • Fixed - Drag and drop not working for image sequences
  • Fixed - Image sequences not added to recent file list
  • Fixed - Users cannot directly edit source path in properties window
  • Fixed - Relative paths do not support image sequences
  • Fixed - Image sequence frame rate "Global" button not working in Project Settings
  • Fixed - Exporting image sequences fails
  • Fixed - Possible crash with single frame image sequence
  • Fixed - Invalid error message when dropping an image sequence in the project view
  • Fixed - "Show in Folder" doesn't work with image sequences
  • Fixed - Memory leak - scaling context not always being closed

v1.0.19 (December 13, 2016)

  • Added - Project tab to preferences dialog
  • Added - Double-click in viewer to toggle playback option
  • Added - Image sequence export integration (experimental)
  • Added - Image sequence frame rate defaults and overrides (experimental)
  • Fixed - Increased the width of annotation size sliders
  • Fixed - Incorrect element end time on export of edited sources
  • Fixed - Seek to next edit point may be off by one frame

v1.0.18 (December 5, 2016)

  • Fixed - Incomplete audio decoding in pcm_s16le codec
  • Fixed - Caching backwards across edit points may fail
  • Fixed - Seeking while playing backwards can cause cache to get into seek loop
  • Fixed - Cache error when using a very small cache with high resolution media
  • Fixed - Incorrect fill frame count
  • Fixed - Video cache should grow dynamically

v1.0.16 (November 30, 2016)

  • Added - Media Info Dialog
  • Added - Hotkeys for annotation tools
  • Added - Syntax highlighting to the Console Window
  • Fixed - Possible crash when deleting all annotation bookmarks
  • Fixed - Scaling artifact in the OpenGL Viewer
  • Fixed - Duplicate hotkeys are not identified and do not work with multiple assignments
  • Fixed - Deleting all items from timeline while playing leaves player in "play" state
  • Fixed - Creating a new project while playing leaves player in "play" state
  • Fixed - Drag and drop on Project View does not add files to recent files list

v1.0.15 (November 24, 2016)

  • Added - Multi-selections to the Project View
  • Added - Multi-selections to the Timeline List View
  • Added - Batch processing of common timeline operations
  • Added - Batch snapshot all frames and frames in range
  • Added - Batch snapshot all bookmarks and bookmarks in range
  • Added - Advanced snapshot user interface
  • Fixed - OnMoveElementUp context menu item removes element
  • Fixed - Deleting multiple sources from the project view requires multiple confirmations
  • Fixed - Uninformative error message when a media file has no streams
  • Fixed - Bookmarks are not displayed in the global timeline if they are after the range end time
  • Fixed - Source and Timeline root folders can be moved to different folders
  • Fixed - Inconsistent ordering when dragging and dropping urls in the Project View

v1.0.14 (November 21, 2016)

  • Annotations - Moved width select slider to right-click context menu for each individual tool (removed width select button)

v1.0.12 (November 17, 2016)

  • Added - Project settings UI
  • Added - Source root path for relative file paths
  • Added - Dynamically generate relative file paths based on source root path
  • Added - Relative source root path and relative file path to project files
  • Added - Option to display source root path and relative file path in Properties view
  • Added - Snapshot to folder and selected folder menu items
  • Fixed - Sources with file not found error should not be excluded on file load
  • Fixed - Remove all bookmarks doesn't clear the current frame annotation
  • Fixed - If project directory doesn't exist, save fails
  • Fixed - A broken source in a timeline can cause a cache size error
  • Fixed - Properties view shouldn't show main menu context menu
  • Fixed - Playback/secondary controls shouldn't show main menu context menu

v1.0.11 (November 14, 2016)

  • Added - Global frame rate for timeline export
  • Fixed - Exported audio is sequenced improperly when clip audio is shorter than clip duration

v1.0.10 (November 11, 2016)

  • Added - Refresh source to the Project View right-click menu
  • Added - Option for single button toggling of both the Project View and Details view
  • Added - Ability to dock Project View and Details View at the top and bottom
  • Fixed - Export should refresh all sources with a path that matches the export output
  • Fixed - Export should provide an error if output file is in current export timeline
  • Fixed - Export should report an error if output file could not be overwritten
  • Fixed - Importing a new file should not reset the default timeline range
  • Fixed - Audio buffer should dynamically resize
  • Fixed - Audio from next element may play in current element if element audio is shorter than video
  • Fixed - Audio may not play to completion with certain codecs
  • Fixed - Audio may not be cached after seek with certain codecs
  • Updated - Text for "Remove All Bookmarks" menu item

v1.0.8 (October 26, 2016)

  • Added - Annotation ghosting (onion-skinning)
  • Added - Profile option to export dialog
  • Added - Default export profile to preferences dialog
  • Added - Annotation tab to preferences dialog
  • Added - Advanced tab to preferences dialog
  • Fixed - No video displayed on some integrated graphics chipsets
  • Fixed - Possible crash when redoing an annotation
  • Fixed - Possible crash when creating a new project with annotation displayed
  • Fixed - Toggling a bookmark off doesn't refresh the viewer
  • Fixed - Out of range bookmarks interfere with bookmark cycling

v1.0.6 (October 17, 2016)

  • Added - Option for high-quality rendering

v1.0.5 (October 14, 2016)

  • Performance - Only allocate texture memory when absolutely necessary
  • Increased samples to reduce possible artifacting

v1.0.4 (October 11, 2016)

  • Fixed - Possible audio buffer overflow
  • Fixed - Loop on step/scrub backwards not seeking end of file
  • Increased refresh frequence during playback

v1.0.3 (October 7, 2016)

  • Added - Variable playback speed
  • Added - Quality option to export dialog
  • RFE - Separated user and export temp directories
  • Fixed - Autoplay not working when loading from cmd line arg
  • Fixed - Resize to Fit not working when loading from cmd line arg
  • Fixed - BBB test file not caching audio correctly

v1.0.2 (October 5, 2016)

  • Added - Alphabetical sort buttons to the timeline list view
  • Added - Multi-selection to the import files dialog
  • Fixed - IMA4 audio playback
  • Fixed - Incorrect offset on very short files
  • Fixed - Export output for some files offset by one frame
  • Changed - FFmpeg export path in Preferences now points to the ffmpeg executable
  • Updated - Labels on some UI elements for clarity

v1.0.1 (October 4, 2016)

  • Initial release