cache_entry.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017-2024 by Norbert Schlia (nschlia@oblivion-software.de)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * On Debian systems, the complete text of the GNU General Public License
 * Version 3 can be found in `/usr/share/common-licenses/GPL-3'.
 */
 
#ifndef CACHE_ENTRY_H
#define CACHE_ENTRY_H
 
#pragma once
 
#include "cache.h"
 
#include "id3v1tag.h"
 
#include <atomic>
 
class Buffer;
 
class Cache_Entry
{
private:
    explicit Cache_Entry(Cache *owner, LPVIRTUALFILE virtualfile);
    Cache_Entry(Cache_Entry &) = delete;
    virtual ~Cache_Entry();
 
public:
    Cache_Entry & operator= (Cache_Entry const & other) = delete;
 
    static Cache_Entry *    create(Cache *owner, LPVIRTUALFILE virtualfile);
    bool                    destroy();
 
    bool                    openio(bool create_cache = true);
    bool                    flush();
    void                    clear(bool fetch_file_time = true);
    size_t                  size() const;
    uint32_t                video_frame_count() const;
    time_t                  age() const;
    time_t                  last_access() const;
    bool                    expired() const;
    bool                    suspend_timeout() const;
    bool                    decode_timeout() const;
    const char *            filename() const;
    const char *            destname() const;
    const char *            virtname() const;
    bool                    update_access(bool update_database = false);
    void                    lock();
    void                    unlock();
    int                     ref_count() const;
    int                     inc_refcount();
    int                     decr_refcount();
 
    bool                    outdated() const;
 
    LPVIRTUALFILE           virtualfile();
 
    bool                    closeio(int flags);
    void                    update_read_count();
    unsigned int            read_count() const;
 
    bool                    is_finished() const;
    bool                    is_finished_incomplete() const;
    bool                    is_finished_success() const;
    bool                    is_finished_error() const;
 
protected:
    void                    close_buffer(int flags);
    bool                    read_info();
    bool                    write_info();
    bool                    delete_info();
 
protected:
    Cache *                 m_owner;                        
    std::recursive_mutex    m_mutex;                        
    std::atomic_int         m_ref_count;                    
    LPVIRTUALFILE           m_virtualfile;                  
public:
    std::unique_ptr<Buffer> m_buffer;                       
    std::atomic_bool        m_is_decoding;                  
    std::recursive_mutex    m_active_mutex;                 
    std::recursive_mutex    m_restart_mutex;                
    std::atomic_bool        m_suspend_timeout;              
    CACHE_INFO              m_cache_info;                   
    ID3v1                   m_id3v1;                        
    std::atomic_uint32_t    m_seek_to_no;                   
};
 
#endif // CACHE_ENTRY_H