Visual Servoing Platform version 3.5.0
vpDirectShowDevice.h
1/****************************************************************************
2 *
3 * ViSP, open source Visual Servoing Platform software.
4 * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5 *
6 * This software 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 * See the file LICENSE.txt at the root directory of this source
11 * distribution for additional information about the GNU GPL.
12 *
13 * For using ViSP with software that can not be combined with the GNU
14 * GPL, please contact Inria about acquiring a ViSP Professional
15 * Edition License.
16 *
17 * See http://visp.inria.fr for more information.
18 *
19 * This software was developed at:
20 * Inria Rennes - Bretagne Atlantique
21 * Campus Universitaire de Beaulieu
22 * 35042 Rennes Cedex
23 * France
24 *
25 * If you have questions regarding the use of this file, please contact
26 * Inria at visp@inria.fr
27 *
28 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30 *
31 * Description:
32 * DirectShow device description.
33 *
34 * Authors:
35 * Bruno Renier
36 *
37 *****************************************************************************/
38
39#ifndef vpDirectShowDevice_hh
40#define vpDirectShowDevice_hh
41
42#ifndef DOXYGEN_SHOULD_SKIP_THIS
43
44#include <visp3/core/vpConfig.h>
45#if (defined(VISP_HAVE_DIRECTSHOW))
46
47#include <atlbase.h>
48#include <dshow.h>
49#include <iostream>
50#include <string>
51
52class VISP_EXPORT vpDirectShowDevice
53{
54
55 std::string name; // the device's name
56 std::string desc; // the device's description
57 std::string devPath; // the device's device path (unique)
58
59 bool inUse; // true if the device is already used by a grabber
60
61public:
62 vpDirectShowDevice() : inUse(false) {}
63 explicit vpDirectShowDevice(const CComPtr<IMoniker> &moniker) : inUse(false) { init(moniker); }
64
65 bool init(const CComPtr<IMoniker> &moniker);
66
67 bool getState() { return inUse; }
68 void setInUse() { inUse = true; }
69 void resetInUse() { inUse = false; }
70
71 std::string &getName() { return name; }
72 std::string &getDesc() { return desc; }
73 std::string &getDevPath() { return devPath; }
74
75 bool operator==(vpDirectShowDevice &dev);
76
77 friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, vpDirectShowDevice &dev);
78};
79#endif
80#endif
81#endif