de.bforartists.Bforartists.yaml

# Flatpak name with runtime 
# and runtime version
id: de.bforartists.Bforartists
runtime: org.freedesktop.Platform
runtime-version: '23.08'
sdk: org.freedesktop.Sdk
command: bforartists

# Sandbox permissions, fine tuned for
# the vast majority of Linux users
finish-args:
  - --share=ipc
  - --socket=wayland
  - --socket=fallback-x11
  - --socket=pulseaudio
  - --device=dri
  - --share=network
  - --filesystem=home
  - --filesystem=/tmp
  - --filesystem=/run/spnav.sock:ro
  - --env=SPNAV_SOCKET=/run/spnav.sock
  - --env=TMP_DIR=/tmp
  - --env=TMP=/tmp
  - --env=LD_LIBRARY_PATH=/app/lib

# We bundle non-free codecs with Bforartists,
# which are build when the Flatpak is
# built. To allow users/distro maintainers 
# to remove non-free codecs, we make this an 
# extension that can be removed
add-extensions:
  de.bforartists.Bforartists.Codecs:
    directory: lib/codecs
    add-ld-path: lib
    bundle: true
    autodelete: true
  org.freedesktop.Platform.ffmpeg-full:
    directory: lib/ffmpeg
    version: '23.08'
    add-ld-path: .
cleanup-commands:
  - mkdir -p /app/lib/ffmpeg
modules:
  - shared-modules/libdecor/libdecor-0.2.0.json

  # Build codecs, including non-free ones
  - name: x264
    config-opts:
      - --prefix=/app/lib/codecs
      - --enable-lto
      - --enable-pic
      - --enable-shared
      - --disable-cli
    sources:
      - type: git
        url: https://code.videolan.org/videolan/x264.git
        commit: 31e19f92f00c7003fa115047ce50978bc98c3a0d
    cleanup:
      - /lib/codecs/include
      - /lib/codecs/lib/pkgconfig

  # We build ffmpeg as Blender (and by extension,
  # Bforartists) doesn't work well with OpenH264
  - name: ffmpeg
    build-options:
      env:
        PKG_CONFIG_PATH: /app/lib/codecs/lib/pkgconfig
    config-opts:
      - --prefix=/app/lib/codecs
      - --enable-shared
      - --disable-static
      - --disable-doc
      - --enable-gpl
      - --enable-version3
      - --disable-nonfree
      - --enable-optimizations
      - --enable-pthreads
      - --disable-bzlib
      - --disable-libgsm
      - --enable-libtheora
      - --enable-libvorbis
      - --enable-libvpx
      - --enable-libx264
      - --enable-zlib
      - --disable-libxcb
      - --disable-lzma
      - --disable-programs
      - --disable-network
      - --disable-protocols
      - --enable-protocol=file
      - --disable-devices
      - --enable-muxer=avi
      - --enable-muxer=h264
      - --enable-muxer=mov
      - --enable-muxer=mp4
      - --enable-muxer=ogg
      - --enable-muxer=webm
      - --enable-demuxer=avi
      - --enable-demuxer=h264
      - --enable-demuxer=mov
      - --enable-demuxer=mp3
      - --enable-demuxer=ogg
      - --enable-demuxer=wav
      - --enable-parser=h264
      - --enable-parser=vorbis
      - --enable-encoder=aac
      - --enable-encoder=libtheora
      - --enable-encoder=libvorbis
      - --enable-encoder=libvpx_vp8
      - --enable-encoder=libvpx_vp9
      - --enable-encoder=libx264
      - --enable-encoder=mpeg4
      - --enable-decoder=aac
      - --enable-decoder=h264
      - --enable-decoder=libvorbis
      - --enable-decoder=libvpx_vp8
      - --enable-decoder=libvpx_vp9
      - --enable-decoder=mp3
      - --enable-decoder=mpeg4
      - --enable-decoder=pcm_s16le
      - --enable-decoder=theora
    sources:
      - type: archive
        url: https://www.ffmpeg.org/releases/ffmpeg-6.1.1.tar.xz
        sha256: 8684f4b00f94b85461884c3719382f1261f0d9eb3d59640a1f4ac0873616f968
    cleanup:
      - /lib/codecs/include
      - /lib/codecs/lib/pkgconfig
      - /lib/codecs/share

  # Libcrypt for BlenderKit support
  # https://github.com/flathub/org.blender.Blender/issues/166
  - name: libxcrypt
    config-opts:
      - --prefix=/app
      - --enable-shared
      - --enable-obsolute-api=glibc
    sources:
      - type: archive
        url: https://github.com/besser82/libxcrypt/releases/download/v4.4.36/libxcrypt-4.4.36.tar.xz
        sha256: e5e1f4caee0a01de2aee26e3138807d6d3ca2b8e67287966d1fefd65e1fd8943

  # Bforartists itself
  - name: bforartists
    buildsystem: simple

    # All commands executed that ultimately
    # install Bforartists to the Flatpak 
    # runtime. This includes desktop files/icons,
    # as well as the metadata file used for Flathub
    build-commands:
      - mv Bforartists*Linux* bforartists
      - install -Dm755 bforartists.sh /app/bin/bforartists
      - mv bforartists /app/bforartists
      - install -Dm644 /app/bforartists/bforartists.desktop /app/share/applications/$FLATPAK_ID.desktop
      - desktop-file-edit --set-icon=${FLATPAK_ID} /app/share/applications/${FLATPAK_ID}.desktop
      - install -Dm644 $FLATPAK_ID.svg /app/share/icons/hicolor/scalable/apps/$FLATPAK_ID.svg
      - install -Dm644 /app/bforartists/bforartists-symbolic.svg /app/share/icons/hicolor/symbolic/apps/$FLATPAK_ID-symbolic.svg
      - cd /app/bforartists/*.*/datafiles && mv locale /app/share/locale && ln -sf
        /app/share/locale locale
      - install -Dm644 $FLATPAK_ID.metainfo.xml /app/share/metainfo/$FLATPAK_ID.metainfo.xml

    # Bforartists tar archive, retrived from
    # GitHub releases and verified with a sha256 
    # checksum. For every update, the URL and checksum 
    # need to be updated. For the checksum, it is as simple
    # as downloading the tar archive and running
    # sha256sum <bforartists tar archive>
    sources:
      - type: archive
        url: https://github.com/Bforartists/Bforartists/releases/download/v4.3.1/Bforartists-4.3.1-Linux.tar.xz
        sha256: adef074132f01d217ae9d6c73afabc7d243bfeac50ab854929e3dd737263865b
        strip-components: 0

        # This is to verify that the URL indeed 
        # exists. This is different from the
        # checksum, which checks if the downloaded 
        # tar archive is indeed the correct archive
        #
        # In addition, this also checks for new updates 
        # to the tar archive automatically
        x-checker-data:
          type: anitya
          project-id: 359756
          stable-only: true
          versions:
            '>=': 3.6.0
          url-template: https://github.com/Bforartists/Bforartists/releases/download/v$version/Bforartists-$version-Linux.tar.xz

      # Metadata and script that executes Bforartists
      - type: file
        path: de.bforartists.Bforartists.metainfo.xml
      - type: file
        path: branding/de.bforartists.Bforartists.svg
      - type: script
        commands:
          - cd /app/bforartists
          - exec ./bforartists "$@"
        dest-filename: bforartists.sh