1 /* ****************************************************************
3 * Copyright 2016 Intel Corporation All Rights Reserved.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 ******************************************************************/
20 /// This sample provides steps to define an interface for a resource
21 /// (properties and methods) and host this resource on the server.
26 #include "platform_features.h"
27 #include <condition_variable>
29 #include "OCPlatform.h"
31 #include "ocpayload.h"
36 #include <mmdeviceapi.h>
37 #include <endpointvolume.h>
39 #include <math.h> /* log */
41 #define SAFE_RELEASE(x) \
43 { (x)->Release(); (x) = NULL; }
47 namespace PH = std::placeholders;
50 void * ChangeMediaRepresentation (void *param);
51 void * handleSlowResponse (void *param, std::shared_ptr<OCResourceRequest> pRequest);
53 void setVolume(int vol);
56 // Specifies where to notify all observers or list of observers
57 // false: notifies all observers
58 // true: notifies list of observers
59 bool isListOfObservers = false;
61 // Specifies secure or non-secure
62 // false: non-secure resource
63 // true: secure resource
64 bool isSecure = false;
66 /// Specifies whether Entity handler is going to do slow response or not
67 bool isSlowResponse = false;
70 // Forward declaring the entityHandler
72 /// This class represents a single resource named 'MediaResource'. This resource has
73 /// two simple properties named 'state' and 'volume'
79 /// Access this property from a TB client
83 std::string m_mediaUri;
84 OCResourceHandle m_resourceHandle;
85 OCRepresentation m_mediaRep;
86 ObservationIds m_interestedObservers;
91 :m_name("Media Player"), m_state(false), m_volume(0), m_mediaUri("/a/media"),
92 m_resourceHandle(nullptr)
94 // Initialize representation
95 m_mediaRep.setUri(m_mediaUri);
97 m_mediaRep.setValue("state", m_state);
98 m_mediaRep.setValue("volume", m_volume);
99 m_mediaRep.setValue("name", m_name);
102 /* Note that this does not need to be a member function: for classes you do not have
103 access to, you can accomplish this with a free function: */
105 /// This function internally calls registerResource API.
106 void createResource()
108 OCStackResult result = OC_STACK_OK;
110 /* Resource Information */
111 std::string resourceURI = m_mediaUri;
112 std::string resourceTypeName = "core.media";
113 std::string resourceInterface = DEFAULT_INTERFACE;
115 /* Device Information */
116 char* deviceName = "IoTivity Media Server";
117 char* specVersion = "core.1.1.0";
118 OCStringLL types{ nullptr, const_cast<char*>(resourceTypeName.c_str()) };
119 OCDeviceInfo deviceInfo{ deviceName, &types, specVersion, nullptr };
121 result = OCPlatform::registerDeviceInfo(deviceInfo);
122 if (OC_STACK_OK != result)
124 cout << "Device information registration was unsuccessful\n";
129 char* platformId = "0A3E0D6F-DBF5-404E-8719-D6880042463A";
130 char* manufacturerName = "OCF";
131 char* manufacturerLink = "https://www.iotivity.org";
132 char* modelNumber = "895";
133 char* dateOfManufacture = "2016-01-15";
134 char* platformVersion = "1.0";
135 char* osVersion = "1.0";
136 char* hardwareVersion = "1.0";
137 char* firmwareVersion = "1.0";
138 char* supportLink = "https://www.iotivity.org";
139 OCPlatformInfo platformInfo = { platformId,
152 result = OCPlatform::registerPlatformInfo(platformInfo);
153 if (OC_STACK_OK != result)
155 cout << "Platform information registration was unsuccessful\n";
159 // OCResourceProperty is defined ocstack.h
160 uint8_t resourceProperty;
163 resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE | OC_SECURE;
167 resourceProperty = OC_DISCOVERABLE | OC_OBSERVABLE;
169 EntityHandler cb = std::bind(&MediaResource::entityHandler, this, PH::_1);
171 // This will internally create and register the resource.
172 result = OCPlatform::registerResource(m_resourceHandle, resourceURI, resourceTypeName,
173 resourceInterface, cb, resourceProperty);
174 if (OC_STACK_OK != result)
176 cout << "Resource creation was unsuccessful\n";
180 OCResourceHandle getHandle()
182 return m_resourceHandle;
185 // Puts representation.
186 // Gets values from the representation and
187 // updates the internal state
188 void put(OCRepresentation& rep)
192 if (rep.getValue("state", m_state))
194 cout << "\t\t\t\t" << "state: " << m_state << endl;
202 cout << "\t\t\t\t" << "state not found in the representation" << endl;
205 if (rep.getValue("volume", m_volume))
207 cout << "\t\t\t\t" << "volume: " << m_volume << endl;
208 if((0 <= m_volume) && (m_volume <= 100))
215 cout << "\t\t\t\t" << "volume not found in the representation" << endl;
220 cout << e.what() << endl;
225 // Post representation.
226 // Post can create new resource or simply act like put.
227 // Gets values from the representation and
228 // updates the internal state
229 OCRepresentation post(OCRepresentation& rep)
236 // gets the updated representation.
237 // Updates the representation with latest internal state before
239 OCRepresentation get()
241 m_mediaRep.setValue("state", m_state);
242 m_mediaRep.setValue("volume", m_volume);
247 void addType(const std::string& type) const
249 OCStackResult result = OCPlatform::bindTypeToResource(m_resourceHandle, type);
250 if (OC_STACK_OK != result)
252 cout << "Binding TypeName to Resource was unsuccessful\n";
256 void addInterface(const std::string& intf) const
258 OCStackResult result = OCPlatform::bindInterfaceToResource(m_resourceHandle, intf);
259 if (OC_STACK_OK != result)
261 cout << "Binding TypeName to Resource was unsuccessful\n";
266 // This is just a sample implementation of entity handler.
267 // Entity handler can be implemented in several ways by the manufacturer
268 OCEntityHandlerResult entityHandler(std::shared_ptr<OCResourceRequest> request)
270 cout << "\tIn Server CPP entity handler:\n";
271 OCEntityHandlerResult ehResult = OC_EH_ERROR;
274 // Get the request type and request flag
275 std::string requestType = request->getRequestType();
276 int requestFlag = request->getRequestHandlerFlag();
278 if(requestFlag & RequestHandlerFlag::RequestFlag)
280 cout << "\t\trequestFlag : Request\n";
281 auto pResponse = std::make_shared<OC::OCResourceResponse>();
282 pResponse->setRequestHandle(request->getRequestHandle());
283 pResponse->setResourceHandle(request->getResourceHandle());
285 // Check for query params (if any)
286 QueryParamsMap queries = request->getQueryParameters();
288 if (!queries.empty())
290 cout << "\nQuery processing upto entityHandler" << std::endl;
292 for (auto it : queries)
294 cout << "Query key: " << it.first << " value : " << it.second
298 // If the request type is GET
299 if(requestType == "GET")
301 cout << "\t\t\trequestType : GET\n";
302 if(isSlowResponse) // Slow response case
304 static int startedThread = 0;
307 std::thread t(handleSlowResponse, (void *)this, request);
311 ehResult = OC_EH_SLOW;
313 else // normal response case.
316 pResponse->setResponseResult(OC_EH_OK);
317 pResponse->setResourceRepresentation(get());
318 if(OC_STACK_OK == OCPlatform::sendResponse(pResponse))
324 else if(requestType == "PUT")
326 cout << "\t\t\trequestType : PUT\n";
327 OCRepresentation rep = request->getResourceRepresentation();
329 // Do related operations related to PUT request
330 // Update the mediaResource
333 pResponse->setResponseResult(OC_EH_OK);
334 pResponse->setResourceRepresentation(get());
335 if(OC_STACK_OK == OCPlatform::sendResponse(pResponse))
340 else if(requestType == "POST")
342 cout << "\t\t\trequestType : POST\n";
344 OCRepresentation rep = request->getResourceRepresentation();
346 // Do related operations related to POST request
347 OCRepresentation rep_post = post(rep);
348 pResponse->setResourceRepresentation(rep_post);
350 if(rep_post.hasAttribute("createduri"))
352 pResponse->setResponseResult(OC_EH_RESOURCE_CREATED);
353 pResponse->setNewResourceUri(rep_post.getValue<std::string>("createduri"));
357 pResponse->setResponseResult(OC_EH_OK);
360 if(OC_STACK_OK == OCPlatform::sendResponse(pResponse))
365 else if(requestType == "DELETE")
367 cout << "Delete request received" << endl;
371 if(requestFlag & RequestHandlerFlag::ObserverFlag)
373 ObservationInfo observationInfo = request->getObservationInfo();
374 if(ObserveAction::ObserveRegister == observationInfo.action)
376 m_interestedObservers.push_back(observationInfo.obsId);
378 else if(ObserveAction::ObserveUnregister == observationInfo.action)
380 m_interestedObservers.erase(std::remove(
381 m_interestedObservers.begin(),
382 m_interestedObservers.end(),
383 observationInfo.obsId),
384 m_interestedObservers.end());
387 cout << "\t\trequestFlag : Observer\n";
389 static int startedThread = 0;
391 // Observation happens on a different thread in ChangeMediaRepresentation function.
392 // If we have not created the thread already, we will create one here.
396 std::thread t(ChangeMediaRepresentation, (void *)this);
406 cout << "Request invalid" << std::endl;
414 // ChangeMediaRepresentaion is an observation function,
415 // which notifies any changes to the resource to stack
416 // via notifyObservers
417 void * ChangeMediaRepresentation (void *param)
420 MediaResource* mediaPtr = (MediaResource*) param;
422 // This function continuously monitors for the changes
429 prevVolume = mediaPtr->m_volume;
430 mediaPtr->m_volume = getVolume();
431 if (prevVolume == mediaPtr->m_volume)
434 cout << "Volume changed from " << prevVolume << "% to " << mediaPtr->m_volume << "%\n";
436 // If under observation if there are any changes to the media resource
437 // we call notifyObservors
439 // For demostration we are changing the volume value and notifying.
441 cout << "\nVolume updated to : " << mediaPtr->m_volume << endl;
442 cout << "Notifying observers with resource handle: " << mediaPtr->getHandle() << endl;
444 OCStackResult result = OC_STACK_OK;
446 if(isListOfObservers)
448 std::shared_ptr<OCResourceResponse> resourceResponse =
449 {std::make_shared<OCResourceResponse>()};
451 resourceResponse->setResourceRepresentation(mediaPtr->get(), DEFAULT_INTERFACE);
453 result = OCPlatform::notifyListOfObservers( mediaPtr->getHandle(),
454 mediaPtr->m_interestedObservers,
459 result = OCPlatform::notifyAllObservers(mediaPtr->getHandle());
462 if(OC_STACK_NO_OBSERVERS == result)
464 cout << "No More observers, stopping notifications" << endl;
473 void * handleSlowResponse (void *param, std::shared_ptr<OCResourceRequest> pRequest)
475 // This function handles slow response case
476 MediaResource* mediaPtr = (MediaResource*) param;
477 // Induce a case for slow response by using sleep
478 cout << "SLOW response" << std::endl;
481 auto pResponse = std::make_shared<OC::OCResourceResponse>();
482 pResponse->setRequestHandle(pRequest->getRequestHandle());
483 pResponse->setResourceHandle(pRequest->getResourceHandle());
484 pResponse->setResourceRepresentation(mediaPtr->get());
486 pResponse->setResponseResult(OC_EH_OK);
488 // Set the slow response flag back to false
489 isSlowResponse = false;
490 OCPlatform::sendResponse(pResponse);
497 cout << "Usage : mediaserver <value>\n";
498 cout << " Default - Non-secure resource and notify all observers\n";
499 cout << " 1 - Non-secure resource and notify list of observers\n\n";
500 cout << " 2 - Secure resource and notify all observers\n";
501 cout << " 3 - Secure resource and notify list of observers\n\n";
502 cout << " 4 - Non-secure resource, GET slow response, notify all observers\n";
505 static FILE* client_open(const char* /*path*/, const char* mode)
507 return fopen("./oic_svr_db_server.dat", mode);
514 // Set up a generic keyboard event.
515 ip.type = INPUT_KEYBOARD;
516 ip.ki.wScan = 0; // hardware scan code for key
518 ip.ki.dwExtraInfo = 0;
519 ip.ki.wVk = VK_MEDIA_PLAY_PAUSE; // virtual-key code for the "a" key
520 ip.ki.dwFlags = 0; // 0 for key press
522 SendInput(1, &ip, sizeof(INPUT));
523 // Release the "Play/Pause" key
524 ip.ki.dwFlags = KEYEVENTF_KEYUP; // KEYEVENTF_KEYUP for key release
525 SendInput(1, &ip, sizeof(INPUT));
530 IAudioEndpointVolume *g_pEndptVol = NULL;
532 IMMDeviceEnumerator *pEnumerator = NULL;
533 IMMDevice *pDevice = NULL;
534 OSVERSIONINFO VersionInfo;
536 ZeroMemory(&VersionInfo, sizeof(OSVERSIONINFO));
537 VersionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
538 GetVersionEx(&VersionInfo);
541 // Get enumerator for audio endpoint devices.
542 hr = CoCreateInstance(__uuidof(MMDeviceEnumerator),
543 NULL, CLSCTX_INPROC_SERVER,
544 __uuidof(IMMDeviceEnumerator),
545 (void**)&pEnumerator);
547 // Get default audio-rendering device.
548 hr = pEnumerator->GetDefaultAudioEndpoint(eRender, eConsole, &pDevice);
550 hr = pDevice->Activate(__uuidof(IAudioEndpointVolume),
551 CLSCTX_ALL, NULL, (void**)&g_pEndptVol);
553 hr = g_pEndptVol->GetMasterVolumeLevelScalar(¤tVal);
554 fflush(stdout); // just in case
556 SAFE_RELEASE(pEnumerator)
557 SAFE_RELEASE(pDevice)
558 SAFE_RELEASE(g_pEndptVol)
560 return ((int) round(100 * currentVal));
564 void setVolume(int vol)
566 IAudioEndpointVolume *g_pEndptVol = NULL;
568 IMMDeviceEnumerator *pEnumerator = NULL;
569 IMMDevice *pDevice = NULL;
570 OSVERSIONINFO VersionInfo;
572 ZeroMemory(&VersionInfo, sizeof(OSVERSIONINFO));
573 VersionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
574 GetVersionEx(&VersionInfo);
577 // Get enumerator for audio endpoint devices.
578 hr = CoCreateInstance(__uuidof(MMDeviceEnumerator),
579 NULL, CLSCTX_INPROC_SERVER,
580 __uuidof(IMMDeviceEnumerator),
581 (void**)&pEnumerator);
583 // Get default audio-rendering device.
584 hr = pEnumerator->GetDefaultAudioEndpoint(eRender, eConsole, &pDevice);
586 hr = pDevice->Activate(__uuidof(IAudioEndpointVolume),
587 CLSCTX_ALL, NULL, (void**)&g_pEndptVol);
588 float got = (float)vol/100.0; // needs to be within 1.0 to 0.0
589 hr = g_pEndptVol->SetMasterVolumeLevelScalar(got, NULL);
590 fflush(stdout); // just in case
592 SAFE_RELEASE(pEnumerator)
593 SAFE_RELEASE(pDevice)
594 SAFE_RELEASE(g_pEndptVol)
598 int main(int argc, char* argv[])
600 OCPersistentStorage ps {client_open, fread, fwrite, fclose, unlink };
604 isListOfObservers = false;
609 int value = atoi(argv[1]);
613 isListOfObservers = true;
617 isListOfObservers = false;
621 isListOfObservers = true;
625 isSlowResponse = true;
638 // Create PlatformConfig object
640 OC::ServiceType::InProc,
641 OC::ModeType::Server,
642 "0.0.0.0", // By setting to "0.0.0.0", it binds to all available interfaces
643 0, // Uses randomly available port
644 OC::QualityOfService::LowQos,
648 OCPlatform::Configure(cfg);
651 // Create the instance of the resource class
652 // (in this case instance of class 'MediaResource').
653 MediaResource myMedia;
655 // Invoke createResource function of class media.
656 myMedia.createResource();
657 cout << "Created resource." << std::endl;
659 // A condition variable will free the mutex it is given, then do a non-
660 // intensive block until 'notify' is called on it. In this case, since we
661 // don't ever call cv.notify, this should be a non-processor intensive version
664 std::condition_variable cv;
665 std::unique_lock<std::mutex> lock(blocker);
666 cout <<"Waiting" << std::endl;
667 cv.wait(lock, []{return false;});
669 catch(OCException &e)
671 cout << "OCException in main : " << e.what() << endl;
674 // No explicit call to stop the platform.
675 // When OCPlatform::destructor is invoked, internally we do platform cleanup