aboutsummaryrefslogblamecommitdiffstats
path: root/src/pcm/PcmBuffer.hxx
blob: ae7030f769753f4786f62c32a07083dd5f7cab2b (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
  
                                                          










                                                                       



                                                                          

   

                      
 
                  
                
 

                 

                   




                                                                     
                  
                     

                    
 








                                               
                         












                                                                              
 
      
/*
 * Copyright (C) 2003-2013 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * 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 2 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef PCM_BUFFER_HXX
#define PCM_BUFFER_HXX

#include "check.h"
#include "gcc.h"

#include <glib.h>

#include <assert.h>

/**
 * Manager for a temporary buffer which grows as needed.  We could
 * allocate a new buffer every time pcm_convert() is called, but that
 * would put too much stress on the allocator.
 */
struct PcmBuffer {
	void *buffer;

	size_t size;

	PcmBuffer():buffer(nullptr), size(0) {}

	~PcmBuffer() {
		g_free(buffer);
	}

	void Clear() {
		g_free(buffer);
		buffer = nullptr;
		size = 0;
	}

	/**
	 * Get the buffer, and guarantee a minimum size.  This buffer becomes
	 * invalid with the next pcm_buffer_get() call.
	 *
	 * This function will never return NULL, even if size is zero, because
	 * the PCM library uses the NULL return value to signal "error".  An
	 * empty destination buffer is not always an error.
	 */
	gcc_malloc
	void *Get(size_t size);
};

#endif