olaf_config.h

Go to the documentation of this file.

// Olaf: Overly Lightweight Acoustic Fingerprinting
// Copyright (C) 2019-2025  Joren Six
 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
 
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
#include <stdbool.h> //bool 
#include <string.h> //bool 
#include <stdlib.h> //bool 
#include <stdio.h>

 
 
#ifndef OLAF_CONFIG_H
#define OLAF_CONFIG_H
    
    typedef struct Olaf_Config Olaf_Config;

    struct Olaf_Config{
 
        char * dbFolder; 
 
        //------ General Configuration

        int audioBlockSize;
        
        int audioSampleRate;

        int audioStepSize;

        int bytesPerAudioSample;
 
        bool verbose;
 
        //------ EVENT POINT Configuration

        int maxEventPointsPerBlock;

        int filterSizeTime;

        int halfFilterSizeTime;
        
        int filterSizeFrequency;
        int halfFilterSizeFrequency; 

        float minEventPointMagnitude;

        int minFrequencyBin;

        int maxEventPointUsages;
 

        int maxEventPoints;
        int eventPointThreshold;

        bool sqrtMagnitude;
        //-----------Fingerprint configuration
        
        bool useMagnitudeInfo;

        int numberOfEPsPerFP;

        int minTimeDistance;
        int maxTimeDistance;

        int minFreqDistance;
        int maxFreqDistance;

        size_t maxFingerprints;
 
 
        //------------ Matcher configuration

        size_t maxResults;

        int searchRange;

        int minMatchCount;

        float minMatchTimeDiff;

        float keepMatchesFor;

        float printResultEvery;

        size_t maxDBCollisions;
    };

    Olaf_Config* olaf_config_default(void);
 

    Olaf_Config* olaf_config_test(void);

    Olaf_Config* olaf_config_esp_32(void);

    Olaf_Config* olaf_config_mem(void);

    void olaf_config_destroy(Olaf_Config *config);
 
#endif // OLAF_CONFIG_H