OF 0.12.0 Release Checklist

[ofTheo]

I found this format quite helpful to organize tracking issues for releases.
Just wanted to put this here so we can start collecting any issues/PR for the next patch release.

Please add links to issues based on testing the nightly packages on different platforms.

0.12.0 SPECIFIC:

Addons:

• See if @bakercp wants to take over ofxPoco now it is not used in core ( but include ofxPoco for next few releases )

Libraries:

• What libraries to drop?
• Remove boost as dependency - but keep it in the download

All Platforms:

• FIX Random - See @artificiel's discussion here: Seed and randomness #7579
• ofDir Update aging nlohmann::json to current version. apothecary#267
• Support C++17 - Discussion about supporting C++17 #6585 ( wip PR here cpp 17 / std::filesystem wip  #6844 )
• Make ofVideoPlayer::isPlaying() consistent ofVideoPlayer isPlaying(), different behavior on ofVideoPlayer with or without Gstreamer #6527 ( without breaking things!! )
• Check out proposal for avoiding ofParameter notify loop for linked ofParams ofParameter<void> notification loop #6602
• ofAppGLFWWindow settings.monitor not being clamped bug causes crash
• Modernize examples/templates main.cpp Modernize examples and templates main.cpp #6720
• Better examples Examples - Update #7076
• Bug with cairo render when setting scale to 0,0 ofCairoRenderer stops working after setting ofScale(0, 0); #6715
• update GLFW ( see WIP : ofAppGLFW improvements #6954 )
• update all 3D model loading to assimp - apart from ply - and better assimp example
• update assimp for better model loading ( update assimp to 5.2.5 add FBX support closes #198 apothecary#236 )
• Drop QTCreator or fix? And focus on VS Code
• Add OF_NO_FMOD to enable AVEngine Sound Player on macOS and Media Engine sound player on Windows - Proposal: a way of not bundling FMOD in XCode #7507 and Windows Media Foundation and XAudio Sound Player #7523

Windows:

• Add emscripten to Windows Release - Add Emscripten to Windows releases #7484
• K-Lite breaks Directshow player - ofDirectShowPlayer hits "failed to find the video renderer" #6765
• Consider a MF video player using IMFMediaEngine ( useful ref here ) Media Foundation Player for Windows #7477
• Add MF and Xaudio2 based sound player Windows Media Foundation and XAudio Sound Player #7523

VS:

• Change default to VS2019 or VS2022
• Switch to VS2019
• Remove 32bit
• Check if C++17 fixes allow for c++latest [MSVC][std:c++latest] openFrameworks failed to build on MSVC #6832
• Update PG

MSYS2:

• Fix PG issue with backslashes - projects generated don't compile with msys2/mingw due to backslashes in config.make projectGenerator#265
• Remove 32bit
• Update PG

macOS:

• Change template to make missing a return a hard error instead of allowing functions not return anything.
• Fmod sound crash ofSoundPlayer crashes(Segmentation fault: 11) about once in 10times #6708 ( Don't see this anymore - @roymacdonald could you see if this is an issue? )
• Assimp went from 26MB to 300MB ( 0.11.0 to 0.11.1 ) fixed by: update assimp to 5.2.5 add FBX support closes #198 apothecary#236
• Remove QTKit QTKit legacy issue that prevents submitting apps to the apple store (and a solution) projectGenerator#264
• Fullscreen issues / viewport issues on M1 ofSetFullscreen - issues after entering and exit fullscreen #6719
• Update template to allow serial device access Xcode template needs update to allow serial device access.  #6864
• 10.15 min macOS ( once C++17 PR is merged )
• Change macOS / iOS / tvOS to ARC Fix Objective-C/C++ codes to supporting ARC #6889
• Add AVFoundation based sound player - Av engine sound player -redo #7293

Linux/ARM:

• test Rpi 3/4 with latest changes
• Try and get Rpi 4 working without X ( see comment from @patriciogonzalezvivo )
• X11 Macro clash with OpenCV 4. Need to do something like this, but maybe targeted to X11 ( https://github.com/openframeworks/openFrameworks/pull/6868/files )
• Fix Gstreamer 1.20 breaking video and grabber
• ofGstVideoPlayer fixes GStreamer fixes for frame by frame, looping, querying duration.  #7063
• Gstreamer issue with 22.04 - gstreamer - opencvExample is not working on Ubuntu #7516

Arm64 / aarch64

• OpenCv linker error RPI linuxaarch64 #7500 (comment)
• Check video playback

iOS:

• examples are broken Most examples for iOS are outdated or broken #6723
• guiExample broken - iOS: ofxGuiExample does not compile due to an ofParameter / ofxSlider linking error #7458
• native UI examples broken iOS: "native" examples are broken -- perhaps ARC-related #7457
• update main.cpp to modern approach
• fix simulator build not working due to duplicate symbols.

Android:

• Bring Android up to date with latest NDK #6762
• Add cpp 17 when @danoli3 's PRs are merged.
• update main.cpp to modern approach

emscripten:

• make html template a little more modern / clean looking
• check out @Jonathhhan 's branch for emscripten fixes. Can we do small bitesized PRs here?
• update to latest emscripten version ( see https://forum.openframeworks.cc/t/the-future-of-emscripten-and-of/38360 )
• fix fullscreen and AA not working Emscripten full screen and antialiasing of 2d-shapes do not work anymore #6758 ( see fix here )
• ofVideoPlayer and Emscripten #7377

CI:

• move nightly and releases to GitHub
  ProjectGenerator:
• Remove macOS binary from PG for Linux: projectGenerator binary distributed with linux (and vs) is a MACH-O binary. projectGenerator#209

Apothecary:

Examples:

• - remove 3D Model loader example and rename assimpExample

GENERAL:

• update the change log.
• update the Thanks.md with scripts/dev/thanks.sh
• update version defines in ofConstants.h.
• change the version on ofSite and make packages.
• update apothecary and projectGenerator submodules
• update stable to master
• Look at issue templates again. ( First take at creating a GitHub issue template First take at creating a GitHub issue template #5652 )
• Unpin this checklist and OF Nightly > Release #7145

Move to 0.13.0

• What addons to drop? #6989
• Remove fmod as the default sound player. replace fmod #167 Licensing Issues | ofSoundPlayer for FMOD to upgrade to FMOD 5 from FMOD 4.4 (Ex)  #5490 Fatal error when compiling OpenFrameworks msys2 windows #6622
• Move templates to root ( and fix CI scripts / PG / etc to correspond )
• Better retina support ( this is a tough one - might need to get bumped ) - Feature discussion - full retina / high res support for openFrameworks #4789
• Remove fmod as the default sound player. replace fmod #167 Licensing Issues | ofSoundPlayer for FMOD to upgrade to FMOD 5 from FMOD 4.4 (Ex)  #5490
• Remove fmod as the default sound player. replace fmod #167 Licensing Issues | ofSoundPlayer for FMOD to upgrade to FMOD 5 from FMOD 4.4 (Ex)  #5490 ( this seems doable if we can figure out the FFT part )
• Rename osx to macOS 😬

[dimitre]

suggestions:

• build RtAudio compatible with macOs 10.13
• removing deprecated functions like loadMovie, etc.
• remove QTKit

[dimitre]

Suggestions: Folders naming and location

it would be great to change some parts of structure for a major version like 0.12.0
changing osx to macos in docs, scripts and templates

and moving templates to root, not inside scripts. it is just strange that this folder sits there, together with lots of .sh folders.

[ofTheo]

Be great if people could add any open issues not listed above to this - either in the comments or by editing this issue.

[Jonathhhan]

Regarding my Emscripten branch: Not sure what is the best way to do the bitesized pull requests, but I am open for that...
(actually I tried to keep everything together, but now I read this: https://yihui.org/en/2018/02/bite-sized-pull-requests/)
Should I make another branch with less changes (only one at a time)?
Would also be great if someone can review my changes, because there are possibly some beginner mistakes (still it works fine for me so far)...
And which of the changes should be included and which not (for now)?

I tried to make a list for a better overview (hope I did not forget anything):

Done:
Fullscreen
Font antialiasing

Done, but could be optimized:
Update OF libs for current Emscripten
Update OF libs for atomics / sharedArrayBuffer (which is needed for AudioWorklet for example)
AudioWorklet
(wasm workers were just merged into the official branch, so could be usable with the official Emscripten branch soon emscripten-core/emscripten#16449)
WebMidi
Simplification (?) of ofxEmscriptenSoundPlayer
Routing of audio nodes (for processing ofxEmscriptenSoundPlayer and ofxEmscriptenVideoPlayer sound with audioWorklets)

Not done (but I have examples for using the file system):
Simplified use of the Emscripten file system

[ofTheo]

Bitesized Pull Requests would be great! Especially starting with stuff which is easy to review and merge. People can then review the PRs in a more focused way. Thanks!! Theo

[Jonathhhan]

Alright, actually I think I need somebody who can help me (already asked in the forum - but it seems quite difficult to find someone, even if paid), also I dont have a lot of time at the moment. But I will try, if I have more time (not sure if that is before 0.12.0). (My problem starts with: This branch is 186 commits behind the upstream and has conflicts that must be resolved.) I am a little lost and have other important things to do at the moment. I am sorry for that.

[Jonathhhan]

Implement audioWorklet from official Emscripten branch: https://github.com/emscripten-core/emscripten/pull/16449/files

[roymacdonald]

hey @Jonathhhan sorry for not being able to help so far. I will take a look at your branch and see how I can help to make a nice and clean PR.

[Jonathhhan]

@roymacdonald no problem. And sorry if I sounded a bit grumpy, it wasnt meant like that. I was just a little overwhelmed and exhausted.... But I think it would be a good idea to implement audioWorklets from the official Emscripten branch instead. Still, my implementation could help to show how to implement it (maybe (hopefully) it doesnt need a lot of changes).

[roymacdonald]

@Jonathhhan no worries. It did not sound like that at all to me. I see that there your most up to date branches are named bitesize-audioworklet and bitesize-AudioWorklet which one should be used?

[Jonathhhan]

@roymacdonald those two branches were my attempts to get clean up to date branches for making the bitsize changes. But I had no luck, because I made some changes to my master branch once (they include none of my current changes yet). So this is still the branch that includes all my changes: https://github.com/Jonathhhan/openFrameworks/tree/AudioWorklet

[dimitre]

Edit: Done
ofxSVG object renamed to ofxSvg

• OpenFrameworks - room for improvement #6866 (comment)
• ofxSVG to ofxSvg #6906