Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / audaspace / intern / AUD_PyInit.cpp
1 /*
2  * Copyright 2009-2011 Jörg Hermann Müller
3  *
4  * This file is part of AudaSpace.
5  *
6  * Audaspace is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * AudaSpace is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Audaspace; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20
21 /** \file \ingroup audaspaceintern
22  */
23
24 #include "AUD_PyInit.h"
25
26 #include <AUD_Sound.h>
27 #include <python/PySound.h>
28 #include <python/PyAPI.h>
29
30 extern "C" {
31 extern void *BKE_sound_get_factory(void *sound);
32 }
33
34 static PyObject *AUD_getSoundFromPointer(PyObject *self, PyObject *args)
35 {
36         long int lptr;
37
38         if (PyArg_Parse(args, "l:_sound_from_pointer", &lptr)) {
39                 if (lptr) {
40                         AUD_Sound* sound = BKE_sound_get_factory((void *) lptr);
41
42                         if (sound) {
43                                 Sound *obj = (Sound *)Sound_empty();
44                                 if (obj) {
45                                         obj->sound = AUD_Sound_copy(sound);
46                                         return (PyObject *) obj;
47                                 }
48                         }
49                 }
50         }
51
52         Py_RETURN_NONE;
53 }
54
55 static PyMethodDef meth_sound_from_pointer[] = {
56     {"_sound_from_pointer", (PyCFunction)AUD_getSoundFromPointer, METH_O,
57      "_sound_from_pointer(pointer)\n\n"
58      "Returns the corresponding :class:`Factory` object.\n\n"
59      ":arg pointer: The pointer to the bSound object as long.\n"
60      ":type pointer: long\n"
61      ":return: The corresponding :class:`Factory` object.\n"
62      ":rtype: :class:`Factory`"}
63 };
64
65 PyObject *AUD_initPython(void)
66 {
67         PyObject *module = PyInit_aud();
68         PyModule_AddObject(module, "_sound_from_pointer", (PyObject *)PyCFunction_New(meth_sound_from_pointer, NULL));
69         PyDict_SetItemString(PyImport_GetModuleDict(), "aud", module);
70
71         return module;
72 }
73