summaryrefslogtreecommitdiffstats
path: root/xbmc/utils/BufferObjectFactory.h
blob: 1420129b66e6317504727ce01be706d89989cf5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
 *  Copyright (C) 2005-2020 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "BufferObject.h"

#include <functional>
#include <list>
#include <memory>

/**
 * @brief Factory that provides CBufferObject registration and creation
 *
 */
class CBufferObjectFactory
{
public:
  /**
   * @brief Create a CBufferObject from the registered BufferObject types.
   *        In the future this may include some criteria for selecting a specific
   *        CBufferObject derived type. Currently it returns the CBufferObject
   *        implementation that was registered last.
   *
   * @return std::unique_ptr<CBufferObject>
   */
  static std::unique_ptr<CBufferObject> CreateBufferObject(bool needsCreateBySize);

  /**
   * @brief Registers a CBufferObject class to class to the factory.
   *
   */
  static void RegisterBufferObject(const std::function<std::unique_ptr<CBufferObject>()>&);

  /**
   * @brief Clears the list of registered CBufferObject types
   *
   */
  static void ClearBufferObjects();

protected:
  static std::list<std::function<std::unique_ptr<CBufferObject>()>> m_bufferObjects;
};