ffmpegfs/html/transcode_8h_source.html

/*

 * Copyright (C) 2006-2008 David Collett @n

 * Copyright (C) 2008-2013 K. Henriksson @n

 * Copyright (C) 2017-2024 FFmpeg support 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 TRANSCODE_H

#define TRANSCODE_H


#pragma once


#include "ffmpegfs.h"

#include "fileio.h"


bool            transcoder_cached_filesize(LPVIRTUALFILE virtualfile, struct stat *stbuf);

bool            transcoder_set_filesize(LPVIRTUALFILE virtualfile, int64_t duration, BITRATE audio_bit_rate, int channels, int sample_rate, AVSampleFormat sample_format, BITRATE video_bit_rate, int width, int height, bool interleaved, const AVRational & framerate);

bool            transcoder_predict_filesize(LPVIRTUALFILE virtualfile, Cache_Entry* cache_entry = nullptr);


// Functions for doing transcoding, called by main program body

Cache_Entry*    transcoder_new(LPVIRTUALFILE virtualfile, bool begin_transcode);

bool            transcoder_read(Cache_Entry* cache_entry, char* buff, size_t offset, size_t len, int *bytes_read, uint32_t segment_no);

bool            transcoder_read_frame(Cache_Entry* cache_entry, char* buff, size_t offset, size_t len, uint32_t frame_no, int * bytes_read, LPVIRTUALFILE virtualfile);

void            transcoder_delete(Cache_Entry* cache_entry);

size_t          transcoder_get_size(Cache_Entry* cache_entry);

size_t          transcoder_buffer_watermark(Cache_Entry* cache_entry, uint32_t segment_no);

size_t          transcoder_buffer_tell(Cache_Entry* cache_entry, uint32_t segment_no);

void            transcoder_exit();


#endif

Cache_Entry
The Cache_Entry class.
Definition: cache_entry.h:49

BITRATE
#define BITRATE
For FFmpeg bit rate is an int.
Definition: ffmpeg_utils.h:145

ffmpegfs.h
Main include for FFmpegfs project.

fileio.h
FileIO class.

VIRTUALFILE
Virtual file definition.
Definition: fileio.h:123

transcoder_new
Cache_Entry * transcoder_new(LPVIRTUALFILE virtualfile, bool begin_transcode)
Allocate and initialise the transcoder.
Definition: transcode.cc:353

transcoder_set_filesize
bool transcoder_set_filesize(LPVIRTUALFILE virtualfile, int64_t duration, BITRATE audio_bit_rate, int channels, int sample_rate, AVSampleFormat sample_format, BITRATE video_bit_rate, int width, int height, bool interleaved, const AVRational &framerate)
Set the file size.
Definition: transcode.cc:288

transcoder_buffer_tell
size_t transcoder_buffer_tell(Cache_Entry *cache_entry, uint32_t segment_no)
Return the current file position in the file.
Definition: transcode.cc:733

transcoder_read
bool transcoder_read(Cache_Entry *cache_entry, char *buff, size_t offset, size_t len, int *bytes_read, uint32_t segment_no)
Read some bytes from the internal buffer and into the given buffer.
Definition: transcode.cc:469

transcoder_exit
void transcoder_exit()
Exit transcoding.
Definition: transcode.cc:738

transcoder_get_size
size_t transcoder_get_size(Cache_Entry *cache_entry)
Return size of output file, as computed by encoder.
Definition: transcode.cc:723

transcoder_read_frame
bool transcoder_read_frame(Cache_Entry *cache_entry, char *buff, size_t offset, size_t len, uint32_t frame_no, int *bytes_read, LPVIRTUALFILE virtualfile)
Read one image frame from the internal buffer and into the given buffer.
Definition: transcode.cc:603

transcoder_buffer_watermark
size_t transcoder_buffer_watermark(Cache_Entry *cache_entry, uint32_t segment_no)
Return the current watermark of the file while transcoding.
Definition: transcode.cc:728

transcoder_cached_filesize
bool transcoder_cached_filesize(LPVIRTUALFILE virtualfile, struct stat *stbuf)
Simply get encoded file size (do not create the whole encoder/decoder objects)
Definition: transcode.cc:261

transcoder_delete
void transcoder_delete(Cache_Entry *cache_entry)
Free the cache entry structure.
Definition: transcode.cc:718

transcoder_predict_filesize
bool transcoder_predict_filesize(LPVIRTUALFILE virtualfile, Cache_Entry *cache_entry=nullptr)
Predict file size.
Definition: transcode.cc:328