digikam-doc/setup_application/video_settings.rst

0001 .. meta::
0002    :description: digiKam Video Settings
0003    :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy, camera, configuration, setup, video
0004
0005 .. metadata-placeholder
0006
0007    :authors: - digiKam Team
0008
0009    :license: see Credits and License page for details (https://docs.digikam.org/en/credits_license.html)
0010
0011 .. _video_settings:
0012
0013 Video Settings
0014 ==============
0015
0016 .. contents::
0017
0018 digiKam relies on `FFMpeg Multimedia framework <https://ffmpeg.org/>`_ to handle video files. FFmpeg is a powerful video toolkit, which include all codecs that digiKam needs to play video files.
0019
0020 This section describes all advanced video settings used to tune media playing features on digiKam.
0021
0022 .. warning::
0023
0024     Changing values from this page can break video player functionalities.
0025
0026 .. note::
0027
0028      The **Reset** button on the bottom of views from this page allows to clear all settings to default values.
0029
0030 Decoder View
0031 ------------
0032
0033 This view allow to define the priority of decoders to use while playing media. In a flat list, you can enable or disable a decoder with the check-box on the left side. Selecting a entry, you can move **Up** or move **Down** with the buttons on the bottom side. The upper entries are taken in the high priority in the list by the player. At least one entry must be enabled in this list to render contents in the media-player.
0034
0035 .. figure:: images/setup_video_decoder.webp
0036     :alt:
0037     :align: center
0038
0039     The digiKam Video Configuration Panel with the Decoder View
0040
0041 AVFormat View
0042 -------------
0043
0044 This view allows to customize advanced settings to the `FFMpeg AVFormat component <https://ffmpeg.org/ffmpeg-formats.html#Format-Options>`_.
0045
0046 The **Enable avformat options** pass to ffmpeg space separated key-value definitions hosted in **Extra** string setting.
0047
0048 The **Reduce buffering** must minimize the delay between frames processed from a stream but this might break the audio-video synchronization.
0049
0050 The **Probe Size** value sets probing size in bytes, i.e. the size of the data to analyze to get stream information. A higher value will enable detecting more information in case it is dispersed into the stream, but will increase latency. Must be an integer not lesser than 32. It is 5000000 by default.
0051
0052 The **Max analyze duration** value specifies how many microseconds are analyzed to probe the input. A higher value will enable detecting more accurate information, but will increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
0053
0054 .. figure:: images/setup_video_avformat.webp
0055     :alt:
0056     :align: center
0057
0058     The digiKam Video Configuration Panel with the AVFormat View
0059
0060 Misc View
0061 ---------
0062
0063 This view allows to customize advanced rendering settings of the video frames on screen.
0064
0065 The **Force fps** value will force to render an amount of frames per seconds on screen. A null value disable this setting.
0066
0067 The **Buffer frames** value will set the number of frames to cache in memory before rendering. Using -1 will let the program to automatize frames storage in memory.
0068
0069 The **Timeout** value will specify the delay in seconds to considerate a broken stream. The **Abort** option will stop to play the stream in video player in this case.
0070
0071 The **OpenGL type** options are available under Windows to optimize support of accelerated OpenGL rendering with video card.
0072
0073 The **EGL** option is available under Linux to turn on support of OpenGL with X11 windows manager, only if X11 XCB extension is present.
0074
0075 .. figure:: images/setup_video_misc.webp
0076     :alt:
0077     :align: center
0078
0079     The digiKam Video Configuration Panel with the Misc View