PINE64 - User contributions [en]

Mainline Hardware Encoding

2024-12-11T15:27:25Z

Link Mauve: /* SoC Support */ JPEG encoding is supported on the rk3588 since Linux 6.12.

'''Mainline Hardware Encoding''' of video can be achieved through the V4L2 user-space API, for which currently only GStreamer implements the required code.

== SoC Support ==

The following table shows the current supported codecs for encoding for each SoC. Support for decoding is separate.

{| class="wikitable plainrowheaders" border="1"
! scope="col" {{Diagonal split header|Codec|SoC}}
! scope="col" | RK3328
! scope="col" | RK3399
! scope="col" | RK3566
! scope="col" | RK3588
|-
! scope="row" | JPEG
| style="text-align:center;"| N/A
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | VP8
| style="text-align:center;"| N/A
| style="background:LightYellow; text-align:center;"| RFC[https://lore.kernel.org/linux-rockchip/20230309125651.23911-1-andrzej.p@collabora.com/T/]a
| style="background:LightYellow; text-align:center;"| RFC[https://lore.kernel.org/linux-rockchip/20230309125651.23911-1-andrzej.p@collabora.com/T/]a
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | H.264/AVC
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| Noa
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | H.265/HEVC
| style="background:#F99; text-align:center;"| No
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|}

=== Notes ===
<ol style="list-style-type:lower-alpha">
<li>Userspace API [https://lore.kernel.org/linux-media/ZK2NiQd1KnraAr20@aptenodytes/ under discussion] as part of the V4L2 stateless encoder uAPI development, with experimental implementations being worked on.</li>
</ol>

== Encoding With GStreamer ==

With GStreamer, in general, any V4L2 control can be set using the <code>extra-controls=foo,name=value</code> syntax after the encode pipeline stage identifier, where <code>foo</code> is any name you wish which GStreamer will promptly ignore, <code>name</code> is the name of the V4L2 control as shown by <code>v4l2-ctl --list-ctrls</code> (make sure to pick the right device with <code>-d</code>), and <code>value</code> is whatever value you want to set it to.

=== JPEG Encoding ===

This example converts an input MP4 file to an output MJPEG-inside-MKV file at JPEG quality 95, without any audio.

gst-launch-1.0 filesrc location=input.mp4 ! qtdemux name=demux demux.video_0 ! decodebin ! videoconvert ! v4l2jpegenc extra-controls=s,compression_quality=95 ! matroskamux ! filesink location=output.mkv

=== VP8 Encoding ===

{{hint|'''Note:''' This requires a draft [https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3736 GStreamer merge request] and the RFC kernel patchset applied.}}
{{note|'''Note:''' Patchset no longer applies cleanly, as AV1 decode controls were introduced and conflict.}}

This example converts an input MP4 file to an output VP8-inside-MKV file with a quantiser between 12 and 28, without any audio. The quantiser value goes from 0 (best quality, biggest filesize) to 63 (worst quality, smallest filesize).

gst-launch-1.0 filesrc location=input.mp4 ! qtdemux name=demux demux.video_0 ! decodebin ! videoconvert ! v4l2slvp8enc min-quality=12 max-quality=28 ! queue ! matroskamux ! filesink location=output.mkv

Alternatively, you can encode in variable bitrate mode with a target bitrate given in bits per second. Do note that Hantro doesn't seem to do target bitrates below 2 mbit/s. In this example, the file is transcoded at a target bitrate of 3 megabits per second.

gst-launch-1.0 filesrc location=input.mp4 ! qtdemux name=demux demux.video_0 ! decodebin ! videoconvert ! v4l2slvp8enc bitrate=3000000 ! queue ! matroskamux ! filesink location=output.mkv

== See Also ==

* [[Mainline Hardware Decoding]]

[[Category:Quartz64]] [[Category:ROCKPro64]] [[Category:Rockchip RK3566]] [[Category:Rockchip RK3399]] [[Category:Pinebook Pro]] [[Category:PinePhone Pro]] [[Category:PineNote]] [[Category:Rockchip RK3588]] [[Category:Rockchip RK3328]] [[Category:ROCK64]]

Mainline Hardware Decoding

2024-12-11T15:18:44Z

Link Mauve: /* Supported Codecs By SoC */ Oops, AV1 should be in green.

{{hint|This page is incomplete, you're welcome to improve it.}}

'''Mainline Hardware Decoding''' refers to video decoding done using hardware accelerators on the mainline Linux kernel (i.e. what sits in Linus' tree).

On most consumer-oriented SoCs, there is what is referred to as a VPU (Video Processing Unit). The VPU is responsible for power-efficient encoding and decoding of videos. Hardware-accelerated video decoding can be useful to get smoother video playback on your devices, lower power consumption, and lower CPU utilisation. Below is information regarding various hardware PINE64 uses and software that works with it.

== Hardware ==

Here's a table of the current support for different hardware. "In review" means the patch series to enable support has been posted to the mailing lists but is undergoing review, "linux-next" means it has been accepted and staged for the next Linux merge window.

=== Supported Codecs By SoC ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" {{Diagonal split header|Codec|SoC}}
! scope="col" style="width:6em" | A64
! scope="col" style="width:6em" | RK3328
! scope="col" style="width:6em" | RK3399
! scope="col" style="width:6em" | RK3566
! scope="col" style="width:6em" | RK3588
|-
! scope="row" | JPEG
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | MPEG-2
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | MPEG-4 Part 2/H.263
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP8
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | H.264/AVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes a
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | H.265/HEVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:LightYellow; text-align:center;"| In review
| style="background:LightYellow; text-align:center;"| Patches Exist
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP9
| style="text-align:center;"| N/A
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AVS2
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AV1
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:PaleGreen; text-align:center;"| Yes
|}

==== Notes ====

<ol style="list-style-type:lower-alpha">
<li>only Hantro, not rkvdec2, so with a maximum resolution of 1080p for now</li>
</ol>

=== Used SoC By Device ===

This table provides a quick reference to check which SoC is used in what Pine devices, for ease of navigating the previous table.

{| class="wikitable plainrowheaders" border="1"
! SoC
! Device(s)
|-
! Allwinner A64
| PinePhone, PineTab1, Pinebook, PINE A64, PINE A64-LTS, SOPINE
|-
! Rockchip RK3328
| ROCK64
|-
! Rockchip RK3399
| PinePhone Pro, Pinebook Pro, ROCKPro64
|-
! Rockchip RK3566
| Quartz64 Model A and B, SOQuartz, PineTab2
|-
! Rockchip RK3588
| QuartzPro64
|}

=== Cedrus ===

In 2018, Bootlin launched a crowdfunding campaign to bring a open source Allwinner VPU driver to mainline Linux, which came to be called Cedrus. The Cedrus media driver (For Allwinner SOCs such as A64) supported by mainline Linux supports H.264 and H.265 video decoding as of Linux 5.10, and with 5.11 came VP8 decoding support and a H.264 stateless video decoder interface. For more information refer to the [https://linux-sunxi.org/Sunxi-Cedrus#Codec_Support Sunxi wiki].

=== Hantro ===

The Hantro media driver supports Rockchip and NXP SoCs including the RK3399 used in the Pinebook Pro and RockPro64. In November 2020 it [https://www.cnx-software.com/2020/11/24/hantro-h1-hardware-accelerated-video-encoding-support-in-mainline-linux/ was announced] that Bootlin was working on encoding support for the driver.

=== rkvdec ===

rkvdec is the video decoding hardware that's developed by Rockchip presumably in house. It's what Rockchip uses for decoding 4K H.264/AVC, VP9 and H.265/HEVC content. The driver in mainline linux for the first generation rkvdec (used in RK3328 and RK3399) supports VP9 and H.264, [https://patchwork.kernel.org/project/linux-rockchip/list/?series=659401 patches for HEVC support] exist but require modification and resubmission to mainline.

RK3566, RK3568 and likely RK3588 use a second generation of rkvdec called rkvdec2. No mainline driver for this exists yet. The rkvdec instance on RK3588 additionally supports the [https://en.wikipedia.org/wiki/Audio_Video_Standard AVS2 video codec].

=== rkdjpeg ===

rkdjpeg is Rockchip's in-house hardware accelerated JPEG decoder. It can be found on the RK3566 and RK3568 as well as the RK3588.

No mainline driver exists for it so far.

== Software ==

=== GStreamer ===

H.264, H.265, MPEG-2, VP8, VP9 and AV1 video decoding is possible when using GStreamer's command line tools, or an application utilizing it such as [https://github.com/Rafostar/clapper Clapper] or [https://flathub.org/apps/details/org.sigxcpu.Livi µPlayer]. µPlayer includes a indicator of when hardware acceleration is properly working and in use.

==== Using gst-launch ====

To test out hardware decoding from the command line, <code>gst-launch-1.0</code> may be used. An example pipeline to demux, hardware decode and display H.264 video in an MP4 container would be as follows:

gst-launch-1.0 filesrc location=yourfilehere.mp4 ! qtdemux ! v4l2slh264dec ! videoconvert ! autovideosink

To do the same for a VP8 WebM file, one may use:

gst-launch-1.0 filesrc location=yourfilehere.webm ! matroskademux ! v4l2slvp8dec ! videoconvert ! autovideosink

Depending on your GStreamer version and your GStreamer's build configuration, the following may be available as well: <code>v4l2slmpeg2dec</code>, <code>v4l2slav1dec</code>, <code>v4l2slvp9dec</code> and <code>v4l2slh265dec</code>.

On platforms with a 2D accelerator (such as Rockchip's RGA) that is supported by v4l2, one may use <code>v4l2convert</code> instead of <code>videoconvert</code> to also hardware accelerate the pixel format conversion.

=== FFmpeg ===

Mainline FFmpeg currently lacks the necessary patches to use the v4l2-requests based API, but [https://github.com/jernejsk/FFmpeg a fork that can utilise it exists]. Fedora users can install precompiled binaries from a [https://dl.kwizart.net/pub/ffmpeg-v4l2-request/ dedicated repository] by one of the Fedora maintainers.

To build it, use something like

git clone -b v4l2-request-n6.0 https://github.com/jernejsk/FFmpeg.git
cd FFmpeg
./configure --enable-v4l2-request --enable-libudev --enable-libdrm --enable-gnutls --prefix=/some/install/prefix/here
make -j$(nproc)

After compiling, you can install it into your specified prefix with

make install

And then modify your PATH to include the prefix's bin directory.

With the patched ffmpeg, you can utilise hardware decoding using the <code>-hwaccel drm</code> parameter, e.g.:

ffmpeg -hwaccel drm -i input.mp4 -f null - -benchmark

to measure how fast it decodes.

=== mpv ===

mpv v0.35 or later, built against the aforementioned FFmpeg fork, can be used to play back videos with hardware accelerated decoding. The hardware decoder path features interop with the GPU output, saving an expensive copyback operation. You can utilise the hardware decoding with e.g.:

mpv --hwdec=drm ''video''

In mpv versions prior to 0.35, you can use the copyback hwdec with:

mpv --hwdec=drm-copy ''video''

To build an mpv against the FFmpeg in your prefix, you can run

PKG_CONFIG_PATH="/path/to/your/ffmpeg/prefix/lib/pkgconfig:$PKG_CONFIG_PATH" meson setup build
ninja -C build

=== HEVC on Linux for RK3399 ===

[https://libreelec.tv/ LibreELEC] maintains [https://github.com/LibreELEC/LibreELEC.tv/tree/master/projects/Rockchip/patches/linux/default patches] applicable to mainline Linux that, almong other things, add HEVC decode to <code>rkvdec</code>. Patches <code>linux-0011-v4l2-from-list.patch</code>, <code>linux-1001-v4l2-rockchip.patch</code>, <code>linux-2000-v4l2-wip-rkvdec-hevc.patch</code> and <code>linux-2001-v4l2-wip-iep-driver.patch</code> from commit [https://github.com/LibreELEC/LibreELEC.tv/tree/269fd4f127ee3acb9306e5ba82e7fb9ca15505cd/projects/Rockchip/patches/linux/default 269fd4f] can be applied to Linux 6.5.2 (tested) and are sufficient to use hardware HEVC decode on the RK3399.

== More Resources ==

* [https://xnux.eu/devices/feature/cedrus-pp.html Megi's Cedrus Information]
* [https://briandaniels.me/2021/06/27/hardware-accelerated-video-playback-on-the-pinephone.html HW accelerated GStreamer playback on the PinePhone]
* [https://briandaniels.me/2021/07/06/hardware-accelerated-video-playback-on-the-pinephone-with-clapper.html HW accelerated Clapper video player on the PinePhone]

== See Also ==

* [[Mainline Hardware Encoding]]

[[Category:Quartz64]] [[Category:ROCKPro64]] [[Category:Rockchip RK3566]] [[Category:Rockchip RK3399]] [[Category:Pinebook Pro]] [[Category:PinePhone Pro]] [[Category:PineNote]] [[Category:Rockchip RK3588]] [[Category:Rockchip RK3328]] [[Category:ROCK64]] [[Category:Allwinner A64]] [[Category:PinePhone]] [[Category:PINE A64-LTS]] [[Category:SOPINE]]

Mainline Hardware Decoding

2024-12-11T15:18:15Z

Link Mauve: /* Supported Codecs By SoC */ Fix outdated information about rk3588

{{hint|This page is incomplete, you're welcome to improve it.}}

'''Mainline Hardware Decoding''' refers to video decoding done using hardware accelerators on the mainline Linux kernel (i.e. what sits in Linus' tree).

On most consumer-oriented SoCs, there is what is referred to as a VPU (Video Processing Unit). The VPU is responsible for power-efficient encoding and decoding of videos. Hardware-accelerated video decoding can be useful to get smoother video playback on your devices, lower power consumption, and lower CPU utilisation. Below is information regarding various hardware PINE64 uses and software that works with it.

== Hardware ==

Here's a table of the current support for different hardware. "In review" means the patch series to enable support has been posted to the mailing lists but is undergoing review, "linux-next" means it has been accepted and staged for the next Linux merge window.

=== Supported Codecs By SoC ===

{| class="wikitable plainrowheaders" border="1"
! scope="col" {{Diagonal split header|Codec|SoC}}
! scope="col" style="width:6em" | A64
! scope="col" style="width:6em" | RK3328
! scope="col" style="width:6em" | RK3399
! scope="col" style="width:6em" | RK3566
! scope="col" style="width:6em" | RK3588
|-
! scope="row" | JPEG
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | MPEG-2
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | MPEG-4 Part 2/H.263
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP8
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | H.264/AVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes a
| style="background:PaleGreen; text-align:center;"| Yes
|-
! scope="row" | H.265/HEVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:LightYellow; text-align:center;"| In review
| style="background:LightYellow; text-align:center;"| Patches Exist
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP9
| style="text-align:center;"| N/A
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AVS2
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AV1
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| Yes
|}

==== Notes ====

<ol style="list-style-type:lower-alpha">
<li>only Hantro, not rkvdec2, so with a maximum resolution of 1080p for now</li>
</ol>

=== Used SoC By Device ===

This table provides a quick reference to check which SoC is used in what Pine devices, for ease of navigating the previous table.

{| class="wikitable plainrowheaders" border="1"
! SoC
! Device(s)
|-
! Allwinner A64
| PinePhone, PineTab1, Pinebook, PINE A64, PINE A64-LTS, SOPINE
|-
! Rockchip RK3328
| ROCK64
|-
! Rockchip RK3399
| PinePhone Pro, Pinebook Pro, ROCKPro64
|-
! Rockchip RK3566
| Quartz64 Model A and B, SOQuartz, PineTab2
|-
! Rockchip RK3588
| QuartzPro64
|}

=== Cedrus ===

In 2018, Bootlin launched a crowdfunding campaign to bring a open source Allwinner VPU driver to mainline Linux, which came to be called Cedrus. The Cedrus media driver (For Allwinner SOCs such as A64) supported by mainline Linux supports H.264 and H.265 video decoding as of Linux 5.10, and with 5.11 came VP8 decoding support and a H.264 stateless video decoder interface. For more information refer to the [https://linux-sunxi.org/Sunxi-Cedrus#Codec_Support Sunxi wiki].

=== Hantro ===

The Hantro media driver supports Rockchip and NXP SoCs including the RK3399 used in the Pinebook Pro and RockPro64. In November 2020 it [https://www.cnx-software.com/2020/11/24/hantro-h1-hardware-accelerated-video-encoding-support-in-mainline-linux/ was announced] that Bootlin was working on encoding support for the driver.

=== rkvdec ===

rkvdec is the video decoding hardware that's developed by Rockchip presumably in house. It's what Rockchip uses for decoding 4K H.264/AVC, VP9 and H.265/HEVC content. The driver in mainline linux for the first generation rkvdec (used in RK3328 and RK3399) supports VP9 and H.264, [https://patchwork.kernel.org/project/linux-rockchip/list/?series=659401 patches for HEVC support] exist but require modification and resubmission to mainline.

RK3566, RK3568 and likely RK3588 use a second generation of rkvdec called rkvdec2. No mainline driver for this exists yet. The rkvdec instance on RK3588 additionally supports the [https://en.wikipedia.org/wiki/Audio_Video_Standard AVS2 video codec].

=== rkdjpeg ===

rkdjpeg is Rockchip's in-house hardware accelerated JPEG decoder. It can be found on the RK3566 and RK3568 as well as the RK3588.

No mainline driver exists for it so far.

== Software ==

=== GStreamer ===

H.264, H.265, MPEG-2, VP8, VP9 and AV1 video decoding is possible when using GStreamer's command line tools, or an application utilizing it such as [https://github.com/Rafostar/clapper Clapper] or [https://flathub.org/apps/details/org.sigxcpu.Livi µPlayer]. µPlayer includes a indicator of when hardware acceleration is properly working and in use.

==== Using gst-launch ====

To test out hardware decoding from the command line, <code>gst-launch-1.0</code> may be used. An example pipeline to demux, hardware decode and display H.264 video in an MP4 container would be as follows:

gst-launch-1.0 filesrc location=yourfilehere.mp4 ! qtdemux ! v4l2slh264dec ! videoconvert ! autovideosink

To do the same for a VP8 WebM file, one may use:

gst-launch-1.0 filesrc location=yourfilehere.webm ! matroskademux ! v4l2slvp8dec ! videoconvert ! autovideosink

Depending on your GStreamer version and your GStreamer's build configuration, the following may be available as well: <code>v4l2slmpeg2dec</code>, <code>v4l2slav1dec</code>, <code>v4l2slvp9dec</code> and <code>v4l2slh265dec</code>.

On platforms with a 2D accelerator (such as Rockchip's RGA) that is supported by v4l2, one may use <code>v4l2convert</code> instead of <code>videoconvert</code> to also hardware accelerate the pixel format conversion.

=== FFmpeg ===

Mainline FFmpeg currently lacks the necessary patches to use the v4l2-requests based API, but [https://github.com/jernejsk/FFmpeg a fork that can utilise it exists]. Fedora users can install precompiled binaries from a [https://dl.kwizart.net/pub/ffmpeg-v4l2-request/ dedicated repository] by one of the Fedora maintainers.

To build it, use something like

git clone -b v4l2-request-n6.0 https://github.com/jernejsk/FFmpeg.git
cd FFmpeg
./configure --enable-v4l2-request --enable-libudev --enable-libdrm --enable-gnutls --prefix=/some/install/prefix/here
make -j$(nproc)

After compiling, you can install it into your specified prefix with

make install

And then modify your PATH to include the prefix's bin directory.

With the patched ffmpeg, you can utilise hardware decoding using the <code>-hwaccel drm</code> parameter, e.g.:

ffmpeg -hwaccel drm -i input.mp4 -f null - -benchmark

to measure how fast it decodes.

=== mpv ===

mpv v0.35 or later, built against the aforementioned FFmpeg fork, can be used to play back videos with hardware accelerated decoding. The hardware decoder path features interop with the GPU output, saving an expensive copyback operation. You can utilise the hardware decoding with e.g.:

mpv --hwdec=drm ''video''

In mpv versions prior to 0.35, you can use the copyback hwdec with:

mpv --hwdec=drm-copy ''video''

To build an mpv against the FFmpeg in your prefix, you can run

PKG_CONFIG_PATH="/path/to/your/ffmpeg/prefix/lib/pkgconfig:$PKG_CONFIG_PATH" meson setup build
ninja -C build

=== HEVC on Linux for RK3399 ===

[https://libreelec.tv/ LibreELEC] maintains [https://github.com/LibreELEC/LibreELEC.tv/tree/master/projects/Rockchip/patches/linux/default patches] applicable to mainline Linux that, almong other things, add HEVC decode to <code>rkvdec</code>. Patches <code>linux-0011-v4l2-from-list.patch</code>, <code>linux-1001-v4l2-rockchip.patch</code>, <code>linux-2000-v4l2-wip-rkvdec-hevc.patch</code> and <code>linux-2001-v4l2-wip-iep-driver.patch</code> from commit [https://github.com/LibreELEC/LibreELEC.tv/tree/269fd4f127ee3acb9306e5ba82e7fb9ca15505cd/projects/Rockchip/patches/linux/default 269fd4f] can be applied to Linux 6.5.2 (tested) and are sufficient to use hardware HEVC decode on the RK3399.

== More Resources ==

* [https://xnux.eu/devices/feature/cedrus-pp.html Megi's Cedrus Information]
* [https://briandaniels.me/2021/06/27/hardware-accelerated-video-playback-on-the-pinephone.html HW accelerated GStreamer playback on the PinePhone]
* [https://briandaniels.me/2021/07/06/hardware-accelerated-video-playback-on-the-pinephone-with-clapper.html HW accelerated Clapper video player on the PinePhone]

== See Also ==

* [[Mainline Hardware Encoding]]

[[Category:Quartz64]] [[Category:ROCKPro64]] [[Category:Rockchip RK3566]] [[Category:Rockchip RK3399]] [[Category:Pinebook Pro]] [[Category:PinePhone Pro]] [[Category:PineNote]] [[Category:Rockchip RK3588]] [[Category:Rockchip RK3328]] [[Category:ROCK64]] [[Category:Allwinner A64]] [[Category:PinePhone]] [[Category:PINE A64-LTS]] [[Category:SOPINE]]

Mainline Hardware Decoding

2023-07-10T16:03:32Z

Link Mauve: /* Hardware */ Add A64 support in the table.

{{hint|This page is incomplete, you're welcome to improve it.}}

'''Mainline Hardware Decoding''' refers to video decoding done using hardware accelerators on the mainline Linux kernel (i.e. what sits in Linus' tree).

On most consumer-oriented SoCs, there is what is referred to as a VPU (Video Processing Unit). The VPU is responsible for power-efficient encoding and decoding of videos. Hardware-accelerated video decoding can be useful to get smoother video playback on your devices, lower power consumption, and lower CPU utilisation. Below is information regarding various hardware PINE64 uses and software that works with it.

== Hardware ==

Here's a table of the current support for different hardware. "In review" means the patch series to enable support has been posted to the mailing lists but is undergoing review, "linux-next" means it has been accepted and staged for the next Linux merge window.

{| class="wikitable plainrowheaders" border="1"
! scope="col" {{Diagonal split header|Codec|SoC}}
! scope="col" | A64
! scope="col" | RK3328
! scope="col" | RK3399
! scope="col" | RK3566
! scope="col" | RK3588
|-
! scope="row" | JPEG
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | MPEG-2
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | MPEG-4 Part 2/H.263
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP8
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | H.264/AVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes a
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | H.265/HEVC
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:LightYellow; text-align:center;"| In review
| style="background:LightYellow; text-align:center;"| In review
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | VP9
| style="text-align:center;"| N/A
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:PaleGreen; text-align:center;"| Yes
| style="background:#F99; text-align:center;"| No
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AVS2
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| No
|-
! scope="row" | AV1
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="text-align:center;"| N/A
| style="background:#F99; text-align:center;"| No
|}

=== Notes ===

<ol style="list-style-type:lower-alpha">
<li>only Hantro, not rkvdec2, so with a maximum resolution of 1080p for now</li>
</ol>

=== Cedrus ===

In 2018, Bootlin launched a crowdfunding campaign to bring a open source Allwinner VPU driver to mainline Linux, which came to be called Cedrus. The Cedrus media driver (For Allwinner SOCs such as A64) supported by mainline Linux supports H.264 and H.265 video decoding as of Linux 5.10, and with 5.11 came VP8 decoding support and a H.264 stateless video decoder interface. For more information refer to the [https://linux-sunxi.org/Sunxi-Cedrus#Codec_Support Sunxi wiki].

=== Hantro ===

The Hantro media driver supports Rockchip and NXP SoCs including the RK3399 used in the Pinebook Pro and RockPro64. In November 2020 it [https://www.cnx-software.com/2020/11/24/hantro-h1-hardware-accelerated-video-encoding-support-in-mainline-linux/ was announced] that Bootlin was working on encoding support for the driver.

=== rkvdec ===

rkvdec is the video decoding hardware that's developed by Rockchip presumably in house. It's what Rockchip uses for decoding 4K H.264/AVC, VP9 and H.265/HEVC content. The driver in mainline linux for the first generation rkvdec (used in RK3328 and RK3399) supports VP9 and H.264, [https://patchwork.kernel.org/project/linux-rockchip/list/?series=659401 patches for HEVC support] are also in the process of review.

RK3566, RK3568 and likely RK3588 use a second generation of rkvdec called rkvdec2. No mainline driver for this exists yet. The rkvdec instance on RK3588 additionally supports the [https://en.wikipedia.org/wiki/Audio_Video_Standard AVS2 video codec].

=== rkdjpeg ===

rkdjpeg is Rockchip's in-house hardware accelerated JPEG decoder. It can be found on the RK3566 and RK3568 as well as the RK3588.

No mainline driver exists for it so far.

== Software ==

=== GStreamer ===
H.264 video decoding is possible when using GStreamer built from source, or an application utilizing it such as [https://github.com/Rafostar/clapper Clapper] or [https://flathub.org/apps/details/org.sigxcpu.Livi µPlayer]. µPlayer includes a indicator of when hardware acceleration is properly working and in use.

=== FFmpeg ===

Mainline FFmpeg currently lacks the necessary patches to use the v4l2-requests based API, but [https://github.com/jernejsk/FFmpeg a fork that can utilise it exists]. Fedora users can install precompiled binaries from a [https://dl.kwizart.net/pub/ffmpeg-v4l2-request/ dedicated repository] by one of the Fedora maintainers.

To build it, use something like

git clone -b v4l2-request-n6.0 https://github.com/jernejsk/FFmpeg.git
cd FFmpeg
./configure --enable-v4l2-request --enable-libudev --enable-libdrm --enable-gnutls --prefix=/some/install/prefix/here
make -j$(nproc)

After compiling, you can install it into your specified prefix with

make install

And then modify your PATH to include the prefix's bin directory.

With the patched ffmpeg, you can utilise hardware decoding using the <code>-hwaccel drm</code> parameter, e.g.:

ffmpeg -hwaccel drm -i input.mp4 -f null - -benchmark

to measure how fast it decodes.

=== mpv ===

mpv v0.35 or later, used against the aforementioned FFmpeg fork (re-building isn't required when using shared ffmpeg libraries), can be used to play back videos with hardware accelerated decoding. The hardware decoder path features interop with the GPU output, saving an expensive copyback operation. You can utilise the hardware decoding with e.g.:

mpv --hwdec=drm ''video''

In mpv versions prior to 0.35, you can use the copyback hwdec with:

mpv --hwdec=drm-copy ''video''

To build an mpv against the FFmpeg in your prefix, you can run

PKG_CONFIG_PATH="/path/to/your/ffmpeg/prefix/lib/pkgconfig:$PKG_CONFIG_PATH" meson setup build
ninja -C build

== More Resources ==

* [https://xnux.eu/devices/feature/cedrus-pp.html Megi's Cedrus Information]
* [https://briandaniels.me/2021/06/27/hardware-accelerated-video-playback-on-the-pinephone.html HW accelerated GStreamer playback on the PinePhone]
* [https://briandaniels.me/2021/07/06/hardware-accelerated-video-playback-on-the-pinephone-with-clapper.html HW accelerated Clapper video player on the PinePhone]

== See Also ==

* [[Mainline Hardware Encoding]]

[[Category:Quartz64]] [[Category:ROCKPro64]] [[Category:Rockchip RK3566]] [[Category:Rockchip RK3399]] [[Category:Pinebook Pro]] [[Category:PinePhone Pro]] [[Category:PineNote]] [[Category:Rockchip RK3588]] [[Category:Rockchip RK3328]] [[Category:ROCK64]] [[Category:Allwinner A64]] [[Category:PinePhone]] [[Category:PINE A64-LTS]] [[Category:SOPINE]]

PinePhone Carrier Support

2021-07-30T09:08:42Z

Link Mauve: /* Europe */ Add Free in France.

{{under construction}}

{{hint|MMS currently doesn't work in any distribution on the PinePhone without a [[PinePhone_Carrier_Support#MMS_workarounds|script]]! This means images and group chats will not work in text messages.}}

This page contains hints on setting up cellular network connectivity for specific carriers.
For more general information, see [[PinePhone#Modem_and_carrier_support|Modem and carrier support]]. For the APN settings see [[PinePhone APN Settings]].

= Check compatibility =
To check if the PinePhone is supported on your carrier:

Search for your carrier on [https://www.frequencycheck.com/ frequencycheck.com] and compare the carrier's LTE/GSM/WCDMA frequencies to the PinePhone's supported frequencies (listed in the [https://www.quectel.com/UploadFile/Product/Quectel_EG25-G_LTE_Specification_V1.1.pdf modem specification sheet]).

It is likely that there will be a few frequencies that your carrier uses which are not supported by the PinePhone. Not all of the carrier's frequencies need to be supported by the PinePhone for it to work - as long as ''most'' of them are supported, you will still get good coverage.

= Tested and working carriers =

The following is a list of carriers which has been tested by users and confirmed to be working (excerpt):

== Asia ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
| Japan || SoftBank || Not tested || Unsupported by carrier || No || No || Mobian Phosh, December 2020
|-
| Japan || Rakuten Mobile || Unsupported by carrier || Unsupported by carrier || Yes || Yes || Mobian Phosh, January 2020
|-
| Japan || Rakuten Mobile || Unsupported by carrier || Unsupported by carrier || Yes || No || Manjaro Plasma Mobile February 2021
|-
| Japan || Docomo || Yes || Not tested || Yes || Yes || Mobian Phosh, February 2021
|-
| India || Vodafone / Vi India || Yes || Not tested || Yes || Yes || DanctNIX (Arch Linux ARM) with Phosh, March 2021
|-
| South Korea || KT || Yes || Not tested || Yes || Yes || Manjaro Phosh, June 2021
|}

== Africa ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Europe ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Sweden || Telenor SE || Not tested || Not tested || Yes || Not tested || Manjaro Plasma Mobile beta2
|-
| UK || Three || Yes || Not tested || Yes || Yes || Manjaro Plasma Mobile beta2
|-
| UK || Vodafone || Yes || Not tested || Yes || Yes || ALARM & pmOS (Phosh?), modem FW latest - 26 Feb 21
|-
| France || Orange || Yes || Not tested || Yes || Yes || Manjaro Phosh Beta6 and later - 9 march 2021
|-
| France || SFR || Yes || Not tested || Yes || Yes || Manjaro Phosh Beta6 and later - 9 march 2021
|-
| France || Free || Yes || Not tested || Yes || Not tested || ArchLinux - 30 July 2021
|-
| Czech Republic || O2 || Yes (only on 2G) || Not tested || Yes || Yes || Mobian Phosh (20210517 image up to date) - 2 June 2021
|-
| Germany || Congstar || Yes || Not tested || Yes || Yes (IPv4 & IPv6) || Mobian (Megi's kernel 5.13.0-rc4, apt up-to-date) with Phosh, 2021-06-07
|-
| Germany || Telekom || Yes || Not tested || Yes || Not tested || Mobian Phosh (5.10-sunxi64), 2021-07-28
|-
|}

== North America ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| USA || T-Mobile || Yes || No || Yes || Yes ||
* Arch Linux Arm 2020/11/29
* Mobian - Phosh
* Manjaro - KDE Plasma Mobile
|-
| USA || MetroPCS (T-Mobile) || Yes || No || Yes || Yes ||
*Arch Linux Arm (Phosh,SXMO) 2021/04/29
*Manjaro - Phosh 2021/04/29
*Mobian - Phosh 2021/3/20
|-
| USA || T-Mobile || Yes - buggy || No || Yes - buggy || Yes - buggy ||
*Manjaro - Plasma Dev 2020/11/21
*Ubuntu Touch - 2020/11/26
*KDE Neon 2020/11/02
|-
| USA || Mint Mobile (T-Mobile) || Yes || Not tested || Yes || Yes ||
*Mobian - Phosh 2021/3/14
*postMarketOS - Phosh, Sxmo, Plasma Mobile 2021/5/26
*Ubuntu Touch 2021/5/24
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*Mobian - Phosh 2021/3/1
|-
| USA || Verizon || No || No || No || No ||
*Ubuntu Touch 2021/5/24 (You can occasionally get the settings to work with Verizon, but it seems like the settings automatically changes the carrier to the wrong one after a few minutes)
|-
| USA || Verizon || Not tested || Not tested || Yes || Not via gui ||
*Manjaro - KDE Plasma Mobile 2021/5/10
|-
| USA || Verizon || Yes || Not tested || Yes || Not via gui ||
*Manjaro - Phosh 2021/5/31
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*postmarketOS - Phosh 2021/5/31
|-
| USA || Verizon || Yes || Not tested || Yes || Yes ||
*Arch - Phosh 2021/5/31
|-
| Canada || Freedom || Yes || Not tested || Yes || Yes ||
*Arch Pinephone - Phosh (APN: internet.windmobile.ca), 2021/4/25
|-
| USA || FaithWireless (AT&T) || Yes || No || Yes || Yes ||
*Arch Linux Arm - Phosh 2021/04/29 (version 0.10.1-1, see the [[PinePhone_Carrier_Support#AT.26T|AT&T issues]] below.)
|-
| USA || Consumer Cellular (AT&T) || Yes || No || Yes || Yes ||
*Manjaro - Phosh 2021/06/26
|-
| USA || Google Fi (T-Mobile) || Yes || No || Yes || Yes ||
*Arch Linux Arm - Phosh 0.10.2 2021/05/29
|}

== South America ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Australia / Oceania ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Test || Test || Yes || Yes || Yes || Yes || TestOS with Phosh, 20201129
|-
|}

== Middle East ==
{| class="wikitable sortable"
!Country || Carrier name || SMS working || MMS working || Calls working || Data working || Tested OS (with version) and UI
|-
|-
| Israel|| Cellcom prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-

|-
| Israel|| Golan TC || receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Partner prepay || receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Pelephone prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| Hot prepay|| receive+notify|| NA || ring+ notify || NA || on PmOS Sxmo May 14 2021.
|-
|-
| Israel|| 019 prepay|| No || NA ||Bars only || NA || on PmOS Sxmo May 14 2021.
|-

|}

= Special carrier notes =

{{Warning|This section contains providers which do not work or require special settings or actions to work.}}

Some carriers might support only certain frequencies or might require certain settings in Ofono or ModemManager. The following is a list of collected notes for carriers regarding special settings, hints or information:

== USA ==
=== AT&T ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page], AT&T's primary bands are 12 and 17 - 700ac and 700 MHz respectively. The PinePhone seems to work out-of-the-box with AT&T. If you transfer a SIM card from another phone you were using with AT&T, you need to activate the PinePhone through [https://www.att.com/buy/wireless/byod/byod AT&T's website]. Calls and SMS messages work. VoLTE is as yet untested.

However, it is likely AT&T will drop support with their network upgrade in the near future like their child company Cricket Wireless already has. [https://www.att.com/ecms/dam/att/consumer/help/pdf/Devices-Working-on-ATT-Network.pdf This page] lists their supported devices for their new network.

=== Consumer Cellular ===

Consumer Cellular is a MVNO that uses both AT&T and T-Mobile networks. On the AT&T network LTE data works without special configuration. If you transfer a SIM card from another phone to the PinePhone, you may need to contact customer support in order for them to register the IMEI association to the correct hardware; in one case it was first incorrectly identified as a Samsung Google Nexus Prime before later being correctly identified by the modem model Quectel EG25-G. Customer support also explicitly enabled VoLTE on the device. After VoLTE instructions on this site were followed and APN instructions on the Consumer Cellular site were followed, VoLTE was confirmed working.

=== Cricket Wireless ===
Cricket wireless is a MVNO that uses AT&T's network. VoLTE was fully supported, but the PinePhone is no longer considered a compatible device in the US by the carrier (as of March 2021).

=== SimpleMobile ===
SimpleMobile is a T-Mobile prepaid MVNO operating in the United States. 4G LTE, VoLTE, data, and SMS all work on the PinePhone after activation. Activation can be done online without extra software or assistance, go to https://www.simplemobile.com/activation/byopcollectsim and make sure you have your SIM card and IMEI ready.

=== Sprint ===
Sprint is currently not supported due to unknown reasons. Any input regarding this issue is highly appreciated.

=== T-Mobile ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page],
T-Mobile's primary frequency band for the United States is 12 (700ac MHz).

T-Mobile's bands and protocols are summarized on
[https://www.frequencycheck.com/carriers/t-mobile-united-states this page].

While the PinePhone's modem does support all LTE bands that T-Mobile uses in the US (And is one of the best choices for band support with the PinePhone's modem in the US), VoLTE is still listed as "Under development" by the modem manufacturer. T-Mobile's system also does not list the PinePhone as a compatible device due to this lack of official VoLTE support. The modem is capable of working on T-Mobile with VoLTE support enabled.

=== Verizon ===
According to [https://ltefix.com/wp-content/uploads/USA-Major-Carriers-Bands-Frequencies-CA.pdf this page],
Verizon's primary frequency band for the United States is 13 (700 MHz). Verizon's bands and protocols are summarized on
[https://www.frequencycheck.com/carriers/verizon-wireless-united-states this page]. According to the same page, Verizon might restrict their network to only approved devices.

Some users reported that they were able to activate their Verizon SIM by using an Verizon-approved burner phone and then inserting the SIM into the PinePhone.

=== Google Fi ===
Only T-Mobile service works currently, not US Cellular or Sprint.
The APN is h2g2.
Information from [https://forum.pine64.org/showthread.php?tid=11675&page=7 the forum].

Bear in mind that initial activation of the SIM card is not possible without an Android phone running Google Apps.

It should also be noted that Google uses a non-standard MMS implementation that is unlikely to be supported on the PinePhone at any point.

== Europe ==
=== Telekom Germany ===
With low signal, there may be loud interference noise audible in calls on the receiving end. It has not yet been tested whether or not this problem is carrier specific. An easy fix is extending the modem antenna with aluminum foil (or similar) inside the back cover of the phone.

= Known issues =
Known issues:
* The [https://www.frequencycheck.com/models FrequencyCheck model page] does not list either Pine64 or the PinePhone.
* T-Mobile's system does not list the PinePhone as a compatible device due to the lack of official VoLTE support from the manufacturer, despite the fact that it does work.
* MMS doesn't currently work in any distribution on the PinePhone by default. This means images and group chats will not work in text messages.
* Some providers may allow only certain known devices identified by their [https://en.wikipedia.org/wiki/Type_Allocation_Code Type Allocation Code].

= MMS workarounds =
These scripts allow partial MMS support on a [[PinePhone]]:

* JMMS: [https://git.sr.ht/~amindfv/jmms]
* silvermms: [https://gitlab.com/5ilver/silvermms]
* MMS via Matrix with mmmpuppet: [[PinePhone MMS with Matrix]]

There is a Haskel MMS client. MMS can also be manually composed with mmsd on the command line.

= Resources =
* IMEI - [https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity International Mobile Equipment Identity]

[[Category:PinePhone]]