Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: c6994d41a3
Fetching contributors…

Cannot retrieve contributors at this time

190 lines (167 sloc) 6.871 kb
// Folve - A fuse filesystem that convolves audio files on-the-fly.
// Copyright (C) 2012 Henner Zeller <>
// 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
// 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, see <>.
#include "conversion-buffer.h"
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
// Annoyingly, mkstemp() does not do TMPDIR trickery and tempnam() is obsolete.
static char *TempNameAllocated(const char *pattern) {
const char *tmp_path = getenv("TMPDIR");
if (tmp_path == NULL || strlen(tmp_path) == 0) tmp_path = getenv("TMP");
if (tmp_path == NULL || strlen(tmp_path) == 0) tmp_path = "/tmp";
char *result = (char*) malloc(strlen(tmp_path) + 1 + strlen(pattern) + 1);
strcpy(result, tmp_path);
strcat(result, "/");
strcat(result, pattern);
return result;
ConversionBuffer::ConversionBuffer(SoundSource *source, const SF_INFO &info)
: source_(source), out_filedes_(-1), snd_writing_enabled_(true),
total_written_(0), max_accessed_(0), header_end_(0), file_complete_(false) {
char *filename = TempNameAllocated("folve-XXXXXX");
out_filedes_ = mkstemp(filename);
if (out_filedes_ < 0) {
perror("Problem opening buffer file");
// After file-open: SetOutputSoundfile() already might attempt to write data.
source_->SetOutputSoundfile(this, CreateOutputSoundfile(info));
ConversionBuffer::~ConversionBuffer() {
sf_count_t ConversionBuffer::SndTell(void *userdata) {
// This will be called within writing, when our mutex is locked. So only
// call the version that assumed locked by mutex.
return reinterpret_cast<ConversionBuffer*>(userdata)->FileSize_Locked();
sf_count_t ConversionBuffer::SndWrite(const void *ptr, sf_count_t count,
void *userdata) {
return reinterpret_cast<ConversionBuffer*>(userdata)->SndAppend(ptr, count);
// These callbacks we don't care about.
static sf_count_t DummySeek(sf_count_t offset, int whence, void *userdata) {
// This seems to be called while closing, probably to modify the
// header. But we already have a custom header, so we need to avoid writing
// to that position. So as soon as we see this, disable writing,
// because it would mess up the file.
if (offset > 0) {
//fprintf(stderr, "Skipping seek to %lld\n", (long long int) offset);
return 0;
static sf_count_t DummyRead(void *ptr, sf_count_t count, void *user_data) {
fprintf(stderr, "DummyRead called\n");
return 0;
SNDFILE *ConversionBuffer::CreateOutputSoundfile(const SF_INFO &out_info) {
SF_INFO info_copy = out_info;
SF_VIRTUAL_IO virtual_io;
memset(&virtual_io, 0, sizeof(virtual_io));
virtual_io.get_filelen = &ConversionBuffer::SndTell;
virtual_io.write = &ConversionBuffer::SndWrite;
virtual_io.tell = &ConversionBuffer::SndTell; = &DummyRead; = &DummySeek;
return sf_open_virtual(&virtual_io, SFM_WRITE, &info_copy, this);
ssize_t ConversionBuffer::Append(const void *data, size_t count) {
if (out_filedes_ < 0) return -1;
//fprintf(stderr, "Extend horizon by %ld bytes.\n", count);
int remaining = count;
const char *buf = (const char*)data;
while (remaining > 0) {
int w = write(out_filedes_, data, count);
if (w < 0) return -errno;
remaining -= w;
buf += w;
total_written_ += count;
return count;
void ConversionBuffer::WriteCharAt(unsigned char c, off_t offset) {
if (out_filedes_ < 0) return;
if (pwrite(out_filedes_, &c, 1, offset) != 1) fprintf(stderr, "Oops.");
ssize_t ConversionBuffer::SndAppend(const void *data, size_t count) {
if (!snd_writing_enabled_) return count;
return Append(data, count);
void ConversionBuffer::HeaderFinished() { header_end_ = FileSize(); }
// Mmh, looks like we're calling ourself while in FillUntil() loop. Investigate.
// Until then: don't lock mutex for simple access.
off_t ConversionBuffer::FileSize() const {
//folve::MutexLock l(&mutex_);
return FileSize_Locked();
off_t ConversionBuffer::FileSize_Locked() const {
return total_written_;
off_t ConversionBuffer::MaxAccessed() const {
//folve::MutexLock l(&mutex_);
return max_accessed_;
bool ConversionBuffer::IsFileComplete() const {
//folve::MutexLock l(&mutex_);
return file_complete_;
void ConversionBuffer::FillUntil(off_t requested_min_written) {
// As soon as someone tries to read beyond of what we already have, we call
// the callback that fills more of it.
// We are shared between potentially several open files. Serialize threads.
folve::MutexLock l(&mutex_);
while (!file_complete_ && total_written_ < requested_min_written) {
if (!source_->AddMoreSoundData()) {
file_complete_ = true;
ssize_t ConversionBuffer::Read(char *buf, size_t size, off_t offset) {
// As long as we're reading only within the header area, allow 'short' reads,
// i.e. reads that return less bytes than requested (but up to the headers'
// size). That means:
// required_min_written = offset + 1; // at least one byte.
// That way, we don't need to start the convolver if someone only reads
// the header: we stop at the header boundary.
// After beginning to read the sound stream, some programs (e.g. kaffeine)
// behave finicky if they don't get the full number of bytes they
// requested in a read() call (this is a bug in these programs, but we've
// to work around it). So that means in that case we make sure that we have
// at least the number of bytes available that are requested:
// required_min_written = offset + size; // all requested bytes.
const off_t required_min_written = offset + (offset >= header_end_ ? size : 1);
const ssize_t read_result = pread(out_filedes_, buf, size, offset);
if (read_result >= 0) {
const off_t new_max_accessed = offset + read_result;
if (new_max_accessed > max_accessed_) {
folve::MutexLock l(&mutex_);
max_accessed_ = new_max_accessed;
return read_result;
Jump to Line
Something went wrong with that request. Please try again.