lfg.h 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. /*
  2. * Lagged Fibonacci PRNG
  3. * Copyright (c) 2008 Michael Niedermayer
  4. *
  5. * This file is part of FFmpeg.
  6. *
  7. * FFmpeg is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * FFmpeg is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with FFmpeg; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. #ifndef AVUTIL_LFG_H
  22. #define AVUTIL_LFG_H
  23. #include <stdint.h>
  24. /**
  25. * Context structure for the Lagged Fibonacci PRNG.
  26. * The exact layout, types and content of this struct may change and should
  27. * not be accessed directly. Only its `sizeof()` is guaranteed to stay the same
  28. * to allow easy instanciation.
  29. */
  30. typedef struct AVLFG {
  31. unsigned int state[64];
  32. int index;
  33. } AVLFG;
  34. void av_lfg_init(AVLFG *c, unsigned int seed);
  35. /**
  36. * Seed the state of the ALFG using binary data.
  37. *
  38. * @return 0 on success, negative value (AVERROR) on failure.
  39. */
  40. int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length);
  41. /**
  42. * Get the next random unsigned 32-bit number using an ALFG.
  43. *
  44. * Please also consider a simple LCG like state= state*1664525+1013904223,
  45. * it may be good enough and faster for your specific use case.
  46. */
  47. static inline unsigned int av_lfg_get(AVLFG *c){
  48. unsigned a = c->state[c->index & 63] = c->state[(c->index-24) & 63] + c->state[(c->index-55) & 63];
  49. c->index += 1U;
  50. return a;
  51. }
  52. /**
  53. * Get the next random unsigned 32-bit number using a MLFG.
  54. *
  55. * Please also consider av_lfg_get() above, it is faster.
  56. */
  57. static inline unsigned int av_mlfg_get(AVLFG *c){
  58. unsigned int a= c->state[(c->index-55) & 63];
  59. unsigned int b= c->state[(c->index-24) & 63];
  60. a = c->state[c->index & 63] = 2*a*b+a+b;
  61. c->index += 1U;
  62. return a;
  63. }
  64. /**
  65. * Get the next two numbers generated by a Box-Muller Gaussian
  66. * generator using the random numbers issued by lfg.
  67. *
  68. * @param lfg pointer to the contex structure
  69. * @param out array where the two generated numbers are placed
  70. */
  71. void av_bmg_get(AVLFG *lfg, double out[2]);
  72. #endif /* AVUTIL_LFG_H */