a36952fd749f232ff9d4f0df0c36c577082ad0fa
[ffmpeg.git] / libavcodec / mem.c
1 /*
2  * default memory allocator for libavcodec
3  * Copyright (c) 2002 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19 #include "avcodec.h"
20
21 /* here we can use OS dependant allocation functions */
22 #undef malloc
23 #undef free
24 #undef realloc
25
26 #ifdef HAVE_MALLOC_H
27 #include <malloc.h>
28 #endif
29
30 /* you can redefine av_malloc and av_free in your project to use your
31    memory allocator. You do not need to suppress this file because the
32    linker will do it automatically */
33
34 /** 
35  * Memory allocation of size byte with alignment suitable for all
36  * memory accesses (including vectors if available on the
37  * CPU). av_malloc(0) must return a non NULL pointer.
38  */
39 void *av_malloc(unsigned int size)
40 {
41     void *ptr;
42     
43 #if defined (HAVE_MEMALIGN)
44     ptr = memalign(16,size);
45     /* Why 64? 
46        Indeed, we should align it:
47          on 4 for 386
48          on 16 for 486
49          on 32 for 586, PPro - k6-III
50          on 64 for K7 (maybe for P3 too).
51        Because L1 and L2 caches are aligned on those values.
52        But I don't want to code such logic here!
53      */
54      /* Why 16?
55         because some cpus need alignment, for example SSE2 on P4, & most RISC cpus
56         it will just trigger an exception and the unaligned load will be done in the
57         exception handler or it will just segfault (SSE2 on P4)
58         Why not larger? because i didnt see a difference in benchmarks ...
59      */
60      /* benchmarks with p3
61         memalign(64)+1          3071,3051,3032
62         memalign(64)+2          3051,3032,3041
63         memalign(64)+4          2911,2896,2915
64         memalign(64)+8          2545,2554,2550
65         memalign(64)+16         2543,2572,2563
66         memalign(64)+32         2546,2545,2571
67         memalign(64)+64         2570,2533,2558
68         
69         btw, malloc seems to do 8 byte alignment by default here
70      */
71 #else
72     ptr = malloc(size);
73 #endif
74     return ptr;
75 }
76
77 /**
78  * av_realloc semantics (same as glibc): if ptr is NULL and size > 0,
79  * identical to malloc(size). If size is zero, it is identical to
80  * free(ptr) and NULL is returned.  
81  */
82 void *av_realloc(void *ptr, unsigned int size)
83 {
84     return realloc(ptr, size);
85 }
86
87 /* NOTE: ptr = NULL is explicetly allowed */
88 void av_free(void *ptr)
89 {
90     /* XXX: this test should not be needed on most libcs */
91     if (ptr)
92         free(ptr);
93 }
94