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

[dimitre]

Anybody else likes the idea of having https://github.com/danomatika/ofxMidi as a core addon?

[Jonathhhan]

Anybody else likes the idea of having https://github.com/danomatika/ofxMidi as a core addon?

definitely :)

[danoli3]

Yes yes

…

On Sat, 2 Apr 2022 at 12:25 pm, Jonathan ***@***.***> wrote: Anybody else likes the idea of having https://github.com/danomatika/ofxMidi as a core addon? definitely :) — Reply to this email directly, view it on GitHub <#6692 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAGK2HDCPYCY55FHJDPLDMLVC6OY7ANCNFSM4YB3EOSQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[dimitre]

Edit: Done
Suggestion: this PR can be added to 0.12 checklist too

• Fix Objective-C/C++ codes to supporting ARC #6889

[dimitre]

hey @ofTheo I've took a look at this:
settings.monitor not being clamped

and moved functionality to outside the if, so it is clamped correctly once
#6954

[dimitre]

hey @ofTheo I was reading this one " Change template to make missing a return a hard error instead of allowing functions not return anything."
and it is already an error in XCode and a warning in make.
This can be changed adding

PLATFORM_CFLAGS += -Werror=return-type

in line 93 of config.osx.default.mk
should I submit a PR?

[ofTheo]

@dimitre that would be great for make! Thanks!!

[dimitre]

Nice, its here

• Make - missing a return a hard error now #6962

[dimitre]

Hey @ofTheo can you explain better about retina support item?

[ofTheo]

@dimitre there is is more info here: #4789

Originally I was imagining that say you had a 2x retina scale OF would render everything twice as large into a 2x frame buffer. However fonts would also need to be loaded at 2x and then things start to get tricky as if you move the window to a 1x ( non retina window ), do you reload the fonts? Or if you start on a non retina monitor and move to a retina monitor do you reload the fonts at 2x?

There are definitely some edge cases where things get tricky.

It might be worth trying out some different approaches and see what is the simplest and most robust approach.

We can query the pixel coordinate scale and we can enable retina support via the plist so, the basic info is there.

Hope that helps!
Theo

[dimitre]

Other suggestion, older deprecated API should be removed already
loadMovie -> load
loadImage -> load
saveImage -> save
initGrabber -> setup

• uniformize API: #3320

[dimitre]

Just to add to list.
it would be great to have orientation issues solved for 0.12

[StaffanMelin]

I saw the Linux issue "Try and get Rpi 4 working without X" in the list. Does this mean running oF headless and without windowing system? I just did something similar on a Rock Pi 4 and I basically just used the ofAppNoWindow feature.

[StaffanMelin]

I think this should be addressed for Linux:
#6871

[dimitre]

Hey @StaffanMelin do you think it is an OF issue rather than GStreamer? Is Processing still shipping a previous version binary to make it work?

[artificiel]

if i may point 2 minor and easy-to-validate PRs: #7583 #7564

[artificiel]

ofRandom: #7598

[artificiel]

allow me to also point #7600

[artificiel]

also #7601

[artificiel]

and just in case it's an easy thing to fix (i guess it's more of a PG (or template?) thing?): make "release" the default -- as discussed in 2012: #1022 -- there seems to be more and more performance difference between debug and release (at least macOS).

[ofTheo]

Also this:
openframeworks/projectGenerator#377

[ofTheo]

Just a heads up that aside from a couple of very small fixes I think we're close to 0.12.0 release.

@dimitre if we can hold off on merging big feature or refactoring PRs for now. Let's let master sit as is for a few days and just focus on testing nightlies and addressing critical platform breaking issues.

Goal will be to post 0.12 early next week.

Edit: I'm guessing that install_dependencies scripts will need testing for ubuntu, debian and arch platforms. Maybe trying a fresh install on RPI3 ( 32bit bullseye raspbian ) and RPi4 ( 64bit bullseye debian ). Testing msys2 with @oxillo 's help.

We could also do a forum post to ask people to test the nightly builds on their platform.

[dimitre]

Great! no more news for pg until release. only bugfixes if they are found.

About RPI:
aarch64 works well for RPI 3B+ in my tests here
it seems to suport every one since RPI3 and zero 2, so this effort can make it work with any PI from after 2016
in my opinion we can drop importance in RPI 32bits release

[ofTheo]

Nice @dimitre!

Thanks for testing. Were you using the 64bit Raspberry Pi Bullseye OS or the Debian 64 bit OS or something different?
It would be awesome if you could try the nightly aarch64 release tomorrow as some of the libs were broken and now should be fixed.

[dimitre]

Raspberry Pi Bullseye.
I've tested some weeks ago before the changes.
I'll be travelling soon so no RPI near for the next two weeks.
I'll post on the forum if somebody else can do some testing.

[ofTheo]

cool! thanks @dimitre
I think I have 2-3 devices I can rummage up and give a try.

[artificiel]

on the x64 archlinux side, fresh install on i5 with of_v20230823_linux64gcc6_release.tar.gz: the download libs scripts work, as does compile and run the 3dprimitives example.

[ofTheo]

Awesome thanks @artificiel !

[Jonathhhan]

ProjectGenerator still does not open projects with Open in IDE. Tested with of_v20230823_vs_release.
Does not matter much to me, just want to mention it.

[ofTheo]

@Jonathhhan yup - trying to track that one down.
If I can't solve it quickly I think we can package nightlies as 0.12.0

[artificiel]

great!

i will still advocate a bit for #7601 as these don't help anyone currently and even if a quickie ARC fix is possible, it will not turn them into good examples.

also I had #7271 on a lingering list -- just tested it, it works and feels more "correct" than executing an arbitrary downloaded script with complete sudo privileges.

[ofTheo]

cool!
Merged #7601 and bumped #7271 to 0.12.1 :)

[ofTheo]

0.12.0 RC 1 is out here:
https://github.com/openframeworks/openFrameworks/releases/tag/0.12.0-rc1

If there are no major issues we'll convert it to full 0.12.0.
Thank you everyone involved for all the work getting this out. 🙏

[moebiussurfing]

Hey, thanks for the update!

Just reporting about PG:

Dragging any example folder to PG is not allowed here on Windows 11.
Also when opening PG with admin rights.

Using the "import" button it works.
"Open IDE" button now works fine too.

[ofTheo]

Thanks for checking @moebiussurfing !!
Yes, I think the dragging into PG not working is okay ( did the older 0.11.2 release PG allow it? ).

Many thanks!
Theo

[moebiussurfing]

yes, older versions allowed drag a project folder to PG

[oxillo]

On MSYS2, compilation raises a lot of annoying deprecation warnings for ofSeedRandom().
The message should be only emitted if the function is used by the user code. Not in the core.

Error in the compilation directory. Sorry !

[oxillo]

Warning about compilation of C files with C++ only option

cc1.exe: warning: command-line option '-std=gnu++17' is valid for C++/ObjC++ but not for C

This is only for addon compilation! fix is not simple.
Not blocking for 12.0 release; let's move it to 12.1 (#7623)

[artificiel]

@oxillo srand-based random will be removed from core soon, but right now the deprecation warning should only be on the argument version. (we still need a single call in the new random engine to keep the seeds in sync but that will also go away).

I've just removed instances of ofSeedRandom in the examples with #7622; can you point if you have others lines for which you get errors?

[oxillo]

@artificiel : I've compiled in the wrong directory... RC1 doesn't seem to have this deprecation warning !
Sorry about the disturbance.

[oxillo]

Only warning that is remaining in the core is about unused function in ofFileUtils.cpp

C:/N/openframeworks/of_v0.12.0-rc1_msys2_mingw64_release/libs/openFrameworks/utils/ofFileUtils.cpp:1480:13: warning: 'bool natural(const ofFile&, const ofFile&)' defined but not used [-Wunused-function]

I think it can be safely deleted as it is replace by naturalStr(). @ofTheo what do you think ?

[ofTheo]

Closing this issue!
https://github.com/openframeworks/openFrameworks/releases/tag/0.12.0
https://forum.openframeworks.cc/t/0-12-0-is-released/42426

Thanks everyone!!!! 🎉