dimanikulin / fva

A convergent tool set in form of desktop applications to automate the process of importing the multimedia data (photo/audio/video) into the IR multimedia systems like digiKam, Google Photo, Apple Photo, Synology Photo Station, etc. to make the multimedia more searchable and to improve family photos
11 stars 2 forks source link
cmake codechecks cpp csv digicam doxygen exif exif-metadata organize-photos photo-organizer photography photomanager photos python qt sqlite synology visual-studio wix yml

FVA Logo

GitHub release (latest by date including pre-releases) GitHub all releases GitHub Release Date
Tests CodeFactor GitHub code size in bytes GitHub repo size
GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests
GitHub Discussions GitHub

Quick Links

Description

FVA Software (Photo-Video-Audio Software) is a convergent tool set in a form of desktop applications aimed at automating importing process of Multimedia Data (photo/audio/video) into Multimedia IR systems like digiKam digiKam.png, Google Photo, Apple Photo, Synology Moments SynologyMoments.png, etc. to make multimedia more fully-searchable as well as to refine family photos.

Input And Output Examples

Capabilities

Software Architecture Requirements

Constraints

This section lists constrains and explanations for them.

Assumptions

This section lists all the assumptions with explanations for them. This is critical to do in order to cover all the gaps in the requirements. # Assumption Description
1 It is assumed that the user, which the proposed solution is going to run under, has the write access to the Google Photo (and other IR Multimedia systems) folder where multimedia data processed is going to be put in.
2 User restarted the wizard after changing the configuration (because of feature of QTWizard and QTWizardPage)

Quality Attributes

This section lists quality attributes for target architecture. So there are following Quality Attributes: Conceptual Integrity, Maintainability, Reusability, Availability, Interoperability, Manageability, Performance, Reliability, Scalability, Security, Portability, Supportability, Testability, Learnability, Traceability.

For more details please see

Hardware requirements

TBD

Software Architecture Views

Context View

The context diagram below shows the solution bounds and its interactions with other objects and subjects.

flowchart LR
    B -->|Multimedia data| C(Online Multimedia IR system)
    B -->|Multimedia data| D(Offline Multimedia IR system)
    A(Photo Album owner) --> B(FVA Solution)
    A(Photo Album owner) --> D1
    A(Photo Album owner) --> D2
    A(Photo Album owner) --> D3
    D1(fa:fa-tablet Tablet) -->|Multimedia data| B(FVA Solution)
    D2(fa:fa-phone Phone) -->|Multimedia data| B(FVA Solution)
    D3(fa:fa-hdd-o External Disk) -->|Multimedia data| B(FVA Solution)

The solution is used during import of new multimedia content from external devices to an existing user photo album.

The photo album owner is the main and only user of the solution.

The external devices might be:

Once the multimedia data from the external devices is processed, the solution interacts with integrated online and offline Multimedia systems.

Functional View

The Layered Architecture shall be applied to the system. Following layers are considered:

flowchart BT
    A(UI) --> B(Processing)
    B(Processing) --> C(Data and Configuration)

For more details please see

Deployment View

The target installation folder shall have next folder structure:

Installation must be possible at any target directory but not only in root folder.

TBD describe dependencies installed along with FVA Software.

TBD fvaParams.csv

Programming Languages

Now C++ and Python are considered as main languages to implement FVA Software.

TBD - to describe for which cases C++ and for which Python.

License

we use 3-rd party code here TBD link and own licence is TBD

Dependencies

Only open source code/tools are used, as a product is open source.

There were other dependencies but they got outdated.

Code Style

Please see here for the rules to create and review the code.

Code Documentation

Please see here for the rules to document the code.

Implementation status

As of now, I have the implementation status for the following components:

These references will give you an overview of the implementation status for each respective component.

Contributing

There are many items to help the author with.

You can fill in this form to understand your needs in Multimedia search and organizing.

You can also post an issue here GitHub issues to request a feature or report a bug.

Here you can start a discussion.

You can also download installation packages that are published for Linux (x86-64), Mac and Windows (latest versions) to try it.

Community Telegram

Definitions, Acronyms, Abbreviations

# Abbreviation or Acronym Definition
1 Exif Exchangeable image file format (officially Exif, according to JEIDA/JEITA/CIPA specifications) is a standard that specifies the formats for images, sound, and ancillary tags used by digital cameras (including smartphones), scanners and other systems handling image and sound files recorded by digital cameras.
2 Google Google LLC is an American multinational technology company that specializes in Internet-related services and products, which include online advertising technologies, a search engine, cloud computing, software, and hardware.
3 IR Multimedia Systems multimedia information retrieval means the process of searching for and finding multimedia documents; the corresponding research field is concerned with building multimedia search engines.
4 Multimedia data Multimedia in principle means data of more than one medium. It usually refers to data representing multiple types of medium to capture information and experiences related to objects and events. Commonly used forms of data are numbers, alphanumeric, text, images, audio, and video. In common usage, people refer a data set as multimedia only when time-dependent data such as audio and video are involved.
5 Multimedia IR Multimedia Information Retrieval (MIR) is an organic system made up of Text Retrieval (TR); Visual Retrieval (VR); Video Retrieval (VDR); and Audio Retrieval (AR) systems. So that each type of digital document may be analyzed and searched by the elements of language appropriate to its nature, search criteria must be extended.