1 /* 2 * Copyright (c) 2015 Dario Casalinuovo <b.vitruvio@gmail.com> 3 * Copyright (c) 2002, 2003 Marcus Overhagen <Marcus@Overhagen.de> 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining 6 * a copy of this software and associated documentation files or portions 7 * thereof (the "Software"), to deal in the Software without restriction, 8 * including without limitation the rights to use, copy, modify, merge, 9 * publish, distribute, sublicense, and/or sell copies of the Software, 10 * and to permit persons to whom the Software is furnished to do so, subject 11 * to the following conditions: 12 * 13 * * Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 16 * * Redistributions in binary form must reproduce the above copyright notice 17 * in the binary, as well as this list of conditions and the following 18 * disclaimer in the documentation and/or other materials provided with 19 * the distribution. 20 * 21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 27 * THE SOFTWARE. 28 * 29 */ 30 31 #include <MediaEventLooper.h> 32 #include <TimeSource.h> 33 #include <scheduler.h> 34 #include <Buffer.h> 35 #include <ServerInterface.h> 36 #include "debug.h" 37 38 /************************************************************* 39 * protected BMediaEventLooper 40 *************************************************************/ 41 42 /* virtual */ 43 BMediaEventLooper::~BMediaEventLooper() 44 { 45 CALLED(); 46 47 // don't call Quit(); here, except if the user was stupid 48 if (fControlThread != -1) { 49 printf("You MUST call BMediaEventLooper::Quit() in your destructor!\n"); 50 Quit(); 51 } 52 } 53 54 /* explicit */ 55 BMediaEventLooper::BMediaEventLooper(uint32 apiVersion) : 56 BMediaNode("called by BMediaEventLooper"), 57 fControlThread(-1), 58 fCurrentPriority(B_URGENT_PRIORITY), 59 fSetPriority(B_URGENT_PRIORITY), 60 fRunState(B_UNREGISTERED), 61 fEventLatency(0), 62 fSchedulingLatency(0), 63 fBufferDuration(0), 64 fOfflineTime(0), 65 fApiVersion(apiVersion) 66 { 67 CALLED(); 68 fEventQueue.SetCleanupHook(BMediaEventLooper::_CleanUpEntry, this); 69 fRealTimeQueue.SetCleanupHook(BMediaEventLooper::_CleanUpEntry, this); 70 } 71 72 /* virtual */ void 73 BMediaEventLooper::NodeRegistered() 74 { 75 CALLED(); 76 // Calling Run() should be done by the derived class, 77 // at least that's how it is documented by the BeBook. 78 // It appears that BeOS R5 called it here. Calling Run() 79 // twice doesn't hurt, and some nodes need it to be called here. 80 Run(); 81 } 82 83 84 /* virtual */ void 85 BMediaEventLooper::Start(bigtime_t performance_time) 86 { 87 CALLED(); 88 // This hook function is called when a node is started 89 // by a call to the BMediaRoster. The specified 90 // performanceTime, the time at which the node 91 // should start running, may be in the future. 92 fEventQueue.AddEvent(media_timed_event(performance_time, BTimedEventQueue::B_START)); 93 } 94 95 96 /* virtual */ void 97 BMediaEventLooper::Stop(bigtime_t performance_time, 98 bool immediate) 99 { 100 CALLED(); 101 // This hook function is called when a node is stopped 102 // by a call to the BMediaRoster. The specified performanceTime, 103 // the time at which the node should stop, may be in the future. 104 // If immediate is true, your node should ignore the performanceTime 105 // value and synchronously stop performance. When Stop() returns, 106 // you're promising not to write into any BBuffers you may have 107 // received from your downstream consumers, and you promise not 108 // to send any more buffers until Start() is called again. 109 110 if (immediate) { 111 // always be sure to add to the front of the queue so we can make sure it is 112 // handled before any buffers are sent! 113 performance_time = 0; 114 } 115 fEventQueue.AddEvent(media_timed_event(performance_time, BTimedEventQueue::B_STOP)); 116 } 117 118 119 /* virtual */ void 120 BMediaEventLooper::Seek(bigtime_t media_time, 121 bigtime_t performance_time) 122 { 123 CALLED(); 124 // This hook function is called when a node is asked to seek to 125 // the specified mediaTime by a call to the BMediaRoster. 126 // The specified performanceTime, the time at which the node 127 // should begin the seek operation, may be in the future. 128 fEventQueue.AddEvent(media_timed_event(performance_time, BTimedEventQueue::B_SEEK, NULL, 129 BTimedEventQueue::B_NO_CLEANUP, 0, media_time, NULL)); 130 } 131 132 133 /* virtual */ void 134 BMediaEventLooper::TimeWarp(bigtime_t at_real_time, 135 bigtime_t to_performance_time) 136 { 137 CALLED(); 138 // This hook function is called when the time source to which the 139 // node is slaved is repositioned (via a seek operation) such that 140 // there will be a sudden jump in the performance time progression 141 // as seen by the node. The to_performance_time argument indicates 142 // the new performance time; the change should occur at the real 143 // time specified by the at_real_time argument. 144 145 // place in the realtime queue 146 fRealTimeQueue.AddEvent(media_timed_event(at_real_time, BTimedEventQueue::B_WARP, 147 NULL, BTimedEventQueue::B_NO_CLEANUP, 0, to_performance_time, NULL)); 148 149 // BeBook: Your implementation of TimeWarp() should call through to BMediaNode::TimeWarp() 150 // BeBook: as well as all other inherited forms of TimeWarp() 151 // XXX should we do this here? 152 BMediaNode::TimeWarp(at_real_time, to_performance_time); 153 } 154 155 156 /* virtual */ status_t 157 BMediaEventLooper::AddTimer(bigtime_t at_performance_time, 158 int32 cookie) 159 { 160 CALLED(); 161 162 media_timed_event event(at_performance_time, 163 BTimedEventQueue::B_TIMER, NULL, 164 BTimedEventQueue::B_EXPIRE_TIMER); 165 event.data = cookie; 166 return EventQueue()->AddEvent(event); 167 } 168 169 170 /* virtual */ void 171 BMediaEventLooper::SetRunMode(run_mode mode) 172 { 173 CALLED(); 174 // The SetRunMode() hook function is called when someone requests that your node's run mode be changed. 175 176 // bump or reduce priority when switching from/to offline run mode 177 int32 priority; 178 priority = (mode == B_OFFLINE) ? min_c(B_NORMAL_PRIORITY, fSetPriority) : fSetPriority; 179 if (priority != fCurrentPriority) { 180 fCurrentPriority = priority; 181 if (fControlThread > 0) { 182 set_thread_priority(fControlThread, fCurrentPriority); 183 fSchedulingLatency = estimate_max_scheduling_latency(fControlThread); 184 printf("BMediaEventLooper: SchedulingLatency is %" B_PRId64 "\n", 185 fSchedulingLatency); 186 } 187 } 188 189 BMediaNode::SetRunMode(mode); 190 } 191 192 193 /* virtual */ void 194 BMediaEventLooper::CleanUpEvent(const media_timed_event *event) 195 { 196 CALLED(); 197 // Implement this function to clean up after custom events you've created 198 // and added to your queue. It's called when a custom event is removed from 199 // the queue, to let you handle any special tidying-up that the event might require. 200 } 201 202 203 /* virtual */ bigtime_t 204 BMediaEventLooper::OfflineTime() 205 { 206 CALLED(); 207 return fOfflineTime; 208 } 209 210 211 /* virtual */ void 212 BMediaEventLooper::ControlLoop() 213 { 214 CALLED(); 215 216 status_t err; 217 bigtime_t waitUntil = B_INFINITE_TIMEOUT; 218 bigtime_t tempLateness = 0; 219 bool hasRealtime = false; 220 bool hasEvent = false; 221 222 // While there are no events or it is not time for the earliest event, 223 // process messages using WaitForMessages. Whenever this funtion times out, 224 // we need to handle the next event 225 226 fSchedulingLatency = estimate_max_scheduling_latency(fControlThread); 227 while (true) { 228 if (RunState() == B_QUITTING) 229 return; 230 231 err = WaitForMessage(waitUntil); 232 if (err == B_TIMED_OUT) { 233 media_timed_event event; 234 if (hasEvent) 235 err = fEventQueue.RemoveFirstEvent(&event); 236 else 237 err = fRealTimeQueue.RemoveFirstEvent(&event); 238 239 if (err == B_OK) { 240 tempLateness -= TimeSource()->RealTime(); 241 if (tempLateness < 0) 242 tempLateness = 0; 243 244 DispatchEvent(&event, tempLateness, hasRealtime); 245 } 246 } else if (err != B_OK) 247 return; 248 249 // BMediaEventLooper compensates your performance time by adding 250 // the event latency (see SetEventLatency()) and the scheduling 251 // latency (or, for real-time events, only the scheduling latency). 252 253 hasRealtime = fRealTimeQueue.HasEvents(); 254 hasEvent = fEventQueue.HasEvents(); 255 256 if (hasEvent) { 257 waitUntil = TimeSource()->RealTimeFor( 258 fEventQueue.FirstEvent()->event_time, 259 fEventLatency + fSchedulingLatency); 260 } else if (!hasRealtime) { 261 waitUntil = B_INFINITE_TIMEOUT; 262 continue; 263 } 264 265 if (hasEvent && hasRealtime) { 266 if (fRealTimeQueue.FirstEventTime() 267 - fSchedulingLatency <= waitUntil) { 268 hasEvent = false; 269 } else 270 hasRealtime = false; 271 } 272 273 if (hasRealtime) { 274 waitUntil = fRealTimeQueue.FirstEventTime() 275 - fSchedulingLatency; 276 } 277 278 tempLateness = waitUntil; 279 if (waitUntil < TimeSource()->RealTime()) 280 waitUntil = 0; 281 } 282 } 283 284 285 thread_id 286 BMediaEventLooper::ControlThread() 287 { 288 CALLED(); 289 return fControlThread; 290 } 291 292 /************************************************************* 293 * protected BMediaEventLooper 294 *************************************************************/ 295 296 297 BTimedEventQueue * 298 BMediaEventLooper::EventQueue() 299 { 300 CALLED(); 301 return &fEventQueue; 302 } 303 304 305 BTimedEventQueue * 306 BMediaEventLooper::RealTimeQueue() 307 { 308 CALLED(); 309 return &fRealTimeQueue; 310 } 311 312 313 int32 314 BMediaEventLooper::Priority() const 315 { 316 CALLED(); 317 return fCurrentPriority; 318 } 319 320 321 int32 322 BMediaEventLooper::RunState() const 323 { 324 PRINT(6, "CALLED BMediaEventLooper::RunState()\n"); 325 return fRunState; 326 } 327 328 329 bigtime_t 330 BMediaEventLooper::EventLatency() const 331 { 332 CALLED(); 333 return fEventLatency; 334 } 335 336 337 bigtime_t 338 BMediaEventLooper::BufferDuration() const 339 { 340 CALLED(); 341 return fBufferDuration; 342 } 343 344 345 bigtime_t 346 BMediaEventLooper::SchedulingLatency() const 347 { 348 CALLED(); 349 return fSchedulingLatency; 350 } 351 352 353 status_t 354 BMediaEventLooper::SetPriority(int32 priority) 355 { 356 CALLED(); 357 358 // clamp to a valid value 359 if (priority < 5) 360 priority = 5; 361 362 if (priority > 120) 363 priority = 120; 364 365 fSetPriority = priority; 366 fCurrentPriority = (RunMode() == B_OFFLINE) ? min_c(B_NORMAL_PRIORITY, fSetPriority) : fSetPriority; 367 368 if (fControlThread > 0) { 369 set_thread_priority(fControlThread, fCurrentPriority); 370 fSchedulingLatency = estimate_max_scheduling_latency(fControlThread); 371 printf("BMediaEventLooper: SchedulingLatency is %" B_PRId64 "\n", 372 fSchedulingLatency); 373 } 374 375 return B_OK; 376 } 377 378 379 void 380 BMediaEventLooper::SetRunState(run_state state) 381 { 382 CALLED(); 383 384 // don't allow run state changes while quitting, 385 // also needed for correct terminating of the ControlLoop() 386 if (fRunState == B_QUITTING && state != B_TERMINATED) 387 return; 388 389 fRunState = state; 390 } 391 392 393 void 394 BMediaEventLooper::SetEventLatency(bigtime_t latency) 395 { 396 CALLED(); 397 // clamp to a valid value 398 if (latency < 0) 399 latency = 0; 400 401 fEventLatency = latency; 402 write_port_etc(ControlPort(), GENERAL_PURPOSE_WAKEUP, 0, 0, B_TIMEOUT, 0); 403 } 404 405 406 void 407 BMediaEventLooper::SetBufferDuration(bigtime_t duration) 408 { 409 CALLED(); 410 fBufferDuration = duration; 411 } 412 413 414 void 415 BMediaEventLooper::SetOfflineTime(bigtime_t offTime) 416 { 417 CALLED(); 418 fOfflineTime = offTime; 419 } 420 421 422 void 423 BMediaEventLooper::Run() 424 { 425 CALLED(); 426 427 if (fControlThread != -1) 428 return; // thread already running 429 430 // until now, the run state is B_UNREGISTERED, but we need to start in B_STOPPED state. 431 SetRunState(B_STOPPED); 432 433 char threadName[32]; 434 sprintf(threadName, "%.20s control", Name()); 435 fControlThread = spawn_thread(_ControlThreadStart, threadName, fCurrentPriority, this); 436 resume_thread(fControlThread); 437 438 // get latency information 439 fSchedulingLatency = estimate_max_scheduling_latency(fControlThread); 440 } 441 442 443 void 444 BMediaEventLooper::Quit() 445 { 446 CALLED(); 447 448 if (fRunState == B_TERMINATED) 449 return; 450 451 SetRunState(B_QUITTING); 452 close_port(ControlPort()); 453 if (fControlThread != -1) { 454 status_t err; 455 wait_for_thread(fControlThread, &err); 456 fControlThread = -1; 457 } 458 SetRunState(B_TERMINATED); 459 } 460 461 462 void 463 BMediaEventLooper::DispatchEvent(const media_timed_event *event, 464 bigtime_t lateness, 465 bool realTimeEvent) 466 { 467 PRINT(6, "CALLED BMediaEventLooper::DispatchEvent()\n"); 468 469 HandleEvent(event, lateness, realTimeEvent); 470 471 switch (event->type) { 472 case BTimedEventQueue::B_START: 473 SetRunState(B_STARTED); 474 break; 475 476 case BTimedEventQueue::B_STOP: 477 SetRunState(B_STOPPED); 478 break; 479 480 case BTimedEventQueue::B_SEEK: 481 /* nothing */ 482 break; 483 484 case BTimedEventQueue::B_WARP: 485 /* nothing */ 486 break; 487 488 case BTimedEventQueue::B_TIMER: 489 TimerExpired(event->event_time, event->data); 490 break; 491 492 default: 493 break; 494 } 495 496 _DispatchCleanUp(event); 497 } 498 499 /************************************************************* 500 * private BMediaEventLooper 501 *************************************************************/ 502 503 504 /* static */ int32 505 BMediaEventLooper::_ControlThreadStart(void *arg) 506 { 507 CALLED(); 508 ((BMediaEventLooper *)arg)->SetRunState(B_STOPPED); 509 ((BMediaEventLooper *)arg)->ControlLoop(); 510 ((BMediaEventLooper *)arg)->SetRunState(B_QUITTING); 511 return 0; 512 } 513 514 515 /* static */ void 516 BMediaEventLooper::_CleanUpEntry(const media_timed_event *event, 517 void *context) 518 { 519 PRINT(6, "CALLED BMediaEventLooper::_CleanUpEntry()\n"); 520 ((BMediaEventLooper *)context)->_DispatchCleanUp(event); 521 } 522 523 524 void 525 BMediaEventLooper::_DispatchCleanUp(const media_timed_event *event) 526 { 527 PRINT(6, "CALLED BMediaEventLooper::_DispatchCleanUp()\n"); 528 529 // this function to clean up after custom events you've created 530 if (event->cleanup >= BTimedEventQueue::B_USER_CLEANUP) 531 CleanUpEvent(event); 532 } 533 534 /* 535 // unimplemented 536 BMediaEventLooper::BMediaEventLooper(const BMediaEventLooper &) 537 BMediaEventLooper &BMediaEventLooper::operator=(const BMediaEventLooper &) 538 */ 539 540 /************************************************************* 541 * protected BMediaEventLooper 542 *************************************************************/ 543 544 545 status_t 546 BMediaEventLooper::DeleteHook(BMediaNode *node) 547 { 548 CALLED(); 549 // this is the DeleteHook that gets called by the media server 550 // before the media node is deleted 551 Quit(); 552 return BMediaNode::DeleteHook(node); 553 } 554 555 /************************************************************* 556 * private BMediaEventLooper 557 *************************************************************/ 558 559 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_0(int32 arg,...) { return B_ERROR; } 560 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_1(int32 arg,...) { return B_ERROR; } 561 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_2(int32 arg,...) { return B_ERROR; } 562 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_3(int32 arg,...) { return B_ERROR; } 563 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_4(int32 arg,...) { return B_ERROR; } 564 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_5(int32 arg,...) { return B_ERROR; } 565 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_6(int32 arg,...) { return B_ERROR; } 566 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_7(int32 arg,...) { return B_ERROR; } 567 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_8(int32 arg,...) { return B_ERROR; } 568 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_9(int32 arg,...) { return B_ERROR; } 569 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_10(int32 arg,...) { return B_ERROR; } 570 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_11(int32 arg,...) { return B_ERROR; } 571 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_12(int32 arg,...) { return B_ERROR; } 572 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_13(int32 arg,...) { return B_ERROR; } 573 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_14(int32 arg,...) { return B_ERROR; } 574 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_15(int32 arg,...) { return B_ERROR; } 575 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_16(int32 arg,...) { return B_ERROR; } 576 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_17(int32 arg,...) { return B_ERROR; } 577 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_18(int32 arg,...) { return B_ERROR; } 578 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_19(int32 arg,...) { return B_ERROR; } 579 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_20(int32 arg,...) { return B_ERROR; } 580 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_21(int32 arg,...) { return B_ERROR; } 581 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_22(int32 arg,...) { return B_ERROR; } 582 status_t BMediaEventLooper::_Reserved_BMediaEventLooper_23(int32 arg,...) { return B_ERROR; } 583 584